Replace BinaryIO with IO[bytes] #644
Merged
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
|
From my understanding, python/typing#829 recommends using protocols for function arguments. |
q0w
commented
Nov 14, 2021
aiodocker/utils.py
Outdated
| @@ -227,12 +217,12 @@ def clean_filters(filters: Mapping = None) -> str: | |||
| return json.dumps(filters) | |||
|
|
|||
|
|
|||
| def mktar_from_dockerfile(fileobject: BinaryIO) -> IO: | |||
| def mktar_from_dockerfile(fileobject: Union[BytesIO, IO[bytes]]) -> IO[bytes]: | |||
There was a problem hiding this comment.
I am not sure what to use here as Tarfile.gettarinfo expects fileobj as BytesIO
There was a problem hiding this comment.
Ok, let's keep BytesIO if there is no choice.
I can recommend making a PR for typeshed; they accept corrections easily and quickly if a patch is correct.
asvetlov
requested changes
Nov 15, 2021
aiodocker/utils.py
Outdated
| @@ -227,12 +217,12 @@ def clean_filters(filters: Mapping = None) -> str: | |||
| return json.dumps(filters) | |||
|
|
|||
|
|
|||
| def mktar_from_dockerfile(fileobject: BinaryIO) -> IO: | |||
| def mktar_from_dockerfile(fileobject: Union[BytesIO, IO[bytes]]) -> IO[bytes]: | |||
There was a problem hiding this comment.
Ok, let's keep BytesIO if there is no choice.
I can recommend making a PR for typeshed; they accept corrections easily and quickly if a patch is correct.
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.
What do these changes do?
Replace
BinaryIOwithIO[bytes]So
mktar_from_dockerfileshould takefileobjasUnion[BytesIO, IO[bytes]](IO[bytes]forelsecase) and returnIO[bytes]because there is not any case with returningIO[str]. Alsodocker.images.buildshould also takefileobjasIO[bytes]There is also a discussion about
typing.IO: python/typing#829, so protocols are useless due to the amount of use.Are there changes in behavior for the user?
Related issue number
Checklist
CONTRIBUTORS.txtchangesfolder<issue_id>.<type>for example (588.bug)issue_idchange it to the pr id after creating the pr.feature: Signifying a new feature..bugfix: Signifying a bug fix..doc: Signifying a documentation improvement..removal: Signifying a deprecation or removal of public API..misc: A ticket has been closed, but it is not of interest to users.