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

The following developers have contributed code and their time to this projects:

See CONTRIBUTORS.md for a full list of contributors.

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.

Support

If commercial support is required, please contact Will McGugan.

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

Uploaded Source

Built Distribution

fs-2.4.1-py2.py3-none-any.whl (125.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for fs-2.4.1.tar.gz
Algorithm Hash digest
SHA256 b93aeb36537873a39705e961fda2959804b7a57d754c6944b784419134f543e9
MD5 01b83f924e1e6259060ac66571bcff2e
BLAKE2b-256 33629742f748ccdfe4905dec7a8c0d23ae4b6455b843e3ce395b3c40fd2d78dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fs-2.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 125.0 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/40.6.2 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.7.2

File hashes

Hashes for fs-2.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3625536cc7348c353e3aff821a99d6fb7a6da4fce174d6a6d10e126818c4ab65
MD5 4fdf3b39614ee9103b838be71055ee60
BLAKE2b-256 589612056442822e4852ca5936dcd7c572efcc563d2c1316f8af3ad130d8c803

See more details on using hashes here.

Supported by

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