nonebot2/nonebot/config.py

241 lines
7.4 KiB
Python
Raw Normal View History

2022-01-18 23:46:10 +08:00
"""本模块定义了 NoneBot 本身运行所需的配置项。
2020-08-20 16:34:07 +08:00
NoneBot 使用 [`pydantic`](https://pydantic-docs.helpmanual.io/) 以及 [`python-dotenv`](https://saurabh-kumar.com/python-dotenv/) 来读取配置
2020-08-20 16:34:07 +08:00
配置项需符合特殊格式或 json 序列化格式详情见 [`pydantic Field Type`](https://pydantic-docs.helpmanual.io/usage/types/) 文档
2022-01-16 11:30:09 +08:00
FrontMatter:
sidebar_position: 1
description: nonebot.config 模块
2020-08-20 16:34:07 +08:00
"""
import os
from pathlib import Path
2020-08-06 17:54:55 +08:00
from datetime import timedelta
2020-07-04 22:51:10 +08:00
from ipaddress import IPv4Address
2021-09-27 00:19:30 +08:00
from typing import Any, Set, Dict, Tuple, Union, Mapping, Optional
2020-07-04 22:51:10 +08:00
2022-01-18 12:31:08 +08:00
from pydantic import BaseSettings, IPvAnyAddress, validator
from pydantic.env_settings import (
SettingsError,
EnvSettingsSource,
InitSettingsSource,
SettingsSourceCallable,
read_env_file,
env_file_sentinel,
)
2021-12-27 02:26:02 +08:00
from nonebot.log import logger
from nonebot.utils import escape_tag
2021-02-28 00:35:40 +08:00
class CustomEnvSettings(EnvSettingsSource):
def __call__(self, settings: BaseSettings) -> Dict[str, Any]:
"""
Build environment variables suitable for passing to the Model.
"""
d: Dict[str, Optional[str]] = {}
2021-02-28 00:35:40 +08:00
if settings.__config__.case_sensitive:
2021-12-16 17:28:57 +08:00
env_vars: Mapping[str, Optional[str]] = os.environ # pragma: no cover
else:
env_vars = {k.lower(): v for k, v in os.environ.items()}
2020-08-13 18:16:59 +08:00
env_file_vars: Dict[str, Optional[str]] = {}
env_file = (
self.env_file
if self.env_file != env_file_sentinel
else settings.__config__.env_file
)
env_file_encoding = (
self.env_file_encoding
if self.env_file_encoding is not None
else settings.__config__.env_file_encoding
)
if env_file is not None:
env_path = Path(env_file)
if env_path.is_file():
env_file_vars = read_env_file(
2020-08-13 18:16:59 +08:00
env_path,
encoding=env_file_encoding,
case_sensitive=settings.__config__.case_sensitive,
)
env_vars = {**env_file_vars, **env_vars}
2021-02-28 00:35:40 +08:00
for field in settings.__fields__.values():
env_val: Optional[str] = None
2020-12-06 02:30:19 +08:00
for env_name in field.field_info.extra["env_names"]:
env_val = env_vars.get(env_name)
if env_name in env_file_vars:
del env_file_vars[env_name]
if env_val is not None:
break
if env_val is None:
continue
if field.is_complex():
try:
2021-02-28 00:35:40 +08:00
env_val = settings.__config__.json_loads(env_val)
2021-12-16 17:28:57 +08:00
except ValueError as e: # pragma: no cover
2021-12-10 17:01:56 +08:00
raise SettingsError(
f'error parsing JSON for "{env_name}"' # type: ignore
) from e
d[field.alias] = env_val
if env_file_vars:
for env_name, env_val in env_file_vars.items():
if (env_val is None or len(env_val) == 0) and env_name in env_vars:
env_val = env_vars[env_name]
try:
2021-02-28 00:35:40 +08:00
if env_val:
2021-12-27 02:26:02 +08:00
env_val = settings.__config__.json_loads(env_val.strip())
except ValueError as e:
2021-12-27 02:26:02 +08:00
logger.opt(colors=True, exception=e).trace(
f"Error while parsing JSON for {escape_tag(env_name)}. Assumed as string."
)
d[env_name] = env_val
return d
2020-07-04 22:51:10 +08:00
2021-02-28 00:35:40 +08:00
class BaseConfig(BaseSettings):
2021-12-16 17:28:57 +08:00
# dummy getattr for pylance checking, actually not used
def __getattr__(self, name: str) -> Any: # pragma: no cover
2020-08-20 15:07:05 +08:00
return self.__dict__.get(name)
2021-02-28 00:35:40 +08:00
class Config:
@classmethod
def customise_sources(
cls,
2021-03-01 00:30:06 +08:00
init_settings: InitSettingsSource,
env_settings: EnvSettingsSource,
2021-02-28 00:35:40 +08:00
file_secret_settings: SettingsSourceCallable,
) -> Tuple[SettingsSourceCallable, ...]:
2021-03-01 00:30:06 +08:00
common_config = init_settings.init_kwargs.pop("_common_config", {})
return (
init_settings,
CustomEnvSettings(
env_settings.env_file, env_settings.env_file_encoding
),
InitSettingsSource(common_config),
file_secret_settings,
)
2021-02-28 00:35:40 +08:00
2020-07-04 22:51:10 +08:00
class Env(BaseConfig):
2022-01-18 12:31:08 +08:00
"""运行环境配置。大小写不敏感。
2020-08-20 15:07:05 +08:00
2022-01-18 12:31:08 +08:00
将会从 `环境变量` > `.env 环境配置文件` 的优先级读取环境信息
2020-08-20 15:07:05 +08:00
"""
2020-07-04 22:51:10 +08:00
environment: str = "prod"
2022-01-18 12:31:08 +08:00
"""当前环境名。
NoneBot 将从 `.env.{environment}` 文件中加载配置
2020-08-20 15:07:05 +08:00
"""
2020-07-04 22:51:10 +08:00
class Config:
extra = "allow"
2020-07-04 22:51:10 +08:00
env_file = ".env"
class Config(BaseConfig):
2022-01-18 12:31:08 +08:00
"""NoneBot 主要配置。大小写不敏感。
2022-01-12 18:19:21 +08:00
除了 NoneBot 的配置项外还可以自行添加配置项到 `.env.{environment}` 文件中
这些配置将会在 json 反序列化后一起带入 `Config` 类中
2022-01-18 12:31:08 +08:00
配置方法参考: [配置](https://v2.nonebot.dev/docs/tutorial/configuration)
"""
2022-01-04 14:36:32 +08:00
_env_file: str
2022-01-18 12:31:08 +08:00
_common_config: Dict[str, Any]
2022-01-04 14:36:32 +08:00
2020-08-01 22:03:40 +08:00
# nonebot configs
2021-12-25 14:57:29 +08:00
driver: str = "~fastapi"
2022-01-18 12:31:08 +08:00
"""NoneBot 运行所使用的 `Driver` 。继承自 {ref}`nonebot.drivers.Driver` 。
配置格式为 `<module>[:<Driver>][+<module>[:<Mixin>]]*`
2021-12-25 14:57:29 +08:00
`~` `nonebot.drivers.` 的缩写
2020-08-20 15:07:05 +08:00
"""
2020-08-18 17:24:49 +08:00
host: IPvAnyAddress = IPv4Address("127.0.0.1") # type: ignore
2022-01-18 12:31:08 +08:00
"""NoneBot {ref}`nonebot.drivers.ReverseDriver` 服务端监听的 IP/主机名。"""
2020-07-04 22:51:10 +08:00
port: int = 8080
2022-01-18 12:31:08 +08:00
"""NoneBot {ref}`nonebot.drivers.ReverseDriver` 服务端监听的端口。"""
2021-12-28 15:19:53 +08:00
log_level: Union[int, str] = "INFO"
2022-01-18 12:31:08 +08:00
"""NoneBot 日志输出等级,可以为 `int` 类型等级或等级名称
参考 [`loguru 日志等级`](https://loguru.readthedocs.io/en/stable/api/logger.html#levels)。
:::tip 提示
日志等级名称应为大写 `INFO`
:::
2022-01-12 18:53:30 +08:00
用法:
```conf
LOG_LEVEL=25
LOG_LEVEL=INFO
2022-01-12 18:53:30 +08:00
```
"""
2020-07-04 22:51:10 +08:00
2020-08-01 22:03:40 +08:00
# bot connection configs
api_timeout: Optional[float] = 30.0
2022-01-18 12:31:08 +08:00
"""API 请求超时时间,单位: 秒。"""
2020-08-01 22:03:40 +08:00
# bot runtime configs
2020-12-17 21:09:30 +08:00
superusers: Set[str] = set()
2022-01-18 12:31:08 +08:00
"""机器人超级用户。
2020-11-30 11:08:00 +08:00
2022-01-12 18:53:30 +08:00
用法:
```conf
2021-01-05 23:06:36 +08:00
SUPERUSERS=["12345789"]
2022-01-12 18:53:30 +08:00
```
2020-08-20 16:34:07 +08:00
"""
2020-10-06 22:29:05 +08:00
nickname: Set[str] = set()
2022-01-18 12:31:08 +08:00
"""机器人昵称。"""
2020-08-17 16:09:41 +08:00
command_start: Set[str] = {"/"}
2022-01-18 12:31:08 +08:00
"""命令的起始标记,用于判断一条消息是不是命令。
用法:
```conf
COMMAND_START=["/", ""]
```
2020-08-20 16:34:07 +08:00
"""
2020-08-17 16:09:41 +08:00
command_sep: Set[str] = {"."}
2022-01-18 12:31:08 +08:00
"""命令的分隔标记,用于将文本形式的命令切分为元组(实际的命令名)。
用法:
```conf
COMMAND_SEP=["."]
```
2020-08-20 16:34:07 +08:00
"""
2020-08-06 17:54:55 +08:00
session_expire_timeout: timedelta = timedelta(minutes=2)
2022-01-18 12:31:08 +08:00
"""等待用户回复的超时时间。
2020-11-30 11:08:00 +08:00
2022-01-12 18:53:30 +08:00
用法:
```conf
2020-08-20 16:34:07 +08:00
SESSION_EXPIRE_TIMEOUT=120 # 单位: 秒
SESSION_EXPIRE_TIMEOUT=[DD ][HH:MM]SS[.ffffff]
SESSION_EXPIRE_TIMEOUT=P[DD]DT[HH]H[MM]M[SS]S # ISO 8601
2022-01-12 18:53:30 +08:00
```
2020-08-20 16:34:07 +08:00
"""
2020-07-04 22:51:10 +08:00
# adapter configs
# adapter configs are defined in adapter/config.py
2020-08-01 22:03:40 +08:00
# custom configs
# custom configs can be assigned during nonebot.init
# or from env file using json loads
2020-07-04 22:51:10 +08:00
class Config:
extra = "allow"
2020-07-04 22:51:10 +08:00
env_file = ".env.prod"
2022-01-18 12:31:08 +08:00
__autodoc__ = {
"CustomEnvSettings": False,
"BaseConfig": False,
}