euler-onebot 0.0.2__tar.gz → 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. euler_onebot-0.1.3/PKG-INFO +468 -0
  2. euler_onebot-0.1.3/pyproject.toml +67 -0
  3. euler_onebot-0.1.3/readme.md +447 -0
  4. euler_onebot-0.1.3/src/euler_onebot.egg-info/PKG-INFO +468 -0
  5. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euler_onebot.egg-info/SOURCES.txt +20 -2
  6. euler_onebot-0.1.3/src/euler_onebot.egg-info/entry_points.txt +2 -0
  7. euler_onebot-0.1.3/src/euler_onebot.egg-info/requires.txt +9 -0
  8. euler_onebot-0.1.3/src/euleronebot/__init__.py +25 -0
  9. euler_onebot-0.1.3/src/euleronebot/__main__.py +3 -0
  10. euler_onebot-0.1.3/src/euleronebot/cli.py +29 -0
  11. euler_onebot-0.1.3/src/euleronebot/config.py +116 -0
  12. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/hyperogger.py +36 -26
  13. euler_onebot-0.1.3/src/euleronebot/onebot/__init__.py +167 -0
  14. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/onebot/api.py +168 -104
  15. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/onebot/api_data.py +136 -52
  16. euler_onebot-0.1.3/src/euleronebot/onebot/connector.py +320 -0
  17. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/onebot/events.py +57 -26
  18. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/onebot/models.py +3 -1
  19. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euleronebot/onebot/segments.py +104 -31
  20. euler_onebot-0.1.3/src/euleronebot/protocol/__init__.py +194 -0
  21. euler_onebot-0.1.3/src/euleronebot/protocol/handle.py +485 -0
  22. euler_onebot-0.1.3/src/euleronebot/protocol/impl.py +617 -0
  23. euler_onebot-0.1.3/src/euleronebot/utils/__init__.py +54 -0
  24. euler_onebot-0.1.3/src/euleronebot/utils/infomgr.py +404 -0
  25. euler_onebot-0.1.3/src/euleronebot/utils/sign_provider.py +31 -0
  26. euler_onebot-0.1.3/src/euleronebot/utils/transformer.py +401 -0
  27. euler_onebot-0.1.3/src/euleronebot/versions.py +9 -0
  28. euler_onebot-0.1.3/tests/test_api.py +74 -0
  29. euler_onebot-0.1.3/tests/test_config.py +102 -0
  30. euler_onebot-0.1.3/tests/test_connector.py +336 -0
  31. euler_onebot-0.1.3/tests/test_events.py +181 -0
  32. euler_onebot-0.1.3/tests/test_handle.py +182 -0
  33. euler_onebot-0.1.3/tests/test_impl.py +373 -0
  34. euler_onebot-0.1.3/tests/test_infomgr.py +194 -0
  35. euler_onebot-0.1.3/tests/test_protocol.py +159 -0
  36. euler_onebot-0.1.3/tests/test_segments.py +65 -0
  37. euler_onebot-0.1.3/tests/test_sign_provider.py +139 -0
  38. euler_onebot-0.1.3/tests/test_utils.py +44 -0
  39. euler_onebot-0.0.2/PKG-INFO +0 -158
  40. euler_onebot-0.0.2/pyproject.toml +0 -28
  41. euler_onebot-0.0.2/readme.md +0 -139
  42. euler_onebot-0.0.2/src/euler_onebot.egg-info/PKG-INFO +0 -158
  43. euler_onebot-0.0.2/src/euler_onebot.egg-info/requires.txt +0 -7
  44. euler_onebot-0.0.2/src/euleronebot/config.py +0 -79
  45. euler_onebot-0.0.2/src/euleronebot/onebot/__init__.py +0 -80
  46. euler_onebot-0.0.2/src/euleronebot/onebot/connector.py +0 -117
  47. euler_onebot-0.0.2/src/euleronebot/protocol.py +0 -528
  48. euler_onebot-0.0.2/src/euleronebot/utils/__init__.py +0 -28
  49. euler_onebot-0.0.2/src/euleronebot/utils/infomgr.py +0 -105
  50. euler_onebot-0.0.2/src/euleronebot/utils/transformer.py +0 -224
  51. euler_onebot-0.0.2/src/euleronebot/versions.py +0 -2
  52. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/LICENSE +0 -0
  53. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/setup.cfg +0 -0
  54. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euler_onebot.egg-info/dependency_links.txt +0 -0
  55. {euler_onebot-0.0.2 → euler_onebot-0.1.3}/src/euler_onebot.egg-info/top_level.txt +0 -0
@@ -0,0 +1,468 @@
1
+ Metadata-Version: 2.4
2
+ Name: euler-onebot
3
+ Version: 0.1.3
4
+ Summary: A OneBot v11 implementation in Python, based on lagrange-python
5
+ Author: HarcicYang
6
+ License-Expression: GPL-3.0-or-later
7
+ Keywords: onebot,qq,lagrange
8
+ Requires-Python: >=3.11
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE
11
+ Requires-Dist: pydantic
12
+ Requires-Dist: pydantic-settings
13
+ Requires-Dist: fastapi
14
+ Requires-Dist: uvicorn[standard]
15
+ Requires-Dist: websockets
16
+ Requires-Dist: python-multipart
17
+ Requires-Dist: httpx
18
+ Requires-Dist: hiro-qq<0.3.0,>=0.2.0
19
+ Requires-Dist: aiosqlite
20
+ Dynamic: license-file
21
+
22
+ # Euler OneBot
23
+
24
+ 一个无聊的 OneBot 实现,完全使用 python 语言,基于 [Hiro QQ](https://github.com/HarcicYang/hiro-qq)
25
+
26
+ ![GPL-3.0](https://img.shields.io/static/v1?label=LICENSE&message=GPL-3.0&style=flat-square)
27
+ ![OneBot V11](https://img.shields.io/badge/OneBot-11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==&style=flat-square)
28
+
29
+
30
+ [友情链接 - Forked Lagrange.Milky](https://github.com/gotohitori0221/Lagrange.Core)
31
+
32
+ ---
33
+
34
+ ## Why EulerOneBot ?
35
+
36
+ 1. 超过90%代码系古法手搓;
37
+ 2. 我敢让他每天都在我自己的账户上运行;
38
+ 3. Hook方案所没有的性能。
39
+
40
+ ## 项目特点
41
+
42
+ 本项目基本目的在于为曾经使用 Lagrange.OneBot 、在 Lagrange.OneBot 停止维护后暂时不愿迁移到 milky 或 期望基于协议库而非
43
+ hook 方案的 OneBot 实现的用户。
44
+
45
+ ## 环境要求
46
+
47
+ 若您使用:
48
+
49
+ - Apple M 系列或 A 系列芯片的 macOS 设备
50
+ - 几乎任何 Windows x64/arm64 设备
51
+ - 几乎任何非 musl 的 x64/arm64 Linux 发行版
52
+
53
+ 则您可以跳过环境配置,前往 [actions](https://github.com/HarcicYang/EulerOneBot/actions/workflows/build_release.yaml)
54
+ 下载打包的可执行文件。
55
+
56
+ - Python >= 3.11
57
+ - [Hiro QQ](https://github.com/Harcic/hiro-qq) [^1]
58
+ - 与所选协议匹配的签名服务(PC 和安卓的接口不一样,见[签名服务](#签名服务),Lagrange 说明见 [SignApiGuide](https://github.com/LagrangeDev/SignApiGuide))
59
+
60
+ ## 安装与使用
61
+
62
+ ### 方式一:使用预编译可执行文件(推荐)
63
+
64
+ 前往 [Actions](https://github.com/HarcicYang/EulerOneBot/actions/workflows/build_release.yaml) 下载与您设备架构对应的产物(
65
+ `-linux-x64` / `-linux-arm64` / `-macos-arm64` / `-windows-x64` / `-windows-arm64`)并解压,随后运行:
66
+
67
+ ```shell
68
+ ./euler-onebot-<版本号> # Linux / macOS(macOS 提供普通命令行程序)
69
+ euler-onebot-<版本号>.exe # Windows
70
+ ```
71
+
72
+ 首次启动会在可执行文件旁自动生成 `appconfig.json` 配置模板并显示提示,填写后重启即可。源码运行时配置仍在当前目录生成。
73
+
74
+ ### 方式二:从源码运行
75
+
76
+ 1. 克隆本项目:
77
+
78
+ ```shell
79
+ git clone https://github.com/HarcicYang/EulerOneBot.git
80
+ cd EulerOneBot
81
+ ```
82
+
83
+ 2. 安装依赖并运行(首次启动会自动生成 `appconfig.json`):
84
+
85
+ ```shell
86
+ uv sync
87
+ uv run euler.onebot
88
+ ```
89
+
90
+ 若您不希望使用 uv,也可以安装后通过命令行入口或 Python 模块运行:
91
+
92
+ ```shell
93
+ pip install .
94
+ euler.onebot
95
+ # 或
96
+ python -m euleronebot
97
+ ```
98
+
99
+ ## 配置文件
100
+
101
+ 首次运行会自动生成 `appconfig.json`,编辑后重启。配置项如下:
102
+
103
+ ```json
104
+ {
105
+ "$schema": "./appconfig.schema.json",
106
+ "log_level": "INFO",
107
+ "log_nf": true,
108
+ "access_token": "",
109
+ "event_compatibility": {
110
+ "reaction_event_type": "reaction"
111
+ },
112
+ "connections": [
113
+ {
114
+ "type": "HTTP",
115
+ "url": "http://127.0.0.1:3000"
116
+ },
117
+ {
118
+ "type": "HTTPPost",
119
+ "url": "http://127.0.0.1:8080/onebot",
120
+ "timeout": 5,
121
+ "secret": ""
122
+ },
123
+ {
124
+ "type": "ForwardWebSocket",
125
+ "url": "ws://127.0.0.1:5004"
126
+ },
127
+ {
128
+ "type": "ReverseWebSocket",
129
+ "url": "ws://127.0.0.1:8080",
130
+ "api_url": "",
131
+ "event_url": "",
132
+ "use_universal_client": false,
133
+ "reconnect_interval": 3000
134
+ }
135
+ ],
136
+ "login": {
137
+ "uin": 0,
138
+ "protocol": "linux",
139
+ "fetch_appinfo": false,
140
+ "signer_url": "https://sign.lagrangecore.org",
141
+ "signer_token": "",
142
+ "use_custom": false,
143
+ "appinfo_path": "./appinfo.json",
144
+ "use_custom_sign_provider": false,
145
+ "sign_provider_path": "./sign_provider.py",
146
+ "sign_provider_entry": "sign_provider",
147
+ "setup_watchdog": false,
148
+ "use_ipv6": false,
149
+ "use_optimum": true
150
+ },
151
+ "heartbeat": {
152
+ "enabled": true,
153
+ "interval": 15000
154
+ }
155
+ }
156
+ ```
157
+ 示例里把四种连接类型都写了一遍,实际只保留自己要用的那条,其余删掉即可,`connections` 数组里可以同时存在多条。
158
+
159
+ 仓库附有 `appconfig.schema.json`(由 `BotConfig` 模型自动生成,可通过 `python scripts/gen_schema.py` 重新生成)。
160
+ 保留配置开头的 `$schema` 字段后,VS Code / IDEA 等编辑器即可获得自动补全与校验。
161
+ 若模型有改动,CI 会校验 schema 文件与模型保持同步。
162
+
163
+ | 字段 | 说明 |
164
+ |------------------------|--------------------------------------------------------------------------------|
165
+ | `$schema` | schema 文件路径,只给编辑器做补全和校验用,程序解析时会忽略 |
166
+ | `log_level` | 日志级别:`TRACE` / `DEBUG` / `INFO` / `WARNING` / `ERROR` / `CRITICAL` |
167
+ | `log_nf` | 是否为日志输出启用 NerdFont |
168
+ | `access_token` | 鉴权 Token,配置后 HTTP / 正向 WebSocket / 反向 WebSocket 需携带(空为不鉴权) |
169
+ | `event_compatibility.reaction_event_type` | reaction 事件下发类型,可选 `reaction` 或 `group_msg_emoji_like` |
170
+ | `connections` | 通信连接列表(见下方连接类型) |
171
+ | `login.uin` | QQ 账号(不要真的写0哦) |
172
+ | `login.protocol` | 协议类型:`linux` / `macos` / `windows` / `android_phone` / `android_pad` |
173
+ | `login.fetch_appinfo` | 是否在启动时从签名服务器获取协议参数,默认 `false` |
174
+ | `login.signer_url` | 签名服务地址(见[签名服务](#签名服务)) |
175
+ | `login.signer_token` | 签名服务 access token |
176
+ | `login.use_custom` | 是否加载自定义协议参数;设为 `true` 后读取 `appinfo_path` 指定的 JSON 文件 |
177
+ | `login.appinfo_path` | 自定义协议参数文件路径,默认 `./appinfo.json`,相对当前工作目录 |
178
+ | `login.use_custom_sign_provider` | 是否改用自定义 sign provider;设为 `true` 后从 `sign_provider_path` 加载 |
179
+ | `login.sign_provider_path` | 自定义 sign provider 文件路径,默认 `./sign_provider.py`,相对当前工作目录 |
180
+ | `login.sign_provider_entry` | 该文件中作为入口的方法名,默认 `sign_provider` |
181
+ | `login.setup_watchdog` | 是否启用看门狗;连续 10 分钟没有处理事件时触发重新登录 |
182
+ | `login.use_ipv6` | 是否使用 IPv6 连接 |
183
+ | `login.use_optimum` | 是否启用最优服务器选择 |
184
+ | `heartbeat.enabled` | 是否启用心跳 |
185
+ | `heartbeat.interval` | 心跳间隔(毫秒) |
186
+
187
+ `event_compatibility.reaction_event_type` 默认值为 `reaction`。设置为 `group_msg_emoji_like` 后,群表情回应事件的
188
+ `notice_type` 会使用该兼容名称,其余字段保持不变。
189
+
190
+ ### 协议类型
191
+
192
+ `login.protocol` 决定用哪套客户端参数登录,目前内置这几套:
193
+
194
+ | 取值 | 说明 |
195
+ |-----------------|-------------------------|
196
+ | `linux` | 默认,PC 端 Linux QQ |
197
+ | `windows` | PC 端 Windows QQ |
198
+ | `macos` | PC 端 macOS QQ |
199
+ | `android_phone` | 安卓手机 QQ 9.1.60 |
200
+ | `android_pad` | 安卓平板 QQ 9.3.70 |
201
+
202
+ 前三个用的是一类 PC 参数,后两个是这次补上的安卓实现,参数和封包细节参照 Lagrange V2:
203
+
204
+ - 每个 SSO 包的保留头都会带上 `MsgType = 32` 和 `NtCoreVersion = 100`;
205
+ - 拉用户资料时,用 uin 查的 `0xFE1_2` 单独放行,`MsgType` 置 0;用 uid 查的 `0xFE1_8` 仍然是 32;
206
+ - 文件相关的 OIDB(`0xE37_1700`、`0x6D9_4`)把保留字段填 1。
207
+
208
+ 切协议不用改代码,改配置就行。不过有两件事得先想清楚:安卓协议必须搭配支持安卓接口的签名服务;登录走的还是通用 NT 登录流程,风控表现和 PC 端不一定一样,建议先拿小号试。
209
+
210
+ ### 从签名服务器获取 appinfo
211
+
212
+ `login.fetch_appinfo` 是这次新加的开关,默认关着。打开以后,启动时会先向签名服务要一份 appinfo,拿到就直接用,拿不到就退回内置参数,不会因此登不上。
213
+
214
+ 地址是在签名地址后面接 `/appinfo_v2`:PC 协议是 `{signer_url}/api/sign/sec-sign/appinfo_v2`,安卓协议是 `{signer_url}/api/sign/appinfo_v2`。返回结构和 Lagrange V2 一样,读 `data` 或 `value` 里的 `os`、`kernel`、`vendor_os`、`qua`、`current_version`、`pt_version`、`sso_version`、`package_name`、`app_id`、`sub_app_id`、`app_client_version`,以及 `sdk_info` 里的 `sdk_version`、`misc_bit_map`、`sub_sig_map`、`main_sig_map`。
215
+
216
+ 开关打开之后,`login.protocol` 只剩两个作用:决定签名接口走哪一套,以及拉取失败时用哪套内置参数兜底。版本号、qua 这些以签名服务返回的为准。签名服务不提供这个接口的话,保持关闭就行。
217
+
218
+ ### 签名服务
219
+
220
+ 登录 QQ 时需要签名服务为关键数据包签名。除上面的示例所用的[Lagrange 提供的签名服务 `https://sign.lagrangecore.org`](https://github.com/LagrangeDev/SignApiGuide),本项目也提供
221
+ [自建的签名 API](https://api.harcic.me/api/sign/manage),目前的长时间测试没有遇到风控/踢出问题,注册应该是更加简单的。其步骤大致如下:
222
+
223
+ 1. 登录您的 GitHub 账户;
224
+ 2. 设置 Owner QQ;
225
+ 3. 创建 access key 并绑定您的 Bot QQ。
226
+
227
+ ```json
228
+ {
229
+ "login": {
230
+ "uin": 1234567890,
231
+ "signer_url": "https://api.harcic.me",
232
+ "signer_token": "YOUR_ACCESS_TOKEN"
233
+ }
234
+ }
235
+ ```
236
+
237
+ 若需要接入其它签名服务,把 `signer_url` 与 `signer_token` 换成对应服务提供的信息即可。
238
+
239
+ 选了 `android_phone` 或 `android_pad` 之后,登录走的是 OICQ `0x810_9` 那套包,和 PC 的 NT 登录不是一条路。签名请求会发到 `{signer_url}/api/sign`,请求体是 `uin`、`cmd`、`seq`、`buffer`、`guid`、`version`、`qua`,返回里从 `data.sign`、`data.token`、`data.extra` 读签名。除此之外还会请求两个安卓专用接口:`/energy` 拿 TLV 544,`/get_tlv553` 拿 TLV 553。PC 端还是原来的 `{signer_url}/api/sign/sec-sign`。
240
+
241
+ 签名服务必须同时支持这三个接口,缺一个都可能登录失败;只支持 PC 那套规范的服务切到安卓协议会直接卡在签名失败。另外安卓协议不支持扫码登录,只能用密码登录。
242
+
243
+ ### 自定义 appinfo.json
244
+
245
+ `appinfo.json` 是可选文件。不用自定义协议时,不需要创建它,保持 `login.use_custom` 为 `false`,程序会用 `login.protocol` 指定的内置参数。
246
+
247
+ 如需使用自定义协议,请将下面的示例保存为本地 `appinfo.json`(或替换为目标客户端对应的参数),再在 `appconfig.json` 的
248
+ `login` 中启用自定义协议并填写该文件路径:
249
+
250
+ 注意,自定义协议版本可能与前文提到的签名服务不兼容。遇到这种情况时,需要自行准备兼容的签名服务,并在 `login.signer_url`
251
+ 和 `login.signer_token` 中填写对应配置。
252
+
253
+ ```json
254
+ {
255
+ "use_custom": true,
256
+ "appinfo_path": "./appinfo.json"
257
+ }
258
+ ```
259
+
260
+ `appinfo.json` 需要包含 Lagrange `AppInfo` 使用的字段。下面以项目当前内置的 Linux 协议参数展示完整格式;若要模拟其他客户端,请替换为与目标客户端版本匹配的参数:
261
+
262
+ ```json
263
+ {
264
+ "Os": "Linux",
265
+ "Kernel": "Linux",
266
+ "VendorOs": "linux",
267
+ "CurrentVersion": "3.2.26-46494",
268
+ "MiscBitmap": 32764,
269
+ "PtVersion": "2.0.0",
270
+ "SsoVersion": 19,
271
+ "PackageName": "com.tencent.qq",
272
+ "WtLoginSdk": "nt.wtlogin.0.0.1",
273
+ "AppId": 1600001615,
274
+ "SubAppId": 537345891,
275
+ "AppIdQrCode": 13697054,
276
+ "AppClientVersion": 46494,
277
+ "MainSigMap": 169742560,
278
+ "SubSigMap": 0,
279
+ "NtLoginType": 1,
280
+ "Qua": "V1_LNX_NQ_3.2.26_46494_GW_B"
281
+ }
282
+ ```
283
+
284
+ ### 自定义 sign provider
285
+
286
+ 除了把 `signer_url` 指向一个 HTTP 签名服务,也可以直接在本进程内签名:把实现写进 `sign_provider.py`,
287
+ 再在配置里打开开关。该文件不纳入版本控制,可以放心写入自己的算法。
288
+
289
+ ```json
290
+ {
291
+ "login": {
292
+ "use_custom_sign_provider": true,
293
+ "sign_provider_path": "./sign_provider.py",
294
+ "sign_provider_entry": "sign_provider"
295
+ }
296
+ }
297
+ ```
298
+
299
+ 入口方法是一个工厂,参数由 hiro-qq 在每次连接时传入,返回值是一个异步签名函数:
300
+
301
+ ```python
302
+ def sign_provider(sign_url, uin, guid, qua):
303
+ async def get_sign(cmd, seq, buf):
304
+ # ...
305
+ return {"sign": "<hex>", "token": "<hex>", "extra": "<hex>"}
306
+
307
+ return get_sign
308
+ ```
309
+
310
+ 几个要点:
311
+
312
+ - `sign_url` 就是 `login.signer_url` 拼上 token 后的地址,用不用由你决定;`uin`、`guid`、`qua` 是当次连接的真实值。
313
+ - hiro-qq 每次 `run()` 都会重新调用工厂,所以启动阶段拿不到设备信息也不影响;文件本身只加载一次。
314
+ - 返回值需要 `sign` / `token` / `extra` 三个十六进制串,返回空 dict 表示这个包不签名。
315
+ - 算法里如果用到 nonce,它是与 `time(NULL)` 绑定的:必须自己取当前 Unix 秒,不能缓存。
316
+ - `sign_provider_entry` 填文件中定义的方法名,可以同时放多个实现按需切换。
317
+ - 这个工厂拿不到协议名,只有 `qua`。要在里面区分 PC 和安卓,按 `qua` 是不是 `V1_AND_` 开头判断就行。
318
+
319
+ 仓库根目录已经放了一份可直接改的单文件实现(移植自 ntqq-pure-sign 的纯 Python 版),把它当起点即可。
320
+
321
+ ### 已经支持的连接类型
322
+
323
+ | 连接类型 | `type` 值 | 说明 |
324
+ |----------------|--------------------|----------------------------------------------------------------------------------------------------------|
325
+ | HTTP | `HTTP` | 在 `url` 指定的地址提供 HTTP API 服务(`GET`/`POST /:action`) |
326
+ | HTTP POST | `HTTPPost` | 将事件上报到 `url` 指定的 Webhook,可配置 `secret` 签名与 `timeout` |
327
+ | 正向 WebSocket | `ForwardWebSocket` | 在 `url` 指定的地址监听,提供 WebSocket 服务供 OneBot 客户端连接 |
328
+ | 反向 WebSocket | `ReverseWebSocket` | 主动连接 `url` 指定的服务端,可配置 `api_url`、`event_url`、`use_universal_client`、`reconnect_interval` |
329
+
330
+ 每类连接可能有额外的配置字段(如 `ReverseWebSocket` 的 `api_url`、`event_url` 等),详见 `ForwardWebsocketConfig`、
331
+ `ReverseWebsocketConfig` 等 Pydantic 模型定义。
332
+
333
+ ## 开发
334
+
335
+ Euler OneBot 使用 [uv](https://docs.astral.sh/uv/) 进行依赖与项目管理:
336
+
337
+ ```shell
338
+ uv sync
339
+ ```
340
+
341
+ ## 支持情况
342
+
343
+ <details>
344
+ <summary>API 类型</summary>
345
+
346
+ | API 名称 | 支持状态 | 类型 |
347
+ |-------------------------|----------|------|
348
+ | send_private_msg | ✅ | 标准 |
349
+ | send_group_msg | ✅ | 标准 |
350
+ | send_msg | ✅ | 标准 |
351
+ | delete_msg | ✅ | 标准 |
352
+ | get_msg | ✅ | 标准 |
353
+ | get_forward_msg | ✅ | 标准 |
354
+ | send_like | ✅ | 标准 |
355
+ | set_group_kick | ✅ | 标准 |
356
+ | set_group_ban | ✅ | 标准 |
357
+ | set_group_whole_ban | ✅ | 标准 |
358
+ | set_group_admin | ✅ | 标准 |
359
+ | set_group_card | ✅ | 标准 |
360
+ | set_group_name | ✅ | 标准 |
361
+ | set_group_leave | ✅ | 标准 |
362
+ | set_group_special_title | ✅ | 标准 |
363
+ | set_friend_add_request | ✅ | 标准 |
364
+ | set_group_add_request | ✅ | 标准 |
365
+ | get_login_info | ✅ | 标准 |
366
+ | get_stranger_info | ✅ | 标准 |
367
+ | get_friend_list | ✅ | 标准 |
368
+ | get_group_info | ✅ | 标准 |
369
+ | get_group_list | ✅ | 标准 |
370
+ | get_group_member_info | ✅ | 标准 |
371
+ | get_group_member_list | ✅ | 标准 |
372
+ | get_cookies | ✅ | 标准 |
373
+ | get_csrf_token | ✅ | 标准 |
374
+ | get_status | ✅ | 标准 |
375
+ | get_version_info | ✅ | 标准 |
376
+ | send_poke | ✅ | 扩展 |
377
+ | group_reaction | ✅ | 扩展 |
378
+ | upload_group_file | ✅ | 扩展 |
379
+ | upload_private_file | ✅ | 扩展 |
380
+ | get_group_file_url | ✅ | 扩展 |
381
+ | get_private_file_url | ✅ | 扩展 |
382
+
383
+ </details>
384
+
385
+ <details>
386
+ <summary>事件类型</summary>
387
+
388
+ | 事件名称 | 支持状态 | 类型 |
389
+ |--------------------------|----------|------|
390
+ | message.private | ✅ | 标准 |
391
+ | message.group | ✅ | 标准 |
392
+ | notice.group_upload | ✅ | 标准 |
393
+ | notice.group_admin | ✅ | 标准 |
394
+ | notice.group_decrease | ✅ | 标准 |
395
+ | notice.group_increase | ✅ | 标准 |
396
+ | notice.group_ban | ✅ | 标准 |
397
+ | notice.friend_add | ✅ | 标准 |
398
+ | notice.group_recall | ✅ | 标准 |
399
+ | notice.friend_recall | ✅ | 标准 |
400
+ | notice.notify.poke | ✅ | 标准 |
401
+ | notice.notify.lucky_king | Never | 标准 |
402
+ | notice.notify.honor | Never | 标准 |
403
+ | request.friend | ✅ | 标准 |
404
+ | request.group | ✅ | 标准 |
405
+ | meta_event.lifecycle | ✅ | 标准 |
406
+ | meta_event.heartbeat | ✅ | 标准 |
407
+ | notice.friend_upload | ✅ | 扩展 |
408
+ | notice.reaction | ✅ | 扩展 |
409
+
410
+ </details>
411
+
412
+ <details>
413
+ <summary>消息段类型</summary>
414
+
415
+ | 消息段类型 | 支持状态 | 类型 |
416
+ |------------|--------------|------|
417
+ | text | ✅ | 标准 |
418
+ | at | ✅ | 标准 |
419
+ | reply | ✅ | 标准 |
420
+ | face | ✅ | 标准 |
421
+ | poke | ✅ | 标准 |
422
+ | node | ✅ | 标准 |
423
+ | forward | ✅ | 标准 |
424
+ | image | ✅ | 标准 |
425
+ | record | ✅ | 标准 |
426
+ | video | ✅ | 标准 |
427
+ | file | ✅ Recv only | 扩展 |
428
+ | contact | ❌ | 标准 |
429
+ | location | ❌ | 标准 |
430
+ | music | ❌ | 标准 |
431
+ | rps | ✅ | 标准 |
432
+ | dice | ✅ | 标准 |
433
+ | shake | ❌ | 标准 |
434
+ | json | ✅ | 标准 |
435
+ | xml | ❌ | 标准 |
436
+ | mface | ✅ | 扩展 |
437
+ | grey_tips | ✅ Send only | 扩展 |
438
+
439
+ </details>
440
+
441
+ <details>
442
+ <summary>通信方式</summary>
443
+
444
+ | 通信方式 | 支持状态 | 类型 |
445
+ |----------------|----------|------|
446
+ | HTTP | ✅ | 标准 |
447
+ | HTTP POST | ✅ | 标准 |
448
+ | 正向 WebSocket | ✅ | 标准 |
449
+ | 反向 WebSocket | ✅ | 标准 |
450
+
451
+ </details>
452
+
453
+ ## 性能基准
454
+
455
+ 在 i5-1135G7 / 16GB 上使用 `uv run python scripts/benchmark.py` 测得:
456
+
457
+ | 场景 | 吞吐 |
458
+ |-------------------------------|--------------|
459
+ | HTTP 端到端(send_group_msg) | ~600 req/s |
460
+ | 正向 WS 请求-响应(单连接) | ~3,700 req/s |
461
+ | WS 事件推送 | ~60,000 条/s |
462
+ | 队列分发(含 SQLite 入库) | ~6,400 req/s |
463
+
464
+ 内存占用:峰值约 80 MB (benchmark 数据), 静默状态 ~= 60 MB (观察数据)
465
+
466
+ ---
467
+
468
+ [^1]: 部分环境下,安装有关依赖库可能需要额外配置 openssl 和 rust 开发环境.
@@ -0,0 +1,67 @@
1
+ [build-system]
2
+ requires = ["setuptools", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "euler-onebot"
7
+ version = "0.1.3"
8
+ description = "A OneBot v11 implementation in Python, based on lagrange-python"
9
+ readme = "readme.md"
10
+ license = "GPL-3.0-or-later"
11
+ requires-python = ">=3.11"
12
+ authors = [
13
+ { name = "HarcicYang" },
14
+ ]
15
+ keywords = ["onebot", "qq", "lagrange"]
16
+ dependencies = [
17
+ "pydantic",
18
+ "pydantic-settings",
19
+ "fastapi",
20
+ "uvicorn[standard]",
21
+ "websockets",
22
+ "python-multipart",
23
+ "httpx",
24
+ "hiro-qq>=0.2.0,<0.3.0",
25
+ "aiosqlite",
26
+ ]
27
+
28
+ [project.scripts]
29
+ "euler.onebot" = "euleronebot.cli:main"
30
+
31
+ [tool.setuptools.packages.find]
32
+ where = ["src"]
33
+ include = ["euleronebot*"]
34
+
35
+ [tool.ruff]
36
+ target-version = "py311"
37
+ line-length = 120
38
+
39
+ [tool.ruff.lint]
40
+ select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF"]
41
+
42
+ [tool.ruff.lint.per-file-ignores]
43
+ # Re-export modules: `import *` is intentional, names are resolved via `__all__`
44
+ "src/euleronebot/onebot/__init__.py" = ["F403", "F405"]
45
+ "src/euleronebot/onebot/api.py" = ["F403", "F405"]
46
+ "src/euleronebot/protocol/impl.py" = ["F403", "F405"]
47
+ # Intentional Chinese UI strings use fullwidth punctuation
48
+ "src/euleronebot/config.py" = ["RUF001"]
49
+ "src/euleronebot/utils/infomgr.py" = ["RUF001"]
50
+
51
+ [tool.pyrefly.errors]
52
+ bad-override-mutable-attribute = false
53
+
54
+
55
+ [tool.pytest.ini_options]
56
+ testpaths = ["tests"]
57
+
58
+ [dependency-groups]
59
+ build = [
60
+ "nuitka>=4.1.3",
61
+ ]
62
+ dev = [
63
+ "pytest>=9.1.1",
64
+ "ruff>=0.16.1",
65
+ "pyrefly>=0.60.0",
66
+ { include-group = "build" },
67
+ ]