Add pyright type checking to CI workflow#114
Merged
conradbzura merged 3 commits intoreleasefrom Feb 21, 2026
Merged
Conversation
13c5776 to
7828de5
Compare
Add pyright to dev dependencies and configure it in pyproject.toml with appropriate include/exclude paths. Excludes protobuf generated files, test directories, and cli.py scratch module from analysis.
7828de5 to
becbbc0
Compare
Correct return type annotations and narrowing issues caught by pyright across the runtime subpackages: - roundrobin: Use AsyncGenerator instead of AsyncIterator for dispatch - task: Add casts for generic W return type and runtime assertions for callable type narrowing - connection: Annotate _execute return type and cast the generator in dispatch to satisfy AsyncGenerator variance - pool: Narrow overload 1 discovery parameter to None to prevent overlap with the discovery-required overload; add third overload for hybrid pools that both spawn local workers and discover remote workers
becbbc0 to
bb476b2
Compare
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
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
Add pyright as the project's static type checker and integrate it into the
run-testsCI workflow. Fix type errors surfaced by pyright in the loadbalancer, task dispatch, and worker connection modules.Closes #106
Proposed changes
CI workflow integration
Add a dedicated "Run linter" step to
.github/workflows/run-tests.yamlthat executesuv run pyrightbefore the test step. This ensures type errors block the pipeline before tests run.Pyright configuration
Add pyright as a dev dependency and configure
[tool.pyright]inwool/pyproject.toml:src/only__pycache__, build artifacts, tests, and generated protobuf stubsreportMissingImports, disablereportMissingTypeStubsType fixes —
AsyncIterator→AsyncGeneratorRoundRobinLoadBalancer.dispatchandWorkerConnection.dispatchboth yield values, making them async generators. Pyright correctly flags theAsyncIteratorannotation as incorrect. Replace withAsyncGeneratorin both signatures.Also fix the
TYPE_CHECKINGimport path inroundrobin.pyfromwool.runtime.work(package) towool.runtime.work.task(module) to resolve a circular import that pyright surfaces.Type fixes —
WorkTask.dispatchreturn narrowingWorkTask.dispatchreturns the generic type varWbut the_run()and_stream()helpers return concrete types. Wrap both return sites withcast(W, ...)so pyright can verify the generic contract. Add runtime assertions at the top of_runand_streamto guard the callable type assumption.Test cases
This change is a CI/tooling addition with no new runtime behavior. Type correctness is validated by pyright itself in CI. The existing test suite verifies that the annotation changes introduce no regressions.
Implementation plan
pyrightto dev dependencies and configure[tool.pyright]inwool/pyproject.toml.github/workflows/run-tests.yamlAsyncIterator→AsyncGeneratorinroundrobin.pyandconnection.pyTYPE_CHECKINGimport path inroundrobin.pycast()calls and runtime assertions intask.py