https://github.com/python/cpython/commit/2cf47389e26cb591342d07dad98619916d5a1b15
commit: 2cf47389e26cb591342d07dad98619916d5a1b15
branch: main
author: Serhiy Storchaka <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-06-18T12:19:32+03:00
summary:
gh-120590: Fix test_pydoc in the refleak hunting mode (GH-120615)
Mocking only works if sys.modules['pydoc'] and pydoc are the same,
but some pydoc functions reload the module and change sys.modules.
Ensure that sys.modules['pydoc'] is always restored after the corresponding
tests.
files:
M Lib/test/test_pydoc/test_pydoc.py
diff --git a/Lib/test/test_pydoc/test_pydoc.py
b/Lib/test/test_pydoc/test_pydoc.py
index b520cfd0b50e38..bffebf38e1f9b2 100644
--- a/Lib/test/test_pydoc/test_pydoc.py
+++ b/Lib/test/test_pydoc/test_pydoc.py
@@ -385,6 +385,11 @@ def html2text(html):
class PydocBaseTest(unittest.TestCase):
+ def tearDown(self):
+ # Self-testing. Mocking only works if sys.modules['pydoc'] and pydoc
+ # are the same. But some pydoc functions reload the module and change
+ # sys.modules, so check that it was restored.
+ self.assertIs(sys.modules['pydoc'], pydoc)
def _restricted_walk_packages(self, walk_packages, path=None):
"""
@@ -416,6 +421,8 @@ def call_url_handler(self, url, expected_title):
class PydocDocTest(unittest.TestCase):
maxDiff = None
+ def tearDown(self):
+ self.assertIs(sys.modules['pydoc'], pydoc)
@unittest.skipIf(hasattr(sys, 'gettrace') and sys.gettrace(),
'trace function introduces __locals__ unexpectedly')
@@ -1284,12 +1291,15 @@ def test_modules_search_builtin(self):
self.assertTrue(result.startswith(expected))
def test_importfile(self):
- loaded_pydoc = pydoc.importfile(pydoc.__file__)
+ try:
+ loaded_pydoc = pydoc.importfile(pydoc.__file__)
- self.assertIsNot(loaded_pydoc, pydoc)
- self.assertEqual(loaded_pydoc.__name__, 'pydoc')
- self.assertEqual(loaded_pydoc.__file__, pydoc.__file__)
- self.assertEqual(loaded_pydoc.__spec__, pydoc.__spec__)
+ self.assertIsNot(loaded_pydoc, pydoc)
+ self.assertEqual(loaded_pydoc.__name__, 'pydoc')
+ self.assertEqual(loaded_pydoc.__file__, pydoc.__file__)
+ self.assertEqual(loaded_pydoc.__spec__, pydoc.__spec__)
+ finally:
+ sys.modules['pydoc'] = pydoc
class Rect:
@@ -1304,6 +1314,8 @@ class Square(Rect):
class TestDescriptions(unittest.TestCase):
+ def tearDown(self):
+ self.assertIs(sys.modules['pydoc'], pydoc)
def test_module(self):
# Check that pydocfodder module can be described
@@ -1793,6 +1805,8 @@ def a_fn_with_https_link():
class PydocFodderTest(unittest.TestCase):
+ def tearDown(self):
+ self.assertIs(sys.modules['pydoc'], pydoc)
def getsection(self, text, beginline, endline):
lines = text.splitlines()
@@ -1932,6 +1946,8 @@ def test_html_doc_routines_in_module(self):
)
class PydocServerTest(unittest.TestCase):
"""Tests for pydoc._start_server"""
+ def tearDown(self):
+ self.assertIs(sys.modules['pydoc'], pydoc)
def test_server(self):
# Minimal test that starts the server, checks that it works, then stops
@@ -1994,9 +2010,14 @@ def test_url_requests(self):
("foobar", "Pydoc: Error - foobar"),
]
- with self.restrict_walk_packages():
- for url, title in requests:
- self.call_url_handler(url, title)
+ self.assertIs(sys.modules['pydoc'], pydoc)
+ try:
+ with self.restrict_walk_packages():
+ for url, title in requests:
+ self.call_url_handler(url, title)
+ finally:
+ # Some requests reload the module and change sys.modules.
+ sys.modules['pydoc'] = pydoc
class TestHelper(unittest.TestCase):
@@ -2006,6 +2027,9 @@ def test_keywords(self):
class PydocWithMetaClasses(unittest.TestCase):
+ def tearDown(self):
+ self.assertIs(sys.modules['pydoc'], pydoc)
+
@unittest.skipIf(hasattr(sys, 'gettrace') and sys.gettrace(),
'trace function introduces __locals__ unexpectedly')
@requires_docstrings
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
