Python Pyramid 简明教程

Python Pyramid - View Configuration

术语“视图配置”指的是将视图可调用对象（一个函数、方法或类）与路由配置的信息关联的机制。Kimono 为给定的 URL 模式找到最佳可调用对象。

有三种配置 view 的方式 −

  1. Using add_view() method

  2. Using @view_config() decorator

  3. 使用 @view_defaults 类装饰器

Using add_view() Method

这是通过调用 Configurator 对象的 add_view() 方法来严格配置视图的最简单方法。

此方法使用以下参数 −

  1. name − 与此视图可调用对象匹配所需的视图名称。如果未提供名称，则使用空字符串（表示默认视图）。

  2. context − 此资源必须是 Python 类的对象，以便找到和调用此视图。如果未提供上下文，则使用值 None，该值与任何资源匹配。

  3. route_name − 此值必须与在调用此视图之前必须匹配的路由配置声明的名称匹配。如果提供了 route_name，则仅当已匹配已命名路由时才调用视图可调用对象。

  4. request_type − 请求必须提供的接口才能找到并调用此视图。

  5. request_method − 一个字符串（如“GET”、“POST”、“PUT”、“DELETE”、“HEAD”或“OPTIONS”），表示 HTTP REQUEST_METHOD 或者包含这些字符串中一个或多个的元组。只有当请求的 method 属性与提供的某个值匹配时，才会调用此视图。

  6. request_param − 此参数可以是任何字符串或字符串序列。只有当 request.params 字典具有与提供的某个值匹配的键时，才会调用此视图。

Example

在以下示例中，定义了两个函数 getview() 和 postview() ，并将其与两个同名路由相关联。这些函数仅仅返回调用它们的 HTTP 方法的名称。

在使用 GET 方法请求 URL /get 时，将调用 getview() 函数。类似地，在 POST 方法请求 /post 路径 ID 时，将执行 postview() 函数。

from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
def getview(request):
   ret=request.method
   return Response('Method: {}'.format(ret))
def postview(request):
   ret=request.method
   return Response('Method: {}'.format(ret))

if __name__ == '__main__':
   with Configurator() as config:
      config.add_route('getview', '/get')
      config.add_route('postview', '/post')
      config.add_view(getview, route_name='getview',request_method='GET')
      config.add_view(postview,route_name='postview', request_method='POST')
      app = config.make_wsgi_app()
      server = make_server('0.0.0.0', 6543, app)
      server.serve_forever()

虽然可以使用 Web 浏览器作为 HTTP 客户端发送 GET 请求，但不能将其用于 POST 请求。因此，我们使用 CURL 命令行实用程序。

C:\Users\Acer>curl localhost:6543/get
Method: GET
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X POST http://localhost:6543/post
Method: POST

如前所述， request_method 参数可以是一个或多个 HTTP 方法的列表。不妨修改上述程序并定义一个 oneview() 函数来标识导致其执行的 HTTP 方法。

def oneview(request):
   ret=request.method
   return Response('Method: {}'.format(ret))

此函数在应用程序的配置中为所有 HTTP 方法注册。

config.add_route('oneview', '/view')
config.add_view(oneview, route_name='oneview',
   request_method=['GET','POST', 'PUT', 'DELETE'])

Output

CURL 输出如下所示：

C:\Users\Acer>curl localhost:6543/view
Method: GET
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X POST http://localhost:6543/view
Method: POST
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X PUT http://localhost:6543/view
Method: PUT
C:\Users\Acer>curl -X DELETE http://localhost:6543/view
Method: DELETE

Using @view_config() Decorator

除了命令式添加视图，还可以使用 @view_config 装饰器将配置的路由与函数、方法甚至可调用的类关联起来。

Example

如申明式配置部分所述，可以将注册的路由与函数关联起来，如下例所示：

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')
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()

请注意，只有在调用 scan() 方法后，才会将视图添加到应用程序配置中。虽然消除了命令式添加视图的需要，但性能可能会略微下降。

Output

view_config() 装饰器还可以传递与 add_view() 方法相同的参数。可以省略所有参数。

@view_config()
def hello_world(request):
   return Response('Hello World!')

在这种情况下，该函数将使用任何路由名称、任何请求方法或参数进行注册。

view_config 装饰器在可调用视图函数的定义之前放置，如以上示例所示。如果要将类用作视图可调用对象，也可以将它放在类的顶部。此类必须具有 call () 方法。

在以下 Pyramid 应用程序代码中， MyView 类用作可调用对象，并由 @view_config 装饰器装饰。

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')
class MyView(object):
   def __init__(self, request):
      self.request = request

   def __call__(self):
      return Response('hello World')

if __name__ == '__main__':
   with Configurator() as config:
      config.add_route('hello', '/')
      #config.add_view(MyView, route_name='hello')
      config.scan()
      app = config.make_wsgi_app()
   server = make_server('0.0.0.0', 6543, app)
   server.serve_forever()

请注意，我们可以通过显式调用 add_view() 方法来添加视图，而不扫描视图配置。

Example

如果类中的方法必须与不同的路由关联，则应在每个方法的顶部使用不同的 @view_config()，如以下示例中所示。在此，我们有两个方法绑定到两个单独的路由。

from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import

class MyView(object):
   def __init__(self, request):
      self.request = request

   @view_config(route_name='getview', request_method='GET')
   def getview(self):
      return Response('hello GET')
   @view_config(route_name='postview', request_method='POST')
   def postview(self):
      return Response('hello POST')

if __name__ == '__main__':
   with Configurator() as config:
      config.add_route('getview', '/get')
      config.add_route('postview', '/post')
      config.scan()
      app = config.make_wsgi_app()
   server = make_server('0.0.0.0', 6543, app)
   server.serve_forever()

Output

以下是 CURL 命令的输出：

C:\Users\Acer>curl localhost:6543/get
hello GET
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X POST http://localhost:6543/post
hello POST

Using @view_defaults() Decorator

view_defaults() 是一个类装饰器。如果你必须将类中的方法作为带有某些常见参数和某些特定参数的视图添加，可以在类的顶部 view_defaults() 装饰器中指定常见参数，通过每个方法前面的单独的 view_config() 执行每个方法的配置。

Example

在下面的代码中，我们有不同的方法响应相同的路由但具有不同的 request_method 。因此，我们将路由名称定义为默认，并在每个视图配置中指定 request_method 。

from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import view_config
from pyramid.view import view_defaults

@view_defaults(route_name='myview')
class MyView(object):
   def __init__(self, request):
      self.request = request

   @view_config( request_method='GET')
   def getview(self):
      return Response('hello GET')
   @view_config(request_method='POST')
   def postview(self):
      return Response('hello POST')
   @view_config(request_method='PUT')
   def putview(self):
      return Response('hello PUT')
   @view_config(request_method='DELETE')
   def delview(self):
      return Response('hello DELETE')

if __name__ == '__main__':
   with Configurator() as config:
      config.add_route('myview', '/view')
      config.scan()
      app = config.make_wsgi_app()
   server = make_server('0.0.0.0', 6543, app)
   server.serve_forever()

Output

向服务器发出不同 HTTP 请求的 CURL 命令如下所示−

C:\Users\Acer>curl localhost:6543/view
hello GET
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X POST http://localhost:6543/view
hello POST
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X PUT http://localhost:6543/view
hello PUT
C:\Users\Acer>curl -X DELETE http://localhost:6543/view
hello DELETE