botpy
botpy 是基于机器人开放平台API 实现的机器人框架，目的提供一个易使用、开发效率高的开发框架。
准备工作
安装
pip install qq-botpy更新包的话需要添加 --upgrade 注：需要python3.7+
使用
需要使用的地方import botpy
import botpy兼容提示
原机器人的老版本qq-bot仍然可以使用，但新接口的支持上会逐渐暂停，此次升级不会影响线上使用的机器人
使用方式
快速入门
步骤1
通过继承实现bot.Client, 实现自己的机器人Client
步骤2
实现机器人相关事件的处理方法,如 on_at_message_create， 详细的事件监听列表，请参考 事件监听.md
如下，是定义机器人被@的后自动回复:
import botpy
from botpy.types.message import Message
class MyClient(botpy.Client):
async def on_ready(self):
print(f"robot 「{self.robot.name}」 on_ready!")
async def on_at_message_create(self, message: Message):
await message.reply(content=f"机器人{self.robot.name}收到你的@消息了: {message.content}")注意:每个事件会下发具体的数据对象，如`message`相关事件是`message.Message`的对象 (部分事件透传了后台数据，暂未实现对象缓存)
步骤3
设置机器人需要监听的事件通道，并启动client
import botpy
from botpy.types.message import Message
class MyClient(botpy.Client):
async def on_at_message_create(self, message: Message):
await self.api.post_message(channel_id=message.channel_id, content="content")
intents = botpy.Intents(public_guild_messages=True)
client = MyClient(intents=intents)
client.run(appid="12345", token="xxxx")备注
也可以通过预设置的类型，设置需要监听的事件通道
import botpy
intents = botpy.Intents.none()
intents.public_guild_messages=True使用API
如果要使用api方法，可以参考如下方式:
import botpy
from botpy.types.message import Message
class MyClient(botpy.Client):
async def on_at_message_create(self, message: Message):
await self.api.post_message(channel_id=message.channel_id, content="content")示例机器人
``examples` <./examples/>`_ 目录下存放示例机器人，具体使用可参考``Readme.md` <./examples/README.md>`_
examples/
.
├── README.md
├── config.example.yaml # 示例配置文件（需要修改为config.yaml）
├── demo_announce.py # 机器人公告API使用示例
├── demo_api_permission.py # 机器人授权查询API使用示例
├── demo_at_reply.py # 机器人at被动回复async示例
├── demo_at_reply_ark.py # 机器人at被动回复ark消息示例
├── demo_at_reply_embed.py # 机器人at被动回复embed消息示例
├── demo_at_reply_command.py # 机器人at被动使用Command指令装饰器回复消息示例
├── demo_at_reply_file_data.py # 机器人at被动回复本地图片消息示例
├── demo_at_reply_keyboard.py # 机器人at被动回复md带内嵌键盘的示例
├── demo_at_reply_markdown.py # 机器人at被动回复md消息示例
├── demo_at_reply_reference.py # 机器人at被动回复消息引用示例
├── demo_dms_reply.py # 机器人私信被动回复示例
├── demo_get_reaction_users.py # 机器人获取表情表态成员列表示例
├── demo_guild_member_event.py # 机器人频道成员变化事件示例
├── demo_interaction.py # 机器人互动事件示例（未启用）
├── demo_pins_message.py # 机器人消息置顶示例
├── demo_recall.py # 机器人消息撤回示例
├── demo_schedule.py # 机器人日程相关示例更多功能
更多功能请参考: [https://github.com/tencent-connect/botpy]
3 maintainers
Metadata
3 maintainers
Release files for qq-botpy 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qq-botpy-1.2.1.tar.gz | 38.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qq_botpy-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.6 kB
Release files / qq-botpy-1.2.1.tar.gz
| Download URL | qq-botpy-1.2.1.tar.gz |
|---|---|
| Size | 38.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
442172a0557a9b43d2777d1c5e072090a9d1a54d588d1c5da8d3efc014f4887f
|
|
BLAKE2b-256 checksum How to use checksums |
1fb71b13569f9cf784d1d37caa2d7bc27246922fe50adb62c3dac0d53d7d38ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.18 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.8
|
Release files / qq_botpy-1.2.1-py3-none-any.whl
| Download URL | qq_botpy-1.2.1-py3-none-any.whl |
|---|---|
| Size | 51.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
18b215690dfed88f711322136ec54b6760040b9b1608eb5db7a44e00f59e4f01
|
|
BLAKE2b-256 checksum How to use checksums |
942ecf662566627f1c3508924ef5a0f8277ffc4ac033d6c3a05d1ead6e76f60b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.18 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.8
|
