gh-92256: Improve Argument Clinic parser error messages #92268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(I'm not sure this needs a NEWS item, but I'm happy to add one.) |
|
Details: - Behaviour pre this changeWhitespace before end line (disallowed with confusing error message): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..5c1f2d4d87 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+ [clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c
Error in file "Modules/_sqlite/cursor.c" on line 71:
Illegal function name: [clinic start generated code]*/Whitespace after end line (allowed): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..958891b995 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ !py
python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c
$Garbage after end line (fails badly): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..8df423fc80 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+[clinic start generated code]*/ // this won't work
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c
Error in file "Modules/_sqlite/cursor.c" on line 71:
Exception raised during parsing:
Traceback (most recent call last):
File "/Users/erlendaasland/src/cpython.git/Tools/clinic/clinic.py", line 2025, in parse
parser.parse(block)
^^^^^^^^^^^^^^^^^^^
File "/Users/erlendaasland/src/cpython.git/Tools/clinic/clinic.py", line 4176, in parse
self.state(line)
^^^^^^^^^^^^^^^^
File "/Users/erlendaasland/src/cpython.git/Tools/clinic/clinic.py", line 4217, in state_dsl_start
fields = shlex.split(line)
^^^^^^^^^^^^^^^^^
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/shlex.py", line 315, in split
return list(lex)
^^^^^^^^^
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/shlex.py", line 300, in __next__
token = self.get_token()
^^^^^^^^^^^^^^^^
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/shlex.py", line 109, in get_token
raw = self.read_token()
^^^^^^^^^^^^^^^^^
File "/Library/Frameworks/Python.framework/Versions/3.11/lib/python3.11/shlex.py", line 191, in read_token
raise ValueError("No closing quotation")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ValueError: No closing quotation- Behaviour post this changeWhitespace before end line (currently disallowed): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..5c1f2d4d87 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+ [clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c
Error in file "Modules/_sqlite/cursor.c" on line 35:
Whitespace is not allowed before the stop lineWhitespace after end line (allowed): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..8e4889f162 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c Garbage after end line (disallowed): $ git diff
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
index 0e903ade5b..8df423fc80 100644
--- a/Modules/_sqlite/cursor.c
+++ b/Modules/_sqlite/cursor.c
@@ -32,7 +32,7 @@
/*[clinic input]
module _sqlite3
class _sqlite3.Cursor "pysqlite_Cursor *" "clinic_state()->CursorType"
-[clinic start generated code]*/
+[clinic start generated code]*/ // this won't work
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c5b8115c5cf30f1]*/
/*
$ python3.11 Tools/clinic/clinic.py -f Modules/_sqlite/cursor.c
Error in file "Modules/_sqlite/cursor.c" on line 35:
Garbage after stop line: '// this won't work' |
vstinner
reviewed
May 3, 2022
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka
approved these changes
May 4, 2022
|
Thanks for the reviews and suggestions, Serhiy and Victor; highly appreciated. |
|
BTW, I guess we should backport this through 3.9. |
serhiy-storchaka
added
skip news
needs backport to 3.10
|
It is an internal tool. No NEWS entry is needed. The change is invisible for users. |
I'll remove the NEWS entry; thanks again. |
|
Serhiy and Victor have approved this change. I'll land this in a day or two. |
|
Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10, 3.11. |
|
GH-92614 is a backport of this pull request to the 3.11 branch. |
|
GH-92615 is a backport of this pull request to the 3.10 branch. |
|
GH-92616 is a backport of this pull request to the 3.9 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 10, 2022
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 10, 2022
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 10, 2022
miss-islington
added a commit
that referenced
this pull request
May 10, 2022
miss-islington
added a commit
that referenced
this pull request
May 10, 2022
miss-islington
added a commit
that referenced
this pull request
May 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.