mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-09-14 07:56:49 +00:00
add log and config docs
This commit is contained in:
@ -1,32 +1,92 @@
|
||||
# NoneBot.config 模块
|
||||
|
||||
|
||||
### _class_ `BaseConfig(_env_file='<objectobject>', _env_file_encoding=None)`
|
||||
## _class_ `Env`
|
||||
|
||||
基类:`pydantic.env_settings.BaseSettings`
|
||||
|
||||
运行环境配置。大小写不敏感。
|
||||
|
||||
### _class_ `Env(_env_file='<objectobject>', _env_file_encoding=None, *, environment='prod')`
|
||||
|
||||
基类:`pydantic.env_settings.BaseSettings`
|
||||
将会从 `nonebot.init 参数` > `环境变量` > `.env 环境配置文件` 的优先级读取配置。
|
||||
|
||||
|
||||
### _class_ `Config(_env_file='<objectobject>', _env_file_encoding=None, *, driver='nonebot.drivers.fastapi', host=IPv4Address('127.0.0.1'), port=8080, secret=None, debug=False, api_root={}, api_timeout=60.0, access_token=None, superusers={}, nickname='', command_start={'/'}, command_sep={'.'}, session_expire_timeout=datetime.timedelta(seconds=120), **values)`
|
||||
|
||||
基类:[`nonebot.config.BaseConfig`](#nonebot.config.BaseConfig)
|
||||
|
||||
NoneBot Config Object
|
||||
|
||||
configs:
|
||||
|
||||
### driver
|
||||
### `environment`
|
||||
|
||||
|
||||
* 类型: str
|
||||
* 类型: `str`
|
||||
|
||||
|
||||
* 默认值: "nonebot.drivers.fastapi"
|
||||
* 默认值: `"prod"`
|
||||
|
||||
|
||||
* 说明:
|
||||
nonebot 运行使用后端框架封装 Driver 。继承自 nonebot.driver.BaseDriver 。
|
||||
当前环境名。 NoneBot 将从 `.env.{environment}` 文件中加载配置。
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
基类:`nonebot.config.BaseConfig`
|
||||
|
||||
NoneBot 主要配置。大小写不敏感。
|
||||
|
||||
除了 NoneBot 的配置项外,还可以自行添加配置项到 `.env.{environment}` 文件中。这些配置将会一起带入 `Config` 类中。
|
||||
|
||||
|
||||
### `driver`
|
||||
|
||||
|
||||
* 类型: `str`
|
||||
|
||||
|
||||
* 默认值: `"nonebot.drivers.fastapi"`
|
||||
|
||||
|
||||
* 说明:
|
||||
NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
|
||||
|
||||
|
||||
### `host`
|
||||
|
||||
|
||||
* 类型: `IPvAnyAddress`
|
||||
|
||||
|
||||
* 默认值: `127.0.0.1`
|
||||
|
||||
|
||||
* 说明:
|
||||
NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
|
||||
|
||||
|
||||
### `port`
|
||||
|
||||
|
||||
* 类型: `int`
|
||||
|
||||
|
||||
* 默认值: `8080`
|
||||
|
||||
|
||||
* 说明:
|
||||
NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
|
||||
|
||||
|
||||
### `secret`
|
||||
|
||||
|
||||
* 类型: `Optional[str]`
|
||||
|
||||
|
||||
* 默认值: `None`
|
||||
|
||||
|
||||
* 说明:
|
||||
上报连接 NoneBot 所需的密钥。
|
||||
|
||||
|
||||
* 示例:
|
||||
|
||||
```http
|
||||
POST /cqhttp/ HTTP/1.1
|
||||
Authorization: Bearer kSLuTF2GC2Q4q4ugm3
|
||||
```
|
||||
|
Reference in New Issue
Block a user