From 72121c6c302d0e177d3f738f51685e0664343ccc Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sun, 27 Jan 2013 19:45:49 +0200 Subject: [PATCH] - Issue #17041: Fix testing when Python is configured with the --without-doc-strings option. --- Lib/ctypes/test/test_win32.py | 5 ++++- Lib/distutils/tests/test_build_ext.py | 5 +++-- Lib/test/test_functools.py | 1 + Lib/test/test_pydoc.py | 32 +++++++++++++++++++-------- Lib/test/test_support.py | 14 ++++++++---- Misc/NEWS | 3 +++ 6 files changed, 44 insertions(+), 16 deletions(-) diff --git a/Lib/ctypes/test/test_win32.py b/Lib/ctypes/test/test_win32.py index 2534a748cd9..77e6fead56f 100644 --- a/Lib/ctypes/test/test_win32.py +++ b/Lib/ctypes/test/test_win32.py @@ -3,6 +3,7 @@ from ctypes import * from ctypes.test import is_resource_enabled import unittest, sys +from test import test_support as support import _ctypes_test @@ -60,7 +61,9 @@ if sys.platform == "win32": def test_COMError(self): from _ctypes import COMError - self.assertEqual(COMError.__doc__, "Raised when a COM method call failed.") + if support.HAVE_DOCSTRINGS: + self.assertEqual(COMError.__doc__, + "Raised when a COM method call failed.") ex = COMError(-1, "text", ("details",)) self.assertEqual(ex.hresult, -1) diff --git a/Lib/distutils/tests/test_build_ext.py b/Lib/distutils/tests/test_build_ext.py index b71cc983bee..f6a503b538e 100644 --- a/Lib/distutils/tests/test_build_ext.py +++ b/Lib/distutils/tests/test_build_ext.py @@ -77,8 +77,9 @@ class BuildExtTestCase(support.TempdirManager, self.assertEqual(xx.foo(2, 5), 7) self.assertEqual(xx.foo(13,15), 28) self.assertEqual(xx.new().demo(), None) - doc = 'This is a template module just for instruction.' - self.assertEqual(xx.__doc__, doc) + if test_support.HAVE_DOCSTRINGS: + doc = 'This is a template module just for instruction.' + self.assertEqual(xx.__doc__, doc) self.assertTrue(isinstance(xx.Null(), xx.Null)) self.assertTrue(isinstance(xx.Str(), xx.Str)) diff --git a/Lib/test/test_functools.py b/Lib/test/test_functools.py index a713314f160..af19ef7fec7 100644 --- a/Lib/test/test_functools.py +++ b/Lib/test/test_functools.py @@ -232,6 +232,7 @@ class TestUpdateWrapper(unittest.TestCase): self.assertEqual(wrapper.attr, 'This is a different test') self.assertEqual(wrapper.dict_attr, f.dict_attr) + @test_support.requires_docstrings def test_builtin_update(self): # Test for bug #1576241 def wrapper(): diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py index d95e7069ce1..382d6dc878f 100644 --- a/Lib/test/test_pydoc.py +++ b/Lib/test/test_pydoc.py @@ -16,6 +16,14 @@ from test.test_support import ( 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 @@ -40,11 +48,9 @@ CLASSES class B(__builtin__.object) | Data descriptors defined here: |\x20\x20 - | __dict__ - | dictionary for instance variables (if defined) + | __dict__%s |\x20\x20 - | __weakref__ - | list of weak references to the object (if defined) + | __weakref__%s |\x20\x20 | ---------------------------------------------------------------------- | Data and other attributes defined here: @@ -75,6 +81,9 @@ CREDITS Nobody """.strip() +expected_text_data_docstrings = tuple('\n | ' + s if s else '' + for s in expected_data_docstrings) + expected_html_pattern = \ """ @@ -121,10 +130,10 @@ expected_html_pattern = \
     Data descriptors defined here:
__dict__
-
dictionary for instance variables (if defined)
+
%s
__weakref__
-
list of weak references to the object (if defined)
+
%s
Data and other attributes defined here:
@@ -168,6 +177,8 @@ war 		Nobody
""".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'" @@ -229,7 +240,9 @@ class PyDocDocTest(unittest.TestCase): mod_url = nturl2path.pathname2url(mod_file) else: mod_url = mod_file - expected_html = expected_html_pattern % (mod_url, mod_file, doc_loc) + 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") @@ -238,8 +251,9 @@ class PyDocDocTest(unittest.TestCase): "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 = 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") diff --git a/Lib/test/test_support.py b/Lib/test/test_support.py index d11343b6b2a..0792c45c885 100644 --- a/Lib/test/test_support.py +++ b/Lib/test/test_support.py @@ -1112,10 +1112,6 @@ def requires_resource(resource): else: return unittest.skip("resource {0!r} is not enabled".format(resource)) -requires_docstrings = unittest.skipUnless( - sysconfig.get_config_var('WITH_DOC_STRINGS'), - "test requires docstrings") - def cpython_only(test): """ Decorator for tests only applicable on CPython. @@ -1193,6 +1189,16 @@ def run_unittest(*classes): suite.addTest(unittest.makeSuite(cls)) _run_suite(suite) +#======================================================================= +# Check for the presence of docstrings. + +HAVE_DOCSTRINGS = (check_impl_detail(cpython=False) or + sys.platform == 'win32' or + sysconfig.get_config_var('WITH_DOC_STRINGS')) + +requires_docstrings = unittest.skipUnless(HAVE_DOCSTRINGS, + "test requires docstrings") + #======================================================================= # doctest driver. diff --git a/Misc/NEWS b/Misc/NEWS index 243781dd481..cd166702228 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -674,6 +674,9 @@ Extension Modules Tests ----- +- Issue #17041: Fix testing when Python is configured with the + --without-doc-strings option. + - Issue #15539: Added regression tests for Tools/scripts/pindent.py. - Issue #15324: Fix regrtest parsing of --fromfile and --randomize options.