API Reference (for Developer)¶

AzfsClient¶

class azfs.clients.AzfsClient(credential, connection_string)¶

Abstract Client for AzBlobClient, AzDataLakeClient and AzQueueClient.

Examples

>>> blob_client = AzfsClient(credential="...").get_client("blob")
# or
>>> datalake_client = AzfsClient(credential="...").get_client("dfs")
# AzfsClient provide easy way to access functions implemented in AzBlobClient and AzDataLakeClient, as below
>>> data_path = "https://testazfs.blob.core.windows.net/test_container/test1.json"
>>> data = AzfsClient(credential="...").get_client("blob").get(path=data_path)

ClientInterface¶

class azfs.clients.client_interface.ClientInterface(credential: Union[str, azure.identity._credentials.default.DefaultAzureCredential, None], connection_string: Optional[str] = None)¶

The class provides Azure Blob, DataLake and Queue Client interface. Abstract methods below are implemented in each inherited classes.

_get_file_client
_get_service_client
_get_container_client
_ls
_get
_put

Clients¶

azfs.clients.client_interface.ClientInterface.get_file_client_from_path(self, path: str) → Union[azure.storage.blob._blob_client.BlobClient, azure.storage.filedatalake._data_lake_file_client.DataLakeFileClient, azure.storage.queue._queue_client.QueueClient]¶

get file_client from given path

Parameters:	path – Azure path that `BlobPathDecode()` can decode
Returns:	Union[BlobClient, DataLakeFileClient, QueueClient]

azfs.clients.client_interface.ClientInterface.get_container_client_from_path(self, path: str) → Union[azure.storage.blob._container_client.ContainerClient, azure.storage.filedatalake._file_system_client.FileSystemClient]¶

get container_client from given path

Parameters:	path – Azure path that `BlobPathDecode()` can decode
Returns:	Union[ContainerClient, FileSystemClient]