Python中如何为接收和返回JSON数据的函数添加类型注解
Python接收/返回JSON的函数类型注解方案
方案1:通用JSON类型别名(无第三方依赖)
JSON数据在Python中对应的原生类型集合为:None、布尔值、整数、浮点数、字符串、元素为JSON类型的列表、键为字符串且值为JSON类型的字典。你可以直接自定义通用JSON类型别名实现标注:
Python 3.5 ~ 3.9 写法
from typing import Union, Dict, List # 自定义JSON类型别名 JSONValue = Union[None, bool, int, float, str, List['JSONValue'], Dict[str, 'JSONValue']] # 标注后的函数 def func(json_data: JSONValue) -> JSONValue: return json_data
Python 3.10+ 简化写法
可以用|运算符替代Union,写法更简洁:
from typing import TypeAlias JSONValue: TypeAlias = None | bool | int | float | str | list['JSONValue'] | dict[str, 'JSONValue'] def func(json_data: JSONValue) -> JSONValue: return json_data
方案2:固定结构JSON用Pydantic模型(更适合业务场景)
如果你的入参和返回JSON有固定的字段结构,推荐用Pydantic的BaseModel定义类型,不仅支持静态类型检查,还能自动做运行时数据校验:
from pydantic import BaseModel # 定义入参JSON结构 class ReqPayload(BaseModel): user_id: int username: str tags: list[str] # 定义返回JSON结构 class RespPayload(BaseModel): code: int msg: str data: ReqPayload # 标注后的函数 def func(json_data: ReqPayload) -> RespPayload: return RespPayload(code=200, msg="success", data=json_data)
这种方案下类型检查工具会自动校验字段类型是否匹配,其他开发者也能直接看到JSON的具体字段结构,协作效率更高。
内容的提问来源于stack exchange,提问作者Milind Sharma
相关产品推荐
相关产品推荐

