ask

• ChoiceTyped
• KeyInput
• NewHandlerChoice
• NonInteractivePromptError
• PromptMatch
• PromptSessionLockedError
• RaiseOnQuestionError
• SelectOptions
• confirm
• force_interactive
• question_patcher
• raise_on_question
• select_dict
• select_list
• select_list_choice
• select_list_multiple
• select_list_multiple_choices
• text

Symbol Details

class: ChoiceTyped

• source

  Since: 0.3.0

class ChoiceTyped:
    name: str
    value: ~T
    description: str | None = None
    checked: bool = False

Field	Type	Default	Since
name	str	-	0.3.0
value	~T	-	0.3.0
description	str | None	None	0.3.0
checked	bool	False	0.3.0

Changes

Version	Change
0.3.0	Made public

class: KeyInput

• source

  Since: 0.3.0

class KeyInput: ...

Changes

Version	Change
0.3.0	Made public

class: NewHandlerChoice

• source

  Since: 0.3.0

class NewHandlerChoice:
    constructor: Callable[[str], ~T]
    new_prompt: str

Field	Type	Default	Since
constructor	Callable[[str], ~T]	-	0.3.0
new_prompt	str	-	0.3.0

Changes

Version	Change
0.3.0	Made public

class: PromptMatch

• source

  Since: 0.3.0

class PromptMatch:
    response: str | None = None
    responses: list[str] = ...
    substring: str = ""
    exact: str = ""
    max_matches: int = 1
    matches_so_far: int = 0

Field	Type	Default	Since
response	str | None	None	0.3.0
responses	list[str]	...	0.3.0
substring	str	''	0.3.0
exact	str	''	0.3.0
max_matches	int	1	0.3.0
matches_so_far	int	0	0.3.0

Changes

Version	Change
0.3.0	Made public

function: confirm

• source

  Since: 0.3.0

def confirm(prompt_text: str, *, default: bool | None = None) -> bool: ...

Changes

Version	Change
0.3.0	Made public

class: force_interactive

• source

  Since: 0.3.0

class force_interactive:
    settings: AskShellSettings = ...

Field	Type	Default	Since
settings	AskShellSettings	...	0.3.0

Changes

Version	Change
0.3.0	Made public

function: select_dict

• source

  Since: 0.3.0

def select_dict(
    prompt_text: str, choices: dict[str, ~T], *, default: str | None = None, options: SelectOptions | None = None
) -> ~T: ...

Changes

Version	Change
0.3.0	Made public

function: select_list

• source

  Since: 0.3.0

def select_list(
    prompt_text: str, choices: list[str], *, default: str | None = None, options: SelectOptions | None = None
) -> str: ...

Changes

Version	Change
0.3.0	Made public

function: select_list_choice

• source

  Since: 0.3.0

def select_list_choice(
    prompt_text: str, choices: list[ChoiceTyped[~T]], *, default: ~T | None = None, options: SelectOptions | None = None
) -> ~T: ...

Changes

Version	Change
0.3.0	Made public

function: select_list_multiple

• source

  Since: 0.3.0

def select_list_multiple(
    prompt_text: str, choices: list[str], *, default: list[str] | None = None, options: SelectOptions | None = None
) -> list[str]: ...

Changes

Version	Change
0.3.0	Made public

function: select_list_multiple_choices

• source

  Since: 0.3.0

def select_list_multiple_choices(
    prompt_text: str,
    choices: list[ChoiceTyped[~T]],
    default: list[~T] | None = None,
    *,
    options: SelectOptions | None = None,
) -> list[~T]: ...

Changes

Version	Change
0.3.0	Made public

exception: PromptSessionLockedError

• source

  Since: 0.11.0

class PromptSessionLockedError(Exception): ...

Changes

Version	Change
0.11.0	Made public