Add filters to climate and light service descriptions #86162
Conversation
home-assistant
bot
added
cla-signed
core
integration: climate
integration: light
labels
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
|
Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
emontnemery
force-pushed
the
filter_service_descriptions_mvp
branch
from
083221f
to
44d235f
Compare
homeassistant/helpers/selector.py
Outdated
| if isinstance(supported_feature, int): | ||
| return supported_feature | ||
|
|
||
| known_entity_features = { |
There was a problem hiding this comment.
should we generate this in a function decorated with @cache ?
homeassistant/helpers/selector.py
Outdated
| "WaterHeaterEntityFeature": WaterHeaterEntityFeature, | ||
| } | ||
|
|
||
| _, enum, feature = supported_feature.split(".", 2) |
There was a problem hiding this comment.
you should catch if it's only has a single or no .
There was a problem hiding this comment.
Voluptuous actually catches this and generates an acceptable error message without catching the ValueError which is raised if the tuple unpacking fails:
voluptuous.error.MultipleInvalid: not a valid value @ data['filter'][0]['supported_features'][0]
Do you think it adds value to add a more specific validation error, maybe something like:
voluptuous.error.MultipleInvalid: Invalid supported feature 'blah', expected <domain>.<enum>.<member> @ data['filter'][0]['supported_features'][0]
homeassistant/helpers/selector.py
Outdated
| @@ -87,6 +152,10 @@ def serialize(self) -> dict[str, dict[str, _T]]: | |||
| vol.Optional("domain"): vol.All(cv.ensure_list, [str]), | |||
| # Device class of the entity | |||
| vol.Optional("device_class"): vol.All(cv.ensure_list, [str]), | |||
| # Features supported by the entity | |||
| vol.Optional("supported_features"): [ | |||
| vol.All(vol.Any(int, str), _validate_supported_feature) | |||
There was a problem hiding this comment.
let's not support int. It's difficult to read
There was a problem hiding this comment.
This is required to be able to instantiate a selector from an already validated configuration where the enum strings have been resolved to their integer values.
We do that in tests to test serialization of configuration, I'm not sure if it's actually needed though?
Proposed change
Add filters to
climateandlightservice descriptionsThis PR makes it possible for service descriptions to add filters both to a service and a service parameters based on the capabilities of the service call target:
entitytarget selector has a new configuration parametersupported_featuressupported_featuresfilter lists supported features needed for the service field, the target entity must support at least one of the supported featuresfilterfiltercan be eithersupported_featuresorattributessupported_featuresfilter lists supported features needed for the service field, the target entity must support at least one of the supported featuresattributefilter names an attribute and lists possible attribute states needed for the service fieldclimateandlightare chosen as targets because they both have services which should be hidden depending on the target, or where service call parameters should be hidden depending on the target.Type of change
Additional information
Checklist
black --fast homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all..coveragerc.To help with the load of incoming pull requests: