datalab-api 0.5.0__tar.gz → 0.5.2__tar.gz

{datalab_api-0.5.0/src/datalab_api.egg-info → datalab_api-0.5.2}/PKG-INFO

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

{datalab_api-0.5.0 → datalab_api-0.5.2}/src/datalab_api/__init__.py

@@ -273,7 +273,13 @@ class DatalabClient(BaseDatalabClient):
                     for chunk in response.iter_bytes(chunk_size=1024):
                         file.write(chunk)
 
-    def get_block(self, item_id: str, block_id: str, block_data: dict[str, Any]) -> dict[str, Any]:
+    def get_block(
+        self,
+        item_id: str,
+        block_id: str,
+        block_data: dict[str, Any] | None = None,
+        event_data: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
         """Get a block with a given ID and block data.
         Should be used in conjunction with `get_item` to load an existing block.
 
@@ -281,17 +287,25 @@ class DatalabClient(BaseDatalabClient):
             item_id: The ID of the item to search for.
             block_id: The ID of the block to search for.
             block_data: Any other block data required by the request.
+            event_data: Any block events to trigger.
 
         Returns:
             A dictionary of block data for the block with the given ID.
 
         """
-        block_url = f"{self.datalab_api_url}/update-block/"
+        block_url = f"{self.datalab_api_url}/blocks/"
+
+        if not block_data:
+            block_data = {}
+
+        block_data["item_id"] = item_id
+        block_data["block_id"] = block_id
+        if "blocktype" not in block_data:
+            raise ValueError("block_data must contain a 'blocktype' key.")
+
         block_request = {
             "block_data": block_data,
-            "item_id": item_id,
-            "block_id": block_id,
-            "save_to_db": False,
+            "event_data": event_data,
         }
         block = self._post(block_url, json=block_request)
         return block["new_block_data"]
@@ -308,7 +322,12 @@ class DatalabClient(BaseDatalabClient):
                 If provided, the new file will take the place of the old file in any blocks it was attached to.
 
         Returns:
-            A dictionary of the uploaded file data.
+            A dictionary of the uploaded file data, with an additional
+            `not_modified` key. If `replace_file_id` was provided and the
+            server already holds identical content (compared by hash), the
+            update is a no-op: the server replies `304 Not Modified` and
+            `not_modified` is `True`. Servers older than datalab#1744 never
+            report this, so `not_modified` is always `False` against them.
 
         """
         if isinstance(file_path, str):
@@ -327,10 +346,23 @@ class DatalabClient(BaseDatalabClient):
                 upload_url,
                 files=files,
                 data={"item_id": item_id, "replace_file": replace_file_id},
-                expected_status=201,
+                expected_status=[201, 304],
                 timeout=upload_timeout,
             )
-        return upload
+
+        # A 201 always carries a body describing the stored file, so an
+        # empty dict here can only be the 304: the server compared hashes,
+        # found it already holds this content, and made no update. That is
+        # a success, so report it rather than raising.
+        if not upload:
+            return {
+                "status": "success",
+                "file_id": replace_file_id,
+                "is_update": True,
+                "not_modified": True,
+            }
+
+        return {**upload, "not_modified": False}
 
     def create_data_block(
         self,
@@ -424,10 +456,10 @@ class DatalabClient(BaseDatalabClient):
 
         if file_ids:
             if len(file_ids) > 1:
-                raise RuntimeError(
-                    "API does not currently support attaching multiple files in a block."
-                )
-            block_data["file_id"] = file_ids[0]
+                block_data["file_ids"] = file_ids
+            else:
+                block_data.pop("file_ids", None)
+                block_data["file_id"] = file_ids[0]
 
         blocks_url = f"{self.datalab_api_url}/update-block/"
         payload = {

{datalab_api-0.5.0 → datalab_api-0.5.2}/src/datalab_api/_base.py

@@ -317,6 +317,12 @@ This is likely a server-side bug. Please report this issue to the datalab develo
                     f"HTTP {response.status_code} error at {url}: {error_message}"
                 )
 
+        # 204 and 304 carry no entity body by definition
+        # Where such a status is expected, an empty body
+        # is the success case rather than a parse failure.
+        if response.status_code in (204, 304):
+            return {}
+
         # Parse JSON response
         try:
             data = response.json()

{datalab_api-0.5.0 → datalab_api-0.5.2/src/datalab_api.egg-info}/PKG-INFO

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

{datalab_api-0.5.0 → datalab_api-0.5.2}/tests/test_client.py

@@ -1,5 +1,6 @@
 import pytest
 import respx
+from httpx import Response
 
 from datalab_api import DatalabClient
 from datalab_api._base import DatalabAPIError
@@ -71,3 +72,54 @@ def test_group_get(fake_api_url, mocked_api):
         assert mocked_api["search-groups"].called
         assert group["immutable_id"] == "67d0b01e03000cdc75134dbd"
         assert group["group_id"] == "test_group"
+
+
+@respx.mock
+def test_upload_file(fake_api_url, mocked_api, tmp_path):
+    """A new upload is stored by the server and reported as modified."""
+    fake_upload = mocked_api.post("/upload-file/", name="upload")
+    fake_upload.return_value = Response(
+        201,
+        json={
+            "status": "success",
+            "file_id": "6810ab6bb2b13a2be6c1e37f",
+            "file_information": {"name": "data.csv"},
+            "is_update": False,
+        },
+    )
+
+    test_file = tmp_path / "data.csv"
+    test_file.write_text("a,b\n1,2\n")
+
+    with DatalabClient(fake_api_url) as client:
+        result = client.upload_file(item_id="KUVEKJ", file_path=test_file)
+
+    assert mocked_api["upload"].called
+    assert result["file_id"] == "6810ab6bb2b13a2be6c1e37f"
+    assert result["not_modified"] is False
+
+
+@respx.mock
+def test_upload_file_not_modified(fake_api_url, mocked_api, tmp_path):
+    """When replacing a file whose content the server already holds, it
+    replies 304 with an empty body. That is a successful no-op, so the
+    existing file ID is returned with `not_modified` set, rather than
+    the empty body being treated as an error."""
+    fake_upload = mocked_api.post("/upload-file/", name="upload")
+    fake_upload.return_value = Response(304, content=b"")
+
+    test_file = tmp_path / "data.csv"
+    test_file.write_text("a,b\n1,2\n")
+
+    with DatalabClient(fake_api_url) as client:
+        result = client.upload_file(
+            item_id="KUVEKJ",
+            file_path=test_file,
+            replace_file_id="6810ab6bb2b13a2be6c1e37f",
+        )
+
+    assert mocked_api["upload"].called
+    assert result["status"] == "success"
+    assert result["file_id"] == "6810ab6bb2b13a2be6c1e37f"
+    assert result["is_update"] is True
+    assert result["not_modified"] is True