Python Pyramid - 查看配置

---

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

配置视图有三种方法-

• 使用 add_view() 方法

• 使用 @view_config() 装饰器

• 使用@view_defaults()类装饰器

使用 add_view() 方法

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

该方法使用以下参数 -

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

• context - 此资源必须是 Python 类的对象才能找到并调用此视图。如果未提供上下文，则使用与任何资源匹配的值 None。

• Route_name - 该值必须与路由配置声明的名称匹配，在调用此视图之前必须匹配该路由配置声明的名称。如果提供了route_name，则仅当命名路由匹配时才会调用可调用视图。

• request_type - 请求必须提供的接口，以便找到和调用该视图。

• request_method - 表示 HTTP REQUEST_METHOD 的字符串（例如“GET”、“POST”、“PUT”、“DELETE”、“HEAD”或“OPTIONS”）或包含一个或多个这些字符串的元组。仅当请求的方法属性与提供的值匹配时才会调用视图。

• request_param - 该参数可以是任何字符串或字符串序列。仅当 request.params 字典具有与提供的值匹配的键时才会调用该视图。

例子

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

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

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

输出

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

使用 @view_config() 装饰器

@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')
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() 方法后，视图才会添加到应用程序配置中。虽然无需强制添加视图，但性能可能会稍微慢一些。

输出

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() 方法来添加视图，而不是扫描视图配置。

例子

如果类中的方法必须与不同的路由关联，则应在每个方法之上使用单独的 @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()

输出

这是 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

使用 @view_defaults() 装饰器

view_defaults()是一个类装饰器。如果您必须将类中的方法添加为具有一些公共参数和一些特定参数的视图，则可以在类顶部的view_defaults()装饰器中指定公共参数，通过单独的view_config()对每个方法进行配置在他们每一个人面前。

例子

在下面的代码中，我们有不同的方法响应相同的路由，但使用不同的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()

输出

向服务器发出不同 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