大多数人能够理解“配置文件”是包含了能够影响一个应用如何运作的设置的文件。当我们看到一个以ini结尾的文件时,很容易能够想到它会在应用启动时作为“配置文件”被加载。
但是,如果你足够聪明,你很容易能够理解 代码 也可以起到“配置文件”的作用。Pyramid框架和其他大多数的web应用平台一样,是一个所谓的框架,它能够调用你编写的代码(这与库函数的性质截然相反,库函数的存在是为了给你调用的)。您将您编写的应用程序代码插入Pyramid应用的行为在本文中也被称为是一种“配置”。你将通过 配置 Pyramid的方式调用代码来组建你的应用。
关于 Pyramidy应用的
.ini
文件的更多信息请参见后面的startup章节
命令式配置
“命令式配置”是指由python语言一句一句进行配置的。以下是一个最简单的使用命令式配置的Pyramid应用:
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
def hello_world(request):
return Response('Hello world!')
if __name__ == '__main__':
with Configurator() as config:
config.add_view(hello_world)
app = config.make_wsgi_app()
server = make_server('0.0.0.0', 8080, app)
server.serve_forever()
我们在这不会过多的讨论这个应用做了什么。请关注在处于 if __name__ == '__main__':
之下的代码块中的配置声明,它们通过调用Configurator类的一个实例的方法完成配置(例如config.add_view(...)
)。这些代码一句接着一句,并且被按顺序执行,也就是说这部分的配置,完全是条件式地用python代码来完成的。
声明式配置
有时候完全通过命令式的代码来完成配置是很痛苦的事,因为在大多数时候我们应用的代码会分布在很多的文件中。如果将配置全部集中在一处,你又将面临这样一个问题:你需要同时关注至少两个文件,一个包含了所有的配置项,另一个包含了这些配置项所指向的对象。为了避免这种情况,Pyramid允许你直接将配置装饰器以注解的形式插入到你写的代码之上,配置装饰器将会为被插入的代码装饰配置属性。举个栗子:
from pyramid.response import Response
from pyramid.view import view_config
@view_config(name='hello', request_method='GET')
def hello(request):
return Response('Hello')
仅仅添加了配置装饰器不会立即让任何的配置生效。在它对Pyramid应用的配置生效之前,它必须在应用代码中通过扫描器被找到,它就是scan。
举个栗子,在上面的代码例子中pyramid.view.view_config
装饰器向hello函数添加了一个特殊属性,使得它能够被扫描器找到。
一个模块或者包的扫描过程发生在pyramid.config.Configurator.scan()
方法被调用之后:扫描行为将会在所有的包及其子包中搜索配置装饰器。举个栗子:
from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import view_config
@view_config()
def hello(request):
return Response('Hello')
if __name__ == '__main__':
with Configurator() as config:
config.scan()
app = config.make_wsgi_app()
server = make_server('0.0.0.0', 8080, app)
server.serve_forever()
扫描器通过递归的方式从包或者模块中带入每个子模块和子包,寻找代表了配置声明的特殊的属性。这些特殊属性通常是通过注解形式的装饰器来附加在代码之上的。例如,view_config
装饰器可以通过注解附加到一个函数或者实例方法之上。
一旦扫描器被调用,并且通过扫描器找到了配置装饰器,框架就会通过一系列的调用帮您完成配置工作。这让我们不需要再使用零散的命令式的配置方式。
配置装饰器和扫描器的组合被称为声明式配置方式。
在上面的例子中,扫描器将被view_config装饰器所装饰的代码有效地转化成了pyramid.config.Configurator.add_view()
方法的调用:
config.add_view(hello)
总结
这是两种pyramid应用的配置方式:命令式和声明式。你能够自由选择你最适合的方式来配置你的应用,两者是完全等价的。后续的文档中的示例会交替地使用这两种方式。