fff-search
Python bindings for FFF (Fast File Finder), built with PyO3 and Maturin. Install with pip install fff-search; import as fff.
Requirements
- Python >= 3.10
- Rust toolchain (to build the native extension)
- uv (recommended)
Development setup
cd packages/fff-python
uv sync --all-extras
uv run maturin develop --release
Running tests
cd packages/fff-python
uv run pytest -v
Standalone example
cd packages/fff-python
uv run python examples/basic.py .
Basic usage
from fff import FileFinder
with FileFinder("/path/to/project", watch=False) as finder:
finder.wait_for_scan_blocking(timeout_ms=5000)
print(f"Indexed under {finder.base_path}")
result = finder.search("main")
if result:
print(f"Showing {len(result)} of {result.total_matched} matches")
for item, score in zip(result.items, result.scores):
print(f"{item.relative_path}: {score.total}")
Async usage
wait_for_scan is a coroutine that polls the scan status and yields to the
event loop, so it never blocks other tasks. Use wait_for_scan_blocking from
synchronous code.
import asyncio
from fff import FileFinder
async def main():
with FileFinder("/path/to/project", watch=False) as finder:
await finder.wait_for_scan(timeout_ms=5000)
result = finder.search("main")
print(result)
asyncio.run(main())
Watching files
Subscribe to filesystem changes with a glob, an exact path, or a directory
subtree (requires watch=True, the default). The callback receives normalized
batches of up to 128 events on a dedicated callback thread. Each path appears
at most once; avoid long-running work so later callbacks are not delayed.
from fff import FileFinder
with FileFinder("/path/to/project") as finder:
finder.wait_for_scan_blocking(timeout_ms=5000)
def on_change(events):
for e in events:
print(e.kind, e.path) # created | modified | removed | renamed | rescan
# Globs are relative to the project root; wildcard-free patterns resolve
# inside the indexed tree — an existing directory watches its whole
# subtree, anything else is an exact file path.
sub = finder.watch("src/**/*.py", on_change)
...
sub.unsubscribe() # non-blocking; the callback never runs after this
# No pattern (None) watches the entire indexed tree
with finder.watch(None, on_change):
...
# Directory subtree with per-subscription excludes (parcel-watcher style)
with finder.watch("src", on_change, ignore=["*.log", "src/vendor"]):
...
A renamed event carries both paths: e.path is the destination and
e.from_path the source. It replaces the removed/created pair, so a move is
one event. Moves in or out of the indexed tree stay a plain created/removed.
A rescan event means individual changes were lost (index overflow or an
ignore-file change) — re-check anything you care about.
Building wheels
cd packages/fff-python
uv run maturin build --release
The produced wheel is abi3 compatible with Python 3.10+.
Metadata
Release files for fff-search 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fff_search-0.11.0.tar.gz | 2.2 MB | With provenance | Details for fff_search-0.11.0.tar.gz |
Built distributions (wheels)
| File | Actions Reset | |||
|---|---|---|---|---|
| fff_search-0.11.0-cp310-abi3-win_amd64.whl | CPython 3.10 | abi3 | Windows x86-64 | Details for fff_search-0.11.0-cp310-abi3-win_amd64.whl |
| fff_search-0.11.0-cp310-abi3-manylinux_2_38_x86_64.whl | CPython 3.10 | abi3 | Linux glibc 2.38+ x86-64 | Details for fff_search-0.11.0-cp310-abi3-manylinux_2_38_x86_64.whl |
| fff_search-0.11.0-cp310-abi3-manylinux_2_38_aarch64.whl | CPython 3.10 | abi3 | Linux glibc 2.38+ ARM64 | Details for fff_search-0.11.0-cp310-abi3-manylinux_2_38_aarch64.whl |
| fff_search-0.11.0-cp310-abi3-macosx_11_0_arm64.whl | CPython 3.10 | abi3 | macOS 11.0+ ARM64 | Details for fff_search-0.11.0-cp310-abi3-macosx_11_0_arm64.whl |
| fff_search-0.11.0-cp310-abi3-macosx_10_12_x86_64.whl | CPython 3.10 | abi3 | macOS 10.12+ x86-64 | Details for fff_search-0.11.0-cp310-abi3-macosx_10_12_x86_64.whl |
Total release size: 20.7 MB
Release files / fff_search-0.11.0.tar.gz
| Download URL | fff_search-0.11.0.tar.gz |
|---|---|
| Size | 2.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
569d97283b756054a0843012dad88f27bf89cdee082322a7e264fcd952aae86a
|
|
BLAKE2b-256 checksum How to use checksums |
3c4a670e1405231d59452c5bdfad8e309cf6c6f055751d596c93303d7476ac58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / fff_search-0.11.0-cp310-abi3-win_amd64.whl
| Download URL | fff_search-0.11.0-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 4.7 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
d55533e787d9186ff8549cbffbf7fa1ebf269f47f9b4fbfb0332d8143523f554
|
|
BLAKE2b-256 checksum How to use checksums |
e194903790f99942d565bb54d1d10e77a8f69244983ba6f66fa4d6d983d928fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / fff_search-0.11.0-cp310-abi3-manylinux_2_38_x86_64.whl
| Download URL | fff_search-0.11.0-cp310-abi3-manylinux_2_38_x86_64.whl |
|---|---|
| Size | 4.4 MB |
| Tags | CPython 3.10 Linux glibc 2.38+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
6936d78405461f2617e7d33910b0cf388be0601a51c4e20a0f7c9d713490f96f
|
|
BLAKE2b-256 checksum How to use checksums |
b9ff079dff42d1cdb621db07cda933c7c9d37db007db5e681b0bbd0873671041
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / fff_search-0.11.0-cp310-abi3-manylinux_2_38_aarch64.whl
| Download URL | fff_search-0.11.0-cp310-abi3-manylinux_2_38_aarch64.whl |
|---|---|
| Size | 2.9 MB |
| Tags | CPython 3.10 Linux glibc 2.38+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
db711d7beaceaf2928a1a6c1b935720b3cae4b8a21b72ffb3ad1dc93605eaada
|
|
BLAKE2b-256 checksum How to use checksums |
55129440a8deec6e134d79953e6450a55f44297e25d6d84a965330552b4b2609
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / fff_search-0.11.0-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | fff_search-0.11.0-cp310-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.5 MB |
| Tags | CPython 3.10 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
4d2296bfe8a60141772fa825003c22856f7b136661f684b8b4d7d9477a4050f5
|
|
BLAKE2b-256 checksum How to use checksums |
09aa43de9117c33b63181858ad93d09718cbfc67992280e40aa37bb6a690167a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logRelease files / fff_search-0.11.0-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | fff_search-0.11.0-cp310-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 4.1 MB |
| Tags | CPython 3.10 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
71fee7ef7cbae7b5c6a71a47e4c7e47bbcb94abf48bc7a7b337942398efcd050
|
|
BLAKE2b-256 checksum How to use checksums |
68d78b30d80a9c9fc637899d0d79f75757d67f19d05074889435e769917d1a10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logSecurity for fff-search 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 6 files in this release have been uploaded with provenance metadata.
Attestation for fff_search-0.11.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 21, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.