feat(object-storage): Add upload_from_dir helper method

This method creates an object out of a local directory by bundling it
into a compressed tarball and uploading it as an object.

Author: adam-rl

src/runloop_api_client/sdk/async_.py

@@ -2,8 +2,12 @@
 
 from __future__ import annotations
 
+import io
+import asyncio
+import tarfile
 from typing import Dict, Mapping, Optional
 from pathlib import Path
+from datetime import timedelta
 from typing_extensions import Unpack
 
 import httpx
@@ -350,7 +354,7 @@ async def upload_from_file(
         path = Path(file_path)
 
         try:
-            content = path.read_bytes()
+            content = await asyncio.to_thread(lambda: path.read_bytes())
         except OSError as error:
             raise OSError(f"Failed to read file {path}: {error}") from error
 
@@ -361,6 +365,50 @@ async def upload_from_file(
         await obj.complete()
         return obj
 
+    async def upload_from_dir(
+        self,
+        dir_path: str | Path,
+        *,
+        name: Optional[str] = None,
+        metadata: Optional[Dict[str, str]] = None,
+        ttl: Optional[timedelta] = None,
+        **options: Unpack[LongRequestOptions],
+    ) -> AsyncStorageObject:
+        """Create and upload an object from a local directory.
+
+        The resulting object will be uploaded as a compressed tarball.
+
+        :param dir_path: Local filesystem directory path to tar
+        :type dir_path: str | Path
+        :param name: Optional object name; defaults to the directory name + '.tar.gz'
+        :type name: Optional[str]
+        :param metadata: Optional key-value metadata
+        :type metadata: Optional[Dict[str, str]]
+        :param ttl: Optional Time-To-Live, after which the object is automatically deleted
+        :type ttl: Optional[timedelta]
+        :param options: See :typeddict:`~runloop_api_client.sdk._types.LongRequestOptions` for available options
+        :return: Wrapper for the uploaded object
+        :rtype: AsyncStorageObject
+        :raises OSError: If the local file cannot be read
+        """
+        path = Path(dir_path)
+        name = name or f"{path.name}.tar.gz"
+        ttl_ms = int(ttl.total_seconds()) * 1000 if ttl else None
+
+        def synchronous_io() -> io.BytesIO:
+            tar_buffer = io.BytesIO()
+            with tarfile.open(fileobj=tar_buffer, mode="w:gz") as tar:
+                tar.add(path, arcname=".", recursive=True)
+            tar_buffer.seek(0)
+            return tar_buffer
+
+        tar_buffer = await asyncio.to_thread(synchronous_io)
+
+        obj = await self.create(name=name, content_type="tgz", metadata=metadata, ttl_ms=ttl_ms, **options)
+        await obj.upload_content(tar_buffer)
+        await obj.complete()
+        return obj
+
     async def upload_from_text(
         self,
         text: str,

src/runloop_api_client/sdk/async_storage_object.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Unpack, override
 
 from ._types import RequestOptions, LongRequestOptions, SDKObjectDownloadParams
@@ -146,7 +147,7 @@ async def delete(
             **options,
         )
 
-    async def upload_content(self, content: str | bytes) -> None:
+    async def upload_content(self, content: str | bytes | Iterable[bytes]) -> None:
         """Upload content to the object's pre-signed URL.
 
         :param content: Bytes or text payload to upload

src/runloop_api_client/sdk/storage_object.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Unpack, override
 
 from ._types import RequestOptions, LongRequestOptions, SDKObjectDownloadParams
@@ -146,7 +147,7 @@ def delete(
             **options,
         )
 
-    def upload_content(self, content: str | bytes) -> None:
+    def upload_content(self, content: str | bytes | Iterable[bytes]) -> None:
         """Upload content to the object's pre-signed URL.
 
         :param content: Bytes or text payload to upload

src/runloop_api_client/sdk/sync.py

@@ -2,8 +2,11 @@
 
 from __future__ import annotations
 
+import io
+import tarfile
 from typing import Dict, Mapping, Optional
 from pathlib import Path
+from datetime import timedelta
 from typing_extensions import Unpack
 
 import httpx
@@ -361,6 +364,46 @@ def upload_from_file(
         obj.complete()
         return obj
 
+    def upload_from_dir(
+        self,
+        dir_path: str | Path,
+        *,
+        name: Optional[str] = None,
+        metadata: Optional[Dict[str, str]] = None,
+        ttl: Optional[timedelta] = None,
+        **options: Unpack[LongRequestOptions],
+    ) -> StorageObject:
+        """Create and upload an object from a local directory.
+
+        The resulting object will be uploaded as a compressed tarball.
+
+        :param dir_path: Local filesystem directory path to tar
+        :type dir_path: str | Path
+        :param name: Optional object name; defaults to the directory name + '.tar.gz'
+        :type name: Optional[str]
+        :param metadata: Optional key-value metadata
+        :type metadata: Optional[Dict[str, str]]
+        :param ttl: Optional Time-To-Live, after which the object is automatically deleted
+        :type ttl: Optional[timedelta]
+        :param options: See :typeddict:`~runloop_api_client.sdk._types.LongRequestOptions` for available options
+        :return: Wrapper for the uploaded object
+        :rtype: StorageObject
+        :raises OSError: If the local file cannot be read
+        """
+        path = Path(dir_path)
+        name = name or f"{path.name}.tar.gz"
+        ttl_ms = int(ttl.total_seconds()) * 1000 if ttl else None
+
+        tar_buffer = io.BytesIO()
+        with tarfile.open(fileobj=tar_buffer, mode="w:gz") as tar:
+            tar.add(path, arcname=".", recursive=True)
+        tar_buffer.seek(0)
+
+        obj = self.create(name=name, content_type="tgz", metadata=metadata, ttl_ms=ttl_ms, **options)
+        obj.upload_content(tar_buffer)
+        obj.complete()
+        return obj
+
     def upload_from_text(
         self,
         text: str,