Dataclasses

API Documentation

pydantic.dataclasses.dataclass

PydanticのBaseModelを使用したくない場合は、代わりに標準のdataclasses(Python 3.7で導入)で同じデータ検証を行うことができます。

from datetime import datetime

from pydantic.dataclasses import dataclass


@dataclass
class User:
    id: int
    name: str = 'John Doe'
    signup_ts: datetime = None


user = User(id='42', signup_ts='2032-06-21T12:00')
print(user)
"""
User(id=42, name='John Doe', signup_ts=datetime.datetime(2032, 6, 21, 12, 0))
"""

Note

pydantic.dataclasses.dataclassはpydantic.BaseModelの置き換えではないことに注意してください。 pydantic.dataclasses.dataclassは、dataclasses.dataclassと同様の機能を提供しますが、Pydantic検証が追加されています。 pydantic.BaseModelをサブクラス化した方が良い場合もあります。

詳細な情報と議論については、pydantic/pydantic#710を参照。

PydanticのデータクラスとBaseModelの違いは以下のとおりです。

• initialization hooksの動作
• JSON dumping

標準のPydanticフィールド型をすべて使用することができます。ただし、コンストラクタに渡された引数は、検証や必要に応じて強制を実行するためにコピーされることに注意してください。

Pydanticデータクラスの検証やJSONスキーマの生成を行うには、データクラスをTypeAdapterでラップし、そのメソッドを利用する必要があります。

default_factoryを必要とするフィールドは、pydantic.Fieldまたはdataclasses.fieldで指定できます。

import dataclasses
from typing import List, Optional

from pydantic import Field, TypeAdapter
from pydantic.dataclasses import dataclass


@dataclass
class User:
    id: int
    name: str = 'John Doe'
    friends: List[int] = dataclasses.field(default_factory=lambda: [0])
    age: Optional[int] = dataclasses.field(
        default=None,
        metadata=dict(title='The age of the user', description='do not lie!'),
    )
    height: Optional[int] = Field(None, title='The height in cm', ge=50, le=300)


user = User(id='42')
print(TypeAdapter(User).json_schema())
"""
{
    'properties': {
        'id': {'title': 'Id', 'type': 'integer'},
        'name': {'default': 'John Doe', 'title': 'Name', 'type': 'string'},
        'friends': {
            'items': {'type': 'integer'},
            'title': 'Friends',
            'type': 'array',
        },
        'age': {
            'anyOf': [{'type': 'integer'}, {'type': 'null'}],
            'default': None,
            'description': 'do not lie!',
            'title': 'The age of the user',
        },
        'height': {
            'anyOf': [
                {'maximum': 300, 'minimum': 50, 'type': 'integer'},
                {'type': 'null'},
            ],
            'default': None,
            'title': 'The height in cm',
        },
    },
    'required': ['id'],
    'title': 'User',
    'type': 'object',
}
"""

pydantic.dataclasses.dataclassの引数は標準デコレータと同じですが、model_configと同じ意味を持つキーワード引数configが1つ追加されています。

Warning

v1.2以降では、The Mypy pluginをcheck_pydantic_dataclasses型にインストールする必要があります。

For more information about combining validators with dataclasses, see dataclass validators. バリデータとデータクラスの組み合わせの詳細については、dataclass validatorsを参照してください。

Dataclass config

configをBaseModelのように変更したい場合は、2つのオプションがあります。

• configをデータクラスデコレータにdictとして適用します
• ConfigDictを設定として使用します

from pydantic import ConfigDict
from pydantic.dataclasses import dataclass


# Option 1 - use directly a dict
# Note: `mypy` will still raise typo error
@dataclass(config=dict(validate_assignment=True))  # (1)!
class MyDataclass1:
    a: int


# Option 2 - use `ConfigDict`
# (same as before at runtime since it's a `TypedDict` but with intellisense)
@dataclass(config=ConfigDict(validate_assignment=True))
class MyDataclass2:
    a: int

1. validate_assignmentの詳細については、API referenceを参照してください。

Note

Pydanticデータクラスは、イニシャライザに渡される追加フィールドをignore、forbid、allowするためのextra設定をサポートしています。ただし、stdlibデータクラスのデフォルトの動作が優先される場合があります。 例えば、extra='allow'を使用するPydanticデータクラスに存在する余分なフィールドは、データクラスがprintされるときに省略されます。

Nested dataclasses

ネストされたデータクラスは、データクラスと通常のモデルの両方でサポートされます。

from pydantic import AnyUrl
from pydantic.dataclasses import dataclass


@dataclass
class NavbarButton:
    href: AnyUrl


@dataclass
class Navbar:
    button: NavbarButton


navbar = Navbar(button={'href': 'https://example.com'})
print(navbar)
#> Navbar(button=NavbarButton(href=Url('https://example.com/')))

フィールドとして使用する場合、データ・クラス(Pydanticまたはvanilla)は検証入力としてディクテーションを使用する必要があります。

Generic dataclasses

Pydanticは、型変数を持つものを含む汎用データクラスをサポートしています。

from typing import Generic, TypeVar

from pydantic import TypeAdapter
from pydantic.dataclasses import dataclass

T = TypeVar('T')


@dataclass
class GenericDataclass(Generic[T]):
    x: T


validator = TypeAdapter(GenericDataclass)

assert validator.validate_python({'x': None}).x is None
assert validator.validate_python({'x': 1}).x == 1
assert validator.validate_python({'x': 'a'}).x == 'a'

BaseModelのフィールドとして、またはFastAPI経由でデータクラスを使用する場合、TypeAdapterは必要ないことに注意してください。

Stdlib dataclasses and Pydantic dataclasses

Inherit from stdlib dataclasses

Stdlibデータクラス(ネストされているかどうかにかかわらず)も継承でき、Pydanticは継承されたすべてのフィールドを自動的に検証します。

import dataclasses

import pydantic


@dataclasses.dataclass
class Z:
    z: int


@dataclasses.dataclass
class Y(Z):
    y: int = 0


@pydantic.dataclasses.dataclass
class X(Y):
    x: int = 0


foo = X(x=b'1', y='2', z='3')
print(foo)
#> X(z=3, y=2, x=1)

try:
    X(z='pika')
except pydantic.ValidationError as e:
    print(e)
    """
    1 validation error for X
    z
      Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='pika', input_type=str]
    """

Use of stdlib dataclasses with BaseModel

stdlibデータクラス(ネストされているかどうかにかかわらず)は、BaseModelと混合されると、Pydanticデータクラスに自動的に変換されることに注意してください! さらに、生成されたPydanticデータクラスは、元のものとまったく同じ構成(order、frozen、...)になります。

import dataclasses
from datetime import datetime
from typing import Optional

from pydantic import BaseModel, ConfigDict, ValidationError


@dataclasses.dataclass(frozen=True)
class User:
    name: str


@dataclasses.dataclass
class File:
    filename: str
    last_modification_time: Optional[datetime] = None


class Foo(BaseModel):
    # Required so that pydantic revalidates the model attributes
    model_config = ConfigDict(revalidate_instances='always')

    file: File
    user: Optional[User] = None


file = File(
    filename=['not', 'a', 'string'],
    last_modification_time='2020-01-01T00:00',
)  # nothing is validated as expected
print(file)
"""
File(filename=['not', 'a', 'string'], last_modification_time='2020-01-01T00:00')
"""

try:
    Foo(file=file)
except ValidationError as e:
    print(e)
    """
    1 validation error for Foo
    file.filename
      Input should be a valid string [type=string_type, input_value=['not', 'a', 'string'], input_type=list]
    """

foo = Foo(file=File(filename='myfile'), user=User(name='pika'))
try:
    foo.user.name = 'bulbi'
except dataclasses.FrozenInstanceError as e:
    print(e)
    #> cannot assign to field 'name'

Use custom types

stdlibデータクラスは検証を追加するために自動的に変換されるため、カスタム型を使用すると予期しない動作が発生する可能性があります。 この場合は単にarbitrary_types_allowedを設定に追加すればよいのです!

import dataclasses

from pydantic import BaseModel, ConfigDict
from pydantic.errors import PydanticSchemaGenerationError


class ArbitraryType:
    def __init__(self, value):
        self.value = value

    def __repr__(self):
        return f'ArbitraryType(value={self.value!r})'


@dataclasses.dataclass
class DC:
    a: ArbitraryType
    b: str


# valid as it is a builtin dataclass without validation
my_dc = DC(a=ArbitraryType(value=3), b='qwe')

try:

    class Model(BaseModel):
        dc: DC
        other: str

    # invalid as it is now a pydantic dataclass
    Model(dc=my_dc, other='other')
except PydanticSchemaGenerationError as e:
    print(e.message)
    """
    Unable to generate pydantic-core schema for <class '__main__.ArbitraryType'>. Set `arbitrary_types_allowed=True` in the model_config to ignore this error or implement `__get_pydantic_core_schema__` on your type to fully support it.

    If you got this error by calling handler(<some type>) within `__get_pydantic_core_schema__` then you likely need to call `handler.generate_schema(<some type>)` since we do not call `__get_pydantic_core_schema__` on `<some type>` otherwise to avoid infinite recursion.
    """


class Model(BaseModel):
    model_config = ConfigDict(arbitrary_types_allowed=True)

    dc: DC
    other: str


m = Model(dc=my_dc, other='other')
print(repr(m))
#> Model(dc=DC(a=ArbitraryType(value=3), b='qwe'), other='other')

Checking if a dataclass is a pydantic dataclass

Pydanticデータクラスは今でもデータクラスとみなされるので、dataclasses.is_dataclassを使用するとTrueが返されます。型が特にpydanticデータクラスであるかどうかを確認するには、pydantic.dataclasses.is_pydantic_dataclassを使用します。

import dataclasses

import pydantic


@dataclasses.dataclass
class StdLibDataclass:
    id: int


PydanticDataclass = pydantic.dataclasses.dataclass(StdLibDataclass)

print(dataclasses.is_dataclass(StdLibDataclass))
#> True
print(pydantic.dataclasses.is_pydantic_dataclass(StdLibDataclass))
#> False

print(dataclasses.is_dataclass(PydanticDataclass))
#> True
print(pydantic.dataclasses.is_pydantic_dataclass(PydanticDataclass))
#> True

Initialization hooks

データクラスを初期化する場合、@model_validatorデコレータのmodeパラメータを使用して、検証の前または後にコードを実行できます。

from typing import Any, Dict

from typing_extensions import Self

from pydantic import model_validator
from pydantic.dataclasses import dataclass


@dataclass
class Birth:
    year: int
    month: int
    day: int


@dataclass
class User:
    birth: Birth

    @model_validator(mode='before')
    @classmethod
    def pre_root(cls, values: Dict[str, Any]) -> Dict[str, Any]:
        print(f'First: {values}')
        """
        First: ArgsKwargs((), {'birth': {'year': 1995, 'month': 3, 'day': 2}})
        """
        return values

    @model_validator(mode='after')
    def post_root(self) -> Self:
        print(f'Third: {self}')
        #> Third: User(birth=Birth(year=1995, month=3, day=2))
        return self

    def __post_init__(self):
        print(f'Second: {self.birth}')
        #> Second: Birth(year=1995, month=3, day=2)


user = User(**{'birth': {'year': 1995, 'month': 3, 'day': 2}})

Pydanticデータクラスの__post_init__はバリデータの_middle_で呼び出されます。 オーダーは以下の通りです。

• model_validator(mode='before')
• field_validator(mode='before')
• field_validator(mode='after')

*内部バリデータ。例えば、int、str、..のような型の検証。 * __post_init__. * model_validator(mode='after')

from dataclasses import InitVar
from pathlib import Path
from typing import Optional

from pydantic.dataclasses import dataclass


@dataclass
class PathData:
    path: Path
    base_path: InitVar[Optional[Path]]

    def __post_init__(self, base_path):
        print(f'Received path={self.path!r}, base_path={base_path!r}')
        #> Received path=PosixPath('world'), base_path=PosixPath('/hello')
        if base_path is not None:
            self.path = base_path / self.path


path_data = PathData('world', base_path='/hello')
# Received path='world', base_path='/hello'
assert path_data.path == Path('/hello/world')

Difference with stdlib dataclasses

Python stdlibのdataclasses.dataclassは検証ステップを実行しないので、__post_init__メソッドしか実装していないことに注意してください。

JSON dumping

Pydanticデータクラスには.model_dump_json()関数がありません。JSONとしてダンプするには、次のようにRootModelを使用する必要があります。

import dataclasses
from typing import List

from pydantic import RootModel
from pydantic.dataclasses import dataclass


@dataclass
class User:
    id: int
    name: str = 'John Doe'
    friends: List[int] = dataclasses.field(default_factory=lambda: [0])


user = User(id='42')
print(RootModel[User](User(id='42')).model_dump_json(indent=4))

JSON output:

{
  "id": 42,
  "name": "John Doe",
  "friends": [
    0
  ]
}