azure-storage-blob 12.25.0b1__py3-none-any.whl → 12.26.0__py3-none-any.whl

azure/storage/blob/aio/_blob_service_client_async.py

@@ -145,7 +145,7 @@ class BlobServiceClient(  # type: ignore [misc]
 
         :param str hostname:
             The hostname of the current location mode.
-        :returns: A formatted endpoint URL including current location mode hostname.
+        :return: A formatted endpoint URL including current location mode hostname.
         :rtype: str
         """
         return f"{self.scheme}://{hostname}/{self._query_str}"
@@ -177,7 +177,7 @@ class BlobServiceClient(  # type: ignore [misc]
         :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.
-        :returns: A Blob service client.
+        :return: A Blob service client.
         :rtype: ~azure.storage.blob.BlobServiceClient
 
         .. admonition:: Example:
@@ -235,7 +235,7 @@ class BlobServiceClient(  # type: ignore [misc]
         The information can also be retrieved if the user has a SAS to a container or blob.
         The keys in the returned dictionary include 'sku_name' and 'account_kind'.
 
-        :returns: A dict of account information (SKU and account type).
+        :return: A dict of account information (SKU and account type).
         :rtype: dict(str, str)
 
         .. admonition:: Example:
@@ -309,7 +309,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An object containing blob service properties such as
+        :return: An object containing blob service properties such as
             analytics logging, hour/minute metrics, cors rules, etc.
         :rtype: Dict[str, Any]
 
@@ -379,6 +379,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
+        :return: None
         :rtype: None
 
         .. admonition:: Example:
@@ -443,7 +444,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) of ContainerProperties.
+        :return: An iterable (auto-paging) of ContainerProperties.
         :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.ContainerProperties]
 
         .. admonition:: Example:
@@ -496,7 +497,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) response of BlobProperties.
+        :return: An iterable (auto-paging) response of BlobProperties.
         :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.FilteredBlob]
         """
 
@@ -545,7 +546,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: A container client to interact with the newly created container.
+        :return: A container client to interact with the newly created container.
         :rtype: ~azure.storage.blob.aio.ContainerClient
 
         .. admonition:: Example:
@@ -607,6 +608,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
+        :return: None
         :rtype: None
 
         .. admonition:: Example:
@@ -646,7 +648,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: A container client for the renamed container.
+        :return: A container client for the renamed container.
         :rtype: ~azure.storage.blob.ContainerClient
         """
         renamed_container = self.get_container_client(new_name)
@@ -685,7 +687,7 @@ class BlobServiceClient(  # type: ignore [misc]
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: The recovered soft-deleted ContainerClient.
+        :return: The recovered soft-deleted ContainerClient.
         :rtype: ~azure.storage.blob.aio.ContainerClient
         """
         new_name = kwargs.pop('new_name', None)
@@ -709,7 +711,7 @@ class BlobServiceClient(  # type: ignore [misc]
             The container. This can either be the name of the container,
             or an instance of ContainerProperties.
         :type container: str or ~azure.storage.blob.ContainerProperties
-        :returns: A ContainerClient.
+        :return: A ContainerClient.
         :rtype: ~azure.storage.blob.aio.ContainerClient
 
         .. admonition:: Example:
@@ -760,7 +762,7 @@ class BlobServiceClient(  # type: ignore [misc]
         :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.
-        :returns: A BlobClient.
+        :return: A BlobClient.
         :rtype: ~azure.storage.blob.aio.BlobClient
 
         .. admonition:: Example:

azure/storage/blob/aio/_container_client_async.py

@@ -186,7 +186,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         :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.
-        :returns: A container client.
+        :return: A container client.
         :rtype: ~azure.storage.blob.ContainerClient
         """
         try:
@@ -239,7 +239,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         :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.
-        :returns: A container client.
+        :return: A container client.
         :rtype: ~azure.storage.blob.ContainerClient
 
         .. admonition:: Example:
@@ -286,7 +286,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: A dictionary of response headers.
+        :return: A dictionary of response headers.
         :rtype: Dict[str, Union[str, datetime]]
 
         .. admonition:: Example:
@@ -331,7 +331,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: The renamed container.
+        :return: The renamed container.
         :rtype: ~azure.storage.blob.ContainerClient
         """
         lease = kwargs.pop('lease', None)
@@ -385,6 +385,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
+        :return: None
         :rtype: None
 
         .. admonition:: Example:
@@ -451,7 +452,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: A BlobLeaseClient object, that can be run in a context manager.
+        :return: A BlobLeaseClient object, that can be run in a context manager.
         :rtype: ~azure.storage.blob.aio.BlobLeaseClient
 
         .. admonition:: Example:
@@ -476,7 +477,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         The information can also be retrieved if the user has a SAS to a container or blob.
         The keys in the returned dictionary include 'sku_name' and 'account_kind'.
 
-        :returns: A dict of account information (SKU and account type).
+        :return: A dict of account information (SKU and account type).
         :rtype: dict(str, str)
         """
         try:
@@ -536,7 +537,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: boolean
+        :return: boolean
         :rtype: bool
         """
         try:
@@ -578,7 +579,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: Container-updated property dict (Etag and last modified).
+        :return: Container-updated property dict (Etag and last modified).
         :rtype: Dict[str, Union[str, datetime]]
 
         .. admonition:: Example:
@@ -613,7 +614,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
 
         Defaults to current container's credentials.
 
-        :returns: A BlobServiceClient.
+        :return: A BlobServiceClient.
         :rtype: ~azure.storage.blob.BlobServiceClient
 
         .. admonition:: Example:
@@ -656,7 +657,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: Access policy information in a dict.
+        :return: Access policy information in a dict.
         :rtype: dict[str, Any]
 
         .. admonition:: Example:
@@ -723,7 +724,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: Container-updated property dict (Etag and last modified).
+        :return: Container-updated property dict (Etag and last modified).
         :rtype: dict[str, str or ~datetime.datetime]
 
         .. admonition:: Example:
@@ -787,7 +788,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) response of BlobProperties.
+        :return: An iterable (auto-paging) response of BlobProperties.
         :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties]
 
         .. admonition:: Example:
@@ -840,7 +841,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) response of blob names as strings.
+        :return: An iterable (auto-paging) response of blob names as strings.
         :rtype: ~azure.core.async_paging.AsyncItemPaged[str]
         """
         if kwargs.pop('prefix', None):
@@ -873,7 +874,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         include: Optional[Union[List[str], str]] = None,
         delimiter: str = "/",
         **kwargs: Any
-    ) -> AsyncItemPaged[BlobProperties]:
+    ) -> AsyncItemPaged[Union[BlobProperties, BlobPrefix]]:
         """Returns a generator to list the blobs under the specified container.
         The generator will lazily follow the continuation tokens returned by
         the service. This operation will list blobs in accordance with a hierarchy,
@@ -898,8 +899,9 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) response of BlobProperties.
-        :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties]
+        :return: An iterable (auto-paging) response of BlobProperties.
+        :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties or
+            ~azure.storage.blob.aio.BlobPrefix]
         """
         if kwargs.pop('prefix', None):
             raise ValueError("Passing 'prefix' has no effect on filtering, " +
@@ -944,7 +946,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
-        :returns: An iterable (auto-paging) response of FilteredBlob.
+        :return: An iterable (auto-paging) response of FilteredBlob.
         :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
         """
         results_per_page = kwargs.pop('results_per_page', None)
@@ -1071,7 +1073,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             function(current: int, total: Optional[int]) where current is the number of bytes transferred
             so far, and total is the size of the blob or None if the size is unknown.
         :paramtype progress_hook: Callable[[int, Optional[int]], Awaitable[None]]
-        :returns: A BlobClient to interact with the newly uploaded blob.
+        :return: A BlobClient to interact with the newly uploaded blob.
         :rtype: ~azure.storage.blob.aio.BlobClient
 
         .. admonition:: Example:
@@ -1121,7 +1123,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         and retains the blob or snapshot for specified number of days.
         After specified number of days, blob's data is removed from the service during garbage collection.
         Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
-        Soft-deleted blob or snapshot can be restored using :func:`~azure.storage.blob.aio.BlobClient.undelete()`
+        Soft-deleted blob or snapshot can be restored using :func:`~azure.storage.blob.aio.BlobClient.undelete_blob()`
 
         :param str blob: The blob with which to interact.
         :param str delete_snapshots:
@@ -1169,6 +1171,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
+        :return: None
         :rtype: None
         """
         if isinstance(blob, BlobProperties):
@@ -1295,7 +1298,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             the timeout will apply to each call individually.
             multiple calls to the Azure service and the timeout will apply to
             each call individually.
-        :returns: A streaming object. (StorageStreamDownloader)
+        :return: A streaming object. (StorageStreamDownloader)
         :rtype: ~azure.storage.blob.aio.StorageStreamDownloader
         """
         if isinstance(blob, BlobProperties):
@@ -1327,7 +1330,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
         and retains the blobs or snapshots for specified number of days.
         After specified number of days, blobs' data is removed from the service during garbage collection.
         Soft deleted blobs or snapshots are accessible through :func:`list_blobs()` specifying `include=["deleted"]`
-        Soft-deleted blobs or snapshots can be restored using :func:`~azure.storage.blob.aio.BlobClient.undelete()`
+        Soft-deleted blobs or snapshots can be restored using :func:`~azure.storage.blob.aio.BlobClient.undelete_blob()`
 
         The maximum number of blobs that can be deleted in a single request is 256.
 
@@ -1393,7 +1396,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
         :return: An async iterator of responses, one for each blob in order
-        :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse]
+        :rtype: AsyncIterator[~azure.core.pipeline.transport.AsyncHttpResponse]
 
         .. admonition:: Example:
 
@@ -1485,7 +1488,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             is raised even if there is a single operation failure. For optimal performance,
             this should be set to False.
         :return: An async iterator of responses, one for each blob in order
-        :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse]
+        :rtype: AsyncIterator[~azure.core.pipeline.transport.AsyncHttpResponse]
         """
         if self._is_localhost:
             kwargs['url_prepend'] = self.account_name
@@ -1546,7 +1549,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             is raised even if there is a single operation failure. For optimal performance,
             this should be set to False.
         :return: An async iterator of responses, one for each blob in order
-        :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse]
+        :rtype: AsyncIterator[~azure.core.pipeline.transport.AsyncHttpResponse]
         """
         if self._is_localhost:
             kwargs['url_prepend'] = self.account_name
@@ -1577,7 +1580,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, StorageAccountHostsMixin, S
             or the response returned from :func:`~BlobClient.create_snapshot()`.
         :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.
-        :returns: A BlobClient.
+        :return: A BlobClient.
         :rtype: ~azure.storage.blob.aio.BlobClient
 
         .. admonition:: Example:

azure/storage/blob/aio/_download_async.py

@@ -6,7 +6,7 @@
 # pylint: disable=invalid-overridden-method
 # mypy: disable-error-code=override
 
-import asyncio
+import asyncio  # pylint: disable=do-not-import-asyncio
 import codecs
 import sys
 import warnings
@@ -46,8 +46,10 @@ T = TypeVar('T', bytes, str)
 async def process_content(data: Any, start_offset: int, end_offset: int, encryption: Dict[str, Any]) -> bytes:
     if data is None:
         raise ValueError("Response cannot be None.")
-    await data.response.load_body()
-    content = cast(bytes, data.response.body())
+    if hasattr(data.response, "is_stream_consumed") and data.response.is_stream_consumed:
+        content = data.response.content
+    else:
+        content = b"".join([d async for d in data])
     if encryption.get('key') is not None or encryption.get('resolver') is not None:
         try:
             return decrypt_blob(
@@ -57,12 +59,14 @@ async def process_content(data: Any, start_offset: int, end_offset: int, encrypt
                 content,
                 start_offset,
                 end_offset,
-                data.response.headers)
+                data.response.headers
+            )
         except Exception as error:
             raise HttpResponseError(
                 message="Decryption failed.",
                 response=data.response,
-                error=error) from error
+                error=error
+            ) from error
     return content
 
 
@@ -449,7 +453,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
 
         NOTE: If the stream has been partially read, some data may be re-downloaded by the iterator.
 
-        :returns: An async iterator of the chunks in the download stream.
+        :return: An async iterator of the chunks in the download stream.
         :rtype: AsyncIterator[bytes]
 
         .. admonition:: Example:
@@ -523,7 +527,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
             The number of chars to download from the stream. Leave unspecified
             or set negative to download all chars. Note, this can only be used
             when encoding is specified on `download_blob`.
-        :returns:
+        :return:
             The requested data as bytes or a string if encoding was specified. If
             the return value is empty, there is no more data to read.
         :rtype: T
@@ -676,7 +680,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
         Read the entire contents of this blob.
         This operation is blocking until all data is downloaded.
 
-        :returns: The requested data as bytes or a string if encoding was specified.
+        :return: The requested data as bytes or a string if encoding was specified.
         :rtype: T
         """
         return await self.read()
@@ -688,7 +692,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
             The stream to download to. This can be an open file-handle,
             or any writable stream. The stream must be seekable if the download
             uses more than one parallel connection.
-        :returns: The number of bytes read.
+        :return: The number of bytes read.
         :rtype: int
         """
         if self._text_mode:
@@ -805,7 +809,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
 
         :param int max_concurrency:
             The number of parallel connections with which to download.
-        :returns: The contents of the file as bytes.
+        :return: The contents of the file as bytes.
         :rtype: bytes
         """
         warnings.warn(
@@ -830,7 +834,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
             The number of parallel connections with which to download.
         :param str encoding:
             Test encoding to decode the downloaded bytes. Default is UTF-8.
-        :returns: The content of the file as a str.
+        :return: The content of the file as a str.
         :rtype: str
         """
         warnings.warn(
@@ -856,7 +860,7 @@ class StorageStreamDownloader(Generic[T]):  # pylint: disable=too-many-instance-
             uses more than one parallel connection.
         :param int max_concurrency:
             The number of parallel connections with which to download.
-        :returns: The properties of the downloaded blob.
+        :return: The properties of the downloaded blob.
         :rtype: Any
         """
         warnings.warn(

azure/storage/blob/aio/_lease_async.py

@@ -107,6 +107,7 @@ class BlobLeaseClient(): # pylint: disable=client-accepts-api-version-keyword
             This value is not tracked or validated on the client. To configure client-side network timesouts
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
             #other-client--per-operation-configuration>`__.
+        :return: None
         :rtype: None
         """
         mod_conditions = get_modify_conditions(kwargs)

azure/storage/blob/aio/_quick_query_helper_async.py

@@ -0,0 +1,194 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+from io import BytesIO
+from typing import (
+    Any, AsyncGenerator, AsyncIterable, Dict, IO, Optional, Type,
+    TYPE_CHECKING
+)
+
+from .._shared.avro.avro_io_async import AsyncDatumReader
+from .._shared.avro.datafile_async import AsyncDataFileReader
+
+if TYPE_CHECKING:
+    from .._models import BlobQueryError
+
+
+class BlobQueryReader:  # pylint: disable=too-many-instance-attributes
+    """A streaming object to read query results."""
+
+    name: str
+    """The name of the blob being queried."""
+    container: str
+    """The name of the container where the blob is."""
+    response_headers: Dict[str, Any]
+    """The response headers of the quick query request."""
+    record_delimiter: str
+    """The delimiter used to separate lines, or records with the data. The `records`
+        method will return these lines via a generator."""
+
+    def __init__(
+        self, name: str = None,  # type: ignore [assignment]
+        container: str = None,  # type: ignore [assignment]
+        errors: Any = None,
+        record_delimiter: str = '\n',
+        encoding: Optional[str] = None,
+        headers: Dict[str, Any] = None,  # type: ignore [assignment]
+        response: Any = None,
+        error_cls: Type["BlobQueryError"] = None,  # type: ignore [assignment]
+    ) -> None:
+        self.name = name
+        self.container = container
+        self.response_headers = headers
+        self.record_delimiter = record_delimiter
+        self._size = 0
+        self._bytes_processed = 0
+        self._errors = errors
+        self._encoding = encoding
+        self._parsed_results = AsyncDataFileReader(QuickQueryStreamer(response), AsyncDatumReader())
+        self._error_cls = error_cls
+
+    async def _setup(self):
+        self._parsed_results = await self._parsed_results.init()
+        first_result = await self._parsed_results.__anext__()
+        self._first_result = self._process_record(first_result)  # pylint: disable=attribute-defined-outside-init
+
+    def __len__(self) -> int:
+        return self._size
+
+    def _process_record(self, result: Dict[str, Any]) -> Optional[bytes]:
+        self._size = result.get('totalBytes', self._size)
+        self._bytes_processed = result.get('bytesScanned', self._bytes_processed)
+        if 'data' in result:
+            return result.get('data')
+        if 'fatal' in result:
+            error = self._error_cls(
+                error=result['name'],
+                is_fatal=result['fatal'],
+                description=result['description'],
+                position=result['position']
+            )
+            if self._errors:
+                self._errors(error)
+        return None
+
+    async def _aiter_stream(self) -> AsyncGenerator[bytes, None]:
+        if self._first_result is not None:
+            yield self._first_result
+        async for next_result in self._parsed_results:
+            processed_result = self._process_record(next_result)
+            if processed_result is not None:
+                yield processed_result
+
+    async def readall(self) -> bytes:
+        """Return all query results.
+
+        This operation is blocking until all data is downloaded.
+
+        :return: The query results.
+        :rtype: bytes
+        """
+        stream = BytesIO()
+        await self.readinto(stream)
+        data = stream.getvalue()
+        if self._encoding:
+            return data.decode(self._encoding)  # type: ignore [return-value]
+        return data
+
+    async def readinto(self, stream: IO) -> None:
+        """Download the query result to a stream.
+
+        :param IO stream:
+            The stream to download to. This can be an open file-handle,
+            or any writable stream.
+        :return: None
+        """
+        async for record in self._aiter_stream():
+            stream.write(record)
+
+    async def records(self) -> AsyncIterable[bytes]:
+        """Returns a record generator for the query result.
+
+        Records will be returned line by line.
+
+        :return: A record generator for the query result.
+        :rtype: AsyncIterable[bytes]
+        """
+        delimiter = self.record_delimiter.encode('utf-8')
+        async for record_chunk in self._aiter_stream():
+            for record in record_chunk.split(delimiter):
+                if self._encoding:
+                    yield record.decode(self._encoding)  # type: ignore [misc]
+                else:
+                    yield record
+
+
+class QuickQueryStreamer:
+    """File-like streaming iterator."""
+
+    def __init__(self, generator):
+        self.generator = generator
+        self.iterator = generator.__aiter__()
+        self._buf = b""
+        self._point = 0
+        self._download_offset = 0
+        self._buf_start = 0
+        self.file_length = None
+
+    def __len__(self):
+        return self.file_length
+
+    def __aiter__(self):
+        return self.iterator
+
+    @staticmethod
+    def seekable():
+        return True
+
+    async def __anext__(self):
+        next_part = await self.iterator.__anext__()
+        self._download_offset += len(next_part)
+        return next_part
+
+    def tell(self):
+        return self._point
+
+    async def seek(self, offset, whence=0):
+        if whence == 0:
+            self._point = offset
+        elif whence == 1:
+            self._point += offset
+        else:
+            raise ValueError("whence must be 0 or 1")
+        if self._point < 0:  # pylint: disable=consider-using-max-builtin
+            self._point = 0
+
+    async def read(self, size):
+        try:
+            # keep reading from the generator until the buffer of this stream has enough data to read
+            while self._point + size > self._download_offset:
+                self._buf += await self.__anext__()
+        except StopAsyncIteration:
+            self.file_length = self._download_offset
+
+        start_point = self._point
+
+        # EOF
+        self._point = min(self._point + size, self._download_offset)
+
+        relative_start = start_point - self._buf_start
+        if relative_start < 0:
+            raise ValueError("Buffer has dumped too much data")
+        relative_end = relative_start + size
+        data = self._buf[relative_start:relative_end]
+
+        # dump the extra data in buffer
+        # buffer start--------------------16bytes----current read position
+        dumped_size = max(relative_end - 16 - relative_start, 0)
+        self._buf_start += dumped_size
+        self._buf = self._buf[dumped_size:]
+
+        return data