Skip to main content

File-system specification

Project description

filesystem_spec

PyPI version Anaconda-Server Badge Build Docs

A specification for pythonic filesystems.

Install

pip install fsspec 

would install the base fsspec. Various optionally supported features might require specification of custom extra require, e.g. pip install fsspec[ssh] will install dependencies for ssh backends support. Use pip install fsspec[full] for installation of all known extra dependencies.

Up-to-date package also provided through conda-forge distribution:

conda install -c conda-forge fsspec 

Purpose

To produce a template or specification for a file-system interface, that specific implementations should follow, so that applications making use of them can rely on a common behaviour and not have to worry about the specific internal implementation decisions with any given backend. Many such implementations are included in this package, or in sister projects such as s3fs and gcsfs.

In addition, if this is well-designed, then additional functionality, such as a key-value store or FUSE mounting of the file-system implementation may be available for all implementations "for free".

Documentation

Please refer to RTD

Develop

fsspec uses GitHub Actions for CI. Environment files can be found in the "ci/" directory. Note that the main environment is called "py38", but it is expected that the version of python installed be adjustable at CI runtime. For local use, pick a version suitable for you.

# For a new environment (mamba / conda). mamba create -n fsspec -c conda-forge python=3.9 -y conda activate fsspec # Standard dev install with docs and tests. pip install -e ".[dev,doc,test]" # Full tests except for downstream pip install s3fs pip uninstall s3fs pip install -e .[dev,doc,test_full] pip install s3fs --no-deps pytest -v # Downstream tests. sh install_s3fs.sh # Windows powershell. install_s3fs.sh 

Testing

Tests can be run in the dev environment, if activated, via pytest fsspec.

The full fsspec suite requires a system-level docker, docker-compose, and fuse installation. If only making changes to one backend implementation, it is not generally necessary to run all tests locally.

It is expected that contributors ensure that any change to fsspec does not cause issues or regressions for either other fsspec-related packages such as gcsfs and s3fs, nor for downstream users of fsspec. The "downstream" CI run and corresponding environment file run a set of tests from the dask test suite, and very minimal tests against pandas and zarr from the test_downstream.py module in this repo.

Code Formatting

fsspec uses Black to ensure a consistent code format throughout the project. Run black fsspec from the root of the filesystem_spec repository to auto-format your code. Additionally, many editors have plugins that will apply black as you edit files. black is included in the tox environments.

Optionally, you may wish to setup pre-commit hooks to automatically run black when you make a git commit. Run pre-commit install --install-hooks from the root of the filesystem_spec repository to setup pre-commit hooks. black will now be run before you commit, reformatting any changed files. You can format without committing via pre-commit run or skip these checks with git commit --no-verify.

Support

Work on this repository is supported in part by:

"Anaconda, Inc. - Advancing AI through open source."

anaconda logo

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fsspec-2025.9.0.tar.gz (304.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fsspec-2025.9.0-py3-none-any.whl (199.3 kB view details)

Uploaded Python 3

File details

Details for the file fsspec-2025.9.0.tar.gz.

File metadata

  • Download URL: fsspec-2025.9.0.tar.gz
  • Upload date:
  • Size: 304.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for fsspec-2025.9.0.tar.gz
Algorithm Hash digest
SHA256 19fd429483d25d28b65ec68f9f4adc16c17ea2c7c7bf54ec61360d478fb19c19
MD5 c99660cbe99837ab6798b2823be64684
BLAKE2b-256 dee0bab50af11c2d75c9c4a2a26a5254573c0bd97cea152254401510950486fa

See more details on using hashes here.

File details

Details for the file fsspec-2025.9.0-py3-none-any.whl.

File metadata

  • Download URL: fsspec-2025.9.0-py3-none-any.whl
  • Upload date:
  • Size: 199.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for fsspec-2025.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 530dc2a2af60a414a832059574df4a6e10cce927f6f4a78209390fe38955cfb7
MD5 84d628649dd983423f59575f37ca84a3
BLAKE2b-256 477170db47e4f6ce3e5c37a607355f80da8860a33226be640226ac52cb05ef2e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page