Summary

Add a function for performing a JSON Merge Patch.

Review Request #9262 — Created Oct. 11, 2017 and submitted Oct. 26, 2017, 2:10 a.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-0.10.x

Bugs

Depends On

Commit

bb5ba55...

Reviewers

Groups

djblets

People

Description

This introduces djblets.util.json_utils.json_merge_patch, an
implementation of JSON Merge Patch (RFC 7396), which is used to apply a
set of changes to a JSON-compatible data structure. Merge Patches allow
for adding new values (which may be complex JSON objects) to
dictionaries or arrays, remove keys from dictionaries or arrays, or
replace existing values.

This has additional support for access control around keys, preventing
certain keys from being replaced or added, optionally aborting the
patching process if encountered.

Testing Done

Unit tests pass.

Tested manually with several targets and dictionaries.

Issues

Description	From	Last Updated
It seems to me that if something fails halfway through we'll end up with a halfway applied patch. Do we …	david	Oct. 22, 2017, 10:35 p.m.
E127 continuation line over-indented for visual indent	reviewbot	Oct. 22, 2017, 10:36 p.m.

flake8 passed.

JSHint passed.

Change Summary:


Added/improved documentation.
Used keyword arguments when calling can_write_key_func.

Commit:

2df5486990a119cf5af496d1172aec8be28f01aa

705c1db6cf6ec30decb9688ef53fd6ae07117131

Diff:

Revision 2 (+313)

Show changes

	djblets/util/json_utils.py
	djblets/util/tests/test_json_utils.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/util/json_utils.py (Diff revision 2)

The issue has been resolved. Show all issues

It seems to me that if something fails halfway through we'll end up with a halfway applied patch. Do we want to change it to operate on a copy of the target and then replace at the very end?

chipx86 Oct. 21, 2017, 4:13 p.m.

It copies each level of the dictionary that's being modified. It doesn't modify the original dictionary.

chipx86 Oct. 21, 2017, 6:44 p.m.

Going to flesh out the unit tests to check that the original dictionary is untouched.

Change Summary:


Renamed the "target" attribute (and related variables/docs) to "doc", helping make it clear that the target itself isn't being modified.
Updated unit tests to sanity-check that no operations end up modifying the original document.

Commit:

705c1db6cf6ec30decb9688ef53fd6ae07117131

bb5ba552322a5994605d30cbc634ff6f38f5b35e

Diff:

Revision 3 (+366)

Show changes

	djblets/util/json_utils.py
	djblets/util/tests/test_json_utils.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/util/json_utils.py (Diff revision 3)
The issue has been resolved. Show all issues
```
E127 continuation line over-indented for visual indent
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-0.10.x (defeb39)