Command

class dublib.CLI.Terminalyzer.Command.Definition.Command(name: str, description: str | None = None, category: str | None = None)

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

property base: _BasePosition

Базовая позиция команды.

property category: str | None

Название категории, к которой относится команда.

create_position(name: str, description: str | None = None, important: bool = False) → _Position

Создаёт дополнительную позицию.

Параметры:

• name (str) – Название позиции.

• description (str | None) – Описание позиции.

• important (bool) – Указывает, является ли позиция обязательной. Для всех параметров позиции автоматически выставляется такое же значение.

Результат:

Представление новой позиции.

Тип результата:

Position

property description: str | None

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

get_position(name: str) → _Position

Возвращает позицию.

Параметры:

name (str) – Имя позиции.

Результат:

Позиция.

Тип результата:

_Position

Исключение:

KeyError – Позиция не найдена.

property max_parameters_count: int

Максимальное количество параметров.

property min_parameters_count: int

Минимальное количество параметров.

property name: str

Название команды.

property positions: tuple[_Position, ...]

Список позиций.

set_category(category: str | None)

Задаёт категорию, в которой будет отображаться команда при выводе помощи.

Параметры:

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