aas-http-client 0.4.1__tar.gz → 0.4.2__tar.gz

{aas_http_client-0.4.1 → aas_http_client-0.4.2}/PKG-INFO

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

@@ -510,6 +510,32 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
+    def post_submodel_element_by_path_submodel_repo(self, submodel_id: str, submodel_element_path: str, submodel_element_data: dict) -> dict | None:
+        """Creates a new submodel element at a specified path within submodel elements hierarchy.
+
+        :param submodel_id: Encoded ID of the Submodel to create elements for
+        :param submodel_element_path: Path within the Submodel elements hierarchy
+        :param submodel_element_data: Data for the new Submodel element
+        :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.post(url, headers=HEADERS, json=submodel_element_data, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_201:
+                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 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.
 

{aas_http_client-0.4.1 → aas_http_client-0.4.2}/aas_http_client/wrapper/sdk_wrapper.py

@@ -257,7 +257,7 @@ class SdkWrapper:
         return submodel_elements
 
     def post_submodel_element_submodel_repo(self, submodel_id: str, submodel_element: model.SubmodelElement) -> model.SubmodelElement | None:
-        """Creates a new submodel element. !!!Serialization to model.SubmodelElements currently not possible.
+        """Creates a new submodel element.
 
         :param submodel_id: Encoded ID of the submodel to create elements for
         :param submodel_element: Submodel element to create
@@ -267,6 +267,20 @@ class SdkWrapper:
         content: dict = self._client.post_submodel_element_submodel_repo(submodel_id, sme_data)
         return _to_object(content)
 
+    def post_submodel_element_by_path_submodel_repo(
+        self, submodel_id: str, submodel_element_path: str, submodel_element: model.SubmodelElement
+    ) -> model.SubmodelElement | None:
+        """Creates a new submodel element at a specified path within submodel elements hierarchy.
+
+        :param submodel_id: Encoded ID of the submodel to create elements for
+        :param submodel_element_path: Path within the Submodel elements hierarchy
+        :param submodel_element: The new Submodel element
+        :return: Submodel element object or None if an error occurred
+        """
+        sme_data = _to_dict(submodel_element)
+        content: dict = self._client.post_submodel_element_by_path_submodel_repo(submodel_id, submodel_element_path, 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.
 

{aas_http_client-0.4.1 → aas_http_client-0.4.2}/aas_http_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.4.1
+Version: 0.4.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.4.1 → aas_http_client-0.4.2}/pyproject.toml

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

{aas_http_client-0.4.1 → aas_http_client-0.4.2}/tests/test_client.py

@@ -555,6 +555,60 @@ def test_018d_patch_submodel_element_by_path_value_only_submodel_repo(client: Aa
         assert get_result.get("description", {})[0].get("text", "") == shared_sme_float.description.get("en", "")
         assert get_result.get("displayName", {})[0].get("text", "") == shared_sme_float.display_name.get("en", "")
 
+def test_019a_post_submodel_element_by_path_submodel_repo(client: AasHttpClient, shared_sm: model.Submodel):
+    submodel_element_list = model.SubmodelElementList(id_short="sme_list_1", type_value_list_element=model.Property, value_type_list_element=model.datatypes.String)
+    submodel_element_list_dict = sdk_tools.convert_to_dict(submodel_element_list)
+    first_result = client.post_submodel_element_submodel_repo(shared_sm.id, submodel_element_list_dict)
+
+    assert first_result is not None
+
+    property = model_builder.create_base_submodel_element_property("sme_property_in_list", model.datatypes.String, "Value in List")
+    property_dict = sdk_tools.convert_to_dict(property)
+    del property_dict["idShort"]
+
+    result = client.post_submodel_element_by_path_submodel_repo(shared_sm.id, submodel_element_list.id_short, property_dict)
+
+    assert result is not None
+    assert "idShort" not in result  # idShort was deleted
+
+    submodel = client.get_submodel_by_id(shared_sm.id)
+
+    assert submodel is not None
+    elements = submodel.get("submodelElements", [])
+    assert len(elements) == 5  # 4 previous properties + 1 list
+    assert elements[4].get("idShort", "") == submodel_element_list.id_short
+    list_elements = elements[4].get("value", [])
+    assert len(list_elements) == 1
+    assert list_elements[0].get("idShort", "") == ""
+    assert list_elements[0].get("value", "") == property.value
+
+
+def test_019b_post_submodel_element_by_path_submodel_repo(client: AasHttpClient, shared_sm: model.Submodel):
+    submodel_element_collection = model.SubmodelElementCollection(id_short="sme_collection_1")
+    submodel_element_collection_dict = sdk_tools.convert_to_dict(submodel_element_collection)
+    first_result = client.post_submodel_element_submodel_repo(shared_sm.id, submodel_element_collection_dict)
+
+    assert first_result is not None
+
+    property = model_builder.create_base_submodel_element_property("sme_property_in_collection", model.datatypes.String, "Value in List")
+    property_dict = sdk_tools.convert_to_dict(property)
+
+    result = client.post_submodel_element_by_path_submodel_repo(shared_sm.id, submodel_element_collection.id_short, property_dict)
+
+    assert result is not None
+    assert result["idShort"] == property.id_short
+
+    submodel = client.get_submodel_by_id(shared_sm.id)
+
+    assert submodel is not None
+    elements = submodel.get("submodelElements", [])
+    assert len(elements) == 6
+    assert elements[5].get("idShort", "") == submodel_element_collection.id_short
+    list_elements = elements[5].get("value", [])
+    assert len(list_elements) == 1
+    assert list_elements[0].get("idShort", "") == property.id_short
+    assert list_elements[0].get("value", "") == property.value
+
 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)