From 9d0add0c7e513a92ee4321aa5be70121c4c1e1e7 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sun, 27 Jan 2013 19:47:45 +0200 Subject: [PATCH] Issue #17041: Fix testing when Python is configured with the --without-doc-strings. --- Lib/ctypes/test/test_win32.py | 5 ++- Lib/distutils/tests/test_build_ext.py | 5 +-- Lib/test/support.py | 10 ++++++ Lib/test/test_bytes.py | 1 + Lib/test/test_functools.py | 1 + Lib/test/test_pydoc.py | 49 +++++++++++++++++---------- Misc/NEWS | 3 ++ 7 files changed, 54 insertions(+), 20 deletions(-) diff --git a/Lib/ctypes/test/test_win32.py b/Lib/ctypes/test/test_win32.py index 2534a748cd9..7e6fe3fba03 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 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 090eacfb2c3..065a6a21c99 100644 --- a/Lib/distutils/tests/test_build_ext.py +++ b/Lib/distutils/tests/test_build_ext.py @@ -73,8 +73,9 @@ class BuildExtTestCase(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 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/support.py b/Lib/test/support.py index 2130fd639c9..66ddf4b0fde 100644 --- a/Lib/test/support.py +++ b/Lib/test/support.py @@ -1477,6 +1477,16 @@ def run_unittest(*classes): _filter_suite(suite, case_pred) _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/Lib/test/test_bytes.py b/Lib/test/test_bytes.py index 89e22740fc6..ba40915f3e3 100644 --- a/Lib/test/test_bytes.py +++ b/Lib/test/test_bytes.py @@ -986,6 +986,7 @@ class AssortedBytesTest(unittest.TestCase): self.assertEqual(bytes(b"abc") < b"ab", False) self.assertEqual(bytes(b"abc") <= b"ab", False) + @test.support.requires_docstrings def test_doc(self): self.assertIsNotNone(bytearray.__doc__) self.assertTrue(bytearray.__doc__.startswith("bytearray("), bytearray.__doc__) diff --git a/Lib/test/test_functools.py b/Lib/test/test_functools.py index 270cab00756..10868f3d154 100644 --- a/Lib/test/test_functools.py +++ b/Lib/test/test_functools.py @@ -287,6 +287,7 @@ class TestUpdateWrapper(unittest.TestCase): with self.assertRaises(AttributeError): functools.update_wrapper(wrapper, f, assign, update) + @support.requires_docstrings @unittest.skipIf(sys.flags.optimize >= 2, "Docstrings are omitted with -O2 and above") def test_builtin_update(self): diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py index c5a8e983568..c7318ff613e 100644 --- a/Lib/test/test_pydoc.py +++ b/Lib/test/test_pydoc.py @@ -30,6 +30,14 @@ except ImportError: if hasattr(pydoc_mod, "__loader__"): del pydoc_mod.__loader__ +if test.support.HAVE_DOCSTRINGS: + expected_data_docstrings = ( + 'dictionary for instance variables (if defined)', + 'list of weak references to the object (if defined)', + ) * 2 +else: + expected_data_docstrings = ('', '', '', '') + expected_text_pattern = """ NAME test.pydoc_mod - This is a test module for test_pydoc @@ -50,20 +58,16 @@ CLASSES | ---------------------------------------------------------------------- | 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\x20\x20 class B(builtins.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: @@ -95,6 +99,9 @@ FILE %s """.strip() +expected_text_data_docstrings = tuple('\n | ' + s if s else '' + for s in expected_data_docstrings) + expected_html_pattern = """ @@ -134,10 +141,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

@@ -148,10 +155,10 @@ Data descriptors defined here:
     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:
@@ -193,6 +200,8 @@ war 		Nobody
""".strip() # ' <- emacs turd +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'" @@ -262,7 +271,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") @@ -271,8 +282,10 @@ 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 % \ - (doc_loc, inspect.getabsfile(pydoc_mod)) + expected_text = expected_text_pattern % ( + (doc_loc,) + + expected_text_data_docstrings + + (inspect.getabsfile(pydoc_mod),)) if result != expected_text: print_diffs(expected_text, result) self.fail("outputs are not equal, see diff above") @@ -346,8 +359,10 @@ class PydocDocTest(unittest.TestCase): captured_output('stderr') as err: helper.help(module) result = buf.getvalue().strip() - expected_text = expected_help_pattern % \ - (doc_loc, inspect.getabsfile(pydoc_mod)) + expected_text = expected_help_pattern % ( + (doc_loc,) + + expected_text_data_docstrings + + (inspect.getabsfile(pydoc_mod),)) self.assertEqual('', output.getvalue()) self.assertEqual('', err.getvalue()) self.assertEqual(expected_text, result) diff --git a/Misc/NEWS b/Misc/NEWS index 3543feb2e56..daca4d37e5d 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -811,6 +811,9 @@ Extension Modules Tests ----- +- Issue #17041: Fix testing when Python is configured with the + --without-doc-strings. + - Issue #15539: Added regression tests for Tools/scripts/pindent.py. - Issue #15324: Fix regrtest parsing of --fromfile, --match, and --randomize