Add py.typed marker for PEP 561 compliance#29
Merged
fferflo merged 1 commit intofferflo:masterfrom Mar 20, 2026
Merged
Conversation
Type checkers (pyright, mypy, basedpyright) require a py.typed marker file to recognize that a package provides inline type annotations. Without this file, users get "Stub file not found" warnings.
Owner
|
Thanks! |
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
2 participants
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.
Summary
Problem
Type checkers (pyright, mypy, basedpyright) report "Stub file not found for einx" because the package is missing the https://peps.python.org/pep-0561/ py.typed marker file.
This happens despite einx having inline type annotations.
Solution
Adding the py.typed marker signals to type checkers that einx is a typed package. The annotations already exist in the source—this just enables their discovery. The types are ignored without this.
Workaround (for users on older versions)
Until this is released, users can suppress the warning in pyproject.toml:
Or in pyrightconfig.json:
{ "reportMissingTypeStubs": false }closes #28