feat: ✨ handle grouped errors under resource fields #175
+138
−3
Conversation
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
martonvago
commented
Oct 29, 2025
martonvago
commented
Oct 29, 2025
| errors_in_group = _get_errors_in_group(schema_errors, parent_error) | ||
| schema_errors.remove(parent_error) | ||
|
|
||
| field_type: str = parent_error.instance.get("type", "string") |
There was a problem hiding this comment.
Defaulting to string if the type is not given. This is because the string-schema is the only one that doesn't require type.
martonvago
commented
Oct 29, 2025
| schema_index = FIELD_TYPES.index(field_type) | ||
| errors_for_other_types = _filter( | ||
| errors_in_group, | ||
| lambda error: f"fields/items/oneOf/{schema_index}/" not in error.schema_path, |
There was a problem hiding this comment.
We can choose the sub-schema by filtering on the schema path. E.g., the schema path of the string-based schema is ...fields/items/oneOf/0/...
martonvago
commented
Oct 29, 2025
martonvago
commented
Oct 29, 2025
| str(files("check_datapackage.schemas").joinpath("data-package-2-0.json")) | ||
| ) | ||
|
|
||
| FIELD_TYPES = [ |
There was a problem hiding this comment.
We can extract this from the schema on the fly if that's better
martonvago
commented
Oct 29, 2025
|
If we merge in #177, I will align this with that |
lwjohnst86
requested changes
Nov 3, 2025
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
lwjohnst86
requested changes
Nov 4, 2025
| if field_type not in FIELD_TYPES: | ||
| unknown_field_error = SchemaError( | ||
| message=( | ||
| "Unknown Data Package field type. Please use one of" |
There was a problem hiding this comment.
Suggested change
| "Unknown Data Package field type. Please use one of" | |
| "The resource's schema's field property doesn't have the correct type. It should be one of" |
Just to be explicitly clear what we're meaning. I think this is correct right?
github-project-automation
bot
moved this from In Review
to In Progress
in Iteration planning
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.
Description
This PR adds a function for handling grouped errors under
$.resources[x].schema.fields[x].Here, the problem comes from the fact that each field type has its own sub-JSON-schema, and each one of these sub-schemas flags issues when the type of a field is not its own type. So, if a field has
type="number"and there is something wrong with the field, then the sub-schemas foryear,string, etc. will also flag issues. The goal is to flag issues only fornumber.Part of #15
Needs an in-depth review.
Checklist
just run-all