Skip to main content

Python's filesystem abstraction layer

Project description

PyFilesystem2
=============

Python's Filesystem abstraction layer.

[![PyPI version](https://badge.fury.io/py/fs.svg)](https://badge.fury.io/py/fs)
[![PyPI](https://img.shields.io/pypi/pyversions/fs.svg)](https://pypi.org/project/fs/)
[![Build Status](https://travis-ci.org/PyFilesystem/pyfilesystem2.svg?branch=master)](https://travis-ci.org/PyFilesystem/pyfilesystem2)
[![Coverage Status](https://coveralls.io/repos/github/PyFilesystem/pyfilesystem2/badge.svg)](https://coveralls.io/github/PyFilesystem/pyfilesystem2)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/30ad6445427349218425d93886ade9ee)](https://www.codacy.com/app/will-mcgugan/pyfilesystem2?utm_source=github.com&utm_medium=referral&utm_content=PyFilesystem/pyfilesystem2&utm_campaign=Badge_Grade)
[![Code Health](https://landscape.io/github/PyFilesystem/pyfilesystem2/master/landscape.svg?style=flat)](https://landscape.io/github/PyFilesystem/pyfilesystem2/master)

Documentation
-------------

* [Wiki](https://www.pyfilesystem.org)
* [API Documentation](https://pyfilesystem2.readthedocs.io/en/latest/)
* [GitHub Repository](https://github.com/PyFilesystem/pyfilesystem2)
* [Blog](https://www.willmcgugan.com/tag/fs/)


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.

```python
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:

```python
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:

```python
projects_fs = open_fs('zip://projects.zip')
```

Or to count the Python lines on an FTP server:

```python
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:

```python
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
-------

* [Will McGugan](https://github.com/willmcgugan)
* [Martin Larralde](https://github.com/althonos)
* [Giampaolo](https://github.com/gpcimino) for `copy_if_newer` and ftp fixes.

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

Uploaded Source

Built Distribution

fs-2.0.22-py2.py3-none-any.whl (120.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for fs-2.0.22.tar.gz
Algorithm Hash digest
SHA256 d4f2ff8f0b6d2e0b1642e1ae6c745e4c2a923bdc84e8a7ca3364a96cb1f8290d
MD5 11118229bb4642e88bbf9ab5381ec226
BLAKE2b-256 56677a9e886f1358d7bdd9a9cc5a7f9bd5bb63c5cb699a5b782cefced9bd2212

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fs-2.0.22-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4cc60ed21561ca1a0bf265481fc91097bb99d1e116f9cb79e13d124b6217a78a
MD5 9d7692bcb9afcfe0ecc8e6c6ddcae469
BLAKE2b-256 335934d5c491ba1b7a8264a57b682cdd6792a16eea2f6ef90c42fd9cb859b262

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