-
Notifications
You must be signed in to change notification settings - Fork 191
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
fix: py.typed #347
fix: py.typed #347
Conversation
This package is missing a py.typed file, so downstream projects will not show up in mypy or other type checkers, even though it has nice .pyi files. This adds a the token file, which will cause mypy to pick it up and use it. See [PEP 0561](https://www.python.org/dev/peps/pep-0561/\). It was also missing the .pyi files from the wheel (noticed when running `pip install build && python -m build`), added `include_package_data` to fix that.
This was attempted before in #318, apparently, but the py.typed fix is missing from that, which is quite important. |
Codecov Report
@@ Coverage Diff @@
## master #347 +/- ##
=======================================
Coverage 89.74% 89.74%
=======================================
Files 5 5
Lines 1063 1063
=======================================
Hits 954 954
Misses 109 109 Continue to review full report at Codecov.
|
Some of the type stubs look wrong too. e.g.
should be
I'm happy to work on this. Any objects to pushing my updates to this PR or should I open a new one? |
I'm perfectly happy to have pushes (sorry I missed this before!). One of the reasons this may have worked in the past is that typeshed had |
I too have come across this, would be really nice to get it in (and get out of Typeshed!) |
Tomli and tomllib (in Python 3.11) have replaces this. So closing. |
This package is missing a py.typed file, so downstream projects will not
show up in mypy or other type checkers, even though it has nice .pyi
files. This adds a the token file, which will cause mypy to pick it up
and use it. See PEP 0561.
It was also missing the .pyi files from the wheel (noticeable when running
pip install build && python -m build
), addedinclude_package_data
tofix that.
Edit: Actually I ran
pipx install build && pyproject-build
, but that's the same thing.Closes #318