FIREQ_CLIENT.prompt_completer#

Command completion for the client REPL.

Functions

make_prompt_session()

Create a PromptSession with history, completion and auto-suggestion.

Classes

CommandCompleter(*args, **kwargs)

Complete commands and command-specific arguments.
class FIREQ_CLIENT.prompt_completer.CommandCompleter(*args: Any, **kwargs: Any)[source]#

Bases: Completer

Complete commands and command-specific arguments.

get_completions(document: prompt_toolkit.document.Document, complete_event: prompt_toolkit.completion.CompleteEvent) → Iterable[prompt_toolkit.completion.Completion][source]#

Yield completions for the command or for the argument being typed.

Parameters:

  • document (Document) – the current prompt document.

  • complete_event (CompleteEvent) – the completion event.

Returns:

the completion suggestions.

Return type:

Iterable[Completion]

FIREQ_CLIENT.prompt_completer.make_prompt_session() → prompt_toolkit.PromptSession.<class 'str'>[source]#

Create a PromptSession with history, completion and auto-suggestion.

Returns:

the configured prompt session.

Return type:

PromptSession[str]