Fix when omitempties(T) = true is defined in StructTypes.foreachfield #50
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
I noticed in some serialized JSON from JSON3.jl recently that some
fields were still getting serialized when I had defined
`StructTypes.omitempties(::Type{MyType}) = true`, which is a shorthand
we introduced when you want to omit empty values for any field in a
type. Unfortunately, we failed to update `StructTypes.foreachfield` to
respect this option and double unfortunately, the code still happened to
"work", i.e. not throw an error whether `omitempties` returned a `Bool`
or `Tuple`. The fix is pretty simple: if `omitempties` returns `true`,
then we query the `fieldnames` of the struct.
Codecov Report
@@ Coverage Diff @@
## main #50 +/- ##
==========================================
+ Coverage 69.16% 69.36% +0.20%
==========================================
Files 1 1
Lines 334 333 -1
==========================================
Hits 231 231
+ Misses 103 102 -1
Continue to review full report at Codecov.
|
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.
I noticed in some serialized JSON from JSON3.jl recently that some
fields were still getting serialized when I had defined
StructTypes.omitempties(::Type{MyType}) = true, which is a shorthandwe introduced when you want to omit empty values for any field in a
type. Unfortunately, we failed to update
StructTypes.foreachfieldtorespect this option and double unfortunately, the code still happened to
"work", i.e. not throw an error whether
omitemptiesreturned aBoolor
Tuple. The fix is pretty simple: ifomitemptiesreturnstrue,then we query the
fieldnamesof the struct.