PyFilesystem2

Python’s Filesystem abstraction layer.

Documentation

Introduction

Think of PyFilesystem’s FS objects as the next logical step to Python’s file objects. In the same way that file objects abstract a single file, FS objects abstract an entire filesystem.

Let’s look at a simple piece of code as an example. The following function uses the PyFilesystem API to count the number of non-blank lines of Python code in a directory. It works recursively, so it will find .py files in all sub-directories.

def count_python_loc(fs):
    """Count non-blank lines of Python code."""
    count = 0
    for path in fs.walk.files(filter=['*.py']):
        with fs.open(path) as python_file:
            count += sum(1 for line in python_file if line.strip())
    return count

We can call count_python_loc as follows:

from fs import open_fs
projects_fs = open_fs('~/projects')
print(count_python_loc(projects_fs))

The line project_fs = open_fs('~/projects') opens an FS object that maps to the projects directory in your home folder. That object is used by count_python_loc when counting lines of code.

To count the lines of Python code in a zip file, we can make the following change:

projects_fs = open_fs('zip://projects.zip')

Or to count the Python lines on an FTP server:

projects_fs = open_fs('ftp://ftp.example.org/projects')

No changes to count_python_loc are necessary, because PyFileystem provides a simple consistent interface to anything that resembles a collection of files and directories. Essentially, it allows you to write code that is independent of where and how the files are physically stored.

Contrast that with a version that purely uses the standard library:

def count_py_loc(path):
    count = 0
    for root, dirs, files in os.walk(path):
        for name in files:
            if name.endswith('.py'):
                with open(os.path.join(root, name), 'rt') as python_file:
                    count += sum(1 for line in python_file if line.strip())

This version is similar to the PyFilesystem code above, but would only work with the OS filesystem. Any other filesystem would require an entirely different API, and you would likely have to re-implement the directory walking functionality of os.walk.

Credits

Will McGugan
Martin Larralde for TarFS
Giampaolo for copy_if_newer and ftp fixes.

PyFilesystem2 owes a massive debt of gratitude to the following developers who contributed code and ideas to the original version.

Ryan Kelly
Andrew Scheller
Ben Timby

Apologies if I missed anyone, feel free to prompt me if your name is missing here.

Metadata

Release files for fs 2.0.8a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fs 2.0.8a1
File	Size	Uploaded
fs-2.0.8a1.tar.gz	93.3 kB	Aug 13, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for fs 2.0.8a1
File	Interpreter	ABI	Platform	Reset
fs-2.0.8a1-py2.py3-none-any.whl 139.1 kB Aug 13, 2017	Python 3, Python 2	none	any	Details

Total release size: 232.4 kB

Release files / fs-2.0.8a1.tar.gz

Download URL	fs-2.0.8a1.tar.gz
Size	93.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`467153d4cbbed2eec20f8ca7dfc78e5d4dba28010f8e8759ddfe5c6e6ef862e6`
BLAKE2b-256 checksum How to use checksums	`7808cd0a138319908eed995dcf9fc5d1335d8e5f784dda0eb59ca350913c9402`
Upload date	Aug 13, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / fs-2.0.8a1-py2.py3-none-any.whl

Download URL	fs-2.0.8a1-py2.py3-none-any.whl
Size	139.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`0d3020b2222729097cb37bc9268127eb2e8305fd49faae7efcac831b98b876b3`
BLAKE2b-256 checksum How to use checksums	`f18fde728849ccd31d951c1814e5ee3ab5bbc99526a1ef0c58a9b894554d0da5`
Upload date	Aug 13, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No