This commit is contained in:
2025-11-29 11:51:59 +03:00
parent 47fda23431
commit 2a96dfcabe
28 changed files with 103 additions and 242 deletions
+4 -45
View File
@@ -3,7 +3,7 @@
InputFlag
=========
Объект `InputFlag` представляет собой флаг, введённый пользователем. Он создаётся в результате обработки пользовательского ввода и содержит информацию о распознанном флаге: его имя, префикс, значение и статус валидации.
Объект ``InputFlag`` представляет собой флаг, введённый пользователем. Он создаётся в результате обработки пользовательского ввода и содержит информацию о распознанном флаге: его имя, префикс, значение и статус валидации.
.. seealso::
@@ -13,26 +13,6 @@ InputFlag
-----
Инициализация
-------------
.. code-block:: python
:linenos:
__init__(
self, name: str, *,
prefix: Literal['-', '--', '---'] = '--',
input_value: str | None,
status: ValidationStatus | None
)
Создаёт новый объект введённого флага.
* ``name``: Имя введённого флага.
* ``prefix``: Префикс флага (``-``, ``--``, ``---``). По умолчанию ``--``.
* ``input_value``: Значение, переданное с флагом. Может быть `None`.
* ``status``: Статус валидации из перечисления `ValidationStatus`.
.. warning ::
Экземпляры этого класса не предназначены для прямого создания. Они содержатся в объекте :ref:`Response <root_api_response>`.
@@ -55,13 +35,7 @@ InputFlag
.. py:attribute:: status
:no-index:
Статус валидации флага: `ValidationStatus.VALID`, `ValidationStatus.INVALID` или `ValidationStatus.UNDEFINED`.
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag/snippet1.py
:linenos:
:language: python
Статус валидации флага: ``ValidationStatus.VALID``, ``ValidationStatus.INVALID`` или ``ValidationStatus.UNDEFINED``.
-----
@@ -81,14 +55,6 @@ string_entity
:return: Строковое представление флага
Это свойство объединяет префикс и имя в строку, представляющую флаг так, как он был введён в командной строке.
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag/snippet2.py
:linenos:
:language: python
-----
Магические методы
@@ -124,7 +90,7 @@ __repr__
Возвращает отладочное представление объекта.
:return: Строка в формате `InputFlag<prefix=..., name=..., value=..., status=...>`.
:return: Строка в формате ``InputFlag<prefix=..., name=..., value=..., status=...>``.
**Пример использования:**
@@ -145,13 +111,6 @@ __eq__
Сравнивает два введённых флага на равенство по имени.
:param other: Объект для сравнения.
:return: `True`, если имена флагов совпадают, иначе `False`.
:raises NotImplementedError: Если `other` не является экземпляром `InputFlag`.
:return: **True**, если имена флагов совпадают, иначе **False**.
Два введённых флага считаются равными, если их имена совпадают.
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag/snippet5.py
:linenos:
:language: python