mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 05:58:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

gh-101552: Allow pydoc to display signatures in source format (#124669)

Browse source 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
Jelle Zijlstra 2024-10-08 22:03:53 -07:00 • committed by GitHub
parent b502573f7f
commit 78406382c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 126 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1073,7 +1073,7 @@ class B(A)
class A(builtins.object)
| A(
| arg1: collections.abc.Callable[[int, int, int], str],
| arg1: Callable[[int, int, int], str],
| arg2: Literal['some value', 'other value'],
| arg3: Annotated[int, 'some docs about this type']
| ) -> None
@ -1082,7 +1082,7 @@ class A(builtins.object)
|
| __init__(
| self,
| arg1: collections.abc.Callable[[int, int, int], str],
| arg1: Callable[[int, int, int], str],
| arg2: Literal['some value', 'other value'],
| arg3: Annotated[int, 'some docs about this type']
| ) -> None
@ -1109,7 +1109,7 @@ class A(builtins.object)
self.assertEqual(doc, '''Python Library Documentation: function func in module %s
func(
arg1: collections.abc.Callable[[typing.Annotated[int, 'Some doc']], str],
arg1: Callable[[Annotated[int, 'Some doc']], str],
arg2: Literal[1, 2, 3, 4, 5, 6, 7, 8]
) -> Annotated[int, 'Some other']
''' % __name__)
@ -1394,8 +1394,8 @@ class TestDescriptions(unittest.TestCase):
T = typing.TypeVar('T')
class C(typing.Generic[T], typing.Mapping[int, str]): ...
self.assertEqual(pydoc.render_doc(foo).splitlines()[-1],
'f\x08fo\x08oo\x08o(data: List[Any], x: int)'
' -> Iterator[Tuple[int, Any]]')
'f\x08fo\x08oo\x08o(data: typing.List[typing.Any], x: int)'
' -> typing.Iterator[typing.Tuple[int, typing.Any]]')
self.assertEqual(pydoc.render_doc(C).splitlines()[2],
'class C\x08C(collections.abc.Mapping, typing.Generic)')