qmenta-client 1.1.dev1410__py3-none-any.whl → 1.1.dev1436__py3-none-any.whl

qmenta/client/Project.py

@@ -1486,7 +1486,8 @@ class Project:
                 analysis_name_or_id = int(analysis_name_or_id)
             else:
                 search_tag = "p_n"
-                excluded_characters = ["\\", "[", "(", "+", "*"]
+                excluded_characters = ["\\", "[", "]", "(", ")",
+                                       "{", "}", "+", "*"]
                 excluded_bool = [character in analysis_name_or_id for character in excluded_characters]
                 if any(excluded_bool):
                     raise Exception(f"p_n does not allow characters {excluded_characters}")
@@ -1536,7 +1537,7 @@ class Project:
             - secret_name: str or None Subject ID
             - tags: str or None
             - with_child_analysis: 1 or None if 1, child analysis of workflows will appear
-            - id: str or None ID
+            - id: int or None ID
             - state: running, completed, pending, exception or None
             - username: str or None
 
@@ -1570,7 +1571,8 @@ class Project:
             if not isinstance(search_condition[key], search_keys[key]) and search_condition[key] is not None:
                 raise Exception((f"The key {key} in the search condition" f"is not type {search_keys[key]}"))
             if "p_n" == key:
-                excluded_characters = ["\\", "[", "(", "+", "*"]
+                excluded_characters = ["\\", "[", "]", "(", ")",
+                                       "{", "}", "+", "*"]
                 excluded_bool = [character in search_condition["p_n"] for character in excluded_characters]
                 if any(excluded_bool):
                     raise Exception(f"p_n does not allow characters {excluded_characters}")
@@ -1691,6 +1693,57 @@ class Project:
 
         return True
 
+    def get_analysis_log(self, analysis_id, file_name=None):
+        """
+        Get the log of an analysis and save it in the provided file.
+        The logs of analysis can only be obtained for the tools you created.
+
+        Note workflows do not have a log so the printed message will only be ERROR.
+        You can only download the anlaysis log of the tools that you own.
+
+        Note this method is very time consuming.
+
+        Parameters
+        ----------
+        analysis_id : int
+            ID of the script to be run.
+        file_name: str
+            Path to the file where to export the log.
+            If None the file will be: f'logs_{analysis_id}.txt'
+
+        Returns
+        -------
+        str or bool
+            File name of the exported file if the export is possible.
+            False otherwise.
+        """
+        logger = logging.getLogger(logger_name)
+        try:
+            analysis_id = str(int(analysis_id))
+        except ValueError:
+            raise ValueError(f"'analysis_id' has to be an integer"
+                             f" not '{analysis_id}'.")
+
+        file_name = file_name if file_name else f"logs_{analysis_id}.txt"
+        try:
+            res = platform.post(
+                    auth=self._account.auth,
+                    endpoint="analysis_manager/download_execution_file",
+                    data={"project_id": analysis_id, "file": f"logs_{analysis_id}"},
+                    timeout=1000
+                )
+        except Exception:
+            logger.error(f"Could not export the analysis log of '{analysis_id}'")
+            return False
+
+        if not res.ok:
+            logger.error(f"The log file could not be extracted for Analysis ID: {analysis_id}.")
+            return False
+
+        with open(file_name, "w") as f:
+            f.write(res.text)
+        return file_name
+
     """ QC Status Related Methods """
 
     def set_qc_status_analysis(self, analysis_id,

{qmenta_client-1.1.dev1410.dist-info → qmenta_client-1.1.dev1436.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: qmenta-client
-Version: 1.1.dev1410
+Version: 1.1.dev1436
 Summary: Python client lib to interact with the QMENTA platform.
 Author: QMENTA
 Author-email: dev@qmenta.com

{qmenta_client-1.1.dev1410.dist-info → qmenta_client-1.1.dev1436.dist-info}/RECORD

@@ -1,10 +1,10 @@
 qmenta/__init__.py,sha256=jv2YF__bseklT3OWEzlqJ5qE24c4aWd5F4r0TTjOrWQ,65
 qmenta/client/Account.py,sha256=S9D0-lmcBln2o3DwJfmLfu5G2wjE7gEJCIeJu89v0Is,9647
 qmenta/client/File.py,sha256=ZgvSqejIosUt4uoX7opUnPnp5XGEaJNMRwFC0mQVB8k,5344
-qmenta/client/Project.py,sha256=tr6_mKCt4hDA5Y8d24V1U3mZBq5_O86Y9TRQbOfLiM8,79916
+qmenta/client/Project.py,sha256=eM6eT6H4d98ExWy-RWLdBbVO_QdW-AyML_Z8wZV5t0U,81881
 qmenta/client/Subject.py,sha256=lhxxVdQ6d-GNoQC8mrJwa4L1f44nJc4PcJtDspmKN7I,8756
 qmenta/client/__init__.py,sha256=AjTojBhZeW5nl0i605KS8S1Gl5tPNc1hdzD47BGNfoI,147
 qmenta/client/utils.py,sha256=5DK2T_HQprrCwLS0Ycm2CjseaYmAUKaJkJvYoW-Rqzc,2479
-qmenta_client-1.1.dev1410.dist-info/METADATA,sha256=kVwivj32iCexGnLGS8ADbJaNbvs-iU3K6iYioJvqAzg,672
-qmenta_client-1.1.dev1410.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-qmenta_client-1.1.dev1410.dist-info/RECORD,,
+qmenta_client-1.1.dev1436.dist-info/METADATA,sha256=Jh3CC_0kIS-G0S3doF1Y4Y3ZO7ds9uGJyFE1KElCX6s,672
+qmenta_client-1.1.dev1436.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+qmenta_client-1.1.dev1436.dist-info/RECORD,,