Web サーバー ゲートウェイ インターフェイス

Webサーバーゲートウェイインターフェース（WSGI、発音はウィスキー^{[1] [2]}またはウィズギー^[3]）は、WebサーバーがPythonプログラミング言語で書かれたWebアプリケーションまたはフレームワークにリクエストを転送するためのシンプルな呼び出し規約です。WSGIの現在のバージョンであるバージョン1.0.1は、 Python拡張提案（PEP）3333で指定されています。 ^[4]

WSGIはもともと2003年にPEP-333として仕様化されました。^{[5] 2010年に公開されたPEP-3333は}Python 3の仕様を更新したものです。

2003年当時、PythonウェブフレームワークはCGI、FastCGI、mod_python、または特定のウェブサーバーのカスタムAPIのみを対象に書かれるのが一般的でした。^[6] PEP 333を引用すると、

Python は現在、Zope、Quixote、Webware、SkunkWeb、PSO、Twisted Web など、さまざまな Web アプリケーション フレームワークを誇​​っています。これはほんの一例です。このように選択肢が多岐にわたるため、Python を初めて使用するユーザーにとっては問題になることがあります。一般的に、Web フレームワークの選択によって、使用可能な Web サーバーの選択肢が制限され、その逆もまた同様です。対照的に、Java には同じ数の Web アプリケーション フレームワークが用意されていますが、Java の「サーブレット」API により、任意の Java Web アプリケーション フレームワークで作成されたアプリケーションを、サーブレット API をサポートする任意の Web サーバーで実行できます。

WSGIは、移植可能なWebアプリケーション開発の共通基盤を促進するために、WebサーバーとWebアプリケーションまたはフレームワーク間の実装中立なインターフェースとして作成されました。^[4]

WSGI には 2 つの側面があります。

• サーバー/ゲートウェイ側。これは、 ApacheやNginxなどの完全な Web サーバー ソフトウェアを実行している場合が多いですが、flup などの Web サーバーと通信できる軽量のアプリケーション サーバーである場合もあります。
• アプリケーション/フレームワーク側。これは、Python プログラムまたはフレームワークによって提供される Python 呼び出し可能オブジェクトです。

サーバーとアプリケーションの間には、通常は Python コードで API の両側を実装する 1 つ以上のWSGIミドルウェア コンポーネントが存在する場合があります。

WSGI では、Python インタープリターの起動方法や、アプリケーション オブジェクトの読み込み方法や構成方法が指定されておらず、フレームワークや Web サーバーによって方法が異なります。

WSGIミドルウェアコンポーネントはPython呼び出し可能オブジェクトであり、それ自体がWSGIアプリケーションですが、他のWSGIアプリケーションに委任することでリクエストを処理することができます。これらのアプリケーション自体がWSGIミドルウェアコンポーネントになることもあります。^[7]

ミドルウェアコンポーネントは次のような機能を実行できます。^[7]

• 環境変数を適宜変更した後、ターゲットURLに基づいてリクエストを異なるアプリケーション オブジェクトにルーティングします。
• 複数のアプリケーションやフレームワークを同じプロセスで並行して実行できるようにする
• リクエストとレスポンスをネットワーク経由で転送することで、負荷分散とリモート処理を実現します。
• XSLTスタイルシートの適用など、コンテンツの後処理を実行する

Pythonで書かれたWSGI 互換の「Hello, World! 」アプリケーション:

def アプリケーション( environ 、 start_response ):
    start_response ( '200 OK' ,  [( 'Content-Type' ,  'text/plain' )])
    yield  b 'Hello, World! \n '

どこ：

• 1行目は、 2つのパラメータとを受け取る関数^[8]を定義します。関数は、 CGI環境変数と、明確に定義されたキーの下にある他のリクエストパラメータとメタデータを含む辞書です。 ^[9]は、2つの位置パラメータとを受け取る呼び出し可能関数です。applicationenvironstart_responseenviron start_responsestatusresponse_headers
• 2 行目はstart_response、HTTP ステータスとして「200 OK」を指定し、応答ヘッダーとして「Content-Type」を指定して を呼び出します。
• 3 行目では、関数をジェネレーターにします。レスポンスの本文は、バイト文字列の反復可能オブジェクトとして返されます。

WSGIネットワークサーバーの完全な例はこの記事の範囲外です。以下は、WSGIアプリケーションを呼び出して、そのHTTPステータス行、応答ヘッダー、応答本文をPythonオブジェクトとして取得する方法の概略です。^[10]辞書の構築方法の詳細はenviron省略されています。

 io からBytesIOをインポート 

def  call_application ( app ,  environ ): 
    status  =  None 
    headers  =  None 
    body  =  BytesIO ()
    
    def  start_response ( rstatus 、 rheaders ):
        非ローカル ステータス、 ヘッダー
        status 、 headers  =  rstatus 、 rheaders
        
    app_iter  =  app ( environ ,  start_response ) 
    try : 
        for  data  in  app_iter : 
            assert  status  is  not  None  and  headers  is  not  None , \
                 "start_response() が呼び出されませんでした" 
            body . write ( data ) 
    finally : 
        if  hasattr ( app_iter ,  'close' ): 
            app_iter . close () 
    return  status ,  headers ,  body . getvalue ()

environ  =  { ... }   # "environ" 辞書
status 、 headers 、 body  =  call_application ( app 、 environ )

数多くのWeb フレームワークが WSGI をサポートしています。

現在、FastCGI、CGI、SCGI、AJP（flupを使用）、twisted.web、Apache（mod_wsgiまたはmod_pythonを使用）、Nginx（ngx_http_uwsgi_moduleを使用）^[26] Nginx Unit（Python言語モジュールを使用）^[27]、Microsoft IIS（WFastCGI、^[28] isapi-wsgi、^[29] PyISAPIe、^[30]またはASPゲートウェイを使用）のラッパーが利用可能です。

• 非同期サーバーゲートウェイインターフェース（ASGI） – WSGIの精神的後継であり、非同期アプリケーションのサポートを追加します。
• Rack – Rubyウェブサーバーインターフェース
• PSGI – Perl Web サーバー ゲートウェイ インターフェース
• SCGI – シンプル コモン ゲートウェイ インターフェース
• JSGI – JavaScriptウェブサーバーゲートウェイインターフェース

• PEP 333 – Python Web サーバー ゲートウェイ インターフェース
• PEP 3333 – Python Web サーバー ゲートウェイ インターフェース v1.0.1
• WSGI メタフレームワーク
• WSGI に関するあらゆる情報を網羅した wiki
• WSGI チュートリアル
• Python 標準ライブラリモジュール wsgiref
• WSGI を使い始める
• NWSGI – IronPython および IIS 用の Python WSGI 仕様の .NET 実装
• Gevent コルーチンベースのネットワークライブラリを使用して実装された Gevent-FastCGI サーバー