349      阿裏雲  技術社區[雲棲]

如何運用 Python 建立你的第一個 Slack 聊天機器人？

聊天機器人（Bot） 是一種像 Slack 一樣的實用的互動聊天服務方式。如果你之前從來沒有建立過聊天機器人，那麼這篇文章提供了一個簡單的入門指南，告訴你如何用 Python 結合 Slack API 建立你第一個聊天機器人。

我們通過搭建你的開發環境, 獲得一個 Slack API 的聊天機器人令牌，並用 Pyhon 開發一個簡單聊天機器人。

我們所需的工具

我們的聊天機器人我們將它稱作為“StarterBot”，它需要 Python 和 Slack API。要運行我們的 Python 代碼，我們需要：

• Python 2 或者 Python 3
• pip 和 virtualenv 來處理 Python 應用程序依賴關係
• 一個可以訪問 API 的免費 Slack 賬號，或者你可以注冊一個 Slack Developer Hangout team。
• 通過 Slack 團隊建立的官方 Python Slack 客戶端代碼庫
• Slack API 測試令牌

當你在本教程中進行構建時，Slack API 文檔 是很有用的。

本教程中所有的代碼都放在 slack-starterbot 公共庫裏，並以 MIT 許可證開源。

搭建我們的環境

我們現在已經知道我們的項目需要什麼樣的工具，因此讓我們來搭建我們所的開發環境吧。首先到終端上（或者 Windows 上的命令提示符）並且切換到你想要存儲這個項目的目錄。在那個目錄裏，創建一個新的 virtualenv 以便和其他的 Python 項目相隔離我們的應用程序依賴關係。

1. virtualenv starterbot

激活 virtualenv：

1. source starterbot/bin/activate

你的提示符現在應該看起來如截圖：

已經激活的 starterbot 的 virtualenv的命令提示符

這個官方的 slack 客戶端 API 幫助庫是由 Slack 建立的，它可以通過 Slack 通道發送和接收消息。通過這個pip 命令安裝 slackclient 庫：

1. pip install slackclient

當 pip 命令完成時，你應該看到類似這樣的輸出，並返回提示符。

在已經激活的 virtualenv 用 pip 安裝 slackclient 的輸出

我們也需要為我們的 Slack 項目獲得一個訪問令牌，以便我們的聊天機器人可以用它來連接到 Slack API。

Slack 實時消息傳遞（RTM）API

Slack 允許程序通過一個 Web API 來訪問他們的消息傳遞通道。去這個 Slack Web API 頁麵 注冊建立你自己的 Slack 項目。你也可以登錄一個你擁有管理權限的已有賬號。

使用 Web API頁麵的右上角登錄按鈕

登錄後你會到達 聊天機器人用戶頁麵。

定製聊天機器人用戶頁麵

給你的聊天機器人起名為“starterbot”然後點擊 “Add bot integration” 按鈕。

添加一個bot integration 並起名為“starterbot”

這個頁麵將重新加載，你將看到一個新生成的訪問令牌。你還可以將標誌改成你自己設計的。例如我給的這個“Full Stack Python”標誌。

為你的新 Slack 聊天機器人複製和粘貼訪問令牌

在頁麵底部點擊“Save Integration”按鈕。你的聊天機器人現在已經準備好連接 Slack API。

Python 開發人員的一個常見的做法是以環境變量輸出秘密令牌。輸出的 Slack 令牌名字為SLACK_BOT_TOKEN：

1. export SLACK_BOT_TOKEN='你的 slack 令牌粘帖在這裏'

好了，我們現在得到了將這個 Slack API 用作聊天機器人的授權。

我們建立聊天機器人還需要更多信息：我們的聊天機器人的 ID。接下來我們將會寫一個簡短的腳本，從 Slack API 獲得該 ID。

獲得我們聊天機器人的 ID

這是最後寫一些 Python 代碼的時候了! 我們編寫一個簡短的 Python 腳本獲得 StarterBot 的 ID 來熱身一下。這個 ID 基於 Slack 項目而不同。

我們需要該 ID，當解析從 Slack RTM 上發給 StarterBot 的消息時，它用於對我們的應用驗明正身。我們的腳本也會測試我們 SLACK_BOT_TOKEN 環境變量是否設置正確。

建立一個命名為 printbotid.py 的新文件，並且填入下麵的代碼：

1. import os
2. from slackclient import SlackClient
4. BOT_NAME = 'starterbot'
6. slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))
8. if __name__ == "__main__":
9. api_call = slack_client.api_call("users.list")
10. if api_call.get('ok'):
11. # retrieve all users so we can find our bot
12. users = api_call.get('members')
13. for user in users:
14. if 'name' in user and user.get('name') == BOT_NAME:
15. print("Bot ID for '" + user['name'] + "' is " + user.get('id'))
16. else:
17. print("could not find bot user with the name " + BOT_NAME)

我們的代碼導入 SlackClient，並用我們設置的環境變量 SLACK_BOT_TOKEN 實例化它。 當該腳本通過 python 命令執行時，我們通過會訪問 Slack API 列出所有的 Slack 用戶並且獲得匹配一個名字為“satrterbot”的 ID。

這個獲得聊天機器人的 ID 的腳本我們僅需要運行一次。

1. python print_bot_id.py

當它運行為我們提供了聊天機器人的 ID 時，腳本會打印出簡單的一行輸出。

在你的 Slack 項目中用 Python 腳本打印 Slack 聊天機器人的 ID

複製這個腳本打印出的唯一 ID。並將該 ID 作為一個環境變量 BOT_ID 輸出。

1. (starterbot)$ export BOT_ID='bot id returned by script'

這個腳本僅僅需要運行一次來獲得聊天機器人的 ID。 我們現在可以在我們的運行 StarterBot 的 Python應用程序中使用這個 ID 。

編碼我們的 StarterBot

現在我們擁有了寫我們的 StarterBot 代碼所需的一切。 創建一個新文件命名為 starterbot.py ，它包括以下代碼。

1. import os
2. import time
3. from slackclient import SlackClient

對 os 和 SlackClient 的導入我們看起來很熟悉，因為我們已經在 theprintbotid.py 中用過它們了。

通過我們導入的依賴包，我們可以使用它們獲得環境變量值，並實例化 Slack 客戶端。

1. # starterbot 的 ID 作為一個環境變量
2. BOT_ID = os.environ.get("BOT_ID")
4. # 常量
5. AT_BOT = "<@" + BOT_ID + ">:"
6. EXAMPLE_COMMAND = "do"
8. # 實例化 Slack 和 Twilio 客戶端
9. slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))

該代碼通過我們以輸出的環境變量 SLACK_BOT_TOKEN 實例化SlackClient` 客戶端。

1. if __name__ == "__main__":
2. READ_WEBSOCKET_DELAY = 1 # 1 從 firehose 讀取延遲 1 秒
3. if slack_client.rtm_connect():
4. print("StarterBot connected and running!")
5. while True:
6. command, channel = parse_slack_output(slack_client.rtm_read())
7. if command and channel:
8. handle_command(command, channel)
9. time.sleep(READ_WEBSOCKET_DELAY)
10. else:
11. print("Connection failed. Invalid Slack token or bot ID?")

Slack 客戶端會連接到 Slack RTM API WebSocket，然後當解析來自 firehose 的消息時會不斷循環。如果有任何發給 StarterBot 的消息，那麼一個被稱作 handle_command 的函數會決定做什麼。

接下來添加兩個函數來解析 Slack 的輸出並處理命令。

1. def handle_command(command, channel):
2. """
3. Receives commands directed at the bot and determines if they
4. are valid commands. If so, then acts on the commands. If not,
5. returns back what it needs for clarification.
6. """
7. response = "Not sure what you mean. Use the *" + EXAMPLE_COMMAND + \
8. "* command with numbers, delimited by spaces."
9. if command.startswith(EXAMPLE_COMMAND):
10. response = "Sure...write some more code then I can do that!"
11. slack_client.api_call("chat.postMessage", channel=channel,
12. text=response, as_user=True)
14. def parse_slack_output(slack_rtm_output):
15. """
16. The Slack Real Time Messaging API is an events firehose.
17. this parsing function returns None unless a message is
18. directed at the Bot, based on its ID.
19. """
20. output_list = slack_rtm_output
21. if output_list and len(output_list) > 0:
22. for output in output_list:
23. if output and 'text' in output and AT_BOT in output['text']:
24. # 返回 @ 之後的文本，刪除空格
25. return output['text'].split(AT_BOT)[1].strip().lower(), \
26. output['channel']
27. return None, None

parse_slack_output 函數從 Slack 接受信息，並且如果它們是發給我們的 StarterBot 時會作出判斷。消息以一個給我們的聊天機器人 ID 的直接命令開始，然後交由我們的代碼處理。目前隻是通過 Slack 管道發布一個消息回去告訴用戶去多寫一些 Python 代碼!

這是整個程序組合在一起的樣子 (你也可以 在 GitHub 中查看該文件）：

1. import os
2. import time
3. from slackclient import SlackClient
5. # starterbot 的 ID 作為一個環境變量
6. BOT_ID = os.environ.get("BOT_ID")
8. # 常量
9. AT_BOT = "<@" + BOT_ID + ">:"
10. EXAMPLE_COMMAND = "do"
12. # 實例化 Slack 和 Twilio 客戶端
13. slack_client = SlackClient(os.environ.get('SLACK_BOT_TOKEN'))
15. def handle_command(command, channel):
16. """
17. Receives commands directed at the bot and determines if they
18. are valid commands. If so, then acts on the commands. If not,
19. returns back what it needs for clarification.
20. """
21. response = "Not sure what you mean. Use the *" + EXAMPLE_COMMAND + \
22. "* command with numbers, delimited by spaces."
23. if command.startswith(EXAMPLE_COMMAND):
24. response = "Sure...write some more code then I can do that!"
25. slack_client.api_call("chat.postMessage", channel=channel,
26. text=response, as_user=True)
28. def parse_slack_output(slack_rtm_output):
29. """
30. The Slack Real Time Messaging API is an events firehose.
31. this parsing function returns None unless a message is
32. directed at the Bot, based on its ID.
33. """
34. output_list = slack_rtm_output
35. if output_list and len(output_list) > 0:
36. for output in output_list:
37. if output and 'text' in output and AT_BOT in output['text']:
38. # 返回 @ 之後的文本，刪除空格
39. return output['text'].split(AT_BOT)[1].strip().lower(), \
40. output['channel']
41. return None, None
43. if __name__ == "__main__":
44. READ_WEBSOCKET_DELAY = 1 # 1 second delay between reading from firehose
45. if slack_client.rtm_connect():
46. print("StarterBot connected and running!")
47. while True:
48. command, channel = parse_slack_output(slack_client.rtm_read())
49. if command and channel:
50. handle_command(command, channel)
51. time.sleep(READ_WEBSOCKET_DELAY)
52. else:
53. print("Connection failed. Invalid Slack token or bot ID?")

現在我們的代碼已經有了，我們可以通過 python starterbot.py 來運行我們 StarterBot 的代碼了。

當 StarterBot 開始運行而且連接到 API 的輸出通道

在 Slack 中創建新通道，並且把 StarterBot 邀請進來，或者把 StarterBot 邀請進一個已經存在的通道中。

在 Slack 界麵創建一個新通道並且邀請 StarterBot

現在在你的通道中給 StarterBot 發命令。

在你的 Slack 通道裏給你的 StarterBot 發命令

如果你從聊天機器人得到的響應中遇見問題，你可能需要做一個修改。正如上麵所寫的這個教程，其中一行AT_BOT = "<@" + BOT_ID + ">:"，在“@starter”（你給你自己的聊天機器人起的名字）後需要一個冒號。從 AT_BOT 字符串後麵移除:。Slack 似乎需要在@ 一個人名後加一個冒號，但這好像是有些不協調的。

結束

好吧，你現在已經獲得一個簡易的聊天機器人，你可以在代碼中很多地方加入你想要創建的任何特性。

原文發布時間為：2016-10-04

本文來自雲棲社區合作夥伴“Linux中國”

最後更新：2017-06-06 16:02:40

  上一篇：  awk 係列：如何使用 awk 語言編寫腳本

  下一篇：  使用 Elasticsearch 和 cAdvisor 監控 Docker 容器