azure-storage-blob 12.20.0__py3-none-any.whl → 12.21.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. azure/storage/blob/_blob_client.py +53 -48
  2. azure/storage/blob/_blob_service_client.py +11 -11
  3. azure/storage/blob/_container_client.py +22 -20
  4. azure/storage/blob/_download.py +277 -167
  5. azure/storage/blob/_generated/_azure_blob_storage.py +1 -1
  6. azure/storage/blob/_generated/_configuration.py +2 -2
  7. azure/storage/blob/_generated/_patch.py +2 -0
  8. azure/storage/blob/_generated/_serialization.py +1 -1
  9. azure/storage/blob/_generated/aio/_azure_blob_storage.py +1 -1
  10. azure/storage/blob/_generated/aio/_configuration.py +2 -2
  11. azure/storage/blob/_generated/aio/_patch.py +2 -0
  12. azure/storage/blob/_generated/aio/operations/_append_blob_operations.py +10 -5
  13. azure/storage/blob/_generated/aio/operations/_blob_operations.py +45 -26
  14. azure/storage/blob/_generated/aio/operations/_block_blob_operations.py +12 -7
  15. azure/storage/blob/_generated/aio/operations/_container_operations.py +39 -20
  16. azure/storage/blob/_generated/aio/operations/_page_blob_operations.py +15 -10
  17. azure/storage/blob/_generated/aio/operations/_patch.py +3 -0
  18. azure/storage/blob/_generated/aio/operations/_service_operations.py +28 -10
  19. azure/storage/blob/_generated/models/_patch.py +3 -0
  20. azure/storage/blob/_generated/operations/_append_blob_operations.py +14 -9
  21. azure/storage/blob/_generated/operations/_blob_operations.py +76 -51
  22. azure/storage/blob/_generated/operations/_block_blob_operations.py +18 -13
  23. azure/storage/blob/_generated/operations/_container_operations.py +64 -39
  24. azure/storage/blob/_generated/operations/_page_blob_operations.py +24 -19
  25. azure/storage/blob/_generated/operations/_patch.py +3 -0
  26. azure/storage/blob/_generated/operations/_service_operations.py +43 -19
  27. azure/storage/blob/_generated/py.typed +1 -0
  28. azure/storage/blob/_lease.py +5 -5
  29. azure/storage/blob/_models.py +1 -1
  30. azure/storage/blob/_serialize.py +1 -0
  31. azure/storage/blob/_shared/authentication.py +62 -4
  32. azure/storage/blob/_shared/base_client.py +1 -1
  33. azure/storage/blob/_shared/base_client_async.py +3 -2
  34. azure/storage/blob/_version.py +1 -1
  35. azure/storage/blob/aio/_blob_client_async.py +49 -46
  36. azure/storage/blob/aio/_blob_service_client_async.py +10 -10
  37. azure/storage/blob/aio/_container_client_async.py +22 -19
  38. azure/storage/blob/aio/_download_async.py +317 -209
  39. azure/storage/blob/aio/_lease_async.py +5 -5
  40. {azure_storage_blob-12.20.0.dist-info → azure_storage_blob-12.21.0.dist-info}/METADATA +6 -6
  41. {azure_storage_blob-12.20.0.dist-info → azure_storage_blob-12.21.0.dist-info}/RECORD +44 -43
  42. {azure_storage_blob-12.20.0.dist-info → azure_storage_blob-12.21.0.dist-info}/WHEEL +1 -1
  43. {azure_storage_blob-12.20.0.dist-info → azure_storage_blob-12.21.0.dist-info}/LICENSE +0 -0
  44. {azure_storage_blob-12.20.0.dist-info → azure_storage_blob-12.21.0.dist-info}/top_level.txt +0 -0
@@ -161,7 +161,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
161
161
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
162
162
  This value is not tracked or validated on the client. To configure client-side network timesouts
163
163
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
164
- #other-client--per-operation-configuration>`_.
164
+ #other-client--per-operation-configuration>`__.
165
165
  :returns: A dictionary of response headers.
166
166
  :rtype: Dict[str, Union[str, datetime]]
167
167
 
@@ -207,7 +207,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
207
207
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
208
208
  This value is not tracked or validated on the client. To configure client-side network timesouts
209
209
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
210
- #other-client--per-operation-configuration>`_.
210
+ #other-client--per-operation-configuration>`__.
211
211
  :returns: The renamed container.
212
212
  :rtype: ~azure.storage.blob.ContainerClient
213
213
  """
@@ -263,7 +263,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
263
263
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
264
264
  This value is not tracked or validated on the client. To configure client-side network timesouts
265
265
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
266
- #other-client--per-operation-configuration>`_.
266
+ #other-client--per-operation-configuration>`__.
267
267
  :rtype: None
268
268
 
269
269
  .. admonition:: Example:
@@ -329,7 +329,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
329
329
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
330
330
  This value is not tracked or validated on the client. To configure client-side network timesouts
331
331
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
332
- #other-client--per-operation-configuration>`_.
332
+ #other-client--per-operation-configuration>`__.
333
333
  :returns: A BlobLeaseClient object, that can be run in a context manager.
334
334
  :rtype: ~azure.storage.blob.aio.BlobLeaseClient
335
335
 
@@ -379,7 +379,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
379
379
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
380
380
  This value is not tracked or validated on the client. To configure client-side network timesouts
381
381
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
382
- #other-client--per-operation-configuration>`_.
382
+ #other-client--per-operation-configuration>`__.
383
383
  :return: Properties for the specified container within a container object.
384
384
  :rtype: ~azure.storage.blob.ContainerProperties
385
385
 
@@ -417,7 +417,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
417
417
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
418
418
  This value is not tracked or validated on the client. To configure client-side network timesouts
419
419
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
420
- #other-client--per-operation-configuration>`_.
420
+ #other-client--per-operation-configuration>`__.
421
421
  :returns: boolean
422
422
  :rtype: bool
423
423
  """
@@ -460,7 +460,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
460
460
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
461
461
  This value is not tracked or validated on the client. To configure client-side network timesouts
462
462
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
463
- #other-client--per-operation-configuration>`_.
463
+ #other-client--per-operation-configuration>`__.
464
464
  :returns: Container-updated property dict (Etag and last modified).
465
465
  :rtype: Dict[str, Union[str, datetime]]
466
466
 
@@ -540,7 +540,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
540
540
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
541
541
  This value is not tracked or validated on the client. To configure client-side network timesouts
542
542
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
543
- #other-client--per-operation-configuration>`_.
543
+ #other-client--per-operation-configuration>`__.
544
544
  :returns: Access policy information in a dict.
545
545
  :rtype: dict[str, Any]
546
546
 
@@ -607,7 +607,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
607
607
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
608
608
  This value is not tracked or validated on the client. To configure client-side network timesouts
609
609
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
610
- #other-client--per-operation-configuration>`_.
610
+ #other-client--per-operation-configuration>`__.
611
611
  :returns: Container-updated property dict (Etag and last modified).
612
612
  :rtype: dict[str, str or ~datetime.datetime]
613
613
 
@@ -671,7 +671,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
671
671
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
672
672
  This value is not tracked or validated on the client. To configure client-side network timesouts
673
673
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
674
- #other-client--per-operation-configuration>`_.
674
+ #other-client--per-operation-configuration>`__.
675
675
  :returns: An iterable (auto-paging) response of BlobProperties.
676
676
  :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties]
677
677
 
@@ -723,7 +723,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
723
723
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
724
724
  This value is not tracked or validated on the client. To configure client-side network timesouts
725
725
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
726
- #other-client--per-operation-configuration>`_.
726
+ #other-client--per-operation-configuration>`__.
727
727
  :returns: An iterable (auto-paging) response of blob names as strings.
728
728
  :rtype: ~azure.core.async_paging.AsyncItemPaged[str]
729
729
  """
@@ -780,7 +780,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
780
780
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
781
781
  This value is not tracked or validated on the client. To configure client-side network timesouts
782
782
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
783
- #other-client--per-operation-configuration>`_.
783
+ #other-client--per-operation-configuration>`__.
784
784
  :returns: An iterable (auto-paging) response of BlobProperties.
785
785
  :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.blob.BlobProperties]
786
786
  """
@@ -826,7 +826,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
826
826
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
827
827
  This value is not tracked or validated on the client. To configure client-side network timesouts
828
828
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
829
- #other-client--per-operation-configuration>`_.
829
+ #other-client--per-operation-configuration>`__.
830
830
  :returns: An iterable (auto-paging) response of FilteredBlob.
831
831
  :rtype: ~azure.core.paging.ItemPaged[~azure.storage.blob.BlobProperties]
832
832
  """
@@ -913,7 +913,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
913
913
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
914
914
  This value is not tracked or validated on the client. To configure client-side network timesouts
915
915
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
916
- #other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
916
+ #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
917
917
  the timeout will apply to each call individually.
918
918
  multiple calls to the Azure service and the timeout will apply to
919
919
  each call individually.
@@ -1015,6 +1015,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1015
1015
  value that, when present, specifies the version of the blob to delete.
1016
1016
 
1017
1017
  .. versionadded:: 12.4.0
1018
+
1018
1019
  This keyword argument was introduced in API version '2019-12-12'.
1019
1020
 
1020
1021
  :keyword lease:
@@ -1049,7 +1050,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1049
1050
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1050
1051
  This value is not tracked or validated on the client. To configure client-side network timesouts
1051
1052
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1052
- #other-client--per-operation-configuration>`_.
1053
+ #other-client--per-operation-configuration>`__.
1053
1054
  :rtype: None
1054
1055
  """
1055
1056
  if isinstance(blob, BlobProperties):
@@ -1113,6 +1114,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1113
1114
  value that, when present, specifies the version of the blob to download.
1114
1115
 
1115
1116
  .. versionadded:: 12.4.0
1117
+
1116
1118
  This keyword argument was introduced in API version '2019-12-12'.
1117
1119
 
1118
1120
  :keyword bool validate_content:
@@ -1171,7 +1173,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1171
1173
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1172
1174
  This value is not tracked or validated on the client. To configure client-side network timesouts
1173
1175
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1174
- #other-client--per-operation-configuration>`_. This method may make multiple calls to the service and
1176
+ #other-client--per-operation-configuration>`__. This method may make multiple calls to the service and
1175
1177
  the timeout will apply to each call individually.
1176
1178
  multiple calls to the Azure service and the timeout will apply to
1177
1179
  each call individually.
@@ -1269,7 +1271,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1269
1271
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1270
1272
  This value is not tracked or validated on the client. To configure client-side network timesouts
1271
1273
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1272
- #other-client--per-operation-configuration>`_.
1274
+ #other-client--per-operation-configuration>`__.
1273
1275
  :return: An async iterator of responses, one for each blob in order
1274
1276
  :rtype: asynciterator[~azure.core.pipeline.transport.AsyncHttpResponse]
1275
1277
 
@@ -1321,6 +1323,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1321
1323
 
1322
1324
  .. note::
1323
1325
  When the blob type is dict, here's a list of keys, value rules.
1326
+
1324
1327
  blob name:
1325
1328
  key: 'name', value type: str
1326
1329
  standard blob tier:
@@ -1348,7 +1351,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1348
1351
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1349
1352
  This value is not tracked or validated on the client. To configure client-side network timesouts
1350
1353
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1351
- #other-client--per-operation-configuration>`_.
1354
+ #other-client--per-operation-configuration>`__.
1352
1355
  :keyword bool raise_on_any_failure:
1353
1356
  This is a boolean param which defaults to True. When this is set, an exception
1354
1357
  is raised even if there is a single operation failure. For optimal performance,
@@ -1401,7 +1404,7 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase, Storag
1401
1404
  https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.
1402
1405
  This value is not tracked or validated on the client. To configure client-side network timesouts
1403
1406
  see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob
1404
- #other-client--per-operation-configuration>`_.
1407
+ #other-client--per-operation-configuration>`__.
1405
1408
  :keyword bool raise_on_any_failure:
1406
1409
  This is a boolean param which defaults to True. When this is set, an exception
1407
1410
  is raised even if there is a single operation failure. For optimal performance,