nonebot.params
本模块定义了依赖注入的各类参数。
def Arg(key=None)
说明:
got的 Arg 参数消息参数
key(str | None)
返回
- Any
def ArgStr(key=None)
说明:
got的 Arg 参数消息文本参数
key(str | None)
返回
- str
def Depends(dependency=None, *, use_cache=True)
说明: 子依赖装饰器
参数
dependency(T_Handler | None): 依赖函数。默认为参数的类型注释。use_cache(bool): 是否使用缓存。默认为True。
返回
- Any
用法
def depend_func() -> Any:
return ...
def depend_gen_func():
try:
yield ...
finally:
...
async def handler(param_name: Any = Depends(depend_func), gen: Any = Depends(depend_gen_func)):
...
class ArgParam(<auto>)
说明:
got的 Arg 参数参数
auto
class BotParam(<auto>)
说明: 参数
参数
auto
class EventParam(<auto>)
说明: 参数
参数
auto
class StateParam(<auto>)
说明: 事件处理状态参数
参数
auto
class DependParam(<auto>)
说明: 子依赖参数
参数
auto
def ArgPlainText(key=None)
说明:
got的 Arg 参数消息纯文本参数
key(str | None)
返回
- str
class DefaultParam(<auto>)
说明: 默认值参数
参数
auto
class MatcherParam(<auto>)
说明: 事件响应器实例参数
参数
auto
class ExceptionParam(<auto>)
说明:
run_postprocessor的异常参数参数
auto
def EventType()
说明: 类型参数
参数
empty
返回
- str
def EventMessage()
说明: 消息参数
参数
empty
返回
- Any
def EventPlainText()
说明: 纯文本消息参数
参数
empty
返回
- str
def EventToMe()
说明:
to_me参数参数
empty
返回
- bool
def Command()
说明: 消息命令元组
参数
empty
返回
- tuple[str, ...]
def RawCommand()
说明: 消息命令文本
参数
empty
返回
- str
def CommandArg()
说明: 消息命令参数
参数
empty
返回
- Any
def CommandStart()
说明: 消息命令开头
参数
empty
返回
- str
def ShellCommandArgs()
说明: shell 命令解析后的参数字典
参数
empty
返回
- Any
def ShellCommandArgv()
说明: shell 命令原始参数列表
参数
empty
返回
- Any
def RegexMatched()
说明: 正则匹配结果
参数
empty
返回
- str
def RegexStr()
说明: 正则匹配结果文本
参数
empty
返回
- str
def RegexGroup()
说明: 正则匹配结果 group 元组
参数
empty
返回
- tuple[Any, ...]
def RegexDict()
说明: 正则匹配结果 group 字典
参数
empty
返回
- dict[str, Any]
def Startswith()
说明: 响应触发前缀
参数
empty
返回
- str
def Endswith()
说明: 响应触发后缀
参数
empty
返回
- str
def Fullmatch()
说明: 响应触发完整消息
参数
empty
返回
- str
def Keyword()
说明: 响应触发关键字
参数
empty
返回
- str
def Received(id=None, default=None)
说明:
receive事件参数参数
id(str | None)default(Any)
返回
- Any
def LastReceived(default=None)
说明:
last_receive事件参数参数
default(Any)
返回
- Any