Python Web框架Sanic response file() 函数用法和示例

发表时间:2020-02-18

response.file() 功能: Sanic 返回文件数据给浏览器,以此实现文件下载功能。

Sanic response.file() 函数

response.file() 语法


async def file(
    location,
    status=200,
    mime_type=None,
    headers=None,
    filename=None,
    _range=None,
):

读写文件是一个IO操作,所以这是一个异步函数,使用时记得加 await

response.file() 参数

  • location:响应要返回的文件的路径;
  • status:默认 http 状态码200,正常返回不要修改;
  • mime_type:文件格式;
  • headers:自定义 http 响应头;
  • filename:如果传值则写入响应头headers的 Content-Disposition
  • _range :指定文件的某一部分;

这里面, location 是必需的参数;
可以通过传入 headers 来自定义响应头;
如果没有传入 mime_type 参数,其内部会使用模块 mimetypes mimetypes.guess_type() 函数通过 filename 来获得;
_range 对象需要有四个属性: start, end, size, total 来描述截取文件中的某一部分。

response.file() 返回值

返回一个 HTTPResponse 类的实例。多数情况下,路由函数直接返回这个实例。当需要再进一步处理响应(比如,设置响应cookies)时,要把它赋值给一个变量。

response.file() 例子

from sanic import Sanic
from sanic import response


app = Sanic()


@app.route('/file')
async def file(request):
    return await response.file(
        './welcom-to-猿人学.jpg',
        headers={'X-Serverd-By': 'YuanRenXue Python'}
    )


if __name__ == '__main__':
    app.run(host='127.0.0.1', port=8888, debug=True)

通过 echo 创建一个假的jpg文件,其内容为“Welcom to 猿人学Python”,再通过 curl 来查看file响应:

echo "Welcom to 猿人学Python" > ./welcom-to-猿人学.jpg
curl -i http://127.0.0.1:8888/file

结果如下,可以看到我们自定义的headers X-Serverd-By: YuanRenXue Python


HTTP/1.1 200 OK
Connection: keep-alive
Keep-Alive: 5
X-Serverd-By: YuanRenXue Python
Content-Length: 10
Content-Type: image/jpeg

Welcom to 猿人学Python

文章来源互联网,如有侵权,请联系管理员删除。邮箱:417803890@qq.com / QQ:417803890

微配音

Python Free

邮箱:417803890@qq.com
QQ:417803890

皖ICP备19001818号-4
© 2019 copyright www.pythonf.cn - All rights reserved

微信扫一扫关注公众号:

联系方式

Python Free