Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

CQHttp Python SDK

Project description

CQHttp Python SDK

License PyPI

本项目为酷 Q 的 CoolQ HTTP API 插件的 Python SDK,封装了 web server 相关的代码,让使用 Python 的开发者能方便地开发插件。仅支持 Python 3.5+。

关于 CoolQ HTTP API 插件,见 richardchien/coolq-http-api

用法

首先安装 cqhttp 包:

pip install cqhttp

注意可能需要把 pip 换成 pip3。本 SDK 依赖于 Flaskrequests 包,因此它们也会被安装。

也可以 clone 本仓库之后用 python setup.py install 来安装。

SDK 的 1.1.0 及以上版本支持插件版本 3.x,且不再兼容旧版插件,如果你需要使用旧版插件,请安装 1.0.1 版本 pip install cqhttp==1.0.1

1.2.0 及以上版本支持插件版本 4.x,同时兼容 3.x。

然后新建 Python 文件,运行 CQHttp 后端:

from cqhttp import CQHttp

bot = CQHttp(api_root='http://127.0.0.1:5700/',
             access_token='your-token',
             secret='your-secret')


@bot.on_message()
def handle_msg(context):
    bot.send(context, '你好呀,下面一条是你刚刚发的:')
    return {'reply': context['message'], 'at_sender': False}


@bot.on_notice('group_increase')  # 如果插件版本是 3.x,这里需要使用 @bot.on_event
def handle_group_increase(context):
    bot.send(context, message='欢迎新人~', is_raw=True)  # 发送欢迎新人


@bot.on_request('group', 'friend')
def handle_request(context):
    return {'approve': True}  # 同意所有加群、加好友请求


bot.run(host='127.0.0.1', port=8080)

创建实例

首先创建 CQHttp 类的实例,传入 api_root,即为酷 Q HTTP API 插件的监听地址,如果你不需要调用 API,也可以不传入。Access token 和签名密钥也在这里传入,如果没有配置 access_tokensecret 项,则不传。

事件处理

on_messageon_notice(插件 v3.x 对应为 on_event)、on_request 三个装饰器分别对应三个上报类型(post_type),括号中指出要处理的消息类型(message_type)、通知类型(notice_type)(插件 v3.x 对应 event 事件名)、请求类型(request_type),一次可指定多个,如果留空,则会处理所有这个上报类型的上报。在上面的例子中 handle_msg 函数将会在收到任意渠道的消息时被调用,handle_group_increase 函数会在群成员增加时调用。

上面三个装饰器装饰的函数,统一接受一个参数,即为上报的数据,具体数据内容见 事件上报;返回值可以是一个字典,会被自动作为 JSON 响应返回给 HTTP API 插件,具体见 上报请求的响应数据格式

API 调用

在设置了 api_root 的情况下,直接在 CQHttp 类的实例上就可以调用 API,例如 bot.send_private_msg(user_id=123456, message='hello'),这里的 send_private_msg 即为 /send_private_msg 发送私聊消息 中的 /send_private_msgAPI 所需参数直接通过命名参数(keyword argument)传入。其它 API 见 API 描述

为了简化发送消息的操作,提供了 send(context, message) 函数,这里的第一个参数 context 也就是上报数据,传入之后函数会自己判断当前需要发送到哪里(哪个好友,或哪个群),无需手动再指定,其它参数仍然可以从 keyword argument 指定,例如 auto_escape=True

每个 API 调用最后都会由 requests 库来发出请求,如果网络无法连接,它可能会抛出 ConnectionError 等异常,见 错误与异常。而一旦请求成功,本 SDK 会判断 HTTP 响应状态码,只有当状态码为 200,且 status 字段为 okasync 时,会返回 data 字段的内容,否则抛出 cqhttp.Error 异常,在这个异常中你可以通过 status_coderetcode 属性来获取 HTTP 状态码和插件的 retcode(如果状态码不为 200,则 retcode 为 None),具体响应状态码和 retcode 的含义,见 响应说明

运行实例

使用装饰器定义好处理函数之后,调用 bot.run() 即可运行。你需要传入 hostport 参数,来指定服务端需要运行在哪个地址,然后在 HTTP API 插件的配置文件中,在 post_url 项中配置此地址(http://host:port/

CQHttp Helper

项目根目录下的 cqhttp_helper.py 文件是 SuperMarioSF 贡献的帮助类,在 CQHttp 类的基础上提供了每个 API 调用的具体函数,以便在支持的代码编辑器中使用代码补全和文档速览。

注意,此文件不在 pip 安装的包中,需单独下载,如果以后插件新增接口,此文件可能没有及时更新,但不影响使用,你仍然可以像使用原始的 CQHttp 一样使用它。

部署

bot.run() 只适用于开发环境,不建议用于生产环境,因此 SDK 从 1.2.1 版本开始提供 bot.wsgi 属性以获取其内部兼容 WSGI 的 app 对象,从而可以使用 Gunicorn、uWSGI 等软件来部署。

遇到问题

本 SDK 的代码非常简单,如果发现有问题可以参考下源码,可以自行做一些修复,也欢迎提交 pull request 或 issue。

Project details


Release history Release notifications

This version
History Node

1.2.1

History Node

1.2.0

History Node

1.1.0

History Node

1.0.1

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cqhttp-1.2.1.tar.gz (5.6 kB) Copy SHA256 hash SHA256 Source None Jun 2, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page