Add py.typed marker to fix mypy type detection (fixes #446)#452
Open
daniel7an wants to merge 1 commit intouiri:masterfrom
Open
Add py.typed marker to fix mypy type detection (fixes #446)#452daniel7an wants to merge 1 commit intouiri:masterfrom
daniel7an wants to merge 1 commit intouiri:masterfrom
Conversation
Fixes uiri#446. The package has .pyi stub files but was missing the PEP 561 py.typed marker file, causing mypy to not recognize the inline type information and instead request installation of types-toml. This commit: - Adds the py.typed marker file to the toml package - Adds package_data to setup.py to ensure py.typed and .pyi files are included in the built distribution
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
1 participant
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.
Problem
Mypy does not recognize the toml package's inline type stubs, producing:
This happens because the package is missing the PEP 561
py.typedmarker file, even though it ships.pyistub files.Fix
toml/py.typedmarker file (empty, as per PEP 561)package_datatosetup.pyto ensurepy.typedand.pyifiles are included in built distributionsRelated