Add pyright for static type checking#17744
Merged
SaschaCowley merged 8 commits intomasterfrom Mar 6, 2025
Merged
Conversation
Contributor
|
Can you clean up the other trailing spaces in requirements.txt by the way? |
Member
Author
|
@hwf1324 - this is probably better done as its own PR, it's relatively trivial |
Member
Author
|
Note: there's no inbuilt way of automatically generating |
SaschaCowley
requested changes
Feb 27, 2025
Member
SaschaCowley
left a comment
There was a problem hiding this comment.
Mostly looks good, however I'm a little concerned about the inclusion of a bunch of internal classes in various modules' __all__.
Co-authored-by: Sean Budd <sean@nvaccess.org>
See test results for failed build of commit f2649a8e74 |
See test results for failed build of commit 445074b0b8 |
See test results for failed build of commit defc94e191 |
5 tasks
seanbudd
pushed a commit
that referenced
this pull request
Mar 26, 2025
6 tasks
5 tasks
seanbudd
added a commit
that referenced
this pull request
Oct 14, 2025
Closes #17749 Summary of the issue: #17744 introduced pyright using it's default server nodeenv. The pyright python package recommends installing pyright[nodejs] for a faster and more reliable server. Hwever we couldn't use it while NVDA was 32bit. This is because the node wheel binaries required a 64bit environment. Now that NVDA has migrated to 64bit, we should update the pyright package version to using nodejs.
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
4 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.
Link to issue number:
Related to #17301
Summary of the issue:
NVDA has no type checking for python.
Python is a dynamically typed language meaning typing issues can occur at runtime.
Static analysers like
mypyorpyrightcan be used to avoid typing errors.Description of user facing changes
None
Description of development approach
pyrightwas chosen overmypyfor performance reasons.Additionally, pyright has better pre-commit integration, and is built-in to VS Code, which is used by most NVDA developers.
We are far from compliant with static type checking, so most rules are currently disabled.
The intention is to fix compliance and turn on rules over time.
Various trivial typing fixes have occurred, particularly:
gettextbuiltins and_buildVersiongenerated build vars__all__to mark export for private classesmatchcasesTesting strategy:
Known issues with pull request:
We are far from compliant with static type checking, so most rules are currently disabled.
The intention is to fix compliance and turn on rules over time.
Code Review Checklist:
@coderabbitai summary