JSONPointer.jl

Implementation of JSONPointer on Julia
Author devsisters
Popularity
4 Stars
Updated Last
1 Year Ago
Started In
June 2020

JSONPointer

LICENSE MIT Run CI on master Converage

Implementation of JSON Pointers according to RFC 6901

Overview

JSONPointer is a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a '/' (%x2F) character.

Examples

Constructing Dictionary

using JSONPointer

julia>p1 = j"/a/1/b"
      p2 = j"/a/2/b"
      data = Dict(p1 =>1, p2 => 2)
Dict{String,Any} with 1 entry:
  "a" => Any[Dict{String,Any}("b"=>1), Dict{String,Any}("b"=>2)]

Accessing nested data

using JSONPointer

julia> arr = [[10, 20, 30, ["me"]]]
       arr[j"/1"] == [10, 20, 30, ["me"]]
       arr[j"/1/2"] == 20
       arr[j"/1/4"] == ["me"]
       arr[j"/1/4/1"] == "me"

julia> dict = Dict("a" => Dict("b" => Dict("c" => [100, Dict("d" => 200)])))
       dict[j"/a"]
       dict[j"/a/b"]
       dict[j"/a/b/c/1"]
       dict[j"/a/b/c/2/d"]

Advanced

Constructing Dictionary With Static type

You can enforce type with ::T at the end of pointer:

  p1 = j"/a::array"
  p2 = j"/b/2::string"
  data = Dict(p1 => [1,2,3], p2 => "Must be a String")

The type T must be one of the six types supported by JSON:

  • ::string
  • ::number
  • ::object
  • ::array
  • ::boolean
  • ::null

String number as a key

If you need to use a string number as key for dict, put '' in front of a number

    p1 = j"/\10"
    data = Dict(p1 => "this won't be a array")

    data[p1]

Limitations

  • Can only used on Dictionary with a 'String' key
  • Supports Only 'Dict' and 'OrderedDict', but could be extended for other 'AbstractDict' types. feel free to create a issue
  • Note that Julia is using 1-based index, 0-based index can be used if argument shift_index = true is given to a JSONPointer.Pointer constructer
julia>JSONPointer.Pointer(j"/foo/0"; shift_index = true)

Required Packages

Used By Packages