qmenta-client 2.1.dev1513__tar.gz → 2.1.dev1514__tar.gz

{qmenta_client-2.1.dev1513 → qmenta_client-2.1.dev1514}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: qmenta-client
-Version: 2.1.dev1513
+Version: 2.1.dev1514
 Summary: Python client lib to interact with the QMENTA platform.
 Author: QMENTA
 Author-email: dev@qmenta.com
@@ -14,5 +14,5 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: future (>=0.18.2,<0.19.0)
 Requires-Dist: pytest-cov (>=6.1.1,<7.0.0)
-Requires-Dist: qmenta-core (>=4.0.1,<5.0.0)
+Requires-Dist: qmenta-core (==4.1)
 Project-URL: Homepage, https://www.qmenta.com/

{qmenta_client-2.1.dev1513 → qmenta_client-2.1.dev1514}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qmenta-client"
-version = "2.1.dev1513"
+version = "2.1.dev1514"
 description = "Python client lib to interact with the QMENTA platform."
 authors = ["QMENTA <dev@qmenta.com>"]
 homepage = "https://www.qmenta.com/"
@@ -15,7 +15,7 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.10"
 future = "^0.18.2"
-qmenta-core = "^4.0.1"
+qmenta-core = "4.1"
 pytest-cov = "^6.1.1"
 
 [tool.poetry.group.dev.dependencies]

{qmenta_client-2.1.dev1513 → qmenta_client-2.1.dev1514}/src/qmenta/client/Project.py

@@ -9,8 +9,10 @@ import sys
 import time
 from collections import defaultdict
 from enum import Enum
+from typing import Any, Dict, Union
 from qmenta.core import errors
 from qmenta.core import platform
+from qmenta.core.upload.single import SingleUpload, FileInfo, UploadStatus
 
 from qmenta.client import Account
 
@@ -262,12 +264,12 @@ class Project:
         description="",
         result=False,
         name="",
-        input_data_type="qmenta_medical_image_data:3.10",
+        input_data_type="qmenta_medical_image_data:3.11.3",
         add_to_container_id=0,
-        chunk_size=2**9,
-        max_retries=10,
+        chunk_size=2**24,  # Optimized for GCS Bucket Storage
+        max_retries=5,
         split_data=False,
-        mock_response=False,
+        mock_response=None,
     ):
         """
         Upload a ZIP file to the platform.
@@ -295,136 +297,55 @@ class Project:
         chunk_size : int
             Size in kB of each chunk. Should be expressed as
             a power of 2: 2**x. Default value of x is 9 (chunk_size = 512 kB)
+        max_retries: int
+            Maximum number of retries when uploading a file before raising
+            an error. Default value: 5
         split_data : bool
             If True, the platform will try to split the uploaded file into
             different sessions. It will be ignored when the ssid or a
             add_to_container_id are given.
+        mock_response: None
+            ONLY USED IN UNITTESTING
 
         Returns
         -------
         bool
             True if correctly uploaded, False otherwise.
         """
-        filename = os.path.split(file_path)[1]
-        input_data_type = "offline_analysis:1.0" if result else input_data_type
-
-        chunk_size *= 1024
-
-        name = name or os.path.split(file_path)[1]
-
-        total_bytes = os.path.getsize(file_path)
-
-        split_data = self.__assert_split_data(
-            split_data, ssid, add_to_container_id
+        input_data_type = (
+            "qmenta_upload_offline_analysis:1.0" if result else input_data_type
         )
 
-        # making chunks of the file and sending one by one
-        logger = logging.getLogger(logger_name)
-        with open(file_path, "rb") as file_object:
+        single_upload = SingleUpload(
+            self._account.auth,
+            file_path,
+            file_info=FileInfo(
+                project_id=self._project_id,
+                subject_name=subject_name,
+                session_id=str(ssid),
+                input_data_type=input_data_type,
+                split_data=split_data,
+                add_to_container_id=add_to_container_id,
+                date_of_scan=date_of_scan,
+                description=description,
+                name=name,
+            ),
+            anonymise=False,  # will be anonymised in the upload tool.
+            chunk_size=chunk_size,
+            max_retries=max_retries,
+        )
 
-            file_size = os.path.getsize(file_path)
-            if file_size == 0:
-                logger.error("Cannot upload empty file {}".format(file_path))
-                return False
-            uploaded = 0
-            session_id = self.__get_session_id(file_path)
-            chunk_num = 0
-            retries_count = 0
-            uploaded_bytes = 0
-            response = None
-            last_chunk = False
-            error_message = None
-
-            while True:
-                data = file_object.read(chunk_size)
-                if not data:
-                    break
-
-                start_position = chunk_num * chunk_size
-                end_position = start_position + chunk_size - 1
-                bytes_to_send = chunk_size
-
-                if end_position >= total_bytes:
-                    last_chunk = True
-                    end_position = total_bytes - 1
-                    bytes_to_send = total_bytes - uploaded_bytes
-
-                bytes_range = (
-                    "bytes "
-                    + str(start_position)
-                    + "-"
-                    + str(end_position)
-                    + "/"
-                    + str(total_bytes)
-                )
+        single_upload.start()
 
-                dispstr = f"attachment; filename={filename}"
-                response = self._upload_chunk(
-                    data,
-                    bytes_range,
-                    bytes_to_send,
-                    session_id,
-                    dispstr,
-                    last_chunk,
-                    name,
-                    date_of_scan,
-                    description,
-                    subject_name,
-                    ssid,
-                    filename,
-                    input_data_type,
-                    result,
-                    add_to_container_id,
-                    split_data,
-                    mock_response=mock_response,
-                )
-                if response is None:
-                    retries_count += 1
-                    time.sleep(retries_count * 5)
-                    if retries_count > max_retries:
-                        error_message = "HTTP Connection Problem"
-                        break
-                elif int(response.status_code) == 201:
-                    chunk_num += 1
-                    retries_count = 0
-                    uploaded_bytes += chunk_size
-                elif int(response.status_code) == 200:
-                    self.__show_progress(file_size, file_size, finish=True)
-                    break
-                elif int(response.status_code) == 416:
-                    retries_count += 1
-                    time.sleep(retries_count * 5)
-                    if retries_count > self.max_retries:
-                        error_message = (
-                            "Error Code: 416; Requested Range "
-                            "Not Satisfiable (NGINX)"
-                        )
-                        break
-                else:
-                    retries_count += 1
-                    time.sleep(retries_count * 5)
-                    if retries_count > max_retries:
-                        error_message = (
-                            "Number of retries has been reached. "
-                            "Upload process stops here !"
-                        )
-                        break
-
-                uploaded += chunk_size
-                self.__show_progress(uploaded, file_size)
-        if error_message is not None:
-            raise Exception(error_message)
-        try:
-            platform.parse_response(response)
-        except errors.PlatformError as error:
-            logger.error(error)
+        if single_upload.status == UploadStatus.FAILED:  # FAILED
+            print("Upload Failed!")
             return False
 
         message = (
             "Your data was successfully uploaded. "
             "The uploaded file will be soon processed !"
         )
-        logger.info(message)
+        print(message)
         return True
 
     def delete_file(self, container_id, filenames):
@@ -516,7 +437,7 @@ class Project:
         return False
 
     def download_file(
-        self, container_id, file_name, local_filename=False, overwrite=False
+        self, container_id, file_name, local_filename=None, overwrite=False
     ):
         """
         Download a single file from a  specific container.
@@ -527,7 +448,7 @@ class Project:
             ID of the container inside which the file is.
         file_name : str
             Name of the file in the container.
-        local_filename : str
+        local_filename : str, optional
             Name of the file to be created. By default, the same as file_name.
         overwrite : bool
             Whether to overwrite the file if existing.
@@ -724,7 +645,7 @@ class Project:
         return self.get_subjects_metadata()
 
     @property
-    def metadata_parameters(self):
+    def metadata_parameters(self) -> Union[Dict, None]:
         """
         List all the parameters in the subject-level metadata.
 
@@ -735,16 +656,20 @@ class Project:
         modification of these subject-level metadata parameters via the
         'change_subject_metadata()' method.
 
+        Example:
+        dictionary {"param_name":
+            { "order": Int,
+            "tags": [tag1, tag2, ..., ],
+            "title: "Title",
+            "type": "integer|string|date|list|decimal",
+            "visible": 0|1
+            }
+        }
+
         Returns
         -------
-        dict[str] -> dict[str] -> x
-            dictionary {"param_name":
-                 { "order": Int,
-                 "tags": [tag1, tag2, ..., ],
-                 "title: "Title",
-                 "type": "integer|string|date|list|decimal",
-                 "visible": 0|1
-                 }}
+        metadata_parameters : dict[str] or None
+
         """
         logger = logging.getLogger(logger_name)
         try:
@@ -1055,7 +980,10 @@ class Project:
                 f"either all starting with 'md_' or none."
             )
 
-        metadata_keys = self.metadata_parameters.keys()
+        metadata_keys = []
+        if self.metadata_parameters:
+            metadata_keys = self.metadata_parameters.keys()
+
         if not all(
             (
                 key[3:] in metadata_keys
@@ -1279,7 +1207,7 @@ class Project:
 
         Returns
         -------
-        dict
+        dict or bool
             Dictionary with the metadata. False otherwise.
         """
         all_metadata = self.list_container_files_metadata(container_id)
@@ -1591,7 +1519,7 @@ class Project:
     def list_container_files(
         self,
         container_id,
-    ):
+    ) -> Any:
         """
         List the name of the files available inside a given container.
         Parameters
@@ -1674,7 +1602,7 @@ class Project:
                 selected_files.append(file)
         return selected_files
 
-    def list_container_files_metadata(self, container_id):
+    def list_container_files_metadata(self, container_id) -> dict:
         """
         List all the metadata of the files available inside a given container.
 
@@ -1705,7 +1633,7 @@ class Project:
 
     """ Analysis Related Methods """
 
-    def get_analysis(self, analysis_name_or_id):
+    def get_analysis(self, analysis_name_or_id) -> dict:
         """
         Returns the analysis corresponding with the analysis id or analysis
         name
@@ -2944,20 +2872,6 @@ class Project:
                 modalities.append(modality)
         return modalities
 
-    def __show_progress(self, done, total, finish=False):
-        bytes_in_mb = 1024 * 1024
-        progress_message = "\r[{:.2f} %] Uploaded {:.2f} of {:.2f} Mb".format(
-            done / float(total) * 100, done / bytes_in_mb, total / bytes_in_mb
-        )
-        sys.stdout.write(progress_message)
-        sys.stdout.flush()
-        if not finish:
-            pass
-            # sys.stdout.write("")
-            # sys.stdout.flush()
-        else:
-            sys.stdout.write("\n")
-
     def __get_session_id(self, file_path):
         m = hashlib.md5()
         m.update(file_path.encode("utf-8"))