jsonyx.apply_patch

jsonyx.apply_patch(obj, patch, *, allow=NOTHING)

Apply a JSON patch to a Python object.

Added in version 2.0.

Changed in version 2.4: Removed use_decimal.

Parameters:

• obj (Any) – a Python object

• patch (_Operation | list[_Operation]) – a JSON patch

• allow (Container[str], default: NOTHING) – the JSON deviations from jsonyx.allow

Raises:

• AssertionError – if an assertion fails

• IndexError – if an index is out of range

• JSONSyntaxError – if a query is invalid

• KeyError – if a key is not found

• TypeError – if a value has the wrong type

• ValueError – if a value is invalid

Returns:

Any – the patched Python object

Example:

>>> import jsonyx as json
>>> json.apply_patch([1, 2, 3], {"op": "del", "path": "$[1]"})
[1, 3]

Tip

• A filter is more robust than an index.

• Use jsonyx.Manipulator directly for better performance.

See also

jsonyx.make_patch() for making a patch.