[feat] Add py.typed marker to allow users to benefit from existing type annotations
#3281
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.
Aim seems to have decent type annotations. Unfortunately it is missing a
py.typedmarker, which would allow users to actually benefit from these typings.For instance when type checking the following user snippet with mypy:
The output is:
i.e., mypy just sees untyped
Anyinstances and fails to detect any bug / wrong usage on them, which is a bummer.By adding this
py.typedmarker, mypy will reveal the types properly asRepoandRun, and it will be able to detect erroneous usages.