mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
docs: fix all references
This commit is contained in:
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Argenta \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-10-16 23:51+0300\n"
|
||||
"POT-Creation-Date: 2025-10-17 18:46+0300\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language: en\n"
|
||||
@@ -49,7 +49,7 @@ msgid "Краткий сэмпл кода, переопределяющего х
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:25
|
||||
msgid "Возможные исключения"
|
||||
msgid "Возможные исключения и нестандартное поведение"
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:28
|
||||
@@ -141,12 +141,12 @@ msgid "Сэмпл кода, переопределяющего хэндлер в
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:97
|
||||
msgid "``UnknownCommandException``: Введена неизвестная команда"
|
||||
msgid "``Поведение обработки неизвестной команды``: Введена неизвестная команда"
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:99
|
||||
msgid ""
|
||||
"Исключение вызывается, когда пользователь вводит команду, которая не "
|
||||
"Поведение триггерится, когда пользователь вводит команду, которая не "
|
||||
"зарегистрирована ни в одном роутере и не является алиасом ни для одной "
|
||||
"зарегистрированной команды."
|
||||
msgstr ""
|
||||
@@ -167,6 +167,34 @@ msgstr ""
|
||||
msgid "Сэмпл кода, переопределяющего хэндлер ввода неизвестной команды:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:120
|
||||
msgid "``Поведение выхода из приложения``: Введена команда выхода"
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:122
|
||||
msgid ""
|
||||
"Поведение триггерится, когда пользователь вводит команду, которая "
|
||||
"маркирована как команда завершения работы."
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:124
|
||||
msgid "Дефолтный хэндлер выводит в консоль текст и завершает работу приложения."
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:130
|
||||
msgid ""
|
||||
"Для переопределения стандартного поведения используется сеттер "
|
||||
"``.set_exit_command_handler(_: NonStandardBehaviorHandler[Response])``, "
|
||||
"протокол ``NonStandardBehaviorHandler[Response]`` соответствует "
|
||||
"``Callable[[Response], None]``, то есть хэндлер должен быть вызываемым "
|
||||
"объектом, к примеру функция или лямбда, которая принимает обязательный "
|
||||
"аргумент типа :ref:`Response <response>` и ничего не возвращает."
|
||||
msgstr ""
|
||||
|
||||
#: ../../root/error_handling.rst:134
|
||||
msgid "Сэмпл кода, переопределяющего хэндлер ввода команды выхода:"
|
||||
msgstr ""
|
||||
|
||||
#~ msgid "привет"
|
||||
#~ msgstr ""
|
||||
|
||||
@@ -379,3 +407,17 @@ msgstr ""
|
||||
#~ "``provide`` instead?"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "Возможные исключения"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid "``UnknownCommandException``: Введена неизвестная команда"
|
||||
#~ msgstr ""
|
||||
|
||||
#~ msgid ""
|
||||
#~ "Исключение вызывается, когда пользователь "
|
||||
#~ "вводит команду, которая не зарегистрирована"
|
||||
#~ " ни в одном роутере и не "
|
||||
#~ "является алиасом ни для одной "
|
||||
#~ "зарегистрированной команды."
|
||||
#~ msgstr ""
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _Autocompleter:
|
||||
.. _root_api_app_autocompleter:
|
||||
|
||||
Autocompleter
|
||||
****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _DividingLines:
|
||||
.. _root_api_app_dividing_lines:
|
||||
|
||||
DividingLines
|
||||
****************
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _root_api_app_index:
|
||||
|
||||
App
|
||||
****************
|
||||
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
.. _Flags:
|
||||
.. _root_api_command_flags:
|
||||
|
||||
Flags
|
||||
****************
|
||||
|
||||
|
||||
.. _flag:
|
||||
|
||||
Flag
|
||||
****************
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _command:
|
||||
.. _root_api_command_index:
|
||||
|
||||
Command
|
||||
=======
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _PossibleValues:
|
||||
.. _root_api_command_possible_values:
|
||||
|
||||
PossibleValues
|
||||
****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _ValidationStatus:
|
||||
.. _root_api_command_validation_status:
|
||||
|
||||
ValidationStatus
|
||||
****************
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
.. _root_api_index:
|
||||
|
||||
|
||||
Публичный API
|
||||
****************
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _Argparser:
|
||||
.. _root_api_orchestrator_argparser:
|
||||
|
||||
Argparser
|
||||
****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _Arguments:
|
||||
.. _root_api_orchestrator_arguments:
|
||||
|
||||
Arguments
|
||||
****************
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
.. _root_api_orchestrator_index:
|
||||
|
||||
Orchestrator
|
||||
****************
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
|
||||
argparser
|
||||
arguments
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _Response:
|
||||
.. _root_api_response:
|
||||
|
||||
Response
|
||||
****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _Router:
|
||||
.. _root_api_router:
|
||||
|
||||
Router
|
||||
****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _contributing:
|
||||
.. _root_contributing:
|
||||
|
||||
Вклад в проект
|
||||
***************************
|
||||
@@ -6,4 +6,4 @@
|
||||
``argenta`` открытый проект и мы рады новым разработчикам в нашем сообществе.
|
||||
|
||||
Getting started
|
||||
========================
|
||||
========================
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _DependencyInjection:
|
||||
.. _root_dependency_injection:
|
||||
|
||||
Внедрение зависимостей
|
||||
****************************
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _root_error_handling:
|
||||
|
||||
Обработка ошибок
|
||||
==========================================
|
||||
|
||||
@@ -12,7 +14,7 @@
|
||||
.. note::
|
||||
Все исключения никогда не остаются необработанными, так как у них есть стандартные хэндлеры. Поэтому переопределение опционально.
|
||||
|
||||
Краткий сэмпл кода, переопределяющего хэндлер ввода
|
||||
Краткий сэмпл кода, переопределяющего хэндлер ввода
|
||||
пустой команды
|
||||
|
||||
.. literalinclude:: ../code_snippets/error_handling_example_sample.py
|
||||
@@ -28,7 +30,7 @@
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Исключение вызывается, когда пользователь вводит команду с некорректным синтаксисом и парсер не может
|
||||
*распарсить* её. В большинстве случаев это означат, что проблема в синтаксисе введённых флагов команды, подробнее о
|
||||
*распарсить* её. В большинстве случаев это означат, что проблема в синтаксисе введённых флагов команды, подробнее о
|
||||
флагах и их синтаксисе в :ref:`Flags <root_flags>`.
|
||||
|
||||
Дефолтный хэндлер выводит в консоль
|
||||
@@ -36,9 +38,9 @@
|
||||
.. code-block:: shell
|
||||
|
||||
Incorrect flag syntax: <raw input command>
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_incorrect_input_syntax_handler(_: NonStandardBehaviorHandler[str])``,
|
||||
протокол ``NonStandardBehaviorHandler[str]`` соответствует ``Callable[[str], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_incorrect_input_syntax_handler(_: NonStandardBehaviorHandler[str])``,
|
||||
протокол ``NonStandardBehaviorHandler[str]`` соответствует ``Callable[[str], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая принимает единственный аргумент - строку, которая представляет собой необработанную введённую команду, и ничего не возвращает.
|
||||
|
||||
Сэмпл кода, переопределяющего хэндлер ввода команды с некорректным синтаксисом:
|
||||
@@ -51,26 +53,29 @@
|
||||
``RepeatedInputFlagsException``: Повторяющийся флаг в введённой команде
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Исключение вызывается, когда пользователь вводит команду с повторяющимся флагом, флаг(:ref:`InputFlag <input_flag>`) считается повторяющимся, если
|
||||
введён флаг с таким же именем, именно именем, без префикса. Подробнее о флагах и их синтаксисе в :ref:`Flags <root_flags>`.
|
||||
Исключение вызывается, когда пользователь вводит команду с повторяющимся флагом, пара введённых флагов(:ref:`InputFlag <input_flag>`) считается
|
||||
равной, если у них одинаковые имена. Подробнее о флагах и их синтаксисе в :ref:`Flags <root_flags>`.
|
||||
|
||||
.. note::
|
||||
Сравнение на равенство у регистрируемых флагов(Flag) происходит иначе, подробнее в :ref:`Flag <root_flags>`.
|
||||
|
||||
Дефолтный хэндлер выводит в консоль
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
Repeated input flags: <raw input command>
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_repeated_input_flags_handler(_: NonStandardBehaviorHandler[str])``,
|
||||
протокол ``NonStandardBehaviorHandler[str]`` соответствует ``Callable[[str], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_repeated_input_flags_handler(_: NonStandardBehaviorHandler[str])``,
|
||||
протокол ``NonStandardBehaviorHandler[str]`` соответствует ``Callable[[str], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая принимает единственный аргумент - строку, которая представляет собой необработанную введённую команду, и ничего не возвращает.
|
||||
|
||||
Сэмпл кода, переопределяющего хэндлер ввода команды с повторяющимися флагами:
|
||||
|
||||
.. literalinclude:: ../code_snippets/error_handling_example_sample3.py
|
||||
:language: python
|
||||
|
||||
|
||||
---------------
|
||||
|
||||
|
||||
``EmptyInputCommandException``: Введена пустая команда
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -81,22 +86,22 @@
|
||||
.. code-block:: shell
|
||||
|
||||
Empty input command
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_empty_command_handler(_: EmptyCommandHandler)``,
|
||||
протокол ``EmptyCommandHandler`` соответствует ``Callable[[], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_empty_command_handler(_: EmptyCommandHandler)``,
|
||||
протокол ``EmptyCommandHandler`` соответствует ``Callable[[], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая не принимает аргументов и ничего не возвращает.
|
||||
|
||||
Сэмпл кода, переопределяющего хэндлер ввода пустой команды:
|
||||
|
||||
.. literalinclude:: ../code_snippets/error_handling_example_sample4.py
|
||||
:language: python
|
||||
|
||||
---------------
|
||||
|
||||
|
||||
---------------
|
||||
|
||||
``Поведение обработки неизвестной команды``: Введена неизвестная команда
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Поведение триггерится, когда пользователь вводит команду, которая не зарегистрирована ни в одном роутере и не является алиасом ни для
|
||||
Поведение триггерится, когда пользователь вводит команду, которая не зарегистрирована ни в одном роутере и не является алиасом ни для
|
||||
одной зарегистрированной команды.
|
||||
|
||||
Дефолтный хэндлер выводит в консоль
|
||||
@@ -104,18 +109,18 @@
|
||||
.. code-block:: shell
|
||||
|
||||
Unknown command: <trigger of the input command>
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_unknown_command_handler(_: NonStandardBehaviorHandler[InputCommand])``,
|
||||
протокол ``NonStandardBehaviorHandler[InputCommand]`` соответствует ``Callable[[InputCommand], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_unknown_command_handler(_: NonStandardBehaviorHandler[InputCommand])``,
|
||||
протокол ``NonStandardBehaviorHandler[InputCommand]`` соответствует ``Callable[[InputCommand], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая принимает обязательный аргумент типа :ref:`InputCommand <input_command>` и ничего не возвращает.
|
||||
|
||||
Сэмпл кода, переопределяющего хэндлер ввода неизвестной команды:
|
||||
|
||||
.. literalinclude:: ../code_snippets/error_handling_example_sample5.py
|
||||
:language: python
|
||||
|
||||
|
||||
---------------
|
||||
|
||||
|
||||
``Поведение выхода из приложения``: Введена команда выхода
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -126,13 +131,12 @@
|
||||
.. code-block:: shell
|
||||
|
||||
See you
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_exit_command_handler(_: NonStandardBehaviorHandler[Response])``,
|
||||
протокол ``NonStandardBehaviorHandler[Response]`` соответствует ``Callable[[Response], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая принимает обязательный аргумент типа :ref:`Response <response>` и ничего не возвращает.
|
||||
|
||||
Для переопределения стандартного поведения используется сеттер ``.set_exit_command_handler(_: NonStandardBehaviorHandler[Response])``,
|
||||
протокол ``NonStandardBehaviorHandler[Response]`` соответствует ``Callable[[Response], None]``, то есть хэндлер должен быть вызываемым объектом,
|
||||
к примеру функция или лямбда, которая принимает обязательный аргумент типа :ref:`Response <root_api_response>` и ничего не возвращает.
|
||||
|
||||
Сэмпл кода, переопределяющего хэндлер ввода команды выхода:
|
||||
|
||||
.. literalinclude:: ../code_snippets/error_handling_example_sample6.py
|
||||
:language: python
|
||||
|
||||
+2
-3
@@ -1,5 +1,4 @@
|
||||
.. _root_flags:
|
||||
|
||||
Флаги
|
||||
=====
|
||||
|
||||
Флаги вводимых команд
|
||||
=====================
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _overriding_formatting:
|
||||
.. _root_overriding_formatting:
|
||||
|
||||
Переопределение форматирования
|
||||
*****************************************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _quickstart:
|
||||
.. _root_quickstart:
|
||||
|
||||
Быстрый старт
|
||||
********************
|
||||
@@ -8,20 +8,19 @@
|
||||
.. code-block:: shell
|
||||
|
||||
pip install argenta
|
||||
|
||||
|
||||
2. **Определение роутера и хэндлеров**. За регистрацию функции как обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен принимать аргумент с типом ``Response``, подробнее в :ref:`разделе <Response>`.
|
||||
|
||||
.. literalinclude:: ../code_snippets/quickstart_example_routers.py
|
||||
:language: python
|
||||
|
||||
|
||||
3. **Определение приложения и оркестратора**. Для запуска приложения необходимо вызвать ``.include_router()`` у созданного приложения и передать ему раннее созданный роутер, после этого необходимо вызвать ``.start_polling()`` у созданного оркестратора и передать ему созданное приложение.
|
||||
|
||||
.. literalinclude:: ../code_snippets/quickstart_example_main.py
|
||||
:language: python
|
||||
|
||||
|
||||
4. **Запуск приложения**. Запускаем приложение как обычный скрипт.
|
||||
|
||||
|
||||
.. image:: https://github.com/koloideal/Argenta/blob/docs/create_docs/imgs/mock_app_preview6.png?raw=true
|
||||
:alt: Quickstart Example
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
.. _root_redirect_stdout:
|
||||
|
||||
|
||||
Перенаправление стандартного вывода
|
||||
***********************************
|
||||
|
||||
|
||||
Reference in New Issue
Block a user