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”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。