Merge cc883d78e5 into 365f4e57d8

custom_components/xiaomi_home/miot/miot_spec.py

@@ -784,12 +784,8 @@ class MIoTSpecParser:
         _LOGGER.debug('parse urn, %s', urn)
         # Load spec instance
         instance: dict = await self.__get_instance(urn=urn)
-        urn_strs: list[str] = urn.split(':')
-        urn_key: str = ':'.join(urn_strs[:6])
         # Modify the spec instance by custom spec
-        instance = self._custom_service.modify_spec(urn_key=urn_key,
-                                                    spec=instance)
-        # Check required fields in the device instance
+        instance = self._custom_service.modify_spec(urn=urn, spec=instance)
         if (
             not isinstance(instance, dict)
             or 'type' not in instance
@@ -807,6 +803,8 @@ class MIoTSpecParser:
                 or not isinstance(res_trans['data'], dict)
             ):
                 raise MIoTSpecError('invalid translation data')
+            urn_strs: list[str] = urn.split(':')
+            urn_key: str = ':'.join(urn_strs[:6])
             trans_data: dict[str, str] = None
             if self._lang == 'zh-Hans':
                 # Simplified Chinese

custom_components/xiaomi_home/miot/miot_storage.py

@@ -1071,17 +1071,17 @@ class SpecCustomService:
     async def deinit_async(self) -> None:
         self._data = None
 
-    def modify_spec(self, urn_key: str, spec: dict) -> dict | None:
+    def modify_spec(self, urn: str, spec: dict) -> dict | None:
         """MUST call init_async() first."""
         if not self._data:
             _LOGGER.error('self._data is None')
             return spec
-        if urn_key not in self._data:
+        if urn not in self._data:
             return spec
         if 'services' not in spec:
             return spec
         spec_services = spec['services']
-        custom_spec = self._data.get(urn_key, None)
+        custom_spec = self._data.get(urn, None)
         # Replace services by custom defined spec
         for i, service in enumerate(spec_services):
             siid = str(service['iid'])

custom_components/xiaomi_home/miot/specs/custom_service.json

@@ -1,5 +1,5 @@
 {
-    "urn:miot-spec-v2:device:airer:0000A00D:hyd-lyjpro": {
+    "urn:miot-spec-v2:device:airer:0000A00D:hyd-lyjpro:1": {
         "3": {
             "iid": 3,
             "type": "urn:miot-spec-v2:service:light:00007802:hyd-lyjpro:1",

custom_components/xiaomi_home/miot/specs/multi_lang.json

@@ -155,7 +155,7 @@
             "service:004:property:001": "事件名稱"
         }
     },
-    "urn:miot-spec-v2:device:switch:0000A003:lumi-acn040": {
+    "urn:miot-spec-v2:device:switch:0000A003:lumi-acn040:1": {
         "en": {
             "service:011": "Right Button On and Off",
             "service:011:property:001": "Right Button On and Off",

test/check_rule_format.py

@@ -20,14 +20,6 @@ SPEC_MULTI_LANG_FILE = path.join(
 SPEC_FILTER_FILE = path.join(
     ROOT_PATH,
     '../custom_components/xiaomi_home/miot/specs/spec_filter.json')
-CUSTOM_SERVICE_FILE = path.join(
-    ROOT_PATH,
-    '../custom_components/xiaomi_home/miot/specs/custom_service.json')
-
-BOOL_TRANS_URN_KEY_COLON_NUM: int = 4
-CUSTOM_SERVICE_URN_KEY_COLON_NUM: int = 5
-MULTI_LANG_URN_KEY_COLON_NUM: int = 5
-SPEC_FILTER_URN_KEY_COLON_NUM: int = 5
 
 
 def load_json_file(file_path: str) -> Optional[dict]:
@@ -98,18 +90,11 @@ def nested_3_dict_str_str(d: dict) -> bool:
             return False
     return True
 
-def urn_key(d: dict, cnt: int) -> bool:
-    for k in d.keys():
-        if cnt != k.count(':'):
-            return False
-    return True
 
 def spec_filter(d: dict) -> bool:
     """restricted format: dict[str, dict[str, list<str>]]"""
     if not dict_str_dict(d):
         return False
-    if not urn_key(d, SPEC_FILTER_URN_KEY_COLON_NUM):
-        return False
     for value in d.values():
         for k, v in value.items():
             if not isinstance(k, str) or not isinstance(v, list):
@@ -119,121 +104,12 @@ def spec_filter(d: dict) -> bool:
     return True
 
 
-def spec_instance_format(d: dict) -> bool:
-    """restricted format of MIoT-Spec-V2 instance"""
-    if ('iid' not in d) or ('type' not in d) or ('description' not in d):
-        return False
-    if not isinstance(d['iid'], int) or not isinstance(d['type'], str) or (
-        not isinstance(d['description'], str)):
-        return False
-    # optional keys for property
-    if 'format' in d:
-        if not isinstance(d['format'], str):
-            return False
-    if 'unit' in d:
-        if not isinstance(d['unit'], str):
-            return False
-    if 'access' in d:
-        if not isinstance(d['access'], list):
-            return False
-        for i in d['access']:
-            if not isinstance(i, str):
-                return False
-    if 'value-list' in d:
-        if not isinstance(d['value-list'], list):
-            return False
-        for i in d['value-list']:
-            if not isinstance(i, dict):
-                return False
-            if 'value' not in i or 'description' not in i:
-                return False
-            if not isinstance(i['value'], int) or not isinstance(i[
-                'description'], str):
-                return False
-            if i['description'].replace(' ','') == '':
-                return False
-    # optional keys for action
-    if 'in' in d:
-        if not isinstance(d['in'], list):
-            return False
-        for i in d['in']:
-            if not isinstance(i, int):
-                return False
-    if 'out' in d:
-        if not isinstance(d['out'], list):
-            return False
-        for i in d['out']:
-            if not isinstance(i, int):
-                return False
-    # optional keys for event
-    if 'arguments' in d:
-        if not isinstance(d['arguments'], list):
-            return False
-        for i in d['arguments']:
-            if not isinstance(i, int):
-                return False
-    # optional keys for service
-    if 'properties' in d:
-        if not isinstance(d['properties'], list):
-            return False
-        for i in d['properties']:
-            if not spec_instance_format(i):
-                return False
-    if 'actions' in d:
-        if not isinstance(d['actions'], list):
-            return False
-        for i in d['actions']:
-            if not spec_instance_format(i):
-                return False
-    if 'events' in d:
-        if not isinstance(d['events'], list):
-            return False
-        for i in d['events']:
-            if not spec_instance_format(i):
-                return False
-    return True
-
-
-def is_integer(s: str) -> bool:
-    try:
-        int(s)
-        return True
-    except ValueError:
-        return False
-
-
-def custom_service(d: dict) -> bool:
-    """restricted format: dict[str, dict[str, Any]]"""
-    if not dict_str_dict(d):
-        return False
-    if not urn_key(d, CUSTOM_SERVICE_URN_KEY_COLON_NUM):
-        return False
-    for v in d.values():
-        for key, value in v.items():
-            if key=='new':
-                if not isinstance(value, list):
-                    return False
-                for i in value:
-                    if not spec_instance_format(i):
-                        return False
-            elif is_integer(key):
-                if not isinstance(value, dict):
-                    return False
-                if not spec_instance_format(value):
-                    return False
-            else:
-                return False
-    return True
-
-
 def bool_trans(d: dict) -> bool:
     """dict[str,  dict[str, str] | dict[str, dict[str, str]] ]"""
     if not isinstance(d, dict):
         return False
     if 'data' not in d or 'translate' not in d:
         return False
-    if not urn_key(d['data'], BOOL_TRANS_URN_KEY_COLON_NUM):
-        return False
     if not dict_str_str(d['data']):
         return False
     if not nested_3_dict_str_str(d['translate']):
@@ -250,13 +126,6 @@ def bool_trans(d: dict) -> bool:
             return False
     return True
 
-def multi_lang(d: dict) -> bool:
-    """dict[str,  dict[str, dict[str, dict[str, str]] ] ]"""
-    if not nested_3_dict_str_str(d):
-        return False
-    if not urn_key(d, MULTI_LANG_URN_KEY_COLON_NUM):
-        return False
-    return True
 
 def compare_dict_structure(dict1: dict, dict2: dict) -> bool:
     if not isinstance(dict1, dict) or not isinstance(dict2, dict):
@@ -291,13 +160,13 @@ def sort_bool_trans(file_path: str):
 
 
 def sort_multi_lang(file_path: str):
-    lang_data: dict = load_json_file(file_path=file_path)
-    lang_data = dict(sorted(lang_data.items()))
-    for urn, trans in lang_data.items():
-        lang_data[urn] = dict(sorted(trans.items()))
-        for lang, spec in lang_data[urn].items():
-            lang_data[urn][lang] = dict(sorted(spec.items()))
-    return lang_data
+    multi_lang: dict = load_json_file(file_path=file_path)
+    multi_lang = dict(sorted(multi_lang.items()))
+    for urn, trans in multi_lang.items():
+        multi_lang[urn] = dict(sorted(trans.items()))
+        for lang, spec in multi_lang[urn].items():
+            multi_lang[urn][lang] = dict(sorted(spec.items()))
+    return multi_lang
 
 
 def sort_spec_filter(file_path: str):
@@ -308,14 +177,6 @@ def sort_spec_filter(file_path: str):
     return filter_data
 
 
-def sort_custom_service(file_path: str):
-    service_data: dict = load_json_file(file_path=file_path)
-    service_data = dict(sorted(service_data.items()))
-    for urn, spec in service_data.items():
-        service_data[urn] = dict(sorted(spec.items()))
-    return service_data
-
-
 @pytest.mark.github
 def test_bool_trans():
     data: dict = load_json_file(SPEC_BOOL_TRANS_FILE)
@@ -334,14 +195,7 @@ def test_spec_filter():
 def test_multi_lang():
     data: dict = load_json_file(SPEC_MULTI_LANG_FILE)
     assert data, f'load {SPEC_MULTI_LANG_FILE} failed'
-    assert multi_lang(data), f'{SPEC_MULTI_LANG_FILE} format error'
-
-
-@pytest.mark.github
-def test_custom_service():
-    data: dict = load_json_file(CUSTOM_SERVICE_FILE)
-    assert data, f'load {CUSTOM_SERVICE_FILE} failed'
-    assert custom_service(data), f'{CUSTOM_SERVICE_FILE} format error'
+    assert nested_3_dict_str_str(data), f'{SPEC_MULTI_LANG_FILE} format error'
 
 
 @pytest.mark.github
@@ -424,12 +278,6 @@ def test_miot_data_sort():
                 f'{SPEC_FILTER_FILE} not sorted, goto project root path'
                 ' and run the following command sorting, ',
                 'pytest -s -v -m update ./test/check_rule_format.py')
-    assert json.dumps(
-        load_json_file(file_path=CUSTOM_SERVICE_FILE)) == json.dumps(
-            sort_custom_service(file_path=CUSTOM_SERVICE_FILE)), (
-                f'{CUSTOM_SERVICE_FILE} not sorted, goto project root path'
-                ' and run the following command sorting, ',
-                'pytest -s -v -m update ./test/check_rule_format.py')
 
 
 @pytest.mark.update
@@ -443,6 +291,3 @@ def test_sort_spec_data():
     sort_data = sort_spec_filter(file_path=SPEC_FILTER_FILE)
     save_json_file(file_path=SPEC_FILTER_FILE, data=sort_data)
     print(SPEC_FILTER_FILE, 'formatted.')
-    sort_data = sort_custom_service(file_path=CUSTOM_SERVICE_FILE)
-    save_json_file(file_path=CUSTOM_SERVICE_FILE, data=sort_data)
-    print(CUSTOM_SERVICE_FILE, 'formatted.')