[docker-py] Fix Container.top() return type
#15067
Merged
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
Nov 24, 2025
Collaborator
srittau
left a comment
srittau
left a comment
There was a problem hiding this comment.
Thanks, one comment below.
| ) -> None: ... | ||
|
|
||
| @type_check_only | ||
| class TopResult(TypedDict): |
Collaborator
There was a problem hiding this comment.
Typecheck-only types need to be prefixed with _ to make it clear to users that this is "special" in some way, even if their IDE or editor doesn't point out the fact that it can't be imported at runtime.
Contributor
Author
There was a problem hiding this comment.
Ah, yes! You are right. I'll fix it now
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
srittau
approved these changes
Nov 24, 2025
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.
Added
TopResultas the return type forContainer.top()andContainerApiMixin.top()instead the incorrectstr.Docstring in docker/docker-py#3371 is also fixed.
Fixes docker/docker-py#2958