chore(refactor): add a py.typed file #91
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/
This didn't really matter when
rapids-dependency-file-generator
was only being used as a CLI, but now thatrapids-build-backend
is consuming it as a library, I think this is useful to have. It means thatmypy
,pyright
, etc. used to checkrapids-build-backend
will also considerrapids_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