Skip to content

Conversation

@bkeryan
Copy link
Collaborator

@bkeryan bkeryan commented Jun 17, 2025

What does this Pull Request accomplish?

Add a dependency on pyright, which is a Python package that wraps the Pyright node.js module.

Fix errors identified by Pyright:

  • converters: error: Method "to_python_value" overrides class "Converter" in an incompatible manner.
    • By default, parameters in Python accept either position or keyword arguments, so changing a parameter name breaks runtime compatibility with keyword arguments.
    • Note that you can use / to specify that the parameters before it are positional-only, so their names do not need to match.
  • tests: error: Argument of type "_LoggingPool" cannot be assigned to parameter "thread_pool" of type "ThreadPoolExecutor" in function "start"
    • The type stubs for grpc.server expect a ThreadPoolExecutor.
    • logging_pool.pool() returns a _LoggingPool object, which uses composition to wrap ThreadPoolExecutor.
    • Arguably the stubs should use the ABC Executor and _LoggingPool should inherit from Executor.

Why should this Pull Request be merged?

Mypy and Pyright have different behavior in some cases and we should test with both.

What testing has been done?

Ran mypy and pyright locally.

bkeryan added 5 commits June 16, 2025 18:48
c:\Dev\nipanel-python\src\nipanel\converters\builtin.py
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:29:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:51:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:73:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:95:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:117:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:141:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:169:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:197:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:223:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
  c:\Dev\nipanel-python\src\nipanel\converters\builtin.py:249:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
c:\Dev\nipanel-python\src\nipanel\converters\protobuf_types.py
  c:\Dev\nipanel-python\src\nipanel\converters\protobuf_types.py:45:9 - error: Method "to_python_value" overrides class "Converter" in an incompatible manner
    Parameter 2 name mismatch: base parameter is named "protobuf_message", override parameter is named "protobuf_value" (reportIncompatibleMethodOverride)
c:\Dev\nipanel-python\tests\conftest.py
  c:\Dev\nipanel-python\tests\conftest.py:20:23 - error: Argument of type "_LoggingPool" cannot be assigned to parameter "thread_pool" of type "ThreadPoolExecutor" in function "start"
    "_LoggingPool" is not assignable to "ThreadPoolExecutor" (reportArgumentType)
@github-actions
Copy link
Contributor

github-actions bot commented Jun 17, 2025

Test Results

 10 files  ±0   10 suites  ±0   20s ⏱️ +6s
 80 tests ±0   80 ✅ ±0  0 💤 ±0  0 ❌ ±0 
770 runs  ±0  770 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 1c3dd1e. ± Comparison against base commit 5b3ea7e.

♻️ This comment has been updated with latest results.

@bkeryan bkeryan merged commit 9afcc8a into main Jun 17, 2025
14 checks passed
@bkeryan bkeryan deleted the users/bkeryan/pyright branch June 17, 2025 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants