fastjsonpatch 0.1.0__cp312-abi3-win_amd64.whl

fastjsonpatch/__init__.py

@@ -0,0 +1,1020 @@
+# -*- coding: utf-8 -*-
+#
+# python-json-patch - An implementation of the JSON Patch format
+# https://github.com/stefankoegl/python-json-patch
+#
+# Copyright (c) 2011 Stefan Kögl <stefan@skoegl.net>
+# All rights reserved.
+#
+# 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.
+#
+
+"""Apply JSON-Patches (RFC 6902) - a faster drop-in for jsonpatch 1.34.
+
+This is jsonpatch's module with its hot paths moved to Rust (``fastjsonpatch._core``):
+
+- ``JsonPatch.from_diff`` / ``make_patch``: ``_core.diff`` yields the same operations
+  as ``DiffBuilder``; it returns None for inputs it cannot reproduce exactly, and
+  ``DiffBuilder`` (kept below, unchanged) runs instead.
+- ``JsonPatch.apply`` / ``apply_patch``: ``_core.apply`` applies operations to plain
+  dicts and lists. An operation it cannot apply exactly goes to the operation
+  classes below before anything is mutated.
+- ``JsonPatch.__init__``: ``_core.validate`` checks operations; unusual ones are
+  checked by ``_get_operation`` as before.
+
+Custom pointer classes, custom ``operations`` and subclasses that override
+``_get_operation`` always use the pure-Python code.
+"""
+
+import collections
+import copy
+import functools
+import importlib.metadata
+import json
+from collections.abc import MutableMapping, MutableSequence, Sequence
+from types import MappingProxyType
+
+from jsonpointer import JsonPointer, JsonPointerException
+
+from . import _core
+
+
+_ST_ADD = 0
+_ST_REMOVE = 1
+
+
+__version__ = importlib.metadata.version('fastjsonpatch')
+__license__ = 'BSD-3-Clause'
+# Version of jsonpatch whose behaviour this module reproduces.
+__jsonpatch_version__ = '1.34'
+
+
+class JsonPatchException(Exception):
+    """Base Json Patch exception"""
+
+
+class InvalidJsonPatch(JsonPatchException):
+    """ Raised if an invalid JSON Patch is created """
+
+
+class JsonPatchConflict(JsonPatchException):
+    """Raised if patch could not be applied due to conflict situation such as:
+    - attempt to add object key when it already exists;
+    - attempt to operate with nonexistence object key;
+    - attempt to insert value to array at position beyond its size;
+    - etc.
+    """
+
+
+class JsonPatchTestFailed(JsonPatchException, AssertionError):
+    """ A Test operation failed """
+
+
+def multidict(ordered_pairs):
+    """Convert duplicate keys values to lists."""
+    # read all values into lists
+    mdict = collections.defaultdict(list)
+    for key, value in ordered_pairs:
+        mdict[key].append(value)
+
+    return dict(
+        # unpack lists that have only 1 item
+        (key, values[0] if len(values) == 1 else values)
+        for key, values in mdict.items()
+    )
+
+
+# The "object_pairs_hook" parameter is used to handle duplicate keys when
+# loading a JSON object.
+_jsonloads = functools.partial(json.loads, object_pairs_hook=multidict)
+
+
+def apply_patch(doc, patch, in_place=False, pointer_cls=JsonPointer):
+    """Apply list of patches to specified json document.
+
+    :param doc: Document object.
+    :type doc: dict
+
+    :param patch: JSON patch as list of dicts or raw JSON-encoded string.
+    :type patch: list or str
+
+    :param in_place: While :const:`True` patch will modify target document.
+                     By default patch will be applied to document copy.
+    :type in_place: bool
+
+    :param pointer_cls: JSON pointer class to use.
+    :type pointer_cls: Type[JsonPointer]
+
+    :return: Patched document object.
+    :rtype: dict
+
+    >>> doc = {'foo': 'bar'}
+    >>> patch = [{'op': 'add', 'path': '/baz', 'value': 'qux'}]
+    >>> other = apply_patch(doc, patch)
+    >>> doc is not other
+    True
+    >>> other == {'foo': 'bar', 'baz': 'qux'}
+    True
+    >>> patch = [{'op': 'add', 'path': '/baz', 'value': 'qux'}]
+    >>> apply_patch(doc, patch, in_place=True) == {'foo': 'bar', 'baz': 'qux'}
+    True
+    >>> doc == other
+    True
+    """
+
+    if isinstance(patch, (str, bytes)):
+        patch = JsonPatch.from_string(patch, pointer_cls=pointer_cls)
+    else:
+        patch = JsonPatch(patch, pointer_cls=pointer_cls)
+    return patch.apply(doc, in_place)
+
+
+def make_patch(src, dst, pointer_cls=JsonPointer):
+    """Generates patch by comparing two document objects. Actually is
+    a proxy to :meth:`JsonPatch.from_diff` method. The resulting patch
+    transforms `src` into `dst`, so it has to be applied to `src` (or to a
+    document equal to it).
+
+    :param src: Data source document object.
+    :type src: dict
+
+    :param dst: Data target document object.
+    :type dst: dict
+
+    :param pointer_cls: JSON pointer class to use.
+    :type pointer_cls: Type[JsonPointer]
+
+    >>> src = {'foo': 'bar', 'numbers': [1, 3, 4, 8]}
+    >>> dst = {'baz': 'qux', 'numbers': [1, 4, 7]}
+    >>> patch = make_patch(src, dst)
+    >>> new = patch.apply(src)
+    >>> new == dst
+    True
+    """
+
+    return JsonPatch.from_diff(src, dst, pointer_cls=pointer_cls)
+
+
+class PatchOperation(object):
+    """A single operation inside a JSON Patch."""
+
+    def __init__(self, operation, pointer_cls=JsonPointer):
+        self.pointer_cls = pointer_cls
+
+        if not operation.__contains__('path'):
+            raise InvalidJsonPatch("Operation must have a 'path' member")
+
+        if isinstance(operation['path'], self.pointer_cls):
+            self.location = operation['path'].path
+            self.pointer = operation['path']
+        else:
+            self.location = operation['path']
+            try:
+                self.pointer = self.pointer_cls(self.location)
+            except TypeError:
+                raise InvalidJsonPatch("Invalid 'path'")
+
+        self.operation = operation
+
+    def apply(self, obj):
+        """Abstract method that applies a patch operation to the specified object."""
+        raise NotImplementedError('should implement the patch operation.')
+
+    def __hash__(self):
+        return hash(frozenset(self.operation.items()))
+
+    def __eq__(self, other):
+        if not isinstance(other, PatchOperation):
+            return False
+        return self.operation == other.operation
+
+    def __ne__(self, other):
+        return not(self == other)
+
+    @property
+    def path(self):
+        return '/'.join(self.pointer.parts[:-1])
+
+    @property
+    def key(self):
+        return self.get_part(-1)
+
+    @key.setter
+    def key(self, value):
+        self.set_part(-1, value)
+
+    def get_part(self, index):
+        try:
+            return int(self.pointer.parts[index])
+        except ValueError:
+            return self.pointer.parts[index]
+
+    def set_part(self, index, value):
+        self.pointer.parts[index] = str(value)
+        self.location = self.pointer.path
+        self.operation['path'] = self.location
+
+
+class RemoveOperation(PatchOperation):
+    """Removes an object property or an array element."""
+
+    def apply(self, obj):
+        subobj, part = _to_last(self.pointer, obj)
+
+        if isinstance(subobj, Sequence) and not isinstance(part, int):
+            raise JsonPointerException("invalid array index '{0}'".format(part))
+
+        try:
+            del subobj[part]
+        except (KeyError, IndexError):
+            msg = "can't remove a non-existent object '{0}'".format(part)
+            raise JsonPatchConflict(msg)
+
+        return obj
+
+
+class AddOperation(PatchOperation):
+    """Adds an object property or an array element."""
+
+    def apply(self, obj):
+        try:
+            value = self.operation["value"]
+        except KeyError:
+            raise InvalidJsonPatch(
+                "The operation does not contain a 'value' member")
+
+        # Insert a copy so the document does not share mutable values with
+        # the patch; otherwise later operations would modify the patch itself.
+        return self._add(obj, copy.deepcopy(value))
+
+    def _add(self, obj, value):
+        subobj, part = _to_last(self.pointer, obj)
+
+        if isinstance(subobj, MutableSequence):
+            if part is None:
+                return value  # we're replacing the root
+
+            elif part == '-':
+                subobj.append(value)  # pylint: disable=E1103
+
+            elif part > len(subobj) or part < 0:
+                raise JsonPatchConflict("can't insert outside of list")
+
+            else:
+                subobj.insert(part, value)  # pylint: disable=E1103
+
+        elif isinstance(subobj, MutableMapping):
+            if part is None:
+                obj = value  # we're replacing the root
+            else:
+                subobj[part] = value
+
+        else:
+            if part is None:
+                raise TypeError("invalid document type {0}".format(type(subobj)))
+            else:
+                raise JsonPatchConflict("unable to fully resolve json pointer {0}, part {1}".format(self.location, part))
+        return obj
+
+
+class ReplaceOperation(PatchOperation):
+    """Replaces an object property or an array element by a new value."""
+
+    def apply(self, obj):
+        try:
+            value = self.operation["value"]
+        except KeyError:
+            raise InvalidJsonPatch(
+                "The operation does not contain a 'value' member")
+
+        # copied for the same reason as in AddOperation.apply
+        value = copy.deepcopy(value)
+
+        subobj, part = _to_last(self.pointer, obj)
+
+        if part is None:
+            return value
+
+        if part == "-":
+            raise InvalidJsonPatch("'path' with '-' can't be applied to 'replace' operation")
+
+        if isinstance(subobj, MutableSequence):
+            if part >= len(subobj) or part < 0:
+                raise JsonPatchConflict("can't replace outside of list")
+
+        elif isinstance(subobj, MutableMapping):
+            if part not in subobj:
+                msg = "can't replace a non-existent object '{0}'".format(part)
+                raise JsonPatchConflict(msg)
+        else:
+            if part is None:
+                raise TypeError("invalid document type {0}".format(type(subobj)))
+            else:
+                raise JsonPatchConflict("unable to fully resolve json pointer {0}, part {1}".format(self.location, part))
+
+        subobj[part] = value
+        return obj
+
+
+class MoveOperation(PatchOperation):
+    """Moves an object property or an array element to a new location."""
+
+    def apply(self, obj):
+        try:
+            if isinstance(self.operation['from'], self.pointer_cls):
+                from_ptr = self.operation['from']
+            else:
+                from_ptr = self.pointer_cls(self.operation['from'])
+        except KeyError:
+            raise InvalidJsonPatch(
+                "The operation does not contain a 'from' member")
+
+        subobj, part = _to_last(from_ptr, obj)
+        try:
+            value = subobj[part]
+        except (KeyError, IndexError) as ex:
+            raise JsonPatchConflict(str(ex))
+
+        # If source and target are equal, this is a no-op
+        if self.pointer == from_ptr:
+            return obj
+
+        if isinstance(subobj, MutableMapping) and \
+                self.pointer.contains(from_ptr):
+            raise JsonPatchConflict('Cannot move values into their own children')
+
+        obj = RemoveOperation({
+            'op': 'remove',
+            'path': self.operation['from']
+        }, pointer_cls=self.pointer_cls).apply(obj)
+
+        # the value has been detached from its old location, so no copy needed
+        obj = AddOperation({
+            'op': 'add',
+            'path': self.location,
+        }, pointer_cls=self.pointer_cls)._add(obj, value)
+
+        return obj
+
+    @property
+    def from_path(self):
+        from_ptr = self.pointer_cls(self.operation['from'])
+        return '/'.join(from_ptr.parts[:-1])
+
+    @property
+    def from_key(self):
+        return self.get_from_part(-1)
+
+    @from_key.setter
+    def from_key(self, value):
+        self.set_from_part(-1, value)
+
+    def get_from_part(self, index):
+        from_ptr = self.pointer_cls(self.operation['from'])
+        try:
+            return int(from_ptr.parts[index])
+        except ValueError:
+            return from_ptr.parts[index]
+
+    def set_from_part(self, index, value):
+        from_ptr = self.pointer_cls(self.operation['from'])
+        from_ptr.parts[index] = str(value)
+        self.operation['from'] = from_ptr.path
+
+
+class TestOperation(PatchOperation):
+    """Test value by specified location."""
+
+    def apply(self, obj):
+        try:
+            subobj, part = _to_last(self.pointer, obj)
+            if part is None:
+                val = subobj
+            else:
+                val = self.pointer.walk(subobj, part)
+        except JsonPointerException as ex:
+            raise JsonPatchTestFailed(str(ex))
+
+        try:
+            value = self.operation['value']
+        except KeyError:
+            raise InvalidJsonPatch(
+                "The operation does not contain a 'value' member")
+
+        if val != value:
+            msg = '{0} ({1}) is not equal to tested value {2} ({3})'
+            raise JsonPatchTestFailed(msg.format(val, type(val),
+                                                 value, type(value)))
+
+        return obj
+
+
+class CopyOperation(PatchOperation):
+    """ Copies an object property or an array element to a new location """
+
+    def apply(self, obj):
+        try:
+            from_ptr = self.pointer_cls(self.operation['from'])
+        except KeyError:
+            raise InvalidJsonPatch(
+                "The operation does not contain a 'from' member")
+
+        subobj, part = _to_last(from_ptr, obj)
+        try:
+            value = copy.deepcopy(subobj if part is None else subobj[part])
+        except (KeyError, IndexError) as ex:
+            raise JsonPatchConflict(str(ex))
+
+        # value is already a deep copy, no need to copy it again
+        obj = AddOperation({
+            'op': 'add',
+            'path': self.location,
+        }, pointer_cls=self.pointer_cls)._add(obj, value)
+
+        return obj
+
+
+class JsonPatch(object):
+    json_dumper = staticmethod(json.dumps)
+    json_loader = staticmethod(_jsonloads)
+
+    operations = MappingProxyType({
+        'remove': RemoveOperation,
+        'add': AddOperation,
+        'replace': ReplaceOperation,
+        'move': MoveOperation,
+        'test': TestOperation,
+        'copy': CopyOperation,
+    })
+
+    """A JSON Patch is a list of Patch Operations.
+
+    >>> patch = JsonPatch([
+    ...     {'op': 'add', 'path': '/foo', 'value': 'bar'},
+    ...     {'op': 'add', 'path': '/baz', 'value': [1, 2, 3]},
+    ...     {'op': 'remove', 'path': '/baz/1'},
+    ...     {'op': 'test', 'path': '/baz', 'value': [1, 3]},
+    ...     {'op': 'replace', 'path': '/baz/0', 'value': 42},
+    ...     {'op': 'remove', 'path': '/baz/1'},
+    ... ])
+    >>> doc = {}
+    >>> result = patch.apply(doc)
+    >>> expected = {'foo': 'bar', 'baz': [42]}
+    >>> result == expected
+    True
+
+    JsonPatch object is iterable, so you can easily access each patch
+    statement in a loop:
+
+    >>> lpatch = list(patch)
+    >>> expected = {'op': 'add', 'path': '/foo', 'value': 'bar'}
+    >>> lpatch[0] == expected
+    True
+    >>> lpatch == patch.patch
+    True
+
+    Also JsonPatch could be converted directly to :class:`bool` if it contains
+    any operation statements:
+
+    >>> bool(patch)
+    True
+    >>> bool(JsonPatch([]))
+    False
+
+    This behavior is very handy with :func:`make_patch` to write more readable
+    code:
+
+    >>> old = {'foo': 'bar', 'numbers': [1, 3, 4, 8]}
+    >>> new = {'baz': 'qux', 'numbers': [1, 4, 7]}
+    >>> patch = make_patch(old, new)
+    >>> if patch:
+    ...     # document have changed, do something useful
+    ...     patch.apply(old)    #doctest: +ELLIPSIS
+    {...}
+    """
+    def __init__(self, patch, pointer_cls=JsonPointer):
+        self.patch = patch
+        self.pointer_cls = pointer_cls
+
+        # Verify that the structure of the patch document
+        # is correct by retrieving each patch element.
+        # Much of the validation is done in the initializer
+        # though some is delayed until the patch is applied.
+        if _fast(type(self), pointer_cls, patch):
+            _core.validate(patch, self._check_operation)
+            return
+        for op in self.patch:
+            self._check_operation(op)
+
+    def _check_operation(self, op):
+        # We're only checking for strings in the following check
+        # for two reasons:
+        #
+        # - It should come from JSON, which only allows strings as
+        #   dictionary keys, so having a string here unambiguously means
+        #   someone used: {"op": ..., ...} instead of [{"op": ..., ...}].
+        #
+        # - There's no possible false positive: if someone give a sequence
+        #   of mappings, this won't raise.
+        if isinstance(op, (str, bytes)):
+            raise InvalidJsonPatch("Document is expected to be sequence of "
+                                   "operations, got a sequence of strings.")
+
+        self._get_operation(op)
+
+    def __str__(self):
+        """str(self) -> self.to_string()"""
+        return self.to_string()
+
+    def __bool__(self):
+        return bool(self.patch)
+
+    __nonzero__ = __bool__
+
+    def __iter__(self):
+        return iter(self.patch)
+
+    def __hash__(self):
+        return hash(tuple(self._ops))
+
+    def __eq__(self, other):
+        if not isinstance(other, JsonPatch):
+            return False
+        return self._ops == other._ops
+
+    def __ne__(self, other):
+        return not(self == other)
+
+    @classmethod
+    def from_string(cls, patch_str, loads=None, pointer_cls=JsonPointer):
+        """Creates JsonPatch instance from string source.
+
+        :param patch_str: JSON patch as raw string.
+        :type patch_str: str
+
+        :param loads: A function of one argument that loads a serialized
+                      JSON string.
+        :type loads: function
+
+        :param pointer_cls: JSON pointer class to use.
+        :type pointer_cls: Type[JsonPointer]
+
+        :return: :class:`JsonPatch` instance.
+        """
+        json_loader = loads or cls.json_loader
+        patch = json_loader(patch_str)
+        return cls(patch, pointer_cls=pointer_cls)
+
+    @classmethod
+    def from_diff(
+            cls, src, dst, optimization=True, dumps=None,
+            pointer_cls=JsonPointer,
+    ):
+        """Creates JsonPatch instance based on comparison of two document
+        objects. Json patch would be created for `src` argument against `dst`
+        one. The resulting patch transforms `src` into `dst`, so it has to be
+        applied to `src` (or to a document equal to it).
+
+        :param src: Data source document object.
+        :type src: dict
+
+        :param dst: Data target document object.
+        :type dst: dict
+
+        :param dumps: A function of one argument that produces a serialized
+                      JSON string.
+        :type dumps: function
+
+        :param pointer_cls: JSON pointer class to use.
+        :type pointer_cls: Type[JsonPointer]
+
+        :return: :class:`JsonPatch` instance.
+
+        >>> src = {'foo': 'bar', 'numbers': [1, 3, 4, 8]}
+        >>> dst = {'baz': 'qux', 'numbers': [1, 4, 7]}
+        >>> patch = JsonPatch.from_diff(src, dst)
+        >>> new = patch.apply(src)
+        >>> new == dst
+        True
+        """
+        if dumps is None and cls.json_dumper is json.dumps:
+            ops = _core.diff(src, dst)
+            if ops is not None:
+                if cls.__init__ is JsonPatch.__init__ and _fast(cls, pointer_cls, ops):
+                    # generated operations need no validation
+                    patch = cls.__new__(cls)
+                    patch.patch, patch.pointer_cls = ops, pointer_cls
+                    return patch
+                return cls(ops, pointer_cls=pointer_cls)
+
+        json_dumper = dumps or cls.json_dumper
+        builder = DiffBuilder(src, dst, json_dumper, pointer_cls=pointer_cls)
+        builder._compare_values((), None, src, dst)
+        ops = list(builder.execute())
+        return cls(ops, pointer_cls=pointer_cls)
+
+    def to_string(self, dumps=None):
+        """Returns patch set as JSON string."""
+        json_dumper = dumps or self.json_dumper
+        return json_dumper(self.patch)
+
+    @property
+    def _ops(self):
+        return tuple(map(self._get_operation, self.patch))
+
+    def apply(self, obj, in_place=False):
+        """Applies the patch to a given object.
+
+        :param obj: Document object.
+        :type obj: dict
+
+        :param in_place: Tweaks the way how patch would be applied - directly to
+                         specified `obj` or to its copy.
+        :type in_place: bool
+
+        :return: Modified `obj`.
+        """
+
+        if _fast(type(self), self.pointer_cls, self.patch):
+            return _core.apply(self.patch, obj, in_place, self._get_operation, _add_stage)
+
+        if not in_place:
+            obj = copy.deepcopy(obj)
+
+        for operation in self._ops:
+            obj = operation.apply(obj)
+
+        return obj
+
+    def _get_operation(self, operation):
+        if 'op' not in operation:
+            raise InvalidJsonPatch("Operation does not contain 'op' member")
+
+        op = operation['op']
+
+        if not isinstance(op, (str, bytes)):
+            raise InvalidJsonPatch("Operation's op must be a string")
+
+        if op not in self.operations:
+            raise InvalidJsonPatch("Unknown operation {0!r}".format(op))
+
+        cls = self.operations[op]
+        return cls(operation, pointer_cls=self.pointer_cls)
+
+
+def _fast(cls, pointer_cls, patch):
+    """Can the Rust core stand in for the Python code of this patch class?"""
+    return (pointer_cls is JsonPointer and type(patch) in (list, tuple)
+            and cls.operations is JsonPatch.operations
+            and cls._get_operation is JsonPatch._get_operation)
+
+
+def _add_stage(obj, location, value):
+    """The second half of move and copy, for the Rust core to delegate to."""
+    return AddOperation({'op': 'add', 'path': location})._add(obj, value)
+
+
+deepcopy = _core.deepcopy
+
+
+class DiffBuilder(object):
+
+    def __init__(self, src_doc, dst_doc, dumps=json.dumps, pointer_cls=JsonPointer):
+        self.dumps = dumps
+        self.pointer_cls = pointer_cls
+        self.index_storage = [{}, {}]
+        self.index_storage2 = [[], []]
+        self.__root = root = []
+        self.src_doc = src_doc
+        self.dst_doc = dst_doc
+        root[:] = [root, root, None]
+
+    def store_index(self, value, index, st):
+        typed_key = (value, type(value))
+        try:
+            storage = self.index_storage[st]
+            stored = storage.get(typed_key)
+            if stored is None:
+                storage[typed_key] = [index]
+            else:
+                storage[typed_key].append(index)
+
+        except TypeError:
+            self.index_storage2[st].append((typed_key, index))
+
+    def take_index(self, value, st):
+        typed_key = (value, type(value))
+        try:
+            stored = self.index_storage[st].get(typed_key)
+            if stored:
+                return stored.pop()
+
+        except TypeError:
+            storage = self.index_storage2[st]
+            for i in range(len(storage)-1, -1, -1):
+                if storage[i][0] == typed_key:
+                    return storage.pop(i)[1]
+
+    def insert(self, op):
+        root = self.__root
+        last = root[0]
+        last[1] = root[0] = [last, root, op]
+        return root[0]
+
+    def remove(self, index):
+        link_prev, link_next, _ = index
+        link_prev[1] = link_next
+        link_next[0] = link_prev
+        index[:] = []
+
+    def iter_from(self, start):
+        root = self.__root
+        curr = start[1]
+        while curr is not root:
+            yield curr[2]
+            curr = curr[1]
+
+    def __iter__(self):
+        root = self.__root
+        curr = root[1]
+        while curr is not root:
+            yield curr[2]
+            curr = curr[1]
+
+    def execute(self):
+        root = self.__root
+        curr = root[1]
+        while curr is not root:
+            if curr[1] is not root:
+                op_first, op_second = curr[2], curr[1][2]
+                if op_first['path'] == op_second['path'] and \
+                        op_first['op'] == 'remove' and \
+                        op_second['op'] == 'add':
+                    yield {
+                        'op': 'replace',
+                        'path': _to_pointer(op_second['path']),
+                        'value': op_second['value'],
+                    }
+                    curr = curr[1][1]
+                    continue
+
+            operation = dict(curr[2])
+            for member in ('from', 'path'):
+                if member in operation:
+                    operation[member] = _to_pointer(operation[member])
+            yield operation
+            curr = curr[1]
+
+    def _adjust_following(self, index, removed):
+        """ Works out how the operations following index change if the item
+        that the operation at index removes (or adds, if not removed) is
+        moved there later instead.
+
+        The operations were made for documents without (or with) the item,
+        and are changed to documents with (or without) it. They never refer
+        to the item, as the diff does not change values it adds or removes.
+        Returns these changes and where the item is after the operations. """
+        location = index[2]['path']
+        changes = []
+        # only array indices change, so nothing does if there are none
+        if not any(isinstance(part, int) for part in location):
+            return changes, location
+
+        for op in self.iter_from(index):
+            # 'from' is removed before 'path' is added
+            for member in ('from', 'path'):
+                if member not in op:
+                    continue
+
+                inserted = member == 'path' and op['op'] in ('add', 'move')
+                if removed:
+                    parts = _with_item(op[member], location, inserted)
+                    present = parts
+                else:
+                    parts = _without_item(op[member], location)
+                    present = op[member]
+
+                if op['op'] != 'replace':
+                    location = _item_after(location, present, inserted)
+                changes.append((op, member, parts))
+
+        return changes, location
+
+    def _item_added(self, path, key, item):
+        target = _path_join(path, key)
+        index = self.take_index(item, _ST_REMOVE)
+        if index is not None:
+            changes, source = self._adjust_following(index, removed=True)
+            # RFC 6902 does not allow moving a value into its own children
+            if not _is_inside(target, source):
+                for op, member, parts in changes:
+                    op[member] = parts
+                self.remove(index)
+                if source != target:
+                    self.insert({'op': 'move', 'from': source,
+                                 'path': target})
+                return
+
+        new_index = self.insert({'op': 'add', 'path': target, 'value': item})
+        self.store_index(item, new_index, _ST_ADD)
+
+    def _item_removed(self, path, key, item):
+        source = _path_join(path, key)
+        index = self.take_index(item, _ST_ADD)
+        if index is not None:
+            changes, added = self._adjust_following(index, removed=False)
+            moved_from = _without_item(source, added)
+            target = _item_after(added, source, False)
+            # RFC 6902 does not allow moving a value into its own children
+            if not _is_inside(target, moved_from):
+                for op, member, parts in changes:
+                    op[member] = parts
+                self.remove(index)
+                if moved_from != target:
+                    self.insert({'op': 'move', 'from': moved_from,
+                                 'path': target})
+                return
+
+        new_index = self.insert({'op': 'remove', 'path': source})
+        self.store_index(item, new_index, _ST_REMOVE)
+
+    def _item_replaced(self, path, key, item):
+        self.insert({
+            'op': 'replace',
+            'path': _path_join(path, key),
+            'value': item,
+        })
+
+    def _compare_dicts(self, path, src, dst):
+        added_keys = [key for key in dst if key not in src]
+        removed_keys = [key for key in src if key not in dst]
+        intersection = [key for key in src if key in dst]
+
+        for key in removed_keys:
+            self._item_removed(path, str(key), src[key])
+
+        for key in added_keys:
+            self._item_added(path, str(key), dst[key])
+
+        for key in intersection:
+            self._compare_values(path, str(key), src[key], dst[key])
+
+    def _compare_lists(self, path, src, dst):
+        len_src, len_dst = len(src), len(dst)
+        max_len = max(len_src, len_dst)
+        min_len = min(len_src, len_dst)
+        for key in range(max_len):
+            if key < min_len:
+                old, new = src[key], dst[key]
+                if isinstance(old, MutableMapping) and \
+                        isinstance(new, MutableMapping):
+                    self._compare_dicts(_path_join(path, key), old, new)
+
+                elif isinstance(old, MutableSequence) and \
+                        isinstance(new, MutableSequence):
+                    self._compare_lists(_path_join(path, key), old, new)
+
+                # To ensure we catch changes to JSON, we can't rely on a
+                # simple old == new, because it would not recognize the
+                # difference between 1 and True, among other things.
+                elif self.dumps(old) == self.dumps(new):
+                    continue
+
+                else:
+                    self._item_removed(path, key, old)
+                    self._item_added(path, key, new)
+
+            elif len_src > len_dst:
+                self._item_removed(path, len_dst, src[key])
+
+            else:
+                self._item_added(path, key, dst[key])
+
+    def _compare_values(self, path, key, src, dst):
+        if isinstance(src, MutableMapping) and \
+                isinstance(dst, MutableMapping):
+            self._compare_dicts(_path_join(path, key), src, dst)
+
+        elif isinstance(src, MutableSequence) and \
+                isinstance(dst, MutableSequence):
+            self._compare_lists(_path_join(path, key), src, dst)
+
+        # To ensure we catch changes to JSON, we can't rely on a simple
+        # src == dst, because it would not recognize the difference between
+        # 1 and True, among other things. Using json.dumps is the most
+        # fool-proof way to ensure we catch type changes that matter to JSON
+        # and ignore those that don't. The performance of this could be
+        # improved by doing more direct type checks, but we'd need to be
+        # careful to accept type changes that don't matter when JSONified.
+        elif self.dumps(src) == self.dumps(dst):
+            return
+
+        else:
+            self._item_replaced(path, key, dst)
+
+
+# The DiffBuilder keeps locations as tuples of object keys (str) and array
+# indices (int), so it can tell them apart when it adjusts array indices
+
+
+def _path_join(path, key):
+    if key is None:
+        return path
+
+    return path + (key,)
+
+
+def _to_pointer(path):
+    return ''.join('/' + str(part).replace('~', '~0').replace('/', '~1')
+                   for part in path)
+
+
+def _is_prefix(sub_parts, parts):
+    return sub_parts == parts[:len(sub_parts)]
+
+
+def _is_inside(parts, container):
+    return len(parts) > len(container) and _is_prefix(container, parts)
+
+
+def _shift(parts, depth, offset):
+    return parts[:depth] + (parts[depth] + offset,) + parts[depth + 1:]
+
+
+def _with_item(parts, location, insertion):
+    """ Changes parts, which assumes that there is no item at location, to
+    the item being there. insertion tells if parts is where 'add' inserts """
+    depth = len(location) - 1
+    if isinstance(location[-1], int) and _is_inside(parts, location[:-1]):
+        index = parts[depth]
+        # inserting at the index of the item inserts before it
+        before_item = insertion and len(parts) == len(location) and \
+            index == location[-1]
+        if index >= location[-1] and not before_item:
+            return _shift(parts, depth, 1)
+
+    return parts
+
+
+def _without_item(parts, location):
+    """ Changes parts, which assumes that there is an item at location, to
+    the item missing """
+    depth = len(location) - 1
+    if isinstance(location[-1], int) and _is_inside(parts, location[:-1]) \
+            and parts[depth] > location[-1]:
+        return _shift(parts, depth, -1)
+
+    return parts
+
+
+def _item_after(location, parts, inserted):
+    """ Where the item at location is after inserting (or removing, if not
+    inserted) the value at parts """
+    depth = len(parts) - 1
+    if not isinstance(parts[-1], int) or not _is_inside(location, parts[:-1]):
+        return location
+
+    if inserted and location[depth] >= parts[-1]:
+        return _shift(location, depth, 1)
+
+    if not inserted and location[depth] > parts[-1]:
+        return _shift(location, depth, -1)
+
+    return location
+
+
+def _to_last(pointer, doc):
+    """Resolve pointer like JsonPointer.to_last, without indexing into strings.
+
+    RFC 6901 only allows reference tokens to be applied to objects and arrays,
+    but older versions of jsonpointer treat strings as sequences.
+    """
+    subobj, part = pointer.to_last(doc)
+
+    if part is not None and isinstance(subobj, str):
+        raise JsonPointerException(
+            "Cannot apply token '{0}' to non-container type {1}".format(
+                part, type(subobj)))
+
+    return subobj, part