リクエストオブジェクト¶

リクエストに関する情報の扱いについて¶

次はリクエスト情報の扱い方について考えてみましょう。クライアントのリクエストに関する情報はWSGIアプリケーションの第一引数に辞書型のオブジェクトとして渡されることはすでに解説しました。ルーティングに必要なリクエストのHTTPメソッドやURLパスは、次のようにこのオブジェクトから取り出す必要があります。

method = env['REQUEST_METHOD'].upper()
path = env['PATH_INFO']

また他にも様々な情報が格納されていて、例えばHTTPリクエストボディを取り出したい際には、次のように記述します。

content_length = int(env.get('CONTENT_LENGTH', 0))
body = env['wsgi.input'].read(content_length)

辞書型オブジェクトから CONTENT_LENGTH と wsgi.input を取り出します。 env["CONTENT_LENGTH"] には、クライアントがHTTPヘッダー Content-Length で指定したレスポンスボディの長さが格納されています。レスポンスボディはファイルオブジェクトになっているので、 Content-Length の長さ分 read() して上げる必要があります。リクエストボディを取り出すだけでも少し大変なように思います。

これらをうまくラップして使いやすくしてくれるクラスがあれば便利です。ほとんどのWSGIフレームワークがこれをラップした「リクエストオブジェクト」を提供します。このフレームワークにも同様に Request クラスを定義してみましょう。

WSGI Environオブジェクトをラップする¶

リクエストオブジェクトがどういうものかというと、WSGIのEnvironをラップしたクラスのオブジェクトです。 WSGI Environに格納されている様々なリクエスト情報をシンプルなAPIで取り出せるよう、プロパティメソッドが定義された Response クラスを用意します。

class Request:
    def __init__(self, environ):
        self.environ = environ
        self._body = None

    @property
    def path(self):
        return self.environ['PATH_INFO'] or '/'

    @property
    def method(self):
        return self.environ['REQUEST_METHOD'].upper()

    @property
    def body(self):
        if self._body is None:
            content_length = int(self.environ.get('CONTENT_LENGTH', 0))
            self._body = self.environ['wsgi.input'].read(content_length)
        return self._body

WSGI Environには様々な情報が格納されていますが、まずは3つだけプロパティメソッドを定義してみました。この Request クラスのオブジェクトを渡してあげれば、フレームワークの利用者は body プロパティにアクセスするだけで、リクエストボディの情報を取得できます。実際にはここであげた他にもたくさんの情報が詰まっているので、必要に応じて拡張していく必要がありますが基本的な考え方はこれだけです。次はアプリケーションに組み込んでみましょう。

アプリケーションに組み込む¶

各関数には、WSGI Environの代わりに Request(env) を渡すように書き換えてみましょう。

class App:
    ...

    def __call__(self, env, start_response):
        request = Request(env)
        callback, kwargs = self.router.match(request.method, request.path)
        return callback(request, start_response, **kwargs)

これで Request クラスのオブジェクトが各関数に渡せるようになりました。アプリケーション側のインターフェイスは次のようになります。

@app.route('^/users/$', 'POST')
def hello(request, start_response):
    print(request.body.decode('utf-8'))
    return [b'User is created']

リクエストボディの文字コードをすべて utf-8 として扱っている点には改善の余地があります。実際には Content-Type ヘッダーなどで指定されている charset を確認してあげるといいでしょう。とはいえひとまず、フレームワークの利用者は簡単にリクエストボディにアクセスできるようになりました。既存のアプリケーションを書き換えてみます。

from app import App
from wsgiref.simple_server import make_server


app = App()


@app.route('^/$', 'GET')
def hello(request, start_response):
    start_response('200 OK', [('Content-type', 'text/plain; charset=utf-8')])
    return [b'Hello World']


@app.route('^/user/(?P<name>\w+)$', 'GET')
def user_detail(request, start_response, name):
    start_response('200 OK', [('Content-type', 'text/plain; charset=utf-8')])
    body = 'Hello {name}'.format(name=name)
    return [body.encode('utf-8')]


if __name__ == '__main__':
    httpd = make_server('', 8000, app)
    httpd.serve_forever()