DEFAULT_HEADER = ''
module-attribute
Default header
DEFAULT_LAYOUT = 'default'
module-attribute
Default layout
DEFAULT_MATCHER = 'extended'
module-attribute
Default matcher
DEFAULT_POINTER = '>'
module-attribute
Default pointer
DEFAULT_PROMPT = '> '
module-attribute
Default input prompt
Finder
Bases: ActionsHandler
Source code in pzp/finder.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
__init__(candidates, fullscreen=True, height=None, format_fn=lambda x: str(x), layout=DEFAULT_LAYOUT, info_style=InfoStyle.DEFAULT, pointer_str=DEFAULT_POINTER, prompt_str=DEFAULT_PROMPT, header_str=DEFAULT_HEADER, keys_binding=None, matcher=DEFAULT_MATCHER, lazy=False, output_stream=sys.stderr)
Initializate Finder object
Parameters:
Name | Type | Description | Default |
---|---|---|---|
candidates |
Union[Callable[[], Sequence[Any]], Iterator[Any], Sequence[Any]]
|
Candidates |
required |
fullscreen |
bool
|
Full screen mode |
True
|
height |
Optional[int]
|
Finder window height |
None
|
format_fn |
Callable[[Any], str]
|
Items format function |
lambda x: str(x)
|
layout |
Union[Type[Layout], str]
|
Finder layout |
DEFAULT_LAYOUT
|
info_style |
Union[InfoStyle, str]
|
Determines the display style of finder info |
InfoStyle.DEFAULT
|
pointer_str |
str
|
Pointer to the current line |
DEFAULT_POINTER
|
prompt_str |
str
|
Input prompt |
DEFAULT_PROMPT
|
header_str |
str
|
Header |
DEFAULT_HEADER
|
keys_binding |
Optional[KeysBinding]
|
Custom keys binding |
None
|
matcher |
Union[Matcher, Type[Matcher], str]
|
Matcher |
DEFAULT_MATCHER
|
lazy |
bool
|
Lazy mode, starts the finder only if the candidates are more than one |
False
|
output_stream |
TextIO
|
Output stream |
sys.stderr
|
Source code in pzp/finder.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
|
abort(key_event)
Cancel
Source code in pzp/finder.py
152 153 154 155 |
|
accept(key_event)
Confirm
Source code in pzp/finder.py
147 148 149 150 |
|
apply_filter()
Filter the items
Source code in pzp/finder.py
131 132 133 134 |
|
down()
Move one line down
Source code in pzp/finder.py
157 158 159 160 |
|
ignore()
Do nothing
Source code in pzp/finder.py
177 178 179 180 |
|
page_down()
Move one page down
Source code in pzp/finder.py
167 168 169 170 |
|
page_up()
Move one page up
Source code in pzp/finder.py
172 173 174 175 |
|
prepare_result()
Output the selected item, if any
Source code in pzp/finder.py
140 141 142 143 144 145 |
|
process_key(ch=None)
Process the pressed key
Source code in pzp/finder.py
120 121 122 123 124 125 126 127 128 129 |
|
refresh_candidates()
Load/reload the candidate list
Source code in pzp/finder.py
115 116 117 118 |
|
setup(input=None)
Setup Finder execution
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input |
Optional[str]
|
initial search string |
None
|
Source code in pzp/finder.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
|
show(input=None)
Open pzp and return the selected element
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input |
Optional[str]
|
initial search string |
None
|
Raises:
Type | Description |
---|---|
AcceptAction
|
Raises when the user presses a key that is mapped to the "accept" action. |
AbortAction
|
Raises when the user presses a key that is mapped to the "abort" action. |
CustomAction
|
Raises when the user presses a key that is mapped to the "custom" action. |
Source code in pzp/finder.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
up()
Move one line up
Source code in pzp/finder.py
162 163 164 165 |
|
update_screen()
Update the screen - erase the old items, print the filtered items and the prompt
Source code in pzp/finder.py
136 137 138 |
|