diff options
| -rw-r--r-- | .travis.yml | 5 | ||||
| -rw-r--r-- | jsonpointer.py | 228 | ||||
| -rw-r--r-- | setup.py | 3 | ||||
| -rwxr-xr-x | tests.py | 101 |
4 files changed, 213 insertions, 124 deletions
diff --git a/.travis.yml b/.travis.yml index 52f3048..389dc95 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,9 +2,10 @@ language: python python: - "2.6" - "2.7" - - "3.2" - "3.3" - "3.4" + - "3.5" + - "3.6" - "pypy" - "pypy3" @@ -16,3 +17,5 @@ script: after_script: - coveralls + +sudo: false diff --git a/jsonpointer.py b/jsonpointer.py index 72e5f93..c411682 100644 --- a/jsonpointer.py +++ b/jsonpointer.py @@ -11,12 +11,12 @@ # are met: # # 1. Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. +# 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. +# 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. +# 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 @@ -30,18 +30,13 @@ # 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 +from __future__ import unicode_literals # Will be parsed by setup.py to determine package metadata __author__ = 'Stefan Kögl <stefan@skoegl.net>' -__version__ = '1.7' +__version__ = '1.10' __website__ = 'https://github.com/stefankoegl/python-json-pointer' __license__ = 'Modified BSD License' @@ -49,43 +44,49 @@ __license__ = 'Modified BSD License' try: from urllib import unquote from itertools import izip -except ImportError: # Python 3 + str = unicode +except ImportError: # Python 3 from urllib.parse import unquote izip = zip +try: + from collections.abc import Mapping, Sequence +except ImportError: # Python 3 + from collections import Mapping, Sequence + 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 +_nothing = object() -class EndOfList(object): - """ Result of accessing element "-" of a list """ +def set_pointer(doc, pointer, value, inplace=True): + """Resolves pointer against doc and sets the value of the target within doc. - def __init__(self, list_): - self.list_ = list_ + 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' }}} - def __repr__(self): - return '{cls}({lst})'.format(cls=self.__class__.__name__, - lst=repr(self.list_)) + >>> 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 + """ -_nothing = object() + pointer = JsonPointer(pointer) + return pointer.set(doc, value, inplace) def resolve_pointer(doc, pointer, default=_nothing): - """ - Resolves pointer against doc and returns the referenced object + """ Resolves pointer against doc and returns the referenced object - >>> obj = {"foo": {"anArray": [ {"prop": 44}], "another prop": {"baz": "A string" }}} + >>> obj = {'foo': {'anArray': [ {'prop': 44}], 'another prop': {'baz': 'A string' }}} >>> resolve_pointer(obj, '') == obj True @@ -104,37 +105,53 @@ def resolve_pointer(doc, pointer, default=_nothing): >>> 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. +def pairwise(iterable): + """ Transforms a list to a list of tuples of adjacent items - >>> obj = {"foo": {"anArray": [ {"prop": 44}], "another prop": {"baz": "A string" }}} + s -> (s0,s1), (s1,s2), (s2, s3), ... - >>> set_pointer(obj, '/foo/anArray/0/prop', 55) == \ - {'foo': {'another prop': {'baz': 'A string'}, 'anArray': [{'prop': 55}]}} - True + >>> list(pairwise([])) + [] - >>> set_pointer(obj, '/foo/yet%20another%20prop', 'added prop') == \ - {'foo': {'another prop': {'baz': 'A string'}, 'yet another prop': 'added prop', 'anArray': [{'prop': 55}]}} - True + >>> 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) - pointer = JsonPointer(pointer) - return pointer.set(doc, value, inplace) + +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_)) class JsonPointer(object): - """ A JSON Pointer that can reference parts of an JSON document """ + """A JSON Pointer that can reference parts of an JSON document""" + + # Array indices must not contain: + # leading zeros, signs, spaces, decimals, etc + _RE_ARRAY_INDEX = re.compile('0|[1-9][0-9]*$') def __init__(self, pointer): parts = pointer.split('/') @@ -142,13 +159,11 @@ class JsonPointer(object): 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] + parts = [unescape(part) for part in parts] self.parts = parts - def to_last(self, doc): - """ Resolves ptr until the last step, returns (sub-doc, last-step) """ + """Resolves ptr until the last step, returns (sub-doc, last-step)""" if not self.parts: return doc, None @@ -159,14 +174,16 @@ class JsonPointer(object): if ptype == dict: pass elif ptype == list or isinstance(doc, Sequence): - if not RE_ARRAY_INDEX.match(str(last)): - raise JsonPointerException("'%s' is not a valid list index" % (last, )) + if not self._RE_ARRAY_INDEX.match(str(last)): + raise JsonPointerException( + "'%s' is not a valid list index" % (last, ) + ) last = int(last) return doc, last def resolve(self, doc, default=_nothing, parts=None): - """Resolves the pointer against doc and returns the referenced object""" + """ Resolves the pointer against doc, returns the referenced object """ if parts is None: parts = self.parts @@ -179,31 +196,41 @@ class JsonPointer(object): if part == '-': doc = EndOfList(doc) else: - if not RE_ARRAY_INDEX.match(str(part)): - raise JsonPointerException("'%s' is not a valid list index" % (part, )) + if not self._RE_ARRAY_INDEX.match(str(part)): + raise JsonPointerException( + "'%s' is not a valid list index" % (part, ) + ) doc = doc[int(part)] else: doc = doc[part] except KeyError: if default is not _nothing: return default - raise JsonPointerException("member '%s' not found in %s" % (part, doc)) + raise JsonPointerException( + "member '%s' not found in %s" % (part, doc) + ) + except IndexError: if default is not _nothing: return default - raise JsonPointerException("index '%s' is out of bounds" % (part, )) + raise JsonPointerException( + "index '%s' is out of bounds" % (part, ) + ) + except TypeError: if default is not _nothing: return default - raise JsonPointerException("Document '%s' does not support indexing, " - "must be dict/list or support __getitem__" % type(doc)) + raise JsonPointerException( + "Document '%s' does not support indexing, must be dict/list " + "or support __getitem__" % type(doc) + ) return doc get = resolve def set(self, doc, value, inplace=True): - """ Resolve the pointer against the doc and replace the target with value. """ + """Resolve the pointer against the doc and replace the target with value.""" if len(self.parts) == 0: if inplace: @@ -219,7 +246,7 @@ class JsonPointer(object): return doc def get_part(self, doc, part): - """ Returns the next step in the correct type """ + """Returns the next step in the correct type""" # Optimize for common cases of doc being a dict or list, but not a # sub-class (because isinstance() is far slower) @@ -229,12 +256,24 @@ class JsonPointer(object): if ptype == list or 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, )) + + if not self._RE_ARRAY_INDEX.match(str(part)): + raise JsonPointerException( + "'%s' is not a valid list index" % (part, ) + ) return int(part) - else: + + 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 " + "mapping/sequence or support __getitem__" % type(doc) + ) + def walk(self, doc, part): """ Walks one step in doc and returns the referenced part """ @@ -242,79 +281,78 @@ class JsonPointer(object): if part == '-' and isinstance(doc, Sequence): return EndOfList(doc) + try: return doc[part] + except KeyError: - raise JsonPointerException("member '%s' not found in %s" % (part, doc)) + raise JsonPointerException( + "member '%s' not found in %s" % (part, doc) + ) + except IndexError: - raise JsonPointerException("index '%s' is out of bounds" % (part, )) + raise JsonPointerException( + "index '%s' is out of bounds" % (part, ) + ) + except TypeError: - raise JsonPointerException("Document '%s' does not support indexing, " - "must be dict/list or support __getitem__" % type(doc)) + raise JsonPointerException( + "Document '%s' does not support indexing, must be dict/list " + "or support __getitem__" % type(doc) + ) + except KeyError: + raise JsonPointerException( + "member '%s' not found in %s" % (part, doc) + ) def contains(self, ptr): - """Returns True if self contains the given 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""" + """ Returns True if self contains the given ptr """ return self.contains(item) @property def path(self): - """ Returns the string representation of the pointer + """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] + parts = [escape(part) for part in self.parts] return ''.join('/' + part for part in parts) def __eq__(self, other): - """ compares a pointer to another object + """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) """ + 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 + """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] + parts = [escape(str(part)) for part in parts] ptr = cls(''.join('/' + part for part in parts)) return ptr +def escape(s): + return s.replace('~', '~0').replace('/', '~1') -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) +def unescape(s): + return s.replace('~1', '/').replace('~0', '~') @@ -45,9 +45,10 @@ CLASSIFIERS = [ 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.2', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Software Development :: Libraries', @@ -1,6 +1,8 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- +from __future__ import unicode_literals + import doctest import unittest import sys @@ -8,6 +10,7 @@ import copy from jsonpointer import resolve_pointer, EndOfList, JsonPointerException, \ JsonPointer, set_pointer + class SpecificationTests(unittest.TestCase): """ Tests all examples from the JSON Pointer specification """ @@ -61,6 +64,7 @@ class SpecificationTests(unittest.TestCase): "/k\"l", "/ ", "/m~0n", + '/\xee', ] for path in paths: ptr = JsonPointer(path) @@ -70,6 +74,7 @@ class SpecificationTests(unittest.TestCase): new_ptr = JsonPointer.from_parts(parts) self.assertEqual(ptr, new_ptr) + class ComparisonTests(unittest.TestCase): def setUp(self): @@ -105,7 +110,6 @@ class ComparisonTests(unittest.TestCase): self.assertTrue(self.ptr1 in self.ptr1) self.assertFalse(self.ptr3 in self.ptr1) - class WrongInputTests(unittest.TestCase): def test_no_start_slash(self): @@ -189,43 +193,53 @@ class SetTests(unittest.TestCase): self.assertRaises(JsonPointerException, set_pointer, doc, "", 9) + class AltTypesTests(unittest.TestCase): - def test_alttypes(self): - JsonPointer.alttypes = True + class Node(object): + def __init__(self, name, parent=None): + self.name = name + self.parent = parent + self.left = None + self.right = None + + def set_left(self, node): + node.parent = self + self.left = node - class Node(object): - def __init__(self, name, parent=None): - self.name = name - self.parent = parent - self.left = None - self.right = None + def set_right(self, node): + node.parent = self + self.right = node - def set_left(self, node): - node.parent = self - self.left = node + def __getitem__(self, key): + if key == 'left': + return self.left + if key == 'right': + return self.right - def set_right(self, node): - node.parent = self - self.right = node + raise KeyError("Only left and right supported") - def __getitem__(self, key): - if key == 'left': - return self.left - if key == 'right': - return self.right + def __setitem__(self, key, val): + if key == 'left': + return self.set_left(val) + if key == 'right': + return self.set_right(val) - raise KeyError("Only left and right supported") + raise KeyError("Only left and right supported: %s" % key) - def __setitem__(self, key, val): - if key == 'left': - return self.set_left(val) - if key == 'right': - return self.set_right(val) + class mdict(object): + def __init__(self, d): + self._d = d + def __getitem__(self, item): + return self._d[item] - raise KeyError("Only left and right supported: %s" % key) + mdict = mdict({'root': {'1': {'2': '3'}}}) + Node = Node + def test_alttypes(self): + Node = self.Node + root = Node('root') root.set_left(Node('a')) root.left.set_left(Node('aa')) @@ -246,6 +260,39 @@ class AltTypesTests(unittest.TestCase): set_pointer(root, '/left/right', Node('AB')) self.assertEqual(resolve_pointer(root, '/left/right').name, 'AB') + def test_mock_dict_sanity(self): + doc = self.mdict + default = None + + # TODO: Generate this automatically for any given object + path_to_expected_value = { + '/root/1': {'2': '3'}, + '/root': {'1': {'2': '3'}}, + '/root/1/2': '3', + } + + for path, expected_value in iter(path_to_expected_value.items()): + self.assertEqual(resolve_pointer(doc, path, default), expected_value) + + def test_mock_dict_returns_default(self): + doc = self.mdict + default = None + + path_to_expected_value = { + '/foo': default, + '/x/y/z/d': default + } + + for path, expected_value in iter(path_to_expected_value.items()): + self.assertEqual(resolve_pointer(doc, path, default), expected_value) + + def test_mock_dict_raises_key_error(self): + doc = self.mdict + self.assertRaises(JsonPointerException, resolve_pointer, doc, '/foo') + self.assertRaises(JsonPointerException, resolve_pointer, doc, '/root/1/2/3/4') + + + suite = unittest.TestSuite() suite.addTest(unittest.makeSuite(SpecificationTests)) suite.addTest(unittest.makeSuite(ComparisonTests)) |