prompt-toolkit

New features:

• Use pyproject.toml instead of setup.py.

Fixes:

• Fix edge case in formatted_text.split_lines when the input starts with a line ending.

Fixes:

• Fixes non user impacting regression on the output rendering. Don't render
  cursor hide/show ANSI escape codes if not needed.

New features:

• On Windows, use virtual terminal input when available.
• Support for multiline suggestions.

Fixes:

• Handle InvalidStateError during termination when using
  run_in_terminal/patch_stdout. This can happen in some cases during
  cancellation, probably when using anyio.
• Fix cursor that remains in hidden state when the application exits. This can
  happen when the application doesn't show the cursor and erase_when_done is
  being used.

Breaking changes:

• Drop support for Python 3.7

Fixes:

• Typing improvements:
  • Add @overload to contrib.regular_languages.compiler.Variables.get.
  • Use Sequence instead of list for words argument in completers.
• Improve ModalCursorShapeConfig:
  • Display an "underscore" cursor in Vi's "replace single" mode, like
    "replace" mode.
  • Display an "beam" cursor in Emacs (insert) mode.

New features:

• Allow passing exception classes for KeyboardInterrupt and EOFError in PromptSession.

Fixes:

• Compute padding parameters for Box widget lazily.

Fixes:

• Fix pytest capsys fixture compatibility.

Fixes:

• Improve performance of GrammarCompleter (faster deduplication of completions).

New features:

• Accept os.PathLike in FileHistory (typing fix).

Fixes:

• Fix memory leak in filters.
• Improve performance of progress bar formatters.
• Fix compatibility when a SIGINT handler is installed by non-Python (Rust, C).
• Limit number of completions in buffer to 10k by default (for performance).

Fixes regression from 3.0.42:

• Fix regression on Pypy: Don't use ctypes.pythonapi to restore SIGINT if not available.

Other changes from 3.0.42:

• Fix line wrapping in patch_stdout on Windows.
• Make formatted_text.split_lines() accept an iterable instead of lists only.
• Disable the IPython workaround (from 3.0.41) for IPython >= 8.18.
• Restore signal.SIGINT handler between prompts

Fixes:

• Fix line wrapping in patch_stdout on Windows.
• Make formatted_text.split_lines() accept an iterable instead of lists only.
• Disable the IPython workaround (from 3.0.41) for IPython >= 8.18.
• Restore signal.SIGINT handler between prompts.

Fixes:

• Fix regression regarding IPython input hook (%gui) integration.

Fixes:

• Improved Python 3.12 support (fixes event loop DeprecationWarning).

New features:

• Vi key bindings: control-t and control-d for indent/unindent in insert mode.
• Insert partial suggestion when control+right is pressed, similar to Fish.
• Use sphinx-nefertiti theme for the docs.

Fixes:

• Fix RuntimeError when __breakpointhook__ is called from another thread.
• Fix memory leak in filters usage.
• Ensure that key bindings are handled in the right context (when using contextvars).

New features:

• Accept in_thread keyword in prompt_toolkit.shortcuts.prompt().
• Support the NO_COLOR environment variable.

Fixes:

• Fix regression in filters. (Use of WeakValueDictionary caused filters to not be cached).

New features:

• Use 24-bit true color now by default on Windows 10/11.

Bug fixes:

• Fix currentThread() deprecation warning.
• Fix memory leak in filters.
• Make VERSION tuple numeric.

New features:

• Add .run() method in TelnetServer. (To be used instead of .start()/.stop().

Breaking changes:

• Subclasses of Filter have to call super() in their __init__.
• Drop support for Python 3.6:
  • This includes code cleanup for Python 3.6 compatibility.
  • Use get_running_loop() instead of get_event_loop().
  • Use asyncio.run() instead of asyncio.run_until_complete().

Fixes:

• Another Python 3.6 fix for a bug that was introduced in 3.0.34.

Fixes:

• Fix bug introduced in 3.0.34 for Python 3.6. Use asynccontextmanager implementation from prompt_toolkit itself.

Fixes:

• Improve completion performance in various places.
• Improve renderer performance.
• Handle KeyboardInterrupt when the stacktrace of an unhandled error is displayed.
• Use correct event loop in Application.create_background_task().
• Fix show_cursor attribute in ScrollablePane.

Fixes:

• Improve termination of Application. Don't suppress CancelledError. This fixes a race condition when an Application gets cancelled while we're waiting for the background tasks to complete.
• Fixed typehint for OneStyleAndTextTuple.
• Small bugfix in CombinedRegistry. Fixed missing @property.

Bug fixes:

• Use DummyInput by default in create_input() if sys.stdin does not have a valid file descriptor. This fixes errors when sys.stdin is patched in certain situations.
• Fix control-c key binding for ProgressBar when the progress bar was not created from the main thread. The current code would try to kill the main thread when control-c was pressed.

New features:

• Accept a cancel_callback in ProgressBar to specify the cancellation behavior for when control-c is pressed.
• Small performance improvement in the renderer.

New features:

• Pass through name property in TextArea widget to Buffer.
• Added a enable_cpr parameter to Vt100_Output, TelnetServer and PromptToolkitSSHServer, to completely disable CPR support instead of automatically detecting it.

New features:

• Allow zero-width-escape sequences in print_formatted_text.
• Add default value option for input dialog.
• Added has_suggestion filter.

Fixes:

• Fix rendering of control-shift-6 (or control-^). Render as '^^'
• Always wrap lines in the Label widget by default.
• Fix enter key binding in system toolbar in Vi mode.
• Improved handling of stdout objects that don't have a 'buffer' attribute. For instance, when using renderer_print_formatted_text in a Jupyter Notebook.

New features:

• Accept 'handle_sigint' parameter in PromptSession.

Fixes

• Fix 'variable referenced before assignment' error in vt100 mouse bindings.
• Pass handle_sigint from Application.run to Application.run_async.
• Fix detection of telnet client side changes.
• Fix print_container utility (handle EOFError).

Breaking changes:

• The following are now context managers: create_pipe_input, PosixPipeInput and Win32PipeInput.

New features:

• Support format specifiers for HTML and ANSI formatted text.
• Accept defaults for checkbox and radio list, and their corresponding dialogs.

Fixes:

• Fix resetting of cursor shape after the application terminates.

New features:

• Support for cursor shapes. The cursor shape for prompts/applications can now be configured, either as a fixed cursor shape, or in case of Vi input mode, according to the current input mode.
• Handle "cursor forward" command in ANSI formatted text. This makes it possible to render many kinds of generated ANSI art.
• Accept align attribute in Label widget.
• Added PlainTextOutput: an output implementation that doesn't render any ANSI escape sequences. This will be used by default when redirecting stdout to a file.
• Added create_app_session_from_tty: a context manager that enforces input/output to go to the current TTY, even if stdin/stdout are attached to pipes.
• Added to_plain_text utility for converting formatted text into plain text.

Fixes:

• Don't automatically use sys.stderr for output when sys.stdout is not a TTY, but sys.stderr is. The previous behavior was confusing, especially when rendering formatted text to the output, and we expect it to follow redirection.

Fixes:

• Fixes issue introduced in 3.0.25: Don't handle SIGINT on Windows.

Fixes:

• Use DummyOutput when sys.stdout is None and DummyInput when sys.stdin is None. This fixes an issue when the code runs on windows, using pythonw.exe and still tries to interact with the terminal.
• Correctly reset Application._is_running flag in case of exceptions in some situations.
• Handle SIGINT (when sent from another process) and allow binding it to a key binding. For prompt sessions, the behavior is now identical to pressing control-c.
• Increase the event loop slow_duration_callback by default to 0.5. This prevents printing warnings if rendering takes too long on slow systems.

Fixes:

• Prevent window content overflowing when using scrollbars.
• Handle PermissionError when trying to attach /dev/null in vt100 input.

Fixes:

• Fix multiline bracketed paste on Windows

New features:

• Add support for some CSI 27 modified variants of "Enter" for xterm in the vt100 input parser.

Fixes:

• Fix stopping of telnet server (capture cancellation exception).

New features:

• Improved mouse support:
  • Support for click-drag, which is useful for selecting text.
  • Detect mouse movements when no button is pressed.
• Support for Python 3.10.

New features:

• Add support for strikethrough text attributes.
• Set up custom breakpointhook while an application is running (if no other breakpointhook was installed). This enhances the usage of PDB for debugging applications.
• Strict type checking is now enabled.

Fixes:

• Ensure that print_formatted_text is always printed above the running application, like patch_stdout. (Before, patch_stdout was even completely ignored in case of `print_formatted_text, so there was no proper way to use it in a running application.)
• Fix handling of non-bmp unicode input on Windows.
• Set minimum Python version to 3.6.2 (Some 3.6.2 features were used).

Fixes:

• Make the flush method of the vt100 output implementation re-entrant (fixes an issue when using aiogevent).
• Fix off-by-one in FormattedTextControl mouse logic.
• Run print_container always in a thread (avoid interfering with possible event loop).
• Make sphinx autodoc generation platform agnostic (don't import Windows stuff when generating Sphinx docs).

New features:

• Added in_thread parameter to Application.run. This is useful for running an application in a background thread, while the main thread blocks. This way, we are sure not to interfere with an event loop in the current thread. (This simplifies some code in ptpython and fixes an issue regarding leaking file descriptors due to not closing the event loop that was created in this background thread.)

New features:

• Accept style parameter in print_container utility.
• On Windows, handle Control-Delete.

Fixes:

• Avoid leaking file descriptors in SSH server.

New features:

• Added ScrollablePane: a scrollable layout container. This allows applications to build a layout, larger than the terminal, with a vertical scroll bar. The vertical scrolling will be done automatically when certain widgets receive the focus.
• Added DeduplicateCompleter and ConditionalCompleter`.
• Added deduplicate argument to merge_completers.

Fixes:

• Set stdout blocking when writing in vt100 output. Fixes an issue when uvloop is used and big amounts of text are written.
• Guarantee height of at least 1 for both labels and text areas.
• In the Window rendering, take dont_extend_width/dont_extend_height into account. This fixes issues where one window is enlarged unexpectedly because it's bundled with another window in a HSplit/VSplit, but with different width/height.
• Don't handle SIGWINCH in progress bar anymore. (The UI runs in another thread, and we have terminal size polling now).
• Fix several thread safety issues and a race condition in the progress bar.
• Fix thread safety issues in Application.invalidate(). (Fixes a RuntimeError in some situations when using progress bars.)
• Fix handling of mouse events on Windows if we have a Windows 10 console with ANSI support.
• Disable QUICK_EDIT_MODE on Windows 10 when mouse support is requested.

New features:

• Disable bell when PROMPT_TOOLKIT_BELL=false environment variable has been set.

Fixes:

• Improve cancellation of history loading.

Fixes:

• Again, fixed the race condition in ThreadedHistory. Previous fix was not correct.

Fixes:

• Fixed a race condition in ThreadedHistory that happens when continuously pasting input text (which would continuously repopulate the history).
• Move cursor key mode resetting (for vt100 terminals) to the renderer. (Mostly cleanup).

New features:

• Poll terminal size: better handle resize events when the application runs in a thread other than the main thread (where handling SIGWINCH doesn't work) or in the Windows console.

Fixes:

• Fix bug in system toolbar. The execution of system commands was broken.
• A refactoring of patch_stdout that includes several fixes.
  • We know look at the AppSession in order to see which application is running, rather then looking at the event loop which is installed when StdoutProxy is created. This way, patch_stdout will work when prompt_toolkit applications with a different event loop run.
  • Fix printing when no application/event loop is running.
  • Fixed the raw argument of PatchStdout.
• A refactoring of the ThreadedHistory, which includes several fixes, in particular a race condition (see issue #1158) that happened when editing input while a big history was still being loaded in the background.

New features:

• Improved WordCompleter: accept display_dict. Also accept formatted text for both display_dict and meta_dict.
• Allow customization of button arrows.

Fixes:

• Correctly recognize backtab on Windows.
• Show original display text in fuzzy completer if no filtering was done.

New features:

• Handle c-tab for TERM=linux.

Fixes:

• Improve rendering speed of print_formatted_text. (Don't render styling attributes to output between fragments that have identical styling.)
• Gracefully handle FileHistory decoding errors.
• Prevent asyncio deprecation warnings.

New features:

• Added validator parameter to input_dialog.

Fixes:

• Cope with stdout not having a working fileno.
• Handle situation when /dev/null is piped into stdin, or when stdin is closed somehow.
• Fix for telnet/ssh server: isatty method was not implemented.
• Display correct error when a tuple is passed into to_formatted_text.
• Pass along WORD parameter in Document._is_word_before_cursor_complete. Fixes some key bindings.
• Expose ProgressBarCounter in shortcuts module.

New features:

• New "placeholder" parameter added to PromptSession.

Other changes:

• The "respond to CPR" logic has been moved from the Input to Output classes (this does clean up some code).

Fixes:

• Bugfix in shift-selection key bindings.
• Fix height calculation of FormattedTextControl when line wrapping is turned on.
• Fixes for SSH server:
  • Missing encoding property.
  • Fix failure in "set_line_mode" call.
  • Handle BrokenPipeError.

New features:

• The SSH/Telnet adaptors have been refactored and improved in several ways. See issues #876 and PR #1150 and #1184 on GitHub.
  • Handle terminal types for both telnet and SSH sessions.
  • Added pipe input abstraction. (base class for PosixPipeInput and Win32PipeInput).
  • The color depth logic has been refactored and moved to the Output implementations. Added get_default_color_depth method to Output objects.
  • All line feet are now preceded by a carriage return in the telnet connection stdout.
• Introduce REPLACE_SINGLE input mode for Vi key bindings.
• Improvements to the checkbox implementation:
  • Hide the scrollbar for a single checkbox.
  • Added a "checked" setter to the checkbox.
• Expose KeyPressEvent in key_binding/init.py (often used in type annotations).
• The renderer has been optimized so that no trailing spaces are generated (this improves copying in some terminals).

Fixes:

• Ignore F21..F24 key bindings by default.
• Fix auto_suggest key bindings when suggestion text is empty.
• Bugfix in SIGWINCH handling.
• Handle bug in HSplit/VSplit when the number of children is zero.
• Bugfix in CPR handling in renderer. Proper cancellation of pending tasks.
• Ensure rprompt aligns with input.
• Use sys.stdin.encoding for decoding stdin stream.

Fixes:

• Bugfix in mouse handling on Windows.

New features:

• Added many more vt100 ANSI sequences and keys.
• Improved control/shift key support in Windows.
• No Mypy errors in prompt_toolkit anymore.
• Added set_exception_handler optional argument to PromptSession.prompt().

Fixes:

• Bugfix in invalidate code. PromptSession was invalidating the UI continuously.
• Add uvloop support (was broken due to an issue in our call_soon_threadsafe).
• Forwarded set_exception_handler in Application.run to the run_async call.
• Bugfix in NestedCompleter when there is a leading space.

Breaking changes:

• ShiftControl has been replaced with ControlShift and s-c with c-s in key bindings. Aliases for backwards-compatibility have been added.

New features:

• Improved support for "dumb" terminals.
• Added support for new keys (vt100 ANSI sequences): Alt + home/end/page-up/page-down/insert.
• Better performance for the "regular languages compiler". Generate fewer and better regular expressions. This should improve the start-up time for applications using this feature.
• Better detection of default color depth.
• Improved the progress bar:
  • Set "time left" to 0 when done or stopped.
  • Added ProgressBarCounter.stopped.
• Accept callables for scroll_offset, min_brightness and max_brightness.
• Added always_prefer_tty parameters to create_input() and create_output().
• Create a new event loop in Application.run() if get_event_loop() raises Runtimeerror.

Fixes:

• Correct cancellation of flush timers for input. (Fixes resource leak where too many useless coroutines were created.)
• Improved the Win32 input event loop. This fixes a bug where the prompt_toolkit application is stopped by something other than user input. (In that case, the application would hang, waiting for input.) This also fixes a RuntimeError in the progress bar code.
• Fixed line-number.current style. (was current-line-number.)
• Handle situation where stdout is no longer a tty (fix bug in get_size).
• Fix parsing of true color in ANSI strings.
• Ignore invalidate() if the application is not running.

Fixes:

• Bugfix in the UI invalidation. Fixes an issue when the application runs again on another event loop. See: https://github.com/ipython/ipython/pull/11973

New features:

• Added new_eventloop_with_inputhook function.
• Set exception handler from within Application.run_async.
• Applied Black code style.

Fixes:

• No longer expect a working event loop in the History classes. (Fix for special situations when a ThreadedHistory is created before the event loop has been set up.)
• Accept an empty prompt continuation.
• A few fixes to the Buffer tempfile code.

New features:

• (almost) 100% type annotated.
• Native asyncio instead of custom event loops.
• Added shift-based text selection (use shift+arrows to start selecting text).

Breaking changes:

• Python 2 support has been dropped. Minimal Python version is now 3.6, although 3.7 is preferred (because of ContextVars).
• Native asyncio, so some async code becomes slightly different.
• The active Application became a contextvar. Which means that it should be propagated correctly to the code that requires it. However, random other threads or coroutines won't be able to know what the current application is.
• The dialog shortcuts API changed. All dialog functions now return an Application. You still have to call either run() or run_async on the Application object.
• The way inputhooks work is changed.
• patch_stdout now requires an Application as input.

Bug fixes:

• Fixed Application.run_system_command on Windows.
• Fixed bug in ANSI text formatting: correctly handle 256/true color sequences.
• Fixed bug in WordCompleter. Provide completions when there's a space before the cursor.

Bug fixes:

• Fixes the issue where changes made to the buffer in the accept handler were not reflected in the history.
• Fix in the application invalidate handler. This prevents a significant slow down in some applications after some time (especially if there is a refresh interval).
• Make print_container utility work if the input is not a pty.

New features:

• Underline non breaking spaces instead of rendering as '&'.
• Added mouse support for radio list.
• Support completion styles for READLINE_LIKE display method.
• Accept formatted text in the display text of completions.
• Added a FuzzyCompleter and FuzzyWordCompleter.
• Improved error handling in Application (avoid displaying a meaningless AssertionError in many cases).

Bug fixes:

• Fixed assertion in PromptSession: the style_transformation check was wrong.
• Removed 'default' attribute in PromptSession. Only ask for it in the prompt() method. This fixes the issue that passing default once, will store it for all consequent calls in the PromptSession.
• Ensure that __pt_formatted_text__ always returns a FormattedText instance. This fixes an issue with print_formatted_text.

New features:

• Improved handling of situations where stdin or stdout are not a terminal. (Print warning instead of failing with an assertion.)
• Added print_container utility.
• Sound bell when attempting to edit read-only buffer.
• Handle page-down and page-up keys in RadioList.
• Accept any collections.abc.Sequence for HSplit/VSplit children (instead of lists only).
• Improved Vi key bindings: return to navigation mode when Insert is pressed.

Bug fixes:

• Don't use the predefined ANSI colors for colors that are defined as RGB. (Terminals can assign different color schemes for ansi colors, and we don't want use any of those for colors that are defined like #aabbcc for instance.)
• Fix in handling of CPRs when patch_stdout is used.

Backwards incompatible changes:

• Change to the Buffer class. Reset the buffer unless the accept_handler returns True (which means: "keep_text"). This doesn't affect applications that use PromptSession.

New features:

• Added AdjustBrightnessStyleTransformation. This is a simple style transformation that improves the rendering on terminals with light or dark background.
• Improved performance (string width caching and line height calculation).
• Improved TextArea:
  • Exposed focus_on_click.
  • Added attributes: auto_suggest, complete_while_typing, history, get_line_prefix, input_processors.
  • Made attributes writable: lexer, completer, complete_while_typing, accept_handler, read_only, wrap_lines.

Bug fixes:

• Fix in DynamicContainer. Return correct result for get_children. This fixes a bug related to focusing.
• Properly compute length of start, end and sym_b characters of progress bar.
• CPR (cursor position request) fix.

Backwards incompatible changes:

• Stop restoring PromptSession attributes when exiting prompt.

New features:

• Added get_line_prefix attribute to window. This opens many possibilities:
  • Line wrapping (soft and hard) can insert whitespace in front of the line, or insert some symbols in front. Like the Vim "breakindent" option.
  • Single line prompts also support line continuations now.
  • Line continuations can have a variable width.
• For VI mode: implemented temporary normal mode (control-O in insert mode).
• Added style transformations API. Useful for swapping between light and dark color schemes. Added swap_light_and_dark_colors parameter to prompt() function.
• Added format() method to ANSI formatted text.
• Set cursor position for Button widgets.
• Added pre_run argument to PromptSession.prompt() method.