Version History

1.44

  • improve: reduce errant XTGETTCAP output for Terminal.app and ConEmu.exe PR #385.

1.43

  • bugfix: regression of XTGETTCAP responses leaking into first call for empty/non-response terminals (libvte/Gnome Terminal), in versions 1.40 to 1.42 PR #383.

1.42

  • bugfix: regression in cbreak() and raw() were not thread-safe broken in versions 1.40 and 1.41, remove signal ignore of SIGTTOU #380.

1.41
1.40

  • improved: jinxed is now required on all platforms, providing a curses-free and singleton-free implementation of the subset of curses used by blessed. The jinxed 1.5.0 release provides a terminal capability database <https://jinxed.readthedocs.io/en/stable/capabilities.html#database> of 45 terminals and their common aliases.

  • improved: Class initialization of Terminal() now uses XTGETTCAP to determine preferred terminal name TN, 24-bit color support RGB, number of colors Co, italic, and blink capabilities.

    This improves detection of Terminal kind and number_of_colors over protocols like serial that cannot forward any environment variables or ssh that do not forward COLORTERM.

  • introduced: A UserWarning is emitted when __getattr__() resolves an unknown terminal capability name, helping developers catch typos like term.bld (missing bold). The warning can be suppressed by setting the environment variable BLESSED_NOWARN_UNKNOWN_CAPS.

  • bugfix: Fixed internal typo susimpleript to the correct terminfo name ssubm for the enter_susimpleript_mode capability. This was previously masked by curses returning an empty string for unknown capabilities.

1.39

  • introduced: progress_bar() for OSC 9;4 sequence.

  • introduced: text_sized() – wrap text in Kitty text sizing protocol (OSC 66) escape sequences, with graceful fallback to plain text when the terminal does not support the protocol.

  • introduced: Keystroke of name CPR_RESPONSE for asynchronous capture of Cursor Position Report responses via inkey(). New argument capture_cpr=True resolves the legacy F3 key ambiguity and matches against CPR_RESPONSE. New properties cpr_yx and cpr_xy return the decoded cursor coordinates. PR #369.

  • improved: inkey() raises EOFError when keyboard fd is at EOF, rather than returning an empty Keystroke. PR #371.

  • improved: ljust(), rjust(), and center() now measure text containing hyperlinks, Kitty text sizing protocol sequences, and overtyping (backspace/cursor-left with painter’s algorithm), introduced by wcwidth 0.7.0.

1.38

  • introduced: does_osc52_clipboard(), clipboard_copy(), and clipboard_paste() to detect, copy, and read from clipboard.

  • introduced: get_color_scheme().

  • introduced: does_kitty_query() for Kitty’s XTGETTCAP query extensions.

  • introduced: does_decrqss() for DECRQSS (Request Status String).

  • introduced: does_styled_underlines() and does_colored_underlines() – detect extended underline styles (Smulx) and colored underlines (Setulc) via XTGETTCAP.

  • introduced: set_window_title() and window_title() – set the terminal window and/or icon title via xterm OSC sequences, with a context manager that pushes and pops the title stack (XTWINOPS).

  • introduced: DecModeResponse.recognized and DecModeResponse.supported properties – distinguish modes the terminal acknowledges from those it can actually use.

  • improved: Smulx and Setulc added to XTGETTCAP capability list.

  • bugfix: EOF when stdin is connected to a Pipe (eg. pytest capture) caused infinite loop PR #366.

  • bugfix: Background SGR not applying to text/suggestion content in blessed.line_editor.LineEditor, now prepend bg_sgr before each content SGR sequence.

  • bugfix: OSC responses for ‘ST’ in addition to ‘BEL’ terminated iTerm2 capabilities, Kitty notifications, Kitty pointer shapes responses

1.37

  • bugfix: legacy CSI letter-form sequences with explicit modifiers and event type (e.g., \x1b[1;1:1A for arrow key press) were not resolved to key names, this affected only some terminals, such as Ghostty. PR #363.

1.36

  • bugfix: [ key returned name of value CSI in Kitty keyboard protocol mode, it now returns KEY_LEFT_SQUARE_BRACKET.

  • improved: Kitty keyboard protocol now synthesizes name for all ASCII alphanumeric and punctuation keys, including unmodified press events (e.g., KEY_A, KEY_PERIOD, KEY_LEFT_SQUARE_BRACKET). Previously, only modified or released/repeated keys received synthesized names.

1.35

  • introduced: cursor_shape() context manager and CursorShape constants for DECSCUSR cursor shape control (block, underline, bar – steady or blinking).

  • introduced: methods key_name() and key_value() allow for better key and value tracking when using kitty keyboard protocol with pressed, released, and repeated events.

  • improved: Synthesize name for “released” and “repeated” key states, when using the kitty keyboard protocol.

  • bugfix: get_fgcolor() and get_bgcolor() now correctly interprets ST-terminated OSC responses in addition to BEL-terminated.

1.34
1.33
1.32
1.31
1.30

  • bugfix: Terminal.wrap drops color escape sequences, PR #352.

  • bugfix: Prevent rare feedback loops in automatic responses, PR #350.

1.29
1.28
1.27

  • bugfix missing tests, bin, and docs folder in 1.26 release, PR #341.

1.26
1.25

  • bugfix: The “Copy globals” fix in 1.20 got reverted in release in 1.23 by PR #306, this release re-applies the fix, PR #326.

1.24

  • bugfix: blessed.Terminal`get_sixel_height_and_width() detection order and improve documentation for window resize event handling PR #320

  • bugfix: change default argument timeout=None to timeout=1 in methods requiring automatic response, preventing stalls on “dumb” terminals PR #317

1.23

  • introduced: Environment values FORCE_COLOR, CLICOLOR_FORCE, and NO_COLOR overrides blessed.Terminal argument value, force_styling PR #295

  • improved: performance of rgb_downconvert() for 256-color terminals, PR #298.

  • deprecated: Python 2.7 through 3.6 no longer supported. PR #299.

  • improved: keyboard support for modifier keys, PR #306.

  • introduced: kitty keyboard protocol support, PR #309.

  • introduced: mouse support, Synchronized Output, and support for DEC Private Modes, PR #310

  • introduced: methods to determine Sixel, dimensions and color depth PR #312

  • introduced: in-band resize support (DEC Private Mode 2048) PR #313

  • introduced: XTVersion identification: PR #314

  • bugfix: default timeout for get_bgcolor, get_fgcolor PR #315

1.22
1.21

  • bugfix: infinite loop in wrap() when “Wide” characters of width 2 (East-Asian or Emoji) are used with a wrap width of 1, and a small performance enhancement, #273 and PR #274 by grayjk merged as PR #275.

1.20
1.19
1.18

  • bugfix: split_seqs() for some sequences like term.move_left(3), #197.

  • introduced: type annotations, #192 by dlax.

  • bugfix: do not fail when sys.stdin is unset, #195 by Olen

  • docfix: correct “Bottom of the screen” example to use end='' and document about it in location.rst, #188 by pyfisch

1.17

  • introduced: Hyperlinks, method link(), #116.

  • introduced: 24-bit color support, detected by term.number_of_colors == 1 << 24, and 24-bit color foreground method color_rgb() and background method on_color_rgb(), as well as 676 common X11 color attribute names are now possible, such as term.aquamarine_on_wheat, #60.

  • introduced: term.move_xy, recommended over built-in move capability, as the argument order, (x, y) matches the return value of get_location(), and all other common graphics library calls, #65.

  • introduced: move_up(), move_down(), Terminal.move_left(), move_right() which are strings that move the cursor one cell in the respective direction, are now also callables for moving n cells to the given direction, such as term.move_right(9).

  • introduced: pixel_width and pixel_height for libsixel support or general curiosity.

  • introduced: formatter() which returns callable formatters for valid text formatters such as ‘red’ or ‘bold_on_red’, returning a NullCallableString if passed an invalid text formatter.

  • bugfix: prevent ValueError: I/O operation on closed file on sys.stdin in multiprocessing environments, where the keyboard wouldn’t work, anyway.

  • bugfix: prevent error condition, ValueError: underlying buffer has been detached in rare conditions where sys.__stdout__ has been detached in test frameworks. #126.

  • bugfix: off-by-one error in get_location(), now accounts for %i in cursor_report, #94.

  • bugfix split_seqs() and related functions failed to match when the color index was greater than 15, #101.

  • bugfix: Context Managers, fullscreen(), hidden_cursor(), and keypad() now flush the stream after writing their sequences.

  • bugfix: chr(127), \x7f has changed from keycode term.DELETE to the more common match, term.BACKSPACE, #115 by jwezel.

  • bugfix: ensure FormattingOtherString may be pickled.

  • bugfix: Use UTF-8 for keyboard if input encoding cannot be determined.

  • deprecated: the curses move() capability is no longer recommended, suggest to use move_xy(), which matches the return value of get_location().

  • deprecated: superscript, subscript, shadow, and dim are no longer “compoundable” with colors, such as in phrase Terminal.blue_subscript('a'). These attributes are not typically supported, anyway. Use Unicode text or 256 or 24-bit color codes instead.

  • deprecated: additional key names, such as KEY_TAB, are no longer “injected” into the curses module namespace.

  • bugfix: briefly tried calling curses.setupterm() with os.devnull as the file descriptor, reverted. #59.

  • deprecated: inkey() no longer raises RuntimeError when stream is not a terminal, programs using inkey() to block indefinitely if a keyboard is not attached. #69.

  • deprecated: using argument _intr_continue to method kbhit(), behavior is as though such value is always True since 1.9.

  • bugfix: Now imports on 3.10+

  • bugfix: Fix detection of shift+arrow keys when using tmux. #178.

  • enhancement: Instantiate SequenceTextWrapper only once in wrap(). #184.

1.16
1.15

  • enhancement: disable timing integration tests for keyboard routines.

  • enhancement: Support python 3.7. PR #102.

  • enhancement: Various fixes to test automation PR #108

1.14

  • bugfix: wrap() misbehaved for text containing newlines, #74.

  • bugfix: TypeError when using PYTHONOPTIMIZE=2 environment variable, #84.

  • bugfix: define blessed.__version__ value, #92.

  • bugfix: detect sequences \x1b[0K and \x1b2K, #95.

1.13

  • enhancement: split_seqs() introduced, and 4x cost reduction in related sequence-aware functions, #29.

  • deprecated: blessed.sequences.measure_length function superseded by iter_parse() if necessary.

  • deprecated: warnings about “binary-packed capabilities” are no longer emitted on strange terminal types, making best effort.

1.12

  • enhancement: get_location() returns the (row, col) position of the cursor at the time of call for attached terminal.

  • enhancement: a keyboard now detected as stdin when stream is sys.stderr.

1.11

  • enhancement: inkey() can return more quickly for combinations such as Alt + Z when MetaSendsEscape is enabled, #30.

  • enhancement: FormattingString may now be nested, such as t.red('red', t.underline('rum')), #61

1.10

  • workaround: provide sc and rc for Terminals of kind='ansi', repairing location() #44.

  • bugfix: length of simple SGR reset sequence \x1b[m was not correctly determined on all terminal types, #45.

  • deprecated: _intr_continue arguments introduced in 1.8 are now marked deprecated in 1.10: beginning with python 3.5, the default behavior is as though this argument is always True, PEP-475, blessed does the same.

1.9

  • enhancement: break_long_words now supported by Terminal.wrap()

  • Ignore curses.error message 'tparm() returned NULL': this occurs on win32 or other platforms using a limited curses implementation, such as PDCurses, where curses.tparm() is not implemented, or no terminal capability database is available.

  • Context manager keypad() emits sequences that enable “application keys” such as the diagonal keys on the numpad. This is equivalent to curses.window.keypad().

  • bugfix: translate keypad application keys correctly.

  • enhancement: no longer depend on the ‘2to3’ tool for python 3 support.

  • enhancement: allow civis and cnorm (hide_cursor, normal_hide) to work with terminal-type ansi by emulating support by proxy.

  • enhancement: new public attribute: kind: the very same as given Terminal.__init__.kind keyword argument. Or, when not given, determined by and equivalent to the TERM Environment variable.

1.8

  • enhancement: export keyboard-read function as public method getch(), so that it may be overridden by custom terminal implementers.

  • enhancement: allow inkey() and kbhit() to return early when interrupted by signal by passing argument _intr_continue=False.

  • enhancement: allow hpa and vpa (move_x, move_y) to work on tmux(1) or screen(1) by emulating support by proxy.

  • enhancement: add rstrip() and lstrip(), strips both sequences and trailing or leading whitespace, respectively.

  • enhancement: include wcwidth library support for length(): the printable width of many kinds of CJK (Chinese, Japanese, Korean) ideographs and various combining characters may now be determined.

  • enhancement: better support for detecting the length or sequences of externally-generated ecma-48 codes when using xterm or aixterm.

  • bugfix: when locale.getpreferredencoding() returns empty string or an encoding that is not valid for codecs.getincrementaldecoder, fallback to ASCII and emit a warning.

  • bugfix: ensure FormattingString and ParameterizingString may be pickled.

  • bugfix: allow ~.inkey and related to be called without a keyboard.

  • change: term.keyboard_fd is set None if stream or sys.stdout is not a tty, making term.inkey(), term.cbreak(), term.raw(), no-op.

  • bugfix: \x1bOH (KEY_HOME) was incorrectly mapped as KEY_LEFT.

1.7

  • Forked github project erikrose/blessings to jquast/blessed, this project was previously known as blessings version 1.6 and prior.

  • introduced: context manager cbreak(), which is equivalent to entering terminal state by tty.setcbreak() and returning on exit, as well as the lesser recommended raw(), pairing from tty.setraw().

  • introduced: inkey(), which will return one or more characters received by the keyboard as a unicode sequence, with additional attributes code and name. This allows application keys (such as the up arrow, or home key) to be detected. Optional value timeout allows for timed poll.

  • introduced: center(), rjust(), ljust(), allowing text containing sequences to be aligned to detected horizontal screen width, or by width specified.

  • introduced: wrap() method. Allows text containing sequences to be word-wrapped without breaking mid-sequence, honoring their printable width.

  • introduced: strip(), strips all sequences and whitespace.

  • introduced: strip_seqs() strip only sequences.

  • introduced: rstrip() and lstrip() strips both sequences and trailing or leading whitespace, respectively.

  • bugfix: cannot call curses.setupterm() more than once per process (from Terminal.__init__()): Previously, blessed pretended to support several instances of different Terminal kind, but was actually using the kind specified by the first instantiation of Terminal. A warning is now issued. Although this misbehavior is still allowed, a warnings.WarningMessage is now emitted to notify about subsequent terminal misbehavior.

  • bugfix: resolved issue where number_of_colors fails when does_styling is False. Resolves issue where piping tests output would fail.

  • bugfix: warn and set does_styling to False when the given kind is not found in the terminal capability database.

  • bugfix: allow unsupported terminal capabilities to be callable just as supported capabilities, so that the return value of color(n) may be called on terminals without color capabilities.

  • bugfix: for terminals without underline, such as vt220, term.underline('text') would emit 'text' + term.normal. Now it emits only 'text'.

  • enhancement: some attributes are now properties, raise exceptions when assigned.

  • enhancement: pypy is now a supported python platform implementation.

  • enhancement: removed pokemon curses.error exceptions.

  • enhancement: do not ignore curses.error exceptions, unhandled curses errors are legitimate errors and should be reported as a bug.

  • enhancement: converted nose tests to pytest, merged travis and tox.

  • enhancement: pytest fixtures, paired with a new @as_subprocess decorator are used to test a multitude of terminal types.

  • enhancement: test accessories @as_subprocess resolves various issues with different terminal types that previously went untested.

  • deprecation: python2.5 is no longer supported (as tox does not supported).

1.6

  • Add does_styling. This takes force_styling into account and should replace most uses of is_a_tty.

  • Make is_a_tty a read-only property like does_styling. Writing to it never would have done anything constructive.

  • Add fullscreen`() and hidden_cursor() to the auto-generated docs.

1.5.1

  • Clean up fabfile, removing the redundant test command.

  • Add Travis support.

  • Make python setup.py test work without spurious errors on 2.6.

  • Work around a tox parsing bug in its config file.

  • Make context managers clean up after themselves even if there’s an exception (Vitja Makarov #29 <https://github.com/erikrose/blessings/pull/29>).

  • Parameterizing a capability no longer crashes when there is no tty (<Vitja Makarov #31 <https://github.com/erikrose/blessings/pull/31>)

1.5

  • Add syntactic sugar and documentation for enter_fullscreen and exit_fullscreen.

  • Add context managers fullscreen() and hidden_cursor().

  • Now you can force a Terminal to never to emit styles by passing keyword argument force_styling=None.

1.4

  • Add syntactic sugar for cursor visibility control and single-space-movement capabilities.

  • Endorse the location() context manager for restoring cursor position after a series of manual movements.

  • Fix a bug in which location() that wouldn’t do anything when passed zeros.

  • Allow tests to be run with python setup.py test.

1.3

  • Added number_of_colors, which tells you how many colors the terminal supports.

  • Made color(n) and on_color(n) callable to wrap a string, like the named colors can. Also, make them both fall back to the setf and setb capabilities (like the named colors do) if the termcap entries for setaf and setab are not available.

  • Allowed color to act as an unparametrized string, not just a callable.

  • Made height and width examine any passed-in stream before falling back to stdout (This rarely if ever affects actual behavior; it’s mostly philosophical).

  • Made caching simpler and slightly more efficient.

  • Got rid of a reference cycle between Terminal and FormattingString.

  • Updated docs to reflect that terminal addressing (as in location()) is 0-based.

1.2

  • Added support for Python 3! We need 3.2.3 or greater, because the curses library couldn’t decide whether to accept strs or bytes before that (https://bugs.python.org/issue10570).

  • Everything that comes out of the library is now unicode. This lets us support Python 3 without making a mess of the code, and Python 2 should continue to work unless you were testing types (and badly). Please file a bug if this causes trouble for you.

  • Changed to the MIT License for better world domination.

  • Added Sphinx docs.

1.1

  • Added nicely named attributes for colors.

  • Introduced compound formatting.

  • Added wrapper behavior for styling and colors.

  • Let you force capabilities to be non-empty, even if the output stream is not a terminal.

  • Added is_a_tty to determine whether the output stream is a terminal.

  • Sugared the remaining interesting string capabilities.

  • Allow location() to operate on just an x or y coordinate.

1.0