Skip to content

bpo-36419: IDLE - Refactor autocompete and improve testing. #15121

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
merged 12 commits into from
Aug 4, 2019
Merged

bpo-36419: IDLE - Refactor autocompete and improve testing. #15121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8c384d6
Some edits and cover thru autocomplete_event.
terryjreedy Mar 26, 2019
48f2b54
Move autocomplete & test up, other changes.
terryjreedy Mar 27, 2019
9a17b9d
more edits
terryjreedy Mar 28, 2019
ff8f6ea
Define open_completion args as tuple constants.
terryjreedy Mar 28, 2019
8c1e8a4
Increase coverage to 93%
terryjreedy Apr 2, 2019
664a6a9
Merge remote-tracking branch 'origin' into autocomplete
terryjreedy Apr 3, 2019
155bc39
Merge try_open_completions_event and _open_completions_later.
terryjreedy Apr 3, 2019
ebaa176
Merge remote-tracking branch 'upstream/master' into autocomplete
terryjreedy Aug 4, 2019
d5cf07a
blurb
terryjreedy Aug 4, 2019
d60abaa
Remove comment I no longer understand.
terryjreedy Aug 4, 2019
09c6b05
Better and more consistent abbreviations.
terryjreedy Aug 4, 2019
019ae89
whitespace
terryjreedy Aug 4, 2019
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
113 changes: 49 additions & 64 deletions Lib/idlelib/autocomplete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,42 +8,45 @@
import string
import sys

# These constants represent the two different types of completions.
# They must be defined here so autocomple_w can import them.
COMPLETE_ATTRIBUTES, COMPLETE_FILES = range(1, 2+1)

# Two types of completions; defined here for autocomplete_w import below.
ATTRS, FILES = 0, 1
from idlelib import autocomplete_w
from idlelib.config import idleConf
from idlelib.hyperparser import HyperParser

# Tuples passed to open_completions.
# EvalFunc, Complete, WantWin, Mode
FORCE = True, False, True, None # Control-Space.
TAB = False, True, True, None # Tab.
TRY_A = False, False, False, ATTRS # '.' for attributes.
TRY_F = False, False, False, FILES # '/' in quotes for file name.

# This string includes all chars that may be in an identifier.
# TODO Update this here and elsewhere.
ID_CHARS = string.ascii_letters + string.digits + "_"

SEPS = os.sep
if os.altsep: # e.g. '/' on Windows...
SEPS += os.altsep

SEPS = f"{os.sep}{os.altsep if os.altsep else ''}"
TRIGGERS = f".{SEPS}"

class AutoComplete:

def __init__(self, editwin=None):
self.editwin = editwin
if editwin is not None: # not in subprocess or test
if editwin is not None: # not in subprocess or no-gui test
self.text = editwin.text
self.autocompletewindow = None
# id of delayed call, and the index of the text insert when
# the delayed call was issued. If _delayed_completion_id is
# None, there is no delayed call.
self._delayed_completion_id = None
self._delayed_completion_index = None
self.autocompletewindow = None
# id of delayed call, and the index of the text insert when
# the delayed call was issued. If _delayed_completion_id is
# None, there is no delayed call.
self._delayed_completion_id = None
self._delayed_completion_index = None

@classmethod
def reload(cls):
cls.popupwait = idleConf.GetOption(
"extensions", "AutoComplete", "popupwait", type="int", default=0)

def _make_autocomplete_window(self):
def _make_autocomplete_window(self): # Makes mocking easier.
return autocomplete_w.AutoCompleteWindow(self.text)

def _remove_autocomplete_window(self, event=None):
Expand All @@ -52,30 +55,12 @@ def _remove_autocomplete_window(self, event=None):
self.autocompletewindow = None

def force_open_completions_event(self, event):
"""Happens when the user really wants to open a completion list, even
if a function call is needed.
"""
self.open_completions(True, False, True)
"(^space) Open completion list, even if a function call is needed."
self.open_completions(FORCE)
return "break"

def try_open_completions_event(self, event):
"""Happens when it would be nice to open a completion list, but not
really necessary, for example after a dot, so function
calls won't be made.
"""
lastchar = self.text.get("insert-1c")
if lastchar == ".":
self._open_completions_later(False, False, False,
COMPLETE_ATTRIBUTES)
elif lastchar in SEPS:
self._open_completions_later(False, False, False,
COMPLETE_FILES)

def autocomplete_event(self, event):
"""Happens when the user wants to complete his word, and if necessary,
open a completion list after that (if there is more than one
completion)
"""
"(tab) Complete word or open list if multiple options."
if hasattr(event, "mc_state") and event.mc_state or\
not self.text.get("insert linestart", "insert").strip():
# A modifier was pressed along with the tab or
Expand All @@ -85,34 +70,34 @@ def autocomplete_event(self, event):
self.autocompletewindow.complete()
return "break"
else:
opened = self.open_completions(False, True, True)
opened = self.open_completions(TAB)
return "break" if opened else None

def _open_completions_later(self, *args):
self._delayed_completion_index = self.text.index("insert")
if self._delayed_completion_id is not None:
self.text.after_cancel(self._delayed_completion_id)
self._delayed_completion_id = \
self.text.after(self.popupwait, self._delayed_open_completions,
*args)

def _delayed_open_completions(self, *args):
def try_open_completions_event(self, event=None):
"(./) Open completion list after pause with no movement."
lastchar = self.text.get("insert-1c")
if lastchar in TRIGGERS:
args = TRY_A if lastchar == "." else TRY_F
self._delayed_completion_index = self.text.index("insert")
if self._delayed_completion_id is not None:
self.text.after_cancel(self._delayed_completion_id)
self._delayed_completion_id = self.text.after(
self.popupwait, self._delayed_open_completions, args)

def _delayed_open_completions(self, args):
"Call open_completions if index unchanged."
self._delayed_completion_id = None
if self.text.index("insert") == self._delayed_completion_index:
self.open_completions(*args)
self.open_completions(args)

def open_completions(self, evalfuncs, complete, userWantsWin, mode=None):
def open_completions(self, args):
"""Find the completions and create the AutoCompleteWindow.
Return True if successful (no syntax error or so found).
If complete is True, then if there's nothing to complete and no
start of completion, won't open completions and return False.
If mode is given, will open a completion list only in this mode.

Action Function Eval Complete WantWin Mode
^space force_open_completions True, False, True no
. or / try_open_completions False, False, False yes
tab autocomplete False, True, True no
"""
evalfuncs, complete, wantwin, mode = args
# Cancel another delayed call, if it exists.
if self._delayed_completion_id is not None:
self.text.after_cancel(self._delayed_completion_id)
Expand All @@ -121,14 +106,14 @@ def open_completions(self, evalfuncs, complete, userWantsWin, mode=None):
hp = HyperParser(self.editwin, "insert")
curline = self.text.get("insert linestart", "insert")
i = j = len(curline)
if hp.is_in_string() and (not mode or mode==COMPLETE_FILES):
if hp.is_in_string() and (not mode or mode==FILES):
# Find the beginning of the string.
# fetch_completions will look at the file system to determine
# whether the string value constitutes an actual file name
# XXX could consider raw strings here and unescape the string
# value if it's not raw.
self._remove_autocomplete_window()
mode = COMPLETE_FILES
mode = FILES
# Find last separator or string start
while i and curline[i-1] not in "'\"" + SEPS:
i -= 1
Expand All @@ -138,17 +123,17 @@ def open_completions(self, evalfuncs, complete, userWantsWin, mode=None):
while i and curline[i-1] not in "'\"":
i -= 1
comp_what = curline[i:j]
elif hp.is_in_code() and (not mode or mode==COMPLETE_ATTRIBUTES):
elif hp.is_in_code() and (not mode or mode==ATTRS):
self._remove_autocomplete_window()
mode = COMPLETE_ATTRIBUTES
mode = ATTRS
while i and (curline[i-1] in ID_CHARS or ord(curline[i-1]) > 127):
i -= 1
comp_start = curline[i:j]
if i and curline[i-1] == '.':
if i and curline[i-1] == '.': # Need object with attributes.
hp.set_index("insert-%dc" % (len(curline)-(i-1)))
comp_what = hp.get_expression()
if not comp_what or \
(not evalfuncs and comp_what.find('(') != -1):
if (not comp_what or
(not evalfuncs and comp_what.find('(') != -1)):
return None
else:
comp_what = ""
Expand All @@ -163,7 +148,7 @@ def open_completions(self, evalfuncs, complete, userWantsWin, mode=None):
self.autocompletewindow = self._make_autocomplete_window()
return not self.autocompletewindow.show_window(
comp_lists, "insert-%dc" % len(comp_start),
complete, mode, userWantsWin)
complete, mode, wantwin)

def fetch_completions(self, what, mode):
"""Return a pair of lists of completions for something. The first list
Expand All @@ -185,7 +170,7 @@ def fetch_completions(self, what, mode):
return rpcclt.remotecall("exec", "get_the_completion_list",
(what, mode), {})
else:
if mode == COMPLETE_ATTRIBUTES:
if mode == ATTRS:
if what == "":
namespace = {**__main__.__builtins__.__dict__,
**__main__.__dict__}
Expand All @@ -207,7 +192,7 @@ def fetch_completions(self, what, mode):
except:
return [], []

elif mode == COMPLETE_FILES:
elif mode == FILES:
if what == "":
what = "."
try:
Expand Down
32 changes: 18 additions & 14 deletions Lib/idlelib/autocomplete_w.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from tkinter import *
from tkinter.ttk import Frame, Scrollbar

from idlelib.autocomplete import COMPLETE_FILES, COMPLETE_ATTRIBUTES
from idlelib.autocomplete import FILES, ATTRS
from idlelib.multicall import MC_SHIFT

HIDE_VIRTUAL_EVENT_NAME = "<<autocompletewindow-hide>>"
Expand Down Expand Up @@ -39,8 +39,7 @@ def __init__(self, widget):
self.completions = None
# A list with more completions, or None
self.morecompletions = None
# The completion mode. Either autocomplete.COMPLETE_ATTRIBUTES or
# autocomplete.COMPLETE_FILES
# The completion mode, either autocomplete.ATTRS or .FILES.
self.mode = None
# The current completion start, on the text box (a string)
self.start = None
Expand Down Expand Up @@ -73,8 +72,8 @@ def _change_start(self, newstart):

def _binary_search(self, s):
"""Find the first index in self.completions where completions[i] is
greater or equal to s, or the last index if there is no such
one."""
greater or equal to s, or the last index if there is no such.
"""
i = 0; j = len(self.completions)
while j > i:
m = (i + j) // 2
Expand All @@ -87,7 +86,8 @@ def _binary_search(self, s):
def _complete_string(self, s):
"""Assuming that s is the prefix of a string in self.completions,
return the longest string which is a prefix of all the strings which
s is a prefix of them. If s is not a prefix of a string, return s."""
s is a prefix of them. If s is not a prefix of a string, return s.
"""
first = self._binary_search(s)
if self.completions[first][:len(s)] != s:
# There is not even one completion which s is a prefix of.
Expand Down Expand Up @@ -116,8 +116,10 @@ def _complete_string(self, s):
return first_comp[:i]

def _selection_changed(self):
"""Should be called when the selection of the Listbox has changed.
Updates the Listbox display and calls _change_start."""
"""Call when the selection of the Listbox has changed.

Updates the Listbox display and calls _change_start.
"""
cursel = int(self.listbox.curselection()[0])

self.listbox.see(cursel)
Expand Down Expand Up @@ -153,8 +155,10 @@ def _selection_changed(self):

def show_window(self, comp_lists, index, complete, mode, userWantsWin):
"""Show the autocomplete list, bind events.
If complete is True, complete the text, and if there is exactly one
matching completion, don't open a list."""

If complete is True, complete the text, and if there is exactly
one matching completion, don't open a list.
"""
# Handle the start we already have
self.completions, self.morecompletions = comp_lists
self.mode = mode
Expand Down Expand Up @@ -300,7 +304,7 @@ def keypress_event(self, event):
if keysym != "Tab":
self.lastkey_was_tab = False
if (len(keysym) == 1 or keysym in ("underscore", "BackSpace")
or (self.mode == COMPLETE_FILES and keysym in
or (self.mode == FILES and keysym in
("period", "minus"))) \
and not (state & ~MC_SHIFT):
# Normal editing of text
Expand Down Expand Up @@ -329,18 +333,18 @@ def keypress_event(self, event):
self.hide_window()
return 'break'

elif (self.mode == COMPLETE_ATTRIBUTES and keysym in
elif (self.mode == ATTRS and keysym in
("period", "space", "parenleft", "parenright", "bracketleft",
"bracketright")) or \
(self.mode == COMPLETE_FILES and keysym in
(self.mode == FILES and keysym in
("slash", "backslash", "quotedbl", "apostrophe")) \
and not (state & ~MC_SHIFT):
# If start is a prefix of the selection, but is not '' when
# completing file names, put the whole
# selected completion. Anyway, close the list.
cursel = int(self.listbox.curselection()[0])
if self.completions[cursel][:len(self.start)] == self.start \
and (self.mode == COMPLETE_ATTRIBUTES or self.start):
and (self.mode == ATTRS or self.start):
self._change_start(self.completions[cursel])
self.hide_window()
return None
Expand Down
Loading