Add JSON3.tostring for Real number overloads when writing
#236
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
This is the best idea I can come up with to address #232. First a summary of the problem, * We allow custom number types to overload `StructTypes.numbertype` that we convert to before writing JSON * However, we only provide JSON writing routines for `Integer` and `AbstractFloat` * So a number like `3//2` (`Rational`) or `π` (`Irrational`) which are both `<: Real`, but not `Integer` or `AbstractFloat` we get the stack overlfow behavior reported above The proposal here then is we first check if a `Real` has overloaded `StructTypes.numbertype` and _if not_, we'll use a new `JSON3.tostring` method, which by default converts the custom number to `Float64` and then calls `Base.string(x)`. This method allows custom number types, like FixedPointDecimal, to overload `JSON3.tostring` to provide an appropriate string representation for their type.
Codecov ReportBase: 88.36% // Head: 88.37% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #236 +/- ##
==========================================
+ Coverage 88.36% 88.37% +0.01%
==========================================
Files 9 9
Lines 1710 1721 +11
==========================================
+ Hits 1511 1521 +10
- Misses 199 200 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
I think this is a good solution! It's a bit unfortunate that a numerical package will need to depend on JSON3 but I think that's just something to think about in future designs/refactors and I'd be happy to add the dependency in for FixedPointDecimals for now. |
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.
This is the best idea I can come up with to address #232. First a summary of the problem,
StructTypes.numbertypethat we convert to before writing JSONIntegerandAbstractFloat3//2(Rational) orπ(Irrational) which are both<: Real, but notIntegerorAbstractFloatwe get the stack overlfow behavior reported aboveThe proposal here then is we first check if a
Realhas overloadedStructTypes.numbertypeand if not, we'll use a newJSON3.tostringmethod, which by default converts the custom number toFloat64and then callsBase.string(x). This method allows custom number types, like FixedPointDecimal, to overloadJSON3.tostringto provide an appropriate string representation for their type.