pybiolib 1.2.740__tar.gz → 1.2.749__tar.gz

{pybiolib-1.2.740 → pybiolib-1.2.749}/PKG-INFO

@@ -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 → pybiolib-1.2.749}/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

{pybiolib-1.2.740 → pybiolib-1.2.749}/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]

{pybiolib-1.2.740 → pybiolib-1.2.749}/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

{pybiolib-1.2.740 → pybiolib-1.2.749}/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 → pybiolib-1.2.749}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pybiolib"
-version = "1.2.740"
+version = "1.2.749"
 description = "BioLib Python Client"
 readme = "PYPI_README.md"
 license = "MIT"