Response

Response — это объект, который передаётся в обработчик команды. Он создаётся автоматически при обработке пользовательского ввода и содержит статус валидации, введённые флаги.

См. также

Документация по InputFlags — коллекция введённых флагов команды.

Документация по ResponseStatus — статусы валидации флагов команды.

Документация по InputFlag — отдельный введённый флаг.

---

Инициализация

__init__(
    self, status: ResponseStatus,
    input_flags: InputFlags = EMPTY_INPUT_FLAGS,
)

Создаёт новый объект ответа.

• status: Общий статус валидации флагов из перечисления ResponseStatus.

• input_flags: Коллекция введённых флагов (InputFlags). По умолчанию — пустая.

Предупреждение

Экземпляры этого класса не предназначены для прямого создания. Они автоматически формируются системой и передаются в обработчик команды в качестве первого обязательного аргумента.

Атрибуты:

status

Общий статус валидации всех флагов команды (ResponseStatus). Указывает, были ли среди введённых флагов некорректные или незарегистрированные.

input_flags

Коллекция всех флагов, переданных с командой (InputFlags). Содержит все обработанные флаги с их значениями и статусами валидации.

Пример использования:

from argenta import Command, Response, Router
from argenta.response import ResponseStatus

router = Router(title="Example")


@router.command(Command("greet", description="Greet the user"))
def greet_handler(response: Response):
    if response.status == ResponseStatus.ALL_FLAGS_VALID:
        print("Hello! All flags are valid.")
    else:
        print("Warning: Some flags have issues.")

---

Работа с флагами

Response предоставляет доступ к введённым флагам через атрибут input_flags. Вы можете проверять их наличие, получать значения и статусы валидации.

Пример работы с флагами:

from argenta import Command, Response, Router
from argenta.command import Flag, Flags
from argenta.command.flag import ValidationStatus
from argenta.response import ResponseStatus

router = Router(title="Flags Example")


@router.command(
    Command(
        "process",
        description="Process with flags",
        flags=Flags([Flag("format", possible_values=["json", "xml"]), Flag("verbose")]),
    )
)
def process_handler(response: Response):
    print(f"Status: {response.status}")

    format_flag = response.input_flags.get_flag_by_name("format")
    verbose_flag = response.input_flags.get_flag_by_name("verbose")

    if format_flag:
        format_value = format_flag.input_value
        print(f"Format: {format_value}")

    if verbose_flag:
        print("Verbose mode enabled")

    if response.status == ResponseStatus.ALL_FLAGS_VALID:
        print("All flags are valid, proceeding...")
    elif response.status == ResponseStatus.INVALID_VALUE_FLAGS:
        print("Warning: Some flags have invalid values")
        for flag in response.input_flags:
            if flag.status == ValidationStatus.INVALID:
                print(f"  Invalid flag: {flag.string_entity} = {flag.input_value}")

---

ResponseStatus

ResponseStatus — это перечисление, которое определяет общий статус валидации всех флагов команды. Используется в атрибуте status объекта Response.

ALL_FLAGS_VALID

ResponseStatus.ALL_FLAGS_VALID = 'ALL_FLAGS_VALID'

Все введённые флаги прошли валидацию. Нет ни некорректных, ни незарегистрированных флагов.

UNDEFINED_FLAGS

ResponseStatus.UNDEFINED_FLAGS = 'UNDEFINED_FLAGS'

Среди введённых флагов есть незарегистрированные, но нет флагов с некорректными значениями.

INVALID_VALUE_FLAGS

ResponseStatus.INVALID_VALUE_FLAGS = 'INVALID_VALUE_FLAGS'

Среди введённых флагов есть флаги с некорректными значениями, но нет незарегистрированных.

UNDEFINED_AND_INVALID_FLAGS

ResponseStatus.UNDEFINED_AND_INVALID_FLAGS = 'UNDEFINED_AND_INVALID_FLAGS'

Среди введённых флагов есть как незарегистрированные, так и флаги с некорректными значениями.