aas-http-client 0.2.61__tar.gz → 0.3.1__tar.gz

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.61
+Version: 0.3.1
 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
@@ -108,6 +108,10 @@ License: # :em engineering methods AG Software License
 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: pydantic>=2.11.5
+Requires-Dist: requests>=2.32.3
+Requires-Dist: basyx-python-sdk>=1.2.1
 Dynamic: license-file
 
 <!-- TODO: Go through the readme and enter the information here -->

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/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:
@@ -510,6 +510,57 @@ class AasHttpClient(BaseModel):
         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.
+
+        :param submodel_id: Encoded ID of the Submodel to retrieve element from
+        :param submodel_element_path: Path of the Submodel element to retrieve
+        :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.get(url, headers=HEADERS, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_200:
+                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 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
 

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/aas_http_client/wrapper/sdk_wrapper.py

@@ -253,6 +253,16 @@ class SdkWrapper:
         content: dict = self._client.post_submodel_element_submodel_repo(submodel_id, 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.
+
+        :param submodel_id: Encoded ID of the Submodel to retrieve element from
+        :param submodel_element_path: Path of the Submodel element to retrieve
+        :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)
+        return _to_object(content)
+
 
 # endregion
 

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/aas_http_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.61
+Version: 0.3.1
 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
@@ -108,6 +108,10 @@ License: # :em engineering methods AG Software License
 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: pydantic>=2.11.5
+Requires-Dist: requests>=2.32.3
+Requires-Dist: basyx-python-sdk>=1.2.1
 Dynamic: license-file
 
 <!-- TODO: Go through the readme and enter the information here -->

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/aas_http_client.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ aas_http_client/client.py
 aas_http_client.egg-info/PKG-INFO
 aas_http_client.egg-info/SOURCES.txt
 aas_http_client.egg-info/dependency_links.txt
+aas_http_client.egg-info/requires.txt
 aas_http_client.egg-info/top_level.txt
 aas_http_client/core/encoder.py
 aas_http_client/core/version_check.py

aas_http_client-0.3.1/aas_http_client.egg-info/requires.txt

@@ -0,0 +1,4 @@
+typing>=3.7.4.3
+pydantic>=2.11.5
+requests>=2.32.3
+basyx-python-sdk>=1.2.1

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/pyproject.toml

@@ -4,13 +4,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aas-http-client"
-version = "0.2.61"
+version = "0.3.1"
 description = "Generic python HTTP client for communication with various types of AAS servers"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [{ name = "Daniel Klein", email = "daniel.klein@em.ag" }]
-dependencies = []
-
+dependencies = [
+    "typing>=3.7.4.3",
+    "pydantic>=2.11.5",
+    "requests>=2.32.3",
+    "basyx-python-sdk>=1.2.1",
+]
 [project.urls]
 Homepage = "https://github.com/fluid40/aas-http-client"
 

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/tests/test_client.py

@@ -5,12 +5,15 @@ from basyx.aas import model
 import aas_http_client.utilities.model_builder as model_builder
 import json
 import basyx.aas.adapter.json
+from urllib.parse import urlparse
 
-JAVA_SERVER_PORT = "8075"
+JAVA_SERVER_PORTS = [8075]
+PYTHON_SERVER_PORTS = [8080, 80]
 
 CONFIG_FILES = [
     "./tests/server_configs/test_dotnet_server_config.json",
     "./tests/server_configs/test_java_server_config.json",
+    "./tests/server_configs/test_python_server_config.json",
 ]
 
 @pytest.fixture(params=CONFIG_FILES, scope="module")
@@ -51,9 +54,39 @@ def shared_aas(shared_sm: model.Submodel) -> model.AssetAdministrationShell:
 
     return aas
 
-def test_001_connect(client: AasHttpClient):
+def test_001a_connect(client: AasHttpClient):
     assert client is not None
 
+def test_001b_delete_all_asset_administration_shells(client: AasHttpClient):
+    result = client.get_all_asset_administration_shells()
+    assert result is not None
+    shells = result.get("result", [])
+
+    for shell in shells:
+        shell_id = shell.get("id", "")
+        if shell_id:
+            delete_result = client.delete_asset_administration_shell_by_id(shell_id)
+            assert delete_result
+
+    shells_result = client.get_all_asset_administration_shells()
+    shells = shells_result.get("result", [])
+    assert len(shells) == 0
+
+def test_001c_delete_all_submodels(client: AasHttpClient):
+    result = client.get_all_submodels()
+    assert result is not None
+    submodels = result.get("result", [])
+
+    for submodel in submodels:
+        submodel_id = submodel.get("id", "")
+        if submodel_id:
+            delete_result = client.delete_submodel_by_id(submodel_id)
+            assert delete_result
+
+    submodels_result = client.get_all_submodels()
+    submodels = submodels_result.get("result", [])
+    assert len(submodels) == 0
+
 def test_002_get_all_asset_administration_shells(client: AasHttpClient):
     result = client.get_all_asset_administration_shells()
     assert result is not None
@@ -113,9 +146,14 @@ def test_005a_put_asset_administration_shell_by_id(client: AasHttpClient, shared
     assert len(get_result.get("submodels", [])) == len(shared_aas.submodel)
 
     # The display name must be empty
-    # currently not working in dotnet
+    # NOTE: currently not working in dotnet
     # assert len(get_result.get("displayName", {})) == 0
 
+    # restore to its original state
+    sm_data_string = json.dumps(shared_aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+    sm_data = json.loads(sm_data_string)
+    client.put_asset_administration_shell_by_id(shared_aas.id, sm_data)  # Restore original submodel
+
 def test_005b_put_asset_administration_shell_by_id(client: AasHttpClient, shared_aas: model.AssetAdministrationShell):
     # put with other ID
     id_short = "put_short_id"
@@ -129,15 +167,26 @@ def test_005b_put_asset_administration_shell_by_id(client: AasHttpClient, shared
     aas_data_string = json.dumps(aas, cls=basyx.aas.adapter.json.AASToJsonEncoder)
     aas_data = json.loads(aas_data_string)
 
-    result = client.put_asset_administration_shell_by_id(shared_aas.id, aas_data)
+    parsed = urlparse(client.base_url)
+    if int(parsed.port) in PYTHON_SERVER_PORTS:
+        # NOTE: Python server crashes by this test
+        result = False
+    else:
+        result = client.put_asset_administration_shell_by_id(shared_aas.id, aas_data)
 
     assert not result
 
+    get_result = client.get_asset_administration_shell_by_id(shared_aas.id)
+
+    assert get_result.get("description", {})[0].get("text", "") != description_text
+    assert get_result.get("description", {})[0].get("text", "") == shared_aas.description.get("en", "")
+
 def test_006_get_asset_administration_shell_by_id_reference_aas_repository(client: AasHttpClient, shared_aas: model.AssetAdministrationShell):
     result = client.get_asset_administration_shell_by_id_reference_aas_repository(shared_aas.id)
 
-    if JAVA_SERVER_PORT in client.base_url:
-        # Basyx java server do not provide this endpoint
+    parsed = urlparse(client.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS:
+        # NOTE: Basyx java server do not provide this endpoint
         assert result is None
     else:
         assert result is not None
@@ -175,8 +224,9 @@ def test_009_post_submodel(client: AasHttpClient, shared_sm: model.Submodel):
 def test_010_get_submodel_by_id_aas_repository(client: AasHttpClient, shared_aas: model.AssetAdministrationShell, shared_sm: model.Submodel):
     result = client.get_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id)
 
-    if JAVA_SERVER_PORT in client.base_url:
-        # Basyx java server do not provide this endpoint
+    parsed = urlparse(client.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS:
+        # NOTE: Basyx java server do not provide this endpoint
         assert result is None
     else:
         assert result is not None
@@ -207,8 +257,9 @@ def test_012_patch_submodel_by_id(client: AasHttpClient, shared_sm: model.Submod
 
     result = client.patch_submodel_by_id(shared_sm.id, sm_data)
 
-    if JAVA_SERVER_PORT in client.base_url:
-        # Basyx java server do not provide this endpoint
+    parsed = urlparse(client.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS or int(parsed.port) in PYTHON_SERVER_PORTS:
+        # NOTE: Basyx java and python server do not provide this endpoint
         assert not result
     else:
         assert result
@@ -235,8 +286,9 @@ def test_013_put_submodel_by_id_aas_repository(client: AasHttpClient, shared_aas
 
     result = client.put_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id, sm_data)
 
-    if JAVA_SERVER_PORT in client.base_url:
-        # Basyx java server do not provide this endpoint
+    parsed = urlparse(client.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS:
+        # NOTE: Basyx java server do not provide this endpoint
         assert not result
     else:
         assert result
@@ -302,9 +354,16 @@ def test_016_post_submodel_element_submodel_repo(client: AasHttpClient, shared_s
 
     get_result = client.get_all_submodel_elements_submodel_repository(shared_sm.id)
 
-    assert get_result is not None
     assert len(get_result.get("result", [])) == 1
 
+def test_017_get_submodel_element_by_path_submodel_repo(client: AasHttpClient, shared_sm: model.Submodel, shared_sme: model.Property):
+    result = client.get_submodel_element_by_path_submodel_repo(shared_sm.id, shared_sme.id_short)
+
+    assert result is not None
+    assert result.get("idShort", "") == shared_sme.id_short
+    assert result.get("description", {})[0].get("text", "") == shared_sme.description.get("en", "")
+    assert result.get("displayName", {})[0].get("text", "") == shared_sme.display_name.get("en", "")
+
 def test_098_delete_asset_administration_shell_by_id(client: AasHttpClient, shared_aas: model.AssetAdministrationShell):
     result = client.delete_asset_administration_shell_by_id(shared_aas.id)
 

{aas_http_client-0.2.61 → aas_http_client-0.3.1}/tests/test_wrapper.py

@@ -3,12 +3,16 @@ from pathlib import Path
 from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config, SdkWrapper
 from basyx.aas import model
 import aas_http_client.utilities.model_builder as model_builder
+from urllib.parse import urlparse
 
-JAVA_SERVER_PORT = "8075"
+JAVA_SERVER_PORTS = [8075]
+PYTHON_SERVER_PORTS = [8080, 80]
+DOTNET_SERVER_PORTS = [5043]
 
 CONFIG_FILES = [
     "./tests/server_configs/test_dotnet_server_config.json",
-    "./tests/server_configs/test_java_server_config.json"
+    "./tests/server_configs/test_java_server_config.json",
+    "./tests/server_configs/test_python_server_config.json"
 ]
 
 @pytest.fixture(params=CONFIG_FILES, scope="module")
@@ -111,6 +115,9 @@ def test_005a_put_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_a
     # currently not working in dotnet
     # assert len(get_result.get("displayName", {})) == 0
 
+    # # restore to its original state
+    wrapper.put_asset_administration_shell_by_id(shared_aas.id, shared_aas)  # Restore original submodel
+
 def test_005b_put_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell):
     # put with other ID
     id_short = "put_short_id"
@@ -121,10 +128,22 @@ def test_005b_put_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_a
     description_text = {"en": "Updated description for unit tests"}
     aas.description = model.MultiLanguageTextType(description_text)
 
-    result = wrapper.put_asset_administration_shell_by_id(shared_aas.id, aas)
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in PYTHON_SERVER_PORTS:
+        # NOTE: Python server crashes by this test
+        result = False
+    else:
+        result = wrapper.put_asset_administration_shell_by_id(shared_aas.id, aas)
 
     assert not result
 
+    assert not result
+
+    shell = wrapper.get_asset_administration_shell_by_id(shared_aas.id)
+
+    assert shell.description.get("en", "") != description_text
+    assert shell.description.get("en", "") == shared_aas.description.get("en", "")
+
 def test_006_get_asset_administration_shell_by_id_reference_aas_repository(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell):
     reference = wrapper.get_asset_administration_shell_by_id_reference_aas_repository(shared_aas.id)
 
@@ -158,7 +177,8 @@ def test_009_post_submodel(wrapper: SdkWrapper, shared_sm: model.Submodel):
 def test_010_get_submodel_by_id_aas_repository(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell, shared_sm: model.Submodel):
     submodel = wrapper.get_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id)
 
-    if JAVA_SERVER_PORT in wrapper.base_url:
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS:
         # Basyx java server do not provide this endpoint
         assert submodel is None
     else:
@@ -187,7 +207,8 @@ def test_012_patch_submodel_by_id(wrapper: SdkWrapper, shared_sm: model.Submodel
 
     result = wrapper.patch_submodel_by_id(shared_sm.id, sm)
 
-    if JAVA_SERVER_PORT in wrapper.base_url:
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS or int(parsed.port) in PYTHON_SERVER_PORTS:
         # Basyx java server do not provide this endpoint
         assert not result
     else:
@@ -214,7 +235,8 @@ def test_013_put_submodel_by_id_aas_repository(wrapper: SdkWrapper, shared_aas:
 
     result = wrapper.put_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id, sm)
 
-    if JAVA_SERVER_PORT in wrapper.base_url:
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in JAVA_SERVER_PORTS:
         # Basyx java server do not provide this endpoint
         assert not result
     else:
@@ -275,20 +297,38 @@ def test_016_post_submodel_element_submodel_repo(wrapper: SdkWrapper, shared_sm:
 
     assert submodel_element is not None
 
-    # currently only dict is returned
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in DOTNET_SERVER_PORTS:
+        # NOTE: dotNet server provides a wrong representation of submodel elements
+        return
 
-    # property: model.Property = submodel_element
+    assert isinstance(submodel_element, model.Property)
 
-    # assert property.id_short == shared_sme.id_short
-    # assert property.description.get("em", "") == shared_sme.description.get("en", "")
-    # assert property.display_name.get("em", "")  == shared_sme.display_name.get("en", "")
-    # assert property.value == shared_sme.value
+    assert submodel_element.id_short == shared_sme.id_short
+    assert submodel_element.description.get("en", "") == shared_sme.description.get("en", "")
+    assert submodel_element.display_name.get("en", "") == shared_sme.display_name.get("en", "")
 
     submodel_elements = wrapper.get_all_submodel_elements_submodel_repository(shared_sm.id)
 
     assert submodel_elements is not None
     assert len(submodel_elements) == 1
 
+def test_017_get_submodel_element_by_path_submodel_repo(wrapper: SdkWrapper, shared_sm: model.Submodel, shared_sme: model.Property):
+    submodel_element = wrapper.get_submodel_element_by_path_submodel_repo(shared_sm.id, shared_sme.id_short)
+
+    assert submodel_element is not None
+
+    parsed = urlparse(wrapper.base_url)
+    if int(parsed.port) in DOTNET_SERVER_PORTS:
+        # NOTE: dotNet server provides a wrong representation of submodel elements
+        return
+
+    assert isinstance(submodel_element, model.Property)
+
+    assert submodel_element.id_short == shared_sme.id_short
+    assert submodel_element.description.get("en", "") == shared_sme.description.get("en", "")
+    assert submodel_element.display_name.get("en", "") == shared_sme.display_name.get("en", "")
+
 def test_098_delete_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell):
     result = wrapper.delete_asset_administration_shell_by_id(shared_aas.id)