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.

Sign up for GitHub

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

Jump to bottom

Type hints #206

Open
The-Compiler opened this issue Nov 26, 2018 · 2 comments · May be fixed by #379
Open

Type hints #206

The-Compiler opened this issue Nov 26, 2018 · 2 comments · May be fixed by #379

Comments

@The-Compiler
Copy link
Contributor

I recently started using mypy with my project and it says "No library stub file for module 'colorama'".

Do you have any plans to introduce type annotations for colorama? Those could be done in the code as comments, as a separate stub file, or (whenever Python 2 support is dropped), with a proper annotation syntax.

Also, thanks a lot for colorama - it made my life so much easier (especially on Windows) in various projects! 👍
@wiggin15
Copy link
Collaborator

There are currently no plans to add type hints.
I was not familiar with the mypy stub files. I'm open to pull requests with this option.

@exhuma
Copy link

exhuma commented Jan 31, 2019

Currently, the best way of doing this is by adding comments (if Python 2 compatibility is required) or annotations (if Python2 support can be ignored), and adding a py.typed file to the repo (See PEP-561).

Conforming to PEP-561 will make it work out-of-the box with mypy without the need to submitting files to typeshed. AFAIK, typeshed is no longer recommended to use anyway for this very reason.

@hatal175 hatal175 mentioned this issue Mar 27, 2021
Merged
@hugovk hugovk mentioned this issue Nov 11, 2022
Merged
@jmelahman jmelahman linked a pull request Aug 7, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

merge types-colorama jmelahman/colorama
3 participants
@exhuma @The-Compiler @wiggin15