search

magmax / python-readchar

Python library to read characters and key strokes
MIT License
143 stars 43 forks source link

missing py.typed marker #100

Closed phoenixr-codes closed 1 year ago

phoenixr-codes commented 1 year ago

mypy raises an error when importing readchar.

error: Skipping analyzing "readchar": module is installed, but missing library stubs or py.typed marker

Fix this issue by adding a py.typed marker:

https://peps.python.org/pep-0561/#packaging-type-information

Python Version: 3.10.6 mypy version: 0.991 readchar version: 4.0.3

Cube707 commented 1 year ago

is it enough to add the py.typed file, as the functions all provide typehints. Or would *.pyi files also be required?

phoenixr-codes commented 1 year ago

An empty py.typed file should be enough. No need to add extra type hints in seperate files.