-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Correctly parse and cross-reference unpacked type annotations #13369
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
Conversation
8d0b968 to
e326ad6
Compare
|
Given that this is the first PR after the release of v8.2.0, I'm not sure how to record it in |
I've now updated CHANGES for the 8.3 header. Sorry for the trouble. A |
0959703 to
20e8d33
Compare
|
Entry added to CHANGES. |
a9b2a27 to
0a874c2
Compare
| ), | ||
| ) | ||
|
|
||
| doctree = _parse_annotation('*tuple[str, int]', app.env) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is *tuple[...] a valid stand-alone type annotation? If not, should we have some validation that Starred only comes after [?
I'm happy to keep things as currently proposed in this PR, just unsure which is the best approach.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is valid in the context of variadic generics annotations (see https://peps.python.org/pep-0646/#unpacking-tuple-types). In other places it is not, but I worked this out under the assumption that Sphinx is looking to accept all valid Python behaviors, not disallow non-valid ones (that would be neat, but would probably imply reimplementing a huge part of the parser in any Python implementation).
With respect to what you are saying about validating it only comes after [: I came out with this PR to deal with annotations in type signatures in function arguments, not in type parameter specifications alla PEP 695. I am AFK and I don't remember off the top of my head if it does come into parsing the latter. I will look into it as soon as I can.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go with this for now, we can make changes later if need be. Thanks!
A
| ), | ||
| ) | ||
|
|
||
| doctree = _parse_annotation('*tuple[str, int]', app.env) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go with this for now, we can make changes later if need be. Thanks!
A
Closes #13368