Metadata-Version: 2.1
Name: fs
Version: 2.4.16
Summary: Python's filesystem abstraction layer
Home-page: https://github.com/PyFilesystem/pyfilesystem2
Author: Will McGugan
Author-email: will@willmcgugan.com
Maintainer: Martin Larralde
Maintainer-email: martin.larralde@embl.de
License: MIT
Project-URL: Bug Reports, https://github.com/PyFilesystem/pyfilesystem2/issues
Project-URL: Documentation, https://pyfilesystem2.readthedocs.io/en/latest/
Project-URL: Wiki, https://www.pyfilesystem.org/
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: System :: Filesystems
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: appdirs (~=1.4.3)
Requires-Dist: setuptools
Requires-Dist: six (~=1.10)
Requires-Dist: backports.os (~=0.1) ; python_version < "3.0"
Requires-Dist: enum34 (~=1.1.6) ; python_version < "3.4"
Requires-Dist: typing (~=3.6) ; python_version < "3.6"
Provides-Extra: scandir
Requires-Dist: scandir (~=1.5) ; (python_version < "3.5") and extra == 'scandir'
# PyFilesystem2
Python's Filesystem abstraction layer.
[](https://pypi.org/project/fs/)
[](https://pypi.org/project/fs/)
[](https://pepy.tech/project/fs/)
[](https://github.com/PyFilesystem/pyfilesystem2/actions?query=branch%3Amaster)
[](https://ci.appveyor.com/project/willmcgugan/pyfilesystem2)
[](https://coveralls.io/github/PyFilesystem/pyfilesystem2)
[](https://www.codacy.com/app/will-mcgugan/pyfilesystem2?utm_source=github.com&utm_medium=referral&utm_content=PyFilesystem/pyfilesystem2&utm_campaign=Badge_Grade)
[](http://pyfilesystem2.readthedocs.io/en/stable/?badge=stable)
## Documentation
- [Wiki](https://www.pyfilesystem.org)
- [API Documentation](https://docs.pyfilesystem.org/)
- [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())
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:
- [Will McGugan](https://github.com/willmcgugan)
- [Martin Larralde](https://github.com/althonos)
- [Giampaolo Cimino](https://github.com/gpcimino)
- [Geoff Jukes](https://github.com/geoffjukes)
See [CONTRIBUTORS.md](https://github.com/PyFilesystem/pyfilesystem2/blob/master/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](mailto:willmcgugan@gmail.com).