Helper

class dublib.CLI.Terminalyzer.Helper.Helper

Модуль помощи.

property callback: Callable

Функция, в которую направляется вывод помощи.

property category: str | None

Категория команд.

property command: Command

Описание команды помощи.

enable(status: bool = True)

Переключает использование модуля помощи.

Параметры:

status (bool) – Статус использования модуля.

enable_sorting(status: bool = True)

Переключает сортировку команд в алфавитном порядке.

Параметры:

status (bool) – Состояние сортировки.

generate_help_command(commands: list[Command], command_name: str, typing: bool = True)

Отправляет подробное описание команды в callback-функцию.

Параметры:

• commands (list[Command]) – Описательные структуры комманд.

• command_name (str) – Название команды, для которой требуется получить помощь.

• typing (bool) – Переключает отображение типов.

generate_help_list(commands: list[Command])

Отправляет список команд с их описанием в callback-функцию.

Параметры:

commands (list[Command]) – Описательные структуры комманд.

property is_enabled: bool

Состояние: активирован ли модуль помощи.

property is_sorting_enabled: bool

Состояние: выполняется ли сортировка команд по алфавиту.

property labels: _HelpLabels

Оператор работы с используемыми в модуле помощи строками.

set_callback(callback: Callable)

Задаёт функцию, в которую будет передан вывод помощи.

Параметры:

callback (Callable) – Функция, в которую направляется вывод помощи. Принимает строку в качестве аргумента.

set_category(category: str | None)

Задаёт категорию для команды помощи.

Параметры:

category (str | None) – Название категории.