Add py.typed marker for PEP 561 support (#116) - #125
Open
Tarcio0211 wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds PEP 561 typing support metadata so type checkers (e.g., mypy) recognize permit as a typed package rather than reporting it as “missing library stubs or py.typed marker”.
Changes:
- Adds an empty
permit/py.typedmarker file. - Updates
setup.pyto includepy.typedin the distributed package viapackage_data.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| setup.py | Includes permit/py.typed in package distribution metadata (package_data). |
| permit/py.typed | Adds the PEP 561 marker file to declare the package as typed. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or 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
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.
Issue: #116
What this PR does:
py.typedfile to thepermitpackage.package_datainsetup.pyto includepy.typedin the distribution.Why:
This resolves the mypy error
Skipping analyzing 'permit': missing library stubs or py.typed markerreported in issue #116. Nowmypycorrectly recognizespermitas a typed package.Testing:
mypyno longer ignores thepermitpackage.pip install -e .) to confirm the marker is included.