pip._vendor.rich.control Namespace Reference

Data Structures
class	Control

Functions
str	strip_control_codes (str text, Dict[int, None] _translate_table=_CONTROL_STRIP_TRANSLATE)
str	escape_control_codes (str text, Dict[int, str] _translate_table=CONTROL_ESCAPE)

Variables
list	STRIP_CONTROL_CODES
dict	_CONTROL_STRIP_TRANSLATE
dict	CONTROL_ESCAPE
dict	CONTROL_CODES_FORMAT
	console = Console()

Function Documentation

escape_control_codes()

str escape_control_codes	(	str	text,
		Dict[int, str]	_translate_table = CONTROL_ESCAPE
	)

Replace control codes with their "escaped" equivalent in the given text.
(e.g. "\b" becomes "\\b")

Args:
    text (str): A string possibly containing control codes.

Returns:
    str: String with control codes replaced with their escaped version.

Definition at line 201 of file control.py.

) -> str:
    """Replace control codes with their "escaped" equivalent in the given text.
    (e.g. "\b" becomes "\\b")
 
    Args:
        text (str): A string possibly containing control codes.
 
    Returns:
        str: String with control codes replaced with their escaped version.
    """
    return text.translate(_translate_table)
 
 

References i.

strip_control_codes()

str strip_control_codes	(	str	text,
		Dict[int, None]	_translate_table = _CONTROL_STRIP_TRANSLATE
	)

Remove control codes from text.

Args:
    text (str): A string possibly contain control codes.

Returns:
    str: String with control codes removed.

Definition at line 187 of file control.py.

) -> str:
    """Remove control codes from text.
 
    Args:
        text (str): A string possibly contain control codes.
 
    Returns:
        str: String with control codes removed.
    """
    return text.translate(_translate_table)
 
 

References i.

Variable Documentation

_CONTROL_STRIP_TRANSLATE

dict _CONTROL_STRIP_TRANSLATE

protected

Initial value:

=  {
    _codepoint: None for _codepoint in STRIP_CONTROL_CODES
}

Definition at line 22 of file control.py.

console

console = Console()

Definition at line 220 of file control.py.

CONTROL_CODES_FORMAT

dict CONTROL_CODES_FORMAT

Initial value:

=  {
    ControlType.BELL: lambda: "\x07",
    ControlType.CARRIAGE_RETURN: lambda: "\r",
    ControlType.HOME: lambda: "\x1b[H",
    ControlType.CLEAR: lambda: "\x1b[2J",
    ControlType.ENABLE_ALT_SCREEN: lambda: "\x1b[?1049h",
    ControlType.DISABLE_ALT_SCREEN: lambda: "\x1b[?1049l",
    ControlType.SHOW_CURSOR: lambda: "\x1b[?25h",
    ControlType.HIDE_CURSOR: lambda: "\x1b[?25l",
    ControlType.CURSOR_UP: lambda param: f"\x1b[{param}A",
    ControlType.CURSOR_DOWN: lambda param: f"\x1b[{param}B",
    ControlType.CURSOR_FORWARD: lambda param: f"\x1b[{param}C",
    ControlType.CURSOR_BACKWARD: lambda param: f"\x1b[{param}D",
    ControlType.CURSOR_MOVE_TO_COLUMN: lambda param: f"\x1b[{param+1}G",
    ControlType.ERASE_IN_LINE: lambda param: f"\x1b[{param}K",
    ControlType.CURSOR_MOVE_TO: lambda x, y: f"\x1b[{y+1};{x+1}H",
    ControlType.SET_WINDOW_TITLE: lambda title: f"\x1b]0;{title}\x07",
}

Definition at line 34 of file control.py.

CONTROL_ESCAPE

dict CONTROL_ESCAPE

Initial value:

=  {
    7: "\\a",
    8: "\\b",
    11: "\\v",
    12: "\\f",
    13: "\\r",
}

Definition at line 26 of file control.py.

STRIP_CONTROL_CODES

list STRIP_CONTROL_CODES

Initial value:

=  [
    7,  # Bell
    8,  # Backspace
    11,  # Vertical tab
    12,  # Form feed
    13,  # Carriage return
]

Definition at line 15 of file control.py.