azure-storage-blob 12.18.0__tar.gz → 12.18.2__tar.gz

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+## 12.18.2 (2023-09-25)
+
+### Bugs Fixed
+- Fixed an issue where `user_agent` was being ignored on `upload_blob` or `download_blob` if client was configured
+for encryption.
+
+## 12.18.1 (2023-09-13)
+
+### Bugs Fixed
+- Fixed breaking `KeyError: 'sdk_moniker'` in `create_configuration`.
+NOTE: This is not an exported method and therefore should not be imported/called directly.
+
 ## 12.18.0 (2023-09-12)
 
 ### Features Added

{azure-storage-blob-12.18.0/azure_storage_blob.egg-info → azure-storage-blob-12.18.2}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: azure-storage-blob
-Version: 12.18.0
+Version: 12.18.2
 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
 Author-email: ascl@microsoft.com
 License: MIT License
 Keywords: azure,azure sdk
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/azure/storage/blob/_blob_client.py

@@ -1005,7 +1005,8 @@ class BlobClient(StorageAccountHostsMixin, StorageEncryptionMixin):  # pylint: d
         This operations returns a BlobQueryReader, users need to use readall() or readinto() to get query data.
 
         :param str query_expression:
-            Required. a query statement.
+            Required. a query statement. For more details see
+            https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.
         :keyword Callable[~azure.storage.blob.BlobQueryError] on_error:
             A function to be called on any processing errors returned by the service.
         :keyword blob_format:

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/azure/storage/blob/_encryption.py

@@ -286,13 +286,23 @@ def modify_user_agent_for_encryption(
     :param str encryption_version: The version of encryption being used.
     :param Dict[str, Any] request_options: The reuqest options to add the user agent override to.
     """
+    # If the user has specified user_agent_overwrite=True, don't make any modifications
+    if request_options.get('user_agent_overwrite'):
+        return
+
+    # If the feature flag is already present, don't add it again
     feature_flag = f"azstorage-clientsideencryption/{encryption_version}"
-    if feature_flag not in user_agent:
-        index = user_agent.find(f"azsdk-python-{moniker}")
-        user_agent = f"{user_agent[:index]}{feature_flag} {user_agent[index:]}"
+    if feature_flag in user_agent:
+        return
+
+    index = user_agent.find(f"azsdk-python-{moniker}")
+    user_agent = f"{user_agent[:index]}{feature_flag} {user_agent[index:]}"
+    # Since we are using user_agent_overwrite=True, we must prepend the user's user_agent if there is one
+    if request_options.get('user_agent'):
+        user_agent = f"{request_options.get('user_agent')} {user_agent}"
 
-        request_options['user_agent'] = user_agent
-        request_options['user_agent_overwrite'] = True
+    request_options['user_agent'] = user_agent
+    request_options['user_agent_overwrite'] = True
 
 
 def get_adjusted_upload_size(length: int, encryption_version: str) -> int:

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/azure/storage/blob/_shared/base_client.py

@@ -410,9 +410,12 @@ def parse_connection_str(conn_str, credential, service):
 
 def create_configuration(**kwargs):
     # type: (**Any) -> Configuration
+    # Backwards compatibility if someone is not passing sdk_moniker
+    if not kwargs.get("sdk_moniker"):
+        kwargs["sdk_moniker"] = f"storage-{kwargs.pop('storage_sdk')}/{VERSION}"
     config = Configuration(**kwargs)
     config.headers_policy = StorageHeadersPolicy(**kwargs)
-    config.user_agent_policy = UserAgentPolicy(sdk_moniker=kwargs.pop('sdk_moniker'), **kwargs)
+    config.user_agent_policy = UserAgentPolicy(**kwargs)
     config.retry_policy = kwargs.get("retry_policy") or ExponentialRetry(**kwargs)
     config.logging_policy = StorageLoggingPolicy(**kwargs)
     config.proxy_policy = ProxyPolicy(**kwargs)

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/azure/storage/blob/_version.py

@@ -4,4 +4,4 @@
 # license information.
 # --------------------------------------------------------------------------
 
-VERSION = "12.18.0"
+VERSION = "12.18.2"

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2/azure_storage_blob.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: azure-storage-blob
-Version: 12.18.0
+Version: 12.18.2
 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
 Author-email: ascl@microsoft.com
 License: MIT License
 Keywords: azure,azure sdk
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/setup.py

@@ -56,7 +56,7 @@ setup(
     url='https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-blob',
     keywords="azure, azure sdk",
     classifiers=[
-        'Development Status :: 5 - Production/Stable',
+        'Development Status :: 4 - Beta',
         'Programming Language :: Python',
         'Programming Language :: Python :: 3 :: Only',
         'Programming Language :: Python :: 3',

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/tests/test_blob_client.py

@@ -9,7 +9,6 @@ from datetime import datetime, timedelta
 
 import pytest
 from azure.core.credentials import AzureSasCredential
-from azure.core.exceptions import AzureError
 from azure.storage.blob import (
     AccountSasPermissions,
     BlobClient,
@@ -19,6 +18,7 @@ from azure.storage.blob import (
     ResourceTypes,
     VERSION,
 )
+from azure.storage.blob._shared.base_client import create_configuration
 
 from devtools_testutils import recorded_by_proxy
 from devtools_testutils.storage import StorageRecordedTestCase
@@ -718,4 +718,17 @@ class TestStorageClient(StorageRecordedTestCase):
                 self.account_url(storage_account_name, "blob"), credential=storage_account_key, container_name='foo', blob_name='bar')
             service.close()
 
+    @BlobPreparer()
+    def test_create_configuration_legacy(self, **kwargs):
+        # Arrange
+        sdk_name = 'Blob-test'
+
+        # Act
+        config = create_configuration(storage_sdk=sdk_name)
+
+        # Assert
+        assert config is not None
+        assert config.max_block_size == 4 * 1024 * 1024
+        assert sdk_name in config.user_agent_policy.user_agent
+
 # ------------------------------------------------------------------------------

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/tests/test_blob_encryption_v2.py

@@ -1066,9 +1066,23 @@ class TestStorageBlobEncryptionV2(StorageRecordedTestCase):
         storage_account_key = kwargs.pop("storage_account_key")
 
         self._setup(storage_account_name, storage_account_key)
+        kek = KeyWrapper('key1')
+        self.enable_encryption_v2(kek)
 
         app_id = 'TestAppId'
-        kek = KeyWrapper('key1')
+        content = b'Hello World Encrypted!'
+
+        def assert_user_agent(request):
+            start = f'{app_id} azstorage-clientsideencryption/2.0 '
+            assert request.http_request.headers['User-Agent'].startswith(start)
+
+        # Test method level keyword
+        blob = self.bsc.get_blob_client(self.container_name, self._get_blob_reference())
+
+        blob.upload_blob(content, overwrite=True, raw_request_hook=assert_user_agent, user_agent=app_id)
+        blob.download_blob(raw_request_hook=assert_user_agent, user_agent=app_id).readall()
+
+        # Test client constructor level keyword
         bsc = BlobServiceClient(
             self.bsc.url,
             credential=storage_account_key,
@@ -1077,13 +1091,7 @@ class TestStorageBlobEncryptionV2(StorageRecordedTestCase):
             key_encryption_key=kek,
             user_agent=app_id)
 
-        def assert_user_agent(request):
-            start = f'{app_id} azstorage-clientsideencryption/2.0 '
-            assert request.http_request.headers['User-Agent'].startswith(start)
-
         blob = bsc.get_blob_client(self.container_name, self._get_blob_reference())
-        content = b'Hello World Encrypted!'
 
-        # Act
         blob.upload_blob(content, overwrite=True, raw_request_hook=assert_user_agent)
         blob.download_blob(raw_request_hook=assert_user_agent).readall()

{azure-storage-blob-12.18.0 → azure-storage-blob-12.18.2}/tests/test_blob_encryption_v2_async.py

@@ -1067,9 +1067,24 @@ class TestStorageBlobEncryptionV2Async(AsyncStorageRecordedTestCase):
         storage_account_key = kwargs.pop("storage_account_key")
 
         await self._setup(storage_account_name, storage_account_key)
+        kek = KeyWrapper('key1')
+        self.enable_encryption_v2(kek)
 
         app_id = 'TestAppId'
-        kek = KeyWrapper('key1')
+        content = b'Hello World Encrypted!'
+
+        def assert_user_agent(request):
+            start = f'{app_id} azstorage-clientsideencryption/2.0 '
+            assert request.http_request.headers['User-Agent'].startswith(start)
+
+        # Test method level keyword
+        blob = self.bsc.get_blob_client(self.container_name, self._get_blob_reference())
+
+        with mock.patch('os.urandom', mock_urandom):
+            await blob.upload_blob(content, overwrite=True, raw_request_hook=assert_user_agent, user_agent=app_id)
+        await (await blob.download_blob(raw_request_hook=assert_user_agent, user_agent=app_id)).readall()
+
+        # Test client constructor level keyword
         bsc = BlobServiceClient(
             self.bsc.url,
             credential=storage_account_key,
@@ -1078,14 +1093,8 @@ class TestStorageBlobEncryptionV2Async(AsyncStorageRecordedTestCase):
             key_encryption_key=kek,
             user_agent=app_id)
 
-        def assert_user_agent(request):
-            start = f'{app_id} azstorage-clientsideencryption/2.0 '
-            assert request.http_request.headers['User-Agent'].startswith(start)
-
         blob = bsc.get_blob_client(self.container_name, self._get_blob_reference())
-        content = b'Hello World Encrypted!'
 
-        # Act
         with mock.patch('os.urandom', mock_urandom):
             await blob.upload_blob(content, overwrite=True, raw_request_hook=assert_user_agent)
         await (await blob.download_blob(raw_request_hook=assert_user_agent)).readall()