Skip to main content

pyfzf

Forked Changes:

This doesn't write to a temporary file before prompting, it communicates with the subprocess directly given any iterator, sending lines as they're processed.

It also lets you send any fzf CLI options as args/kwargs, or decorate a function which returns an iterator to use as fzf input (see below for examples)

A python wrapper for junegunn's fzf.

Requirements

  • Python 3.6+
  • fzf

Note: fzf must be installed and available on $PATH.

Installation

pip install pyfzf_iter

Usage

from pyfzf.pyfzf import FzfPrompt

fzf = FzfPrompt()
fzf = FzfPrompt(default_options="--reverse")

If fzf is not available on PATH, you can specify a location

fzf = FzfPrompt('/path/to/fzf')

Simply pass a sequence of items to the prompt function to invoke fzf

fzf.prompt(range(0,10))

You can pass additional positional arguments to fzf.

fzf.prompt(range(0,10), '--multi', '--cycle')
fzf.prompt(range(0,50), 'multi', 'cycle', height='20%')
fzf.prompt(range(0,50), 'x', 'i', 'm', '--tac')

Items are streamed to the fzf process one line at a time, you can pass any sort of iterator or generator as the first argument. For example, a file object, or a glob of files to search for, displaying a preview:

fzf.prompt(open("README.md"), "-m", delimiter="")

from pathlib import Path
fzf.prompt(Path(".").rglob("*.md"), "-m", r"--preview='cat {}'")

Items are delimited with \n by default, you can also change the delimiter (useful for multiline items):

>>> fzf.prompt(["5\n10", "15\n20"], '--read0', '-m', delimiter='\0')
['15\n20']

You can also wrap a decorate a function with wrap, which then runs fzf when you call the function:

from pyfzf import FzfPrompt

fzf = FzfPrompt()

@fzf.wrap("--tac")
def items(n: int):
    return range(n)

# prompts you to pick one of the items with fzf
items(n=50)

Metadata

Release files for pyfzf-iter 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyfzf-iter 0.0.1
File Size Uploaded
pyfzf_iter-0.0.1.tar.gz 7.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyfzf-iter 0.0.1
File Interpreter ABI Platform
pyfzf_iter-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 15.7 kB

Release files / pyfzf_iter-0.0.1.tar.gz

Download URL pyfzf_iter-0.0.1.tar.gz
Size 7.6 kB
Tags Source
SHA-256 checksum
How to use checksums
03e20516949ffa704c85ed03575962684f186bb8b7318d915c677bc60a2296cf
BLAKE2b-256 checksum
How to use checksums
7a241b7f29b009ba4c88e1ccc482ec6ad4ce52374ab43e2f69789a9d0022c098
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.4

Release files / pyfzf_iter-0.0.1-py3-none-any.whl

Download URL pyfzf_iter-0.0.1-py3-none-any.whl
Size 8.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3553c686cd7b5e9ec89c1fdb6ea0aae203021a32236690414f61a982165556b1
BLAKE2b-256 checksum
How to use checksums
24b31bb96d8bb5b9bba4ef3e25d0bbb303ece9532e18d66ef7d67c9b933d7400
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.4

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page