Also allow os.PathLike in typing of write_to_path - #606
Merged
Conversation
pquentin
reviewed
Jul 6, 2023
|
|
||
| Args: | ||
| path (str): The path to write to. | ||
| path (str or path-like object): The path to write to. |
Member
There was a problem hiding this comment.
This breaks the documentation build, should we use os.PathLike[str] here or find a way to ignore the Sphinx failure?
Member
Author
There was a problem hiding this comment.
Fixed, thanks. BTW, these docstring types are mostly redundant with the function typing, I can configure sphinx accordingly and remove them if you agree.
If have e.g. a pathlib.Path, this allows `blob.write_to_path(path)` instead of `blob.write_to_path(str(path))`.
Member
|
Thank you for your contribution, I released it as part of 1.1.0. (It was a good opportunity to setup Trusted Publishing!) |
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
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.
If have e.g. a pathlib.Path, this allows
blob.write_to_path(path)instead ofblob.write_to_path(str(path)).