Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support user-defined mapping for Inf and NaN via keyword arg #294

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

support user-defined mapping for Inf and NaN via keyword arg #294

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d68937d
support user-defined mapping for Inf and NaN via keyword arg
hhaensel Nov 17, 2024
7d887c6
Merge branch 'quinnj:main' into hh-infinity2
hhaensel Jan 2, 2025
1ce1b28
allow_inf: fix lower performance for default_mapping, add `underscore…
Jan 15, 2025
f656813
remove custom inf_mappings and add kw inf_mapping to docstring
hhaensel Jan 15, 2025
62f8efb
modify docstring for inf_mapping
Jan 16, 2025
0dc0277
revise docstring of write, add brackets for clarity
hhaensel Jan 29, 2025
4fc6b43
support `read()` with inf_mapping
Jan 31, 2025
7f08318
include quotes in test when reading inf and nan strings
Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions src/write.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ Write JSON.
## Keyword Args

* `allow_inf`: Allow writing of `Inf` and `NaN` values (not part of the JSON standard). [default `false`]
* `inf_mapping`: A function to map `Inf`, `-Inf` and `NaN` values to a custom representation. [default `nothing`]

if `inf_mapping` is `nothing` the mapping is equivalent to

`inf_mapping = x -> x == Inf ? "Infinity" : x == -Inf ? "-Infinity" : "NaN"``
* `dateformat`: A [`DateFormat`](https://docs.julialang.org/en/v1/stdlib/Dates/#Dates.DateFormat) describing how to format `Date`s in the object. [default `Dates.default_format(T)`]
"""
function write(io::IO, obj::T; kw...) where {T}
Expand Down Expand Up @@ -279,19 +284,26 @@ function write(::NumberType, buf, pos, len, x::AbstractFloat; allow_inf::Bool=fa
return buf, pos, len
end

@inline function write(::NumberType, buf, pos, len, x::T; allow_inf::Bool=false, kw...) where {T <: Base.IEEEFloat}
isfinite(x) || allow_inf || error("$x not allowed to be written in JSON spec")
if isinf(x)
@inline function write(::NumberType, buf, pos, len, x::T; inf_mapping::Union{Function, Nothing} = nothing, allow_inf::Bool = inf_mapping !== nothing, kw...) where {T <: Base.IEEEFloat}
if isfinite(x) || allow_inf && inf_mapping === nothing && isnan(x)
@check Ryu.neededdigits(T)
pos = Ryu.writeshortest(buf, pos, x)
else
allow_inf || error("$x not allowed to be written in JSON spec")
# Although this is non-standard JSON, "Infinity" is commonly used.
# See https://docs.python.org/3/library/json.html#infinite-and-nan-number-values.
if sign(x) == -1
@writechar '-'
if inf_mapping === nothing
sign(x) == -1 && @writechar '-'
@writechar 'I' 'n' 'f' 'i' 'n' 'i' 't' 'y'
else
bytes = codeunits(inf_mapping(x))
@check length(bytes)
for b in bytes
@inbounds buf[pos] = b
pos += 1
end
end
@writechar 'I' 'n' 'f' 'i' 'n' 'i' 't' 'y'
return buf, pos, len
end
@check Ryu.neededdigits(T)
pos = Ryu.writeshortest(buf, pos, x)
return buf, pos, len
end

Expand Down
5 changes: 5 additions & 0 deletions test/json.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ end
@test JSON3.read("Inf"; allow_inf=true) === Inf
@test JSON3.read("Infinity"; allow_inf=true) === Inf
@test JSON3.read("-Infinity"; allow_inf=true) === -Inf
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting that it is not possible to support reading with a custom mapping defined with a function that maps Float64 to String.

However, it is possible to support reading and writing with a @NamedTuple{positive_inf::AbstractString, negative_inf::AbstractString, nan::AbstractString} API.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I agree that not being able to read the JSON back in when a custom mapping is used is a bummer, but also it's something that is/will be better solved in JSONBase.jl, where it's easier to override reading things.

Actually, we do have the RawJson construct if you really needed to parse something back in; it's a bit of a heavy-handed escape hatch here, but technically would work.


quoted_inf_mapping(x) = x == Inf ? "\"Infinity\"" : x == -Inf ? "\"-Infinity\"" : "\"NaN\""
@test JSON3.write(NaN, inf_mapping = quoted_inf_mapping) == "\"NaN\""
@test JSON3.write(Inf, inf_mapping = quoted_inf_mapping) == "\"Infinity\""
@test JSON3.write(-Inf, inf_mapping = quoted_inf_mapping) == "\"-Infinity\""
end

@testset "Char" begin
Expand Down
Loading