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

Make PEP 561 compatible packages 💖 #53

Merged
merged 1 commit into from
Jul 15, 2019
Merged

Make PEP 561 compatible packages 💖 #53

merged 1 commit into from
Jul 15, 2019

Conversation

deepyaman
Copy link
Member

@deepyaman deepyaman commented Jul 10, 2019

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

  • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.

  • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.

  • I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

Motivation and Context

Distributing and packaging type information as per PEP 561 makes type checkers like mypy aware that the third-party package (in this case, Kedro) supports typing, and the importing package can then perform (Kedro-)typing-aware checking. The best alternative is to push stubs to typeshed, but that doesn't take full advantage of inline typing and is maintained by a different team.

How has this been tested?

What testing strategies have you used?

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes
  • Assigned myself to the PR

@tolomea
Copy link
Contributor

tolomea commented Jul 11, 2019

Could you please fill in the "Motivation and Context" section of the description above

@deepyaman
Copy link
Member Author

@tolomea Motivation and Context added above:

Distributing and packaging type information as per PEP 561 makes type checkers like mypy aware that the third-party package (in this case, Kedro) supports typing, and the importing package can then perform (Kedro-)typing-aware checking. The best alternative is to push stubs to typeshed, but that doesn't take full advantage of inline typing and is maintained by a different team.

Copy link
Contributor

@tolomea tolomea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry about the delay getting to this. It looks fine. Could you please add yourself to the 0.15 contributors section in release notes and bring the pull request up to date with develop.

@tolomea tolomea merged commit e51b450 into kedro-org:develop Jul 15, 2019
@deepyaman deepyaman deleted the feature/pep-561-compat branch July 15, 2019 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants