pydantic中怎么使用别名alias

今天小编给大家分享一下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”这篇文章的所有内容，感谢各位的阅读！相信大家阅读完这篇文章都有很大的收获，小编每天都会为大家更新不同的知识，如果还想学习更多的知识，请关注创新互联行业资讯频道。

当前文章：pydantic中怎么使用别名alias
转载源于：http://bzwzjz.com/article/gegijo.html