Skip to content

jsondiff/jsonpatch crash with a raw traceback on UTF-8 BOM files #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Qrytics wants to merge 1 commit into
base: master
Choose a base branch
from
Open

jsondiff/jsonpatch crash with a raw traceback on UTF-8 BOM files #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions jsonpatch_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@

jsondiff_parser = argparse.ArgumentParser(
prog='jsondiff', description='Diff two JSON files')
jsondiff_parser.add_argument('FILE1', type=argparse.FileType('r', encoding='utf-8'))
jsondiff_parser.add_argument('FILE2', type=argparse.FileType('r', encoding='utf-8'))
jsondiff_parser.add_argument('FILE1', type=argparse.FileType('r', encoding='utf-8-sig'))
jsondiff_parser.add_argument('FILE2', type=argparse.FileType('r', encoding='utf-8-sig'))
jsondiff_parser.add_argument('--indent', type=int, default=None,
help='Indent output by n spaces')
jsondiff_parser.add_argument('-u', '--preserve-unicode', action='store_true',
Expand Down Expand Up @@ -51,9 +51,9 @@ def diff_files():
jsonpatch_parser = argparse.ArgumentParser(
prog='jsonpatch',
description='Apply a JSON patch on a JSON file')
jsonpatch_parser.add_argument('ORIGINAL', type=argparse.FileType('r', encoding='utf-8'),
jsonpatch_parser.add_argument('ORIGINAL', type=argparse.FileType('r', encoding='utf-8-sig'),
help='Original file')
jsonpatch_parser.add_argument('PATCH', type=argparse.FileType('r', encoding='utf-8'),
jsonpatch_parser.add_argument('PATCH', type=argparse.FileType('r', encoding='utf-8-sig'),
nargs='?', default=sys.stdin,
help='Patch file (read from stdin if omitted)')
jsonpatch_parser.add_argument('--indent', type=int, default=None,
Expand Down
23 changes: 23 additions & 0 deletions tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3148,6 +3148,29 @@ def test_jsondiff_utf8_files_without_utf8_mode(self):
self.assertEqual(jsonpatch.apply_patch(self.read(src), patch),
self.read(dst))

def test_jsondiff_utf8_bom_files(self):
for path, value in (('a.json', {'a': 1}), ('b.json', {'a': 2})):
with open(os.path.join(self.dir, path), 'w', encoding='utf-8-sig') as f:
json.dump(value, f)
src = os.path.join(self.dir, 'a.json')
dst = os.path.join(self.dir, 'b.json')
res = self.run_script('jsondiff', src, dst)
# like diff, it exits with 1 if the files differ
self.assertEqual(res.returncode, 1, res.stderr)
patch = json.loads(res.stdout)
self.assertEqual(jsonpatch.apply_patch({'a': 1}, patch), {'a': 2})

def test_jsonpatch_utf8_bom_files(self):
doc = os.path.join(self.dir, 'doc.json')
patch = os.path.join(self.dir, 'patch.json')
with open(doc, 'w', encoding='utf-8-sig') as f:
json.dump({'a': 1}, f)
with open(patch, 'w', encoding='utf-8-sig') as f:
json.dump([{'op': 'replace', 'path': '/a', 'value': 2}], f)
res = self.run_script('jsonpatch', doc, patch)
self.assertEqual(res.returncode, 0, res.stderr)
self.assertEqual(json.loads(res.stdout), {'a': 2})

def test_jsonpatch(self):
doc = self.write('doc.json', {'a': [1, 2], 'b': 0})
patch = self.write('patch.json', [{'op': 'add', 'path': '/a/-', 'value': 3},
Expand Down