Python wsgiref 模块源码浅析

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

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协议的服务。


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

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方法就是在该类定义的。

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

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 方法写入到缓冲可写文件中。完成服务器对客户端的响应。

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的源码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,928评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,192评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,468评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,186评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,295评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,374评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,403评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,186评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,610评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,906评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,075评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,755评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,393评论 3 320
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,079评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,313评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,934评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,963评论 2 351

推荐阅读更多精彩内容