summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNikita Sobolev <mail@sobolevn.me>2024-02-15 13:35:56 (GMT)
committerGitHub <noreply@github.com>2024-02-15 13:35:56 (GMT)
commit9bc32cdc363dfa00293917be3d694df8fa7f7007 (patch)
tree74d091354d495e17b68f1e26f91002e428a18d80
parent0e4f73b8e457b1efa57b735205e8e85a3d11d9f2 (diff)
downloadcpython-9bc32cdc363dfa00293917be3d694df8fa7f7007.zip
cpython-9bc32cdc363dfa00293917be3d694df8fa7f7007.tar.gz
cpython-9bc32cdc363dfa00293917be3d694df8fa7f7007.tar.bz2
[3.12] gh-108303: Move all `pydoc` related files to `test_pydoc` (GH-114506) (#115502)
(cherry picked from commit ccc76c3e88647e416184bb1f5210b4e8946ae358)
-rwxr-xr-xLib/pydoc.py2
-rw-r--r--Lib/test/libregrtest/findtests.py1
-rw-r--r--Lib/test/test_pydoc/__init__.py6
-rw-r--r--Lib/test/test_pydoc/pydoc_mod.py (renamed from Lib/test/pydoc_mod.py)0
-rw-r--r--Lib/test/test_pydoc/pydocfodder.py (renamed from Lib/test/pydocfodder.py)0
-rw-r--r--Lib/test/test_pydoc/test_pydoc.py (renamed from Lib/test/test_pydoc.py)47
-rw-r--r--Makefile.pre.in1
7 files changed, 32 insertions, 25 deletions
diff --git a/Lib/pydoc.py b/Lib/pydoc.py
index 63b4e74..e770b29 100755
--- a/Lib/pydoc.py
+++ b/Lib/pydoc.py
@@ -529,7 +529,7 @@ class Doc:
'_thread', 'zipimport') or
(file.startswith(basedir) and
not file.startswith(os.path.join(basedir, 'site-packages')))) and
- object.__name__ not in ('xml.etree', 'test.pydoc_mod')):
+ object.__name__ not in ('xml.etree', 'test.test_pydoc.pydoc_mod')):
if docloc.startswith(("http://", "https://")):
docloc = "{}/{}.html".format(docloc.rstrip("/"), object.__name__.lower())
else:
diff --git a/Lib/test/libregrtest/findtests.py b/Lib/test/libregrtest/findtests.py
index ee890b5..4ac95e2 100644
--- a/Lib/test/libregrtest/findtests.py
+++ b/Lib/test/libregrtest/findtests.py
@@ -23,6 +23,7 @@ SPLITTESTDIRS: set[TestName] = {
"test_future_stmt",
"test_gdb",
"test_inspect",
+ "test_pydoc",
"test_multiprocessing_fork",
"test_multiprocessing_forkserver",
"test_multiprocessing_spawn",
diff --git a/Lib/test/test_pydoc/__init__.py b/Lib/test/test_pydoc/__init__.py
new file mode 100644
index 0000000..f2a39a3
--- /dev/null
+++ b/Lib/test/test_pydoc/__init__.py
@@ -0,0 +1,6 @@
+import os
+from test import support
+
+
+def load_tests(*args):
+ return support.load_package_tests(os.path.dirname(__file__), *args)
diff --git a/Lib/test/pydoc_mod.py b/Lib/test/test_pydoc/pydoc_mod.py
index 80c287f..80c287f 100644
--- a/Lib/test/pydoc_mod.py
+++ b/Lib/test/test_pydoc/pydoc_mod.py
diff --git a/Lib/test/pydocfodder.py b/Lib/test/test_pydoc/pydocfodder.py
index 27037e0..27037e0 100644
--- a/Lib/test/pydocfodder.py
+++ b/Lib/test/test_pydoc/pydocfodder.py
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc/test_pydoc.py
index 87cd6d5..b1aa967 100644
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc/test_pydoc.py
@@ -32,8 +32,8 @@ from test.support import (reap_children, captured_output, captured_stdout,
captured_stderr, is_emscripten, is_wasi,
requires_docstrings, MISSING_C_DOCSTRINGS)
from test.support.os_helper import (TESTFN, rmtree, unlink)
-from test import pydoc_mod
-from test import pydocfodder
+from test.test_pydoc import pydoc_mod
+from test.test_pydoc import pydocfodder
class nonascii:
@@ -50,7 +50,7 @@ else:
expected_text_pattern = """
NAME
- test.pydoc_mod - This is a test module for test_pydoc
+ test.test_pydoc.pydoc_mod - This is a test module for test_pydoc
%s
CLASSES
builtins.object
@@ -123,7 +123,7 @@ FUNCTIONS
DATA
__xyz__ = 'X, Y and Z'
- c_alias = test.pydoc_mod.C[int]
+ c_alias = test.test_pydoc.pydoc_mod.C[int]
list_alias1 = typing.List[int]
list_alias2 = list[int]
type_union1 = typing.Union[int, str]
@@ -146,7 +146,7 @@ expected_text_data_docstrings = tuple('\n | ' + s if s else ''
for s in expected_data_docstrings)
html2text_of_expected = """
-test.pydoc_mod (version 1.2.3.4)
+test.test_pydoc.pydoc_mod (version 1.2.3.4)
This is a test module for test_pydoc
Modules
@@ -211,7 +211,7 @@ Functions
Data
__xyz__ = 'X, Y and Z'
- c_alias = test.pydoc_mod.C[int]
+ c_alias = test.test_pydoc.pydoc_mod.C[int]
list_alias1 = typing.List[int]
list_alias2 = list[int]
type_union1 = typing.Union[int, str]
@@ -340,7 +340,7 @@ def get_pydoc_link(module):
"Returns a documentation web link of a module"
abspath = os.path.abspath
dirname = os.path.dirname
- basedir = dirname(dirname(abspath(__file__)))
+ basedir = dirname(dirname(dirname(abspath(__file__))))
doc = pydoc.TextDoc()
loc = doc.getdocloc(module, basedir=basedir)
return loc
@@ -487,7 +487,7 @@ class PydocDocTest(unittest.TestCase):
@requires_docstrings
def test_not_ascii(self):
- result = run_pydoc('test.test_pydoc.nonascii', PYTHONIOENCODING='ascii')
+ result = run_pydoc('test.test_pydoc.test_pydoc.nonascii', PYTHONIOENCODING='ascii')
encoded = nonascii.__doc__.encode('ascii', 'backslashreplace')
self.assertIn(encoded, result)
@@ -667,9 +667,9 @@ class PydocDocTest(unittest.TestCase):
buf = StringIO()
helper = pydoc.Helper(output=buf)
unused, doc_loc = get_pydoc_text(pydoc_mod)
- module = "test.pydoc_mod"
+ module = "test.test_pydoc.pydoc_mod"
help_header = """
- Help on module test.pydoc_mod in test:
+ Help on module test.test_pydoc.pydoc_mod in test.test_pydoc:
""".lstrip()
help_header = textwrap.dedent(help_header)
@@ -1050,7 +1050,6 @@ 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)
@@ -1229,7 +1228,7 @@ sm(x, y)
'cm(...)\n'
' A class method\n')
self.assertEqual(self._get_summary_lines(X.cm), """\
-cm(x) class method of test.test_pydoc.X
+cm(x) class method of test.test_pydoc.test_pydoc.X
A class method
""")
self.assertIn("""
@@ -1411,19 +1410,19 @@ class PydocFodderTest(unittest.TestCase):
lines = self.getsection(result, f' | Methods {where}:', ' | ' + '-'*70)
self.assertIn(' | A_method_alias = A_method(self)', lines)
self.assertIn(' | B_method_alias = B_method(self)', lines)
- self.assertIn(' | A_staticmethod(x, y) from test.pydocfodder.A', lines)
+ self.assertIn(' | A_staticmethod(x, y) from test.test_pydoc.pydocfodder.A', lines)
self.assertIn(' | A_staticmethod_alias = A_staticmethod(x, y)', lines)
- self.assertIn(' | global_func(x, y) from test.pydocfodder', lines)
+ self.assertIn(' | global_func(x, y) from test.test_pydoc.pydocfodder', lines)
self.assertIn(' | global_func_alias = global_func(x, y)', lines)
- self.assertIn(' | global_func2_alias = global_func2(x, y) from test.pydocfodder', lines)
+ self.assertIn(' | global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines)
self.assertIn(' | __repr__(self, /) from builtins.object', lines)
self.assertIn(' | object_repr = __repr__(self, /)', lines)
lines = self.getsection(result, f' | Static methods {where}:', ' | ' + '-'*70)
- self.assertIn(' | A_classmethod_ref = A_classmethod(x) class method of test.pydocfodder.A', lines)
- note = '' if cls is pydocfodder.B else ' class method of test.pydocfodder.B'
+ self.assertIn(' | A_classmethod_ref = A_classmethod(x) class method of test.test_pydoc.pydocfodder.A', lines)
+ note = '' if cls is pydocfodder.B else ' class method of test.test_pydoc.pydocfodder.B'
self.assertIn(' | B_classmethod_ref = B_classmethod(x)' + note, lines)
- self.assertIn(' | A_method_ref = A_method() method of test.pydocfodder.A instance', lines)
+ self.assertIn(' | A_method_ref = A_method() method of test.test_pydoc.pydocfodder.A instance', lines)
self.assertIn(' | get(key, default=None, /) method of builtins.dict instance', lines)
self.assertIn(' | dict_get = get(key, default=None, /) method of builtins.dict instance', lines)
@@ -1439,19 +1438,19 @@ class PydocFodderTest(unittest.TestCase):
lines = self.getsection(result, f'Methods {where}:', '-'*70)
self.assertIn('A_method_alias = A_method(self)', lines)
self.assertIn('B_method_alias = B_method(self)', lines)
- self.assertIn('A_staticmethod(x, y) from test.pydocfodder.A', lines)
+ self.assertIn('A_staticmethod(x, y) from test.test_pydoc.pydocfodder.A', lines)
self.assertIn('A_staticmethod_alias = A_staticmethod(x, y)', lines)
- self.assertIn('global_func(x, y) from test.pydocfodder', lines)
+ self.assertIn('global_func(x, y) from test.test_pydoc.pydocfodder', lines)
self.assertIn('global_func_alias = global_func(x, y)', lines)
- self.assertIn('global_func2_alias = global_func2(x, y) from test.pydocfodder', lines)
+ self.assertIn('global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines)
self.assertIn('__repr__(self, /) from builtins.object', lines)
self.assertIn('object_repr = __repr__(self, /)', lines)
lines = self.getsection(result, f'Static methods {where}:', '-'*70)
- self.assertIn('A_classmethod_ref = A_classmethod(x) class method of test.pydocfodder.A', lines)
- note = '' if cls is pydocfodder.B else ' class method of test.pydocfodder.B'
+ self.assertIn('A_classmethod_ref = A_classmethod(x) class method of test.test_pydoc.pydocfodder.A', lines)
+ note = '' if cls is pydocfodder.B else ' class method of test.test_pydoc.pydocfodder.B'
self.assertIn('B_classmethod_ref = B_classmethod(x)' + note, lines)
- self.assertIn('A_method_ref = A_method() method of test.pydocfodder.A instance', lines)
+ self.assertIn('A_method_ref = A_method() method of test.test_pydoc.pydocfodder.A instance', lines)
lines = self.getsection(result, f'Class methods {where}:', '-'*70)
self.assertIn('B_classmethod(x)', lines)
diff --git a/Makefile.pre.in b/Makefile.pre.in
index dd5e69f..f676035 100644
--- a/Makefile.pre.in
+++ b/Makefile.pre.in
@@ -2208,6 +2208,7 @@ TESTSUBDIRS= idlelib/idle_test \
test/test_lib2to3/data/fixers/myfixes \
test/test_module \
test/test_peg_generator \
+ test/test_pydoc \
test/test_sqlite3 \
test/test_tkinter \
test/test_tomllib \