python-json-pointer/jsonpointer.py at master · jlquant/python-json-pointer · GitHub

History

315 lines (221 loc) · 9.15 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

# -*- coding: utf-8 -*-

# python-json-pointer - An implementation of the JSON Pointer syntax

# https://github.com/stefankoegl/python-json-pointer

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions

# are met:

# 1. Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

# 2. Redistributions in binary form must reproduce the above copyright

# notice, this list of conditions and the following disclaimer in the

# documentation and/or other materials provided with the distribution.

# 3. The name of the author may not be used to endorse or promote products

# derived from this software without specific prior written permission.

# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR

# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,

# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from __future__ import unicode_literals

""" Identify specific nodes in a JSON document (RFC 6901) """

try:

from collections.abc import Mapping, Sequence

except ImportError:

from collections import Mapping, Sequence

# Will be parsed by setup.py to determine package metadata

__author__ = 'Stefan Kögl <stefan@skoegl.net>'

__version__ = '1.9'

__website__ = 'https://github.com/stefankoegl/python-json-pointer'

__license__ = 'Modified BSD License'

try:

from urllib import unquote

from itertools import izip

str = unicode

except ImportError: # Python 3

from urllib.parse import unquote

izip = zip

from itertools import tee

import re

import copy

# array indices must not contain leading zeros, signs, spaces, decimals, etc

RE_ARRAY_INDEX=re.compile('0|[1-9][0-9]*$')

class JsonPointerException(Exception):

pass

class EndOfList(object):

""" Result of accessing element "-" of a list """

def __init__(self, list_):

self.list_ = list_

def __repr__(self):

return '{cls}({lst})'.format(cls=self.__class__.__name__,

lst=repr(self.list_))

_nothing = object()

def resolve_pointer(doc, pointer, default=_nothing):

"""

Resolves pointer against doc and returns the referenced object

>>> obj = {"foo": {"anArray": [ {"prop": 44}], "another prop": {"baz": "A string" }}}

>>> resolve_pointer(obj, '') == obj

True

>>> resolve_pointer(obj, '/foo') == obj['foo']

True

>>> resolve_pointer(obj, '/foo/another%20prop') == obj['foo']['another prop']

True

>>> resolve_pointer(obj, '/foo/another%20prop/baz') == obj['foo']['another prop']['baz']

True

>>> resolve_pointer(obj, '/foo/anArray/0') == obj['foo']['anArray'][0]

True

>>> resolve_pointer(obj, '/some/path', None) == None

True

"""

pointer = JsonPointer(pointer)

return pointer.resolve(doc, default)

def set_pointer(doc, pointer, value, inplace=True):

"""

Resolves pointer against doc and sets the value of the target within doc.

With inplace set to true, doc is modified as long as pointer is not the

root.

>>> obj = {"foo": {"anArray": [ {"prop": 44}], "another prop": {"baz": "A string" }}}

>>> set_pointer(obj, '/foo/anArray/0/prop', 55) == \

{'foo': {'another prop': {'baz': 'A string'}, 'anArray': [{'prop': 55}]}}

True

>>> set_pointer(obj, '/foo/yet%20another%20prop', 'added prop') == \

{'foo': {'another prop': {'baz': 'A string'}, 'yet another prop': 'added prop', 'anArray': [{'prop': 55}]}}

True

"""

pointer = JsonPointer(pointer)

return pointer.set(doc, value, inplace)

class JsonPointer(object):

""" A JSON Pointer that can reference parts of an JSON document """

def __init__(self, pointer):

parts = pointer.split('/')

if parts.pop(0) != '':

raise JsonPointerException('location must starts with /')

parts = map(unquote, parts)

parts = [part.replace('~1', '/') for part in parts]

parts = [part.replace('~0', '~') for part in parts]

self.parts = parts

def to_last(self, doc):

""" Resolves ptr until the last step, returns (sub-doc, last-step) """

if not self.parts:

return doc, None

for part in self.parts[:-1]:

doc = self.walk(doc, part)

return doc, self.get_part(doc, self.parts[-1])

def resolve(self, doc, default=_nothing):

"""Resolves the pointer against doc and returns the referenced object"""

for part in self.parts:

try:

doc = self.walk(doc, part)

except JsonPointerException:

if default is _nothing:

raise

else:

return default

return doc

get = resolve

def set(self, doc, value, inplace=True):

""" Resolve the pointer against the doc and replace the target with value. """

if len(self.parts) == 0:

if inplace:

raise JsonPointerException('cannot set root in place')

return value

if not inplace:

doc = copy.deepcopy(doc)

(parent, part) = self.to_last(doc)

parent[part] = value

return doc

def get_part(self, doc, part):

""" Returns the next step in the correct type """

if isinstance(doc, Mapping):

return part

elif isinstance(doc, Sequence):

if part == '-':

return part

if not RE_ARRAY_INDEX.match(str(part)):

raise JsonPointerException("'%s' is not a valid list index" % (part, ))

return int(part)

elif hasattr(doc, '__getitem__'):

# Allow indexing via ducktyping if the target has defined __getitem__

return part

else:

raise JsonPointerException("Document '%s' does not support indexing, "

"must be dict/list or support __getitem__" % type(doc))

def walk(self, doc, part):

""" Walks one step in doc and returns the referenced part """

part = self.get_part(doc, part)

assert (type(doc) in (dict, list) or hasattr(doc, '__getitem__')), "invalid document type %s" % (type(doc),)

if isinstance(doc, Mapping):

try:

return doc[part]

except KeyError:

raise JsonPointerException("member '%s' not found in %s" % (part, doc))

elif isinstance(doc, Sequence):

if part == '-':

return EndOfList(doc)

try:

return doc[part]

except IndexError:

raise JsonPointerException("index '%s' is out of bounds" % (part, ))

else:

# Object supports __getitem__, assume custom indexing

return doc[part]

def contains(self, ptr):

"""Returns True if self contains the given ptr"""

return self.parts[:len(ptr.parts)] == ptr.parts

def __contains__(self, item):

"""Returns True if self contains the given ptr"""

return self.contains(item)

@property

def path(self):

""" Returns the string representation of the pointer

>>> ptr = JsonPointer('/~0/0/~1').path == '/~0/0/~1'

"""

parts = [part.replace('~', '~0') for part in self.parts]

parts = [part.replace('/', '~1') for part in parts]

return ''.join('/' + part for part in parts)

def __eq__(self, other):

""" compares a pointer to another object

Pointers can be compared by comparing their strings (or splitted

strings), because no two different parts can point to the same

structure in an object (eg no different number representations) """

if not isinstance(other, JsonPointer):

return False

return self.parts == other.parts

def __hash__(self):

return hash(tuple(self.parts))

@classmethod

def from_parts(cls, parts):

""" Constructs a JsonPointer from a list of (unescaped) paths

>>> JsonPointer.from_parts(['a', '~', '/', 0]).path == '/a/~0/~1/0'

True

"""

parts = [str(part) for part in parts]

parts = [part.replace('~', '~0') for part in parts]

parts = [part.replace('/', '~1') for part in parts]

ptr = cls(''.join('/' + part for part in parts))

return ptr

def pairwise(iterable):

""" s -> (s0,s1), (s1,s2), (s2, s3), ...

>>> list(pairwise([]))

[]

>>> list(pairwise([1]))

[]

>>> list(pairwise([1, 2, 3, 4]))

[(1, 2), (2, 3), (3, 4)]

"""

a, b = tee(iterable)

for _ in b:

break

return izip(a, b)

python-json-pointer/jsonpointer.py at master · jlquant/python-json-pointer · GitHub

Expand file tree

Breadcrumbs

jsonpointer.py

Latest commit

History

Breadcrumbs

jsonpointer.py

File metadata and controls