利用Pydantic优雅处理几何数据结构 - 前端输入验证实践 ...

利用Pydantic优雅处理几何数据结构 - 前端输入验证实践

一、应用场景解析

在视频分析类项目中，前端常需要传递几何坐标数据。比方智能安防体系中，需要接收：

• 视频流地址（rtsp_video）
  
• 检测区域坐标点（points）
  
• 警戒通道坐标（passway）
  

这些数据需要满足严格的格式要求：

1. {
2.     "rtsp_video": "rtsp://localhost:5555/live",
3.     "points": [[100, 400], [500, 400], [500, 200], [100, 200]],
4.     "passway": [[[500, 200], [100, 200]]]
5. }

复制代码

二、基础模型设计

2.1 优化方案

1. from typing import Annotated
2. from pydantic import BaseModel, Field
4. class VideoData(BaseModel):
5.     """视频分析基础数据模型"""
6.     rtsp_video: str = Field(
7.         example="rtsp://localhost:5555/live",
8.         description="RTSP视频流地址"
9.     )
10.    
11.     points: list[Annotated[list[int], Field(
12.         min_length=2,
13.         max_length=2,
14.         example=[100, 400]
15.     )]]
16.    
17.     passway: list[list[Annotated[list[int], Field(
18.         min_length=2,
19.         max_length=2,
20.         example=[[500, 200]]
21.     )]]]
22.    

复制代码

支持传入的json参考：
{
“rtsp_video”: “rtsp://localhost:5555/live”,
“points”:[[100, 400], [500, 400], [500, 200], [100, 200]],
“passway”: [[[500, 200], [100, 200]]]
}
2.2 方案优化建议

• 利用类型别名增强可读性
  

1. Coordinate = Annotated[
2.     list[int],
3.     Field(min_length=2, max_length=2, example=[100, 400])
4. ]

复制代码

• 基础结构化嵌套模型
  

1. class Point(BaseModel):
2.     x: int
3.     y: int
5. class Line(BaseModel):
6.     start: Point
7.     end: Point
9. class OptimizedVideoData(BaseModel):
10.     rtsp_video: str
11.     points: list[Point]
12.     passway: list[list[Line]]

复制代码

三、验证增强计谋

3.1 数值范围约束

1. from pydantic import conint
3. PixelCoordinate = Annotated[
4.     conint(ge=0, le=1920),  # 假设最大分辨率1920x1080
5.     Field(description="像素坐标系坐标值")
6. ]

复制代码

3.2 自定义验证器

1. from pydantic import validator
3. class EnhancedPoint(BaseModel):
4.     x: int
5.     y: int
7.     @validator('x', 'y')
8.     def check_coordinate_range(cls, v):
9.         if not (0 <= v <= 1920):
10.             raise ValueError("坐标值超出有效范围")
11.         return v

复制代码

四、最佳实践建议

• 为字段添加文档解释
  

1. class DocumentedVideoData(BaseModel):
2.     """视频分析数据模型（带完整文档）"""
3.     rtsp_video: str = Field(
4.         ...,
5.         title="视频流地址",
6.         description="RTSP协议的视频流访问地址",
7.         example="rtsp://localhost:5555/live"
8.     )

复制代码

• 设置模型行为
  

1. class Config:
2.     json_schema_extra = {
3.         "points_example": [[100, 400], [500, 400]],
4.         "passway_example": [[[500, 200], [100, 200]]]
5.     }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。