cpython.git - https://github.com/python/cpython.git

diff options

Diffstat (limited to 'Python/formatter_string.c')

0 files changed, 0 insertions, 0 deletions

import sys import os import os.path import difflib import subprocess import re import pydoc import inspect import unittest import test.test_support from contextlib import contextmanager from test.test_support import ( TESTFN, forget, rmtree, EnvironmentVarGuard, reap_children) from test import pydoc_mod 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__ | dictionary for instance variables (if defined) |\x20\x20 | __weakref__ | list of weak references to the object (if defined) |\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_html_pattern = \ """ <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big><a href="test.html">test</a>.pydoc_mod</big></big> (version 1.2.3.4)</td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:%s">%s</a>%s</td></tr></table> <tt>This is a test module for test_pydoc</tt> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%%"><dl> <dt><a href="__builtin__.html#object">__builtin__.object</a> </dt><dd> <dl> <dt><a href="test.pydoc_mod.html#B">B</a> </dt></dl> </dd> <dt><a href="test.pydoc_mod.html#A">A</a> </dt></dl> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="A">class A</a></td></tr> \x20\x20\x20\x20 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td> <td colspan=2><tt>Hello and goodbye  </tt></td></tr> <tr><td> </td> <td width="100%%">Methods defined here: <dl><dt><a name="A-__init__">__init__</a>()</dt><dd><tt>Wow, I have no function!</tt></dd></dl> </td></tr></table> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="B">class B</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td> <td width="100%%">Data descriptors defined here: <dl><dt>__dict__</dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Data and other attributes defined here: <dl><dt>NO_MEANING = 'eggs'</dl> </td></tr></table></td></tr></table> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> <td colspan=3 valign=bottom>  <big>Functions</big></td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td> <td width="100%%"><dl><dt><a name="-doc_func">doc_func</a>()</dt><dd><tt>This function solves all of the world's problems: hunger lack of Python war</tt></dd></dl> <dl><dt><a name="-nodoc_func">nodoc_func</a>()</dt></dl> </td></tr></table> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom>  <big>Data</big></td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td> <td width="100%%">__author__ = 'Benjamin Peterson' __credits__ = 'Nobody' __version__ = '1.2.3.4'</td></tr></table> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#7799ee"> <td colspan=3 valign=bottom>  <big>Author</big></td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#7799ee"><tt>      </tt></td><td> </td> <td width="100%%">Benjamin Peterson</td></tr></table> <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#7799ee"> <td colspan=3 valign=bottom>  <big>Credits</big></td></tr> \x20\x20\x20\x20 <tr><td bgcolor="#7799ee"><tt>      </tt></td><td> </td> <td width="100%%">Nobody</td></tr></table> """.strip() # 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): """ Runs pydoc on the specified module. Returns the stripped output of pydoc. """ cmd = [sys.executable, pydoc.__file__, " ".join(args), module_name] try: output = subprocess.Popen(cmd, stdout=subprocess.PIPE).communicate()[0] return output.strip() finally: reap_children() 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 = " <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): 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) if result != expected_html: print_diffs(expected_html, result) self.fail("outputs are not equal, see diff 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) if result != expected_text: print_diffs(expected_text, result) self.fail("outputs are not equal, see diff above") 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_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), ) @contextmanager def newdirinpath(dir): os.mkdir(dir) sys.path.insert(0, dir) yield sys.path.pop(0) rmtree(dir) with newdirinpath(TESTFN), EnvironmentVarGuard() as env: env['PYTHONPATH'] = TESTFN fullmodname = os.path.join(TESTFN, modname) sourcefn = fullmodname + os.extsep + "py" for importstring, expectedinmsg in testpairs: f = open(sourcefn, 'w') f.write("import {}\n".format(importstring)) f.close() try: result = run_pydoc(modname) finally: forget(modname) expected = badimport_pattern % (modname, expectedinmsg) self.assertEqual(expected, result) 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") 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.assertTrue("pydocfodder" in 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.assertTrue(expected in 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.assertTrue(expected in pydoc.render_doc(c)) def test_main(): test.test_support.run_unittest(PyDocDocTest, TestDescriptions) if __name__ == "__main__": test_main()


context:
space:
mode: