Skip to content

Commit

Permalink
bpo-40897:Give priority to using the current class constructor in `in…
Browse files Browse the repository at this point in the history
…spect.signature` (GH-27177) (GH-27209)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 6aab5f9)

Co-authored-by: Weipeng Hong <hongweichen8888@sina.com>
  • Loading branch information
miss-islington and hongweipeng committed Jul 17, 2021
1 parent ed2db9b commit df7c629
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 8 deletions.
24 changes: 16 additions & 8 deletions Lib/inspect.py
Expand Up @@ -2341,15 +2341,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
Expand Up @@ -2958,6 +2958,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
@@ -0,0 +1,2 @@
Give priority to using the current class constructor in
:func:`inspect.signature`. Patch by Weipeng Hong.

0 comments on commit df7c629

Please sign in to comment.