This commit is contained in:
2025-02-11 21:36:23 +03:00
parent 2d088caaaf
commit b0eb1e3e6c
3 changed files with 15 additions and 11 deletions
+9 -5
View File
@@ -57,7 +57,7 @@ if __name__ == '__main__':
---
### *class* :: `App`
Основной класс приложения Argenta.
Класс, определяющий поведение и состояние приложения
#### Конструктор
```python
@@ -110,9 +110,9 @@ App(prompt: str = 'Enter a command',
---
**App().**`set_initial_greeting(greeting: str) -> None`
**App().**`set_initial_message(message: str) -> None`
*param* `greeting: str` **::** устанавливаемое приветственное сообщение
*param* `message: str` **::** устанавливаемое приветственное сообщение
*example* **::** `"Hello, I'm a cli example app"`
*method mean* **::** устанавливает сообщение, которое будет отображено при запуске программы
@@ -151,13 +151,17 @@ App(prompt: str = 'Enter a command',
## Примечания
- pass
- Среди зарегистрированных в приложении роутеров должен быть один главный, является ли роутер главным
определяется значением аргумента `is_main` равным `True`, в методе `App().include_router()`, который по умолчанию равен
`False`, если в приложении зарегистрирован лишь один роутер, то он неявно устанавливается главным, если
зарегистрировано больше одного роутера, то требуется явное указание главного. При регистрации более одного
главного роутера вызывается исключение `OnlyOneMainRouterIsAllowedException`. При регистрации более одного
роутера и отсутствии указания главного вызывается исключение `MissingMainRouterException`
### Исключения
Определены в файле `exceptions.py`:
- `InvalidRouterInstanceException` — Вызывается, если передан неверный объект роутера.
- `InvalidDescriptionMessagePatternException` — Вызывается при неправильном формате шаблона описания команд.