aas-http-client 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

aas_http_client/client.py

@@ -510,6 +510,32 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
+    def post_submodel_element_by_path_submodel_repo(self, submodel_id: str, submodel_element_path: str, submodel_element_data: dict) -> dict | None:
+        """Creates a new submodel element at a specified path within submodel elements hierarchy.
+
+        :param submodel_id: Encoded ID of the Submodel to create elements for
+        :param submodel_element_path: Path within the Submodel elements hierarchy
+        :param submodel_element_data: Data for the new Submodel element
+        :return: Submodel element data or None if an error occurred
+        """
+        decoded_submodel_id: str = decode_base_64(submodel_id)
+        url = f"{self.base_url}/submodels/{decoded_submodel_id}/submodel-elements/{submodel_element_path}"
+
+        try:
+            response = self._session.post(url, headers=HEADERS, json=submodel_element_data, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_201:
+                log_response_errors(response)
+                return None
+
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Error call REST API: {e}")
+            return None
+
+        content = response.content.decode("utf-8")
+        return json.loads(content)
+
     def get_submodel_element_by_path_submodel_repo(self, submodel_id: str, submodel_element_path: str) -> dict | None:
         """Returns a specific submodel element from the Submodel at a specified path.
 

aas_http_client/demo/demo_process.py

@@ -6,7 +6,7 @@ from pathlib import Path
 from basyx.aas import model
 
 from aas_http_client.client import AasHttpClient, create_client_by_config
-from aas_http_client.utilities import model_builder
+from aas_http_client.utilities import model_builder, sdk_tools
 from aas_http_client.wrapper.sdk_wrapper import SdkWrapper, create_wrapper_by_config
 
 logger = logging.getLogger(__name__)
@@ -17,6 +17,7 @@ def start() -> None:
     # create a submodel element
     sme_short_id: str = model_builder.create_unique_short_id("poc_sme")
     sme = model_builder.create_base_submodel_element_property(sme_short_id, model.datatypes.String, "Sample Value")
+    clone = model_builder.clone_submodel_element_property(sme)
 
     # create a submodel
     sm_short_id: str = model_builder.create_unique_short_id("poc_sm")
@@ -29,7 +30,7 @@ def start() -> None:
     aas = model_builder.create_base_ass(aas_short_id)
 
     # add submodel to AAS
-    model_builder.add_submodel_to_aas(aas, submodel)
+    sdk_tools.add_submodel_to_aas(aas, submodel)
 
     wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/python_server_config.yml"))
     # dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.yml"))

aas_http_client/demo/logging_handler.py

@@ -0,0 +1,177 @@
+"""
+Logging handler.
+
+This module contains all methods and functions to handle the logging.
+"""
+
+import json
+import logging
+import queue
+import sys
+import uuid
+from datetime import UTC, datetime
+from logging.handlers import QueueHandler
+from pathlib import Path
+from typing import ClassVar
+
+from pythonjsonlogger import jsonlogger
+
+LOG_FOLDER: str = "./_log"
+LOG_FILE_SUFFIX: str = "_log.json"
+
+
+class ColorCodes:
+    """Define the color codes for the console output."""
+
+    grey = "\x1b[38;21m"
+    green = "\x1b[1;32m"
+    yellow = "\x1b[33;21m"
+    red = "\x1b[31;21m"
+    bold_red = "\x1b[31;1m"
+    blue = "\x1b[1;34m"
+    light_blue = "\x1b[1;36m"
+    purple = "\x1b[1;35m"
+    reset = "\x1b[0m"
+
+
+class CustomConsoleFormatter(logging.Formatter):
+    """Custom console formatter for logging with colored level.
+
+    :param logging: formatter
+    """
+
+    FORMATS: ClassVar[dict] = {
+        logging.DEBUG: ColorCodes.blue + "%(levelname)s" + ColorCodes.reset + ":   %(message)s (%(filename)s:%(lineno)d)",
+        logging.INFO: ColorCodes.green + "%(levelname)s" + ColorCodes.reset + ":   %(message)s",
+        logging.WARNING: ColorCodes.yellow + "%(levelname)s" + ColorCodes.reset + ":   %(message)s",
+        logging.ERROR: ColorCodes.red + "%(levelname)s" + ColorCodes.reset + ":    %(message)s (%(filename)s:%(lineno)d)",
+        logging.CRITICAL: ColorCodes.bold_red + "%(levelname)s:  %(message)s (%(filename)s:%(lineno)d)" + ColorCodes.reset,
+    }
+
+    def format(self, record) -> str:
+        """Format the log record.
+
+        :param record: record to format
+        :return: formatted record
+        """
+        log_fmt = self.FORMATS.get(record.levelno)
+        formatter = logging.Formatter(log_fmt)
+        return formatter.format(record)
+
+
+def _handle_file_rotation(log_file_path: Path, max_file_count: int = 5) -> None:
+    log_folder: Path = log_file_path.resolve()
+
+    if max_file_count < 1:
+        return
+
+    if not log_folder.exists():
+        return
+
+    existing_log_files: list[Path] = [file for file in log_folder.iterdir() if file.name.endswith(LOG_FILE_SUFFIX)]
+
+    if len(existing_log_files) < max_file_count:
+        return
+
+    existing_log_files.sort(key=lambda x: x.stat().st_ctime)
+
+    files_to_delete: int = len(existing_log_files) - (max_file_count - 1)
+
+    for file in existing_log_files[:files_to_delete]:
+        file.unlink()
+
+    return
+
+
+def initialize_logging(console_level=logging.INFO) -> Path:
+    """Initialize the standard logging.
+
+    :param debug_mode_status: Status of the debug mode
+    :param log_file_name: Name of the (path and extension)
+    """
+    log_path = Path(LOG_FOLDER).resolve()
+    log_path.mkdir(parents=True, exist_ok=True)
+
+    log_file_path = log_path / "api.log"
+
+    log_file_format = "%(asctime)s %(levelname)s: %(message)s   (%(filename)s:%(lineno)d)"
+    logging.basicConfig(
+        filename=log_file_path,
+        level=logging.DEBUG,
+        format=log_file_format,
+        filemode="w",
+    )
+
+    # set console logging
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(console_level)
+    console_handler.setFormatter(CustomConsoleFormatter())
+    logging.getLogger("").addHandler(console_handler)
+
+    # set queue logging
+    log_queue: queue.Queue = queue.Queue(-1)  # Use default max size
+    queue_handler = QueueHandler(log_queue)
+    logging.getLogger("").addHandler(queue_handler)
+
+    logger = logging.getLogger(__name__)
+    script_path = Path(sys.argv[0])
+    python_version = sys.version.replace("\n", "")
+
+    print("")
+    logger.info(f"Run script '{script_path.name.replace('.py', '')}'")
+    logger.info(f"Script executed by Python v{python_version}")
+    logger.info("Logging initialized")
+
+    return log_file_path.resolve()
+
+
+def read_log_file_as_list(log_file_path: Path) -> list[dict]:
+    """Read the log file as a list of dictionaries (Json conform).
+
+    :param log_file_path: Path to the log file
+    :return: list of dictionaries (Json conform)
+    """
+    with Path.open(log_file_path, "r", encoding="utf-8") as f:
+        return [json.loads(line) for line in f if line.strip()]
+
+
+def set_log_file(
+    max_log_files: int = 10,
+) -> Path:
+    """Set the log file.
+
+    :param max_log_files: max number of log files in folder, defaults to 5
+    :return: log file path
+    """
+    logger = logging.getLogger()  # Get the root logger
+
+    # Remove all existing file handlers
+    for handler in logger.handlers[:]:
+        if isinstance(handler, logging.FileHandler):
+            logger.removeHandler(handler)
+            handler.close()
+
+    now = datetime.now(tz=UTC)
+    time_string = now.strftime("%Y-%m-%d_%H-%M-%S")
+
+    # handle log file and folder
+    log_path: Path = Path(LOG_FOLDER).resolve()
+    log_path = Path(LOG_FOLDER, "runtime").resolve()
+
+    log_path.mkdir(parents=True, exist_ok=True)
+    log_file_name = f"{uuid.uuid4().hex}{LOG_FILE_SUFFIX}"
+    log_file_path = log_path / f"{time_string}_{log_file_name}"
+
+    _handle_file_rotation(log_path, max_log_files)
+
+    # Add a new file handler with the new log file path
+    json_formatter = jsonlogger.JsonFormatter("%(asctime)s %(levelname)s %(name)s %(message)s %(filename)s %(lineno)d")
+    json_file_handler = logging.FileHandler(log_file_path, mode="w")
+    json_file_handler.setFormatter(json_formatter)
+    json_file_handler.setLevel(logging.DEBUG)
+    logger.addHandler(json_file_handler)
+
+    logging.info(f"Maximum log file number is: {max_log_files}")  # noqa: LOG015
+    logging.info(f"Write log file to: '{log_file_path}'")  # noqa: LOG015
+
+    return log_file_path.resolve()

aas_http_client/utilities/model_builder.py

@@ -39,6 +39,27 @@ def create_base_submodel_element_property(
     return sme
 
 
+def clone_submodel_element_property(property: model.Property) -> model.Property:
+    """Clone a SubmodelElement of type Property."""
+    sme = model.Property(id_short=property.id_short, value_type=property.value_type, value=property.value)
+    sme.description = property.description
+    sme.display_name = property.display_name
+    sme.value = property.value
+    sme.value_type = property.value_type
+    sme.semantic_id = property.semantic_id
+    sme.qualifier = property.qualifier
+    sme.category = property.category
+    sme.extension = property.extension
+    sme.embedded_data_specifications = property.embedded_data_specifications
+    sme.namespace_element_sets = property.namespace_element_sets
+    sme.supplemental_semantic_id = property.supplemental_semantic_id
+    sme.value_id = property.value_id
+    sme.value_type = property.value_type
+    sme.parent = property.parent
+
+    return sme
+
+
 def create_base_submodel(identifier: str, id_short: str, display_name: str = "", description: str = "") -> model.Submodel:
     """Create a basic Submodel.
 

aas_http_client/utilities/sdk_tools.py

@@ -16,10 +16,18 @@ def add_submodel_to_aas(aas: model.AssetAdministrationShell, submodel: model.Sub
     :param aas: provided AssetAdministrationShell to which the Submodel should be added
     :param submodel: given Submodel to add
     """
-    # aas.submodel.add(submodel)
     aas.submodel.add(model.ModelReference.from_referable(submodel))
 
 
+def remove_submodel_from_aas(aas: model.AssetAdministrationShell, submodel: model.Submodel) -> None:
+    """Remove a given Submodel correctly from a provided AssetAdministrationShell.
+
+    :param aas: provided AssetAdministrationShell from which the Submodel should be removed
+    :param submodel: given Submodel to remove
+    """
+    aas.submodel.remove(model.ModelReference.from_referable(submodel))
+
+
 def convert_to_object(content: dict) -> Any | None:
     """Convert a dictionary to a BaSyx SDK framework object.
 

aas_http_client/wrapper/sdk_wrapper.py

@@ -257,7 +257,7 @@ class SdkWrapper:
         return submodel_elements
 
     def post_submodel_element_submodel_repo(self, submodel_id: str, submodel_element: model.SubmodelElement) -> model.SubmodelElement | None:
-        """Creates a new submodel element. !!!Serialization to model.SubmodelElements currently not possible.
+        """Creates a new submodel element.
 
         :param submodel_id: Encoded ID of the submodel to create elements for
         :param submodel_element: Submodel element to create
@@ -267,6 +267,20 @@ class SdkWrapper:
         content: dict = self._client.post_submodel_element_submodel_repo(submodel_id, sme_data)
         return _to_object(content)
 
+    def post_submodel_element_by_path_submodel_repo(
+        self, submodel_id: str, submodel_element_path: str, submodel_element: model.SubmodelElement
+    ) -> model.SubmodelElement | None:
+        """Creates a new submodel element at a specified path within submodel elements hierarchy.
+
+        :param submodel_id: Encoded ID of the submodel to create elements for
+        :param submodel_element_path: Path within the Submodel elements hierarchy
+        :param submodel_element: The new Submodel element
+        :return: Submodel element object or None if an error occurred
+        """
+        sme_data = _to_dict(submodel_element)
+        content: dict = self._client.post_submodel_element_by_path_submodel_repo(submodel_id, submodel_element_path, sme_data)
+        return _to_object(content)
+
     def get_submodel_element_by_path_submodel_repo(self, submodel_id: str, submodel_element_path: str) -> model.SubmodelElement | None:
         """Returns a specific submodel element from the Submodel at a specified path.
 

{aas_http_client-0.4.0.dist-info → aas_http_client-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.4.0
+Version: 0.4.2
 Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License

aas_http_client-0.4.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+aas_http_client/__init__.py,sha256=bBfrdXUHvukisXIj0CcnNUHUw8_7nrdnfQRve8nM_3U,982
+aas_http_client/client.py,sha256=mWM1cfynFii0eZFrfSK4w10BXFemU2_aOwgdE0iCYo0,28484
+aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
+aas_http_client/core/version_check.py,sha256=9dR0Q6jCFygH_ctj4vyrjerpHvolT87ayengZFlBWCw,708
+aas_http_client/demo/demo_process.py,sha256=KkYMLdQYmGdAVfIwd1f8Zn0NqOTQUrvSLXJDjGGAz5M,3369
+aas_http_client/demo/logging_handler.py,sha256=VJtZ4u3x_LhYZQtfNck7FuXhGFZm7gid0uDhvf9GjJ8,5596
+aas_http_client/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aas_http_client/utilities/model_builder.py,sha256=SxAv8DJkKksykw_2gtTV2jHu-MRzevOVzspn807_7VA,4680
+aas_http_client/utilities/sdk_tools.py,sha256=CDD0mus8jOi-irgPO6dQHulmEyu8BSG_05Mol_nirK0,2008
+aas_http_client/wrapper/sdk_wrapper.py,sha256=FaftHLQ97HvxNUtFO_1JizSgWbu_rsfegaMkUMWgS6c,15540
+aas_http_client-0.4.2.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
+aas_http_client-0.4.2.dist-info/METADATA,sha256=Rp_HjtoKXohEC71BBe7FGhO-QHfNki-YtkisCR5PvPY,10467
+aas_http_client-0.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_http_client-0.4.2.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
+aas_http_client-0.4.2.dist-info/RECORD,,

aas_http_client-0.4.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-aas_http_client/__init__.py,sha256=bBfrdXUHvukisXIj0CcnNUHUw8_7nrdnfQRve8nM_3U,982
-aas_http_client/client.py,sha256=CtX1nlIo65-Um9AlXZ3gOfEMJwcLDJNOssxkGXAlsg0,27205
-aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
-aas_http_client/core/version_check.py,sha256=9dR0Q6jCFygH_ctj4vyrjerpHvolT87ayengZFlBWCw,708
-aas_http_client/demo/demo_process.py,sha256=s60SBx0le1G2BU_uJ8vC5i6zTcSGQprSnYafZPUtOtE,3299
-aas_http_client/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aas_http_client/utilities/model_builder.py,sha256=6pZ0mcfofkuCu24wp71vhBKyaLXJcHpU8N4PBHx_Xpo,3782
-aas_http_client/utilities/sdk_tools.py,sha256=QPpItZdhw8y13IgpS015vTAb8e8QfPeidUuE6-K0JIo,1637
-aas_http_client/wrapper/sdk_wrapper.py,sha256=67RiQ5qAgFq84817QurGX-GJBsM3QI3k4-uBC7sOQio,14807
-aas_http_client-0.4.0.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
-aas_http_client-0.4.0.dist-info/METADATA,sha256=o5uysJOtlvq_E-ALEMnnw0oEAbfHXYqGOhT2xpRKmVc,10467
-aas_http_client-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_http_client-0.4.0.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
-aas_http_client-0.4.0.dist-info/RECORD,,