# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import functools
import time
from typing import ( # pylint: disable=unused-import
Optional, Union, Any, Dict, TYPE_CHECKING
)
from azure.core.async_paging import AsyncItemPaged
from azure.core.pipeline import AsyncPipeline
from azure.core.tracing.decorator import distributed_trace
from azure.core.tracing.decorator_async import distributed_trace_async
from .._parser import _get_file_permission, _datetime_to_str
from .._shared.parser import _str
from .._generated.aio import AzureFileStorage
from .._generated.version import VERSION
from .._generated.models import StorageErrorException
from .._shared.base_client_async import AsyncStorageAccountHostsMixin, AsyncTransportWrapper
from .._shared.policies_async import ExponentialRetry
from .._shared.request_handlers import add_metadata_headers
from .._shared.response_handlers import return_response_headers, process_storage_error
from .._deserialize import deserialize_directory_properties
from .._directory_client import ShareDirectoryClient as ShareDirectoryClientBase
from ._file_client_async import ShareFileClient
from ._models import DirectoryPropertiesPaged, HandlesPaged
if TYPE_CHECKING:
from datetime import datetime
from .._models import ShareProperties, DirectoryProperties, ContentSettings, NTFSAttributes
from .._generated.models import HandleItem
[docs]class ShareDirectoryClient(AsyncStorageAccountHostsMixin, ShareDirectoryClientBase):
"""A client to interact with a specific directory, although it may not yet exist.
For operations relating to a specific subdirectory or file in this share, the clients for those
entities can also be retrieved using the :func:`get_subdirectory_client` and :func:`get_file_client` functions.
:param str account_url:
The URI to the storage account. In order to create a client given the full URI to the directory,
use the :func:`from_directory_url` classmethod.
:param share_name:
The name of the share for the directory.
:type share_name: str
:param str directory_path:
The directory path for the directory with which to interact.
If specified, this value will override a directory value specified in the directory URL.
:param str snapshot:
An optional share snapshot on which to operate. This can be the snapshot ID string
or the response returned from :func:`ShareClient.create_snapshot`.
:param credential:
The credential with which to authenticate. This is optional if the
account URL already has a SAS token. The value can be a SAS token string or an account
shared access key.
:keyword str secondary_hostname:
The hostname of the secondary endpoint.
:keyword loop:
The event loop to run the asynchronous tasks.
:keyword int max_range_size: The maximum range size used for a file upload. Defaults to 4*1024*1024.
"""
def __init__( # type: ignore
self, account_url, # type: str
share_name, # type: str
directory_path, # type: str
snapshot=None, # type: Optional[Union[str, Dict[str, Any]]]
credential=None, # type: Optional[Any]
**kwargs # type: Optional[Any]
):
# type: (...) -> None
kwargs['retry_policy'] = kwargs.get('retry_policy') or ExponentialRetry(**kwargs)
loop = kwargs.pop('loop', None)
super(ShareDirectoryClient, self).__init__(
account_url,
share_name=share_name,
directory_path=directory_path,
snapshot=snapshot,
credential=credential,
loop=loop,
**kwargs)
self._client = AzureFileStorage(version=VERSION, url=self.url, pipeline=self._pipeline, loop=loop)
self._loop = loop
[docs] def get_file_client(self, file_name, **kwargs):
# type: (str, Any) -> ShareFileClient
"""Get a client to interact with a specific file.
The file need not already exist.
:param str file_name:
The name of the file.
:returns: A File Client.
:rtype: ~azure.storage.fileshare.ShareFileClient
"""
if self.directory_path:
file_name = self.directory_path.rstrip('/') + "/" + file_name
_pipeline = AsyncPipeline(
transport=AsyncTransportWrapper(self._pipeline._transport), # pylint: disable = protected-access
policies=self._pipeline._impl_policies # pylint: disable = protected-access
)
return ShareFileClient(
self.url, file_path=file_name, share_name=self.share_name, snapshot=self.snapshot,
credential=self.credential, _hosts=self._hosts, _configuration=self._config,
_pipeline=_pipeline, _location_mode=self._location_mode, loop=self._loop, **kwargs)
[docs] def get_subdirectory_client(self, directory_name, **kwargs):
# type: (str, Any) -> ShareDirectoryClient
"""Get a client to interact with a specific subdirectory.
The subdirectory need not already exist.
:param str directory_name:
The name of the subdirectory.
:returns: A Directory Client.
:rtype: ~azure.storage.fileshare.aio.ShareDirectoryClient
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START get_subdirectory_client]
:end-before: [END get_subdirectory_client]
:language: python
:dedent: 16
:caption: Gets the subdirectory client.
"""
directory_path = self.directory_path.rstrip('/') + "/" + directory_name
_pipeline = AsyncPipeline(
transport=AsyncTransportWrapper(self._pipeline._transport), # pylint: disable = protected-access
policies=self._pipeline._impl_policies # pylint: disable = protected-access
)
return ShareDirectoryClient(
self.url, share_name=self.share_name, directory_path=directory_path, snapshot=self.snapshot,
credential=self.credential, _hosts=self._hosts, _configuration=self._config,
_pipeline=_pipeline, _location_mode=self._location_mode, loop=self._loop, **kwargs)
[docs] @distributed_trace_async
async def create_directory(self, **kwargs):
# type: (Any) -> Dict[str, Any]
"""Creates a new directory under the directory referenced by the client.
:keyword dict(str,str) metadata:
Name-value pairs associated with the directory as metadata.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: Directory-updated property dict (Etag and last modified).
:rtype: dict(str, Any)
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START create_directory]
:end-before: [END create_directory]
:language: python
:dedent: 16
:caption: Creates a directory.
"""
metadata = kwargs.pop('metadata', None)
timeout = kwargs.pop('timeout', None)
headers = kwargs.pop('headers', {})
headers.update(add_metadata_headers(metadata)) # type: ignore
try:
return await self._client.directory.create( # type: ignore
timeout=timeout,
cls=return_response_headers,
headers=headers,
**kwargs)
except StorageErrorException as error:
process_storage_error(error)
[docs] @distributed_trace_async
async def delete_directory(self, **kwargs):
# type: (**Any) -> None
"""Marks the directory for deletion. The directory is
later deleted during garbage collection.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: None
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START delete_directory]
:end-before: [END delete_directory]
:language: python
:dedent: 16
:caption: Deletes a directory.
"""
timeout = kwargs.pop('timeout', None)
try:
await self._client.directory.delete(timeout=timeout, **kwargs)
except StorageErrorException as error:
process_storage_error(error)
[docs] @distributed_trace
def list_directories_and_files(self, name_starts_with=None, **kwargs):
# type: (Optional[str], Any) -> AsyncItemPaged
"""Lists all the directories and files under the directory.
:param str name_starts_with:
Filters the results to return only entities whose names
begin with the specified prefix.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: An auto-paging iterable of dict-like DirectoryProperties and FileProperties
:rtype: ~azure.core.async_paging.AsyncItemPaged[DirectoryProperties and FileProperties]
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START lists_directory]
:end-before: [END lists_directory]
:language: python
:dedent: 16
:caption: List directories and files.
"""
timeout = kwargs.pop('timeout', None)
results_per_page = kwargs.pop('results_per_page', None)
command = functools.partial(
self._client.directory.list_files_and_directories_segment,
sharesnapshot=self.snapshot,
timeout=timeout,
**kwargs)
return AsyncItemPaged(
command, prefix=name_starts_with, results_per_page=results_per_page,
page_iterator_class=DirectoryPropertiesPaged)
[docs] @distributed_trace
def list_handles(self, recursive=False, **kwargs):
# type: (bool, Any) -> AsyncItemPaged
"""Lists opened handles on a directory or a file under the directory.
:param bool recursive:
Boolean that specifies if operation should apply to the directory specified by the client,
its files, its subdirectories and their files. Default value is False.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: An auto-paging iterable of HandleItem
:rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.storage.fileshare.HandleItem]
"""
timeout = kwargs.pop('timeout', None)
results_per_page = kwargs.pop('results_per_page', None)
command = functools.partial(
self._client.directory.list_handles,
sharesnapshot=self.snapshot,
timeout=timeout,
recursive=recursive,
**kwargs)
return AsyncItemPaged(
command, results_per_page=results_per_page,
page_iterator_class=HandlesPaged)
[docs] @distributed_trace_async
async def close_handle(self, handle, **kwargs):
# type: (Union[str, HandleItem], Any) -> int
"""Close an open file handle.
:param handle:
A specific handle to close.
:type handle: str or ~azure.storage.fileshare.Handle
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns:
The total number of handles closed. This could be 0 if the supplied
handle was not found.
:rtype: int
"""
try:
handle_id = handle.id # type: ignore
except AttributeError:
handle_id = handle
if handle_id == '*':
raise ValueError("Handle ID '*' is not supported. Use 'close_all_handles' instead.")
try:
response = await self._client.directory.force_close_handles(
handle_id,
marker=None,
recursive=None,
sharesnapshot=self.snapshot,
cls=return_response_headers,
**kwargs
)
return response.get('number_of_handles_closed', 0)
except StorageErrorException as error:
process_storage_error(error)
[docs] @distributed_trace_async
async def close_all_handles(self, recursive=False, **kwargs):
# type: (bool, Any) -> int
"""Close any open file handles.
This operation will block until the service has closed all open handles.
:param bool recursive:
Boolean that specifies if operation should apply to the directory specified by the client,
its files, its subdirectories and their files. Default value is False.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: The total number of handles closed.
:rtype: int
"""
timeout = kwargs.pop('timeout', None)
start_time = time.time()
try_close = True
continuation_token = None
total_handles = 0
while try_close:
try:
response = await self._client.directory.force_close_handles(
handle_id='*',
timeout=timeout,
marker=continuation_token,
recursive=recursive,
sharesnapshot=self.snapshot,
cls=return_response_headers,
**kwargs
)
except StorageErrorException as error:
process_storage_error(error)
continuation_token = response.get('marker')
try_close = bool(continuation_token)
total_handles += response.get('number_of_handles_closed', 0)
if timeout:
timeout = max(0, timeout - (time.time() - start_time))
return total_handles
[docs] @distributed_trace_async
async def get_directory_properties(self, **kwargs):
# type: (Any) -> DirectoryProperties
"""Returns all user-defined metadata and system properties for the
specified directory. The data returned does not include the directory's
list of files.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: DirectoryProperties
:rtype: ~azure.storage.fileshare.DirectoryProperties
"""
timeout = kwargs.pop('timeout', None)
try:
response = await self._client.directory.get_properties(
timeout=timeout,
cls=deserialize_directory_properties,
**kwargs)
except StorageErrorException as error:
process_storage_error(error)
return response # type: ignore
[docs] @distributed_trace_async
async def create_subdirectory(
self, directory_name, # type: str
**kwargs
):
# type: (...) -> ShareDirectoryClient
"""Creates a new subdirectory and returns a client to interact
with the subdirectory.
:param str directory_name:
The name of the subdirectory.
:keyword dict(str,str) metadata:
Name-value pairs associated with the subdirectory as metadata.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:returns: ShareDirectoryClient
:rtype: ~azure.storage.fileshare.aio.ShareDirectoryClient
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START create_subdirectory]
:end-before: [END create_subdirectory]
:language: python
:dedent: 16
:caption: Create a subdirectory.
"""
metadata = kwargs.pop('metadata', None)
timeout = kwargs.pop('timeout', None)
subdir = self.get_subdirectory_client(directory_name)
await subdir.create_directory(metadata=metadata, timeout=timeout, **kwargs)
return subdir # type: ignore
[docs] @distributed_trace_async
async def delete_subdirectory(
self, directory_name, # type: str
**kwargs
):
# type: (...) -> None
"""Deletes a subdirectory.
:param str directory_name:
The name of the subdirectory.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: None
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START delete_subdirectory]
:end-before: [END delete_subdirectory]
:language: python
:dedent: 16
:caption: Delete a subdirectory.
"""
timeout = kwargs.pop('timeout', None)
subdir = self.get_subdirectory_client(directory_name)
await subdir.delete_directory(timeout=timeout, **kwargs)
[docs] @distributed_trace_async
async def upload_file(
self, file_name, # type: str
data, # type: Any
length=None, # type: Optional[int]
**kwargs # type: Any
):
# type: (...) -> ShareFileClient
"""Creates a new file in the directory and returns a ShareFileClient
to interact with the file.
:param str file_name:
The name of the file.
:param Any data:
Content of the file.
:param int length:
Length of the file in bytes. Specify its maximum size, up to 1 TiB.
:keyword dict(str,str) metadata:
Name-value pairs associated with the file as metadata.
:keyword ~azure.storage.fileshare.ContentSettings content_settings:
ContentSettings object used to set file properties. Used to set content type, encoding,
language, disposition, md5, and cache control.
:keyword bool validate_content:
If true, calculates an MD5 hash for each range of the file. The storage
service checks the hash of the content that has arrived with the hash
that was sent. This is primarily valuable for detecting bitflips on
the wire if using http instead of https as https (the default) will
already validate. Note that this MD5 hash is not stored with the
file.
:keyword int max_concurrency:
Maximum number of parallel connections to use.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:keyword str encoding:
Defaults to UTF-8.
:returns: ShareFileClient
:rtype: ~azure.storage.fileshare.aio.ShareFileClient
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START upload_file_to_directory]
:end-before: [END upload_file_to_directory]
:language: python
:dedent: 16
:caption: Upload a file to a directory.
"""
file_client = self.get_file_client(file_name)
await file_client.upload_file(
data,
length=length,
**kwargs)
return file_client # type: ignore
[docs] @distributed_trace_async
async def delete_file(
self, file_name, # type: str
**kwargs # type: Optional[Any]
):
# type: (...) -> None
"""Marks the specified file for deletion. The file is later
deleted during garbage collection.
:param str file_name:
The name of the file to delete.
:keyword int timeout:
The timeout parameter is expressed in seconds.
:rtype: None
.. admonition:: Example:
.. literalinclude:: ../samples/file_samples_directory_async.py
:start-after: [START delete_file_in_directory]
:end-before: [END delete_file_in_directory]
:language: python
:dedent: 16
:caption: Delete a file in a directory.
"""
file_client = self.get_file_client(file_name)
await file_client.delete_file(**kwargs)