Pyjo.JSON.Pointer - JSON Pointers

from Pyjo.JSON.Pointer import Pointer

pointer = Pointer({'foo': [23, 'bar']})
print(pointer.get('/foo/1'))
if pointer.contains('/foo'):
    print('Contains "/foo".')

# Or import the module, as in Google Python Style Guide

import Pyjo.JSON.Pointer

pointer = Pyjo.JSON.Pointer.new({'foo': [23, 'bar']})
print(pointer.get('/foo/1'))
if pointer.contains('/foo'):
    print('Contains "/foo".')

Pyjo.JSON.Pointer is an implementation of RFC 6901.

See also

Pyjoyment, https://mojolicious.org.

Ported from Mojo::JSON::Pointer of Mojolicious 9.49.

Classes

class Pyjo.JSON.Pointer.Pyjo_JSON_Pointer(data: Any = None)[source]

Pyjo.JSON.Pointer inherits all methods from Pyjo.Base and implements the following new ones.

__init__(data: Any = None) → None[source]
pointer = Pyjo.JSON.Pointer.new()
pointer = Pyjo.JSON.Pointer.new({'foo': 'bar'})

Build new Pyjo.JSON.Pointer object.

contains(pointer: str) → bool[source]
boolean = pointer.contains('/foo/1')

Check if data contains a value that can be identified with the given JSON Pointer.

# True
Pyjo.JSON.Pointer.new('just a string').contains('')
Pyjo.JSON.Pointer.new({'♥': 'pyjoyment'}).contains('/♥')
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5]}).contains('/foo')
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5]}).contains('/baz/1')

# False
Pyjo.JSON.Pointer.new({'♥': 'pyjoyment'}).contains('/☃')
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5]}).contains('/bar')
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5]}).contains('/baz/9')
data: Any
data = pointer.data
pointer.data = {'foo': 'bar'}

Data structure to be processed.

get(pointer: str) → Any[source]
value = pointer.get('/foo/bar')

Extract value from data identified by the given JSON Pointer.

# "just a string"
Pyjo.JSON.Pointer.new('just a string').get('')

# "pyjoyment"
Pyjo.JSON.Pointer.new({'♥': 'pyjoyment'}).get('/♥')

# "bar"
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5, 6]}).get('/foo')

# 4
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5, 6]}).get('/baz/0')

# 6
Pyjo.JSON.Pointer.new({'foo': 'bar', 'baz': [4, 5, 6]}).get('/baz/2')