jsonpointer 3.2.1__tar.gz → 3.4__tar.gz

{jsonpointer-3.2.1/jsonpointer.egg-info → jsonpointer-3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jsonpointer
-Version: 3.2.1
+Version: 3.4
 Summary:  Identify specific nodes in a JSON document (RFC 6901) 
 Home-page: https://github.com/stefankoegl/python-json-pointer
 Author: Stefan Kögl

{jsonpointer-3.2.1 → jsonpointer-3.4}/bin/jsonpointer

@@ -27,6 +27,8 @@ parser.add_argument('FILE', type=str, nargs='+',
                     help='Files for which the pointer should be resolved')
 parser.add_argument('--indent', type=int, default=None,
                     help='Indent output by n spaces')
+parser.add_argument('--continue-on-error', action='store_true',
+                    help='Continue with remaining files after JSON or text decoding errors')
 parser.add_argument('-v', '--version', action='version',
                     version='%(prog)s ' + jsonpointer.__version__)
 
@@ -77,8 +79,8 @@ def parse_pointer(args):
 def resolve_files():
     """ Resolve a JSON pointer on JSON files
 
-    Returns False if the pointer could not be resolved on at least one
-    file. """
+    Returns False if the pointer could not be resolved on at least one file,
+    or if --continue-on-error skipped a JSON or text decoding error. """
     args = parser.parse_args()
 
     ptr, files = parse_pointer(args)
@@ -90,7 +92,16 @@ def resolve_files():
         except argparse.ArgumentTypeError as e:
             parser.error(str(e))
 
-        doc = json.load(f)
+        try:
+            doc = json.load(f)
+        except (json.JSONDecodeError, UnicodeDecodeError) as e:
+            if not args.continue_on_error:
+                raise
+            print('Could not parse JSON in %r: %s' % (name, e),
+                  file=sys.stderr)
+            ok = False
+            continue
+
         try:
             result = jsonpointer.resolve_pointer(doc, ptr)
             print(json.dumps(result, indent=args.indent))

{jsonpointer-3.2.1 → jsonpointer-3.4/jsonpointer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jsonpointer
-Version: 3.2.1
+Version: 3.4
 Summary:  Identify specific nodes in a JSON document (RFC 6901) 
 Home-page: https://github.com/stefankoegl/python-json-pointer
 Author: Stefan Kögl

{jsonpointer-3.2.1 → jsonpointer-3.4}/jsonpointer.py

@@ -32,7 +32,7 @@
 
 # Will be parsed by setup.py to determine package metadata
 __author__ = 'Stefan Kögl <stefan@skoegl.net>'
-__version__ = '3.2.1'
+__version__ = '3.4'
 __website__ = 'https://github.com/stefankoegl/python-json-pointer'
 __license__ = 'Modified BSD License'
 
@@ -48,12 +48,17 @@ _nothing = object()
 VERBOSE_EXCEPTIONS = True
 
 
-def set_pointer(doc, pointer, value, inplace=True):
+def set_pointer(doc, pointer, value, inplace=True, create=False):
     """Resolves a 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.
 
+    With create set to true, missing intermediate members are created as
+    dicts instead of raising a JsonPointerException. A missing intermediate
+    array element can be created by referencing the end of the array, either
+    with "-" or with an index equal to the length of the array.
+
     >>> obj = {'foo': {'anArray': [ {'prop': 44}], 'another prop': {'baz': 'A string' }}}
 
     >>> set_pointer(obj, '/foo/anArray/0/prop', 55) == \
@@ -68,10 +73,14 @@ def set_pointer(doc, pointer, value, inplace=True):
     >>> set_pointer(obj, '/foo/a%20b', 'x') == \
     {'foo': {'a%20b': 'x' }}
     True
+
+    >>> set_pointer({}, '/cat/name', 'whiskers', create=True) == \
+    {'cat': {'name': 'whiskers'}}
+    True
     """
 
     pointer = JsonPointer(pointer)
-    return pointer.set(doc, value, inplace)
+    return pointer.set(doc, value, inplace, create)
 
 
 def resolve_pointer(doc, pointer, default=_nothing):
@@ -200,8 +209,11 @@ class JsonPointer:
 
     get = resolve
 
-    def set(self, doc, value, inplace=True):
-        """Resolve the pointer against the doc and replace the target with value."""
+    def set(self, doc, value, inplace=True, create=False):
+        """Resolve the pointer against the doc and replace the target with value.
+
+        With create set to true, missing intermediate members are created as
+        dicts (see set_pointer)."""
 
         if len(self.parts) == 0:
             if inplace:
@@ -211,20 +223,67 @@ class JsonPointer:
         if not inplace:
             doc = copy.deepcopy(doc)
 
-        (parent, part) = self.to_last(doc)
+        if create:
+            parent = doc
+            for i, part in enumerate(self.parts[:-1]):
+                part = self._get_create_part(parent, part)
+                if self._is_missing(parent, part):
+                    # Everything below this point is new, so build the
+                    # missing structure detached and attach it in one step.
+                    # This leaves doc unchanged if anything goes wrong.
+                    child = value
+                    for missing in reversed(self.parts[i + 1:]):
+                        child = {missing: child}
+                    self._set_child(parent, part, child)
+                    return doc
+                parent = self.walk(parent, part)
+            part = self._get_create_part(parent, self.parts[-1])
+        else:
+            (parent, part) = self.to_last(doc)
+
+        self._set_child(parent, part, value)
+        return doc
+
+    @classmethod
+    def _get_create_part(cls, doc, part):
+        """Like get_part, but maps an index just past the end of a sequence
+        to "-" so that it is appended"""
+
+        part = cls.get_part(doc, part)
+        if isinstance(doc, Sequence) and part == len(doc):
+            return '-'
+        return part
+
+    @staticmethod
+    def _is_missing(doc, part):
+        """Returns True if part does not exist in doc but could be added"""
+
+        if isinstance(doc, Mapping):
+            return part not in doc
+
+        if isinstance(doc, Sequence) and not isinstance(doc, str):
+            return part == '-'
+
+        return False
+
+    @staticmethod
+    def _set_child(parent, part, value):
+        """Sets parent[part] to value, appending for the end of a sequence"""
 
         if isinstance(parent, str):
             raise JsonPointerException("Cannot set value in a string")
         elif isinstance(parent, Sequence) and part == '-':
-            parent.append(value)
+            try:
+                parent.append(value)
+            except AttributeError as e:
+                # immutable sequences, such as tuples, can't be appended to
+                raise JsonPointerException("Invalid assignment target: %s" % (e,))
         else:
             try:
                 parent[part] = value
             except (TypeError, IndexError) as e:
                 raise JsonPointerException("Invalid assignment target: %s" % (e,))
 
-        return doc
-
     @classmethod
     def get_part(cls, doc, part):
         """Returns the next step in the correct type"""
@@ -307,7 +366,7 @@ class JsonPointer:
             suffix_parts = suffix
         try:
             return self.__class__.from_parts(chain(self.parts, suffix_parts))
-        except:  # noqa E722
+        except Exception:
             raise JsonPointerException("Invalid suffix")
 
     def __truediv__(self, suffix):

{jsonpointer-3.2.1 → jsonpointer-3.4}/tests.py

@@ -196,6 +196,19 @@ class ComparisonTests(unittest.TestCase):
         ptr12e = self.ptr1 / ["a", "b"]
         self.assertEqual(ptr12e.path, "/a/b/c/a/b")
 
+    def test_join_preserves_control_flow_exceptions(self):
+        for exception_type in (KeyboardInterrupt, SystemExit, GeneratorExit):
+            with self.subTest(exception_type=exception_type):
+                error = exception_type()
+
+                def parts():
+                    yield 'valid'
+                    raise error
+
+                with self.assertRaises(exception_type) as caught:
+                    self.ptr1.join(parts())
+                self.assertIs(caught.exception, error)
+
     def test_join_subclass(self):
         class Pointer(JsonPointer):
             pass
@@ -373,6 +386,69 @@ class SetTests(unittest.TestCase):
 
         self.assertRaises(JsonPointerException, set_pointer, doc, "", 9)
 
+    def test_set_create(self):
+        doc = {}
+        set_pointer(doc, "/cat/name", "whiskers", create=True)
+        self.assertEqual(doc, {"cat": {"name": "whiskers"}})
+
+        doc = {"cities": {"NewYork": "0"}}
+        set_pointer(doc, "/cities/LosAngeles/population", "4mln", create=True)
+        self.assertEqual(doc, {"cities": {
+            "NewYork": "0",
+            "LosAngeles": {"population": "4mln"},
+        }})
+
+        # existing members are kept
+        set_pointer(doc, "/cities/LosAngeles/area", 1302, create=True)
+        self.assertEqual(doc["cities"]["LosAngeles"],
+                         {"population": "4mln", "area": 1302})
+
+    def test_set_create_not_inplace(self):
+        doc = {"a": {}}
+        newdoc = set_pointer(doc, "/a/b/c", 1, inplace=False, create=True)
+        self.assertEqual(newdoc, {"a": {"b": {"c": 1}}})
+        self.assertEqual(doc, {"a": {}})
+
+    def test_set_create_list(self):
+        doc = {"foo": []}
+        set_pointer(doc, "/foo/-/bar", 1, create=True)
+        self.assertEqual(doc, {"foo": [{"bar": 1}]})
+
+        set_pointer(doc, "/foo/1/bar", 2, create=True)
+        self.assertEqual(doc, {"foo": [{"bar": 1}, {"bar": 2}]})
+
+        set_pointer(doc, "/foo/0/baz", 3, create=True)
+        self.assertEqual(doc, {"foo": [{"bar": 1, "baz": 3}, {"bar": 2}]})
+
+        set_pointer(doc, "/foo/2", 4, create=True)
+        self.assertEqual(doc, {"foo": [{"bar": 1, "baz": 3}, {"bar": 2}, 4]})
+
+    def test_set_create_invalid(self):
+        doc = {"foo": [1], "s": "str"}
+        # indices past the end of a list can't be created
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/foo/5/bar", 1, create=True)
+        # nothing can be created inside a string
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/s/bar/baz", 1, create=True)
+        self.assertEqual(doc, {"foo": [1], "s": "str"})
+
+    def test_set_create_immutable_sequence(self):
+        doc = {"items": ()}
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/items/0/leaf", 7, create=True)
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/items/0", 7, create=True)
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/items/-", 7)
+        self.assertEqual(doc, {"items": ()})
+
+    def test_set_create_off_by_default(self):
+        doc = {}
+        self.assertRaises(JsonPointerException, set_pointer, doc,
+                          "/cat/name", "whiskers")
+        self.assertEqual(doc, {})
+
 
 class AltTypesTests(unittest.TestCase):
     class Node(object):
@@ -494,7 +570,7 @@ class CommandLineTests(unittest.TestCase):
             f.write(content)
 
     def _run(self, *args):
-        env = dict(os.environ, PYTHONPATH=self.ROOT)
+        env = dict(os.environ, PYTHONPATH=self.ROOT, PYTHONUTF8='1')
         return subprocess.run([sys.executable, self.SCRIPT] + list(args),
                               cwd=self.dir, env=env, capture_output=True,
                               text=True)
@@ -571,6 +647,92 @@ class CommandLineTests(unittest.TestCase):
         self.assertIn('Could not resolve pointer', proc.stderr)
         self.assertEqual(proc.stdout, '1\n')
 
+    def test_invalid_json(self):
+        for content in ('', '{"a": }', '{"a": 1}\n{"a": 2}'):
+            with self.subTest(content=content):
+                self._write('invalid.json', content)
+                proc = self._run('--continue-on-error', '/a', 'invalid.json')
+                self.assertEqual(proc.returncode, 1)
+                self.assertEqual(proc.stdout, '')
+                self.assertIn("Could not parse JSON in 'invalid.json':",
+                              proc.stderr)
+                self.assertIn('line ', proc.stderr)
+                self.assertNotIn('Traceback', proc.stderr)
+
+    def test_invalid_json_in_one_file(self):
+        self._write('invalid.json', '{"a": }')
+        for index in range(3):
+            with self.subTest(index=index):
+                files = ['a.json', 'b.json']
+                files.insert(index, 'invalid.json')
+                proc = self._run('--continue-on-error', '/a', *files)
+                self.assertEqual(proc.returncode, 1)
+                self.assertEqual(proc.stdout, self.A_OUT + self.B_OUT)
+                self.assertIn("Could not parse JSON in 'invalid.json':",
+                              proc.stderr)
+                self.assertNotIn('Traceback', proc.stderr)
+
+    def test_invalid_json_and_unresolvable_pointer(self):
+        self._write('invalid.json', '{"a": }')
+        proc = self._run('--continue-on-error', '/b',
+                         'invalid.json', 'a.json', 'b.json')
+        self.assertEqual(proc.returncode, 1)
+        self.assertEqual(proc.stdout, '1\n')
+        self.assertIn("Could not parse JSON in 'invalid.json':", proc.stderr)
+        self.assertIn('Could not resolve pointer:', proc.stderr)
+        self.assertNotIn('Traceback', proc.stderr)
+
+    def test_invalid_json_stops_without_continue_on_error(self):
+        self._write('invalid.json', '{"a": }')
+        for index in range(3):
+            with self.subTest(index=index):
+                files = ['a.json', 'b.json']
+                files.insert(index, 'invalid.json')
+                proc = self._run('/a', *files)
+                self.assertEqual(proc.returncode, 1)
+                self.assertEqual(proc.stdout,
+                                 ''.join([self.A_OUT, self.B_OUT][:index]))
+                self.assertIn('JSONDecodeError', proc.stderr)
+
+    def test_invalid_encoding_in_one_file(self):
+        with open(os.path.join(self.dir, 'invalid.json'), 'wb') as f:
+            f.write(b'{"a":"\xff"}')
+        for index in range(3):
+            with self.subTest(index=index):
+                files = ['a.json', 'b.json']
+                files.insert(index, 'invalid.json')
+                proc = self._run('--continue-on-error', '/a', *files)
+                self.assertEqual(proc.returncode, 1)
+                self.assertEqual(proc.stdout, self.A_OUT + self.B_OUT)
+                self.assertIn("Could not parse JSON in 'invalid.json':",
+                              proc.stderr)
+                self.assertIn('decode', proc.stderr)
+                self.assertNotIn('Traceback', proc.stderr)
+
+    def test_invalid_encoding_stops_without_continue_on_error(self):
+        with open(os.path.join(self.dir, 'invalid.json'), 'wb') as f:
+            f.write(b'{"a":"\xff"}')
+        proc = self._run('/a', 'a.json', 'invalid.json', 'b.json')
+        self.assertEqual(proc.returncode, 1)
+        self.assertEqual(proc.stdout, self.A_OUT)
+        self.assertIn('UnicodeDecodeError', proc.stderr)
+
+    def test_continue_on_error_with_valid_files(self):
+        for pointer in (['/a'], ['-p', '/a'], ['-f', 'ptr.txt']):
+            with self.subTest(pointer=pointer):
+                proc = self._run('--continue-on-error', *pointer,
+                                 'a.json', 'b.json')
+                self.assertEqual(proc.returncode, 0, proc.stderr)
+                self.assertEqual(proc.stdout, self.A_OUT + self.B_OUT)
+                self.assertEqual(proc.stderr, '')
+
+    def test_continue_on_error_does_not_skip_missing_files(self):
+        proc = self._run('--continue-on-error', '/a',
+                         'a.json', 'missing.json', 'b.json')
+        self.assertEqual(proc.returncode, 2)
+        self.assertEqual(proc.stdout, self.A_OUT)
+        self.assertIn('missing.json', proc.stderr)
+
     def test_pointer_file_requires_value(self):
         proc = self._run('-f', '-p', '/a', 'a.json')
         self.assertEqual(proc.returncode, 2)