codeocean 0.1.4__tar.gz → 0.1.6__tar.gz

{codeocean-0.1.4 → codeocean-0.1.6}/CHANGELOG.md

@@ -1,9 +1,17 @@
 CHANGELOG
 =========
 
+## 0.1.6 (2024-10-15)
+
+- [#13](https://github.com/codeocean/codeocean-sdk-python/pull/13) feat: makes polling interval configurable
+
+## 0.1.5 (2024-08-08)
+
+- [#10](https://github.com/codeocean/codeocean-sdk-python/pull/10) fix: Provenance optional fields
+
 ## 0.1.4 (2024-08-02)
 
-- Add support for Python >= 3.9 
+- Add support for Python >= 3.9
 
 ## 0.1.3 (2024-07-09)
 

{codeocean-0.1.4 → codeocean-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: codeocean
-Version: 0.1.4
+Version: 0.1.6
 Summary: Code Ocean Python SDK
 Project-URL: Homepage, https://github.com/codeocean/codeocean-sdk-python
 Project-URL: Issues, https://github.com/codeocean/codeocean-sdk-python/issues

{codeocean-0.1.4 → codeocean-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "codeocean"
-version = "0.1.4"
+version = "0.1.6"
 authors = [
   { name="Code Ocean", email="dev@codeocean.com" },
 ]

{codeocean-0.1.4 → codeocean-0.1.6}/src/codeocean/computation.py

@@ -141,17 +141,21 @@ class Computations:
 
         return Computation.from_dict(res.json())
 
-    def wait_until_completed(self, computation: Computation) -> Computation:
+    def wait_until_completed(self, computation: Computation, polling_interval: int = 5) -> Computation:
         """
         Polls the given computation until it reaches the 'Completed' or 'Failed' state.
         """
+        if polling_interval < 5:
+            raise ValueError(
+                f"Polling interval {polling_interval} should be greater than or equal to 5"
+            )
         while True:
             comp = self.get_computation(computation.id)
 
             if comp.state in [ComputationState.Completed, ComputationState.Failed]:
                 return comp
 
-            sleep(5)
+            sleep(polling_interval)
 
     def list_computation_results(self, computation_id: str, path: str = "") -> Folder:
         data = {

{codeocean-0.1.4 → codeocean-0.1.6}/src/codeocean/data_asset.py

@@ -27,9 +27,9 @@ class DataAssetState(StrEnum):
 class Provenance:
     commit: str
     run_script: str
-    data_assets: str
     docker_image: str
     capsule: str
+    data_assets: Optional[list[str]] = None
 
 
 class DataAssetOrigin(StrEnum):
@@ -237,17 +237,21 @@ class DataAssets:
 
         return DataAsset.from_dict(res.json())
 
-    def wait_until_ready(self, data_asset: DataAsset) -> DataAsset:
+    def wait_until_ready(self, data_asset: DataAsset, polling_interval: int = 5) -> DataAsset:
         """
         Polls the given data asset until it reaches the 'Ready' or 'Failed' state.
         """
+        if polling_interval < 5:
+            raise ValueError(
+                f"Polling interval {polling_interval} should be greater than or equal to 5"
+            )
         while True:
             da = self.get_data_asset(data_asset.id)
 
             if da.state in [DataAssetState.Ready, DataAssetState.Failed]:
                 return da
 
-            sleep(5)
+            sleep(polling_interval)
 
     def delete_data_asset(self, data_asset_id: str):
         self.client.delete(f"data_assets/{data_asset_id}")