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, None

def 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