diff options
Diffstat (limited to 'lib/python2.7/test/test_pydoc.py')
| -rw-r--r-- | lib/python2.7/test/test_pydoc.py | 423 |
1 files changed, 0 insertions, 423 deletions
diff --git a/lib/python2.7/test/test_pydoc.py b/lib/python2.7/test/test_pydoc.py deleted file mode 100644 index 382d6dc..0000000 --- a/lib/python2.7/test/test_pydoc.py +++ /dev/null @@ -1,423 +0,0 @@ -import os -import sys -import difflib -import __builtin__ -import re -import pydoc -import inspect -import keyword -import unittest -import xml.etree -import test.test_support -from collections import namedtuple -from test.script_helper import assert_python_ok -from test.test_support import ( - TESTFN, rmtree, reap_children, captured_stdout) - -from test import pydoc_mod - -if test.test_support.HAVE_DOCSTRINGS: - expected_data_docstrings = ( - 'dictionary for instance variables (if defined)', - 'list of weak references to the object (if defined)', - ) -else: - expected_data_docstrings = ('', '') - -expected_text_pattern = \ -""" -NAME - test.pydoc_mod - This is a test module for test_pydoc - -FILE - %s -%s -CLASSES - __builtin__.object - B - A -\x20\x20\x20\x20 - class A - | Hello and goodbye - |\x20\x20 - | Methods defined here: - |\x20\x20 - | __init__() - | Wow, I have no function! -\x20\x20\x20\x20 - class B(__builtin__.object) - | Data descriptors defined here: - |\x20\x20 - | __dict__%s - |\x20\x20 - | __weakref__%s - |\x20\x20 - | ---------------------------------------------------------------------- - | Data and other attributes defined here: - |\x20\x20 - | NO_MEANING = 'eggs' - -FUNCTIONS - doc_func() - This function solves all of the world's problems: - hunger - lack of Python - war -\x20\x20\x20\x20 - nodoc_func() - -DATA - __author__ = 'Benjamin Peterson' - __credits__ = 'Nobody' - __version__ = '1.2.3.4' - -VERSION - 1.2.3.4 - -AUTHOR - Benjamin Peterson - -CREDITS - Nobody -""".strip() - -expected_text_data_docstrings = tuple('\n | ' + s if s else '' - for s in expected_data_docstrings) - -expected_html_pattern = \ -""" -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading"> -<tr bgcolor="#7799ee"> -<td valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"> <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 -><td align=right valign=bottom -><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:%s">%s</a>%s</font></td></tr></table> - <p><tt>This is a test module for test_pydoc</tt></p> -<p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ee77aa"> -<td colspan=3 valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> -\x20\x20\x20\x20 -<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> -<td width="100%%"><dl> -<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> -</font></dt><dd> -<dl> -<dt><font face="helvetica, arial"><a href="test.pydoc_mod.html#B">B</a> -</font></dt></dl> -</dd> -<dt><font face="helvetica, arial"><a href="test.pydoc_mod.html#A">A</a> -</font></dt></dl> - <p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="A">class <strong>A</strong></a></font></td></tr> -\x20\x20\x20\x20 -<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> -<td colspan=2><tt>Hello and goodbye<br> </tt></td></tr> -<tr><td> </td> -<td width="100%%">Methods defined here:<br> -<dl><dt><a name="A-__init__"><strong>__init__</strong></a>()</dt><dd><tt>Wow, I have no function!</tt></dd></dl> - -</td></tr></table> <p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> -<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> -\x20\x20\x20\x20 -<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> -<td width="100%%">Data descriptors defined here:<br> -<dl><dt><strong>__dict__</strong></dt> -<dd><tt>%s</tt></dd> -</dl> -<dl><dt><strong>__weakref__</strong></dt> -<dd><tt>%s</tt></dd> -</dl> -<hr> -Data and other attributes defined here:<br> -<dl><dt><strong>NO_MEANING</strong> = 'eggs'</dl> - -</td></tr></table></td></tr></table><p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#eeaa77"> -<td colspan=3 valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> -\x20\x20\x20\x20 -<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> -<td width="100%%"><dl><dt><a name="-doc_func"><strong>doc_func</strong></a>()</dt><dd><tt>This function solves all of the world's problems:<br> -hunger<br> -lack of Python<br> -war</tt></dd></dl> - <dl><dt><a name="-nodoc_func"><strong>nodoc_func</strong></a>()</dt></dl> -</td></tr></table><p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#55aa55"> -<td colspan=3 valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> -\x20\x20\x20\x20 -<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> -<td width="100%%"><strong>__author__</strong> = 'Benjamin Peterson'<br> -<strong>__credits__</strong> = 'Nobody'<br> -<strong>__version__</strong> = '1.2.3.4'</td></tr></table><p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#7799ee"> -<td colspan=3 valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> -\x20\x20\x20\x20 -<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> -<td width="100%%">Benjamin Peterson</td></tr></table><p> -<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#7799ee"> -<td colspan=3 valign=bottom> <br> -<font color="#ffffff" face="helvetica, arial"><big><strong>Credits</strong></big></font></td></tr> -\x20\x20\x20\x20 -<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> -<td width="100%%">Nobody</td></tr></table> -""".strip() - -expected_html_data_docstrings = tuple(s.replace(' ', ' ') - for s in expected_data_docstrings) - -# output pattern for missing module -missing_pattern = "no Python documentation found for '%s'" - -# output pattern for module with bad imports -badimport_pattern = "problem in %s - <type 'exceptions.ImportError'>: No module named %s" - -def run_pydoc(module_name, *args, **env): - """ - Runs pydoc on the specified module. Returns the stripped - output of pydoc. - """ - args = args + (module_name,) - # do not write bytecode files to avoid caching errors - rc, out, err = assert_python_ok('-B', pydoc.__file__, *args, **env) - return out.strip() - -def get_pydoc_html(module): - "Returns pydoc generated output as html" - doc = pydoc.HTMLDoc() - output = doc.docmodule(module) - loc = doc.getdocloc(pydoc_mod) or "" - if loc: - loc = "<br><a href=\"" + loc + "\">Module Docs</a>" - return output.strip(), loc - -def get_pydoc_text(module): - "Returns pydoc generated output as text" - doc = pydoc.TextDoc() - loc = doc.getdocloc(pydoc_mod) or "" - if loc: - loc = "\nMODULE DOCS\n " + loc + "\n" - - output = doc.docmodule(module) - - # cleanup the extra text formatting that pydoc preforms - patt = re.compile('\b.') - output = patt.sub('', output) - return output.strip(), loc - -def print_diffs(text1, text2): - "Prints unified diffs for two texts" - lines1 = text1.splitlines(True) - lines2 = text2.splitlines(True) - diffs = difflib.unified_diff(lines1, lines2, n=0, fromfile='expected', - tofile='got') - print '\n' + ''.join(diffs) - - -class PyDocDocTest(unittest.TestCase): - - @unittest.skipIf(sys.flags.optimize >= 2, - "Docstrings are omitted with -O2 and above") - def test_html_doc(self): - result, doc_loc = get_pydoc_html(pydoc_mod) - mod_file = inspect.getabsfile(pydoc_mod) - if sys.platform == 'win32': - import nturl2path - mod_url = nturl2path.pathname2url(mod_file) - else: - mod_url = mod_file - expected_html = expected_html_pattern % ( - (mod_url, mod_file, doc_loc) + - expected_html_data_docstrings) - if result != expected_html: - print_diffs(expected_html, result) - self.fail("outputs are not equal, see diff above") - - @unittest.skipIf(sys.flags.optimize >= 2, - "Docstrings are omitted with -O2 and above") - def test_text_doc(self): - result, doc_loc = get_pydoc_text(pydoc_mod) - expected_text = expected_text_pattern % ( - (inspect.getabsfile(pydoc_mod), doc_loc) + - expected_text_data_docstrings) - if result != expected_text: - print_diffs(expected_text, result) - self.fail("outputs are not equal, see diff above") - - def test_issue8225(self): - # Test issue8225 to ensure no doc link appears for xml.etree - result, doc_loc = get_pydoc_text(xml.etree) - self.assertEqual(doc_loc, "", "MODULE DOCS incorrectly includes a link") - - def test_non_str_name(self): - # issue14638 - # Treat illegal (non-str) name like no name - class A: - __name__ = 42 - class B: - pass - adoc = pydoc.render_doc(A()) - bdoc = pydoc.render_doc(B()) - self.assertEqual(adoc.replace("A", "B"), bdoc) - - def test_not_here(self): - missing_module = "test.i_am_not_here" - result = run_pydoc(missing_module) - expected = missing_pattern % missing_module - self.assertEqual(expected, result, - "documentation for missing module found") - - def test_input_strip(self): - missing_module = " test.i_am_not_here " - result = run_pydoc(missing_module) - expected = missing_pattern % missing_module.strip() - self.assertEqual(expected, result, - "white space was not stripped from module name " - "or other error output mismatch") - - def test_stripid(self): - # test with strings, other implementations might have different repr() - stripid = pydoc.stripid - # strip the id - self.assertEqual(stripid('<function stripid at 0x88dcee4>'), - '<function stripid>') - self.assertEqual(stripid('<function stripid at 0x01F65390>'), - '<function stripid>') - # nothing to strip, return the same text - self.assertEqual(stripid('42'), '42') - self.assertEqual(stripid("<type 'exceptions.Exception'>"), - "<type 'exceptions.Exception'>") - - -class PydocImportTest(unittest.TestCase): - - def setUp(self): - self.test_dir = os.mkdir(TESTFN) - self.addCleanup(rmtree, TESTFN) - - def test_badimport(self): - # This tests the fix for issue 5230, where if pydoc found the module - # but the module had an internal import error pydoc would report no doc - # found. - modname = 'testmod_xyzzy' - testpairs = ( - ('i_am_not_here', 'i_am_not_here'), - ('test.i_am_not_here_either', 'i_am_not_here_either'), - ('test.i_am_not_here.neither_am_i', 'i_am_not_here.neither_am_i'), - ('i_am_not_here.{}'.format(modname), - 'i_am_not_here.{}'.format(modname)), - ('test.{}'.format(modname), modname), - ) - - sourcefn = os.path.join(TESTFN, modname) + os.extsep + "py" - for importstring, expectedinmsg in testpairs: - with open(sourcefn, 'w') as f: - f.write("import {}\n".format(importstring)) - result = run_pydoc(modname, PYTHONPATH=TESTFN) - expected = badimport_pattern % (modname, expectedinmsg) - self.assertEqual(expected, result) - - def test_apropos_with_bad_package(self): - # Issue 7425 - pydoc -k failed when bad package on path - pkgdir = os.path.join(TESTFN, "syntaxerr") - os.mkdir(pkgdir) - badsyntax = os.path.join(pkgdir, "__init__") + os.extsep + "py" - with open(badsyntax, 'w') as f: - f.write("invalid python syntax = $1\n") - result = run_pydoc('zqwykjv', '-k', PYTHONPATH=TESTFN) - self.assertEqual('', result) - - def test_apropos_with_unreadable_dir(self): - # Issue 7367 - pydoc -k failed when unreadable dir on path - self.unreadable_dir = os.path.join(TESTFN, "unreadable") - os.mkdir(self.unreadable_dir, 0) - self.addCleanup(os.rmdir, self.unreadable_dir) - # Note, on Windows the directory appears to be still - # readable so this is not really testing the issue there - result = run_pydoc('zqwykjv', '-k', PYTHONPATH=TESTFN) - self.assertEqual('', result) - - -class TestDescriptions(unittest.TestCase): - - def test_module(self): - # Check that pydocfodder module can be described - from test import pydocfodder - doc = pydoc.render_doc(pydocfodder) - self.assertIn("pydocfodder", doc) - - def test_classic_class(self): - class C: "Classic class" - c = C() - self.assertEqual(pydoc.describe(C), 'class C') - self.assertEqual(pydoc.describe(c), 'instance of C') - expected = 'instance of C in module %s' % __name__ - self.assertIn(expected, pydoc.render_doc(c)) - - def test_class(self): - class C(object): "New-style class" - c = C() - - self.assertEqual(pydoc.describe(C), 'class C') - self.assertEqual(pydoc.describe(c), 'C') - expected = 'C in module %s object' % __name__ - self.assertIn(expected, pydoc.render_doc(c)) - - def test_namedtuple_public_underscore(self): - NT = namedtuple('NT', ['abc', 'def'], rename=True) - with captured_stdout() as help_io: - help(NT) - helptext = help_io.getvalue() - self.assertIn('_1', helptext) - self.assertIn('_replace', helptext) - self.assertIn('_asdict', helptext) - - -class TestHelper(unittest.TestCase): - def test_keywords(self): - self.assertEqual(sorted(pydoc.Helper.keywords), - sorted(keyword.kwlist)) - - def test_builtin(self): - for name in ('str', 'str.translate', '__builtin__.str', - '__builtin__.str.translate'): - # test low-level function - self.assertIsNotNone(pydoc.locate(name)) - # test high-level function - try: - pydoc.render_doc(name) - except ImportError: - self.fail('finding the doc of {!r} failed'.format(o)) - - for name in ('not__builtin__', 'strrr', 'strr.translate', - 'str.trrrranslate', '__builtin__.strrr', - '__builtin__.str.trrranslate'): - self.assertIsNone(pydoc.locate(name)) - self.assertRaises(ImportError, pydoc.render_doc, name) - - -def test_main(): - try: - test.test_support.run_unittest(PyDocDocTest, - PydocImportTest, - TestDescriptions, - TestHelper) - finally: - reap_children() - -if __name__ == "__main__": - test_main() |