Skip to main content

Python wrapper for junegunn's fuzzyfinder (fzf)

Project description

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfzf_iter-0.0.1.tar.gz (7.6 kB view hashes)

Uploaded Source

Built Distribution

pyfzf_iter-0.0.1-py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page