aas-http-client 0.3.0__tar.gz → 0.3.2__tar.gz

{aas_http_client-0.3.0 → aas_http_client-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.3.0
+Version: 0.3.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.3.0 → aas_http_client-0.3.2}/aas_http_client/client.py

@@ -109,7 +109,7 @@ class AasHttpClient(BaseModel):
         url = f"{self.base_url}/shells"
 
         try:
-            response = self._session.get(url, headers=HEADERS, timeout=2)
+            response = self._session.get(url, headers=HEADERS, timeout=10)
             logger.debug(f"Call REST API url '{response.url}'")
 
             if response.status_code != STATUS_CODE_200:
@@ -536,6 +536,31 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
+    def delete_submodel_element_by_path_submodel_repo(self, submodel_id: str, submodel_element_path: str):
+        """Deletes a submodel element at a specified path within the submodel elements hierarchy.
+
+        :param submodel_id: Encoded ID of the Submodel to delete submodel element from
+        :param submodel_element_path: Path of the Submodel element to delete
+        :return: True if the deletion 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}"
+
+        try:
+            response = self._session.delete(url, headers=HEADERS, 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
 
@@ -552,19 +577,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
@@ -573,19 +598,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.")

{aas_http_client-0.3.0 → aas_http_client-0.3.2}/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:
@@ -266,11 +280,12 @@ class SdkWrapper:
 
 # endregion
 
+# region utils
+
 
 def _to_object(content: dict) -> Any | None:
     try:
         dict_string = json.dumps(content)
-        print(dict_string)
         return json.loads(dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
     except Exception as e:
         logger.error(f"Decoding error: {e}")
@@ -288,6 +303,8 @@ def _to_dict(object: Any) -> dict | None:
         return None
 
 
+# endregion
+
 # region wrapper
 
 
@@ -301,7 +318,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 ""_
@@ -313,7 +330,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
@@ -322,43 +339,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.0 → aas_http_client-0.3.2}/aas_http_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.3.0
+Version: 0.3.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.3.0 → aas_http_client-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-http-client"
-version = "0.3.0"
+version = "0.3.2"
 description = "Generic python HTTP client for communication with various types of AAS servers"
 readme = "README.md"
 license = { file = "LICENSE" }

{aas_http_client-0.3.0 → aas_http_client-0.3.2}/tests/test_client.py

@@ -1,6 +1,6 @@
 import pytest
 from pathlib import Path
-from aas_http_client.client import create_client_by_config, AasHttpClient
+from aas_http_client.client import create_client_by_config, AasHttpClient, create_client_by_dict, create_client_by_url
 from basyx.aas import model
 import aas_http_client.utilities.model_builder as model_builder
 import json
@@ -54,6 +54,21 @@ def shared_aas(shared_sm: model.Submodel) -> model.AssetAdministrationShell:
 
     return aas
 
+def test_000a_create_client_by_url(client: AasHttpClient):
+    base_url: str = client.base_url
+    new_client: AasHttpClient = create_client_by_url(base_url=base_url)
+    assert new_client is not None
+
+def test_000b_create_client_by_dict(client: AasHttpClient):
+    base_url: str = client.base_url
+
+    config_dict: dict = {
+        "base_url": base_url
+    }
+
+    new_client: AasHttpClient = create_client_by_dict(configuration=config_dict)
+    assert new_client is not None
+
 def test_001a_connect(client: AasHttpClient):
     assert client is not None
 

{aas_http_client-0.3.0 → aas_http_client-0.3.2}/tests/test_wrapper.py

@@ -1,6 +1,6 @@
 import pytest
 from pathlib import Path
-from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config, SdkWrapper
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config, SdkWrapper, create_wrapper_by_dict, create_wrapper_by_url
 from basyx.aas import model
 import aas_http_client.utilities.model_builder as model_builder
 from urllib.parse import urlparse
@@ -55,6 +55,21 @@ def shared_aas(shared_sm: model.Submodel) -> model.AssetAdministrationShell:
 
     return aas
 
+def test_000a_create_wrapper_by_url(wrapper: SdkWrapper):
+    base_url: str = wrapper.base_url
+    new_client: SdkWrapper = create_wrapper_by_url(base_url=base_url)
+    assert new_client is not None
+
+def test_000b_create_wrapper_by_dict(wrapper: SdkWrapper):
+    base_url: str = wrapper.base_url
+
+    config_dict: dict = {
+        "base_url": base_url
+    }
+
+    new_client: SdkWrapper = create_wrapper_by_dict(configuration=config_dict)
+    assert new_client is not None
+
 def test_001_connect(wrapper: SdkWrapper):
     assert wrapper is not None