photosynthesis-team / piq

Measures and metrics for image2image tasks. PyTorch.
Apache License 2.0
1.41k stars 120 forks source link

Ship `py.typed` file for `mypy` support #376

Open adamtheturtle opened 10 months ago

adamtheturtle commented 10 months ago

Is your feature request related to a problem? Please describe.

When I use mypy and piq, I get an error like the following:

mypy example.py
example.py:1: error: Skipping analyzing "piq": module is installed, but missing library stubs or py.typed marker  [import-untyped]
example.py:1: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports

Even if I # type: ignore the error, I do not get the benefits of type safety when using piq. Similar errors occur with other type checkers (pyre, pyright).

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

Describe the solution you'd like

Add an empty py.typed file to piq. This tells mypy to use the types defined in piq.

Describe alternatives you've considered