This commit is contained in:
2025-11-02 00:17:28 +03:00
parent acddb1fbc6
commit df7313912c
26 changed files with 501 additions and 566 deletions
+24 -23
View File
@@ -3,15 +3,15 @@
Flags
======
Объект ``Flags`` представляет собой коллекцию флагов команды в приложении ``Argenta``. Его основная задача — группировать и управлять набором флагов, зарегистрированных для конкретной команды. ``Flags`` служит контейнером, который позволяет удобно добавлять, извлекать и итерировать флаги, а также проверять их наличие.
`Flags` — это коллекция флагов команды. Её основная задача — группировать и управлять набором флагов, зарегистрированных для конкретной команды. `Flags` служит контейнером, который позволяет удобно добавлять, извлекать, итерировать флаги и проверять их наличие.
``Flags`` наследуется от базового класса ``BaseFlags`` и специализируется для работы с объектами типа ``Flag``. Этот класс используется при создании команд с множественными флагами и предоставляет интерфейс для управления ими.
`Flags` наследуется от базового класса `BaseFlags` и специализируется на работе с объектами типа `Flag`. Этот класс используется при создании команд с несколькими флагами и предоставляет интерфейс для управления ими.
.. seealso::
Документация по отдельным флагам (:ref:`Flag <root_api_command_flag>`, :ref:`InputFlag <root_api_command_input_flag>`)
Документация по :ref:`InputFlags <root_api_command_input_flags>` — коллекции распаршенных флагов пользователя
Документация по :ref:`InputFlags <root_api_command_input_flags>` — коллекция обработанных флагов, введённых пользователем.
:ref:`Общая информация <root_flags>` о флагах и их использовании в приложении ``Argenta``
@@ -25,15 +25,16 @@ Flags
__init__(self, flags: list[Flag] | None = None) -> None
Создает новую коллекцию флагов.
Создаёт новую коллекцию флагов.
* ``flags`` : Необязательный список флагов типа ``Flag`` для инициализации коллекции. Если не указан, создается пустая коллекция.
* ``flags``: Необязательный список флагов типа `Flag` для инициализации коллекции. Если не указан, создаётся пустая коллекция.
**Атрибуты:**
.. py:attribute:: flags
:no-index:
Список всех зарегистрированных флагов типа ``Flag``. Пустой список, если флаги не были переданы при инициализации.
Список всех зарегистрированных флагов типа `Flag`. Пуст, если флаги не были переданы при инициализации.
**Пример использования:**
@@ -54,12 +55,12 @@ add_flag
add_flag(self, flag: Flag) -> None
Добавляет один флаг в коллекцию.
Добавляет флаг в коллекцию.
:param flag: Флаг типа ``Flag`` для добавления в коллекцию
:return: None
:param flag: Флаг типа `Flag` для добавления.
:return: None.
Метод добавляет переданный флаг в конец списка ``flags``. Используется для динамического расширения набора флагов после создания коллекции.
Метод добавляет флаг в конец списка `flags`. Используется для динамического расширения набора флагов.
**Пример использования:**
@@ -77,12 +78,12 @@ add_flags
add_flags(self, flags: list[Flag]) -> None
Добавляет список флагов в коллекцию.
Добавляет в коллекцию список флагов.
:param flags: Список флагов типа ``Flag`` для добавления
:return: None
:param flags: Список флагов типа `Flag` для добавления.
:return: None.
Метод расширяет текущую коллекцию, добавляя все флаги из переданного списка. Эффективен для пакетного добавления множества флагов.
Метод расширяет коллекцию, добавляя в неё все флаги из переданного списка. Эффективен для пакетного добавления.
**Пример использования:**
@@ -100,12 +101,12 @@ get_flag_by_name
get_flag_by_name(self, name: str) -> Flag | None
Получает флаг по его имени.
Возвращает флаг по имени.
:param name: Имя искомого флага
:return: Объект ``Flag`` с указанным именем или ``None``, если флаг не найден
:param name: Имя искомого флага.
:return: Объект `Flag` или `None`, если флаг не найден.
Метод выполняет поиск по списку ``flags`` и возвращает первый флаг с соответствующим именем. Если флаг не найден, возвращается ``None``.
Метод выполняет поиск по списку `flags` и возвращает первый флаг с соответствующим именем. Если флаг не найден, возвращается `None`.
**Пример использования:**
@@ -126,9 +127,9 @@ __iter__
__iter__(self) -> Iterator[Flag]
Делает коллекцию итерируемой, позволяя использовать её в циклах.
Делает коллекцию итерируемой для использования в циклах.
:return: Итератор по списку флагов
:return: Итератор по списку флагов.
**Пример использования:**
@@ -146,10 +147,10 @@ __getitem__
__getitem__(self, flag_index: int) -> Flag
Позволяет получать флаги по индексу.
Позволяет получать флаг по индексу.
:param flag_index: Индекс флага в списке
:return: Флаг с указанным индексом
:param flag_index: Индекс флага в списке.
:return: Флаг по указанному индексу.
**Пример использования:**