Filesystem interface to Azure Blob and Data Lake Storage (Gen2)
Quickstart
This package can be installed using:
pip install adlfs
or
conda install -c conda-forge adlfs
The az:// and abfs:// protocols are included in fsspec's known_implementations registry.
To connect to Azure Blob Storage or Azure Data Lake Storage (ADLS) Gen2 filesystem you can use the protocol abfs or az:
import dask.dataframe as dd
storage_options={'account_name': ACCOUNT_NAME, 'account_key': ACCOUNT_KEY}
ddf = dd.read_csv('abfs://{CONTAINER}/{FOLDER}/*.csv', storage_options=storage_options)
ddf = dd.read_parquet('az://{CONTAINER}/folder.parquet', storage_options=storage_options)
Accepted protocol / uri formats include:
'PROTOCOL://container/path-part/file'
'PROTOCOL://container@account.blob.core.windows.net/path-part/file'
'PROTOCOL://container@account.dfs.core.windows.net/path-part/file'
or optionally, if AZURE_STORAGE_ACCOUNT_NAME and an AZURE_STORAGE_<CREDENTIAL> is
set as an environmental variable, then storage_options will be read from the environmental
variables
To read from a public storage blob you are required to specify the 'account_name'.
For example, you can access NYC Taxi & Limousine Commission as:
storage_options = {'account_name': 'azureopendatastorage'}
ddf = dd.read_parquet('az://nyctlc/green/puYear=2019/puMonth=*/*.parquet', storage_options=storage_options)
Details
The package includes pythonic filesystem implementations for both Azure Blobs and Azure Datalake Gen2 (ADLS), that facilitate interactions between these implementations and Dask. This is done leveraging the fsspec/filesystem_spec base class and Azure Python SDKs.
Operations against Azure Blobs and ADLS Gen2 are implemented by leveraging Azure Blob Storage Python SDK.
Setting credentials
If no credentials/configuration is provided, DefaultAzureCredential will be used for authentication. If you want to use alternative credentials, storage_options can be instantiated with a variety of keyword arguments:
connection_stringaccount_nameaccount_keysas_tokentenant_id,client_id, andclient_secretare combined for an Azure ServicePrincipal e.g.storage_options={'account_name': ACCOUNT_NAME, 'tenant_id': TENANT_ID, 'client_id': CLIENT_ID, 'client_secret': CLIENT_SECRET}anon: bool, optional. Set toTrueto use anonymous authentication. If not set, theAZURE_STORAGE_ANONenvironment variable will be checked before defaulting toFalsewhere credentials are discovered on the system.location_mode: valid values are "primary" or "secondary" and apply to RA-GRS accounts
For more argument details see all arguments for AzureBlobFileSystem here
The following environmental variables can also be set and picked up for authentication:
- "AZURE_STORAGE_CONNECTION_STRING"
- "AZURE_STORAGE_ACCOUNT_NAME"
- "AZURE_STORAGE_ACCOUNT_KEY"
- "AZURE_STORAGE_SAS_TOKEN"
- "AZURE_STORAGE_TENANT_ID"
- "AZURE_STORAGE_CLIENT_ID"
- "AZURE_STORAGE_CLIENT_SECRET"
The filesystem can be instantiated for different use cases based on a variety of storage_options combinations. The following list describes some common use cases utilizing AzureBlobFileSystem, i.e. protocols abfsor az. Note that all cases require the account_name argument to be provided:
- Auto credential solving using Azure's DefaultAzureCredential() library:
storage_options={'account_name': ACCOUNT_NAME}will useDefaultAzureCredentialto get valid credentials to the containerACCOUNT_NAME.DefaultAzureCredentialattempts to authenticate via the mechanisms and order visualized here. - Anonymous connection to public container:
storage_options={'account_name': ACCOUNT_NAME, 'anon': True}will assume theACCOUNT_NAMEpoints to a public container, and attempt to use an anonymous login. Note, the default value foranonis False. - Azure ServicePrincipal:
tenant_id,client_id, andclient_secretare all used as credentials for an Azure ServicePrincipal: e.g.storage_options={'account_name': ACCOUNT_NAME, 'tenant_id': TENANT_ID, 'client_id': CLIENT_ID, 'client_secret': CLIENT_SECRET}.
Append Blob
The AzureBlobFileSystem accepts all of the Async BlobServiceClient arguments.
By default, write operations create BlockBlobs in Azure, which, once written can not be appended. It is possible to create an AppendBlob using mode="ab" when creating and operating on blobs. Currently, AppendBlobs are not available if hierarchical namespaces are enabled.
Older versions
ADLS Gen1 filesystem has officially been retired. Hence the adl:// method, which was designed to connect to ADLS Gen1 is obsolete.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file adlfs-2026.8.0.tar.gz.
File metadata
- Download URL: adlfs-2026.8.0.tar.gz
- Upload date:
- Size: 55.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b78a01bd892c2a99f461b2b2ef4592c2eb45934e728f318472291ccaa6378e06
|
|
| MD5 |
18a049335a806d128142d6156ab45224
|
|
| BLAKE2b-256 |
f4299937905acfaf3e4826d7782f8efab845bb11eaa2e24749a16eeab32e7fa0
|
File details
Details for the file adlfs-2026.8.0-py3-none-any.whl.
File metadata
- Download URL: adlfs-2026.8.0-py3-none-any.whl
- Upload date:
- Size: 46.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
858d8999b83ad70baae89ee2ad67f40443f9d94e0257351a74866d643f22d54d
|
|
| MD5 |
de46760694758c3bbedfbedb5e1b80e5
|
|
| BLAKE2b-256 |
568c2a895811f69699915ddd4e346ea3a1ab26b585025eac890d19dd5193c7f4
|
