app/docs/en/dev/api/log.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2024-08-21 17:59:21 +08:00
---
title: liteyuki.log
---
2024-08-29 14:19:39 +08:00
### *func* `get_format() -> str`
2024-08-21 17:59:21 +08:00
<details>
2024-08-29 14:19:39 +08:00
<summary> <b>Source code</b> </summary>
2024-08-21 17:59:21 +08:00
```python
def get_format(level: str) -> str:
if level == 'DEBUG':
return debug_format
else:
return default_format
```
</details>
2024-08-29 14:19:39 +08:00
### *func* `init_log()`
2024-08-21 17:59:21 +08:00
2024-08-29 14:19:39 +08:00
**Description**: 在语言加载完成后执行
2024-08-21 17:59:21 +08:00
<details>
2024-08-29 14:19:39 +08:00
<summary> <b>Source code</b> </summary>
2024-08-21 17:59:21 +08:00
```python
def init_log(config: dict):
"""
在语言加载完成后执行
Returns:
"""
logger.remove()
logger.add(sys.stdout, level=0, diagnose=False, format=get_format(config.get('log_level', 'INFO')))
show_icon = config.get('log_icon', True)
logger.level('DEBUG', color='<blue>', icon=f"{('🐛' if show_icon else '')}DEBUG")
logger.level('INFO', color='<normal>', icon=f"{('' if show_icon else '')}INFO")
logger.level('SUCCESS', color='<green>', icon=f"{('✅' if show_icon else '')}SUCCESS")
logger.level('WARNING', color='<yellow>', icon=f"{('⚠️' if show_icon else '')}WARNING")
logger.level('ERROR', color='<red>', icon=f"{('⭕' if show_icon else '')}ERROR")
```
</details>
2024-08-29 14:19:39 +08:00
### ***var*** `debug_format = '<c>{time:YYYY-MM-DD HH:mm:ss}</c> <lvl>[{level.icon}]</lvl> <c><{name}.{module}.{function}:{line}></c> {message}'`
2024-08-21 17:59:21 +08:00
2024-08-29 14:19:39 +08:00
- **Type**: `str`
2024-08-21 17:59:21 +08:00
2024-08-29 14:19:39 +08:00
### ***var*** `default_format = '<c>{time:MM-DD HH:mm:ss}</c> <lvl>[{level.icon}]</lvl> <c><{name}></c> {message}'`
2024-08-21 17:59:21 +08:00
2024-08-29 14:19:39 +08:00
- **Type**: `str`
2024-08-21 17:59:21 +08:00