웹 서버 게이트웨이 인터페이스

3. 상세 사양

WSGI는 서버/게이트웨이 측과 애플리케이션/프레임워크 측, 두 가지 측면으로 구성된다. 서버 측은 환경 정보와 콜백 함수를 애플리케이션 측에 제공하고, 애플리케이션 측은 요청을 처리하여 제공된 콜백 함수를 통해 서버 측에 응답한다.

웹 서버에 요청이 오면 다음과 같은 흐름으로 WSGI가 처리한다.

1. 서버 측이 클라이언트로부터 요청을 받는다.

2. 서버 측은 애플리케이션 측이 엔트리 포인트로 제공하는 호출 가능한 객체(함수나 클래스 인스턴스 등 `__call__`이 정의된 객체)를 호출하여 해당 인수로 환경 변수와 하나의 콜백용 호출 가능 객체를 전달한다.

3. 애플리케이션 측은 이 콜백용 호출 가능 객체를 호출함으로써 상태 코드와 응답 헤더를 서버 측에 전달하고, 더 나아가 본문을 생성하는 반복 가능한 객체(이터레이터나 리스트 등)를 반환값으로 반환한다.

4. 서버 측은 이를 사용하여 클라이언트에 대한 응답을 생성한다.

WSGI 미들웨어는 서버와 애플리케이션 사이에서 요청/응답을 처리하며, 서버의 관점에서는 애플리케이션으로, 애플리케이션의 관점에서는 서버로 행동한다. 미들웨어는 다음과 같은 기능을 수행할 수 있다.

• 환경 변수가 바뀌면 타겟 URL에 따라서 리퀘스트의 경로를 지정해준다.
• 같은 프로세스에서 여러 애플리케이션과 프레임워크가 실행되게 한다.
• XSLT 스타일시트를 적용하는 것과 같이 전처리를 한다.
• 목표 URL에 따라 환경 변수를 적절히 변경하고 요청을 다른 애플리케이션 객체로 회송한다.
• 여러 애플리케이션(및 프레임워크)이 동일한 프로세스 내에서 공존하여 작동하도록 한다.
• 요청과 응답을 네트워크상에서 전송함으로써 부하 분산과 원격 처리
• 콘텐츠의 후처리 실행 - XSL 스타일시트를 적용하는 등

4. WSGI 미들웨어

WSGI 미들웨어는 서버와 애플리케이션 사이에서 동작하며, 서버 관점에서는 애플리케이션으로, 애플리케이션 관점에서는 서버로 작동한다. WSGI 미들웨어는 다음과 같은 기능을 수행하는 파이썬 호출 가능 객체이다.

• 대상 URL에 따라 요청을 다른 애플리케이션 객체로 라우팅하고, 그에 따라 환경 변수를 변경한다.
• 동일한 프로세스에서 여러 애플리케이션 또는 프레임워크를 병렬로 실행할 수 있도록 허용한다.
• 로드 밸런싱 및 원격 처리를 위해 네트워크를 통해 요청 및 응답을 전달한다.
• XSLT 스타일시트 적용과 같은 콘텐츠 후처리를 수행한다.

5. 애플리케이션 예시

python

def application(environ, start_response):

start_response('200 OK', [('Content-Type', 'text/plain')])

yield b'Hello, World!\n'

```

파이썬으로 작성된 WSGI 호환 "Hello, World!" 애플리케이션 예시는 위와 같다.<sup>[8]</sup>

• 1행은 `application` 함수를 정의하며, `environ`과 `start_response` 두 개의 매개변수를 받는다.
• `environ`은 CGI 환경 변수와 기타 요청 매개변수 및 메타데이터를 포함하는 딕셔너리이다.<sup>[9]</sup>
• `start_response`는 호출 가능하며, `status`와 `response_headers` 두 개의 위치 매개변수를 받는다.
• 2행은 `start_response`를 호출하여 "200 OK"를 HTTP 상태로, "Content-Type"을 응답 헤더로 지정한다.
• 3행은 함수를 제너레이터로 만든다. 응답 본문은 바이트 문자열의 반복 가능한 객체로 반환된다.

• WSGI 애플리케이션은 호출 가능 객체(`__call__`이 정의된 객체)로 정의한다(이 예에서는 `application` 함수).
• 이 객체가 호출될 때, `environ` 인수로 CGI와 유사한 환경 변수가 전달된다.
• `start_response` 인수로 상태 코드와 응답 헤더를 받는 호출 가능 객체가 전달된다.
• `start_response`를 호출하여 상태 코드와 응답 헤더를 설정한다.
• WSGI 애플리케이션의 반환값은 본문을 생성하는 iterable 객체여야 한다. 이 예에서는 파이썬의 제너레이터 기능을 사용하여 구현한다.

6. 애플리케이션 호출 예시

다음은 WSGI 애플리케이션을 호출하여 HTTP 상태, 응답 헤더, 응답 본문을 파이썬 객체로 검색하는 방법의 개요이다.<sup>[10]</sup> `environ` 딕셔너리 구성 방법에 대한 세부 정보는 생략되었다.



from io import BytesIO

def call_application(app, environ):

status = None

headers = None

body = BytesIO()

def start_response(rstatus, rheaders):

nonlocal status, headers

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() was not called"

body.write(data)

finally:

if hasattr(app_iter, 'close'):

app_iter.close()

return status, headers, body.getvalue()

environ = {...} # "environ" dict

status, headers, body = call_application(app, environ)

7. WSGI 호환 애플리케이션 및 프레임워크

Django, Flask, Pyramid, CherryPy, Bottle 등 다양한 파이썬 웹 프레임워크가 WSGI를 지원한다. Google App Engine의 webapp2도 WSGI를 지원한다.

WSGI를 지원하는 주요 웹 프레임워크 및 애플리케이션은 다음과 같다.

8. WSGI 지원 서버

다수의 웹 프레임워크가 WSGI를 지원한다.

• [https://github.com/jonashaag/bjoern bjoern]
• BlueBream
• bobo<sup>[11]</sup>
• Bottle
• CherryPy
• Django<sup>[12]</sup>
• Eventlet<sup>[13]</sup>
• [https://github.com/jamesroberts/fastwsgi FastWSGI]
• Flask
• Falcon (웹 프레임워크) <sup>[14]</sup>
• Gevent-FastCGI<sup>[15]</sup>
• Google App Engine의 webapp2
• Gunicorn
• prestans<sup>[16]</sup>
• mod_wsgi는 Apache와 함께 사용한다.<sup>[17]</sup>
• netius
• pycnic<sup>[18]</sup>
• Paste 구성 요소인 WebOb는 특히 WSGI 확장이며, Pylons 프로젝트에 의해 채택되었다.
• Pylons
• Pyramid
• restlite<sup>[19]</sup>
• Tornado
• Trac
• TurboGears
• Uliweb<sup>[20]</sup>
• uWSGI
• Waitress<sup>[21]</sup>
• web.py<sup>[22]</sup>
• web2py
• weblayer<sup>[23]</sup>
• Werkzeug<sup>[24]</sup>
• Radicale<sup>[25]</sup>

9. 다른 프로그래밍 언어에 대한 영향

WSGI에서 영감을 받아 다른 프로그래밍 언어에도 유사한 인터페이스가 만들어졌다. 다음은 그 예이다.

• PSGI (Perl Web Server Gateway Interface)
• Rack (Ruby Web Server Interface)
• SCGI
• Ring (Clojure)
• [https://github.com/fukamachi/clack Clack] (Common Lisp)
• [https://hackage.haskell.org/package/wai WAI] (Haskell, Web Application Interface)

10. Python 3와 WSGI

Python 3에서 문자열과 바이트열이 분리된 것은 WSGI에 문제를 야기했다. HTTP 헤더 데이터는 텍스트로 처리되거나 바이너리로 처리되지만, WSGI는 헤더 데이터를 문자열로 처리한다. Python 2에서는 텍스트도 바이너리도 "문자열"로 처리했기 때문에 문제가 없었지만, Python 3에서는 바이너리는 bytes형으로 처리하게 되었고, "문자열"은 Unicode 문자열을 의미하게 되었다. 이 문제에 대처한 갱신된 WSGI 사양은 PEP 3333으로 공개되어 있다.

재고된 WSGI 사양으로 Web3라는 것도 제안되었으며, 이는 PEP 444로 공개되어 있다. Web3는 호환되지 않는 WSGI의 파생이며, Python 2.6 이후 및 3.1 이후에서 동작하도록 설계되었다.

참조

<sub>[1]</sub> 웹사이트 An Introduction to Web Programming with WSGI http://www.phyast.pi[...] 2007-06-11
<sub>[2]</sub> 논문 Mucking about with microframeworks https://lwn.net/Arti[...] 2019-07-09
<sub>[3]</sub> 웹사이트 An Introduction to Python WSGI Servers for Performance {{!}} AppDynamics https://www.appdynam[...] 2020-08-20
<sub>[4]</sub> 웹사이트 PEP 3333 - Python Web Server Gateway Interface v1.0.1 https://www.python.o[...] 2018-04-04
<sub>[5]</sub> 웹사이트 PEP 333 -- Python Web Server Gateway Interface v1.0 https://www.python.o[...] 2018-04-04
<sub>[6]</sub> 웹사이트 FrontPage - Python Wiki https://www.python.o[...] 2017-01-27
<sub>[7]</sub> 웹사이트 PEP 3333 -- Python Web Server Gateway Interface v1.0.1 https://www.python.o[...] 2018-04-04
<sub>[8]</sub> 문서 i.e. "a function, method, class, or an instance with a __call__ method"
<sub>[9]</sub> 웹사이트 PEP 3333 -- Python Web Server Gateway Interface v1.0.1 https://www.python.o[...] 2018-04-04
<sub>[10]</sub> 웹사이트 Creating WSGI Middleware - Alan Christopher Thomas - Minted - PythonKC https://www.youtube.[...] YouTube 2017-01-27
<sub>[11]</sub> 웹사이트 プエラリアジェルの効果は? http://bobo.digicool[...] 2017-01-27
<sub>[12]</sub> 웹사이트 Django without mod_python, and WSGI support | Weblog | Django http://www.djangopro[...] 2017-01-27
<sub>[13]</sub> 웹사이트 wsgi – WSGI server — Eventlet 0.20.1 documentation http://eventlet.net/[...] 2017-01-27
<sub>[14]</sub> 웹사이트 Falcon - Bare-metal web API framework for Python https://falconframew[...] 2017-10-22
<sub>[15]</sub> 웹사이트 gevent-fastcgi 1.0.2.1 : Python Package Index https://pypi.python.[...] 2017-01-27
<sub>[16]</sub> 웹사이트 anomaly/prestans: A WSGI compliant REST micro-framework https://github.com/p[...] 2017-01-27
<sub>[17]</sub> 웹사이트 Google Code Archive - Long-term storage for Google Code Project Hosting http://code.google.c[...] 2017-01-27
<sub>[18]</sub> 웹사이트 Pycnic Framework http://pycnic.nullis[...] 2017-01-27
<sub>[19]</sub> 웹사이트 theintencity/restlite: Light-weight RESTful server tools in Python https://github.com/t[...] 2017-01-27
<sub>[20]</sub> 웹사이트 limodou/uliweb: Simple and easy use python web framework https://github.com/l[...] 2017-01-27
<sub>[21]</sub> 웹사이트 waitress documentation https://docs.pylonsp[...] 2018-09-26
<sub>[22]</sub> 웹사이트 Welcome to http://webpy.org/ 2017-01-27
<sub>[23]</sub> 웹사이트 weblayer — weblayer v0.4.3 documentation http://packages.pyth[...] 2017-01-27
<sub>[24]</sub> 웹사이트 Welcome | Werkzeug (The Python WSGI Utility Library) http://werkzeug.poco[...] 2017-01-27
<sub>[25]</sub> 웹사이트 CalDAV and CardDAV Server - A Simple Calendar and Contact Server http://radicale.org/ 2017-01-27
<sub>[26]</sub> 웹사이트 Module ngx_http_uwsgi_module http://nginx.org/en/[...] 2017-01-27
<sub>[27]</sub> 웹사이트 Configuration — NGINX Unit https://unit.nginx.o[...] 2023-05-04
<sub>[28]</sub> 웹사이트 Python Tools for Visual Studio - Documentation http://pytools.codep[...] 2017-01-27
<sub>[29]</sub> 웹사이트 Google Code Archive - Long-term storage for Google Code Project Hosting http://code.google.c[...] 2017-01-27
<sub>[30]</sub> 웹사이트 Python ISAPI Extension for IIS download | SourceForge.net http://pyisapie.sour[...] 2017-01-27
<sub>[31]</sub> 웹사이트 An Introduction to Web Programming with WSGI http://www.phyast.pi[...] 2007-11
<sub>[32]</sub> 논문 Mucking about with microframeworks https://lwn.net/Arti[...] 2019-09
<sub>[33]</sub> 웹인용 PEP 333 -- Python Web Server Gateway Interface v1.0 https://www.python.o[...] 2018-04-04