pzp
Pure-python fzf-inspired element picker
Requirements
- Python 3.6+
Install
pip install pzp
Usage
from pzp import pzp
pzp(['a', 'b', 'c'])
Layout
The finder by default starts in fullscreen mode. You can make it start below the
cursor with fullscreen=False
option.
Also, with the height
argument you can limit the window height.
pzp(candidates=range(0, 1000), fullscreen=False, height=20)
You can choose between the following layout using the layout
option.
- default Display from the bottom of the screen
- reverse Display from the top of the screen
- reverse-list Display from the top of the screen, prompt at the bottom
Search syntax
The finder starts in "extended-search mode" where you can type in multiple search
terms delimited by spaces. e.g. ^music .mp3$ sbtrkt !fire
Token | Match type | Description |
---|---|---|
t1 t2 |
tokens-match | Items that include t1 and t2 |
'star wars |
line-match (not-splitted) | Items that include star wars |
^music |
prefix-exact-match | Items that start with music |
.py$ |
suffix-exact-match | Items that end with .py |
!fire |
inverse-exact-match | Items that do not include fire |
!^music |
inverse-prefix-exact-match | Items that do not start with music |
!.py$ |
inverse-suffix-exact-match | Items that do not end with .py |
Key/Event Bindings
keys_binding
argument allows you to bind one or more keys to one action.
You can use it to customize key bindings or implementing custom behaviors.
try:
item = pzp(
candidates=candidates,
keys_binding={
"custom-action": ["ctrl-o"],
"exclamation": ["!"]
},
)
print(item)
except CustomAction as action:
print(action.action)
print(action.selected_item)
Available Keys
Key | Synonyms type |
---|---|
space | |
tab | |
btab | shift-tab |
enter | |
esc | |
insert | |
del | |
bspace | bs |
up | |
down | |
left | |
right | |
home | |
end | |
pgdn | page-down |
pgup | page-up |
f1 - f12 | |
ctrl-/ | |
ctrl-\ | |
ctrl-] | |
ctrl-^ | |
ctrl-a - ctrl-z | |
any single character |
Available Actions
A key can be bound to one of following actions or to a custom action.
Action* | Default binding |
---|---|
accept | enter |
abort | ctrl-c ctrl-g ctrl-q esc |
beginning-of-line | ctrl-a home |
backward-char | ctrl-b left |
forward-char | ctrl-f right |
end-of-line | ctrl-e end |
backward-delete-char | ctrl-h bspace |
delete-char | del |
up | ctrl-k ctrl-p up |
down | ctrl-j ctrl-n down |
page-down | pgdn |
page-up | pgup |
ignore |
Licence
The MIT License (MIT)
Copyright (c) 2013-2022 Andrea Bonomi andrea.bonomi@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.