Tsugu Python Frontend
Project description
Tsugu Python Frontend
Python 编写的 Tsugu 前端模块
实现
- 自然语言输入 -> 返回结果
- 独立路由输入 -> 返回结果
部分支持
- 本地数据库 (sqlite3)
- 远程数据库 (客户端)
- 配置项 (基础配置、代理、命令别名 等)
安装
安装 tsugu 模块
pip install tsugu
后端需求
- 出图:需要支持
v2 API
(2024.2.28日以后的后端版本) - 用户数据:需要一个启用了数据库的后端,需要支持
v2 API
后端设置可以不同,默认全部设置为公共后端。
测试与调用
调用 tsugu.handler
handler
是tsugu
的一个同步函数,用于直接处理用户输入的自然语言并返回查询结果:
import tsugu
# 四个参数,分别意味着 消息内容 用户id 平台 频道id
for i in tsugu.handler(message='查卡 ars 1x', user_id='1528593481', platform='red', channel_id='666808414'):
print('文本: ',i) if isinstance(i, str) else None
print(f"[图片]") if isinstance(i, bytes) else None
在常用的qqbot中,群号就是
channel_id
。
当你使用QQ号作为user_id
时,platform
可以填写red
。
- 异步框架下,可以使用
run_in_executor
方法:
未来会支持异步版本
run_in_executor 一辈子吧
如果你方便使用 base64,handler_old
方法或许会更好:
import tsugu
for i in tsugu.handler_old(message='查卡 ars 1x', user_id='1528593481', platform='red', channel_id='666808414'):
print('文本: ',i) if i['type'] == 'text' else None
print(f"[图片]") if i['type'] == 'base64' else None
使用本地数据库
import tsugu
tsugu.database(path="./data.db")
此操作会自动创建或使用本地数据库为 tsugu.bot 提供用户数据。
远程数据库将不使用。
使用配置文件
import tsugu
tsugu.config.reload_from_json('./config.json')
如果不存在,会创建默认配置文件。
注意,不清楚的配置项请不要更改,更改配置项可能会导致不可预知的错误。
- 你也可以直接更改配置,但不推荐:
import tsugu
# 更改的后端地址。
tsugu.config.backend = "http://127.0.0.0.1:3000"
# 添加关闭抽卡模拟的群号。
tsugu.config.ban_gacha_simulate_group_data = ["114514", "1919810"]
使用 tsugu.router
路由与内部方法
- 如果想自己进行自然语言处理,你可以使用单独的路由:
import tsugu
# 获取用户数据
reply = tsugu.router.get_user_data("red", "1234567890")
# 查卡
reply = tsugu.router.card("红 ksm", [0, 3], 5)
# 设置玩家车牌转发
reply = tsugu.router.set_car_forward("red", "1234567890", True)
- 此外还暴露了一些内部方法,需要可以使用:
import tsugu
tsugu.interior_local_method.bind_player_verification("red", "1234567890", True)
tsugu.interior_remote_method.bind_player_verification("red", "1234567890", 0, '1000011232', True)
tsugu.interior_local_method.submit_car_number_msg("123456 大分q1", "1234567890", "red")
相对应登录端
部署方式 | 传送门 |
---|---|
lpt 登陆端部署 |
客服ano酱指导(这里可以点击)
注意,如果你不知道什么是BanGDream,请不要随意加群
本群还是欢迎加群的(
BanGDreamBot开发聊天群
温馨的聊天环境~
更新
pip install tsugu --upgrade
使用官方源安装
pip install tsugu --index-url https://pypi.org/simple/
使用清华源安装(可能不能即使更新)
pip install tsugu --index-url https://pypi.tuna.tsinghua.edu.cn/simple
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tsugu-0.6.1.tar.gz
(19.5 kB
view hashes)
Built Distribution
tsugu-0.6.1-py3-none-any.whl
(21.6 kB
view hashes)