搜索

[25564] 2016-10-05_如何运用Python建立你的第一个Slack聊天机器人？

文档创建者：s7ckTeam
浏览次数：4
最后更新：2025-01-19
2016-10-05_如何运用Python建立你的第一个Slack聊天机器人？ 如 何 运 用   P y t h o n   建 立 你 的 第 一 个   S l a c k   聊 天 机 器 人 ？ 原 创   j i a j i a 9 l l i n u x e r   L i n u x 中 国   2 0 1 6 - 1 0 - 0 5 本 文 导 航 - 我 们 所 需 的 工 具 - 搭 建 我 们 的 环 境 - S l a c k   实 时 消 息 传 递 （ R T M ） A P I - 获 得 我 们 聊 天 机 器 人 的   I D - 编 码 我 们 的   S t a r t e r B o t - 结 束 聊 天 机 器 人 （ B o t ） [ 1 ]   是 一 种 像   S l a c k [ 2 ]   一 样 的 实 用 的 互 动 聊 天 服 务 方 式 。 如 果 你 之 前 从 来 没 有 建 立 过 聊 天 机 器 人 ， 那 么 这 篇 文 章 提 供 了 一 个 简 单 的 入 门 指 南 ， 告 诉 你 如 何 用   P y t h o n   结 合   S l a c k   A P I [ 3 ]   建 立 你 第 一 个 聊 天 机 器 人 。 我 们 通 过 搭 建 你 的 开 发 环 境 ,   获 得 一 个   S l a c k   A P I   的 聊 天 机 器 人 令 牌 ， 并 用   P y h o n   开 发 一 个 简 单 聊 天 机 器 人 。 我 们 所 需 的 工 具 我 们 所 需 的 工 具 我 们 的 聊 天 机 器 人 我 们 将 它 称 作 为 “ S t a r t e r B o t ” ， 它 需 要   P y t h o n   和   S l a c k   A P I 。 要 运 行 我 们 的   P y t h o n   代 码 ， 我 们 需 要 ： P y t h o n   2   或 者   P y t h o n   3 [ 4 ] p i p [ 5 ]   和   v i r t u a l e n v [ 6 ]   来 处 理   P y t h o n   应 用 程 序 依 赖 关 系 [ 7 ] 一 个 可 以 访 问   A P I   的 免 费   S l a c k   账 号 [ 8 ] ， 或 者 你 可 以 注 册 一 个   S l a c k   D e v e l o p e r   H a n g o u t   t e a m [ 9 ] 。 通 过   S l a c k   团 队 建 立 的 官 方   P y t h o n   S l a c k   客 户 端 [ 1 0 ] 代 码 库 S l a c k   A P I   测 试 令 牌 [ 1 1 ] 当 你 在 本 教 程 中 进 行 构 建 时 ， S l a c k   A P I   文 档 [ 1 2 ]   是 很 有 用 的 。 本 教 程 中 所 有 的 代 码 都 放 在   s l a c k - s t a r t e r b o t [ 1 3 ]   公 共 库 里 ， 并 以   M I T   许 可 证 开 源 。 搭 建 我 们 的 环 境 搭 建 我 们 的 环 境
我 们 现 在 已 经 知 道 我 们 的 项 目 需 要 什 么 样 的 工 具 ， 因 此 让 我 们 来 搭 建 我 们 所 的 开 发 环 境 吧 。 首 先 到 终 端 上 （ 或 者   W i n d o w s 上 的 命 令 提 示 符 ） 并 且 切 换 到 你 想 要 存 储 这 个 项 目 的 目 录 。 在 那 个 目 录 里 ， 创 建 一 个 新 的   v i r t u a l e n v   以 便 和 其 他 的   P y t h o n   项 目 相 隔 离 我 们 的 应 用 程 序 依 赖 关 系 。 激 活   v i r t u a l e n v ： 你 的 提 示 符 现 在 应 该 看 起 来 如 截 图 ： 已 经 激 活 的   s t a r t e r b o t   的   v i r t u a l e n v 的 命 令 提 示 符 这 个 官 方 的   s l a c k   客 户 端   A P I   帮 助 库 是 由   S l a c k   建 立 的 ， 它 可 以 通 过   S l a c k   通 道 发 送 和 接 收 消 息 。 通 过 这 个     命 令 安 装   s l a c k c l i e n t   库 ： 当     命 令 完 成 时 ， 你 应 该 看 到 类 似 这 样 的 输 出 ， 并 返 回 提 示 符 。 1 .   v i r t u a l e n v   s t a r t e r b o t 1 .   s o u r c e   s t a r t e r b o t / b i n / a c t i v a t e p i p 1 .   p i p   i n s t a l l   s l a c k c l i e n t p i p
在 已 经 激 活 的   v i r t u a l e n v   用   p i p   安 装   s l a c k c l i e n t   的 输 出 我 们 也 需 要 为 我 们 的   S l a c k   项 目 获 得 一 个 访 问 令 牌 ， 以 便 我 们 的 聊 天 机 器 人 可 以 用 它 来 连 接 到   S l a c k   A P I 。 S l a c k   实 时 消 息 传 递 （ 实 时 消 息 传 递 （ R T M ） ） A P I S l a c k   允 许 程 序 通 过 一 个   W e b   A P I [ 1 4 ]   来 访 问 他 们 的 消 息 传 递 通 道 。 去 这 个   S l a c k   W e b   A P I   页 面 [ 1 5 ]   注 册 建 立 你 自 己 的   S l a c k 项 目 。 你 也 可 以 登 录 一 个 你 拥 有 管 理 权 限 的 已 有 账 号 。 使 用   W e b   A P I 页 面 的 右 上 角 登 录 按 钮 登 录 后 你 会 到 达   聊 天 机 器 人 用 户 页 面 [ 1 6 ] 。
定 制 聊 天 机 器 人 用 户 页 面 给 你 的 聊 天 机 器 人 起 名 为 “ s t a r t e r b o t ” 然 后 点 击   “ A d d   b o t   i n t e g r a t i o n ”   按 钮 。 添 加 一 个 b o t   i n t e g r a t i o n   并 起 名 为 “ s t a r t e r b o t ” 这 个 页 面 将 重 新 加 载 ， 你 将 看 到 一 个 新 生 成 的 访 问 令 牌 。 你 还 可 以 将 标 志 改 成 你 自 己 设 计 的 。 例 如 我 给 的 这 个 “ F u l l   S t a c k P y t h o n ” 标 志 。
为 你 的 新   S l a c k   聊 天 机 器 人 复 制 和 粘 贴 访 问 令 牌 在 页 面 底 部 点 击 “ S a v e   I n t e g r a t i o n ” 按 钮 。 你 的 聊 天 机 器 人 现 在 已 经 准 备 好 连 接   S l a c k   A P I 。 P y t h o n   开 发 人 员 的 一 个 常 见 的 做 法 是 以 环 境 变 量 输 出 秘 密 令 牌 。 输 出 的   S l a c k   令 牌 名 字 为 ： 好 了 ， 我 们 现 在 得 到 了 将 这 个   S l a c k   A P I   用 作 聊 天 机 器 人 的 授 权 。 我 们 建 立 聊 天 机 器 人 还 需 要 更 多 信 息 ： 我 们 的 聊 天 机 器 人 的   I D 。 接 下 来 我 们 将 会 写 一 个 简 短 的 脚 本 ， 从   S l a c k   A P I   获 得 该 I D 。 获 得 我 们 聊 天 机 器 人 的 获 得 我 们 聊 天 机 器 人 的   I D 这 是 最 后 写 一 些   P y t h o n   代 码 的 时 候 了 !   我 们 编 写 一 个 简 短 的   P y t h o n   脚 本 获 得   S t a r t e r B o t   的   I D   来 热 身 一 下 。 这 个   I D   基 于 S l a c k   项 目 而 不 同 。 我 们 需 要 该   I D ， 当 解 析 从   S l a c k   R T M   上 发 给   S t a r t e r B o t   的 消 息 时 ， 它 用 于 对 我 们 的 应 用 验 明 正 身 。 我 们 的 脚 本 也 会 测 试 我 们     环 境 变 量 是 否 设 置 正 确 。 建 立 一 个 命 名 为   p r i n t b o t i d . p y   的 新 文 件 ， 并 且 填 入 下 面 的 代 码 ： S L A C K _ B O T _ T O K E N 1 .   e x p o r t   S L A C K _ B O T _ T O K E N = ' 你 的   s l a c k   令 牌 粘 帖 在 这 里 ' S L A C K _ B O T _ T O K E N
3 .   5 .   7 .   我 们 的 代 码 导 入   S l a c k C l i e n t ， 并 用 我 们 设 置 的 环 境 变 量     实 例 化 它 。   当 该 脚 本 通 过   p y t h o n   命 令 执 行 时 ， 我 们 通 过 会 访 问   S l a c k   A P I   列 出 所 有 的   S l a c k   用 户 并 且 获 得 匹 配 一 个 名 字 为 “ s a t r t e r b o t ” 的   I D 。 这 个 获 得 聊 天 机 器 人 的   I D   的 脚 本 我 们 仅 需 要 运 行 一 次 。 当 它 运 行 为 我 们 提 供 了 聊 天 机 器 人 的   I D   时 ， 脚 本 会 打 印 出 简 单 的 一 行 输 出 。 在 你 的   S l a c k   项 目 中 用   P y t h o n   脚 本 打 印   S l a c k   聊 天 机 器 人 的   I D 1 .   i m p o r t   o s 2 .   f r o m   s l a c k c l i e n t   i m p o r t   S l a c k C l i e n t 4 .   B O T _ N A M E   =   ' s t a r t e r b o t ' 6 .   s l a c k _ c l i e n t   =   S l a c k C l i e n t ( o s . e n v i r o n . g e t ( ' S L A C K _ B O T _ T O K E N ' ) ) 8 .   i f   _ _ n a m e _ _   = =   " _ _ m a i n _ _ " : 9 .           a p i _ c a l l   =   s l a c k _ c l i e n t . a p i _ c a l l ( " u s e r s . l i s t " ) 1 0 .           i f   a p i _ c a l l . g e t ( ' o k ' ) : 1 1 .                   #   r e t r i e v e   a l l   u s e r s   s o   w e   c a n   f i n d   o u r   b o t 1 2 .                   u s e r s   =   a p i _ c a l l . g e t ( ' m e m b e r s ' ) 1 3 .                   f o r   u s e r   i n   u s e r s : 1 4 .                           i f   ' n a m e '   i n   u s e r   a n d   u s e r . g e t ( ' n a m e ' )   = =   B O T _ N A M E : 1 5 .                                   p r i n t ( " B o t   I D   f o r   ' "   +   u s e r [ ' n a m e ' ]   +   " '   i s   "   +   u s e r . g e t ( ' i d ' ) ) 1 6 .           e l s e : 1 7 .                   p r i n t ( " c o u l d   n o t   f i n d   b o t   u s e r   w i t h   t h e   n a m e   "   +   B O T _ N A M E ) S L A C K _ B O T _ T O K E N 1 .   p y t h o n   p r i n t _ b o t _ i d . p y
复 制 这 个 脚 本 打 印 出 的 唯 一   I D 。 并 将 该   I D   作 为 一 个 环 境 变 量     输 出 。 这 个 脚 本 仅 仅 需 要 运 行 一 次 来 获 得 聊 天 机 器 人 的   I D 。   我 们 现 在 可 以 在 我 们 的 运 行   S t a r t e r B o t   的   P y t h o n 应 用 程 序 中 使 用 这 个 I D   。 编 码 我 们 的 编 码 我 们 的   S t a r t e r B o t 现 在 我 们 拥 有 了 写 我 们 的   S t a r t e r B o t   代 码 所 需 的 一 切 。   创 建 一 个 新 文 件 命 名 为   s t a r t e r b o t . p y   ， 它 包 括 以 下 代 码 。 对     和     的 导 入 我 们 看 起 来 很 熟 悉 ， 因 为 我 们 已 经 在   t h e p r i n t b o t i d . p y   中 用 过 它 们 了 。 通 过 我 们 导 入 的 依 赖 包 ， 我 们 可 以 使 用 它 们 获 得 环 境 变 量 值 ， 并 实 例 化   S l a c k   客 户 端 。 3 .   7 .   B O T _ I D 1 .   ( s t a r t e r b o t ) $   e x p o r t   B O T _ I D = ' b o t   i d   r e t u r n e d   b y   s c r i p t ' 1 .   i m p o r t   o s 2 .   i m p o r t   t i m e 3 .   f r o m   s l a c k c l i e n t   i m p o r t   S l a c k C l i e n t o s S l a c k C l i e n t 1 .   #   s t a r t e r b o t   的   I D   作 为 一 个 环 境 变 量 2 .   B O T _ I D   =   o s . e n v i r o n . g e t ( " B O T _ I D " ) 4 .   #   常 量 5 .   A T _ B O T   =   " < @ "   +   B O T _ I D   +   " > : " 6 .   E X A M P L E _ C O M M A N D   =   " d o " 8 .   #   实 例 化   S l a c k   和   T w i l i o   客 户 端 9 .   s l a c k _ c l i e n t   =   S l a c k C l i e n t ( o s . e n v i r o n . g e t ( ' S L A C K _ B O T _ T O K E N ' ) )
该 代 码 通 过 我 们 以 输 出 的 环 境 变 量   S l a c k C l i e n t `   客 户 端 。 1 2 .   S l a c k   客 户 端 会 连 接 到   S l a c k   R T M   A P I   W e b S o c k e t ， 然 后 当 解 析 来 自   f i r e h o s e   的 消 息 时 会 不 断 循 环 。 如 果 有 任 何 发 给   S t a r t e r B o t 的 消 息 ， 那 么 一 个 被 称 作     的 函 数 会 决 定 做 什 么 。 接 下 来 添 加 两 个 函 数 来 解 析   S l a c k   的 输 出 并 处 理 命 令 。 9 .   s l a c k _ c l i e n t   =   S l a c k C l i e n t ( o s . e n v i r o n . g e t ( ' S L A C K _ B O T _ T O K E N ' ) ) S L A C K _ B O T _ T O K E N   实 例 化 1 .   i f   _ _ n a m e _ _   = =   " _ _ m a i n _ _ " : 2 .           R E A D _ W E B S O C K E T _ D E L A Y   =   1   #   1   从   f i r e h o s e   读 取 延 迟   1   秒 3 .           i f   s l a c k _ c l i e n t . r t m _ c o n n e c t ( ) : 4 .                   p r i n t ( " S t a r t e r B o t   c o n n e c t e d   a n d   r u n n i n g ! " ) 5 .                   w h i l e   T r u e : 6 .                           c o m m a n d ,   c h a n n e l   =   p a r s e _ s l a c k _ o u t p u t ( s l a c k _ c l i e n t . r t m _ r e a d ( ) ) 7 .                           i f   c o m m a n d   a n d   c h a n n e l : 8 .                                   h a n d l e _ c o m m a n d ( c o m m a n d ,   c h a n n e l ) 9 .                           t i m e . s l e e p ( R E A D _ W E B S O C K E T _ D E L A Y ) 1 0 .           e l s e : 1 1 .                   p r i n t ( " C o n n e c t i o n   f a i l e d .   I n v a l i d   S l a c k   t o k e n   o r   b o t   I D ? " ) h a n d l e _ c o m m a n d 1 .   d e f   h a n d l e _ c o m m a n d ( c o m m a n d ,   c h a n n e l ) : 2 .           " " " 3 .                   R e c e i v e s   c o m m a n d s   d i r e c t e d   a t   t h e   b o t   a n d   d e t e r m i n e s   i f   t h e y 4 .                   a r e   v a l i d   c o m m a n d s .   I f   s o ,   t h e n   a c t s   o n   t h e   c o m m a n d s .   I f   n o t , 5 .                   r e t u r n s   b a c k   w h a t   i t   n e e d s   f o r   c l a r i f i c a t i o n . 6 .           " " " 7 .           r e s p o n s e   =   " N o t   s u r e   w h a t   y o u   m e a n .   U s e   t h e   * "   +   E X A M P L E _ C O M M A N D   +  
1 3 .   2 8 .     函 数 从   S l a c k   接 受 信 息 ， 并 且 如 果 它 们 是 发 给 我 们 的   S t a r t e r B o t   时 会 作 出 判 断 。 消 息 以 一 个 给 我 们 的 聊 天 机 器 人   I D   的 直 接 命 令 开 始 ， 然 后 交 由 我 们 的 代 码 处 理 。 目 前 只 是 通 过   S l a c k   管 道 发 布 一 个 消 息 回 去 告 诉 用 户 去 多 写 一 些   P y t h o n   代 码 ! 这 是 整 个 程 序 组 合 在 一 起 的 样 子   ( 你 也 可 以   在   G i t H u b   中 查 看 该 文 件 [ 1 7 ] ） ：         r e s p o n s e   =   " N o t   s u r e   w h a t   y o u   m e a n .   U s e   t h e   * "   +   E X A M P L E _ C O M M A N D   +   8 .                                 " *   c o m m a n d   w i t h   n u m b e r s ,   d e l i m i t e d   b y   s p a c e s . " 9 .           i f   c o m m a n d . s t a r t s w i t h ( E X A M P L E _ C O M M A N D ) : 1 0 .                   r e s p o n s e   =   " S u r e . . . w r i t e   s o m e   m o r e   c o d e   t h e n   I   c a n   d o   t h a t ! " 1 1 .           s l a c k _ c l i e n t . a p i _ c a l l ( " c h a t . p o s t M e s s a g e " ,   c h a n n e l = c h a n n e l , 1 2 .                                                       t e x t = r e s p o n s e ,   a s _ u s e r = T r u e ) 1 4 .   d e f   p a r s e _ s l a c k _ o u t p u t ( s l a c k _ r t m _ o u t p u t ) : 1 5 .           " " " 1 6 .                   T h e   S l a c k   R e a l   T i m e   M e s s a g i n g   A P I   i s   a n   e v e n t s   f i r e h o s e . 1 7 .                   t h i s   p a r s i n g   f u n c t i o n   r e t u r n s   N o n e   u n l e s s   a   m e s s a g e   i s 1 8 .                   d i r e c t e d   a t   t h e   B o t ,   b a s e d   o n   i t s   I D . 1 9 .           " " " 2 0 .           o u t p u t _ l i s t   =   s l a c k _ r t m _ o u t p u t 2 1 .           i f   o u t p u t _ l i s t   a n d   l e n ( o u t p u t _ l i s t )   >   0 : 2 2 .                   f o r   o u t p u t   i n   o u t p u t _ l i s t : 2 3 .                           i f   o u t p u t   a n d   ' t e x t '   i n   o u t p u t   a n d   A T _ B O T   i n   o u t p u t [ ' t e x t ' ] : 2 4 .                                   #   返 回   @   之 后 的 文 本 ， 删 除 空 格 2 5 .                                   r e t u r n   o u t p u t [ ' t e x t ' ] . s p l i t ( A T _ B O T ) [ 1 ] . s t r i p ( ) . l o w e r ( ) ,   2 6 .                                                 o u t p u t [ ' c h a n n e l ' ] 2 7 .           r e t u r n   N o n e ,   N o n e p a r s e _ s l a c k _ o u t p u t 1 .   i m p o r t   o s 2 .   i m p o r t   t i m e 3 .   f r o m   s l a c k c l i e n t   i m p o r t   S l a c k C l i e n t
4 .   7 .   1 1 .   1 4 .   2 7 .   5 .   #   s t a r t e r b o t   的   I D   作 为 一 个 环 境 变 量 6 .   B O T _ I D   =   o s . e n v i r o n . g e t ( " B O T _ I D " ) 8 .   #   常 量 9 .   A T _ B O T   =   " < @ "   +   B O T _ I D   +   " > : " 1 0 .   E X A M P L E _ C O M M A N D   =   " d o " 1 2 .   #   实 例 化   S l a c k   和   T w i l i o   客 户 端 1 3 .   s l a c k _ c l i e n t   =   S l a c k C l i e n t ( o s . e n v i r o n . g e t ( ' S L A C K _ B O T _ T O K E N ' ) ) 1 5 .   d e f   h a n d l e _ c o m m a n d ( c o m m a n d ,   c h a n n e l ) : 1 6 .           " " " 1 7 .                   R e c e i v e s   c o m m a n d s   d i r e c t e d   a t   t h e   b o t   a n d   d e t e r m i n e s   i f   t h e y 1 8 .                   a r e   v a l i d   c o m m a n d s .   I f   s o ,   t h e n   a c t s   o n   t h e   c o m m a n d s .   I f   n o t , 1 9 .                   r e t u r n s   b a c k   w h a t   i t   n e e d s   f o r   c l a r i f i c a t i o n . 2 0 .           " " " 2 1 .           r e s p o n s e   =   " N o t   s u r e   w h a t   y o u   m e a n .   U s e   t h e   * "   +   E X A M P L E _ C O M M A N D   +   2 2 .                                 " *   c o m m a n d   w i t h   n u m b e r s ,   d e l i m i t e d   b y   s p a c e s . " 2 3 .           i f   c o m m a n d . s t a r t s w i t h ( E X A M P L E _ C O M M A N D ) : 2 4 .                   r e s p o n s e   =   " S u r e . . . w r i t e   s o m e   m o r e   c o d e   t h e n   I   c a n   d o   t h a t ! " 2 5 .           s l a c k _ c l i e n t . a p i _ c a l l ( " c h a t . p o s t M e s s a g e " ,   c h a n n e l = c h a n n e l , 2 6 .                                                       t e x t = r e s p o n s e ,   a s _ u s e r = T r u e ) 2 8 .   d e f   p a r s e _ s l a c k _ o u t p u t ( s l a c k _ r t m _ o u t p u t ) : 2 9 .           " " " 3 0 .                   T h e   S l a c k   R e a l   T i m e   M e s s a g i n g   A P I   i s   a n   e v e n t s   f i r e h o s e . 3 1 .                   t h i s   p a r s i n g   f u n c t i o n   r e t u r n s   N o n e   u n l e s s   a   m e s s a g e   i s 3 2 .                   d i r e c t e d   a t   t h e   B o t ,   b a s e d   o n   i t s   I D . 3 3 .           " " " 3 4 .           o u t p u t _ l i s t   =   s l a c k _ r t m _ o u t p u t
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理