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.
97 lines
4.8 KiB
ReStructuredText
97 lines
4.8 KiB
ReStructuredText
.. _root_api_index:
|
|
|
|
|
|
Публичное API
|
|
=============
|
|
|
|
Описание раздела
|
|
----------------
|
|
|
|
В этом разделе описан публичный API библиотеки. Он включает:
|
|
|
|
- Классы и функции для интеграции в ваши приложения.
|
|
- Рекомендации по использованию и поддерживаемые сценарии.
|
|
- Примеры кода, подробные сигнатуры и описание возвращаемых значений.
|
|
- Гарантии стабильности и обратной совместимости.
|
|
|
|
Интерфейсы, не описанные в этом разделе, считаются внутренними. Их использование может привести к ошибкам при обновлении библиотеки. При разработке собственных решений используйте только компоненты, описанные здесь. Это обеспечит стабильность и совместимость ваших продуктов с будущими версиями ``Argenta``.
|
|
|
|
-----
|
|
|
|
Публичные импорты
|
|
-----------------
|
|
|
|
Все основные компоненты библиотеки доступны для прямого импорта из корневого пакета ``argenta`` или его подмодулей.
|
|
|
|
.. rubric:: Основные компоненты
|
|
|
|
.. code-block:: python
|
|
|
|
from argenta import App, Orchestrator, Router, Command, Response
|
|
|
|
* :ref:`App <root_api_app_index>` — Объект приложения, который отвечает за логику роутинга, настройки, валидации и т.д.
|
|
* :ref:`Orchestrator <root_api_orchestrator_index>` — Класс для конфигурирования и запуска всего приложения.
|
|
* :ref:`Router <root_api_router>` — Класс для группировки и регистрации команд.
|
|
* :ref:`Command <root_api_command_index>` — Класс для создания команд при инициализации хэндлеров.
|
|
* :ref:`Response <root_api_response>` — Объект ответа, передаваемый в обработчики.
|
|
|
|
.. rubric:: Команды и флаги
|
|
|
|
.. code-block:: python
|
|
|
|
from argenta.command import (
|
|
Flag,
|
|
Flags,
|
|
InputFlag,
|
|
InputFlags,
|
|
PossibleValues,
|
|
ValidationStatus,
|
|
PredefinedFlags
|
|
)
|
|
|
|
* :ref:`Flag <root_api_command_flag>` — Класс для описания флага.
|
|
* :ref:`Flags <root_api_command_flags>` — Коллекция для регистрации флагов.
|
|
* :ref:`InputFlag <root_api_command_input_flag>` — Класс для введённого пользователем флага.
|
|
* :ref:`InputFlags <root_api_command_input_flags>` — Коллекция введённых флагов.
|
|
* :ref:`PossibleValues <root_api_command_possible_values>` — Правила валидации значений флага.
|
|
* :ref:`ValidationStatus <root_api_command_validation_status>` — Статусы валидации флагов.
|
|
* :ref:`PredefinedFlags <root_api_command_flag_predefined_flags>` — Коллекция предопределённых флагов.
|
|
|
|
.. rubric:: Настройка приложения
|
|
|
|
.. code-block:: python
|
|
|
|
from argenta.app import (
|
|
AutoCompleter,
|
|
StaticDividingLine,
|
|
DynamicDividingLine,
|
|
PredefinedMessages
|
|
)
|
|
|
|
* :ref:`AutoCompleter <root_api_app_autocompleter>` - Класс для настройки автодополнения.
|
|
* :ref:`StaticDividingLine <root_api_app_dividing_lines>` — Статическая разделительная линия для оформления вывода.
|
|
* :ref:`DynamicDividingLine <root_api_app_dividing_lines>` — Динамическая разделительная линия для оформления вывода.
|
|
* :ref:`PredefinedMessages <root_api_predefined_messages>` — Готовые сообщения для вывода при старте приложения.
|
|
|
|
.. rubric:: Внедрение зависимостей
|
|
|
|
.. code-block:: python
|
|
|
|
from argenta.di import (
|
|
FromDishka,
|
|
inject
|
|
)
|
|
|
|
* :ref:`FromDishka <root_dependency_injection>` — Маркер аргумента функции как зависимости, которая должна быть инжектирована.
|
|
* :ref:`inject <root_dependency_injection>` — Декоратор для инжектирования зависимостей, указанных в сигнатуре.
|
|
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
app/index
|
|
router
|
|
orchestrator/index
|
|
command/index
|
|
response
|
|
bridge |