web-dev-qa-db-fra.com

Créer une tâche asynchrone dans Flask

J'écris une application dans Flask, qui fonctionne très bien sauf que WSGI est synchrone et bloquant. J'ai une tâche en particulier qui appelle une API tierce et cette tâche peut prendre plusieurs minutes. Je voudrais faire cet appel (c'est en fait une série d'appels) et le laisser courir. tandis que le contrôle est rendu à Flask.

Ma vue ressemble à:

@app.route('/render/<id>', methods=['POST'])
def render_script(id=None):
    ...
    data = json.loads(request.data)
    text_list = data.get('text_list')
    final_file = audio_class.render_audio(data=text_list)
    # do stuff
    return Response(
        mimetype='application/json',
        status=200
    )

Maintenant, ce que je veux faire est d'avoir la ligne

final_file = audio_class.render_audio()

lance et fournit un rappel à exécuter lorsque la méthode retourne, alors que Flask peut continuer à traiter les demandes. C’est la seule tâche dont j’ai besoin Flask pour exécuter de manière asynchrone, et je voudrais quelques conseils sur la meilleure façon de mettre en œuvre cela.

J'ai examiné Twisted et Klein, mais je ne suis pas sûr qu'ils soient exagérés, car Threading suffirait peut-être. Ou peut-être que le céleri est un bon choix pour cela?

pythonasynchronousflask
54
Darwin Tech

Je voudrais utiliser Céleri pour gérer la tâche asynchrone pour vous. Vous aurez besoin d'installer un courtier pour servir de file d'attente (RabbitMQ et Redis sont recommandés).

app.py:

from flask import Flask
from celery import Celery

broker_url = 'amqp://guest@localhost'          # Broker URL for RabbitMQ task queue

app = Flask(__name__)    
celery = Celery(app.name, broker=broker_url)
celery.config_from_object('celeryconfig')      # Your celery configurations in a celeryconfig.py

@celery.task(bind=True)
def some_long_task(self, x, y):
    # Do some long task
    ...

@app.route('/render/<id>', methods=['POST'])
def render_script(id=None):
    ...
    data = json.loads(request.data)
    text_list = data.get('text_list')
    final_file = audio_class.render_audio(data=text_list)
    some_long_task.delay(x, y)                 # Call your async task and pass whatever necessary variables
    return Response(
        mimetype='application/json',
        status=200
    )

Exécutez votre application Flask) et démarrez un autre processus pour exécuter votre travailleur du céleri.

$ celery worker -A app.celery --loglevel=debug

Je voudrais aussi me référer à la rédaction de de Miguel Gringberg pour un guide plus détaillé sur l’utilisation du céleri avec flacon.

68
Connie

Le filetage est une autre solution possible. Bien que la solution basée sur le céleri soit préférable pour les applications à grande échelle, si vous ne vous attendez pas à un trafic excessif sur le noeud final en question, le threading est une alternative viable.

Cette solution est basée sur PyCon 2016 de Miguel Grinberg Flask lors de la présentation de Scale , en particulier diapositive 41 dans son diaporama. His le code est également disponible sur github pour ceux intéressés par la source originale.

Du point de vue de l'utilisateur, le code fonctionne comme suit:

  1. Vous appelez le noeud final qui exécute la tâche de longue durée.
  2. Ce noeud final renvoie 202 Accepted avec un lien pour vérifier le statut de la tâche.
  3. Les appels à la liaison de statut renvoient 202 pendant que le processus est toujours en cours d'exécution et renvoient 200 (et le résultat) une fois la tâche terminée.

Pour convertir un appel api en tâche de fond, ajoutez simplement le décorateur @async_api.

Voici un exemple entièrement contenu:

from flask import Flask, g, abort, current_app, request, url_for
from werkzeug.exceptions import HTTPException, InternalServerError
from flask_restful import Resource, Api
from datetime import datetime
from functools import wraps
import threading
import time
import uuid

tasks = {}

app = Flask(__name__)
api = Api(app)


@app.before_first_request
def before_first_request():
    """Start a background thread that cleans up old tasks."""
    def clean_old_tasks():
        """
        This function cleans up old tasks from our in-memory data structure.
        """
        global tasks
        while True:
            # Only keep tasks that are running or that finished less than 5
            # minutes ago.
            five_min_ago = datetime.timestamp(datetime.utcnow()) - 5 * 60
            tasks = {task_id: task for task_id, task in tasks.items()
                     if 'completion_timestamp' not in task or task['completion_timestamp'] > five_min_ago}
            time.sleep(60)

    if not current_app.config['TESTING']:
        thread = threading.Thread(target=clean_old_tasks)
        thread.start()


def async_api(wrapped_function):
    @wraps(wrapped_function)
    def new_function(*args, **kwargs):
        def task_call(flask_app, environ):
            # Create a request context similar to that of the original request
            # so that the task can have access to flask.g, flask.request, etc.
            with flask_app.request_context(environ):
                try:
                    tasks[task_id]['return_value'] = wrapped_function(*args, **kwargs)
                except HTTPException as e:
                    tasks[task_id]['return_value'] = current_app.handle_http_exception(e)
                except Exception as e:
                    # The function raised an exception, so we set a 500 error
                    tasks[task_id]['return_value'] = InternalServerError()
                    if current_app.debug:
                        # We want to find out if something happened so reraise
                        raise
                finally:
                    # We record the time of the response, to help in garbage
                    # collecting old tasks
                    tasks[task_id]['completion_timestamp'] = datetime.timestamp(datetime.utcnow())

                    # close the database session (if any)

        # Assign an id to the asynchronous task
        task_id = uuid.uuid4().hex

        # Record the task, and then launch it
        tasks[task_id] = {'task_thread': threading.Thread(
            target=task_call, args=(current_app._get_current_object(),
                               request.environ))}
        tasks[task_id]['task_thread'].start()

        # Return a 202 response, with a link that the client can use to
        # obtain task status
        print(url_for('gettaskstatus', task_id=task_id))
        return 'accepted', 202, {'Location': url_for('gettaskstatus', task_id=task_id)}
    return new_function


class GetTaskStatus(Resource):
    def get(self, task_id):
        """
        Return status about an asynchronous task. If this request returns a 202
        status code, it means that task hasn't finished yet. Else, the response
        from the task is returned.
        """
        task = tasks.get(task_id)
        if task is None:
            abort(404)
        if 'return_value' not in task:
            return '', 202, {'Location': url_for('gettaskstatus', task_id=task_id)}
        return task['return_value']


class CatchAll(Resource):
    @async_api
    def get(self, path=''):
        # perform some intensive processing
        print("starting processing task, path: '%s'" % path)
        time.sleep(10)
        print("completed processing task, path: '%s'" % path)
        return f'The answer is: {path}'


api.add_resource(CatchAll, '/<path:path>', '/')
api.add_resource(GetTaskStatus, '/status/<task_id>')


if __== '__main__':
    app.run(debug=True)
6
Jurgen Strydom