Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Python's filesystem abstraction layer

Project Description

Python’s Filesystem abstraction layer.

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.

Release History

Release History

This version
History Node

2.0.16

History Node

2.0.15

History Node

2.0.14

History Node

2.0.12

History Node

2.0.12a1

History Node

2.0.12a0

History Node

2.0.11

History Node

2.0.11a0

History Node

2.0.10

History Node

2.0.10a2

History Node

2.0.10a1

History Node

2.0.10a0

History Node

2.0.9

History Node

2.0.8

History Node

2.0.8a1

History Node

2.0.7

History Node

2.0.6

History Node

2.0.6a2

History Node

2.0.6a1

History Node

2.0.6a0

History Node

2.0.5

History Node

2.0.5a0

History Node

2.0.4

History Node

2.0.4a3

History Node

2.0.4a1

History Node

2.0.4a0

History Node

2.0.3

History Node

2.0.2

History Node

2.0.1

History Node

2.0.1a0

History Node

2.0.0

History Node

2.0.0a6

History Node

2.0.0a5

History Node

2.0.0a4

History Node

2.0.0a3

History Node

2.0.0a2

History Node

2.0.0a1

History Node

2.0.0a0

History Node

0.5.5a1

History Node

0.5.4

History Node

0.5.3

History Node

0.5.2

History Node

0.5.1

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
fs-2.0.16-py2.py3-none-any.whl (105.7 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Nov 11, 2017
fs-2.0.16.tar.gz (103.5 kB) Copy SHA256 Checksum SHA256 Source Nov 11, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting