aas-http-client 0.3.6__tar.gz → 0.3.9__tar.gz

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/PKG-INFO

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

@@ -617,7 +617,7 @@ def create_client_by_url(
     :param trust_env: Whether to trust environment variables for proxy settings, defaults to True
     :return: An instance of Http client initialized with the provided parameters.
     """
-    logger.info(f"Create AAS server http 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
@@ -637,7 +637,7 @@ def create_client_by_dict(configuration: dict, password: str = "") -> AasHttpCli
     :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}'")
+    logger.info("Create AAS server http client from dictionary.")
     config_string = json.dumps(configuration, indent=4)
 
     return _create_client(config_string, password)
@@ -651,7 +651,7 @@ def create_client_by_config(config_file: Path, password: str = "") -> AasHttpCli
     :return: An instance of Http client initialized with the provided parameters.
     """
     config_file = config_file.resolve()
-    logger.info(f"Create AAS server 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.")
@@ -674,7 +674,7 @@ def _create_client(config_string: str, password: str) -> AasHttpClient | None:
         f"username: '{client.username}' | "
         f"https_proxy: '{client.https_proxy}' | "
         f"http_proxy: '{client.http_proxy}' | "
-        f"connection_timeout: '{client.connection_time_out}'"
+        f"connection_timeout: '{client.connection_time_out}'."
     )
     client.initialize(password)
 
@@ -689,7 +689,7 @@ def _create_client(config_string: str, password: str) -> AasHttpClient | None:
 
 def _connect_to_api(client: AasHttpClient) -> bool:
     start_time = time.time()
-    logger.debug(f"Try to connect to REST API '{client.base_url}' for {client.connection_time_out} seconds")
+    logger.debug(f"Try to connect to REST API '{client.base_url}' for {client.connection_time_out} seconds.")
     counter: int = 0
     while True:
         try:
@@ -703,7 +703,7 @@ def _connect_to_api(client: AasHttpClient) -> bool:
             raise TimeoutError(f"Connection to server API timed out after {client.connection_time_out} seconds.")
 
         counter += 1
-        logger.warning(f"Retrying connection (attempt: {counter})")
+        logger.warning(f"Retrying connection (attempt: {counter}).")
         time.sleep(1)
 
 

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/aas_http_client/core/version_check.py

@@ -1,6 +1,8 @@
-import requests
 import importlib.metadata
 
+import requests
+
+
 def check_for_update(package_name="aas-http-client"):
     try:
         current_version = importlib.metadata.version(package_name)
@@ -14,4 +16,4 @@ def check_for_update(package_name="aas-http-client"):
                 f"Use the following command to update the package: pip install --upgrade {package_name}"
             )
     except Exception:
-        pass
+        pass

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/aas_http_client/demo/demo_process.py

@@ -16,7 +16,7 @@ def start() -> None:
     """Start the demo process."""
     # 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")
+    sme = model_builder.create_base_submodel_element_property(sme_short_id, model.datatypes.String, "Sample Value")
 
     # create a submodel
     sm_short_id: str = model_builder.create_unique_short_id("poc_sm")

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/aas_http_client/utilities/model_builder.py

@@ -18,10 +18,10 @@ def create_unique_short_id(id_short: str) -> str:
     return f"{id_short}_{str(uuid.uuid4()).replace('-', '_')}"
 
 
-def create_base_submodel_element_Property(
+def create_base_submodel_element_property(
     id_short: str, type: model.datatypes, value: Any, display_name: str = "", description: str = ""
 ) -> model.Property:
-    """Create a basic Property Submodel Element."""
+    """Create a basic SubmodelElement of type Property."""
     sme = model.Property(id_short=id_short, value_type=type, value=value)
 
     if not description:
@@ -39,17 +39,15 @@ def create_base_submodel_element_Property(
     return sme
 
 
-def create_base_submodel(id_short: str, namespace: str = "fluid40", display_name: str = "", description: str = "") -> model.Submodel:
+def create_base_submodel(identifier: str, id_short: str, display_name: str = "", description: str = "") -> model.Submodel:
     """Create a basic Submodel.
 
+    :param identifier: identifier of the Submodel
     :param id_short: ID short of the Submodel
-    :param namespace: namespace of the Submodel , defaults to "fluid40"
     :param display_name: display name of the Submodel, defaults to ""
     :param description: description of the Submodel, defaults to ""
     :return: Submodel instance
     """
-    identifier = f"{namespace}/{id_short}" if namespace else id_short
-
     sm = model.Submodel(identifier)
     sm.id_short = id_short
 
@@ -68,16 +66,16 @@ def create_base_submodel(id_short: str, namespace: str = "fluid40", display_name
     return sm
 
 
-def create_base_ass(id_short: str, namespace: str = "fluid40", display_name: str = "", description: str = "") -> model.AssetAdministrationShell:
+def create_base_ass(identifier: str, id_short: str, display_name: str = "", description: str = "") -> model.AssetAdministrationShell:
     """Create a basic AAS.
 
+    :param identifier: identifier of the AAS
     :param id_short: ID short of the AAS
-    :param namespace: namespace of the AAS, defaults to "basyx_python_aas_server"
     :param display_name: display name of the AAS, defaults to ""
     :param description: description of the AAS, defaults to ""
     :return: AssetAdministrationShell instance
     """
-    asset_info = create_base_asset_information(id_short, namespace)
+    asset_info = create_base_asset_information(identifier)
 
     aas = model.AssetAdministrationShell(id_=asset_info.global_asset_id, asset_information=asset_info)
     aas.id_short = id_short
@@ -97,24 +95,13 @@ def create_base_ass(id_short: str, namespace: str = "fluid40", display_name: str
     return aas
 
 
-def add_submodel_to_aas(aas: model.AssetAdministrationShell, submodel: model.Submodel) -> None:
-    """Add a given Submodel correctly to a provided AssetAdministrationShell.
-
-    :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 create_base_asset_information(id_short: str, namespace: str = "basyx_python_aas_server") -> model.AssetInformation:
+def create_base_asset_information(identifier: str) -> model.AssetInformation:
     """Return a basic AssetInformation instance.
 
     :param id_short: short ID of the AssetInformation
     :param namespace: namespace of the AssetInformation, defaults to "basyx_python_aas_server"
     :return: AssetInformation instance
     """
-    identifier = f"{namespace}/{id_short}" if namespace else id_short
     return model.AssetInformation(model.AssetKind.INSTANCE, identifier)
 
 

aas_http_client-0.3.9/aas_http_client/utilities/sdk_tools.py

@@ -0,0 +1,50 @@
+"""Utility functions for working with the BaSyx SDK framework objects."""
+
+import json
+import logging
+from typing import Any
+
+import basyx.aas.adapter.json
+from basyx.aas import model
+
+logger = logging.getLogger(__name__)
+
+
+def add_submodel_to_aas(aas: model.AssetAdministrationShell, submodel: model.Submodel) -> None:
+    """Add a given Submodel correctly to a provided AssetAdministrationShell.
+
+    :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 convert_to_object(content: dict) -> Any | None:
+    """Convert a dictionary to a BaSyx SDK framework object.
+
+    :param content: dictionary to convert
+    :return: BaSyx SDK framework object or None
+    """
+    try:
+        dict_string = json.dumps(content)
+        return json.loads(dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
+    except Exception as e:
+        logger.error(f"Decoding error: {e}")
+        logger.error(f"In JSON: {content}")
+        return None
+
+
+def convert_to_dict(object: Any) -> dict | None:
+    """Convert a BaSyx SDK framework object. to a dictionary.
+
+    :param object: BaSyx SDK framework object to convert
+    :return: dictionary representation of the object or None
+    """
+    try:
+        data_string = json.dumps(object, cls=basyx.aas.adapter.json.AASToJsonEncoder)
+        return json.loads(data_string)
+    except Exception as e:
+        logger.error(f"Encoding error: {e}")
+        logger.error(f"In object: {object}")
+        return None

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/aas_http_client/wrapper/sdk_wrapper.py

@@ -3,12 +3,12 @@
 import json
 import logging
 from pathlib import Path
-from typing import Any
 
-import basyx.aas.adapter.json
 from basyx.aas import model
 
 from aas_http_client.client import AasHttpClient, _create_client
+from aas_http_client.utilities.sdk_tools import convert_to_dict as _to_dict
+from aas_http_client.utilities.sdk_tools import convert_to_object as _to_object
 
 logger = logging.getLogger(__name__)
 
@@ -298,31 +298,6 @@ class SdkWrapper:
         return self._client
 
 
-# region utils
-
-
-def _to_object(content: dict) -> Any | None:
-    try:
-        dict_string = json.dumps(content)
-        return json.loads(dict_string, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
-    except Exception as e:
-        logger.error(f"Decoding error: {e}")
-        logger.error(f"In JSON: {content}")
-        return None
-
-
-def _to_dict(object: Any) -> dict | None:
-    try:
-        data_string = json.dumps(object, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-        return json.loads(data_string)
-    except Exception as e:
-        logger.error(f"Encoding error: {e}")
-        logger.error(f"In object: {object}")
-        return None
-
-
-# endregion
-
 # region wrapper
 
 
@@ -350,7 +325,7 @@ def create_wrapper_by_url(
     :param trust_env: Whether to trust environment variables for proxy settings, defaults to True
     :return: An instance of SdkWrapper initialized with the provided parameters.
     """
-    logger.info(f"Create AAS server 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
@@ -370,7 +345,7 @@ def create_wrapper_by_dict(configuration: dict, password: str = "") -> SdkWrappe
     :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}'")
+    logger.info("Create AAS server wrapper from dictionary.")
     config_string = json.dumps(configuration, indent=4)
     return SdkWrapper(config_string, password)
 
@@ -382,7 +357,7 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrappe
     :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 wrapper client 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.")

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/aas_http_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.3.6
+Version: 0.3.9
 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.6 → aas_http_client-0.3.9}/aas_http_client.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ aas_http_client/core/version_check.py
 aas_http_client/demo/demo_process.py
 aas_http_client/utilities/__init__.py
 aas_http_client/utilities/model_builder.py
+aas_http_client/utilities/sdk_tools.py
 aas_http_client/wrapper/sdk_wrapper.py
 tests/test_client.py
 tests/test_wrapper.py

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/pyproject.toml

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

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/tests/test_client.py

@@ -3,6 +3,7 @@ from pathlib import Path
 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 aas_http_client.utilities.sdk_tools as sdk_tools
 import json
 import basyx.aas.adapter.json
 from urllib.parse import urlparse
@@ -41,35 +42,35 @@ def client(request) -> AasHttpClient:
 @pytest.fixture(scope="module")
 def shared_sme_string() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_string", model.datatypes.String, "Sample String Value")
+    return model_builder.create_base_submodel_element_property("sme_property_string", model.datatypes.String, "Sample String Value")
 
 @pytest.fixture(scope="module")
 def shared_sme_bool() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_bool", model.datatypes.Boolean, True)
+    return model_builder.create_base_submodel_element_property("sme_property_bool", model.datatypes.Boolean, True)
 
 @pytest.fixture(scope="module")
 def shared_sme_int() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_int", model.datatypes.Integer, 262)
+    return model_builder.create_base_submodel_element_property("sme_property_int", model.datatypes.Integer, 262)
 
 @pytest.fixture(scope="module")
 def shared_sme_float() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_float", model.datatypes.Float, 262.3)
+    return model_builder.create_base_submodel_element_property("sme_property_float", model.datatypes.Float, 262.3)
 
 @pytest.fixture(scope="module")
 def shared_sm() -> model.Submodel:
     # create a Submodel
-    return model_builder.create_base_submodel("sm_http_client_unit_tests", "")
+    return model_builder.create_base_submodel(identifier="fluid40/sm_http_client_unit_tests", id_short="sm_http_client_unit_tests")
 
 @pytest.fixture(scope="module")
 def shared_aas(shared_sm: model.Submodel) -> model.AssetAdministrationShell:
     # create an AAS
-    aas = model_builder.create_base_ass(id_short="aas_http_client_unit_tests", namespace="")
+    aas = model_builder.create_base_ass(identifier="fluid40/aas_http_client_unit_tests", id_short="aas_http_client_unit_tests")
 
     # add Submodel to AAS
-    model_builder.add_submodel_to_aas(aas, shared_sm)
+    sdk_tools.add_submodel_to_aas(aas, shared_sm)
 
     return aas
 
@@ -133,20 +134,22 @@ def test_003_post_asset_administration_shell(client: AasHttpClient, shared_aas:
     result = client.post_asset_administration_shell(aas_data)
 
     assert result is not None
-    result_id_short = result.get("idShort", "")
-    assert result_id_short == shared_aas.id_short
+    assert result.get("idShort", "") == shared_aas.id_short
+    assert result.get("id", "") == shared_aas.id
 
     get_result = client.get_all_asset_administration_shells()
     assert get_result is not None
     shells = get_result.get("result", [])
     assert len(shells) == 1
     assert shells[0].get("idShort", "") == shared_aas.id_short
+    assert shells[0].get("id", "") == shared_aas.id
 
 def test_004a_get_asset_administration_shell_by_id(client: AasHttpClient, shared_aas: model.AssetAdministrationShell):
     result = client.get_asset_administration_shell_by_id(shared_aas.id)
 
     assert result is not None
     assert result.get("idShort", "") == shared_aas.id_short
+    assert result.get("id", "") == shared_aas.id
 
 def test_004b_get_asset_administration_shell_by_id(client: AasHttpClient):
     result = client.get_asset_administration_shell_by_id("non_existent_id")
@@ -191,7 +194,8 @@ def test_005a_put_asset_administration_shell_by_id(client: AasHttpClient, shared
 def test_005b_put_asset_administration_shell_by_id(client: AasHttpClient, shared_aas: model.AssetAdministrationShell):
     # put with other ID
     id_short = "put_short_id"
-    asset_info = model_builder.create_base_asset_information(id_short)
+    identifier = f"fluid40/{id_short}"
+    asset_info = model_builder.create_base_asset_information(identifier)
     aas = model.AssetAdministrationShell(id_=asset_info.global_asset_id, asset_information=asset_info)
     aas.id_short = id_short
 
@@ -309,7 +313,7 @@ def test_012_patch_submodel_by_id(client: AasHttpClient, shared_sm: model.Submod
         assert get_result.get("displayName", {})[0].get("text", "") == shared_sm.display_name.get("en", "")
 
 def test_013_put_submodel_by_id_aas_repository(client: AasHttpClient, shared_aas: model.AssetAdministrationShell, shared_sm: model.Submodel):
-    sm = model.Submodel(shared_sm.id_short)
+    sm = model.Submodel(shared_sm.id)
     sm.id_short = shared_sm.id_short
 
     description_text = "Put via shell description for unit tests"
@@ -342,7 +346,7 @@ def test_013_put_submodel_by_id_aas_repository(client: AasHttpClient, shared_aas
     client.put_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id, sm_data)  # Restore original submodel
 
 def test_014_put_submodels_by_id(client: AasHttpClient, shared_sm: model.Submodel):
-    sm = model.Submodel(shared_sm.id_short)
+    sm = model.Submodel(shared_sm.id)
     sm.id_short = shared_sm.id_short
 
     description_text = "Put description for unit tests"

{aas_http_client-0.3.6 → aas_http_client-0.3.9}/tests/test_wrapper.py

@@ -3,6 +3,7 @@ from pathlib import Path
 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
+import aas_http_client.utilities.sdk_tools as sdk_tools
 from urllib.parse import urlparse
 import json
 
@@ -41,37 +42,37 @@ def wrapper(request) -> SdkWrapper:
 @pytest.fixture(scope="module")
 def shared_sme_string() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_string", model.datatypes.String, "Sample String Value")
+    return model_builder.create_base_submodel_element_property("sme_property_string", model.datatypes.String, "Sample String Value")
 
 @pytest.fixture(scope="module")
 def shared_sme_bool() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_bool", model.datatypes.Boolean, True)
+    return model_builder.create_base_submodel_element_property("sme_property_bool", model.datatypes.Boolean, True)
 
 @pytest.fixture(scope="module")
 def shared_sme_int() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_int", model.datatypes.Integer, 262)
+    return model_builder.create_base_submodel_element_property("sme_property_int", model.datatypes.Integer, 262)
 
 @pytest.fixture(scope="module")
 def shared_sme_float() -> model.Property:
     # create a Submodel
-    return model_builder.create_base_submodel_element_Property("sme_property_float", model.datatypes.Float, 262.3)
+    return model_builder.create_base_submodel_element_property("sme_property_float", model.datatypes.Float, 262.3)
 
 @pytest.fixture(scope="module")
 def shared_sm() -> model.Submodel:
     # create a Submodel
-    submodel = model_builder.create_base_submodel("sm_http_client_unit_tests", "")
+    submodel = model_builder.create_base_submodel(identifier="fluid40/sm_http_client_unit_tests", id_short="sm_http_client_unit_tests")
     submodel.category = "Unit Test"
     return submodel
 
 @pytest.fixture(scope="module")
 def shared_aas(shared_sm: model.Submodel) -> model.AssetAdministrationShell:
     # create an AAS
-    aas = model_builder.create_base_ass(id_short="aas_http_client_unit_tests", namespace="")
+    aas = model_builder.create_base_ass(identifier="fluid40/aas_http_client_unit_tests", id_short="aas_http_client_unit_tests")
 
     # add Submodel to AAS
-    model_builder.add_submodel_to_aas(aas, shared_sm)
+    sdk_tools.add_submodel_to_aas(aas, shared_sm)
 
     return aas
 
@@ -162,7 +163,8 @@ def test_005a_put_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_a
 def test_005b_put_asset_administration_shell_by_id(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell):
     # put with other ID
     id_short = "put_short_id"
-    asset_info = model_builder.create_base_asset_information(id_short)
+    identifier = f"fluid40/{id_short}"
+    asset_info = model_builder.create_base_asset_information(identifier)
     aas = model.AssetAdministrationShell(id_=asset_info.global_asset_id, asset_information=asset_info)
     aas.id_short = id_short
 
@@ -267,7 +269,7 @@ def test_012_patch_submodel_by_id(wrapper: SdkWrapper, shared_sm: model.Submodel
         assert len(submodel.submodel_element) == len(shared_sm.submodel_element)
 
 def test_013_put_submodel_by_id_aas_repository(wrapper: SdkWrapper, shared_aas: model.AssetAdministrationShell, shared_sm: model.Submodel):
-    sm = model.Submodel(shared_sm.id_short)
+    sm = model.Submodel(shared_sm.id)
     sm.id_short = shared_sm.id_short
 
     description_text = "Put via shell description for unit tests"
@@ -300,7 +302,7 @@ def test_013_put_submodel_by_id_aas_repository(wrapper: SdkWrapper, shared_aas:
         wrapper.put_submodel_by_id_aas_repository(shared_aas.id, shared_sm.id, shared_sm)  # Restore original submodel
 
 def test_014_put_submodels_by_id(wrapper: SdkWrapper, shared_sm: model.Submodel):
-    sm = model.Submodel(shared_sm.id_short)
+    sm = model.Submodel(shared_sm.id)
     sm.id_short = shared_sm.id_short
 
     description_text = "Put description for unit tests"