1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
181
182
183
184
185
186
187
|
# fuzzy
A prompt that lists choices to select while also allowing fuzzy search like fzf.
## Example
```{note}
The following example will download a sample file and demos the performance of searching with 100k words.
```
<details>
<summary>Classic Syntax (PyInquirer)</summary>
```{eval-rst}
.. literalinclude :: ../../../examples/classic/fuzzy.py
:language: python
```
</details>
<details open>
<summary>Alternate Syntax</summary>
```{eval-rst}
.. literalinclude :: ../../../examples/alternate/fuzzy.py
:language: python
```
</details>
## Choices
```{seealso}
{ref}`pages/dynamic:choices`
```
```{attention}
This prompt does not accepts choices containing {ref}`pages/separator:Separator` instances.
```
## Keybindings
```{seealso}
{ref}`pages/kb:Keybindings`
```
```{hint}
This prompt does not enable `j/k` navigation when `vi_mode` is `True`. When `vi_mode` is `True` in fuzzy prompt, the input buffer
will become vim input mode, no other keybindings are altered.
The `space` key for toggle choice is also disabled since it blocks user from typing space in the input buffer.
```
```{include} ../kb.md
:start-after: <!-- start kb -->
:end-before: <!-- end kb -->
```
```{include} ./list.md
:start-after: <!-- start list kb -->
:end-before: <!-- end list kb -->
```
In addition, with the release of [0.3.2](https://github.com/kazhala/InquirerPy/releases/tag/0.3.2), you can now also toggle string matching algorithm.
```{seealso}
{ref}`pages/prompts/fuzzy:Exact Sub-String match`
```
```{code-block}
{
"toggle-exact": [] # toggle string matching algorithm between fuzzy or exact
}
```
## Multiple Selection
```{seealso}
{ref}`pages/prompts/list:Multiple Selection`
```
## Default Value
```{seealso}
{ref}`pages/dynamic:default`
```
The `default` parameter for this prompt will set the default search text in the input buffer (sort of replicate the behavior of fzf).
If you wish to pre-select certain choices, you can leverage the `enabled` parameter/key of each choice.
```{code-block} python
from InquirerPy.base import Choice
choices = [
Choice(1, enabled=True), # enabled by default
Choice(2) # not enabled
]
```
## Exact Sub-String Match
This prompt uses the [fzy](https://github.com/jhawthorn/fzy) fuzzy match algorithm by default. You can enable exact sub-string match
by using the parameter `match_exact`.
<details>
<summary>Classic Syntax (PyInquirer)</summary>
```{code-block} python
from InquirerPy import prompt
questions = [
{
"type": "fuzzy",
"message": "Select actions:",
"choices": ["hello", "weather", "what", "whoa", "hey", "yo"],
"match_exact": True,
"exact_symbol": " E", # indicator of exact match
},
]
result = prompt(questions=questions)
```
</details>
<details open>
<summary>Alternate Syntax</summary>
```{code-block} python
from InquirerPy import inquirer
result = inquirer.fuzzy(
message="Select actions:",
choices=["hello", "weather", "what", "whoa", "hey", "yo"],
match_exact=True,
exact_symbol=" E", # indicator of exact match
).execute()
```
</details>
You can also enable a keybinding to toggle the matching algorithm.
<details>
<summary>Classic Syntax (PyInquirer)</summary>
```{code-block} python
from InquirerPy import prompt
questions = [
{
"type": "fuzzy",
"message": "Select actions:",
"choices": ["hello", "weather", "what", "whoa", "hey", "yo"],
"keybindings": {"toggle-exact": [{"key": "c-t"}]},
},
]
result = prompt(questions=questions)
```
</details>
<details open>
<summary>Alternate Syntax</summary>
```{code-block} python
from InquirerPy import inquirer
result = inquirer.fuzzy(
message="Select actions:",
choices=["hello", "weather", "what", "whoa", "hey", "yo"],
keybindings={"toggle-exact": [{"key": "c-t"}]},
).execute()
```
</details>
## Reference
```{eval-rst}
.. autoclass:: InquirerPy.prompts.fuzzy.FuzzyPrompt
:noindex:
```
|
