Skip to main content

Python's filesystem abstraction layer

Project description

PyFilesystem2

Python's Filesystem abstraction layer.

PyPI version PyPI Build Status Coverage Status Codacy Badge Code Health

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())
    return count

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.27.tar.gz (116.8 kB view details)

Uploaded Source

Built Distribution

fs-2.0.27-py2.py3-none-any.whl (119.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fs-2.0.27.tar.gz.

File metadata

  • Download URL: fs-2.0.27.tar.gz
  • Upload date:
  • Size: 116.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for fs-2.0.27.tar.gz
Algorithm Hash digest
SHA256 31f684435514bff9e9c8a6eb99a0ce201492cd4b4ffa7f6c13162defba0582ad
MD5 7bc57f8389f4fc32c95ab3d1381c4343
BLAKE2b-256 5990be19410e175ba1cfc0ccd98400c0ee053c22e475f1b143b92b2d07a1d5e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fs-2.0.27-py2.py3-none-any.whl
  • Upload date:
  • Size: 119.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.0

File hashes

Hashes for fs-2.0.27-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3c0fe6ee4e0889453d43bf644a5fc0dbb774cea878c6f30b2c3ed8d22ce9859c
MD5 da86b759e5f11aae8ec2d1f4bed303a0
BLAKE2b-256 b31d45d5a8de7527782594f0dce0199efb868570dcaf2a8ee9626d9513dfee3e

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