前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >sanic中文文档

sanic中文文档

作者头像
py3study
发布2020-01-03 10:47:28
4K0
发布2020-01-03 10:47:28
举报
文章被收录于专栏:python3

入门指南

Install Sanic:python3 -m pip install sanic example

代码语言:javascript
复制
from sanic import Sanic
from sanic.response import text
app = Sanic(__name__)
@app.route("/")
async def test(request):
    return text('Hello world!')
app.run(host="0.0.0.0", port=8000, debug=True)

路由

路由允许用户为不同的URL端点指定处理程序函数。

demo:

代码语言:javascript
复制
from sanic.response import json
@app.route("/")
async def test(request):
    return json({ "hello": "world" })

url http://server.url/ 被访问(服务器的基本url),最终'/'被路由器匹配到处理程序函数,测试,然后返回一个JSON对象。

请求参数

请求参数

要指定一个参数,可以用像这样的角引号<PARAM>包围它。请求参数将作为关键字参数传递给路线处理程序函数。 demo

代码语言:javascript
复制
from sanic.response import text
@app.route('/tag/<tag>')
async def tag_handler(request, tag):
    return text('Tag - {}'.format(tag))

为参数指定类型,在参数名后面添加(:类型)。如果参数不匹配指定的类型,Sanic将抛出一个不存在的异常,导致一个404页面 demo:

代码语言:javascript
复制
from sanic.response import text
@app.route('/number/<integer_arg:int>')
async def integer_handler(request, integer_arg):
    return text('Integer - {}'.format(integer_arg))
@app.route('/number/<number_arg:number>')
async def number_handler(request, number_arg):
    return text('Number - {}'.format(number_arg))
@app.route('/person/<name:[A-z]+>')
async def person_handler(request, name):
    return text('Person - {}'.format(name))
@app.route('/folder/<folder_id:[A-z0-9]{0,4}>')
async def folder_handler(request, folder_id):
    return text('Folder - {}'.format(folder_id))

请求类型

代码语言:javascript
复制
路由装饰器接受一个可选的参数,方法,它允许处理程序函数与列表中的任何HTTP方法一起工作。
demo_1
from sanic.response import text
@app.route('/post', methods=['POST'])
async def post_handler(request):
    return text('POST request - {}'.format(request.json))
@app.route('/get', methods=['GET'])
async def get_handler(request):
    return text('GET request - {}'.format(request.args))
demo_2
from sanic.response import text
@app.post('/post')
async def post_handler(request):
    return text('POST request - {}'.format(request.json))
@app.get('/get')
async def get_handler(request):
    return text('GET request - {}'.format(request.args))

增加路由

代码语言:javascript
复制
from sanic.response import text
# Define the handler functions
async def handler1(request):
    return text('OK')
async def handler2(request, name):
    return text('Folder - {}'.format(name))
async def person_handler2(request, name):
    return text('Person - {}'.format(name))
# Add each handler function as a route
app.add_route(handler1, '/test')
app.add_route(handler2, '/folder/<name>')
app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])

url_for

Sanic提供了一个urlfor方法,根据处理程序方法名生成url。避免硬编码url路径到您的应用程序 demo

代码语言:javascript
复制
@app.route('/')
async def index(request):
    # generate a URL for the endpoint `post_handler`
    url = app.url_for('post_handler', post_id=5)
    # the URL is `/posts/5`, redirect to it
    return redirect(url)
@app.route('/posts/<post_id>')
async def post_handler(request, post_id):
    return text('Post - {}'.format(post_id))

Notice:

  • 给url equest的关键字参数不是请求参数,它将包含在URL的查询字符串中。例如:
代码语言:javascript
复制
url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two')
# /posts/5?arg_one=one&arg_two=two
  • 所有有效的参数必须传递给url以便构建一个URL。如果没有提供一个参数,或者一个参数与指定的类型不匹配,就会抛出一个URLBuildError 可以将多值参数传递给url
代码语言:javascript
复制
url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'])
# /posts/5?arg_one=one&arg_one=two

WebSocket routes(网络套接字路由)

websocket 可以通过装饰路由实现 demo:

代码语言:javascript
复制
@app.websocket('/feed')
async def feed(request, ws):
    while True:
        data = 'hello!'
        print('Sending: ' + data)
        await ws.send(data)
        data = await ws.recv()
        print('Received: ' + data)
        
另外,添加 websocket 路由方法可以代替装饰器

async def feed(request, ws):
    pass
app.add_websocket_route(my_websocket_handler, '/feed')

响应( response )

text

代码语言:javascript
复制
from sanic import response
@app.route('/text')
def handle_request(request):
    return response.text('Hello world!')

HTML

代码语言:javascript
复制
from sanic import response
@app.route('/html')
def handle_request(request):
    return response.html('<p>Hello world!</p>')

JSON

代码语言:javascript
复制
from sanic import response
@app.route('/json')
def handle_request(request):
    return response.json({'message': 'Hello world!'})

File

代码语言:javascript
复制
from sanic import response
@app.route('/file')
async def handle_request(request):
    return await response.file('/srv/www/whatever.png')
Streaming
代码语言:javascript
复制
from sanic import response
@app.route("/streaming")
async def index(request):
    async def streaming_fn(response):
        response.write('foo')
        response.write('bar')
    return response.stream(streaming_fn, content_type='text/plain')

File Streaming

对于大文件,文件和流的组合

代码语言:javascript
复制
from sanic import response
@app.route('/big_file.png')
async def handle_request(request):
    return await response.file_stream('/srv/www/whatever.png')

Redirect

代码语言:javascript
复制
from sanic import response
@app.route('/redirect')
def handle_request(request):
    return response.redirect('/json')

Raw

没有进行编码的响应

代码语言:javascript
复制
from sanic import response
@app.route(‘/raw ’)
def handle_request(request):
return response.raw(‘ raw data ’)

Modify headers or status

要修改头或状态代码,将标题或状态参数传递给这些函数

代码语言:javascript
复制
from sanic import response
@app.route(‘/json ’)
def handle_request(request):
return response.json(
{‘ message ’: ‘ Hello world!’},
headers={‘ X-Served-By ’: ‘ sanic ’},
status=200
)
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019/09/26 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 入门指南
  • 路由
  • 请求参数
    • 请求参数
    • 请求类型
    • 增加路由
    • url_for
    • WebSocket routes(网络套接字路由)
    • 响应( response )
      • text
        • HTML
          • JSON
            • File
              • Streaming
            • File Streaming
              • Redirect
                • Raw
                  • Modify headers or status
                  领券
                  问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档