Add strict support for mypy #169
Open
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
muddyfish
had a problem deploying
to
integration-tests
GitHub Actions
Failure
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
had a problem deploying
to
integration-tests
GitHub Actions
Failure
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
had a problem deploying
to
integration-tests
GitHub Actions
Failure
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
muddyfish
temporarily deployed
to
integration-tests
GitHub Actions
Inactive
dnanuti
reviewed
Mar 6, 2024
| @@ -17,8 +28,10 @@ | |||
|
|
|||
| log = logging.getLogger(__name__) | |||
|
|
|||
| T_co = TypeVar("T_co", covariant=True) | |||
There was a problem hiding this comment.
| ): | ||
| ) -> S3IterableDataset[S3Reader]: ... | ||
|
|
||
| @overload |
There was a problem hiding this comment.
Do we want to introduce this overload just for typing?
|
|
||
| from s3torchconnectorclient._mountpoint_s3_client import ObjectInfo, GetObjectStream | ||
|
|
||
|
|
||
| class S3Reader(io.BufferedIOBase): | ||
| class S3Reader(io.BufferedIOBase, IO[bytes]): |
There was a problem hiding this comment.
Why are we extending also IO[bytes]?
| @@ -187,3 +188,12 @@ def writable(self) -> bool: | |||
| bool: Return whether object was opened for writing. | |||
| """ | |||
| return False | |||
|
|
|||
| def write(self, data: Any) -> int: | |||
There was a problem hiding this comment.
Similarly to these, shouldn't the writer throw on READ?
Also, I'd rather say "Not supported" as I don't think we'll implement write for S3Reader.
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.
Description
Adds strict type checking with mypy. From the mypy guide, it says
I think this would be an ideal situation to be in, if possible. It does add extra work however when writing the code to ensure it type checks completely.
S3MapDatasetandS3IterableDatasetare now implemented as generics. This has no impact for customers not using type checking, but should improve IDE & mypy support.Additional context
Changes the constructor for
S3MapDatasetandS3IterableDataset. These constructors are not public, so it's OK to change.Related items
Testing
mypy --strict s3torchconnector/src && mypy --strict s3torchconnectorclient/python/srcpassesBy submitting this pull request, I confirm that my contribution is made under the terms of BSD 3-Clause License and I agree to the terms of the LICENSE.