pydantic中怎么使用别名alias

发布时间:2022-10-17 13:51:20 作者:iii
来源:亿速云 阅读:241

今天小编给大家分享一下pydantic中怎么使用别名alias的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

前言

pydantic 里面json是一个内置属性,我想定义一个字段名称是json,这就会引起报错: Field name "json" shadows a BaseModel attribute; use a different field name with "alias='json'"
因为 json 是BaseModel 的一个属性,需使用别名alias='json'

遇到的问题

代码如下,需定义一个json的字段名称

from pydantic import BaseModel, Field
from typing import List, Optional, Any, Optional


class APIRequest(BaseModel):
    method: str
    url: str
    json: Optional[dict]


req = APIRequest(
    method='POST',
    url='/api/login',
    json={"user": "test", "password": "123"}
)
print(req.json())

运行报错:Field name "json" shadows a BaseModel attribute; use a different field name with "alias='json'"
从报错看解决办法是需要使用别名"alias='json'"

使用别名alias

alias 别名的使用,需配合 Field 定义字段

from pydantic import BaseModel, Field

class APIRequest(BaseModel):
    method: str
    url: str
    json_: Optional[dict] = Field(alias='json')

在传值的时候,还是传json名称

req = APIRequest(
    method='POST',
    url='/api/login',
    json={"user": "test", "password": "123"}
)
print(req.json())

运行结果

{"method": "POST", "url": "/api/login", "json_": {"user": "test", "password": "123"}}

得到的结果字段名称是"json_"

by_alias=True

我们期望得到的结果 "json_" 替换成别名json, 于是需使用by_alias=True

req = APIRequest(
    method='POST',
    url='/api/login',
    json={"user": "test", "password": "123"}
)
print(req.json(by_alias=True))
print(req.dict(by_alias=True))

运行结果

{"method": "POST", "url": "/api/login", "json": {"user": "test", "password": "123"}}
{'method': 'POST', 'url': '/api/login', 'json': {'user': 'test', 'password': '123'}}

这样就可以避免跟一些属性名称重复的问题。

以上就是“pydantic中怎么使用别名alias”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注亿速云行业资讯频道。

推荐阅读:
  1. Linux基础命令---alias别名
  2. alias别名永久生效

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

pydantic alias

上一篇:Spring加入事务和嵌套事务的区别是什么

下一篇:guava如何使用

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》