forked from pydantic/pydantic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_validators.py
2612 lines (1975 loc) · 73.2 KB
/
test_validators.py
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import contextlib
import re
import sys
from collections import deque
from datetime import date, datetime
from enum import Enum
from functools import partial, partialmethod
from itertools import product
from typing import Any, Callable, Deque, Dict, FrozenSet, List, Optional, Tuple, Union
from unittest.mock import MagicMock
import pytest
from dirty_equals import HasRepr
from typing_extensions import Annotated, Literal
from pydantic import (
BaseModel,
ConfigDict,
Field,
FieldValidationInfo,
PydanticDeprecatedSince20,
PydanticUserError,
ValidationError,
ValidationInfo,
ValidatorFunctionWrapHandler,
errors,
field_validator,
model_validator,
root_validator,
validator,
)
from pydantic.functional_validators import AfterValidator, BeforeValidator, PlainValidator, WrapValidator
V1_VALIDATOR_DEPRECATION_MATCH = r'Pydantic V1 style `@validator` validators are deprecated'
def test_annotated_validator_after() -> None:
MyInt = Annotated[int, AfterValidator(lambda x, _info: x if x != -1 else 0)]
class Model(BaseModel):
x: MyInt
assert Model(x=0).x == 0
assert Model(x=-1).x == 0
assert Model(x=-2).x == -2
assert Model(x=1).x == 1
assert Model(x='-1').x == 0
def test_annotated_validator_before() -> None:
FloatMaybeInf = Annotated[float, BeforeValidator(lambda x, _info: x if x != 'zero' else 0.0)]
class Model(BaseModel):
x: FloatMaybeInf
assert Model(x='zero').x == 0.0
assert Model(x=1.0).x == 1.0
assert Model(x='1.0').x == 1.0
def test_annotated_validator_builtin() -> None:
"""https://github.com/pydantic/pydantic/issues/6752"""
TruncatedFloat = Annotated[float, BeforeValidator(int)]
DateTimeFromIsoFormat = Annotated[datetime, BeforeValidator(datetime.fromisoformat)]
class Model(BaseModel):
x: TruncatedFloat
y: DateTimeFromIsoFormat
m = Model(x=1.234, y='2011-11-04T00:05:23')
assert m.x == 1
assert m.y == datetime(2011, 11, 4, 0, 5, 23)
def test_annotated_validator_plain() -> None:
MyInt = Annotated[int, PlainValidator(lambda x, _info: x if x != -1 else 0)]
class Model(BaseModel):
x: MyInt
assert Model(x=0).x == 0
assert Model(x=-1).x == 0
assert Model(x=-2).x == -2
def test_annotated_validator_wrap() -> None:
def sixties_validator(val: Any, handler: ValidatorFunctionWrapHandler, info: ValidationInfo) -> date:
if val == 'epoch':
return date.fromtimestamp(0)
newval = handler(val)
if not date.fromisoformat('1960-01-01') <= newval < date.fromisoformat('1970-01-01'):
raise ValueError(f'{val} is not in the sixties!')
return newval
SixtiesDateTime = Annotated[date, WrapValidator(sixties_validator)]
class Model(BaseModel):
x: SixtiesDateTime
assert Model(x='epoch').x == date.fromtimestamp(0)
assert Model(x='1962-01-13').x == date(year=1962, month=1, day=13)
assert Model(x=datetime(year=1962, month=1, day=13)).x == date(year=1962, month=1, day=13)
with pytest.raises(ValidationError) as exc_info:
Model(x=date(year=1970, month=4, day=17))
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(ValueError('1970-04-17 is not in the sixties!')))},
'input': date(1970, 4, 17),
'loc': ('x',),
'msg': 'Value error, 1970-04-17 is not in the sixties!',
'type': 'value_error',
}
]
def test_annotated_validator_nested() -> None:
MyInt = Annotated[int, AfterValidator(lambda x: x if x != -1 else 0)]
def non_decreasing_list(data: List[int]) -> List[int]:
for prev, cur in zip(data, data[1:]):
assert cur >= prev
return data
class Model(BaseModel):
x: Annotated[List[MyInt], AfterValidator(non_decreasing_list)]
assert Model(x=[0, -1, 2]).x == [0, 0, 2]
with pytest.raises(ValidationError) as exc_info:
Model(x=[0, -1, -2])
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(AssertionError('assert -2 >= 0')))},
'input': [0, -1, -2],
'loc': ('x',),
'msg': 'Assertion failed, assert -2 >= 0',
'type': 'assertion_error',
}
]
def test_annotated_validator_runs_before_field_validators() -> None:
MyInt = Annotated[int, AfterValidator(lambda x: x if x != -1 else 0)]
class Model(BaseModel):
x: MyInt
@field_validator('x')
def val_x(cls, v: int) -> int:
assert v != -1
return v
assert Model(x=-1).x == 0
@pytest.mark.parametrize(
'validator, func',
[
(PlainValidator, lambda x: x if x != -1 else 0),
(WrapValidator, lambda x, nxt: x if x != -1 else 0),
(BeforeValidator, lambda x: x if x != -1 else 0),
(AfterValidator, lambda x: x if x != -1 else 0),
],
)
def test_annotated_validator_typing_cache(validator, func):
FancyInt = Annotated[int, validator(func)]
class FancyIntModel(BaseModel):
x: Optional[FancyInt]
assert FancyIntModel(x=1234).x == 1234
assert FancyIntModel(x=-1).x == 0
assert FancyIntModel(x=0).x == 0
def test_simple():
class Model(BaseModel):
a: str
@field_validator('a')
@classmethod
def check_a(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
assert Model(a='this is foobar good').a == 'this is foobar good'
with pytest.raises(ValidationError) as exc_info:
Model(a='snap')
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(ValueError('"foobar" not found in a')))},
'input': 'snap',
'loc': ('a',),
'msg': 'Value error, "foobar" not found in a',
'type': 'value_error',
}
]
def test_int_validation():
class Model(BaseModel):
a: int
with pytest.raises(ValidationError) as exc_info:
Model(a='snap')
assert exc_info.value.errors(include_url=False) == [
{
'type': 'int_parsing',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'snap',
}
]
assert Model(a=3).a == 3
assert Model(a=True).a == 1
assert Model(a=False).a == 0
with pytest.raises(ValidationError) as exc_info:
Model(a=4.5)
assert exc_info.value.errors(include_url=False) == [
{
'type': 'int_from_float',
'loc': ('a',),
'msg': 'Input should be a valid integer, got a number with a fractional part',
'input': 4.5,
}
]
# Doesn't raise ValidationError for number > (2 ^ 63) - 1
assert Model(a=(2**63) + 100).a == (2**63) + 100
@pytest.mark.parametrize('value', [2.2250738585072011e308, float('nan'), float('inf')])
def test_int_overflow_validation(value):
class Model(BaseModel):
a: int
with pytest.raises(ValidationError) as exc_info:
Model(a=value)
assert exc_info.value.errors(include_url=False) == [
{'type': 'finite_number', 'loc': ('a',), 'msg': 'Input should be a finite number', 'input': value}
]
def test_frozenset_validation():
class Model(BaseModel):
a: FrozenSet[int]
with pytest.raises(ValidationError) as exc_info:
Model(a='snap')
assert exc_info.value.errors(include_url=False) == [
{'type': 'frozen_set_type', 'loc': ('a',), 'msg': 'Input should be a valid frozenset', 'input': 'snap'}
]
assert Model(a={1, 2, 3}).a == frozenset({1, 2, 3})
assert Model(a=frozenset({1, 2, 3})).a == frozenset({1, 2, 3})
assert Model(a=[4, 5]).a == frozenset({4, 5})
assert Model(a=(6,)).a == frozenset({6})
assert Model(a={'1', '2', '3'}).a == frozenset({1, 2, 3})
def test_deque_validation():
class Model(BaseModel):
a: Deque[int]
with pytest.raises(ValidationError) as exc_info:
Model(a='snap')
assert exc_info.value.errors(include_url=False) == [
{'type': 'list_type', 'loc': ('a',), 'msg': 'Input should be a valid list', 'input': 'snap'}
]
with pytest.raises(ValidationError) as exc_info:
Model(a=['a'])
assert exc_info.value.errors(include_url=False) == [
{
'type': 'int_parsing',
'loc': ('a', 0),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'a',
}
]
with pytest.raises(ValidationError) as exc_info:
Model(a=('a',))
assert exc_info.value.errors(include_url=False) == [
{
'type': 'int_parsing',
'loc': ('a', 0),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'a',
}
]
assert Model(a={'1'}).a == deque([1])
assert Model(a=[4, 5]).a == deque([4, 5])
assert Model(a=(6,)).a == deque([6])
def test_validate_whole():
class Model(BaseModel):
a: List[int]
@field_validator('a', mode='before')
@classmethod
def check_a1(cls, v: List[Any]) -> List[Any]:
v.append('123')
return v
@field_validator('a')
@classmethod
def check_a2(cls, v: List[int]) -> List[Any]:
v.append(456)
return v
assert Model(a=[1, 2]).a == [1, 2, 123, 456]
def test_validate_pre_error():
calls = []
class Model(BaseModel):
a: List[int]
@field_validator('a', mode='before')
@classmethod
def check_a1(cls, v: Any):
calls.append(f'check_a1 {v}')
if 1 in v:
raise ValueError('a1 broken')
v[0] += 1
return v
@field_validator('a')
@classmethod
def check_a2(cls, v: Any):
calls.append(f'check_a2 {v}')
if 10 in v:
raise ValueError('a2 broken')
return v
assert Model(a=[3, 8]).a == [4, 8]
assert calls == ['check_a1 [3, 8]', 'check_a2 [4, 8]']
calls = []
with pytest.raises(ValidationError) as exc_info:
Model(a=[1, 3])
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(ValueError('a1 broken')))},
'input': [1, 3],
'loc': ('a',),
'msg': 'Value error, a1 broken',
'type': 'value_error',
}
]
assert calls == ['check_a1 [1, 3]']
calls = []
with pytest.raises(ValidationError) as exc_info:
Model(a=[5, 10])
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(ValueError('a2 broken')))},
'input': [6, 10],
'loc': ('a',),
'msg': 'Value error, a2 broken',
'type': 'value_error',
}
]
assert calls == ['check_a1 [5, 10]', 'check_a2 [6, 10]']
@pytest.fixture(scope='session', name='ValidateAssignmentModel')
def validate_assignment_model_fixture():
class ValidateAssignmentModel(BaseModel):
a: int = 4
b: str = ...
c: int = 0
@field_validator('b')
@classmethod
def b_length(cls, v, info):
values = info.data
if 'a' in values and len(v) < values['a']:
raise ValueError('b too short')
return v
@field_validator('c')
@classmethod
def double_c(cls, v: Any):
return v * 2
model_config = ConfigDict(validate_assignment=True, extra='allow')
return ValidateAssignmentModel
def test_validating_assignment_ok(ValidateAssignmentModel):
p = ValidateAssignmentModel(b='hello')
assert p.b == 'hello'
def test_validating_assignment_fail(ValidateAssignmentModel):
with pytest.raises(ValidationError):
ValidateAssignmentModel(a=10, b='hello')
p = ValidateAssignmentModel(b='hello')
with pytest.raises(ValidationError):
p.b = 'x'
def test_validating_assignment_value_change(ValidateAssignmentModel):
p = ValidateAssignmentModel(b='hello', c=2)
assert p.c == 4
p = ValidateAssignmentModel(b='hello')
assert p.c == 0
p.c = 3
assert p.c == 6
assert p.model_dump()['c'] == 6
def test_validating_assignment_extra(ValidateAssignmentModel):
p = ValidateAssignmentModel(b='hello', extra_field=1.23)
assert p.extra_field == 1.23
p = ValidateAssignmentModel(b='hello')
p.extra_field = 1.23
assert p.extra_field == 1.23
p.extra_field = 'bye'
assert p.extra_field == 'bye'
assert p.model_dump()['extra_field'] == 'bye'
def test_validating_assignment_dict(ValidateAssignmentModel):
with pytest.raises(ValidationError) as exc_info:
ValidateAssignmentModel(a='x', b='xx')
assert exc_info.value.errors(include_url=False) == [
{
'type': 'int_parsing',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'x',
}
]
def test_validating_assignment_values_dict():
class ModelOne(BaseModel):
a: int
class ModelTwo(BaseModel):
m: ModelOne
b: int
@field_validator('b')
@classmethod
def validate_b(cls, b, info: FieldValidationInfo):
if 'm' in info.data:
return b + info.data['m'].a # this fails if info.data['m'] is a dict
else:
return b
model_config = ConfigDict(validate_assignment=True)
model = ModelTwo(m=ModelOne(a=1), b=2)
assert model.b == 3
model.b = 3
assert model.b == 4
def test_validate_multiple():
class Model(BaseModel):
a: str
b: str
@field_validator('a', 'b')
@classmethod
def check_a_and_b(cls, v: Any, info: FieldValidationInfo) -> Any:
if len(v) < 4:
field = cls.model_fields[info.field_name]
raise AssertionError(f'{field.alias or info.field_name} is too short')
return v + 'x'
assert Model(a='1234', b='5678').model_dump() == {'a': '1234x', 'b': '5678x'}
with pytest.raises(ValidationError) as exc_info:
Model(a='x', b='x')
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(AssertionError('a is too short')))},
'input': 'x',
'loc': ('a',),
'msg': 'Assertion failed, a is too short',
'type': 'assertion_error',
},
{
'ctx': {'error': HasRepr(repr(AssertionError('b is too short')))},
'input': 'x',
'loc': ('b',),
'msg': 'Assertion failed, b is too short',
'type': 'assertion_error',
},
]
def test_classmethod():
class Model(BaseModel):
a: str
@field_validator('a')
@classmethod
def check_a(cls, v: Any):
assert cls is Model
return v
m = Model(a='this is foobar good')
assert m.a == 'this is foobar good'
m.check_a('x')
def test_use_bare():
with pytest.raises(TypeError, match='`@validator` should be used with fields'):
class Model(BaseModel):
a: str
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
@validator
def checker(cls, v):
return v
def test_use_bare_field_validator():
with pytest.raises(TypeError, match='`@field_validator` should be used with fields'):
class Model(BaseModel):
a: str
@field_validator
def checker(cls, v):
return v
def test_use_no_fields():
with pytest.raises(TypeError, match=re.escape("validator() missing 1 required positional argument: '__field'")):
class Model(BaseModel):
a: str
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
@validator()
def checker(cls, v):
return v
def test_use_no_fields_field_validator():
with pytest.raises(
TypeError, match=re.escape("field_validator() missing 1 required positional argument: '__field'")
):
class Model(BaseModel):
a: str
@field_validator()
def checker(cls, v):
return v
def test_validator_bad_fields_throws_configerror():
"""
Attempts to create a validator with fields set as a list of strings,
rather than just multiple string args. Expects ConfigError to be raised.
"""
with pytest.raises(TypeError, match='`@validator` fields should be passed as separate string args.'):
class Model(BaseModel):
a: str
b: str
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
@validator(['a', 'b'])
def check_fields(cls, v):
return v
def test_field_validator_bad_fields_throws_configerror():
"""
Attempts to create a validator with fields set as a list of strings,
rather than just multiple string args. Expects ConfigError to be raised.
"""
with pytest.raises(TypeError, match='`@field_validator` fields should be passed as separate string args.'):
class Model(BaseModel):
a: str
b: str
@field_validator(['a', 'b'])
def check_fields(cls, v):
return v
def test_validate_always():
check_calls = 0
class Model(BaseModel):
a: str = None
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
@validator('a', pre=True, always=True)
@classmethod
def check_a(cls, v: Any):
nonlocal check_calls
check_calls += 1
return v or 'xxx'
assert Model().a == 'xxx'
assert check_calls == 1
assert Model(a='y').a == 'y'
assert check_calls == 2
def test_field_validator_validate_default():
check_calls = 0
class Model(BaseModel):
a: str = Field(None, validate_default=True)
@field_validator('a', mode='before')
@classmethod
def check_a(cls, v: Any):
nonlocal check_calls
check_calls += 1
return v or 'xxx'
assert Model().a == 'xxx'
assert check_calls == 1
assert Model(a='y').a == 'y'
assert check_calls == 2
def test_validate_always_on_inheritance():
check_calls = 0
class ParentModel(BaseModel):
a: str = None
class Model(ParentModel):
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
@validator('a', pre=True, always=True)
@classmethod
def check_a(cls, v: Any):
nonlocal check_calls
check_calls += 1
return v or 'xxx'
assert Model().a == 'xxx'
assert check_calls == 1
assert Model(a='y').a == 'y'
assert check_calls == 2
def test_field_validator_validate_default_on_inheritance():
check_calls = 0
class ParentModel(BaseModel):
a: str = Field(None, validate_default=True)
class Model(ParentModel):
@field_validator('a', mode='before')
@classmethod
def check_a(cls, v: Any):
nonlocal check_calls
check_calls += 1
return v or 'xxx'
assert Model().a == 'xxx'
assert check_calls == 1
assert Model(a='y').a == 'y'
assert check_calls == 2
def test_validate_not_always():
check_calls = 0
class Model(BaseModel):
a: Optional[str] = None
@field_validator('a', mode='before')
@classmethod
def check_a(cls, v: Any):
nonlocal check_calls
check_calls += 1
return v or 'xxx'
assert Model().a is None
assert check_calls == 0
assert Model(a='y').a == 'y'
assert check_calls == 1
@pytest.mark.parametrize(
'decorator, pytest_warns',
[
(validator, pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH)),
(field_validator, contextlib.nullcontext()),
],
)
def test_wildcard_validators(decorator, pytest_warns):
calls: list[tuple[str, Any]] = []
with pytest_warns:
class Model(BaseModel):
a: str
b: int
@decorator('a')
def check_a(cls, v: Any) -> Any:
calls.append(('check_a', v))
return v
@decorator('*')
def check_all(cls, v: Any) -> Any:
calls.append(('check_all', v))
return v
@decorator('*', 'a')
def check_all_a(cls, v: Any) -> Any:
calls.append(('check_all_a', v))
return v
assert Model(a='abc', b='123').model_dump() == dict(a='abc', b=123)
assert calls == [
('check_a', 'abc'),
('check_all', 'abc'),
('check_all_a', 'abc'),
('check_all', 123),
('check_all_a', 123),
]
@pytest.mark.parametrize(
'decorator, pytest_warns',
[
(validator, pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH)),
(field_validator, contextlib.nullcontext()),
],
)
def test_wildcard_validator_error(decorator, pytest_warns):
with pytest_warns:
class Model(BaseModel):
a: str
b: str
@decorator('*')
def check_all(cls, v: Any) -> Any:
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
assert Model(a='foobar a', b='foobar b').b == 'foobar b'
with pytest.raises(ValidationError) as exc_info:
Model(a='snap')
assert exc_info.value.errors(include_url=False) == [
{
'ctx': {'error': HasRepr(repr(ValueError('"foobar" not found in a')))},
'input': 'snap',
'loc': ('a',),
'msg': 'Value error, "foobar" not found in a',
'type': 'value_error',
},
{'type': 'missing', 'loc': ('b',), 'msg': 'Field required', 'input': {'a': 'snap'}},
]
def test_invalid_field():
msg = (
r'Decorators defined with incorrect fields:'
r' tests.test_validators.test_invalid_field.<locals>.Model:\d+.check_b'
r" \(use check_fields=False if you're inheriting from the model and intended this\)"
)
with pytest.raises(errors.PydanticUserError, match=msg):
class Model(BaseModel):
a: str
@field_validator('b')
def check_b(cls, v: Any):
return v
def test_validate_child():
class Parent(BaseModel):
a: str
class Child(Parent):
@field_validator('a')
@classmethod
def check_a(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
assert Parent(a='this is not a child').a == 'this is not a child'
assert Child(a='this is foobar good').a == 'this is foobar good'
with pytest.raises(ValidationError):
Child(a='snap')
def test_validate_child_extra():
class Parent(BaseModel):
a: str
@field_validator('a')
@classmethod
def check_a_one(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
class Child(Parent):
@field_validator('a')
@classmethod
def check_a_two(cls, v: Any):
return v.upper()
assert Parent(a='this is foobar good').a == 'this is foobar good'
assert Child(a='this is foobar good').a == 'THIS IS FOOBAR GOOD'
with pytest.raises(ValidationError):
Child(a='snap')
def test_validate_child_all():
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
class Parent(BaseModel):
a: str
class Child(Parent):
@validator('*')
@classmethod
def check_a(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
assert Parent(a='this is not a child').a == 'this is not a child'
assert Child(a='this is foobar good').a == 'this is foobar good'
with pytest.raises(ValidationError):
Child(a='snap')
def test_validate_parent():
class Parent(BaseModel):
a: str
@field_validator('a')
@classmethod
def check_a(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
class Child(Parent):
pass
assert Parent(a='this is foobar good').a == 'this is foobar good'
assert Child(a='this is foobar good').a == 'this is foobar good'
with pytest.raises(ValidationError):
Parent(a='snap')
with pytest.raises(ValidationError):
Child(a='snap')
def test_validate_parent_all():
with pytest.warns(PydanticDeprecatedSince20, match=V1_VALIDATOR_DEPRECATION_MATCH):
class Parent(BaseModel):
a: str
@validator('*')
@classmethod
def check_a(cls, v: Any):
if 'foobar' not in v:
raise ValueError('"foobar" not found in a')
return v
class Child(Parent):
pass
assert Parent(a='this is foobar good').a == 'this is foobar good'
assert Child(a='this is foobar good').a == 'this is foobar good'
with pytest.raises(ValidationError):
Parent(a='snap')
with pytest.raises(ValidationError):
Child(a='snap')
def test_inheritance_keep():
class Parent(BaseModel):
a: int
@field_validator('a')
@classmethod
def add_to_a(cls, v: Any):
return v + 1
class Child(Parent):
pass
assert Child(a=0).a == 1
def test_inheritance_replace():
"""We promise that if you add a validator
with the same _function_ name as an existing validator
it replaces the existing validator and is run instead of it.
"""
class Parent(BaseModel):
a: List[str]
@field_validator('a')
@classmethod
def parent_val_before(cls, v: List[str]):
v.append('parent before')
return v
@field_validator('a')
@classmethod
def val(cls, v: List[str]):
v.append('parent')
return v
@field_validator('a')
@classmethod
def parent_val_after(cls, v: List[str]):
v.append('parent after')
return v
class Child(Parent):
@field_validator('a')
@classmethod
def child_val_before(cls, v: List[str]):
v.append('child before')
return v
@field_validator('a')
@classmethod
def val(cls, v: List[str]):
v.append('child')
return v
@field_validator('a')
@classmethod
def child_val_after(cls, v: List[str]):
v.append('child after')
return v
assert Parent(a=[]).a == ['parent before', 'parent', 'parent after']
assert Child(a=[]).a == ['parent before', 'child', 'parent after', 'child before', 'child after']
def test_inheritance_replace_root_validator():
"""
We promise that if you add a validator
with the same _function_ name as an existing validator
it replaces the existing validator and is run instead of it.
"""
with pytest.warns(PydanticDeprecatedSince20):
class Parent(BaseModel):
a: List[str]
@root_validator(skip_on_failure=True)
def parent_val_before(cls, values: Dict[str, Any]):
values['a'].append('parent before')
return values
@root_validator(skip_on_failure=True)
def val(cls, values: Dict[str, Any]):
values['a'].append('parent')
return values
@root_validator(skip_on_failure=True)
def parent_val_after(cls, values: Dict[str, Any]):
values['a'].append('parent after')
return values
class Child(Parent):