melobot.adapter

适配器层组件

class melobot.adapter.Adapter[源代码]

基类：HookMixin[AdapterLifeSpan], Generic[EventFactoryT, OutputFactoryT, EchoFactoryT, ActionT, InSourceT, OutSourceT], BetterABC

适配器基类

变量:

protocol (LiteralString) -- 适配器所使用的协议

get_isrcs(filter: Callable[[InSourceT], bool]) → set[InSourceT][源代码]

获取与当前适配器匹配的所有输入源

参数:

filter (Callable[[InSourceT], bool]) -- 过滤函数，为 True 时保留输入源

返回:

输入源的集合

返回类型:

set[InSourceT]

get_osrcs(filter: Callable[[OutSourceT], bool]) → set[OutSourceT][源代码]

获取与当前适配器匹配的所有输出源

参数:

filter (Callable[[OutSourceT], bool]) -- 过滤函数，为 True 时保留输出源

返回:

输出源的集合

返回类型:

set[OutSourceT]

filter_out(filter: Callable[[OutSourceT], bool]) → _GeneratorContextManager[Callable[[OutSourceT], bool]][源代码]

上下文管理器，提供由 filter 控制输出的输出上下文

参数:

filter (Callable[[OutSourceT], bool]) -- 过滤函数，为 True 时允许该输出源输出

返回类型:

_GeneratorContextManager[Callable[[OutSourceT], bool]]

async call_output(action: ActionT) → ActionHandleGroup[源代码]

输出行为，返回 ActionHandleGroup

适配器开发者的适配器子类可以重写此方法，以实现自定义功能

但子类实现中必须调用原始方法： super().call_output(...)

参数:

action (ActionT) -- 行为

返回:

ActionHandleGroup 对象

返回类型:

ActionHandleGroup

property on_before_event_handle: Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

给适配器注册 AdapterLifeSpan.BEFORE_EVENT_HANDLE 阶段 hook 的装饰器

property on_before_action_exec: Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

给适配器注册 AdapterLifeSpan.BEFORE_ACTION_EXEC 阶段 hook 的装饰器

property on_started: Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

给适配器注册 AdapterLifeSpan.STARTED 阶段 hook 的装饰器

property on_close: Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

给适配器注册 AdapterLifeSpan.CLOSE 阶段 hook 的装饰器

property on_stopped: Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

给适配器注册 AdapterLifeSpan.STOPPED 阶段 hook 的装饰器

get_hook_evoke_time(hook_type: HookEnumT) → float

获取指定 hook 最后一次触发的时间戳（秒）

若从未触发过，返回 -1

参数:

hook_type (HookEnumT) -- hook 类型

返回:

触发时间

返回类型:

float

on(*periods: HookEnumT) → Callable[[SyncOrAsyncCallable[P, None]], AsyncCallable[P, None]]

注册一个 hook

参数:

periods (HookEnumT) -- 要绑定的 hook 类型

返回:

装饰器

返回类型:

Callable[[SyncOrAsyncCallable[~P, None]], AsyncCallable[~P, None]]

class melobot.adapter.AdapterLifeSpan[源代码]

基类：Enum

适配器生命周期阶段的枚举

BEFORE_EVENT_HANDLE = 'beh'

适配器将一个事件投入分发器之前（提供首参数类型为 Event 的依赖注入，你可以自行细化类型）

BEFORE_ACTION_EXEC = 'bae'

适配器将一个行为投入执行之前（提供首参数类型为 Action 的依赖注入，你可以自行细化类型）

STARTED = 'sta'

适配器启动完成之后（此时所有同协议的源已经开始工作）

CLOSE = 'clo'

适配器停止即将发生前（出现异常可能不会调用此类型）

STOPPED = 'sto'

适配器停止完成后（包含任何情况导致的停止）

class melobot.adapter.AbstractEventFactory[源代码]

基类：BetterABC, Generic[InPacketT, EventT]

抽象事件工厂类

abstract async create(packet: InPacketT) → EventT[源代码]

将 InPacket 对象转换为 Event 对象的方法

参数:

packet (InPacketT) -- 输入包

返回:

事件

返回类型:

EventT

class melobot.adapter.AbstractOutputFactory[源代码]

基类：BetterABC, Generic[OutPacketT, ActionT]

抽象输出工厂类

abstract async create(action: ActionT) → OutPacketT[源代码]

将 Action 对象转换为 OutPacket 对象的方法

参数:

  • packet -- 行为

  • action (ActionT)

返回:

输出包

返回类型:

OutPacketT

class melobot.adapter.AbstractEchoFactory[源代码]

基类：BetterABC, Generic[EchoPacketT, EchoT]

抽象回应工厂类

abstract async create(packet: EchoPacketT) → EchoT | None[源代码]

将 EchoPacket 对象转换为 Echo 对象的方法

参数:

packet (EchoPacketT) -- 回应包

返回:

回应或空值

返回类型:

EchoT | None

实体基类

class melobot.adapter.Event[源代码]

基类：AttrReprMixin, FlagMixin

事件基类

变量:

  • protocol (LiteralString) -- 遵循的协议，为空则协议无关

  • time (float) -- 时间戳

  • id (str) -- id 标识

  • scope (Hashable | None) -- 所在的域，可空

  • contents (Sequence[Content]) -- 附加的通用内容序列

get_origin_info() → EventOrigin[源代码]
返回类型:

EventOrigin

class melobot.adapter.TextEvent[源代码]

基类：Event, BetterABC

文本事件类

变量:

  • text (str) -- 文本内容

  • textlines (list[str]) -- 文本分行内容

text: str
textlines: list[str]
class melobot.adapter.Action[源代码]

基类：AttrReprMixin, FlagMixin

行为基类

变量:

  • time (float) -- 时间戳

  • id (str) -- id 标识

  • protocol (LiteralString | None) -- 遵循的协议，为空则协议无关

  • contents (Sequence[Content]) -- 附加的通用内容序列

  • scope (Hashable | None) -- 所在的域，可空

  • trigger (Event | None) -- 触发该行为的事件，为空表明不由事件触发

class melobot.adapter.Echo[源代码]

基类：AttrReprMixin, FlagMixin

回应基类

变量:

  • time (float) -- 时间戳

  • id (str) -- id 标识

  • protocol (LiteralString | None) -- 遵循的协议，为空则协议无关

  • scope (Hashable | None) -- 所在的域，可空

  • status (int) -- 回应状态码

  • prompt (str) -- 回应提示语

行为实体相关部件

class melobot.adapter.ActionHandle[源代码]

基类：Generic[EchoT]

行为操作句柄

变量:

  • action (Action) -- 操作包含的行为对象

  • status (Literal["PENDING", "EXECUTING", "DONE"]) -- 操作的状态。分别对应：未执行、执行中、执行完成

  • out_src (AbstractOutSource) -- 执行操作的输出源对象

__await__() → Generator[Any, Any, EchoT | None][源代码]
返回类型:

Generator[Any, Any, EchoT | None]

execute() → Self[源代码]
返回类型:

Self

class melobot.adapter.ActionHandleGroup[源代码]

基类：Generic[EchoT]

行为操作句柄组

__len__() → int[源代码]
返回类型:

int

__iter__() → Iterator[ActionHandle[EchoT]][源代码]
返回类型:

Iterator[ActionHandle[EchoT]]

async __aiter__() → AsyncIterator[tuple[EchoT | None, ActionHandle[EchoT]]][源代码]
返回类型:

AsyncIterator[tuple[EchoT | None, ActionHandle[EchoT]]]

async unwrap_iter() → AsyncIterator[EchoT][源代码]
返回类型:

AsyncIterator[EchoT]

__await__() → Generator[Any, Any, list[EchoT | None]][源代码]
返回类型:

Generator[Any, Any, list[EchoT | None]]

async unwrap(idx: int) → EchoT[源代码]
参数:

idx (int)

返回类型:

EchoT

async unwrap_all() → list[EchoT][源代码]
返回类型:

list[EchoT]

execute() → None[源代码]
返回类型:

None

melobot.adapter.lazy_action() → Generator[None, None, None][源代码]

手动执行行为操作的上下文管理器

展开一个行为操作不自动执行的上下文，适用于需要手动干预行为操作执行时机的场景

返回类型:

Generator[None, None, None]

通用内容实体

class melobot.adapter.content.TextStyle[源代码]

基类：object

跨平台文本格式选项

mime_type: str = 'text/plain'
bold: bool = False
italic: bool = False
underline: bool = False
strikethrough: bool = False
color: Color | None = None
spoiler: bool = False
quote: bool = False
reply_current: bool = False
code: bool = False
follow_theme: bool = True
__init__(mime_type: str = 'text/plain', bold: bool = False, italic: bool = False, underline: bool = False, strikethrough: bool = False, color: Color | None = None, link_to: str | None = None, spoiler: bool = False, quote: bool = False, reply_current: bool = False, code: bool = False, follow_theme: bool = True) → None
参数:
返回类型:

None

class melobot.adapter.content.Content[源代码]

基类：object

通用内容基类

class melobot.adapter.content.TextContent[源代码]

基类：Content

文本内容

__init__(text: str, style: TextStyle | None = None) → None[源代码]

初始化文本内容

参数:

  • text (str) -- 文本

  • style (TextStyle | None) -- 文本样式

返回类型:

None

class melobot.adapter.content.MediaContent[源代码]

基类：Content

多媒体内容

__init__(*, name: str, url: str | None = None, raw: bytes | None = None, mimetype: str | None = None) → None[源代码]

初始化多媒体内容

参数:

  • name (str) -- 多媒体内容的名称

  • raw (bytes | None) -- 多媒体内容的二进制内容

  • url (str | None) -- 多媒体内容的网络地址（和 raw 参数二选一）

  • mimetype (str | None) -- 多媒体内容的 mimetype，为空则根据 name 自动检测

返回类型:

None

class melobot.adapter.content.ImageContent[源代码]

基类：MediaContent

图像内容，初始化方法参考基类

class melobot.adapter.content.AudioContent[源代码]

基类：MediaContent

音频内容，初始化方法参考基类

class melobot.adapter.content.VoiceContent[源代码]

基类：AudioContent

语音内容，初始化方法参考基类

class melobot.adapter.content.VideoContent[源代码]

基类：MediaContent

视频内容，初始化方法参考基类

class melobot.adapter.content.FileContent[源代码]

基类：Content

文件内容

__init__(name: str, flag: Hashable) → None[源代码]

初始化文件内容

参数:

  • name (str) -- 文件名

  • flag (Hashable) -- 文件的唯一标记

返回类型:

None

class melobot.adapter.content.ReferContent[源代码]

基类：Content

引用内容

__init__(prompt: str, flag: Hashable, contents: Sequence[Content]) → None[源代码]

初始化引用内容

参数:

  • prompt (str) -- 引用的文本提示

  • flag (Hashable) -- 引用的唯一标记

  • contents (Sequence[Content]) -- 附加的通用内容序列

返回类型:

None

class melobot.adapter.content.ResourceContent[源代码]

基类：Content

资源内容

__init__(name: str, url: str) → None[源代码]

初始化资源内容

参数:

  • name (str) -- 名称

  • url (str) -- 网络地址

返回类型:

None

通用输出方法

async melobot.adapter.generic.send_text(*texts: str | TextContent) → ActionHandleGroup[源代码]

通用文本输出方法

参数:

texts (str | TextContent)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_media(name: str, raw: bytes | None = None, url: str | None = None, mimetype: str | None = None) → ActionHandleGroup[源代码]

通用媒体内容输出方法

参数:

  • name (str)

  • raw (bytes | None)

  • url (str | None)

  • mimetype (str | None)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_image(name: str, raw: bytes | None = None, url: str | None = None, mimetype: str | None = None) → ActionHandleGroup[源代码]

通用图像内容输出方法

参数:

  • name (str)

  • raw (bytes | None)

  • url (str | None)

  • mimetype (str | None)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_audio(name: str, raw: bytes | None = None, url: str | None = None, mimetype: str | None = None) → ActionHandleGroup[源代码]

通用音频内容输出方法

参数:

  • name (str)

  • raw (bytes | None)

  • url (str | None)

  • mimetype (str | None)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_voice(name: str, raw: bytes | None = None, url: str | None = None, mimetype: str | None = None) → ActionHandleGroup[源代码]

通用语音内容输出方法

参数:

  • name (str)

  • raw (bytes | None)

  • url (str | None)

  • mimetype (str | None)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_video(name: str, raw: bytes | None = None, url: str | None = None, mimetype: str | None = None) → ActionHandleGroup[源代码]

通用视频内容输出方法

参数:

  • name (str)

  • raw (bytes | None)

  • url (str | None)

  • mimetype (str | None)

返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_file(name: str, path: str | PathLike[str]) → ActionHandleGroup[源代码]

通用文件输出方法

参数:
返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_refer(event: Event, contents: Sequence[Content] | None = None) → ActionHandleGroup[源代码]

通用过往事件引用输出方法

参数:
返回类型:

ActionHandleGroup

async melobot.adapter.generic.send_resource(name: str, url: str) → ActionHandleGroup[源代码]

通用其他资源输出方法

参数:
返回类型:

ActionHandleGroup

泛型

melobot.adapter.EventT

事件泛型

melobot.adapter.ActionT

行为（动作）泛型

melobot.adapter.EchoT

回应泛型