技術共有

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

Python WSGI サーバーのチュートリアル:start_response メソッド分析

この記事では、WSGI サーバーについて詳しく分析します。 start_response 方法。このメソッドは、HTTP 応答のステータス コードと応答ヘッダーを処理し、write レスポンスデータを送信する関数です。このメソッドがどのように機能するかを行ごとに説明し、その機能を理解するのに役立つ背景を説明します。

背景知識

WSGI (Web Server Gateway Interface) は、Web サーバーと Web アプリケーションまたはフレームワークを接続するために使用される標準インターフェイスです。 WSGI を介して、サーバーとアプリケーションの間で通信し、HTTP リクエストと応答を処理できます。

WSGIサーバーを実装する場合、start_response このメソッドは、HTTP 応答ステータスと応答ヘッダーを設定するために WSGI アプリケーションによって呼び出され、応答データを書き込むための関数を返す重要な部分です。

start_response メソッドの実装

以下は典型的なものです start_response メソッドの実装:

def start_response(status, response_headers, exc_info=None):
    if exc_info:
        try:
            if headers_sent:
                reraise(*exc_info)
        finally:
            exc_info = None
    elif headers_set:
        raise AssertionError("Headers already set")
    headers_set[:] = [status, response_headers]
    return write
1
2
3
4
5
6
7
8
9
10
11

ステップバイステップの説明

1. 対処する exc_info パラメータ

if exc_info:
    try:
        if headers_sent:
            reraise(*exc_info)
    finally:
        exc_info = None
1
2
3
4
5
6

• exc_info 通常、引数には次の形式の例外タプルが含まれます。(type, value, traceback) 、例外処理に使用されます。もしexc_info のためではないNone、処理する必要のある例外があることを示します。
• try ブロック内チェックheaders_sent 応答ヘッダーが送信されたかどうか。応答ヘッダーが送信された場合は、reraise(*exc_info) 例外を再スローします。
• finally ブロックは、例外を処理した後、exc_info に設定None処理の重複を避けるため。

2. レスポンスヘッダーが設定されているか確認する

elif headers_set:
    raise AssertionError("Headers already set")
1
2

• もし headers_set リストにはすでに値が含まれている（つまり、応答ヘッダーが設定されている）場合、AssertionError 異常な。このチェックにより、start_response 応答ヘッダーを設定するために 1 回だけ呼び出すことができます。

3. 応答ステータスと応答ヘッダーを設定する

headers_set[:] = [status, response_headers]
1

• スライス割り当てを使用して、 status そしてresponse_headers に割り当てられたheaders_set リスト。この目的は保持することですheaders_set を参照しますが、その内容を更新します。
• status HTTP 応答ステータス コードとメッセージを表す文字列です。たとえば、"200 OK"。
• response_headers タプルを含むリストであり、各タプルは応答ヘッダーのキーと値のペアを表します。たとえば、[("Content-Type", "text/html"), ("Content-Length", "123")]。

4. 戻る write 関数

return write
1

• start_response メソッドは、write 関数。この関数は、応答データを送信するために WSGI アプリケーションによって呼び出されます。

使用例

使用方法を示す完全な例は次のとおりです start_response WSGI 応答を処理するメソッド:

import socketserver

class MyTCPHandler(socketserver.BaseRequestHandler):
    def handle(self):
        self.headers_set = []
        self.headers_sent = []

        def start_response(status, response_headers, exc_info=None):
            if exc_info:
                try:
                    if self.headers_sent:
                        raise exc_info[1]
                finally:
                    exc_info = None
            elif self.headers_set:
                raise AssertionError("Headers already set")
            self.headers_set[:] = [status, response_headers]
            return self.write

        def write(data):
            assert self.headers_set, "write() before start_response"
            if not self.headers_sent:
                status, response_headers = self.headers_sent[:] = self.headers_set
                try:
                    code, msg = status.split(None, 1)
                except ValueError:
                    code, msg = status, ""
                code = int(code)
                self.send_response(code, msg)
                header_keys = set()
                for key, value in response_headers:
                    self.send_header(key, value)
                    key = key.lower()
                    header_keys.add(key)
                if not (
                    "content-length" in header_keys
                    or self.environ["REQUEST_METHOD"] == "HEAD"
                    or code < 200
                    or code in (204, 304)
                ):
                    self.close_connection = True
                    self.send_header("Connection", "close")
                if "server" not in header_keys:
                    self.send_header("Server", self.version_string())
                if "date" not in header_keys:
                    self.send_header("Date", self.date_time_string())
                self.end_headers()

            assert isinstance(data, bytes), "applications must write bytes"
            self.wfile.write(data)
            self.wfile.flush()

        self.write = write
        self.environ = self.make_environ()

        try:
            result = self.server.app(self.environ, start_response)
            try:
                for data in result:
                    write(data)
                if not self.headers_sent:
                    write(b"")
            finally:
                if hasattr(result, "close"):
                    result.close()
        except Exception as e:
            self.send_error(500, str(e))

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
        print("Server started at {}:{}".format(HOST, PORT))
        server.serve_forever()
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

要約する

このチュートリアルを通じて、WSGI サーバーを詳細に分析しました。 start_response HTTP 応答のステータス コードと応答ヘッダーを処理し、応答データを書き込むための関数を返す方法を説明するメソッド。これらの内容を理解すると、WSGI 仕様をよりよく理解し、カスタマイズされた WSGI サーバーを実装するのに役立ちます。このチュートリアルがお役に立てば幸いです。詳細と例については、を参照してください。公式ドキュメント。