feat: ship py.typed to allow type checking #55
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This might take me some time as it's not something I'll benefit from (I'm a typing heretic, and kinda okay checking Python types just in VS Code with the pyright server), and I'm not a big fan of having code in the init file. Unless this has great benefits for users of the package, I'll probably procrastinate this until the code becomes a package (as in 'Python files inside directory') for other reasons. |
|
Without that mypy won't use type hints in this module. I can structure the module more, I just wanted to minimize the changes for this pull request. |
The py.typed needs to be present in the module to make type checking work (see PEP 561). In order to make it possible, the module can no longer be a single file, but needs to be installed in a directory.
|
I've moved the code from |
|
I’m sorry for the radio silence - I got sick. I’ll get back to this soon
once I’m fit and have time for coding on this.
…On Thu 9. 1. 2025 at 11:40, Michal Čihař ***@***.***> wrote:
I've moved the code from __init__.py now. As mentioned before, having
py.typed is the only way for type checkers to be able to use type hints
in a third-party code using this module.
—
Reply to this email directly, view it on GitHub
<#55 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACFGMKYA3OCNVFHJKCMVRL2JZGYNAVCNFSM6AAAAABUV6QIESVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZZG44DQOBSHA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The py.typed needs to be present in the module to make type checking work (see PEP 561). In order to make it possible, the module can no longer be a single file, but needs to be installed in a directory.