Skip to content
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

py.typed files missing? #471

Open
steve-mavens opened this issue Nov 27, 2024 · 3 comments
Open

py.typed files missing? #471

steve-mavens opened this issue Nov 27, 2024 · 3 comments

Comments

@steve-mavens
Copy link

Everything has type annotations, but there's no py.typed files in the top-level packages to tell mypy that it should use them: https://peps.python.org/pep-0561/#packaging-type-information

Is this intentional, or just an oversight? I think the py.typed mechanism is there because some people use annotations internally, but their annotations perhaps aren't accurate enough for their library's users to rely on. So they don't want to "publish" them, even though they're right there in the shipped code. Omitting the py.typed file means that the annotations aren't usable.

@MarshalX
Copy link
Owner

Hi, yes types are not ready to be public. There is a bunch of what we need to fix and enable more strict checks. That for now is disabled. In the future type checking must be a part of CI on every PR

@steve-mavens
Copy link
Author

Thanks for explaining the current status. It might be that the types for the parts I use are good enough, and then if mypy fixes python/mypy#8545 I'll be sorted :-)

@MarshalX
Copy link
Owner

Hm. Probably public api is good enough. Until you are not using something complicated like direct call of get_or_create()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants