Issue #5067: improve some json error messages.

pitrou · pitrou · commit 802d669044b1 · 2012-06-29T01:59:54.000+02:00
Patch by Serhiy Storchaka.
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
@@ -99,7 +99,7 @@ Using json.tool from the shell to validate and pretty-print::
         "json": "obj"
     }
     $ echo '{1.2:3.4}' | python -mjson.tool
-    Expecting property name: line 1 column 1 (char 1)
+    Expecting property name enclosed in double quotes: line 1 column 1 (char 1)
 
 .. highlight:: python3
 
diff --git a/Lib/json/__init__.py b/Lib/json/__init__.py
@@ -97,7 +97,7 @@
         "json": "obj"
     }
     $ echo '{ 1.2:3.4}' | python -m json.tool
-    Expecting property name: line 1 column 2 (char 2)
+    Expecting property name enclosed in double quotes: line 1 column 2 (char 2)
 """
 __version__ = '2.0.9'
 __all__ = [
diff --git a/Lib/json/decoder.py b/Lib/json/decoder.py
@@ -172,7 +172,8 @@ def JSONObject(s_and_end, strict, scan_once, object_hook, object_pairs_hook,
                 pairs = object_hook(pairs)
             return pairs, end + 1
         elif nextchar != '"':
-            raise ValueError(errmsg("Expecting property name", s, end))
+            raise ValueError(errmsg(
+                "Expecting property name enclosed in double quotes", s, end))
     end += 1
     while True:
         key, end = scanstring(s, end, strict)
@@ -182,7 +183,7 @@ def JSONObject(s_and_end, strict, scan_once, object_hook, object_pairs_hook,
         if s[end:end + 1] != ':':
             end = _w(s, end).end()
             if s[end:end + 1] != ':':
-                raise ValueError(errmsg("Expecting : delimiter", s, end))
+                raise ValueError(errmsg("Expecting ':' delimiter", s, end))
         end += 1
 
         try:
@@ -210,12 +211,13 @@ def JSONObject(s_and_end, strict, scan_once, object_hook, object_pairs_hook,
         if nextchar == '}':
             break
         elif nextchar != ',':
-            raise ValueError(errmsg("Expecting , delimiter", s, end - 1))
+            raise ValueError(errmsg("Expecting ',' delimiter", s, end - 1))
         end = _w(s, end).end()
         nextchar = s[end:end + 1]
         end += 1
         if nextchar != '"':
-            raise ValueError(errmsg("Expecting property name", s, end - 1))
+            raise ValueError(errmsg(
+                "Expecting property name enclosed in double quotes", s, end - 1))
     if object_pairs_hook is not None:
         result = object_pairs_hook(pairs)
         return result, end
@@ -249,7 +251,7 @@ def JSONArray(s_and_end, scan_once, _w=WHITESPACE.match, _ws=WHITESPACE_STR):
         if nextchar == ']':
             break
         elif nextchar != ',':
-            raise ValueError(errmsg("Expecting , delimiter", s, end))
+            raise ValueError(errmsg("Expecting ',' delimiter", s, end))
         try:
             if s[end] in _ws:
                 end += 1
diff --git a/Lib/json/tool.py b/Lib/json/tool.py
@@ -7,7 +7,7 @@
         "json": "obj"
     }
     $ echo '{ 1.2:3.4}' | python -m json.tool
-    Expecting property name: line 1 column 2 (char 2)
+    Expecting property name enclosed in double quotes: line 1 column 2 (char 2)
 
 """
 import sys
diff --git a/Modules/_json.c b/Modules/_json.c
@@ -646,7 +646,7 @@ _parse_object_unicode(PyScannerObject *s, PyObject *pystr, Py_ssize_t idx, Py_ss
 
             /* read key */
             if (PyUnicode_READ(kind, str, idx) != '"') {
-                raise_errmsg("Expecting property name", pystr, idx);
+                raise_errmsg("Expecting property name enclosed in double quotes", pystr, idx);
                 goto bail;
             }
             key = scanstring_unicode(pystr, idx + 1, strict, &next_idx);
@@ -667,7 +667,7 @@ _parse_object_unicode(PyScannerObject *s, PyObject *pystr, Py_ssize_t idx, Py_ss
             /* skip whitespace between key and : delimiter, read :, skip whitespace */
             while (idx <= end_idx && IS_WHITESPACE(PyUnicode_READ(kind, str, idx))) idx++;
             if (idx > end_idx || PyUnicode_READ(kind, str, idx) != ':') {
-                raise_errmsg("Expecting : delimiter", pystr, idx);
+                raise_errmsg("Expecting ':' delimiter", pystr, idx);
                 goto bail;
             }
             idx++;
@@ -707,7 +707,7 @@ _parse_object_unicode(PyScannerObject *s, PyObject *pystr, Py_ssize_t idx, Py_ss
                 break;
             }
             else if (PyUnicode_READ(kind, str, idx) != ',') {
-                raise_errmsg("Expecting , delimiter", pystr, idx);
+                raise_errmsg("Expecting ',' delimiter", pystr, idx);
                 goto bail;
             }
             idx++;
@@ -797,7 +797,7 @@ _parse_array_unicode(PyScannerObject *s, PyObject *pystr, Py_ssize_t idx, Py_ssi
                 break;
             }
             else if (PyUnicode_READ(kind, str, idx) != ',') {
-                raise_errmsg("Expecting , delimiter", pystr, idx);
+                raise_errmsg("Expecting ',' delimiter", pystr, idx);
                 goto bail;
             }
             idx++;

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ Using json.tool from the shell to validate and pretty-print::`
`99`	`99`	`"json": "obj"`
`100`	`100`	`}`
`101`	`101`	`$ echo '{1.2:3.4}' \| python -mjson.tool`
`102`		`- Expecting property name: line 1 column 1 (char 1)`
	`102`	`+ Expecting property name enclosed in double quotes: line 1 column 1 (char 1)`
`103`	`103`
`104`	`104`	`.. highlight:: python3`
`105`	`105`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@`
`97`	`97`	`"json": "obj"`
`98`	`98`	`}`
`99`	`99`	`$ echo '{ 1.2:3.4}' \| python -m json.tool`
`100`		`- Expecting property name: line 1 column 2 (char 2)`
	`100`	`+ Expecting property name enclosed in double quotes: line 1 column 2 (char 2)`
`101`	`101`	`"""`
`102`	`102`	`__version__ = '2.0.9'`
`103`	`103`	`__all__ = [`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`"json": "obj"`
`8`	`8`	`}`
`9`	`9`	`$ echo '{ 1.2:3.4}' \| python -m json.tool`
`10`		`- Expecting property name: line 1 column 2 (char 2)`
	`10`	`+ Expecting property name enclosed in double quotes: line 1 column 2 (char 2)`
`11`	`11`
`12`	`12`	`"""`
`13`	`13`	`import sys`
Original file line number	Diff line number	Diff line change
`@@ -646,7 +646,7 @@ _parse_object_unicode(PyScannerObject s, PyObject pystr, Py_ssize_t idx, Py_ss`
`646`	`646`
`647`	`647`	`/* read key */`
`648`	`648`	`if (PyUnicode_READ(kind, str, idx) != '"') {`
`649`		`- raise_errmsg("Expecting property name", pystr, idx);`
	`649`	`+ raise_errmsg("Expecting property name enclosed in double quotes", pystr, idx);`
`650`	`650`	`goto bail;`
`651`	`651`	`}`
`652`	`652`	`key = scanstring_unicode(pystr, idx + 1, strict, &next_idx);`
`@@ -667,7 +667,7 @@ _parse_object_unicode(PyScannerObject s, PyObject pystr, Py_ssize_t idx, Py_ss`
`667`	`667`	`/* skip whitespace between key and : delimiter, read :, skip whitespace */`
`668`	`668`	`while (idx <= end_idx && IS_WHITESPACE(PyUnicode_READ(kind, str, idx))) idx++;`
`669`	`669`	`if (idx > end_idx \|\| PyUnicode_READ(kind, str, idx) != ':') {`
`670`		`- raise_errmsg("Expecting : delimiter", pystr, idx);`
	`670`	`+ raise_errmsg("Expecting ':' delimiter", pystr, idx);`
`671`	`671`	`goto bail;`
`672`	`672`	`}`
`673`	`673`	`idx++;`
`@@ -707,7 +707,7 @@ _parse_object_unicode(PyScannerObject s, PyObject pystr, Py_ssize_t idx, Py_ss`
`707`	`707`	`break;`
`708`	`708`	`}`
`709`	`709`	`else if (PyUnicode_READ(kind, str, idx) != ',') {`
`710`		`- raise_errmsg("Expecting , delimiter", pystr, idx);`
	`710`	`+ raise_errmsg("Expecting ',' delimiter", pystr, idx);`
`711`	`711`	`goto bail;`
`712`	`712`	`}`
`713`	`713`	`idx++;`
`@@ -797,7 +797,7 @@ _parse_array_unicode(PyScannerObject s, PyObject pystr, Py_ssize_t idx, Py_ssi`
`797`	`797`	`break;`
`798`	`798`	`}`
`799`	`799`	`else if (PyUnicode_READ(kind, str, idx) != ',') {`
`800`		`- raise_errmsg("Expecting , delimiter", pystr, idx);`
	`800`	`+ raise_errmsg("Expecting ',' delimiter", pystr, idx);`
`801`	`801`	`goto bail;`
`802`	`802`	`}`
`803`	`803`	`idx++;`