kolo/Argenta
1
0
Fork 0
mirror of https://github.com/koloideal/Argenta.git synced 2026-06-10 10:05:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
kolo
2025-11-29 11:51:59 +03:00
parent 47fda23431
commit 2a96dfcabe
28 changed files with 103 additions and 242 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/root/api/command/possible_values.rst
+11 -31
View File
@@ -4,26 +4,23 @@
PossibleValues
==============
`PossibleValues` — это перечисление (`Enum`), которое определяет специальные режимы валидации для значений флагов. Его задача — предоставить стандартные константы для управления поведением флагов. `PossibleValues` используется в параметре `possible_values` класса `Flag`, чтобы указать, может ли флаг принимать значения и какие ограничения на них накладываются.
``PossibleValues`` — это перечисление (``Enum``), которое определяет специальные режимы валидации для значений флагов. ``PossibleValues`` используется в параметре ``possible_values`` класса ``Flag``, чтобы указать, может ли флаг принимать значения и какие ограничения на них накладываются.
`PossibleValues` наследуется от `Enum` и содержит два основных значения: `NEITHER` (для флагов без значений) и `ALL` (для флагов, принимающих любые значения). Это перечисление используется вместе со списками строк и регулярными выражениями для создания гибкой системы валидации.
``PossibleValues`` содержит два основных значения: ``NEITHER`` (для флагов, которые не могут принимать значения) и ``ALL`` (для флагов, принимающих любые значения). Это перечисление используется вместе со списками строк и регулярными выражениями для создания гибкой системы валидации.
.. note::
Результат валидации доступен через атрибут `status` у экземпляра `InputFlag`. Подробнее см. :ref:`здесь <root_api_command_input_flag>`.
Результат валидации доступен через атрибут ``status`` у экземпляра ``InputFlag``. Подробнее см. :ref:`здесь <root_api_command_input_flag>`.
.. seealso::
Документация по :ref:`Flag <root_api_command_flag>` — класс флага, использующий `PossibleValues`.
Документация по :ref:`Flag <root_api_command_flag>` — класс флага, использующий ``PossibleValues``.
Документация по :ref:`PredefinedFlags <root_api_command_flag_predefined_flags>` — готовые флаги с примерами использования `PossibleValues`.
Документация по :ref:`ValidationStatus <root_api_command_validation_status>` — результат валидации ввёденного флага.
:ref:`Общая информация <root_flags>` о флагах и их использовании в приложении ``Argenta``
-----
Значения enum
-------------
NEITHER
~~~~~~~
@@ -65,10 +62,8 @@ ALL
**Примеры флагов с** ``ALL``:
* ``--output`` — путь к выходному файлу
* ``--message`` — произвольное текстовое сообщение
* ``--name`` — произвольное имя
* ``--data`` — произвольные данные
**Пример использования:**
@@ -78,35 +73,20 @@ ALL
-----
Использование в Flag
---------------------
Параметр possible_values
~~~~~~~~~~~~~~~~~~~~~~~~~
`PossibleValues` используется как один из возможных типов для параметра `possible_values` при создании экземпляра `Flag`.
``PossibleValues`` используется как один из возможных типов для параметра ``possible_values`` при создании экземпляра ``Flag``.
**Доступные типы для** `possible_values`:
**Доступные типы для** ``possible_values``:
1. `PossibleValues.NEITHER`: флаг без значения.
2. `PossibleValues.ALL`: флаг с любым значением (по умолчанию).
3. `list[str]`: флаг с ограниченным набором значений.
4. `Pattern[str]`: флаг со значением, проверяемым по регулярному выражению.
1. ``PossibleValues.NEITHER``: флаг без значения.
2. ``PossibleValues.ALL``: флаг с любым значением (по умолчанию).
3. ``list[str]``: флаг с ограниченным набором значений.
4. ``Pattern[str]``: флаг со значением, проверяемым по регулярному выражению.
**Пример комбинированного использования:**
.. literalinclude:: ../../../code_snippets/possible_values/combined.py
:linenos:
:language: python
-----
Использование в PredefinedFlags
-------------------------------
Многие предопределённые флаги используют `PossibleValues.NEITHER`:
.. literalinclude:: ../../../code_snippets/possible_values/predefined.py
:linenos:
:language: python