azure-storage-blob 12.26.0__py3-none-any.whl → 12.27.0__py3-none-any.whl

azure/storage/blob/aio/_blob_service_client_async.py

@@ -139,7 +139,23 @@ class BlobServiceClient(  # type: ignore [misc]
         self._client._config.version = get_api_version(kwargs)  # type: ignore [assignment]
         self._configure_encryption(kwargs)
 
-    def _format_url(self, hostname):
+    async def __aenter__(self) -> Self:
+        await self._client.__aenter__()
+        return self
+
+    async def __aexit__(self, *args) -> None:
+        await self._client.__aexit__(*args)
+
+    async def close(self) -> None:
+        """This method is to close the sockets opened by the client.
+        It need not be used when using with a context manager.
+
+        :return: None
+        :rtype: None
+        """
+        await self._client.close()
+
+    def _format_url(self, hostname: str) -> str:
         """Format the endpoint URL according to the current location
         mode hostname.
 
@@ -174,6 +190,27 @@ class BlobServiceClient(  # type: ignore [misc]
             ~azure.core.credentials.AzureSasCredential or
             ~azure.core.credentials_async.AsyncTokenCredential or
             str or dict[str, str] or None
+        :keyword str api_version:
+            The Storage API version to use for requests. Default value is the most recent service version that is
+            compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
+
+            .. versionadded:: 12.2.0
+
+        :keyword str secondary_hostname:
+            The hostname of the secondary endpoint.
+        :keyword int max_block_size: The maximum chunk size for uploading a block blob in chunks.
+            Defaults to 4*1024*1024, or 4MB.
+        :keyword int max_single_put_size: If the blob size is less than or equal max_single_put_size, then the blob will
+            be uploaded with only one http PUT request. If the blob size is larger than max_single_put_size,
+            the blob will be uploaded in chunks. Defaults to 64*1024*1024, or 64MB.
+        :keyword int min_large_block_upload_threshold: The minimum chunk size required to use the memory efficient
+            algorithm when uploading a block blob. Defaults to 4*1024*1024+1.
+        :keyword bool use_byte_buffer: Use a byte buffer for block blob uploads. Defaults to False.
+        :keyword int max_page_size: The maximum chunk size for uploading a page blob. Defaults to 4*1024*1024, or 4MB.
+        :keyword int max_single_get_size: The maximum size for a blob to be downloaded in a single call,
+            the exceeded part will be downloaded in chunks (could be parallel). Defaults to 32*1024*1024, or 32MB.
+        :keyword int max_chunk_get_size: The maximum chunk size used for downloading a blob. Defaults to 4*1024*1024,
+            or 4MB.
         :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
             authentication. Only has an effect when credential is of type TokenCredential. The value could be
             https://storage.azure.com/ (default) or https://<account>.blob.core.windows.net.
@@ -236,7 +273,7 @@ class BlobServiceClient(  # type: ignore [misc]
         The keys in the returned dictionary include 'sku_name' and 'account_kind'.
 
         :return: A dict of account information (SKU and account type).
-        :rtype: dict(str, str)
+        :rtype: Dict[str, str]
 
         .. admonition:: Example:
 
@@ -529,7 +566,7 @@ class BlobServiceClient(  # type: ignore [misc]
         :param metadata:
             A dict with name-value pairs to associate with the
             container as metadata. Example: `{'Category':'test'}`
-        :type metadata: dict(str, str)
+        :type metadata: Dict[str, str]
         :param public_access:
             Possible values include: 'container', 'blob'.
         :type public_access: str or ~azure.storage.blob.PublicAccess
@@ -759,7 +796,7 @@ class BlobServiceClient(  # type: ignore [misc]
             The optional blob snapshot on which to operate. This can either be the ID of the snapshot,
             or a dictionary output returned by
             :func:`~azure.storage.blob.aio.BlobClient.create_snapshot()`.
-        :type snapshot: str or dict(str, Any)
+        :type snapshot: str or Dict[str, Any]
         :keyword str version_id: The version id parameter is an opaque DateTime value that, when present,
             specifies the version of the blob to operate on.
         :return: A BlobClient.

azure/storage/blob/aio/_blob_service_client_async.pyi

@@ -0,0 +1,187 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+# pylint: skip-file
+
+from datetime import datetime
+from types import TracebackType
+from typing import (
+    Any,
+    Dict,
+    List,
+    Optional,
+    Union,
+)
+from typing_extensions import Self
+
+from azure.core import MatchConditions
+from azure.core.async_paging import AsyncItemPaged
+from azure.core.credentials import AzureNamedKeyCredential, AzureSasCredential
+from azure.core.credentials_async import AsyncTokenCredential
+from azure.core.tracing.decorator import distributed_trace
+from azure.core.tracing.decorator_async import distributed_trace_async
+
+from ._blob_client_async import BlobClient
+from ._container_client_async import ContainerClient
+from ._lease_async import BlobLeaseClient
+from .._encryption import StorageEncryptionMixin
+from .._models import (
+    BlobAnalyticsLogging,
+    ContainerEncryptionScope,
+    ContainerProperties,
+    CorsRule,
+    FilteredBlob,
+    Metrics,
+    PublicAccess,
+    RetentionPolicy,
+    StaticWebsite,
+)
+from .._shared.base_client import StorageAccountHostsMixin
+from .._shared.base_client_async import AsyncStorageAccountHostsMixin
+from .._shared.models import UserDelegationKey
+
+class BlobServiceClient(  # type: ignore [misc]
+    AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, StorageEncryptionMixin
+):
+    def __init__(
+        self,
+        account_url: str,
+        credential: Optional[
+            Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, AsyncTokenCredential]
+        ] = None,
+        *,
+        api_version: Optional[str] = None,
+        secondary_hostname: Optional[str] = None,
+        max_block_size: int = 4 * 1024 * 1024,
+        max_single_put_size: int = 64 * 1024 * 1024,
+        min_large_block_upload_threshold: int = 4 * 1024 * 1024 + 1,
+        use_byte_buffer: bool = False,
+        max_page_size: int = 4 * 1024 * 1024,
+        max_single_get_size: int = 32 * 1024 * 1024,
+        max_chunk_get_size: int = 4 * 1024 * 1024,
+        audience: Optional[str] = None,
+        **kwargs: Any
+    ) -> None: ...
+    async def __aenter__(self) -> Self: ...
+    async def __aexit__(
+        self, typ: Optional[type[BaseException]], exc: Optional[BaseException], tb: Optional[TracebackType]
+    ) -> None: ...
+    async def close(self) -> None: ...
+    @classmethod
+    def from_connection_string(
+        cls,
+        conn_str: str,
+        credential: Optional[
+            Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, AsyncTokenCredential]
+        ] = None,
+        *,
+        api_version: Optional[str] = None,
+        secondary_hostname: Optional[str] = None,
+        max_block_size: int = 4 * 1024 * 1024,
+        max_single_put_size: int = 64 * 1024 * 1024,
+        min_large_block_upload_threshold: int = 4 * 1024 * 1024 + 1,
+        use_byte_buffer: bool = False,
+        max_page_size: int = 4 * 1024 * 1024,
+        max_single_get_size: int = 32 * 1024 * 1024,
+        max_chunk_get_size: int = 4 * 1024 * 1024,
+        audience: Optional[str] = None,
+        **kwargs: Any
+    ) -> Self: ...
+    @distributed_trace_async
+    async def get_user_delegation_key(
+        self, key_start_time: datetime, key_expiry_time: datetime, *, timeout: Optional[int] = None, **kwargs: Any
+    ) -> UserDelegationKey: ...
+    @distributed_trace_async
+    async def get_account_information(self, **kwargs: Any) -> Dict[str, str]: ...
+    @distributed_trace_async
+    async def get_service_stats(self, *, timeout: Optional[int] = None, **kwargs: Any) -> Dict[str, Any]: ...
+    @distributed_trace_async
+    async def get_service_properties(self, *, timeout: Optional[int] = None, **kwargs: Any) -> Dict[str, Any]: ...
+    @distributed_trace_async
+    async def set_service_properties(
+        self,
+        analytics_logging: Optional[BlobAnalyticsLogging] = None,
+        hour_metrics: Optional[Metrics] = None,
+        minute_metrics: Optional[Metrics] = None,
+        cors: Optional[List[CorsRule]] = None,
+        target_version: Optional[str] = None,
+        delete_retention_policy: Optional[RetentionPolicy] = None,
+        static_website: Optional[StaticWebsite] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace
+    def list_containers(
+        self,
+        name_starts_with: Optional[str] = None,
+        include_metadata: bool = False,
+        *,
+        include_deleted: Optional[bool] = None,
+        include_system: Optional[bool] = None,
+        results_per_page: Optional[int] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncItemPaged[ContainerProperties]: ...
+    @distributed_trace
+    def find_blobs_by_tags(
+        self,
+        filter_expression: str,
+        *,
+        results_per_page: Optional[int] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncItemPaged[FilteredBlob]: ...
+    @distributed_trace_async
+    async def create_container(
+        self,
+        name: str,
+        metadata: Optional[Dict[str, str]] = None,
+        public_access: Optional[Union[PublicAccess, str]] = None,
+        *,
+        container_encryption_scope: Optional[Union[dict, ContainerEncryptionScope]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> ContainerClient: ...
+    @distributed_trace_async
+    async def delete_container(
+        self,
+        container: Union[ContainerProperties, str],
+        lease: Optional[Union[BlobLeaseClient, str]] = None,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        etag: Optional[str] = None,
+        match_condition: Optional[MatchConditions] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace_async
+    async def _rename_container(
+        self,
+        name: str,
+        new_name: str,
+        *,
+        lease: Optional[Union[BlobLeaseClient, str]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> ContainerClient: ...
+    @distributed_trace_async
+    async def undelete_container(
+        self,
+        deleted_container_name: str,
+        deleted_container_version: str,
+        *,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> ContainerClient: ...
+    def get_container_client(self, container: Union[ContainerProperties, str]) -> ContainerClient: ...
+    def get_blob_client(
+        self,
+        container: Union[ContainerProperties, str],
+        blob: str,
+        snapshot: Optional[Union[Dict[str, Any], str]] = None,
+        *,
+        version_id: Optional[str] = None,
+        **kwargs: Any
+    ) -> BlobClient: ...

azure/storage/blob/aio/_container_client_async.py

@@ -62,7 +62,11 @@ if TYPE_CHECKING:
     )
 
 
-class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, StorageEncryptionMixin):  # type: ignore [misc]  # pylint: disable=too-many-public-methods
+class ContainerClient(  # type: ignore [misc]  # pylint: disable=too-many-public-methods
+    AsyncStorageAccountHostsMixin,
+    StorageAccountHostsMixin,
+    StorageEncryptionMixin
+):
     """A client to interact with a specific container, although that container
     may not yet exist.
 
@@ -143,6 +147,22 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         self._client = self._build_generated_client()
         self._configure_encryption(kwargs)
 
+    async def __aenter__(self) -> Self:
+        await self._client.__aenter__()
+        return self
+
+    async def __aexit__(self, *args) -> None:
+        await self._client.__aexit__(*args)
+
+    async def close(self) -> None:
+        """This method is to close the sockets opened by the client.
+        It need not be used when using with a context manager.
+
+        :return: None
+        :rtype: None
+        """
+        await self._client.close()
+
     def _build_generated_client(self) -> AzureBlobStorage:
         client = AzureBlobStorage(self.url, base_url=self.url, pipeline=self._pipeline)
         client._config.version = self._api_version  # type: ignore [assignment] # pylint: disable=protected-access
@@ -782,6 +802,9 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions',
             'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
         :type include: list[str] or str
+        :keyword int results_per_page:
+            Controls the maximum number of Blobs that will be included in each page of results if using
+            `AsyncItemPaged.by_page()`.
         :keyword int timeout:
             Sets the server-side timeout for the operation in seconds. For more details see
             https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
@@ -835,6 +858,9 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         :keyword str name_starts_with:
             Filters the results to return only blobs whose names
             begin with the specified prefix.
+        :keyword int results_per_page:
+            Controls the maximum number of Blobs that will be included in each page of results if using
+            `AsyncItemPaged.by_page()`.
         :keyword int timeout:
             Sets the server-side timeout for the operation in seconds. For more details see
             https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.