python-prompt-toolkit API reference

400 public APIs from python-prompt-toolkit (prompt-toolkit/python-prompt-toolkit) — 92 classes, 123 functions, 185 methods. Signatures extracted by static analysis of the actual source.

Repository: prompt-toolkit/python-prompt-toolkit

Kind	Count
Classes	92
Functions	123
Methods	185

API list

classsrc.prompt_toolkit.application.application.Application

The main Application class!

methodsrc.prompt_toolkit.application.application.Application.color_depth() -> ColorDepth

The active :class:`.ColorDepth`.

methodsrc.prompt_toolkit.application.application.Application.exit() -> None

Exit without arguments.

methodsrc.prompt_toolkit.application.application.Application.get_used_style_strings() -> list[str]

Return a list of used style strings.

methodsrc.prompt_toolkit.application.application.Application.reset() -> None

Reset everything, for reading the next input.

func

src.prompt_toolkit.application.current.create_app_session(input:Input | None=None, output:Output | None=None) -> Generator[AppSession, None, None]

Create a separate AppSession.

funcsrc.prompt_toolkit.application.current.get_app() -> Application[Any]

Get the current active (running) Application.

classsrc.prompt_toolkit.auto_suggest.AutoSuggest

Base class for auto suggestion implementations.

methodsrc.prompt_toolkit.auto_suggest.AutoSuggest.get_suggestion(buffer:Buffer, document:Document) -> Suggestion | None

Return `None` or a :class:`.Suggestion` instance.

classsrc.prompt_toolkit.auto_suggest.Suggestion

Suggestion returned by an auto-suggest algorithm.

classsrc.prompt_toolkit.auto_suggest.ThreadedAutoSuggest

Wrapper that runs auto suggestions in a thread.

methodsrc.prompt_toolkit.buffer.Buffer.append_to_history() -> None

Append the current input to the history.

methodsrc.prompt_toolkit.buffer.Buffer.apply_completion(completion:Completion) -> None

Insert a given completion.

method

src.prompt_toolkit.buffer.Buffer.apply_search(search_state:SearchState, include_current_position:bool=True, count:int=1) -> None

Apply search.

methodsrc.prompt_toolkit.buffer.Buffer.complete_next(count:int=1, disable_wrap_around:bool=False) -> None

Browse to the next completions.

methodsrc.prompt_toolkit.buffer.Buffer.complete_previous(count:int=1, disable_wrap_around:bool=False) -> None

Browse to the previous completions.

methodsrc.prompt_toolkit.buffer.Buffer.cursor_down(count:int=1) -> None

(for multiline edit).

methodsrc.prompt_toolkit.buffer.Buffer.cursor_up(count:int=1) -> None

(for multiline edit).

method

src.prompt_toolkit.buffer.Buffer.get_search_position(search_state:SearchState, include_current_position:bool=True, count:int=1) -> int

Get the cursor position for this search.

methodsrc.prompt_toolkit.buffer.Buffer.go_to_completion(index:int | None) -> None

Select a completion from the list of current completions.

methodsrc.prompt_toolkit.buffer.Buffer.go_to_history(index:int) -> None

Go to this item in the history.

methodsrc.prompt_toolkit.buffer.Buffer.history_backward(count:int=1) -> None

Move backwards through history.

methodsrc.prompt_toolkit.buffer.Buffer.history_forward(count:int=1) -> None

Move forwards through the history.

methodsrc.prompt_toolkit.buffer.Buffer.insert_line_above(copy_margin:bool=True) -> None

Insert a new line above the current one.

methodsrc.prompt_toolkit.buffer.Buffer.insert_line_below(copy_margin:bool=True) -> None

Insert a new line below the current one.

method

src.prompt_toolkit.buffer.Buffer.insert_text(data:str, overwrite:bool=False, move_cursor:bool=True, fire_event:bool=True) -> None

Insert characters at cursor position.

methodsrc.prompt_toolkit.buffer.Buffer.is_returnable() -> bool

True when there is something handling accept.

methodsrc.prompt_toolkit.buffer.Buffer.join_selected_lines(separator:str=' ') -> None

Join the selected lines.

methodsrc.prompt_toolkit.buffer.Buffer.newline(copy_margin:bool=True) -> None

Insert a line ending at the current position.

methodsrc.prompt_toolkit.buffer.Buffer.open_in_editor(validate_and_handle:bool=False) -> asyncio.Task[None]

Open code in editor.

method

src.prompt_toolkit.buffer.Buffer.paste_clipboard_data(data:ClipboardData, paste_mode:PasteMode=PasteMode.EMACS, count:int=1) -> None

Insert the data from the clipboard.

funcsrc.prompt_toolkit.buffer.Buffer.proceed() -> bool

Keep retrieving completions.

funcsrc.prompt_toolkit.buffer.Buffer.search_once(working_index:int, document:Document) -> tuple[int, Document] | None

Do search one time.

method

src.prompt_toolkit.buffer.Buffer.transform_lines(line_index_iterator:Iterable[int], transform_callback:Callable[[str], str]) -> str

Transforms the text on a range of lines.

methodsrc.prompt_toolkit.buffer.Buffer.transform_region(from_:int, to:int, transform_callback:Callable[[str], str]) -> None

Transform a part of the input string.

methodsrc.prompt_toolkit.buffer.Buffer.validate(set_cursor:bool=False) -> bool

Returns `True` if valid.

methodsrc.prompt_toolkit.buffer.Buffer.validate_and_handle() -> None

Validate buffer and handle the accept action.

classsrc.prompt_toolkit.buffer.CompletionState

Immutable class that contains a completion state.

classsrc.prompt_toolkit.buffer.EditReadOnlyBuffer

Attempt editing of read-only :class:`.Buffer`.

classsrc.prompt_toolkit.buffer.ValidationState

The validation state of a buffer.

funcsrc.prompt_toolkit.buffer.indent(buffer:Buffer, from_row:int, to_row:int, count:int=1) -> None

Indent text of a :class:`.Buffer` object.

funcsrc.prompt_toolkit.buffer.reshape_text(buffer:Buffer, from_row:int, to_row:int) -> None

Reformat text, taking the width into account.

funcsrc.prompt_toolkit.buffer.unindent(buffer:Buffer, from_row:int, to_row:int, count:int=1) -> None

Unindent text of a :class:`.Buffer` object.

methodsrc.prompt_toolkit.cache.SimpleCache.clear() -> None

Clear cache.

methodsrc.prompt_toolkit.cache.SimpleCache.get(key:_T, getter_func:Callable[[], _U]) -> _U

Get object from the cache.

classsrc.prompt_toolkit.clipboard.base.Clipboard

Abstract baseclass for clipboards.

methodsrc.prompt_toolkit.clipboard.base.Clipboard.get_data() -> ClipboardData

Return clipboard data.

methodsrc.prompt_toolkit.clipboard.base.Clipboard.rotate() -> None

For Emacs mode, rotate the kill ring.

methodsrc.prompt_toolkit.clipboard.base.Clipboard.set_data(data:ClipboardData) -> None

Set data to the clipboard.

methodsrc.prompt_toolkit.clipboard.base.Clipboard.set_text(text:str) -> None

Shortcut for setting plain text on clipboard.

classsrc.prompt_toolkit.clipboard.base.ClipboardData

Text on the clipboard.

classsrc.prompt_toolkit.clipboard.in_memory.InMemoryClipboard

Default clipboard implementation.

classsrc.prompt_toolkit.completion.base.CompleteEvent

Event that called the completer.

classsrc.prompt_toolkit.completion.base.Completer

Base class for completer implementations.

methodsrc.prompt_toolkit.completion.base.Completion.display_meta() -> StyleAndTextTuples

Return meta-text.

methodsrc.prompt_toolkit.completion.base.Completion.display_meta_text() -> str

The 'meta' field as plain text.

methodsrc.prompt_toolkit.completion.base.Completion.display_text() -> str

The 'display' field as plain text.

classsrc.prompt_toolkit.completion.base.DummyCompleter

A completer that doesn't return any completion.

func

src.prompt_toolkit.completion.base.get_common_complete_suffix(document:Document, completions:Sequence[Completion]) -> str

Return the common prefix for all completions.

funcsrc.prompt_toolkit.completion.base.merge_completers(completers:Sequence[Completer], deduplicate:bool=False) -> Completer

Combine several completers into one.

classsrc.prompt_toolkit.completion.filesystem.PathCompleter

Complete for Path variables.

classsrc.prompt_toolkit.completion.fuzzy_completer.FuzzyCompleter

Fuzzy completion.

classsrc.prompt_toolkit.completion.fuzzy_completer.FuzzyWordCompleter

Fuzzy completion on a list of words.

classsrc.prompt_toolkit.completion.word_completer.WordCompleter

Simple autocompletion on a list of words.

funcsrc.prompt_toolkit.completion.word_completer.WordCompleter.word_matches(word:str) -> bool

True when the word before the cursor matches.

classsrc.prompt_toolkit.contrib.completers.system.SystemCompleter

Completer for system commands.

classsrc.prompt_toolkit.contrib.regular_languages.compiler.Match

:param string: The input string.

methodsrc.prompt_toolkit.contrib.regular_languages.compiler.Match.variables() -> Variables

Returns :class:`Variables` instance.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.AnyNode

Union operation (OR operation) between several grammars.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.Lookahead

Lookahead expression.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.Node

Base class for all the grammar nodes.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.NodeSequence

Concatenation operation of several grammars.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.Regex

Regular expression.

classsrc.prompt_toolkit.contrib.regular_languages.regex_parser.Variable

Mark a variable in the regular grammar.

classsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser

Parser for the Telnet protocol.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.do_received(data:bytes) -> None

Received telnet DO command.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.dont_received(data:bytes) -> None

Received telnet DONT command.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.feed(data:bytes) -> None

Feed data to the parser.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.naws(data:bytes) -> None

Received NAWS.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.negotiate(data:bytes) -> None

Got negotiate data.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.ttype(data:bytes) -> None

Received terminal type.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.will_received(data:bytes) -> None

Received telnet WILL command.

methodsrc.prompt_toolkit.contrib.telnet.protocol.TelnetProtocolParser.wont_received(data:bytes) -> None

Received telnet WONT command.

classsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection

Class that represents one Telnet connection.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.close() -> None

Closed by client.

funcsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.data_received(data:bytes) -> None

TelnetProtocolParser 'data_received' callback

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.feed(data:bytes) -> None

Handler for incoming data.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.run_application() -> None

Run application.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.send(formatted_text:AnyFormattedText) -> None

Send text to the client.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.send_above_prompt(formatted_text:AnyFormattedText) -> None

Send text to the client.

funcsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.size_received(rows:int, columns:int) -> None

TelnetProtocolParser 'size_received' callback

funcsrc.prompt_toolkit.contrib.telnet.server.TelnetConnection.ttype_received(ttype:str) -> None

TelnetProtocolParser 'ttype_received' callback

classsrc.prompt_toolkit.contrib.telnet.server.TelnetServer

Telnet server implementation.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetServer.run(ready_cb:Callable[[], None] | None=None) -> None

Run the telnet server, until this gets cancelled.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetServer.start() -> None

Deprecated: Use `.run()` instead.

methodsrc.prompt_toolkit.contrib.telnet.server.TelnetServer.stop() -> None

Deprecated: Use `.run()` instead.

classsrc.prompt_toolkit.cursor_shapes.SimpleCursorShapeConfig

Always show the given cursor shape.

methodsrc.prompt_toolkit.document.Document.cursor_position() -> int

The document cursor position.

methodsrc.prompt_toolkit.document.Document.cursor_position_col() -> int

Current column.

methodsrc.prompt_toolkit.document.Document.cursor_position_row() -> int

Current row.

methodsrc.prompt_toolkit.document.Document.end_of_paragraph(count:int=1, after:bool=False) -> int

Return the end of the current paragraph.

methodsrc.prompt_toolkit.document.Document.find_all(sub:str, ignore_case:bool=False) -> list[int]

Find all occurrences of the substring.

method

src.prompt_toolkit.document.Document.find_next_matching_line(match_func:Callable[[str], bool], count:int=1) -> int | None

Look downwards for empty lines.

method

src.prompt_toolkit.document.Document.find_previous_matching_line(match_func:Callable[[str], bool], count:int=1) -> int | None

Look upwards for empty lines.

methodsrc.prompt_toolkit.document.Document.get_cursor_left_position(count:int=1) -> int

Relative position for cursor left.

methodsrc.prompt_toolkit.document.Document.get_cursor_right_position(count:int=1) -> int

Relative position for cursor_right.

methodsrc.prompt_toolkit.document.Document.get_end_of_line_position() -> int

Relative position for the end of this line.

methodsrc.prompt_toolkit.document.Document.get_start_of_line_position(after_whitespace:bool=False) -> int

Relative position for the start of this line.

methodsrc.prompt_toolkit.document.Document.get_word_before_cursor(WORD:bool=False, pattern:Pattern[str] | None=None) -> str

Give the word before the cursor.

methodsrc.prompt_toolkit.document.Document.get_word_under_cursor(WORD:bool=False) -> str

Return the word, currently below the cursor.

methodsrc.prompt_toolkit.document.Document.line_count() -> int

Return the number of lines in this document.

methodsrc.prompt_toolkit.document.Document.lines() -> list[str]

Array of all the lines.

methodsrc.prompt_toolkit.document.Document.on_first_line() -> bool

True when we are at the first line.

methodsrc.prompt_toolkit.document.Document.on_last_line() -> bool

True when we are at the last line.

methodsrc.prompt_toolkit.document.Document.selection() -> SelectionState | None

:class:`.SelectionState` object.

methodsrc.prompt_toolkit.document.Document.selection_range() -> tuple[int, int]

Return (from, to) tuple of the selection.

methodsrc.prompt_toolkit.document.Document.start_of_paragraph(count:int=1, before:bool=False) -> int

Return the start of the current paragraph.

methodsrc.prompt_toolkit.document.Document.text() -> str

The document text.

methodsrc.prompt_toolkit.document.Document.translate_row_col_to_index(row:int, col:int) -> int

Given a (row, col) tuple, return the corresponding index.

funcsrc.prompt_toolkit.eventloop.async_generator.runner() -> None

Consume the generator in background thread.

classsrc.prompt_toolkit.eventloop.inputhook.InputHookContext

Given as a parameter to the inputhook.

funcsrc.prompt_toolkit.eventloop.utils.get_traceback_from_context(context:dict[str, Any]) -> TracebackType | None

Get the traceback object from the context.

funcsrc.prompt_toolkit.eventloop.win32.create_win32_event() -> HANDLE

Creates a Win32 unnamed Event .

funcsrc.prompt_toolkit.eventloop.win32.wait_for_handles(handles:list[HANDLE], timeout:int=INFINITE) -> HANDLE | None

Waits for multiple handles.

funcsrc.prompt_toolkit.filters.app.completion_is_selected() -> bool

True when the user selected a completion.

funcsrc.prompt_toolkit.filters.app.control_is_searchable() -> bool

When the current UIControl is searchable.

funcsrc.prompt_toolkit.filters.app.emacs_mode() -> bool

When the Emacs bindings are active.

funcsrc.prompt_toolkit.filters.app.has_arg() -> bool

Enable when the input processor has an 'arg'.

funcsrc.prompt_toolkit.filters.app.has_completions() -> bool

Enable when the current buffer has completions.

funcsrc.prompt_toolkit.filters.app.has_focus(value:FocusableElement) -> Condition

Enable when this buffer has the focus.

funcsrc.prompt_toolkit.filters.app.has_selection() -> bool

Enable when the current buffer has a selection.

funcsrc.prompt_toolkit.filters.app.has_suggestion() -> bool

Enable when the current buffer has a suggestion.

funcsrc.prompt_toolkit.filters.app.has_validation_error() -> bool

Current buffer has validation error.

funcsrc.prompt_toolkit.filters.app.in_editing_mode(editing_mode:EditingMode) -> Condition

Check whether a given editing mode is active.

funcsrc.prompt_toolkit.filters.app.is_read_only() -> bool

True when the current buffer is read only.

funcsrc.prompt_toolkit.filters.app.is_searching() -> bool

When we are searching.

funcsrc.prompt_toolkit.filters.app.vi_recording_macro() -> bool

When recording a Vi macro.

classsrc.prompt_toolkit.filters.base.Always

Always enable feature.

classsrc.prompt_toolkit.filters.base.Condition

Turn any callable into a Filter.

classsrc.prompt_toolkit.filters.base.Never

Never enable feature.

funcsrc.prompt_toolkit.filters.utils.is_true(value:FilterOrBool) -> bool

Test whether `value` is True.

classsrc.prompt_toolkit.formatted_text.ansi.ANSI

ANSI formatted text.

funcsrc.prompt_toolkit.formatted_text.ansi.ansi_escape(text:object) -> str

Replace characters with a special meaning.

classsrc.prompt_toolkit.formatted_text.base.FormattedText

A list of ``(style, text)`` tuples.

classsrc.prompt_toolkit.formatted_text.html.HTML

HTML formatted text.

funcsrc.prompt_toolkit.formatted_text.html.HTML.get_current_style() -> str

Build style string for current node.

funcsrc.prompt_toolkit.formatted_text.html.HTML.process_node(node:Any) -> None

Process node recursively.

funcsrc.prompt_toolkit.formatted_text.utils.fragment_list_to_text(fragments:StyleAndTextTuples) -> str

Concatenate all the text parts again.

funcsrc.prompt_toolkit.formatted_text.utils.fragment_list_width(fragments:StyleAndTextTuples) -> int

Return the character width of this text fragment list.

funcsrc.prompt_toolkit.formatted_text.utils.to_plain_text(value:AnyFormattedText) -> str

Turn any kind of formatted text back into plain text.

classsrc.prompt_toolkit.history.History

Base ``History`` class.

methodsrc.prompt_toolkit.history.History.append_string(string:str) -> None

Add string to the history.

methodsrc.prompt_toolkit.history.History.store_string(string:str) -> None

Store the string in persistent storage.

classsrc.prompt_toolkit.input.base.Input

Abstraction for any input.

methodsrc.prompt_toolkit.input.base.Input.close() -> None

Close input.

methodsrc.prompt_toolkit.input.base.Input.closed() -> bool

Should be true when the input stream is closed.

methodsrc.prompt_toolkit.input.base.Input.fileno() -> int

Fileno for putting this in an event loop.

methodsrc.prompt_toolkit.input.base.Input.flush_keys() -> list[KeyPress]

Flush the underlying parser.

methodsrc.prompt_toolkit.input.base.Input.typeahead_hash() -> str

Identifier for storing type ahead key presses.

classsrc.prompt_toolkit.input.base.PipeInput

Abstraction for pipe input.

methodsrc.prompt_toolkit.input.base.PipeInput.send_bytes(data:bytes) -> None

Feed byte string into the pipe

methodsrc.prompt_toolkit.input.base.PipeInput.send_text(data:str) -> None

Feed a text string into the pipe

funcsrc.prompt_toolkit.input.defaults.create_pipe_input() -> AbstractContextManager[PipeInput]

Create an input pipe.

classsrc.prompt_toolkit.input.posix_pipe.PosixPipeInput

Input that is send through a pipe.

methodsrc.prompt_toolkit.input.posix_pipe.PosixPipeInput.close() -> None

Close pipe fds.

methodsrc.prompt_toolkit.input.posix_pipe.PosixPipeInput.send_text(data:str) -> None

Send text to the input.

funcsrc.prompt_toolkit.input.typeahead.clear_typeahead(input_obj:Input) -> None

Clear typeahead buffer.

funcsrc.prompt_toolkit.input.typeahead.get_typeahead(input_obj:Input) -> list[KeyPress]

Retrieve typeahead and reset the buffer for this input.

funcsrc.prompt_toolkit.input.typeahead.store_typeahead(input_obj:Input, key_presses:list[KeyPress]) -> None

Insert typeahead key presses for the given input.

classsrc.prompt_toolkit.input.vt100.Vt100Input

Vt100 input for Posix systems.

methodsrc.prompt_toolkit.input.vt100.Vt100Input.flush_keys() -> list[KeyPress]

Flush pending keys and return them.

methodsrc.prompt_toolkit.input.vt100.Vt100Input.read_keys() -> list[KeyPress]

Read list of KeyPress.

classsrc.prompt_toolkit.input.vt100_parser.Vt100Parser

Parser for VT100 input stream.

methodsrc.prompt_toolkit.input.vt100_parser.Vt100Parser.feed(data:str) -> None

Feed the input stream.

methodsrc.prompt_toolkit.input.vt100_parser.Vt100Parser.feed_and_flush(data:str) -> None

Wrapper around ``feed`` and ``flush``.

methodsrc.prompt_toolkit.input.vt100_parser.Vt100Parser.flush() -> None

Flush the buffer of the input stream.

classsrc.prompt_toolkit.input.win32.Win32Input

`Input` class that reads from the Windows console.

classsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput

This is an input pipe that works on Windows.

methodsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput.close() -> None

Close write-end of the pipe.

methodsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput.flush_keys() -> list[KeyPress]

Flush pending keys and return them.

methodsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput.read_keys() -> list[KeyPress]

Read list of KeyPress.

methodsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput.send_bytes(data:bytes) -> None

Send bytes to the input.

methodsrc.prompt_toolkit.input.win32_pipe.Win32PipeInput.send_text(text:str) -> None

Send text to the input.

funcsrc.prompt_toolkit.key_binding.bindings.completion.run_compl() -> None

Coroutine.

funcsrc.prompt_toolkit.key_binding.bindings.emacs.handle_digit(c:str) -> None

Handle input of arguments.

funcsrc.prompt_toolkit.key_binding.bindings.emacs.load_emacs_bindings() -> KeyBindingsBase

Some e-macs extensions.

funcsrc.prompt_toolkit.key_binding.bindings.emacs.unshift_move(event:E) -> None

Used for the shift selection mode.

funcsrc.prompt_toolkit.key_binding.bindings.focus.focus_next(event:E) -> None

Focus the next visible Window.

funcsrc.prompt_toolkit.key_binding.bindings.focus.focus_previous(event:E) -> None

Focus the previous visible Window.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.accept_line(event:E) -> None

Accept the line regardless of where the cursor is.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.backward_char(event:E) -> None

Move back a character.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.backward_delete_char(event:E) -> None

Delete the character behind the cursor.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.beginning_of_buffer(event:E) -> None

Move to the start of the buffer.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.beginning_of_history(event:E) -> None

Move to the first line in the history.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.beginning_of_line(event:E) -> None

Move to the start of the current line.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.capitalize_word(event:E) -> None

Capitalize the current (or following) word.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.complete(event:E) -> None

Attempt to perform completion.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.decorator(handler:_T) -> _T

`handler` is a callable or Binding.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.delete_char(event:E) -> None

Delete character before the cursor.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.delete_horizontal_space(event:E) -> None

Delete all spaces and tabs around point.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.downcase_word(event:E) -> None

Lowercase the current (or following) word.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.emacs_editing_mode(event:E) -> None

Switch to Emacs editing mode.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.end_of_buffer(event:E) -> None

Move to the end of the buffer.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.end_of_file(event:E) -> None

Exit.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.end_of_line(event:E) -> None

Move to the end of the line.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.forward_char(event:E) -> None

Move forward a character.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.forward_word(event:E) -> None

Move forward to the end of the next word.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.insert_comment(event:E) -> None

Without numeric argument, comment all lines.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.kill_line(event:E) -> None

Kill the text from the cursor to the end of the line.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.menu_complete(event:E) -> None

Generate completions, or go to the next completion.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.prefix_meta(event:E) -> None

Metafy the next character typed.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.print_last_kbd_macro(event:E) -> None

Print the last keyboard macro.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.quoted_insert(event:E) -> None

Add the next character typed to the line verbatim.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.redraw_current_line(event:E) -> None

Refresh the current line.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.register(name:str) -> Callable[[_T], _T]

Store handler in the `_readline_commands` dictionary.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.self_insert(event:E) -> None

Insert yourself.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.undo(event:E) -> None

Incremental undo.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.uppercase_word(event:E) -> None

Uppercase the current (or following) word.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.vi_editing_mode(event:E) -> None

Switch to Vi editing mode.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.yank(event:E) -> None

Paste before cursor.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.yank_nth_arg(event:E) -> None

Insert the first argument of the previous command.

funcsrc.prompt_toolkit.key_binding.bindings.named_commands.yank_pop(event:E) -> None

Rotate the kill ring, and yank the new top.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_backward(event:E, half:bool=False) -> None

Scroll window up.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_forward(event:E, half:bool=False) -> None

Scroll window down.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_half_page_down(event:E) -> None

Same as ControlF, but only scroll half a page.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_half_page_up(event:E) -> None

Same as ControlB, but only scroll half a page.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_one_line_down(event:E) -> None

scroll_offset += 1

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_one_line_up(event:E) -> None

scroll_offset -= 1

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_page_down(event:E) -> None

Scroll page down.

funcsrc.prompt_toolkit.key_binding.bindings.scroll.scroll_page_up(event:E) -> None

Scroll page up.

funcsrc.prompt_toolkit.key_binding.bindings.search.accept_search(event:E) -> None

When enter pressed in isearch, quit isearch mode.

funcsrc.prompt_toolkit.key_binding.bindings.search.start_forward_incremental_search(event:E) -> None

Enter forward incremental search.

funcsrc.prompt_toolkit.key_binding.bindings.search.start_reverse_incremental_search(event:E) -> None

Enter reverse incremental search.

methodsrc.prompt_toolkit.key_binding.bindings.vi.TextObject.cut(buffer:Buffer) -> tuple[Document, ClipboardData]

Turn text object into `ClipboardData` instance.

methodsrc.prompt_toolkit.key_binding.bindings.vi.TextObject.get_line_numbers(buffer:Buffer) -> tuple[int, int]

Return a (start_line, end_line) pair.

methodsrc.prompt_toolkit.key_binding.bindings.vi.TextObject.sorted() -> tuple[int, int]

Return a (start, end) tuple where start <= end.

func

src.prompt_toolkit.key_binding.bindings.vi.create_delete_and_change_operators(delete_only:bool, with_register:bool=False) -> None

Delete and change operators.

funcsrc.prompt_toolkit.key_binding.bindings.vi.insert_in_block_selection(event:E, after:bool=False) -> None

Insert in block selection mode.

funcsrc.prompt_toolkit.key_binding.bindings.vi.load_vi_bindings() -> KeyBindingsBase

Vi extensions.

func

src.prompt_toolkit.key_binding.bindings.vi.operator_decorator(*filter:Filter=Always(), *eager:bool=False, *keys:Keys | str) -> Callable[[_OF], _OF]

funcsrc.prompt_toolkit.key_binding.bindings.vi.repeat(reverse:bool) -> None

Create ',' and ';' commands.

classsrc.prompt_toolkit.key_binding.emacs_state.EmacsState

Mutable class to hold Emacs specific state.

methodsrc.prompt_toolkit.key_binding.emacs_state.EmacsState.end_macro() -> None

End recording macro.

methodsrc.prompt_toolkit.key_binding.emacs_state.EmacsState.is_recording() -> bool

Tell whether we are recording a macro.

methodsrc.prompt_toolkit.key_binding.emacs_state.EmacsState.start_macro() -> None

Start recording macro.

classsrc.prompt_toolkit.key_binding.key_bindings.Binding

Key binding: (key sequence + handler + filter).

classsrc.prompt_toolkit.key_binding.key_bindings.ConditionalKeyBindings

Wraps around a `KeyBindings`.

classsrc.prompt_toolkit.key_binding.key_bindings.KeyBindings

A container for a set of key bindings.

methodsrc.prompt_toolkit.key_binding.key_bindings.KeyBindings.remove(*args:Keys | str | KeyHandlerCallable) -> None

Remove a key binding.

classsrc.prompt_toolkit.key_binding.key_bindings.KeyBindingsBase

Interface for a KeyBindings.

methodsrc.prompt_toolkit.key_binding.key_bindings.KeyBindingsBase.bindings() -> list[Binding]

List of `Binding` objects.

classsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent

Key press event, delivered to key bindings.

methodsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent.app() -> Application[Any]

The current `Application` object.

methodsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent.append_to_arg_count(data:str) -> None

Add digit to the input argument.

methodsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent.arg() -> int

Repetition argument.

methodsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent.cli() -> Application[Any]

For backward-compatibility.

methodsrc.prompt_toolkit.key_binding.key_processor.KeyPressEvent.current_buffer() -> Buffer

The current buffer.

funcsrc.prompt_toolkit.key_binding.key_processor.KeyProcessor.flush_keys() -> None

Flush keys.

funcsrc.prompt_toolkit.key_binding.key_processor.KeyProcessor.wait() -> None

Wait for timeout.

classsrc.prompt_toolkit.keys.Keys

List of keys for use in key bindings.

classsrc.prompt_toolkit.layout.containers.ColorColumn

Column for a :class:`.Window` to be colored.

classsrc.prompt_toolkit.layout.containers.Container

Base class for user interface layout.

classsrc.prompt_toolkit.layout.containers.Float

Float for use in a :class:`.FloatContainer`.

classsrc.prompt_toolkit.layout.containers.HSplit

Several layouts, one stacked above/under the other.

classsrc.prompt_toolkit.layout.containers.HorizontalAlign

Alignment for `VSplit`.

classsrc.prompt_toolkit.layout.containers.ScrollOffsets

Scroll offsets for the :class:`.Window` class.

classsrc.prompt_toolkit.layout.containers.VerticalAlign

Alignment for `HSplit`.

classsrc.prompt_toolkit.layout.containers.Window

Container that holds a control.

func

src.prompt_toolkit.layout.containers.Window.do_scroll(current_scroll:int, scroll_offset_start:int, scroll_offset_end:int, cursor_pos:int, window_size:int, content_size:int) -> int

Scrolling algorithm.

methodsrc.prompt_toolkit.layout.containers.Window.preferred_height(width:int, max_available_height:int) -> Dimension

Calculate the preferred height for this window.

methodsrc.prompt_toolkit.layout.containers.Window.preferred_width(max_available_width:int) -> Dimension

Calculate the preferred width for this window.

funcsrc.prompt_toolkit.layout.containers.Window.render_margin(m:Margin, width:int) -> UIContent

Render margin.

method

src.prompt_toolkit.layout.containers.Window.write_to_screen(screen:Screen, mouse_handlers:MouseHandlers, write_position:WritePosition, parent_style:str, erase_bg:bool, z_index:int | None) -> None

Write window to screen.

classsrc.prompt_toolkit.layout.containers.WindowAlign

Alignment of the Window content.

funcsrc.prompt_toolkit.layout.containers.to_container(container:AnyContainer) -> Container

Make sure that the given object is a :class:`.Container`.

funcsrc.prompt_toolkit.layout.containers.to_window(container:AnyContainer) -> Window

Make sure that the given argument is a :class:`.Window`.

funcsrc.prompt_toolkit.layout.controls.BufferControl.get_line(i:int) -> StyleAndTextTuples

Return the fragments for a given line number.

funcsrc.prompt_toolkit.layout.controls.BufferControl.translate_rowcol(row:int, col:int) -> Point

Return the content column for this coordinate.

classsrc.prompt_toolkit.layout.controls.FormattedTextControl

Control that displays formatted text.

methodsrc.prompt_toolkit.layout.controls.FormattedTextControl.mouse_handler(mouse_event:MouseEvent) -> NotImplementedOrNone

Handle mouse events.

methodsrc.prompt_toolkit.layout.controls.FormattedTextControl.preferred_width(max_available_width:int) -> int

Return the preferred width for this control.

classsrc.prompt_toolkit.layout.controls.UIContent

Content generated by a user control.

classsrc.prompt_toolkit.layout.controls.UIControl

Base class for all user interface controls.

methodsrc.prompt_toolkit.layout.controls.UIControl.create_content(width:int, height:int) -> UIContent

Generate the content for this user control.

methodsrc.prompt_toolkit.layout.controls.UIControl.get_invalidate_events() -> Iterable[Event[object]]

Return a list of `Event` objects.

methodsrc.prompt_toolkit.layout.controls.UIControl.is_focusable() -> bool

Tell whether this user control is focusable.

methodsrc.prompt_toolkit.layout.controls.UIControl.mouse_handler(mouse_event:MouseEvent) -> NotImplementedOrNone

Handle mouse events.

methodsrc.prompt_toolkit.layout.controls.UIControl.move_cursor_down() -> None

Request to move the cursor down.

methodsrc.prompt_toolkit.layout.controls.UIControl.move_cursor_up() -> None

Request to move the cursor up.

methodsrc.prompt_toolkit.layout.dimension.Dimension.exact(amount:int) -> Dimension

Return a :class:`.Dimension` with an exact size.

funcsrc.prompt_toolkit.layout.dimension.sum_layout_dimensions(dimensions:list[Dimension]) -> Dimension

Sum a list of :class:`.Dimension` instances.

funcsrc.prompt_toolkit.layout.dimension.to_dimension(value:AnyDimension) -> Dimension

Turn the given object into a `Dimension` object.

methodsrc.prompt_toolkit.layout.layout.Layout.focus(value:FocusableElement) -> None

Focus the given UI element.

methodsrc.prompt_toolkit.layout.layout.Layout.focus_last() -> None

Give the focus to the last focused control.

methodsrc.prompt_toolkit.layout.layout.Layout.focus_next() -> None

Focus the next visible/focusable Window.

methodsrc.prompt_toolkit.layout.layout.Layout.focus_previous() -> None

Focus the previous visible/focusable Window.

methodsrc.prompt_toolkit.layout.layout.Layout.has_focus(value:FocusableElement) -> bool

Check whether the given control has the focus.

methodsrc.prompt_toolkit.layout.layout.Layout.is_searching() -> bool

True if we are searching right now.

funcsrc.prompt_toolkit.layout.layout.walk(container:Container, skip_hidden:bool=False) -> Iterable[Container]

Walk through layout, starting at this container.

classsrc.prompt_toolkit.layout.margins.Margin

Base interface for a margin.

method

src.prompt_toolkit.layout.margins.Margin.create_margin(window_render_info:WindowRenderInfo, width:int, height:int) -> StyleAndTextTuples

Creates a margin.

classsrc.prompt_toolkit.layout.margins.NumberedMargin

Margin that displays the line numbers.

methodsrc.prompt_toolkit.layout.margins.PromptMargin.get_width(get_ui_content:Callable[[], UIContent]) -> int

Width to report to the `Window`.

classsrc.prompt_toolkit.layout.margins.ScrollbarMargin

Margin displaying a scrollbar.

funcsrc.prompt_toolkit.layout.margins.ScrollbarMargin.is_scroll_button(row:int) -> bool

True if we should display a button on this row.

funcsrc.prompt_toolkit.layout.mouse_handlers.MouseHandlers.dummy_callback(mouse_event:MouseEvent) -> NotImplementedOrNone

:param mouse_event: `MouseEvent` instance.

classsrc.prompt_toolkit.layout.processors.AfterInput

Insert text after the input.

classsrc.prompt_toolkit.layout.processors.AppendAutoSuggestion

Append the auto suggestion to the input.

classsrc.prompt_toolkit.layout.processors.BeforeInput

Insert text before the input.

classsrc.prompt_toolkit.layout.processors.DummyProcessor

A `Processor` that doesn't do anything.

classsrc.prompt_toolkit.layout.processors.PasswordProcessor

Processor that masks the input.

method

src.prompt_toolkit.layout.processors.Processor.apply_transformation(transformation_input:TransformationInput) -> Transformation

Apply transformation.

classsrc.prompt_toolkit.layout.processors.ShowArg

Display the 'arg' in front of the input.

classsrc.prompt_toolkit.layout.processors.ShowLeadingWhiteSpaceProcessor

Make leading whitespace visible.

classsrc.prompt_toolkit.layout.processors.ShowTrailingWhiteSpaceProcessor

Make trailing whitespace visible.

funcsrc.prompt_toolkit.layout.processors.TabsProcessor.display_to_source(display_pos:int) -> int

Maps display cursor position to the original one.

funcsrc.prompt_toolkit.layout.processors.TabsProcessor.source_to_display(from_position:int) -> int

Maps original cursor position to the new one.

funcsrc.prompt_toolkit.layout.processors.merge_processors(processors:list[Processor]) -> Processor

Merge multiple `Processor` objects into one.

classsrc.prompt_toolkit.layout.screen.Char

Represent a single character in a :class:`.Screen`.

classsrc.prompt_toolkit.layout.screen.Screen

Two dimensional buffer of :class:`.Char` instances.

methodsrc.prompt_toolkit.layout.screen.Screen.append_style_to_content(style_str:str) -> None

For all the characters in the screen.

methodsrc.prompt_toolkit.layout.screen.Screen.draw_all_floats() -> None

Draw all float functions in order of z-index.

methodsrc.prompt_toolkit.layout.screen.Screen.get_cursor_position(window:Window) -> Point

Get the cursor position for a given window.

methodsrc.prompt_toolkit.layout.screen.Screen.get_menu_position(window:Window) -> Point

Get the menu position for a given window.

methodsrc.prompt_toolkit.layout.screen.Screen.set_cursor_position(window:Window, position:Point) -> None

Set the cursor position for a given window.

methodsrc.prompt_toolkit.layout.screen.Screen.set_menu_position(window:Window, position:Point) -> None

Set the cursor position for a given window.

funcsrc.prompt_toolkit.layout.scrollable_pane.ScrollablePane.is_scroll_button(row:int) -> bool

True if we should display a button on this row.

funcsrc.prompt_toolkit.layout.scrollable_pane.ScrollablePane.wrap_mouse_handler(handler:MouseHandler) -> MouseHandler

Wrap mouse handler.

classsrc.prompt_toolkit.lexers.base.DynamicLexer

Lexer class that can dynamically returns any Lexer.

classsrc.prompt_toolkit.lexers.base.Lexer

Base class for all lexers.

funcsrc.prompt_toolkit.lexers.base.SimpleLexer.get_line(lineno:int) -> StyleAndTextTuples

Return the tokens for the given line.

classsrc.prompt_toolkit.lexers.pygments.PygmentsLexer

Lexer that calls a pygments lexer.

methodsrc.prompt_toolkit.lexers.pygments.PygmentsLexer.from_filename(filename:str, sync_from_start:FilterOrBool=True) -> Lexer

Create a `Lexer` from a filename.

funcsrc.prompt_toolkit.lexers.pygments.PygmentsLexer.get_line(i:int) -> StyleAndTextTuples

Return the tokens for a given line number.

classsrc.prompt_toolkit.lexers.pygments.SyntaxSync

Syntax synchronizer.

classsrc.prompt_toolkit.mouse_events.MouseEvent

Mouse event, sent to `UIControl.mouse_handler`.

classsrc.prompt_toolkit.output.base.DummyOutput

For testing.

methodsrc.prompt_toolkit.output.base.DummyOutput.fileno() -> int

There is no sensible default for fileno().

methodsrc.prompt_toolkit.output.base.Output.ask_for_cpr() -> None

Asks for a cursor position report (CPR).

methodsrc.prompt_toolkit.output.base.Output.bell() -> None

Sound bell.

methodsrc.prompt_toolkit.output.base.Output.clear_title() -> None

Clear title again.

methodsrc.prompt_toolkit.output.base.Output.cursor_backward(amount:int) -> None

Move cursor `amount` place backward.

methodsrc.prompt_toolkit.output.base.Output.cursor_down(amount:int) -> None

Move cursor `amount` place down.

methodsrc.prompt_toolkit.output.base.Output.cursor_forward(amount:int) -> None

Move cursor `amount` place forward.

methodsrc.prompt_toolkit.output.base.Output.cursor_goto(row:int=0, column:int=0) -> None

Move cursor position.

methodsrc.prompt_toolkit.output.base.Output.cursor_up(amount:int) -> None

Move cursor `amount` place up.

methodsrc.prompt_toolkit.output.base.Output.disable_autowrap() -> None

Disable auto line wrapping.

methodsrc.prompt_toolkit.output.base.Output.disable_bracketed_paste() -> None

For vt100 only.

methodsrc.prompt_toolkit.output.base.Output.disable_mouse_support() -> None

Disable mouse.

methodsrc.prompt_toolkit.output.base.Output.enable_autowrap() -> None

Enable auto line wrapping.

methodsrc.prompt_toolkit.output.base.Output.enable_bracketed_paste() -> None

For vt100 only.

methodsrc.prompt_toolkit.output.base.Output.enable_mouse_support() -> None

Enable mouse.

methodsrc.prompt_toolkit.output.base.Output.encoding() -> str

Return the encoding for this output, e.g.

methodsrc.prompt_toolkit.output.base.Output.enter_alternate_screen() -> None

Go to the alternate screen buffer.

methodsrc.prompt_toolkit.output.base.Output.flush() -> None

Write to output stream and flush.

methodsrc.prompt_toolkit.output.base.Output.get_default_color_depth() -> ColorDepth

Get default color depth for this output.

methodsrc.prompt_toolkit.output.base.Output.get_rows_below_cursor_position() -> int

For Windows only.

methodsrc.prompt_toolkit.output.base.Output.get_size() -> Size

Return the size of the output window.

methodsrc.prompt_toolkit.output.base.Output.hide_cursor() -> None

Hide cursor.

methodsrc.prompt_toolkit.output.base.Output.quit_alternate_screen() -> None

Leave the alternate screen buffer.

methodsrc.prompt_toolkit.output.base.Output.reset_attributes() -> None

Reset color and styling attributes.

methodsrc.prompt_toolkit.output.base.Output.reset_cursor_key_mode() -> None

For vt100 only.

methodsrc.prompt_toolkit.output.base.Output.reset_cursor_shape() -> None

Reset cursor shape.

methodsrc.prompt_toolkit.output.base.Output.scroll_buffer_to_prompt() -> None

For Win32 only.

methodsrc.prompt_toolkit.output.base.Output.set_attributes(attrs:Attrs, color_depth:ColorDepth) -> None

Set new color and styling attributes.

methodsrc.prompt_toolkit.output.base.Output.set_cursor_shape(cursor_shape:CursorShape) -> None

Set cursor shape to block, beam or underline.

methodsrc.prompt_toolkit.output.base.Output.set_title(title:str) -> None

Set terminal title.

methodsrc.prompt_toolkit.output.base.Output.show_cursor() -> None

Show cursor.

methodsrc.prompt_toolkit.output.base.Output.write_raw(data:str) -> None

Write text.

classsrc.prompt_toolkit.output.color_depth.ColorDepth

Possible color depth values for the output.

classsrc.prompt_toolkit.output.conemu.ConEmuOutput

ConEmu (Windows) output abstraction.

classsrc.prompt_toolkit.output.win32.ColorLookupTable

Inspired by pygments/formatters/terminal256.py

classsrc.prompt_toolkit.output.win32.Win32Output

I/O abstraction for rendering to Windows consoles.

methodsrc.prompt_toolkit.output.win32.Win32Output.encoding() -> str

Return encoding used for stdout.

methodsrc.prompt_toolkit.output.win32.Win32Output.enter_alternate_screen() -> None

Go to alternate screen buffer.

methodsrc.prompt_toolkit.output.win32.Win32Output.fileno() -> int

Return file descriptor.

methodsrc.prompt_toolkit.output.win32.Win32Output.flush() -> None

Write to output stream and flush.

methodsrc.prompt_toolkit.output.win32.Win32Output.get_win32_screen_buffer_info() -> CONSOLE_SCREEN_BUFFER_INFO

Return Screen buffer info.

methodsrc.prompt_toolkit.output.win32.Win32Output.quit_alternate_screen() -> None

Make stdout again the active buffer.

methodsrc.prompt_toolkit.output.win32.Win32Output.scroll_buffer_to_prompt() -> None

To be called before drawing the prompt.

methodsrc.prompt_toolkit.output.win32.Win32Output.set_title(title:str) -> None

Set terminal title.

classsrc.prompt_toolkit.output.windows10.Windows10_Output

Windows 10 output abstraction.

methodsrc.prompt_toolkit.output.windows10.Windows10_Output.flush() -> None

Write to output stream and flush.

classsrc.prompt_toolkit.renderer.CPR_Support

Enum: whether or not CPR is supported.

classsrc.prompt_toolkit.renderer.HeightIsUnknownError

Information unavailable.

methodsrc.prompt_toolkit.renderer.Renderer.clear() -> None

Clear screen and go to 0,0

methodsrc.prompt_toolkit.renderer.Renderer.render(app:Application[Any], layout:Layout, is_done:bool=False) -> None

Render the current interface to the output.

methodsrc.prompt_toolkit.renderer.Renderer.request_absolute_cursor_position() -> None

Get current cursor position.

methodsrc.prompt_toolkit.renderer.Renderer.wait_for_cpr_responses(timeout:int=1) -> None

Wait for a CPR response.

methodsrc.prompt_toolkit.renderer.Renderer.waiting_for_cpr() -> bool

Waiting for CPR flag.

funcsrc.prompt_toolkit.renderer.move_cursor(new:Point) -> Point

Move cursor to this `new` point.

funcsrc.prompt_toolkit.renderer.output_char(char:Char) -> None

Write the output of this character.

funcsrc.prompt_toolkit.renderer.reset_attributes() -> None

Wrapper around Output.reset_attributes.

funcsrc.prompt_toolkit.search.accept_search() -> None

Accept current search query.

funcsrc.prompt_toolkit.search.do_incremental_search(direction:SearchDirection, count:int=1) -> None

Apply search, but keep search buffer focused.

funcsrc.prompt_toolkit.search.stop_search(buffer_control:BufferControl | None=None) -> None

Stop search through the given `buffer_control`.

classsrc.prompt_toolkit.selection.SelectionState

State of the current selection.

classsrc.prompt_toolkit.selection.SelectionType

Type of selection.

classsrc.prompt_toolkit.shortcuts.choice_input.ChoiceInput

Input selection prompt.

func

src.prompt_toolkit.shortcuts.dialogs.yes_no_dialog(title:AnyFormattedText='', text:AnyFormattedText='', yes_text:str='Yes', no_text:str='No', style:BaseStyle | None=None) -> Application[bool]

Display a Yes/No dialog.

About this data

These signatures were extracted from the public source of prompt-toolkit/python-prompt-toolkit using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries