Skip to content

Commit 75cb79a

Browse files
committed
rename callback -> function, fix error message
1 parent ca9b467 commit 75cb79a

19 files changed

+248
-181
lines changed

pydantic_core/core_schema.py

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1499,18 +1499,18 @@ def __call__(self, __input_value: Any, __info: ModelFieldValidationInfo) -> Any:
14991499
...
15001500

15011501

1502-
class FieldValidatorCallbackSchema(TypedDict):
1502+
class FieldValidatorFunctionSchema(TypedDict):
15031503
type: Literal['field']
1504-
call: FieldValidatorCallback
1504+
function: FieldValidatorCallback
15051505

15061506

1507-
class GeneralValidatorCallbackSchema(TypedDict):
1507+
class GeneralValidatorFunctionSchema(TypedDict):
15081508
type: Literal['general']
1509-
call: GeneralValidatorCallback
1509+
function: GeneralValidatorCallback
15101510

15111511

1512-
class CallbackSchema(TypedDict, total=False):
1513-
function: Required[Union[FieldValidatorCallbackSchema, GeneralValidatorCallbackSchema]]
1512+
class FunctionSchema(TypedDict, total=False):
1513+
function: Required[Union[FieldValidatorFunctionSchema, GeneralValidatorFunctionSchema]]
15141514
type: Required[Literal['function']]
15151515
mode: Required[Literal['before', 'after']]
15161516
schema: Required[CoreSchema]
@@ -1519,14 +1519,14 @@ class CallbackSchema(TypedDict, total=False):
15191519
serialization: SerSchema
15201520

15211521

1522-
def field_before_validation_callback(
1522+
def field_before_validation_function(
15231523
function: FieldValidatorCallback,
15241524
schema: CoreSchema,
15251525
*,
15261526
ref: str | None = None,
15271527
metadata: Any = None,
15281528
serialization: SerSchema | None = None,
1529-
) -> CallbackSchema:
1529+
) -> FunctionSchema:
15301530
"""
15311531
Returns a schema that calls a validator function before validating
15321532
the provided **model field** schema, e.g.:
@@ -1539,7 +1539,7 @@ def fn(v: bytes, info: core_schema.ModelFieldValidationInfo) -> str:
15391539
assert info.field_name is not None
15401540
return v.decode() + 'world'
15411541
1542-
func_schema = core_schema.field_before_validation_callback(function=fn, schema=core_schema.str_schema())
1542+
func_schema = core_schema.field_before_validation_function(function=fn, schema=core_schema.str_schema())
15431543
schema = core_schema.typed_dict_schema(
15441544
{'a': core_schema.typed_dict_field(func_schema)}
15451545
)
@@ -1558,22 +1558,22 @@ def fn(v: bytes, info: core_schema.ModelFieldValidationInfo) -> str:
15581558
return dict_not_none(
15591559
type='function',
15601560
mode='before',
1561-
function={'type': 'field', 'call': function},
1561+
function={'type': 'field', 'function': function},
15621562
schema=schema,
15631563
ref=ref,
15641564
metadata=metadata,
15651565
serialization=serialization,
15661566
)
15671567

15681568

1569-
def general_before_validation_callback(
1569+
def general_before_validation_function(
15701570
function: GeneralValidatorCallback,
15711571
schema: CoreSchema,
15721572
*,
15731573
ref: str | None = None,
15741574
metadata: Any = None,
15751575
serialization: SerSchema | None = None,
1576-
) -> CallbackSchema:
1576+
) -> FunctionSchema:
15771577
"""
15781578
Returns a schema that calls a validator function before validating the provided schema, e.g.:
15791579
@@ -1586,7 +1586,7 @@ def fn(v: Any, info: core_schema.ValidationInfo) -> str:
15861586
assert 'hello' in v_str
15871587
return v_str + 'world'
15881588
1589-
schema = core_schema.general_before_validation_callback(function=fn, schema=core_schema.str_schema())
1589+
schema = core_schema.general_before_validation_function(function=fn, schema=core_schema.str_schema())
15901590
v = SchemaValidator(schema)
15911591
assert v.validate_python(b'hello ') == "b'hello 'world"
15921592
```
@@ -1601,22 +1601,22 @@ def fn(v: Any, info: core_schema.ValidationInfo) -> str:
16011601
return dict_not_none(
16021602
type='function',
16031603
mode='before',
1604-
function={'type': 'general', 'call': function},
1604+
function={'type': 'general', 'function': function},
16051605
schema=schema,
16061606
ref=ref,
16071607
metadata=metadata,
16081608
serialization=serialization,
16091609
)
16101610

16111611

1612-
def field_after_validation_callback(
1612+
def field_after_validation_function(
16131613
function: FieldValidatorCallback,
16141614
schema: CoreSchema,
16151615
*,
16161616
ref: str | None = None,
16171617
metadata: Any = None,
16181618
serialization: SerSchema | None = None,
1619-
) -> CallbackSchema:
1619+
) -> FunctionSchema:
16201620
"""
16211621
Returns a schema that calls a validator function after validating
16221622
the provided **model field** schema, e.g.:
@@ -1629,7 +1629,7 @@ def fn(v: str, info: core_schema.ModelFieldValidationInfo) -> str:
16291629
assert info.field_name is not None
16301630
return v + 'world'
16311631
1632-
func_schema = core_schema.field_after_validation_callback(function=fn, schema=core_schema.str_schema())
1632+
func_schema = core_schema.field_after_validation_function(function=fn, schema=core_schema.str_schema())
16331633
schema = core_schema.typed_dict_schema(
16341634
{'a': core_schema.typed_dict_field(func_schema)}
16351635
)
@@ -1648,22 +1648,22 @@ def fn(v: str, info: core_schema.ModelFieldValidationInfo) -> str:
16481648
return dict_not_none(
16491649
type='function',
16501650
mode='after',
1651-
function={'type': 'field', 'call': function},
1651+
function={'type': 'field', 'function': function},
16521652
schema=schema,
16531653
ref=ref,
16541654
metadata=metadata,
16551655
serialization=serialization,
16561656
)
16571657

16581658

1659-
def general_after_validation_callback(
1659+
def general_after_validation_function(
16601660
function: GeneralValidatorCallback,
16611661
schema: CoreSchema,
16621662
*,
16631663
ref: str | None = None,
16641664
metadata: Any = None,
16651665
serialization: SerSchema | None = None,
1666-
) -> CallbackSchema:
1666+
) -> FunctionSchema:
16671667
"""
16681668
Returns a schema that calls a validator function after validating the provided schema, e.g.:
16691669
@@ -1674,7 +1674,7 @@ def fn(v: str, info: core_schema.ValidationInfo) -> str:
16741674
assert 'hello' in v
16751675
return v + 'world'
16761676
1677-
schema = core_schema.general_after_validation_callback(schema=core_schema.str_schema(), function=fn)
1677+
schema = core_schema.general_after_validation_function(schema=core_schema.str_schema(), function=fn)
16781678
v = SchemaValidator(schema)
16791679
assert v.validate_python('hello ') == 'hello world'
16801680
```
@@ -1689,7 +1689,7 @@ def fn(v: str, info: core_schema.ValidationInfo) -> str:
16891689
return dict_not_none(
16901690
type='function',
16911691
mode='after',
1692-
function={'type': 'general', 'call': function},
1692+
function={'type': 'general', 'function': function},
16931693
schema=schema,
16941694
ref=ref,
16951695
metadata=metadata,
@@ -1716,18 +1716,18 @@ def __call__(
17161716
...
17171717

17181718

1719-
class FieldWrapValidatorCallbackSchema(TypedDict):
1719+
class FieldWrapValidatorFunctionSchema(TypedDict):
17201720
type: Literal['field']
1721-
call: FieldWrapValidatorCallback
1721+
function: FieldWrapValidatorCallback
17221722

17231723

1724-
class GeneralWrapValidatorCallbackSchema(TypedDict):
1724+
class GeneralWrapValidatorFunctionSchema(TypedDict):
17251725
type: Literal['general']
1726-
call: GeneralWrapValidatorCallback
1726+
function: GeneralWrapValidatorCallback
17271727

17281728

1729-
class WrapCallbackSchema(TypedDict, total=False):
1730-
function: Required[Union[GeneralWrapValidatorCallbackSchema, FieldWrapValidatorCallbackSchema]]
1729+
class WrapFunctionSchema(TypedDict, total=False):
1730+
function: Required[Union[GeneralWrapValidatorFunctionSchema, FieldWrapValidatorFunctionSchema]]
17311731
type: Required[Literal['function']]
17321732
mode: Required[Literal['wrap']]
17331733
schema: Required[CoreSchema]
@@ -1736,14 +1736,14 @@ class WrapCallbackSchema(TypedDict, total=False):
17361736
serialization: SerSchema
17371737

17381738

1739-
def general_wrap_validation_callback(
1739+
def general_wrap_validation_function(
17401740
function: GeneralWrapValidatorCallback,
17411741
schema: CoreSchema,
17421742
*,
17431743
ref: str | None = None,
17441744
metadata: Any = None,
17451745
serialization: SerSchema | None = None,
1746-
) -> WrapCallbackSchema:
1746+
) -> WrapFunctionSchema:
17471747
"""
17481748
Returns a schema which calls a function with a `validator` callable argument which can
17491749
optionally be used to call inner validation with the function logic, this is much like the
@@ -1755,7 +1755,7 @@ def general_wrap_validation_callback(
17551755
def fn(v: str, validator: core_schema.CallableValidator, info: core_schema.ValidationInfo) -> str:
17561756
return validator(input_value=v) + 'world'
17571757
1758-
schema = core_schema.general_wrap_validation_callback(function=fn, schema=core_schema.str_schema())
1758+
schema = core_schema.general_wrap_validation_function(function=fn, schema=core_schema.str_schema())
17591759
v = SchemaValidator(schema)
17601760
assert v.validate_python('hello ') == 'hello world'
17611761
```
@@ -1770,22 +1770,22 @@ def fn(v: str, validator: core_schema.CallableValidator, info: core_schema.Valid
17701770
return dict_not_none(
17711771
type='function',
17721772
mode='wrap',
1773-
function={'type': 'general', 'call': function},
1773+
function={'type': 'general', 'function': function},
17741774
schema=schema,
17751775
ref=ref,
17761776
metadata=metadata,
17771777
serialization=serialization,
17781778
)
17791779

17801780

1781-
def field_wrap_validation_callback(
1781+
def field_wrap_validation_function(
17821782
function: FieldWrapValidatorCallback,
17831783
schema: CoreSchema,
17841784
*,
17851785
ref: str | None = None,
17861786
metadata: Any = None,
17871787
serialization: SerSchema | None = None,
1788-
) -> WrapCallbackSchema:
1788+
) -> WrapFunctionSchema:
17891789
"""
17901790
Returns a schema applicable to **fields**
17911791
which calls a function with a `validator` callable argument which can
@@ -1800,7 +1800,7 @@ def fn(v: bytes, validator: core_schema.CallableValidator, info: core_schema.Mod
18001800
assert info.field_name is not None
18011801
return validator(v) + 'world'
18021802
1803-
func_schema = core_schema.field_wrap_validation_callback(function=fn, schema=core_schema.str_schema())
1803+
func_schema = core_schema.field_wrap_validation_function(function=fn, schema=core_schema.str_schema())
18041804
schema = core_schema.typed_dict_schema(
18051805
{'a': core_schema.typed_dict_field(func_schema)}
18061806
)
@@ -1819,30 +1819,30 @@ def fn(v: bytes, validator: core_schema.CallableValidator, info: core_schema.Mod
18191819
return dict_not_none(
18201820
type='function',
18211821
mode='wrap',
1822-
function={'type': 'field', 'call': function},
1822+
function={'type': 'field', 'function': function},
18231823
schema=schema,
18241824
ref=ref,
18251825
metadata=metadata,
18261826
serialization=serialization,
18271827
)
18281828

18291829

1830-
class PlainCallbackSchema(TypedDict, total=False):
1830+
class PlainFunctionSchema(TypedDict, total=False):
18311831
type: Required[Literal['function']]
18321832
mode: Required[Literal['plain']]
1833-
function: Required[Union[FieldValidatorCallbackSchema, GeneralValidatorCallbackSchema]]
1833+
function: Required[Union[FieldValidatorFunctionSchema, GeneralValidatorFunctionSchema]]
18341834
ref: str
18351835
metadata: Any
18361836
serialization: SerSchema
18371837

18381838

1839-
def general_plain_validation_callback(
1839+
def general_plain_validation_function(
18401840
function: GeneralValidatorCallback,
18411841
*,
18421842
ref: str | None = None,
18431843
metadata: Any = None,
18441844
serialization: SerSchema | None = None,
1845-
) -> PlainCallbackSchema:
1845+
) -> PlainFunctionSchema:
18461846
"""
18471847
Returns a schema that uses the provided function for validation, e.g.:
18481848
@@ -1853,7 +1853,7 @@ def fn(v: str, info: core_schema.ValidationInfo) -> str:
18531853
assert 'hello' in v
18541854
return v + 'world'
18551855
1856-
schema = core_schema.general_plain_validation_callback(function=fn)
1856+
schema = core_schema.general_plain_validation_function(function=fn)
18571857
v = SchemaValidator(schema)
18581858
assert v.validate_python("hello ") == 'hello world'
18591859
```
@@ -1867,20 +1867,20 @@ def fn(v: str, info: core_schema.ValidationInfo) -> str:
18671867
return dict_not_none(
18681868
type='function',
18691869
mode='plain',
1870-
function={'type': 'general', 'call': function},
1870+
function={'type': 'general', 'function': function},
18711871
ref=ref,
18721872
metadata=metadata,
18731873
serialization=serialization,
18741874
)
18751875

18761876

1877-
def field_plain_validation_callback(
1877+
def field_plain_validation_function(
18781878
function: FieldValidatorCallback,
18791879
*,
18801880
ref: str | None = None,
18811881
metadata: Any = None,
18821882
serialization: SerSchema | None = None,
1883-
) -> PlainCallbackSchema:
1883+
) -> PlainFunctionSchema:
18841884
"""
18851885
Returns a schema that uses the provided function for validation, e.g.:
18861886
@@ -1893,7 +1893,7 @@ def fn(v: Any, info: core_schema.ModelFieldValidationInfo) -> str:
18931893
assert info.field_name is not None
18941894
return str(v) + 'world'
18951895
1896-
func_schema = core_schema.field_plain_validation_callback(function=fn)
1896+
func_schema = core_schema.field_plain_validation_function(function=fn)
18971897
schema = core_schema.typed_dict_schema(
18981898
{'a': core_schema.typed_dict_field(func_schema)}
18991899
)
@@ -1911,7 +1911,7 @@ def fn(v: Any, info: core_schema.ModelFieldValidationInfo) -> str:
19111911
return dict_not_none(
19121912
type='function',
19131913
mode='plain',
1914-
function={'type': 'field', 'call': function},
1914+
function={'type': 'field', 'function': function},
19151915
ref=ref,
19161916
metadata=metadata,
19171917
serialization=serialization,
@@ -2196,7 +2196,7 @@ def fn(v: str, info: core_schema.ValidationInfo) -> str:
21962196
assert 'hello' in v
21972197
return v + ' world'
21982198
2199-
fn_schema = core_schema.general_plain_validation_callback(function=fn)
2199+
fn_schema = core_schema.general_plain_validation_function(function=fn)
22002200
schema = core_schema.chain_schema(fn_schema, fn_schema, fn_schema, core_schema.str_schema())
22012201
v = SchemaValidator(schema)
22022202
assert v.validate_python("hello") == 'hello world world world'
@@ -3068,9 +3068,9 @@ def definition_reference_schema(
30683068
FrozenSetSchema,
30693069
GeneratorSchema,
30703070
DictSchema,
3071-
CallbackSchema,
3072-
WrapCallbackSchema,
3073-
PlainCallbackSchema,
3071+
FunctionSchema,
3072+
WrapFunctionSchema,
3073+
PlainFunctionSchema,
30743074
WithDefaultSchema,
30753075
NullableSchema,
30763076
UnionSchema,

0 commit comments

Comments
 (0)