feat: add type stub #8
Open
Conversation
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
This PR adds type stubs (.pyi) to enable IDE completion and type checking.
Details
The
.pyifiles were automatically generated usingpyo3-stub-genand then manually refined and formatted into__init__.pyifor distribution.The reason for choosing
__init__.pyirather thanhtmd.pyiis that, withhtmd.pyi, each member is treated as a member of thehtmd.htmdmodule. Conversely, using__init__.pyiallows members to be treated directly as part of thehtmdmodule itself. This approach aligns with how standard libraries handle module members and is thus considered preferable.I have added some notes to
DEVELOPMENT.mdregarding the issues I personally encountered and the process for generating.pyifiles. Feel free to remove these notes if deemed unnecessary.