aas-standard-parser 0.2.6__py3-none-any.whl → 0.2.7__py3-none-any.whl

aas_standard_parser/__init__.py

@@ -1,11 +1,26 @@
+"""AAS Standard parser Package."""
+
 import importlib.metadata
-from datetime import datetime
+from datetime import datetime, timezone
+
+from aas_standard_parser import (
+    aas_parser,
+    aid_parser,
+    aimc_parser,
+    collection_helpers,
+    reference_helpers,
+    submodel_json_parser,
+    submodel_parser,
+    utils,
+)
+from aas_standard_parser.aid_parser import AIDParser
+from aas_standard_parser.version_check import check_for_update
 
-# TODO: introduce MIT license
-__copyright__ = f"Copyright (C) {datetime.now().year} :em engineering methods AG. All rights reserved."
+__copyright__ = f"Copyright (C) {datetime.now(tz=timezone.utc).year} Fluid 4.0. All rights reserved."
 __author__ = "Daniel Klein, Celina Adelhardt, Tom Gneuß"
 
 try:
+    __license__ = "MIT"
     __version__ = importlib.metadata.version(__name__)
 except importlib.metadata.PackageNotFoundError:
     __version__ = "0.0.0-dev"
@@ -13,7 +28,17 @@ except importlib.metadata.PackageNotFoundError:
 __project__ = "aas-standard-parser"
 __package__ = "aas-standard-parser"
 
-from aas_standard_parser import aas_parser, aid_parser, aimc_parser, submodel_parser
-from aas_standard_parser.aid_parser import AIDParser
 
-__all__ = ["AIDParser", "aimc_parser", "aas_parser", "aid_parser", "submodel_parser"]
+check_for_update()
+
+__all__ = [
+    "AIDParser",
+    "aas_parser",
+    "aid_parser",
+    "aimc_parser",
+    "collection_helpers",
+    "reference_helpers",
+    "submodel_json_parser",
+    "submodel_parser",
+    "utils",
+]

aas_standard_parser/aas_parser.py

@@ -8,10 +8,10 @@ logger = logging.getLogger(__name__)
 
 
 def get_submodel_ids(shell: model.AssetAdministrationShell) -> list[str]:
-    """Get all submodel IDs from the given AAS.
+    """Get all IDs from the submodels referenced in the given AAS.
 
-    :param shell: parent AAS to search within
-    :return: list of submodel IDs
+    :param shell: The Asset Administration Shell to extract submodel IDs from.
+    :return: A list of submodel IDs referenced in the AAS.
     """
     submodel_ids = []
     for submodel in shell.submodel:

aas_standard_parser/reference_helpers.py

@@ -1,15 +1,22 @@
+"""Helper functions for working with ModelReference objects in the AAS standard parser."""
+
 from basyx.aas.model import ModelReference
 
 
-def construct_idshort_path_from_reference(reference: ModelReference) -> str:
-    idshort_path: str = ""
+def construct_id_short_path_from_reference(reference: ModelReference) -> str:
+    """Constructs an idShort path from the given ModelReference.
+
+    :param reference: The ModelReference to construct the idShort path from.
+    :return: The constructed idShort path as a string.
+    """
+    id_short_path: str = ""
 
     # start from the second Key and omit the Identifiable at the beginning of the list
     for key in reference.key[1:]:
-        idshort_path += key.value + "."
+        id_short_path += key.value + "."
 
     # get rid of the trailing dot
-    return idshort_path[:-1]
+    return id_short_path[:-1]
 
 
 def get_values_from_keys(reference: ModelReference) -> list[str]:

aas_standard_parser/submodel_json_parser.py

@@ -0,0 +1,35 @@
+"""Module for parsing submodels JSON data."""
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def get_value_from_semantic_id_by_index(submodel_data: dict, index: int) -> str | None:
+    """Retrieve the value from the semantic ID from a submodel JSON dictionary by index.
+
+    :param submodel_data: The submodel data as a dictionary.
+
+    :param index: The index to access if the element is a list or collection.
+    :return: The value of the found submodel element or None if not found.
+    """
+    if "semantic_id" not in submodel_data or len(submodel_data.semantic_id.key) == 0:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID")
+        return None
+
+    sm_semantic_id = submodel_data.get("semantic_id", {})
+    if "keys" not in sm_semantic_id or len(sm_semantic_id["keys"]) == 0:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID keys")
+        return None
+
+    if len(sm_semantic_id["keys"]) < index + 1:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID key at index {index}")
+        return None
+
+    key = sm_semantic_id["keys"][index]
+
+    if "value" not in key:
+        logger.debug(f"Submodel '{submodel_data}' has no semantic ID value")
+        return None
+
+    return key["value"]

aas_standard_parser/submodel_parser.py

@@ -3,32 +3,19 @@
 import logging
 
 from basyx.aas import model
-from basyx.aas.model import NamespaceSet, SubmodelElement
-
-from aas_standard_parser import collection_helpers
 
 logger = logging.getLogger(__name__)
 
 
-def get_element_by_semantic_id(collection: NamespaceSet[SubmodelElement], semantic_id: str) -> SubmodelElement | None:
-    """Get an element from parent collection by its semantic ID (not recursive).
-
-    :param parent: parent collection to search within
-    :param semantic_id: semantic ID to search for
-    :return: the found submodel element or None if not found
-    """
-    return collection_helpers.find_by_semantic_id(collection, semantic_id)
-
-
-def get_submodel_element_by_path(submodel: model.Submodel, path: str) -> model.SubmodelElement:
-    """Returns a specific submodel element from the submodel at a specific path.
+def get_submodel_element_by_id_short_path(submodel: model.Submodel, id_short_path: str) -> model.SubmodelElement:
+    """Retrieve a specific submodel element from the submodel at a specific idShort path.
 
     :param submodel: The submodel to search within.
-    :param path: IdShort path to the submodel element (dot-separated), e.g., "Element1.Element2[0].Element3".
+    :param id_short_path: IdShort path to the submodel element (dot-separated), e.g., "Element1.Element2[0].Element3".
     :return: The found submodel element or None if not found.
     """
     # Split the path by '.' and traverse the structure
-    parts = path.split(".")
+    parts = id_short_path.split(".")
     current_elements = submodel.submodel_element
     part_index = 0
     for part in parts:

aas_standard_parser/utils.py

@@ -1,3 +1,5 @@
+"""Utility functions for AAS standard parser."""
+
 import json
 from pathlib import Path
 
@@ -6,19 +8,19 @@ from basyx.aas import model
 
 
 def create_submodel_from_file(file_path: str) -> model.Submodel:
-    """Creates a Submodel from a given file path.
+    """Loads a Submodel structure from a given JSON file and converts it into a model.Submodel object from the python SDK framework.
 
-    :param file_path: Path to the file containing the submodel data.
-    :return: The created Submodel object.
+    :param file_path: Path to the JSON file containing the Submodel structure.
+    :return: A model.Submodel object representing the loaded Submodel structure.
     """
     file = Path(file_path)
     if not file.exists():
-        raise FileNotFoundError(f"Submodel template file not found: {file}")
+        raise FileNotFoundError(f"Submodel structure file not found: {file}")
 
     template_data = {}
 
     # Load the template JSON file
-    with open(file, "r", encoding="utf-8") as f:
+    with file.open("r", encoding="utf-8") as f:
         template_data = json.load(f)
 
     # Load the template JSON into a Submodel object

aas_standard_parser/version_check.py

@@ -0,0 +1,28 @@
+"""Utility functions for version checking."""
+
+import importlib.metadata
+import logging
+
+import requests
+
+logger = logging.getLogger(__name__)
+
+
+def check_for_update(package_name="aas-standard-parser"):
+    """Check for updates of the package on PyPI.
+
+    :param package_name: The name of the package to check for updates, defaults to "aas-standard-parser"
+    """
+    try:
+        current_version = importlib.metadata.version(package_name)
+        pypi_url = f"https://pypi.org/pypi/{package_name}/json"
+        latest_version = requests.get(pypi_url, timeout=3).json()["info"]["version"]
+
+        if current_version != latest_version:
+            print(
+                f"⚠️  A new version for package '{package_name}' is available: "
+                f"{latest_version} (currently installed: {current_version}). "
+                f"Use the following command to update the package: pip install --upgrade {package_name}"
+            )
+    except Exception as exc:
+        logger.exception(f"Exception occurred while checking for package update: {exc}")

aas_standard_parser-0.2.7.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: aas-standard-parser
+Version: 0.2.7
+Summary: Some auxiliary functions for parsing standard submodels
+Author-email: Daniel Klein <daniel.klein@em.ag>
+License: MIT License
+        
+        Copyright (c) 2025 Fluid4.0
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/fluid40/aas-http-client
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing>=3.7.4.3
+Requires-Dist: basyx-python-sdk>=1.2.1
+Dynamic: license-file
+
+# aas-standard-parser
+
+<div align="center">
+<!-- change this to your projects logo if you have on.
+  If you don't have one it might be worth trying chatgpt dall-e to create one for you...
+ -->
+<img src="docs/assets/fluid_logo.svg" alt="aas_http_client" width=500 />
+</div>
+
+---
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-%23f8a602?label=License&labelColor=%23992b2e)](LICENSE)
+[![CI](https://github.com/fluid40/aas-standard-parser/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-standard-parser/actions)
+[![PyPI version](https://img.shields.io/pypi/v/aas-standard-parser.svg)](https://pypi.org/project/aas-standard-parser/)
+
+
+This project provides tools for parsing and handling Asset Administration Shell (AAS) standard submodels, with a focus on AID and AIMC submodels. It enables:
+
+- Extraction, interpretation, and mapping of submodel elements and their properties
+- Working with references, semantic IDs, and submodel element collections
+- Representation and processing of mapping configurations and source-sink relations
+- Structured and colored logging, including log file management
+
+These components enable efficient parsing, transformation, and analysis of AAS submodels in Python-based workflows.
+> **Note:** Most functions in this project utilize the [python aas sdk framework](https://github.com/aas-core-works/aas-core3.0-python) for parsing and handling AAS submodels, ensuring compatibility with the official AAS data models and structures.
+---
+
+## Provided Parsers
+
+- **AID Parser**: Parses AID submodels to extract interface descriptions, properties, and security/authentication details.
+- **AIMC Parser**: Parses AIMC submodels to extract and process mapping configurations and source-sink relations.
+- **AAS Parser**: Utilities to extract submodel IDs from an Asset Administration Shell.
+- **Submodel Parser**: Helpers to retrieve submodel elements by semantic ID or by path within a submodel.
+
+## Helper Modules
+
+- **Collection Helpers**: Functions to search and filter submodel elements by semantic ID, idShort, or supplemental semantic ID within collections.
+- **Reference Helpers**: Utilities for working with references, such as constructing idShort paths and extracting values from reference keys.
+- **Utilities**: General utility functions, including loading a submodel from a file.
+
+---
+
+## API References
+- AID Parser
+- AIMC Parser
+- [AAS Parser](docs/api_references/api_aas_parser.md)
+- [Submodel Parser](docs/api_references/api_submodel_parser.md)
+- Collection Helpers
+- [Reference Helpers](docs/api_references/api_reference_helpers.md)
+- [Utilities](docs/api_references/api_utils.md)
+
+## Resources
+
+🤖 [Releases](http://github.com/fluid40/aas-standard-parser/releases)
+
+📦 [Pypi Packages](https://pypi.org/project/aas-standard-parser/)
+
+📜 [MIT License](LICENSE)

aas_standard_parser-0.2.7.dist-info/RECORD

@@ -0,0 +1,18 @@
+aas_standard_parser/__init__.py,sha256=hYQya1mIcVbk8sSSB1PcoUq8Ipu4BYHLlahTS5h-bak,1029
+aas_standard_parser/aas_parser.py,sha256=aKeiq6YFVpYyntfwdqTaMgzab_5Eo_4wV1BWBP5BLvo,744
+aas_standard_parser/aid_parser.py,sha256=9vp8_kJRfExTmw8tjmO32n1eHFAE5ItmfPlZ2ORLZMs,14314
+aas_standard_parser/aimc_parser.py,sha256=3GSM-jBj-9OqNDnL7CssqogNOZEd7_fjRtxwzRZi-iA,9972
+aas_standard_parser/collection_helpers.py,sha256=fTQGQiC-bGD41Qx0FDDBtWhvkeZtEe6Sh-aT93ePwro,4153
+aas_standard_parser/reference_helpers.py,sha256=HJMK1FjoEkPipw9kcT7k75EYioHz_SwcLLqXdFo9Eew,1339
+aas_standard_parser/submodel_json_parser.py,sha256=uy1tEQH5AAiysVbtwLHEK_V_bVRMx7SMQLhhm6m3MOc,1260
+aas_standard_parser/submodel_parser.py,sha256=cKDKUBoKMJb1q6ISalJhLlE1VRqqFHTDWsv6BdeSmXU,2653
+aas_standard_parser/utils.py,sha256=TSOvTZxhPp4s63rn-xzLQasDxEiHyk6BcHhIkzaUTek,905
+aas_standard_parser/version_check.py,sha256=P1nb2WvVVU5RaQ4mWViFLnF9QkUv61Zc2EApYPGiiC8,1058
+aas_standard_parser/classes/aimc_parser_classes.py,sha256=PwKpuyB36urFc8YqQ6KtrG8H5WLd-3R2c3yST8Yyc_w,2581
+aas_standard_parser/demo/demo_process.py,sha256=Xn9uD0xLoNx0ZvB3Lk0oYkGBRHaEfUbfqv5_SpPWYck,530
+aas_standard_parser/demo/logging_handler.py,sha256=x-eX4XDU3sZTJE22rzJSiaWQ8wRMbtaFpFBAeAcbIzI,5752
+aas_standard_parser-0.2.7.dist-info/licenses/LICENSE,sha256=simqYMD2P9Ikm0Kh9n7VGNpaVcm2TMVVQmECYZ_xVZ8,1065
+aas_standard_parser-0.2.7.dist-info/METADATA,sha256=hLgmuUuUXjM6FkGYoPFajsss7XUdzv48apwg0wI5Ru0,4502
+aas_standard_parser-0.2.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_standard_parser-0.2.7.dist-info/top_level.txt,sha256=OQaK6cwYttR1-eKTz5u4M0jbwSfp4HqJ56chaf0nHnw,20
+aas_standard_parser-0.2.7.dist-info/RECORD,,

aas_standard_parser-0.2.6.dist-info/METADATA

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: aas-standard-parser
-Version: 0.2.6
-Summary: Some auxiliary functions for parsing standard submodels
-Author-email: Daniel Klein <daniel.klein@em.ag>
-License: MIT License
-        
-        Copyright (c) 2025 Fluid4.0
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/fluid40/aas-http-client
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing>=3.7.4.3
-Requires-Dist: basyx-python-sdk>=1.2.1
-Dynamic: license-file
-
-# aas-standard-parser
-Some auxiliary functions for parsing standard submodels

aas_standard_parser-0.2.6.dist-info/RECORD

@@ -1,16 +0,0 @@
-aas_standard_parser/__init__.py,sha256=lp7rs4UL5yebN0F69JKuNaqI8kI2_lU2LV3B0vUSXAw,687
-aas_standard_parser/aas_parser.py,sha256=9SDxG2YGEWlcK2Wyy70r9rOO6ExAOaN79-SbjurOci4,667
-aas_standard_parser/aid_parser.py,sha256=9vp8_kJRfExTmw8tjmO32n1eHFAE5ItmfPlZ2ORLZMs,14314
-aas_standard_parser/aimc_parser.py,sha256=3GSM-jBj-9OqNDnL7CssqogNOZEd7_fjRtxwzRZi-iA,9972
-aas_standard_parser/collection_helpers.py,sha256=fTQGQiC-bGD41Qx0FDDBtWhvkeZtEe6Sh-aT93ePwro,4153
-aas_standard_parser/reference_helpers.py,sha256=mUWlxD81aV8J-VLowjZ1prS52cFW1EVwXkaUOFL_P2Y,1037
-aas_standard_parser/submodel_parser.py,sha256=XH-XTBB3a0MB1NR5nAzG9C6f9hT_qG42f-ABruN3MzE,3169
-aas_standard_parser/utils.py,sha256=5iIPpM_ob2V9MwFL_vTbXd23doYKot30xenRmTPAquo,723
-aas_standard_parser/classes/aimc_parser_classes.py,sha256=PwKpuyB36urFc8YqQ6KtrG8H5WLd-3R2c3yST8Yyc_w,2581
-aas_standard_parser/demo/demo_process.py,sha256=Xn9uD0xLoNx0ZvB3Lk0oYkGBRHaEfUbfqv5_SpPWYck,530
-aas_standard_parser/demo/logging_handler.py,sha256=x-eX4XDU3sZTJE22rzJSiaWQ8wRMbtaFpFBAeAcbIzI,5752
-aas_standard_parser-0.2.6.dist-info/licenses/LICENSE,sha256=simqYMD2P9Ikm0Kh9n7VGNpaVcm2TMVVQmECYZ_xVZ8,1065
-aas_standard_parser-0.2.6.dist-info/METADATA,sha256=-ikDTRghNsQWEqvTm3X1zntFc5XrXBG_xJA66UpDc4E,1718
-aas_standard_parser-0.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_standard_parser-0.2.6.dist-info/top_level.txt,sha256=OQaK6cwYttR1-eKTz5u4M0jbwSfp4HqJ56chaf0nHnw,20
-aas_standard_parser-0.2.6.dist-info/RECORD,,