Python 3 用 Deferred API

このページでは、従来のバンドルサービスの 1 つである Deferred API を、スタンダード環境の Python 3 ランタイムとともに使用する方法を説明します。アプリを使用すると Python 3 用 App Engine サービス SDK を介してバンドルサービスにアクセスできます。

概要

これまで遅延パッケージ google.appengine.ext.deferred は Python 2 の webapp フレームワークに依存していました。webapp フレームワークは Python 3 用 App Engine サービス SDK から削除されたため、Python 2 アプリを Python 3 にアップグレードする際にはいくつかの変更が必要になります。

Deferred API を有効にする

Python 3 用 Deferred API を有効にする際、app.yaml ファイル内で builtins.deferred を on に設定する必要がなくなりました。API を有効にするには、wrap_wsgi_app() の呼び出しで use_deferred=True を渡す必要があります。

類似点と相違点

デフォルトでは、Python 3 用 Deferred API は Python 2 と同じ URL（/_ah/queue/deferred）と同じデフォルトキューを使用します。なお、Cloud Tasks に移行するアプリの場合、デフォルトキューが自動的に作成されないため、遅延タスクライブラリは使用できません。

アプリでデフォルトの /_ah/queue/deferred エンドポイントを使用する場合、Python 3 での deferred.defer() の使用は、Python 2 の場合と同じになります。アプリでカスタム URL を遅延タスクの実行に使用する場合、Python 2 の deferred モジュール内の TaskHandler クラスがこの API の Python 3 バージョンで削除されているため、いくつかの変更が必要になります。

遅延タスクの実行用にカスタム URL を設定するには、アプリで deferred.Handler クラス（Python 2 における以前の deferred.TaskHandler）内の post メソッドまたは run_from_request メソッドを上書きして、WSGI リクエストパラメータを含むディクショナリを表す environ パラメータを渡します。これにより、post メソッドをカスタムエンドポイントから呼び出すことができます（Python 3 のサンプルを参照）。

リクエストのルーティングや environ ディクショナリへのアクセスなど、Python 3 Deferred API のエンドツーエンドの使用法は、アプリが移行するウェブフレームワークによって異なります。次のセクションでは、Python 2 のサンプルと Python 3 のサンプルで行われたコードの変更を比較します。

Python 3 の例

次のサンプルでは、Flask アプリと Django アプリでデフォルトのエンドポイントとカスタムエンドポイントを使用して遅延タスクを実行する方法を示しています。

Flask

import os

from flask import Flask, request
from google.appengine.api import wrap_wsgi_app
from google.appengine.ext import deferred
from google.appengine.ext import ndb

my_key = os.environ.get("GAE_VERSION", "Missing")

app = Flask(__name__)
app.wsgi_app = wrap_wsgi_app(app.wsgi_app, use_deferred=True)

class Counter(ndb.Model):
    count = ndb.IntegerProperty(indexed=False)

def do_something_later(key, amount):
    entity = Counter.get_or_insert(key, count=0)
    entity.count += amount
    entity.put()

@app.route("/counter/increment")
def increment_counter():
    # Use default URL and queue name, no task name, execute ASAP.
    deferred.defer(do_something_later, my_key, 10)

    # Use default URL and queue name, no task name, execute after 1 minute.
    deferred.defer(do_something_later, my_key, 10, _countdown=60)

    # Providing non-default task queue arguments
    deferred.defer(do_something_later, my_key, 10, _url="/custom/path", _countdown=120)

    return "Deferred counter increment."

@app.route("/counter/get")
def view_counter():
    counter = Counter.get_or_insert(my_key, count=0)
    return str(counter.count)

@app.route("/custom/path", methods=["POST"])
def custom_deferred():
    print("Executing deferred task.")
    # request.environ contains the WSGI `environ` dictionary (See PEP 0333)
    return deferred.Handler().post(request.environ)

Django

import os

from django.conf import settings
from django.core.wsgi import get_wsgi_application
from django.http import HttpResponse
from django.urls import path
from google.appengine.api import wrap_wsgi_app
from google.appengine.ext import deferred
from google.appengine.ext import ndb

my_key = os.environ.get("GAE_VERSION", "Missing")

class Counter(ndb.Model):
    count = ndb.IntegerProperty(indexed=False)

def do_something_later(key, amount):
    entity = Counter.get_or_insert(key, count=0)
    entity.count += amount
    entity.put()

def increment_counter(request):
    # Use default URL and queue name, no task name, execute ASAP.
    deferred.defer(do_something_later, my_key, 10)

    # Use default URL and queue name, no task name, execute after 1 minute.
    deferred.defer(do_something_later, my_key, 10, _countdown=60)

    # Providing non-default task queue arguments
    deferred.defer(do_something_later, my_key, 10, _url="/custom/path", _countdown=120)

    return HttpResponse("Deferred counter increment.")

def view_counter(request):
    counter = Counter.get_or_insert(my_key, count=0)
    return HttpResponse(str(counter.count))

def custom_deferred(request):
    print("Executing deferred task.")
    # request.environ contains the WSGI `environ` dictionary (See PEP 0333)
    response, status, headers = deferred.Handler().post(request.environ)
    return HttpResponse(response, status=status.value)

urlpatterns = (
    path("counter/get", view_counter, name="view_counter"),
    path("counter/increment", increment_counter, name="increment_counter"),
    path("custom/path", custom_deferred, name="custom_deferred"),
)

settings.configure(
    DEBUG=True,
    SECRET_KEY="thisisthesecretkey",
    ROOT_URLCONF=__name__,
    MIDDLEWARE_CLASSES=(
        "django.middleware.common.CommonMiddleware",
        "django.middleware.csrf.CsrfViewMiddleware",
        "django.middleware.clickjacking.XFrameOptionsMiddleware",
    ),
    ALLOWED_HOSTS=["*"],
)

app = wrap_wsgi_app(get_wsgi_application(), use_deferred=True)

フレームワークなし

import os
import re

from google.appengine.api import wrap_wsgi_app
from google.appengine.ext import deferred
from google.appengine.ext import ndb

my_key = os.environ.get("GAE_VERSION", "Missing")

class Counter(ndb.Model):
    count = ndb.IntegerProperty(indexed=False)

def do_something_later(key, amount):
    entity = Counter.get_or_insert(key, count=0)
    entity.count += amount
    entity.put()

def IncrementCounter(environ, start_response):
    # Use default URL and queue name, no task name, execute ASAP.
    deferred.defer(do_something_later, my_key, 10)

    # Use default URL and queue name, no task name, execute after 1 minute.
    deferred.defer(do_something_later, my_key, 10, _countdown=60)

    # Providing non-default task queue arguments
    deferred.defer(do_something_later, my_key, 10, _url="/custom/path", _countdown=120)

    start_response("200 OK", [("Content-Type", "text/html")])
    return [b"Deferred counter increment."]

def ViewCounter(environ, start_response):
    counter = Counter.get_or_insert(my_key, count=0)
    start_response("200 OK", [("Content-Type", "text/html")])
    return [str(counter.count).encode("utf-8")]

class CustomDeferredHandler(deferred.Handler):
    """Deferred task handler that adds additional logic."""

    def post(self, environ):
        print("Executing deferred task.")
        return super().post(environ)

routes = {
    "counter/increment": IncrementCounter,
    "counter/get": ViewCounter,
    "custom/path": CustomDeferredHandler(),
}

class WSGIApplication:
    def __call__(self, environ, start_response):
        path = environ.get("PATH_INFO", "").lstrip("/")
        for regex, handler in routes.items():
            match = re.search(regex, path)
            if match is not None:
                return handler(environ, start_response)

        start_response("404 Not Found", [("Content-Type", "text/plain")])
        return [b"Not found"]

app = wrap_wsgi_app(WSGIApplication(), use_deferred=True)

コードサンプル

このガイドの完全なコードサンプルについては、GitHub をご覧ください。