FSSPEC: Filesystem interfaces for Python

Filesystem Spec (FSSPEC) is a project to unify various projects and classes to work with remote filesystems and file-system-like abstractions using a standard pythonic interface.

Highlights

• based on s3fs and gcsfs

• fsspec instances are serializable and can be passed between processes/machines

• the OpenFiles file-like instances are also serializable

• implementations provide random access, to enable only the part of a file required to be read; plus a template to base other file-like classes on

• file access can use transparent compression and text-mode

• any file-system directory can be viewed as a key-value/mapping store

• if installed, all file-system classes also subclass from pyarrow.filesystem.FileSystem, so can work with any arrow function expecting such an instance

• writes can be transactional: stored in a temporary location and only moved to the final destination when the transaction is committed

• FUSE: mount any path from any backend to a point on your file-system

• cached instances tokenised on the instance parameters

These are described further in the Features of fsspec section.

Installation

pip install fsspec

Not all included filesystems are usable by default without installing extra dependencies. For example to be able to access data in S3:

pip install fsspec[s3]

or

conda install -c conda-forge fsspec

Implementations

This repo contains several file-system implementations, see Built-in Implementations. However, the external projects s3fs and gcsfs depend on fsspec and share the same behaviours. Dask and Intake use fsspec internally for their IO needs.

The current list of known implementations can be found as follows

from fsspec.registry import known_implementations
known_implementations

These are only imported on request, which may fail if a required dependency is missing. The dictionary fsspec.registry contains all imported implementations, and can be mutated by user code, if necessary.

Contents:

• Introduction
  • Background
  • History
  • Influences
  • Not pyfilesystems?
  • Structure of the package
• Usage
  • Instantiate a file-system
  • Use a file-system
  • Higher-level
• Features of fsspec
  • Serialisability
  • OpenFile instances
  • Random Access and Buffering
  • Transparent text-mode and compression
  • Key-value stores
  • PyArrow integration
  • Transactions
  • Mount anything with FUSE
  • Instance Caching
  • Listings Caching
  • File Buffering
  • URL chaining
  • Caching Files Locally
  • Remote Write Caching
  • File Selector
• Async
• API Reference
  • User Functions
  • Base Classes
  • Built-in Implementations
  • Other Known Implementations
  • Read Buffering
• Changelog
  • Version 0.8.3
  • Version 0.8.2
  • Version 0.8.1
  • Version 0.8.0
  • Version 0.7.5
  • Version 0.7.4
  • 0.7.3 series
  • Version 0.6.2
  • Version 0.6.1
  • Version 0.6.0
• Developing with fsspec
  • Clients of the library
  • Implementing a backend
  • Implementing async

Indices and tables

• Index

• Module Index

• Search Page