Terminal

Note

The code for socon.utils.terminal was initially copied from pytest 7.2, file src/_pytest/terminal.py. Link to the project: https://github.com/pytest-dev/pytest

This document will present the TerminalWriter that Socon use to print information in the terminal. We believe that this can be really useful for Socon based framework to display information in the terminal. We will also show how to colorize the output of the terminal using the colorize() function.

Colorize function

colorize(opts: Union[tuple, list] = [], fg: str = None, bg: str = None, **_: dict)

Return your text enclosed by ANSI graphics code.

Parameters:

• msg – Text message

• opts – Text decorations

• fg – Foreground colors

• bg – Background colors

Valid decorators:

• ‘bold’

• ‘underscore’

• ‘blink’

• ‘reverse’

• ‘conceal’

• ‘noreset’ - string will not be auto-terminated with the RESET code

Valid colors:

• ‘black’

• ‘red’

• ‘green’

• ‘yellow’

• ‘blue’

• ‘magenta’

• ‘cyan’

• ‘white’

Examples:

colorize(‘hello’, fg=’red’, bg=’blue’, opts=(‘blink’,))

print(colorize(‘first line’, fg=’red’, opts=(‘noreset’,)))

print(‘this should be red too’)

colorize(opts=(‘reset’,))

print(‘This will be print with default color’)

TerminalWriter objects

class TerminalWriter

Base class to write information on the terminal.

Configurable attributes

TerminalWriter.stream

The output stream of the terminal. If not specified at the terminal creation, the default stream is sys.stdout.

Read-only attributes

TerminalWriter.fullwidth

Return the current size of the terminal.

Methods

TerminalWriter.sep(sepchar: str, title: str = None, fullwidth: int = None, **markup)

Create a separator line with or without a title. By default the separator will use the fullwidth of the terminal. A specific width can be passed to the function if required. You can also pass the newline argument if you want to add a newline before, after or before and after the separator.

Parameters:

markup – Parameters of the colorize() function. Example: tw.sep(‘-’, ‘Hello’, fg=’blue’)

TerminalWriter.write(msg: str, *, flush: bool = False. **markup)

Write a message to the terminal.

Parameters:

markup – Parameters of the colorize() function. Example: tw.write(‘Hello’, fg=’blue’)

TerminalWriter.line(msg: str, **markup)

Write a message that will end with a new line.

Parameters:

markup – Parameters of the colorize() function. Example: tw.line(‘Hello’, fg=’blue’)

TerminalWriter.flush()

Flush the stream output buffer. The write everything in the buffer to the terminal.

TerminalWriter.rewrite(line: str, erase: bool = False, **markup)

Rewinds the terminal cursor to the beginning and writes the given line.

Parameters:

markup – Parameters of the colorize() function. Example: tw.rewrite(‘Hello’, fg=’blue’)

TerminalWriter.underline(msg: str, decorator: str = '-', **markup)

Underline a message with a decorator.

Parameters:

markup – Parameters of the colorize() function. Example: tw.underline(‘Hello’, fg=’blue’)