mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-10 00:43:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18

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

Browse source
This commit is contained in:
Terry Jan Reedy 2019-08-04 19:48:52 -04:00 • committed by GitHub
parent d748a80855
commit 1213123005
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 215 additions and 175 deletions
Download patch file Download diff file Expand all files Collapse all files

111
Lib/idlelib/autocomplete.py
View file

@ -8,42 +8,45 @@ import os
import string import string
import sys import sys
# These constants represent the two different types of completions. # Two types of completions; defined here for autocomplete_w import below.
# They must be defined here so autocomple_w can import them. ATTRS, FILES = 0, 1
COMPLETE_ATTRIBUTES, COMPLETE_FILES = range(1, 2+1)
from idlelib import autocomplete_w from idlelib import autocomplete_w
from idlelib.config import idleConf from idlelib.config import idleConf
from idlelib.hyperparser import HyperParser 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. # This string includes all chars that may be in an identifier.
# TODO Update this here and elsewhere. # TODO Update this here and elsewhere.
ID_CHARS = string.ascii_letters + string.digits + "_" ID_CHARS = string.ascii_letters + string.digits + "_"
SEPS = os.sep SEPS = f"{os.sep}{os.altsep if os.altsep else ''}"
if os.altsep: # e.g. '/' on Windows... TRIGGERS = f".{SEPS}"
SEPS += os.altsep
class AutoComplete: class AutoComplete:
def __init__(self, editwin=None): def __init__(self, editwin=None):
self.editwin = editwin 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.text = editwin.text
self.autocompletewindow = None self.autocompletewindow = None
# id of delayed call, and the index of the text insert when # id of delayed call, and the index of the text insert when
# the delayed call was issued. If _delayed_completion_id is # the delayed call was issued. If _delayed_completion_id is
# None, there is no delayed call. # None, there is no delayed call.
self._delayed_completion_id = None self._delayed_completion_id = None
self._delayed_completion_index = None self._delayed_completion_index = None
@classmethod @classmethod
def reload(cls): def reload(cls):
cls.popupwait = idleConf.GetOption( cls.popupwait = idleConf.GetOption(
"extensions", "AutoComplete", "popupwait", type="int", default=0) "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) return autocomplete_w.AutoCompleteWindow(self.text)
def _remove_autocomplete_window(self, event=None): def _remove_autocomplete_window(self, event=None):
@ -52,30 +55,12 @@ class AutoComplete:
self.autocompletewindow = None self.autocompletewindow = None
def force_open_completions_event(self, event): def force_open_completions_event(self, event):
"""Happens when the user really wants to open a completion list, even "(^space) Open completion list, even if a function call is needed."
if a function call is needed. self.open_completions(FORCE)
"""
self.open_completions(True, False, True)
return "break" 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): def autocomplete_event(self, event):
"""Happens when the user wants to complete his word, and if necessary, "(tab) Complete word or open list if multiple options."
open a completion list after that (if there is more than one
completion)
"""
if hasattr(event, "mc_state") and event.mc_state or\ if hasattr(event, "mc_state") and event.mc_state or\
not self.text.get("insert linestart", "insert").strip(): not self.text.get("insert linestart", "insert").strip():
# A modifier was pressed along with the tab or # A modifier was pressed along with the tab or
@ -85,34 +70,34 @@ class AutoComplete:
self.autocompletewindow.complete() self.autocompletewindow.complete()
return "break" return "break"
else: else:
opened = self.open_completions(False, True, True) opened = self.open_completions(TAB)
return "break" if opened else None return "break" if opened else None
def _open_completions_later(self, *args): def try_open_completions_event(self, event=None):
self._delayed_completion_index = self.text.index("insert") "(./) Open completion list after pause with no movement."
if self._delayed_completion_id is not None: lastchar = self.text.get("insert-1c")
self.text.after_cancel(self._delayed_completion_id) if lastchar in TRIGGERS:
self._delayed_completion_id = \ args = TRY_A if lastchar == "." else TRY_F
self.text.after(self.popupwait, self._delayed_open_completions, self._delayed_completion_index = self.text.index("insert")
*args) 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 _delayed_open_completions(self, args):
"Call open_completions if index unchanged."
self._delayed_completion_id = None self._delayed_completion_id = None
if self.text.index("insert") == self._delayed_completion_index: 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. """Find the completions and create the AutoCompleteWindow.
Return True if successful (no syntax error or so found). Return True if successful (no syntax error or so found).
If complete is True, then if there's nothing to complete and no If complete is True, then if there's nothing to complete and no
start of completion, won't open completions and return False. start of completion, won't open completions and return False.
If mode is given, will open a completion list only in this mode. 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. # Cancel another delayed call, if it exists.
if self._delayed_completion_id is not None: if self._delayed_completion_id is not None:
self.text.after_cancel(self._delayed_completion_id) self.text.after_cancel(self._delayed_completion_id)
@ -121,14 +106,14 @@ class AutoComplete:
hp = HyperParser(self.editwin, "insert") hp = HyperParser(self.editwin, "insert")
curline = self.text.get("insert linestart", "insert") curline = self.text.get("insert linestart", "insert")
i = j = len(curline) 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. # Find the beginning of the string.
# fetch_completions will look at the file system to determine # fetch_completions will look at the file system to determine
# whether the string value constitutes an actual file name # whether the string value constitutes an actual file name
# XXX could consider raw strings here and unescape the string # XXX could consider raw strings here and unescape the string
# value if it's not raw. # value if it's not raw.
self._remove_autocomplete_window() self._remove_autocomplete_window()
mode = COMPLETE_FILES mode = FILES
# Find last separator or string start # Find last separator or string start
while i and curline[i-1] not in "'\"" + SEPS: while i and curline[i-1] not in "'\"" + SEPS:
i -= 1 i -= 1
@ -138,17 +123,17 @@ class AutoComplete:
while i and curline[i-1] not in "'\"": while i and curline[i-1] not in "'\"":
i -= 1 i -= 1
comp_what = curline[i:j] 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() self._remove_autocomplete_window()
mode = COMPLETE_ATTRIBUTES mode = ATTRS
while i and (curline[i-1] in ID_CHARS or ord(curline[i-1]) > 127): while i and (curline[i-1] in ID_CHARS or ord(curline[i-1]) > 127):
i -= 1 i -= 1
comp_start = curline[i:j] 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))) hp.set_index("insert-%dc" % (len(curline)-(i-1)))
comp_what = hp.get_expression() comp_what = hp.get_expression()
if not comp_what or \ if (not comp_what or
(not evalfuncs and comp_what.find('(') != -1): (not evalfuncs and comp_what.find('(') != -1)):
return None return None
else: else:
comp_what = "" comp_what = ""
@ -163,7 +148,7 @@ class AutoComplete:
self.autocompletewindow = self._make_autocomplete_window() self.autocompletewindow = self._make_autocomplete_window()
return not self.autocompletewindow.show_window( return not self.autocompletewindow.show_window(
comp_lists, "insert-%dc" % len(comp_start), comp_lists, "insert-%dc" % len(comp_start),
complete, mode, userWantsWin) complete, mode, wantwin)
def fetch_completions(self, what, mode): def fetch_completions(self, what, mode):
"""Return a pair of lists of completions for something. The first list """Return a pair of lists of completions for something. The first list
@ -185,7 +170,7 @@ class AutoComplete:
return rpcclt.remotecall("exec", "get_the_completion_list", return rpcclt.remotecall("exec", "get_the_completion_list",
(what, mode), {}) (what, mode), {})
else: else:
if mode == COMPLETE_ATTRIBUTES: if mode == ATTRS:
if what == "": if what == "":
namespace = {**__main__.__builtins__.__dict__, namespace = {**__main__.__builtins__.__dict__,
**__main__.__dict__} **__main__.__dict__}
@ -207,7 +192,7 @@ class AutoComplete:
except: except:
return [], [] return [], []
elif mode == COMPLETE_FILES: elif mode == FILES:
if what == "": if what == "":
what = "." what = "."
try: try:

32
Lib/idlelib/autocomplete_w.py
View file

@ -6,7 +6,7 @@ import platform
from tkinter import * from tkinter import *
from tkinter.ttk import Frame, Scrollbar 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 from idlelib.multicall import MC_SHIFT
HIDE_VIRTUAL_EVENT_NAME = "<<autocompletewindow-hide>>" HIDE_VIRTUAL_EVENT_NAME = "<<autocompletewindow-hide>>"
@ -39,8 +39,7 @@ class AutoCompleteWindow:
self.completions = None self.completions = None
# A list with more completions, or None # A list with more completions, or None
self.morecompletions = None self.morecompletions = None
# The completion mode. Either autocomplete.COMPLETE_ATTRIBUTES or # The completion mode, either autocomplete.ATTRS or .FILES.
# autocomplete.COMPLETE_FILES
self.mode = None self.mode = None
# The current completion start, on the text box (a string) # The current completion start, on the text box (a string)
self.start = None self.start = None
@ -73,8 +72,8 @@ class AutoCompleteWindow:
def _binary_search(self, s): def _binary_search(self, s):
"""Find the first index in self.completions where completions[i] is """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 greater or equal to s, or the last index if there is no such.
one.""" """
i = 0; j = len(self.completions) i = 0; j = len(self.completions)
while j > i: while j > i:
m = (i + j) // 2 m = (i + j) // 2
@ -87,7 +86,8 @@ class AutoCompleteWindow:
def _complete_string(self, s): def _complete_string(self, s):
"""Assuming that s is the prefix of a string in self.completions, """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 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) first = self._binary_search(s)
if self.completions[first][:len(s)] != s: if self.completions[first][:len(s)] != s:
# There is not even one completion which s is a prefix of. # There is not even one completion which s is a prefix of.
@ -116,8 +116,10 @@ class AutoCompleteWindow:
return first_comp[:i] return first_comp[:i]
def _selection_changed(self): def _selection_changed(self):
"""Should be called when the selection of the Listbox has changed. """Call when the selection of the Listbox has changed.
Updates the Listbox display and calls _change_start."""
Updates the Listbox display and calls _change_start.
"""
cursel = int(self.listbox.curselection()[0]) cursel = int(self.listbox.curselection()[0])
self.listbox.see(cursel) self.listbox.see(cursel)
@ -153,8 +155,10 @@ class AutoCompleteWindow:
def show_window(self, comp_lists, index, complete, mode, userWantsWin): def show_window(self, comp_lists, index, complete, mode, userWantsWin):
"""Show the autocomplete list, bind events. """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 # Handle the start we already have
self.completions, self.morecompletions = comp_lists self.completions, self.morecompletions = comp_lists
self.mode = mode self.mode = mode
@ -300,7 +304,7 @@ class AutoCompleteWindow:
if keysym != "Tab": if keysym != "Tab":
self.lastkey_was_tab = False self.lastkey_was_tab = False
if (len(keysym) == 1 or keysym in ("underscore", "BackSpace") 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"))) \ ("period", "minus"))) \
and not (state & ~MC_SHIFT): and not (state & ~MC_SHIFT):
# Normal editing of text # Normal editing of text
@ -329,10 +333,10 @@ class AutoCompleteWindow:
self.hide_window() self.hide_window()
return 'break' return 'break'
elif (self.mode == COMPLETE_ATTRIBUTES and keysym in elif (self.mode == ATTRS and keysym in
("period", "space", "parenleft", "parenright", "bracketleft", ("period", "space", "parenleft", "parenright", "bracketleft",
"bracketright")) or \ "bracketright")) or \
(self.mode == COMPLETE_FILES and keysym in (self.mode == FILES and keysym in
("slash", "backslash", "quotedbl", "apostrophe")) \ ("slash", "backslash", "quotedbl", "apostrophe")) \
and not (state & ~MC_SHIFT): and not (state & ~MC_SHIFT):
# If start is a prefix of the selection, but is not '' when # If start is a prefix of the selection, but is not '' when
@ -340,7 +344,7 @@ class AutoCompleteWindow:
# selected completion. Anyway, close the list. # selected completion. Anyway, close the list.
cursel = int(self.listbox.curselection()[0]) cursel = int(self.listbox.curselection()[0])
if self.completions[cursel][:len(self.start)] == self.start \ 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._change_start(self.completions[cursel])
self.hide_window() self.hide_window()
return None return None

246
Lib/idlelib/idle_test/test_autocomplete.py
View file

@ -1,4 +1,4 @@
"Test autocomplete, coverage 87%." "Test autocomplete, coverage 93%."
import unittest import unittest
from unittest.mock import Mock, patch from unittest.mock import Mock, patch
@ -45,127 +45,177 @@ class AutoCompleteTest(unittest.TestCase):
def test_init(self): def test_init(self):
self.assertEqual(self.autocomplete.editwin, self.editor) self.assertEqual(self.autocomplete.editwin, self.editor)
self.assertEqual(self.autocomplete.text, self.text)
def test_make_autocomplete_window(self): def test_make_autocomplete_window(self):
testwin = self.autocomplete._make_autocomplete_window() testwin = self.autocomplete._make_autocomplete_window()
self.assertIsInstance(testwin, acw.AutoCompleteWindow) self.assertIsInstance(testwin, acw.AutoCompleteWindow)
def test_remove_autocomplete_window(self): def test_remove_autocomplete_window(self):
self.autocomplete.autocompletewindow = ( acp = self.autocomplete
self.autocomplete._make_autocomplete_window()) acp.autocompletewindow = m = Mock()
self.autocomplete._remove_autocomplete_window() acp._remove_autocomplete_window()
self.assertIsNone(self.autocomplete.autocompletewindow) m.hide_window.assert_called_once()
self.assertIsNone(acp.autocompletewindow)
def test_force_open_completions_event(self): def test_force_open_completions_event(self):
# Test that force_open_completions_event calls _open_completions. # Call _open_completions and break.
o_cs = Func() acp = self.autocomplete
self.autocomplete.open_completions = o_cs open_c = Func()
self.autocomplete.force_open_completions_event('event') acp.open_completions = open_c
self.assertEqual(o_cs.args, (True, False, True)) self.assertEqual(acp.force_open_completions_event('event'), 'break')
self.assertEqual(open_c.args[0], ac.FORCE)
def test_try_open_completions_event(self):
Equal = self.assertEqual
autocomplete = self.autocomplete
trycompletions = self.autocomplete.try_open_completions_event
o_c_l = Func()
autocomplete._open_completions_later = o_c_l
# _open_completions_later should not be called with no text in editor.
trycompletions('event')
Equal(o_c_l.args, None)
# _open_completions_later should be called with COMPLETE_ATTRIBUTES (1).
self.text.insert('1.0', 're.')
trycompletions('event')
Equal(o_c_l.args, (False, False, False, 1))
# _open_completions_later should be called with COMPLETE_FILES (2).
self.text.delete('1.0', 'end')
self.text.insert('1.0', '"./Lib/')
trycompletions('event')
Equal(o_c_l.args, (False, False, False, 2))
def test_autocomplete_event(self): def test_autocomplete_event(self):
Equal = self.assertEqual Equal = self.assertEqual
autocomplete = self.autocomplete acp = self.autocomplete
# Test that the autocomplete event is ignored if user is pressing a # Result of autocomplete event: If modified tab, None.
# modifier key in addition to the tab key.
ev = Event(mc_state=True) ev = Event(mc_state=True)
self.assertIsNone(autocomplete.autocomplete_event(ev)) self.assertIsNone(acp.autocomplete_event(ev))
del ev.mc_state del ev.mc_state
# Test that tab after whitespace is ignored. # If tab after whitespace, None.
self.text.insert('1.0', ' """Docstring.\n ') self.text.insert('1.0', ' """Docstring.\n ')
self.assertIsNone(autocomplete.autocomplete_event(ev)) self.assertIsNone(acp.autocomplete_event(ev))
self.text.delete('1.0', 'end') self.text.delete('1.0', 'end')
# If autocomplete window is open, complete() method is called. # If active autocomplete window, complete() and 'break'.
self.text.insert('1.0', 're.') self.text.insert('1.0', 're.')
# This must call autocomplete._make_autocomplete_window(). acp.autocompletewindow = mock = Mock()
Equal(self.autocomplete.autocomplete_event(ev), 'break') mock.is_active = Mock(return_value=True)
Equal(acp.autocomplete_event(ev), 'break')
mock.complete.assert_called_once()
acp.autocompletewindow = None
# If autocomplete window is not active or does not exist, # If no active autocomplete window, open_completions(), None/break.
# open_completions is called. Return depends on its return. open_c = Func(result=False)
autocomplete._remove_autocomplete_window() acp.open_completions = open_c
o_cs = Func() # .result = None. Equal(acp.autocomplete_event(ev), None)
autocomplete.open_completions = o_cs Equal(open_c.args[0], ac.TAB)
Equal(self.autocomplete.autocomplete_event(ev), None) open_c.result = True
Equal(o_cs.args, (False, True, True)) Equal(acp.autocomplete_event(ev), 'break')
o_cs.result = True Equal(open_c.args[0], ac.TAB)
Equal(self.autocomplete.autocomplete_event(ev), 'break')
Equal(o_cs.args, (False, True, True))
def test_open_completions_later(self): def test_try_open_completions_event(self):
# Test that autocomplete._delayed_completion_id is set. Equal = self.assertEqual
text = self.text
acp = self.autocomplete acp = self.autocomplete
acp._delayed_completion_id = None trycompletions = acp.try_open_completions_event
acp._open_completions_later(False, False, False, ac.COMPLETE_ATTRIBUTES) after = Func(result='after1')
cb1 = acp._delayed_completion_id acp.text.after = after
self.assertTrue(cb1.startswith('after'))
# Test that cb1 is cancelled and cb2 is new. # If no text or trigger, after not called.
acp._open_completions_later(False, False, False, ac.COMPLETE_FILES) trycompletions()
self.assertNotIn(cb1, self.root.tk.call('after', 'info')) Equal(after.called, 0)
cb2 = acp._delayed_completion_id text.insert('1.0', 're')
self.assertTrue(cb2.startswith('after') and cb2 != cb1) trycompletions()
self.text.after_cancel(cb2) Equal(after.called, 0)
# Attribute needed, no existing callback.
text.insert('insert', ' re.')
acp._delayed_completion_id = None
trycompletions()
Equal(acp._delayed_completion_index, text.index('insert'))
Equal(after.args,
(acp.popupwait, acp._delayed_open_completions, ac.TRY_A))
cb1 = acp._delayed_completion_id
Equal(cb1, 'after1')
# File needed, existing callback cancelled.
text.insert('insert', ' "./Lib/')
after.result = 'after2'
cancel = Func()
acp.text.after_cancel = cancel
trycompletions()
Equal(acp._delayed_completion_index, text.index('insert'))
Equal(cancel.args, (cb1,))
Equal(after.args,
(acp.popupwait, acp._delayed_open_completions, ac.TRY_F))
Equal(acp._delayed_completion_id, 'after2')
def test_delayed_open_completions(self): def test_delayed_open_completions(self):
# Test that autocomplete._delayed_completion_id set to None Equal = self.assertEqual
# and that open_completions is not called if the index is not
# equal to _delayed_completion_index.
acp = self.autocomplete acp = self.autocomplete
acp.open_completions = Func() open_c = Func()
acp.open_completions = open_c
self.text.insert('1.0', '"dict.')
# Set autocomplete._delayed_completion_id to None.
# Text index changed, don't call open_completions.
acp._delayed_completion_id = 'after' acp._delayed_completion_id = 'after'
acp._delayed_completion_index = self.text.index('insert+1c') acp._delayed_completion_index = self.text.index('insert+1c')
acp._delayed_open_completions(1, 2, 3) acp._delayed_open_completions('dummy')
self.assertIsNone(acp._delayed_completion_id) self.assertIsNone(acp._delayed_completion_id)
self.assertEqual(acp.open_completions.called, 0) Equal(open_c.called, 0)
# Test that open_completions is called if indexes match. # Text index unchanged, call open_completions.
acp._delayed_completion_index = self.text.index('insert') acp._delayed_completion_index = self.text.index('insert')
acp._delayed_open_completions(1, 2, 3, ac.COMPLETE_FILES) acp._delayed_open_completions((1, 2, 3, ac.FILES))
self.assertEqual(acp.open_completions.args, (1, 2, 3, 2)) self.assertEqual(open_c.args[0], (1, 2, 3, ac.FILES))
def test_oc_cancel_comment(self):
none = self.assertIsNone
acp = self.autocomplete
# Comment is in neither code or string.
acp._delayed_completion_id = 'after'
after = Func(result='after')
acp.text.after_cancel = after
self.text.insert(1.0, '# comment')
none(acp.open_completions(ac.TAB)) # From 'else' after 'elif'.
none(acp._delayed_completion_id)
def test_oc_no_list(self):
acp = self.autocomplete
fetch = Func(result=([],[]))
acp.fetch_completions = fetch
self.text.insert('1.0', 'object')
self.assertIsNone(acp.open_completions(ac.TAB))
self.text.insert('insert', '.')
self.assertIsNone(acp.open_completions(ac.TAB))
self.assertEqual(fetch.called, 2)
def test_open_completions_none(self):
# Test other two None returns.
none = self.assertIsNone
acp = self.autocomplete
# No object for attributes or need call not allowed.
self.text.insert(1.0, '.')
none(acp.open_completions(ac.TAB))
self.text.insert('insert', ' int().')
none(acp.open_completions(ac.TAB))
# Blank or quote trigger 'if complete ...'.
self.text.delete(1.0, 'end')
self.assertFalse(acp.open_completions(ac.TAB))
self.text.insert('1.0', '"')
self.assertFalse(acp.open_completions(ac.TAB))
self.text.delete('1.0', 'end')
class dummy_acw():
__init__ = Func()
show_window = Func(result=False)
hide_window = Func()
def test_open_completions(self): def test_open_completions(self):
# Test completions of files and attributes as well as non-completion # Test completions of files and attributes.
# of errors. acp = self.autocomplete
self.text.insert('1.0', 'pr') fetch = Func(result=(['tem'],['tem', '_tem']))
self.assertTrue(self.autocomplete.open_completions(False, True, True)) acp.fetch_completions = fetch
def make_acw(): return self.dummy_acw()
acp._make_autocomplete_window = make_acw
self.text.insert('1.0', 'int.')
acp.open_completions(ac.TAB)
self.assertIsInstance(acp.autocompletewindow, self.dummy_acw)
self.text.delete('1.0', 'end') self.text.delete('1.0', 'end')
# Test files. # Test files.
self.text.insert('1.0', '"t') self.text.insert('1.0', '"t')
#self.assertTrue(self.autocomplete.open_completions(False, True, True)) self.assertTrue(acp.open_completions(ac.TAB))
self.text.delete('1.0', 'end')
# Test with blank will fail.
self.assertFalse(self.autocomplete.open_completions(False, True, True))
# Test with only string quote will fail.
self.text.insert('1.0', '"')
self.assertFalse(self.autocomplete.open_completions(False, True, True))
self.text.delete('1.0', 'end') self.text.delete('1.0', 'end')
def test_fetch_completions(self): def test_fetch_completions(self):
@ -174,21 +224,21 @@ class AutoCompleteTest(unittest.TestCase):
# a small list containing non-private variables. # a small list containing non-private variables.
# For file completion, a large list containing all files in the path, # For file completion, a large list containing all files in the path,
# and a small list containing files that do not start with '.'. # and a small list containing files that do not start with '.'.
autocomplete = self.autocomplete acp = self.autocomplete
small, large = self.autocomplete.fetch_completions( small, large = acp.fetch_completions(
'', ac.COMPLETE_ATTRIBUTES) '', ac.ATTRS)
if __main__.__file__ != ac.__file__: if __main__.__file__ != ac.__file__:
self.assertNotIn('AutoComplete', small) # See issue 36405. self.assertNotIn('AutoComplete', small) # See issue 36405.
# Test attributes # Test attributes
s, b = autocomplete.fetch_completions('', ac.COMPLETE_ATTRIBUTES) s, b = acp.fetch_completions('', ac.ATTRS)
self.assertLess(len(small), len(large)) self.assertLess(len(small), len(large))
self.assertTrue(all(filter(lambda x: x.startswith('_'), s))) self.assertTrue(all(filter(lambda x: x.startswith('_'), s)))
self.assertTrue(any(filter(lambda x: x.startswith('_'), b))) self.assertTrue(any(filter(lambda x: x.startswith('_'), b)))
# Test smalll should respect to __all__. # Test smalll should respect to __all__.
with patch.dict('__main__.__dict__', {'__all__': ['a', 'b']}): with patch.dict('__main__.__dict__', {'__all__': ['a', 'b']}):
s, b = autocomplete.fetch_completions('', ac.COMPLETE_ATTRIBUTES) s, b = acp.fetch_completions('', ac.ATTRS)
self.assertEqual(s, ['a', 'b']) self.assertEqual(s, ['a', 'b'])
self.assertIn('__name__', b) # From __main__.__dict__ self.assertIn('__name__', b) # From __main__.__dict__
self.assertIn('sum', b) # From __main__.__builtins__.__dict__ self.assertIn('sum', b) # From __main__.__builtins__.__dict__
@ -197,7 +247,7 @@ class AutoCompleteTest(unittest.TestCase):
mock = Mock() mock = Mock()
mock._private = Mock() mock._private = Mock()
with patch.dict('__main__.__dict__', {'foo': mock}): with patch.dict('__main__.__dict__', {'foo': mock}):
s, b = autocomplete.fetch_completions('foo', ac.COMPLETE_ATTRIBUTES) s, b = acp.fetch_completions('foo', ac.ATTRS)
self.assertNotIn('_private', s) self.assertNotIn('_private', s)
self.assertIn('_private', b) self.assertIn('_private', b)
self.assertEqual(s, [i for i in sorted(dir(mock)) if i[:1] != '_']) self.assertEqual(s, [i for i in sorted(dir(mock)) if i[:1] != '_'])
@ -211,36 +261,36 @@ class AutoCompleteTest(unittest.TestCase):
return ['monty', 'python', '.hidden'] return ['monty', 'python', '.hidden']
with patch.object(os, 'listdir', _listdir): with patch.object(os, 'listdir', _listdir):
s, b = autocomplete.fetch_completions('', ac.COMPLETE_FILES) s, b = acp.fetch_completions('', ac.FILES)
self.assertEqual(s, ['bar', 'foo']) self.assertEqual(s, ['bar', 'foo'])
self.assertEqual(b, ['.hidden', 'bar', 'foo']) self.assertEqual(b, ['.hidden', 'bar', 'foo'])
s, b = autocomplete.fetch_completions('~', ac.COMPLETE_FILES) s, b = acp.fetch_completions('~', ac.FILES)
self.assertEqual(s, ['monty', 'python']) self.assertEqual(s, ['monty', 'python'])
self.assertEqual(b, ['.hidden', 'monty', 'python']) self.assertEqual(b, ['.hidden', 'monty', 'python'])
def test_get_entity(self): def test_get_entity(self):
# Test that a name is in the namespace of sys.modules and # Test that a name is in the namespace of sys.modules and
# __main__.__dict__. # __main__.__dict__.
autocomplete = self.autocomplete acp = self.autocomplete
Equal = self.assertEqual Equal = self.assertEqual
Equal(self.autocomplete.get_entity('int'), int) Equal(acp.get_entity('int'), int)
# Test name from sys.modules. # Test name from sys.modules.
mock = Mock() mock = Mock()
with patch.dict('sys.modules', {'tempfile': mock}): with patch.dict('sys.modules', {'tempfile': mock}):
Equal(autocomplete.get_entity('tempfile'), mock) Equal(acp.get_entity('tempfile'), mock)
# Test name from __main__.__dict__. # Test name from __main__.__dict__.
di = {'foo': 10, 'bar': 20} di = {'foo': 10, 'bar': 20}
with patch.dict('__main__.__dict__', {'d': di}): with patch.dict('__main__.__dict__', {'d': di}):
Equal(autocomplete.get_entity('d'), di) Equal(acp.get_entity('d'), di)
# Test name not in namespace. # Test name not in namespace.
with patch.dict('__main__.__dict__', {}): with patch.dict('__main__.__dict__', {}):
with self.assertRaises(NameError): with self.assertRaises(NameError):
autocomplete.get_entity('not_exist') acp.get_entity('not_exist')
if __name__ == '__main__': if __name__ == '__main__':

1
Misc/NEWS.d/next/IDLE/2019-08-04-17-10-01.bpo-36419.TJZqOc.rst Normal file
View file

@ -0,0 +1 @@
IDLE - Refactor autocompete and improve testing.