Skip to content

Commit

Permalink
gh-113149: Improve error message when JSON has trailing comma (GH-113227
Browse files Browse the repository at this point in the history
)
  • Loading branch information
carsonRadtke authored Dec 17, 2023
1 parent 21d5299 commit cfa25fe
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 3 deletions.
7 changes: 7 additions & 0 deletions Lib/json/decoder.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,13 @@ def JSONObject(s_and_end, strict, scan_once, object_hook, object_pairs_hook,
break
elif nextchar != ',':
raise JSONDecodeError("Expecting ',' delimiter", s, end - 1)
comma_idx = end - 1
end = _w(s, end).end()
nextchar = s[end:end + 1]
end += 1
if nextchar != '"':
if nextchar == '}':
raise JSONDecodeError("Illegal trailing comma before end of object", s, comma_idx)
raise JSONDecodeError(
"Expecting property name enclosed in double quotes", s, end - 1)
if object_pairs_hook is not None:
Expand Down Expand Up @@ -240,13 +243,17 @@ def JSONArray(s_and_end, scan_once, _w=WHITESPACE.match, _ws=WHITESPACE_STR):
break
elif nextchar != ',':
raise JSONDecodeError("Expecting ',' delimiter", s, end - 1)
comma_idx = end - 1
try:
if s[end] in _ws:
end += 1
if s[end] in _ws:
end = _w(s, end + 1).end()
nextchar = s[end:end + 1]
except IndexError:
pass
if nextchar == ']':
raise JSONDecodeError("Illegal trailing comma before end of array", s, comma_idx)

return values, end

Expand Down
8 changes: 5 additions & 3 deletions Lib/test/test_json/test_fail.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ def test_unexpected_data(self):
('{"spam":[}', 'Expecting value', 9),
('[42:', "Expecting ',' delimiter", 3),
('[42 "spam"', "Expecting ',' delimiter", 4),
('[42,]', 'Expecting value', 4),
('[42,]', "Illegal trailing comma before end of array", 3),
('{"spam":[42}', "Expecting ',' delimiter", 11),
('["]', 'Unterminated string starting at', 1),
('["spam":', "Expecting ',' delimiter", 7),
('["spam",]', 'Expecting value', 8),
('["spam",]', "Illegal trailing comma before end of array", 7),
('{:', 'Expecting property name enclosed in double quotes', 1),
('{,', 'Expecting property name enclosed in double quotes', 1),
('{42', 'Expecting property name enclosed in double quotes', 1),
Expand All @@ -159,7 +159,9 @@ def test_unexpected_data(self):
('[{"spam":]', 'Expecting value', 9),
('{"spam":42 "ham"', "Expecting ',' delimiter", 11),
('[{"spam":42]', "Expecting ',' delimiter", 11),
('{"spam":42,}', 'Expecting property name enclosed in double quotes', 11),
('{"spam":42,}', "Illegal trailing comma before end of object", 10),
('{"spam":42 , }', "Illegal trailing comma before end of object", 11),
('[123 , ]', "Illegal trailing comma before end of array", 6),
]
for data, msg, idx in test_cases:
with self.assertRaises(self.JSONDecodeError) as cm:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Improve error message when a JSON array or object contains a trailing comma.
Patch by Carson Radtke.
14 changes: 14 additions & 0 deletions Modules/_json.c
Original file line number Diff line number Diff line change
Expand Up @@ -662,6 +662,7 @@ _parse_object_unicode(PyScannerObject *s, PyObject *memo, PyObject *pystr, Py_ss
PyObject *key = NULL;
int has_pairs_hook = (s->object_pairs_hook != Py_None);
Py_ssize_t next_idx;
Py_ssize_t comma_idx;

str = PyUnicode_DATA(pystr);
kind = PyUnicode_KIND(pystr);
Expand Down Expand Up @@ -741,10 +742,16 @@ _parse_object_unicode(PyScannerObject *s, PyObject *memo, PyObject *pystr, Py_ss
raise_errmsg("Expecting ',' delimiter", pystr, idx);
goto bail;
}
comma_idx = idx;
idx++;

/* skip whitespace after , delimiter */
while (idx <= end_idx && IS_WHITESPACE(PyUnicode_READ(kind, str, idx))) idx++;

if (idx <= end_idx && PyUnicode_READ(kind, str, idx) == '}') {
raise_errmsg("Illegal trailing comma before end of object", pystr, comma_idx);
goto bail;
}
}
}

Expand Down Expand Up @@ -785,6 +792,7 @@ _parse_array_unicode(PyScannerObject *s, PyObject *memo, PyObject *pystr, Py_ssi
PyObject *val = NULL;
PyObject *rval;
Py_ssize_t next_idx;
Py_ssize_t comma_idx;

rval = PyList_New(0);
if (rval == NULL)
Expand Down Expand Up @@ -822,10 +830,16 @@ _parse_array_unicode(PyScannerObject *s, PyObject *memo, PyObject *pystr, Py_ssi
raise_errmsg("Expecting ',' delimiter", pystr, idx);
goto bail;
}
comma_idx = idx;
idx++;

/* skip whitespace after , */
while (idx <= end_idx && IS_WHITESPACE(PyUnicode_READ(kind, str, idx))) idx++;

if (idx <= end_idx && PyUnicode_READ(kind, str, idx) == ']') {
raise_errmsg("Illegal trailing comma before end of array", pystr, comma_idx);
goto bail;
}
}
}

Expand Down

0 comments on commit cfa25fe

Please sign in to comment.