[docker-py] Add some missing types #15084
Open
+127
−25
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
- `Container` - `ContainerCollection` - `ExecApiMixin`
This comment has been minimized.
This comment has been minimized.
srittau
requested changes
Nov 26, 2025
stubs/docker/docker/api/exec_api.pyi
Outdated
| ): ... | ||
| self, | ||
| exec_id: str, | ||
| detach: Literal[True] = ..., |
Collaborator
There was a problem hiding this comment.
This wouldn't work, since it would also match if detach is left out (meaning it's False):
Suggested change
| detach: Literal[True] = ..., | |
| detach: Literal[True], |
Comment on lines
36
to
45
| @overload | ||
| def exec_start( | ||
| self, | ||
| exec_id: str, | ||
| detach: Literal[False] = False, | ||
| tty: bool = False, | ||
| stream: bool = False, | ||
| socket: Literal[True] = ..., | ||
| demux: bool = False, | ||
| ) -> SocketIO | _BufferedReaderStream | SSHSocket: ... |
Collaborator
There was a problem hiding this comment.
Same is true for the socket argument here. Unfortunately, we can't just remove the default as that would cause a syntax error. So we can to split this overload into two:
Suggested change
| @overload | |
| def exec_start( | |
| self, | |
| exec_id: str, | |
| detach: Literal[False] = False, | |
| tty: bool = False, | |
| stream: bool = False, | |
| socket: Literal[True] = ..., | |
| demux: bool = False, | |
| ) -> SocketIO | _BufferedReaderStream | SSHSocket: ... | |
| @overload | |
| def exec_start( | |
| self, | |
| exec_id: str, | |
| detach: Literal[False], | |
| tty: bool, | |
| stream: bool, | |
| socket: Literal[True], | |
| demux: bool = False, | |
| ) -> SocketIO | _BufferedReaderStream | SSHSocket: ... | |
| @overload | |
| def exec_start( | |
| self, | |
| exec_id: str, | |
| detach: Literal[False] = False, | |
| tty: bool = False, | |
| stream: bool = False, | |
| *, | |
| socket: Literal[True], | |
| demux: bool = False, | |
| ) -> SocketIO | _BufferedReaderStream | SSHSocket: ... |
The same for the other overloads using a ... default below. I won't be pretty.
Contributor
Author
|
Thank you for your hints @srittau. I think that overloads work properly now |
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add missing types for the methods of the following classes:
ContainerContainerCollectionExecApiMixinReferences: