Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use _PATH in annotations and convert to str if Path #15560

Merged
merged 2 commits into from
Nov 8, 2022

Conversation

dyollb
Copy link
Contributor

@dyollb dyollb commented Nov 6, 2022

What does this PR do?

This minor change adds type annotation for pathlib.Path to some code locations, e.g. Trainer(default_root_dir: _PATH.
The type _PATH which is Union[str, Path] is used as it is already declared/used elsewhere.

To not break downstream code that expects str, the _PATH args/options are converted to str using os.fspath.

Fixes #15497

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

Writing a test for these small changes doesn't seem useful.

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Nov 6, 2022
@mergify mergify bot added the ready PRs ready to be merged label Nov 7, 2022
@carmocca carmocca added this to the v1.9 milestone Nov 7, 2022
@carmocca carmocca added the feature Is an improvement or enhancement label Nov 7, 2022
@awaelchli awaelchli merged commit 18f7f2d into Lightning-AI:master Nov 8, 2022
@awaelchli awaelchli changed the title use _PATH in annotations and convert to str if Path Use _PATH in annotations and convert to str if Path Nov 8, 2022
Borda pushed a commit that referenced this pull request Nov 8, 2022
Co-authored-by: Bryn Lloyd <[email protected]>
(cherry picked from commit 18f7f2d)
lexierule pushed a commit that referenced this pull request Nov 10, 2022
Co-authored-by: Bryn Lloyd <[email protected]>
(cherry picked from commit 18f7f2d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Is an improvement or enhancement pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support pathlib.Path paths in lightning API
5 participants