[docker] Fix Container.attach() return type
#15155
Open
+82
−5
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
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
This comment has been minimized.
This comment has been minimized.
srittau
requested changes
Dec 20, 2025
Collaborator
srittau
left a comment
There was a problem hiding this comment.
Thanks, looks good! A suggestion for the tests, though.
Comment on lines
6
to
8
| def check_attach_stream(c: Container) -> None: | ||
| for line in c.attach(stdout=True, stderr=True, stream=True, logs=True): | ||
| line.decode("utf-8") |
Collaborator
There was a problem hiding this comment.
This test can be simplified and "typified", and extended:
Suggested change
| def check_attach_stream(c: Container) -> None: | |
| for line in c.attach(stdout=True, stderr=True, stream=True, logs=True): | |
| line.decode("utf-8") | |
| c: Container | |
| assert_type(c.attach(), bytes) | |
| assert_type(c.attach(stream=False), bytes) | |
| for line in c.attach(stream=True): | |
| assert_type(line, bytes) |
Contributor
Author
There was a problem hiding this comment.
Thank you for the review! The suggested code fails pyright CI because c: Container without assignment is seen as an unbound variable. Pyright reports: "c" is unbound (reportUnboundVariable). To fix this, we need to wrap it in a function with a parameter, which is how other tests handle cases where instances can't be easily constructed:
def check_attach(c: Container) -> None:
assert_type(c.attach(), bytes)
assert_type(c.attach(stream=False), bytes)
for line in c.attach(stream=True):
assert_type(line, bytes)Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
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.
PR Summary
The
Container.attach()method was incorrectly typed as returningstr | tuple[str | None, str | None] | ...but it actually returnsbytes. Whenstream=True, it returns aCancellableStream[bytes]that yieldsbytesobjects on iteration. This caused false positive errors when users called.decode()on the output, since mypy thought the values werestr(which has no.decode()method). So this PR adds proper overloads for bothContainer.attach()andContainerApiMixin.attach()based on thestreamanddemuxparameters:stream=False, demux=False→bytesstream=False, demux=True→tuple[bytes | None, bytes | None]stream=True, demux=False→CancellableStream[bytes]stream=True, demux=True→CancellableStream[tuple[bytes | None, bytes | None]]Please note that tests follow the "less is more" rule of the the project so minimal.
Fixes #15143