[File]Rest Parity

Author: xiafu-msft

azure-storage-common/azure/storage/common/_deserialization.py

@@ -84,6 +84,13 @@ def _get_download_size(start_range, end_range, resource_size):
     'x-ms-copy-status-description': ('copy', 'status_description', _to_str),
     'x-ms-has-immutability-policy': (None, 'has_immutability_policy', _bool),
     'x-ms-has-legal-hold': (None, 'has_legal_hold', _bool),
+    'x-ms-file-attributes': ('smb_properties', 'ntfs_attributes', _to_str),
+    'x-ms-file-creation-time': ('smb_properties', 'creation_time', parser.parse, True),
+    'x-ms-file-last-write-time': ('smb_properties', 'last_write_time', parser.parse, True),
+    'x-ms-file-change-time': ('smb_properties', 'change_time', parser.parse, True),
+    'x-ms-file-permission-key': ('smb_properties', 'permission_key', _to_str),
+    'x-ms-file-id': ('smb_properties', 'file_id', _to_str),
+    'x-ms-file-parent-id': ('smb_properties', 'parent_id', _to_str),
 }
 
 
@@ -120,7 +127,11 @@ def _parse_properties(response, result_class):
                 setattr(props, info[1], info[2](value))
             else:
                 attr = getattr(props, info[0])
-                setattr(attr, info[1], info[2](value))
+                # if info[3] is True, time zones in parsed strings are ignored and a naive :class:`datetime` object
+                # will be returned.
+                ignoretz = info[3] if len(info) > 3 else False
+                header_value = info[2](value, ignoretz=ignoretz) if info[2] is parser.parse else info[2](value)
+                setattr(attr, info[1], header_value)
 
     if hasattr(props, 'blob_type') and props.blob_type == 'PageBlob' and hasattr(props, 'blob_tier') and props.blob_tier is not None:
         props.blob_tier = _to_upper_str(props.blob_tier)

azure-storage-file/ChangeLog.md

@@ -4,6 +4,9 @@
 
 ## Version XX.XX.XX
 - Added update_range_from_file_url API to writes the bytes from one Azure File endpoint into the specified range of another Azure File endpoint.
+- Added set_directory_properties, create_permission_for_share and get_permission_for_share APIs
+- Added optional parameters(file_permission, smb_properties) for create_file*, create_directory* related APIs and set_file_properties API
+- Updated get_file_properties, get_directory_properties so that the response has SMB related properties
 
 ## Version 2.0.1:
 - Updated dependency on azure-storage-common.

azure-storage-file/azure/storage/file/_deserialization.py

@@ -60,6 +60,24 @@ def _parse_directory(response, name):
     return Directory(name, props, metadata)
 
 
+def _parse_permission_key(response):
+    '''
+    Extracts out file permission key
+    '''
+
+    if response is None or response.headers is None:
+        return None
+    return response.headers.get('x-ms-file-permission-key', None)
+
+
+def _parse_permission(response):
+    '''
+    Extracts out file permission
+    '''
+
+    return response.body
+
+
 def _parse_file(response, name, validate_content=False):
     if response is None:
         return None

azure-storage-file/azure/storage/file/_serialization.py

@@ -3,12 +3,17 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from sys import getsizeof
+
 from azure.storage.common._common_conversion import _str
 from azure.storage.common._error import (
     _validate_not_none,
     _ERROR_START_END_NEEDED_FOR_MD5,
     _ERROR_RANGE_TOO_LARGE_FOR_MD5,
 )
+_ERROR_TOO_MANY_FILE_PERMISSIONS = 'file_permission and file_permission_key should not be set at the same time'
+_FILE_PERMISSION_TOO_LONG = 'Size of file_permission is too large. file_permission should be <=8KB, else' \
+                            'please use file_permission_key'
 
 
 def _get_path(share_name=None, directory_name=None, file_name=None):
@@ -65,3 +70,25 @@ def _validate_and_format_range_headers(request, start_range, end_range, start_ra
             raise ValueError(_ERROR_RANGE_TOO_LARGE_FOR_MD5)
 
         request.headers['x-ms-range-get-content-md5'] = 'true'
+
+
+def _validate_and_return_file_permission(file_permission, file_permission_key, default_permission):
+    # if file_permission and file_permission are both empty, then use the default_permission value as file permission
+    # file_permission size should be <= 8KB, else file permission_key should be used
+    empty_file_permission = file_permission is None or len(file_permission) == 0
+    empty_file_permission_key = file_permission_key is None or len(file_permission_key) == 0
+    file_permission_size_too_big = getsizeof(file_permission) > 8 * 1024
+
+    if file_permission_size_too_big:
+        raise ValueError(_FILE_PERMISSION_TOO_LONG)
+
+    if empty_file_permission:
+        if empty_file_permission_key:
+            return default_permission
+        else:
+            return None
+
+    if empty_file_permission_key:
+        return file_permission
+
+    raise ValueError(_ERROR_TOO_MANY_FILE_PERMISSIONS)