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
|
from __future__ import annotations
import contextlib
from collections.abc import Generator
from functools import partial
from typing import Any
import pytest
from pydantic_core import ValidationError
from pydantic import BaseModel, TypeAdapter, create_model, dataclasses, field_validator, validate_call
from pydantic.config import ExtraValues
from pydantic.plugin import (
PydanticPluginProtocol,
SchemaTypePath,
ValidateJsonHandlerProtocol,
ValidatePythonHandlerProtocol,
ValidateStringsHandlerProtocol,
)
from pydantic.plugin._loader import _plugins
pytestmark = pytest.mark.thread_unsafe(reason='`install_plugin()` is thread unsafe')
@contextlib.contextmanager
def install_plugin(plugin: PydanticPluginProtocol) -> Generator[None, None, None]:
_plugins[plugin.__class__.__qualname__] = plugin
try:
yield
finally:
_plugins.clear()
def test_on_validate_json_on_success() -> None:
class CustomOnValidateJson(ValidateJsonHandlerProtocol):
def on_enter(
self,
input: str | bytes | bytearray,
*,
strict: bool | None = None,
extra: ExtraValues | None = None,
context: Any | None = None,
self_instance: Any | None = None,
by_alias: bool | None = None,
by_name: bool | None = None,
) -> None:
assert input == '{"a": 1}'
assert strict is None
assert extra is None
assert context is None
assert self_instance is None
def on_success(self, result: Any) -> None:
assert isinstance(result, Model)
class CustomPlugin(PydanticPluginProtocol):
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert config == {'title': 'Model'}
assert plugin_settings == {'observe': 'all'}
assert schema_type.__name__ == 'Model'
assert schema_type_path == SchemaTypePath(
'tests.test_plugins', 'test_on_validate_json_on_success.<locals>.Model'
)
assert schema_kind == 'BaseModel'
return None, CustomOnValidateJson(), None
plugin = CustomPlugin()
with install_plugin(plugin):
class Model(BaseModel, plugin_settings={'observe': 'all'}):
a: int
assert Model.model_validate({'a': 1}) == Model(a=1)
assert Model.model_validate_json('{"a": 1}') == Model(a=1)
assert Model.__pydantic_validator__.title == 'Model'
def test_on_validate_json_on_error() -> None:
class CustomOnValidateJson:
def on_enter(
self,
input: str | bytes | bytearray,
*,
strict: bool | None = None,
extra: ExtraValues | None = None,
context: Any | None = None,
self_instance: Any | None = None,
by_alias: bool | None = None,
by_name: bool | None = None,
) -> None:
assert input == '{"a": "potato"}'
assert strict is None
assert extra is None
assert context is None
assert self_instance is None
def on_error(self, error: ValidationError) -> None:
assert error.title == 'Model'
assert error.errors(include_url=False) == [
{
'input': 'potato',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'type': 'int_parsing',
},
]
class Plugin(PydanticPluginProtocol):
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert config == {'title': 'Model'}
assert plugin_settings == {'observe': 'all'}
return None, CustomOnValidateJson(), None
plugin = Plugin()
with install_plugin(plugin):
class Model(BaseModel, plugin_settings={'observe': 'all'}):
a: int
assert Model.model_validate({'a': 1}) == Model(a=1)
with contextlib.suppress(ValidationError):
Model.model_validate_json('{"a": "potato"}')
def test_on_validate_python_on_success() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
def on_enter(
self,
input: Any,
*,
strict: bool | None = None,
extra: ExtraValues | None = None,
from_attributes: bool | None = None,
context: Any | None = None,
self_instance: Any | None = None,
by_alias: bool | None = None,
by_name: bool | None = None,
) -> None:
assert input == {'a': 1}
assert strict is None
assert extra is None
assert context is None
assert self_instance is None
def on_success(self, result: Any) -> None:
assert isinstance(result, Model)
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert config == {'title': 'Model'}
assert plugin_settings == {'observe': 'all'}
assert schema_type.__name__ == 'Model'
assert schema_kind == 'BaseModel'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
class Model(BaseModel, plugin_settings={'observe': 'all'}):
a: int
assert Model.model_validate({'a': 1}).model_dump() == {'a': 1}
assert Model.model_validate_json('{"a": 1}').model_dump() == {'a': 1}
def test_on_validate_python_on_error() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
def on_enter(
self,
input: Any,
*,
strict: bool | None = None,
extra: ExtraValues | None = None,
from_attributes: bool | None = None,
context: Any | None = None,
self_instance: Any | None = None,
by_alias: bool | None = None,
by_name: bool | None = None,
) -> None:
assert input == {'a': 'potato'}
assert strict is None
assert extra is None
assert context is None
assert self_instance is None
def on_error(self, error: ValidationError) -> None:
assert error.title == 'Model'
assert error.errors(include_url=False) == [
{
'input': 'potato',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'type': 'int_parsing',
},
]
class Plugin(PydanticPluginProtocol):
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert config == {'title': 'Model'}
assert plugin_settings == {'observe': 'all'}
assert schema_type.__name__ == 'Model'
assert schema_kind == 'BaseModel'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
class Model(BaseModel, plugin_settings={'observe': 'all'}):
a: int
with contextlib.suppress(ValidationError):
Model.model_validate({'a': 'potato'})
assert Model.model_validate_json('{"a": 1}').model_dump() == {'a': 1}
def test_stateful_plugin() -> None:
stack: list[Any] = []
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
def on_enter(
self,
input: Any,
*,
strict: bool | None = None,
extra: ExtraValues | None = None,
from_attributes: bool | None = None,
context: Any | None = None,
self_instance: Any | None = None,
by_alias: bool | None = None,
by_name: bool | None = None,
) -> None:
stack.append(input)
def on_success(self, result: Any) -> None:
stack.pop()
def on_error(self, error: Exception) -> None:
stack.pop()
def on_exception(self, exception: Exception) -> None:
stack.pop()
class Plugin(PydanticPluginProtocol):
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
return CustomOnValidatePython(), None, None
plugin = Plugin()
class MyException(Exception):
pass
with install_plugin(plugin):
class Model(BaseModel, plugin_settings={'observe': 'all'}):
a: int
@field_validator('a')
def validate_a(cls, v: int) -> int:
if v < 0:
raise MyException
return v
with contextlib.suppress(ValidationError):
Model.model_validate({'a': 'potato'})
assert not stack
with contextlib.suppress(MyException):
Model.model_validate({'a': -1})
assert not stack
assert Model.model_validate({'a': 1}).a == 1
assert not stack
def test_all_handlers():
log = []
class Python(ValidatePythonHandlerProtocol):
def on_enter(self, input, **kwargs) -> None:
log.append(f'python enter input={input} kwargs={kwargs}')
def on_success(self, result: Any) -> None:
log.append(f'python success result={result}')
def on_error(self, error: ValidationError) -> None:
log.append(f'python error error={error}')
class Json(ValidateJsonHandlerProtocol):
def on_enter(self, input, **kwargs) -> None:
log.append(f'json enter input={input} kwargs={kwargs}')
def on_success(self, result: Any) -> None:
log.append(f'json success result={result}')
def on_error(self, error: ValidationError) -> None:
log.append(f'json error error={error}')
class Strings(ValidateStringsHandlerProtocol):
def on_enter(self, input, **kwargs) -> None:
log.append(f'strings enter input={input} kwargs={kwargs}')
def on_success(self, result: Any) -> None:
log.append(f'strings success result={result}')
def on_error(self, error: ValidationError) -> None:
log.append(f'strings error error={error}')
class Plugin(PydanticPluginProtocol):
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
return Python(), Json(), Strings()
plugin = Plugin()
with install_plugin(plugin):
class Model(BaseModel):
a: int
assert Model(a=1).model_dump() == {'a': 1}
# insert_assert(log)
assert log == ["python enter input={'a': 1} kwargs={'self_instance': Model()}", 'python success result=a=1']
log.clear()
assert Model.model_validate_json('{"a": 2}', context={'c': 2}).model_dump() == {'a': 2}
# insert_assert(log)
assert log == [
"json enter input={\"a\": 2} kwargs={'strict': None, 'extra': None, 'context': {'c': 2}, 'by_alias': None, 'by_name': None}",
'json success result=a=2',
]
log.clear()
assert Model.model_validate_strings({'a': '3'}, strict=True, extra='forbid', context={'c': 3}).model_dump() == {
'a': 3
}
# insert_assert(log)
assert log == [
"strings enter input={'a': '3'} kwargs={'strict': True, 'extra': 'forbid', 'context': {'c': 3}, 'by_alias': None, 'by_name': None}",
'strings success result=a=3',
]
def test_plugin_path_dataclass() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert schema_type.__name__ == 'Bar'
assert schema_type_path == SchemaTypePath('tests.test_plugins', 'test_plugin_path_dataclass.<locals>.Bar')
assert schema_kind == 'dataclass'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
@dataclasses.dataclass
class Bar:
a: int
def test_plugin_path_type_adapter() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert str(schema_type) == 'list[str]'
assert schema_type_path == SchemaTypePath('tests.test_plugins', 'list[str]')
assert schema_kind == 'TypeAdapter'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
adapter = TypeAdapter(list[str])
adapter.validate_python(['a', 'b'])
def test_plugin_path_type_adapter_with_module() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert str(schema_type) == 'list[str]'
assert schema_type_path == SchemaTypePath('provided_module_by_type_adapter', 'list[str]')
assert schema_kind == 'TypeAdapter'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
TypeAdapter(list[str], module='provided_module_by_type_adapter')
def test_plugin_path_type_adapter_without_name_in_globals() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert str(schema_type) == 'list[str]'
assert schema_type_path == SchemaTypePath('', 'list[str]')
assert schema_kind == 'TypeAdapter'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
code = """
import pydantic
pydantic.TypeAdapter(list[str])
"""
exec(code, {'bar': 'baz'})
def test_plugin_path_validate_call() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin1:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert schema_type.__name__ == 'foo'
assert schema_type_path == SchemaTypePath(
'tests.test_plugins', 'test_plugin_path_validate_call.<locals>.foo'
)
assert schema_kind == 'validate_call'
return CustomOnValidatePython(), None, None
plugin = Plugin1()
with install_plugin(plugin):
@validate_call()
def foo(a: int):
return a
class Plugin2:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert schema_type.__name__ == 'my_wrapped_function'
assert schema_type_path == SchemaTypePath(
'tests.test_plugins', 'partial(test_plugin_path_validate_call.<locals>.my_wrapped_function)'
)
assert schema_kind == 'validate_call'
return CustomOnValidatePython(), None, None
plugin = Plugin2()
with install_plugin(plugin):
def my_wrapped_function(a: int, b: int, c: int):
return a + b + c
my_partial_function = partial(my_wrapped_function, c=3)
validate_call(my_partial_function)
def test_plugin_path_create_model() -> None:
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
assert schema_type.__name__ == 'FooModel'
assert list(schema_type.model_fields.keys()) == ['foo', 'bar']
assert schema_type_path == SchemaTypePath('tests.test_plugins', 'FooModel')
assert schema_kind == 'create_model'
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
create_model('FooModel', foo=(str, ...), bar=(int, 123))
def test_plugin_path_complex() -> None:
paths: list[tuple(str, str)] = []
class CustomOnValidatePython(ValidatePythonHandlerProtocol):
pass
class Plugin:
def new_schema_validator(self, schema, schema_type, schema_type_path, schema_kind, config, plugin_settings):
paths.append((schema_type.__name__, schema_type_path, schema_kind))
return CustomOnValidatePython(), None, None
plugin = Plugin()
with install_plugin(plugin):
def foo():
class Model1(BaseModel):
pass
def bar():
class Model2(BaseModel):
pass
foo()
bar()
assert paths == [
(
'Model1',
SchemaTypePath('tests.test_plugins', 'test_plugin_path_complex.<locals>.foo.<locals>.Model1'),
'BaseModel',
),
(
'Model2',
SchemaTypePath('tests.test_plugins', 'test_plugin_path_complex.<locals>.bar.<locals>.Model2'),
'BaseModel',
),
]
|
