Python 数据接口定义与检查
1 Pydantic库基本使用
Python 数据接口定义与检查库。pydantic库的数据定义方式是通过BaseModel类来进行定义的，所有基于pydantic的数据类型本质上都是一个BaseModel类
from pydantic import BaseModel
class Person(BaseModel):
name: str
# 直接传值
p = Person(name="Soloman")
# 通过字典传入
p = {"name": "Soloman"}
p = Person(**p)
print(p.json()) # {"name": "Soloman"}
# 当传入值错误的时候，pydantic就会抛出报错：name field required (type=value_error.missing)
p = Person(people="Soloman")
# 如果传入值多于定义值时，BaseModel也会自动对其进行过滤.额外的参数website与age都被自动过滤掉了
p = Person(name="Soloman", website="www.soloman.vip", age=88)
print(p.json()) # {"name": "Soloman"}
# pydantic在数据传输时会直接进行数据类型转换，因此，如果数据传输格式错误，但是可以通过转换变换为正确的数据类型是，数据传输也可以成功
p = Person(name=999)
print(p.json()) # {"name": "999"}
2 Pydantic基本数据类型
from pydantic import BaseModel
from typing import Dict, List, Sequence, Set, Tuple
class DataType(BaseModel):
a: int # 整型
b: float # 浮点型
c: str # 字符串
d: bool # 布尔型
e: List[int] # 整型列表
f: Dict[str, int] # 字典型，key为str，value为int
g: Set[int] # 集合
h: Tuple[str, int] # 元组
3 Pydantic高级数据结构
# enum数据类型，通过enum库进行实现
from enum import Enum
class Gender(str, Enum):
man = "man"
women = "women"
# 可选数据类型，如果一个数据类型不是必须的，可以允许用户在使用中不进行传入，则我们可以使用typing库中的Optional方法进行实现。需要注意的是，设置为可选之后，数据中仍然会有age字段，但是其默认值为None，即当不传入age字段时，Person仍然可以取到age，只是其值为None
from typing import Optional
from pydantic import BaseModel
class Person(BaseModel):
name: str
age: Optional[int]
# 数据默认值的设置
from pydantic import BaseModel
class Person(BaseModel):
name: str
gender: str = "man"
p = Person(name="Soloman")
print(p.json()) # {"name": "Soloman", "gender": "man"}
# 允许多种数据类型，如果一个数据可以允许多种数据类型，我们可以通过typing库中的Union方法进行实现。
from typing import Union
from pydantic import BaseModel
class Time(BaseModel):
time: Union[int, str]
t = Time(time=12345)
print(t.json()) # {"time": 12345}
t = Time(time = "2022-02-30")
print(t.json()) # {"time": "2021-02-30"}
# 异名数据传递方法，假设我们之前已经定义了一个参量命名为了A，但是在后续的定义中，我们希望这个量被命名为B
from pydantic import BaseModel, Field
class Password(BaseModel):
password: str = Field(alias = "pwd")
p = Password(pwd="123456")
print(p.json()) # {"password": "123456"}
4 高级数据结构定义和实例化
from enum import Enum
from typing import List, Union
from datetime import date
from pydantic import BaseModel
class Gender(str, Enum):
man = "man"
women = "women"
class Person(BaseModel):
name : str
gender : Gender
class Department(BaseModel):
name : str
lead : Person
cast : List[Person]
class Group(BaseModel):
owner: Person
member_list: List[Person] = []
class Company(BaseModel):
name: str
owner: Union[Person, Group]
regtime: date
department_list: List[Department] = []
# 需要注意的是，我们除了可以一步一步地实例化之外，如果我们已经有了一个完整的Company的内容字典，我们也可以一步到位地进行实例化
sales_department = {
"name": "sales",
"lead": {
"name": "Sarah", "gender": "women"},
"cast": [
{
"name": "Sarah", "gender": "women"},
{
"name": "Bob", "gender": "man"},
{
"name": "Mary", "gender": "women"}
]
}
research_department = {
"name": "research",
"lead": {
"name": "Allen", "gender": "man"},
"cast": [
{
"name": "Jane", "gender": "women"},
{
"name": "Tim", "gender": "man"}
]
}
company = {
"name": "Fantasy",
"owner": {
"name": "Victor", "gender": "man"},
"regtime": "2020-7-23",
"department_list": [
sales_department,
research_department
]
}
company = Company(**company)
5 高级数据检查方法
使用validator和config方法来实现更为复杂的数据类型定义以及检查
# validator用法
import re
from pydantic import BaseModel, validator
class Password(BaseModel):
password: str
@validator("password")
def password_rule(cls, password):
def is_valid(password):
if len(password) < 6 or len(password) > 20:
return False
if not re.search("[a-z]", password):
return False
if not re.search("[A-Z]", password):
return False
if not re.search("\d", password):
return False
return True
if not is_valid(password):
raise ValueError("password is invalid")
# Config方法，对BaseModel中的某一基本型进行统一的格式要求
from pydantic import BaseModel
class Password(BaseModel):
password: str
class Config:
min_anystr_length = 6 # 令Password类中所有的字符串长度均要不少于6
max_anystr_length = 20 # 令Password类中所有的字符串长度均要不大于20