Implement introspectable settings #1500
Merged
Conversation
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
The @settings decorator creates a corresponding descriptor depending on what parameters are given to it: * If min_value or max_value is defined, a NumberSettingDescriptor is created. * If choices is defined, an EnumSettingDescriptor is created. This also converts the descriptors to use attrs as kw_args is only available from python 3.10 onwards, and using it is a prerequisite to allow sane inheritance on data classes. This commit also touches cooker.py to rename previously used variable `settings` to `_settings` and its exposed getter to `cooker_settings`.
8 tasks
Codecov Report
@@ Coverage Diff @@
## master #1500 +/- ##
==========================================
- Coverage 82.63% 82.62% -0.02%
==========================================
Files 142 142
Lines 14053 14081 +28
Branches 3383 3391 +8
==========================================
+ Hits 11613 11634 +21
- Misses 2221 2224 +3
- Partials 219 223 +4
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
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.
Continuing the work to make the library introspectable (#1495), this PR adds introspectable settings exposed in homeassitstant using
numberandselectplatforms.If you want to develop or test this, the homeassistant fork supporting these features is currently available at rytilahti/home-assistant@xiaomi_miio/feat/entities_from_upstream
The
@settingdecorator creates a correspondingSettingDescriptorobject depending on the input parameters:min_valueormax_valueis defined, aNumberSettingDescriptoris created.EnumSettingDescriptoris created.The created
SettingDescriptorobjects are exposed to downstream users using theDevice.settings()method.This also converts the descriptors to use attrs as kw_args is only available from python 3.10 onwards,
and using it is a prerequisite to allow sane inheritance on data classes.
Breaking change
This commit also touches
cooker.pyto rename previously used variablesettingsto_settingsand its exposed getter tocooker_settings(@syssi).