粗略过一遍,修复一眼可见的问题

This commit is contained in:
hemengyang 2022-01-12 19:41:42 +08:00
parent ec06010298
commit 98deadb4d6
9 changed files with 30 additions and 69 deletions

View File

@ -1,16 +1,9 @@
"""
## 配置
NoneBot 使用 `pydantic`_ 以及 `python-dotenv`_ 来读取配置
NoneBot 使用 [`pydantic`](https://pydantic-docs.helpmanual.io/) 以及 [`python-dotenv`](https://saurabh-kumar.com/python-dotenv/) 来读取配置
配置项需符合特殊格式或 json 序列化格式详情见 `pydantic Field Type`_ 文档
.. _pydantic:
https://pydantic-docs.helpmanual.io/
.. _python-dotenv:
https://saurabh-kumar.com/python-dotenv/
.. _pydantic Field Type:
https://pydantic-docs.helpmanual.io/usage/types/
配置项需符合特殊格式或 json 序列化格式详情见 [`pydantic Field Type`](https://pydantic-docs.helpmanual.io/usage/types/) 文档
"""
import os
from pathlib import Path
@ -174,16 +167,13 @@ class Config(BaseConfig):
"""
log_level: Union[int, str] = "INFO"
"""
配置 NoneBot 日志输出等级可以为 `int` 类型等级或等级名称参考 `loguru 日志等级`_
配置 NoneBot 日志输出等级可以为 `int` 类型等级或等级名称参考 [`loguru 日志等级`](https://loguru.readthedocs.io/en/stable/api/logger.html#levels)
用法:
```conf
LOG_LEVEL=25
LOG_LEVEL=INFO
```
.. _loguru 日志等级:
https://loguru.readthedocs.io/en/stable/api/logger.html#levels
"""
# bot connection configs

View File

@ -113,9 +113,6 @@ class Driver(abc.ABC):
def run(self, *args, **kwargs):
"""
启动驱动框架
参数: *args
**kwargs
"""
logger.opt(colors=True).debug(
f"<g>Loaded adapters: {escape_tag(', '.join(self._adapters))}</g>"
@ -135,8 +132,7 @@ class Driver(abc.ABC):
"""
装饰一个函数使他在 bot 通过 WebSocket 连接成功时执行
:函数参数:
参数:
bot: 当前连接上的 Bot 对象
"""
self._bot_connection_hook.add(func)
@ -146,8 +142,7 @@ class Driver(abc.ABC):
"""
装饰一个函数使他在 bot 通过 WebSocket 连接断开时执行
:函数参数:
参数:
bot: 当前连接上的 Bot 对象
"""
self._bot_disconnection_hook.add(func)

View File

@ -3,10 +3,7 @@
本驱动同时支持服务端以及客户端连接
后端使用方法请参考: `FastAPI 文档`_
.. _FastAPI 文档:
https://fastapi.tiangolo.com/
后端使用方法请参考: [`FastAPI 文档`](https://fastapi.tiangolo.com/)
"""
import logging

View File

@ -1,10 +1,7 @@
"""
## Quart 驱动适配
后端使用方法请参考: `Quart 文档`_
.. _Quart 文档:
https://pgjones.gitlab.io/quart/index.html
后端使用方法请参考: [`Quart 文档`](https://pgjones.gitlab.io/quart/index.html)
"""
import asyncio
@ -139,16 +136,12 @@ class Driver(ReverseDriver):
@overrides(ReverseDriver)
def on_startup(self, func: _AsyncCallable) -> _AsyncCallable:
"""参考文档: `Startup and Shutdown`_
.. _Startup and Shutdown:
https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html
"""
"""参考文档: [`Startup and Shutdown`](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)"""
return self.server_app.before_serving(func) # type: ignore
@overrides(ReverseDriver)
def on_shutdown(self, func: _AsyncCallable) -> _AsyncCallable:
"""参考文档: `Startup and Shutdown`_"""
"""参考文档: [`Startup and Shutdown`](https://pgjones.gitlab.io/quart/how_to_guides/startup_shutdown.html)"""
return self.server_app.after_serving(func) # type: ignore
@overrides(ReverseDriver)

View File

@ -1,12 +1,11 @@
"""
## 日志
NoneBot 使用 `loguru`_ 来记录日志信息
NoneBot 使用 [`loguru`][loguru] 来记录日志信息
自定义 logger 请参考 `loguru`_ 文档
自定义 logger 请参考 [`loguru`][loguru] 文档
.. _loguru:
https://github.com/Delgan/loguru
[loguru]: https://github.com/Delgan/loguru
"""
import sys
@ -25,11 +24,11 @@ logger: "Logger" = loguru.logger
"""
NoneBot 日志记录器对象
:默认信息:
默认信息:
* 格式: `[%(asctime)s %(name)s] %(levelname)s: %(message)s`
* 等级: `INFO` 根据 `config.log_level` 配置改变
* 输出: 输出至 stdout
- 格式: `[%(asctime)s %(name)s] %(levelname)s: %(message)s`
- 等级: `INFO` 根据 `config.log_level` 配置改变
- 输出: 输出至 stdout
用法:
```python

View File

@ -480,9 +480,6 @@ class ToMeRule:
def to_me() -> Rule:
"""
通过 `event.is_tome()` 判断事件是否与机器人有关
参数:
*
"""
return Rule(ToMeRule())

View File

@ -1,20 +1,11 @@
"""
## 类型
下面的文档中类型部分使用 Python Type Hint 语法 `PEP 484`_`PEP 526`_ `typing`_
下面的文档中类型部分使用 Python Type Hint 语法 [`PEP 484`](https://www.python.org/dev/peps/pep-0484/)[`PEP 526`](https://www.python.org/dev/peps/pep-0526/) [`typing`](https://docs.python.org/3/library/typing.html)
除了 Python 内置的类型下面还出现了如下 NoneBot 自定类型实际上它们是 Python 内置类型的别名
以下类型均可从 nonebot.typing 模块导入
.. _PEP 484:
https://www.python.org/dev/peps/pep-0484/
.. _PEP 526:
https://www.python.org/dev/peps/pep-0526/
.. _typing:
https://docs.python.org/3/library/typing.html
"""
from typing import (
TYPE_CHECKING,

View File

@ -135,8 +135,7 @@ def logger_wrapper(logger_name: str):
"""
用于打印 adapter 的日志
:log 参数:
参数:
level: 日志等级
message: 日志信息
exception: 异常信息