Python WSGI 规范

简介: Python WSGI 规范

作为 Python Web 开发者来说,在开发程序阶段一般是不会接触到 WSGI 这个名词的,但当程序开发完成,考虑上线部署的时候,WSGI 规范是一个绕不开的话题,本文将介绍何为 WSGI。

WSGI 全拼 Web Server Gateway Interface,是为 Python 语言定义的 Web 服务器和 Web 应用程序(或框架)之间的一种通用编程接口。翻译成白话就是说 WSGI 是一个协议,就像 HTTP 协议定义了客户端和服务端数据传输的规范,WSGI 协议定义了 Web 服务器和 Web 应用程序之间协同工作的规范。

Python Web 应用部署方案

FlaskDjango 等 Web 框架都提供了内置的 Web Server,本地开发阶段可以使用 flask runpython manage.py runserver 来分别启动 FlaskDjango 内置的 Server。

在生产环境部署应用时,通常不会使用框架内置的 Server,而是使用 GunicornuWSGI 来部署,以获得更好的性能。部署过 Python Web 应用的同学应该对如下部署架构有所了解,左侧是浏览器,右侧是服务器。在服务器内部,首先通过 Nginx 来监听 80/443 端口,当接收到来自客户端的请求时,Nginx 会将请求转发到监听 5000 端口的 Gunicorn/uWSGI Server,接着请求会通过 WSGI 协议被传递到 Flask/Django 框架,在框架内部处理请求逻辑后,会将响应信息按照原路返回。

Python Web Server Deploy

你可能会问,Nginx 性能很高,为什么不将应用直接部署到 Nginx 上,而是中间通过 Gunicorn/uWSGI 做一层转发呢?因为 Nginx 没有遵循 WSGI 规范,并不能像 Gunicorn/uWSGI 这样很容易的与 Flask/Django 框架结合起来。

WSGI 规范

根据 Python Web 应用部署架构,我们知道了 WSGI 所处的位置,接下来看下 WSGI 规范具体定义了哪些内容。

如同 HTTP 协议有一个客户端和一个服务端,WSGI 协议有一个 Application 端和一个 Server 端,其中 Application 就是指 FlaskDjango 这些 Web 框架,而 Server 就是指 GunicornuWSGI 等 Web 服务器。

WSGI 协议规定 Application 端需要实现成一个可调用对象(函数、类等),其接口如下:

1
2
3
4
5
defsimple_app(environ, start_response):
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
return ['Hello world!\n']

simple_app 就是一个最简单的 Application,它需要接收两个参数,environ 是一个 dict,其中保存了所有 HTTP 请求相关的信息,由 Server 端提供,start_response 是一个可调用对象,同样由 Server 端提供,simple_app内部需要调用一次 start_response,并将 状态码响应头 当作参数传递给它,simple_app 最终会返回一个可迭代对象作为 HTTP Body 内容返回给客户端。

我们已经知道了 Application 端接口,接下来看下一个符合 WSGI 协议的 Server 端实现:

1
2
3
4
5
6
7
8
9
10
11
12
13
import os
defwsgi_server(application):
    environ = dict(os.environ.items())
defstart_response(status, response_headers):
        print(f'status: {status}')
        print(f'response_headers: {response_headers}')
    result = application(environ, start_response)
for data in result:
        print(f'response_body: {data}')

示例中 Server 端同样使用函数来实现,wsgi_server 接收一个 application 作为参数,在其内部构造了 environstart_response 两个对象,这里使用环境变量信息来模拟 HTTP 请求信息构造 environ 字典,start_response 同样被定义为一个函数,供 application 在内部对其进行调用,wsgi_server 函数最后会调用 application 并对其进行打印。

现在有了 Application 端和 Server 端,我们可以来测试一下这个简单的 WSGI 程序示例。只需要将 simple_app 作为参数传递给 wsgi_server 并调用 wsgi_server 即可:

1
wsgi_server(simple_app)

执行以上代码,将得到如下打印:

1
2
3
status: 200 OK
response_headers: [('Content-type', 'text/plain')]
response_body: Hello world!

以上,我们分别实现了符合 WSGI 规范的 Application 端和 Server 端,虽然程序看起来比较简陋,但不论多么复杂的 Python Web 框架和 Server 都同样遵循此规范。

WSGI 实际应用

学习了 WSGI 规范,我们可以来验证下平时使用的 Python Web 框架是否真的遵循此规范,这里以 Flask 框架源码为例,可以在 https://github.com/pallets/flask/blob/master/src/flask/app.py 查看 Flask 的定义:

1
2
3
4
5
6
7
8
9
classFlask(Scaffold):
    ...
def__call__(self, environ, start_response):
"""The WSGI server calls the Flask application object as the
        WSGI application. This calls :meth:`wsgi_app`, which can be
        wrapped to apply middleware.
        """
return self.wsgi_app(environ, start_response)

Flask 类内部通过实现 __call__ 方法,使得 Flask 实例对象成为一个可调用对象,其接口实现同样符合 WSGI Application 规范。

参考

https://www.python.org/dev/peps/pep-0333/

相关文章
|
7月前
|
应用服务中间件 Apache nginx
Python Web 开发: 什么是 WSGI(Web Server Gateway Interface)?
Python Web 开发: 什么是 WSGI(Web Server Gateway Interface)?
151 1
|
存储 安全 PHP
【100天精通Python】Day48:Python Web开发_WSGI网络服务器网关接口与使用
【100天精通Python】Day48:Python Web开发_WSGI网络服务器网关接口与使用
105 0
|
7月前
|
SQL API Python
Python DB API下规范下cursor对象常用接口
Python DB API下规范下cursor对象常用接口。
99 4
WK
|
2月前
|
开发者 Python
Python 设计规范
Python的设计规范覆盖了代码布局、命名、注释、函数编写及模块化设计等多个方面,旨在提升代码的可读性与维护性。其中包括缩进、行宽、空行等布局要求;变量、函数、类等命名规则;单行与多行注释说明;函数长度与职责划分;模块的单一职责、开放封闭与依赖倒置原则;避免硬编码并使用有意义的命名;以及遵循PEP 8官方编码标准,以确保代码风格的一致性。遵循这些规范能帮助开发者编写更高质量且易于维护的Python代码。
WK
91 2
WK
|
2月前
|
开发者 Python
Python代码布局规范有哪些
这段内容介绍了Python代码布局的规范,涵盖缩进、空行、行宽、空格使用、注释及顶级定义间的空行等方面,强调使用空格缩进、限制行宽、操作符两侧加空格、简洁注释等实践,旨在提升代码可读性和一致性,便于维护与理解。遵循这些规范能帮助开发者编写更清晰、整洁且易读的Python代码。
WK
45 2
|
7月前
|
Python
【Python操作基础】——语句书写规范
【Python操作基础】——语句书写规范
|
4月前
|
Python
【Python高手必备】从菜鸟到大师——一份详尽的Python编写规范指南,让你的代码焕然一新!
【8月更文挑战第22天】Python以简洁易读著称,遵循编写规范对保证代码质量至关重要。规范包括:使用4空格缩进,函数间空两行提升可读性,每行不超过79字符,及特定命名约定。如函数`calculate_total`、类`ShoppingCart`、常量`PI`。注释解释逻辑,文档字符串描述功能。利用`try-except`处理异常,有序导入模块,避免通配符导入防止命名冲突。使用列表推导和生成器表达式优化性能。遵循这些规范,可使代码更规范、易读和易维护。
70 1
|
4月前
|
安全 搜索推荐 开发者
"揭秘Python编写的艺术境界:不规范代码的悲剧,规范之美让你事半功倍!"
【8月更文挑战第21天】编写高质量Python代码需遵循规范以提升可读性和可维护性。例如,变量命名应采用小写字母加下划线(如`user_name`而非`uName`),函数命名清晰并避免硬编码(如使用`calculate_circle_area`替代`area_of_circle`并定义精确π值)。此外,添加有意义的注释(如解释冒泡排序逻辑),合理排版(如明确函数参数与返回值),以及适当异常处理(确保文件操作安全),都是良好实践。遵循这些规范能显著提高代码质量和团队协作效率。
39 0
|
7月前
|
监控 Python
什么是WSGI,uwsgi和gunicorn在Python Web部署中起到什么作用?
**WSGI**是Python Web应用与服务器间的标准接口。**uwsgi**是实现WSGI的服务器,用于在不同服务器上高效部署应用。**gunicorn**是高性能的WSGI服务器,提供易用接口和进程管理功能。两者协同工作,作为桥梁连接应用与服务器,支持高并发和生产环境部署,提升性能和可靠性。配置因应用和环境而异,需按需调整。
235 2
|
开发者 Python
【从零学习python 】88. WSGI接口详解:实现简单高效的Web开发
【从零学习python 】88. WSGI接口详解:实现简单高效的Web开发
78 0