pilot-platform-object-storage 2.0.0__tar.gz → 2.1.0__tar.gz

{pilot_platform_object_storage-2.0.0 → pilot_platform_object_storage-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pilot-platform-object-storage
-Version: 2.0.0
+Version: 2.1.0
 Summary: Python library for interacting with multiple object storage APIs.
 License: Proprietary
 Author: Indoc Systems

{pilot_platform_object_storage-2.0.0 → pilot_platform_object_storage-2.1.0}/object_storage/factories.py

@@ -17,7 +17,7 @@ def get_file_client(provider: Provider | str, sas_url: str, **kwargs: dict[str,
     if provider == 'azure':
         return AzureBlobClient(blob_sas_url=sas_url)
     else:
-        raise ValueError(f"Unknown provider: {provider}")
+        raise ValueError(f'Unknown provider: {provider}')
 
 
 def get_gcs_object_client(project_id: str, service_json: dict[str, Any]) -> GCSObjectClient:

{pilot_platform_object_storage-2.0.0 → pilot_platform_object_storage-2.1.0}/object_storage/providers/gcp/object_client.py

@@ -71,7 +71,7 @@ class GCSObjectClient:
 
     def _part_object_name(self, final_key: str, upload_id: str, chunk_number: int) -> str:
         # Temporary object path for each chunk in google starts with 'multipart/'
-        return f"multipart/{upload_id}/{final_key}/part-{chunk_number:06d}"
+        return f'multipart/{upload_id}/{final_key}/part-{chunk_number:06d}'
 
     # Object related methods
 
@@ -167,6 +167,52 @@ class GCSObjectClient:
 
         return session_uri
 
+    async def cancel_resumable_upload(self, session_uri: str) -> None:
+        """
+        Summary:
+            Cancel a Google Cloud Storage resumable upload session. After cancellation,
+            the session URI becomes unusable and the upload cannot be resumed or finalized.
+
+        Behavior:
+            - Sends a DELETE to the session URI with Content-Length: 0 (required by GCS JSON API).
+            - A successful cancellation returns HTTP 499 (Client Closed Request).
+            - Some environments may return 204 (No Content) instead — also valid.
+            - If a session is already invalid, GCS may return 404 or 410; these are treated as success.
+            - Does NOT delete any uploaded draft chunks or create a final object, because the object
+              is only committed at the final POST request.
+
+        Parameters:
+            session_uri (str):
+                The resumable upload session URL returned from `get_resumable_session_uri`.
+                This is also the value returned by GCS in the `Location` header on upload init.
+
+        Returns:
+            None
+
+        Raises:
+            RuntimeError:
+                If the DELETE request returns a status code outside the expected success cases.
+
+        References:
+            https://cloud.google.com/storage/docs/performing-resumable-uploads#cancel-upload
+        """
+
+        def _cancel() -> None:
+            authed = self._authed()
+            headers = {'Content-Length': '0'}
+
+            resp = authed.delete(session_uri, headers=headers)
+
+            # Valid successful outcomes:
+            # 499 - documented success status for cancelled GCS resumable uploads
+            # 204 - alternative valid success response
+            # 404/410 - session already invalid/expired/completed (safe to treat as success)
+            success_statuses = (499, 204, 404, 410)
+            if resp.status_code not in success_statuses:
+                raise RuntimeError(f'Failed to cancel resumable upload: {resp.status_code} {resp.text}')
+
+        await asyncio.to_thread(_cancel)
+
     async def get_presigned_download_url(
         self,
         bucket: str,
@@ -209,7 +255,7 @@ class GCSObjectClient:
         """
 
         def _list() -> dict[int, int]:
-            prefix = f"multipart/{upload_id}/{final_key}/"
+            prefix = f'multipart/{upload_id}/{final_key}/'
             out: dict[int, int] = {}
             for b in self._client.list_blobs(bucket, prefix=prefix):
                 leaf = b.name.rsplit('/', 1)[-1]  # e.g., part-000037
@@ -318,7 +364,7 @@ class GCSObjectClient:
             bucket_ref = self._get_bucket(bucket)
             soft_delete_versions = list(self._client.list_blobs(bucket_ref, prefix=object_name, soft_deleted=True))
             if not soft_delete_versions:
-                raise VersionNotFound(f"No soft-deleted versions found for {object_name!r}")
+                raise VersionNotFound(f'No soft-deleted versions found for {object_name!r}')
             soft_delete_versions.sort(key=lambda b: (getattr(b, 'soft_delete_time', None), b.generation), reverse=True)
             latest = soft_delete_versions[0]
             gen = int(latest.generation)
@@ -331,7 +377,7 @@ class GCSObjectClient:
             )
             resp = authed.post(url, headers={'Content-Type': 'application/json'})
             if resp.status_code >= 400:
-                raise RuntimeError(f"Restore failed: {resp.status_code} {resp.text}")
+                raise RuntimeError(f'Restore failed: {resp.status_code} {resp.text}')
 
             live_blobs = list(self._client.list_blobs(bucket, match_glob=object_name))
             live_blobs.sort(key=lambda b: (b.time_created, b.generation), reverse=True)

{pilot_platform_object_storage-2.0.0 → pilot_platform_object_storage-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pilot-platform-object-storage"
-version = "2.0.0"
+version = "2.1.0"
 description = "Python library for interacting with multiple object storage APIs."
 authors = ["Indoc Systems"]
 readme = "README.md"