Add py.typed marker and complete type annotations#124
Merged
Conversation
Add PEP 561 py.typed marker so type checkers (mypy, pyright) recognize the package as typed. Complete type annotations for all public methods missing them: context manager protocol, createTask/createTaskSmee parameter types, and exception subclass constructors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The task class `type` attributes conflict with the builtin `type` used in type annotations, causing an ambiguous cross-reference warning that fails the -W docs build. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Summary
py.typedmarker file so type checkers (mypy, pyright) recognize the package as typed[tool.setuptools.package-data]inpyproject.tomlto includepy.typedin distributions__enter__,__exit__,close),createTask/createTaskSmee(task: BaseTaskinstead ofAny), and exception subclass constructorsTest plan
py.typedis included in built wheel (unzip -l dist/*.whl | grep py.typed)🤖 Generated with Claude Code