2020-09-13 00:43:31 +08:00
|
|
|
---
|
|
|
|
|
contentSidebar: true
|
|
|
|
|
sidebarDepth: 0
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# NoneBot.utils 模块
|
|
|
|
|
|
|
|
|
|
|
2020-10-01 00:55:03 +08:00
|
|
|
## `escape_tag(s)`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **说明**
|
|
|
|
|
|
|
|
|
|
用于记录带颜色日志时转义 `<tag>` 类型特殊标签
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* `s: str`: 需要转义的字符串
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* `str`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2020-09-13 00:43:31 +08:00
|
|
|
## `run_sync(func)`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **说明**
|
|
|
|
|
|
|
|
|
|
一个用于包装 sync function 为 async function 的装饰器
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **参数**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* `func: Callable[..., Any]`: 被装饰的同步函数
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **返回**
|
|
|
|
|
|
|
|
|
|
|
2020-09-13 13:01:23 +08:00
|
|
|
* `Callable[..., Awaitable[Any]]`
|
2020-09-13 00:43:31 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
## _class_ `DataclassEncoder`
|
|
|
|
|
|
|
|
|
|
基类：`json.encoder.JSONEncoder`
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
* **说明**
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
在JSON序列化 `Message` (List[Dataclass]) 时使用的 `JSONEncoder`
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
## `logger_wrapper(logger_name)`
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
* **说明**
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
用于打印 adapter 的日志。
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
* **Log 参数**
|
2020-12-13 12:53:33 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
* `level: Literal['WARNING', 'DEBUG', 'INFO']`: 日志等级
|
2020-09-13 00:43:31 +08:00
|
|
|
|
2020-12-13 12:53:33 +08:00
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
* `message: str`: 日志信息
|
2020-09-13 00:43:31 +08:00
|
|
|
|
|
|
|
|
|
2021-07-26 12:14:29 +08:00
|
|
|
* `exception: Optional[Exception]`: 异常信息
|
