Add pyright for static type checking

[seanbudd]

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 mypy or pyright can be used to avoid typing errors.

Description of user facing changes

None

Description of development approach

pyright was chosen over mypy for 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:

• removing unnecessary casts
• fixing type hints
• adding relevant type ignore comments
• removing redundant type ignore comments
• adding type stubs for gettext builtins and _buildVersion generated build vars
• remove duplicate imports
• adding __all__ to mark export for private classes
• adding missing match cases

Testing strategy:

• Smoke test NVDA
• pyright passing
• Automated testing passes

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:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

@coderabbitai summary

[hwf1324]

Can you clean up the other trailing spaces in requirements.txt by the way?

[seanbudd]

@hwf1324 - this is probably better done as its own PR, it's relatively trivial

[seanbudd]

Note: there's no inbuilt way of automatically generating type: ignore comments like we can with ruff and noqa comments.
A custom script could be written to take the JSON output of pyright, and add comments using the data.
It would be great to do this and open source it for others

[SaschaCowley]

Mostly looks good, however I'm a little concerned about the inclusion of a bunch of internal classes in various modules' __all__.

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• PASS: Lint check.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/0a7ys280htwgurrk/artifacts/output/nvda_snapshot_pr17744-35491,f2649a8e.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.3,
  INSTALL_END 1.1,
  BUILD_START 0.0,
  BUILD_END 18.3,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.4,
  TEST_START 0.0,
  TEST_END 21.1,
  FINISH_END 0.1

See test results for failed build of commit f2649a8e74

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• FAIL: Lint check. See test results and lint artifacts for more information.
• FAIL: System tests (tags: installer NVDA). See test results for more information.
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/11ycqu65tlt7ssn3/artifacts/output/nvda_snapshot_pr17744-35515,445074b0.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.4,
  INSTALL_END 1.1,
  BUILD_START 0.0,
  BUILD_END 18.0,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.4,
  TEST_START 0.0,
  TEST_END 21.1,
  FINISH_END 0.1

See test results for failed build of commit 445074b0b8

[AppVeyorBot]

• PASS: Translation comments check.
• PASS: License check.
• PASS: Unit tests.
• FAIL: Lint check. See test results and lint artifacts for more information.
• PASS: System tests (tags: installer NVDA).
• Build (for testing PR): https://ci.appveyor.com/api/buildjobs/kxdyi6n0v7wt1365/artifacts/output/nvda_snapshot_pr17744-35523,defc94e1.exe
• CI timing (mins):
  INIT 0.0,
  INSTALL_START 1.3,
  INSTALL_END 1.0,
  BUILD_START 0.0,
  BUILD_END 21.0,
  TESTSETUP_START 0.0,
  TESTSETUP_END 0.5,
  TEST_START 0.0,
  TEST_END 21.7,
  FINISH_END 0.1

See test results for failed build of commit defc94e191

[SaschaCowley]

Thanks @seanbudd