Skip to main content

Filesystem abstraction layer

Project description

PyFilesystem is an abstraction layer for filesystems. In the same way that Python’s file-like objects provide a common way of accessing files, PyFilesystem provides a common way of accessing entire filesystems. You can write platform-independent code to work with local files, that also works with any of the supported filesystems (zip, ftp, S3 etc.).

Pyfilesystem works with Linux, Windows and Mac.

Suported Filesystems

Here are a few of the filesystems that can be accessed with Pyfilesystem:

  • DavFS access files & directories on a WebDAV server

  • FTPFS access files & directories on an FTP server

  • MemoryFS access files & directories stored in memory (non-permanent but very fast)

  • MountFS creates a virtual directory structure built from other filesystems

  • MultiFS a virtual filesystem that combines a list of filesystems into one, and checks them in order when opening files

  • OSFS the native filesystem

  • SFTPFS access files & directores stored on a Secure FTP server

  • S3FS access files & directories stored on Amazon S3 storage

  • TahoeLAFS access files & directories stored on a Tahoe distributed filesystem

  • ZipFS access files and directories contained in a zip file


The following snippet prints the total number of bytes contained in all your Python files in C:/projects (including sub-directories):

from fs.osfs import OSFS
projects_fs = OSFS('C:/projects')
print sum(projects_fs.getsize(path)
          for path in projects_fs.walkfiles(wildcard="*.py"))

That is, assuming you are on Windows and have a directory called ‘projects’ in your C drive. If you are on Linux / Mac, you might replace the second line with something like:

projects_fs = OSFS('~/projects')

If you later want to display the total size of Python files stored in a zip file, you could make the following change to the first two lines:

from fs.zipfs import ZipFS
projects_fs = ZipFS('')

In fact, you could use any of the supported filesystems above, and the code would continue to work as before.

An alternative to explicitly importing the filesystem class you want, is to use an FS opener which opens a filesystem from a URL-like syntax:

from fs.opener import fsopendir
projects_fs = fsopendir('C:/projects')

You could change C:/projects to zip:// to open the zip file, or even to sum up the bytes of Python stored on an ftp server.


This is from an early version of PyFilesystem, but still relevant

Discussion Group

Further Information

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

fs-0.5.4.tar.gz (231.3 kB view hashes)

Uploaded Source

Supported by

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