PasteDeploy

不知不觉已经写了几篇有关 WSGI 的博文了，继续坚持。嗯，再来一篇，哈哈！

在以前博文 WSGI 和 Webob 中我们已经知道可以用原始或者装饰器的方法来实现应用的串联（中间件加应用）。这种方式应付比较简单的情况还可以，但如果出现多个中间件加应用的情况，这种方式就会有点力不从心了，代码逻辑的维护估计也是够呛。这时，PasteDeploy 的出现就可以解决我们的问题。PasteDeploy 利用配置文件就可以配置各种中间件和应用，让我们不用考虑中间件与中间件之间、中间件与应用之间的对接问题。这样一来，我们就可以专注实现各种中间件和应用的逻辑。

关于 PasteDeploy 的详细介绍，可参考以下几个资料：

• 官方文档
• Python.Paste 指南之 Deploy

本文就不打算重新说一遍了，而是重点关注一些值得注意的地方。

另外，PasteDeploy 会用到 paste 其他组件，所以如果我们要研究源码，可以同时下载这两者的代码：

• PasteDeploy
• Paste

这两者都是使用 Mercurial 进行源码管理，如果要 clone 的话要安装 Mercurial 工具。

PasteDeploy 应用实例

博文 Python PasteDeploy 笔记的例子感觉很不错，所以就直接拿来改动下（主要是代码规范优化，原谅我的强迫症…）。先来看下配置文件：

[DEFAULT]
key1 = value1
key2 = value2
key3 = values

[filter:logrequest]
username = root
password = root123
paste.filter_factory = pastedeploylab:LogFilter.factory

[app:showversion]
version = 1.0.0
paste.app_factory = pastedeploylab:ShowVersion.factory

[app:calculator]
description = This is an "+-*/" Calculator
paste.app_factory = pastedeploylab:Calculator.factory

[pipeline:root]
pipeline = logrequest showversion

[pipeline:calc]
pipeline = logrequest calculator

[composite:main]
use = egg:Paste#urlmap
/ : root
/calc : calc

源码：

'''
Created on 2011-6-12
@author: Sonic
'''
import os
from webob import Request
from webob import Response
from paste.deploy import loadapp
from wsgiref.simple_server import make_server


# Filter
class LogFilter(object):
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        print 'filter:LogFilter is called.'
        return self.app(environ, start_response)

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print 'in LogFilter.factory', global_conf, kwargs
        return LogFilter	# 注意 PasteDeploy 流水线中间件返回的不是类实例，因为它还用用应用初始化（__init__(self, app)）


class ShowVersion(object):
    def __init__(self):
        pass

    def __call__(self, environ, start_response):
        print 'app:ShowVersion is called.'
        start_response('200 OK', [('Content-type', 'text/plain')])
        return ['Paste Deploy LAB: Version = 1.0.0', ]

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print 'in ShowVersion.factory', global_conf, kwargs
        return ShowVersion()	# PasteDeploy 流水线最终应用，直接返回类实例即可


class Calculator(object):
    def __init__(self):
        pass

    def __call__(self, environ, start_response):
        print 'app:Calculator is called.'

        req = Request(environ)
        res = Response()
        res.status = '200 OK'
        res.content_type = 'text/plain'

        # get operands
        op = req.GET.get('op', u'plus')
        opnd1 = req.GET.get('opnd1', u'1')
        opnd2 = req.GET.get('opnd2', u'1')

        opnd1 = int(opnd1)
        opnd2 = int(opnd2)
        result = 0
        if op == u'plus':
            result = opnd1 + opnd2
        elif op == u'minus':
            result = opnd1 - opnd2
        elif op == u'multiply':
            result = opnd1 * opnd2
        elif op == u'divide':
            result = opnd1 / opnd2

        res.body = '%d %s %d Equals = %d' % (opnd1, str(op), opnd2, result)
        return res(environ, start_response)

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print "in Calculator.factory", global_conf, kwargs
        return Calculator()	# PasteDeploy 流水线最终应用，直接返回类实例即可


if __name__ == '__main__':
    app_name = 'main'
    config_file = 'pastedeploylab.ini'
    wsgi_app = loadapp('config:%s' % os.path.abspath(config_file), app_name)
    server = make_server('localhost', 8080, wsgi_app)
    server.serve_forever()

通过配置文件，我们知道总共有 2 个应用 showversion 和 calculator；1 个过滤器 logrequest；2 个流水线 root 和 calc。最后，我们使用 Paste 包的 urlmap 工具。如果我们看一下 urlmap 源码，我们会发现其实它也是一个 WSGI 应用（真是“万物”皆 WSGI 应用。其实，我们还可以想一下，为什么 URLMap 必须是一个 WSGI 应用呢？）：

# paste/urlmap.py

class URLMap(DictMixin):
    ......

    def __call__(self, environ, start_response):
        host = environ.get('HTTP_HOST', environ.get('SERVER_NAME')).lower()
        if ':' in host:
            host, port = host.split(':', 1)
        else:
            if environ['wsgi.url_scheme'] == 'http':
                port = '80'
            else:
                port = '443'
        path_info = environ.get('PATH_INFO')
        path_info = self.normalize_url(path_info, False)[1]
        for (domain, app_url), app in self.applications:
            if domain and domain != host and domain != host+':'+port:
                continue

            # url 分发，如当我们在浏览器输入 http://ip:port/calc，此时 path_info 为 /calc，
            # 跟 self.applications（流水线 pipeline:root 和 pipeline:calc）中的 app_url （/ 和 /calc） 匹配后，
            # 就会将请求分发到对应的流水线 pipeline:calc，接着调用流水线指定的第一个应用（中间件） LogFilter，
            # 再由该应用调用 Calculator 应用。
            if (path_info == app_url
                or path_info.startswith(app_url + '/')):
                environ['SCRIPT_NAME'] += app_url
                environ['PATH_INFO'] = path_info[len(app_url):]
                return app(environ, start_response)  # 实际调用 LogFilter
        environ['paste.urlmap_object'] = self
        return self.not_found_application(environ, start_response)

所以，知道这个工作流程后，其实我们会发现，其实 PasteDeploy 做的工作很简单，通过解析配置文件，建立起中间件、应用的流水线。这就是这个工具的重点。

初始化及调用 pipeline 的执行顺序

如果我们运行上边的例子，我们会得到下边的输出：

in Calculator.factory ...
in LogFilter.factory ...
in ShowVersion.factory ...
in LogFilter.factory ...

但如果我们在浏览器输入 http://ip:8080/ 及 http://ip:8080/calc?op=plus&opnd1=1&opnd2=2 则可以在控制台看到如下结果：

filter:LogFilter is called.
app:ShowVersion is called.
filter:LogFilter is called.
app:Calculator is called.

也就是说，初始化 pipeline 和调用 pipeline 的执行顺序是相反的。以 pipeline root 为例，前者的执行顺序相当于 LogFilter.factory(ShowVersion.factory)，先执行的是括号里边的函数；后者的执行顺序相当于 ShowVersion.__call__(LogFilter.__call__)，先执行的是也是括号里边的函数。

PasteDeploy 与 Webob

对上面的例子，我们还可以进一步优化，利用 webob.dec.wsgify 装饰器来将类转化为 WSGI 应用：

'''
Created on 2011-6-12
@author: Sonic
'''
import os
from webob import Response
from webob.dec import wsgify
from paste.deploy import loadapp
from wsgiref.simple_server import make_server


# Filter
class LogFilter(object):
    def __init__(self, app):
        self.app = app

    @wsgify
    def __call__(self, req):
        print 'filter:LogFilter is called.'
        return self.app

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print 'in LogFilter.factory', global_conf, kwargs
        return LogFilter	# 注意 PasteDeploy 流水线中间件返回的不是类实例，因为它还用用应用初始化（__init__(self, app)）


class ShowVersion(object):
    def __init__(self):
        pass

    @wsgify
    def __call__(self, req):
        print 'app:ShowVersion is called.'
        return Response('Paste Deploy LAB: Version = 1.0.0')

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print 'in ShowVersion.factory', global_conf, kwargs
        return ShowVersion()	# PasteDeploy 流水线最终应用，直接返回类实例即可


class Calculator(object):
    def __init__(self):
        pass

    @wsgify
    def __call__(self, req):
        print 'app:Calculator is called.'

        res = Response()
        res.status = '200 OK'
        res.content_type = 'text/plain'

        # get operands
        op = req.GET.get('op', u'plus')
        opnd1 = req.GET.get('opnd1', u'1')
        opnd2 = req.GET.get('opnd2', u'1')

        opnd1 = int(opnd1)
        opnd2 = int(opnd2)
        result = 0
        if op == u'plus':
            result = opnd1 + opnd2
        elif op == u'minus':
            result = opnd1 - opnd2
        elif op == u'multiply':
            result = opnd1 * opnd2
        elif op == u'divide':
            result = opnd1 / opnd2

        res.body = '%d %s %d Equals = %d' % (opnd1, str(op), opnd2, result)
        return res

    @classmethod
    def factory(cls, global_conf, **kwargs):
        print "in Calculator.factory", global_conf, kwargs
        return Calculator()	# PasteDeploy 流水线最终应用，直接返回类实例即可


if __name__ == '__main__':
    app_name = 'main'
    config_file = 'pastedeploylab.ini'
    wsgi_app = loadapp('config:%s' % os.path.abspath(config_file), app_name)
    server = make_server('localhost', 8080, wsgi_app)
    server.serve_forever()