如何将通过HTTP POST接收的数据从Python Flask脚本传递到单独的Python脚本进行处理?

时间:2017-02-21 21:07:48

标签: python python-2.7 flask slack-api slack

好吧,伙计们,所以这就是我的问题。

我正在开发一个带有打包机器人的Slack应用程序,允许用户在Slack中玩游戏。我已经成功构建了机器人并根据API guidelines将其与应用程序打包在一起。一旦我发现了Interactive Messages功能,我决定实现所述功能,以便更加用户友好地使用游戏。

交互式消息功能允许您使用按钮发布消息,用户可以单击该按钮来调用操作。我的机器人脚本,我们称之为bot.py,提示用户(使用Slack chat.postMessage功能)包含一些消息,可以从中选择。这个脚本有一个类(我知道它应该更加模块化,但所有时间都很快),它打开了一个通过Slack RTM API进行通信的Web套接字。因此,当脚本运行时,它始终是" listen"对于来自频道中用户的命令,如下所示:@botname command。脚本的一部分调用了这个"总是在监听"州看起来像这样:

#bot.py
...
if slack_client.rtm_connect():
        print("MYBOT v1.0 connected and running!")
        while True:
            command, channel, user = self.parse_slack_output(slack_client.rtm_read())
            if command and channel:
                if channel not in self.channel_ids_to_name.keys():
                    #this (most likely) means that this channel is a PM with the bot
                    self.handle_private_message(command, user)
                else:
                    self.handle_command(command, channel, user)
            time.sleep(READ_WEBSOCKET_DELAY)
    else:
        print("Connection failed. Invalid Slack token or bot ID?")

这一切都很好。现在,让我们说用户已经使用命令成功创建游戏实例并开始播放。在某个时刻,系统会提示用户输入特朗普套装:

#bot.py
...
attachments =[{
"title":"Please select index for trump suit:",
"fallback":"Your interface does not support interactive messages.",
"callback_id":"prompt_trump_suit", 
"attachment_type":"default", 
"actions":
        [{"name":"diamonds","text":":diamonds:","type":"button","value":"0"},
        {"name":"clubs","text":":clubs:","type":"button","value":"1"},
        {"name":"hearts","text":":hearts:","type":"button","value":"2"},
        {"name":"spades","text":":spades:","type":"button","value":"3"}]
}]
slack.chat.post_message(
        channel=player_id,
        as_user=True,
        attachments=attachments
        )

互动讯息looks like this。单击此消息中的一个按钮的操作通过HTTP POST将有效负载发送到Web服务器。我在项目中的另一个脚本(我们称之为app.py)是一个Flask脚本,当用户单击其中一个按钮时,该脚本成功接收此POST请求。接收POST请求的脚本部分如下所示:

#app.py
...
# handles interactive button responses for mybot
@app.route('/actions', methods=['POST'])
def inbound():
    payload = request.form.get('payload')
    data = json.loads(payload)
    token = data['token']
    if token == SLACK_VERIFICATION_TOKEN:
        print 'TOKEN is good!'
        response_url = data['response_url']
        channel_info = data['channel']
        channel_id = channel_info['id']
        user_info = data['user']
        user_id = user_info['id']
        user_name = user_info['name']
        actions = data['actions'][0]
        value = actions['value']
        print 'User sending message: ',user_name
        print "Value received: ",value
    return Response(), 200

单击该按钮时,我得到预期的输出:

TOKEN is good!
User sending message:  my_username
Value received:  3

所以到目前为止一切都很成功。现在,我想要做的是获取POST信息并使用它来调用处理特朗普套装选择的bot.py脚本中的函数。问题是,如果我要调用该函数,让我们调用它handle_trump_suit_selection(),我首先必须在Bot()文件中实例化一个app.py对象,这当然是不会按预期工作,因为该函数将使用新的Bot()实例调用,因此不会与当前游戏处于相同的状态。

那么如何才能将POST信息恢复到Bot()中所需的bot.py实例以进行进一步处理?我是Python的OOP新手,特别是Flask和Slack API的新手,所以对我来说很容易;)。

提前致谢。

1 个答案:

答案 0 :(得分:1)

伟大的成功!

<强> TL; DR: 基本上,解决方案是创建一个Celery任务,使用Slack Events API从Flask应用程序实例化bot实例。您将任务设置为在输入所需输入后启动,立即将所需的Response(200)返回Slack,同时启动bot脚本(启动RTM API Web套接字)并行启动。

细节: 因此,如上所述,事实证明所需要的是a queuing service of some sort。我最终选择CeleryHeroku(我主持Slack应用程序)及其易于理解的文档集成相对容易。

以这种方式开发Slack应用程序需要设置并使用Slack Events API从发布消息的Slack通道接收命令(&#34;播放my_game&#34;在此示例中)。程序的app(app.py)部分侦听此事件,当输入与您正在查找的内容匹配时,它会并行启动Celery任务(在tasks.py中,实例化Bot()本例中的bot.py实例)。 :)现在,机器人可以使用Slack RTM API和Slack Events API进行侦听和响应。这允许您在Slack框架内构建丰富的应用程序/服务。

如果您要设置类似的东西,下面是我的项目布局和重要的代码详细信息。随意使用它们作为模板。

项目布局:

  • project_name_folder
    • app_folder
      • static_folder
      • templates_folder
      • __初始化__。PY
      • my_app.py
      • bot.py
      • tasks.py
    • Procfile
    • requirements.txt

<强> __ INIT __ PY:

from celery import Celery
app = Celery('tasks')
import os
app.conf.update(BROKER_URL=os.environ['RABBITMQ_BIGWIG_URL']) # Heroku Celery broker

<强> my_app.py:

from flask import Flask, request, Response, render_template
import app
from app import tasks

app = Flask(__name__)

@app.route('/events', methods=['POST'])
def events():
"""
Handles the inbound event of a post to the main Slack channel
"""
  data = json.loads(request.data)
  try:
    for k, v in data['event'].iteritems():
      ts = data['event']['ts']
      channel = data['event']['channel']
      user_id = data['event']['user']
      team_id = data['team_id']

      if 'play my_game' in str(v):
        tasks.launch_bot.delay(user_id, channel, ts, team_id) # launch the bot in parallel
        return Response(), 200
  except Exception as e:
    raise

<强> bot.py:

from slackclient import SlackClient
class Bot():
  def main():
    # opening the Slack web-socket connection
    READ_WEBSOCKET_DELAY = 1  # 1 second delay between reading from firehose
    if self.slack_client.rtm_connect():
      while True:
        command, channel, user, ts = self.parse_slack_output()
          if command and channel:
            if channel not in self.channel_ids_to_name.keys():
              # this (most likely) means that this channel is a PM with the bot
              self.handle_private_message(command, user, ts)
            else:
              self.handle_command(command, channel, user, ts)
          time.sleep(READ_WEBSOCKET_DELAY)

<强> tasks.py:

import bot
from bot import Bot
from app import app

@app.task
def launch_bot(user_id, channel, ts, team_id):
'''
Instantiates the necessary objects to play a game

Args:
        [user_id] (str) The id of the user from which the command was sent
        [channel] (str) The channel the command was posted in
        [ts] (str) The timestamp of the command

'''
  print "launch_bot(user_id,channel)"
  app.control.purge()
  bot = Bot()
  bot.initialize(user_id, channel)
  bot.main()

Procfile(如果使用Heroku):

web: gunicorn --pythonpath app my_app:app
worker: celery -A app.tasks worker -B --loglevel=DEBUG

如果您有任何问题,请告诉我。这花了我一点时间才弄明白,如果你正在敲打这个,我很乐意帮助你。