[components] Enrich pydantic validation errors with filepaths, line numbers #26962
+314
−6
Conversation
This file contains 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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
benpankow
force-pushed
the
benpankow/components-enrich-yaml
branch
from
954424c to
54d3e9d
Compare
benpankow
requested review from
schrockn,
OwenKephart and
smackesey
and removed request for
schrockn and
OwenKephart
schrockn
reviewed
Jan 9, 2025
| @@ -3,6 +3,6 @@ | |||
| - key: customers | |||
|
|
|||
| - command: "python customer_stats.py" | |||
| assets: | |||
schrockn
reviewed
Jan 9, 2025
| both error reporting and populating source position information. | ||
| """ | ||
| try: | ||
| model = parse_obj_as(cls, obj_parse_root.value) |
There was a problem hiding this comment.
This is deprecated:
'parse_obj_as is deprecated. Use pydantic.TypeAdapter.validate_python instead.',
schrockn
reviewed
Jan 9, 2025
Comment on lines
+23
to
+29
| def from_file(contents: str, filepath: str) -> "ComponentFileModel": | ||
| parsed = parse_yaml_with_source_positions(contents, filepath) | ||
| obj = _parse_and_populate_model_with_annotated_errors( | ||
| cls=ComponentFileModel, obj_parse_root=parsed, obj_key_path_prefix=[] | ||
| ) | ||
|
|
||
| obj._source_position_tree = parsed.source_position_tree # noqa: SLF001 |
There was a problem hiding this comment.
We should create a new non-pydantic class that represents the File and all metadata about it.
There was a problem hiding this comment.
need code smell article for this one :-)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Ports over the YAML line tracking functionality to enrich Pydantic
ValidationErrorsthrown when instantiating components. The filepath of the loaded YAML file & offending line number are appended to the error message.Test Plan
New set of validation integration tests.