Merge pull request #318 from jofriedm-msft/dev

Return etag and lmt for create_from_*

Author: zezha-msft

ChangeLog.md

@@ -2,6 +2,11 @@
 
 > See [BreakingChanges](BreakingChanges.md) for a detailed list of API breaks.
 
+## Version X.X.X:
+
+### Blob:
+- create_from_* and and append_blob_from_* methods will return response_properties which contains the etag and last modified time.
+
 ## Version 0.34.3:
 - All: Made the socket timeout configurable. Increased the default socket timeout to 20 seconds.
 - All: Fixed a bug where SAS tokens were being duplicated on retries

azure/storage/blob/_upload_chunking.py

@@ -15,6 +15,7 @@
 import sys
 from threading import Lock
 from time import sleep
+
 from cryptography.hazmat.primitives.padding import PKCS7
 from .._common_conversion import _encode_base64
 from .._serialization import (
@@ -37,7 +38,7 @@ def _upload_blob_chunks(blob_service, container_name, blob_name,
                         blob_size, block_size, stream, max_connections,
                         progress_callback, validate_content, lease_id, uploader_class, 
                         maxsize_condition=None, if_match=None, timeout=None,
-                        content_encryption_key=None, initialization_vector=None):
+                        content_encryption_key=None, initialization_vector=None, resource_properties=None):
 
     encryptor, padder = _get_blob_encryptor_and_padder(content_encryption_key, initialization_vector,
                                                        uploader_class is not _PageBlobChunkUploader)
@@ -104,6 +105,10 @@ def _upload_blob_chunks(blob_service, container_name, blob_name,
     else:
         range_ids = [uploader.process_chunk(result) for result in uploader.get_chunk_streams()]
 
+    if resource_properties:
+        resource_properties.last_modified = uploader.last_modified
+        resource_properties.etag = uploader.etag
+
     return range_ids
 
 def _upload_blob_substream_blocks(blob_service, container_name, blob_name,
@@ -249,6 +254,10 @@ def _upload_substream_block_with_progress(self, block_id, block_stream):
         self._update_progress(len(block_stream))
         return range_id
 
+    def set_response_properties(self, resp):
+        self.etag = resp.etag
+        self.last_modified = resp.last_modified
+
 class _BlockBlobChunkUploader(_BlobChunkUploader):
     def _upload_chunk(self, chunk_offset, chunk_data):
         block_id = url_quote(_encode_base64('{0:032d}'.format(chunk_offset)))
@@ -297,6 +306,8 @@ def _upload_chunk(self, chunk_start, chunk_data):
         if not self.parallel:
             self.if_match = resp.etag
 
+        self.set_response_properties(resp)
+
 class _AppendBlobChunkUploader(_BlobChunkUploader):
     def _upload_chunk(self, chunk_offset, chunk_data):
         if not hasattr(self, 'current_length'):
@@ -323,6 +334,8 @@ def _upload_chunk(self, chunk_offset, chunk_data):
                 timeout=self.timeout,
             )
 
+        self.set_response_properties(resp)
+
 class _SubStream(IOBase):
     def __init__(self, wrapped_stream, stream_begin_index, length, lockObj):
         # Python 2.7: file-like objects created with open() typically support seek(), but are not

azure/storage/blob/appendblobservice.py

@@ -33,7 +33,10 @@
     _AppendBlobChunkUploader,
     _upload_blob_chunks,
 )
-from .models import _BlobTypes
+from .models import (
+    _BlobTypes,
+    ResourceProperties
+)
 from .._constants import (
     SERVICE_HOST_BASE,
     DEFAULT_PROTOCOL,
@@ -325,6 +328,8 @@ def append_blob_from_path(
             The timeout parameter is expressed in seconds. This method may make 
             multiple calls to the Azure service and the timeout will apply to 
             each call individually.
+        :return: ETag and last modified properties for the Append Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -333,16 +338,16 @@ def append_blob_from_path(
 
         count = path.getsize(file_path)
         with open(file_path, 'rb') as stream:
-            self.append_blob_from_stream(
-                container_name,
-                blob_name,
-                stream,
-                count=count,
-                validate_content=validate_content,
-                maxsize_condition=maxsize_condition,
-                progress_callback=progress_callback,
-                lease_id=lease_id,
-                timeout=timeout)
+            return self.append_blob_from_stream(
+                    container_name,
+                    blob_name,
+                    stream,
+                    count=count,
+                    validate_content=validate_content,
+                    maxsize_condition=maxsize_condition,
+                    progress_callback=progress_callback,
+                    lease_id=lease_id,
+                    timeout=timeout)
 
     def append_blob_from_bytes(
         self, container_name, blob_name, blob, index=0, count=None,
@@ -387,6 +392,8 @@ def append_blob_from_bytes(
             The timeout parameter is expressed in seconds. This method may make 
             multiple calls to the Azure service and the timeout will apply to 
             each call individually.
+        :return: ETag and last modified properties for the Append Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -404,16 +411,16 @@ def append_blob_from_bytes(
         stream = BytesIO(blob)
         stream.seek(index)
 
-        self.append_blob_from_stream(
-            container_name,
-            blob_name,
-            stream,
-            count=count,
-            validate_content=validate_content,
-            maxsize_condition=maxsize_condition,
-            lease_id=lease_id,
-            progress_callback=progress_callback,
-            timeout=timeout)
+        return self.append_blob_from_stream(
+                container_name,
+                blob_name,
+                stream,
+                count=count,
+                validate_content=validate_content,
+                maxsize_condition=maxsize_condition,
+                lease_id=lease_id,
+                progress_callback=progress_callback,
+                timeout=timeout)
 
     def append_blob_from_text(
         self, container_name, blob_name, text, encoding='utf-8',
@@ -455,6 +462,8 @@ def append_blob_from_text(
             The timeout parameter is expressed in seconds. This method may make 
             multiple calls to the Azure service and the timeout will apply to 
             each call individually.
+        :return: ETag and last modified properties for the Append Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -465,17 +474,17 @@ def append_blob_from_text(
             _validate_not_none('encoding', encoding)
             text = text.encode(encoding)
 
-        self.append_blob_from_bytes(
-            container_name,
-            blob_name,
-            text,
-            index=0,
-            count=len(text),
-            validate_content=validate_content,
-            maxsize_condition=maxsize_condition,
-            lease_id=lease_id,
-            progress_callback=progress_callback,
-            timeout=timeout)
+        return self.append_blob_from_bytes(
+                container_name,
+                blob_name,
+                text,
+                index=0,
+                count=len(text),
+                validate_content=validate_content,
+                maxsize_condition=maxsize_condition,
+                lease_id=lease_id,
+                progress_callback=progress_callback,
+                timeout=timeout)
 
     def append_blob_from_stream(
         self, container_name, blob_name, stream, count=None,
@@ -518,12 +527,18 @@ def append_blob_from_stream(
             The timeout parameter is expressed in seconds. This method may make 
             multiple calls to the Azure service and the timeout will apply to 
             each call individually.
+        :return: ETag and last modified properties for the Append Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
         _validate_not_none('stream', stream)
         _validate_encryption_unsupported(self.require_encryption, self.key_encryption_key)
 
+        # _upload_blob_chunks returns the block ids for block blobs so resource_properties
+        # is passed as a parameter to get the last_modified and etag for page and append blobs.
+        # this info is not needed for block_blobs since _put_block_list is called after which gets this info
+        resource_properties = ResourceProperties()
         _upload_blob_chunks(
             blob_service=self,
             container_name=container_name,
@@ -537,5 +552,8 @@ def append_blob_from_stream(
             lease_id=lease_id,
             uploader_class=_AppendBlobChunkUploader,
             maxsize_condition=maxsize_condition,
-            timeout=timeout
-        )
+            timeout=timeout,
+            resource_properties=resource_properties
+        )
+
+        return resource_properties

azure/storage/blob/blockblobservice.py

@@ -384,29 +384,31 @@ def create_blob_from_path(
             The timeout parameter is expressed in seconds. This method may make
             multiple calls to the Azure service and the timeout will apply to
             each call individually.
+        :return: ETag and last modified properties for the Block Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
         _validate_not_none('file_path', file_path)
 
         count = path.getsize(file_path)
         with open(file_path, 'rb') as stream:
-            self.create_blob_from_stream(
-                container_name=container_name,
-                blob_name=blob_name,
-                stream=stream,
-                count=count,
-                content_settings=content_settings,
-                metadata=metadata,
-                validate_content=validate_content,
-                lease_id=lease_id,
-                progress_callback=progress_callback,
-                max_connections=max_connections,
-                if_modified_since=if_modified_since,
-                if_unmodified_since=if_unmodified_since,
-                if_match=if_match,
-                if_none_match=if_none_match,
-                timeout=timeout)
+            return self.create_blob_from_stream(
+                    container_name=container_name,
+                    blob_name=blob_name,
+                    stream=stream,
+                    count=count,
+                    content_settings=content_settings,
+                    metadata=metadata,
+                    validate_content=validate_content,
+                    lease_id=lease_id,
+                    progress_callback=progress_callback,
+                    max_connections=max_connections,
+                    if_modified_since=if_modified_since,
+                    if_unmodified_since=if_unmodified_since,
+                    if_match=if_match,
+                    if_none_match=if_none_match,
+                    timeout=timeout)
 
     def create_blob_from_stream(
         self, container_name, blob_name, stream, count=None,
@@ -492,6 +494,8 @@ def create_blob_from_stream(
             with your input stream.
             The SubStream class will attempt to buffer up to 4 MB internally to reduce the amount of
             seek and read calls to the underlying stream. This is particularly beneficial when uploading larger blocks.
+        :return: ETag and last modified properties for the Block Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -508,7 +512,7 @@ def create_blob_from_stream(
                 progress_callback(0, count)
 
             data = stream.read(count)
-            self._put_blob(
+            resp = self._put_blob(
                 container_name=container_name,
                 blob_name=blob_name,
                 blob=data,
@@ -524,6 +528,8 @@ def create_blob_from_stream(
 
             if progress_callback:
                 progress_callback(count, count)
+
+            return resp
         else:
             cek, iv, encryption_data = None, None, None
 
@@ -568,7 +574,7 @@ def create_blob_from_stream(
                     timeout=timeout,
                 )
 
-            self._put_block_list(
+            return self._put_block_list(
                 container_name=container_name,
                 blob_name=blob_name,
                 block_list=block_ids,
@@ -653,6 +659,8 @@ def create_blob_from_bytes(
             The timeout parameter is expressed in seconds. This method may make
             multiple calls to the Azure service and the timeout will apply to
             each call individually.
+        :return: ETag and last modified properties for the Block Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -669,7 +677,7 @@ def create_blob_from_bytes(
         stream = BytesIO(blob)
         stream.seek(index)
 
-        self.create_blob_from_stream(
+        return self.create_blob_from_stream(
             container_name=container_name,
             blob_name=blob_name,
             stream=stream,
@@ -753,6 +761,8 @@ def create_blob_from_text(
             The timeout parameter is expressed in seconds. This method may make
             multiple calls to the Azure service and the timeout will apply to
             each call individually.
+        :return: ETag and last modified properties for the Block Blob
+        :rtype: :class:`~azure.storage.blob.models.ResourceProperties`
         '''
         _validate_not_none('container_name', container_name)
         _validate_not_none('blob_name', blob_name)
@@ -762,23 +772,23 @@ def create_blob_from_text(
             _validate_not_none('encoding', encoding)
             text = text.encode(encoding)
 
-        self.create_blob_from_bytes(
-            container_name=container_name,
-            blob_name=blob_name,
-            blob=text,
-            index=0,
-            count=len(text),
-            content_settings=content_settings,
-            metadata=metadata,
-            validate_content=validate_content,
-            lease_id=lease_id,
-            progress_callback=progress_callback,
-            max_connections=max_connections,
-            if_modified_since=if_modified_since,
-            if_unmodified_since=if_unmodified_since,
-            if_match=if_match,
-            if_none_match=if_none_match,
-            timeout=timeout)
+        return self.create_blob_from_bytes(
+                container_name=container_name,
+                blob_name=blob_name,
+                blob=text,
+                index=0,
+                count=len(text),
+                content_settings=content_settings,
+                metadata=metadata,
+                validate_content=validate_content,
+                lease_id=lease_id,
+                progress_callback=progress_callback,
+                max_connections=max_connections,
+                if_modified_since=if_modified_since,
+                if_unmodified_since=if_unmodified_since,
+                if_match=if_match,
+                if_none_match=if_none_match,
+                timeout=timeout)
 
     #-----Helper methods------------------------------------
     def _put_blob(self, container_name, blob_name, blob, content_settings=None,