Skip to main content

Python's filesystem abstraction layer

Project description

Python’s Filesystem abstraction layer.

PyPI version PyPI Build Status Coverage Status Codacy Badge

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

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.

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-2.0.6a2.tar.gz (92.5 kB view details)

Uploaded Source

Built Distribution

fs-2.0.6a2-py2.py3-none-any.whl (138.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fs-2.0.6a2.tar.gz.

File metadata

  • Download URL: fs-2.0.6a2.tar.gz
  • Upload date:
  • Size: 92.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fs-2.0.6a2.tar.gz
Algorithm Hash digest
SHA256 90888be68c21b02255b854e27b43d337caee523cc7a86dc0af0de436949f34ce
MD5 57f893785ab61c6385b02d2bef5286a3
BLAKE2b-256 313c39453fe296422ea72494b4b6c046b57b3b97f9239ffea2ebbd85b5cf0e6c

See more details on using hashes here.

File details

Details for the file fs-2.0.6a2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fs-2.0.6a2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ff875aa5b2fcf12a62644c85b5334dc4a3856d88f1a758a5ce8010c5faa0d3f7
MD5 f33fff1ec18986c7d3d2f02c54d3c8c8
BLAKE2b-256 e2c64bd5a8e9e59d1d5c2056311e7a463e7d67f4a965fec2f88d924c8eba0a3c

See more details on using hashes here.

Supported by

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