`IncompleteInputError` is undocumented #119521

JelleZijlstra · 2024-05-24T19:20:33Z

#113745 added a new built-in exception IncompleteInputError, but it is not mentioned anywhere in the docs (except in the auto-generated list of classes) or in the What's New. It should be documented. cc @pablogsal

Linked PRs

gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from stable ABI #119680
[3.13] gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from public API/ABI (GH-119680, GH-120955) #120944
gh-119521: Use PyAPI_DATA, not extern, for _PyExc_IncompleteInpu…tError #120955
gh-119521: Remove _IncompleteInputError from the docs #120993
[3.13] gh-119521: Remove _IncompleteInputError from the docs (GH-120993) #121076

The text was updated successfully, but these errors were encountered:

pablogsal · 2024-05-24T21:42:35Z

I don't want to document this as this is an implementation detail of the parser specially tailored for the codeop module. It is only raised when a very specific undocumented flag is passed to the parser to support better what the codeop module needs to do and I don't think we want users to depend on it.

JelleZijlstra · 2024-05-24T21:55:51Z

It's a builtin though. If we don't want this to be public, we shouldn't have put it in the builtins.

JelleZijlstra · 2024-05-24T22:12:15Z

Possibly the new exception should be given a dunder name (since dunder names are reserved for the language), or placed in some private extension module (maybe _ast?).

pablogsal · 2024-05-25T00:17:49Z

It's a builtin though. If we don't want this to be public, we shouldn't have put it in the builtins.

That's a side effect of being a subclass of SyntaxError that's available via the normal subclass in exceptions.c mechanism in a way that generates directly a type that we can use in the parser, unfortunately. Adding this to a module is much more complicated due to a bootstrapping problem with the parser (I need to double check if this is 100% the case so take this with a pinch of salt)

pablogsal · 2024-05-25T00:20:43Z

We can try to prepend a underscore to the name for sure.

I can try to investigate if there is an easy way to move it to some other hidden place when used via Python as well but IIRC it's a bit complex

pablogsal · 2024-05-25T16:20:58Z

Bad news: I dedicated some time to investigate and seems prepending the symbol with an underscore fails in macOS because prepending the symbol with an underscore triggers some linkage failure (doing any other alterations to the symbol name does not). Also, exceptions cannot be easily declared outside the Objects/exceptions.c module and even if they can there is a bootstrapping problem with the parser. We can proceed in two ways:

Remove the exception, make the parser raise some weird exception and somehow parse the message (very ugly and error prone).
Document the exception and say is an implementation detail.
Document the exception.
Somehow investigate if there is a way to override this problem with linkage

pablogsal · 2024-05-25T16:27:01Z

I may be possible that I am missing something obvious, but this diff:

ndex 68d7985dac8..0f71b1dcdb3 100644
--- a/Include/pyerrors.h
+++ b/Include/pyerrors.h
@@ -108,7 +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_IncompleteInputError;
 PyAPI_DATA(PyObject *) PyExc_ReferenceError;
 PyAPI_DATA(PyObject *) PyExc_SystemError;
 PyAPI_DATA(PyObject *) PyExc_SystemExit;
diff --git a/Lib/test/test_stable_abi_ctypes.py b/Lib/test/test_stable_abi_ctypes.py
index c06c285c501..446df809e9c 100644
--- a/Lib/test/test_stable_abi_ctypes.py
+++ b/Lib/test/test_stable_abi_ctypes.py
@@ -267,7 +267,7 @@ SYMBOL_NAMES = (
     "PyExc_IOError",
     "PyExc_ImportError",
     "PyExc_ImportWarning",
-    "PyExc_IncompleteInputError",
+    "_PyExc_IncompleteInputError",
     "PyExc_IndentationError",
     "PyExc_IndexError",
     "PyExc_InterruptedError",
diff --git a/Misc/stable_abi.toml b/Misc/stable_abi.toml
index 77473662aaa..597e8d24084 100644
--- a/Misc/stable_abi.toml
+++ b/Misc/stable_abi.toml
@@ -2480,7 +2480,7 @@
 [function._Py_SetRefcnt]
     added = '3.13'
     abi_only = true
-[data.PyExc_IncompleteInputError]
+[data._PyExc_IncompleteInputError]
     added = '3.13'
 [function.PyList_GetItemRef]
     added = '3.13'
diff --git a/PC/python3dll.c b/PC/python3dll.c
index 86c88843089..d72c87e1e9e 100755
--- a/PC/python3dll.c
+++ b/PC/python3dll.c
@@ -839,7 +839,7 @@ EXPORT_DATA(PyExc_FutureWarning)
 EXPORT_DATA(PyExc_GeneratorExit)
 EXPORT_DATA(PyExc_ImportError)
 EXPORT_DATA(PyExc_ImportWarning)
-EXPORT_DATA(PyExc_IncompleteInputError)
+EXPORT_DATA(_PyExc_IncompleteInputError)
 EXPORT_DATA(PyExc_IndentationError)
 EXPORT_DATA(PyExc_IndexError)
 EXPORT_DATA(PyExc_InterruptedError)
diff --git a/Parser/pegen.c b/Parser/pegen.c
index 3d3e6455940..ad462d25fda 100644
--- 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 _PyPegen_raise_error(p, PyExc_IncompleteInputError, 0, "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
index 8b6fe94e3af..b62f89a56ab 100644
--- a/Tools/c-analyzer/cpython/globals-to-fix.tsv
+++ b/Tools/c-analyzer/cpython/globals-to-fix.tsv
@@ -200,7 +200,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_IncompleteInputError    -
 Objects/exceptions.c   -       _PyExc_LookupError      -
 Objects/exceptions.c   -       _PyExc_IndexError       -
 Objects/exceptions.c   -       _PyExc_KeyError -
@@ -266,7 +266,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_IncompleteInputError     -
 Objects/exceptions.c   -       PyExc_LookupError       -
 Objects/exceptions.c   -       PyExc_IndexError        -
 Objects/exceptions.c   -       PyExc_KeyError  -
diff --git a/Objects/exceptions.c b/Objects/exceptions.c
index f9cd577c1c1..01c72956a8c 100644
--- a/Objects/exceptions.c
+++ b/Objects/exceptions.c
@@ -2606,9 +2606,9 @@ MiddlingExtendsException(PyExc_IndentationError, TabError, SyntaxError,
                          "Improper mixture of spaces and tabs.");

 /*
- *    IncompleteInputError extends SyntaxError
+ *    _IncompleteInputError extends SyntaxError
  */
-MiddlingExtendsException(PyExc_SyntaxError, IncompleteInputError, SyntaxError,
+MiddlingExtendsException(PyExc_SyntaxError, _IncompleteInputError, SyntaxError,
                          "incomplete input.");

 /*
@@ -3675,7 +3675,7 @@ static struct static_exception static_exceptions[] = {

     // Level 4: Other subclasses
     ITEM(IndentationError), // base: SyntaxError(Exception)
-    ITEM(IncompleteInputError), // base: SyntaxError(Exception)
+    ITEM(_IncompleteInputError), // base: SyntaxError(Exception)
     ITEM(IndexError),  // base: LookupError(Exception)
     ITEM(KeyError),  // base: LookupError(Exception)
     ITEM(ModuleNotFoundError), // base: ImportError(Exception)

fails with:

Undefined symbols for architecture arm64:
  "__PyExc_IncompleteInputError", referenced from:
      __PyPegen_run_parser in pegen.o
ld: symbol(s) not found for architecture arm64
clang: error: linker command failed with exit code 1 (use -v to see invocation)
make: *** [Programs/_freeze_module] Error 1

JelleZijlstra · 2024-05-27T22:49:40Z

We only want the Python-visible name to have an underscore (or two) though, the C name can stay. So I think you could manually expand the MiddlingExtendsException macro and use a different name for the C type name and the Python-visible __name__.

pablogsal · 2024-05-28T12:04:41Z

We only want the Python-visible name to have an underscore (or two) though, the C name can stay. So I think you could manually expand the MiddlingExtendsException macro and use a different name for the C type name and the Python-visible __name__.

I was a bit reluctant to add a new macro just for this but it seems that there is no much around this unfortunately

… and remove from stable ABI

pablogsal · 2024-05-28T18:38:20Z

I found a better way to solve this problem!

… and remove from stable ABI

… and remove from stable ABI Signed-off-by: Pablo Galindo <[email protected]>

…emove from public API/ABI (GH-119680) Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

… and remove from public API/ABI (pythonGH-119680) (cherry picked from commit ac61d58) Co-authored-by: Pablo Galindo Salgado <[email protected]> Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

…tError` (GH-120955)

…teInputError` (pythonGH-120955)

…r and remove from public API/ABI (GH-119680, GH-120955) (GH-120944) - gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from public API/ABI (GH-119680) (cherry picked from commit ce1064e) - gh-119521: Use `PyAPI_DATA`, not `extern`, for `_PyExc_IncompleteInputError` (GH-120955) (cherry picked from commit ac61d58) Co-authored-by: Pablo Galindo Salgado <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

encukou · 2024-06-25T10:40:09Z

The rename is merged, but looking at the issues again, I think we should also remove _IncompleteInputError from the docs.

…-120993) (cherry picked from commit 1167a9a) Co-authored-by: Petr Viktorin <[email protected]>

…) (GH-121076) gh-119521: Remove _IncompleteInputError from the docs (GH-120993) (cherry picked from commit 1167a9a) Co-authored-by: Petr Viktorin <[email protected]>

… and remove from public API/ABI (pythonGH-119680) Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

…teInputError` (pythonGH-120955)

…-120993)

…_IncompleteInputError'. See python/cpython#119521

… and remove from public API/ABI (pythonGH-119680) Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

…teInputError` (pythonGH-120955)

…-120993)

… and remove from public API/ABI (pythonGH-119680) Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

…teInputError` (pythonGH-120955)

…-120993)

JelleZijlstra added docs Documentation in the Doc dir 3.13 bugs and security fixes 3.14 new features, bugs and security fixes labels May 24, 2024

JelleZijlstra mentioned this issue May 24, 2024

builtins: updates for py313 python/typeshed#12028

Merged

JelleZijlstra added the deferred-blocker label May 24, 2024

ezio-melotti added this to Release and Deferred blockers 🚫 May 24, 2024

github-project-automation bot moved this to Todo in Release and Deferred blockers 🚫 May 24, 2024

pablogsal added a commit to pablogsal/cpython that referenced this issue May 28, 2024

pythongh-119521: Rename IncompleteInputError to _IncompleteInputError…

f15f2dd

… and remove from stable ABI

bedevere-app bot mentioned this issue May 28, 2024

gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from stable ABI #119680

Merged

pablogsal added a commit to pablogsal/cpython that referenced this issue May 28, 2024

pythongh-119521: Rename IncompleteInputError to _IncompleteInputError…

8f58081

… and remove from stable ABI

pablogsal added a commit to pablogsal/cpython that referenced this issue May 30, 2024

pythongh-119521: Rename IncompleteInputError to _IncompleteInputError…

edfed4d

… and remove from stable ABI Signed-off-by: Pablo Galindo <[email protected]>

encukou added a commit that referenced this issue Jun 24, 2024

gh-119521: Rename IncompleteInputError to _IncompleteInputError and r…

ac61d58

…emove from public API/ABI (GH-119680) Signed-off-by: Pablo Galindo <[email protected]> Co-authored-by: Petr Viktorin <[email protected]>

This was referenced Jun 24, 2024

[3.13] gh-119521: Rename IncompleteInputError to _IncompleteInputError and remove from public API/ABI (GH-119680, GH-120955) #120944

Merged

gh-119521: Use PyAPI_DATA, not extern, for _PyExc_IncompleteInpu…tError #120955

Merged

encukou added a commit that referenced this issue Jun 24, 2024

gh-119521: Use PyAPI_DATA, not extern, for `_PyExc_IncompleteInpu…

ce1064e

…tError` (GH-120955)

encukou added a commit to miss-islington/cpython that referenced this issue Jun 24, 2024

pythongh-119521: Use PyAPI_DATA, not extern, for `_PyExc_Incomple…

cf2fe14

…teInputError` (pythonGH-120955)

encukou added a commit to encukou/cpython that referenced this issue Jun 25, 2024

pythongh-119521: Remove _IncompleteInputError from the docs

0b51614

bedevere-app bot mentioned this issue Jun 25, 2024

gh-119521: Remove _IncompleteInputError from the docs #120993

Merged

encukou added a commit that referenced this issue Jun 27, 2024

gh-119521: Remove _IncompleteInputError from the docs (GH-120993)

1167a9a

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 27, 2024

pythongh-119521: Remove _IncompleteInputError from the docs (pythonGH…

af88ef1

…-120993) (cherry picked from commit 1167a9a) Co-authored-by: Petr Viktorin <[email protected]>

bedevere-app bot mentioned this issue Jun 27, 2024

[3.13] gh-119521: Remove _IncompleteInputError from the docs (GH-120993) #121076

Merged

encukou closed this as completed Jun 27, 2024

github-project-automation bot moved this from Todo to Done in Release and Deferred blockers 🚫 Jun 27, 2024

mrahtz pushed a commit to mrahtz/cpython that referenced this issue Jun 30, 2024

pythongh-119521: Use PyAPI_DATA, not extern, for `_PyExc_Incomple…

9c2601f

…teInputError` (pythonGH-120955)

mrahtz pushed a commit to mrahtz/cpython that referenced this issue Jun 30, 2024

pythongh-119521: Remove _IncompleteInputError from the docs (pythonGH…

8182d66

…-120993)

scoder added a commit to cython/cython that referenced this issue Jul 1, 2024

Looks like the Py3.13 builtin 'IncompleteInputError' was renamed to '…

6b8aa43

…_IncompleteInputError'. See python/cpython#119521

noahbkim pushed a commit to hudson-trading/cpython that referenced this issue Jul 11, 2024

pythongh-119521: Use PyAPI_DATA, not extern, for `_PyExc_Incomple…

fd3ca36

…teInputError` (pythonGH-120955)

noahbkim pushed a commit to hudson-trading/cpython that referenced this issue Jul 11, 2024

pythongh-119521: Remove _IncompleteInputError from the docs (pythonGH…

35a5060

…-120993)

estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024

pythongh-119521: Use PyAPI_DATA, not extern, for `_PyExc_Incomple…

4ef920b

…teInputError` (pythonGH-120955)

estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024

pythongh-119521: Remove _IncompleteInputError from the docs (pythonGH…

58cc958

…-120993)

Dec	JAN	Feb
	01
2024	2025	2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`IncompleteInputError` is undocumented #119521

`IncompleteInputError` is undocumented #119521

JelleZijlstra commented May 24, 2024 •

edited by bedevere-app bot

Loading

pablogsal commented May 24, 2024

JelleZijlstra commented May 24, 2024

JelleZijlstra commented May 24, 2024

pablogsal commented May 25, 2024 •

edited

Loading

pablogsal commented May 25, 2024 •

edited

Loading

pablogsal commented May 25, 2024

pablogsal commented May 25, 2024

JelleZijlstra commented May 27, 2024

pablogsal commented May 28, 2024

pablogsal commented May 28, 2024

encukou commented Jun 25, 2024

IncompleteInputError is undocumented #119521

IncompleteInputError is undocumented #119521

Comments

JelleZijlstra commented May 24, 2024 • edited by bedevere-app bot Loading

Linked PRs

pablogsal commented May 24, 2024

JelleZijlstra commented May 24, 2024

JelleZijlstra commented May 24, 2024

pablogsal commented May 25, 2024 • edited Loading

pablogsal commented May 25, 2024 • edited Loading

pablogsal commented May 25, 2024

pablogsal commented May 25, 2024

JelleZijlstra commented May 27, 2024

pablogsal commented May 28, 2024

pablogsal commented May 28, 2024

encukou commented Jun 25, 2024

`IncompleteInputError` is undocumented #119521

`IncompleteInputError` is undocumented #119521

JelleZijlstra commented May 24, 2024 •

edited by bedevere-app bot

Loading

pablogsal commented May 25, 2024 •

edited

Loading

pablogsal commented May 25, 2024 •

edited

Loading