Flags

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

См. также

Документация по отдельным флагам (Flag, InputFlag)

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

Общая информация о флагах и их использовании в приложении Argenta

---

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

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

Создаёт новую коллекцию флагов.

• flags: Необязательный список флагов типа Flag для инициализации коллекции. Если не указан, создаётся пустая коллекция.

Атрибуты:

flags

Список всех зарегистрированных флагов типа Flag.

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

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)

---

Методы

add_flag

add_flag(self, flag: Flag) -> None

Добавляет флаг в коллекцию.

param flag:

Флаг типа Flag для добавления.

return:

None.

Используется для динамического расширения набора флагов.

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

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

Добавляет в коллекцию список флагов.

param flags:

Список флагов типа Flag для добавления.

return:

None.

Метод расширяет коллекцию, добавляя в неё все флаги из переданного списка. Эффективен для пакетного добавления.

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

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

Возвращает флаг по имени.

param name:

Имя искомого флага.

return:

Объект Flag или None, если флаг не найден.

Метод возвращает флаг с соответствующим именем. Если флаг не найден, возвращается None.

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

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