Update all project documentation

This commit is contained in:
2026-04-16 15:20:19 +03:00
parent e752f88ae2
commit 22b85455e1
7 changed files with 94 additions and 38 deletions

View File

@@ -35,16 +35,11 @@ python -m app.komAI
Модуль `config_manager` управляет конфигурацией с регистрацией параметров.
```python
import src.utils.config_manager
config = src.utils.config_manager.config
import src.utils.config_manager as config
config = config.config
# Регистрация параметра
config.register(name="app_name", val="komAI", desc="Наименование проекта", cat="app")
# Получение значения
config.get("app_name", cat="app")
# Сохранение в файл
config.save()
```
@@ -52,10 +47,24 @@ config.save()
## Логирование
Все консольные выводы дублируются в логах. Настройка логирования в `config/global.yaml`.
Модуль `log_manager` обеспечивает логирование с выводом в консоль и файл.
```python
import src.utils.log_manager as log
log.register_global_params()
log.register(module="app", log_console=True, log_file="app.log")
log.setup()
logger = log.get_logger("app")
logger.print("Сообщение") # вместо print()
```
См. [doc/src.utils.log_manager.md](doc/src.utils.log_manager.md) для подробной документации.
## Тесты
```bash
python -m tests.test_config_manager
python -m tests.test_log_manager
```