gh-113744: Add a new IncompleteInputError exception to improve incomplete input detection in the codeop module (#113745)

pablogsal · web-flow · commit 39d102c2ee8e · 2024-01-30T16:21:30.000Z
Signed-off-by: Pablo Galindo &lt;pablogsal@gmail.com&gt;
diff --git a/Doc/data/stable_abi.dat b/Doc/data/stable_abi.dat
diff --git a/Include/pyerrors.h b/Include/pyerrors.h
@@ -108,6 +108,7 @@ PyAPI_DATA(PyObject *) PyExc_NotImplementedError;
 PyAPI_DATA(PyObject *) PyExc_SyntaxError;
 PyAPI_DATA(PyObject *) PyExc_IndentationError;
 PyAPI_DATA(PyObject *) PyExc_TabError;
+PyAPI_DATA(PyObject *) PyExc_IncompleteInputError;
 PyAPI_DATA(PyObject *) PyExc_ReferenceError;
 PyAPI_DATA(PyObject *) PyExc_SystemError;
 PyAPI_DATA(PyObject *) PyExc_SystemExit;
diff --git a/Lib/codeop.py b/Lib/codeop.py
@@ -65,9 +65,10 @@ def _maybe_compile(compiler, source, filename, symbol):
             try:
                 compiler(source + "\n", filename, symbol)
                 return None
+            except IncompleteInputError as e:
+                return None
             except SyntaxError as e:
-                if "incomplete input" in str(e):
-                    return None
+                pass
                 # fallthrough
 
     return compiler(source, filename, symbol, incomplete_input=False)
diff --git a/Lib/test/exception_hierarchy.txt b/Lib/test/exception_hierarchy.txt
@@ -44,6 +44,7 @@ BaseException
       ├── StopAsyncIteration
       ├── StopIteration
       ├── SyntaxError
+      │    └── IncompleteInputError
       │    └── IndentationError
       │         └── TabError
       ├── SystemError
diff --git a/Lib/test/test_pickle.py b/Lib/test/test_pickle.py
@@ -567,7 +567,8 @@ def test_exceptions(self):
                            RecursionError,
                            EncodingWarning,
                            BaseExceptionGroup,
-                           ExceptionGroup):
+                           ExceptionGroup,
+                           IncompleteInputError):
                     continue
                 if exc is not OSError and issubclass(exc, OSError):
                     self.assertEqual(reverse_mapping('builtins', name),
diff --git a/Lib/test/test_stable_abi_ctypes.py b/Lib/test/test_stable_abi_ctypes.py
diff --git a/Misc/stable_abi.toml b/Misc/stable_abi.toml
@@ -2485,3 +2485,5 @@
 [function._Py_SetRefcnt]
     added = '3.13'
     abi_only = true
+[data.PyExc_IncompleteInputError]
+    added = '3.13'
diff --git a/Objects/exceptions.c b/Objects/exceptions.c
@@ -2566,6 +2566,11 @@ MiddlingExtendsException(PyExc_SyntaxError, IndentationError, SyntaxError,
 MiddlingExtendsException(PyExc_IndentationError, TabError, SyntaxError,
                          "Improper mixture of spaces and tabs.");
 
+/*
+ *    IncompleteInputError extends SyntaxError
+ */
+MiddlingExtendsException(PyExc_SyntaxError, IncompleteInputError, SyntaxError,
+                         "incomplete input.");
 
 /*
  *    LookupError extends Exception
@@ -3635,6 +3640,7 @@ static struct static_exception static_exceptions[] = {
 
     // Level 4: Other subclasses
     ITEM(IndentationError), // base: SyntaxError(Exception)
+    ITEM(IncompleteInputError), // base: SyntaxError(Exception)
     ITEM(IndexError),  // base: LookupError(Exception)
     ITEM(KeyError),  // base: LookupError(Exception)
     ITEM(ModuleNotFoundError), // base: ImportError(Exception)
diff --git a/PC/python3dll.c b/PC/python3dll.c
diff --git a/Parser/pegen.c b/Parser/pegen.c
@@ -844,7 +844,7 @@ _PyPegen_run_parser(Parser *p)
     if (res == NULL) {
         if ((p->flags & PyPARSE_ALLOW_INCOMPLETE_INPUT) &&  _is_end_of_source(p)) {
             PyErr_Clear();
-            return RAISE_SYNTAX_ERROR("incomplete input");
+            return _PyPegen_raise_error(p, PyExc_IncompleteInputError, 0, "incomplete input");
         }
         if (PyErr_Occurred() && !PyErr_ExceptionMatches(PyExc_SyntaxError)) {
             return NULL;
diff --git a/Tools/c-analyzer/cpython/globals-to-fix.tsv b/Tools/c-analyzer/cpython/globals-to-fix.tsv
@@ -197,6 +197,7 @@ Objects/exceptions.c	-	_PyExc_AttributeError	-
 Objects/exceptions.c	-	_PyExc_SyntaxError	-
 Objects/exceptions.c	-	_PyExc_IndentationError	-
 Objects/exceptions.c	-	_PyExc_TabError	-
+Objects/exceptions.c	-	_PyExc_IncompleteInputError	-
 Objects/exceptions.c	-	_PyExc_LookupError	-
 Objects/exceptions.c	-	_PyExc_IndexError	-
 Objects/exceptions.c	-	_PyExc_KeyError	-
@@ -261,6 +262,7 @@ Objects/exceptions.c	-	PyExc_AttributeError	-
 Objects/exceptions.c	-	PyExc_SyntaxError	-
 Objects/exceptions.c	-	PyExc_IndentationError	-
 Objects/exceptions.c	-	PyExc_TabError	-
+Objects/exceptions.c	-	PyExc_IncompleteInputError	-
 Objects/exceptions.c	-	PyExc_LookupError	-
 Objects/exceptions.c	-	PyExc_IndexError	-
 Objects/exceptions.c	-	PyExc_KeyError	-

Original file line number	Diff line number	Diff line change
`@@ -844,7 +844,7 @@ _PyPegen_run_parser(Parser *p)`
`844`	`844`	`if (res == NULL) {`
`845`	`845`	`if ((p->flags & PyPARSE_ALLOW_INCOMPLETE_INPUT) && _is_end_of_source(p)) {`
`846`	`846`	`PyErr_Clear();`
`847`		`- return RAISE_SYNTAX_ERROR("incomplete input");`
	`847`	`+ return _PyPegen_raise_error(p, PyExc_IncompleteInputError, 0, "incomplete input");`
`848`	`848`	`}`
`849`	`849`	`if (PyErr_Occurred() && !PyErr_ExceptionMatches(PyExc_SyntaxError)) {`
`850`	`850`	`return NULL;`