TTkString

class TTkString(text: str = '', color: TTkColor = None)

Bases: object

TermTk String Helper

The TTkString constructor creates a terminal String object.

Parameters:

• text (str, optional) – text of the string, defaults to “”

• color (TTkColor, optional) – the color of the string, defaults to TTkColor.RST

Example:

# No params Constructor
str1 = TTkString() + "test 1"
str2 = TTkString() + TTkColor.BOLD + "test 2"

# Indexed params constructor
str3 = TTkString("test 3")
str4 = TTkString("test 4", TTkColor.ITALIC)

# Named params constructor
str5 = TTkString(text="test 5")
str6 = TTkString(text="test 6", color=TTkColor.ITALIC+TTkColor.bg("000044"))

# Combination of constructors (Highly Unrecommended)
str7 = TTkString("test 7", color=TTkColor.fg('#FF0000'))

Methods

align(width=None, color=<TermTk.TTkCore.color._TTkColor object>, alignment=0) → Self

Align the string

Parameters:

• width (int, optional) – the new width

• color (TTkColor, optional) – the color of the padding, defaults to TTkColor.RST

• alignment (TTkConstant.Alignment, optional) – the alignment of the text to the full width NONE

charAt(pos: int) → str

colorAt(pos: int) → TTkColor

completeColor(color, match=None, posFrom=None, posTo=None) → Self

Complete the color of the entire string or a slice of it

The Fg and/or Bg of the string is replaced with the selected Fg/Bg color only if missing

If only the color is specified, the entire string is colorized

Parameters:

• color (TTkColor) – the color to be used, defaults to TTkColor.RST

• match (str, optional) – the match to colorize

• posFrom (int, optional) – the initial position of the color

• posTo (int, optional) – the final position of the color

extractShortcuts() → Self

find(*args, **kwargs) → None

findall(regexp, ignoreCase=False)

FindAll the regexp matches in the string

Parameters:

• regexp (str) – the regular expression to be matched

• ignoreCase (bool) – Ignore case, defaults to False

getData()

getIndexes(char)

isPlainText() → bool

Return True if the string does not include colors or modifications

isdigit() → bool

join(strings: list[Self]) → Self

Join the input strings using the current as separator

Parameters:

strings (list) – the list of strings to be joined

lstrip(ch: str) → Self

nextPos(pos)

prevPos(pos)

replace(*args, **kwargs) → Self

replace (old, new, count)

Replace “old” match with “new” string for “count” times

Parameters:

• old (str) – the match to be placed

• new (str, optional) – the match to replace

• count (int, optional) – the number of occurrences

sameAs(other: Self) → bool

search(regexp, ignoreCase=False)

Return the re.match of the regexp

Parameters:

• regexp (str) – the regular expression to be matched

• ignoreCase (bool) – Ignore case, defaults to False

setCharAt(pos: int, char: str) → Self

setColor(color, match=None, posFrom=None, posTo=None) → Self

Set the color of the entire string or a slice of it

If only the color is specified, the entire string is colorized

Parameters:

• color (TTkColor) – the color to be used, defaults to TTkColor.RST

• match (str, optional) – the match to colorize

• posFrom (int, optional) – the initial position of the color

• posTo (int, optional) – the final position of the color

setColorAt(pos, color) → Self

split(separator) → list[Self]

Split the string using a separator

Note

Only a one char separator is currently supported

Parameters:

separator (str) – the “char” separator to be used

substring(fr=None, to=None) → Self

Return the substring

Parameters:

• fr (int, optional) – the starting of the slice, defaults to 0

• to (int, optional) – the ending of the slice, defaults to the end of the string

tab2spaces(tabSpaces=4) → Self

Return the string representation with the tabs (converted in spaces) trimmed and aligned

tabCharPos(pos, tabSpaces=4, alignTabRight=False) → int

Return the char position in the string from the position in its representation with the tab and variable char sizes are solved

i.e.

pos                   X = 11
tab2Spaces |----------|---------------------|
Tabs             |-|  |  |-|     |-|   |
_text      L😁rem   ipsum   dolor   sit amet,
chars      .. ...t  .....t  .....t  ...t.....
ret                   x = 7 (tab is a char)

termWidth() → int

toAnsi(strip=False)

Return the ansii (terminal colors/events) representation of the string

toAscii() → str

Return the ascii representation of the string

TTkString Attributes

unicodeWideOverflowColor