pyte.Stream(screen=None, strict=True)[source]¶
│ │ │ A stream is a state machine that parses a stream of bytes and │ │ │ dispatches events based on what it sees.
│ │ │screen (pyte.screens.Screen) – a screen to dispatch events to.
strict (bool) – check if a given screen implements all required │ │ │ +
strict (bool) – check if a given screen implements all required │ │ │ events.
Note
│ │ │Stream only accepts text as input, but if for some reason │ │ │ @@ -164,16 +164,16 @@ │ │ │
pyte.screens.Cursor(x, y, attrs=Char(data=' ', fg='default', bg='default', bold=False, italics=False, underscore=False, strikethrough=False, reverse=False))[source]¶Screen cursor.
│ │ │x (int) – 0-based horizontal cursor position.
y (int) – 0-based vertical cursor position.
x (int) – 0-based horizontal cursor position.
y (int) – 0-based vertical cursor position.
attrs (pyte.screens.Char) – cursor attributes (see
│ │ │ select_graphic_rendition()
│ │ │ for details).
pyte.screens.Char[source]¶A single styled on-screen character.
│ │ │data (str) – unicode character. Invariant: len(data) == 1.
fg (str) – foreground colour. Defaults to "default".
bg (str) – background colour. Defaults to "default".
bold (bool) – flag for rendering the character using bold font. │ │ │ +
data (str) – unicode character. Invariant: len(data) == 1.
fg (str) – foreground colour. Defaults to "default".
bg (str) – background colour. Defaults to "default".
bold (bool) – flag for rendering the character using bold font.
│ │ │ Defaults to False.
italics (bool) – flag for rendering the character using italic font. │ │ │ +
italics (bool) – flag for rendering the character using italic font.
│ │ │ Defaults to False.
underscore (bool) – flag for rendering the character underlined. │ │ │ +
underscore (bool) – flag for rendering the character underlined.
│ │ │ Defaults to False.
strikethrough (bool) – flag for rendering the character with a │ │ │ +
strikethrough (bool) – flag for rendering the character with a
│ │ │ strike-through line. Defaults to False.
reverse (bool) – flag for swapping foreground and background colours │ │ │ +
reverse (bool) – flag for swapping foreground and background colours
│ │ │ during rendering. Defaults to False.
Changed in version 0.7.0: If the requested screen size is identical to the current screen │ │ │ size, the method does nothing.
│ │ │set_margins(top=None, bottom=None)[source]¶Select top and bottom margins for the scrolling region.
│ │ │ │ │ │set_mode(*modes, **kwargs)[source]¶Set (enable) a given list of modes.
│ │ │modes (list) – modes to set, where each mode is a constant │ │ │ +
modes (list) – modes to set, where each mode is a constant
│ │ │ from pyte.modes.
reset_mode(*modes, **kwargs)[source]¶Reset (disable) a given list of modes.
│ │ │modes (list) – modes to reset – hopefully, each mode is a │ │ │ +
modes (list) – modes to reset – hopefully, each mode is a
│ │ │ constant from pyte.modes.
define_charset(code, mode)[source]¶Define G0 or G1 charset.
code (str) – character set code, should be a character │ │ │ +
code (str) – character set code, should be a character
│ │ │ from "B0UK", otherwise ignored.
mode (str) – if "(" G0 charset is defined, if
│ │ │ +
mode (str) – if "(" G0 charset is defined, if
│ │ │ ")" – we operate on G1.
Warning
│ │ │User-defined charsets are currently not supported.
│ │ │ @@ -418,15 +418,15 @@ │ │ │draw(data)[source]¶Display decoded characters at the current cursor position and
│ │ │ advances the cursor if DECAWM is set.
data (str) – text to display.
│ │ │ +data (str) – text to display.
│ │ │Changed in version 0.5.0: Character width is taken into account. Specifically, zero-width │ │ │ and unprintable characters do not affect screen state. Full-width │ │ │ characters are rendered into two consecutive character containers.
│ │ │delete_lines(count=None)[source]¶
│ │ │ Delete the indicated # of lines, starting at line with │ │ │ cursor. As lines are deleted, lines displayed below cursor │ │ │ move up. Lines added to bottom of screen have spaces with same │ │ │ character attributes as last line moved up.
│ │ │ │ │ │insert_characters(count=None)[source]¶Insert the indicated # of blank characters at the cursor │ │ │ position. The cursor does not move and remains at the beginning │ │ │ of the inserted blank characters. Data on the line is shifted │ │ │ forward.
│ │ │ │ │ │delete_characters(count=None)[source]¶Delete the indicated # of characters, starting with the │ │ │ character at cursor position. When a character is deleted, all │ │ │ characters to the right of cursor move left. Character attributes │ │ │ move with the characters.
│ │ │ │ │ │erase_characters(count=None)[source]¶Erase the indicated # of characters, starting with the │ │ │ character at cursor position. Character attributes are set │ │ │ cursor attributes. The cursor remains in the same position.
│ │ │count (int) – number of characters to erase.
│ │ │ +count (int) – number of characters to erase.
│ │ │Note
│ │ │Using cursor attributes for character attributes may seem │ │ │ illogical, but if recall that a terminal emulator emulates │ │ │ a type writer, it starts to make sense. The only way a type │ │ │ @@ -585,50 +585,50 @@ │ │ │
erase_in_line(how=0, private=False)[source]¶Erase a line in a specific way.
│ │ │Character attributes are set to cursor attributes.
│ │ │how (int) –
defines the way the line should be erased in:
│ │ │ +how (int) –
defines the way the line should be erased in:
│ │ │0 – Erases from cursor to end of line, including cursor
│ │ │ position.
1 – Erases from beginning of line to cursor,
│ │ │ including cursor position.
2 – Erases complete line.
private (bool) – when True only characters marked as
│ │ │ +
private (bool) – when True only characters marked as
│ │ │ eraseable are affected not implemented.
erase_in_display(how=0, private=False)[source]¶Erases display in a specific way.
│ │ │Character attributes are set to cursor attributes.
│ │ │how (int) –
defines the way the line should be erased in:
│ │ │ +how (int) –
defines the way the line should be erased in:
│ │ │0 – Erases from cursor to end of screen, including
│ │ │ cursor position.
1 – Erases from beginning of screen to cursor,
│ │ │ including cursor position.
2 and 3 – Erases complete display. All lines
│ │ │ are erased and changed to single-width. Cursor does not
│ │ │ move.
private (bool) – when True only characters marked as
│ │ │ +
private (bool) – when True only characters marked as
│ │ │ eraseable are affected not implemented.
clear_tab_stop(how=0)[source]¶Clear a horizontal tab stop.
│ │ │how (int) –
defines a way the tab stop should be cleared:
│ │ │ +how (int) –
defines a way the tab stop should be cleared:
│ │ │0 or nothing – Clears a horizontal tab stop at cursor
│ │ │ position.
3 – Clears all horizontal tab stops.
ensure_vbounds(use_margins=None)[source]¶Ensure the cursor is within vertical screen bounds.
│ │ │ │ │ │cursor_up(count=None)[source]¶Move cursor up the indicated # of lines in same column. │ │ │ Cursor stops at top margin.
│ │ │ │ │ │cursor_up1(count=None)[source]¶Move cursor up the indicated # of lines to column 1. Cursor │ │ │ stops at bottom margin.
│ │ │ │ │ │cursor_down(count=None)[source]¶Move cursor down the indicated # of lines in same column. │ │ │ Cursor stops at bottom margin.
│ │ │ │ │ │cursor_down1(count=None)[source]¶Move cursor down the indicated # of lines to column 1. │ │ │ Cursor stops at bottom margin.
│ │ │ │ │ │cursor_back(count=None)[source]¶Move cursor left the indicated # of columns. Cursor stops │ │ │ at left margin.
│ │ │ │ │ │cursor_forward(count=None)[source]¶Move cursor right the indicated # of columns. Cursor stops │ │ │ at right margin.
│ │ │ │ │ │cursor_position(line=None, column=None)[source]¶Set the cursor to a specific line and column.
│ │ │Cursor is allowed to move out of the scrolling region only when
│ │ │ DECOM is reset, otherwise – the position
│ │ │ doesn’t change.
cursor_to_column(column=None)[source]¶Move cursor to a specific column in the current line.
│ │ │ │ │ │cursor_to_line(line=None)[source]¶Move cursor to a specific line in the current column.
│ │ │ │ │ │bell(*args)[source]¶report_device_attributes(mode=0, **kwargs)[source]¶report_device_status(mode)[source]¶Report terminal status or cursor position.
│ │ │mode (int) – if 5 – terminal status, 6 – cursor position, │ │ │ +
mode (int) – if 5 – terminal status, 6 – cursor position, │ │ │ otherwise a noop.
│ │ │New in version 0.5.0.
│ │ │write_process_input(data)[source]¶Write data to the process running inside the terminal.
│ │ │By default is a noop.
│ │ │data (str) – text to write to the process stdin.
data (str) – text to write to the process stdin.
New in version 0.5.0.
│ │ │pyte.screens.HistoryScreen(columns, lines, history=100, ratio=0.5)[source]¶
│ │ │ A :class:~`pyte.screens.Screen` subclass, which keeps track │ │ │ of screen history and allows pagination. This is not linux-specific, │ │ │ but still useful; see page 462 of VT520 User’s Manual.
│ │ │history (int) – total number of history lines to keep; is split │ │ │ +
history (int) – total number of history lines to keep; is split │ │ │ between top and bottom queues.
ratio (int) – defines how much lines to scroll on next_page()
│ │ │ +
ratio (int) – defines how much lines to scroll on next_page()
│ │ │ and prev_page() calls.
history¶before_event(event)[source]¶Ensure a screen is at the bottom of the history buffer.
│ │ │ │ │ │Warning
│ │ │This is developer API with no backward compatibility guarantees.