别名
支持别名配置。
AliasPath dataclass
¶
一个由 validation_alias
用作创建别名的便利数据类。
属性
名称 | 类型 | 描述 |
---|---|---|
路径 |
列表[整数 | 字符串]
|
字符串或整数别名列表。 |
源代码位于 pydantic/aliases.py
28 29 |
|
convert_to_aliases ¶
search_dict_for_path ¶
在字典中搜索由别名指定的路径。
返回
类型 | 描述 |
---|---|
Any
|
指定路径的值,如果未找到路径,则为 |
源代码位于 pydantic/aliases.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|
AliasChoices dataclass
¶
一个由 validation_alias
用作创建别名的便利数据类。
属性
名称 | 类型 | 描述 |
---|---|---|
选择 |
列表[字符串 | AliasPath]
|
包含字符串或 |
源代码位于 pydantic/aliases.py
70 71 |
|
convert_to_aliases ¶
将参数转换为包含字符串或整数别名列表的列表。
返回
类型 | 描述 |
---|---|
列表[列表[字符串 | 整数]]
|
别名列表。 |
源代码位于 pydantic/aliases.py
73 74 75 76 77 78 79 80 81 82 83 84 85 |
|
AliasGenerator dataclass
¶
AliasGenerator(
alias: Callable[[str], str] | None = None,
validation_alias: (
Callable[[str], str | AliasPath | AliasChoices]
| None
) = None,
serialization_alias: Callable[[str], str] | None = None,
)
使用文档
一个由 alias_generator
用作创建各种别名的便利数据类。
属性
名称 | 类型 | 描述 |
---|---|---|
alias |
可调用[[字符串], 字符串] | 无
|
一个可调用对象,它接受一个字段名并返回其别名。 |
validation_alias |
可调用[[字符串], 字符串 | AliasPath | AliasChoices] | 无
|
一个可调用对象,它接受一个字段名并返回其验证别名。 |
serialization_alias |
可调用[[字符串], 字符串] | 无
|
一个可调用对象,它接受一个字段名并返回其序列化别名。 |
generate_aliases ¶
generate_aliases(
field_name: str,
) -> tuple[
str | None,
str | AliasPath | AliasChoices | None,
str | None,
]
为字段生成 alias
、validation_alias
和 serialization_alias
。
返回
类型 | 描述 |
---|---|
元组[字符串 | 无, 字符串 | AliasPath | AliasChoices | 无, 字符串 | 无]
|
包含三个别名(验证、别名和序列化)的元组。 |
源代码位于 pydantic/aliases.py
125 126 127 128 129 130 131 132 133 134 135 |
|