Python: Add type hints and py.typed marker #264
Closed
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 PR adds type hints to the Python snowballstemmer package and includes a
py.typedmarker file for PEP 561 compliance.Changes
among.py,basestemmer.py,stemwords.py,testapp.pycreate_init.pyto generate typed__init__.pywith annotations foralgorithms()andstemmer()functionspy.typedmarker file for PEP 561 compliancesetup.pywithpackage_datato includepy.typedin installed packageMANIFEST.inandGNUmakefileto includepy.typedin distributionBenefits
This allows users of the snowballstemmer package to benefit from static type checking with mypy, pyright, and other type checkers. IDEs will also provide better autocompletion and documentation.
Compatibility
from __future__ import annotationsfor forward reference supportTYPE_CHECKINGguards to avoid runtime import overhead