input¶
Hook for PyInquirer 'input' type prompts. Allows the user to input a string input. Source example
Inputs¶
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| message | str | None | False | String message to show when prompting. |
| default | Any | None | False | Default choice. |
Arguments¶
| Position | Argument | Type |
|---|---|---|
| 1 | message | str |
Returns¶
str
Examples¶
The input hook can be called in a number of ways
compact_implicit->: input
compact_with_question->: input Ask a question?
input_expanded:
->: input
message: A question?
default: things
? compact_implicit >>>
? Ask a question?
? A question? things
compact_implicit: <user input>
compact_with_question: <user input>
input_expanded: <user input>