search

rapidsai / dependency-file-generator

https://pypi.org/project/rapids-dependency-file-generator/
Apache License 2.0
15 stars 13 forks source link

chore(refactor): add a py.typed file #91

Closed jameslamb closed 6 months ago

jameslamb commented 6 months ago

Contributes to #76 and #87.

Proposes adding a py.typed file, to advertise to type-checkers that this project contains inline type hints (i.e. doesn't ship a separate package of type stubs).

This is described in PEP 561: https://peps.python.org/pep-0561/

Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing.

This didn't really matter when rapids-dependency-file-generator was only being used as a CLI, but now that rapids-build-backend is consuming it as a library, I think this is useful to have. It means that mypy, pyright, etc. used to check rapids-build-backend will also consider rapids_dependency_file_generator's type hints.

How I tested this

Built a wheel and confirmed that this file made it in with my MANIFEST.in changes here.

python -m build .
unzip -l ./dist/rapids_dependency_file_generator-1.13.5-py3-none-any.whl
jameslamb commented 6 months ago

Do we need to add mypy to the pre-commit hooks?

I think we should, but it'll take a bit of work to get there. I documented that in #87 and am gonna keep chipping away it this week while waiting on builds for other projects.

GPUtester commented 6 months ago

:tada: This PR is included in version 1.13.6 :tada:

The release is available on:

Your semantic-release bot :package::rocket: