用 Python 写一个简单的Web框架

一、概述

二、从demo_app开始

三、WSGI中的application

四、区分URL

五、重构

1、正则匹配URL

2、DRY

3、抽象出框架

六、参考


一、概述

在Python中,WSGI(Web Server Gateway Interface)定义了Web服务器与Web应用(或Web框架)之间的标准接口。在WSGI的规范下,各种各样的Web服务器和Web框架都可以很好的交互。

由于WSGI的存在,用Python写一个简单的Web框架也变得非常容易。然而,同很多其他的强大软件一样,要实现一个功能丰富、健壮高效的Web框架并非易事;如果您打算这么做,可能使用一个现成的Web框架(如 Django、Tornado、web.py 等)会是更合适的选择。

本文尝试写一个类似web.py的Web框架。好吧,我承认我夸大其辞了:首先,web.py并不简单;其次,本文只重点实现了 URL调度(URL dispatch)部分。

二、从demo_app开始

首先,作为一个初步体验,我们可以借助 wsgiref.simple_server 来搭建一个简单无比(trivial)的Web应用:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

fromwsgiref.simple_serverimportmake_server, demo_app

httpd = make_server('',8086, demo_app)

sa = httpd.socket.getsockname()

print'http://{0}:{1}/'.format(*sa)

# Respond to requests until process is killed

httpd.serve_forever()

运行脚本:

$ python code.py

http://0.0.0.0:8086/

打开浏览器,输入http://0.0.0.0:8086/后可以看到:一行”Hello world!” 和 众多环境变量值。


三、WSGI中的application

WSGI中规定:application是一个 可调用对象(callable object),它接受 environ 和 start_response 两个参数,并返回一个 字符串迭代对象。

其中,可调用对象 包括 函数、方法、类 或者 具有__call__方法的 实例;environ 是一个字典对象,包括CGI风格的环境变量(CGI-style environment variables)和 WSGI必需的变量(WSGI-required variables);start_response 是一个可调用对象,它接受两个 常规参数(status,response_headers)和 一个 默认参数(exc_info);字符串迭代对象 可以是 字符串列表、生成器函数 或者 具有__iter__方法的可迭代实例。更多细节参考 Specification Details。

The Application/Framework Side 中给出了一个典型的application实现:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

defsimple_app(environ, start_response):

"""Simplest possible application object"""

status ='200 OK'

response_headers = [('Content-type','text/plain')]

start_response(status, response_headers)

return['Hello world! ']

现在用simple_app来替换demo_app:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""code.py"""

fromwsgiref.simple_serverimportmake_server

fromapplicationimportsimple_appasapp

if__name__ =='__main__':

httpd = make_server('',8086, app)

sa = httpd.socket.getsockname()

print'http://{0}:{1}/'.format(*sa)

# Respond to requests until process is killed

httpd.serve_forever()

运行脚本code.py后,访问http://0.0.0.0:8086/就可以看到那行熟悉的句子:Hello world!

四、区分URL

倒腾了一阵子后,您会发现不管如何改变URL中的path部分,得到的响应都是一样的。因为simple_app只识别host+port部分。

为了对URL中的path部分进行区分处理,需要修改application.py的实现。

首先,改用 类 来实现application:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

classmy_app:

def__init__(self, environ, start_response):

self.environ = environ

self.start = start_response

def__iter__(self):

status ='200 OK'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Hello world! "

然后,增加对URL中path部分的区分处理:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

classmy_app:

def__init__(self, environ, start_response):

self.environ = environ

self.start = start_response

def__iter__(self):

path = self.environ['PATH_INFO']

ifpath =="/":

returnself.GET_index()

elifpath =="/hello":

returnself.GET_hello()

else:

returnself.notfound()

defGET_index(self):

status ='200 OK'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Welcome! "

defGET_hello(self):

status ='200 OK'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Hello world! "

defnotfound(self):

status ='404 Not Found'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Not Found "

修改code.py中的from application import simple_app as app,用my_app来替换simple_app后即可体验效果。




如果你在学习Python的过程当中有遇见任何问题,可以加入我的python交流学企鹅群:【611+530+101】,多多交流问题,互帮互助,群里有不错的学习教程和开发工具。学习python有任何问题(学习方法,学习效率,如何就业),可以随时来咨询我



五、重构

上面的代码虽然奏效,但是在编码风格和灵活性方面有很多问题,下面逐步对其进行重构。

1、正则匹配URL

消除URL硬编码,增加URL调度的灵活性:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

importre##########修改点

classmy_app:

urls = (

("/","index"),

("/hello/(.*)","hello"),

)##########修改点

def__init__(self, environ, start_response):

self.environ = environ

self.start = start_response

def__iter__(self):##########修改点

path = self.environ['PATH_INFO']

method = self.environ['REQUEST_METHOD']

forpattern, nameinself.urls:

m = re.match('^'+ pattern +'$', path)

ifm:

# pass the matched groups as arguments to the function

args = m.groups()

funcname = method.upper() +'_'+ name

ifhasattr(self, funcname):

func = getattr(self, funcname)

returnfunc(*args)

returnself.notfound()

defGET_index(self):

status ='200 OK'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Welcome! "

defGET_hello(self, name):##########修改点

status ='200 OK'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Hello %s! "% name

defnotfound(self):

status ='404 Not Found'

response_headers = [('Content-type','text/plain')]

self.start(status, response_headers)

yield"Not Found "

2、DRY

消除GET_*方法中的重复代码,并且允许它们返回字符串:

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

importre

classmy_app:

urls = (

("/","index"),

("/hello/(.*)","hello"),

)

def__init__(self, environ, start_response):##########修改点

self.environ = environ

self.start = start_response

self.status ='200 OK'

self._headers = []

def__iter__(self):##########修改点

result = self.delegate()

self.start(self.status, self._headers)

# 将返回值result(字符串 或者 字符串列表)转换为迭代对象

ifisinstance(result, basestring):

returniter([result])

else:

returniter(result)

defdelegate(self):##########修改点

path = self.environ['PATH_INFO']

method = self.environ['REQUEST_METHOD']

forpattern, nameinself.urls:

m = re.match('^'+ pattern +'$', path)

ifm:

# pass the matched groups as arguments to the function

args = m.groups()

funcname = method.upper() +'_'+ name

ifhasattr(self, funcname):

func = getattr(self, funcname)

returnfunc(*args)

returnself.notfound()

defheader(self, name, value):##########修改点

self._headers.append((name, value))

defGET_index(self):##########修改点

self.header('Content-type','text/plain')

return"Welcome! "

defGET_hello(self, name):##########修改点

self.header('Content-type','text/plain')

return"Hello %s! "% name

defnotfound(self):##########修改点

self.status ='404 Not Found'

self.header('Content-type','text/plain')

return"Not Found "

3、抽象出框架

为了将类my_app抽象成一个独立的框架,需要作出以下修改:

剥离出其中的具体处理细节:urls配置 和 GET_*方法(改成在多个类中实现相应的GET方法)

把方法header实现为类方法(classmethod),以方便外部作为功能函数调用

改用 具有__call__方法的 实例 来实现application

修改后的application.py(最终版本):

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""application.py"""

importre

classmy_app:

"""my simple web framework"""

headers = []

def__init__(self, urls=(), fvars={}):

self._urls = urls

self._fvars = fvars

def__call__(self, environ, start_response):

self._status ='200 OK'# 默认状态OK

delself.headers[:]# 清空上一次的headers

result = self._delegate(environ)

start_response(self._status, self.headers)

# 将返回值result(字符串 或者 字符串列表)转换为迭代对象

ifisinstance(result, basestring):

returniter([result])

else:

returniter(result)

def_delegate(self, environ):

path = environ['PATH_INFO']

method = environ['REQUEST_METHOD']

forpattern, nameinself._urls:

m = re.match('^'+ pattern +'$', path)

ifm:

# pass the matched groups as arguments to the function

args = m.groups()

funcname = method.upper()# 方法名大写(如GET、POST)

klass = self._fvars.get(name)# 根据字符串名称查找类对象

ifhasattr(klass, funcname):

func = getattr(klass, funcname)

returnfunc(klass(), *args)

returnself._notfound()

def_notfound(self):

self._status ='404 Not Found'

self.header('Content-type','text/plain')

return"Not Found "

@classmethod

defheader(cls, name, value):

cls.headers.append((name, value))

对应修改后的code.py(最终版本):

#!/usr/bin/env python

# -*- coding: utf-8 -*-

"""code.py"""

fromapplicationimportmy_app

urls = (

("/","index"),

("/hello/(.*)","hello"),

)

wsgiapp = my_app(urls, globals())

classindex:

defGET(self):

my_app.header('Content-type','text/plain')

return"Welcome! "

classhello:

defGET(self, name):

my_app.header('Content-type','text/plain')

return"Hello %s! "% name

if__name__ =='__main__':

fromwsgiref.simple_serverimportmake_server

httpd = make_server('',8086, wsgiapp)

sa = httpd.socket.getsockname()

print'http://{0}:{1}/'.format(*sa)

# Respond to requests until process is killed

httpd.serve_forever()

当然,您还可以在code.py中配置更多的URL映射,并实现相应的类来对请求作出响应。

六、参考

本文主要参考了 How to write a web framework in Python(作者 anandology 是web.py代码的两位维护者之一,另一位则是大名鼎鼎却英年早逝的 Aaron Swartz),在此基础上作了一些调整和修改,并掺杂了自己的一些想法。

如果您还觉得意犹未尽,Why so many Python web frameworks? 也是一篇很好的文章,也许它会让您对Python中Web框架的敬畏之心荡然无存:-)

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

推荐阅读更多精彩内容