Flags

Flags is a collection of command flags. Its main purpose is to group and manage the set of flags registered for a specific command. Flags serves as a container that allows convenient addition, retrieval, iteration of flags, and checking their presence.

See also

Documentation for individual flags (Flag, InputFlag)

Documentation for InputFlags — a collection of processed flags entered by the user.

General information about flags and their usage in the Argenta application

---

Initialization

__init__(self, flags: list[Flag] | None = None) -> None

Creates a new flag collection.

• flags: Optional list of flags of type Flag for initializing the collection. If not specified, an empty collection is created.

Attributes:

flags

List of all registered flags of type Flag.

Usage example:

import re
from argenta.command import Command, Flag, Flags

flags = Flags(
    [
        Flag("host", possible_values=re.compile(r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")),
        Flag("port", possible_values=re.compile(r"^\d{1,5}$")),
    ]
)

cmd = Command("start", description="Start the server", flags=flags)

---

Methods

add_flag

add_flag(self, flag: Flag) -> None

Adds a flag to the collection.

param flag:

Flag of type Flag to add.

return:

None.

Used for dynamically extending the set of flags.

Usage example:

from argenta.command import Flag, Flags

flags: Flags = Flags()

flags.add_flag(Flag("config"))
flags.add_flag(Flag("debug"))
flags.add_flag(Flag("log-level", possible_values=["INFO", "DEBUG", "ERROR"]))

print(len(flags))  # 3

---

add_flags

add_flags(self, flags: list[Flag]) -> None

Adds a list of flags to the collection.

param flags:

List of flags of type Flag to add.

return:

None.

The method extends the collection by adding all flags from the provided list. Efficient for batch addition.

Usage example:

from argenta.command import Flag, Flags
from argenta.command.flag.defaults import PredefinedFlags

flags = Flags([PredefinedFlags.HOST])

additional_flags = [
    PredefinedFlags.PORT,
    Flag("database"),
    Flag("ssl"),
    Flag("verbose"),
]

flags.add_flags(additional_flags)

print(len(flags))  # 5

---

get_flag_by_name

get_flag_by_name(self, name: str) -> Flag | None

Returns a flag by name.

param name:

Name of the flag to search for.

return:

Flag object or None if the flag is not found.

The method returns a flag with the corresponding name. If the flag is not found, None is returned.

Usage example:

from argenta.command import Flag, Flags
from argenta.command.flag.defaults import PredefinedFlags


flags = Flags([PredefinedFlags.HOST, PredefinedFlags.PORT, Flag("verbose")])

host_flag = flags.get_flag_by_name("host")
if host_flag:
    print(f"Found flag: {host_flag.name}")

unknown_flag = flags.get_flag_by_name("nonexistent")
if unknown_flag is None:
    print("Flag not found")