Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fail-fast for dicts #1543

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add fail-fast for dicts #1543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5dd9abd
Add fail-fast for dicts, model and dataclass
uriyyo Nov 17, 2024
b9e0f5c
Merge branch 'main' into more-fail-fast
uriyyo Dec 8, 2024
7642acc
Revert changes to model-fields and dataclass
uriyyo Dec 26, 2024
805c64a
Merge remote-tracking branch 'origin/main' into more-fail-fast
uriyyo Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions python/pydantic_core/core_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ class CoreConfig(TypedDict, total=False):
validate_default: bool
# used on typed-dicts and arguments
populate_by_name: bool # replaces `allow_population_by_field_name` in pydantic v1
# stop validation on a first error, used with typed-dict
fail_fast: bool
# fields related to string fields only
str_max_length: int
str_min_length: int
Expand Down Expand Up @@ -1886,6 +1888,7 @@ class DictSchema(TypedDict, total=False):
values_schema: CoreSchema # default: AnySchema
min_length: int
max_length: int
fail_fast: bool
strict: bool
ref: str
metadata: Dict[str, Any]
Expand All @@ -1898,6 +1901,7 @@ def dict_schema(
*,
min_length: int | None = None,
max_length: int | None = None,
fail_fast: bool | None = None,
strict: bool | None = None,
ref: str | None = None,
metadata: Dict[str, Any] | None = None,
Expand All @@ -1921,6 +1925,7 @@ def dict_schema(
values_schema: The value must be a dict with values that match this schema
min_length: The value must be a dict with at least this many items
max_length: The value must be a dict with at most this many items
fail_fast: Stop validation on the first error
strict: Whether the keys and values should be validated with strict mode
ref: optional unique identifier of the schema, used to reference the schema in other places
metadata: Any other information you want to include with the schema, not used by pydantic-core
Expand All @@ -1932,6 +1937,7 @@ def dict_schema(
values_schema=values_schema,
min_length=min_length,
max_length=max_length,
fail_fast=fail_fast,
strict=strict,
ref=ref,
metadata=metadata,
Expand Down Expand Up @@ -2893,6 +2899,7 @@ class TypedDictSchema(TypedDict, total=False):
extra_behavior: ExtraBehavior
total: bool # default: True
populate_by_name: bool # replaces `allow_population_by_field_name` in pydantic v1
fail_fast: bool # default: False
ref: str
metadata: Dict[str, Any]
serialization: SerSchema
Expand All @@ -2909,6 +2916,7 @@ def typed_dict_schema(
extra_behavior: ExtraBehavior | None = None,
total: bool | None = None,
populate_by_name: bool | None = None,
fail_fast: bool | None = None,
ref: str | None = None,
metadata: Dict[str, Any] | None = None,
serialization: SerSchema | None = None,
Expand Down Expand Up @@ -2943,6 +2951,7 @@ class MyTypedDict(TypedDict):
extra_behavior: The extra behavior to use for the typed dict
total: Whether the typed dict is total, otherwise uses `typed_dict_total` from config
populate_by_name: Whether the typed dict should populate by name
fail_fast: Stop validation on the first error
serialization: Custom serialization schema
"""
return _dict_not_none(
Expand All @@ -2955,6 +2964,7 @@ class MyTypedDict(TypedDict):
extra_behavior=extra_behavior,
total=total,
populate_by_name=populate_by_name,
fail_fast=fail_fast,
ref=ref,
metadata=metadata,
serialization=serialization,
Expand Down
20 changes: 20 additions & 0 deletions src/validators/dict.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ pub struct DictValidator {
value_validator: Box<CombinedValidator>,
min_length: Option<usize>,
max_length: Option<usize>,
fail_fast: bool,
name: String,
}

Expand Down Expand Up @@ -53,6 +54,7 @@ impl BuildValidator for DictValidator {
value_validator,
min_length: schema.get_as(intern!(py, "min_length"))?,
max_length: schema.get_as(intern!(py, "max_length"))?,
fail_fast: schema.get_as(intern!(py, "fail_fast"))?.unwrap_or(false),
name,
}
.into())
Expand All @@ -78,6 +80,7 @@ impl Validator for DictValidator {
input,
min_length: self.min_length,
max_length: self.max_length,
fail_fast: self.fail_fast,
key_validator: &self.key_validator,
value_validator: &self.value_validator,
state,
Expand All @@ -94,6 +97,7 @@ struct ValidateToDict<'a, 's, 'py, I: Input<'py> + ?Sized> {
input: &'a I,
min_length: Option<usize>,
max_length: Option<usize>,
fail_fast: bool,
key_validator: &'a CombinedValidator,
value_validator: &'a CombinedValidator,
state: &'a mut ValidationState<'s, 'py>,
Expand All @@ -111,6 +115,12 @@ where
let mut errors: Vec<ValLineError> = Vec::new();
let allow_partial = self.state.allow_partial;

macro_rules! should_fail_fast {
() => {
self.fail_fast && !errors.is_empty()
};
}

for (_, is_last_partial, item_result) in self.state.enumerate_last_partial(iterator) {
self.state.allow_partial = false.into();
let (key, value) = item_result?;
Expand All @@ -130,6 +140,11 @@ where
true => allow_partial,
false => false.into(),
};

if should_fail_fast!() {
break;
}

let output_value = match self.value_validator.validate(self.py, value.borrow_input(), self.state) {
Ok(value) => value,
Err(ValError::LineErrors(line_errors)) => {
Expand All @@ -141,6 +156,11 @@ where
Err(ValError::Omit) => continue,
Err(err) => return Err(err),
};

if should_fail_fast!() {
break;
}

if let Some(key) = output_key {
output.set_item(key, output_value)?;
}
Expand Down
13 changes: 13 additions & 0 deletions src/validators/typed_dict.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ pub struct TypedDictValidator {
extra_behavior: ExtraBehavior,
extras_validator: Option<Box<CombinedValidator>>,
strict: bool,
fail_fast: bool,
loc_by_alias: bool,
}

Expand All @@ -56,6 +57,7 @@ impl BuildValidator for TypedDictValidator {
let total =
schema_or_config(schema, config, intern!(py, "total"), intern!(py, "typed_dict_total"))?.unwrap_or(true);
let populate_by_name = schema_or_config_same(schema, config, intern!(py, "populate_by_name"))?.unwrap_or(false);
let fail_fast = schema_or_config_same(schema, config, intern!(py, "fail_fast"))?.unwrap_or(false);

let extra_behavior = ExtraBehavior::from_schema_or_config(py, schema, config, ExtraBehavior::Ignore)?;

Expand Down Expand Up @@ -129,6 +131,7 @@ impl BuildValidator for TypedDictValidator {
extra_behavior,
extras_validator,
strict,
fail_fast,
loc_by_alias: config.get_as(intern!(py, "loc_by_alias"))?.unwrap_or(true),
}
.into())
Expand Down Expand Up @@ -174,6 +177,10 @@ impl Validator for TypedDictValidator {
let mut fields_set_count: usize = 0;

for field in &self.fields {
if self.fail_fast && !errors.is_empty() {
break;
}

let op_key_value = match dict.get_item(&field.lookup_key) {
Ok(v) => v,
Err(ValError::LineErrors(line_errors)) => {
Expand Down Expand Up @@ -265,6 +272,7 @@ impl Validator for TypedDictValidator {
extra_behavior: ExtraBehavior,
partial_last_key: Option<LocItem>,
allow_partial: PartialMode,
fail_fast: bool,
}

impl<'py, Key, Value> ConsumeIterator<ValResult<(Key, Value)>> for ValidateExtras<'_, '_, 'py>
Expand All @@ -275,6 +283,10 @@ impl Validator for TypedDictValidator {
type Output = ValResult<()>;
fn consume_iterator(self, iterator: impl Iterator<Item = ValResult<(Key, Value)>>) -> ValResult<()> {
for item_result in iterator {
if self.fail_fast && !self.errors.is_empty() {
break;
}

let (raw_key, value) = item_result?;
let either_str = match raw_key
.borrow_input()
Expand Down Expand Up @@ -354,6 +366,7 @@ impl Validator for TypedDictValidator {
extra_behavior: self.extra_behavior,
partial_last_key,
allow_partial,
fail_fast: self.fail_fast,
})??;
}

Expand Down
58 changes: 58 additions & 0 deletions tests/validators/test_dict.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,3 +258,61 @@ def test_json_dict_complex_key():
assert v.validate_json('{"1+2j": 2, "infj": 4}') == {complex(1, 2): 2, complex(0, float('inf')): 4}
with pytest.raises(ValidationError, match='Input should be a valid complex string'):
v.validate_json('{"1+2j": 2, "": 4}') == {complex(1, 2): 2, complex(0, float('inf')): 4}


@pytest.mark.parametrize(
('fail_fast', 'expected'),
[
pytest.param(
True,
[
{
'type': 'int_parsing',
'loc': ('a', '[key]'),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'a',
},
],
id='fail_fast',
),
pytest.param(
False,
[
{
'type': 'int_parsing',
'loc': ('a', '[key]'),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'a',
},
{
'type': 'int_parsing',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'b',
},
{
'type': 'int_parsing',
'loc': ('c', '[key]'),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'c',
},
{
'type': 'int_parsing',
'loc': ('c',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'input': 'd',
},
],
id='not_fail_fast',
),
],
)
def test_dict_fail_fast(fail_fast, expected):
v = SchemaValidator(
{'type': 'dict', 'keys_schema': {'type': 'int'}, 'values_schema': {'type': 'int'}, 'fail_fast': fail_fast}
)

with pytest.raises(ValidationError) as exc_info:
v.validate_python({'a': 'b', 'c': 'd'})

assert exc_info.value.errors(include_url=False) == expected
59 changes: 59 additions & 0 deletions tests/validators/test_typed_dict.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1196,3 +1196,62 @@ def validate(v, info):
gc.collect()

assert ref() is None


@pytest.mark.parametrize(
('fail_fast', 'expected'),
[
pytest.param(
True,
[
{
'input': 'c',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'type': 'int_parsing',
},
],
id='fail_fast',
),
pytest.param(
False,
[
{
'input': 'c',
'loc': ('a',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'type': 'int_parsing',
},
{
'input': 'd',
'loc': ('b',),
'msg': 'Input should be a valid integer, unable to parse string as an integer',
'type': 'int_parsing',
},
],
id='not_fail_fast',
),
],
)
def test_typed_dict_fail_fast(fail_fast, expected):
v = SchemaValidator(
{
'type': 'typed-dict',
'fields': {
'a': {
'type': 'typed-dict-field',
'schema': {'type': 'int'},
},
'b': {
'type': 'typed-dict-field',
'schema': {'type': 'int'},
},
},
'fail_fast': fail_fast,
}
)

with pytest.raises(ValidationError) as exc_info:
v.validate_python({'a': 'c', 'b': 'd'})

assert exc_info.value.errors(include_url=False) == expected
Loading