mridc.utils.formaters package

Submodules

mridc.utils.formaters.base module

class mridc.utils.formaters.base.BaseMRIDCFormatter(color=True, fmt=None, datefmt=None, colors=None)[source]

Bases: BaseFormatter

Base formatter for MRIDC logs.

DEFAULT_FORMAT = '%(color)s[MRIDC %(levelname)1.1s %(asctime)s %(module)s:%(lineno)d]%(end_color)s %(message)s'
class mridc.utils.formaters.base.DebugMRIDCFormatter(color=True, fmt=None, datefmt=None, colors=None)[source]

Bases: BaseFormatter

Debug formatter for MRIDC logs.

DEFAULT_FORMAT = '%(color)s[MRIDC %(levelname)1.1s %(asctime)s %(module)s:%(lineno)d rank:%(rank)s]%(end_color)s %(message)s'

mridc.utils.formaters.colors module

class mridc.utils.formaters.colors.AnsiBack[source]

Bases: AnsiCodes

ANSI color codes for background text.

BLACK = 40
BLUE = 44
CYAN = 46
GREEN = 42
LIGHTBLACK_EX = 100
LIGHTBLUE_EX = 104
LIGHTCYAN_EX = 106
LIGHTGREEN_EX = 102
LIGHTMAGENTA_EX = 105
LIGHTRED_EX = 101
LIGHTWHITE_EX = 107
LIGHTYELLOW_EX = 103
MAGENTA = 45
RED = 41
RESET = 49
WHITE = 47
YELLOW = 43
class mridc.utils.formaters.colors.AnsiCodes[source]

Bases: object

ANSI color codes.

class mridc.utils.formaters.colors.AnsiCursor[source]

Bases: object

ANSI cursor codes.

static BACK(n=1)[source]

Move the cursor back n lines.

Parameters

n (Number of lines.) – int

Returns

str

Return type

String of characters.

static DOWN(n=1)[source]

Move the cursor down n lines.

Parameters

n (Number of lines.) – int

Returns

str

Return type

String of characters.

static FORWARD(n=1)[source]

Move the cursor forward n lines.

Parameters

n (Number of lines.) – int

Returns

str

Return type

String of characters.

static POS(x=1, y=1)[source]

Move the cursor to the specified position.

Parameters

  • x (X position.) – int

  • y (Y position.) – int

Returns

str

Return type

String of characters.

static UP(n=1)[source]

Move the cursor up n lines.

Parameters

n (Number of lines.) – int

Returns

str

Return type

String of characters.

class mridc.utils.formaters.colors.AnsiFore[source]

Bases: AnsiCodes

ANSI color codes for foreground text.

BLACK = 30
BLUE = 34
CYAN = 36
GREEN = 32
LIGHTBLACK_EX = 90
LIGHTBLUE_EX = 94
LIGHTCYAN_EX = 96
LIGHTGREEN_EX = 92
LIGHTMAGENTA_EX = 95
LIGHTRED_EX = 91
LIGHTWHITE_EX = 97
LIGHTYELLOW_EX = 93
MAGENTA = 35
RED = 31
RESET = 39
WHITE = 37
YELLOW = 33
class mridc.utils.formaters.colors.AnsiStyle[source]

Bases: AnsiCodes

ANSI color codes for text styles.

BRIGHT = 1
DIM = 2
NORMAL = 22
RESET_ALL = 0
mridc.utils.formaters.colors.clear_line(mode=2)[source]

Clear terminal line.

Parameters

mode (Mode.) – int

Returns

str

Return type

String of characters.

mridc.utils.formaters.colors.clear_screen(mode=2)[source]

Clear terminal screen.

Parameters

mode (Mode.) – int

Returns

str

Return type

String of characters.

mridc.utils.formaters.colors.code_to_chars(code)[source]

Convert ANSI color code to string of characters.

Parameters

code (ANSI color code.) – int

Returns

str

Return type

String of characters.

mridc.utils.formaters.colors.set_title(title)[source]

Set terminal title.

Parameters

title (Title.) – str

Returns

str

Return type

String of characters.

mridc.utils.formaters.utils module

mridc.utils.formaters.utils.check_color_support()[source]
Returns

bool

Return type

True if the terminal supports color, False otherwise.

mridc.utils.formaters.utils.to_unicode(value)[source]

Converts a string to unicode. If the string is already unicode, it is returned as is. If it is a byte string, it is decoded using utf-8.

Parameters

value (The string to convert.) – str

Returns

str

Return type

The converted string.

Module contents