[pull] master from stefankoegl:master

.coveragerc

@@ -1,8 +1,10 @@
 # .coveragerc to control coverage.py
 [run]
 branch = True
+source = jsonpatch
 
 [report]
+show_missing = True
 # Regexes for lines to exclude from consideration
 exclude_lines =
     # Have to re-enable the standard pragma

.github/workflows/test.yaml

@@ -0,0 +1,34 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["2.7", "3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install coveralls
+#      - name: Lint with flake8
+#        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          # flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test
+        run: |
+          coverage run --source=jsonpointer tests.py

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: docs/requirements.txt

LICENSE

@@ -0,0 +1,11 @@
+Copyright (c) 2011 Stefan Kögl <[email protected]>
+
+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. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.

MANIFEST.in

@@ -4,3 +4,4 @@ include README.md
 include tests.py
 include ext_tests.py
 include AUTHORS
+include tests.js

README.md

@@ -1,18 +1,24 @@
-python-json-patch [![Build Status](https://secure.travis-ci.org/stefankoegl/python-json-patch.png?branch=master)](https://travis-ci.org/stefankoegl/python-json-patch) [![Coverage Status](https://coveralls.io/repos/stefankoegl/python-json-patch/badge.png?branch=master)](https://coveralls.io/r/stefankoegl/python-json-patch?branch=master) ![Downloads](https://pypip.in/d/jsonpatch/badge.png) ![Version](https://pypip.in/v/jsonpatch/badge.png)
+python-json-patch
 =================
+
+[![PyPI version](https://img.shields.io/pypi/v/jsonpatch.svg)](https://pypi.python.org/pypi/jsonpatch/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/jsonpatch.svg)](https://pypi.python.org/pypi/jsonpatch/)
+[![Build Status](https://travis-ci.org/stefankoegl/python-json-patch.png?branch=master)](https://travis-ci.org/stefankoegl/python-json-patch)
+[![Coverage Status](https://coveralls.io/repos/stefankoegl/python-json-patch/badge.png?branch=master)](https://coveralls.io/r/stefankoegl/python-json-patch?branch=master)
+
 Applying JSON Patches in Python
 -------------------------------
 
 Library to apply JSON Patches according to
 [RFC 6902](http://tools.ietf.org/html/rfc6902)
 
-See Sourcecode for Examples
+See source code for examples
 
 * Website: https://github.com/stefankoegl/python-json-patch
 * Repository: https://github.com/stefankoegl/python-json-patch.git
 * Documentation: https://python-json-patch.readthedocs.org/
 * PyPI: https://pypi.python.org/pypi/jsonpatch
-* Travis-CI: https://travis-ci.org/stefankoegl/python-json-patch
+* Travis CI: https://travis-ci.org/stefankoegl/python-json-patch
 * Coveralls: https://coveralls.io/r/stefankoegl/python-json-patch
 
 Running external tests

bin/jsondiff

@@ -4,7 +4,6 @@
 from __future__ import print_function
 
 import sys
-import os.path
 import json
 import jsonpatch
 import argparse
@@ -15,6 +14,8 @@ parser.add_argument('FILE1', type=argparse.FileType('r'))
 parser.add_argument('FILE2', type=argparse.FileType('r'))
 parser.add_argument('--indent', type=int, default=None,
                     help='Indent output by n spaces')
+parser.add_argument('-u', '--preserve-unicode', action='store_true',
+                    help='Output Unicode character as-is without using Code Point')
 parser.add_argument('-v', '--version', action='version',
                     version='%(prog)s ' + jsonpatch.__version__)
 
@@ -32,8 +33,9 @@ def diff_files():
     doc1 = json.load(args.FILE1)
     doc2 = json.load(args.FILE2)
     patch = jsonpatch.make_patch(doc1, doc2)
-    print(json.dumps(patch.patch, indent=args.indent))
-
+    if patch.patch:
+        print(json.dumps(patch.patch, indent=args.indent, ensure_ascii=not(args.preserve_unicode)))
+        sys.exit(1)
 
 if __name__ == "__main__":
     main()

bin/jsonpatch

@@ -24,7 +24,8 @@ parser.add_argument('-i', '--in-place', action='store_true',
                     help='Modify ORIGINAL in-place instead of to stdout')
 parser.add_argument('-v', '--version', action='version',
                     version='%(prog)s ' + jsonpatch.__version__)
-
+parser.add_argument('-u', '--preserve-unicode', action='store_true',
+                    help='Output Unicode character as-is without using Code Point')
 
 def main():
     try:
@@ -72,8 +73,8 @@ def patch_files():
 
     # By this point we have some sort of file object we can write the 
     # modified JSON to.
-
-    json.dump(result, fp, indent=args.indent)
+    
+    json.dump(result, fp, indent=args.indent, ensure_ascii=not(args.preserve_unicode))
     fp.write('\n')
 
     if args.in_place:

doc/commandline.rst

@@ -10,7 +10,7 @@ The JSON patch package contains the commandline utilities ``jsondiff`` and
 The program ``jsondiff`` can be used to create a JSON patch by comparing two
 JSON files ::
 
-    usage: jsondiff [-h] [--indent INDENT] [-v] FILE1 FILE2
+    usage: jsondiff [-h] [--indent INDENT] [-u] [-v] FILE1 FILE2
 
     Diff two JSON files
 
@@ -19,9 +19,10 @@ JSON files ::
       FILE2
 
     optional arguments:
-      -h, --help       show this help message and exit
-      --indent INDENT  Indent output by n spaces
-      -v, --version    show program's version number and exit
+      -h, --help             show this help message and exit
+      --indent INDENT        Indent output by n spaces
+      -u, --preserve-unicode Output Unicode character as-is without using Code Point
+      -v, --version          show program's version number and exit
 
 Example
 ^^^^^^^
@@ -74,10 +75,12 @@ The program ``jsonpatch`` is used to apply JSON patches on JSON files. ::
       PATCH            Patch file
 
     optional arguments:
-      -h, --help       show this help message and exit
-      --indent INDENT  Indent output by n spaces
-      -v, --version    show program's version number and exit
-
+     -h, --help             show this help message and exit
+     --indent INDENT        Indent output by n spaces
+     -b, --backup           Back up ORIGINAL if modifying in-place
+     -i, --in-place         Modify ORIGINAL in-place instead of to stdout
+     -v, --version          show program's version number and exit
+     -u, --preserve-unicode Output Unicode character as-is without using Code Point
 
 Example
 ^^^^^^^

doc/index.rst

@@ -6,10 +6,15 @@
 python-json-patch
 =================
 
-*python-json-patch* is a Python library for applying JSON patches (`RFC
-6902 <http://tools.ietf.org/html/rfc6902>`_). Python 2.6, 2.7, 3.2, 3.3
-and PyPy are supported.
-
+`python-json-patch <https://github.com/stefankoegl/python-json-patch>`_
+is a Python library for applying JSON patches (`RFC 6902
+<http://tools.ietf.org/html/rfc6902>`_). Python 2.7 and 3.4+ are
+supported. Tests are run on both CPython and PyPy.
+
+**Installation**
+.. code-block:: bash
+  $ pip install jsonpatch
+..
 
 **Contents**
 

doc/tutorial.rst

@@ -67,3 +67,55 @@ explicitly.
     # or from a list
     >>> patch = [{'op': 'add', 'path': '/baz', 'value': 'qux'}]
     >>> res = jsonpatch.apply_patch(obj, patch)
+
+
+Dealing with Custom Types
+-------------------------
+
+Custom JSON dump and load functions can be used to support custom types such as
+`decimal.Decimal`. The following examples shows how the
+`simplejson <https://simplejson.readthedocs.io/>`_ package, which has native
+support for Python's ``Decimal`` type, can be used to create a custom
+``JsonPatch`` subclass with ``Decimal`` support:
+
+.. code-block:: python
+
+    >>> import decimal
+    >>> import simplejson
+
+    >>> class DecimalJsonPatch(jsonpatch.JsonPatch):
+            @staticmethod
+            def json_dumper(obj):
+                return simplejson.dumps(obj)
+
+            @staticmethod
+            def json_loader(obj):
+                return simplejson.loads(obj, use_decimal=True,
+                                        object_pairs_hook=jsonpatch.multidict)
+
+    >>> src = {}
+    >>> dst = {'bar': decimal.Decimal('1.10')}
+    >>> patch = DecimalJsonPatch.from_diff(src, dst)
+    >>> doc = {'foo': 1}
+    >>> result = patch.apply(doc)
+    {'foo': 1, 'bar': Decimal('1.10')}
+
+Instead of subclassing it is also possible to pass a dump function to
+``from_diff``:
+
+    >>> patch = jsonpatch.JsonPatch.from_diff(src, dst, dumps=simplejson.dumps)
+
+a dumps function to ``to_string``:
+
+    >>> serialized_patch = patch.to_string(dumps=simplejson.dumps)
+    '[{"op": "add", "path": "/bar", "value": 1.10}]'
+
+and load  function to ``from_string``:
+
+    >>> import functools
+    >>> loads = functools.partial(simplejson.loads, use_decimal=True,
+                                  object_pairs_hook=jsonpatch.multidict)
+    >>> patch.from_string(serialized_patch, loads=loads)
+    >>> doc = {'foo': 1}
+    >>> result = patch.apply(doc)
+    {'foo': 1, 'bar': Decimal('1.10')}

ext_tests.py

@@ -34,7 +34,6 @@
 """ Script to run external tests, eg from
 https://github.com/json-patch/json-patch-tests """
 
-from functools import partial
 import doctest
 import unittest
 import jsonpatch
@@ -60,12 +59,15 @@ def _test(self, test):
                 )
 
         else:
-            res = jsonpatch.apply_patch(test['doc'], test['patch'])
+            try:
+                res = jsonpatch.apply_patch(test['doc'], test['patch'])
+            except jsonpatch.JsonPatchException as jpe:
+                raise Exception(test.get('comment', '')) from jpe
 
             # if there is no 'expected' we only verify that applying the patch
-            # does not raies an exception
+            # does not raise an exception
             if 'expected' in test:
-                self.assertEquals(res, test['expected'])
+                self.assertEqual(res, test['expected'], test.get('comment', ''))
 
 
 def make_test_case(tests):
@@ -112,24 +114,25 @@ def get_suite(filenames):
 
 try:
     import coverage
+    cov = coverage.Coverage()
 except ImportError:
-    coverage = None
+    cov = None
 
-if coverage is not None:
-    coverage.erase()
-    coverage.start()
+if cov is not None:
+    cov.erase()
+    cov.start()
 
 result = runner.run(suite)
 
 if not result.wasSuccessful():
     sys.exit(1)
 
-if coverage is not None:
-    coverage.stop()
-    coverage.report(coverage_modules)
-    coverage.erase()
+if cov is not None:
+    cov.stop()
+    cov.report(coverage_modules)
+    cov.erase()
 
-if coverage is None:
+if cov is None:
     sys.stderr.write("""
 No coverage reporting done (Python module "coverage" is missing)
 Please install the python-coverage package to get coverage reporting.