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 字符串裁切与提取全面且实用的解决方案

《Python字符串裁切与提取全面且实用的解决方案》本文梳理了Python字符串处理方法,涵盖基础切片、split/partition分割、正则匹配及结构化数据解析(如BeautifulSoup、j... 目录python 字符串裁切与提取的完整指南 基础切片方法1. 使用切片操作符[start:end]2

Python库 Django 的简介、安装、用法入门教程

《Python库Django的简介、安装、用法入门教程》Django是Python最流行的Web框架之一,它帮助开发者快速、高效地构建功能强大的Web应用程序,接下来我们将从简介、安装到用法详解,... 目录一、Django 简介 二、Django 的安装教程 1. 创建虚拟环境2. 安装Django三、创

基于Python编写自动化邮件发送程序(进阶版)

《基于Python编写自动化邮件发送程序(进阶版)》在数字化时代,自动化邮件发送功能已成为企业和个人提升工作效率的重要工具,本文将使用Python编写一个简单的自动化邮件发送程序,希望对大家有所帮助... 目录理解SMTP协议基础配置开发环境构建邮件发送函数核心逻辑实现完整发送流程添加附件支持功能实现htm

Python如何调用另一个类的方法和属性

《Python如何调用另一个类的方法和属性》在Python面向对象编程中,类与类之间的交互是非常常见的场景,本文将详细介绍在Python中一个类如何调用另一个类的方法和属性,大家可以根据需要进行选择... 目录一、前言二、基本调用方式通过实例化调用通过类继承调用三、高级调用方式通过组合方式调用通过类方法/静

基于Python实现温度单位转换器(新手版)

《基于Python实现温度单位转换器(新手版)》这篇文章主要为大家详细介绍了如何基于Python实现温度单位转换器,主要是将摄氏温度(C)和华氏温度(F)相互转换,下面小编就来和大家简单介绍一下吧... 目录为什么选择温度转换器作为第一个项目项目概述所需基础知识实现步骤详解1. 温度转换公式2. 用户输入处

python中update()函数的用法和一些例子

《python中update()函数的用法和一些例子》update()方法是字典对象的方法,用于将一个字典中的键值对更新到另一个字典中,:本文主要介绍python中update()函数的用法和一些... 目录前言用法注意事项示例示例 1: 使用另一个字典来更新示例 2: 使用可迭代对象来更新示例 3: 使用

python连接sqlite3简单用法完整例子

《python连接sqlite3简单用法完整例子》SQLite3是一个内置的Python模块,可以通过Python的标准库轻松地使用,无需进行额外安装和配置,:本文主要介绍python连接sqli... 目录1. 连接到数据库2. 创建游标对象3. 创建表4. 插入数据5. 查询数据6. 更新数据7. 删除

Python中的sort()和sorted()用法示例解析

《Python中的sort()和sorted()用法示例解析》本文给大家介绍Python中list.sort()和sorted()的使用区别,详细介绍其参数功能及Timsort排序算法特性,涵盖自适应... 目录一、list.sort()参数说明常用内置函数基本用法示例自定义函数示例lambda表达式示例o

从基础到高阶详解Python多态实战应用指南

《从基础到高阶详解Python多态实战应用指南》这篇文章主要从基础到高阶为大家详细介绍Python中多态的相关应用与技巧,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、多态的本质:python的“鸭子类型”哲学二、多态的三大实战场景场景1:数据处理管道——统一处理不同数据格式

Python利用GeoPandas打造一个交互式中国地图选择器

《Python利用GeoPandas打造一个交互式中国地图选择器》在数据分析和可视化领域,地图是展示地理信息的强大工具,被将使用Python、wxPython和GeoPandas构建的交互式中国地图行... 目录技术栈概览代码结构分析1. __init__ 方法:初始化与状态管理2. init_ui 方法: