Migrate to using pathlib in most of the SDK #5435
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
`pathlib` enables simpler, more type-safe code. For user-facing functions, keep accepting `str` paths to maintain compatibility and flexibility, but add support for arbitrary path-like objects. For internal functions (in `downloading.py` and `uploading.py`), don't bother and require `pathlib.Path`. The only code that isn't converted is build-time code (e.g. `setup.py`) and code that came from openapi-generator.
SpecLad
force-pushed
the
cvat-sdk-path
branch
from
9ae56c7
to
ddc32b8
Compare
Merged
2 tasks
mikhail-treskin
pushed a commit
to retailnext/cvat
that referenced
this pull request
Jul 1, 2023
For user-facing functions, keep accepting `str` paths to maintain compatibility and flexibility, but add support for arbitrary path-like objects. For internal functions (in `downloading.py` and `uploading.py`), don't bother and require `pathlib.Path`. The only code that isn't converted is build-time code (e.g. `setup.py`) and code that came from openapi-generator.
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.
For user-facing functions, keep accepting
strpaths to maintain compatibility and flexibility, but add support for arbitrary path-like objects. For internal functions (indownloading.pyanduploading.py), don't bother and requirepathlib.Path.The only code that isn't converted is build-time code (e.g.
setup.py) and code that came from openapi-generator.Motivation and context
pathlibenables simpler, more type-safe code. This also makes the API more convenient for users who are already usingpathlib(or an alternative path library).How has this been tested?
Unit tests.
Checklist
developbranch[ ] I have updated the documentation accordingly[ ] I have added tests to cover my changes[ ] I have linked related issues (read github docs)[ ] I have increased versions of npm packages if it is necessary (cvat-canvas,cvat-core, cvat-data and cvat-ui)
License
Feel free to contact the maintainers if that's a concern.