Skip to content

Config Formatters

Here belong tools for configuration formatting purposes.

Attributes

FORMATTERS

1
2
3
4
FORMATTERS: dict[str, type[FormatterBase]] = {formatter.alias: formatter for formatter in (
    ArgsFormatter,
    IniFormatter,
)}

Available formatters by alias.

Functions

format_print_text

1
2
3
4
5
format_print_text(
    text: str, 
    color_fg: str | None = None,  # (1)!
    color_bg: str | None = None,  # (2)!
) -> str

  1. text (foreground) color

  2. text (background) color

Format given text using ANSI formatting escape sequences.

Could be useful for print command.

Classes

ArgsFormatter

1
ArgsFormatter(sections: list[Section])

FormatterBase

Translates a configuration to command line arguments.

iter_options 

1
.iter_options() -> Generator[tuple[str, str, Any], None, None]

Iterates configuration sections groups options.

FormatterBase

1
FormatterBase(sections: list[Section])

Base class for configuration formatters.

iter_options

1
.iter_options() -> Generator[tuple[str, str, Any], None, None]

Iterates configuration sections groups options.

IniFormatter

1
IniFormatter(sections: list[Section])

FormatterBase

Translates a configuration as INI file.

iter_options 

1
.iter_options() -> Generator[tuple[str, str, Any], None, None]

Iterates configuration sections groups options.