Open
Conversation
`setuptools_scm` ensures `astropy_iers_data/_version.py` is annotated and mypy can infer all the types everywhere else, so adding mypy configuration is all that is needed to enable type checking.
PEP 561 – Distributing and Packaging Type Information requires packages that support type checking in downstream packages to declare that with a marker file named `py.typed`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The first commit enables type checking with mypy. The
astropy_iers_data/_version.pyfile thatsetuptools_scmgenerates whenastropy_iers_datais installed is annotated and mypy can infer all the types everywhere else, so there is no need write any annotations. Adding basic mypy configuration is sufficient to enable type checking.The second commit adds the
py.typedmarker file which declares support for type checking in downstream packages. Without this marker file type checking code that depends onastropy_iers_datacauses typing errors:The third commit adds a tox environment and a CI job for type checking so that any typing errors in the future could be caught here before they cause problems downstream.