python-iotbot 1.0.0

IOTBOT SDK with python!

python-iotbot

IOTBOT SDK with python

简介

IOTBOT 是一个非常好用的 QQ 机器人框架，api 设计得也比较优雅，特别能用多种方式对接，跨平台也足够吸引人，所以花了点时间，对部分内容进行了封装，方便用 python 开发插件的朋友。

Tips: 因为本身只是对接口的封装，并没有什么实质性的亮点功能，（说白了就是体力活，）觉得还行可以 star 或者 fork 下来，添加更多功能（找人做体力活 😂)

1.0.0版本开始支持插件化, 没做太多测试，不清楚bug

不适合做游戏类功能, 因为运行过程中插件之间是混乱的

适合只需要接受指令后只需发送特定内容的功能

安装

推荐

pip install git+https://github.com/XiyaoWong/python-iotbot.git@master

或者

git clone https://github.com/XiyaoWong/python-iotbot
cd python-iotbot
python setup.py install

或者

pip install python-iotbot

快速使用

from iotbot import IOTBOT, GroupMsg

bot = IOTBOT(your_bot_qq)


@bot.on_group_msg
def group(ctx: GroupMsg):
    print(f"""
{ctx.FromNickName}在{ctx.MsgTime}的时候，发了一个类型是{ctx.MsgType}的消息，内容为：
{ctx.Content}""")
    print(ctx.get('CurrentQQ'))


bot.run()

代码很简洁

要处理好友消息和事件都是一样的做法

@bot.on_friend_msg
def friend(ctx: FriendMsg):
    pass


@bot.on_event
def event(message: dict):
    pass

其中群消息和好友消息中的ctx都是将原上报数据处理过的对象，你可以直接用.访问

事件类型暂时没有处理，因为用得比较少，为原来的字典类型。

注意：你可以使用这些装饰器注册任意多的消息接受函数, 而且都不是必须的，

必须的是参数有且只有一个

当然你也可以这样：

def group(ctx):
    pass
def group2(ctx):
    pass

bot.add_group_msg_receiver(group)
bot.add_group_msg_receiver(group2)

动作

其中封装了常见的几种方法（动作）用来发送消息

from iotbot import Action

...
action = Action(qq) 
# action = Action(); action.bind_bot(bot)
# action = Action(bot) # type(bot) == IOTBOT
# 动作和机器人实例关系并不紧密，可以在任意地方定义和使用

# 发送好友消息
action.send_friend_text_msg(ctx.FromUin, '成功')
# 发送图片
action.send_friend_pic_msg(ctx.FromUin, picUrl='https://t.cn/A6Am7xYO', flashPic=True)
...

有完善的代码提示，提供了大量参数可自行设置

插件化

要开启插件功能，只需在定义机器人时设置对应参数, 例：

from iotbot import IOTBOT, GroupMsg

bot = IOTBOT(your_bot_qq, use_plugins=True)
# 参数`plugin_dir`用来指定插件目录, 默认为`plugins`

一个插件，大概长这样

from iotbot import IOTBOT, GroupMsg, FriendMsg


# 下面三个函数名不能改，否则不会调用
# 但是都是可选项，建议把不需要用到的函数删除，节约资源

def receive_group_msg(ctx: GroupMsg):
    pass

def receive_friend_msg(ctx: FriendMsg):
    pass

def receive_events(ctx: dict):
    pass

插件文件名需以bot_开头命名

不管是手动添加还是插件形式，都是同样的receiver函数，运行起来的行为完全一致

还是麻烦？

你会发现有几段代码都是固定的，创建机器人对象，写装饰器 所以你可以这样,在命令行中

生成主体文件

>>> iotbot --help
>>> iotbot -n app -q 123456
# 或者
>>> iotbot

<<< 将创建app.py文件, 机器人QQ为：123456。是否确定？ y/N: y
<<< 创建成功~

<<< 执行如下命令：python app.py

<<< 在机器人所在的群或私聊机器人发送：.test

生成插件模板

>>> iotbot -p hello

<<< 将生成bot_hello.py，这是覆盖写操作，确定？ y/N y
<<< OK!

Thx list

golezi/pyiotqq

mcoo/iotqq-plugins-demo

少部分参考

LICENSE

MIT

CHANGELOG

0.2.3 - 2020-05-15

1. 更多action

2. 每个action除默认参数外，还可设置:

   • api_path default=/v1/LuaApiCaller
   • iot_timeout default=self.timeout=10 IOTBOT端处理允许等待的时间
   • bot_qq default=self.qq 机器人QQ号

1.0.0 - 2020-05-28

大改动

1. 插件化
2. 效率更高，不漏消息
3. 更多快捷方法
4. 更多自定义参数