Response

Response is an object that is passed to the command handler. It is created automatically when processing user input and contains validation status and entered flags.

See also

Documentation for InputFlags — collection of entered command flags.

Documentation for ResponseStatus — command flag validation statuses.

Documentation for InputFlag — individual entered flag.

---

Initialization

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

Creates a new response object.

• status: Overall flag validation status from the ResponseStatus enumeration.

• input_flags: Collection of entered flags (InputFlags). Empty by default.

Warning

Instances of this class are not intended for direct creation. They are automatically formed by the system and passed to the command handler as the first required argument.

Attributes:

status

Overall validation status of all command flags (ResponseStatus). Indicates whether there were any incorrect or unregistered flags among the entered ones.

input_flags

Collection of all flags passed with the command (InputFlags). Contains all processed flags with their values and validation statuses.

Usage example:

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.")

---

Working with Flags

Response provides access to entered flags through the input_flags attribute. You can check their presence, get values, and validation statuses.

Example of working with 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 is an enumeration that defines the overall validation status of all command flags. Used in the status attribute of the Response object.

ALL_FLAGS_VALID

ResponseStatus.ALL_FLAGS_VALID = 'ALL_FLAGS_VALID'

All entered flags passed validation. There are no incorrect or unregistered flags.

UNDEFINED_FLAGS

ResponseStatus.UNDEFINED_FLAGS = 'UNDEFINED_FLAGS'

Among the entered flags, there are unregistered ones, but no flags with incorrect values.

INVALID_VALUE_FLAGS

ResponseStatus.INVALID_VALUE_FLAGS = 'INVALID_VALUE_FLAGS'

Among the entered flags, there are flags with incorrect values, but no unregistered ones.

UNDEFINED_AND_INVALID_FLAGS

ResponseStatus.UNDEFINED_AND_INVALID_FLAGS = 'UNDEFINED_AND_INVALID_FLAGS'

Among the entered flags, there are both unregistered flags and flags with incorrect values.