Giters

sueprtiamo / teelebot

Python实现的Telegram Bot机器人框架

Home Page:https://ojoll.com/archives/48/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

teelebot

Python实现的Telegram Bot机器人框架，具有插件系统，插件支持热更新和热装载。

    __            __     __          __
   / /____  ___  / /__  / /_  ____  / /_
  / __/ _ \/ _ \/ / _ \/ __ \/ __ \/ __/
 / /_/  __/  __/ /  __/ /_/ / /_/ / /_
 \__/\___/\___/_/\___/_.___/\____/\__/

说明

teelebot 是Python编写的Telegram Bot框架。teelebot 具有插件系统，Bot功能以插件的形式组织，你只需要实现具有特定功能的插件，其余细节交给 teelebot 框架处理，极大地提高了Bot的开发部署效率。你可以自由地组合插件，来搭建具有特定功能的Bot。

插件请前往：官方插件仓库

推荐插件：

  • Menu - 自动生成的插件菜单

  • Uptime - 获取Bot运行状态

  • PluginCTL - 插件分群开关控制

  • PluginManagementTools - 插件包管理工具

  • Guard - 广告过滤， 使用 DFA 对消息进行过滤；入群验证码人机检测

更新日志

方法列表

Demo

环境要求

Python版本

teelebot 只支持 Python3.x，不支持Python2.x。

本项目在 Python 3.5 及以上版本测试通过。

安装

1.Pip

pip install teelebot

此方式推荐使用Python虚拟环境安装

2.Docker

# 无代理
docker run -it \
	--name teelebot \
	--restart always \
	-v /path/to/teelebot/config:/config \
	-v /path/to/teelebot/plugins:/plugins \
	ghcr.io/plutobell/teelebot:latest
	
# 有代理
docker run -it \
	--name teelebot \
	--restart always \
	--network host \
	-e http_proxy="http://ip:port" \
	-e https_proxy="http://ip:port" \
	-v /path/to/teelebot/config:/config \
	-v /path/to/teelebot/plugins:/plugins \
	ghcr.io/plutobell/teelebot:latest

Tip: 容器创建后请完善配置文件参数，然后重启容器

升级

1.Pip

pip install teelebot --upgrade

2.Docker

# 与Docker容器升级方法相同

另外，可通过 exec 指令在容器中执行命令 pip install teelebot --upgrade 进行升级

使用

一行命令启动 (Polling Mode)

请自行替换 < ... > 的内容

teelebot -c/--config <config file path> -p/--plugin <plugin path> -k/--key <bot key> -r/--root <your user id>

此命令会自动生成在Polling模式下适用的配置文件，并且，-c/--config 参数可以省略(省略将使用默认配置文件路径)。

一、运行模式

teelebot 支持以 Webhook 模式和 Polling 模式运行。生产环境推荐使用 Webhook 模式，而 Polling 则仅用于开发环境。

1、Webhook 模式

要以 Webhook 模式运行，请将配置文件字段 webhook 设置为 True ，此模式涉及的配置文件字段如下：

[config]
webhook=True
self_signed=False
cert_key=your private cert path
cert_pub=your public cert path
server_address=your server ip address or domain
server_port=your server port
local_address=webhook local address
local_port=webhook local port

self_signed 用于设置是否使用自签名证书，而 cert_key 和 cert_pub 则是你的证书路径(绝对路径)，server_address 为你的服务器公网IP, server_port 为服务器的端口(目前 telegram 官方仅支持 443, 80, 88, 8443)，local_address 为Webhook 本地监听地址， local_port 为 Webhook 本地运行的端口。

推荐搭配 nginx 使用，自签名证书生成请参考：Generating a self-signed certificate pair (PEM)

2、Polling 模式

要以 Polling 模式运行，只需要保证配置文件 webhook 字段为 False 即可。此模式最基本的配置文件如下:

[config]
key=bot key
pool_size=40
webhook=False
root_id=your user id
debug=False
plugin_dir=your plugin dir

二、运行

任意路径打开终端，输入以下命令：

  • 对于使用程序配置文件默认路径的：

    输入teelebot 回车,正常情况下你应该能看见屏幕提示机器人开始运行。

  • 对于命令行手动指定配置文件路径的：

    输入teelebot -c/--config <configure file path> 回车,正常情况下你应该能看见屏幕提示机器人开始运行。(更多指令请通过 -h/--help 查看)

可配合supervisor使用。

三、配置文件

完整的配置文件如下所示:

[config]
key=bot key
plugin_dir=your plugin dir
pool_size=40 //the thread pool size, default 40, range(1, 101)
buffer_size=16 //the buffer area size, default 16(MB)
webhook=False
self_signed=False //Optional while webhook is False
cert_key=your private cert path //Optional while webhook is False
cert_pub=your public cert path //Optional while webhook is False
server_ip=your server ip address //Optional while webhook is False
server_port=your server port //Optional while webhook is False
local_address=webhook local address //Optional while webhook is False
local_port=webhook local port //Optional while webhook is False
root_id=your user id
debug=False
drop_pending_updates=False
local_api_server=local api server address //[Optional]
updates_chat_member=False //[Optional]

在 1.13.0 及以上版本，支持自动生成配置文件。（默认为Polling模式）

1.在命令行未指定配置文件路径的情况下，会在默认配置文件路径下不存在配置文件时自动生成配置文件 config.cfg。

  • 在Linux下，会自动在用户目录下创建文件夹 .teelebot ，并生成配置文件 config.cfg

  • 在Windows下，则会在 C:\Users\<username> 目录下创建文件夹 .teelebot ，并生成配置文件 config.cfg

2.指定配置文件

Linux 和 Windows 都可在命令行通过参数手动指定配置文件路径，命令格式：

teelebot -c/--config <configure file path>

路径必须为绝对路径，此情况下也会在指定路径上不存在配置文件时自动生成配置文件 ，配置文件命名由指定的路径决定。

Tip: 自动生成的配置文件未设置这几个字段值：key、root_id、plugin_dir，key 和 root_id 为必须，但我们仍然可以通过命令行设置他们：

teelebot -c/--config <config file path> -k/--key <bot key> -r/--root <your user id>

使用以上命令会以Polling模式运行框架，而无需困扰于处理配置文件。

之后请手动设置 plugin_dir 。

插件开发指南 (以 Hello 插件为例) v1.1

一、插件结构

一个完整的 teelebot 插件应当呈现为一个文件夹，即一个Python包，以 Hello 插件为例，最基本的目录结构如下：

Hello/
  ./__init__.py
  ./Hello.py
  ./Hello_screenshot.png
  ./README.md
  ./METADATA

二、规则

命名

在构建teelebot插件中应当遵守的规则是：每个插件目录下应当存在一个与插件同名的.py 文件，比如插件 Hello 中的 Hello.py 文件，并且此文件中必须存在作为插件入口的同名函数，以插件 Hello 为例：

#file Hello/Hello.py

# -*- coding:utf-8 -*-

def Hello(bot, message):
    pass

函数 Hello() 即为插件的入口函数，参数 bot 为Bot接口库实例化对象，参数 message 用于接收消息数据。

资源路径

若要打开某个插件目录下的文件资源，需要使用的路径应当遵循以下的格式：

bot.path_converter(bot.plugin_dir + "<plugin dir name>/<resource address>")

方法 path_converter 根据操作系统转换路径格式。

三、自定义触发指令

插件指令

插件的触发指令可不同于插件名，允许自定义。以插件 Hello 为例，触发指令为 /helloworld 而不是 Hello。

修改插件目录下的 __init__.py 文件设置触发指令：

#file Hello/__init__.py

#/helloworld
#Hello World插件例子

第一行为触发指令，默认以 / 作为前缀；第二行为插件简介。

不用作插件的特殊情况

通常情况下，位于 plugins 目录下的所有包都将被识别为插件并自动加载到 teelebot 中。但在某些情况下，存在并不用作插件而只是多个插件共用包的情况，若想该包不被 teelebot 加载为插件，请将触发指令设置为 ~~ 。以 tools 共用包为例， __init__.py 文件内容如下：

#fille tools/__init__.py

#~~
#tools 包的简介

插件共用包应当直接通过import导入：

import tools

建议用作插件的包名遵守 Pascal命名法，即每个单词的首字母大写；而不用做插件的包名使用全小写的包名，每个单词之间以_ 分隔。以区分 插件包 和 非插件包 ：

- plugins
  - Menu    #插件包
  - tools   #非插件包

Tip: 插件共用包的结构也应当遵循插件结构

Inline Mode 下的插件指令

若要编写 Inline Mode 类型插件，请将触发指令前缀更改为 ?: 。

以插件 InlineModeDemo 为例，__init__.py 文件内容如下：

#file InlineModeDemo/__init__.py

#?:search:
#InlineModeDemo InlineMode插件例子

根据__init__.py 文件的触发指令，在Telegram客户端使用插件 InlineModeDemo 应遵循以下格式:

@bot_username search:<search content>

另外，也可以去掉触发指令 search: ，只保留前缀，插件 InlineModeDemo 将响应所有inline_query 消息：

#file InlineModeDemo/__init__.py

#?:
#InlineModeDemo InlineMode插件例子

此时，在Telegram客户端使用插件 InlineModeDemo 应遵循以下格式:

@bot_username <search content>

四、插件模板创建工具

在 v1.9.20_dev 及以上版本，可以通过命令行指令一键创建插件模板。

  • 1.14.1 以前的版本
teelebot -p/--plugin <plugin name>
  • 1.14.1 以后的版本
teelebot -mp/--make_plugin <plugin name>

该指令会使用框架配置文件(config.cfg)中的插件路径作为所创建插件模板的存放路径。

五、周期性任务

在 v1.11.1 及以上版本，可以创建周期性任务，功能类似循环定时器。

可获得的方法：

  • schedule.add : 添加任务
  • schedule.delete : 移除任务
  • schedule.find : 查找任务
  • schedule.clear : 清空任务池
  • schedule.status : 查看任务池状态

例：

ok, uid = bot.schedule.add(gap, event, (bot, ))
ok, uid = bot.schedule.delete(uid)
ok, uid = bot.schedule.find(uid)
ok, uid = bot.schedule.clear()
ok, uid = bot.schedule.status()

周期性任务池的大小为全局线程池的三分之一 ，线程池大小则可通过配置文件指定。

六、数据暂存器

在 v1.16.0 及以上版本，每个插件将拥有一个用于临时存储数据的暂存区，可通过以下方法对暂存区进行操作。

可获得的方法:

  • buffer.status : 获取数据暂存区的使用情况， 单位为字节
  • buffer.sizeof : 获取单个插件数据暂存区占用内存大小，单位为字节
  • buffer.read : 从暂存区读取数据，返回的数据类型为字典
  • buffer.write : 写入数据到暂存区，写入的数据类型为字典

例：

ok, buf = bot.buffer.status()
ok, buf = bot.buffer.sizeof(plugin_name="")
ok, buf = bot.buffer.read(plugin_name="")
ok, buf = bot.buffer.write(buffer=buf, plugin_name="")

所有方法的参数 plugin_name 为可选参数，默认为调用插件的名字

可通过每个插件的 __init__.py 文件控制其他插件对本插件暂存区的访问权限 ，格式如下 (读:写)：

#file Hello/__init__.py

#/helloworld
#Hello World插件例子
#True:False

在上面的配置下，其他插件可以读取 Hello 插件的暂存区，但是不能修改其暂存区。

留空的默认权限为 False:False

七、METADATA文件内容 （Metadata-version: 1.0）

在 v1.17.0 及以上版本，插件包引入了文件 METADATA ，以存储插件信息。

以Hello 插件为例， METADATA文件内容如下：

Metadata-version: 1.0
Plugin-name: Hello
Version: 1.0.0
Summary: Hello World插件例子
Home-page: https://github.com/plutobell/teelebot
Author: Pluto (github.com/plutobell)
Author-email: hi#ojoll.com (#==@)
License: GPLv3
Keywords: Hello World
Requires-teelebot: >=1.17.0
Requires-dist: 
Source: https://github.com/plutobell/teelebot-plugins

其中，Requires-dist: 为插件包的依赖（例如：requests），各个依赖间请使用英文字符 "," 进行分隔。

Tip: 此文件在使用插件模板创建工具创建插件时会自动生成

联系我

  • Email：hi#ojoll.com ( # == @ )
  • Blog: 北及
  • Telegram群组：teelebot体验群（t.me/teelebot_chat）
  • 其他：本repo 的 Issue

About

Python实现的Telegram Bot机器人框架

https://ojoll.com/archives/48/

License:GNU General Public License v3.0

Languages

Language:Python 99.8%Language:Dockerfile 0.2%