1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
|
import copy
from typing import Annotated, Any, Final, Union
import pytest
from annotated_types import Gt
from pydantic_core import PydanticUndefined
from typing_extensions import TypeAliasType
import pydantic.dataclasses
from pydantic import (
AfterValidator,
BaseModel,
ConfigDict,
Field,
PydanticUserError,
RootModel,
TypeAdapter,
ValidationError,
computed_field,
create_model,
validate_call,
)
from pydantic.fields import FieldInfo
from pydantic.warnings import UnsupportedFieldAttributeWarning
def test_field_info_annotation_keyword_argument():
"""This tests that `FieldInfo.from_field` raises an error if passed the `annotation` kwarg.
At the time of writing this test there is no way `FieldInfo.from_field` could receive the `annotation` kwarg from
anywhere inside Pydantic code. However, it is possible that this API is still being in use by applications and
third-party tools.
"""
with pytest.raises(TypeError) as e:
FieldInfo.from_field(annotation=())
assert e.value.args == ('"annotation" is not permitted as a Field keyword argument',)
def test_field_info_annotated_attribute_name_clashing():
"""This tests that `FieldInfo.from_annotated_attribute` will raise a `PydanticUserError` if attribute names clashes
with a type.
"""
with pytest.raises(PydanticUserError):
class SubModel(BaseModel):
a: int = 1
class Model(BaseModel):
SubModel: SubModel = Field()
def test_init_var_field():
@pydantic.dataclasses.dataclass
class Foo:
bar: str
baz: str = Field(init_var=True)
class Model(BaseModel):
foo: Foo
model = Model(foo=Foo('bar', baz='baz'))
assert 'bar' in model.foo.__pydantic_fields__
assert 'baz' not in model.foo.__pydantic_fields__
def test_root_model_arbitrary_field_name_error():
with pytest.raises(
NameError, match="Unexpected field with name 'a_field'; only 'root' is allowed as a field of a `RootModel`"
):
class Model(RootModel[int]):
a_field: str
def test_root_model_arbitrary_private_field_works():
class Model(RootModel[int]):
_a_field: str = 'value 1'
m = Model(1)
assert m._a_field == 'value 1'
m._a_field = 'value 2'
assert m._a_field == 'value 2'
def test_root_model_field_override():
# Weird as this is, I think it's probably best to allow it to ensure it is possible to override
# the annotation in subclasses of RootModel subclasses. Basically, I think retaining the flexibility
# is worth the increased potential for weird/confusing "accidental" overrides.
# I'm mostly including this test now to document the behavior
class Model(RootModel[int]):
root: str
assert Model.model_validate('abc').root == 'abc'
with pytest.raises(ValidationError) as exc_info:
Model.model_validate(1)
assert exc_info.value.errors(include_url=False) == [
{'input': 1, 'loc': (), 'msg': 'Input should be a valid string', 'type': 'string_type'}
]
class SubModel(Model):
root: float
with pytest.raises(ValidationError) as exc_info:
SubModel.model_validate('abc')
assert exc_info.value.errors(include_url=False) == [
{
'input': 'abc',
'loc': (),
'msg': 'Input should be a valid number, unable to parse string as a number',
'type': 'float_parsing',
}
]
validated = SubModel.model_validate_json('1').root
assert validated == 1.0
assert isinstance(validated, float)
def test_frozen_field_repr():
class Model(BaseModel):
non_frozen_field: int = Field(frozen=False)
frozen_field: int = Field(frozen=True)
assert repr(Model.model_fields['non_frozen_field']) == 'FieldInfo(annotation=int, required=True)'
assert repr(Model.model_fields['frozen_field']) == 'FieldInfo(annotation=int, required=True, frozen=True)'
def test_model_field_default_info():
"""Test that __repr_args__ of FieldInfo includes the default value when it's set to None."""
class Model(BaseModel):
a: Union[int, None] = Field(default=None)
b: Union[int, None] = None
assert str(Model.model_fields) == (
"{'a': FieldInfo(annotation=Union[int, NoneType], required=False, default=None), "
"'b': FieldInfo(annotation=Union[int, NoneType], required=False, default=None)}"
)
def test_computed_field_raises_correct_attribute_error():
class Model(BaseModel):
model_config = ConfigDict(extra='allow')
@computed_field
def comp_field(self) -> str:
raise AttributeError('Computed field attribute error')
@property
def prop_field(self):
raise AttributeError('Property attribute error')
with pytest.raises(AttributeError, match='Computed field attribute error'):
Model().comp_field
with pytest.raises(AttributeError, match='Property attribute error'):
Model().prop_field
with pytest.raises(AttributeError, match='Property attribute error'):
Model(some_extra_field='some value').prop_field
with pytest.raises(AttributeError, match=f"'{Model.__name__}' object has no attribute 'invalid_field'"):
Model().invalid_field
@pytest.mark.parametrize('number', (1, 42, 443, 11.11, 0.553))
def test_coerce_numbers_to_str_field_option(number):
class Model(BaseModel):
field: str = Field(coerce_numbers_to_str=True, max_length=10)
assert Model(field=number).field == str(number)
@pytest.mark.parametrize('number', (1, 42, 443, 11.11, 0.553))
def test_coerce_numbers_to_str_field_precedence(number):
class Model(BaseModel):
model_config = ConfigDict(coerce_numbers_to_str=True)
field: str = Field(coerce_numbers_to_str=False)
with pytest.raises(ValidationError):
Model(field=number)
class Model(BaseModel):
model_config = ConfigDict(coerce_numbers_to_str=False)
field: str = Field(coerce_numbers_to_str=True)
assert Model(field=number).field == str(number)
def test_rebuild_model_fields_preserves_description() -> None:
"""https://github.com/pydantic/pydantic/issues/11696"""
class Model(BaseModel):
model_config = ConfigDict(use_attribute_docstrings=True)
f: 'Int'
"""test doc"""
assert Model.model_fields['f'].description == 'test doc'
Int = int
Model.model_rebuild()
assert Model.model_fields['f'].description == 'test doc'
def test_final_to_frozen_with_assignment() -> None:
class Model(BaseModel):
# A buggy implementation made it so that `frozen` wouldn't
# be set on the `FieldInfo`:
b: Annotated[Final[int], ...] = Field(alias='test')
assert Model.model_fields['b'].frozen
def test_metadata_preserved_with_assignment() -> None:
def func1(v):
pass
def func2(v):
pass
class Model(BaseModel):
# A buggy implementation made it so that the first validator
# would be dropped:
a: Annotated[int, AfterValidator(func1), Field(gt=1), AfterValidator(func2)] = Field(...)
metadata = Model.model_fields['a'].metadata
assert isinstance(metadata[0], AfterValidator)
assert isinstance(metadata[1], Gt)
assert isinstance(metadata[2], AfterValidator)
def test_reused_field_not_mutated() -> None:
"""https://github.com/pydantic/pydantic/issues/11876"""
Ann = Annotated[int, Field()]
class Foo(BaseModel):
f: Ann = 50
class Bar(BaseModel):
f: Annotated[Ann, Field()]
assert Bar.model_fields['f'].default is PydanticUndefined
def test_no_duplicate_metadata_with_assignment_and_rebuild() -> None:
"""https://github.com/pydantic/pydantic/issues/11870"""
class Model(BaseModel):
f: Annotated['Int', Gt(1)] = Field()
Int = int
Model.model_rebuild()
assert len(Model.model_fields['f'].metadata) == 1
def test_fastapi_compatibility_hack() -> None:
class Body(FieldInfo):
"""A reproduction of the FastAPI's `Body` param."""
field = Body()
# Assigning after doesn't update `_attributes_set`, which is currently
# relied on to merge `FieldInfo` instances during field creation.
# This is also what the FastAPI code is doing in some places.
# The FastAPI compatibility hack makes it so that it still works.
field.default = 1
Model = create_model('Model', f=(int, field))
model_field = Model.model_fields['f']
assert isinstance(model_field, Body)
assert not model_field.is_required()
_unsupported_standalone_fieldinfo_attributes = (
('alias', 'alias'),
('validation_alias', 'alias'),
('serialization_alias', 'alias'),
('default', 1),
('default_factory', lambda: 1),
('exclude', True),
('deprecated', True),
('repr', False),
('validate_default', True),
('frozen', True),
('init', True),
('init_var', True),
('kw_only', True),
)
@pytest.mark.parametrize(
['attribute', 'value'],
_unsupported_standalone_fieldinfo_attributes,
)
def test_unsupported_field_attribute_type_alias(attribute: str, value: Any) -> None:
TestType = TypeAliasType('TestType', Annotated[int, Field(**{attribute: value})])
with pytest.warns(UnsupportedFieldAttributeWarning):
class Model(BaseModel):
f: TestType
@pytest.mark.parametrize(
['attribute', 'value'],
_unsupported_standalone_fieldinfo_attributes,
)
def test_unsupported_field_attribute_nested(attribute: str, value: Any) -> None:
TestType = TypeAliasType('TestType', Annotated[int, Field(**{attribute: value})])
with pytest.warns(UnsupportedFieldAttributeWarning):
class Model(BaseModel):
f: list[TestType]
@pytest.mark.parametrize(
['attribute', 'value'],
[
(attr, value)
for attr, value in _unsupported_standalone_fieldinfo_attributes
if attr not in ('default', 'default_factory')
],
)
def test_unsupported_field_attribute_nested_with_function(attribute: str, value: Any) -> None:
TestType = TypeAliasType('TestType', Annotated[int, Field(**{attribute: value})])
with pytest.warns(UnsupportedFieldAttributeWarning):
@validate_call
def func(a: list[TestType]) -> None:
return None
def test_default_factory_validated_data_argument_unsupported() -> None:
with pytest.warns(
UnsupportedFieldAttributeWarning,
match=(
r"A 'default_factory' taking validated data as an argument was provided to the `Field\(\)` function, "
'but no validated data is available in the context it was used.'
),
):
TypeAdapter(Annotated[int, Field(default_factory=lambda v: v['key'])])
def test_parent_field_info_not_mutated() -> None:
class Parent(BaseModel):
a: Annotated[int, Gt(2)]
# Sub.a's `FieldInfo` is copied from `Parent`.
# Up until v2.12.2, it did not make proper use of the
# `FieldInfo._copy()` method, resulting in mutations
# (although not recommended) leaking to the parent model:
class Sub(Parent):
pass
Sub.model_fields['a'].metadata.append(object())
assert len(Parent.model_fields['a'].metadata) == 1
def test_field_info_mutation_create_model() -> None:
"""
https://github.com/pydantic/pydantic/issues/12374.
This test is meant to prevent regressions, but it does *not* mean
it is a supported pattern. Passing a `FieldInfo` instance as `Annotated`
metadata isn't supposed to work (and it only does because we made the mistake
of having `Field()` returning `FieldInfo` instances -- see
https://github.com/pydantic/pydantic/issues/11122).
"""
def create_patch_model(cls: type[BaseModel]) -> type[BaseModel]:
fields = {}
for field_name, field in cls.model_fields.items():
field_copy = copy.deepcopy(field)
field_copy.default = None
fields[field_name] = (field.annotation, field_copy)
return create_model(f'Patch{cls.__name__}', **fields)
class Model(BaseModel):
a: Annotated[int, Field(gt=2)]
b: Annotated[int, Field(gt=3)]
PatchModel = create_patch_model(Model)
p_empty = PatchModel()
assert p_empty.a is None
assert p_empty.b is None
def test_optional_model_using_asdict() -> None:
def make_fields_optional(model_cls: type[BaseModel]) -> type[BaseModel]:
new_fields = {}
for f_name, f_info in model_cls.model_fields.items():
f_dct = f_info.asdict()
new_fields[f_name] = (
Annotated[(Union[f_dct['annotation'], None], *f_dct['metadata'], Field(**f_dct['attributes']))], # noqa: F821
None,
)
return create_model(
f'{type.__name__}Optional',
__base__=model_cls, # (1)!
**new_fields,
)
class Model(BaseModel):
a: Annotated[int, Field(gt=1)]
ModelOptional = make_fields_optional(Model)
assert ModelOptional().a is None
with pytest.raises(ValidationError):
ModelOptional(a=0)
def test_default_factory_without_validated_data_unsupported() -> None:
class FooBar(BaseModel):
a: int = Field(default_factory=lambda x: x)
assert FooBar.model_fields['a'].get_default() is None
with pytest.raises(ValueError):
FooBar.model_fields['a'].get_default(call_default_factory=True)
|