pybiolib 1.2.740__py3-none-any.whl → 1.2.749__py3-none-any.whl

biolib/_internal/types/experiment.py

@@ -11,20 +11,21 @@ class ResultCounts(TypedDict):
     total: int
 
 
-class ExperimentDict(TypedDict):
+class DeprecatedExperimentDict(TypedDict):
+    # Note: fields on this TypedDict are deprecated
+    job_count: int
+    job_running_count: int
+
+
+class ExperimentDict(DeprecatedExperimentDict):
     uuid: Optional[str]
     name: Optional[str]
+    created_at: Optional[str]
     finished_at: Optional[str]
-    first_created_at: Optional[str]
     last_created_at: Optional[str]
     last_created_result: Optional[ResultDict]
     result_counts: ResultCounts
 
 
-class ExperimentSlimDict(TypedDict):
-    job_count: int
-    job_running_count: int
-
-
-class ExperimentDetailedDict(ExperimentSlimDict):
+class ExperimentDetailedDict(ExperimentDict):
     pass

biolib/_internal/types/resource.py

@@ -1,6 +1,6 @@
 from .app import AppSlimDict
 from .data_record import DataRecordSlimDict
-from .experiment import ExperimentSlimDict
+from .experiment import DeprecatedExperimentDict
 from .typing import Optional, TypedDict
 
 
@@ -15,4 +15,4 @@ class ResourceDict(TypedDict):
 class ResourceDetailedDict(ResourceDict):
     app: Optional[AppSlimDict]
     data_record: Optional[DataRecordSlimDict]
-    experiment: Optional[ExperimentSlimDict]
+    experiment: Optional[DeprecatedExperimentDict]

biolib/_internal/types/result.py

@@ -8,3 +8,7 @@ class ResultDict(TypedDict):
     created_at: str
     state: str
     finished_at: Optional[str]
+
+
+class ResultDetailedDict(ResultDict):
+    pass

biolib/experiments/experiment.py

@@ -1,8 +1,9 @@
 import time
 from collections import OrderedDict
 
-import biolib._internal.types as _types
 from biolib import api
+from biolib._internal.types.experiment import DeprecatedExperimentDict, ExperimentDict
+from biolib._internal.types.resource import ResourceDetailedDict
 from biolib.biolib_errors import BioLibError
 from biolib.jobs.job import Job
 from biolib.jobs.types import JobsPaginatedResponse
@@ -22,8 +23,8 @@ class Experiment:
         }
     )
 
-    def __init__(self, uri: str, _resource_dict: Optional[_types.ResourceDetailedDict] = None):
-        self._resource_dict: _types.ResourceDetailedDict = _resource_dict or self._get_or_create_resource_dict(uri)
+    def __init__(self, uri: str, _resource_dict: Optional[ResourceDetailedDict] = None):
+        self._resource_dict: ResourceDetailedDict = _resource_dict or self._get_or_create_resource_dict(uri)
 
     def __enter__(self):
         Experiment._BIOLIB_EXPERIMENTS.append(self)
@@ -50,7 +51,7 @@ class Experiment:
         return self._resource_dict['uri']
 
     @property
-    def _experiment_dict(self) -> _types.ExperimentSlimDict:
+    def _experiment_dict(self) -> DeprecatedExperimentDict:
         if not self._resource_dict['experiment']:
             raise ValueError(f'Resource {self.uri} is not an Experiment')
 
@@ -65,7 +66,8 @@ class Experiment:
     # Prints a table listing info about experiments accessible to the user
     @staticmethod
     def show_experiments(count: int = 25) -> None:
-        experiment_dicts = api.client.get(path='/experiments/', params={'page_size': str(count)}).json()['results']
+        pagniated_response = api.client.get(path='/experiments/', params={'page_size': str(count)}).json()
+        experiment_dicts: List[ExperimentDict] = pagniated_response['results']
         BioLibTable(
             columns_to_row_map=Experiment._table_columns_to_row_map,
             rows=experiment_dicts,
@@ -75,7 +77,7 @@ class Experiment:
     @staticmethod
     def get_by_uri(uri: str) -> 'Experiment':
         query_param_key = 'uri' if '/' in uri else 'name'
-        resource_dict: _types.ResourceDetailedDict = api.client.get('/resource/', params={query_param_key: uri}).json()
+        resource_dict: ResourceDetailedDict = api.client.get('/resource/', params={query_param_key: uri}).json()
         if not resource_dict['experiment']:
             raise ValueError(f'Resource {uri} is not an experiment')
 
@@ -195,20 +197,39 @@ class Experiment:
 
         return jobs
 
+    def get_results(self, status: Optional[str] = None) -> List[Job]:
+        r"""Get a list of results in this experiment, optionally filtered by status.
+
+        Args:
+            status (str, optional): Filter results by status. One of:
+                'in_progress', 'completed', 'failed', 'cancelled'
+
+        Returns:
+            List[Job]: List of result objects in this experiment
+
+        Example::
+
+            >>> # Get all results in the experiment
+            >>> results = experiment.get_results()
+            >>> # Get only completed results
+            >>> completed_results = experiment.get_results(status='completed')
+        """
+        return self.get_jobs(status=status)
+
     def rename(self, destination: str) -> None:
         api.client.patch(f'/resources/{self.uuid}/', data={'uri': destination})
         self._refetch()
 
     @staticmethod
-    def _get_resource_dict_by_uuid(uuid: str) -> _types.ResourceDetailedDict:
-        resource_dict: _types.ResourceDetailedDict = api.client.get(f'/resources/{uuid}/').json()
+    def _get_resource_dict_by_uuid(uuid: str) -> ResourceDetailedDict:
+        resource_dict: ResourceDetailedDict = api.client.get(f'/resources/{uuid}/').json()
         if not resource_dict['experiment']:
             raise ValueError('Resource from URI is not an experiment')
 
         return resource_dict
 
     @staticmethod
-    def _get_or_create_resource_dict(uri: str) -> _types.ResourceDetailedDict:
+    def _get_or_create_resource_dict(uri: str) -> ResourceDetailedDict:
         response_dict = api.client.post(path='/experiments/', data={'uri' if '/' in uri else 'name': uri}).json()
         return Experiment._get_resource_dict_by_uuid(uuid=response_dict['uuid'])
 

{pybiolib-1.2.740.dist-info → pybiolib-1.2.749.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pybiolib
-Version: 1.2.740
+Version: 1.2.749
 Summary: BioLib Python Client
 License: MIT
 Keywords: biolib

{pybiolib-1.2.740.dist-info → pybiolib-1.2.749.dist-info}/RECORD

@@ -25,12 +25,12 @@ biolib/_internal/tree_utils.py,sha256=_Q_6_NDtIiROcefymqxEVddjqti6Mt3OZ4U0GcDW61
 biolib/_internal/types/__init__.py,sha256=WvtlSHh77QhYVTLeRpoPAzqvByLzbEPf_ZqYGHFlQug,247
 biolib/_internal/types/app.py,sha256=Mz2QGD_jESX-K9JYnLWPo4YA__Q_1FQQTk9pvidCohU,118
 biolib/_internal/types/data_record.py,sha256=9r_vdhVs60YTnzU4XQFXfDrfS2P2MqD3BH2xa7lk6ck,852
-biolib/_internal/types/experiment.py,sha256=H1trex0sQIYiNUreBG_2dOFsy-Gw072pB4Mv77-bizY,619
+biolib/_internal/types/experiment.py,sha256=2SbCLSwgLglmQgyUHYb5SvO0Cfsgs-f3jqao9--Z_sY,682
 biolib/_internal/types/file_node.py,sha256=T6BIqo662f3nwMBRqtBHYsg6YuuUaKpiokHcVjv9_ME,283
-biolib/_internal/types/resource.py,sha256=uUI9Rt5ehkXv9NEDW9zsaPXiTXxnj811rSUW3g_joJw,437
+biolib/_internal/types/resource.py,sha256=LQnIYBR8Fi7zvnA5vBpzcL2c6ZjpaKNTe38hXck82k0,449
 biolib/_internal/types/resource_permission.py,sha256=ZE7eokpzswAiqe4GdpdxdZ6_jl0LdiRD9gP81I8C3fY,292
 biolib/_internal/types/resource_version.py,sha256=cU0YFHqxO-wX_Y6CoeK0Iei61gFwVoyR_kPOSTQ4mCs,304
-biolib/_internal/types/result.py,sha256=2fh-f_faH5NVlhWeT2iFfnj6YgtBcjo5GHR80SSNU90,182
+biolib/_internal/types/result.py,sha256=MesSTBXCkaw8HydXgHf1OKGVLzsxhZ1KV5z4w-VI-0M,231
 biolib/_internal/types/typing.py,sha256=qrsk8hHcGEbDpU1QQFzHAKnhQxkMe7uJ6pxHeAnfv1Y,414
 biolib/_internal/utils/__init__.py,sha256=p5vsIFyu-zYqBgdSMfwW9NC_jk7rXvvCbV4Bzd3As7c,630
 biolib/_internal/utils/multinode.py,sha256=-J3PEAK3NaOwCn--5T7vWHkA3yu5w9QhmuhkQcH-2wY,8229
@@ -110,7 +110,7 @@ biolib/compute_node/webserver/webserver_types.py,sha256=2t8EaFKESnves3BA_NBdnS2y
 biolib/compute_node/webserver/webserver_utils.py,sha256=XWvwYPbWNR3qS0FYbLLp-MDDfVk0QdaAmg3xPrT0H2s,4234
 biolib/compute_node/webserver/worker_thread.py,sha256=7uD9yQPhePYvP2HCJ27EeZ_h6psfIWFgqm1RHZxzobs,12483
 biolib/experiments/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-biolib/experiments/experiment.py,sha256=pBtnOHz0kKoFxlIGf08o8ZCEOze-CljwfOsTdhvCTCk,8646
+biolib/experiments/experiment.py,sha256=OTUPOY_F5qo22oFi3acnRMmG0pcmP6ZfoQncFkcTYDQ,9478
 biolib/jobs/__init__.py,sha256=aIb2H2DHjQbM2Bs-dysFijhwFcL58Blp0Co0gimED3w,32
 biolib/jobs/job.py,sha256=X33-s9u8x3uZI0x_fSDgEFAW0ke-8Qi96M-VB-W29MA,26703
 biolib/jobs/job_result.py,sha256=rALHiKYNaC9lHi_JJqBob1RubzNLwG9Z386kwRJjd2M,5885
@@ -130,8 +130,8 @@ biolib/utils/cache_state.py,sha256=u256F37QSRIVwqKlbnCyzAX4EMI-kl6Dwu6qwj-Qmag,3
 biolib/utils/multipart_uploader.py,sha256=XvGP1I8tQuKhAH-QugPRoEsCi9qvbRk-DVBs5PNwwJo,8452
 biolib/utils/seq_util.py,sha256=Ozk0blGtPur_D9MwShD02r_mphyQmgZkx-lOHOwnlIM,6730
 biolib/utils/zip/remote_zip.py,sha256=0wErYlxir5921agfFeV1xVjf29l9VNgGQvNlWOlj2Yc,23232
-pybiolib-1.2.740.dist-info/LICENSE,sha256=F2h7gf8i0agDIeWoBPXDMYScvQOz02pAWkKhTGOHaaw,1067
-pybiolib-1.2.740.dist-info/METADATA,sha256=jxc0mTaGlV37EWAQgLiyqqIjKlzTL17D_9-1paNxx34,1570
-pybiolib-1.2.740.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-pybiolib-1.2.740.dist-info/entry_points.txt,sha256=p6DyaP_2kctxegTX23WBznnrDi4mz6gx04O5uKtRDXg,42
-pybiolib-1.2.740.dist-info/RECORD,,
+pybiolib-1.2.749.dist-info/LICENSE,sha256=F2h7gf8i0agDIeWoBPXDMYScvQOz02pAWkKhTGOHaaw,1067
+pybiolib-1.2.749.dist-info/METADATA,sha256=hAUHVeH2pyZYFKHncVnsKqV6m2q0J29O_Qs2PUFyrIM,1570
+pybiolib-1.2.749.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+pybiolib-1.2.749.dist-info/entry_points.txt,sha256=p6DyaP_2kctxegTX23WBznnrDi4mz6gx04O5uKtRDXg,42
+pybiolib-1.2.749.dist-info/RECORD,,