aas-http-client 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

aas_http_client/wrapper/sdk_wrapper.py

@@ -0,0 +1,272 @@
+"""BaSyx Server interface for REST API communication."""
+
+import json
+import logging
+from pathlib import Path
+
+import basyx.aas.adapter.json
+
+from basyx.aas.model import AssetAdministrationShell, Reference, Submodel
+from aas_http_client.client import AasHttpClient, _create_client
+logger = logging.getLogger(__name__)
+
+class SdkWrapper():
+    """Represents a SdkWrapper to communicate with a REST API."""
+    _client: AasHttpClient = None
+
+    def post_shells(self, aas: AssetAdministrationShell) -> dict | None:
+        """Post an Asset Administration Shell (AAS) to the REST API.
+
+        :param aas: Asset Administration Shell to post
+        :return: Response data as a dictionary or None if an error occurred
+        """
+        aas_data_string = json.dumps(aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        aas_data = json.loads(aas_data_string)
+
+        return self._client.post_shells(aas_data)
+
+    def put_shells(self, identifier: str, aas: AssetAdministrationShell) -> bool:
+        """Update an Asset Administration Shell (AAS) by its ID in the REST API.
+
+        :param identifier: Identifier of the AAS to update
+        :param aas: Asset Administration Shell data to update
+        :return: True if the update was successful, False otherwise
+        """
+        aas_data_string = json.dumps(aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        aas_data = json.loads(aas_data_string)
+
+        return self._client.put_shells(identifier, aas_data)
+
+    def put_shells_submodels(self, aas_id: str, submodel_id: str, submodel: Submodel) -> bool:
+        """Update a submodel by its ID for a specific Asset Administration Shell (AAS).
+
+        :param aas_id: ID of the AAS to update the submodel for
+        :param submodel: Submodel data to update
+        :return: True if the update was successful, False otherwise
+        """
+        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        sm_data = json.loads(sm_data_string)
+
+        return self._client.put_shells_submodels(aas_id, submodel_id, sm_data)
+
+    def get_shells(self) -> list[AssetAdministrationShell] | None:
+        """Get all Asset Administration Shells (AAS) from the REST API.
+
+        :return: AAS objects or None if an error occurred
+        """
+        content: dict = self._client.get_shells()
+        
+        if not content:
+            logger.warning("No AAS found in the REST API.")
+            return []
+
+        results: list = content.get("result", [])
+        if not results:
+            logger.warning("No AAS found in the REST API results.")
+            return []
+
+        aas_list: list[AssetAdministrationShell] = []
+
+        for result in results:
+            if not isinstance(result, dict):
+                logger.error(f"Invalid AAS data: {result}")
+                return None
+
+            aas_dict_string = json.dumps(result)
+            aas = json.loads(aas_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+            aas_list.append(aas)
+
+        return aas_list
+
+    def get_shells_by_id(self, aas_id: str) -> AssetAdministrationShell | None:
+        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
+
+        :param aas_id: ID of the AAS to retrieve
+        :return: AAS object or None if an error occurred
+        """
+        content: dict = self._client.get_shells_by_id(aas_id)
+        return json.load(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+    def get_shells_reference_by_id(self, aas_id: str) -> Reference | None:
+        content: dict = self._client.get_shells_reference_by_id(aas_id)
+        return json.load(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+    def get_shells_submodels(self, aas_id: str, submodel_id: str) -> Submodel | None:
+        """Get a submodel by its ID for a specific Asset Administration Shell (AAS).
+
+        :param aas_id: ID of the AAS to retrieve the submodel from
+        :param submodel_id: ID of the submodel to retrieve
+        :return: Submodel object or None if an error occurred
+        """
+        content: dict = self._client.get_shells_by_id(aas_id)
+        return json.load(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+    def delete_shells_by_id(self, aas_id: str) -> bool:
+        """Get an Asset Administration Shell (AAS) by its ID from the REST API.
+
+        :param aas_id: ID of the AAS to retrieve
+        :return: True if the deletion was successful, False otherwise
+        """
+        return self._client.delete_shells_by_id(aas_id)
+
+    def post_submodels(self, submodel: Submodel) -> bool:
+        """Post a submodel to the REST API.
+
+        :param submodel: submodel data as a dictionary
+        :return: Response data as a dictionary or None if an error occurred
+        """
+        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        sm_data = json.loads(sm_data_string)
+
+        return self._client.post_submodels(sm_data)
+
+    def put_submodels(self, identifier: str, submodel: Submodel) -> bool:
+        """Update a submodel by its ID in the REST API.
+
+        :param identifier: Identifier of the submodel to update
+        :param submodel: Submodel data to update
+        :return: True if the update was successful, False otherwise
+        """
+        sm_data_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        sm_data = json.loads(sm_data_string)
+
+        return self._client.put_submodels(identifier, sm_data)
+
+    def get_submodel_by_id(self, submodel_id: str) -> Submodel | None:
+        """Get a submodel by its ID from the REST API.
+
+        :param submodel_id: ID of the submodel to retrieve
+        :return: Submodel object or None if an error occurred
+        """
+        content = self._client.get_submodel_by_id(submodel_id)
+        
+        if not content:
+            logger.warning(f"No submodel found with ID '{submodel_id}' in the REST API.")
+            return None
+
+        if not isinstance(content, dict):
+            logger.error(f"Invalid submodel data: {content}")
+            return None
+        
+        return json.loads(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+    def get_submodels(self) -> list[Submodel] | None:
+        """Get all submodels from the REST API.
+
+        :return: Submodel objects or None if an error occurred
+        """
+        content: list = self._client.get_submodels()
+
+        if not content:
+            logger.warning("No submodels found in the REST API.")
+            return []
+
+        results: list = content.get("result", [])
+        if not results:
+            logger.warning("No submodels found in the REST API results.")
+            return []
+
+        submodels: list[Submodel] = []
+
+        for result in results:
+            if not isinstance(result, dict):
+                logger.error(f"Invalid submodel data: {result}")
+                return None
+
+            sm_dict_string = json.dumps(result)
+            submodel = json.loads(sm_dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+            submodels.append(submodel)
+
+        return submodels
+
+    def get_submodels_by_id(self, submodel_id: str) -> Submodel | None:
+        """Get a submodel by its ID from the REST API.
+
+        :param submodel_id: ID of the submodel to retrieve
+        :return: Submodel object or None if an error occurred
+        """
+        content = self._client.get_submodels_by_id(submodel_id)
+
+        if not content:
+            logger.warning(f"No submodel found with ID '{submodel_id}' in the REST API.")
+            return None
+        
+        if not isinstance(content, dict):
+            logger.error(f"Invalid submodel data: {content}")
+            return None
+#
+        return json.loads(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+
+    def patch_submodel_by_id(self, submodel_id: str, submodel: Submodel):
+        sm_dict_string = json.dumps(submodel, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        sm_dict = json.loads(sm_dict_string)
+
+        return self._client.patch_submodel_by_id(submodel_id, sm_dict)
+
+    def delete_submodels_by_id(self, submodel_id: str) -> bool:
+        """Delete a submodel by its ID from the REST API.
+
+        :param submodel_id: ID of the submodel to delete
+        :return: True if the deletion was successful, False otherwise
+        """
+        return self._client.delete_submodels_by_id(submodel_id)
+
+def create_wrapper_by_url(
+    base_url: str,
+    api_base_path: str = "",
+    username: str = "",
+    password: str = "",
+    http_proxy: str = "",
+    https_proxy: str = "",
+    time_out: int = 200,
+    connection_time_out: int = 60,
+    ssl_verify: str = True,  # noqa: FBT002
+) -> SdkWrapper | None:
+    """Create a BaSyx server interface client 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 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 HttpClient initialized with the provided parameters.
+    """
+    logger.info(f"Create BaSyx server interface client from URL '{base_url}'")
+    config_dict: dict[str, str] = {}
+    config_dict["base_url"] = base_url
+    config_dict["api_base_path"] = api_base_path
+    config_dict["username"] = username
+    config_dict["http_proxy"] = http_proxy
+    config_dict["https_proxy"] = https_proxy
+    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)
+    
+    wrapper = SdkWrapper()
+    wrapper._client = _create_client(config_string, password)                           
+    return wrapper
+    
+
+
+def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
+    """Create a BaSyx server interface client from the given parameters.
+
+    :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 HttpClient initialized with the provided parameters.
+    """
+    logger.info(f"Create BaSyx server interface client from config file '{config_file}'")
+    if not config_file.exists():
+        config_string = "{}"
+        logger.warning(f"Server config file '{config_file}' not found. Using default config.")
+    else:
+        config_string = config_file.read_text(encoding="utf-8")
+        logger.debug(f"Server config  file '{config_file}' found.")
+
+    wrapper = SdkWrapper()
+    wrapper._client = _create_client(config_string, password)                           
+    return wrapper

{aas_http_client-0.1.4.dist-info → aas_http_client-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.1.4
+Version: 0.1.5
 Summary: Generic HTTP client for communicating with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: MIT License

aas_http_client-0.1.5.dist-info/RECORD

@@ -0,0 +1,15 @@
+aas_http_client/__init__.py,sha256=M9EBVZcs0jg7v0RaziftjGcOzNET8gsgJ_-oRXNZxDo,657
+aas_http_client/client.py,sha256=3I29OJJUPd2tP_46dDntyvzAlcFQHrMD2iEfc_mpn2I,21428
+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=-9-oQEi_B08W-POl2SVP4COodGPHN3mTw9rrPgLLpeY,2170
+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=bDK9cOrU4vlkQTHTgmeiVftQduKSZSKGAX10weSHQWs,3756
+aas_http_client/wrapper/python_sdk_wrapper_tmp.py,sha256=J1ze7TXKMiOjA5dDVNrc-GRoxQ_9r7rU8qW8C0yErG0,24206
+aas_http_client/wrapper/sdk_wrapper.py,sha256=sUfdawn9TWNbs7YELBTuMKBhiqd_eeQwk-AmzPWgLII,11117
+aas_http_client-0.1.5.dist-info/licenses/LICENSE,sha256=simqYMD2P9Ikm0Kh9n7VGNpaVcm2TMVVQmECYZ_xVZ8,1065
+aas_http_client-0.1.5.dist-info/METADATA,sha256=0W3KjbyhUkX7Pva9H8Mgl5dhgPl-r7Yce3ni_6w5ajI,2754
+aas_http_client-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_http_client-0.1.5.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
+aas_http_client-0.1.5.dist-info/RECORD,,

aas_http_client-0.1.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-aas_http_client/__init__.py,sha256=0G7BtUBA13vzzs1Nk8-gnnBSJLM6JYrwacxSamC2VSE,577
-aas_http_client/client.py,sha256=J1ze7TXKMiOjA5dDVNrc-GRoxQ_9r7rU8qW8C0yErG0,24206
-aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
-aas_http_client/core/version_check.py,sha256=721Zs3xSRrJTYZtAxkaUWg9LLKtpU7oFM62DzQHZdE4,705
-aas_http_client-0.1.4.dist-info/licenses/LICENSE,sha256=simqYMD2P9Ikm0Kh9n7VGNpaVcm2TMVVQmECYZ_xVZ8,1065
-aas_http_client-0.1.4.dist-info/METADATA,sha256=N2VTAX0NAc65x11V9zz2Wk_cHj8vT3mqySi96NSLjOI,2754
-aas_http_client-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_http_client-0.1.4.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
-aas_http_client-0.1.4.dist-info/RECORD,,