Improve return type for socket.getaddrinfo for missing ipv6 support #13372
Conversation
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
This comment has been minimized.
This comment has been minimized.
srittau
requested changes
Jan 6, 2025
stdlib/socket.pyi
Outdated
Comment on lines
1402
to
1405
| # the 5th tuple item is an address | ||
| def getaddrinfo( | ||
| host: bytes | str | None, port: bytes | str | int | None, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0 | ||
| ) -> list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int]]]: ... | ||
| ) -> list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]]]: ... |
There was a problem hiding this comment.
Let's amend the comment to document this. Something along the lines of:
The 5th tuple item is the socket address, for IP4, IP6, or IP6 if Python is compiled with --disable-ipv6, respectively.
srittau
approved these changes
Jan 6, 2025
|
Diff from mypy_primer, showing the effect of this PR on open source code: mongo-python-driver (https://github.com/mongodb/mongo-python-driver)
+ pymongo/synchronous/auth.py:192: error: Argument 1 to "getnameinfo" has incompatible type "tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]"; expected "tuple[str, int] | tuple[str, int, int, int]" [arg-type]
+ pymongo/asynchronous/auth.py:195: error: Argument 1 to "getnameinfo" has incompatible type "tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]"; expected "tuple[str, int] | tuple[str, int, int, int]" [arg-type]
urllib3 (https://github.com/urllib3/urllib3)
+ test/contrib/test_socks.py:120: error: Incompatible return value type (got "list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes]]]", expected "list[tuple[AddressFamily, SocketKind, int, str, tuple[str, int] | tuple[str, int, int, int]]]") [return-value]
trio (https://github.com/python-trio/trio)
+ src/trio/_socket.py:215: error: Incompatible return value type (got "list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int], tuple[int, bytes]]]]", expected "list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int]]]]") [return-value]
+ src/trio/_socket.py:244: error: Argument 1 to "to_thread_run_sync" has incompatible type "Callable[[Union[bytes, str, None], Union[bytes, str, int, None], int, int, int, int], list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int], tuple[int, bytes]]]]]"; expected "Callable[..., list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int]]]]]" [arg-type]
+ src/trio/_tests/test_socket.py:130: error: Argument 1 to "MonkeypatchedGAI" has incompatible type "Callable[[Union[bytes, str, None], Union[bytes, str, int, None], int, int, int, int], list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int], tuple[int, bytes]]]]]"; expected "Callable[[Union[str, bytes, None], Union[str, bytes, int, None], int, int, int, int], list[tuple[AddressFamily, SocketKind, int, str, Union[tuple[str, int], tuple[str, int, int, int]]]]]" [arg-type]
|
tjstum
added a commit
to tjstum/trio
that referenced
this pull request
Feb 5, 2025
In python/typeshed#13372, the type of the stdlib's `socket.getaddrinfo` was updated to add a union member for cases where Python was compiled with `--disable-ipv6`. This causes custom resolvers that use the stdlib function to fail mypy This is probably going to (mypy) break everyone's custom `HostnameResolver`, since the parent type is changing
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.
Closes #13344