pyfzf

library0.3.1pypypi✓ verified 25d ago

pyfzf is a Python wrapper for junegunn's fuzzyfinder (fzf), enabling Python applications to leverage fzf's interactive filtering capabilities directly from Python. The library is actively maintained, with its latest version 0.3.1 released in March 2022, and typically sees updates for feature enhancements and platform compatibility.

devops

pip install pyfzf

github ↗package ↗

INSTALL

IMPORT

SIG · PYFZF

pyfzf

devopspythonv0.3.1

Install

1.5s avg

Import

10ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.3.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.010s · 17.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.5s · import 0.010s · 18MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

FzfPrompt

✓ from pyfzf.pyfzf import FzfPrompt

Initializes FzfPrompt and displays a list of options using fzf, allowing for multi-selection. The selected items are returned as a list. You can pass additional fzf command-line arguments as a second argument to the `prompt` method.

from pyfzf.pyfzf import FzfPrompt fzf = FzfPrompt() options = ['apple', 'banana', 'cherry', 'date'] selected_items = fzf.prompt(options, '--multi') if selected_items: print(f"You selected: {', '.join(selected_items)}") else: print("No item selected.")

Debug

Known issues

breakingpyfzf officially requires Python 3.6+. Older versions (prior to 0.2.1) might have supported Python 2, but modern usage expects Python 3.6+.

fix

Ensure your environment uses Python 3.6 or newer.

affects: <0.2.1

breakingThe `plumbum` dependency was removed in version 0.3.0. If your application indirectly relied on `plumbum` through pyfzf, it will no longer be available.

fix

If `plumbum` functionality is still needed, install it explicitly (`pip install plumbum`) or refactor your code to use standard Python `subprocess` module.

affects: <0.3.0

gotchaThe `fzf` binary (junegunn's fuzzy-finder) must be installed on your system and accessible via the system PATH. pyfzf is a wrapper and does not bundle the fzf executable itself. If not found, `FzfPrompt` can be initialized with the full path to the `fzf` binary.

fix

Install fzf (e.g., `brew install fzf` on macOS, `sudo apt install fzf` on Debian/Ubuntu) or initialize `FzfPrompt('/path/to/fzf')`.

affects: All versions

gotchaUnicode support on Windows was improved significantly in version 0.3.1. Users on Windows experiencing issues with non-ASCII characters should upgrade.

fix

Upgrade to pyfzf 0.3.1 or newer: `pip install --upgrade pyfzf`.

affects: <0.3.1

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'pyfzf'

The pyfzf library has not been installed in your Python environment.

fix

Install the library using pip: `pip install pyfzf`

FileNotFoundError: [Errno 2] No such file or directory: 'fzf'

The underlying fzf executable, which pyfzf wraps, is not installed or not available in your system's PATH.

fix

Install fzf according to its documentation (e.g., `brew install fzf` on macOS, or see https://github.com/junegunn/fzf#installation) and ensure it's in your system's PATH. Alternatively, you can specify the fzf executable path when initializing FzfPrompt: `fzf = FzfPrompt('/path/to/fzf')`

ModuleNotFoundError: No module named 'pyfzf.FzfPrompt'

You are attempting to import FzfPrompt directly from the top-level 'pyfzf' package, but it resides within the nested 'pyfzf' module inside the package.

fix

Correct the import statement to specifically reference the internal module: `from pyfzf.pyfzf import FzfPrompt`

Upgrade

Version history

0.3.1latest on PyPI · released Mar 1, 2022

Audit

Dependencies

fzfrequiredpyfzf is a wrapper around the fzf command-line tool, which must be installed and available in your system's PATH.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/nk412/pyfzf ↗

packagehttps://pypi.org/project/pyfzf/ ↗