mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs
This commit is contained in:
@@ -17,10 +17,6 @@ root_doc = "index"
|
|||||||
locale_dirs = ['locales/']
|
locale_dirs = ['locales/']
|
||||||
gettext_compact = False
|
gettext_compact = False
|
||||||
|
|
||||||
extensions = [
|
|
||||||
"sphinx.ext.graphviz"
|
|
||||||
]
|
|
||||||
|
|
||||||
templates_path = ["_templates"]
|
templates_path = ["_templates"]
|
||||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||||
|
|
||||||
|
|||||||
+2
-1
@@ -32,7 +32,8 @@ Argenta предназначена для создания приложений,
|
|||||||
Следующая диаграмма иллюстрирует, как компоненты Argenta взаимодействуют друг с другом, обрабатывая ввод пользователя.
|
Следующая диаграмма иллюстрирует, как компоненты Argenta взаимодействуют друг с другом, обрабатывая ввод пользователя.
|
||||||
|
|
||||||
.. image:: https://i.ibb.co/hF3FdFr1/argenta-intro-drawio-2.png
|
.. image:: https://i.ibb.co/hF3FdFr1/argenta-intro-drawio-2.png
|
||||||
:alt: Архитектура Argenta
|
:alt: Request Lifecycle Diagram
|
||||||
|
:align: center
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|||||||
@@ -67,10 +67,13 @@ App
|
|||||||
:param routers: Последовательность экземпляров ``Router`` для регистрации.
|
:param routers: Последовательность экземпляров ``Router`` для регистрации.
|
||||||
|
|
||||||
- .. py:method:: add_message_on_startup(self, message: str) -> None
|
- .. py:method:: add_message_on_startup(self, message: str) -> None
|
||||||
|
|
||||||
Добавляет текстовое сообщение, которое выводится при запуске приложения после `initial_message`.
|
Добавляет текстовое сообщение, которое выводится при запуске приложения после `initial_message`.
|
||||||
|
|
||||||
:param message: Строка с сообщением.
|
:param message: Строка с сообщением.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
Для вывода стандартных сообщений можно использовать готовые шаблоны из :ref:`PredefinedMessages <root_api_predefined_messages>`.
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
@@ -135,3 +138,42 @@ App
|
|||||||
|
|
||||||
autocompleter
|
autocompleter
|
||||||
dividing_lines
|
dividing_lines
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. _root_api_predefined_messages:
|
||||||
|
|
||||||
|
PredefinedMessages
|
||||||
|
------------------
|
||||||
|
|
||||||
|
`PredefinedMessages` — это перечисление (Enum), содержащее набор готовых к использованию строковых сообщений. Они отформатированы с использованием синтаксиса `rich` и предназначены для вывода стандартной информации, такой как подсказки по использованию.
|
||||||
|
|
||||||
|
Вы можете импортировать и использовать их напрямую в своих обработчиках.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
from argenta.app import PredefinedMessages
|
||||||
|
|
||||||
|
def my_handler(response):
|
||||||
|
print(PredefinedMessages.USAGE)
|
||||||
|
|
||||||
|
.. py:class:: PredefinedMessages
|
||||||
|
|
||||||
|
.. py:attribute:: USAGE
|
||||||
|
|
||||||
|
Строка: ``[b dim]Usage[/b dim]: [i]<command> <[green]flags[/green]>[/i]``
|
||||||
|
|
||||||
|
Отображается как: ``Usage: <command> <flags>``
|
||||||
|
|
||||||
|
.. py:attribute:: HELP
|
||||||
|
|
||||||
|
Строка: ``[b dim]Help[/b dim]: [i]<command>[/i] [b red]--help[/b red]``
|
||||||
|
|
||||||
|
Отображается как: ``Help: <command> --help``
|
||||||
|
|
||||||
|
.. py:attribute:: AUTOCOMPLETE
|
||||||
|
|
||||||
|
Строка: ``[b dim]Autocomplete[/b dim]: [i]<part>[/i] [bold]<tab>``
|
||||||
|
|
||||||
|
Отображается как: ``Autocomplete: <part> <tab>``
|
||||||
|
|||||||
@@ -95,5 +95,4 @@
|
|||||||
router
|
router
|
||||||
orchestrator/index
|
orchestrator/index
|
||||||
command/index
|
command/index
|
||||||
response
|
response
|
||||||
|
|
||||||
@@ -37,8 +37,6 @@
|
|||||||
|
|
||||||
Вы можете заранее определить список допустимых значений для флага.
|
Вы можете заранее определить список допустимых значений для флага.
|
||||||
|
|
||||||
**Пример:**
|
|
||||||
|
|
||||||
Предположим, у вас есть флаг ``--format``, который может принимать только значения ``json`` или ``xml``.
|
Предположим, у вас есть флаг ``--format``, который может принимать только значения ``json`` или ``xml``.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
@@ -57,8 +55,6 @@
|
|||||||
|
|
||||||
Для более сложных проверок можно использовать регулярные выражения. Это полезно, когда значение должно соответствовать определённому формату (например, email-адрес, дата или номер телефона).
|
Для более сложных проверок можно использовать регулярные выражения. Это полезно, когда значение должно соответствовать определённому формату (например, email-адрес, дата или номер телефона).
|
||||||
|
|
||||||
**Пример:**
|
|
||||||
|
|
||||||
Допустим, флаг ``--email`` должен принимать только корректные email-адреса.
|
Допустим, флаг ``--email`` должен принимать только корректные email-адреса.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|||||||
Reference in New Issue
Block a user