misc: Add module type hints #33
Open
Conversation
This file contains 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
This commit adds type hints to the module. It's missing the addition of a `py.typed` file to be PEP 561 compliant [1]. However, it seems that will require moving away from the `py_modules` setup in `setup.py`, according to the PEP: > This PEP does not support distributing typing information as part of > module-only distributions or single-file modules within namespace > packages. > The single-file module should be refactored into a package and > indicate that the package supports typing as described above. [1] https://peps.python.org/pep-0561/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit adds type hints to the module. It's missing the addition of a
py.typedfile to be PEP 561 compliant [1]. However, it seems that will require moving away from thepy_modulessetup insetup.py, according to the PEP:[1] https://peps.python.org/pep-0561/