datalab-api 0.2.5__tar.gz → 0.2.7__tar.gz

{datalab_api-0.2.5/src/datalab_api.egg-info → datalab_api-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datalab-api
-Version: 0.2.5
+Version: 0.2.7
 Summary: A Python API for instances of the datalab data management platform (https://github.com/the-grey-group/datalab).
 Author-email: Matthew Evans <matthew@ml-evs.science>
 License: MIT

{datalab_api-0.2.5 → datalab_api-0.2.7}/src/datalab_api/__init__.py

@@ -124,11 +124,15 @@ class DatalabClient(BaseDatalabClient):
             new_item = item_data
         new_item.update({"item_id": item_id, "type": item_type})
 
+        if new_item["item_id"] is None:
+            new_item.pop("item_id")
+
         if collection_id is not None:
             try:
                 collection_immutable_id = self.get_collection(collection_id)["immutable_id"]
             except RuntimeError:
-                collection_immutable_id = self.create_collection(collection_id)["immutable_id"]
+                self.create_collection(collection_id)
+                collection_immutable_id = self.get_collection(collection_id)["immutable_id"]
             new_item["collections"] = new_item.get("collections", [])
             new_item["collections"].append({"immutable_id": collection_immutable_id})
 
@@ -386,6 +390,33 @@ class DatalabClient(BaseDatalabClient):
 
         return block_data
 
+    def update_data_block(
+        self, item_id: str, block_id: str, block_type: str, block_data: dict
+    ) -> dict[str, Any]:
+        """Attempts to update a block with the given payload of data,
+        returning the updated block.
+
+        Parameters:
+            item_id: The ID of the item that the block is attached to.
+            block_id: The ID of existing block.
+            block_type: The type of block to update.
+            block_data: The payload of block data to update; will be used to selectively update
+                any fields present, with validation performed by the remote block code itself.
+
+        Returns:
+            If successful, the updated block data.
+
+        Raises:
+            RuntimeError: If the block update fails.
+
+        """
+        payload = {k: v for k, v in block_data.items()}
+        payload["block_id"] = block_id
+        payload["blocktype"] = block_type
+        payload["item_id"] = item_id
+
+        return self._update_data_block(block_type=block_type, block_data=payload)
+
     def _update_data_block(
         self, block_type: str, block_data: dict, file_ids: str | list[str] | None = None
     ) -> dict[str, Any]:
@@ -398,7 +429,6 @@ class DatalabClient(BaseDatalabClient):
                 raise RuntimeError(
                     "API does not currently support attaching multiple files in a block."
                 )
-
             block_data["file_id"] = file_ids[0]
 
         blocks_url = f"{self.datalab_api_url}/update-block/"

{datalab_api-0.2.5 → datalab_api-0.2.7}/src/datalab_api/_base.py

@@ -95,6 +95,7 @@ class BaseDatalabClient(metaclass=AutoPrettyPrint):
     _api_key: Optional[str] = None
     _session: Optional[httpx.Client] = None
     _headers: dict[str, str] = {}
+    _timeout: httpx.Timeout = httpx.Timeout(10.0, read=60.0)
 
     bad_server_versions: Optional[tuple[tuple[int, int, int]]] = ((0, 2, 0),)
     """Any known server versions that are not supported by this client."""
@@ -172,13 +173,19 @@ class BaseDatalabClient(metaclass=AutoPrettyPrint):
     @property
     def session(self) -> httpx.Client:
         if self._session is None:
-            return self._http_client(headers=self.headers)
+            return self._http_client(headers=self.headers, timeout=self.timeout)
         return self._session
 
     @property
-    def headers(self):
+    def headers(self) -> dict[str, str]:
+        """Any headers to send with each request to the datalab API."""
         return self._headers
 
+    @property
+    def timeout(self) -> httpx.Timeout:
+        """A timeout object to use for the datalab API session."""
+        return self._timeout
+
     def _version_negotiation(self):
         """Check whether this client is expected to work with this instance.
 

{datalab_api-0.2.5 → datalab_api-0.2.7/src/datalab_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datalab-api
-Version: 0.2.5
+Version: 0.2.7
 Summary: A Python API for instances of the datalab data management platform (https://github.com/the-grey-group/datalab).
 Author-email: Matthew Evans <matthew@ml-evs.science>
 License: MIT