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: Описание команды.

property max_parameters_count: int: Максимальное количество параметров.

property min_parameters_count: int: Минимальное количество параметров.

property name: str: Название команды.

property positions: list[_Position]: Список позиций.

set_category(category: str | None)[исходный код]

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

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