| Python SDK 接入指南 | 您所在的位置：网站首页 › qq机器人商店 › Python SDK 接入指南 |
Python SDK 接入指南
|
# Python SDK 接入指南 外发版本通过下面方式安装 pip install qq-botpy 1更新包的话需要添加 --upgrade 兼容版本：python3.8+ # sdk 使用需要使用的地方import botpy import botpy 1# 兼容提示原机器人的老版本qq-bot仍然可以使用，但新接口的支持上会逐渐暂停，此次升级不会影响线上使用的机器人 # 示例机器人examples (opens new window) 目录下存放示例机器人，可供实现参考。 # botpy-API基于 机器人开放平台API (opens new window) 实现的 API 接口封装。 # 快速示例通过继承实现bot.Client, 实现自己的机器人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={appid}, token={token}) 12345678910# botpy-事件监听异步模块基于 websocket 技术用于监听频道内的相关事件，如消息、成员变化等事件，用于开发者对事件进行相应的处理。 更完整的事件说明，请参考 事件监听 (opens new window) # 订阅事件的方法 # 方法一： intents = botpy.Intents() client = MyClient(intents=intents) 12在Intents中填入对应的参数 例子： intents = botpy.Intents(public_guild_messages=True, direct_message=True, guilds=True) 1# 方法二： intents = botpy.Intents.none() 1然后打开对应的订阅(参数列表) intents.public_guild_messages=True intents.direct_message=True intents.guilds=True 123说明： 方法二对应的快捷订阅方式为 订阅所有事件 intents = botpy.Intents.all() 1订阅所有的公域事件 intents = botpy.Intents.default() 1# 备注也可以通过预设置的类型，设置需要监听的事件通道 import botpy intents = botpy.Intents.none() intents.public_guild_messages=True 1234# 参数列表 参数 含义 public_guild_messages 公域消息事件 guild_messages 消息事件 (仅 私域 机器人能够设置此 intents) direct_message 私信事件 guild_message_reactions 消息相关互动事件 guilds 频道事件 guild_members 频道成员事件 interaction 互动事件 message_audit 消息审核事件 forums 论坛事件 (仅 私域 机器人能够设置此 intents) audio_action 音频事件 # 日志打印基于自带的 logging 模块封装的日志模块，提供了日志写入以及美化了打印格式，并支持调整打印级别（默认打印级别为 INFO）。 # 使用方法引用模块，并获取 logger 实例： from botpy import logging 1或者通过botpy.logger也可以获取logger对象 然后就可以愉快地使用 logger 进行打印。例如： from botpy import logger logger.info("hello world!") 123# 日志设置SDK的日志设置集成在bot.Client的实例化阶段，也可通过logging.configure_logging修改(均为可选) import botpy # 示例，非默认值 botpy.Client( log_level=10, log_format="new format", bot_log=None, ext_handlers=False, log_config="log_config.json" ) 12345678910# log_level日志级别，默认为INFO 命令行启动py可增加参数-d 或 --debug快捷打开debug日志 python3 demo_at_reply.py -d 1几个可选取值（参考了logging模块的取值 (opens new window)）： Level 取值 CRITICAL 50 ERROR 40 WARNING 30 INFO 20 DEBUG 10 NOTSET 0 # log_format日志控制台输出格式，默认为 "\033[1;33m[%(levelname)s]\t(%(filename)s:%(lineno)s)%(funcName)s\t\033[0m%(message)s" # bot_log是否启用botpy日志，默认为True True 启用 None 禁用 拓展 False 禁用 拓展+控制台输出 # ext_handlers日志Handler拓展，为True使用默认拓展，False不添加拓展，可用list添加多个拓展。默认为True 默认拓展 import os import logging from logging.handlers import TimedRotatingFileHandler DEFAULT_FILE_HANDLER = { # 要实例化的Handler "handler": TimedRotatingFileHandler, # 可选 Default to DEFAULT_FILE_FORMAT "format": "%(asctime)s\t[%(levelname)s]\t(%(filename)s:%(lineno)s)%(funcName)s\t%(message)s", # 可选 Default to DEBUG "level": logging.DEBUG, # 以下是Handler相关参数 "when": "D", "backupCount": 7, "encoding": "utf-8", # *特殊* 对于filename参数，其中如有 %(name)s 会在实例化阶段填入相应的日志name "filename": os.path.join(os.getcwd(), "%(name)s.log"), } 123456789101112131415161718# 修改默认拓展 import os import botpy from botpy.logging import DEFAULT_FILE_HANDLER # 修改日志路径 DEFAULT_FILE_HANDLER["filename"] = os.path.join(os.getcwd(), "log", "%(name)s.log") # 修改日志格式 DEFAULT_FILE_HANDLER["format"] = "new format" botpy.Client(ext_handlers=DEFAULT_FILE_HANDLER) 12345678910# log_config该参数将传入logging.config.dictConfig(内置logging而非botpy.logging)，如果为.json/.yaml文件路径将从文件中读取配置，无默认值 在GitHub上编辑此页 (opens new window) 上次更新: 6/24/2022, 6:27:11 PMPythonSDK更新日志 → 贡献者🎉 |
【本文地址】