Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 23:21:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-133210: Fix test_pydoc in --without-doc-strings mode (#133271)

Browse source
This commit is contained in:
sobolevn 2025-05-02 13:12:24 +03:00 • committed by GitHub
parent a6ddd078d0
commit 4912b29166
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 60 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

38
Lib/test/test_pydoc/test_pydoc.py
View file

@ -1927,18 +1927,28 @@ def test_text_doc_routines_in_class(self, cls=pydocfodder.B):
self.assertIn(' | global_func(x, y) from test.test_pydoc.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_func_alias = global_func(x, y)', lines)
self.assertIn(' | global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines) self.assertIn(' | global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' | count(self, value, /) from builtins.list', lines) self.assertIn(' | count(self, value, /) from builtins.list', lines)
self.assertIn(' | list_count = count(self, value, /)', lines) self.assertIn(' | list_count = count(self, value, /)', lines)
self.assertIn(' | __repr__(self, /) from builtins.object', lines) self.assertIn(' | __repr__(self, /) from builtins.object', lines)
self.assertIn(' | object_repr = __repr__(self, /)', lines) self.assertIn(' | object_repr = __repr__(self, /)', lines)
else:
self.assertIn(' | count(self, object, /) from builtins.list', lines)
self.assertIn(' | list_count = count(self, object, /)', lines)
self.assertIn(' | __repr__(...) from builtins.object', lines)
self.assertIn(' | object_repr = __repr__(...)', lines)
lines = self.getsection(result, f' | Static methods {where}:', ' | ' + '-'*70) lines = self.getsection(result, f' | Static methods {where}:', ' | ' + '-'*70)
self.assertIn(' | A_classmethod_ref = A_classmethod(x) class method of test.test_pydoc.pydocfodder.A', lines) 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' 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(' | B_classmethod_ref = B_classmethod(x)' + note, lines)
self.assertIn(' | A_method_ref = A_method() method of test.test_pydoc.pydocfodder.A instance', lines) self.assertIn(' | A_method_ref = A_method() method of test.test_pydoc.pydocfodder.A instance', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' | get(key, default=None, /) method of builtins.dict 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) self.assertIn(' | dict_get = get(key, default=None, /) method of builtins.dict instance', lines)
else:
self.assertIn(' | get(...) method of builtins.dict instance', lines)
self.assertIn(' | dict_get = get(...) method of builtins.dict instance', lines)
lines = self.getsection(result, f' | Class methods {where}:', ' | ' + '-'*70) lines = self.getsection(result, f' | Class methods {where}:', ' | ' + '-'*70)
self.assertIn(' | B_classmethod(x)', lines) self.assertIn(' | B_classmethod(x)', lines)
@ -1957,10 +1967,16 @@ def test_html_doc_routines_in_class(self, cls=pydocfodder.B):
self.assertIn('global_func(x, y) from test.test_pydoc.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_func_alias = global_func(x, y)', lines)
self.assertIn('global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines) self.assertIn('global_func2_alias = global_func2(x, y) from test.test_pydoc.pydocfodder', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn('count(self, value, /) from builtins.list', lines) self.assertIn('count(self, value, /) from builtins.list', lines)
self.assertIn('list_count = count(self, value, /)', lines) self.assertIn('list_count = count(self, value, /)', lines)
self.assertIn('__repr__(self, /) from builtins.object', lines) self.assertIn('__repr__(self, /) from builtins.object', lines)
self.assertIn('object_repr = __repr__(self, /)', lines) self.assertIn('object_repr = __repr__(self, /)', lines)
else:
self.assertIn('count(self, object, /) from builtins.list', lines)
self.assertIn('list_count = count(self, object, /)', lines)
self.assertIn('__repr__(...) from builtins.object', lines)
self.assertIn('object_repr = __repr__(...)', lines)
lines = self.getsection(result, f'Static methods {where}:', '-'*70) lines = self.getsection(result, f'Static methods {where}:', '-'*70)
self.assertIn('A_classmethod_ref = A_classmethod(x) class method of test.test_pydoc.pydocfodder.A', lines) self.assertIn('A_classmethod_ref = A_classmethod(x) class method of test.test_pydoc.pydocfodder.A', lines)
@ -1997,15 +2013,27 @@ def test_text_doc_routines_in_module(self):
self.assertIn(' A_method3 = A_method() method of B instance', lines) self.assertIn(' A_method3 = A_method() method of B instance', lines)
self.assertIn(' A_staticmethod_ref = A_staticmethod(x, y)', lines) self.assertIn(' A_staticmethod_ref = A_staticmethod(x, y)', lines)
self.assertIn(' A_staticmethod_ref2 = A_staticmethod(y) method of B instance', lines) self.assertIn(' A_staticmethod_ref2 = A_staticmethod(y) method of B instance', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' get(key, default=None, /) method of builtins.dict 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) self.assertIn(' dict_get = get(key, default=None, /) method of builtins.dict instance', lines)
else:
self.assertIn(' get(...) method of builtins.dict instance', lines)
self.assertIn(' dict_get = get(...) method of builtins.dict instance', lines)
# unbound methods # unbound methods
self.assertIn(' B_method(self)', lines) self.assertIn(' B_method(self)', lines)
self.assertIn(' B_method2 = B_method(self)', lines) self.assertIn(' B_method2 = B_method(self)', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' count(self, value, /) unbound builtins.list method', lines) self.assertIn(' count(self, value, /) unbound builtins.list method', lines)
self.assertIn(' list_count = count(self, value, /) unbound builtins.list method', lines) self.assertIn(' list_count = count(self, value, /) unbound builtins.list method', lines)
self.assertIn(' __repr__(self, /) unbound builtins.object method', lines) self.assertIn(' __repr__(self, /) unbound builtins.object method', lines)
self.assertIn(' object_repr = __repr__(self, /) unbound builtins.object method', lines) self.assertIn(' object_repr = __repr__(self, /) unbound builtins.object method', lines)
else:
self.assertIn(' count(self, object, /) unbound builtins.list method', lines)
self.assertIn(' list_count = count(self, object, /) unbound builtins.list method', lines)
self.assertIn(' __repr__(...) unbound builtins.object method', lines)
self.assertIn(' object_repr = __repr__(...) unbound builtins.object method', lines)
def test_html_doc_routines_in_module(self): def test_html_doc_routines_in_module(self):
doc = pydoc.HTMLDoc() doc = pydoc.HTMLDoc()
@ -2026,15 +2054,25 @@ def test_html_doc_routines_in_module(self):
self.assertIn(' A_method3 = A_method() method of B instance', lines) self.assertIn(' A_method3 = A_method() method of B instance', lines)
self.assertIn(' A_staticmethod_ref = A_staticmethod(x, y)', lines) self.assertIn(' A_staticmethod_ref = A_staticmethod(x, y)', lines)
self.assertIn(' A_staticmethod_ref2 = A_staticmethod(y) method of B instance', lines) self.assertIn(' A_staticmethod_ref2 = A_staticmethod(y) method of B instance', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' get(key, default=None, /) method of builtins.dict 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) self.assertIn(' dict_get = get(key, default=None, /) method of builtins.dict instance', lines)
else:
self.assertIn(' get(...) method of builtins.dict instance', lines)
self.assertIn(' dict_get = get(...) method of builtins.dict instance', lines)
# unbound methods # unbound methods
self.assertIn(' B_method(self)', lines) self.assertIn(' B_method(self)', lines)
self.assertIn(' B_method2 = B_method(self)', lines) self.assertIn(' B_method2 = B_method(self)', lines)
if not support.MISSING_C_DOCSTRINGS:
self.assertIn(' count(self, value, /) unbound builtins.list method', lines) self.assertIn(' count(self, value, /) unbound builtins.list method', lines)
self.assertIn(' list_count = count(self, value, /) unbound builtins.list method', lines) self.assertIn(' list_count = count(self, value, /) unbound builtins.list method', lines)
self.assertIn(' __repr__(self, /) unbound builtins.object method', lines) self.assertIn(' __repr__(self, /) unbound builtins.object method', lines)
self.assertIn(' object_repr = __repr__(self, /) unbound builtins.object method', lines) self.assertIn(' object_repr = __repr__(self, /) unbound builtins.object method', lines)
else:
self.assertIn(' count(self, object, /) unbound builtins.list method', lines)
self.assertIn(' list_count = count(self, object, /) unbound builtins.list method', lines)
self.assertIn(' __repr__(...) unbound builtins.object method', lines)
self.assertIn(' object_repr = __repr__(...) unbound builtins.object method', lines)
@unittest.skipIf( @unittest.skipIf(