qbotsdk 0.6.0__tar.gz

qbotsdk-0.6.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# 更新日志
+
+## [0.6.0] - 2026-10-28
+
+首个发布到 PyPI 的版本。
+
+### 新增
+
+- 事件接入改为适配器模式，默认提供`WebSocketAdapter`与`WebhookAdapter`，默认使用 `WebSocketAdapter()`
+- 会话存储抽象 `SessionStorage`
+- 新增 `build_webhook_handler(dispatcher, app_secret)`
+- 群聊与单聊消息带 `keyboard` 时自动升成 Markdown 消息
+- 新增 `qbotsdk.__version__`
+- 新增六个示例以及`examples/README.md`。
+
+### 变更
+
+- 会话存储从 `qbotsdk.gateway.storage` 移到顶层的 `qbotsdk.storage`。
+- Redis 支持抽成可选依赖 `qbotsdk[redis]`
+- 全仓导入统一为绝对导入，由 `ruff` 的 `TID` 规则约束。
+
+### 破坏性变更
+
+- `Bot` 默认使用 `WebSocketAdapter()`；`Bot` 的 `intents` 与 `shard` 参数移到 `WebSocketAdapter`。
+- `WebhookServer` 的第一个参数从 `Bot` 改成 `Dispatcher`。
+
+[0.6.0]: https://github.com/half-nothing/qbotsdk/releases/tag/v0.6.0

qbotsdk-0.6.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qbotsdk-0.6.0/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: qbotsdk
+Version: 0.6.0
+Summary: Async SDK for the QQ bot open platform
+Keywords: qq,qqbot,bot,sdk,websocket,webhook,asyncio
+Author-Email: Half_nothing <Half_nothing@163.com>
+Maintainer-Email: Half_nothing <Half_nothing@163.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://github.com/half-nothing/qbotsdk
+Project-URL: Repository, https://github.com/half-nothing/qbotsdk
+Project-URL: Issues, https://github.com/half-nothing/qbotsdk/issues
+Project-URL: Changelog, https://github.com/half-nothing/qbotsdk/blob/main/CHANGELOG.md
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.14.3
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: yarl>=1.24.5
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: cryptography>=50.0.2
+Requires-Dist: async-event-bus>=1.0.0
+Provides-Extra: redis
+Requires-Dist: redis>=8.1.0; extra == "redis"
+Description-Content-Type: text/markdown
+
+# qbotsdk
+
+非官方 QQ 机器人 SDK
+
+[![Python](https://img.shields.io/badge/Python-3.12%2B-blue)](https://www.python.org/)
+[![License](https://img.shields.io/github/license/half-nothing/qbotsdk)](./LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/qbotsdk)](https://pypi.org/project/qbotsdk/)
+
+## 特性
+
+- **全异步**：基于 `asyncio` 与 `aiohttp`，所有接口均为异步接口。
+- **登录态自动维护**：`access_token` 自动换取、缓存、到期前刷新。
+- **连接与重连**：WebSocket 适配器自动心跳、断线重连与 Resume。
+- **接入方式可插拔**：默认走 WebSocket 长连接，也可以换成 Webhook 回调，或自己实现 `Adapter`。
+- **消息即对象**：收到的事件可以直接 `await event.reply(...)`。
+- **容错内置**：429 按 `Retry-After` 重试，幂等请求遇 5xx 与网络异常退避重试，本地令牌桶限流，错误统一成 `QQBotError` 体系。
+- **类型完整**：pydantic v2 模型、全量类型标注、随包分发 `py.typed`。
+
+## 安装
+
+包名与导入名均为 `qbotsdk`，要求 Python 版本 >= 3.12。
+
+```bash
+pip install qbotsdk
+uv add qbotsdk           # uv 项目里加依赖
+uv pip install qbotsdk   # 或直接装进当前环境
+```
+
+要从源码安装
+
+```bash
+git clone https://github.com/half-nothing/qbotsdk.git
+cd qbotsdk
+
+pip install -e .         # 可编辑模式，改完立刻生效
+uv pip install -e .      # uv 同理
+```
+
+## 快速开始
+
+```python
+import asyncio
+import os
+
+from qbotsdk import Bot
+
+
+async def main() -> None:
+    # https://q.qq.com/qqbot/dashboard/manage
+    # 进入上方网站管理机器人，在开发设置中找到“AppID 接入凭证”卡片
+    # 将环境变量QQ_BOT_APP_ID设为获取到的AppID
+    # 将环境变量QQ_BOT_APP_SECRET设为获取到的AppSecret
+    # 如果您选择直接替换对应内容，请不要将携带敏感信息的文件提交到仓库
+    async with Bot(
+        app_id=os.environ["QQ_BOT_APP_ID"],
+        app_secret=os.environ["QQ_BOT_APP_SECRET"],
+    ) as bot:
+        me = await bot.api.user.me()
+        print(f"登录成功：{me.username}")
+
+        async for guild in bot.api.user.iter_guilds():
+            channels = await bot.api.guild.channels(guild.id)
+            print(f"{guild.name}：{len(channels)} 个子频道")
+
+
+asyncio.run(main())
+```
+
+## 接收事件
+
+默认走 WebSocket 长连接
+
+```python
+import asyncio
+
+from async_event_bus import EventContext
+
+from qbotsdk import Bot
+from qbotsdk.model.event import C2CMessageCreate, GroupAtMessageCreate, InteractionCreate
+
+
+async def main() -> None:
+    # 认证信息的具体获取方式请查看“快速开始”章节
+    async with Bot(app_id=..., app_secret=...) as bot:
+
+        @bot.on(GroupAtMessageCreate)
+        async def on_group_at(ctx: EventContext[GroupAtMessageCreate]) -> None:
+            await ctx.event.reply("收到: " + ctx.event.content)
+
+        @bot.on(C2CMessageCreate)
+        async def on_c2c(ctx: EventContext[C2CMessageCreate]) -> None:
+            await ctx.event.reply("收到: " + ctx.event.content)
+
+        @bot.on(InteractionCreate)
+        async def on_interaction(ctx: EventContext[InteractionCreate]) -> None:
+            if ctx.event.needs_response:
+                await ctx.event.respond()  # 不回应客户端会一直 loading
+
+        await bot.start()
+        await asyncio.sleep(3600)
+
+
+asyncio.run(main())
+```
+
+bot的`adapter`参数默认为`WebSocketAdapter`，可以显式指定为`WebhookAdapter`  
+也可以自行实现`Adapter`从而扩展更多接入方式，自行实现的`Adapter`需要继承`qbotsdk.adapter.Adapter`并实现两个抽象方法
+
+`WebSocketAdapter`的会话状态默认存在内存里  
+如果想关闭后自动续连，可以在构造`WebSocketAdapter`的时候传递参数`session_storage=`  
+可选值为`MemorySessionStorage`, `FileSessionStorage`, `RedisSessionStorage`, 默认为`MemorySessionStorage`
+
+```python
+from qbotsdk import WebSocketAdapter
+from qbotsdk.storage import FileSessionStorage
+
+# 若不传存储路径，默认路径为软件运行目录下的.session.json文件
+WebSocketAdapter(session_storage=FileSessionStorage())
+
+# Redis 在可选依赖里, 使用前需要先安装qbotsdk[redis]
+from qbotsdk.storage import RedisSessionStorage
+
+# 给完整地址
+WebSocketAdapter(session_storage=RedisSessionStorage.from_url("redis://:pwd@10.0.0.5:6379/2"))
+
+# 或者只给零件, 地址由SDK拼
+storage = RedisSessionStorage.from_url(host="10.0.0.5", port=6379, password="pwd", db=2)
+WebSocketAdapter(session_storage=storage)
+
+# Unix domain socket, 以及指定RESP协议版本
+RedisSessionStorage.from_url(unix_socket="/var/run/redis/redis.sock", db=2, protocol=3)
+```
+
+也可以直接把现成的Redis客户端交给SDK
+
+```python
+# 特别注意，SDK需要的Redis实例全限定名是redis.asyncio.Redis
+from redis.asyncio import Redis
+
+from qbotsdk.storage import RedisSessionStorage
+
+storage = RedisSessionStorage(Redis(host="10.0.0.5", port=6379))
+```
+
+
+### Webhook 接入
+
+在[QQ机器人管理后台](https://q.qq.com/qqbot/dashboard/manage)填好回调地址并勾选要监听的事件后，
+事件就改走 HTTP 推送，代码层面仅需把适配器换成 `WebhookAdapter`：
+
+```python
+from qbotsdk import Bot, WebhookAdapter
+
+bot = Bot(
+    # 认证信息的具体获取方式请查看“快速开始”章节
+    app_id=...,
+    app_secret=...,
+    adapter=WebhookAdapter(
+        "同app_secret",
+        port=8443,
+        path="/qbotsdk",
+        certfile="certs/fullchain.pem",
+        keyfile="certs/privkey.pem",
+    ),
+)
+await bot.start()
+```
+
+没有公网地址时用反向代理或内网穿透把请求转到本机，务必原样透传 body 和两个签名头，任何改写都会导致验签失败。
+
+如果事件要接进自己已有的aiohttp应用，不用起整套服务器，挂一个处理函数就行：
+
+```python
+from aiohttp import web
+
+from qbotsdk import Bot, build_webhook_handler
+
+bot = Bot(app_id=..., app_secret=...)
+app = web.Application()
+app.router.add_post("/qbotsdk", build_webhook_handler(bot.dispatcher, "机器人密钥"))
+```
+
+如果要使用flask等其他http框架，仿照该处理函数写一遍处理函数即可。
+
+## 示例
+
+具体示例请见[examples文件夹](examples/README.md)。
+
+## 第三方依赖
+
+| 依赖                                                                 | 用途                      | 许可                         |
+|--------------------------------------------------------------------|-------------------------|----------------------------|
+| [aiohttp](https://github.com/aio-libs/aiohttp)                     | HTTP 与 WebSocket 客户端    | Apache-2.0 AND MIT         |
+| [pydantic](https://github.com/pydantic/pydantic)                   | 数据模型与校验                 | MIT                        |
+| [loguru](https://github.com/Delgan/loguru)                         | 日志                      | MIT                        |
+| [cryptography](https://github.com/pyca/cryptography)               | Webhook 的 ed25519 签名与验签 | Apache-2.0 OR BSD-3-Clause |
+| [async-event-bus](https://github.com/half-nothing/async-event-bus) | 事件总线                    | MIT                        |
+| [yarl](https://github.com/aio-libs/yarl)                           | URL 拼接                  | Apache-2.0                 |
+
+## 致谢
+
+- [QQ 机器人官方文档](https://bot.q.qq.com/wiki/develop/api-v2)：字段、错误码与协议细节都以它为准。
+- [async-event-bus](https://github.com/half-nothing/async-event-bus)：事件总线。
+- [aiohttp](https://github.com/aio-libs/aiohttp)：HTTP 与 WebSocket 客户端。
+- [pydantic](https://github.com/pydantic/pydantic)：数据模型与校验。
+- [loguru](https://github.com/Delgan/loguru)：日志。
+- [cryptography](https://github.com/pyca/cryptography)：ed25519 签名与验签。
+- [yarl](https://github.com/aio-libs/yarl)：URL 拼接。
+- 腾讯官方 Python SDK 文档与社区实现：心跳、Resume、关闭码语义对照过。
+- 所有反馈过的使用者。
+
+## 许可证
+
+Apache-2.0，见 [LICENSE](LICENSE)。