Fix typing issues around Range/RangeValue #1196
Open
Conversation
This file contains 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
bryanforbes
reviewed
Oct 21, 2024
asyncpg/types.py
Outdated
| @@ -63,10 +63,10 @@ class _RangeValue(typing.Protocol): | |||
| def __eq__(self, __value: object) -> bool: | |||
| ... | |||
|
|
|||
| def __lt__(self, __other: _RangeValue) -> bool: | |||
| def __lt__(self: _RV, __other: _RV) -> bool: | |||
There was a problem hiding this comment.
I believe def __lt__(self, __other: Self) -> bool: should work
There was a problem hiding this comment.
Unfortunately it does not- I tried that first and settled on what was submitted to get it all working. Here's the output with your suggestion (made to both __lt__ and __gt__):
% pyright tests/test_types.py
/Users/dmcgee/projects/sbl/asyncpg/tests/test_types.py
/Users/dmcgee/projects/sbl/asyncpg/tests/test_types.py:18:25 - error: Argument of type "Literal[1]" cannot be assigned to parameter "lower" of type "_RV@Range | None" in function "__init__"
Type "Literal[1]" is not assignable to type "_RV@Range | None"
Type "Literal[1]" is not assignable to type "_RangeValue"
"Literal[1]" is incompatible with protocol "_RangeValue"
"__lt__" is an incompatible type
Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__lt__, /) -> bool"
"__gt__" is an incompatible type
Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__gt__, /) -> bool"
"Literal[1]" is not assignable to "None" (reportArgumentType)
There was a problem hiding this comment.
Suggested change
| def __lt__(self: _RV, __other: _RV) -> bool: | |
| def __lt__(self, __other: Self, /) -> bool: |
This will fix it, checked locally with pyright as well.
See typeshed which has the definition of int.__lt__ that pyright (correctly) consider to not be compatible with _RangeValue.__lt__:
https://github.com/python/typeshed/blob/ca65e087f1f9dfc28e89192b60ce7cfc2e92c674/stdlib/builtins.pyi#L321
DanielNoord
suggested changes
Oct 22, 2024
asyncpg/types.py
Outdated
| @@ -63,10 +63,10 @@ class _RangeValue(typing.Protocol): | |||
| def __eq__(self, __value: object) -> bool: | |||
| ... | |||
|
|
|||
| def __lt__(self, __other: _RangeValue) -> bool: | |||
| def __lt__(self: _RV, __other: _RV) -> bool: | |||
There was a problem hiding this comment.
Suggested change
| def __lt__(self: _RV, __other: _RV) -> bool: | |
| def __lt__(self, __other: Self, /) -> bool: |
This will fix it, checked locally with pyright as well.
See typeshed which has the definition of int.__lt__ that pyright (correctly) consider to not be compatible with _RangeValue.__lt__:
https://github.com/python/typeshed/blob/ca65e087f1f9dfc28e89192b60ce7cfc2e92c674/stdlib/builtins.pyi#L321
In order for the `_RangeValue` protocol to type check properly, it needs to reference `Self`, not itself. Both pyright and mypy show a ton of errors when type checking this before these changes. (I've omitted non-relevant errors here): ``` % pyright tests/test_types.py /Users/dmcgee/projects/sbl/asyncpg/tests/test_types.py /Users/dmcgee/projects/sbl/asyncpg/tests/test_types.py:18:25 - error: Argument of type "Literal[1]" cannot be assigned to parameter "lower" of type "_RV@Range | None" in function "__init__" Type "Literal[1]" is not assignable to type "_RV@Range | None" Type "Literal[1]" is not assignable to type "_RangeValue" "Literal[1]" is incompatible with protocol "_RangeValue" "__lt__" is an incompatible type Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__lt__, /) -> bool" "__gt__" is an incompatible type Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__gt__, /) -> bool" "Literal[1]" is not assignable to "None" (reportArgumentType) /Users/dmcgee/projects/sbl/asyncpg/tests/test_types.py:18:34 - error: Argument of type "Literal[5]" cannot be assigned to parameter "upper" of type "_RV@Range | None" in function "__init__" Type "Literal[5]" is not assignable to type "_RV@Range | None" Type "Literal[5]" is not assignable to type "_RangeValue" "Literal[5]" is incompatible with protocol "_RangeValue" "__lt__" is an incompatible type Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__lt__, /) -> bool" "__gt__" is an incompatible type Type "(value: int, /) -> bool" is not assignable to type "(__other: _RV@__gt__, /) -> bool" "Literal[5]" is not assignable to "None" (reportArgumentType) ... % mypy tests/test_types.py | grep arg-type tests/test_types.py:18: error: Argument "lower" to "Range" has incompatible type "int"; expected "None" [arg-type] tests/test_types.py:18: error: Argument "upper" to "Range" has incompatible type "int"; expected "None" [arg-type] ... (19 more errors) ``` After this change, the type checking comes back clean: ``` % pyright tests/test_types.py 0 errors, 0 warnings, 0 informations % mypy tests/test_types.py | grep arg-type <no output> ```
toofishes
force-pushed
the
fix-range-typing
branch
from
e00885a
to
80502bf
Compare
|
Great suggestion - I made the update. I also verified that this works for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm glad to see some type hints were added in 0.30.0! I tried them out, and encountered a minor issue.
In order for the
_RangeValueprotocol to type check properly, it needs to reference the createdTypeVar, not itself.Both pyright and mypy show a ton of errors when type checking this before these changes. (I've omitted non-relevant errors here):
After this change, the type checking comes back clean:
This slight change appears to match what was expected when
bound=was implemented: python/typing#59 (comment)