chore(api): apply mypy consistently across api #15821
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
sfoster1
reviewed
Aug 2, 2024
There was a problem hiding this comment.
Going from Well to Location is done by doing well.top() or well.bottom() or something. In general though, I wouldn't worry too much about it; just getting the warnings removed is good enough, and making the typing elegant can happen in a followup pass.
The things to worry about are actual non-typechecking code changes to production software. That's what needs a second look, as in the API transfers code, for instance.
ryanthecoder
reviewed
Aug 2, 2024
| hw_api_cntrlr = await API.build_hardware_controller( | ||
| loop=asyncio.get_running_loop(), | ||
| feature_flags=HardwareFeatureFlags.build_from_ff(), | ||
| firmware=_find_smoothie_file(), |
There was a problem hiding this comment.
Should Be NONE since this isn't running on an actual robot
There was a problem hiding this comment.
Talked about in person - made a different change
This was a bit more in depth - the code changes here actually needed a bit more, as much as I wanted to remove them.
sfoster1
approved these changes
Aug 7, 2024
SyntaxColoring
requested changes
Aug 7, 2024
|
The failing tests are because fe6252c needs to be merged into edge as well as release |
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.
Overview
At present, typechecking is not applied fully and consistently across the API directory. This PR removes exceptions to mypy checking rules and makes sure that all mypy typechecking tests pass.
EXEC-201 EXEC-202
Test Plan and Hands on Testing
Remove all exceptions from
api/mypy.iniand runmake -C api lintfrom the home directory and make sure all the tests pass.Changelog
Review requests
Lots of file changes in this one. Most changes in most files are just monotonous
-> Nonefunction return type annotations(or something similar). For reviewers, I would focus on the following files:protocols/labware.py: My edits to _check_for_subdirectories seem strange. I'm not confident in the new things I imported to get that type annotation to work.test_transfers.py: There are dozens of conversions betweenLocation,Well, andLocation | Well. What should be done about these? If one function has aWelland wants to call a function that takes in aLocation, how should I convert it?Risk assessment
Low.