mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 18:15: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
4.3 KiB
ReStructuredText
117 lines
4.3 KiB
ReStructuredText
.. _root_api_response:
|
||
|
||
Response
|
||
========
|
||
|
||
``Response`` — это объект, который передаётся в обработчик команды. Он создаётся автоматически при обработке пользовательского ввода и содержит статус валидации, введённые флаги.
|
||
|
||
|
||
.. seealso::
|
||
|
||
Документация по :ref:`InputFlags <root_api_command_input_flags>` — коллекция введённых флагов команды.
|
||
|
||
Документация по :ref:`ResponseStatus <root_api_response_status>` — статусы валидации флагов команды.
|
||
|
||
Документация по :ref:`InputFlag <root_api_command_input_flag>` — отдельный введённый флаг.
|
||
|
||
-----
|
||
|
||
Инициализация
|
||
-------------
|
||
|
||
.. code-block:: python
|
||
:linenos:
|
||
|
||
__init__(
|
||
self, status: ResponseStatus,
|
||
input_flags: InputFlags = EMPTY_INPUT_FLAGS,
|
||
)
|
||
|
||
Создаёт новый объект ответа.
|
||
|
||
* ``status``: Общий статус валидации флагов из перечисления ``ResponseStatus``.
|
||
* ``input_flags``: Коллекция введённых флагов (``InputFlags``). По умолчанию — пустая.
|
||
|
||
.. warning::
|
||
Экземпляры этого класса не предназначены для прямого создания. Они автоматически формируются системой и передаются в обработчик команды в качестве первого обязательного аргумента.
|
||
|
||
**Атрибуты:**
|
||
|
||
.. py:attribute:: status
|
||
:no-index:
|
||
|
||
Общий статус валидации всех флагов команды (``ResponseStatus``). Указывает, были ли среди введённых флагов некорректные или незарегистрированные.
|
||
|
||
.. py:attribute:: input_flags
|
||
:no-index:
|
||
|
||
Коллекция всех флагов, переданных с командой (``InputFlags``). Содержит все обработанные флаги с их значениями и статусами валидации.
|
||
|
||
**Пример использования:**
|
||
|
||
.. literalinclude:: ../../code_snippets/response/snippet1.py
|
||
:linenos:
|
||
:language: python
|
||
|
||
-----
|
||
|
||
Работа с флагами
|
||
----------------
|
||
|
||
``Response`` предоставляет доступ к введённым флагам через атрибут ``input_flags``. Вы можете проверять их наличие, получать значения и статусы валидации.
|
||
|
||
**Пример работы с флагами:**
|
||
|
||
.. literalinclude:: ../../code_snippets/response/snippet6.py
|
||
:linenos:
|
||
:language: python
|
||
|
||
-----
|
||
|
||
.. _root_api_response_status:
|
||
|
||
ResponseStatus
|
||
--------------
|
||
|
||
``ResponseStatus`` — это перечисление, которое определяет общий статус валидации всех флагов команды. Используется в атрибуте ``status`` объекта ``Response``.
|
||
|
||
ALL_FLAGS_VALID
|
||
~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: python
|
||
:linenos:
|
||
|
||
ResponseStatus.ALL_FLAGS_VALID = 'ALL_FLAGS_VALID'
|
||
|
||
Все введённые флаги прошли валидацию. Нет ни некорректных, ни незарегистрированных флагов.
|
||
|
||
UNDEFINED_FLAGS
|
||
~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: python
|
||
:linenos:
|
||
|
||
ResponseStatus.UNDEFINED_FLAGS = 'UNDEFINED_FLAGS'
|
||
|
||
Среди введённых флагов есть незарегистрированные, но нет флагов с некорректными значениями.
|
||
|
||
INVALID_VALUE_FLAGS
|
||
~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: python
|
||
:linenos:
|
||
|
||
ResponseStatus.INVALID_VALUE_FLAGS = 'INVALID_VALUE_FLAGS'
|
||
|
||
Среди введённых флагов есть флаги с некорректными значениями, но нет незарегистрированных.
|
||
|
||
UNDEFINED_AND_INVALID_FLAGS
|
||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
.. code-block:: python
|
||
:linenos:
|
||
|
||
ResponseStatus.UNDEFINED_AND_INVALID_FLAGS = 'UNDEFINED_AND_INVALID_FLAGS'
|
||
|
||
Среди введённых флагов есть как незарегистрированные, так и флаги с некорректными значениями.
|