aas-standard-parser 0.1.6__tar.gz → 0.1.7__tar.gz

{aas_standard_parser-0.1.6 → aas_standard_parser-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-standard-parser
-Version: 0.1.6
+Version: 0.1.7
 Summary: Some auxiliary functions for parsing standard submodels
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: MIT License

{aas_standard_parser-0.1.6 → aas_standard_parser-0.1.7}/aas_standard_parser/aid_parser.py

@@ -5,17 +5,32 @@ from typing import Dict, List
 from basyx.aas.model import (
     Property,
     SubmodelElement,
-    SubmodelElementCollection, SubmodelElementList, Submodel,
+    SubmodelElementCollection, SubmodelElementList,
 )
 
 from aas_standard_parser.collection_helpers import find_by_semantic_id, find_all_by_semantic_id, find_by_id_short
 
 
+class IProtocolBinding:
+
+    def __init__(self):
+        pass
+
+
+class HttpProtocolBinding(IProtocolBinding):
+
+    def __init__(self, method_name: str, headers: Dict[str, str]):
+        super().__init__()
+        self.method_name = method_name
+        self.headers = headers
+
+
 class PropertyDetails:
 
-    def __init__(self, href: str, keys: List[str]):
+    def __init__(self, href: str, keys: List[str], protocol_binding: IProtocolBinding = None):
         self.href = href
         self.keys = keys
+        self.protocol_binding = protocol_binding
 
 
 class IAuthenticationDetails:
@@ -44,7 +59,7 @@ class AIDParser():
     def __init__(self):
         pass
 
-    def get_base_url_from_interface(self, aid_interface: SubmodelElementCollection) -> str:
+    def parse_base(self, aid_interface: SubmodelElementCollection) -> str:
         """Get the base address (EndpointMetadata.base) from a SMC describing an interface in the AID."""
 
         endpoint_metadata: SubmodelElementCollection | None = find_by_semantic_id(
@@ -62,7 +77,7 @@ class AIDParser():
         return base.value
 
 
-    def create_property_to_href_map(self, aid_interface: SubmodelElementCollection) -> Dict[str, PropertyDetails]:
+    def parse_properties(self, aid_interface: SubmodelElementCollection) -> Dict[str, PropertyDetails]:
         """Find all first-level and nested properties in a provided SMC describing one interface in the AID.
         Map each property (either top-level or nested) to the according 'href' attribute.
         Nested properties are further mapped to the hierarchical list of keys
@@ -88,38 +103,53 @@ class AIDParser():
         fl_properties: List[SubmodelElement] = find_all_by_semantic_id(
             properties.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition"
         )
-        # TODO: some AIDs have typos in that semanticId but we only support the official ones
-        #fl_properties_alternative: List[SubmodelElement] = find_all_by_semantic_id(
-        #    properties.value, "https://admin-shell.io/idta/AssetInterfaceDescription/1/0/PropertyDefinition"
-        #)
-        #fl_properties.extend(fl_properties_alternative)
         if fl_properties is None:
-            #raise ValueError(f"No first-level 'property' SMC not found in 'properties' SMC.")
+            print(f"WARN: No first-level 'property' SMC not found in 'properties' SMC.")
             return {}
 
-        def traverse_property(smc: SubmodelElementCollection, parent_path: str, href: str, key_path: List[str | int],
-                              is_items=False, idx=None, is_top_level=False):
+        def traverse_property(smc: SubmodelElementCollection, parent_path: str, href: str,
+                              key_path: List[str | int], is_items=False, idx=None, is_top_level=False,
+                              protocol_binding: IProtocolBinding = None):
             # determine local key only if not top-level
             if not is_top_level:
                 if is_items and idx is not None:
-                    local_key = idx  # integer index
+                    # is a nested "items" property -> add index to the list of keys
+                    local_key = idx
                 else:
+                    # is a nested "properties" property -> add value of "key" attribute or idShort to list of keys
                     key_prop = find_by_semantic_id(
                         smc.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key"
                     )
-                    local_key = key_prop.value if key_prop else smc.id_short  # string
+                    local_key = key_prop.value if key_prop else smc.id_short
                 new_key_path = key_path + [local_key]
             else:
-                new_key_path = key_path  # top-level: no key added
-
-            # register this property
+                # TODO: use the key of the first-level property (or its idShort otherwise)
+                # is a top-level property
+                #key_prop: Property | None = find_by_semantic_id(
+                #    smc.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/key"
+                #)
+                #local_key = key_prop.value if key_prop else smc.id_short
+                #new_key_path = [local_key]
+
+                new_key_path = key_path
+                # NOTE (Tom Gneuß, 2025-10-20)
+                # See GitHub Issue: https://github.com/admin-shell-io/submodel-templates/issues/197
+                # First-level properties are allowed to have a "key" attribute - otherwise the idShort path is used.
+                # However, complex first-level properties would represent, e.g., the JSON payload (object) itself.
+                # This JSON payload does only have keys for nested elements.
+                # So, using the key (or idShort) of the first-level property to get the JSON object from the payload
+                # is not possible.
+                # On the other hand: the first-level property could intentionally be something within the JSON object.
+                # In that case, having a "key" (or using the idSort) is entirely valid.
+                # How to distinguish both cases?
+
+            # create the idShort path of this property
             full_path = f"{parent_path}.{smc.id_short}"
-            mapping[full_path] = PropertyDetails(href, new_key_path)
+            # add this property with all its details to the mapping -> href (from top-level parent if this is nested),
+            # protocol bindings (from top-level parent if this is nested), list of keys
+            mapping[full_path] = PropertyDetails(href, new_key_path, protocol_binding)
 
             # traverse nested "properties" or "items"
-            # (nested properties = object members, nested items = array elements)
-            # TODO: some apparently use the wrong semanticId:
-            # "https://www.w3.org/2019/wot/td#PropertyAffordance"
             for nested_sem_id in [
                 "https://www.w3.org/2019/wot/json-schema#properties",
                 "https://www.w3.org/2019/wot/json-schema#items",
@@ -133,26 +163,17 @@ class AIDParser():
                     nested_properties: List[SubmodelElement] = find_all_by_semantic_id(
                         nested_group.value, "https://www.w3.org/2019/wot/json-schema#propertyName"
                     )
-                    # TODO: some AIDs have typos or use wrong semanticIds but we only support the official ones
-                    #nested_properties_alternative1: List[SubmodelElement] = find_all_by_semantic_id(
-                    #    nested_group.value, "https://admin-shell.io/idta/AssetInterfaceDescription/1/0/PropertyDefinition"
-                    #)
-                    # nested_properties_alternative2: List[SubmodelElement] = find_all_by_semantic_id(
-                    #    nested_group.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition"
-                    # )
-                    #nested_properties.extend(nested_properties_alternative1)
-                    #nested_properties.extend(nested_properties_alternative2)
 
                     # traverse all nested properties/items recursively
                     for idx, nested in enumerate(nested_properties):
                         if nested_sem_id.endswith("#items"):
-                            # for arrays: append index instead of property key
+                            # for arrays: append index instead of "key" attribute
                             traverse_property(nested, full_path, href, new_key_path, is_items=True, idx=idx)
                         else:
                             traverse_property(nested, full_path, href, new_key_path)
 
         # process all first-level properties
-        for fl_property in fl_properties:
+        for fl_property in fl_properties:   # type: SubmodelElementCollection
             forms: SubmodelElementCollection | None = find_by_semantic_id(
                 fl_property.value, "https://www.w3.org/2019/wot/td#hasForm"
             )
@@ -165,15 +186,51 @@ class AIDParser():
             if href is None:
                 raise ValueError("'href' Property not found in 'forms' SMC.")
 
+            # get the href value of the first-level property
             href_value = href.value
+
+            # construct the idShort path up to "Interface_.InteractionMetadata.properties"
+            # will be used as prefix for the idShort paths of the first-level and nested properties
             idshort_path_prefix = f"{aid_interface.id_short}.{interaction_metadata.id_short}.{properties.id_short}"
 
+            # check which protocol-specific subtype of forms is used
+            # there is no clean solution for determining the subtype (e.g., a supplSemId)
+            # -> can only be figured out if the specific fields are present
+            protocol_binding: IProtocolBinding = None
+
+            # ... try HTTP ("htv_methodName" must be present)
+            htv_method_name: Property | None = find_by_semantic_id(
+                forms.value, "https://www.w3.org/2011/http#methodName"
+            )
+            if htv_method_name is not None:
+                protocol_binding: HttpProtocolBinding = HttpProtocolBinding(htv_method_name.value, {})
+                htv_headers: SubmodelElementCollection | None = find_by_semantic_id(
+                    forms.value, "https://www.w3.org/2011/http#headers"
+                )
+                if htv_headers is not None:
+                    for header in htv_headers.value:    # type: SubmodelElementCollection
+                        htv_field_name: Property | None = find_by_semantic_id(
+                            header.value, "https://www.w3.org/2011/http#fieldName"
+                        )
+                        htv_field_value: Property | None = find_by_semantic_id(
+                            header.value, "https://www.w3.org/2011/http#fieldValue"
+                        )
+                        protocol_binding.headers[htv_field_name.value] = htv_field_value.value
+
+            # TODO: the other protocols
+            # ... try Modbus
+            # ... try MQTT
+
+            # recursively parse the first-level property and its nested properties (if any)
             traverse_property(
-                fl_property,
-                idshort_path_prefix,
-                href_value,
-                [],
-                is_top_level=True
+                smc=fl_property,
+                parent_path=idshort_path_prefix,
+                href=href_value,
+                key_path=[],
+                is_items=False,
+                idx=None,
+                is_top_level=True,
+                protocol_binding=protocol_binding
             )
 
         return mapping

{aas_standard_parser-0.1.6 → aas_standard_parser-0.1.7}/aas_standard_parser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-standard-parser
-Version: 0.1.6
+Version: 0.1.7
 Summary: Some auxiliary functions for parsing standard submodels
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: MIT License

{aas_standard_parser-0.1.6 → aas_standard_parser-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-standard-parser"
-version = "0.1.6"
+version = "0.1.7"
 description = "Some auxiliary functions for parsing standard submodels"
 readme = "README.md"
 license = { file = "LICENSE" }