Port variant py310
Summary Python's filesystem abstraction layer (3.10)
Package version 2.4.16
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants py39
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 08 MAY 2022, 14:37:35 UTC
Port created 03 JAN 2020, 01:03:23 UTC
Subpackage Descriptions
single # PyFilesystem2 Python's Filesystem abstraction layer. [PyPI version] [PyPI] [Downloads] [Build Status] [Windows Build Status] [Coverage Status] [Codacy Badge] [Docs] ## Documentation - [Wiki] - [API Documentation] - [GitHub Repository] - [Blog] ## 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 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://') ``` Or to count the Python lines on an FTP server: ```python projects_fs = open_fs('') ``` 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] - [Martin Larralde] - [Giampaolo Cimino] - [Geoff Jukes]
Configuration Switches (platform-specific settings discarded)
PY310 ON Build using Python 3.10 PY39 OFF Build using Python 3.9
Package Dependencies by Type
Build (only) python-pip:single:py310
Build and Runtime python310:single:standard
Runtime (only) python-appdirs:single:py310
Download groups
main mirror://PYPIWHL/b9/5c/a3d95dc1ec6cdeb032d789b552ecc76effa3557ea9186e1566df6aac18df
Distribution File Information
660064febbccda264ae0b6bace80a8d1be9e089e0a5eb2427b7d517f9a91545c 135261 fs-2.4.16-py2.py3-none-any.whl
Ports that require python-fs:py310
No other ports depend on this one.