aas-http-client 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

aas_http_client/client.py

@@ -4,6 +4,7 @@ import json
 import logging
 import time
 from pathlib import Path
+from typing import Any
 
 import basyx.aas.adapter.json
 import basyx.aas.adapter.json.json_serialization as js
@@ -26,7 +27,7 @@ STATUS_CODE_404 = 404
 HEADERS = {"Content-Type": "application/json"}
 
 
-def log_response_errors(response: Response):
+def log_response_errors(response: Response):  # noqa: C901
     """Create error messages from the response and log them.
 
     :param response: response
@@ -561,6 +562,32 @@ class AasHttpClient(BaseModel):
 
         return True
 
+    def patch_submodel_element_by_path_value_only_submodel_repo(self, submodel_id: str, submodel_element_path: str, value: str) -> bool:
+        """Updates the value of an existing SubmodelElement.
+
+        :param submodel_id: Encoded ID of the Submodel to update submodel element for
+        :param submodel_element_path: Path of the Submodel element to update
+        :param value: Submodel element value to update as string
+        :return: True if the patch was successful, False otherwise
+        """
+        decoded_submodel_id: str = decode_base_64(submodel_id)
+
+        url = f"{self.base_url}/submodels/{decoded_submodel_id}/submodel-elements/{submodel_element_path}/$value"
+
+        try:
+            response = self._session.patch(url, headers=HEADERS, json=value, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_204:
+                log_response_errors(response)
+                return False
+
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Error call REST API: {e}")
+            return False
+
+        return True
+
 
 # endregion
 
@@ -577,19 +604,19 @@ def create_client_by_url(
     connection_time_out: int = 60,
     ssl_verify: str = True,  # noqa: FBT002
 ) -> AasHttpClient | None:
-    """Create a AAS HTTP client from the given parameters.
+    """Create a HTTP client for a AAS server connection from the given parameters.
 
-    :param base_url: base URL of the BaSyx server, e.g. "http://basyx_python_server:80/"_
-    :param username: username for the BaSyx server interface client, defaults to ""_
-    :param password: password for the BaSyx server interface client, defaults to ""_
+    :param base_url: Base URL of the AAS server, e.g. "http://basyx_python_server:80/"_
+    :param username: Username for the AAS server, defaults to ""_
+    :param password: Password for the AAS server, defaults to ""_
     :param http_proxy: http proxy URL, defaults to ""_
     :param https_proxy: https proxy URL, defaults to ""_
-    :param time_out: timeout for the API calls, defaults to 200
-    :param connection_time_out: timeout for the connection to the API, defaults to 60
-    :param ssl_verify: whether to verify SSL certificates, defaults to True
-    :return: An instance of AasHttpClient initialized with the provided parameters.
+    :param time_out: Timeout for the API calls, defaults to 200
+    :param connection_time_out: Timeout for the connection to the API, defaults to 60
+    :param ssl_verify: Whether to verify SSL certificates, defaults to True
+    :return: An instance of Http client initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx server interface client from URL '{base_url}'")
+    logger.info(f"Create AAS server http client from URL '{base_url}'")
     config_dict: dict[str, str] = {}
     config_dict["base_url"] = base_url
     config_dict["username"] = username
@@ -598,19 +625,31 @@ def create_client_by_url(
     config_dict["time_out"] = time_out
     config_dict["connection_time_out"] = connection_time_out
     config_dict["ssl_verify"] = ssl_verify
-    config_string = json.dumps(config_dict, indent=4)
+    return create_client_by_dict(config_dict, password)
+
+
+def create_client_by_dict(configuration: dict, password: str = "") -> AasHttpClient | None:
+    """Create a HTTP client for a AAS server connection from the given configuration.
+
+    :param configuration: Dictionary containing the BaSyx server connection settings.
+    :param password: Password for the AAS server, defaults to ""_
+    :return: An instance of Http client initialized with the provided parameters.
+    """
+    logger.info(f"Create AAS server http client from configuration '{configuration}'")
+    config_string = json.dumps(configuration, indent=4)
+
     return _create_client(config_string, password)
 
 
 def create_client_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
-    """Create a AAS HTTP client from the given parameters.
+    """Create a HTTP client for a AAS server connection from a given configuration file.
 
-    :param config_file: Path to the configuration file containing the BaSyx server connection settings.
+    :param config_file: Path to the configuration file containing the AAS server connection settings.
     :param password: password for the BaSyx server interface client, defaults to ""_
-    :return: An instance of HttpClient initialized with the provided parameters.
+    :return: An instance of Http client initialized with the provided parameters.
     """
     config_file = config_file.resolve()
-    logger.info(f"Create AAS HTTP client from Configuration file '{config_file}'")
+    logger.info(f"Create AAS server http client from configuration file '{config_file}'")
     if not config_file.exists():
         config_string = "{}"
         logger.warning(f"Configuration file '{config_file}' not found. Using default configuration.")
@@ -623,8 +662,7 @@ def create_client_by_config(config_file: Path, password: str = "") -> AasHttpCli
 
 def _create_client(config_string: str, password) -> AasHttpClient | None:
     try:
-        connection_settings = AasHttpClient.model_validate_json(config_string)
-        client = AasHttpClient(**connection_settings.model_dump())
+        client = AasHttpClient.model_validate_json(config_string)
     except ValidationError as ve:
         raise ValidationError(f"Invalid BaSyx server connection file: {ve}") from ve
 

aas_http_client/wrapper/sdk_wrapper.py

@@ -19,6 +19,20 @@ class SdkWrapper:
     _client: AasHttpClient = None
     base_url: str = ""
 
+    def __init__(self, config_string: str, password: str = ""):
+        """Initializes the wrapper with the given configuration.
+
+        :param config_string: Configuration string for the BaSyx server connection.
+        :param password: Password for the BaSyx server interface client, defaults to "".
+        """
+        client = _create_client(config_string, password)
+
+        if not client:
+            raise ValueError("Failed to create AAS HTTP client with the provided configuration.")
+
+        self._client = client
+        self.base_url = client.base_url
+
     # region shells
 
     def post_asset_administration_shell(self, aas: model.AssetAdministrationShell) -> model.AssetAdministrationShell | None:
@@ -261,11 +275,24 @@ class SdkWrapper:
         :return: Submodel element object or None if an error occurred
         """
         content: dict = self._client.get_submodel_element_by_path_submodel_repo(submodel_id, submodel_element_path)
+        print(content)
         return _to_object(content)
 
+    def patch_submodel_element_by_path_value_only_submodel_repo(self, submodel_id: str, submodel_element_path: str, value: str) -> bool:
+        """Updates the value of an existing SubmodelElement.
+
+        :param submodel_id: Encoded ID of the Submodel to update submodel element for
+        :param submodel_element_path: Path of the Submodel element to update
+        :param value: Submodel element value to update as string
+        :return: True if the patch was successful, False otherwise
+        """
+        return self._client.patch_submodel_element_by_path_value_only_submodel_repo(submodel_id, submodel_element_path, value)
+
 
 # endregion
 
+# region utils
+
 
 def _to_object(content: dict) -> Any | None:
     try:
@@ -287,6 +314,8 @@ def _to_dict(object: Any) -> dict | None:
         return None
 
 
+# endregion
+
 # region wrapper
 
 
@@ -300,7 +329,7 @@ def create_wrapper_by_url(
     connection_time_out: int = 60,
     ssl_verify: str = True,  # noqa: FBT002
 ) -> SdkWrapper | None:
-    """Create a wrapper for the BaSyx Python SDK from the given parameters.
+    """Create a wrapper for a AAS server connection from the given parameters.
 
     :param base_url: base URL of the BaSyx server, e.g. "http://basyx_python_server:80/"_
     :param username: username for the BaSyx server interface client, defaults to ""_
@@ -312,7 +341,7 @@ def create_wrapper_by_url(
     :param ssl_verify: whether to verify SSL certificates, defaults to True
     :return: An instance of SdkWrapper initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx Python SDK wrapper from URL '{base_url}'")
+    logger.info(f"Create AAS server wrapper from URL '{base_url}'")
     config_dict: dict[str, str] = {}
     config_dict["base_url"] = base_url
     config_dict["username"] = username
@@ -321,43 +350,36 @@ def create_wrapper_by_url(
     config_dict["time_out"] = time_out
     config_dict["connection_time_out"] = connection_time_out
     config_dict["ssl_verify"] = ssl_verify
-    config_string = json.dumps(config_dict, indent=4)
+    return create_wrapper_by_dict(config_dict, password)
 
-    wrapper = SdkWrapper()
-    client = _create_client(config_string, password)
 
-    if not client:
-        return None
+def create_wrapper_by_dict(configuration: dict, password: str = "") -> SdkWrapper | None:
+    """Create a wrapper for a AAS server connection from the given configuration.
 
-    wrapper._client = client
-    wrapper.base_url = client.base_url
-    return wrapper
+    :param config: Dictionary containing the BaSyx server connection settings.
+    :param password: Password for the BaSyx server interface client, defaults to "".
+    :return: An instance of SdkWrapper initialized with the provided parameters.
+    """
+    logger.info(f"Create AAS server wrapper from configuration '{configuration}'")
+    config_string = json.dumps(configuration, indent=4)
+    return SdkWrapper(config_string, password)
 
 
 def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrapper | None:
-    """Create a wrapper for the BaSyx Python SDK from the given parameters.
+    """Create a wrapper for a AAS server connection from a given configuration file.
 
     :param config_file: Path to the configuration file containing the BaSyx server connection settings.
     :param password: password for the BaSyx server interface client, defaults to ""_
     :return: An instance of SdkWrapper initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx Python SDK wrapper from configuration file '{config_file}'")
+    logger.info(f"Create AAS wrapper client from configuration file '{config_file}'")
     if not config_file.exists():
         config_string = "{}"
         logger.warning(f"Configuration file '{config_file}' not found. Using default config.")
     else:
         config_string = config_file.read_text(encoding="utf-8")
         logger.debug(f"Configuration file '{config_file}' found.")
-
-    wrapper = SdkWrapper()
-    client = _create_client(config_string, password)
-
-    if not client:
-        return None
-
-    wrapper._client = client
-    wrapper.base_url = client.base_url
-    return wrapper
+    return SdkWrapper(config_string, password)
 
 
 # endregion

{aas_http_client-0.3.1.dist-info → aas_http_client-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.3.1
+Version: 0.3.3
 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.3.1.dist-info → aas_http_client-0.3.3.dist-info}/RECORD

@@ -1,14 +1,14 @@
 aas_http_client/__init__.py,sha256=cAr1mQzWp0G0LKtkAOYzc9t95OY3jM3Aj4bKnxx0Dso,901
-aas_http_client/client.py,sha256=neuEMk1lyOHOgVv3OBzNeXDWEtkN4qfox-hMRjtDWHM,25350
+aas_http_client/client.py,sha256=LXqhMLkNO9Itu9Pj369vJurBCd0kiqvhrgnahEmkUtI,27041
 aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
 aas_http_client/core/version_check.py,sha256=721Zs3xSRrJTYZtAxkaUWg9LLKtpU7oFM62DzQHZdE4,705
 aas_http_client/demo/demo_process.py,sha256=6sN_N3QbA4iLUmzeg1Y_XOwVAuDNtwkR4grAg7EkjWM,3301
 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=EUqVvKgXiyJNtyUeFrL6ronfF4hiF1KCipxSaLj6EiE,4465
-aas_http_client/wrapper/sdk_wrapper.py,sha256=pphxkTwnaoG44hOqelwnqBWupGfDX2ExBDhAdZNFQuQ,13512
-aas_http_client-0.3.1.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
-aas_http_client-0.3.1.dist-info/METADATA,sha256=LAC3u23U1X84glQ5zg77p3oPn-pl1mAOGHOgYaWsTdU,10467
-aas_http_client-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_http_client-0.3.1.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
-aas_http_client-0.3.1.dist-info/RECORD,,
+aas_http_client/wrapper/sdk_wrapper.py,sha256=KOPcnW0SrpoH6Z6ycDtzSmMdbk2MHj_UqbEbKGgGfWA,15010
+aas_http_client-0.3.3.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
+aas_http_client-0.3.3.dist-info/METADATA,sha256=RtgD4C2wO1BBzPXRaU7xVRxZHuGuSQX6M7ca5B-tJHM,10467
+aas_http_client-0.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_http_client-0.3.3.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
+aas_http_client-0.3.3.dist-info/RECORD,,