gh-73536: Add support of multi-signatures #117671

serhiy-storchaka · 2024-04-09T09:55:51Z

Add inspect.MultiSignature which is a subclass of inspect.Signature.
Add inspect.signatures().
inspect.signature() can now return a multi-signature.
Support multi-signatures in pydoc.
Support multi-signatures in IDLE calltips.
Support multi-signatures in dataclasses docstrings.
Allow multiple @text_signature in Argument Clinic.
Add representable signatures for all builtin functions and methods of builtin classes except type() and super().

Issue: Add support of multiple signatures #73536

* Add inspect.MultiSignature which is a subclass of inspect.Signature. * Add inspect.signatures(). * inspect.signature() can now return a multi-signature. * Support multi-signatures in pydoc. * Support multi-signatures in IDLE calltips. * Support multi-signatures in dataclasses docstrings. * Allow multiple @text_signature in Argument Clinic. * Add representable signatures for all builtin functions and methods of builtin classes except type() and super().

Objects/memoryobject.c

Python/bltinmodule.c

Gouvernathor · 2024-04-10T23:31:07Z

Lib/inspect.py

@@ -2126,11 +2131,29 @@ def _signature_get_partial(wrapped_sig, partial, extra_args=()):
    return wrapped_sig.replace(parameters=new_params.values())


+def _multisignature_get_partial(wrapped_sig, partial, extra_args=()):
+    last_exc = None


Unless the case of the list being empty is handled elsewhere, this could result in a raise None. Maybe that None should instead be something like Exception("Empty MultiSignature list") ?

It is checked in the constructor. I think even about removing this assignment, NameError is clearer indication if something goes wrong.

Gouvernathor · 2024-04-10T23:35:28Z

Lib/inspect.py

+            return True
+        if isinstance(other, MultiSignature):
+            return self._signatures == other._signatures
+        if len(self._signatures) == 1 and isinstance(other, Signature):


I think this should be

Suggested change

if len(self._signatures) == 1 and isinstance(other, Signature):

if isinstance(other, Signature):

return len(self._signatures) == 1

and the addition to Signature's eq should be removed, above.

No, it is not correct, it would make a 1-element MultiSignature equal to any Signature.

You perhaps mistyped, I wrote more correct fix.

I did. That's good. (I would suggest removing the line about MultiSignature in Signature's eq as I believe it's dead code now, but up to you).

It is not dead. It is called in SignatureSubclass() == MultiSignature(). Although it is not covered by tests yet.

Gouvernathor · 2024-04-10T23:40:16Z

Lib/inspect.py

+        return '\n'.join(sig.format(max_width=max_width)
+                         for sig in self._signatures)
+
+
 def signature(obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False):
    """Get a signature object for the passed callable."""
    return Signature.from_callable(obj, follow_wrapped=follow_wrapped,


Given that the original Signature.from_callable is not changed and does the exact same call to _from_callable, that means both signature and Signature.from_callable may return a MultiSignature object, right ?

Strictly speaking this is not a violation of backwards compatibility as MultiSignature is a subclass of Signature, but I find it weird and it may break some strict-type behaviors. Is there a way to have those only return pure Signature objects, without breaking everything this update brings to the table ?

Yes, it is. The idea was that inspect.signature() will start to support previously not supported cases and return a MultiSignature which should be compatible with Signature. But now I am no longer sure. They are not so well compatible as I expected, and in most cases I needed to rewrite the code to explicitly handle MultiSignature. This is why I added inspect.signatures(). Now the code is in the intermediate state -- either MultiSignature will be made more compatible with Signature and inspect.signatures() may disappear, or they will became completely different things.

Python/bltinmodule.c

Objects/memoryobject.c

serhiy-storchaka · 2024-04-11T06:30:47Z

Lib/inspect.py

@@ -2126,11 +2131,29 @@ def _signature_get_partial(wrapped_sig, partial, extra_args=()):
    return wrapped_sig.replace(parameters=new_params.values())


+def _multisignature_get_partial(wrapped_sig, partial, extra_args=()):
+    last_exc = None


It is checked in the constructor. I think even about removing this assignment, NameError is clearer indication if something goes wrong.

Lib/inspect.py

serhiy-storchaka · 2024-04-11T06:36:27Z

Lib/inspect.py

+            return True
+        if isinstance(other, MultiSignature):
+            return self._signatures == other._signatures
+        if len(self._signatures) == 1 and isinstance(other, Signature):


No, it is not correct, it would make a 1-element MultiSignature equal to any Signature.

You perhaps mistyped, I wrote more correct fix.

serhiy-storchaka · 2024-04-11T06:44:58Z

Lib/inspect.py

+        return '\n'.join(sig.format(max_width=max_width)
+                         for sig in self._signatures)
+
+
 def signature(obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False):
    """Get a signature object for the passed callable."""
    return Signature.from_callable(obj, follow_wrapped=follow_wrapped,


Yes, it is. The idea was that inspect.signature() will start to support previously not supported cases and return a MultiSignature which should be compatible with Signature. But now I am no longer sure. They are not so well compatible as I expected, and in most cases I needed to rewrite the code to explicitly handle MultiSignature. This is why I added inspect.signatures(). Now the code is in the intermediate state -- either MultiSignature will be made more compatible with Signature and inspect.signatures() may disappear, or they will became completely different things.

…nd sys modules.

skirpichev · 2024-10-29T02:47:14Z

@serhiy-storchaka, now this again has conflicts with the main. I did pr serhiy-storchaka#22 that address this, hope it helps.

Are you thinking about writing a PEP as Petr suggested?

bedevere-app bot mentioned this pull request Apr 9, 2024

Add support of multiple signatures #73536

Open

erlend-aasland reviewed Apr 10, 2024

View reviewed changes

Objects/memoryobject.c Outdated Show resolved Hide resolved

Python/bltinmodule.c Outdated Show resolved Hide resolved

serhiy-storchaka added 2 commits April 10, 2024 16:27

Add tests and fix errors.

54db6d3

Fix signatures of hex() methods.

9bbde5f

Gouvernathor reviewed Apr 10, 2024

View reviewed changes

Refactor support of partial and partialmethod.

5c9ddb9

serhiy-storchaka commented Apr 11, 2024

View reviewed changes

serhiy-storchaka added 5 commits April 11, 2024 09:47

Update Lib/inspect.py

5e7ca6d

Remove old commented out code.

53bc04e

Add $module for builtin functions.

1a3536f

Tests signatures of methods. Fix more signatures in builtins, types a…

6ff7151

…nd sys modules.

Merge branch 'main' into wip-inspect-multi-signature

2ad265a

serhiy-storchaka mentioned this pull request Apr 11, 2024

Add more signatures for builtin functions and methods #117764

Closed

Merge branch 'main' into wip-inspect-multi-signature

57f3abf

serhiy-storchaka mentioned this pull request Jun 7, 2024

int.__round__(None) is not supported #120080

Closed

Merge branch 'main' into wip-inspect-multi-signature

2227748

skirpichev self-requested a review October 29, 2024 03:02

skirpichev mentioned this pull request Nov 6, 2024

gh-125897: Fix the range function refering to step as a kwarg #125945

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-73536: Add support of multi-signatures #117671

gh-73536: Add support of multi-signatures #117671

serhiy-storchaka commented Apr 9, 2024 •

edited by bedevere-app bot

Loading

Gouvernathor Apr 10, 2024 •

edited

Loading

serhiy-storchaka Apr 11, 2024

Gouvernathor Apr 11, 2024

Gouvernathor Apr 10, 2024

serhiy-storchaka Apr 11, 2024

Gouvernathor Apr 11, 2024

serhiy-storchaka Apr 11, 2024

Gouvernathor Apr 10, 2024

serhiy-storchaka Apr 11, 2024

serhiy-storchaka Apr 11, 2024

serhiy-storchaka Apr 11, 2024

serhiy-storchaka Apr 11, 2024

skirpichev commented Oct 29, 2024

	if len(self._signatures) == 1 and isinstance(other, Signature):
	if isinstance(other, Signature):
	return len(self._signatures) == 1

gh-73536: Add support of multi-signatures #117671

Are you sure you want to change the base?

gh-73536: Add support of multi-signatures #117671

Conversation

serhiy-storchaka commented Apr 9, 2024 • edited by bedevere-app bot Loading

Gouvernathor Apr 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skirpichev commented Oct 29, 2024

serhiy-storchaka commented Apr 9, 2024 •

edited by bedevere-app bot

Loading

Gouvernathor Apr 10, 2024 •

edited

Loading