Python wsgiref 模块源码浅析

原文出处： 人世间（@-人世间-） 欢迎分享原创到伯乐头条

SimpleHTTPServer模块提供了创建一个http服务的例子。Python web领域里却很少这么做，而是使用了另外一个协议 — WSGI协议。Python的wisiref模块提供了demo_app，来演示如何使用wsgi协议。

1 2 3 4 5 6 7 8 9 10

def demo_app(environ,start_response): from StringIO import StringIO stdout = StringIO() print >>stdout, "Hello world!" print >>stdout h = environ.items(); h.sort() for k,v in h: print >>stdout, k,'=', repr(v) start_response("200 OK", [('Content-Type','text/plain')]) return [stdout.getvalue()]

demo_app即是一个标准的wsgi app。它接受两个参数，一个包含cgi服务器的环境变量，另外一个参数是一个函数，这个函数也接受两个函数，一个是http状态，另外是http协议的header信息。最后该app返回一个可迭代对象，这个对象即发送给客户端的body内容。demo_app有一些对StringIO的操作，这些都是把environ进行格式化输出。
Python的web框架，都是一个wsgi app。通过自己构造wsgi应用，很容易写出一个框架的骨架。python定义了wsgi，让web框架几乎可以大一统了。下面就来分析，python是如何实现这个协议的。

WSGIServer

python使用WSGIServer和WSGIRequestHandler构建wsgi协议的服务。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

class WSGIServer(HTTPServer): application = None def server_bind(self): HTTPServer.server_bind(self) self.setup_environ() def setup_environ(self): # 甚至环境变量 env = self.base_environ = {} env['SERVER_NAME'] = self.server_name env['GATEWAY_INTERFACE'] = 'CGI/1.1' env['SERVER_PORT'] = str(self.server_port) env['REMOTE_HOST']='' env['CONTENT_LENGTH']='' env['SCRIPT_NAME'] = '' def get_app(self): return self.application def set_app(self,application): self.application = application

WSGIServer继承HTTPServer，重写了server_bind仿佛，设置了一些专用的环境变量。比较简单，我们也知道，Server只是处理socket连接相关的逻辑，RequestHandler才是处理客户端请求逻辑。

WSGIRequestHandler

WSGIRequestHandler 也不复杂，只有3个方法，get_environ用来设置并返回环境变量的字典，get_stderr用于获取标准错误输出。handle则是重写基类BaseRequestHandler的方法。前文我们也提到，handle用于不同协议处理客户端的入口。

handler

1 2 3 4 5 6 7 8 9 10

def handle(self): self.raw_requestline = self.rfile.readline() if not self.parse_request(): return handler = ServerHandler( self.rfile, self.wfile, self.get_stderr(), self.get_environ() ) handler.request_handler = self handler.run(self.server.get_app())

handle方法和BaseHTTPRequestHanler的handle方法所做的类似，解析验证客户端的http的request是否合法。不同的在于，此时会绑定一个ServerHandler的实例对象，并把缓冲可读可写文件句柄，环境变量等传入该类。同时调用这个对象的run方法。其实，我们之前定义的app，恰恰就是传给run方法，通过run方法的包装，实现wsgi协议的通信。

BaseHandler 和 ServerHandler

ServerHandler 来自wsgiref的handlers模块，它继承 BaseHandler类。又一个带base类。BaseHandler主要用于操作WSGI app。run方法就是在该类定义的。

1 2 3 4 5 6 7 8 9 10 11

def run(self, application): try: self.setup_environ() self.result = application(self.environ, self.start_response) self.finish_response() except: try: self.handle_error() except: self.close() raise

run方法最重要的就是调用自定义的wsgi app，并把在finish_reponse方法中把结果send给客户端。

finish_response

1 2 3 4 5 6 7 8

def finish_response(self): try: if not self.result_is_file() or not self.sendfile(): for data in self.result: self.write(data) self.finish_content() finally: self.close()

把可迭代对象数据返回。通过write方法把数据写入缓冲可写文件，然后发送给客户端。

send_preamble

finish_response返回http的body是一方面，其中还需要返回http的headers。这个操作分别在wirte方法和finish_content中，它们都调用了send_headers方法，send_headers方法由通过调用send_preamble构造header数据，并最终通过_write 方法写入到缓冲可写文件中。完成服务器对客户端的响应。

1 2 3 4 5 6 7 8 9 10 11 12 13

def send_preamble(self): if self.origin_server: if self.client_is_modern(): self._write('HTTP/%s %s\r\n' % (self.http_version,self.status)) if 'Date' not in self.headers: self._write( 'Date: %s\r\n' % format_date_time(time.time()) ) if self.server_software and 'Server' not in self.headers: self._write('Server: %s\r\n' % self.server_software) else: self._write('Status: %s\r\n' % self.status)

wsgiref模块还包含了另外几个子模块，上面的的内容主要来自 simple_server 和 handler模块，此外还有headers喝validata模块，用于包装headers和做验证，暂且忽略了。
wsgi是 python web框架中的标准，实现了wsgi协议就能写出一个web框架。python的世界里不少知名的框架。接下来将会探究一下werkzeug和flask的源码以及tornado的源码。
问啊-定制化IT教育平台，牛人一对一服务，有问必答，开发编程社交头条 官方网站：www.wenaaa.com
QQ群290551701 聚集很多互联网精英，技术总监，架构师，项目经理！开源技术研究，欢迎业内人士，大牛及新手有志于从事IT行业人员进入！