From 2a08f6bdf69547388842c5e631810af8850ff607 Mon Sep 17 00:00:00 2001 From: nonebot Date: Sun, 3 Oct 2021 08:41:04 +0000 Subject: [PATCH] :memo: update api docs --- docs/api/adapters/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/adapters/README.md b/docs/api/adapters/README.md index 3c1bcc8b..f9c99f6b 100644 --- a/docs/api/adapters/README.md +++ b/docs/api/adapters/README.md @@ -306,6 +306,7 @@ await bot.send_msg(message="hello world") * **说明** 根据创建消息模板, 用法和 `str.format` 大致相同, 但是可以输出消息对象, 并且支持以 `Message` 对象作为消息模板 + 并且提供了拓展的格式化控制符, 可以用适用于该消息类型的 `MessageSegment` 的工厂方法创建消息 @@ -313,17 +314,18 @@ await bot.send_msg(message="hello world") ```python ->>> Message.template("{} {}").format("hello", "world") +>>> Message.template("{} {}").format("hello", "world") # 基础演示 Message(MessageSegment(type='text', data={'text': 'hello world'})) ->>> Message.template("{} {}").format(MessageSegment.image("file///..."), "world") +>>> Message.template("{} {}").format(MessageSegment.image("file///..."), "world") # 支持消息段等对象 Message(MessageSegment(type='image', data={'file': 'file///...'}), MessageSegment(type='text', data={'text': 'world'})) ->>> Message.template( +>>> Message.template( # 支持以Message对象作为消息模板 ... MessageSegment.text('test {event.user_id}') + MessageSegment.face(233) + -... MessageSegment.text('test {event.message}')).format(event={'user_id':123456, 'message':'hello world'} -... ) +... MessageSegment.text('test {event.message}')).format(event={'user_id':123456, 'message':'hello world'}) Message(MessageSegment(type='text', data={'text': 'test 123456'}), MessageSegment(type='face', data={'face': 233}), MessageSegment(type='text', data={'text': 'test hello world'})) +>>> Message.template("{link:image}").format(link='https://...') # 支持拓展格式化控制符 +Message(MessageSegment(type='image', data={'file': 'https://...'})) ```