第四章 响应处理和FastAPI配置

Author: liaogx

tutorial/chapter04.py

@@ -2,73 +2,152 @@
 # -*- coding:utf-8 -*-
 # __author__ = '__Jack__'
 
-# from typing import List
-#
-# from fastapi import Form, File, UploadFile
-# from starlette.requests import Request
-#
-# from fastapi import APIRouter
-#
-#
-# app02 = APIRouter()
-#
-#
-# @app02.post("/user/")
-# async def login_post(request: Request, username: str = Form(...), password: str = Form(...)):
-#     """
-#     Form表单操作
-#     :param request:
-#     :param username:
-#     :param password:
-#     :return:
-#     """
-#
-#     print(f"username: {username}, password: {password}")
-#
-#     return templates.TemplateResponse("post.html", {"request": request, "username": username, "password": password})
-#
-#
-# @app02.get("/user/")
-# async def login_get(request: Request):
-#     return templates.TemplateResponse("post.html", {"request": request})
-#
-#
-# @app02.get("/file/")
-# async def login_get(request: Request):
-#     return templates.TemplateResponse("file.html", {"request": request})
-#
-#
-# @app02.post("/file/")
-# async def upload_file(request: Request, files_list: List[bytes] = File(...), files_name: List[UploadFile] = File(...)):
-#     """
-#     上传多个文件
-#     :param request:
-#     :param files_list: List[bytes]表示可上传多个文件，bytes表示上传一个文件
-#     :param files_name:
-#     :return:
-#     """
-#
-#     return templates.TemplateResponse("file.html", {
-#         "request": Request,
-#         "file_sizes": [len(file) for file in files_list],  # 用字节长度表示文件大小
-#         "filenames": [file.filename for file in files_name]
-#     })
-#
-#
-# @app02.post("/create_file/")
-# async def create_file(request: Request, file1: bytes = File(...), file2: UploadFile = File(...), notes: str = Form(...)):
-#     """
-#     上传单个文件
-#     :param request:
-#     :param file1: bytes类型可以统计长度，但是没有content_type属性
-#     :param file2: UploadFile类有content_type属性，但是不能len()统计文件长度
-#     :param notes:
-#     :return:
-#     """
-#
-#     return templates.TemplateResponse("file.html", {
-#         "request": Request,
-#         "file_size": len(file1),
-#         "notes": notes,
-#         "file2_content_type": file2.content_type
-#     })
+from typing import Optional, List
+
+from fastapi import APIRouter, status, Form, File, UploadFile, HTTPException
+from pydantic import BaseModel, EmailStr
+
+app04 = APIRouter()
+
+"""Response Model 响应模型"""
+
+
+class UserIn(BaseModel):
+    username: str
+    password: str
+    email: EmailStr
+    mobile: str = "10086"
+    address: str = None
+    full_name: Optional[str] = None
+
+
+class UserOut(BaseModel):
+    username: str
+    email: EmailStr  # 用 EmailStr 需要 pip install pydantic[email]
+    mobile: str = "10086"
+    address: str = None
+    full_name: Optional[str] = None
+
+
+users = {
+    "user01": {"username": "user01", "password": "123123", "email": "[email protected]"},
+    "user02": {"username": "user02", "password": "123456", "email": "[email protected]", "mobile": "110"}
+}
+
+
+@app04.post("/response_model/", response_model=UserOut, response_model_exclude_unset=True)
+async def response_model(user: UserIn):
+    """response_model_exclude_unset=True表示默认值不包含在响应中，仅包含实际给的值，如果实际给的值与默认值相同也会包含在响应中"""
+    print(user.password)  # password不会被返回
+    # return user
+    return users["user01"]
+
+
+@app04.post(
+    "/response_model/attributes",
+    response_model=UserOut,
+    # response_model=Union[UserIn, UserOut],
+    # response_model=List[UserOut],
+    response_model_include=["username", "email", "mobile"],
+    response_model_exclude=["mobile"]
+)
+async def response_model_attributes(user: UserIn):
+    """response_model_include列出需要在返回结果中包含的字段；response_model_exclude列出需要在返回结果中排除的字段"""
+    # del user.password  # Union[UserIn, UserOut]后，删除password属性也能返回成功
+    return user
+    # return [user, user]
+
+
+"""Response Status Code 响应状态码"""
+
+
+@app04.post("/status_code", status_code=200)
+async def status_code():
+    return {"status_code": 200}
+
+
+@app04.post("/status_attribute", status_code=status.HTTP_200_OK)
+async def status_attribute():
+    print(type(status.HTTP_200_OK))
+    return {"status_code": status.HTTP_200_OK}
+
+
+"""Form Data 表单数据处理"""
+
+
+@app04.post("/login/")
+async def login(username: str = Form(...), password: str = Form(...)):  # 定义表单参数
+    """用Form类需要pip install python-multipart; Form类的元数据和校验方法类似Body/Query/Path/Cookie"""
+    return {"username": username}
+
+
+"""Request Files 单文件、多文件上传及参数详解"""
+
+
+@app04.post("/file")
+async def file_(file: bytes = File(...)):  # 如果要上传多个文件 files: List[bytes] = File(...)
+    """使用File类 文件内容会以bytes的形式读入内存 适合于上传小文件"""
+    return {"file_size": len(file)}
+
+
+@app04.post("/upload_files")
+async def upload_files(files: List[UploadFile] = File(...)):  # 如果要上传单个文件 file: UploadFile = File(...)
+    """
+    使用UploadFile类的优势:
+    1.文件存储在内存中，使用的内存达到阈值后，将被保存在磁盘中
+    2.适合于图片、视频大文件
+    3.可以获取上传的文件的元数据，如文件名，创建时间等
+    4.有文件对象的异步接口
+    5.上传的文件是Python文件对象，可以使用write(), read(), seek(), close()操作
+    """
+    for file in files:
+        contents = await file.read()
+        print(contents)
+    return {"filename": files[0].filename, "content_type": files[0].content_type}
+
+
+"""【见coronavirus应用】
+开发COVID-19感染数据查询接口
+FastAPI项目的静态文件配置
+Jinja2模板渲染COVID-19查询页面
+"""
+
+"""Path Operation Configuration 路径操作配置"""
+
+
+@app04.post(
+    "/path_operation_configuration",
+    response_model=UserOut,
+    # tags=["Path", "Operation", "Configuration"],
+    summary="This is summary",
+    description="This is description",
+    response_description="This is response description",
+    deprecated=True,
+    status_code=status.HTTP_200_OK
+)
+async def path_operation_configuration(user: UserIn):
+    """
+    Path Operation Configuration 路径操作配置
+    :param user: 用户信息
+    :return: 返回结果
+    """
+    return user.dict()
+
+
+"""【见run.py】FastAPI 应用的常见配置项"""
+
+"""Handling Errors 错误处理"""
+
+
+@app04.get("/http_exception")
+async def http_exception(city: str):
+    if city != "Beijing":
+        raise HTTPException(status_code=404, detail="City not found!", headers={"X-Error": "Error"})
+    return {"city": city}
+
+
+@app04.get("/http_exception/{city_id}")
+async def override_http_exception(city_id: int):
+    if city_id == 1:
+        raise HTTPException(status_code=418, detail="Nope! I don't like 1.")
+    return {"city_id": city_id}