feat: allow invalid output fields to be dropped instead of raising#248
Open
haneug wants to merge 2 commits into
Open
feat: allow invalid output fields to be dropped instead of raising#248haneug wants to merge 2 commits into
haneug wants to merge 2 commits into
Conversation
haneug
added
enhancement
timmyte
requested changes
Jun 10, 2026
timmyte
left a comment
timmyte
left a comment
Contributor
There was a problem hiding this comment.
Thanks for adding this feature. That's a very good idea.
It would be great if you could generally document your code more extensively, as it does introduce new concepts, which are not trivial.
What is not clear to me: You are saying, that in non-strict mode invalid keys are set to None? But what if their default value is not None?
| return handler(data) | ||
| except ValidationError as e: | ||
| # > Default is strict is set to True and the error is just raised | ||
| if (info.context or {}).get("strict", True): |
Contributor
There was a problem hiding this comment.
- Please add comments, why are you even looking for
stricthere.
Please explain that you are looking for the method parameter. - I would also add
strictas class variable, instead of hard-coding the default here.
So the expression turns into:
(info.context or {}).get("strict", cls.strict)
| if (info.context or {}).get("strict", True): | ||
| raise | ||
| if not isinstance(data, dict): | ||
| raise |
Contributor
There was a problem hiding this comment.
Why is the exception also raise under this condition? Please extend the code documentation here.
| raise | ||
| if not isinstance(data, dict): | ||
| raise | ||
| bad_keys = {str(error["loc"][0]) for error in e.errors() if error["loc"]} |
Contributor
There was a problem hiding this comment.
What are bad_keys? Please add comment describing the need to check this condition here as well.
| bad_keys = {str(error["loc"][0]) for error in e.errors() if error["loc"]} | ||
| if not bad_keys: | ||
| raise | ||
| cleaned = {k: v for k, v in data.items() if str(k) not in bad_keys} |
Contributor
There was a problem hiding this comment.
What is cleaned?
Please add comments.
| result = handler(cleaned) # re-raises if required fields are missing | ||
| warnings.warn( | ||
| f"{cls.__name__}: dropped fields due to validation errors: {bad_keys}", | ||
| stacklevel=2, |
Contributor
There was a problem hiding this comment.
Why explicitly stacklevel=2?
Please document this in the code.
Comment on lines
+128
to
+131
| strict: bool, default: True | ||
| If True, a ValidationError is raised when any field in the parsed output cannot be validated. | ||
| If False, fields that fail validation are silently set to None and a UserWarning is emitted. | ||
| Only takes effect when `parse=True`; otherwise pass `strict` directly to `Output.parse()`. |
Contributor
There was a problem hiding this comment.
Suggested change
| strict: bool, default: True | |
| If True, a ValidationError is raised when any field in the parsed output cannot be validated. | |
| If False, fields that fail validation are silently set to None and a UserWarning is emitted. | |
| Only takes effect when `parse=True`; otherwise pass `strict` directly to `Output.parse()`. | |
| strict: bool, default: True | |
| If `True`, a `ValidationError` is raised when any field in the parsed output cannot be validated. | |
| If `False`, fields that fail validation are silently set to `None` and a `UserWarning` is emitted. | |
| Only takes effect when `parse=True`; otherwise pass `strict` directly to `Output.parse()`. |
Comment on lines
+194
to
+196
| strict: bool, default: True | ||
| If True, a ValidationError is raised when any field in the parsed output cannot be validated. | ||
| If False, fields that fail validation are silently set to None and a UserWarning is emitted. |
Contributor
There was a problem hiding this comment.
Suggested change
| strict: bool, default: True | |
| If True, a ValidationError is raised when any field in the parsed output cannot be validated. | |
| If False, fields that fail validation are silently set to None and a UserWarning is emitted. | |
| strict: bool, default: True | |
| If `True`, a `ValidationError` is raised when any field in the parsed output cannot be validated. | |
| If `False`, fields that fail validation are silently set to `None` and a `UserWarning` is emitted. |
Comment on lines
+229
to
+230
| If True, a ValidationError is raised when any field cannot be validated. | ||
| If False, fields that fail validation are set to None and a UserWarning is emitted. |
Contributor
There was a problem hiding this comment.
Suggested change
| If True, a ValidationError is raised when any field cannot be validated. | |
| If False, fields that fail validation are set to None and a UserWarning is emitted. | |
| If `True`, a `ValidationError` is raised when any field cannot be validated. | |
| If `False`, fields that fail validation are set to `None` and a `UserWarning` is emitted. |
Comment on lines
+260
to
+261
| If True, a ValidationError is raised when any field cannot be validated. | ||
| If False, fields that fail validation are set to None and a UserWarning is emitted. |
Contributor
There was a problem hiding this comment.
Suggested change
| If True, a ValidationError is raised when any field cannot be validated. | |
| If False, fields that fail validation are set to None and a UserWarning is emitted. | |
| If `True`, a `ValidationError` is raised when any field cannot be validated. | |
| If `False`, fields that fail validation are set to `None` and a `UserWarning` is emitted. |
| assert result.calculation_info is not None | ||
| assert result.calculation_info.charge is None | ||
| assert result.calculation_info.mult == 1 | ||
| assert any("charge" in str(w.message) for w in caught) |
Contributor
There was a problem hiding this comment.
Please document the test mechanism with charge more extensively. It's not trivial. Thanks!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes Issues
Closes None
Description
strict=TruetoOutput.__init__()and toOutput.parse()which allows to drop the fields where Pydantic validation fail when it is set toFalse. This way we do not switch the current behavior but have the option for a less strict output generation.Release Notes
(Project adheres to Keep a Changelog; Every entry should start in upper-case and end with
(#<pr-id>); Remove sections that don't apply)Added
Output.parse(),Output.parse_property(),Output.parse_gbw(), andOutput.__init__()now accept astrictparameter (default True). When set to False, output fields that fail Pydantic validation are silently set to None and a UserWarning is emitted instead of raising a ValidationError.