mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-28 05:59:10 +08:00
令参数列表符合 autodoc 格式
This commit is contained in:
hemengyang
parent
4ba1a09fb7
commit
a5f32febbd
@ -57,11 +57,11 @@ def get_driver() -> Driver:
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Driver`: 全局 Driver 对象
|
Driver: 全局 Driver 对象
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
|
|
||||||
:用法:
|
:用法:
|
||||||
|
|
||||||
@ -81,11 +81,11 @@ def get_app() -> Any:
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Any`: Server App 对象
|
Any: Server App 对象
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
|
|
||||||
:用法:
|
:用法:
|
||||||
|
|
||||||
@ -107,11 +107,11 @@ def get_asgi() -> Any:
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Any`: Asgi 对象
|
Any: Asgi 对象
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
|
|
||||||
:用法:
|
:用法:
|
||||||
|
|
||||||
@ -133,17 +133,17 @@ def get_bot(self_id: Optional[str] = None) -> Bot:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `self_id: Optional[str]`: 用来识别 Bot 的 ID
|
self_id: 用来识别 Bot 的 ID
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Bot`: Bot 对象
|
Bot: Bot 对象
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
* `KeyError`: 对应 ID 的 Bot 不存在
|
KeyError: 对应 ID 的 Bot 不存在
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
* `ValueError`: 没有传入 ID 且没有 Bot 可用
|
ValueError: 没有传入 ID 且没有 Bot 可用
|
||||||
|
|
||||||
:用法:
|
:用法:
|
||||||
|
|
||||||
@ -169,11 +169,11 @@ def get_bots() -> Dict[str, Bot]:
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Dict[str, Bot]`: 一个以字符串 ID 为键，Bot 对象为值的字典
|
Dict[str, Bot]: 一个以字符串 ID 为键，Bot 对象为值的字典
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
* `ValueError`: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
ValueError: 全局 Driver 对象尚未初始化 (nonebot.init 尚未调用)
|
||||||
|
|
||||||
:用法:
|
:用法:
|
||||||
|
|
||||||
@ -227,8 +227,8 @@ def init(*, _env_file: Optional[str] = None, **kwargs):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `_env_file: Optional[str]`: 配置文件名，默认从 .env.{env_name} 中读取配置
|
_env_file: 配置文件名，默认从 .env.{env_name} 中读取配置
|
||||||
* `**kwargs`: 任意变量，将会存储到 Config 对象里
|
**kwargs: 任意变量，将会存储到 Config 对象里
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -269,8 +269,8 @@ def run(*args: Any, **kwargs: Any) -> None:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*args`: 传入 Driver.run 的位置参数
|
*args: 传入 Driver.run 的位置参数
|
||||||
* `**kwargs`: 传入 Driver.run 的命名参数
|
**kwargs: 传入 Driver.run 的命名参数
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
|
|||||||
@ -67,7 +67,7 @@ class Adapter(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `api: str`: API 名称
|
api: API 名称
|
||||||
* `**data`: API 数据
|
**data: API 数据
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|||||||
@ -38,8 +38,8 @@ class Bot(abc.ABC):
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `self_id: str`: 机器人 ID
|
self_id: 机器人 ID
|
||||||
* `request: HTTPConnection`: request 连接对象
|
request: request 连接对象
|
||||||
"""
|
"""
|
||||||
self.adapter: "Adapter" = adapter
|
self.adapter: "Adapter" = adapter
|
||||||
self.self_id: str = self_id
|
self.self_id: str = self_id
|
||||||
@ -62,8 +62,8 @@ class Bot(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `api: str`: API 名称
|
api: API 名称
|
||||||
* `**data`: API 数据
|
**data: API 数据
|
||||||
|
|
||||||
:示例:
|
:示例:
|
||||||
|
|
||||||
@ -131,9 +131,9 @@ class Bot(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `event: Event`: 上报事件
|
event: 上报事件
|
||||||
* `message: Union[str, Message, MessageSegment]`: 要发送的消息
|
message: 要发送的消息
|
||||||
* `**kwargs`
|
**kwargs
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -144,9 +144,9 @@ class Bot(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: 当前 bot 对象
|
bot: 当前 bot 对象
|
||||||
* `api: str`: 调用的 api 名称
|
api: 调用的 api 名称
|
||||||
* `data: Dict[str, Any]`: api 调用的参数字典
|
data: api 调用的参数字典
|
||||||
"""
|
"""
|
||||||
cls._calling_api_hook.add(func)
|
cls._calling_api_hook.add(func)
|
||||||
return func
|
return func
|
||||||
@ -158,11 +158,11 @@ class Bot(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: 当前 bot 对象
|
bot: 当前 bot 对象
|
||||||
* `exception: Optional[Exception]`: 调用 api 时发生的错误
|
exception: 调用 api 时发生的错误
|
||||||
* `api: str`: 调用的 api 名称
|
api: 调用的 api 名称
|
||||||
* `data: Dict[str, Any]`: api 调用的参数字典
|
data: api 调用的参数字典
|
||||||
* `result: Any`: api 调用的返回
|
result: api 调用的返回
|
||||||
"""
|
"""
|
||||||
cls._called_api_hook.add(func)
|
cls._called_api_hook.add(func)
|
||||||
return func
|
return func
|
||||||
|
|||||||
@ -20,7 +20,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Literal["message", "notice", "request", "meta_event"]`
|
Literal["message", "notice", "request", "meta_event"]
|
||||||
* 其他自定义 `str`
|
* 其他自定义 `str`
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
@ -32,7 +32,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -43,7 +43,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -56,7 +56,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
|
|
||||||
:异常:
|
:异常:
|
||||||
|
|
||||||
@ -71,7 +71,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -82,7 +82,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -93,7 +93,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `Message`
|
Message
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `str`
|
str
|
||||||
"""
|
"""
|
||||||
return self.get_message().extract_plain_text()
|
return self.get_message().extract_plain_text()
|
||||||
|
|
||||||
@ -114,6 +114,6 @@ class Event(abc.ABC, BaseModel):
|
|||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
* `bool`
|
bool
|
||||||
"""
|
"""
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|||||||
@ -99,7 +99,7 @@ class Message(List[TMS], abc.ABC):
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `message: Union[str, list, dict, MessageSegment, Message, Any]`: 消息内容
|
message: 消息内容
|
||||||
"""
|
"""
|
||||||
super().__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
if message is None:
|
if message is None:
|
||||||
@ -137,7 +137,7 @@ class Message(List[TMS], abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `format_string: str`: 格式化字符串
|
format_string: 格式化字符串
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -190,7 +190,7 @@ class Message(List[TMS], abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `obj: Union[str, MessageSegment]`: 要添加的消息段
|
obj: 要添加的消息段
|
||||||
"""
|
"""
|
||||||
if isinstance(obj, MessageSegment):
|
if isinstance(obj, MessageSegment):
|
||||||
super(Message, self).append(obj)
|
super(Message, self).append(obj)
|
||||||
@ -206,7 +206,7 @@ class Message(List[TMS], abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `obj: Union[Message, Iterable[MessageSegment]]`: 要添加的消息数组
|
obj: 要添加的消息数组
|
||||||
"""
|
"""
|
||||||
for segment in obj:
|
for segment in obj:
|
||||||
self.append(segment)
|
self.append(segment)
|
||||||
|
|||||||
@ -51,8 +51,8 @@ class MessageTemplate(Formatter, Generic[TF]):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `template: Union[str, Message]`: 模板
|
template: 模板
|
||||||
* `factory: Union[str, Message]`: 消息构造类型，默认为 `str`
|
factory: 消息构造类型，默认为 `str`
|
||||||
"""
|
"""
|
||||||
self.template: TF = template
|
self.template: TF = template
|
||||||
self.factory: Type[TF] = factory
|
self.factory: Type[TF] = factory
|
||||||
|
|||||||
@ -56,8 +56,8 @@ class Driver(abc.ABC):
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `env: Env`: 包含环境信息的 Env 对象
|
env: 包含环境信息的 Env 对象
|
||||||
* `config: Config`: 包含配置信息的 Config 对象
|
config: 包含配置信息的 Config 对象
|
||||||
"""
|
"""
|
||||||
self.env: str = env.environment
|
self.env: str = env.environment
|
||||||
"""
|
"""
|
||||||
@ -85,9 +85,9 @@ class Driver(abc.ABC):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `name: str`: 适配器名称，用于在连接时进行识别
|
name: 适配器名称，用于在连接时进行识别
|
||||||
* `adapter: Type[Bot]`: 适配器 Class
|
adapter: 适配器 Class
|
||||||
* `**kwargs`: 其他传递给适配器的参数
|
**kwargs: 其他传递给适配器的参数
|
||||||
"""
|
"""
|
||||||
name = adapter.get_name()
|
name = adapter.get_name()
|
||||||
if name in self._adapters:
|
if name in self._adapters:
|
||||||
@ -118,8 +118,8 @@ class Driver(abc.ABC):
|
|||||||
启动驱动框架
|
启动驱动框架
|
||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
* `*args`
|
*args
|
||||||
* `**kwargs`
|
**kwargs
|
||||||
"""
|
"""
|
||||||
logger.opt(colors=True).debug(
|
logger.opt(colors=True).debug(
|
||||||
f"<g>Loaded adapters: {escape_tag(', '.join(self._adapters))}</g>"
|
f"<g>Loaded adapters: {escape_tag(', '.join(self._adapters))}</g>"
|
||||||
@ -141,7 +141,7 @@ class Driver(abc.ABC):
|
|||||||
|
|
||||||
:函数参数:
|
:函数参数:
|
||||||
|
|
||||||
* `bot: Bot`: 当前连接上的 Bot 对象
|
bot: 当前连接上的 Bot 对象
|
||||||
"""
|
"""
|
||||||
self._bot_connection_hook.add(func)
|
self._bot_connection_hook.add(func)
|
||||||
return func
|
return func
|
||||||
@ -152,7 +152,7 @@ class Driver(abc.ABC):
|
|||||||
|
|
||||||
:函数参数:
|
:函数参数:
|
||||||
|
|
||||||
* `bot: Bot`: 当前连接上的 Bot 对象
|
bot: 当前连接上的 Bot 对象
|
||||||
"""
|
"""
|
||||||
self._bot_disconnection_hook.add(func)
|
self._bot_disconnection_hook.add(func)
|
||||||
return func
|
return func
|
||||||
|
|||||||
@ -43,7 +43,7 @@ class BlockDriver(Driver):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `func: Callable[[], Awaitable[None]]`
|
func
|
||||||
"""
|
"""
|
||||||
self.startup_funcs.add(func)
|
self.startup_funcs.add(func)
|
||||||
return func
|
return func
|
||||||
@ -55,7 +55,7 @@ class BlockDriver(Driver):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `func: Callable[[], Awaitable[None]]`
|
func
|
||||||
"""
|
"""
|
||||||
self.shutdown_funcs.add(func)
|
self.shutdown_funcs.add(func)
|
||||||
return func
|
return func
|
||||||
|
|||||||
@ -24,8 +24,8 @@ class ParserExit(NoneBotException):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `status`
|
status
|
||||||
* `message`
|
message
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, status: int = 0, message: Optional[str] = None):
|
def __init__(self, status: int = 0, message: Optional[str] = None):
|
||||||
@ -52,7 +52,7 @@ class IgnoredException(ProcessException):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `reason`: 忽略事件的原因
|
reason: 忽略事件的原因
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, reason):
|
def __init__(self, reason):
|
||||||
@ -71,7 +71,7 @@ class MockApiException(ProcessException):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `result`: 返回的内容
|
result: 返回的内容
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, result: Any):
|
def __init__(self, result: Any):
|
||||||
@ -167,7 +167,7 @@ class AdapterException(NoneBotException):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `adapter_name: str`: 标识 adapter
|
adapter_name: 标识 adapter
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, adapter_name: str) -> None:
|
def __init__(self, adapter_name: str) -> None:
|
||||||
|
|||||||
@ -214,17 +214,17 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `type_: str`: 事件响应器类型，与 `event.get_type()` 一致时触发，空字符串表示任意
|
type_: 事件响应器类型，与 `event.get_type()` 一致时触发，空字符串表示任意
|
||||||
* `rule: Optional[Rule]`: 匹配规则
|
rule: 匹配规则
|
||||||
* `permission: Optional[Permission]`: 权限
|
permission: 权限
|
||||||
* `handlers: Optional[List[T_Handler]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器，即触发一次后删除
|
temp: 是否为临时事件响应器，即触发一次后删除
|
||||||
* `priority: int`: 响应优先级
|
priority: 响应优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级的响应器传播
|
block: 是否阻止事件向更低优先级的响应器传播
|
||||||
* `plugin: Optional[Plugin]`: 事件响应器所在插件
|
plugin: 事件响应器所在插件
|
||||||
* `module: Optional[ModuleType]`: 事件响应器所在模块
|
module: 事件响应器所在模块
|
||||||
* `default_state: Optional[T_State]`: 默认状态 `state`
|
default_state: 默认状态 `state`
|
||||||
* `expire_time: Optional[datetime]`: 事件响应器最终有效时间点，过时即被删除
|
expire_time: 事件响应器最终有效时间点，过时即被删除
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -280,8 +280,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
bot: Bot 对象
|
||||||
* `event: Event`: 上报事件
|
event: 上报事件
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -306,9 +306,9 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
bot: Bot 对象
|
||||||
* `event: Event`: 上报事件
|
event: 上报事件
|
||||||
* `state: T_State`: 当前状态
|
state: 当前状态
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -326,7 +326,7 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `func: T_TypeUpdater`: 响应事件类型更新函数
|
func: 响应事件类型更新函数
|
||||||
"""
|
"""
|
||||||
cls._default_type_updater = Dependent[str].parse(
|
cls._default_type_updater = Dependent[str].parse(
|
||||||
call=func, allow_types=cls.HANDLER_PARAM_TYPES
|
call=func, allow_types=cls.HANDLER_PARAM_TYPES
|
||||||
@ -340,7 +340,7 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `func: T_PermissionUpdater`: 会话权限更新函数
|
func: 会话权限更新函数
|
||||||
"""
|
"""
|
||||||
cls._default_permission_updater = Dependent[Permission].parse(
|
cls._default_permission_updater = Dependent[Permission].parse(
|
||||||
call=func, allow_types=cls.HANDLER_PARAM_TYPES
|
call=func, allow_types=cls.HANDLER_PARAM_TYPES
|
||||||
@ -368,7 +368,7 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `parameterless: Optional[List[Any]]`: 非参数类型依赖列表
|
parameterless: 非参数类型依赖列表
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def _decorator(func: T_Handler) -> T_Handler:
|
def _decorator(func: T_Handler) -> T_Handler:
|
||||||
@ -386,8 +386,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `id: str`: 消息 ID
|
id: 消息 ID
|
||||||
* `parameterless: Optional[List[Any]]`: 非参数类型依赖列表
|
parameterless: 非参数类型依赖列表
|
||||||
"""
|
"""
|
||||||
|
|
||||||
async def _receive(event: Event, matcher: "Matcher") -> Union[None, NoReturn]:
|
async def _receive(event: Event, matcher: "Matcher") -> Union[None, NoReturn]:
|
||||||
@ -426,10 +426,10 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `key: str`: 参数名
|
key: 参数名
|
||||||
* `prompt: Optional[Union[str, Message, MessageSegment, MessageFormatter]]`: 在参数不存在时向用户发送的消息
|
prompt: 在参数不存在时向用户发送的消息
|
||||||
* `args_parser: Optional[T_ArgsParser]`: 可选参数解析函数，空则使用默认解析函数
|
args_parser: 可选参数解析函数，空则使用默认解析函数
|
||||||
* `parameterless: Optional[List[Any]]`: 非参数类型依赖列表
|
parameterless: 非参数类型依赖列表
|
||||||
"""
|
"""
|
||||||
|
|
||||||
async def _key_getter(event: Event, matcher: "Matcher"):
|
async def _key_getter(event: Event, matcher: "Matcher"):
|
||||||
@ -470,8 +470,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment]`: 消息内容
|
message: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
bot = current_bot.get()
|
bot = current_bot.get()
|
||||||
event = current_event.get()
|
event = current_event.get()
|
||||||
@ -493,8 +493,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `message: Union[str, Message, MessageSegment, MessageTemplate]`: 消息内容
|
message: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
if message is not None:
|
if message is not None:
|
||||||
await cls.send(message, **kwargs)
|
await cls.send(message, **kwargs)
|
||||||
@ -511,8 +511,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `prompt: Union[str, Message, MessageSegment, MessageTemplate]`: 消息内容
|
prompt: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
if prompt is not None:
|
if prompt is not None:
|
||||||
await cls.send(prompt, **kwargs)
|
await cls.send(prompt, **kwargs)
|
||||||
@ -529,8 +529,8 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `prompt: Union[str, Message, MessageSegment, MessageTemplate]`: 消息内容
|
prompt: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
if prompt is not None:
|
if prompt is not None:
|
||||||
await cls.send(prompt, **kwargs)
|
await cls.send(prompt, **kwargs)
|
||||||
@ -548,9 +548,9 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `key: str`: 参数名
|
key: 参数名
|
||||||
* `prompt: Union[str, Message, MessageSegment, MessageTemplate]`: 消息内容
|
prompt: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
matcher = current_matcher.get()
|
matcher = current_matcher.get()
|
||||||
matcher.set_target(ARG_KEY.format(key=key))
|
matcher.set_target(ARG_KEY.format(key=key))
|
||||||
@ -570,9 +570,9 @@ class Matcher(metaclass=MatcherMeta):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `id: str`: 消息 id
|
id: 消息 id
|
||||||
* `prompt: Union[str, Message, MessageSegment, MessageTemplate]`: 消息内容
|
prompt: 消息内容
|
||||||
* `**kwargs`: 其他传递给 `bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
**kwargs`bot.send` 的参数，请参考对应 adapter 的 bot 对象 api
|
||||||
"""
|
"""
|
||||||
matcher = current_matcher.get()
|
matcher = current_matcher.get()
|
||||||
matcher.set_target(RECEIVE_KEY.format(id=id))
|
matcher.set_target(RECEIVE_KEY.format(id=id))
|
||||||
|
|||||||
@ -238,8 +238,8 @@ async def handle_event(bot: "Bot", event: "Event") -> None:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
bot: Bot 对象
|
||||||
* `event: Event`: Event 对象
|
event: Event 对象
|
||||||
|
|
||||||
:示例:
|
:示例:
|
||||||
|
|
||||||
|
|||||||
@ -60,8 +60,8 @@ def Depends(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `dependency: Optional[Callable[..., Any]] = None`: 依赖函数。默认为参数的类型注释。
|
dependency: 依赖函数。默认为参数的类型注释。
|
||||||
* `use_cache: bool = True`: 是否使用缓存。默认为 `True`。
|
use_cache: 是否使用缓存。默认为 `True`。
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
|
|||||||
@ -60,7 +60,7 @@ class Permission:
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*checkers: Union[T_PermissionChecker, Dependent[bool]`: PermissionChecker
|
*checkers: PermissionChecker
|
||||||
"""
|
"""
|
||||||
|
|
||||||
self.checkers: Set[Dependent[bool]] = set(
|
self.checkers: Set[Dependent[bool]] = set(
|
||||||
@ -87,10 +87,10 @@ class Permission:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
bot: Bot 对象
|
||||||
* `event: Event`: Event 对象
|
event: Event 对象
|
||||||
* `stack: Optional[AsyncExitStack]`: 异步上下文栈
|
stack: 异步上下文栈
|
||||||
* `dependency_cache: Optional[CacheDict[T_Handler, Any]]`: 依赖缓存
|
dependency_cache: 依赖缓存
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -185,8 +185,8 @@ def USER(*users: str, perm: Optional[Permission] = None):
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*user: str`: 白名单
|
*user: 白名单
|
||||||
* `perm: Optional[Permission]`: 需要同时满足的权限
|
perm: 需要同时满足的权限
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return Permission(User(users, perm))
|
return Permission(User(users, perm))
|
||||||
|
|||||||
@ -16,7 +16,7 @@ def load_plugin(module_path: str) -> Optional[Plugin]:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `module_path: str`: 插件名称 `path.to.your.plugin`
|
module_path: 插件名称 `path.to.your.plugin`
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -149,7 +149,7 @@ def require(name: str) -> Export:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
|
name: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
|
|||||||
@ -59,14 +59,14 @@ def on(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `type: str`: 事件响应器类型
|
type: 事件响应器类型
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -103,12 +103,12 @@ def on_metaevent(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -146,13 +146,13 @@ def on_message(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -189,12 +189,12 @@ def on_notice(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -231,12 +231,12 @@ def on_request(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -270,15 +270,15 @@ def on_startswith(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
|
msg: 指定消息开头内容
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `ignorecase: bool`: 是否忽略大小写
|
ignorecase: 是否忽略大小写
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -299,15 +299,15 @@ def on_endswith(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
|
msg: 指定消息结尾内容
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `ignorecase: bool`: 是否忽略大小写
|
ignorecase: 是否忽略大小写
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -327,14 +327,14 @@ def on_keyword(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `keywords: Set[str]`: 关键词列表
|
keywords: 关键词列表
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -357,15 +357,15 @@ def on_command(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
cmd: 指定命令内容
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
aliases: 命令别名
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -396,16 +396,16 @@ def on_shell_command(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
cmd: 指定命令内容
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
aliases: 命令别名
|
||||||
* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象
|
parser: `nonebot.rule.ArgumentParser` 对象
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -434,15 +434,15 @@ def on_regex(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `pattern: str`: 正则表达式
|
pattern: 正则表达式
|
||||||
* `flags: Union[int, re.RegexFlag]`: 正则匹配标志
|
flags: 正则匹配标志
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -458,8 +458,8 @@ class CommandGroup:
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
cmd: 命令前缀
|
||||||
* `**kwargs`: 其他传递给 `on_command` 的参数默认值，参考 `on_command <#on-command-cmd-rule-none-aliases-none-kwargs>`_
|
**kwargs`on_command` 的参数默认值，参考 `on_command <#on-command-cmd-rule-none-aliases-none-kwargs>`_
|
||||||
"""
|
"""
|
||||||
self.basecmd: Tuple[str, ...] = (cmd,) if isinstance(cmd, str) else cmd
|
self.basecmd: Tuple[str, ...] = (cmd,) if isinstance(cmd, str) else cmd
|
||||||
"""
|
"""
|
||||||
@ -478,8 +478,8 @@ class CommandGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
cmd: 命令前缀
|
||||||
* `**kwargs`: 其他传递给 `on_command` 的参数，将会覆盖命令组默认值
|
**kwargs`on_command` 的参数，将会覆盖命令组默认值
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -500,8 +500,8 @@ class CommandGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 命令前缀
|
cmd: 命令前缀
|
||||||
* `**kwargs`: 其他传递给 `on_shell_command` 的参数，将会覆盖命令组默认值
|
**kwargs`on_shell_command` 的参数，将会覆盖命令组默认值
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -537,14 +537,14 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `type: str`: 事件响应器类型
|
type: 事件响应器类型
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -562,12 +562,12 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -587,13 +587,13 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -612,12 +612,12 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -636,12 +636,12 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -662,15 +662,15 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: Union[str, Tuple[str, ...]]`: 指定消息开头内容
|
msg: 指定消息开头内容
|
||||||
* `ignorecase: bool`: 是否忽略大小写
|
ignorecase: 是否忽略大小写
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -689,15 +689,15 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: Union[str, Tuple[str, ...]]`: 指定消息结尾内容
|
msg: 指定消息结尾内容
|
||||||
* `ignorecase: bool`: 是否忽略大小写
|
ignorecase: 是否忽略大小写
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -716,14 +716,14 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `keywords: Set[str]`: 关键词列表
|
keywords: 关键词列表
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -749,15 +749,15 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
cmd: 指定命令内容
|
||||||
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
aliases: 命令别名
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -786,16 +786,16 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `cmd: Union[str, Tuple[str, ...]]`: 指定命令内容
|
cmd: 指定命令内容
|
||||||
* `aliases: Optional[Set[Union[str, Tuple[str, ...]]]]`: 命令别名
|
aliases: 命令别名
|
||||||
* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象
|
parser: `nonebot.rule.ArgumentParser` 对象
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -820,15 +820,15 @@ class MatcherGroup:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `pattern: str`: 正则表达式
|
pattern: 正则表达式
|
||||||
* `flags: Union[int, re.RegexFlag]`: 正则匹配标志
|
flags: 正则匹配标志
|
||||||
* `rule: Optional[Union[Rule, T_RuleChecker]]`: 事件响应规则
|
rule: 事件响应规则
|
||||||
* `permission: Optional[Union[Permission, T_PermissionChecker]] =]]`: 事件响应权限
|
permission: 事件响应权限
|
||||||
* `handlers: Optional[List[Union[T_Handler, Dependent]]]`: 事件处理函数列表
|
handlers: 事件处理函数列表
|
||||||
* `temp: bool`: 是否为临时事件响应器（仅执行一次）
|
temp: 是否为临时事件响应器（仅执行一次）
|
||||||
* `priority: int`: 事件响应器优先级
|
priority: 事件响应器优先级
|
||||||
* `block: bool`: 是否阻止事件向更低优先级传递
|
block: 是否阻止事件向更低优先级传递
|
||||||
* `state: Optional[T_State]`: 默认 state
|
state: 默认 state
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
|
|||||||
@ -58,7 +58,7 @@ def get_plugin(name: str) -> Optional[Plugin]:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `name: str`: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
|
name: 插件名，与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件，则为文件(夹)名。
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
|
|||||||
@ -89,7 +89,7 @@ class Rule:
|
|||||||
"""
|
"""
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*checkers: Union[T_RuleChecker, Dependent[bool]]`: RuleChecker
|
*checkers: RuleChecker
|
||||||
|
|
||||||
"""
|
"""
|
||||||
self.checkers: Set[Dependent[bool]] = set(
|
self.checkers: Set[Dependent[bool]] = set(
|
||||||
@ -117,11 +117,11 @@ class Rule:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `bot: Bot`: Bot 对象
|
bot: Bot 对象
|
||||||
* `event: Event`: Event 对象
|
event: Event 对象
|
||||||
* `state: T_State`: 当前 State
|
state: 当前 State
|
||||||
* `stack: Optional[AsyncExitStack]`: 异步上下文栈
|
stack: 异步上下文栈
|
||||||
* `dependency_cache: Optional[CacheDict[T_Handler, Any]]`: 依赖缓存
|
dependency_cache: 依赖缓存
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -218,7 +218,7 @@ def startswith(msg: Union[str, Tuple[str, ...]], ignorecase: bool = False) -> Ru
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: str`: 消息开头字符串
|
msg: 消息开头字符串
|
||||||
"""
|
"""
|
||||||
if isinstance(msg, str):
|
if isinstance(msg, str):
|
||||||
msg = (msg,)
|
msg = (msg,)
|
||||||
@ -251,7 +251,7 @@ def endswith(msg: Union[str, Tuple[str, ...]], ignorecase: bool = False) -> Rule
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `msg: str`: 消息结尾字符串
|
msg: 消息结尾字符串
|
||||||
"""
|
"""
|
||||||
if isinstance(msg, str):
|
if isinstance(msg, str):
|
||||||
msg = (msg,)
|
msg = (msg,)
|
||||||
@ -277,7 +277,7 @@ def keyword(*keywords: str) -> Rule:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*keywords: str`: 关键词
|
*keywords: 关键词
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return Rule(KeywordsRule(*keywords))
|
return Rule(KeywordsRule(*keywords))
|
||||||
@ -302,7 +302,7 @@ def command(*cmds: Union[str, Tuple[str, ...]]) -> Rule:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*cmds: Union[str, Tuple[str, ...]]`: 命令内容
|
*cmds: 命令内容
|
||||||
|
|
||||||
:示例:
|
:示例:
|
||||||
|
|
||||||
@ -402,8 +402,8 @@ def shell_command(
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `*cmds: Union[str, Tuple[str, ...]]`: 命令内容
|
*cmds: 命令内容
|
||||||
* `parser: Optional[ArgumentParser]`: `nonebot.rule.ArgumentParser` 对象
|
parser: `nonebot.rule.ArgumentParser` 对象
|
||||||
|
|
||||||
:示例:
|
:示例:
|
||||||
|
|
||||||
@ -477,8 +477,8 @@ def regex(regex: str, flags: Union[int, re.RegexFlag] = 0) -> Rule:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `regex: str`: 正则表达式
|
regex: 正则表达式
|
||||||
* `flags: Union[int, re.RegexFlag]`: 正则标志
|
flags: 正则标志
|
||||||
|
|
||||||
\:\:\:tip 提示
|
\:\:\:tip 提示
|
||||||
正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 来确保匹配开头
|
正则表达式匹配使用 search 而非 match，如需从头匹配请使用 `r"^xxx"` 来确保匹配开头
|
||||||
|
|||||||
@ -73,11 +73,11 @@ T_EventPreProcessor = Callable[..., Union[None, Awaitable[None]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
事件预处理函数 EventPreProcessor 类型
|
事件预处理函数 EventPreProcessor 类型
|
||||||
"""
|
"""
|
||||||
@ -85,11 +85,11 @@ T_EventPostProcessor = Callable[..., Union[None, Awaitable[None]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
事件预处理函数 EventPostProcessor 类型
|
事件预处理函数 EventPostProcessor 类型
|
||||||
"""
|
"""
|
||||||
@ -97,12 +97,12 @@ T_RunPreProcessor = Callable[..., Union[None, Awaitable[None]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `MatcherParam`: Matcher 对象
|
MatcherParam: Matcher 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPreProcessor 类型
|
事件响应器运行前预处理函数 RunPreProcessor 类型
|
||||||
"""
|
"""
|
||||||
@ -110,13 +110,13 @@ T_RunPostProcessor = Callable[..., Union[None, Awaitable[None]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `MatcherParam`: Matcher 对象
|
MatcherParam: Matcher 对象
|
||||||
* `ExceptionParam`: 异常对象（可能为 None）
|
ExceptionParam: 异常对象（可能为 None）
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
|
事件响应器运行前预处理函数 RunPostProcessor 类型，第二个参数为运行时产生的错误（如果存在）
|
||||||
"""
|
"""
|
||||||
@ -125,11 +125,11 @@ T_RuleChecker = Callable[..., Union[bool, Awaitable[bool]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
RuleChecker 即判断是否响应事件的处理函数。
|
RuleChecker 即判断是否响应事件的处理函数。
|
||||||
"""
|
"""
|
||||||
@ -137,10 +137,10 @@ T_PermissionChecker = Callable[..., Union[bool, Awaitable[bool]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
RuleChecker 即判断是否响应消息的处理函数。
|
RuleChecker 即判断是否响应消息的处理函数。
|
||||||
"""
|
"""
|
||||||
@ -153,12 +153,12 @@ T_TypeUpdater = Callable[..., Union[str, Awaitable[str]]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `MatcherParam`: Matcher 对象
|
MatcherParam: Matcher 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
TypeUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新响应的事件类型。默认会更新为 `message`。
|
TypeUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新响应的事件类型。默认会更新为 `message`。
|
||||||
"""
|
"""
|
||||||
@ -166,12 +166,12 @@ T_PermissionUpdater = Callable[..., Union["Permission", Awaitable["Permission"]]
|
|||||||
"""
|
"""
|
||||||
:依赖参数:
|
:依赖参数:
|
||||||
|
|
||||||
* `DependParam`: 子依赖参数
|
DependParam: 子依赖参数
|
||||||
* `BotParam`: Bot 对象
|
BotParam: Bot 对象
|
||||||
* `EventParam`: Event 对象
|
EventParam: Event 对象
|
||||||
* `StateParam`: State 对象
|
StateParam: State 对象
|
||||||
* `MatcherParam`: Matcher 对象
|
MatcherParam: Matcher 对象
|
||||||
* `DefaultParam`: 带有默认值的参数
|
DefaultParam: 带有默认值的参数
|
||||||
|
|
||||||
PermissionUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新会话对象权限。默认会更新为当前事件的触发对象。
|
PermissionUpdater 在 Matcher.pause, Matcher.reject 时被运行，用于更新会话对象权限。默认会更新为当前事件的触发对象。
|
||||||
"""
|
"""
|
||||||
|
|||||||
@ -35,7 +35,7 @@ def escape_tag(s: str) -> str:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `s: str`: 需要转义的字符串
|
s: 需要转义的字符串
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -92,7 +92,7 @@ def run_sync(call: Callable[P, R]) -> Callable[P, Awaitable[R]]:
|
|||||||
|
|
||||||
:参数:
|
:参数:
|
||||||
|
|
||||||
* `call: Callable[P, R]`: 被装饰的同步函数
|
call: 被装饰的同步函数
|
||||||
|
|
||||||
:返回:
|
:返回:
|
||||||
|
|
||||||
@ -147,9 +147,9 @@ def logger_wrapper(logger_name: str):
|
|||||||
|
|
||||||
:log 参数:
|
:log 参数:
|
||||||
|
|
||||||
* `level: Literal["CRITICAL", "WARNING", "INFO", "DEBUG", "TRACE"]`: 日志等级
|
level: 日志等级
|
||||||
* `message: str`: 日志信息
|
message: 日志信息
|
||||||
* `exception: Optional[Exception]`: 异常信息
|
exception: 异常信息
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def log(level: str, message: str, exception: Optional[Exception] = None):
|
def log(level: str, message: str, exception: Optional[Exception] = None):
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user