Slack 机器

Slack 机器是一个简单却强大、且可扩展的 Slack 机器人框架。它不仅仅是一款机器人，更是一个能助您将 Slack 工作区打造成为 ChatOps 强国的框架。Slack 机器采用直观的插件系统，让您能够快速构建机器人，同时还能轻松实现代码的高效组织。一个插件可能看起来如下所示：

from machine.plugins.base import MachineBasePlugin
from machine.plugins.message import Message
from machine.plugins.decorators import respond_to


class DeploymentPlugin(MachineBasePlugin):
    """部署"""

    @respond_to(r"deploy (?P<application>\w+) to (?P<environment>\w+)")
    async def deploy(self, msg: Message, application, environment):
        """部署 <application> <environment>: 将应用部署到目标环境"""
        await msg.say(f"正在将 {application} 部署到 {environment}")

重大变更

已弃用对 Python 3.8 的支持（v0.38.0）

自 v0.38.0 起，我们已不再支持 Python 3.8。Python 3.8 于 2024 年 10 月 7 日正式停止维护。

功能特性

• 通过极简配置即可上手使用
• 基于 Slack 事件 API 构建，可流畅地响应半实时事件。采用 Socket 模式，因此您的机器人无需暴露在互联网中！
• 支持通过 Slack Web API 进行丰富的交互操作
• 提供高阶 API，让插件开发更加便捷
• 提供低阶 API，以实现更高的灵活性
• 基于 AsyncIO 构建，确保通过并发处理与 Slack 的通信，从而获得卓越的性能

插件 API 特性：

• 可监听并响应任意正则表达式
• 可响应斜杠命令
• 可捕获消息中的特定部分，并将其作为变量用于函数中
• 可响应频道、群组以及私信对话中的消息
• 可通过反应进行回复
• 可在讨论串中作出回应
• 可发送临时消息
• 可向任意用户发送私信
• 支持 块
• 支持 消息附件 [旧版 🏚]
• 支持 互动元素
• 支持 模态框
• 可监听并响应任何由事件 API 所支持的 Slack 事件
• 可在持久化存储中存储和检索各类数据（目前支持 Redis、DynamoDB、SQLite 以及内存存储）
• 可安排任务与消息执行
• 可发出并监听事件
• 提供插件帮助文本

即将推出

• 支持快捷键
• ... 以及更多功能

安装

您可以通过运行以下命令，将 Slack 机器添加到您的 uv 项目中：

uv add slack-machine

或者将其添加到您的 Poetry 项目中：

poetry add slack-machine

最后，您也可以使用 pip 进行安装（不推荐）：

$ pip install slack-machine

强烈建议您在 虚拟环境 中安装 slack-machine！（请参阅 Python 文档 了解如何创建虚拟环境）

使用方法

1. 在您的 Slack 机器机器人目录中创建一个文件夹：mkdir my-slack-bot && cd my-slack-bot

2. 在机器人目录中添加一个 local_settings.py 文件：touch local_settings.py

3. 在 Slack 中创建一个新的应用：https://api.slack.com/apps

4. 选择从“应用清单”中创建应用

5. 复制并粘贴以下应用清单：manifest.yaml

6. 将 Slack 应用和机器人令牌添加到您的 local_settings.py 中，如下所示：

   SLACK_APP_TOKEN = "xapp-my-app-token"
   SLACK_BOT_TOKEN = "xoxb-my-bot-token"
   

7. 使用 slack-machine 启动机器人

8. ...

9. 享受乐趣吧！

文档

您可以在此处查看 Slack 机器的官方文档：https://dondebonair.github.io/slack-machine/

快去阅读一下，学习如何正确配置 Slack 机器、编写插件，以及更多实用技巧！

此外，还有一个示例插件，充分展示了 Slack 机器的诸多功能： Slack 机器厨房插件

Slack Machine 快速上手指南

环境准备

• Python 版本：≥ 3.9（不再支持 3.8）
• 系统：Linux / macOS / Windows WSL
• 网络：可访问 Slack API（无需公网 IP，使用 Socket Mode）

安装步骤

1. 创建虚拟环境（推荐）

   python -m venv venv
   source venv/bin/activate  # Windows: venv\Scripts\activate
   

2. 安装 slack-machine
   使用 uv（最快）

   uv add slack-machine
   

   或使用 Poetry

   poetry add slack-machine
   

   或使用 pip

   pip install slack-machine
   

基本使用

1. 新建项目目录

   mkdir my-slack-bot && cd my-slack-bot
   

2. 创建配置文件

   touch local_settings.py
   

3. 在 Slack API 控制台 创建 App

   • 选择「From an app manifest」
   • 粘贴 manifest.yaml

4. 获取并写入 Token
   在 local_settings.py 中填入：

   SLACK_APP_TOKEN = "xapp-1-..."
   SLACK_BOT_TOKEN = "xoxb-..."
   

5. 启动机器人

   slack-machine
   

6. 在 Slack 中 @机器人 发送

   deploy myapp to prod
   

   机器人将回复

   Deploying myapp to prod
   

完成！更多插件开发示例见 官方文档。