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

azure/storage/blob/aio/_container_client_async.pyi

@@ -0,0 +1,384 @@
+# -------------------------------------------------------------------------
+# 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,
+    AnyStr,
+    AsyncIterable,
+    AsyncIterator,
+    Awaitable,
+    Callable,
+    Dict,
+    List,
+    IO,
+    Iterable,
+    Optional,
+    overload,
+    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.pipeline.transport import AsyncHttpResponse
+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 ._blob_service_client_async import BlobServiceClient
+from ._download_async import StorageStreamDownloader
+from ._lease_async import BlobLeaseClient
+from ._list_blobs_helper import BlobPrefix
+from .._encryption import StorageEncryptionMixin
+from .._generated.models import RehydratePriority
+from .._models import (
+    AccessPolicy,
+    BlobType,
+    BlobProperties,
+    ContainerEncryptionScope,
+    ContainerProperties,
+    ContentSettings,
+    CustomerProvidedEncryptionKey,
+    FilteredBlob,
+    PremiumPageBlobTier,
+    PublicAccess,
+    StandardBlobTier,
+)
+from .._shared.base_client import StorageAccountHostsMixin
+from .._shared.base_client_async import AsyncStorageAccountHostsMixin
+
+class ContainerClient(  # type: ignore[misc]
+    AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, StorageEncryptionMixin
+):
+    account_name: str
+    container_name: str
+    def __init__(
+        self,
+        account_url: str,
+        container_name: str,
+        credential: Optional[
+            Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, AsyncTokenCredential]
+        ] = None,
+        *,
+        api_version: Optional[str] = None,
+        secondary_hostname: Optional[str] = None,
+        audience: Optional[str] = None,
+        max_block_size: int = 4 * 1024 * 1024,
+        max_page_size: int = 4 * 1024 * 1024,
+        max_chunk_get_size: int = 4 * 1024 * 1024,
+        max_single_put_size: int = 64 * 1024 * 1024,
+        max_single_get_size: int = 32 * 1024 * 1024,
+        min_large_block_upload_threshold: int = 4 * 1024 * 1024 + 1,
+        use_byte_buffer: Optional[bool] = 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_container_url(
+        cls,
+        container_url: str,
+        credential: Optional[
+            Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, AsyncTokenCredential]
+        ] = None,
+        *,
+        api_version: Optional[str] = None,
+        secondary_hostname: Optional[str] = None,
+        audience: Optional[str] = None,
+        max_block_size: int = 4 * 1024 * 1024,
+        max_page_size: int = 4 * 1024 * 1024,
+        max_chunk_get_size: int = 4 * 1024 * 1024,
+        max_single_put_size: int = 64 * 1024 * 1024,
+        max_single_get_size: int = 32 * 1024 * 1024,
+        min_large_block_upload_threshold: int = 4 * 1024 * 1024 + 1,
+        use_byte_buffer: Optional[bool] = None,
+        **kwargs: Any
+    ) -> Self: ...
+    @classmethod
+    def from_connection_string(
+        cls,
+        conn_str: str,
+        container_name: str,
+        credential: Optional[
+            Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, AsyncTokenCredential]
+        ] = None,
+        *,
+        api_version: Optional[str] = None,
+        secondary_hostname: Optional[str] = None,
+        audience: Optional[str] = None,
+        max_block_size: int = 4 * 1024 * 1024,
+        max_page_size: int = 4 * 1024 * 1024,
+        max_chunk_get_size: int = 4 * 1024 * 1024,
+        max_single_put_size: int = 64 * 1024 * 1024,
+        max_single_get_size: int = 32 * 1024 * 1024,
+        min_large_block_upload_threshold: int = 4 * 1024 * 1024 + 1,
+        use_byte_buffer: Optional[bool] = None,
+        **kwargs: Any
+    ) -> Self: ...
+    @distributed_trace_async
+    async def create_container(
+        self,
+        metadata: Optional[Dict[str, str]] = None,
+        public_access: Optional[Union[PublicAccess, str]] = None,
+        *,
+        container_encryption_scope: Optional[Union[Dict[str, Any], ContainerEncryptionScope]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> Dict[str, Union[str, datetime]]: ...
+    @distributed_trace_async
+    async def _rename_container(
+        self,
+        new_name: str,
+        *,
+        lease: Optional[Union[BlobLeaseClient, str]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> "ContainerClient": ...
+    @distributed_trace_async
+    async def delete_container(
+        self,
+        *,
+        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 acquire_lease(
+        self,
+        lease_duration: int = -1,
+        lease_id: Optional[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
+    ) -> BlobLeaseClient: ...
+    @distributed_trace_async
+    async def get_account_information(self, **kwargs: Any) -> Dict[str, str]: ...
+    @distributed_trace_async
+    async def get_container_properties(
+        self, *, lease: Optional[Union[BlobLeaseClient, str]] = None, timeout: Optional[int] = None, **kwargs: Any
+    ) -> ContainerProperties: ...
+    @distributed_trace_async
+    async def exists(self, *, timeout: Optional[int] = None, **kwargs: Any) -> bool: ...
+    @distributed_trace_async
+    async def set_container_metadata(
+        self,
+        metadata: Optional[Dict[str, str]] = None,
+        *,
+        lease: Optional[Union[BlobLeaseClient, str]] = None,
+        if_modified_since: Optional[datetime] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> Dict[str, Union[str, datetime]]: ...
+    @distributed_trace
+    def _get_blob_service_client(self) -> BlobServiceClient: ...
+    @distributed_trace_async
+    async def get_container_access_policy(
+        self, *, lease: Optional[Union[BlobLeaseClient, str]] = None, timeout: Optional[int] = None, **kwargs: Any
+    ) -> Dict[str, Any]: ...
+    @distributed_trace_async
+    async def set_container_access_policy(
+        self,
+        signed_identifiers: Dict[str, AccessPolicy],
+        public_access: Optional[Union[str, PublicAccess]] = None,
+        *,
+        lease: Optional[Union[BlobLeaseClient, str]] = None,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> Dict[str, Union[str, datetime]]: ...
+    @distributed_trace
+    def list_blobs(
+        self,
+        name_starts_with: Optional[str] = None,
+        include: Optional[Union[str, List[str]]] = None,
+        *,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncItemPaged[BlobProperties]: ...
+    @distributed_trace
+    def list_blob_names(
+        self, *, name_starts_with: Optional[str] = None, timeout: Optional[int] = None, **kwargs: Any
+    ) -> AsyncItemPaged[str]: ...
+    @distributed_trace
+    def walk_blobs(
+        self,
+        name_starts_with: Optional[str] = None,
+        include: Optional[Union[List[str], str]] = None,
+        delimiter: str = "/",
+        **kwargs: Any
+    ) -> AsyncItemPaged[Union[BlobProperties, BlobPrefix]]: ...
+    @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 upload_blob(
+        self,
+        name: str,
+        data: Union[bytes, str, Iterable[AnyStr], AsyncIterable[AnyStr], IO[AnyStr]],
+        blob_type: Union[str, BlobType] = BlobType.BLOCKBLOB,
+        length: Optional[int] = None,
+        metadata: Optional[Dict[str, str]] = None,
+        *,
+        overwrite: Optional[bool] = None,
+        content_settings: Optional[ContentSettings] = None,
+        validate_content: Optional[bool] = None,
+        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,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        premium_page_blob_tier: Optional[PremiumPageBlobTier] = None,
+        standard_blob_tier: Optional[StandardBlobTier] = None,
+        maxsize_condition: Optional[int] = None,
+        max_concurrency: Optional[int] = None,
+        cpk: Optional[CustomerProvidedEncryptionKey] = None,
+        encryption_scope: Optional[str] = None,
+        encoding: Optional[str] = None,
+        progress_hook: Optional[Callable[[int, Optional[int]], Awaitable[None]]] = None,
+        **kwargs: Any
+    ) -> BlobClient: ...
+    @distributed_trace_async
+    async def delete_blob(
+        self,
+        blob: str,
+        delete_snapshots: Optional[str] = None,
+        *,
+        version_id: Optional[str] = None,
+        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,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @overload
+    async def download_blob(
+        self,
+        blob: str,
+        offset: Optional[int] = None,
+        length: Optional[int] = None,
+        *,
+        version_id: Optional[str] = None,
+        validate_content: Optional[bool] = None,
+        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,
+        if_tags_match_condition: Optional[str] = None,
+        cpk: Optional[CustomerProvidedEncryptionKey] = None,
+        max_concurrency: Optional[int] = None,
+        encoding: str,
+        progress_hook: Optional[Callable[[int, int], Awaitable[None]]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> StorageStreamDownloader[str]: ...
+    @overload
+    async def download_blob(
+        self,
+        blob: str,
+        offset: Optional[int] = None,
+        length: Optional[int] = None,
+        *,
+        version_id: Optional[str] = None,
+        validate_content: Optional[bool] = None,
+        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,
+        if_tags_match_condition: Optional[str] = None,
+        cpk: Optional[CustomerProvidedEncryptionKey] = None,
+        max_concurrency: Optional[int] = None,
+        encoding: None = None,
+        progress_hook: Optional[Callable[[int, int], Awaitable[None]]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> StorageStreamDownloader[bytes]: ...
+    @distributed_trace_async  # type: ignore[misc]
+    async def download_blob(
+        self,
+        blob: str,
+        offset: Optional[int] = None,
+        length: Optional[int] = None,
+        *,
+        version_id: Optional[str] = None,
+        validate_content: Optional[bool] = None,
+        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,
+        if_tags_match_condition: Optional[str] = None,
+        cpk: Optional[CustomerProvidedEncryptionKey] = None,
+        max_concurrency: Optional[int] = None,
+        encoding: Optional[str] = None,
+        progress_hook: Optional[Callable[[int, int], Awaitable[None]]] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> Union[StorageStreamDownloader[str], StorageStreamDownloader[bytes]]: ...
+    @distributed_trace_async
+    async def delete_blobs(
+        self,
+        *blobs: Union[str, Dict[str, Any], BlobProperties],
+        delete_snapshots: Optional[str] = None,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        if_tags_match_condition: Optional[str] = None,
+        raise_on_any_failure: bool = True,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncIterator[AsyncHttpResponse]: ...
+    @distributed_trace_async
+    async def set_standard_blob_tier_blobs(
+        self,
+        standard_blob_tier: Union[str, StandardBlobTier],
+        *blobs: Union[str, Dict[str, Any], BlobProperties],
+        rehydrate_priority: Optional[RehydratePriority] = None,
+        if_tags_match_condition: Optional[str] = None,
+        raise_on_any_failure: bool = True,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncIterator[AsyncHttpResponse]: ...
+    @distributed_trace_async
+    async def set_premium_page_blob_tier_blobs(
+        self,
+        premium_page_blob_tier: Union[str, PremiumPageBlobTier],
+        *blobs: Union[str, Dict[str, Any], BlobProperties],
+        raise_on_any_failure: bool = True,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> AsyncIterator[AsyncHttpResponse]: ...
+    def get_blob_client(
+        self, blob: str, snapshot: Optional[str] = None, *, version_id: Optional[str] = None
+    ) -> BlobClient: ...

azure/storage/blob/aio/_lease_async.py

@@ -19,7 +19,7 @@ if TYPE_CHECKING:
     from datetime import datetime
 
 
-class BlobLeaseClient(): # pylint: disable=client-accepts-api-version-keyword
+class BlobLeaseClient: # pylint: disable=client-accepts-api-version-keyword
     """Creates a new BlobLeaseClient.
 
     This client provides lease operations on a BlobClient or ContainerClient.
@@ -40,7 +40,7 @@ class BlobLeaseClient(): # pylint: disable=client-accepts-api-version-keyword
     """The last modified timestamp of the lease currently being maintained.
     This will be `None` if no lease has yet been acquired or modified."""
 
-    def __init__( # pylint: disable=missing-client-constructor-parameter-credential, missing-client-constructor-parameter-kwargs
+    def __init__(  # pylint: disable=missing-client-constructor-parameter-credential, missing-client-constructor-parameter-kwargs
         self, client: Union["BlobClient", "ContainerClient"],
         lease_id: Optional[str] = None
     ) -> None:

azure/storage/blob/aio/_lease_async.pyi

@@ -0,0 +1,81 @@
+# -------------------------------------------------------------------------
+# 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 typing import Any, Optional, Union
+
+from azure.core import MatchConditions
+from azure.core.tracing.decorator_async import distributed_trace_async
+from ._blob_client_async import BlobClient
+from ._container_client_async import ContainerClient
+
+class BlobLeaseClient:
+    id: str
+    etag: Optional[str]
+    last_modified: Optional[datetime]
+    def __init__(self, client: Union[BlobClient, ContainerClient], lease_id: Optional[str] = None) -> None: ...
+    @distributed_trace_async
+    async def acquire(
+        self,
+        lease_duration: int = -1,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        etag: Optional[str] = None,
+        match_condition: Optional[MatchConditions] = None,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace_async
+    async def renew(
+        self,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        etag: Optional[str] = None,
+        match_condition: Optional[MatchConditions] = None,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace_async
+    async def release(
+        self,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        etag: Optional[str] = None,
+        match_condition: Optional[MatchConditions] = None,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace_async
+    async def change(
+        self,
+        proposed_lease_id: str,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        etag: Optional[str] = None,
+        match_condition: Optional[MatchConditions] = None,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> None: ...
+    @distributed_trace_async
+    async def break_lease(
+        self,
+        lease_break_period: Optional[int] = None,
+        *,
+        if_modified_since: Optional[datetime] = None,
+        if_unmodified_since: Optional[datetime] = None,
+        if_tags_match_condition: Optional[str] = None,
+        timeout: Optional[int] = None,
+        **kwargs: Any
+    ) -> int: ...

{azure_storage_blob-12.26.0.dist-info → azure_storage_blob-12.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: azure-storage-blob
-Version: 12.26.0
+Version: 12.27.0
 Summary: Microsoft Azure Blob Storage Client Library for Python
 Home-page: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
 Author: Microsoft Corporation
@@ -11,13 +11,12 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: azure-core>=1.30.0
@@ -26,6 +25,19 @@ Requires-Dist: typing-extensions>=4.6.0
 Requires-Dist: isodate>=0.6.1
 Provides-Extra: aio
 Requires-Dist: azure-core[aio]>=1.30.0; extra == "aio"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Azure Storage Blobs client library for Python
 Azure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data, such as text or binary data.
@@ -49,7 +61,7 @@ Blob storage is ideal for:
 ## Getting started
 
 ### Prerequisites
-* Python 3.8 or later is required to use this package. For more details, please read our page on [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy).
+* Python 3.9 or later is required to use this package. For more details, please read our page on [Azure SDK for Python version support policy](https://github.com/Azure/azure-sdk-for-python/wiki/Azure-SDKs-Python-version-support-policy).
 * You must have an [Azure subscription](https://azure.microsoft.com/free/) and an
 [Azure storage account](https://learn.microsoft.com/azure/storage/common/storage-account-overview) to use this package.