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

Improve annotations for _defaults_from_env_vars decorator #11888

Merged
merged 6 commits into from
Feb 22, 2022

Conversation

rsokl
Copy link
Contributor

@rsokl rsokl commented Feb 11, 2022

What does this PR do?

This PR fixes the annotations for the the _defaults_from_env_vars decorator; this enables type-checkers to "see" the proper signature for Trainer.__init__.

mypy documents the proper annotation for a decorator, which I have incorporated here.

Before:
(The following screenshots are taken from VSCode with Pylance)

Signature of Trainer cannot be inspected by type-checkers:

VSCode example

IDEs cannot flag incorrect usage of Trainer:

VSCode example

After:

Signature is found!
VSCode example

Bad usages flagged!
VSCode example

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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read 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 🙃

@mergify mergify bot added the ready PRs ready to be merged label Feb 12, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
@mergify mergify bot removed the has conflicts label Feb 22, 2022
@carmocca carmocca added this to the 1.6 milestone Feb 22, 2022
@carmocca carmocca enabled auto-merge (squash) February 22, 2022 16:14
CHANGELOG.md Show resolved Hide resolved
@carmocca carmocca merged commit 550d3a6 into Lightning-AI:master Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready PRs ready to be merged refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants