ANSI escape codes (style, colour)

We use ANSI escape codes to format documentation. You can type these in to your docstrings directly, or (more readable), you can also use the aliases we provide.

seali.RESET

Place this in a string to reset all current styles and colours.

Styles

Use within an f-string as f"...{seali.BOLD}red text here{seali.RESET}..." to set the style.

seali.BOLD

seali.FAINT

seali.ITALIC

seali.UNDERLINE

Colours (standard)

Use within an f-string as f"...{seali.RED}red text here{seali.RESET}..." to set the foreground (text) colour.

Use as f"...{seali.RED.bg}..." to set the background colour.

Use as f"...{seali.RED.bright}..." to set the foreground (text) colour to the bright version of that colour.

Use as f"...{seali.RED.bright_bg}..." to set the background colour to the bright version of that colour.

seali.BLACK

seali.RED

seali.GREEN

seali.YELLOW

seali.BLUE

seali.MAGENTA

seali.CYAN

seali.WHITE

Colours (RGB)

seali.RGB

Create an ANSI colour of red/green/blue.

Use within an f-string as

colour = seali.RGB(r=10, g=255, b=45)
f"...{colour}coloured text here{seali.RESET}..."

to set the foreground (text) colour, and

colour = seali.RGB(r=10, g=255, b=45)
f"...{colour.bg}coloured background here{seali.RESET}..."

to set the background colour.

__init__(r: int, g: int, b: int)

Arguments:

• r: the amount of red, an integer from 0 to 255 inclusive.
• g: the amount of green, an integer from 0 to 255 inclusive.
• b: the amount of blue, an integer from 0 to 255 inclusive.