feat: use yaml to parse action params (#447)

* feat: use yaml to parse action params

* feat: use yaml to parse action params

* feat: improve notify, action-text trans logic

* perf: reduce the number of judgments

---------

Co-authored-by: topsworld <sworldtop@gmail.com>

custom_components/xiaomi_home/notify.py

@@ -46,14 +46,15 @@ off Xiaomi or its affiliates' products.
 Notify entities for Xiaomi Home.
 """
 from __future__ import annotations
-import json
 import logging
-from typing import Optional
+from typing import Any, Optional
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.components.notify import NotifyEntity
+from homeassistant.util import yaml
+from homeassistant.exceptions import HomeAssistantError
 
 from .miot.miot_spec import MIoTSpecAction
 from .miot.miot_device import MIoTDevice, MIoTActionEntity
@@ -82,6 +83,7 @@ async def async_setup_entry(
 
 class Notify(MIoTActionEntity, NotifyEntity):
     """Notify entities for Xiaomi Home."""
+    # pylint: disable=unused-argument
 
     def __init__(self, miot_device: MIoTDevice, spec: MIoTSpecAction) -> None:
         """Initialize the Notify."""
@@ -96,34 +98,58 @@ class Notify(MIoTActionEntity, NotifyEntity):
         self, message: str, title: Optional[str] = None
     ) -> None:
         """Send a message."""
-        del title
         if not message:
             _LOGGER.error(
                 'action exec failed, %s(%s), empty action params',
                 self.name, self.entity_id)
             return
+        in_list: Any = None
         try:
-            in_list: list = json.loads(message)
+            # YAML will convert yes, no, on, off, true, false to the bool type,
-        except json.JSONDecodeError:
+            # and if it is a string, quotation marks need to be added.
+            in_list = yaml.parse_yaml(content=message)
+        except HomeAssistantError:
             _LOGGER.error(
                 'action exec failed, %s(%s), invalid action params format, %s',
                 self.name, self.entity_id, message)
             return
-
+        if len(self.spec.in_) == 1 and not isinstance(in_list, list):
+            in_list = [in_list]
         if not isinstance(in_list, list) or len(in_list) != len(self.spec.in_):
             _LOGGER.error(
                 'action exec failed, %s(%s), invalid action params, %s',
                 self.name, self.entity_id, message)
             return
-
         in_value: list[dict] = []
         for index, prop in enumerate(self.spec.in_):
-            if type(in_list[index]).__name__ != prop.format_:
+            if prop.format_ == 'str':
-                _LOGGER.error(
+                if isinstance(in_list[index], (bool, int, float, str)):
-                    'action exec failed, %s(%s), invalid params item, '
+                    in_value.append(
-                    'which item(%s) in the list must be %s, %s',
+                        {'piid': prop.iid, 'value': str(in_list[index])})
-                    self.name, self.entity_id, prop.description_trans,
+                    continue
-                    prop.format_, message)
+            elif prop.format_ == 'bool':
-                return
+                if isinstance(in_list[index], (bool, int)):
-            in_value.append({'piid': prop.iid, 'value': in_list[index]})
+                    # yes, no, on, off, true, false and other bool types
-        return await self.action_async(in_list=in_value)
+                    # will also be parsed as 0 and 1 of int.
+                    in_value.append(
+                        {'piid': prop.iid, 'value': bool(in_list[index])})
+                    continue
+            elif prop.format_ == 'float':
+                if isinstance(in_list[index], (int, float)):
+                    in_value.append(
+                        {'piid': prop.iid, 'value': in_list[index]})
+                    continue
+            elif prop.format_ == 'int':
+                if isinstance(in_list[index], int):
+                    in_value.append(
+                        {'piid': prop.iid, 'value': in_list[index]})
+                    continue
+            # Invalid params type, raise error.
+            _LOGGER.error(
+                'action exec failed, %s(%s), invalid params item, '
+                'which item(%s) in the list must be %s, %s type was %s, %s',
+                self.name, self.entity_id, prop.description_trans,
+                prop.format_, in_list[index], type(
+                    in_list[index]).__name__, message)
+            return
+        await self.action_async(in_list=in_value)

custom_components/xiaomi_home/text.py

@@ -46,14 +46,15 @@ off Xiaomi or its affiliates' products.
 Text entities for Xiaomi Home.
 """
 from __future__ import annotations
-import json
 import logging
-from typing import Optional
+from typing import Any, Optional
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.components.text import TextEntity
+from homeassistant.util import yaml
+from homeassistant.exceptions import HomeAssistantError
 
 from .miot.const import DOMAIN
 from .miot.miot_spec import MIoTSpecAction, MIoTSpecProperty
@@ -119,16 +120,18 @@ class ActionText(MIoTActionEntity, TextEntity):
     async def async_set_value(self, value: str) -> None:
         if not value:
             return
-        in_list: list = None
+        in_list: Any = None
         try:
-            in_list = json.loads(value)
+            in_list = yaml.parse_yaml(content=value)
-        except json.JSONDecodeError as e:
+        except HomeAssistantError as e:
             _LOGGER.error(
                 'action exec failed, %s(%s), invalid action params format, %s',
                 self.name, self.entity_id, value)
             raise ValueError(
                 f'action exec failed, {self.name}({self.entity_id}), '
                 f'invalid action params format, {value}') from e
+        if len(self.spec.in_) == 1 and not isinstance(in_list, list):
+            in_list = [in_list]
         if not isinstance(in_list, list) or len(in_list) != len(self.spec.in_):
             _LOGGER.error(
                 'action exec failed, %s(%s), invalid action params, %s',
@@ -138,16 +141,40 @@ class ActionText(MIoTActionEntity, TextEntity):
                 f'invalid action params, {value}')
         in_value: list[dict] = []
         for index, prop in enumerate(self.spec.in_):
-            if type(in_list[index]).__name__ != prop.format_:
+            if prop.format_ == 'str':
-                logging.error(
+                if isinstance(in_list[index], (bool, int, float, str)):
-                    'action exec failed, %s(%s), invalid params item, which '
+                    in_value.append(
-                    'item(%s) in the list must be %s, %s', self.name,
+                        {'piid': prop.iid, 'value': str(in_list[index])})
-                    self.entity_id, prop.description_trans, prop.format_, value)
+                    continue
-                raise ValueError(
+            elif prop.format_ == 'bool':
-                    f'action exec failed, {self.name}({self.entity_id}), '
+                if isinstance(in_list[index], (bool, int)):
-                    f'invalid params item, which item({prop.description_trans})'
+                    # yes, no, on, off, true, false and other bool types
-                    f' in the list must be {prop.format_}, {value}')
+                    # will also be parsed as 0 and 1 of int.
-            in_value.append({'piid': prop.iid, 'value': in_list[index]})
+                    in_value.append(
+                        {'piid': prop.iid, 'value': bool(in_list[index])})
+                    continue
+            elif prop.format_ == 'float':
+                if isinstance(in_list[index], (int, float)):
+                    in_value.append(
+                        {'piid': prop.iid, 'value': in_list[index]})
+                    continue
+            elif prop.format_ == 'int':
+                if isinstance(in_list[index], int):
+                    in_value.append(
+                        {'piid': prop.iid, 'value': in_list[index]})
+                    continue
+            # Invalid params type, raise error.
+            _LOGGER.error(
+                'action exec failed, %s(%s), invalid params item, '
+                'which item(%s) in the list must be %s, %s type was %s, %s',
+                self.name, self.entity_id, prop.description_trans,
+                prop.format_, in_list[index], type(
+                    in_list[index]).__name__, value)
+            raise ValueError(
+                f'action exec failed, {self.name}({self.entity_id}), '
+                f'invalid params item, which item({prop.description_trans}) '
+                f'in the list must be {prop.format_}, {in_list[index]} type '
+                f'was {type(in_list[index]).__name__}, {value}')
 
         self._attr_native_value = value
         if await self.action_async(in_list=in_value):