Python testing mypy conformance #38165
Merged
Conversation
This file contains 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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances mypy conformance for the Python testing modules by adding new type stub (.pyi) files, updating type annotations, and introducing a CI workflow for mypy validation.
- Added type stub files for tasks, pics, apps, and package init in the chip.testing module.
- Updated type annotations and function signatures in testing code and tests to align with stricter type checking.
- Introduced a GitHub Actions workflow to validate type correctness using mypy.
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/tasks.pyi | Added type stubs for tasks signatures. |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/pics.pyi | Added type stubs for pics functions. |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/apps.pyi | Added type stubs for apps and subprocess classes. |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/init.pyi | Provided a stub file for the chip.testing package. |
| src/python_testing/matter_testing_infrastructure/chip/testing/tasks.py | Updated wait() method’s return type for consistency with type stubs. |
| src/python_testing/matter_testing_infrastructure/chip/testing/taglist_and_topology_test.py | Refined type hints and annotations in helper functions and test cases. |
| src/python_testing/matter_testing_infrastructure/chip/testing/pics.py | Improved XML parsing by adding checks for missing elements. |
| .github/workflows/mypy-validation.yml | Added a CI workflow for mypy validation on selected files. |
Files not reviewed (1)
- src/python_testing/matter_testing_infrastructure/mypy.ini: Language not supported
|
PR #38165: Size comparison from 0b71b04 to 0c40401 Full report (75 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
asirko-soft
requested review from
tcarmelveilleux,
andy31415,
khodya,
arkq and
cecille
|
PR #38165: Size comparison from 1560a87 to a5a6063 Full report (70 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, psoc6, qpg, stm32, telink, tizen)
|
khodya
reviewed
Apr 1, 2025
khodya
reviewed
Apr 1, 2025
cecille
approved these changes
Apr 1, 2025
src/python_testing/matter_testing_infrastructure/chip/testing/pics.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull Request Overview
This PR adds type annotations and stubs for matter testing code to ensure mypy conformance while also introducing a new CI workflow for type validation.
- Introduces type stub files for tasks, pics, and apps under chip/typings
- Updates type hints and error reporting in testing code (tasks.py, taglist_and_topology_test.py, pics.py)
- Adds a GitHub Actions workflow to run mypy on a subset of files
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/tasks.pyi | Added type stubs for subprocess tasks |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/pics.pyi | Added type stubs for pics functions |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/apps.pyi | Added type stubs for app server subprocess classes |
| src/python_testing/matter_testing_infrastructure/chip/typings/chip/testing/init.pyi | Created package stub for chip.testing |
| src/python_testing/matter_testing_infrastructure/chip/testing/tasks.py | Updated return type of the wait method for improved type checking |
| src/python_testing/matter_testing_infrastructure/chip/testing/taglist_and_topology_test.py | Enhanced type annotations, added type ignore comments where necessary, and standardized type hints |
| src/python_testing/matter_testing_infrastructure/chip/testing/pics.py | Improved error messages during XML parsing with robust checks for missing elements/text |
| .github/workflows/mypy-validation.yml | Added a new CI workflow to run mypy validation on selected testing files |
Files not reviewed (1)
- src/python_testing/matter_testing_infrastructure/mypy.ini: Language not supported
soares-sergio
pushed a commit
to soares-sergio/connectedhomeip
that referenced
this pull request
Apr 8, 2025
* mypy type stubs for apps and tasks * fix mypy warnings in taglist_and_topology_test.py * fix mypy warnings in pics.py * gh action yml * gh workflow update * run mypy from python env * debug * fix filename * resolve mypy warnings in taglist file * ignore mypy warning * linter fixes * lint fix 2 * resolve review comments
sayondeep
pushed a commit
to sayondeep/connectedhomeip
that referenced
this pull request
Apr 10, 2025
* mypy type stubs for apps and tasks * fix mypy warnings in taglist_and_topology_test.py * fix mypy warnings in pics.py * gh action yml * gh workflow update * run mypy from python env * debug * fix filename * resolve mypy warnings in taglist file * ignore mypy warning * linter fixes * lint fix 2 * resolve review comments
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.
Basically reusing existing mypy installation to check for a typing issues in matter testing code. Only couple of files are being checked to keep this PR small. Also added the CI workflow. Please let me know if the approach is reasonable and I can continue with keeping other files conformant in a similar fashion.
Testing
Local and CI testing
Fixes #37749