aas-standard-parser 0.3.2__tar.gz → 0.3.4__tar.gz

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/PKG-INFO

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

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser/__init__.py

@@ -1,22 +1,23 @@
 """AAS Standard parser Package."""
 
 import importlib.metadata
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from aas_standard_parser import (
     aas_parser,
     aid_parser,
     aimc_parser,
     collection_helpers,
+    descriptor_json_helper,
     reference_helpers,
-    submodel_json_parser,
+    submodel_json_helper,
     submodel_parser,
     utils,
 )
 from aas_standard_parser.aid_parser import AIDParser
 from aas_standard_parser.version_check import check_for_update
 
-__copyright__ = f"Copyright (C) {datetime.now(tz=timezone.utc).year} Fluid 4.0. All rights reserved."
+__copyright__ = f"Copyright (C) {datetime.now(tz=UTC).year} Fluid 4.0. All rights reserved."
 __author__ = "Daniel Klein, Celina Adelhardt, Tom Gneuß"
 
 try:
@@ -37,8 +38,9 @@ __all__ = [
     "aid_parser",
     "aimc_parser",
     "collection_helpers",
+    "descriptor_json_helper",
     "reference_helpers",
-    "submodel_json_parser",
+    "submodel_json_helper",
     "submodel_parser",
     "utils",
 ]

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser/aid_parser.py

@@ -1,76 +1,88 @@
 """This module provides functions to parse AID Submodels and extract MQTT interface descriptions."""
 
 import base64
-from typing import Dict, List
 
-from basyx.aas.model import (
-    Property,
-    SubmodelElement,
-    SubmodelElementCollection,
-    SubmodelElementList,
-)
+from basyx.aas import model
 
 from aas_standard_parser.collection_helpers import find_all_by_semantic_id, find_by_id_short, find_by_semantic_id
 
 
 class IProtocolBinding:
+    """Interface for protocol binding details."""
+
     def __init__(self):
-        pass
+        """Initialize IProtocolBinding."""
 
 
 class HttpProtocolBinding(IProtocolBinding):
-    def __init__(self, method_name: str, headers: Dict[str, str]):
+    """HTTP protocol binding details."""
+
+    def __init__(self, method_name: str, headers: dict[str, str]):
+        """Initialize HttpProtocolBinding."""
         super().__init__()
         self.method_name = method_name
         self.headers = headers
 
 
 class PropertyDetails:
-    def __init__(self, href: str, keys: List[str], protocol_binding: IProtocolBinding = None):
+    """Details of a property in an AID interface."""
+
+    def __init__(self, href: str, keys: list[str], protocol_binding: IProtocolBinding = None):
+        """Initialize PropertyDetails."""
         self.href = href
         self.keys = keys
         self.protocol_binding = protocol_binding
 
 
 class IAuthenticationDetails:
+    """Interface for authentication details."""
+
     def __init__(self):
+        """Initialize IAuthenticationDetails."""
         # TODO: different implementations for different AID versions
-        pass
 
 
 class BasicAuthenticationDetails(IAuthenticationDetails):
+    """Basic authentication details."""
+
     def __init__(self, user: str, password: str):
+        """Initialize BasicAuthenticationDetails."""
         self.user = user
         self.password = password
         super().__init__()
 
 
 class NoAuthenticationDetails(IAuthenticationDetails):
+    """No authentication details."""
+
     def __init__(self):
+        """Initialize NoAuthenticationDetails."""
         super().__init__()
 
 
 class AIDParser:
+    """Parser for Asset Interface Descriptions (AID) Submodels."""
+
     def __init__(self):
-        pass
+        """Initialize the AIDParser."""
 
-    def parse_base(self, aid_interface: SubmodelElementCollection) -> str:
+    def parse_base(self, aid_interface: model.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(
+        endpoint_metadata: model.SubmodelElementCollection | None = find_by_semantic_id(
             aid_interface.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata"
         )
         if endpoint_metadata is None:
             raise ValueError(f"'EndpointMetadata' SMC not found in the provided '{aid_interface.id_short}' SMC.")
 
-        base: Property | None = find_by_semantic_id(endpoint_metadata.value, "https://www.w3.org/2019/wot/td#baseURI")
+        base: model.Property | None = find_by_semantic_id(endpoint_metadata.value, "https://www.w3.org/2019/wot/td#baseURI")
         if base is None:
             raise ValueError("'base' Property not found in 'EndpointMetadata' SMC.")
 
         return base.value
 
-    def parse_properties(self, aid_interface: SubmodelElementCollection) -> Dict[str, PropertyDetails]:
+    def parse_properties(self, aid_interface: model.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
         that are necessary to extract their value from the payload of the interface.
@@ -78,32 +90,32 @@ class AIDParser:
         :param aid_interface: An SMC describing an interface in the AID.
         :return: A dictionary mapping each property (represented by its idShort-path) to PropertyDetails.
         """
-        mapping: Dict[str, PropertyDetails] = {}
+        mapping: dict[str, PropertyDetails] = {}
 
-        interaction_metadata: SubmodelElementCollection | None = find_by_semantic_id(
+        interaction_metadata: model.SubmodelElementCollection | None = find_by_semantic_id(
             aid_interface.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/InteractionMetadata"
         )
         if interaction_metadata is None:
             raise ValueError(f"'InteractionMetadata' SMC not found in the provided '{aid_interface.id_short}' SMC.")
 
-        properties: SubmodelElementCollection | None = find_by_semantic_id(
+        properties: model.SubmodelElementCollection | None = find_by_semantic_id(
             interaction_metadata.value, "https://www.w3.org/2019/wot/td#PropertyAffordance"
         )
         if properties is None:
             raise ValueError("'properties' SMC not found in 'InteractionMetadata' SMC.")
 
-        fl_properties: List[SubmodelElement] = find_all_by_semantic_id(
+        fl_properties: list[model.SubmodelElement] = find_all_by_semantic_id(
             properties.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/PropertyDefinition"
         )
         if fl_properties is None:
-            print(f"WARN: No first-level 'property' SMC not found in 'properties' SMC.")
+            print("WARN: No first-level 'property' SMC not found in 'properties' SMC.")
             return {}
 
         def traverse_property(
-            smc: SubmodelElementCollection,
+            smc: model.SubmodelElementCollection,
             parent_path: str,
             href: str,
-            key_path: List[str | int],
+            key_path: list[str | int],
             is_items=False,
             idx=None,
             is_top_level=False,
@@ -151,13 +163,13 @@ class AIDParser:
                 "https://www.w3.org/2019/wot/json-schema#properties",
                 "https://www.w3.org/2019/wot/json-schema#items",
             ]:
-                nested_group: SubmodelElementCollection | None = find_by_semantic_id(smc.value, nested_sem_id)
+                nested_group: model.SubmodelElementCollection | None = find_by_semantic_id(smc.value, nested_sem_id)
                 if nested_group:
                     # attach the name of that SMC ("items" or "properties" or similar) to the key_path
                     full_path += "." + nested_group.id_short
 
                     # find all nested properties/items by semantic-ID
-                    nested_properties: List[SubmodelElement] = find_all_by_semantic_id(
+                    nested_properties: list[model.SubmodelElement] = find_all_by_semantic_id(
                         nested_group.value, "https://www.w3.org/2019/wot/json-schema#propertyName"
                     )
 
@@ -171,11 +183,11 @@ class AIDParser:
 
         # process all first-level 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")
+            forms: model.SubmodelElementCollection | None = find_by_semantic_id(fl_property.value, "https://www.w3.org/2019/wot/td#hasForm")
             if forms is None:
                 raise ValueError(f"'forms' SMC not found in '{fl_property.id_short}' SMC.")
 
-            href: Property | None = find_by_semantic_id(forms.value, "https://www.w3.org/2019/wot/hypermedia#hasTarget")
+            href: model.Property | None = find_by_semantic_id(forms.value, "https://www.w3.org/2019/wot/hypermedia#hasTarget")
             if href is None:
                 raise ValueError("'href' Property not found in 'forms' SMC.")
 
@@ -192,14 +204,14 @@ class AIDParser:
             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")
+            htv_method_name: model.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")
+                htv_headers: model.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")
+                    for header in htv_headers.value:  # type: ignore # type: SubmodelElementCollection
+                        htv_field_name: model.Property | None = find_by_semantic_id(header.value, "https://www.w3.org/2011/http#fieldName")
+                        htv_field_value: model.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
@@ -220,19 +232,21 @@ class AIDParser:
 
         return mapping
 
-    def parse_security(self, aid_interface: SubmodelElementCollection) -> IAuthenticationDetails:
+    def parse_security(self, aid_interface: model.SubmodelElementCollection) -> IAuthenticationDetails:
         """Extract the authentication details (EndpointMetadata.security) from the provided interface in the AID.
 
         :param aid_interface: An SMC describing an interface in the AID.
         :return: A subtype of IAuthenticationDetails with details depending on the specified authentication method for the interface.
         """
-        endpoint_metadata: SubmodelElementCollection | None = find_by_semantic_id(
+        endpoint_metadata: model.SubmodelElementCollection | None = find_by_semantic_id(
             aid_interface.value, "https://admin-shell.io/idta/AssetInterfacesDescription/1/0/EndpointMetadata"
         )
         if endpoint_metadata is None:
             raise ValueError(f"'EndpointMetadata' SMC not found in the provided '{aid_interface.id_short}' SMC.")
 
-        security: SubmodelElementList | None = find_by_semantic_id(endpoint_metadata.value, "https://www.w3.org/2019/wot/td#hasSecurityConfiguration")
+        security: model.SubmodelElementList | None = find_by_semantic_id(
+            endpoint_metadata.value, "https://www.w3.org/2019/wot/td#hasSecurityConfiguration"
+        )
         if security is None:
             raise ValueError("'security' SML not found in 'EndpointMetadata' SMC.")
 
@@ -244,19 +258,19 @@ class AIDParser:
         sc_idshort = security.value[0].value.key[-1].value
 
         # get the securityDefinitions SMC
-        security_definitions: SubmodelElementCollection | None = find_by_semantic_id(
+        security_definitions: model.SubmodelElementCollection | None = find_by_semantic_id(
             endpoint_metadata.value, "https://www.w3.org/2019/wot/td#definesSecurityScheme"
         )
         if security_definitions is None:
             raise ValueError("'securityDefinitions' SMC not found in 'EndpointMetadata' SMC.")
 
         # find the security scheme SMC with the same idShort as mentioned in the reference "sc"
-        referenced_security: SubmodelElementCollection | None = find_by_id_short(security_definitions.value, sc_idshort)
+        referenced_security: model.SubmodelElementCollection | None = find_by_id_short(security_definitions.value, sc_idshort)
         if referenced_security is None:
             raise ValueError(f"Referenced security scheme '{sc_idshort}' SMC not found in 'securityDefinitions' SMC")
 
         # get the name of the security scheme
-        scheme: Property | None = find_by_semantic_id(referenced_security.value, "https://www.w3.org/2019/wot/security#SecurityScheme")
+        scheme: model.Property | None = find_by_semantic_id(referenced_security.value, "https://www.w3.org/2019/wot/security#SecurityScheme")
         if scheme is None:
             raise ValueError(f"'scheme' Property not found in referenced security scheme '{sc_idshort}' SMC.")
 
@@ -267,7 +281,7 @@ class AIDParser:
                 auth_details = NoAuthenticationDetails()
 
             case "basic":
-                basic_sc_name: Property | None = find_by_semantic_id(referenced_security.value, "https://www.w3.org/2019/wot/security#name")
+                basic_sc_name: model.Property | None = find_by_semantic_id(referenced_security.value, "https://www.w3.org/2019/wot/security#name")
                 if basic_sc_name is None:
                     raise ValueError("'name' Property not found in 'basic_sc' SMC")
 

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser/aimc_parser.py

@@ -53,11 +53,11 @@ def get_mapping_configuration_elements(aimc_submodel: model.Submodel) -> list[mo
     return mapping_configurations
 
 
-def parse_mapping_configurations(aimc_submodel: model.Submodel) -> MappingConfigurations:
+def parse_mapping_configurations(aimc_submodel: model.Submodel) -> MappingConfigurations | None:
     """Parse all mapping configurations in the AIMC submodel.
 
     :param aimc_submodel: The AIMC submodel to parse mapping configurations from.
-    :return: A list of parsed mapping configurations.
+    :return: A list of parsed mapping configurations or None if parsing failed.
     """
     logger.info("Parse mapping configurations from AIMC submodel.")
 
@@ -67,7 +67,7 @@ def parse_mapping_configurations(aimc_submodel: model.Submodel) -> MappingConfig
     mapping_configurations_elements = get_mapping_configuration_elements(aimc_submodel)
     if mapping_configurations_elements is None:
         logger.error("No mapping configuration elements found in AIMC submodel.")
-        return mapping_configurations_elements
+        return None
 
     # parse each mapping configuration element
     for mc_element in mapping_configurations_elements:

aas_standard_parser-0.3.4/aas_standard_parser/classes/descriptor_json_helper_classes.py

@@ -0,0 +1,12 @@
+"""Helper classes for descriptor JSON parsing."""
+
+
+class EndPointHrefData:
+    """Class to represent an endpoint href data structure."""
+
+    def __init__(self, href: str):
+        """Initialize the EndPointHrefData with the given href."""
+        self.href: str = href
+        self.base_url: str = ""
+        self.identifier: str = ""
+        self.identifier_encoded: str = ""

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser/collection_helpers.py

@@ -87,5 +87,8 @@ def contains_supplemental_semantic_id(element: SubmodelElement, semantic_id_valu
     :param semantic_id_value: The supplemental semantic ID value to search for.
     :return: True if the element contains the supplemental semantic ID, False otherwise.
     """
+    if element.supplemental_semantic_id is None or len(element.supplemental_semantic_id.key) == 0:
+        return False
+
     reference: Reference = ExternalReference((Key(type_=KeyTypes.GLOBAL_REFERENCE, value=semantic_id_value),))
     return element.supplemental_semantic_id.__contains__(reference)

aas_standard_parser-0.3.4/aas_standard_parser/descriptor_json_helper.py

@@ -0,0 +1,64 @@
+"""Module for parsing descriptor JSON data."""
+
+import logging
+
+from aas_standard_parser.classes.descriptor_json_helper_classes import EndPointHrefData
+from aas_standard_parser.utils import decode_base_64, encode_base_64
+
+logger = logging.getLogger(__name__)
+
+
+def get_endpoint_href_by_index(descriptor_data: dict, endpoint_index: int = 0) -> str | None:
+    """Get the href from a descriptor's endpoints.
+
+    :param descriptor_data: The descriptor data containing endpoints.
+    :param endpoint_index: The index of the endpoint to extract the href from.
+    :return: The href string if found, otherwise None.
+    """
+    endpoints = get_endpoint_hrefs(descriptor_data)
+
+    if not endpoints or len(endpoints) == 0:
+        logger.warning(f"No endpoints found in descriptor {descriptor_data}")
+        return None
+
+    if endpoint_index >= len(endpoints):
+        logger.warning(f"Endpoint index {endpoint_index} out of range for descriptor {descriptor_data}")
+        return None
+
+    return endpoints[endpoint_index]
+
+
+def get_endpoint_hrefs(descriptor_data: dict) -> list[str]:
+    """Get all hrefs from a descriptor's endpoints.
+
+    :param descriptor_data: The descriptor data containing endpoints.
+    :return: A list of href strings extracted from the endpoints.
+    """
+    return [endpoint.get("protocolInformation", {}).get("href", "") for endpoint in descriptor_data.get("endpoints", [])]
+
+
+def parse_endpoint_href(href: str) -> EndPointHrefData | None:
+    """Parse the endpoint href into its components.
+
+    :param href: The href string to parse.
+    :return: An EndPointHrefData object containing parsed components.
+    """
+    if "shells/" not in href and "submodels/" not in href:
+        logger.warning(f"Invalid href format: {href}")
+        return None
+
+    split_str = ""
+    if "/shells/" in href:
+        split_str = "/shells/"
+    elif "/submodels/" in href:
+        split_str = "/submodels/"
+
+    base_url: str = href.split(split_str, maxsplit=1)[0]
+    identifier: str = href.split(split_str)[1]
+
+    href_data = EndPointHrefData(href)
+    href_data.base_url = base_url
+    href_data.identifier = identifier
+    href_data.identifier_encoded = encode_base_64(identifier)
+
+    return href_data

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser/utils.py

@@ -1,5 +1,6 @@
 """Utility functions for AAS standard parser."""
 
+import base64
 import json
 import logging
 from pathlib import Path
@@ -48,3 +49,25 @@ def _convert_to_object(content: dict) -> Any | None:
         logger.error(f"Decoding error: {e}")
         logger.error(f"In JSON: {content}")
         return None
+
+
+def decode_base_64(text: str) -> str:
+    """Decode a Base64 encoded string.
+
+    :param text: Base64 encoded string to decode
+    :return:  Decoded string
+    """
+    text_bytes = text.encode("utf-8")
+    base64_bytes = base64.b64encode(text_bytes)
+    return base64_bytes.decode("utf-8")
+
+
+def encode_base_64(text: str) -> str:
+    """Encode a string to Base64.
+
+    :param text: String to encode
+    :return: Base64 encoded string
+    """
+    text_bytes = text.encode("utf-8")
+    base64_bytes = base64.b64decode(text_bytes)
+    return base64_bytes.decode("utf-8")

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser.egg-info/PKG-INFO

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

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/aas_standard_parser.egg-info/SOURCES.txt

@@ -6,8 +6,9 @@ aas_standard_parser/aas_parser.py
 aas_standard_parser/aid_parser.py
 aas_standard_parser/aimc_parser.py
 aas_standard_parser/collection_helpers.py
+aas_standard_parser/descriptor_json_helper.py
 aas_standard_parser/reference_helpers.py
-aas_standard_parser/submodel_json_parser.py
+aas_standard_parser/submodel_json_helper.py
 aas_standard_parser/submodel_parser.py
 aas_standard_parser/utils.py
 aas_standard_parser/version_check.py
@@ -17,6 +18,8 @@ aas_standard_parser.egg-info/dependency_links.txt
 aas_standard_parser.egg-info/requires.txt
 aas_standard_parser.egg-info/top_level.txt
 aas_standard_parser/classes/aimc_parser_classes.py
+aas_standard_parser/classes/descriptor_json_helper_classes.py
 aas_standard_parser/demo/demo_process.py
 aas_standard_parser/demo/logging_handler.py
-tests/test_aimc_parser.py
+tests/test_aimc_parser.py
+tests/test_descriptor_json_helper.py

{aas_standard_parser-0.3.2 → aas_standard_parser-0.3.4}/pyproject.toml

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

aas_standard_parser-0.3.4/tests/test_descriptor_json_helper.py

@@ -0,0 +1,18 @@
+import pytest
+from basyx.aas import model
+
+from aas_standard_parser.descriptor_json_helper import parse_endpoint_href
+
+
+@pytest.fixture(scope="module")
+def href() -> model.Property:
+    # create a Submodel
+    return "http://aas-server:8075/shells/aHR0cHM6Ly9mbHVpZDQwLmRlL2lkcy9zaGVsbC81NzkzXzU0NDlfNzgzMF80MjIz"
+
+def test_001_get_mapping_configuration_root_element(href: str):
+    href_data = parse_endpoint_href(href)
+
+    assert href_data is not None
+    assert href_data.base_url == "http://aas-server:8075"
+    assert href_data.identifier == "aHR0cHM6Ly9mbHVpZDQwLmRlL2lkcy9zaGVsbC81NzkzXzU0NDlfNzgzMF80MjIz"
+    assert href_data.identifier_encoded == "https://fluid40.de/ids/shell/5793_5449_7830_4223"