Skip to content
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

gh-104050: Argument clinic: improve typing around adding C converters #107209

Merged
merged 1 commit into from
Jul 25, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Jul 24, 2023

Some of this looks a little complicated at first glance, but it's hopefully not too hard to grok

Comment on lines +2651 to +2656
CConverterClassT = TypeVar("CConverterClassT", bound=type["CConverter"])

def add_c_converter(
f: type[CConverter],
f: CConverterClassT,
name: str | None = None
) -> type[CConverter]:
) -> CConverterClassT:
Copy link
Member Author

@AlexWaygood AlexWaygood Jul 24, 2023

Choose a reason for hiding this comment

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

By using a TypeVar here (and with the other functions in this PR), we can make the annotation much more expressive.

The annotation currently says "you put in an object f that's some subtype of type[CConverter], and you get out an object that's some subtype of type[CConverter].

The new annotation, by contrast, says, "you put in an object f, and you get out an object that has the same type as whatever the type of f is, as long as the type of f is a subtype of type[CConverter].

Copy link
Member Author

Choose a reason for hiding this comment

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

As an example, with the following snippet:

x = add_c_converter(bool_converter)

Mypy would have inferred the type of x to be type[CConverter] with the current annotation. But with the new annotation, mypy should be able to infer that the type of x is bool_converter.

Copy link
Contributor

Choose a reason for hiding this comment

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

Neat!

Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

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

Thanks!

@AlexWaygood AlexWaygood merged commit dbfe738 into python:main Jul 25, 2023
@AlexWaygood AlexWaygood deleted the add-converter-typing branch July 25, 2023 08:18
jtcave pushed a commit to jtcave/cpython that referenced this pull request Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants