Refactor the base module and make it an API for low level commands #2615
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
Collaborator
MattHag
commented
Sep 28, 2024
MattHag
commented
- Remove imports of hidapi and make it a child of base
- Remove cross-references of hidapi and base and pass base as low level at instantiation
This module shouldn't be necessary on the long run. Remove pieces from it whenever possible.
Enforce a total coverage of 40% of the code. Related pwr-Solaar#1097
Create coverage.xml, upload it to GitHub CI and visualize with codecov. Setup instruction: - Install codecov for project https://github.com/settings/installations/55029514 - Add CODECOV_TOKEN in the GitHub CI project secrets Related pwr-Solaar#1097
Introduce unit tests. Related pwr-Solaar#2273
Introduce unit tests. Related pwr-Solaar#2273
- Remove comments with unused receivers - Simplify receiver hardcoded info
Add test for it.
Name the key symbol mapping different than the module itself.
Fix typo in package name.
Linux uses udev, other platforms use the cross-platform hidapi implementation. Remove implicit loading of hidapi in hidapi/__init__.py.
Split model and view, and enable view mocks for unit tests without GDK.
Clean up, type hint and tests base_usb and related modules.
Avoid the need for hidapi imports and add them to the base API module.
Avoid direct access to hidapi and use the base module as low-level API instead. This change replaces the remaining calls to find_paired_node and find_paired_node_wpid by exposing them via base module.
With this test all receiver tests are macOS compatible again. The low level interface supports passing a fake API for unit tests.
A module level function is sufficient, no wrapper needed.
MattHag
changed the title
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.