Sanic​——Python函数变成API的神器

2023-10-16 20:36

本文主要是介绍Sanic​——Python函数变成API的神器,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

640?wx_fmt=png&wxfrom=13&tp=wxpic


今天给大家介绍一个超好用的框架,迅速将Python函数变成API,它就是最近越来越火的异步Web框架Sanic

1. Sanic简介

Sanic 是 Python3.7+ Web 服务器和 Web 框架,旨在提高性能。它允许使用 Python3.5 中添加的async/await语法,这使得您的代码有效的避免阻塞从而达到提升响应速度的目的。

看到这里,可能你会注意到,Sanic的一个显著特性就是高性能,由于支持async/await语法,它的执行速度会非常的快。

在GitHub上面有一个项目专门是给各种语言的web框架进行压测(传送门)。

框架每秒处理请求数(64并发)每秒处理请求数(256并发)每秒处理请求数(512并发)
starlette (0.20)50,90053,04853,094
sanic (22.6)49,14851,76251,300
fastapi (0.81)34,19236,86636,668
falcon (3.1)22,12221,60621,323
flask (2.2)13,94513,83013,661
tornado (6.2)13,65514,49613,924
django (4.1)8,0017,9408,002

可以看出来,Sanic在常用的Python框架中,速度是处在领先地位的。

除了高性能之外,Sanic一个超方便的地方就是可以部署在生产环境,它自带了一个Web服务器,可以使用Run方法直接启动应用。当然除此之外,您还可以使用支持ASGI(Asynchronous Server Gateway Interface)应用的服务器来部署Sanic,或者使用Gunicorn.

在这里还要特别提一下Sanic的社区,Sanic的网站拥有完善的中文用户手册,该网站是由贡献者自主发起且受官方承认,由翻译者进行翻译贡献,由Sanic官方团队进行发布,很适合英文不太好的小伙伴阅读学习。

社区非常欢迎新的贡献者加入,可以在GitHub上面浏览标记好的问题,也可以在论坛上进行提问、讨论、解答。

2. 快速上手

首先,我们需要先安装Sanic框架。

pip install sanic

现在,来写一个Hello World

from sanic import Sanic
from sanic.response import textapp = Sanic("HelloWorld")@app.get("/hello")
async def hello_world(request):return text("Hello, this is my first app in Sancic framework.")

注意,必须使用response或继承自response的类作为相应类型。在许多其他框架中,它们允许您使用诸如return "Hello World"或者return {"foo":"bar"}的方式来进行返回,但是为了执行这类隐式调用,需要在响应流程中的某个位置花费大量的时间来确定您到底想要表达什么意思。因此,我们以轻松调用为代价,来提升服务的响应速度,Sanic会要求您对您的响应进行显式调用

将上面的代码保存为HelloWorld.py,然后用下面命令执行,它会调用内置的Web服务器运行程序。

sanic HelloWorld.app

如果执行命令的时候遇到下面的报错,检查一下是否已经将脚本所在目录(通常为C:\Users%userid%\AppData\Roaming\Python\Python310\Scripts)放在环境变量中。

'sanic' is not recognized as an internal or external command,
operable program or batch file.

命令执行成功会出现下面的提示:

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1

从提示中可以看出来,sanic模式是运行在生产模式,可以通过加启动参数--debug或者--dev用于开发模式。

现在我们来看看效果:

使用浏览器打开网址http://localhost:8000/hello

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1

也可以使用其它API测试工具比如Postman来测试:

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1

服务启动的默认端口是8000,如果想要修改端口,可以使用启动参数或者代码中声明的方式。

启动参数指定端口

sanic HelloWorld.app --host=127.0.0.1 --port=7890

通过代码指定端口

app.run(host='127.0.0.1', port=7890)

run方法支持以下几个关键字参数:

参数名称默认值参数说明
host"127.0.0.1"服务器监听的地址。
port8000服务器监听的端口。
unixNoneUnix套接字文件(不是TCP)。
debugFalse开启DEBUG输出(降低服务器性能)。
sslNoneSSLContext,子进程用于 SSL 加密。
sockNone服务器接受连接的套接字。
workers1要生成的子进程数量。
loopNone一个兼容 asyncio 的事件循环。如果没有指定,Sanic 会创建自己的事件循环。
protocolHttpProtocolasyncio.protocol 子类。
access_logTrue启用请求访问日志(显著降低服务器速度)。

可以使用python HellowWorld.py来运行带有app.run(...)方法的程序。

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1

3. 实现Get和Post接口

Sanic通过注解来定义接口方法,用一个简单的加减运算作为例子。

from sanic import Sanic
from sanic.response import text, jsonapp = Sanic("HelloWorld")@app.get("/add")
async def addXY(request):parameters = request.argsx = float(parameters['x'][0])y = float(parameters['y'][0])result = str(x + y)return text("The result is: " + result)@app.post("minus")
async def minusXY(request):parameters = request.jsonx = float(parameters['x'])y = float(parameters['y'])result = x - yreturn json({"Result": result})app.run(host='127.0.0.1', port=7890)

使用Postman调用接口

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1

640?wx_fmt=png&tp=wxpic&wxfrom=5&wx_lazy=1&wx_co=1


以上,相信您已经对Sanic框架有了一个基本的了解,也掌握了快速搭建api接口以及测试的方法。如果大家觉得文章还不错的话,欢迎大家三连(点赞+在看+收藏)。

这篇关于Sanic​——Python函数变成API的神器的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/220638

相关文章

Python错误AttributeError: 'NoneType' object has no attribute问题的彻底解决方法

《Python错误AttributeError:NoneTypeobjecthasnoattribute问题的彻底解决方法》在Python项目开发和调试过程中,经常会碰到这样一个异常信息... 目录问题背景与概述错误解读:AttributeError: 'NoneType' object has no at

Python使用openpyxl读取Excel的操作详解

《Python使用openpyxl读取Excel的操作详解》本文介绍了使用Python的openpyxl库进行Excel文件的创建、读写、数据操作、工作簿与工作表管理,包括创建工作簿、加载工作簿、操作... 目录1 概述1.1 图示1.2 安装第三方库2 工作簿 workbook2.1 创建:Workboo

基于Python实现简易视频剪辑工具

《基于Python实现简易视频剪辑工具》这篇文章主要为大家详细介绍了如何用Python打造一个功能完备的简易视频剪辑工具,包括视频文件导入与格式转换,基础剪辑操作,音频处理等功能,感兴趣的小伙伴可以了... 目录一、技术选型与环境搭建二、核心功能模块实现1. 视频基础操作2. 音频处理3. 特效与转场三、高

Python实现中文文本处理与分析程序的示例详解

《Python实现中文文本处理与分析程序的示例详解》在当今信息爆炸的时代,文本数据的处理与分析成为了数据科学领域的重要课题,本文将使用Python开发一款基于Python的中文文本处理与分析程序,希望... 目录一、程序概述二、主要功能解析2.1 文件操作2.2 基础分析2.3 高级分析2.4 可视化2.5

一文解密Python进行监控进程的黑科技

《一文解密Python进行监控进程的黑科技》在计算机系统管理和应用性能优化中,监控进程的CPU、内存和IO使用率是非常重要的任务,下面我们就来讲讲如何Python写一个简单使用的监控进程的工具吧... 目录准备工作监控CPU使用率监控内存使用率监控IO使用率小工具代码整合在计算机系统管理和应用性能优化中,监

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

Python实现终端清屏的几种方式详解

《Python实现终端清屏的几种方式详解》在使用Python进行终端交互式编程时,我们经常需要清空当前终端屏幕的内容,本文为大家整理了几种常见的实现方法,有需要的小伙伴可以参考下... 目录方法一:使用 `os` 模块调用系统命令方法二:使用 `subprocess` 模块执行命令方法三:打印多个换行符模拟

Python实现MQTT通信的示例代码

《Python实现MQTT通信的示例代码》本文主要介绍了Python实现MQTT通信的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 安装paho-mqtt库‌2. 搭建MQTT代理服务器(Broker)‌‌3. pytho

MySQL字符串常用函数详解

《MySQL字符串常用函数详解》本文给大家介绍MySQL字符串常用函数,本文结合实例代码给大家介绍的非常详细,对大家学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql字符串常用函数一、获取二、大小写转换三、拼接四、截取五、比较、反转、替换六、去空白、填充MySQL字符串常用函数一、

基于Python开发一个图像水印批量添加工具

《基于Python开发一个图像水印批量添加工具》在当今数字化内容爆炸式增长的时代,图像版权保护已成为创作者和企业的核心需求,本方案将详细介绍一个基于PythonPIL库的工业级图像水印解决方案,有需要... 目录一、系统架构设计1.1 整体处理流程1.2 类结构设计(扩展版本)二、核心算法深入解析2.1 自