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

Add missing library stubs or py.typed marker #219

Open
jblemoine opened this issue May 14, 2024 · 0 comments
Open

Add missing library stubs or py.typed marker #219

jblemoine opened this issue May 14, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jblemoine
Copy link

jblemoine commented May 14, 2024

🚀 Feature

Add missing py.typed marker

Motivation

This proposal aims to make the project adhere to the PEP 561 standard for stub packages, thereby enabling type checking. Given that the project is largely typed, it could also benefit other packages that depend on comet and utilize mypy.

Alternatives

Another option is to configure mypy to disregard missing import errors in projects that rely on comet. For example by adding a # type: ignore at the end of the line containing the import.

Additional context

I'm using comet in my personal project, which has a CI step for type checking.

@jblemoine jblemoine added the enhancement New feature or request label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant