简单介绍Python下自己编写web框架的一些要点


Posted in Python onApril 29, 2015

在正式开始Web开发前,我们需要编写一个Web框架。

为什么不选择一个现成的Web框架而是自己从头开发呢?我们来考察一下现有的流行的Web框架:

  • Django:一站式开发框架,但不利于定制化;
  • web.py:使用类而不是更简单的函数来处理URL,并且URL映射是单独配置的;
  • Flask:使用@decorator的URL路由不错,但框架对应用程序的代码入侵太强;
  • bottle:缺少根据URL模式进行拦截的功能,不利于做权限检查。

所以,我们综合几种框架的优点,设计一个简单、灵活、入侵性极小的Web框架。
设计Web框架

一个简单的URL框架应该允许以@decorator方式直接把URL映射到函数上:

# 首页:
@get('/')
def index():
  return '<h1>Index page</h1>'

# 带参数的URL:
@get('/user/:id')
def show_user(id):
  user = User.get(id)
  return 'hello, %s' % user.name

有没有@decorator不改变函数行为,也就是说,Web框架的API入侵性很小,你可以直接测试函数show_user(id)而不需要启动Web服务器。

函数可以返回str、unicode以及iterator,这些数据可以直接作为字符串返回给浏览器。

其次,Web框架要支持URL拦截器,这样,我们就可以根据URL做权限检查:

@interceptor('/manage/')
def check_manage_url(next):
  if current_user.isAdmin():
    return next()
  else:
    raise seeother('/signin')

拦截器接受一个next函数,这样,一个拦截器可以决定调用next()继续处理请求还是直接返回。

为了支持MVC,Web框架需要支持模板,但是我们不限定使用哪一种模板,可以选择jinja2,也可以选择mako、Cheetah等等。

要统一模板的接口,函数可以返回dict并配合@view来渲染模板:

@view('index.html')
@get('/')
def index():
  return dict(blogs=get_recent_blogs(), user=get_current_user())

如果需要从form表单或者URL的querystring获取用户输入的数据,就需要访问request对象,如果要设置特定的Content-Type、设置Cookie等,就需要访问response对象。request和response对象应该从一个唯一的ThreadLocal中获取:

@get('/test')
def test():
  input_data = ctx.request.input()
  ctx.response.content_type = 'text/plain'
  ctx.response.set_cookie('name', 'value', expires=3600)
  return 'result'

最后,如果需要重定向、或者返回一个HTTP错误码,最好的方法是直接抛出异常,例如,重定向到登陆页:

raise seeother('/signin')

返回404错误:

raise notfound()

基于以上接口,我们就可以实现Web框架了。
实现Web框架

最基本的几个对象如下:

# transwarp/web.py

# 全局ThreadLocal对象:
ctx = threading.local()

# HTTP错误类:
class HttpError(Exception):
  pass

# request对象:
class Request(object):
  # 根据key返回value:
  def get(self, key, default=None):
    pass

  # 返回key-value的dict:
  def input(self):
    pass

  # 返回URL的path:
  @property
  def path_info(self):
    pass

  # 返回HTTP Headers:
  @property
  def headers(self):
    pass

  # 根据key返回Cookie value:
  def cookie(self, name, default=None):
    pass

# response对象:
class Response(object):
  # 设置header:
  def set_header(self, key, value):
    pass

  # 设置Cookie:
  def set_cookie(self, name, value, max_age=None, expires=None, path='/'):
    pass

  # 设置status:
  @property
  def status(self):
    pass
  @status.setter
  def status(self, value):
    pass

# 定义GET:
def get(path):
  pass

# 定义POST:
def post(path):
  pass

# 定义模板:
def view(path):
  pass

# 定义拦截器:
def interceptor(pattern):
  pass

# 定义模板引擎:
class TemplateEngine(object):
  def __call__(self, path, model):
    pass

# 缺省使用jinja2:
class Jinja2TemplateEngine(TemplateEngine):
  def __init__(self, templ_dir, **kw):
    from jinja2 import Environment, FileSystemLoader
    self._env = Environment(loader=FileSystemLoader(templ_dir), **kw)

  def __call__(self, path, model):
    return self._env.get_template(path).render(**model).encode('utf-8')

把上面的定义填充完毕,我们就只剩下一件事情:定义全局WSGIApplication的类,实现WSGI接口,然后,通过配置启动,就完成了整个Web框架的工作。

设计WSGIApplication要充分考虑开发模式(Development Mode)和产品模式(Production Mode)的区分。在产品模式下,WSGIApplication需要直接提供WSGI接口给服务器,让服务器调用该接口,而在开发模式下,我们更希望能通过app.run()直接启动服务器进行开发调试:

wsgi = WSGIApplication()
if __name__ == '__main__':
  wsgi.run()
else:
  application = wsgi.get_wsgi_application()

因此,WSGIApplication定义如下:

class WSGIApplication(object):
  def __init__(self, document_root=None, **kw):
    pass

  # 添加一个URL定义:
  def add_url(self, func):
    pass

  # 添加一个Interceptor定义:
  def add_interceptor(self, func):
    pass

  # 设置TemplateEngine:
  @property
  def template_engine(self):
    pass

  @template_engine.setter
  def template_engine(self, engine):
    pass

  # 返回WSGI处理函数:
  def get_wsgi_application(self):
    def wsgi(env, start_response):
      pass
    return wsgi

  # 开发模式下直接启动服务器:
  def run(self, port=9000, host='127.0.0.1'):
    from wsgiref.simple_server import make_server
    server = make_server(host, port, self.get_wsgi_application())
    server.serve_forever()
Try

把WSGIApplication类填充完毕,我们就得到了一个完整的Web框架。

Python 相关文章推荐
Python中的exec、eval使用实例
Sep 23 Python
Python for Informatics 第11章 正则表达式(一)
Apr 21 Python
python中常用的九种预处理方法分享
Sep 11 Python
Django接受前端数据的几种方法总结
Nov 04 Python
Python内置函数OCT详解
Nov 09 Python
Python元组知识点总结
Feb 18 Python
Python for循环与range函数的使用详解
Mar 23 Python
python 中pyqt5 树节点点击实现多窗口切换问题
Jul 04 Python
Python pandas 列转行操作详解(类似hive中explode方法)
May 18 Python
基于Django快速集成Echarts代码示例
Dec 01 Python
PyQt 如何创建自定义QWidget
Mar 24 Python
解决Pytorch半精度浮点型网络训练的问题
May 24 Python
编写Python的web框架中的Model的教程
Apr 29 #Python
python获取本地计算机名字的方法
Apr 29 #Python
Python中编写ORM框架的入门指引
Apr 29 #Python
python获取本机mac地址和ip地址的方法
Apr 29 #Python
在Python中编写数据库模块的教程
Apr 29 #Python
Python的gevent框架的入门教程
Apr 29 #Python
在Python中使用HTML模版的教程
Apr 29 #Python
You might like
PHP 使用header函数设置HTTP头的示例解析 表头
2013/06/17 PHP
Linux下创建nginx脚本-start、stop、reload…
2014/08/03 PHP
HR vs CL BO3 第一场 2.13
2021/03/10 DOTA
js获取IP和PcName(IE)在vs中可用
2013/08/02 Javascript
jquery parent和parents的区别分析
2013/10/02 Javascript
js调试系列 控制台命令行API使用方法
2014/06/18 Javascript
jQuery中clearQueue()方法用法实例
2014/12/29 Javascript
原生javascript实现隔行换色
2015/01/04 Javascript
JS定义类的六种方式详解
2016/05/12 Javascript
js正则表达式replace替换变量方法
2016/05/21 Javascript
深入理解js数组的sort排序
2016/05/28 Javascript
JS提示:Uncaught SyntaxError:Unexpected token ) 错误的解决方法
2016/08/19 Javascript
详解如何用VUE写一个多用模态框组件模版
2018/09/27 Javascript
小程序自定义单页面、全局导航栏的实现代码
2019/03/15 Javascript
vue中axios请求的封装实例代码
2019/03/23 Javascript
解决vue v-for src 图片路径问题 404
2019/11/12 Javascript
d3.js 地铁轨道交通项目实战
2019/11/27 Javascript
vue-router路由懒加载及实现的3种方式
2021/02/28 Vue.js
[00:52]DOTA2齐天大圣预告片
2016/08/13 DOTA
[00:20]TI9不朽观赛名额抽取
2019/08/05 DOTA
Python编码时应该注意的几个情况
2013/03/04 Python
零基础写python爬虫之抓取百度贴吧并存储到本地txt文件改进版
2014/11/06 Python
python 正确保留多位小数的实例
2018/07/16 Python
对Python3使运行暂停的方法详解
2019/02/18 Python
Python数据可视化:顶级绘图库plotly详解
2019/12/07 Python
使用python执行shell脚本 并动态传参 及subprocess的使用详解
2020/03/06 Python
django列表筛选功能的实现代码
2020/03/27 Python
Python如何telnet到网络设备
2021/02/18 Python
HTML5实现应用程序缓存(Application Cache)
2020/06/16 HTML / CSS
Harman Audio官方商店:购买JBL、Harman Kardon、Infinity和AKG
2019/12/05 全球购物
保安公司服务承诺书
2014/05/28 职场文书
应届生面试求职信
2014/07/02 职场文书
企业公益活动策划方案
2014/08/24 职场文书
转学证明范本
2015/06/19 职场文书
运动会200米广播稿
2015/08/19 职场文书
MySQL分区表管理命令汇总
2022/03/21 MySQL