EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / test / test_pydoc.py

import sys\r
import os\r
import os.path\r
import difflib\r
import subprocess\r
import re\r
import pydoc\r
import inspect\r
import keyword\r
import unittest\r
import xml.etree\r
import test.test_support\r
from contextlib import contextmanager\r
from collections import namedtuple\r
from test.test_support import (\r
    TESTFN, forget, rmtree, EnvironmentVarGuard, reap_children, captured_stdout)\r
\r
from test import pydoc_mod\r
\r
expected_text_pattern = \\r
"""\r
NAME\r
    test.pydoc_mod - This is a test module for test_pydoc\r
\r
FILE\r
    %s\r
%s\r
CLASSES\r
    __builtin__.object\r
        B\r
    A\r
\x20\x20\x20\x20\r
    class A\r
     |  Hello and goodbye\r
     |\x20\x20\r
     |  Methods defined here:\r
     |\x20\x20\r
     |  __init__()\r
     |      Wow, I have no function!\r
\x20\x20\x20\x20\r
    class B(__builtin__.object)\r
     |  Data descriptors defined here:\r
     |\x20\x20\r
     |  __dict__\r
     |      dictionary for instance variables (if defined)\r
     |\x20\x20\r
     |  __weakref__\r
     |      list of weak references to the object (if defined)\r
     |\x20\x20\r
     |  ----------------------------------------------------------------------\r
     |  Data and other attributes defined here:\r
     |\x20\x20\r
     |  NO_MEANING = 'eggs'\r
\r
FUNCTIONS\r
    doc_func()\r
        This function solves all of the world's problems:\r
        hunger\r
        lack of Python\r
        war\r
\x20\x20\x20\x20\r
    nodoc_func()\r
\r
DATA\r
    __author__ = 'Benjamin Peterson'\r
    __credits__ = 'Nobody'\r
    __version__ = '1.2.3.4'\r
\r
VERSION\r
    1.2.3.4\r
\r
AUTHOR\r
    Benjamin Peterson\r
\r
CREDITS\r
    Nobody\r
""".strip()\r
\r
expected_html_pattern = \\r
"""\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading">\r
<tr bgcolor="#7799ee">\r
<td valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="test.html"><font color="#ffffff">test</font></a>.pydoc_mod</strong></big></big> (version 1.2.3.4)</font></td\r
><td align=right valign=bottom\r
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:%s">%s</a>%s</font></td></tr></table>\r
    <p><tt>This&nbsp;is&nbsp;a&nbsp;test&nbsp;module&nbsp;for&nbsp;test_pydoc</tt></p>\r
<p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#ee77aa">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%"><dl>\r
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>\r
</font></dt><dd>\r
<dl>\r
<dt><font face="helvetica, arial"><a href="test.pydoc_mod.html#B">B</a>\r
</font></dt></dl>\r
</dd>\r
<dt><font face="helvetica, arial"><a href="test.pydoc_mod.html#A">A</a>\r
</font></dt></dl>\r
 <p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#ffc8d8">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#000000" face="helvetica, arial"><a name="A">class <strong>A</strong></a></font></td></tr>\r
\x20\x20\x20\x20\r
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>\r
<td colspan=2><tt>Hello&nbsp;and&nbsp;goodbye<br>&nbsp;</tt></td></tr>\r
<tr><td>&nbsp;</td>\r
<td width="100%%">Methods defined here:<br>\r
<dl><dt><a name="A-__init__"><strong>__init__</strong></a>()</dt><dd><tt>Wow,&nbsp;I&nbsp;have&nbsp;no&nbsp;function!</tt></dd></dl>\r
\r
</td></tr></table> <p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#ffc8d8">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#000000" face="helvetica, arial"><a name="B">class <strong>B</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%">Data descriptors defined here:<br>\r
<dl><dt><strong>__dict__</strong></dt>\r
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>\r
</dl>\r
<dl><dt><strong>__weakref__</strong></dt>\r
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>\r
</dl>\r
<hr>\r
Data and other attributes defined here:<br>\r
<dl><dt><strong>NO_MEANING</strong> = 'eggs'</dl>\r
\r
</td></tr></table></td></tr></table><p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#eeaa77">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%"><dl><dt><a name="-doc_func"><strong>doc_func</strong></a>()</dt><dd><tt>This&nbsp;function&nbsp;solves&nbsp;all&nbsp;of&nbsp;the&nbsp;world's&nbsp;problems:<br>\r
hunger<br>\r
lack&nbsp;of&nbsp;Python<br>\r
war</tt></dd></dl>\r
 <dl><dt><a name="-nodoc_func"><strong>nodoc_func</strong></a>()</dt></dl>\r
</td></tr></table><p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#55aa55">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%"><strong>__author__</strong> = 'Benjamin Peterson'<br>\r
<strong>__credits__</strong> = 'Nobody'<br>\r
<strong>__version__</strong> = '1.2.3.4'</td></tr></table><p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#7799ee">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%">Benjamin&nbsp;Peterson</td></tr></table><p>\r
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">\r
<tr bgcolor="#7799ee">\r
<td colspan=3 valign=bottom>&nbsp;<br>\r
<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr>\r
\x20\x20\x20\x20\r
<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>\r
<td width="100%%">Nobody</td></tr></table>\r
""".strip()\r
\r
\r
# output pattern for missing module\r
missing_pattern = "no Python documentation found for '%s'"\r
\r
# output pattern for module with bad imports\r
badimport_pattern = "problem in %s - <type 'exceptions.ImportError'>: No module named %s"\r
\r
def run_pydoc(module_name, *args):\r
    """\r
    Runs pydoc on the specified module. Returns the stripped\r
    output of pydoc.\r
    """\r
    cmd = [sys.executable, pydoc.__file__, " ".join(args), module_name]\r
    try:\r
        output = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()[0]\r
        return output.strip()\r
    finally:\r
        reap_children()\r
\r
def get_pydoc_html(module):\r
    "Returns pydoc generated output as html"\r
    doc = pydoc.HTMLDoc()\r
    output = doc.docmodule(module)\r
    loc = doc.getdocloc(pydoc_mod) or ""\r
    if loc:\r
        loc = "<br><a href=\"" + loc + "\">Module Docs</a>"\r
    return output.strip(), loc\r
\r
def get_pydoc_text(module):\r
    "Returns pydoc generated output as text"\r
    doc = pydoc.TextDoc()\r
    loc = doc.getdocloc(pydoc_mod) or ""\r
    if loc:\r
        loc = "\nMODULE DOCS\n    " + loc + "\n"\r
\r
    output = doc.docmodule(module)\r
\r
    # cleanup the extra text formatting that pydoc preforms\r
    patt = re.compile('\b.')\r
    output = patt.sub('', output)\r
    return output.strip(), loc\r
\r
def print_diffs(text1, text2):\r
    "Prints unified diffs for two texts"\r
    lines1 = text1.splitlines(True)\r
    lines2 = text2.splitlines(True)\r
    diffs = difflib.unified_diff(lines1, lines2, n=0, fromfile='expected',\r
                                 tofile='got')\r
    print '\n' + ''.join(diffs)\r
\r
\r
class PyDocDocTest(unittest.TestCase):\r
\r
    @unittest.skipIf(sys.flags.optimize >= 2,\r
                     "Docstrings are omitted with -O2 and above")\r
    def test_html_doc(self):\r
        result, doc_loc = get_pydoc_html(pydoc_mod)\r
        mod_file = inspect.getabsfile(pydoc_mod)\r
        if sys.platform == 'win32':\r
            import nturl2path\r
            mod_url = nturl2path.pathname2url(mod_file)\r
        else:\r
            mod_url = mod_file\r
        expected_html = expected_html_pattern % (mod_url, mod_file, doc_loc)\r
        if result != expected_html:\r
            print_diffs(expected_html, result)\r
            self.fail("outputs are not equal, see diff above")\r
\r
    @unittest.skipIf(sys.flags.optimize >= 2,\r
                     "Docstrings are omitted with -O2 and above")\r
    def test_text_doc(self):\r
        result, doc_loc = get_pydoc_text(pydoc_mod)\r
        expected_text = expected_text_pattern % \\r
                        (inspect.getabsfile(pydoc_mod), doc_loc)\r
        if result != expected_text:\r
            print_diffs(expected_text, result)\r
            self.fail("outputs are not equal, see diff above")\r
\r
    def test_issue8225(self):\r
        # Test issue8225 to ensure no doc link appears for xml.etree\r
        result, doc_loc = get_pydoc_text(xml.etree)\r
        self.assertEqual(doc_loc, "", "MODULE DOCS incorrectly includes a link")\r
\r
    def test_not_here(self):\r
        missing_module = "test.i_am_not_here"\r
        result = run_pydoc(missing_module)\r
        expected = missing_pattern % missing_module\r
        self.assertEqual(expected, result,\r
            "documentation for missing module found")\r
\r
    def test_badimport(self):\r
        # This tests the fix for issue 5230, where if pydoc found the module\r
        # but the module had an internal import error pydoc would report no doc\r
        # found.\r
        modname = 'testmod_xyzzy'\r
        testpairs = (\r
            ('i_am_not_here', 'i_am_not_here'),\r
            ('test.i_am_not_here_either', 'i_am_not_here_either'),\r
            ('test.i_am_not_here.neither_am_i', 'i_am_not_here.neither_am_i'),\r
            ('i_am_not_here.{}'.format(modname), 'i_am_not_here.{}'.format(modname)),\r
            ('test.{}'.format(modname), modname),\r
            )\r
\r
        @contextmanager\r
        def newdirinpath(dir):\r
            os.mkdir(dir)\r
            sys.path.insert(0, dir)\r
            yield\r
            sys.path.pop(0)\r
            rmtree(dir)\r
\r
        with newdirinpath(TESTFN), EnvironmentVarGuard() as env:\r
            env['PYTHONPATH'] = TESTFN\r
            fullmodname = os.path.join(TESTFN, modname)\r
            sourcefn = fullmodname + os.extsep + "py"\r
            for importstring, expectedinmsg in testpairs:\r
                f = open(sourcefn, 'w')\r
                f.write("import {}\n".format(importstring))\r
                f.close()\r
                try:\r
                    result = run_pydoc(modname)\r
                finally:\r
                    forget(modname)\r
                expected = badimport_pattern % (modname, expectedinmsg)\r
                self.assertEqual(expected, result)\r
\r
    def test_input_strip(self):\r
        missing_module = " test.i_am_not_here "\r
        result = run_pydoc(missing_module)\r
        expected = missing_pattern % missing_module.strip()\r
        self.assertEqual(expected, result,\r
            "white space was not stripped from module name "\r
            "or other error output mismatch")\r
\r
    def test_stripid(self):\r
        # test with strings, other implementations might have different repr()\r
        stripid = pydoc.stripid\r
        # strip the id\r
        self.assertEqual(stripid('<function stripid at 0x88dcee4>'),\r
                         '<function stripid>')\r
        self.assertEqual(stripid('<function stripid at 0x01F65390>'),\r
                         '<function stripid>')\r
        # nothing to strip, return the same text\r
        self.assertEqual(stripid('42'), '42')\r
        self.assertEqual(stripid("<type 'exceptions.Exception'>"),\r
                         "<type 'exceptions.Exception'>")\r
\r
\r
class TestDescriptions(unittest.TestCase):\r
\r
    def test_module(self):\r
        # Check that pydocfodder module can be described\r
        from test import pydocfodder\r
        doc = pydoc.render_doc(pydocfodder)\r
        self.assertIn("pydocfodder", doc)\r
\r
    def test_classic_class(self):\r
        class C: "Classic class"\r
        c = C()\r
        self.assertEqual(pydoc.describe(C), 'class C')\r
        self.assertEqual(pydoc.describe(c), 'instance of C')\r
        expected = 'instance of C in module %s' % __name__\r
        self.assertIn(expected, pydoc.render_doc(c))\r
\r
    def test_class(self):\r
        class C(object): "New-style class"\r
        c = C()\r
\r
        self.assertEqual(pydoc.describe(C), 'class C')\r
        self.assertEqual(pydoc.describe(c), 'C')\r
        expected = 'C in module %s object' % __name__\r
        self.assertIn(expected, pydoc.render_doc(c))\r
\r
    def test_namedtuple_public_underscore(self):\r
        NT = namedtuple('NT', ['abc', 'def'], rename=True)\r
        with captured_stdout() as help_io:\r
            help(NT)\r
        helptext = help_io.getvalue()\r
        self.assertIn('_1', helptext)\r
        self.assertIn('_replace', helptext)\r
        self.assertIn('_asdict', helptext)\r
\r
\r
class TestHelper(unittest.TestCase):\r
    def test_keywords(self):\r
        self.assertEqual(sorted(pydoc.Helper.keywords),\r
                         sorted(keyword.kwlist))\r
\r
\r
def test_main():\r
    test.test_support.run_unittest(PyDocDocTest,\r
                                   TestDescriptions,\r
                                   TestHelper)\r
\r
if __name__ == "__main__":\r
    test_main()\r