FastAPI快速入门2 Pydantic&错误处理

思考未来的虎

2.1 Pydantic简介

Pydantic使用python类型注解进行数据验证和配置管理。这是一款能让您更精确地处理数据结构的工具。例如，到目前为止，我们一直依赖字典来定义项目中的典型配方。有了Pydantic，我们可以这样定义配方：

1. from pydantic import BaseModel
3. class Recipe(BaseModel):
4.     id: int
5.     label: str
6.     source: str
8. raw_recipe = {'id': 1, 'label': 'Lasagna', 'source': 'Grandma Wisdom'}
9. structured_recipe = Recipe(**raw_recipe)
10. print(structured_recipe.id)
11. #> 1

复制代码

Recipe 类继承自Pydantic BaseModel，我们可以使用标准Python类型提示来定义每个预期字段及其类型。
除了使用类型模块的标准类型外，您还可以像这样递归地使用Pydantic模型：

1. from pydantic import BaseModel
3. class Car(BaseModel):
4.     brand: str
5.     color: str
6.     gears: int
9. class ParkingLot(BaseModel):
10.     cars: List[Car]  # recursively use `Car`
11.     spaces: int

复制代码

结合这些功能，您可以定义非常复杂的对象。这只是Pydantic功能的皮毛，以下是对其优势的快速总结：

• 无需学习新的微语言（这意味着它能很好地与集成开发环境/精简器配合使用）
  
• 既可用于 "验证该请求/响应数据"，也可用于加载配置
  
• 验证复杂的数据结构--Pydantic 提供极为精细的验证器
  
• 可扩展--您可以创建自定义数据类型
  
• 可与Python数据类一起使用
  
• 速度非常快
  

2.2 Pydantic与FastAPI结合使用

ch02/main.py

1. from fastapi import FastAPI, APIRouter, Query
3. from typing import Optional
5. from schemas import RecipeSearchResults, Recipe, RecipeCreate
6. from recipe_data import RECIPES
9. app = FastAPI(title="Recipe API", openapi_url="/openapi.json")
11. api_router = APIRouter()
14. @api_router.get("/", status_code=200)
15. def root() -> dict:
16.     """
17.     Root GET
18.     """
19.     return {"msg": "Hello, World!"}
22. # Updated using to use a response_model
23. # https://fastapi.tiangolo.com/tutorial/response-model/
24. @api_router.get("/recipe/{recipe_id}", status_code=200, response_model=Recipe)
25. def fetch_recipe(*, recipe_id: int) -> dict:
26.     """
27.     Fetch a single recipe by ID
28.     """
30.     result = [recipe for recipe in RECIPES if recipe["id"] == recipe_id]
31.     if result:
32.         return result[0]
35. # Updated using the FastAPI parameter validation `Query` class
36. # # https://fastapi.tiangolo.com/tutorial/query-params-str-validations/
37. @api_router.get("/search/", status_code=200, response_model=RecipeSearchResults)
38. def search_recipes(
39.     *,
40.     keyword: Optional[str] = Query(
41.         None,
42.         min_length=3,
43.         openapi_examples={
44.             "chickenExample": {
45.                 "summary": "A chicken search example",
46.                 "value": "chicken",
47.             }
48.         },
49.     ),
50.     max_results: Optional[int] = 10
51. ) -> dict:
52.     """
53.     Search for recipes based on label keyword
54.     """
55.     if not keyword:
56.         # we use Python list slicing to limit results
57.         # based on the max_results query parameter
58.         return {"results": RECIPES[:max_results]}
60.     results = filter(lambda recipe: keyword.lower() in recipe["label"].lower(), RECIPES)
61.     return {"results": list(results)[:max_results]}
64. # New addition, using Pydantic model `RecipeCreate` to define
65. # the POST request body
66. @api_router.post("/recipe/", status_code=201, response_model=Recipe)
67. def create_recipe(*, recipe_in: RecipeCreate) -> dict:
68.     """
69.     Create a new recipe (in memory only)
70.     """
71.     new_entry_id = len(RECIPES) + 1
72.     recipe_entry = Recipe(
73.         id=new_entry_id,
74.         label=recipe_in.label,
75.         source=recipe_in.source,
76.         url=recipe_in.url,
77.     )
78.     RECIPES.append(recipe_entry.dict())
80.     return recipe_entry
83. app.include_router(api_router)
86. if __name__ == "__main__":
87.     # Use this for debugging purposes only
88.     import uvicorn
90.     uvicorn.run(app, host="0.0.0.0", port=8001, log_level="debug")

复制代码

ch02/schemas.py:

1. from pydantic import BaseModel, HttpUrl
3. from typing import Sequence
6. class Recipe(BaseModel):
7.     id: int
8.     label: str
9.     source: str
10.     url: HttpUrl
13. class RecipeSearchResults(BaseModel):
14.     results: Sequence[Recipe]
17. class RecipeCreate(BaseModel):
18.     label: str
19.     source: str
20.     url: HttpUrl
21.     submitter_id: int

复制代码

/recipe/{recipe_id} 已更新为包含response_model字段。在这里，我们通过Pydantic来定义JSON响应的结构。
新的食谱类继承自pydantic BaseModel，每个字段都使用标准类型提示进行定义,除了 url 字段，它使用了 Pydantic HttpUrl helper。这将强制执行预期的 URL 组件，例如方案（http 或 https）的存在。
我们在 /search endpointsearch 端点响应中添加了响应模型 RecipeSearchResults。我们引入了 FastAPI Query 类，它允许我们为查询参数添加额外的验证和要求，例如最小长度。请注意，由于我们设置了示例字段，因此当您"尝试"时，文档页面上会显示该示例字段。
RecipeSearchResults 类使用Pydantic的递归功能定义了一个字段，该字段指向我们之前定义的另一个Pydantic 类，即Recipe类。我们指定结果字段将是一个Recipes的Sequence（这是一个支持 len 和 getitem 的可迭代类）。
为了将函数设置为处理POST请求，我们只需调整api_router装饰器。请注意，我们还将HTTP status_code设置为 201，因为我们正在创建资源。
recipe_in 字段是 POST 请求正文。通过指定 Pydantic 模式，我们能够自动验证传入的请求，确保其主体符合我们的模式。
为了持久保存创建的配方，我们正在进行原始列表追加。当然，这只是一个玩具示例，在服务器重启时不会持久化数据。在本系列的后面，我们将介绍数据库。
RecipeCreate 模式包含一个新字段：submitter_id，因此我们要将它与 Recipe 模式区分开来。
请务必在本地通过交互式文档运行应用程序时尝试创建一些新菜谱。
参考资料

• 软件测试精品书籍文档下载持续更新 https://github.com/china-testing/python-testing-examples 请点赞，谢谢！
  
• 本文涉及的python测试开发库 谢谢点赞！ https://github.com/china-testing/python_cn_resouce
  
• python精品书籍下载 https://github.com/china-testing/python_cn_resouce/blob/main/python_good_books.md
  
• Linux精品书籍下载 https://www.cnblogs.com/testing-/p/17438558.html
  

2.3 错误处理

• 错误处理之前：
  

• 新增错误处理
  

ch02/main2.py

1. from fastapi import FastAPI, APIRouter, Query, HTTPException  # 1
2. # skipping...
4. @api_router.get("/recipe/{recipe_id}", status_code=200, response_model=Recipe)
5. def fetch_recipe(*, recipe_id: int) -> Any:
6.     """
7.     Fetch a single recipe by ID
8.     """
10.     result = [recipe for recipe in RECIPES if recipe["id"] == recipe_id]
11.     if not result:
12.         # the exception is raised, not returned - you will get a validation
13.         # error otherwise.
14.         # 2
15.         raise HTTPException(
16.             status_code=404, detail=f"Recipe with ID {recipe_id} not found"
17.         )
19.     return result[0]

复制代码

来源:https://www.cnblogs.com/testing-/p/18247338
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！