python创建slack bot

2024-03-26 11:40
文章标签 python 创建 slack bot

本文主要是介绍python创建slack bot,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

搭建环境:这边使用的是Python3

(1)使用vistualenv 创建一个与其他python项目隔离的环境

virtualenv starterbot

(2)激活virtualenv

source starterbot/bin/activate

(3)安装slackclient

Slack构建的官方API帮助程序库可以发送和接收来自Slack频道的消息

pip3 install slackclient

(4)登录slack官网,注册一个账号,戳账号注册 

(5)注册之后来到  戳slackAPI   选择 start building->create a slack app

还需要创建一个Slack App来为你的机器人接收一个API令牌。使用xxx(按照喜好取名)作为你的应用程序名称。如果你登录了多个工作区,请从下拉列表中选择一个开发工作区



(6)填入app的名字,和之前注册slack加入的workspace


(7)create App之后,进入app的配置页面


(8)我们希望我们的Starter Bot像您团队中的任何其他用户一样出现 - 它将参与渠道,小组和DM中的对话。在Slack App中,这被称为bot用户,我们通过在“功能”部分下选择“Bot Users”来设置它。点击“Add a Bot User”后,您应该选择一个显示名称,选择一个默认的用户名,并通过点击“添加Bot用户”保存您的选择


(9)“Add Bot User”之后,回到 Settings->Install App 把应用程序安装到我们的开发工作区中。一旦安装了该应用程序,它将显示一个bot用户oauth访问令牌以作为bot用户进行身份验证


(10)将秘密令牌作为环境变量导出。回到终端中,导出Slack令牌,名称为SLACK_BOT_TOKEN

export SLACK_BOT_TOKEN='your bot user access token here'

现在我们被授权使用Slack RTM和Web API作为bot用户

开始编码

(1)创建一个名为flowerBot.py的文件,文件内先引入四个库

import os
import time
import re
from slackclient import SlackClient

(2)实例化SlackClient并使用刚才export出来的SLACK_BOT_TOKEN

#创建一个SlackClient的实例,并获取之前export出来的SLACK_BOT_TOKEN
slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))#在bot启动之后,会获得一个userId,先初始化
starterbot_id = None#以下常量备用
RTM_READ_DELAY = 1    #RTM实时通讯,读完消息后,一秒延迟
EXAMPLE_COMMAND = "do"
MENTION_REGEX = "^<@(|[WU].+?)>(.*)"    # @xxx 使用到的正则表达式

(3)书写main函数

if __name__ == "__main__":#使用rtm_connect方法,启动bot;一旦连接成功后,会调用web api方法 (auth.test)去找到bot的user ID#每个bot在当前的app内都有属于自己的user ID,存储这个user ID 会帮助程序理解是谁在一个会话里提到了他if slack_client.rtm_connect(with_team_state=False):print("Starter Bot connected and running!")starterbot_id = slack_client.api_call("auth.test")["user_id"]while True:#对于每个读取的事件,该parse_bot_commands()函数确定事件是否包含Bot的命令。如果是,那么command将包含一个值,#该handle_command()函数决定如何处理该命令command, channel = parse_bot_commands(slack_client.rtm_read())if command:handle_command(command, channel)time.sleep(RTM_READ_DELAY)else:print("Connection failed. Exception traceback printed above.")

(4)写方法

parse_bot_commands()函数从Slack获取事件并确定它们是否是指向Starter Bot的命令。我们的机器人会遇到很多 事件类型,但为了查找命令我们只想考虑 消息事件消息事件也有子类型,但是我们想要查找的命令没有定义任何子类型。该函数通过检查这些属性过滤出无趣的事件。现在我们知道该事件代表了带有一些文本的消息,但我们想要了解文本中是否提到了Starter Bot。parse_direct_mention() 函数将从消息文本开始提到,然后我们将它与我们之前存储的Starter Bot的用户ID进行比较。如果它们相同,那么我们知道这是一个bot命令,并返回带有通道ID的命令文本。

parse_direct_mentions()函数使用正则表达式来确定消息开头是否提及用户它返回用户ID和剩余的消息(None, None如果没有发现任何提及)。

最后一个功能handle_command()就是在将来您将添加Starter Bot的所有有趣命令,幽默和个性。目前,它只有一个示例命令:do如果该命令以已知命令开始,则它将具有适当的响应。如果不是,则使用默认响应。通过调用chat.postMessage通道Web API方法将响应发送回Slack 


def parse_bot_commands(slack_events):"""解析来自Slack RTM API的事件列表以查找bot命令,如果找到了bot命令,则此函数返回一个命令和通道的元组,如果未找到,则此函数返回无。"""for event in slack_events:if event["type"] == "message" and not "subtype" in event:user_id, message = parse_direct_mention(event["text"])if user_id == starterbot_id:return message, event["channel"]return None, Nonedef parse_direct_mention(message_text):"""在消息文本中查找直接提及(在开头提及)并返回提到的用户ID。如果没有直接提及,则返回None"""matches = re.search(MENTION_REGEX, message_text)# 所述第一组包含的用户名,该第二组包含其余消息print('matches.group(1)', matches.group(1))print('matches.group(2).strip()', matches.group(2).strip())return (matches.group(1), matches.group(2).strip()) if matches else (None, None)def handle_command(command, channel):"""如果命令已知,则执行机器人命令"""# 默认响应是用户的帮助文本default_response = "Not sure what you mean. Try *{}*.".format(EXAMPLE_COMMAND)# 查找并执行给定的命令,填充响应response = None# 这是您开始执行更多命令的地方!if command.startswith(EXAMPLE_COMMAND):response = "Sure...write some more code then I can do that!"# 将响应发送回通道slack_client.api_call("chat.postMessage",channel=channel,text=response or default_response)

(5)整体

以上自己拼一下吧,哈哈哈

运行这个python文件,出现 Starter Bot connected and running! 说明就成功了

原文参照:https://www.fullstackpython.com/blog/build-first-slack-bot-python.html



这篇关于python创建slack bot的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/848388

相关文章

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中反转字符串的常见方法小结

《Python中反转字符串的常见方法小结》在Python中,字符串对象没有内置的反转方法,然而,在实际开发中,我们经常会遇到需要反转字符串的场景,比如处理回文字符串、文本加密等,因此,掌握如何在Pyt... 目录python中反转字符串的方法技术背景实现步骤1. 使用切片2. 使用 reversed() 函

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

Python中你不知道的gzip高级用法分享

《Python中你不知道的gzip高级用法分享》在当今大数据时代,数据存储和传输成本已成为每个开发者必须考虑的问题,Python内置的gzip模块提供了一种简单高效的解决方案,下面小编就来和大家详细讲... 目录前言:为什么数据压缩如此重要1. gzip 模块基础介绍2. 基本压缩与解压缩操作2.1 压缩文