From f43b82fa0d97d6b10915d4405eade7bfe0d22738 Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Fri, 11 Oct 2019 14:20:55 -0700 Subject: [PATCH 1/2] changes file_permission_key param to permission_key --- .../file/aio/directory_client_async.py | 10 +++---- .../storage/file/aio/file_client_async.py | 30 +++++++++---------- .../storage/file/aio/share_client_async.py | 6 ++-- .../azure/storage/file/directory_client.py | 10 +++---- .../azure/storage/file/file_client.py | 30 +++++++++---------- .../azure/storage/file/share_client.py | 6 ++-- .../tests/test_directory.py | 2 +- .../tests/test_directory_async.py | 2 +- 8 files changed, 48 insertions(+), 48 deletions(-) diff --git a/sdk/storage/azure-storage-file/azure/storage/file/aio/directory_client_async.py b/sdk/storage/azure-storage-file/azure/storage/file/aio/directory_client_async.py index 936c64dcce33..524b30ea28d3 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/aio/directory_client_async.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/aio/directory_client_async.py @@ -361,7 +361,7 @@ async def set_http_headers(self, file_attributes="none", # type: Union[str, NTF file_creation_time="preserve", # type: Union[str, datetime] file_last_write_time="preserve", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs): # type: ignore # type: (...) -> Dict[str, Any] @@ -387,21 +387,21 @@ async def set_http_headers(self, file_attributes="none", # type: Union[str, NTF input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ - file_permission = _get_file_permission(file_permission, file_permission_key, 'preserve') + file_permission = _get_file_permission(file_permission, permission_key, 'preserve') try: return await self._client.directory.set_properties( # type: ignore file_attributes=_str(file_attributes), file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, timeout=timeout, cls=return_response_headers, **kwargs) diff --git a/sdk/storage/azure-storage-file/azure/storage/file/aio/file_client_async.py b/sdk/storage/azure-storage-file/azure/storage/file/aio/file_client_async.py index e66050c24ade..c5493ca350d1 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/aio/file_client_async.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/aio/file_client_async.py @@ -63,7 +63,7 @@ async def _upload_file_helper( file_creation_time=file_creation_time, file_last_write_time=file_last_write_time, file_permission=file_permission, - file_permission_key=file_permission_key, + permission_key=file_permission_key, timeout=timeout, **kwargs ) @@ -151,7 +151,7 @@ async def create_file( # type: ignore file_creation_time="now", # type: Union[str, datetime] file_last_write_time="now", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs # type: Any ): @@ -188,10 +188,10 @@ async def create_file( # type: ignore input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -219,7 +219,7 @@ async def create_file( # type: ignore file_content_language=content_settings.content_language, file_content_disposition=content_settings.content_disposition, ) - file_permission = _get_file_permission(file_permission, file_permission_key, 'Inherit') + file_permission = _get_file_permission(file_permission, permission_key, 'Inherit') try: return await self._client.file.create( # type: ignore file_content_length=size, @@ -228,7 +228,7 @@ async def create_file( # type: ignore file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, file_http_headers=file_http_headers, headers=headers, timeout=timeout, @@ -250,7 +250,7 @@ async def upload_file( file_creation_time="now", # type: Union[str, datetime] file_last_write_time="now", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] encoding="UTF-8", # type: str timeout=None, # type: Optional[int] **kwargs # type: Any @@ -299,10 +299,10 @@ async def upload_file( input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -348,7 +348,7 @@ async def upload_file( file_creation_time=file_creation_time, file_last_write_time=file_last_write_time, file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, **kwargs ) @@ -535,7 +535,7 @@ async def set_http_headers(self, content_settings, # type: ContentSettings file_creation_time="preserve", # type: Union[str, datetime] file_last_write_time="preserve", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs # Any ): # type: ignore @@ -564,10 +564,10 @@ async def set_http_headers(self, content_settings, # type: ContentSettings input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -580,7 +580,7 @@ async def set_http_headers(self, content_settings, # type: ContentSettings file_content_language=content_settings.content_language, file_content_disposition=content_settings.content_disposition, ) - file_permission = _get_file_permission(file_permission, file_permission_key, 'preserve') + file_permission = _get_file_permission(file_permission, permission_key, 'preserve') try: return await self._client.file.set_http_headers( # type: ignore file_content_length=file_content_length, @@ -589,7 +589,7 @@ async def set_http_headers(self, content_settings, # type: ContentSettings file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, timeout=timeout, cls=return_response_headers, **kwargs diff --git a/sdk/storage/azure-storage-file/azure/storage/file/aio/share_client_async.py b/sdk/storage/azure-storage-file/azure/storage/file/aio/share_client_async.py index 2d430ab77b60..81738256a9be 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/aio/share_client_async.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/aio/share_client_async.py @@ -491,7 +491,7 @@ async def create_permission_for_share(self, file_permission, # type: str @distributed_trace_async async def get_permission_for_share( # type: ignore - self, file_permission_key, # type: str + self, permission_key, # type: str timeout=None, # type: Optional[int] **kwargs # type: Any ): @@ -500,7 +500,7 @@ async def get_permission_for_share( # type: ignore This 'permission' can be used for the files/directories in the share. - :param str file_permission_key: + :param str permission_key: Key of the file permission to retrieve :param int timeout: The timeout parameter is expressed in seconds. @@ -509,7 +509,7 @@ async def get_permission_for_share( # type: ignore """ try: return await self._client.share.get_permission( # type: ignore - file_permission_key=file_permission_key, + file_permission_key=permission_key, cls=deserialize_permission, timeout=timeout, **kwargs) diff --git a/sdk/storage/azure-storage-file/azure/storage/file/directory_client.py b/sdk/storage/azure-storage-file/azure/storage/file/directory_client.py index 9b94fffe3804..d62fdc178d65 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/directory_client.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/directory_client.py @@ -434,7 +434,7 @@ def set_http_headers(self, file_attributes="none", # type: Union[str, NTFSAttri file_creation_time="preserve", # type: Union[str, datetime] file_last_write_time="preserve", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs): # type: ignore # type: (...) -> Dict[str, Any] @@ -460,21 +460,21 @@ def set_http_headers(self, file_attributes="none", # type: Union[str, NTFSAttri input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ - file_permission = _get_file_permission(file_permission, file_permission_key, 'preserve') + file_permission = _get_file_permission(file_permission, permission_key, 'preserve') try: return self._client.directory.set_properties( # type: ignore file_attributes=_str(file_attributes), file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, timeout=timeout, cls=return_response_headers, **kwargs) diff --git a/sdk/storage/azure-storage-file/azure/storage/file/file_client.py b/sdk/storage/azure-storage-file/azure/storage/file/file_client.py index cf01f9264e37..f09cd06a39cd 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/file_client.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/file_client.py @@ -71,7 +71,7 @@ def _upload_file_helper( file_creation_time=file_creation_time, file_last_write_time=file_last_write_time, file_permission=file_permission, - file_permission_key=file_permission_key, + permission_key=file_permission_key, **kwargs ) if size == 0: @@ -340,7 +340,7 @@ def create_file( # type: ignore file_creation_time="now", # type: Union[str, datetime] file_last_write_time="now", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs # type: Any ): @@ -377,10 +377,10 @@ def create_file( # type: ignore input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -408,7 +408,7 @@ def create_file( # type: ignore file_content_language=content_settings.content_language, file_content_disposition=content_settings.content_disposition ) - file_permission = _get_file_permission(file_permission, file_permission_key, 'Inherit') + file_permission = _get_file_permission(file_permission, permission_key, 'Inherit') try: return self._client.file.create( # type: ignore file_content_length=size, @@ -417,7 +417,7 @@ def create_file( # type: ignore file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, file_http_headers=file_http_headers, headers=headers, timeout=timeout, @@ -438,7 +438,7 @@ def upload_file( file_creation_time="now", # type: Union[str, datetime] file_last_write_time="now", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] encoding="UTF-8", # type: str timeout=None, # type: Optional[int] **kwargs # type: Any @@ -487,10 +487,10 @@ def upload_file( input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) @@ -535,7 +535,7 @@ def upload_file( file_creation_time=file_creation_time, file_last_write_time=file_last_write_time, file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, **kwargs) @distributed_trace @@ -723,7 +723,7 @@ def set_http_headers(self, content_settings, # type: ContentSettings file_creation_time="preserve", # type: Union[str, datetime] file_last_write_time="preserve", # type: Union[str, datetime] file_permission=None, # type: Optional[str] - file_permission_key=None, # type: Optional[str] + permission_key=None, # type: Optional[str] timeout=None, # type: Optional[int] **kwargs # Any ): # type: ignore @@ -752,10 +752,10 @@ def set_http_headers(self, content_settings, # type: ContentSettings input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. :type file_permission: str - :param file_permission_key: Key of the permission to be set for the + :param permission_key: Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. - :type file_permission_key: str + :type permission_key: str :returns: File-updated property dict (Etag and last modified). :rtype: dict(str, Any) """ @@ -768,7 +768,7 @@ def set_http_headers(self, content_settings, # type: ContentSettings file_content_language=content_settings.content_language, file_content_disposition=content_settings.content_disposition ) - file_permission = _get_file_permission(file_permission, file_permission_key, 'preserve') + file_permission = _get_file_permission(file_permission, permission_key, 'preserve') try: return self._client.file.set_http_headers( # type: ignore file_content_length=file_content_length, @@ -777,7 +777,7 @@ def set_http_headers(self, content_settings, # type: ContentSettings file_creation_time=_datetime_to_str(file_creation_time), file_last_write_time=_datetime_to_str(file_last_write_time), file_permission=file_permission, - file_permission_key=file_permission_key, + file_permission_key=permission_key, timeout=timeout, cls=return_response_headers, **kwargs) diff --git a/sdk/storage/azure-storage-file/azure/storage/file/share_client.py b/sdk/storage/azure-storage-file/azure/storage/file/share_client.py index 2f5636dc334c..70fcf2294827 100644 --- a/sdk/storage/azure-storage-file/azure/storage/file/share_client.py +++ b/sdk/storage/azure-storage-file/azure/storage/file/share_client.py @@ -671,7 +671,7 @@ def create_permission_for_share(self, file_permission, # type: str @distributed_trace def get_permission_for_share( # type: ignore - self, file_permission_key, # type: str + self, permission_key, # type: str timeout=None, # type: Optional[int] **kwargs # type: Any ): @@ -680,7 +680,7 @@ def get_permission_for_share( # type: ignore This 'permission' can be used for the files/directories in the share. - :param str file_permission_key: + :param str permission_key: Key of the file permission to retrieve :param int timeout: The timeout parameter is expressed in seconds. @@ -689,7 +689,7 @@ def get_permission_for_share( # type: ignore """ try: return self._client.share.get_permission( # type: ignore - file_permission_key=file_permission_key, + file_permission_key=permission_key, cls=deserialize_permission, timeout=timeout, **kwargs) diff --git a/sdk/storage/azure-storage-file/tests/test_directory.py b/sdk/storage/azure-storage-file/tests/test_directory.py index c30535e452c9..30cce6b9401c 100644 --- a/sdk/storage/azure-storage-file/tests/test_directory.py +++ b/sdk/storage/azure-storage-file/tests/test_directory.py @@ -348,7 +348,7 @@ def test_set_directory_properties_with_file_permission_key(self): # Act directory_client.set_http_headers(file_attributes='None', file_creation_time=new_creation_time, file_last_write_time=new_last_write_time, - file_permission_key=permission_key) + permission_key=permission_key) directory_properties = directory_client.get_directory_properties() # Assert diff --git a/sdk/storage/azure-storage-file/tests/test_directory_async.py b/sdk/storage/azure-storage-file/tests/test_directory_async.py index fe6a08cbca84..8d7a778e6f50 100644 --- a/sdk/storage/azure-storage-file/tests/test_directory_async.py +++ b/sdk/storage/azure-storage-file/tests/test_directory_async.py @@ -461,7 +461,7 @@ async def _test_set_directory_properties_with_file_permission_key(self): # Act await directory_client.set_http_headers(file_attributes='None', file_creation_time=new_creation_time, file_last_write_time=new_last_write_time, - file_permission_key=permission_key) + permission_key=permission_key) directory_properties = await directory_client.get_directory_properties() # Assert From 51ce200ef7319d6ecf703ef298a29dc81c39f6ba Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Fri, 11 Oct 2019 15:54:49 -0700 Subject: [PATCH 2/2] update history --- sdk/storage/azure-storage-file/HISTORY.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sdk/storage/azure-storage-file/HISTORY.md b/sdk/storage/azure-storage-file/HISTORY.md index f6c58c60b66b..de1a2530d27f 100644 --- a/sdk/storage/azure-storage-file/HISTORY.md +++ b/sdk/storage/azure-storage-file/HISTORY.md @@ -1,5 +1,11 @@ # Change Log azure-storage-file +## Version 12.0.0: + +**Breaking changes** + +- `file_permission_key` parameter has been renamed to `permission_key` + ## Version 12.0.0b4: **Breaking changes**