qmenta-client 1.1.dev1337__py3-none-any.whl → 1.1.dev1349__py3-none-any.whl

qmenta/client/Project.py

@@ -675,10 +675,27 @@ class Project:
         return data["fields"]
 
     def get_analysis(self, analysis_name_or_id):
+        """
+        Returns the analysis corresponding with the analysis id or analysis name
+
+        Parameters
+        ----------
+        analysis_name_or_id : int, str
+            analysis_id or analysis name to search for
+
+        Returns
+        -------
+        analysis: dict
+            A dictionary containing the analysis information
+        """
         if isinstance(analysis_name_or_id, int):
             search_tag = "id"
         elif isinstance(analysis_name_or_id, str):
-            search_tag = "p_n"
+            if analysis_name_or_id.isdigit():
+                search_tag = "id"
+                analysis_name_or_id = int(analysis_name_or_id)
+            else:
+                search_tag = "p_n"
         else:
             raise Exception("The analysis identifier must be its name or an " "integer")
 
@@ -698,32 +715,37 @@ class Project:
 
     def list_analysis(self, search_condition={}, items=(0, 9999)):
         """
-        List the analysis available to the user.
-        search condition example:
-        search_condition = {
-        "secret_name":"014_S_6920",
-        "from_d": "06.02.2025",
-        "with_child_analysis": 1,
-        "state": "completed"
+        List the analysis available to the user.\n
+
+        Examples
+        --------
+
+        >>> search_condition = {
+            "secret_name":"014_S_6920",
+            "from_d": "06.02.2025",
+            "with_child_analysis": 1,
+            "state": "completed"
         }
+            list_analysis(search_condition=search_condition)
 
         Parameters
         ----------
         search_condition : dict
-            p_n: str # analysis_name
-            type: str # analysis_type
-            from_d: str #  dd.mm.yyyy
-            to_d: str # dd.mm.yyyy
-            qa_status: str # pass/fail/nd
-            secret_name: str # Subject_ID
-            tags: str #
-            with_child_analysis: 1
-            # if 1, child analysis of workflows will appear
-            id: str # container_id
-            state: # running, completed, pending, exception
-            username: str #
-        limit : int
-            Max number of results
+            - p_n: str Analysis name
+            - type: str Type
+            - from_d: str  dd.mm.yyyy Date from
+            - to_d: str dd.mm.yyyy Date to
+            - qa_status: str pass/fail/nd QC status
+            - secret_name: str Subject ID
+            - tags: str
+            - with_child_analysis: 1 if 1, child analysis of workflows will appear
+            - id: str ID
+            - state: running, completed, pending, exception
+            - username: str
+
+        items : List[int]
+            list containing two elements [min, max] that correspond to the
+            mininum and maximum range of analysis listed
 
         Returns
         -------
@@ -842,23 +864,48 @@ class Project:
         ]
         return containers
 
-    def list_result_containers(self, limit=1000):
+    def list_result_containers(self, search_condition={}, items=(0, 9999)):
         """
         List the result containers available to the user.
+        Examples
+        --------
+
+        >>> search_condition = {
+            "secret_name":"014_S_6920",
+            "from_d": "06.02.2025",
+            "with_child_analysis": 1,
+            "state": "completed"
+        }
+            list_result_containers(search_condition=search_condition)
 
         Parameters
         ----------
-        limit : int
-            Max number of results
+        search_condition : dict
+            - p_n: str Analysis name
+            - type: str Type
+            - from_d: str  dd.mm.yyyy Date from
+            - to_d: str dd.mm.yyyy Date to
+            - qa_status: str pass/fail/nd QC status
+            - secret_name: str Subject ID
+            - tags: str
+            - with_child_analysis: 1 if 1, child analysis of workflows will appear
+            - id: str ID
+            - state: running, completed, pending, exception
+            - username: str
+        items : List[int]
+            list containing two elements [min, max] that correspond to the
+            mininum and maximum range of analysis listed
 
         Returns
         -------
         dict
             List of containers, each a dictionary
             {"name": "container-name", "id": "container_id"}
+            if "id": None, that analysis did not had an output container,
+            probably it is a workflow
         """
-        analysis = self.list_analysis(limit)
-        return [{"name": a["name"], "id": a["out_container_id"]} for a in analysis]
+        analyses = self.list_analysis(search_condition, items)
+        return [{"name": analysis["name"], "id": (analysis.get("out_container_id") or None)} for analysis in analyses]
 
     def list_container_files(
         self,

{qmenta_client-1.1.dev1337.dist-info → qmenta_client-1.1.dev1349.dist-info}/METADATA

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

{qmenta_client-1.1.dev1337.dist-info → qmenta_client-1.1.dev1349.dist-info}/RECORD

@@ -1,10 +1,10 @@
 qmenta/__init__.py,sha256=jv2YF__bseklT3OWEzlqJ5qE24c4aWd5F4r0TTjOrWQ,65
 qmenta/client/Account.py,sha256=MEljEy9cmg2uP2FG1d3TZAgfj66EE2_3PQAZ9rvpCXY,9647
 qmenta/client/File.py,sha256=ZgvSqejIosUt4uoX7opUnPnp5XGEaJNMRwFC0mQVB8k,5344
-qmenta/client/Project.py,sha256=XzolIEPQzUWPelWtv67fiYvLGXp7bLRfH2-Ckvgl8Ao,75153
+qmenta/client/Project.py,sha256=xk-C4kf2i7RLsIp3fiwHQzlEOZpb1sL-KqxGqDex8Mc,76953
 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.dev1337.dist-info/METADATA,sha256=Epl4svIqv_lvXPjjfBh5zAU02b5i_sq1z-ZptA0c58o,672
-qmenta_client-1.1.dev1337.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-qmenta_client-1.1.dev1337.dist-info/RECORD,,
+qmenta_client-1.1.dev1349.dist-info/METADATA,sha256=RBQVZKHts7FiBDWvv9C5Nf6lCj8I5YH6N_shy1JRBsc,672
+qmenta_client-1.1.dev1349.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+qmenta_client-1.1.dev1349.dist-info/RECORD,,