FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-81677: basic support for annotations in __text_signature__'s by skirpichev · Pull Request #101872 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-81677: basic support for annotations in __text_signature__'s - #101872

Closed
skirpichev wants to merge 27 commits into
python:mainfrom
skirpichev:text_sign_annot
ConversationCommits (27)ChecksFiles changed
Closed

gh-81677: basic support for annotations in __text_signature__'s#101872
skirpichev wants to merge 27 commits into
python:mainfrom
skirpichev:text_sign_annot

Conversation

skirpichev commented Feb 13, 2023 •
edited
Loading

Copy link
Copy Markdown
Member
  • add support for parsing annotations from __text_signature__ properties. Mostly naive and minimal implementation: there could be some validation of parsed annotations (e.g. to exclude something like print(1)).
    But I doubt, that this is required. In fact, probably the whole method could be refactored to do first parsing the program string, then do ast transformation (RewriteSymbolics) for defaults, then do ast.unparse(), eval its output and use _signature_from_function() helper to get the final result.
  • relax requirements for specification of text signatures in the PyDoc_STRVAR. Before - only ([<python-style parameter_list>]) was accepted. Now it permits everything till the end marker (\n--\n\n), that allows us to
    specify return annotations. (A first step to something like Support return annotation in signature for Argument Clinic #76120.)

This doesn't touch public interfaces: the __text_signature__ property left undocumented (but see #93865).

bedevere-bot mentioned this pull request Feb 13, 2023
Open
arhadthedev added interpreter-core (Objects, Python, Grammar, and Parser dirs) topic-typing labels Feb 13, 2023

skirpichev commented Mar 3, 2023

Copy link
Copy Markdown
Member Author

@sobolevn, maybe you could review this (at least the inspect part)?

sobolevn reviewed Mar 3, 2023
View reviewed changes

sobolevn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for working on this!

Couple of thoughts:

  1. Does anyone actually use __text_annotations__? (I am asking because I don't know). I assume people use it, is it a breaking change for them?
  2. How well does your solution support more complex annotations that require (a) typing imports, what we might need from there? (b) forward references and https://peps.python.org/pep-0649/

Other than that - I don't really have an opinion on this feature. Because I don't any real use-cases for it.

skirpichev commented Mar 3, 2023

Copy link
Copy Markdown
Member Author

Does anyone actually use __text_annotations__?

I can't find any example outside of the CPython, and it's not documented (as the __signature__ property, which is used, e.g. in the SymPy). There is an issue, which is more or less a feature request: #93865

Clearly, it might be useful for extensions.

I assume people use it, is it a breaking change for them?

No, I don't think so. Previously, the return annotation was just ignored and if there were parameter annotations - an exception was raised.

How well does your solution support more complex annotations that require (a) typing imports, what we might need from there? (b) forward references

This solution does assume application in the stdlib modules and simple extensions (e.g. I've tested this on the gmpy2), so
nothing fancy yet. If this does make sense at all (see the subject on a different approach) - then I'll think about extending
it to a more complex annotations.

Because I don't any real use-cases for it.

Any example of using __text_signature__ property in the stdlib. In most cases, however, this will require
support from the AC (not sure if this should be a part of this PR). But some functions/methods add now signatures
without using the AC, e.g. the math.gcd.

skirpichev mentioned this pull request Mar 5, 2023
Closed
messense mentioned this pull request Aug 17, 2023
Closed

skirpichev commented Sep 3, 2023

Copy link
Copy Markdown
Member Author

@1st1, you are listed as an expert for the inspect module. Maybe you could review this little pr?

LLukas22 mentioned this pull request Sep 9, 2023
Closed

skirpichev commented Oct 24, 2023

Copy link
Copy Markdown
Member Author

@vstinner, maybe you could review this? I would guess something like this should be a first step on solving #76120 (your issue). It seems some external projects already depend on this pr, so I would appreciate any feedback.

hauntsaninja reviewed Nov 10, 2023
View reviewed changes
Comment thread Lib/inspect.py Outdated
Comment thread Lib/inspect.py Outdated

skirpichev commented Jan 24, 2024

Copy link
Copy Markdown
Member Author

https://discuss.python.org/t/43914

hiaselhans mentioned this pull request Jan 26, 2024
Open
1 of 7 tasks

skirpichev commented Feb 20, 2024

Copy link
Copy Markdown
Member Author

PEP waiting for a sponsor: skirpichev/peps#2

skirpichev closed this Feb 20, 2024
skirpichev changed the title gh-81677: basic support for annotations in __text_signature__'s WIP: provide __signature__ attribute for builtins (Signature object built from the PEP 7-like "signature line") Feb 26, 2024
skirpichev changed the title WIP: provide __signature__ attribute for builtins (Signature object built from the PEP 7-like "signature line") gh-81677: WIP: provide __signature__ attribute for builtins (Signature object built from the PEP 7-like "signature line") Feb 26, 2024
skirpichev added 11 commits March 1, 2024 15:06
skirpichev changed the title gh-81677: WIP: provide __signature__ attribute for builtins (Signature object built from the PEP 7-like "signature line") gh-81677: basic support for annotations in __text_signature__'s Jul 19, 2024
skirpichev marked this pull request as ready for review July 19, 2024 06:45

skirpichev commented Jul 19, 2024

Copy link
Copy Markdown
Member Author

Ok, it seems nobody like to sponsor PEP, so I'm returning PR to initial shape (that address review). This is ready for review again.

skirpichev mentioned this pull request Jul 19, 2024
Closed

AA-Turner commented Jul 19, 2024

Copy link
Copy Markdown
Member

Ok, it seems nobody like to sponsor PEP

Have you posted the draft PEP on discuss.python.org? It may have been missed here...

A

skirpichev commented Jul 19, 2024

Copy link
Copy Markdown
Member Author

Have you posted the draft PEP on discuss.python.org? It may have been missed here...

Yes, that was posted in the thread, discussing this pr, there.

skirpichev requested a review from sobolevn January 27, 2026 08:19

skirpichev commented Jan 27, 2026

Copy link
Copy Markdown
Member Author

@sobolevn, let me know if it does make sense to keep this pr open.

skirpichev closed this Jan 30, 2026
skirpichev deleted the text_sign_annot branch January 30, 2026 04:16
coderabbitai Bot mentioned this pull request Aug 11, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

markshannon Awaiting requested review from markshannon markshannon is a code owner
hauntsaninja Awaiting requested review from hauntsaninja
sobolevn Awaiting requested review from sobolevn

Assignees

No one assigned

Labels

awaiting review interpreter-core (Objects, Python, Grammar, and Parser dirs) topic-typing

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Back | FazBrowse Home | New Git URL