Update documentation and code snippets

This commit is contained in:
2025-12-04 18:17:36 +03:00
parent be083bb64d
commit 9179eb8468
23 changed files with 33 additions and 83 deletions
+13 -22
View File
@@ -73,12 +73,9 @@
Флаги против аргументов
-----------------------
В контексте Argenta флаги и аргументы относятся к разным уровням взаимодействия с приложением и имеют принципиально разные сферы действия.
В контексте Argenta флаги и аргументы относятся к разным уровням взаимодействия с приложением.
Определение и назначение
~~~~~~~~~~~~~~~~~~~~~~~~
**Аргументы** — это параметры, передаваемые при запуске приложения один раз при инициализации. Они определяют глобальное состояние и конфигурацию приложения на протяжении всей его работы, например адрес базы данных, уровень логирования или режим работы.
**Аргументы** — это параметры, передаваемые при запуске приложения. Они определяют глобальную конфигурацию на протяжении всей его работы (например, адрес базы данных, уровень логирования).
.. seealso:: API и более подробное описание в разделах :ref:`ArgParser <root_api_orchestrator_argparser>` и :ref:`Arguments <root_api_orchestrator_arguments>`.
@@ -91,34 +88,28 @@
Ключевые различия
~~~~~~~~~~~~~~~~~
**Время жизни и область действия**
Аргументы передаются один раз при запуске приложения и сохраняют действие на весь период работы (скоуп **APP**). Флаги наоборот локальны и живут в рамках скоупа **REQUEST**.
**Время жизни**
Аргументы передаются один раз при запуске и действуют на весь период работы приложения. Флаги локальны и существуют только в рамках выполнения команды.
**Частота изменения**
Для изменения аргументов необходимо перезапустить приложение. Флаги можно менять между каждым вводом команды без остановки приложения.
**Изменяемость**
Для изменения аргументов необходимо перезапустить приложение. Флаги можно менять при каждом вводе команды.
**Уровень конфигурации**
Аргументы управляют глобальной конфигурацией приложения и его окружением. Флаги управляют поведением отдельных команд и операций пользователя.
**Использование**
Аргументы задают начальное состояние системы: что подключить, как работать. Флаги управляют тактикой выполнения команд: как её выполнить, с какими изменениями.
**Назначение**
Аргументы управляют глобальной конфигурацией приложения. Флаги управляют поведением отдельных команд.
-----
Практические примеры в Argenta
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Практические примеры
~~~~~~~~~~~~~~~~~~~~
При запуске приложения Argenta передаются аргументы:
Аргументы при запуске приложения:
- Адрес подключения к базе данных
- Режим работы (production, development, testing)
- Уровень логирования
- Путь к конфигурационным файлам
В интерактивной сессии для каждой команды указываются флаги:
Флаги в интерактивной сессии:
- ``deploy --verbose --dry-run`` — для текущей команды развёртывания
- ``deploy --verbose --dry-run`` — для команды развёртывания
- ``backup --compress --encrypted`` — для команды резервного копирования
- ``test --parallel --coverage`` — для команды тестирования
Один пользователь может выполнить разные команды с разными флагами в одной сессии приложения, без необходимости перезапуска с новыми аргументами.