Add Python type stub file for pyxrt module #9505
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
Add pyxrt.pyi type stub file with complete type annotations for the pyxrt module and install it alongside the compiled extension module. This file is needed for IDE autocompletion and type checking and does not affect execution.
|
@AngryLoki is not a repository collaborator. To proceed:
|
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem solved by the commit
Right now all usage of pyxrt either not validated or causes type errors (when checking with any modern type-checking tool like pyright/pylance). There is no autocomplete either.
Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered
N/A
How problem was solved, alternative solutions (if any) and why they were rejected
This pull-request adds pyxrt.pyi type stub file with complete type annotations for the pyxrt module and installs it alongside the compiled extension module. The file covers the whole module verbatim, not trying to remove any duplicate definitions.
Risks (if any) associated the changes in the commit
pyxrt.pyi may desync with C++ code in the future, but it should not break anything other than type checking. This file is needed for IDE autocompletion and type checking and does not affect execution (at all).
What has been tested and how, request additional testing if necessary
Checked against current usage in mlir-aie iron with Python >= 3.11.
Documentation impact (if any)
N/A