microsoft-agents-storage-blob 0.0.0__py3-none-any.whl

microsoft/agents/storage/blob/__init__.py

@@ -0,0 +1,4 @@
+from .blob_storage import BlobStorage
+from .blob_storage_config import BlobStorageConfig
+
+__all__ = ["BlobStorage", "BlobStorageConfig"]

microsoft/agents/storage/blob/blob_storage.py

@@ -0,0 +1,100 @@
+import json
+from typing import TypeVar, Union
+from io import BytesIO
+
+from azure.storage.blob.aio import (
+    ContainerClient,
+    BlobServiceClient,
+)
+
+from microsoft.agents.hosting.core.storage import StoreItem
+from microsoft.agents.hosting.core.storage.storage import AsyncStorageBase
+from microsoft.agents.hosting.core.storage._type_aliases import JSON
+from microsoft.agents.hosting.core.storage.error_handling import (
+    ignore_error,
+    is_status_code_error,
+)
+
+from .blob_storage_config import BlobStorageConfig
+
+StoreItemT = TypeVar("StoreItemT", bound=StoreItem)
+
+
+class BlobStorage(AsyncStorageBase):
+
+    def __init__(self, config: BlobStorageConfig):
+
+        if not config.container_name:
+            raise ValueError("BlobStorage: Container name is required.")
+
+        self.config = config
+
+        blob_service_client: BlobServiceClient = self._create_client()
+        self._container_client: ContainerClient = (
+            blob_service_client.get_container_client(config.container_name)
+        )
+        self._initialized: bool = False
+
+    def _create_client(self) -> BlobServiceClient:
+        if self.config.url:  # connect with URL and credentials
+            if not self.config.credential:
+                raise ValueError(
+                    "BlobStorage: Credential is required when using a custom service URL."
+                )
+            return BlobServiceClient(
+                account_url=self.config.url, credential=self.config.credential
+            )
+
+        else:  # connect with connection string
+            return BlobServiceClient.from_connection_string(
+                self.config.connection_string
+            )
+
+    async def initialize(self) -> None:
+        """Initializes the storage container"""
+        if not self._initialized:
+            # This should only happen once - assuming this is a singleton.
+            await ignore_error(
+                self._container_client.create_container(), is_status_code_error(409)
+            )
+            self._initialized = True
+
+    async def _read_item(
+        self, key: str, *, target_cls: StoreItemT = None, **kwargs
+    ) -> tuple[Union[str, None], Union[StoreItemT, None]]:
+        item = await ignore_error(
+            self._container_client.download_blob(blob=key),
+            is_status_code_error(404),
+        )
+        if not item:
+            return None, None
+
+        item_rep: str = await item.readall()
+        item_JSON: JSON = json.loads(item_rep)
+        try:
+            return key, target_cls.from_json_to_store_item(item_JSON)
+        except AttributeError as error:
+            raise TypeError(
+                f"BlobStorage.read_item(): could not deserialize blob item into {target_cls} class. Error: {error}"
+            )
+
+    async def _write_item(self, key: str, item: StoreItem) -> None:
+        item_JSON: JSON = item.store_item_to_json()
+        if item_JSON is None:
+            raise ValueError(
+                "BlobStorage.write(): StoreItem serialization cannot return None"
+            )
+        item_rep_bytes = json.dumps(item_JSON).encode("utf-8")
+
+        # getting the length is important for performance with large blobs
+        await self._container_client.upload_blob(
+            name=key,
+            data=BytesIO(item_rep_bytes),
+            overwrite=True,
+            length=len(item_rep_bytes),
+        )
+
+    async def _delete_item(self, key: str) -> None:
+        await ignore_error(
+            self._container_client.delete_blob(blob=key), is_status_code_error(404)
+        )

microsoft/agents/storage/blob/blob_storage_config.py

@@ -0,0 +1,28 @@
+from typing import Union
+
+from azure.core.credentials import TokenCredential
+
+
+class BlobStorageConfig:
+    """Configuration settings for BlobStorage."""
+
+    def __init__(
+        self,
+        container_name: str,
+        connection_string: str = "",
+        url: str = "",
+        credential: Union[TokenCredential, None] = None,
+    ):
+        """Configuration settings for BlobStorage.
+
+        container_name: The name of the blob container.
+        connection_string: The connection string to the storage account.
+        url: The URL of the blob service. If provided, credential must also be provided.
+        credential: The TokenCredential to use for authentication when using a custom URL.
+
+        credential-based authentication is prioritized over connection string authentication.
+        """
+        self.container_name: str = container_name
+        self.connection_string: str = connection_string
+        self.url: str = url
+        self.credential: Union[TokenCredential, None] = credential

microsoft_agents_storage_blob-0.0.0.dist-info/METADATA

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-storage-blob
+Version: 0.0.0
+Summary: A blob storage library for Microsoft Agents
+Author: Microsoft Corporation
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Requires-Dist: microsoft-agents-hosting-core==0.0.0
+Requires-Dist: azure-core
+Requires-Dist: azure-storage-blob
+Dynamic: requires-dist

microsoft_agents_storage_blob-0.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+microsoft/agents/storage/blob/__init__.py,sha256=5IxnH_hkyJrp5Gdk92cfK78d39m_DAEyjX-iFr9g1Do,137
+microsoft/agents/storage/blob/blob_storage.py,sha256=xbOAJzVhT4YRPKBtFDWpmPkPT3LWHqEFPlXdZ8I7teM,3534
+microsoft/agents/storage/blob/blob_storage_config.py,sha256=wKK7WJAdy4FIIx5HCVIDNecPefZB5Hy6jM82gKdCBF8,1009
+microsoft_agents_storage_blob-0.0.0.dist-info/METADATA,sha256=wCv1rah5-pQZ5S7_n2b5O2-gWUlBp80Ss56ovodVnKE,519
+microsoft_agents_storage_blob-0.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_storage_blob-0.0.0.dist-info/top_level.txt,sha256=egwWDmpnNBTGerc55Oa6VVW9hTKdtxFjHWHywqmVMpM,10
+microsoft_agents_storage_blob-0.0.0.dist-info/RECORD,,

microsoft_agents_storage_blob-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

microsoft_agents_storage_blob-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+microsoft