Skip to content

bpo-38530: Require 50% similarity in NameError suggestions #25584

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 4 commits into from
Apr 27, 2021
Merged

bpo-38530: Require 50% similarity in NameError suggestions #25584

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f7ef5a
Require suggestions be 50% similar
sweeneyde Apr 25, 2021
bd1ad7a
📜🤖 Added by blurb_it.
blurb-it[bot] Apr 25, 2021
2d6233e
Revert "📜🤖 Added by blurb_it."
sweeneyde Apr 25, 2021
c88fd85
Add similar test for attribute errors
sweeneyde Apr 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions Lib/test/test_exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1507,6 +1507,61 @@ def f():

self.assertNotIn("somethingverywronghehe", err.getvalue())

def test_name_error_bad_suggestions_do_not_trigger_for_small_names(self):
Comment thread
pablogsal marked this conversation as resolved.
vvv = mom = w = id = python = None

with self.subTest(name="b"):
try:
b
except NameError as exc:
with support.captured_stderr() as err:
sys.__excepthook__(*sys.exc_info())
self.assertNotIn("you mean", err.getvalue())
self.assertNotIn("vvv", err.getvalue())
self.assertNotIn("mom", err.getvalue())
self.assertNotIn("'id'", err.getvalue())
self.assertNotIn("'w'", err.getvalue())
self.assertNotIn("'python'", err.getvalue())

with self.subTest(name="v"):
try:
v
except NameError as exc:
with support.captured_stderr() as err:
sys.__excepthook__(*sys.exc_info())
self.assertNotIn("you mean", err.getvalue())
self.assertNotIn("vvv", err.getvalue())
self.assertNotIn("mom", err.getvalue())
self.assertNotIn("'id'", err.getvalue())
self.assertNotIn("'w'", err.getvalue())
self.assertNotIn("'python'", err.getvalue())

with self.subTest(name="m"):
try:
m
except NameError as exc:
with support.captured_stderr() as err:
sys.__excepthook__(*sys.exc_info())
self.assertNotIn("you mean", err.getvalue())
self.assertNotIn("vvv", err.getvalue())
self.assertNotIn("mom", err.getvalue())
self.assertNotIn("'id'", err.getvalue())
self.assertNotIn("'w'", err.getvalue())
self.assertNotIn("'python'", err.getvalue())

with self.subTest(name="py"):
try:
py
except NameError as exc:
with support.captured_stderr() as err:
sys.__excepthook__(*sys.exc_info())
self.assertNotIn("you mean", err.getvalue())
self.assertNotIn("vvv", err.getvalue())
self.assertNotIn("mom", err.getvalue())
self.assertNotIn("'id'", err.getvalue())
self.assertNotIn("'w'", err.getvalue())
self.assertNotIn("'python'", err.getvalue())

def test_name_error_suggestions_do_not_trigger_for_too_many_locals(self):
def f():
# Mutating locals() is unreliable, so we need to do it by hand
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2021-04-25-03-18-41.bpo-38530.dPwLC2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
``NameError`` suggestions now require at least 50% similarity, eliminating false positives for short variable names.
5 changes: 4 additions & 1 deletion Python/suggestions.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,10 @@ calculate_suggestions(PyObject *dir,
if (current_distance == -1) {
return NULL;
}
if (current_distance == 0 || current_distance > MAX_DISTANCE) {
if (current_distance == 0 ||
current_distance > MAX_DISTANCE ||
current_distance * 2 > name_size)
{
continue;
}
if (!suggestion || current_distance < suggestion_distance) {
Expand Down