ff
About
ff is a tool for finding files in the filesystem.
NOTE: ff is in the early stages of development, expect things to break and syntax to change.
Summary
ff is a tool for finding files in the filesystem that all share a set of
common features. Its scope is similar to find(1) and fd(1) but it aims at
being more accessible and easier to use than find and more versatile and
powerful than fd. It is written in Python >= 3.6.
Features
- Search by file attributes.
- Search in a wide variety of file metadata.
- Simple yet powerful expression syntax.
- Flexible output options.
- Flexible sort options.
- Extendable by user plugins.
- Parallel search and processing.
- Usable in scripts with a Python API.
Examples
Store all files from the current directory that are tracked by git(1) in a
tar(1) archive:
$ ff type=f git.tracked=yes --sort --exec-batch tar cvzf git-tracked.tar.gz
Find files in the directory Videos/ that end with .mkv or .mp4 and are
between 720 and 1080 pixels high:
$ ff Videos/ {{ ext=mkv or ext=mp4 }} and {{ height+=720 and height-=1080 }}
More examples are here.
Installation
To build and install ff simply type:
$ python setup.py install
or
$ pip install find-ff
Building with Cython is also supported. Cython >= 3.0 is required. Depending on the set of arguments this may offer a significant speed-up.
$ python setup-cython.py install
Python API
You can use ff's query capabilities in your own scripts:
from ff import Find
for entry in Find("type=f git.tracked=yes", directories=["/home/user/project"], sort=["path"]):
print(entry["relpath"])
Developing plugins and debug mode
There is a template for new plugins to start from (plugin_template.py) with
exhaustive instructions and comments, so you can develop plugins for your own
needs.
Useful in that regard is ff's debug mode. It can be activated by executing
the ff module.
$ python -m ff --debug info,cache ...
Debug mode produces lots of messages which can be limited to certain categories
using the --debug category1,category2,... option. On top of that, debug mode
activates many internal checks using assert(). Therefore, it is advisable to
use debug mode during plugin development.
1 maintainer
Release files for find-ff 592
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| find-ff-592.tar.gz | 76.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| find_ff-592-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 195.6 kB
Release files / find-ff-592.tar.gz
| Download URL | find-ff-592.tar.gz |
|---|---|
| Size | 76.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c39ea468d2ba530ace8450816af21dba8f0ad7dd082a394a6bc69881e353ac4
|
|
BLAKE2b-256 checksum How to use checksums |
c48754af402cd4a79c77bcf305e9fbe99660c9fb8eed111d957907fb09f6d8bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
Release files / find_ff-592-py3-none-any.whl
| Download URL | find_ff-592-py3-none-any.whl |
|---|---|
| Size | 119.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1efad7f15fa138b0de5ac4f9a0a4c2f41de707d9b6528f53634577ee49fb5f63
|
|
BLAKE2b-256 checksum How to use checksums |
ac3c7e12f08a5beacb603c1b35a39f102bd2be76370e21b37408b7af77484911
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
|
