mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
kolo
ce7e24b924
The entire public api is covered with documentation in two languages - Russian and English. the library now supports the latest three versions of python - 3.12, 3.13 and 3.14 minor design changes: now, when a Boolean flag is entered, its value is an empty string, not None. tests have been adapted to the supported versions of python, readmi has been redesigned in two languages, German is no longer available.
117 lines
3.2 KiB
ReStructuredText
117 lines
3.2 KiB
ReStructuredText
.. _root_api_command_input_flag:
|
|
|
|
InputFlag
|
|
=========
|
|
|
|
Объект ``InputFlag`` представляет собой флаг, введённый пользователем. Он создаётся в результате обработки пользовательского ввода и содержит информацию о распознанном флаге: его имя, префикс, значение и статус валидации.
|
|
|
|
.. seealso::
|
|
|
|
Документация по :ref:`Flag <root_api_command_flag>` — класс для регистрации флага.
|
|
|
|
Документация по :ref:`ValidationStatus <root_api_command_validation_status>` — статусы валидации флагов.
|
|
|
|
-----
|
|
|
|
.. warning ::
|
|
Экземпляры этого класса не предназначены для прямого создания. Они содержатся в объекте :ref:`Response <root_api_response>`.
|
|
|
|
**Атрибуты:**
|
|
|
|
.. py:attribute:: name
|
|
:no-index:
|
|
|
|
Имя введённого флага.
|
|
|
|
.. py:attribute:: prefix
|
|
:no-index:
|
|
|
|
Префикс флага: ``-``, ``--`` или ``---``.
|
|
|
|
.. py:attribute:: input_value
|
|
|
|
Значение, переданное с флагом. Может быть ``''`` (пустой строкой) для флагов без значений.
|
|
|
|
.. py:attribute:: status
|
|
:no-index:
|
|
|
|
Статус валидации флага: ``ValidationStatus.VALID``, ``ValidationStatus.INVALID`` или ``ValidationStatus.UNDEFINED``.
|
|
|
|
-----
|
|
|
|
Свойства
|
|
--------
|
|
|
|
string_entity
|
|
~~~~~~~~~~~~~
|
|
|
|
.. code-block:: python
|
|
:linenos:
|
|
|
|
@property
|
|
string_entity(self) -> str
|
|
|
|
Возвращает строковое представление флага в формате ``prefix + name``.
|
|
|
|
:return: Строковое представление флага
|
|
|
|
-----
|
|
|
|
Магические методы
|
|
-----------------
|
|
|
|
__str__
|
|
~~~~~~~
|
|
|
|
.. code-block:: python
|
|
:linenos:
|
|
|
|
__str__(self) -> str
|
|
|
|
Возвращает строковое представление флага вместе с его значением.
|
|
|
|
:return: Строка в формате ``флаг значение``.
|
|
|
|
**Пример использования:**
|
|
|
|
.. literalinclude:: ../../../code_snippets/input_flag/snippet3.py
|
|
:linenos:
|
|
:language: python
|
|
|
|
-----
|
|
|
|
__repr__
|
|
~~~~~~~~
|
|
|
|
.. code-block:: python
|
|
:linenos:
|
|
|
|
__repr__(self) -> str
|
|
|
|
Возвращает отладочное представление объекта.
|
|
|
|
:return: Строка в формате ``InputFlag<prefix=..., name=..., value=..., status=...>``.
|
|
|
|
**Пример использования:**
|
|
|
|
.. literalinclude:: ../../../code_snippets/input_flag/snippet4.py
|
|
:linenos:
|
|
:language: python
|
|
|
|
-----
|
|
|
|
__eq__
|
|
~~~~~~
|
|
|
|
.. code-block:: python
|
|
:linenos:
|
|
|
|
__eq__(self, other: object) -> bool
|
|
|
|
Сравнивает два введённых флага на равенство по имени.
|
|
|
|
:param other: Объект для сравнения.
|
|
:return: **True**, если имена флагов совпадают, иначе **False**.
|
|
|
|
Два введённых флага считаются равными, если их имена совпадают.
|