[Variant] Add documentation, tests and cleaner api for Variant::get_path #7942
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
alamb
commented
Jul 16, 2025
| @@ -133,29 +132,21 @@ mod test { | |||
| fn get_primitive_variant_field() { | |||
| single_variant_get_test( | |||
| r#"{"some_field": 1234}"#, | |||
| vec![VariantPathElement::field("some_field".into())].into(), | |||
| VariantPath::from("some_field"), | |||
There was a problem hiding this comment.
This gives a good idea of what the new API looks like. I think it is much clearer personally
alamb
commented
Jul 16, 2025
| @@ -1068,6 +1072,35 @@ impl<'m, 'v> Variant<'m, 'v> { | |||
| /// Return a new Variant with the path followed. | |||
| /// | |||
| /// If the path is not found, `None` is returned. | |||
| /// | |||
| /// # Example | |||
There was a problem hiding this comment.
I really wanted to add these tests / examples which lead to the other API changes
alamb
commented
Jul 16, 2025
| @@ -22,7 +22,7 @@ use arrow::{ | |||
| error::Result, | |||
| }; | |||
| use arrow_schema::{ArrowError, Field}; | |||
| use parquet_variant::path::VariantPath; | |||
| use parquet_variant::VariantPath; | |||
There was a problem hiding this comment.
I re-exported the paths at the same top level
Samyak2
approved these changes
Jul 17, 2025
| VariantPathElement::field("some_field".into()), | ||
| ] | ||
| .into(), | ||
| VariantPath::from(0).join("some_field"), |
There was a problem hiding this comment.
This is a much better API!
friendlymatthew
approved these changes
Jul 17, 2025
|
Thank you @friendlymatthew and @Samyak2 for the reviews |
scovich
reviewed
Jul 17, 2025
Comment on lines
+49
to
+52
| /// let path3 = VariantPath::new(vec![ | ||
| /// VariantPathElement::field("foo"), | ||
| /// VariantPathElement::index(0) | ||
| /// ]); |
There was a problem hiding this comment.
Should it also impl FromIterator so people can do:
VariantPath::from_iter(["foo".into(), 0.into()])or
["foo".into(), 0.into()].into_iter().collect::<VariantPath>()There was a problem hiding this comment.
- Great idea -- filed [Variant]
impl FromIteratorfprVariantPath#7955
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.
Which issue does this PR close?
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax.
variant_getcompute kernel #7919Rationale for this change
While reviewing #7919 from @Samyak2 I found I wanted to write some additional tests directly for
Variant::get_pathWhen I started doing that I found it was somewhat awkward to write examples, so I added some new conversion routines to make it easier.
What changes are included in this PR?
VaraintGetandVariantPathAre these changes tested?
Yes, by doc examples which run in CI
Are there any user-facing changes?
If there are user-facing changes then we may require documentation to be updated before approving the PR.
If there are any breaking changes to public APIs, please call them out.