r""" Terminal escape sequence patterns. This module provides regex patterns for matching terminal escape sequences. All patterns match sequences that begin with ESC (``\x1b``). Before calling re.match with these patterns, callers should first check that the character at the current position is ESC for optimal performance. """ # std imports import re import typing # local from .sgr_state import _SGR_PATTERN # Text Sizing Protocol (OSC 66), https://sw.kovidgoyal.net/kitty/text-sizing-protocol/ TEXT_SIZING_PATTERN = re.compile( r'\x1b\]66;([^;\x07\x1b]*);([^\x07\x1b]*)(\x07|\x1b\\)' ) # Zero-width escape sequences (SGR, OSC, CSI, etc.). This table, like INDETERMINATE_EFFECT_SEQUENCE, # originated from the 'blessed' library. ZERO_WIDTH_PATTERN = re.compile( # CSI sequences r'\x1b\[[\x30-\x3f]*[\x20-\x2f]*[\x40-\x7e]|' # OSC sequences, note that text sizing protocol (OSC 66) is special case in width() and clip(), # and contrary to the variable name, it is positive width. r'\x1b\][^\x07\x1b]*(?:\x07|\x1b\\)|' # APC sequences r'\x1b_[^\x1b\x07]*(?:\x07|\x1b\\)|' # DCS sequences r'\x1bP[^\x1b\x07]*(?:\x07|\x1b\\)|' # PM sequences r'\x1b\^[^\x1b\x07]*(?:\x07|\x1b\\)|' # Character set designation (subset of nF, handled separately for clarity) r'\x1b[()].|' # nF sequences: ESC + one or more intermediate bytes (0x20-0x2F) + final byte (0x30-0x7E) r'\x1b[\x20-\x2f]+[\x30-\x7e]|' # Fe sequences (C1 controls) r'\x1b[\x40-\x5f]|' # Fp sequences (private use) r'\x1b[\x30-\x3f]|' # Fs sequences (independent functions) r'\x1b[\x60-\x7e]' ) # Cursor right movement: CSI [n] C, parameter may be parsed by width() CURSOR_RIGHT_SEQUENCE = re.compile(r'\x1b\[(\d*)C') # Cursor left movement: CSI [n] D, parameter may be parsed by width() CURSOR_LEFT_SEQUENCE = re.compile(r'\x1b\[(\d*)D') # Horizontal position absolute: CSI [n] G, parameter may be parsed by width() CURSOR_HPA_SEQUENCE = re.compile(r'\x1b\[(\d*)G') # Combined cursor movement: single regex for fast-path detection of any # horizontal cursor movement (left, right, hpa). Avoids two separate search() # calls in hot-path width() and clip() pre-checks. CURSOR_MOVEMENT_SEQUENCE = re.compile(r'\x1b\[(\d*)[CDG]') # Combined horizontal cursor movement: matches BS, CR, and CSI C/D/G cursor sequences # in a single regex pass. Used by clip() to decide between the simple append path # and the painter's algorithm. _HORIZONTAL_CURSOR_MOVEMENT = re.compile(r'[\x08\r]|\x1b\[(\d*)[CDG]') # Combined pattern: a single regex that matches any zero-width escape sequence # and classifies it via named groups, aprox 2x faster than redundant re.matches # in clip() and width(). _SEQUENCE_CLASSIFY = re.compile( _SGR_PATTERN.pattern.replace('(', '(?P', 1) + '|' + CURSOR_HPA_SEQUENCE.pattern.replace('(', '(?P', 1) + '|' + CURSOR_RIGHT_SEQUENCE.pattern.replace('(', '(?P', 1) + '|' + CURSOR_LEFT_SEQUENCE.pattern.replace('(', '(?P', 1) + '|' + r'\x1b\]66;(?P[^;\x07\x1b]*);(?P[^\x07\x1b]*)(?P\x07|\x1b\\)' + '|' + r'(?P(?:' + ZERO_WIDTH_PATTERN.pattern + '))' ) # Indeterminate effect sequences - raise ValueError in 'strict' mode. The effects of these sequences # are likely to be undesirable, moving the cursor vertically or to any unknown position, and # otherwise not managed by the 'width' method of this library. # # This table was created initially with code generation by extraction of termcap library with # techniques used at 'blessed' library runtime for 'xterm', 'alacritty', 'kitty', ghostty', # 'screen', 'tmux', and others. Then, these common capabilities were merged into the list below. INDETERMINATE_EFFECT_SEQUENCE = re.compile( '|'.join(f'(?:{_pattern})' for _pattern in ( r'\x1b\[\d+;\d+r', # change_scroll_region r'\x1b\[\d*K', # erase_in_line (clr_eol, clr_bol) r'\x1b\[\d*J', # erase_in_display (clr_eos, erase_display) r'\x1b\[\d+;\d+H', # cursor_address r'\x1b\[\d*H', # cursor_home r'\x1b\[\d*A', # cursor_up r'\x1b\[\d*B', # cursor_down r'\x1b\[\d*P', # delete_character r'\x1b\[\d*M', # delete_line r'\x1b\[\d*L', # insert_line r'\x1b\[\d*@', # insert_character r'\x1b\[\d+X', # erase_chars r'\x1b\[\d*S', # scroll_up (parm_index) r'\x1b\[\d*T', # scroll_down (parm_rindex) r'\x1b\[\d*d', # row_address r'\x1b\[\?1049[hl]', # alternate screen buffer r'\x1b\[\?47[hl]', # alternate screen (legacy) r'\x1b8', # restore_cursor r'\x1bD', # scroll_forward (index) r'\x1bM', # scroll_reverse (reverse index) r'\x1bc', # full_reset (RIS) )) ) def iter_sequences(text: str) -> typing.Iterator[typing.Tuple[str, bool]]: r""" Iterate through text, yielding segments with sequence identification. This generator yields tuples of ``(segment, is_sequence)`` for each part of the input text, where ``is_sequence`` is ``True`` if the segment is a recognized terminal escape sequence. :param text: String to iterate through. :returns: Iterator of (segment, is_sequence) tuples. .. versionadded:: 0.3.0 Example:: >>> list(iter_sequences('hello')) [('hello', False)] >>> list(iter_sequences('\x1b[31mred')) [('\x1b[31m', True), ('red', False)] >>> list(iter_sequences('\x1b[1m\x1b[31m')) [('\x1b[1m', True), ('\x1b[31m', True)] """ idx = 0 text_len = len(text) segment_start = 0 while idx < text_len: char = text[idx] if char == '\x1b': # Yield any accumulated non-sequence text if idx > segment_start: yield (text[segment_start:idx], False) # Try to match an escape sequence match = ZERO_WIDTH_PATTERN.match(text, idx) if match: yield (match.group(), True) idx = match.end() else: # Lone ESC or unrecognized - yield as sequence anyway yield (char, True) idx += 1 segment_start = idx else: idx += 1 # Yield any remaining text if segment_start < text_len: yield (text[segment_start:], False) def strip_sequences(text: str) -> str: r""" Return text with all terminal escape sequences removed. Unknown or incomplete ESC sequences are preserved. :param text: String that may contain terminal escape sequences. :returns: The input text with all escape sequences stripped. .. versionadded:: 0.3.0 .. versionchanged:: 0.7.0 Inner text of OSC 66 (Text sizing protocol) is preserved. Example:: >>> strip_sequences('\x1b[31mred\x1b[0m') 'red' >>> strip_sequences('hello') 'hello' >>> strip_sequences('\x1b[1m\x1b[31mbold red\x1b[0m text') 'bold red text' >>> strip_sequences('\x1b]66;s=2;hello\x07') 'hello' >>> strip_sequences('\x1b]8;id=34;https://example.com\x1b\\[view]\x1b]8;;\x1b\\') '[view]' """ if '\x1b]66;' in text: text = TEXT_SIZING_PATTERN.sub(r'\2', text) return ZERO_WIDTH_PATTERN.sub('', text)