Skip to content

Add py.typed file #406

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

Merged
merged 1 commit into from
Dec 17, 2021
Merged

Add py.typed file #406

merged 1 commit into from
Dec 17, 2021

Conversation

kasium
Copy link
Contributor

@kasium kasium commented Dec 13, 2021

This change adds the py.typed file, so that mypy and other type checkers can pickup the types.
Therefore a small tweak to setup.cfg is needed. I added as well the typed classifier for pypi.

I manually verified that the file is present in the distributions

What kind of change does this PR introduce?

  • 🐞 bug fix
  • 🐣 feature
  • 📋 docs update
  • 📋 tests/coverage improvement
  • 📋 refactoring
  • 💥 other

📋 What is the related issue number (starting with #)

Relates #384

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

📋 Other information:

📋 Contribution checklist:

(If you're a first-timer, check out
this guide on making great pull requests)

  • I wrote descriptive pull request text above
  • I think the code is well written
  • I wrote good commit messages
  • I have squashed related commits together after
    the changes have been approved
  • Unit tests for the changes exist
  • Integration tests for the changes exist (if applicable)
  • I used the same coding conventions as the rest of the project
  • The new code doesn't generate linter offenses
  • Documentation reflects the changes
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences

This change is Reviewable

This change adds the py.typed file, so that mypy and other type checkers can pickup the types.
Therefore a small tweak to setup.cfg is needed. I added as well the typed classifier for pypi.

I manually verified that the file is present in the distributions
@kasium kasium mentioned this pull request Dec 13, 2021
3 tasks
@codecov
Copy link

codecov bot commented Dec 13, 2021

Codecov Report

Merging #406 (2849ed9) into master (d758451) will decrease coverage by 0.68%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #406      +/-   ##
==========================================
- Coverage   80.50%   79.81%   -0.69%     
==========================================
  Files          28       28              
  Lines        4390     4390              
==========================================
- Hits         3534     3504      -30     
- Misses        856      886      +30     

@webknjaz
Copy link
Member

I manually verified that the file is present in the distributions

Yep, the thing that automatically includes all of the Git-tracked files into the sdist is setuptools-scm.

Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Thanks!

@webknjaz webknjaz merged commit edf6c4e into cherrypy:master Dec 17, 2021
@kasium kasium deleted the py-typed branch December 17, 2021 10:25
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.

2 participants