FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-107944: Improve error message for function calls with bad keyword arguments by pablogsal · Pull Request #107969 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-107944: Improve error message for function calls with bad keyword arguments #107969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogsal merged 1 commit into from
Aug 17, 2023
Conversation 5 Commits 1 Checks 0 Files changed
Merged

gh-107944: Improve error message for function calls with bad keyword arguments #107969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .c  (2) .h  (1) .py  (1) .rst  (1) All 4 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
2 changes: 1 addition & 1 deletion Include/internal/pycore_pyerrors.h
Show comments
View file
Open in desktop
This file contains hidden or 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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ extern PyObject* _PyExc_PrepReraiseStar(
extern int _PyErr_CheckSignalsTstate(PyThreadState *tstate);

extern void _Py_DumpExtensionModules(int fd, PyInterpreterState *interp);

extern PyObject* _Py_CalculateSuggestions(PyObject *dir, PyObject *name);
extern PyObject* _Py_Offer_Suggestions(PyObject* exception);
// Export for '_testinternalcapi' shared extension
PyAPI_FUNC(Py_ssize_t) _Py_UTF8_Edit_Cost(PyObject *str_a, PyObject *str_b,
Expand Down
68 changes: 68 additions & 0 deletions Lib/test/test_call.py
Show comments
View file
Open in desktop
This file contains hidden or 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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,74 @@ def test_multiple_values(self):
with self.check_raises_type_error(msg):
A().method_two_args("x", "y", x="oops")

@cpython_only
class TestErrorMessagesSuggestions(unittest.TestCase):
@contextlib.contextmanager
def check_suggestion_includes(self, message):
with self.assertRaises(TypeError) as cm:
yield
self.assertIn(f"Did you mean '{message}'?", str(cm.exception))

@contextlib.contextmanager
def check_suggestion_not_pressent(self):
with self.assertRaises(TypeError) as cm:
yield
self.assertNotIn("Did you mean", str(cm.exception))

def test_unexpected_keyword_suggestion_valid_positions(self):
def foo(blech=None, /, aaa=None, *args, late1=None):
pass

cases = [
("blach", None),
("aa", "aaa"),
("orgs", None),
("late11", "late1"),
]

for keyword, suggestion in cases:
with self.subTest(keyword):
ctx = self.check_suggestion_includes(suggestion) if suggestion else self.check_suggestion_not_pressent()
with ctx:
foo(**{keyword:None})

def test_unexpected_keyword_suggestion_kinds(self):

def substitution(noise=None, more_noise=None, a = None, blech = None):
pass

def elimination(noise = None, more_noise = None, a = None, blch = None):
pass

def addition(noise = None, more_noise = None, a = None, bluchin = None):
pass

def substitution_over_elimination(blach = None, bluc = None):
pass

def substitution_over_addition(blach = None, bluchi = None):
pass

def elimination_over_addition(bluc = None, blucha = None):
pass

def case_change_over_substitution(BLuch=None, Luch = None, fluch = None):
pass

for func, suggestion in [
(addition, "bluchin"),
(substitution, "blech"),
(elimination, "blch"),
(addition, "bluchin"),
(substitution_over_elimination, "blach"),
(substitution_over_addition, "blach"),
(elimination_over_addition, "bluc"),
(case_change_over_substitution, "BLuch"),
]:
with self.subTest(suggestion):
with self.check_suggestion_includes(suggestion):
func(bluch=None)

@cpython_only
class TestRecursion(unittest.TestCase):

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Core and Builtins/2023-08-15-11-09-50.gh-issue-107944.zQLp3j.rst
Show comments
View file
Open in desktop
This file contains hidden or 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
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Improve error message for function calls with bad keyword arguments. Patch
by Pablo Galindo
31 changes: 28 additions & 3 deletions Python/ceval.c
Show comments
View file
Open in desktop
This file contains hidden or 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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
#include "pycore_tuple.h" // _PyTuple_ITEMS()
#include "pycore_typeobject.h" // _PySuper_Lookup()
#include "pycore_uops.h" // _PyUOpExecutorObject
#include "pycore_pyerrors.h"

#include "pycore_dict.h"
#include "dictobject.h"
Expand Down Expand Up @@ -1327,9 +1328,33 @@ initialize_locals(PyThreadState *tstate, PyFunctionObject *func,
goto kw_fail;
}

_PyErr_Format(tstate, PyExc_TypeError,
"%U() got an unexpected keyword argument '%S'",
func->func_qualname, keyword);
PyObject* suggestion_keyword = NULL;
if (total_args > co->co_posonlyargcount) {
PyObject* possible_keywords = PyList_New(total_args - co->co_posonlyargcount);

if (!possible_keywords) {
PyErr_Clear();
} else {
for (Py_ssize_t k = co->co_posonlyargcount; k < total_args; k++) {
PyList_SET_ITEM(possible_keywords, k - co->co_posonlyargcount, co_varnames[k]);
}

suggestion_keyword = _Py_CalculateSuggestions(possible_keywords, keyword);
Py_DECREF(possible_keywords);
}
}

if (suggestion_keyword) {
_PyErr_Format(tstate, PyExc_TypeError,
"%U() got an unexpected keyword argument '%S'. Did you mean '%S'?",
func->func_qualname, keyword, suggestion_keyword);
Py_DECREF(suggestion_keyword);
} else {
_PyErr_Format(tstate, PyExc_TypeError,
"%U() got an unexpected keyword argument '%S'",

lysnikolaou Aug 15, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Wouldn't it be a better UX if we included a list with all the possible keywords here? We could special-case it for cases where the list is smaller than X, in order to keep the output to a reasonable size.

pablogsal Aug 15, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think is better, but on the other hand, it would be a bunch of extra code (joining the list with commas + handling errors) so not sure if is worth the complexity. @rhettinger what do you think? (Note we are referring to the fallback message when we could not find the suggestion either because of errors or because there is nothing close).

rhettinger Aug 17, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

what do you think?

I think what you have now will suffice — only offer a suggestion when a plausible candidate can be found; otherwise, just note that the keyword argument doesn't match.
func->func_qualname, keyword);
}

goto kw_fail;
}

Expand Down
14 changes: 7 additions & 7 deletions Python/suggestions.c
Show comments
View file
Open in desktop
This file contains hidden or 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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ levenshtein_distance(const char *a, size_t a_size,
return result;
}

static inline PyObject *
calculate_suggestions(PyObject *dir,
PyObject *
_Py_CalculateSuggestions(PyObject *dir,
PyObject *name)
{
assert(!PyErr_Occurred());
Expand Down Expand Up @@ -195,7 +195,7 @@ get_suggestions_for_attribute_error(PyAttributeErrorObject *exc)
return NULL;
}

PyObject *suggestions = calculate_suggestions(dir, name);
PyObject *suggestions = _Py_CalculateSuggestions(dir, name);
Py_DECREF(dir);
return suggestions;
}
Expand Down Expand Up @@ -259,7 +259,7 @@ get_suggestions_for_name_error(PyObject* name, PyFrameObject* frame)
}
}

PyObject *suggestions = calculate_suggestions(dir, name);
PyObject *suggestions = _Py_CalculateSuggestions(dir, name);
Py_DECREF(dir);
if (suggestions != NULL || PyErr_Occurred()) {
return suggestions;
Expand All @@ -269,7 +269,7 @@ get_suggestions_for_name_error(PyObject* name, PyFrameObject* frame)
if (dir == NULL) {
return NULL;
}
suggestions = calculate_suggestions(dir, name);
suggestions = _Py_CalculateSuggestions(dir, name);
Py_DECREF(dir);
if (suggestions != NULL || PyErr_Occurred()) {
return suggestions;
Expand All @@ -279,7 +279,7 @@ get_suggestions_for_name_error(PyObject* name, PyFrameObject* frame)
if (dir == NULL) {
return NULL;
}
suggestions = calculate_suggestions(dir, name);
suggestions = _Py_CalculateSuggestions(dir, name);
Py_DECREF(dir);

return suggestions;
Expand Down Expand Up @@ -371,7 +371,7 @@ offer_suggestions_for_import_error(PyImportErrorObject *exc)
return NULL;
}

PyObject *suggestion = calculate_suggestions(dir, name);
PyObject *suggestion = _Py_CalculateSuggestions(dir, name);
Py_DECREF(dir);
if (!suggestion) {
return NULL;
Expand Down
Back | FazBrowse Home | New Git URL