Python Pyramid - 应用程序配置

Pyramid 应用程序对象有一个应用程序注册表，用于存储视图函数到路由的映射以及其他特定于应用程序的组件注册。Configurator 类用于构建应用程序注册表。

配置器生命周期由返回应用程序对象的上下文管理器管理。

with Configurator(settings=settings) as config:
   #configuration methods
   app = config.make_wsgi_app()

Configurator 类定义了以下重要方法来自定义应用程序 -

添加路由（）

此方法注册 URL 调度的路由。使用以下参数 -

  • name - 第一个必需的位置参数必须是路线的唯一名称。该名称用于在注册视图或生成 URL 时标识路由。

  • pattern - 第二个必需的位置参数是表示 URL 路径的字符串，可选地包含用于解析 URL 中的变量数据的变量占位符。占位符由大括号括起来。例如，“/students/{id}”。

  • request_method - 该值可以是“GET”、“POST”、“HEAD”、“DELETE”、“PUT”之一。仅此类型的请求将与路由进行匹配。

添加视图（）

此方法将视图配置添加到应用程序注册表。它将视图函数绑定到配置中存在的route_name 。所需的参数是 -

  • view - 视图函数的名称。

  • Route_name - 必须与路由配置声明的名称匹配的字符串。

  • request_method - 表示 HTTP REQUEST_METHOD 的字符串（例如“GET”、“POST”、“PUT”、“DELETE”、“HEAD”或“OPTIONS”），或包含一个或多个这些字符串的元组。

添加静态视图（）

此方法添加一个用于渲染静态资源（例如图像和 CSS 文件）的视图，并使用以下参数 -

  • name - 该参数是一个字符串，表示与应用程序相关的本地 URL 前缀或完整 URL。

  • 路径- 此参数表示静态文件所在的磁盘路径。它的值可以是绝对路径或包相对路径。

该方法依次调用Configurator对象的add_route()方法。

add_notfound_view()

该方法添加一个视图，当当前请求找不到匹配的视图时要执行。以下代码显示了一个示例 -

from pyramid.config import Configurator
from pyramid.response import Response

def notfound(request):
   return Response('Not Found', status='404 Not Found')
   
config.add_notfound_view(notfound)

add_forbidden_​​view()

配置应用程序注册表，以便定义在引发 HTTPForbidden 异常时要执行的视图。参数列表包含对返回 403 状态响应的函数的引用。如果未提供参数，注册表将添加default_exceptionresponse_view()。

添加异常视图（）

此方法会导致将异常视图功能添加到配置中，以针对指定的异常。

make_wsgi_app()

此方法返回 Pyramid WSGI 应用程序对象。

扫描（）

这是一个用于注册视图的包装器。它导入所有寻找 @view_config 装饰器的应用程序模块。

对于每一个，它都会使用相同的关键字参数调用 config.add_view(view)。对 scan() 函数的调用执行对包和所有装饰的所有子包的扫描。

执行应用程序注册表配置的典型语句序列如以下代码片段所示 -

from pyramid.config import Configurator

with Configurator() as config:
   config.add_route('hello', '/')
   config.add_view(hello_world, route_name='hello')
   app = config.make_wsgi_app()

这种应用程序配置方法称为命令式配置。Pyramid提供了另一种配置方法，称为装饰配置。

声明式配置

有时，通过命令式代码进行配置变得很困难，特别是当应用程序代码分布在许多文件中时。声明式配置是一种方便的方法。Pyramid.view模型定义了view_config——一个函数、类或方法装饰器——它允许视图注册非常接近视图函数本身的定义。

为@view_config()装饰器提供了两个重要的参数。它们是route_name和request_method。它们具有与Configurator 类的add_route()方法中相同的解释。它下面的函数被修饰，以便它绑定到添加到应用程序对象注册表中的路由。

下面给出的是hello_world()视图函数的声明性配置示例-

from pyramid.response import Response
from pyramid.view import view_config

@view_config(route_name='hello', request_method='GET')
def hello_world(request):
   return Response('Hello World!')

view_config 装饰器向 hello_world() 函数添加一个属性，使其可供稍后扫描找到。

例子

配置修饰和扫描调用的组合统称为声明性配置。以下代码使用声明性方法配置应用程序注册表。

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(route_name='hello', request_method='GET')
def hello_world(request):
   return Response('Hello World!')
   
if __name__ == '__main__':
   with Configurator() as config:
      config.add_route('hello', '/')
      config.scan()
      app = config.make_wsgi_app()
   server = make_server('0.0.0.0', 6543, app)
   server.serve_forever()

扫描器将 view_config 的参数转换为对 Pyramid.config.Configurator.add_view() 方法的调用，因此该操作相当于以下语句 -

config.add_view(hello_world, route_name='hello', request_method='GET')

输出

上述程序运行后，WSGI服务器启动。当浏览器访问链接 http://localhost:6543/ 时，将像以前一样呈现“Hello World”消息。

配置