feat: Validate overrides key consistency for schema sampling #165
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.
Motivation
When sampling for a schema by providing a sequence of mappings (rather than a mapping of iterables), the keys of the first mapping in the override dictate the schema of the data frame that is initialized to start sampling. This is currently not clearly documented.
While specifying different keys for the different entries can work out (e.g., by leaving out certain keys in following members, which are then imputed as
None), it is pretty easy to add overrides keys to entries at indices > 0 which are not in the first entry. These will then silently be ignored. This can cause the sampling operation to fail (as it would need the overrides to find a compliant data frame) or (even worse) lead to a sampled data frame that does not comply with the expectations of the user.Changes