Python Pyramid - 视图配置

上一页
下一页

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

有三种方法可以配置视图：

  • 使用 add_view() 方法

  • 使用 @view_config() 装饰器

  • 使用 @view_defaults() 类装饰器

使用 add_view() 方法

这是通过调用Configurator对象的add_view()方法以命令式方式配置视图的最简单方法。

此方法使用以下参数：

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

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

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

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

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

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

示例

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

当使用 GET 方法请求 URL /get 时，调用 getview() 函数。类似地，当使用 POST 方法请求/post路径时，执行 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 https://:6543/post
Method: POST

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

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 https://:6543/view
Method: POST
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X PUT https://:6543/view
Method: PUT
C:\Users\Acer>curl -X DELETE https://: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 https://: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 https://:6543/view
hello POST
C:\Users\Acer>curl -d "param1=value1" -H "Content-Type: application/json" -X PUT https://:6543/view
hello PUT
C:\Users\Acer>curl -X DELETE https://:6543/view
hello DELETE
打印页面
上一页
下一页
广告
© . All rights reserved.