summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGenzer Hawker <genzers@gmail.com>2021-03-03 14:24:31 +0700
committerGenzer Hawker <genzers@gmail.com>2021-03-03 14:54:40 +0700
commit974d54f393de78ce21bee9897cee8f1ace5813ee (patch)
treee0eee3753a354820e913d6e2e7958a0d16f0d3e2
parentdbea3db33298da4ec41197b07612c42580e132e4 (diff)
downloadpython-json-patch-974d54f393de78ce21bee9897cee8f1ace5813ee.tar.gz
Add support for preserving Unicode characters in jsonpatch CLI
If the JSON content contains some Unicode characters, the jsonpatch final output will encode the Unicode character using ASCII (i.e `\u0394`). This behaviour comes from the module `json.dump()` governed by a flag `ensure_ascii`[1]. For example: ```json /* patch.json */ [{ "op": "add", "path": "/SomeUnicodeSamples", "value": "𝒞𝘋𝙴𝓕ĢȞỈ𝕵 đ áê 🤩 äÄöÖüÜß" }] ``` After applying the patch on an empty source file `{}`, this is the output: ```json {"SomeUnicodeSamples": "\ud835\udc9e\ud835\ude0b...\u00fc\u00dc\u00df"} ``` This commit adds a flag `-u|--preserve-unicode` in the jsonpatch CLI to configure the behaviour of `json.dump`'s `ensure_ascii` flag. Using the `--preserve-unicode` flag, the cli will print the Unicode characters as-is without any encoding. [1]: https://docs.python.org/3/library/json.html#basic-usage
-rwxr-xr-xbin/jsonpatch7
-rw-r--r--doc/commandline.rst10
2 files changed, 10 insertions, 7 deletions
diff --git a/bin/jsonpatch b/bin/jsonpatch
index 3f01738..a7adf29 100755
--- a/bin/jsonpatch
+++ b/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:
diff --git a/doc/commandline.rst b/doc/commandline.rst
index 5644d08..5fb9a3c 100644
--- a/doc/commandline.rst
+++ b/doc/commandline.rst
@@ -74,10 +74,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
^^^^^^^