aas-http-client 1.2.20__tar.gz → 1.3.0__tar.gz

{aas_http_client-1.2.20 → aas_http_client-1.3.0}/PKG-INFO

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

{aas_http_client-1.2.20 → aas_http_client-1.3.0}/aas_http_client/classes/client/implementations/experimental_implementation.py

@@ -3,7 +3,7 @@
 import logging
 import mimetypes
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from aas_http_client.utilities.constants import LogIntensity
 
@@ -263,6 +263,54 @@ class ExperimentalImplementation(BaseModel):
 
         return True
 
+    # POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
+    def post_file_by_path_submodel_repo_stream(
+        self, submodel_identifier: str, id_short_path: str, file_octet_stream: Any, mime_type: str = "application/octet-stream"
+    ) -> bool:
+        """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
+
+        :param submodel_identifier: The Submodels unique id
+        :param id_short_path: IdShort path to the submodel element (dot-separated)
+        :param file_octet_stream: File content as a byte stream
+        :return: Attachment data as bytes or None if an error occurred
+        """
+        if file_octet_stream is None:
+            _logger.error("Attachment file stream is None.")
+            return False
+
+        if not self._client.encoded_ids:
+            submodel_identifier = encode_base_64(submodel_identifier)
+
+        url = f"{self._client.base_url}/submodels/{submodel_identifier}/submodel-elements/{id_short_path}/attachment"
+
+        self._client.set_token()
+
+        try:
+            files = {"file": ("attachment", file_octet_stream, mime_type or "application/octet-stream")}
+            response = self._session.post(url, files=files, timeout=self._client.time_out)
+
+            _logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code == STATUS_CODE_404:
+                if self._client.get_log_intensity() == LogIntensity.HIGH:
+                    _logger.warning(f"Submodel with id '{submodel_identifier}' or Submodel element with IDShort path '{id_short_path}' not found.")
+                elif self._client.get_log_intensity() == LogIntensity.STANDARD:
+                    _logger.debug(f"Submodel with id '{submodel_identifier}' or Submodel element with IDShort path '{id_short_path}' not found.")
+
+                _logger.debug(response.text)
+                return False
+
+            # original dotnet server delivers 200 instead of 204
+            if response.status_code not in (STATUS_CODE_200, STATUS_CODE_204):
+                log_response(response)
+                return False
+
+        except requests.exceptions.RequestException as e:
+            _logger.error(f"Error call REST API: {e}")
+            return False
+
+        return True
+
     # PUT /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
     def put_file_by_path_submodel_repo(self, submodel_identifier: str, id_short_path: str, file: Path) -> bool:
         """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
@@ -312,6 +360,54 @@ class ExperimentalImplementation(BaseModel):
 
         return True
 
+    # PUT /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
+    def put_file_by_path_submodel_repo_stream(
+        self, submodel_identifier: str, id_short_path: str, file_octet_stream: Any, mime_type: str = "application/octet-stream"
+    ) -> bool:
+        """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
+
+        :param submodel_identifier: The Submodels unique id
+        :param id_short_path: IdShort path to the submodel element (dot-separated)
+        :param file_octet_stream: File content as a byte stream
+        :return: Attachment data as bytes or None if an error occurred
+        """
+        if file_octet_stream is None:
+            _logger.error("Attachment file stream is None.")
+            return False
+
+        if not self._client.encoded_ids:
+            submodel_identifier = encode_base_64(submodel_identifier)
+
+        url = f"{self._client.base_url}/submodels/{submodel_identifier}/submodel-elements/{id_short_path}/attachment"
+
+        self._client.set_token()
+
+        try:
+            files = {"file": ("attachment", file_octet_stream, mime_type or "application/octet-stream")}
+            response = self._session.put(url, files=files, timeout=self._client.time_out)
+
+            _logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code == STATUS_CODE_404:
+                if self._client.get_log_intensity() == LogIntensity.HIGH:
+                    _logger.warning(f"Submodel with id '{submodel_identifier}' or Submodel element with IDShort path '{id_short_path}' not found.")
+                elif self._client.get_log_intensity() == LogIntensity.STANDARD:
+                    _logger.debug(f"Submodel with id '{submodel_identifier}' or Submodel element with IDShort path '{id_short_path}' not found.")
+
+                _logger.debug(response.text)
+                return False
+
+            # original dotnet server delivers 200 instead of 204
+            if response.status_code not in (STATUS_CODE_200, STATUS_CODE_204):
+                log_response(response)
+                return False
+
+        except requests.exceptions.RequestException as e:
+            _logger.error(f"Error call REST API: {e}")
+            return False
+
+        return True
+
     # DELETE /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
     def delete_file_by_path_submodel_repo(self, submodel_identifier: str, id_short_path: str) -> bool:
         """Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.

{aas_http_client-1.2.20 → aas_http_client-1.3.0}/aas_http_client/classes/wrapper/sdk_wrapper.py

@@ -851,6 +851,25 @@ class SdkWrapper:
 
         return self._client.experimental.post_file_by_path_submodel_repo(submodel_identifier, id_short_path, file)
 
+    # POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
+    def experimental_post_file_by_path_submodel_repo_stream(
+        self, submodel_identifier: str, id_short_path: str, file_octet_stream: Any, mime_type: str = "application/octet-stream"
+    ) -> bool:
+        """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
+
+        :param submodel_identifier: The Submodels unique id
+        :param id_short_path: IdShort path to the submodel element (dot-separated)
+        :param file_octet_stream: File content as a byte stream
+        :param mime_type: MIME type of the file content, defaults to "application/octet-stream"
+        :return: Attachment data as bytes or None if an error occurred
+        """
+        if not self._client.experimental:
+            _logger.error("Experimental API is not initialized in the client. Call 'initialize()' method of the client before calling this method.")
+            return False
+
+        return self._client.experimental.post_file_by_path_submodel_repo_stream(submodel_identifier, id_short_path, file_octet_stream, mime_type)
+
+    # PUT /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
     def experimental_put_file_by_path_submodel_repo(self, submodel_identifier: str, id_short_path: str, file: Path) -> bool:
         """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
 
@@ -865,6 +884,23 @@ class SdkWrapper:
 
         return self._client.experimental.put_file_by_path_submodel_repo(submodel_identifier, id_short_path, file)
 
+    # PUT /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment
+    def experimental_put_file_by_path_submodel_repo_stream(
+        self, submodel_identifier: str, id_short_path: str, file_octet_stream: Any, mime_type: str = "application/octet-stream"
+    ) -> bool:
+        """Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
+
+        :param submodel_identifier: The Submodels unique id
+        :param id_short_path: IdShort path to the submodel element (dot-separated)
+        :param file: Path to the file to upload as attachment
+        :return: Attachment data as bytes or None if an error occurred
+        """
+        if not self._client.experimental:
+            _logger.error("Experimental API is not initialized in the client. Call 'initialize()' method of the client before calling this method.")
+            return False
+
+        return self._client.experimental.put_file_by_path_submodel_repo_stream(submodel_identifier, id_short_path, file_octet_stream, mime_type)
+
     def experimental_delete_file_by_path_submodel_repo(self, submodel_identifier: str, id_short_path: str) -> bool:
         """Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy. Experimental feature - may not be supported by all servers.
 

{aas_http_client-1.2.20 → aas_http_client-1.3.0}/aas_http_client.egg-info/PKG-INFO

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

{aas_http_client-1.2.20 → aas_http_client-1.3.0}/pyproject.toml

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