Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/lib/python3.8/idlelib/autocomplete.py @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 """Complete either attribute names or file names.
jpayne@69 2
jpayne@69 3 Either on demand or after a user-selected delay after a key character,
jpayne@69 4 pop up a list of candidates.
jpayne@69 5 """
jpayne@69 6 import __main__
jpayne@69 7 import os
jpayne@69 8 import string
jpayne@69 9 import sys
jpayne@69 10
jpayne@69 11 # Two types of completions; defined here for autocomplete_w import below.
jpayne@69 12 ATTRS, FILES = 0, 1
jpayne@69 13 from idlelib import autocomplete_w
jpayne@69 14 from idlelib.config import idleConf
jpayne@69 15 from idlelib.hyperparser import HyperParser
jpayne@69 16
jpayne@69 17 # Tuples passed to open_completions.
jpayne@69 18 # EvalFunc, Complete, WantWin, Mode
jpayne@69 19 FORCE = True, False, True, None # Control-Space.
jpayne@69 20 TAB = False, True, True, None # Tab.
jpayne@69 21 TRY_A = False, False, False, ATTRS # '.' for attributes.
jpayne@69 22 TRY_F = False, False, False, FILES # '/' in quotes for file name.
jpayne@69 23
jpayne@69 24 # This string includes all chars that may be in an identifier.
jpayne@69 25 # TODO Update this here and elsewhere.
jpayne@69 26 ID_CHARS = string.ascii_letters + string.digits + "_"
jpayne@69 27
jpayne@69 28 SEPS = f"{os.sep}{os.altsep if os.altsep else ''}"
jpayne@69 29 TRIGGERS = f".{SEPS}"
jpayne@69 30
jpayne@69 31 class AutoComplete:
jpayne@69 32
jpayne@69 33 def __init__(self, editwin=None):
jpayne@69 34 self.editwin = editwin
jpayne@69 35 if editwin is not None: # not in subprocess or no-gui test
jpayne@69 36 self.text = editwin.text
jpayne@69 37 self.autocompletewindow = None
jpayne@69 38 # id of delayed call, and the index of the text insert when
jpayne@69 39 # the delayed call was issued. If _delayed_completion_id is
jpayne@69 40 # None, there is no delayed call.
jpayne@69 41 self._delayed_completion_id = None
jpayne@69 42 self._delayed_completion_index = None
jpayne@69 43
jpayne@69 44 @classmethod
jpayne@69 45 def reload(cls):
jpayne@69 46 cls.popupwait = idleConf.GetOption(
jpayne@69 47 "extensions", "AutoComplete", "popupwait", type="int", default=0)
jpayne@69 48
jpayne@69 49 def _make_autocomplete_window(self): # Makes mocking easier.
jpayne@69 50 return autocomplete_w.AutoCompleteWindow(self.text)
jpayne@69 51
jpayne@69 52 def _remove_autocomplete_window(self, event=None):
jpayne@69 53 if self.autocompletewindow:
jpayne@69 54 self.autocompletewindow.hide_window()
jpayne@69 55 self.autocompletewindow = None
jpayne@69 56
jpayne@69 57 def force_open_completions_event(self, event):
jpayne@69 58 "(^space) Open completion list, even if a function call is needed."
jpayne@69 59 self.open_completions(FORCE)
jpayne@69 60 return "break"
jpayne@69 61
jpayne@69 62 def autocomplete_event(self, event):
jpayne@69 63 "(tab) Complete word or open list if multiple options."
jpayne@69 64 if hasattr(event, "mc_state") and event.mc_state or\
jpayne@69 65 not self.text.get("insert linestart", "insert").strip():
jpayne@69 66 # A modifier was pressed along with the tab or
jpayne@69 67 # there is only previous whitespace on this line, so tab.
jpayne@69 68 return None
jpayne@69 69 if self.autocompletewindow and self.autocompletewindow.is_active():
jpayne@69 70 self.autocompletewindow.complete()
jpayne@69 71 return "break"
jpayne@69 72 else:
jpayne@69 73 opened = self.open_completions(TAB)
jpayne@69 74 return "break" if opened else None
jpayne@69 75
jpayne@69 76 def try_open_completions_event(self, event=None):
jpayne@69 77 "(./) Open completion list after pause with no movement."
jpayne@69 78 lastchar = self.text.get("insert-1c")
jpayne@69 79 if lastchar in TRIGGERS:
jpayne@69 80 args = TRY_A if lastchar == "." else TRY_F
jpayne@69 81 self._delayed_completion_index = self.text.index("insert")
jpayne@69 82 if self._delayed_completion_id is not None:
jpayne@69 83 self.text.after_cancel(self._delayed_completion_id)
jpayne@69 84 self._delayed_completion_id = self.text.after(
jpayne@69 85 self.popupwait, self._delayed_open_completions, args)
jpayne@69 86
jpayne@69 87 def _delayed_open_completions(self, args):
jpayne@69 88 "Call open_completions if index unchanged."
jpayne@69 89 self._delayed_completion_id = None
jpayne@69 90 if self.text.index("insert") == self._delayed_completion_index:
jpayne@69 91 self.open_completions(args)
jpayne@69 92
jpayne@69 93 def open_completions(self, args):
jpayne@69 94 """Find the completions and create the AutoCompleteWindow.
jpayne@69 95 Return True if successful (no syntax error or so found).
jpayne@69 96 If complete is True, then if there's nothing to complete and no
jpayne@69 97 start of completion, won't open completions and return False.
jpayne@69 98 If mode is given, will open a completion list only in this mode.
jpayne@69 99 """
jpayne@69 100 evalfuncs, complete, wantwin, mode = args
jpayne@69 101 # Cancel another delayed call, if it exists.
jpayne@69 102 if self._delayed_completion_id is not None:
jpayne@69 103 self.text.after_cancel(self._delayed_completion_id)
jpayne@69 104 self._delayed_completion_id = None
jpayne@69 105
jpayne@69 106 hp = HyperParser(self.editwin, "insert")
jpayne@69 107 curline = self.text.get("insert linestart", "insert")
jpayne@69 108 i = j = len(curline)
jpayne@69 109 if hp.is_in_string() and (not mode or mode==FILES):
jpayne@69 110 # Find the beginning of the string.
jpayne@69 111 # fetch_completions will look at the file system to determine
jpayne@69 112 # whether the string value constitutes an actual file name
jpayne@69 113 # XXX could consider raw strings here and unescape the string
jpayne@69 114 # value if it's not raw.
jpayne@69 115 self._remove_autocomplete_window()
jpayne@69 116 mode = FILES
jpayne@69 117 # Find last separator or string start
jpayne@69 118 while i and curline[i-1] not in "'\"" + SEPS:
jpayne@69 119 i -= 1
jpayne@69 120 comp_start = curline[i:j]
jpayne@69 121 j = i
jpayne@69 122 # Find string start
jpayne@69 123 while i and curline[i-1] not in "'\"":
jpayne@69 124 i -= 1
jpayne@69 125 comp_what = curline[i:j]
jpayne@69 126 elif hp.is_in_code() and (not mode or mode==ATTRS):
jpayne@69 127 self._remove_autocomplete_window()
jpayne@69 128 mode = ATTRS
jpayne@69 129 while i and (curline[i-1] in ID_CHARS or ord(curline[i-1]) > 127):
jpayne@69 130 i -= 1
jpayne@69 131 comp_start = curline[i:j]
jpayne@69 132 if i and curline[i-1] == '.': # Need object with attributes.
jpayne@69 133 hp.set_index("insert-%dc" % (len(curline)-(i-1)))
jpayne@69 134 comp_what = hp.get_expression()
jpayne@69 135 if (not comp_what or
jpayne@69 136 (not evalfuncs and comp_what.find('(') != -1)):
jpayne@69 137 return None
jpayne@69 138 else:
jpayne@69 139 comp_what = ""
jpayne@69 140 else:
jpayne@69 141 return None
jpayne@69 142
jpayne@69 143 if complete and not comp_what and not comp_start:
jpayne@69 144 return None
jpayne@69 145 comp_lists = self.fetch_completions(comp_what, mode)
jpayne@69 146 if not comp_lists[0]:
jpayne@69 147 return None
jpayne@69 148 self.autocompletewindow = self._make_autocomplete_window()
jpayne@69 149 return not self.autocompletewindow.show_window(
jpayne@69 150 comp_lists, "insert-%dc" % len(comp_start),
jpayne@69 151 complete, mode, wantwin)
jpayne@69 152
jpayne@69 153 def fetch_completions(self, what, mode):
jpayne@69 154 """Return a pair of lists of completions for something. The first list
jpayne@69 155 is a sublist of the second. Both are sorted.
jpayne@69 156
jpayne@69 157 If there is a Python subprocess, get the comp. list there. Otherwise,
jpayne@69 158 either fetch_completions() is running in the subprocess itself or it
jpayne@69 159 was called in an IDLE EditorWindow before any script had been run.
jpayne@69 160
jpayne@69 161 The subprocess environment is that of the most recently run script. If
jpayne@69 162 two unrelated modules are being edited some calltips in the current
jpayne@69 163 module may be inoperative if the module was not the last to run.
jpayne@69 164 """
jpayne@69 165 try:
jpayne@69 166 rpcclt = self.editwin.flist.pyshell.interp.rpcclt
jpayne@69 167 except:
jpayne@69 168 rpcclt = None
jpayne@69 169 if rpcclt:
jpayne@69 170 return rpcclt.remotecall("exec", "get_the_completion_list",
jpayne@69 171 (what, mode), {})
jpayne@69 172 else:
jpayne@69 173 if mode == ATTRS:
jpayne@69 174 if what == "":
jpayne@69 175 namespace = {**__main__.__builtins__.__dict__,
jpayne@69 176 **__main__.__dict__}
jpayne@69 177 bigl = eval("dir()", namespace)
jpayne@69 178 bigl.sort()
jpayne@69 179 if "__all__" in bigl:
jpayne@69 180 smalll = sorted(eval("__all__", namespace))
jpayne@69 181 else:
jpayne@69 182 smalll = [s for s in bigl if s[:1] != '_']
jpayne@69 183 else:
jpayne@69 184 try:
jpayne@69 185 entity = self.get_entity(what)
jpayne@69 186 bigl = dir(entity)
jpayne@69 187 bigl.sort()
jpayne@69 188 if "__all__" in bigl:
jpayne@69 189 smalll = sorted(entity.__all__)
jpayne@69 190 else:
jpayne@69 191 smalll = [s for s in bigl if s[:1] != '_']
jpayne@69 192 except:
jpayne@69 193 return [], []
jpayne@69 194
jpayne@69 195 elif mode == FILES:
jpayne@69 196 if what == "":
jpayne@69 197 what = "."
jpayne@69 198 try:
jpayne@69 199 expandedpath = os.path.expanduser(what)
jpayne@69 200 bigl = os.listdir(expandedpath)
jpayne@69 201 bigl.sort()
jpayne@69 202 smalll = [s for s in bigl if s[:1] != '.']
jpayne@69 203 except OSError:
jpayne@69 204 return [], []
jpayne@69 205
jpayne@69 206 if not smalll:
jpayne@69 207 smalll = bigl
jpayne@69 208 return smalll, bigl
jpayne@69 209
jpayne@69 210 def get_entity(self, name):
jpayne@69 211 "Lookup name in a namespace spanning sys.modules and __main.dict__."
jpayne@69 212 return eval(name, {**sys.modules, **__main__.__dict__})
jpayne@69 213
jpayne@69 214
jpayne@69 215 AutoComplete.reload()
jpayne@69 216
jpayne@69 217 if __name__ == '__main__':
jpayne@69 218 from unittest import main
jpayne@69 219 main('idlelib.idle_test.test_autocomplete', verbosity=2)