kolo/Argenta
1
0
Fork 0
mirror of https://github.com/koloideal/Argenta.git synced 2026-06-10 10:05:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
kolo
2025-11-01 11:38:48 +03:00
parent 0598f6e7a5
commit e4a5c6d398
73 changed files with 53 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/root/api/app/autocompleter.rst
+1 -1
View File
@@ -46,6 +46,6 @@ AutoCompleter
``AutoCompleter`` передается как аргумент при инициализации `App`.
.. literalinclude:: ../../../code_snippets/autocompleter_snippet.py
.. literalinclude:: ../../../code_snippets/autocompleter/snippet.py
:language: python
:linenos:
docs/root/api/app/dividing_lines.rst
+1 -1
View File
@@ -70,6 +70,6 @@ Dividing Lines
Пример конфигурации
--------------------
.. literalinclude:: ../../../code_snippets/dividing_lines_snippet.py
.. literalinclude:: ../../../code_snippets/dividing_lines/snippet.py
:language: python
:linenos:
docs/root/api/command/flag.rst
+6 -6
View File
@@ -54,7 +54,7 @@ Flag
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flag_snippet.py
.. literalinclude:: ../../../code_snippets/flag/snippet.py
:linenos:
:language: python
@@ -80,7 +80,7 @@ string_entity
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flag_snippet3.py
.. literalinclude:: ../../../code_snippets/flag/snippet3.py
:linenos:
:language: python
@@ -103,7 +103,7 @@ __str__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flag_snippet4.py
.. literalinclude:: ../../../code_snippets/flag/snippet4.py
:linenos:
:language: python
@@ -123,7 +123,7 @@ __repr__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flag_snippet5.py
.. literalinclude:: ../../../code_snippets/flag/snippet5.py
:linenos:
:language: python
@@ -147,7 +147,7 @@ __eq__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flag_snippet6.py
.. literalinclude:: ../../../code_snippets/flag/snippet6.py
:linenos:
:language: python
@@ -266,6 +266,6 @@ PredefinedFlags
**Пример использования:**
.. literalinclude:: ../../../code_snippets/predefined_flags_snippet.py
.. literalinclude:: ../../../code_snippets/flag/predefined_flags.py
:linenos:
:language: python
docs/root/api/command/flags.rst
+6 -6
View File
@@ -37,7 +37,7 @@ Flags
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet.py
.. literalinclude:: ../../../code_snippets/flags/snippet.py
:linenos:
:language: python
@@ -63,7 +63,7 @@ add_flag
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet2.py
.. literalinclude:: ../../../code_snippets/flags/snippet2.py
:linenos:
:language: python
@@ -86,7 +86,7 @@ add_flags
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet3.py
.. literalinclude:: ../../../code_snippets/flags/snippet3.py
:linenos:
:language: python
@@ -109,7 +109,7 @@ get_flag_by_name
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet4.py
.. literalinclude:: ../../../code_snippets/flags/snippet4.py
:linenos:
:language: python
@@ -132,7 +132,7 @@ __iter__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet5.py
.. literalinclude:: ../../../code_snippets/flags/snippet5.py
:linenos:
:language: python
@@ -153,6 +153,6 @@ __getitem__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/flags_snippet6.py
.. literalinclude:: ../../../code_snippets/flags/snippet6.py
:linenos:
:language: python
docs/root/api/command/index.rst
+3 -3
View File
@@ -50,7 +50,7 @@ Command
**Пример использования:**
.. literalinclude:: ../../../code_snippets/command_snippet.py
.. literalinclude:: ../../../code_snippets/command/snippet.py
:linenos:
.. seealso ::
@@ -65,12 +65,12 @@ Command
**Базовый пример:**
.. literalinclude:: ../../../code_snippets/command_snippet2.py
.. literalinclude:: ../../../code_snippets/command/snippet2.py
:linenos:
**Команды с флагами:**
.. literalinclude:: ../../../code_snippets/command_snippet3.py
.. literalinclude:: ../../../code_snippets/command/snippet3.py
:linenos:
-----
docs/root/api/command/input_flag.rst
+7 -5
View File
@@ -39,10 +39,12 @@ InputFlag
**Атрибуты:**
.. py:attribute:: name
:no-index:
Имя введённого флага в виде строки.
.. py:attribute:: prefix
:no-index:
Префикс флага. Один из: ``"-"``, ``"--"``, ``"---"``.
@@ -56,7 +58,7 @@ InputFlag
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag_snippet1.py
.. literalinclude:: ../../../code_snippets/input_flag/snippet1.py
:linenos:
:language: python
@@ -82,7 +84,7 @@ string_entity
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag_snippet2.py
.. literalinclude:: ../../../code_snippets/input_flag/snippet2.py
:linenos:
:language: python
@@ -105,7 +107,7 @@ __str__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag_snippet3.py
.. literalinclude:: ../../../code_snippets/input_flag/snippet3.py
:linenos:
:language: python
@@ -125,7 +127,7 @@ __repr__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag_snippet4.py
.. literalinclude:: ../../../code_snippets/input_flag/snippet4.py
:linenos:
:language: python
@@ -149,6 +151,6 @@ __eq__
**Пример использования:**
.. literalinclude:: ../../../code_snippets/input_flag_snippet5.py
.. literalinclude:: ../../../code_snippets/input_flag/snippet5.py
:linenos:
:language: python
docs/root/api/command/possible_values.rst
+4 -4
View File
@@ -45,7 +45,7 @@ NEITHER
**Пример использования:**
.. literalinclude:: ../../../code_snippets/possible_values_neither_snippet.py
.. literalinclude:: ../../../code_snippets/possible_values/neither.py
:linenos:
:language: python
@@ -72,7 +72,7 @@ ALL
**Пример использования:**
.. literalinclude:: ../../../code_snippets/possible_values_all_snippet.py
.. literalinclude:: ../../../code_snippets/possible_values/all.py
:linenos:
:language: python
@@ -95,7 +95,7 @@ ALL
**Пример комбинированного использования:**
.. literalinclude:: ../../../code_snippets/possible_values_combined_snippet.py
.. literalinclude:: ../../../code_snippets/possible_values/combined.py
:linenos:
:language: python
@@ -106,7 +106,7 @@ ALL
Многие предопределенные флаги используют ``PossibleValues.NEITHER``:
.. literalinclude:: ../../../code_snippets/possible_values_predefined_snippet.py
.. literalinclude:: ../../../code_snippets/possible_values/predefined.py
:linenos:
:language: python
docs/root/api/command/validation_status.rst
+3 -3
View File
@@ -45,7 +45,7 @@ VALID
**Пример использования:**
.. literalinclude:: ../../../code_snippets/validation_status_valid_snippet1.py
.. literalinclude:: ../../../code_snippets/validation_status/valid.py
:linenos:
:language: python
@@ -72,7 +72,7 @@ INVALID
**Пример использования:**
.. literalinclude:: ../../../code_snippets/validation_status_invalid_snippet2.py
.. literalinclude:: ../../../code_snippets/validation_status/invalid.py
:linenos:
:language: python
@@ -103,7 +103,7 @@ UNDEFINED
Пример демонстрирует использование всех статусов в реальном сценарии:
.. literalinclude:: ../../../code_snippets/validation_status_comprehensive_snippet6.py
.. literalinclude:: ../../../code_snippets/validation_status/comprehensive.py
:linenos:
:language: python
docs/root/api/orchestrator/argparser.rst
+1 -1
View File
@@ -47,7 +47,7 @@ ArgParser
Пример использования
--------------------
.. literalinclude:: ../../../code_snippets/argparser_snippet.py
.. literalinclude:: ../../../code_snippets/argparser/snippet.py
:language: python
:linenos:
docs/root/api/orchestrator/argspace.rst
+3 -3
View File
@@ -85,7 +85,7 @@ get_by_type
**Пример использования:**
.. literalinclude:: ../../../code_snippets/argspace_snippet3.py
.. literalinclude:: ../../../code_snippets/argspace/snippet3.py
:linenos:
-----
@@ -105,12 +105,12 @@ InputArgument
**Полный пример:**
.. literalinclude:: ../../../code_snippets/argspace_snippet.py
.. literalinclude:: ../../../code_snippets/argspace/snippet.py
:linenos:
Доступ к аргументам из хэндлеров осуществляется с помощью ``di``, подробнее :ref:`тут <root_dependency_injection>`.
.. literalinclude:: ../../../code_snippets/argspace_snippet2.py
.. literalinclude:: ../../../code_snippets/argspace/snippet2.py
:linenos:
**Запуск приложения:**
docs/root/api/orchestrator/arguments.rst
+1
View File
@@ -169,6 +169,7 @@ InputArgument
**Атрибуты:**
.. py:attribute:: name
:no-index:
Имя аргумента в виде строки. Соответствует имени, указанному при создании ``ValueArgument`` или ``BooleanArgument``.
docs/root/api/orchestrator/index.rst
+1 -1
View File
@@ -62,7 +62,7 @@ Orchestrator
Пример использования
--------------------
.. literalinclude:: ../../../code_snippets/orchestrator_snippet.py
.. literalinclude:: ../../../code_snippets/orchestrator/snippet.py
:language: python
.. toctree::
docs/root/api/router.rst
+1 -1
View File
@@ -38,7 +38,7 @@ Router
**Пример использования:**
.. literalinclude:: ../../code_snippets/router_snippet.py
.. literalinclude:: ../../code_snippets/router/snippet.py
:linenos:
:language: python
docs/root/dependency_injection.rst
+4 -4
View File
@@ -18,19 +18,19 @@
.. note::
``argenta.di.FromDishka`` это алиас к ``dishka.FromDishka``, они полностью взаимозаменяемы.
.. literalinclude:: ../code_snippets/dependency_injection_snippet.py
.. literalinclude:: ../code_snippets/dependency_injection/snippet.py
:language: python
:linenos:
``Argenta`` -> ``dishka`` зарезолвит тайпхинты и внедрит зависимость с возвращаемым типом ``Connection``, прежде чем использовать зависимость её нужно создать, для этого нужно создать соответствующий провайдер.
.. literalinclude:: ../code_snippets/dependency_injection_snippet2.py
.. literalinclude:: ../code_snippets/dependency_injection/snippet2.py
:language: python
:linenos:
После создания провайдера, его нужно зарегистрировать в оркестраторе.
.. literalinclude:: ../code_snippets/dependency_injection_snippet3.py
.. literalinclude:: ../code_snippets/dependency_injection/snippet3.py
:language: python
:linenos:
@@ -49,7 +49,7 @@
Краткий сэмпл кода, который получает объект ``ArgSpace`` и выводит в консоль аргумент с именем "type":
.. literalinclude:: ../code_snippets/dependency_injection_snippet4.py
.. literalinclude:: ../code_snippets/dependency_injection/snippet4.py
:language: python
:linenos:
docs/root/error_handling.rst
+6 -6
View File
@@ -17,7 +17,7 @@
Краткий сэмпл кода, переопределяющего хэндлер ввода
пустой команды
.. literalinclude:: ../code_snippets/error_handling_snippet.py
.. literalinclude:: ../code_snippets/error_handling/snippet.py
:language: python
:linenos:
@@ -46,7 +46,7 @@
Сэмпл кода, переопределяющего хэндлер ввода команды с некорректным синтаксисом:
.. literalinclude:: ../code_snippets/error_handling_snippet2.py
.. literalinclude:: ../code_snippets/error_handling/snippet2.py
:language: python
:linenos:
@@ -73,7 +73,7 @@
Сэмпл кода, переопределяющего хэндлер ввода команды с повторяющимися флагами:
.. literalinclude:: ../code_snippets/error_handling_snippet3.py
.. literalinclude:: ../code_snippets/error_handling/snippet3.py
:language: python
:linenos:
@@ -96,7 +96,7 @@
Сэмпл кода, переопределяющего хэндлер ввода пустой команды:
.. literalinclude:: ../code_snippets/error_handling_snippet4.py
.. literalinclude:: ../code_snippets/error_handling/snippet4.py
:language: python
:linenos:
@@ -120,7 +120,7 @@
Сэмпл кода, переопределяющего хэндлер ввода неизвестной команды:
.. literalinclude:: ../code_snippets/error_handling_snippet5.py
.. literalinclude:: ../code_snippets/error_handling/snippet5.py
:language: python
:linenos:
@@ -143,6 +143,6 @@
Сэмпл кода, переопределяющего хэндлер ввода команды выхода:
.. literalinclude:: ../code_snippets/error_handling_snippet6.py
.. literalinclude:: ../code_snippets/error_handling/snippet6.py
:language: python
:linenos:
docs/root/overriding_formatting.rst
+1 -1
View File
@@ -39,6 +39,6 @@
Пример использования
--------------------
.. literalinclude:: ../code_snippets/overriding_format_example_sample.py
.. literalinclude:: ../code_snippets/overriding_formatting/sample.py
:language: python
:linenos:
docs/root/quickstart.rst
+2 -2
View File
@@ -11,13 +11,13 @@
2. **Определение роутера и хэндлеров**. За регистрацию функции как обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен принимать аргумент с типом ``Response``, подробнее в :ref:`разделе <root_api_response>`.
.. literalinclude:: ../code_snippets/quickstart_example_routers.py
.. literalinclude:: ../code_snippets/quickstart/routers.py
:language: python
:linenos:
3. **Определение приложения и оркестратора**. Для запуска приложения необходимо вызвать ``.include_router()`` у созданного приложения и передать ему раннее созданный роутер, после этого необходимо вызвать ``.start_polling()`` у созданного оркестратора и передать ему созданное приложение.
.. literalinclude:: ../code_snippets/quickstart_example_main.py
.. literalinclude:: ../code_snippets/quickstart/main.py
:language: python
:linenos:
docs/root/redirect_stdout.rst
+2 -2
View File
@@ -43,7 +43,7 @@
Если при создании роутера установить ``disable_redirect_stdout=True``, то для всех команд этого роутера механизм перехвата ``stdout`` будет отключен.
.. literalinclude:: ../code_snippets/redirect_stdout_example_sample.py
.. literalinclude:: ../code_snippets/redirect_stdout/sample.py
:language: python
:linenos:
@@ -69,7 +69,7 @@
Вы можете глобально задать тип разделительной линии для всего приложения через аргумент ``dividing_line`` в конструкторе ``App``.
.. literalinclude:: ../code_snippets/redirect_stdout_example_sample2.py
.. literalinclude:: ../code_snippets/redirect_stdout/sample2.py
:language: python
:linenos: