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

Uploaded Source

Built Distribution

fs-2.3.1-py2.py3-none-any.whl (124.7 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: fs-2.3.1.tar.gz
  • Upload date:
  • Size: 123.3 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.3.1.tar.gz
Algorithm Hash digest
SHA256 6c3f79a16dfcbf8a8f437f81dd8afaa3741285d9369574c48e1d27e40b0c980e
MD5 74c53854e09e8afff3d4d39ea88c935d
BLAKE2b-256 3429ffb874f3f4771a47713dd7f183bb9e809d76cba4a60c1660e174753d40fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fs-2.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 124.7 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.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e3eca265a800b477b0f73803f3158db0c09e3a8501a3d4dbe79d7a7d8dbb149d
MD5 67506093e6d6afa5128db31a4c68e17a
BLAKE2b-256 1e8692910741ddd8cece3193c414938558ee9c212ac0b185a053ca95a42bcf03

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