当前位置：网站首页>Pecan — @expose()

Pecan — @expose()

2022-07-03 19:14:00 【Procedural ape treading on colorful auspicious clouds】

List of articles

@expose()

pecan.expose Can mark controller Method , So that this method can pass http visit .

pecan.expose The definition is as follows ：

pecan.expose(template=None, generic=False, route=None, **kw)

template： The path of the template . It can also be a renderer represented by strings , for example ‘json’.
content_type： by template Appoint content-type
generic：boolean value , When it comes to true when , The same path will result from http Different methods are routed to the corresponding methods .
route： Specify the name of the path segment . The default is the function name .

Example ：

hello Method will return Hello World As HTML Response body

from pecan import expose

class RootController(object):
    @expose()
    def hello(self):
        return 'Hello World'

expose() You can use the same method multiple times .

from pecan import expose

class RootController(object):
    @expose('json')
    @expose('text_template.mako', content_type='text/plain')
    @expose('html_template.mako')
    def hello(self):
        return {
    'msg': 'Hello!'}

<!-- html_template.mako -->
<html>
    <body>${msg}</body>
</html>

@expose(‘json’) Will use JSON Serialize the return value , The request path is /hello.json

@expose(‘text_template.mako’, content_type=‘text/plain’) Will use text_template.mako Rendering , The request path is /hello.txt

@expose(‘html_template.mako’) The request path is /hello.html, Default content-type by text/html

Specify path segments

If you want to use include - The path of , for example /some-path, But in Python in , Method names cannot contain -. At this point, you can specify expose Of route value .

Example ：

Only through /some-path Path successfully accessed . and /some_path Will return 404

class RootController(object):

    @pecan.expose(route='some-path')
    def some_path(self):
        return dict()

Routing based on request method

generic by true when , The same path can be routed to the corresponding method according to the request method .

as follows ,index Handle http GET /,index_POST Handle http POST /

expose Will generate f.when Decorator .

from pecan import expose


class RootController(object):

    # HTTP GET /
    @expose(generic=True, template='json')
    def index(self):
        return dict()

    # HTTP POST /
    @index.when(method='POST', template='json')
    def index_POST(self, **kw):
        uuid = create_something()
        return dict(uuid=uuid)