Erreurs de validation

Pydantic tente de fournir des erreurs de validation utiles. Vous trouverez ci-dessous des détails sur les erreurs de validation courantes que les utilisateurs peuvent rencontrer lorsqu'ils travaillent avec pydantic, ainsi que quelques suggestions sur la façon de les corriger.

type_arguments¶

Cette erreur est générée lorsqu'un objet qui serait passé en argument à une fonction lors de la validation n'est pas un tuple , list ou dict . Étant donné que NamedTuple utilise des appels de fonction dans son implémentation, c'est une façon de produire cette erreur:

from typing import NamedTuple

from pydantic import BaseModel, ValidationError


class MyNamedTuple(NamedTuple):
    x: int


class MyModel(BaseModel):
    field: MyNamedTuple


try:
    MyModel.model_validate({'field': 'invalid'})
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'arguments_type'

`assertion_error`¶

Cette erreur est générée lorsqu'une instruction assert défaillante est rencontrée lors de la validation:

from pydantic import BaseModel, ValidationError, field_validator


class Model(BaseModel):
    x: int

    @field_validator('x')
    @classmethod
    def force_x_positive(cls, v):
        assert v > 0
        return v


try:
    Model(x=-1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'assertion_error'

`bool_parsing`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne qui n'est pas valide pour la coercition vers un booléen:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: bool


Model(x='true')  # OK

try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'bool_parsing'

`bool_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ bool:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: bool


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'bool_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de bool .

`bytes_too_long`¶

Cette erreur est générée lorsque la longueur d'une valeur bytes est supérieure à la contrainte max_length du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: bytes = Field(max_length=3)


try:
    Model(x=b'test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'bytes_too_long'

`bytes_too_short`¶

Cette erreur est générée lorsque la longueur d'une valeur bytes est inférieure à la contrainte min_length du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: bytes = Field(min_length=3)


try:
    Model(x=b't')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'bytes_too_short'

`bytes_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ bytes:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: bytes


try:
    Model(x=123)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'bytes_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de bytes .

`callable_type`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas valide en tant que Callable:

from typing import Any, Callable

from pydantic import BaseModel, ImportString, ValidationError


class Model(BaseModel):
    x: ImportString[Callable[[Any], Any]]


Model(x='math:cos')  # OK

try:
    Model(x='os.path')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'callable_type'

`dataclass_exact_type`¶

Cette erreur est générée lors de la validation d'une classe de données avec strict=True et que l'entrée n'est pas une instance de la classe de données:

import pydantic.dataclasses
from pydantic import TypeAdapter, ValidationError


@pydantic.dataclasses.dataclass
class MyDataclass:
    x: str


adapter = TypeAdapter(MyDataclass)

print(adapter.validate_python(MyDataclass(x='test'), strict=True))
#> MyDataclass(x='test')
print(adapter.validate_python({'x': 'test'}))
#> MyDataclass(x='test')

try:
    adapter.validate_python({'x': 'test'}, strict=True)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'dataclass_exact_type'

`dataclass_type`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas valide pour un champ de dataclass:

from pydantic import ValidationError, dataclasses


@dataclasses.dataclass
class Inner:
    x: int


@dataclasses.dataclass
class Outer:
    y: Inner


Outer(y=Inner(x=1))  # OK

try:
    Outer(y=1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'dataclass_type'

`date_from_datetime_inexact`¶

Cette erreur est générée lorsque la valeur datetime d’entrée fournie pour un champ date a une composante temporelle différente de zéro. Pour qu'un horodatage soit analysé dans un champ de type date , les composants temporels doivent tous être nuls:

from datetime import date, datetime

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: date


Model(x='2023-01-01')  # OK
Model(x=datetime(2023, 1, 1))  # OK

try:
    Model(x=datetime(2023, 1, 1, 12))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_from_datetime_inexact'

`date_from_datetime_parsing`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne qui ne peut pas être analysée pour un champ date:

from datetime import date

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: date


try:
    Model(x='XX1494012000')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_from_datetime_parsing'

`date_future`¶

Cette erreur est générée lorsque la valeur d'entrée fournie pour un champ FutureDate n'est pas dans le futur:

from datetime import date

from pydantic import BaseModel, FutureDate, ValidationError


class Model(BaseModel):
    x: FutureDate


try:
    Model(x=date(2000, 1, 1))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_future'

`date_parsing`¶

Cette erreur est générée lors de la validation de JSON où la valeur d'entrée est une chaîne qui ne peut pas être analysée pour un champ date:

import json
from datetime import date

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: date = Field(strict=True)


try:
    Model.model_validate_json(json.dumps({'x': '1'}))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_parsing'

`date_past`¶

Cette erreur est générée lorsque la valeur fournie pour un champ PastDate n'est pas dans le passé:

from datetime import date, timedelta

from pydantic import BaseModel, PastDate, ValidationError


class Model(BaseModel):
    x: PastDate


try:
    Model(x=date.today() + timedelta(1))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_past'

`date_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ date:

from datetime import date

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: date


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'date_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de date .

`datetime_from_date_parsing`¶

!!! note La prise en charge de cette erreur, ainsi que la prise en charge de l'analyse des dates et heures à partir des dates yyyy-MM-DD seront ajoutées dans v2.6.0

Cette erreur est générée lorsque la valeur d'entrée est une chaîne qui ne peut pas être analysée pour un champ datetime:

from datetime import datetime

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: datetime


try:
    # there is no 13th month
    Model(x='2023-13-01')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_from_date_parsing'

`datetime_future`¶

Cette erreur est générée lorsque la valeur fournie pour un champ FutureDatetime n'est pas dans le futur:

from datetime import datetime

from pydantic import BaseModel, FutureDatetime, ValidationError


class Model(BaseModel):
    x: FutureDatetime


try:
    Model(x=datetime(2000, 1, 1))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_future'

`datetime_object_invalid`¶

Cette erreur est générée lorsque quelque chose concernant l'objet datetime n'est pas valide:

from datetime import datetime, tzinfo

from pydantic import AwareDatetime, BaseModel, ValidationError


class CustomTz(tzinfo):
    # utcoffset is not implemented!

    def tzname(self, _dt):
        return 'CustomTZ'


class Model(BaseModel):
    x: AwareDatetime


try:
    Model(x=datetime(2023, 1, 1, tzinfo=CustomTz()))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_object_invalid'

`datetime_parsing`¶

Cette erreur est générée lorsque la valeur est une chaîne qui ne peut pas être analysée pour un champ datetime:

import json
from datetime import datetime

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: datetime = Field(strict=True)


try:
    Model.model_validate_json(json.dumps({'x': 'not a datetime'}))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_parsing'

`datetime_past`¶

Cette erreur est générée lorsque la valeur fournie pour un champ PastDatetime n'est pas dans le passé:

from datetime import datetime, timedelta

from pydantic import BaseModel, PastDatetime, ValidationError


class Model(BaseModel):
    x: PastDatetime


try:
    Model(x=datetime.now() + timedelta(100))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_past'

`datetime_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ datetime:

from datetime import datetime

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: datetime


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'datetime_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de datetime .

`decimal_max_digits`¶

Cette erreur est générée lorsque la valeur fournie pour un Decimal comporte trop de chiffres:

from decimal import Decimal

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: Decimal = Field(max_digits=3)


try:
    Model(x='42.1234')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'decimal_max_digits'

`decimal_max_places`¶

Cette erreur est générée lorsque la valeur fournie pour une valeur Decimal comporte trop de chiffres après la virgule:

from decimal import Decimal

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: Decimal = Field(decimal_places=3)


try:
    Model(x='42.1234')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'decimal_max_places'

`decimal_parsing`¶

Cette erreur est générée lorsque la valeur fournie pour un Decimal n'a pas pu être analysée comme un nombre décimal:

from decimal import Decimal

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: Decimal = Field(decimal_places=3)


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'decimal_parsing'

`decimal_type`¶

Cette erreur est générée lorsque la valeur fournie pour un Decimal est du mauvais type:

from decimal import Decimal

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: Decimal = Field(decimal_places=3)


try:
    Model(x=[1, 2, 3])
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'decimal_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de Decimal .

`decimal_whole_digits`¶

Cette erreur est générée lorsque la valeur fournie pour un Decimal comporte plus de chiffres avant le point décimal que max_digits - decimal_places (à condition que les deux soient spécifiés):

from decimal import Decimal

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: Decimal = Field(max_digits=6, decimal_places=3)


try:
    Model(x='12345.6')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'decimal_whole_digits'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de Decimal .

`dict_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas dict pour un champ dict:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: dict


try:
    Model(x=['1', '2'])
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'dict_type'

`enum`¶

Cette erreur est générée lorsque la valeur d'entrée n'existe pas dans les membres d'un champ enum:

from enum import Enum

from pydantic import BaseModel, ValidationError


class MyEnum(str, Enum):
    option = 'option'


class Model(BaseModel):
    x: MyEnum


try:
    Model(x='other_option')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'enum'

`extra_forbidden`¶

Cette erreur est générée lorsque la valeur d'entrée contient des champs supplémentaires, mais model_config['extra'] == 'forbid' :

from pydantic import BaseModel, ConfigDict, ValidationError


class Model(BaseModel):
    x: str

    model_config = ConfigDict(extra='forbid')


try:
    Model(x='test', y='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'extra_forbidden'

Vous pouvez en savoir plus sur la configuration extra dans la section Attributs supplémentaires.

`finite_number`¶

Cette erreur est générée lorsque la valeur est infinie ou trop grande pour être représentée sous la forme d'un nombre à virgule flottante de 64 bits lors de la validation:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: int


try:
    Model(x=2.2250738585072011e308)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'finite_number'

`float_parsing`¶

Cette erreur est générée lorsque la valeur est une chaîne qui ne peut pas être analysée comme un float:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: float


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'float_parsing'

`float_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ float:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: float


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'float_type'

`frozen_field`¶

Cette erreur se produit lorsque vous tentez d'attribuer une valeur à un champ avec frozen=True , ou de supprimer un tel champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: str = Field('test', frozen=True)


model = Model()

try:
    model.x = 'test1'
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'frozen_field'

try:
    del model.x
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'frozen_field'

`frozen_instance`¶

Cette erreur est générée lorsque model_config['frozen] == True et que vous tentez de supprimer ou d'attribuer une nouvelle valeur à l'un des champs:

from pydantic import BaseModel, ConfigDict, ValidationError


class Model(BaseModel):
    x: int

    model_config = ConfigDict(frozen=True)


m = Model(x=1)

try:
    m.x = 2
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'frozen_instance'

try:
    del m.x
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'frozen_instance'

`frozen_set_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ frozenset:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: frozenset


try:
    model = Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'frozen_set_type'

`get_attribute_error`¶

Cette erreur est générée lorsque model_config['from_attributes'] == True et une erreur est générée lors de la lecture des attributs:

from pydantic import BaseModel, ConfigDict, ValidationError


class Foobar:
    def __init__(self):
        self.x = 1

    @property
    def y(self):
        raise RuntimeError('intentional error')


class Model(BaseModel):
    x: int
    y: str

    model_config = ConfigDict(from_attributes=True)


try:
    Model.model_validate(Foobar())
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'get_attribute_error'

`greater_than`¶

Cette erreur est générée lorsque la valeur n'est pas supérieure à la contrainte gt du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: int = Field(gt=10)


try:
    Model(x=10)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'greater_than'

`greater_than_equal`¶

Cette erreur est générée lorsque la valeur n'est pas supérieure ou égale à la contrainte ge du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: int = Field(ge=10)


try:
    Model(x=9)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'greater_than_equal'

`int_from_float`¶

Cette erreur est générée lorsque vous fournissez une valeur float pour un champ int:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: int


try:
    Model(x=0.5)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'int_from_float'

`int_parsing`¶

Cette erreur est générée lorsque la valeur ne peut pas être analysée comme int:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: int


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'int_parsing'

`int_parsing_size`¶

Cette erreur est générée lors de la tentative d'analyse d'une valeur Python ou JSON à partir d'une chaîne en dehors de la plage maximale autorisée par l'analyse Python str à int:

import json

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: int


# from Python
assert Model(x='1' * 4_300).x == int('1' * 4_300)  # OK

too_long = '1' * 4_301
try:
    Model(x=too_long)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'int_parsing_size'

# from JSON
try:
    Model.model_validate_json(json.dumps({'x': too_long}))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'int_parsing_size'

`int_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ int:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: int


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'int_type'

`invalid_key`¶

Cette erreur se produit lors de la tentative de validation d'un dict dont la clé n'est pas une instance de str :

from pydantic import BaseModel, ConfigDict, ValidationError


class Model(BaseModel):
    x: int

    model_config = ConfigDict(extra='allow')


try:
    Model.model_validate({'x': 1, b'y': 2})
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'invalid_key'

`is_instance_of`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas une instance du type attendu:

from pydantic import BaseModel, ConfigDict, ValidationError


class Nested:
    x: str


class Model(BaseModel):
    y: Nested

    model_config = ConfigDict(arbitrary_types_allowed=True)


try:
    Model(y='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'is_instance_of'

`is_subclass_of`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas une sous-classe du type attendu:

from typing import Type

from pydantic import BaseModel, ValidationError


class Nested:
    x: str


class Model(BaseModel):
    y: Type[Nested]


try:
    Model(y='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'is_subclass_of'

`iterable_type`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas valide en tant que Iterable:

from typing import Iterable

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    y: Iterable


try:
    Model(y=123)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'iterable_type'

`iteration_error`¶

Cette erreur est générée lorsqu'une erreur se produit lors de l'itération:

from typing import List

from pydantic import BaseModel, ValidationError


def gen():
    yield 1
    raise RuntimeError('error')


class Model(BaseModel):
    x: List[int]


try:
    Model(x=gen())
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'iteration_error'

`json_invalid`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas une chaîne JSON valide:

from pydantic import BaseModel, Json, ValidationError


class Model(BaseModel):
    x: Json


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'json_invalid'

`json_type`¶

Cette erreur est générée lorsque la valeur d'entrée est d'un type qui ne peut pas être analysé en tant que JSON:

from pydantic import BaseModel, Json, ValidationError


class Model(BaseModel):
    x: Json


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'json_type'

`less_than`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas inférieure à la contrainte lt du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: int = Field(lt=10)


try:
    Model(x=10)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'less_than'

`less_than_equal`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas inférieure ou égale à la contrainte le du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: int = Field(le=10)


try:
    Model(x=11)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'less_than_equal'

`list_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ list:

from typing import List

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: List[int]


try:
    Model(x=1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'list_type'

`literal_error`¶

Cette erreur est générée lorsque la valeur d'entrée ne fait pas partie des valeurs littérales attendues:

from typing_extensions import Literal

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: Literal['a', 'b']


Model(x='a')  # OK

try:
    Model(x='c')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'literal_error'

`mapping_type`¶

Cette erreur est générée lorsqu'un problème survient lors de la validation en raison d'un échec dans un appel aux méthodes du protocole Mapping , comme .items() :

from collections.abc import Mapping
from typing import Dict

from pydantic import BaseModel, ValidationError


class BadMapping(Mapping):
    def items(self):
        raise ValueError()

    def __iter__(self):
        raise ValueError()

    def __getitem__(self, key):
        raise ValueError()

    def __len__(self):
        return 1


class Model(BaseModel):
    x: Dict[str, str]


try:
    Model(x=BadMapping())
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'mapping_type'

`missing`¶

Cette erreur est générée lorsqu'il manque des champs obligatoires dans la valeur d'entrée:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: str


try:
    Model()
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'missing'

`missing_argument`¶

Cette erreur est générée lorsqu'un argument de position ou de mot-clé requis n'est pas transmis à une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(a: int):
    return a


try:
    foo()
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'missing_argument'

`missing_keyword_only_argument`¶

Cette erreur est générée lorsqu'un argument obligatoire de mot-clé uniquement n'est pas transmis à une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(*, a: int):
    return a


try:
    foo()
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'missing_keyword_only_argument'

`missing_positional_only_argument`¶

Cette erreur est générée lorsqu'un argument de position uniquement requis n'est pas transmis à une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(a: int, /):
    return a


try:
    foo()
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'missing_positional_only_argument'

`model_attributes_type`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas un dictionnaire valide, une instance de modèle ou une instance à partir de laquelle les champs peuvent être extraits:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    a: int
    b: int


# simply validating a dict
print(Model.model_validate({'a': 1, 'b': 2}))
#> a=1 b=2


class CustomObj:
    def __init__(self, a, b):
        self.a = a
        self.b = b


# using from attributes to extract fields from an objects
print(Model.model_validate(CustomObj(3, 4), from_attributes=True))
#> a=3 b=4

try:
    Model.model_validate('not an object', from_attributes=True)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'model_attributes_type'

`model_type`¶

Cette erreur est générée lorsque l'entrée d'un modèle n'est pas une instance du modèle ou du dict:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    a: int
    b: int


# simply validating a dict
m = Model.model_validate({'a': 1, 'b': 2})
print(m)
#> a=1 b=2

# validating an existing model instance
print(Model.model_validate(m))
#> a=1 b=2

try:
    Model.model_validate('not an object')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'model_type'

`multiple_argument_values`¶

Cette erreur est générée lorsque vous fournissez plusieurs valeurs pour un seul argument lors de l'appel d'une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(a: int):
    return a


try:
    foo(1, a=2)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'multiple_argument_values'

`multiple_of`¶

Cette erreur est générée lorsque l'entrée n'est pas un multiple de la contrainte multiple_of d'un champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: int = Field(multiple_of=5)


try:
    Model(x=1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'multiple_of'

`no_such_attribute`¶

Cette erreur est générée lorsque validate_assignment=True dans la configuration et que vous tentez d'attribuer une valeur à un attribut qui n'est pas un champ existant:

from pydantic import ConfigDict, ValidationError, dataclasses


@dataclasses.dataclass(config=ConfigDict(validate_assignment=True))
class MyDataclass:
    x: int


m = MyDataclass(x=1)
try:
    m.y = 10
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'no_such_attribute'

`none_required`¶

Cette erreur est générée lorsque la valeur d'entrée n'est pas None pour un champ qui nécessite None:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: None


try:
    Model(x=1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'none_required'

!!! note Vous pouvez rencontrer cette erreur en cas de collision de noms dans votre modèle entre un nom de champ et son type. Plus précisément, cette erreur est susceptible d'être générée lorsque la valeur par défaut de ce champ est None .

For example, the following would yield the `none_required` validation error since the field `int` is set to a default value of `None` and has the exact same name as its type, which causes problems with validation.
```py
from typing import Optional

from pydantic import BaseModel


class M1(BaseModel):
    int: Optional[int] = None


m = M1(int=123)  # errors
```

`recursion_loop`¶

Cette erreur est générée lorsqu'une référence cyclique est détectée:

from typing import List

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: List['Model']


d = {'x': []}
d['x'].append(d)
try:
    Model(**d)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'recursion_loop'

`set_type`¶

Cette erreur est générée lorsque le type de valeur n'est pas valide pour un champ set:

from typing import Set

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: Set[int]


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'set_type'

`string_pattern_mismatch`¶

Cette erreur est générée lorsque la valeur d'entrée ne correspond pas à la contrainte pattern du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: str = Field(pattern='test')


try:
    Model(x='1')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_pattern_mismatch'

`string_sub_type`¶

Cette erreur est générée lorsque la valeur est une instance d'un sous-type strict de str lorsque le champ est strict:

from enum import Enum

from pydantic import BaseModel, Field, ValidationError


class MyEnum(str, Enum):
    foo = 'foo'


class Model(BaseModel):
    x: str = Field(strict=True)


try:
    Model(x=MyEnum.foo)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_sub_type'

`string_too_long`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne dont la longueur est supérieure à la contrainte max_length du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: str = Field(max_length=3)


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_too_long'

`string_too_short`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne dont la longueur est inférieure à la contrainte min_length du champ:

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: str = Field(min_length=3)


try:
    Model(x='t')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_too_short'

`string_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ str:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: str


try:
    Model(x=1)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de str .

`string_unicode`¶

Cette erreur est générée lorsque la valeur ne peut pas être analysée en tant que chaîne Unicode:

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: str


try:
    Model(x=b'\x81')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'string_unicode'

`time_delta_parsing`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne qui ne peut pas être analysée pour un champ timedelta:

from datetime import timedelta

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: timedelta


try:
    Model(x='t')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'time_delta_parsing'

`time_delta_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ timedelta:

from datetime import timedelta

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: timedelta


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'time_delta_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de timedelta .

`time_parsing`¶

Cette erreur est générée lorsque la valeur d'entrée est une chaîne qui ne peut pas être analysée pour un champ time:

from datetime import time

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: time


try:
    Model(x='25:20:30.400')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'time_parsing'

`time_type`¶

Cette erreur est générée lorsque le type de valeur n'est pas valide pour un champ time:

from datetime import time

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: time


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'time_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de time .

`timezone_aware`¶

Cette erreur est générée lorsque la valeur datetime fournie pour un champ datetime prenant en compte le fuseau horaire ne contient pas d'informations sur le fuseau horaire:

from datetime import datetime

from pydantic import AwareDatetime, BaseModel, ValidationError


class Model(BaseModel):
    x: AwareDatetime


try:
    Model(x=datetime.now())
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'timezone_aware'

`timezone_naive`¶

Cette erreur est générée lorsque la valeur datetime fournie pour un champ datetime naïf de fuseau horaire contient des informations sur le fuseau horaire:

from datetime import datetime, timezone

from pydantic import BaseModel, NaiveDatetime, ValidationError


class Model(BaseModel):
    x: NaiveDatetime


try:
    Model(x=datetime.now(tz=timezone.utc))
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'timezone_naive'

`too_long`¶

Cette erreur est générée lorsque la longueur de la valeur d'entrée est supérieure à la contrainte max_length du champ:

from typing import List

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: List[int] = Field(max_length=3)


try:
    Model(x=[1, 2, 3, 4])
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'too_long'

`too_short`¶

Cette erreur est générée lorsque la longueur de la valeur est inférieure à la contrainte min_length du champ:

from typing import List

from pydantic import BaseModel, Field, ValidationError


class Model(BaseModel):
    x: List[int] = Field(min_length=3)


try:
    Model(x=[1, 2])
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'too_short'

`tuple_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ tuple:

from typing import Tuple

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    x: Tuple[int]


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'tuple_type'

Cette erreur est également générée pour les champs stricts lorsque la valeur d'entrée n'est pas une instance de tuple .

`unexpected_keyword_argument`¶

Cette erreur est générée lorsque vous fournissez une valeur par mot-clé pour un argument de position uniquement lors de l'appel d'une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(a: int, /):
    return a


try:
    foo(a=2)
except ValidationError as exc:
    print(repr(exc.errors()[1]['type']))
    #> 'unexpected_keyword_argument'

Il est également généré lors de l'utilisation de pydantic.dataclasses et extra=forbid :

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


@dataclass(config={'extra': 'forbid'})
class Foo:
    bar: int


try:
    TypeAdapter(Foo).validate_python({'bar': 1, 'foobar': 2})
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'unexpected_keyword_argument'

`unexpected_positional_argument`¶

Cette erreur est générée lorsque vous fournissez une valeur de position pour un argument de mot-clé uniquement lors de l'appel d'une fonction décorée avec validate_call :

from pydantic import ValidationError, validate_call


@validate_call
def foo(*, a: int):
    return a


try:
    foo(2)
except ValidationError as exc:
    print(repr(exc.errors()[1]['type']))
    #> 'unexpected_positional_argument'

`union_tag_invalid`¶

Cette erreur est générée lorsque le discriminateur de l'entrée ne fait pas partie des valeurs attendues:

from typing import Union

from typing_extensions import Literal

from pydantic import BaseModel, Field, ValidationError


class BlackCat(BaseModel):
    pet_type: Literal['blackcat']


class WhiteCat(BaseModel):
    pet_type: Literal['whitecat']


class Model(BaseModel):
    cat: Union[BlackCat, WhiteCat] = Field(..., discriminator='pet_type')


try:
    Model(cat={'pet_type': 'dog'})
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'union_tag_invalid'

`union_tag_not_found`¶

Cette erreur est générée lorsqu'il n'est pas possible d'extraire une valeur discriminatrice de l'entrée:

from typing import Union

from typing_extensions import Literal

from pydantic import BaseModel, Field, ValidationError


class BlackCat(BaseModel):
    pet_type: Literal['blackcat']


class WhiteCat(BaseModel):
    pet_type: Literal['whitecat']


class Model(BaseModel):
    cat: Union[BlackCat, WhiteCat] = Field(..., discriminator='pet_type')


try:
    Model(cat={'name': 'blackcat'})
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'union_tag_not_found'

`url_parsing`¶

Cette erreur est générée lorsque la valeur d'entrée ne peut pas être analysée en tant qu'URL:

from pydantic import AnyUrl, BaseModel, ValidationError


class Model(BaseModel):
    x: AnyUrl


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'url_parsing'

`url_scheme`¶

Cette erreur est générée lorsque le schéma d'URL n'est pas valide pour le type d'URL du champ:

from pydantic import BaseModel, HttpUrl, ValidationError


class Model(BaseModel):
    x: HttpUrl


try:
    Model(x='ftp://example.com')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'url_scheme'

`url_syntax_violation`¶

Cette erreur est générée lorsque la syntaxe de l'URL n'est pas valide:

from pydantic import BaseModel, Field, HttpUrl, ValidationError


class Model(BaseModel):
    x: HttpUrl = Field(strict=True)


try:
    Model(x='http:////example.com')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'url_syntax_violation'

`url_too_long`¶

Cette erreur est générée lorsque la longueur de l'URL est supérieure à 2083:

from pydantic import BaseModel, HttpUrl, ValidationError


class Model(BaseModel):
    x: HttpUrl


try:
    Model(x='x' * 2084)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'url_too_long'

`url_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ URL:

from pydantic import BaseModel, HttpUrl, ValidationError


class Model(BaseModel):
    x: HttpUrl


try:
    Model(x=None)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'url_type'

`uuid_parsing`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas valide pour un champ UUID:

from uuid import UUID

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    u: UUID


try:
    Model(u='12345678-124-1234-1234-567812345678')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'uuid_parsing'

`uuid_type`¶

Cette erreur est générée lorsque le type de la valeur d'entrée n'est pas une instance valide pour un champ UUID (str, bytes ou UUID):

from uuid import UUID

from pydantic import BaseModel, ValidationError


class Model(BaseModel):
    u: UUID


try:
    Model(u=1234567812412341234567812345678)
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'uuid_type'

`uuid_version`¶

Cette erreur est générée lorsque le type de la valeur d'entrée ne correspond pas à la version de l'UUID:

from pydantic import UUID5, BaseModel, ValidationError


class Model(BaseModel):
    u: UUID5


try:
    Model(u='a6cc5730-2261-11ee-9c43-2eb5a363657c')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'uuid_version'

`value_error`¶

Cette erreur est générée lorsqu'une ValueError est générée lors de la validation:

from pydantic import BaseModel, ValidationError, field_validator


class Model(BaseModel):
    x: str

    @field_validator('x')
    @classmethod
    def repeat_b(cls, v):
        raise ValueError()


try:
    Model(x='test')
except ValidationError as exc:
    print(repr(exc.errors()[0]['type']))
    #> 'value_error'

本文总阅读量次

Erreurs de validation

type_arguments¶

assertion_error¶

bool_parsing¶

bool_type¶

bytes_too_long¶

bytes_too_short¶

bytes_type¶

callable_type¶

dataclass_exact_type¶

dataclass_type¶

date_from_datetime_inexact¶

date_from_datetime_parsing¶

date_future¶

date_parsing¶

date_past¶

date_type¶

datetime_from_date_parsing¶

datetime_future¶

datetime_object_invalid¶

datetime_parsing¶

datetime_past¶

datetime_type¶

decimal_max_digits¶

decimal_max_places¶

decimal_parsing¶

decimal_type¶

decimal_whole_digits¶

dict_type¶

enum¶

extra_forbidden¶

finite_number¶

float_parsing¶

float_type¶

frozen_field¶

frozen_instance¶

frozen_set_type¶

get_attribute_error¶

greater_than¶

greater_than_equal¶

int_from_float¶

int_parsing¶

int_parsing_size¶

int_type¶

invalid_key¶

is_instance_of¶

is_subclass_of¶

iterable_type¶

iteration_error¶

json_invalid¶

json_type¶

less_than¶

less_than_equal¶

list_type¶

literal_error¶

mapping_type¶

missing¶

missing_argument¶

missing_keyword_only_argument¶

missing_positional_only_argument¶

model_attributes_type¶

model_type¶

multiple_argument_values¶

multiple_of¶

no_such_attribute¶

none_required¶

recursion_loop¶

set_type¶

string_pattern_mismatch¶

string_sub_type¶

string_too_long¶

string_too_short¶

string_type¶

string_unicode¶

time_delta_parsing¶

time_delta_type¶

time_parsing¶

time_type¶

timezone_aware¶

timezone_naive¶