8000 bpo-40897:Give priority to using the current class constructor in `inspect.signature` by hongweipeng · Pull Request #27177 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

bpo-40897:Give priority to using the current class constructor in inspect.signature #27177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions Lib/inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -2444,15 +2444,23 @@ def _signature_from_callable(obj, *,
if call is not None:
sig = _get_signature_of(call)
else:
# Now we check if the 'obj' class has a '__new__' method
factory_method = None
new = _signature_get_user_defined_method(obj, '__new__')
if new is not None:
sig = _get_signature_of(new)
else:
# Finally, we should have at least __init__ implemented
init = _signature_get_user_defined_method(obj, '__init__')
if init is not None:
sig = _get_signature_of(init)
init = _signature_get_user_defined_method(obj, '__init__')
# Now we check if the 'obj' class has an own '__new__' method
if '__new__' in obj.__dict__:
factory_method = new
# or an own '__init__' method
elif '__init__' in obj.__dict__:
factory_method = init
# If not, we take inherited '__new__' or '__init__', if present
elif new is not None:
factory_method = new
elif init is not None:
factory_method = init

if factory_method is not None:
sig = _get_signature_of(factory_method)

if sig is None:
# At this point we know, that `obj` is a class, with no user-
Expand Down
41 changes: 41 additions & 0 deletions Lib/test/test_inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -3063,6 +3063,47 @@ def __init__(self, b):
('bar', 2, ..., "keyword_only")),
...))

def test_signature_on_subclass(self):
class A:
def __new__(cls, a=1, *args, **kwargs):
return object.__new__(cls)
class B(A):
def __init__(self, b):
pass
class C(A):
def __new__(cls, a=1, b=2, *args, **kwargs):
return object.__new__(cls)
class D(A):
pass

self.assertEqual(self.signature(B),
((('b', ..., ..., "positional_or_keyword"),),
...))
self.assertEqual(self.signature(C),
((('a', 1, ..., 'positional_or_keyword'),
('b', 2, ..., 'positional_or_keyword'),
('args', ..., ..., 'var_positional'),
('kwargs', ..., ..., 'var_keyword')),
...))
self.assertEqual(self.signature(D),
((('a', 1, ..., 'positional_or_keyword'),
('args', ..., ..., 'var_positional'),
('kwargs', ..., ..., 'var_keyword')),
...))

def test_signature_on_generic_subclass(self):
from typing import Generic, TypeVar

T = TypeVar('T')

class A(Generic[T]):
def __init__(self, *, a: int) -> None:
pass

self.assertEqual(self.signature(A),
((('a', ..., int, 'keyword_only'),),
None))

@unittest.skipIf(MISSING_C_DOCSTRINGS,
"Signature information for builtins requires docstrings")
def test_signature_on_class_without_init(self):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Give priority to using the current class constructor in
:func:`inspect.signature`. Patch by Weipeng Hong.
0