python系列：FASTAPI系列 19返回异常处理 & FASTAPI系列 20-异常处理器exception_handler

已于 2024-06-04 13:04:57 修改
阅读量1.2k 收藏 19
点赞数 28
CC 4.0 BY-SA版权
分类专栏： # python 文章标签： python fastapi 开发语言
于 2024-06-03 19:54:44 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_54626591/article/details/139423102
python 专栏收录该内容
331 篇文章 ¥99.90 ¥299.90
订阅专栏

FASTAPI系列 19返回异常处理 & FASTAPI系列 20-异常处理器exception_handler



一、 FASTAPI系列 19返回异常处理

前言

某些情况下，需要向客户端返回错误提示。这里所谓的客户端包括前端浏览器、其他应用程序、物联网设备等。需要向客户端返回错误提示的场景主要如下：

  • 遇到这些情况时，通常要返回 4XX（400 至 499）HTTP 状态码。

  • 4XX 状态码与表示请求成功的 2XX（200 至 299） HTTP 状态码类似。只不过，4XX 状态码表示客户端发生的错误。

一、使用 HTTPException

向客户端返回 HTTP 错误响应，可以使用 HTTPException。

from fastapi import FastAPI, HTTPException

app = FastAPI(
了解本专栏 订阅专栏 解锁全文
Python面试宝典：Python中与FastApi相关的面试笔试题（1000加面试笔试题助你轻松捕获大厂Offer）
今晚打老虎的专栏
05-28 428
python中与FastApi相关的知识和面试笔试题
FastApi-异常处理(6)
Python进阶专栏《爬虫实战进阶》，《Pyppeteer从入门到精通》原创作者
01-21 602
本文是该专栏的第6篇，后面会持续分享FastApi以及项目实战的各种干货知识。通常情况下，当请求参数不符合规范时，我们需要对请求异常进行处理，返回相应的状态码和提示。这样方便用户快速知道哪里的参数出错，能及时找出解决方法。而本文，笔者将针对FastApi的异常情况以及出现异常的解决方法，进行详细介绍。（附带完整代码）
Python框架篇(4):FastApi-错误处理
weixin_68789096的博客
01-03 1779
新建包app/errors，并新增文件""" 自定义参数验证异常错误"""# 这里response.ResponseFail是上篇文章中的内容在包""" 统一注册自定义错误处理器"""# 注册参数验证错误,并覆盖模式RequestValidationError新建包app/errors，并新增文件"""自定义处理HTTPException"""# 处理404错误content=jsonable_encoder(response.ResponseFail("接口路由不存在~")),
FastAPI系列教程11：Exception异常处理体系详解
GeekABC
10-26 5523
为了在FastAPI应用中友好地向endpoint用户传递异常信息，FastAPI使用HTTPException类、exception_handler装饰器以及middlerware中间件对用户代码中的Exception进行包装呈现。
FastAPI 异常处理
2501_90353350的博客
05-27 664
添加自定义处理器，要使用Starlette 的异常工具。假设要触发的自定义异常叫作 UnicornException。且需要 FastAPI 实现全局处理该异常。"""自定义异常类-用户不存在异常"""detail = "用户不存在""""自定义异常处理器 - 用户不存在:return:""""000","111"# 用户不存在创建项目目录结构commons包下的exceptions.py"""全局的请求参数校验异常:return:"""
fastApi笔记13-异常处理
梦忆安凉的博客
03-07 1026
fastApi 异常处理
FastAPI 异常处理：处理 HTTP 错误、自定义全局异常和覆盖请求校验异常
敲代码别忘了喝上一杯凉白开。
01-14 1337
异常处理是构建健壮 FastAPI 应用的关键要素。本文深入探讨了如何处理常见的 HTTP 错误、如何自定义全局异常处理器以及如何覆盖默认的请求验证异常处理。通过具体示例，您将学会如何使用 `HTTPException` 处理 API 错误，如何创建自定义异常及其处理器，以及如何在 FastAPI 中覆盖 `RequestValidationError` 和 `HTTPException`。掌握这些技巧，能帮助您提升 API 的稳定性与用户体验。
四、Python框架篇: FastApi-错误处理
donkeyboy001的博客
10-23 968
"""自定义处理HTTPException"""# 处理404错误content=jsonable_encoder(HttpResponse.ResponseFail("接口路由不存在~")),# 处理405错误content=jsonable_encoder(HttpResponse.ResponseFail("请求方式错误，请查看文档确认~")),else:"""自定义全局系统错误"""
FO: Will watch for changes in these directories: ['E:\\python\\Python313\\fastapi\\ORM系统'] INFO: Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit) INFO: Started reloader process [8364] using StatReload INFO: Started server process [12812] INFO: Waiting for application startup. INFO: Application startup complete. INFO: 127.0.0.1:63944 - "GET /docs HTTP/1.1" 200 OK INFO: 127.0.0.1:63944 - "GET /openapi.json HTTP/1.1" 200 OK INFO: 127.0.0.1:63944 - "GET /student/ HTTP/1.1" 500 Internal Server Error ERROR: Exception in ASGI application Traceback (most recent call last): File "E:\python\Python313\fastapi\.venv\Lib\site-packages\uvicorn\protocols\http\h11_impl.py", line 403, in run_asgi result = await app( # type: ignore[func-returns-value] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ self.scope, self.receive, self.send ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ) ^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\uvicorn\middleware\proxy_headers.py", line 60, in __call__ return await self.app(scope, receive, send) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\applications.py", line 1054, in __call__ await super().__call__(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\applications.py", line 112, in __call__ await self.middleware_stack(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\errors.py", line 187, in __call__ raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\errors.py", line 165, in __call__ await self.app(scope, receive, _send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\middleware\exceptions.py", line 62, in __call__ await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 53, in wrapped_app raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 42, in wrapped_app await app(scope, receive, sender) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 714, in __call__ await self.middleware_stack(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 734, in app await route.handle(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 288, in handle await self.app(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 76, in app await wrap_app_handling_exceptions(app, request)(scope, receive, send) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 53, in wrapped_app raise exc File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\_exception_handler.py", line 42, in wrapped_app await app(scope, receive, sender) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\starlette\routing.py", line 73, in app response = await f(request) ^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\routing.py", line 301, in app raw_response = await run_endpoint_function( ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ...<3 lines>... ) ^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\fastapi\routing.py", line 212, in run_endpoint_function return await dependant.call(**values) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\ORM系统\api\students.py", line 26, in get_all_students stu1 = await Students.filter(sno__gt=2003) ~~~~~~~~~~~~~~~^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\models.py", line 1323, in filter return cls._meta.manager.get_queryset().filter(*args, **kwargs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\manager.py", line 19, in get_queryset return QuerySet(self._model) File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\queryset.py", line 337, in __init__ super().__init__(model) ~~~~~~~~~~~~~~~~^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\queryset.py", line 99, in __init__ self.capabilities: Capabilities = model._meta.db.capabilities ^^^^^^^^^^^^^^ File "E:\python\Python313\fastapi\.venv\Lib\site-packages\tortoise\models.py", line 280, in db raise ConfigurationError( f"default_connection for the model {self._model} cannot be None" ) tortoise.exceptions.ConfigurationError: default_connection for the model <class 'ORM系统.models.Students'> cannot be None
最新发布
06-30
我们正在解决FastAPI应用在访问学生接口时出现的500内部服务器错误，具体错误信息是“TortoiseORM500Internal ServerError:default_connection forthe modelcannot beNone”。这个错误通常意味着Tortoise ORM在尝试...
【RESTful API构建】：用FastAPI打造YOLOv5模型的Web服务
![【RESTful API构建】：用FastAPI... RESTful API基础与FastAPI简介 ## RESTful API基础 RESTful API是一种基于HTTP协议的软件架构风格，强调使用无状态通信。REST代表表现层状态转换（Representational State Trans
fastapi入门五处理异常
舌尖上的蛋炒饭的博客
12-07 745
fastapi入门五处理异常 """ @File : fastapiOne.py @Desciption： """ import uvicorn from fastapi import FastAPI, HTTPException, Query app = FastAPI() people_id_str = {"1": "2"} people_id_int = [1, 2, 3, 4, 5] @app.post("/fastapi/{people_idone}") async def po
python异常总结
03-05
python异常总结，包括常见的AssertionError、KeyError、TypeError、ValueError等Python异常
FASTAPI系列 20-异常处理器exception_handler
lzq599220的博客
04-11 1325
通常我们可以通过 raise 抛出一个 HTTPException 异常，请求参数不合法会抛出RequestValidationError 异常，这是最常见的2种异常。FastAPI 调用的就是 RequestValidationError 类，因此，如果在 response_model 中使用 Pydantic 模型，且数据有错误时，在日志中就会看到这个错误。但客户端或用户看不到这个错误。反之，客户端接收到的是 HTTP 状态码为 500 的「内部服务器错误」。
FastAPI 学习之路（十九）处理错误/异常
mr~li的博客
08-29 2265
异常处理
FastAPI从入门到实战（12）——错误处理
欢迎自九陌而来的你做客九陌斋！
12-03 2752
错误提示是非常重要的，比如权限控制、资源控制等场景，需要服务器返回给用户错误提示，包括状态码和提示等内容，所以本文就主要记录FastAPI里的错误处理相关的内容
FASTAPI系列 19返回异常处理
lzq599220的博客
04-09 1058
某些情况下，需要向客户端返回错误提示。这里所谓的客户端包括前端浏览器、其他应用程序、物联网设备等。遇到这些情况时，通常要返回 4XX（400 至 499）HTTP 状态码。4XX 状态码与表示请求成功的 2XX（200 至 299） HTTP 状态码类似。只不过，4XX 状态码表示客户端发生的错误。本文介绍了在FastAPI应用中如何通过使用HTTPException来实现对客户端的异常返回处理，以应对特定的错误场景。
FastAPI学习-23.异常处理器 exception_handler
qq_27371025的博客
10-07 718
通常我们可以通过 raise 抛出一个 `HTTPException` 异常，请求参数不合法会抛出`RequestValidationError` 异常，这是最常见的2种异常。
FastAPI学习-24.自定义异常处理器 exception_handler
qq_27371025的博客
10-07 843
假设要触发的自定义异常叫作 `UnicornException`。 且需要 FastAPI 实现全局处理该异常。 此时，可以用 `@app.exception_handler()` 添加自定义异常控制器
python fastapi add_exception_handler
06-25
在 FastAPI 应用中添加自定义异常处理器可以通过 `@app.exception_handler()` 装饰器实现，这一机制允许开发者捕获特定的异常并返回定制化的响应。例如，可以为 `HTTPException` 添加一个全局处理器，以统一处理所有由应用抛出的 HTTP 错误。 以下是一个示例，展示如何添加一个自定义异常处理器来捕获和处理 `HTTPException`： ```python from fastapi import FastAPI, HTTPException from fastapi.responses import JSONResponse app = FastAPI() @app.exception_handler(HTTPException) async def http_exception_handler(request, exc): # 返回一个自定义的 JSON 响应，包含状态码和错误信息 return JSONResponse( status_code=exc.status_code, content={"error": exc.detail}, ) @app.get("/example") async def example_endpoint(): # 抛出一个 HTTP 异常 raise HTTPException(status_code=400, detail="Bad request") ``` 上述代码中，当 `/example` 端点被调用时，会抛出一个 `HTTPException`，其状态码为 400，错误信息为 "Bad request"。由于已经定义了针对 `HTTPException` 的异常处理器，该异常会被捕获，并通过 `JSONResponse` 返回一个格式化的 JSON 响应[^1]。 此外，还可以为非 HTTP 特定的异常（如自定义异常类）添加处理器。例如，定义一个名为 `CustomError` 的异常类，并为其添加一个处理器： ```python class CustomError(Exception): pass @app.exception_handler(CustomError) async def custom_error_handler(request, exc): return JSONResponse( status_code=500, content={"error": "Internal server error"}, ) @app.get("/custom-example") async def custom_example_endpoint(): # 抛出自定义异常 raise CustomError() ``` 在这个例子中，当 `/custom-example` 端点被调用时，会抛出一个 `CustomError` 异常。该异常会被 `custom_error_handler` 捕获，并返回一个状态码为 500 的 JSON 响应，内容为 "Internal server error"[^1]。 这种机制不仅提升了错误处理的一致性，还增强了用户体验，因为客户端可以接收到结构化且有意义的错误信息。 ### 相关问题 1. 如何在 FastAPI 中使用中间件进行请求拦截和处理？ 2. 如何在 FastAPI 中实现 JWT 身份验证？ 3. 如何限制 FastAPI 应用中的并发请求数量？ 4. 如何在 FastAPI 中记录日志以便调试异常？
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

坦笑&&life

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值