Show More
@@ -1,2060 +1,2066 b'' | |||
|
1 | 1 | """Completion for IPython. |
|
2 | 2 | |
|
3 | 3 | This module started as fork of the rlcompleter module in the Python standard |
|
4 | 4 | library. The original enhancements made to rlcompleter have been sent |
|
5 | 5 | upstream and were accepted as of Python 2.3, |
|
6 | 6 | |
|
7 | 7 | This module now support a wide variety of completion mechanism both available |
|
8 | 8 | for normal classic Python code, as well as completer for IPython specific |
|
9 | 9 | Syntax like magics. |
|
10 | 10 | |
|
11 | 11 | Latex and Unicode completion |
|
12 | 12 | ============================ |
|
13 | 13 | |
|
14 | 14 | IPython and compatible frontends not only can complete your code, but can help |
|
15 | 15 | you to input a wide range of characters. In particular we allow you to insert |
|
16 | 16 | a unicode character using the tab completion mechanism. |
|
17 | 17 | |
|
18 | 18 | Forward latex/unicode completion |
|
19 | 19 | -------------------------------- |
|
20 | 20 | |
|
21 | 21 | Forward completion allows you to easily type a unicode character using its latex |
|
22 | 22 | name, or unicode long description. To do so type a backslash follow by the |
|
23 | 23 | relevant name and press tab: |
|
24 | 24 | |
|
25 | 25 | |
|
26 | 26 | Using latex completion: |
|
27 | 27 | |
|
28 | 28 | .. code:: |
|
29 | 29 | |
|
30 | 30 | \\alpha<tab> |
|
31 | 31 | Ξ± |
|
32 | 32 | |
|
33 | 33 | or using unicode completion: |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | .. code:: |
|
37 | 37 | |
|
38 | 38 | \\greek small letter alpha<tab> |
|
39 | 39 | Ξ± |
|
40 | 40 | |
|
41 | 41 | |
|
42 | 42 | Only valid Python identifiers will complete. Combining characters (like arrow or |
|
43 | 43 | dots) are also available, unlike latex they need to be put after the their |
|
44 | 44 | counterpart that is to say, `F\\\\vec<tab>` is correct, not `\\\\vec<tab>F`. |
|
45 | 45 | |
|
46 | 46 | Some browsers are known to display combining characters incorrectly. |
|
47 | 47 | |
|
48 | 48 | Backward latex completion |
|
49 | 49 | ------------------------- |
|
50 | 50 | |
|
51 | 51 | It is sometime challenging to know how to type a character, if you are using |
|
52 | 52 | IPython, or any compatible frontend you can prepend backslash to the character |
|
53 | 53 | and press `<tab>` to expand it to its latex form. |
|
54 | 54 | |
|
55 | 55 | .. code:: |
|
56 | 56 | |
|
57 | 57 | \\Ξ±<tab> |
|
58 | 58 | \\alpha |
|
59 | 59 | |
|
60 | 60 | |
|
61 | 61 | Both forward and backward completions can be deactivated by setting the |
|
62 | 62 | ``Completer.backslash_combining_completions`` option to ``False``. |
|
63 | 63 | |
|
64 | 64 | |
|
65 | 65 | Experimental |
|
66 | 66 | ============ |
|
67 | 67 | |
|
68 | 68 | Starting with IPython 6.0, this module can make use of the Jedi library to |
|
69 | 69 | generate completions both using static analysis of the code, and dynamically |
|
70 | 70 | inspecting multiple namespaces. The APIs attached to this new mechanism is |
|
71 | 71 | unstable and will raise unless use in an :any:`provisionalcompleter` context |
|
72 | 72 | manager. |
|
73 | 73 | |
|
74 | 74 | You will find that the following are experimental: |
|
75 | 75 | |
|
76 | 76 | - :any:`provisionalcompleter` |
|
77 | 77 | - :any:`IPCompleter.completions` |
|
78 | 78 | - :any:`Completion` |
|
79 | 79 | - :any:`rectify_completions` |
|
80 | 80 | |
|
81 | 81 | .. note:: |
|
82 | 82 | |
|
83 | 83 | better name for :any:`rectify_completions` ? |
|
84 | 84 | |
|
85 | 85 | We welcome any feedback on these new API, and we also encourage you to try this |
|
86 | 86 | module in debug mode (start IPython with ``--Completer.debug=True``) in order |
|
87 | 87 | to have extra logging information is :any:`jedi` is crashing, or if current |
|
88 | 88 | IPython completer pending deprecations are returning results not yet handled |
|
89 | 89 | by :any:`jedi` |
|
90 | 90 | |
|
91 | 91 | Using Jedi for tab completion allow snippets like the following to work without |
|
92 | 92 | having to execute any code: |
|
93 | 93 | |
|
94 | 94 | >>> myvar = ['hello', 42] |
|
95 | 95 | ... myvar[1].bi<tab> |
|
96 | 96 | |
|
97 | 97 | Tab completion will be able to infer that ``myvar[1]`` is a real number without |
|
98 | 98 | executing any code unlike the previously available ``IPCompleter.greedy`` |
|
99 | 99 | option. |
|
100 | 100 | |
|
101 | 101 | Be sure to update :any:`jedi` to the latest stable version or to try the |
|
102 | 102 | current development version to get better completions. |
|
103 | 103 | """ |
|
104 | 104 | |
|
105 | 105 | |
|
106 | 106 | # Copyright (c) IPython Development Team. |
|
107 | 107 | # Distributed under the terms of the Modified BSD License. |
|
108 | 108 | # |
|
109 | 109 | # Some of this code originated from rlcompleter in the Python standard library |
|
110 | 110 | # Copyright (C) 2001 Python Software Foundation, www.python.org |
|
111 | 111 | |
|
112 | 112 | |
|
113 | 113 | import __main__ |
|
114 | 114 | import builtins as builtin_mod |
|
115 | 115 | import glob |
|
116 | 116 | import time |
|
117 | 117 | import inspect |
|
118 | 118 | import itertools |
|
119 | 119 | import keyword |
|
120 | 120 | import os |
|
121 | 121 | import re |
|
122 | 122 | import sys |
|
123 | 123 | import unicodedata |
|
124 | 124 | import string |
|
125 | 125 | import warnings |
|
126 | 126 | |
|
127 | 127 | from contextlib import contextmanager |
|
128 | 128 | from importlib import import_module |
|
129 | 129 | from typing import Iterator, List, Tuple, Iterable, Union |
|
130 | 130 | from types import SimpleNamespace |
|
131 | 131 | |
|
132 | 132 | from traitlets.config.configurable import Configurable |
|
133 | 133 | from IPython.core.error import TryNext |
|
134 | 134 | from IPython.core.inputtransformer2 import ESC_MAGIC |
|
135 | 135 | from IPython.core.latex_symbols import latex_symbols, reverse_latex_symbol |
|
136 | 136 | from IPython.core.oinspect import InspectColors |
|
137 | 137 | from IPython.utils import generics |
|
138 | 138 | from IPython.utils.dir2 import dir2, get_real_method |
|
139 | 139 | from IPython.utils.process import arg_split |
|
140 | 140 | from traitlets import Bool, Enum, observe, Int |
|
141 | 141 | |
|
142 | 142 | # skip module docstests |
|
143 | 143 | skip_doctest = True |
|
144 | 144 | |
|
145 | 145 | try: |
|
146 | 146 | import jedi |
|
147 | 147 | jedi.settings.case_insensitive_completion = False |
|
148 | 148 | import jedi.api.helpers |
|
149 | 149 | import jedi.api.classes |
|
150 | 150 | JEDI_INSTALLED = True |
|
151 | 151 | except ImportError: |
|
152 | 152 | JEDI_INSTALLED = False |
|
153 | 153 | #----------------------------------------------------------------------------- |
|
154 | 154 | # Globals |
|
155 | 155 | #----------------------------------------------------------------------------- |
|
156 | 156 | |
|
157 | 157 | # Public API |
|
158 | 158 | __all__ = ['Completer','IPCompleter'] |
|
159 | 159 | |
|
160 | 160 | if sys.platform == 'win32': |
|
161 | 161 | PROTECTABLES = ' ' |
|
162 | 162 | else: |
|
163 | 163 | PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&' |
|
164 | 164 | |
|
165 | 165 | # Protect against returning an enormous number of completions which the frontend |
|
166 | 166 | # may have trouble processing. |
|
167 | 167 | MATCHES_LIMIT = 500 |
|
168 | 168 | |
|
169 | 169 | _deprecation_readline_sentinel = object() |
|
170 | 170 | |
|
171 | 171 | |
|
172 | 172 | class ProvisionalCompleterWarning(FutureWarning): |
|
173 | 173 | """ |
|
174 | 174 | Exception raise by an experimental feature in this module. |
|
175 | 175 | |
|
176 | 176 | Wrap code in :any:`provisionalcompleter` context manager if you |
|
177 | 177 | are certain you want to use an unstable feature. |
|
178 | 178 | """ |
|
179 | 179 | pass |
|
180 | 180 | |
|
181 | 181 | warnings.filterwarnings('error', category=ProvisionalCompleterWarning) |
|
182 | 182 | |
|
183 | 183 | @contextmanager |
|
184 | 184 | def provisionalcompleter(action='ignore'): |
|
185 | 185 | """ |
|
186 | 186 | |
|
187 | 187 | |
|
188 | 188 | This contest manager has to be used in any place where unstable completer |
|
189 | 189 | behavior and API may be called. |
|
190 | 190 | |
|
191 | 191 | >>> with provisionalcompleter(): |
|
192 | 192 | ... completer.do_experimetal_things() # works |
|
193 | 193 | |
|
194 | 194 | >>> completer.do_experimental_things() # raises. |
|
195 | 195 | |
|
196 | 196 | .. note:: Unstable |
|
197 | 197 | |
|
198 | 198 | By using this context manager you agree that the API in use may change |
|
199 | 199 | without warning, and that you won't complain if they do so. |
|
200 | 200 | |
|
201 | 201 | You also understand that if the API is not to you liking you should report |
|
202 | 202 | a bug to explain your use case upstream and improve the API and will loose |
|
203 | 203 | credibility if you complain after the API is make stable. |
|
204 | 204 | |
|
205 | 205 | We'll be happy to get your feedback , feature request and improvement on |
|
206 | 206 | any of the unstable APIs ! |
|
207 | 207 | """ |
|
208 | 208 | with warnings.catch_warnings(): |
|
209 | 209 | warnings.filterwarnings(action, category=ProvisionalCompleterWarning) |
|
210 | 210 | yield |
|
211 | 211 | |
|
212 | 212 | |
|
213 | 213 | def has_open_quotes(s): |
|
214 | 214 | """Return whether a string has open quotes. |
|
215 | 215 | |
|
216 | 216 | This simply counts whether the number of quote characters of either type in |
|
217 | 217 | the string is odd. |
|
218 | 218 | |
|
219 | 219 | Returns |
|
220 | 220 | ------- |
|
221 | 221 | If there is an open quote, the quote character is returned. Else, return |
|
222 | 222 | False. |
|
223 | 223 | """ |
|
224 | 224 | # We check " first, then ', so complex cases with nested quotes will get |
|
225 | 225 | # the " to take precedence. |
|
226 | 226 | if s.count('"') % 2: |
|
227 | 227 | return '"' |
|
228 | 228 | elif s.count("'") % 2: |
|
229 | 229 | return "'" |
|
230 | 230 | else: |
|
231 | 231 | return False |
|
232 | 232 | |
|
233 | 233 | |
|
234 | 234 | def protect_filename(s, protectables=PROTECTABLES): |
|
235 | 235 | """Escape a string to protect certain characters.""" |
|
236 | 236 | if set(s) & set(protectables): |
|
237 | 237 | if sys.platform == "win32": |
|
238 | 238 | return '"' + s + '"' |
|
239 | 239 | else: |
|
240 | 240 | return "".join(("\\" + c if c in protectables else c) for c in s) |
|
241 | 241 | else: |
|
242 | 242 | return s |
|
243 | 243 | |
|
244 | 244 | |
|
245 | 245 | def expand_user(path:str) -> Tuple[str, bool, str]: |
|
246 | 246 | """Expand ``~``-style usernames in strings. |
|
247 | 247 | |
|
248 | 248 | This is similar to :func:`os.path.expanduser`, but it computes and returns |
|
249 | 249 | extra information that will be useful if the input was being used in |
|
250 | 250 | computing completions, and you wish to return the completions with the |
|
251 | 251 | original '~' instead of its expanded value. |
|
252 | 252 | |
|
253 | 253 | Parameters |
|
254 | 254 | ---------- |
|
255 | 255 | path : str |
|
256 | 256 | String to be expanded. If no ~ is present, the output is the same as the |
|
257 | 257 | input. |
|
258 | 258 | |
|
259 | 259 | Returns |
|
260 | 260 | ------- |
|
261 | 261 | newpath : str |
|
262 | 262 | Result of ~ expansion in the input path. |
|
263 | 263 | tilde_expand : bool |
|
264 | 264 | Whether any expansion was performed or not. |
|
265 | 265 | tilde_val : str |
|
266 | 266 | The value that ~ was replaced with. |
|
267 | 267 | """ |
|
268 | 268 | # Default values |
|
269 | 269 | tilde_expand = False |
|
270 | 270 | tilde_val = '' |
|
271 | 271 | newpath = path |
|
272 | 272 | |
|
273 | 273 | if path.startswith('~'): |
|
274 | 274 | tilde_expand = True |
|
275 | 275 | rest = len(path)-1 |
|
276 | 276 | newpath = os.path.expanduser(path) |
|
277 | 277 | if rest: |
|
278 | 278 | tilde_val = newpath[:-rest] |
|
279 | 279 | else: |
|
280 | 280 | tilde_val = newpath |
|
281 | 281 | |
|
282 | 282 | return newpath, tilde_expand, tilde_val |
|
283 | 283 | |
|
284 | 284 | |
|
285 | 285 | def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str: |
|
286 | 286 | """Does the opposite of expand_user, with its outputs. |
|
287 | 287 | """ |
|
288 | 288 | if tilde_expand: |
|
289 | 289 | return path.replace(tilde_val, '~') |
|
290 | 290 | else: |
|
291 | 291 | return path |
|
292 | 292 | |
|
293 | 293 | |
|
294 | 294 | def completions_sorting_key(word): |
|
295 | 295 | """key for sorting completions |
|
296 | 296 | |
|
297 | 297 | This does several things: |
|
298 | 298 | |
|
299 | 299 | - Demote any completions starting with underscores to the end |
|
300 | 300 | - Insert any %magic and %%cellmagic completions in the alphabetical order |
|
301 | 301 | by their name |
|
302 | 302 | """ |
|
303 | 303 | prio1, prio2 = 0, 0 |
|
304 | 304 | |
|
305 | 305 | if word.startswith('__'): |
|
306 | 306 | prio1 = 2 |
|
307 | 307 | elif word.startswith('_'): |
|
308 | 308 | prio1 = 1 |
|
309 | 309 | |
|
310 | 310 | if word.endswith('='): |
|
311 | 311 | prio1 = -1 |
|
312 | 312 | |
|
313 | 313 | if word.startswith('%%'): |
|
314 | 314 | # If there's another % in there, this is something else, so leave it alone |
|
315 | 315 | if not "%" in word[2:]: |
|
316 | 316 | word = word[2:] |
|
317 | 317 | prio2 = 2 |
|
318 | 318 | elif word.startswith('%'): |
|
319 | 319 | if not "%" in word[1:]: |
|
320 | 320 | word = word[1:] |
|
321 | 321 | prio2 = 1 |
|
322 | 322 | |
|
323 | 323 | return prio1, word, prio2 |
|
324 | 324 | |
|
325 | 325 | |
|
326 | 326 | class _FakeJediCompletion: |
|
327 | 327 | """ |
|
328 | 328 | This is a workaround to communicate to the UI that Jedi has crashed and to |
|
329 | 329 | report a bug. Will be used only id :any:`IPCompleter.debug` is set to true. |
|
330 | 330 | |
|
331 | 331 | Added in IPython 6.0 so should likely be removed for 7.0 |
|
332 | 332 | |
|
333 | 333 | """ |
|
334 | 334 | |
|
335 | 335 | def __init__(self, name): |
|
336 | 336 | |
|
337 | 337 | self.name = name |
|
338 | 338 | self.complete = name |
|
339 | 339 | self.type = 'crashed' |
|
340 | 340 | self.name_with_symbols = name |
|
341 | 341 | self.signature = '' |
|
342 | 342 | self._origin = 'fake' |
|
343 | 343 | |
|
344 | 344 | def __repr__(self): |
|
345 | 345 | return '<Fake completion object jedi has crashed>' |
|
346 | 346 | |
|
347 | 347 | |
|
348 | 348 | class Completion: |
|
349 | 349 | """ |
|
350 | 350 | Completion object used and return by IPython completers. |
|
351 | 351 | |
|
352 | 352 | .. warning:: Unstable |
|
353 | ||
|
353 | ||
|
354 | 354 | This function is unstable, API may change without warning. |
|
355 | 355 | It will also raise unless use in proper context manager. |
|
356 | 356 | |
|
357 | 357 | This act as a middle ground :any:`Completion` object between the |
|
358 | 358 | :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion |
|
359 | 359 | object. While Jedi need a lot of information about evaluator and how the |
|
360 | 360 | code should be ran/inspected, PromptToolkit (and other frontend) mostly |
|
361 | 361 | need user facing information. |
|
362 | 362 | |
|
363 | 363 | - Which range should be replaced replaced by what. |
|
364 | 364 | - Some metadata (like completion type), or meta information to displayed to |
|
365 | 365 | the use user. |
|
366 | 366 | |
|
367 | 367 | For debugging purpose we can also store the origin of the completion (``jedi``, |
|
368 | 368 | ``IPython.python_matches``, ``IPython.magics_matches``...). |
|
369 | 369 | """ |
|
370 | 370 | |
|
371 | 371 | __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin'] |
|
372 | 372 | |
|
373 | 373 | def __init__(self, start: int, end: int, text: str, *, type: str=None, _origin='', signature='') -> None: |
|
374 | 374 | warnings.warn("``Completion`` is a provisional API (as of IPython 6.0). " |
|
375 | 375 | "It may change without warnings. " |
|
376 | 376 | "Use in corresponding context manager.", |
|
377 | 377 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
378 | 378 | |
|
379 | 379 | self.start = start |
|
380 | 380 | self.end = end |
|
381 | 381 | self.text = text |
|
382 | 382 | self.type = type |
|
383 | 383 | self.signature = signature |
|
384 | 384 | self._origin = _origin |
|
385 | 385 | |
|
386 | 386 | def __repr__(self): |
|
387 | 387 | return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \ |
|
388 | 388 | (self.start, self.end, self.text, self.type or '?', self.signature or '?') |
|
389 | 389 | |
|
390 | 390 | def __eq__(self, other)->Bool: |
|
391 | 391 | """ |
|
392 | 392 | Equality and hash do not hash the type (as some completer may not be |
|
393 | 393 | able to infer the type), but are use to (partially) de-duplicate |
|
394 | 394 | completion. |
|
395 | 395 | |
|
396 | 396 | Completely de-duplicating completion is a bit tricker that just |
|
397 | 397 | comparing as it depends on surrounding text, which Completions are not |
|
398 | 398 | aware of. |
|
399 | 399 | """ |
|
400 | 400 | return self.start == other.start and \ |
|
401 | 401 | self.end == other.end and \ |
|
402 | 402 | self.text == other.text |
|
403 | 403 | |
|
404 | 404 | def __hash__(self): |
|
405 | 405 | return hash((self.start, self.end, self.text)) |
|
406 | 406 | |
|
407 | 407 | |
|
408 | 408 | _IC = Iterable[Completion] |
|
409 | 409 | |
|
410 | 410 | |
|
411 | 411 | def _deduplicate_completions(text: str, completions: _IC)-> _IC: |
|
412 | 412 | """ |
|
413 | 413 | Deduplicate a set of completions. |
|
414 | 414 | |
|
415 | 415 | .. warning:: Unstable |
|
416 | 416 | |
|
417 | 417 | This function is unstable, API may change without warning. |
|
418 | 418 | |
|
419 | 419 | Parameters |
|
420 | 420 | ---------- |
|
421 | 421 | text: str |
|
422 | 422 | text that should be completed. |
|
423 | 423 | completions: Iterator[Completion] |
|
424 | 424 | iterator over the completions to deduplicate |
|
425 | 425 | |
|
426 | 426 | Yields |
|
427 | 427 | ------ |
|
428 | 428 | `Completions` objects |
|
429 | 429 | |
|
430 | 430 | |
|
431 | 431 | Completions coming from multiple sources, may be different but end up having |
|
432 | 432 | the same effect when applied to ``text``. If this is the case, this will |
|
433 | 433 | consider completions as equal and only emit the first encountered. |
|
434 | 434 | |
|
435 | 435 | Not folded in `completions()` yet for debugging purpose, and to detect when |
|
436 | 436 | the IPython completer does return things that Jedi does not, but should be |
|
437 | 437 | at some point. |
|
438 | 438 | """ |
|
439 | 439 | completions = list(completions) |
|
440 | 440 | if not completions: |
|
441 | 441 | return |
|
442 | 442 | |
|
443 | 443 | new_start = min(c.start for c in completions) |
|
444 | 444 | new_end = max(c.end for c in completions) |
|
445 | 445 | |
|
446 | 446 | seen = set() |
|
447 | 447 | for c in completions: |
|
448 | 448 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
449 | 449 | if new_text not in seen: |
|
450 | 450 | yield c |
|
451 | 451 | seen.add(new_text) |
|
452 | 452 | |
|
453 | 453 | |
|
454 | 454 | def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC: |
|
455 | 455 | """ |
|
456 | 456 | Rectify a set of completions to all have the same ``start`` and ``end`` |
|
457 | 457 | |
|
458 | 458 | .. warning:: Unstable |
|
459 | 459 | |
|
460 | 460 | This function is unstable, API may change without warning. |
|
461 | 461 | It will also raise unless use in proper context manager. |
|
462 | 462 | |
|
463 | 463 | Parameters |
|
464 | 464 | ---------- |
|
465 | 465 | text: str |
|
466 | 466 | text that should be completed. |
|
467 | 467 | completions: Iterator[Completion] |
|
468 | 468 | iterator over the completions to rectify |
|
469 | 469 | |
|
470 | 470 | |
|
471 | 471 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though |
|
472 | 472 | the Jupyter Protocol requires them to behave like so. This will readjust |
|
473 | 473 | the completion to have the same ``start`` and ``end`` by padding both |
|
474 | 474 | extremities with surrounding text. |
|
475 | 475 | |
|
476 | 476 | During stabilisation should support a ``_debug`` option to log which |
|
477 | 477 | completion are return by the IPython completer and not found in Jedi in |
|
478 | 478 | order to make upstream bug report. |
|
479 | 479 | """ |
|
480 | 480 | warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). " |
|
481 | 481 | "It may change without warnings. " |
|
482 | 482 | "Use in corresponding context manager.", |
|
483 | 483 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
484 | 484 | |
|
485 | 485 | completions = list(completions) |
|
486 | 486 | if not completions: |
|
487 | 487 | return |
|
488 | 488 | starts = (c.start for c in completions) |
|
489 | 489 | ends = (c.end for c in completions) |
|
490 | 490 | |
|
491 | 491 | new_start = min(starts) |
|
492 | 492 | new_end = max(ends) |
|
493 | 493 | |
|
494 | 494 | seen_jedi = set() |
|
495 | 495 | seen_python_matches = set() |
|
496 | 496 | for c in completions: |
|
497 | 497 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
498 | 498 | if c._origin == 'jedi': |
|
499 | 499 | seen_jedi.add(new_text) |
|
500 | 500 | elif c._origin == 'IPCompleter.python_matches': |
|
501 | 501 | seen_python_matches.add(new_text) |
|
502 | 502 | yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature) |
|
503 | 503 | diff = seen_python_matches.difference(seen_jedi) |
|
504 | 504 | if diff and _debug: |
|
505 | 505 | print('IPython.python matches have extras:', diff) |
|
506 | 506 | |
|
507 | 507 | |
|
508 | 508 | if sys.platform == 'win32': |
|
509 | 509 | DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?' |
|
510 | 510 | else: |
|
511 | 511 | DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' |
|
512 | 512 | |
|
513 | 513 | GREEDY_DELIMS = ' =\r\n' |
|
514 | 514 | |
|
515 | 515 | |
|
516 | 516 | class CompletionSplitter(object): |
|
517 | 517 | """An object to split an input line in a manner similar to readline. |
|
518 | 518 | |
|
519 | 519 | By having our own implementation, we can expose readline-like completion in |
|
520 | 520 | a uniform manner to all frontends. This object only needs to be given the |
|
521 | 521 | line of text to be split and the cursor position on said line, and it |
|
522 | 522 | returns the 'word' to be completed on at the cursor after splitting the |
|
523 | 523 | entire line. |
|
524 | 524 | |
|
525 | 525 | What characters are used as splitting delimiters can be controlled by |
|
526 | 526 | setting the ``delims`` attribute (this is a property that internally |
|
527 | 527 | automatically builds the necessary regular expression)""" |
|
528 | 528 | |
|
529 | 529 | # Private interface |
|
530 | 530 | |
|
531 | 531 | # A string of delimiter characters. The default value makes sense for |
|
532 | 532 | # IPython's most typical usage patterns. |
|
533 | 533 | _delims = DELIMS |
|
534 | 534 | |
|
535 | 535 | # The expression (a normal string) to be compiled into a regular expression |
|
536 | 536 | # for actual splitting. We store it as an attribute mostly for ease of |
|
537 | 537 | # debugging, since this type of code can be so tricky to debug. |
|
538 | 538 | _delim_expr = None |
|
539 | 539 | |
|
540 | 540 | # The regular expression that does the actual splitting |
|
541 | 541 | _delim_re = None |
|
542 | 542 | |
|
543 | 543 | def __init__(self, delims=None): |
|
544 | 544 | delims = CompletionSplitter._delims if delims is None else delims |
|
545 | 545 | self.delims = delims |
|
546 | 546 | |
|
547 | 547 | @property |
|
548 | 548 | def delims(self): |
|
549 | 549 | """Return the string of delimiter characters.""" |
|
550 | 550 | return self._delims |
|
551 | 551 | |
|
552 | 552 | @delims.setter |
|
553 | 553 | def delims(self, delims): |
|
554 | 554 | """Set the delimiters for line splitting.""" |
|
555 | 555 | expr = '[' + ''.join('\\'+ c for c in delims) + ']' |
|
556 | 556 | self._delim_re = re.compile(expr) |
|
557 | 557 | self._delims = delims |
|
558 | 558 | self._delim_expr = expr |
|
559 | 559 | |
|
560 | 560 | def split_line(self, line, cursor_pos=None): |
|
561 | 561 | """Split a line of text with a cursor at the given position. |
|
562 | 562 | """ |
|
563 | 563 | l = line if cursor_pos is None else line[:cursor_pos] |
|
564 | 564 | return self._delim_re.split(l)[-1] |
|
565 | 565 | |
|
566 | 566 | |
|
567 | 567 | |
|
568 | 568 | class Completer(Configurable): |
|
569 | 569 | |
|
570 | 570 | greedy = Bool(False, |
|
571 | 571 | help="""Activate greedy completion |
|
572 | 572 | PENDING DEPRECTION. this is now mostly taken care of with Jedi. |
|
573 | 573 | |
|
574 | 574 | This will enable completion on elements of lists, results of function calls, etc., |
|
575 | 575 | but can be unsafe because the code is actually evaluated on TAB. |
|
576 | 576 | """ |
|
577 | 577 | ).tag(config=True) |
|
578 | 578 | |
|
579 | 579 | use_jedi = Bool(default_value=False, |
|
580 | 580 | help="Experimental: Use Jedi to generate autocompletions. " |
|
581 | 581 | "Off by default.").tag(config=True) |
|
582 | 582 | |
|
583 | 583 | jedi_compute_type_timeout = Int(default_value=400, |
|
584 | 584 | help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types. |
|
585 | 585 | Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt |
|
586 | 586 | performance by preventing jedi to build its cache. |
|
587 | 587 | """).tag(config=True) |
|
588 | 588 | |
|
589 | 589 | debug = Bool(default_value=False, |
|
590 | 590 | help='Enable debug for the Completer. Mostly print extra ' |
|
591 | 591 | 'information for experimental jedi integration.')\ |
|
592 | 592 | .tag(config=True) |
|
593 | 593 | |
|
594 |
backslash_combining_completions = Bool(True, |
|
|
594 | backslash_combining_completions = Bool(True, | |
|
595 | 595 | help="Enable unicode completions, e.g. \\alpha<tab> . " |
|
596 | 596 | "Includes completion of latex commands, unicode names, and expanding " |
|
597 | 597 | "unicode characters back to latex commands.").tag(config=True) |
|
598 | 598 | |
|
599 | 599 | |
|
600 | 600 | |
|
601 | 601 | def __init__(self, namespace=None, global_namespace=None, **kwargs): |
|
602 | 602 | """Create a new completer for the command line. |
|
603 | 603 | |
|
604 | 604 | Completer(namespace=ns, global_namespace=ns2) -> completer instance. |
|
605 | 605 | |
|
606 | 606 | If unspecified, the default namespace where completions are performed |
|
607 | 607 | is __main__ (technically, __main__.__dict__). Namespaces should be |
|
608 | 608 | given as dictionaries. |
|
609 | 609 | |
|
610 | 610 | An optional second namespace can be given. This allows the completer |
|
611 | 611 | to handle cases where both the local and global scopes need to be |
|
612 | 612 | distinguished. |
|
613 | 613 | """ |
|
614 | 614 | |
|
615 | 615 | # Don't bind to namespace quite yet, but flag whether the user wants a |
|
616 | 616 | # specific namespace or to use __main__.__dict__. This will allow us |
|
617 | 617 | # to bind to __main__.__dict__ at completion time, not now. |
|
618 | 618 | if namespace is None: |
|
619 | 619 | self.use_main_ns = True |
|
620 | 620 | else: |
|
621 | 621 | self.use_main_ns = False |
|
622 | 622 | self.namespace = namespace |
|
623 | 623 | |
|
624 | 624 | # The global namespace, if given, can be bound directly |
|
625 | 625 | if global_namespace is None: |
|
626 | 626 | self.global_namespace = {} |
|
627 | 627 | else: |
|
628 | 628 | self.global_namespace = global_namespace |
|
629 | 629 | |
|
630 | 630 | super(Completer, self).__init__(**kwargs) |
|
631 | 631 | |
|
632 | 632 | def complete(self, text, state): |
|
633 | 633 | """Return the next possible completion for 'text'. |
|
634 | 634 | |
|
635 | 635 | This is called successively with state == 0, 1, 2, ... until it |
|
636 | 636 | returns None. The completion should begin with 'text'. |
|
637 | 637 | |
|
638 | 638 | """ |
|
639 | 639 | if self.use_main_ns: |
|
640 | 640 | self.namespace = __main__.__dict__ |
|
641 | 641 | |
|
642 | 642 | if state == 0: |
|
643 | 643 | if "." in text: |
|
644 | 644 | self.matches = self.attr_matches(text) |
|
645 | 645 | else: |
|
646 | 646 | self.matches = self.global_matches(text) |
|
647 | 647 | try: |
|
648 | 648 | return self.matches[state] |
|
649 | 649 | except IndexError: |
|
650 | 650 | return None |
|
651 | 651 | |
|
652 | 652 | def global_matches(self, text): |
|
653 | 653 | """Compute matches when text is a simple name. |
|
654 | 654 | |
|
655 | 655 | Return a list of all keywords, built-in functions and names currently |
|
656 | 656 | defined in self.namespace or self.global_namespace that match. |
|
657 | 657 | |
|
658 | 658 | """ |
|
659 | 659 | matches = [] |
|
660 | 660 | match_append = matches.append |
|
661 | 661 | n = len(text) |
|
662 | 662 | for lst in [keyword.kwlist, |
|
663 | 663 | builtin_mod.__dict__.keys(), |
|
664 | 664 | self.namespace.keys(), |
|
665 | 665 | self.global_namespace.keys()]: |
|
666 | 666 | for word in lst: |
|
667 | 667 | if word[:n] == text and word != "__builtins__": |
|
668 | 668 | match_append(word) |
|
669 | 669 | |
|
670 | 670 | snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z") |
|
671 | 671 | for lst in [self.namespace.keys(), |
|
672 | 672 | self.global_namespace.keys()]: |
|
673 | 673 | shortened = {"_".join([sub[0] for sub in word.split('_')]) : word |
|
674 | 674 | for word in lst if snake_case_re.match(word)} |
|
675 | 675 | for word in shortened.keys(): |
|
676 | 676 | if word[:n] == text and word != "__builtins__": |
|
677 | 677 | match_append(shortened[word]) |
|
678 | 678 | return matches |
|
679 | 679 | |
|
680 | 680 | def attr_matches(self, text): |
|
681 | 681 | """Compute matches when text contains a dot. |
|
682 | 682 | |
|
683 | 683 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
684 | 684 | evaluatable in self.namespace or self.global_namespace, it will be |
|
685 | 685 | evaluated and its attributes (as revealed by dir()) are used as |
|
686 | 686 | possible completions. (For class instances, class members are |
|
687 | 687 | also considered.) |
|
688 | 688 | |
|
689 | 689 | WARNING: this can still invoke arbitrary C code, if an object |
|
690 | 690 | with a __getattr__ hook is evaluated. |
|
691 | 691 | |
|
692 | 692 | """ |
|
693 | 693 | |
|
694 | 694 | # Another option, seems to work great. Catches things like ''.<tab> |
|
695 | 695 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
696 | ||
|
696 | ||
|
697 | 697 | if m: |
|
698 | 698 | expr, attr = m.group(1, 3) |
|
699 | 699 | elif self.greedy: |
|
700 | 700 | m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer) |
|
701 | 701 | if not m2: |
|
702 | 702 | return [] |
|
703 | 703 | expr, attr = m2.group(1,2) |
|
704 | 704 | else: |
|
705 | 705 | return [] |
|
706 | ||
|
706 | ||
|
707 | 707 | try: |
|
708 | 708 | obj = eval(expr, self.namespace) |
|
709 | 709 | except: |
|
710 | 710 | try: |
|
711 | 711 | obj = eval(expr, self.global_namespace) |
|
712 | 712 | except: |
|
713 | 713 | return [] |
|
714 | 714 | |
|
715 | 715 | if self.limit_to__all__ and hasattr(obj, '__all__'): |
|
716 | 716 | words = get__all__entries(obj) |
|
717 | 717 | else: |
|
718 | 718 | words = dir2(obj) |
|
719 | 719 | |
|
720 | 720 | try: |
|
721 | 721 | words = generics.complete_object(obj, words) |
|
722 | 722 | except TryNext: |
|
723 | 723 | pass |
|
724 | 724 | except AssertionError: |
|
725 | 725 | raise |
|
726 | 726 | except Exception: |
|
727 | 727 | # Silence errors from completion function |
|
728 | 728 | #raise # dbg |
|
729 | 729 | pass |
|
730 | 730 | # Build match list to return |
|
731 | 731 | n = len(attr) |
|
732 | 732 | return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
733 | 733 | |
|
734 | 734 | |
|
735 | 735 | def get__all__entries(obj): |
|
736 | 736 | """returns the strings in the __all__ attribute""" |
|
737 | 737 | try: |
|
738 | 738 | words = getattr(obj, '__all__') |
|
739 | 739 | except: |
|
740 | 740 | return [] |
|
741 | ||
|
741 | ||
|
742 | 742 | return [w for w in words if isinstance(w, str)] |
|
743 | 743 | |
|
744 | 744 | |
|
745 | 745 | def match_dict_keys(keys: List[str], prefix: str, delims: str): |
|
746 | 746 | """Used by dict_key_matches, matching the prefix to a list of keys |
|
747 | 747 | |
|
748 | 748 | Parameters |
|
749 | 749 | ========== |
|
750 | 750 | keys: |
|
751 | 751 | list of keys in dictionary currently being completed. |
|
752 | 752 | prefix: |
|
753 | 753 | Part of the text already typed by the user. e.g. `mydict[b'fo` |
|
754 | 754 | delims: |
|
755 | 755 | String of delimiters to consider when finding the current key. |
|
756 | 756 | |
|
757 | 757 | Returns |
|
758 | 758 | ======= |
|
759 | 759 | |
|
760 | 760 | A tuple of three elements: ``quote``, ``token_start``, ``matched``, with |
|
761 | 761 | ``quote`` being the quote that need to be used to close current string. |
|
762 | 762 | ``token_start`` the position where the replacement should start occurring, |
|
763 | 763 | ``matches`` a list of replacement/completion |
|
764 | 764 | |
|
765 | 765 | """ |
|
766 | 766 | if not prefix: |
|
767 | 767 | return None, 0, [repr(k) for k in keys |
|
768 | 768 | if isinstance(k, (str, bytes))] |
|
769 | 769 | quote_match = re.search('["\']', prefix) |
|
770 | 770 | quote = quote_match.group() |
|
771 | 771 | try: |
|
772 | 772 | prefix_str = eval(prefix + quote, {}) |
|
773 | 773 | except Exception: |
|
774 | 774 | return None, 0, [] |
|
775 | 775 | |
|
776 | 776 | pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$' |
|
777 | 777 | token_match = re.search(pattern, prefix, re.UNICODE) |
|
778 | 778 | token_start = token_match.start() |
|
779 | 779 | token_prefix = token_match.group() |
|
780 | 780 | |
|
781 | 781 | matched = [] |
|
782 | 782 | for key in keys: |
|
783 | 783 | try: |
|
784 | 784 | if not key.startswith(prefix_str): |
|
785 | 785 | continue |
|
786 | 786 | except (AttributeError, TypeError, UnicodeError): |
|
787 | 787 | # Python 3+ TypeError on b'a'.startswith('a') or vice-versa |
|
788 | 788 | continue |
|
789 | 789 | |
|
790 | 790 | # reformat remainder of key to begin with prefix |
|
791 | 791 | rem = key[len(prefix_str):] |
|
792 | 792 | # force repr wrapped in ' |
|
793 | 793 | rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"') |
|
794 | 794 | if rem_repr.startswith('u') and prefix[0] not in 'uU': |
|
795 | 795 | # Found key is unicode, but prefix is Py2 string. |
|
796 | 796 | # Therefore attempt to interpret key as string. |
|
797 | 797 | try: |
|
798 | 798 | rem_repr = repr(rem.encode('ascii') + '"') |
|
799 | 799 | except UnicodeEncodeError: |
|
800 | 800 | continue |
|
801 | 801 | |
|
802 | 802 | rem_repr = rem_repr[1 + rem_repr.index("'"):-2] |
|
803 | 803 | if quote == '"': |
|
804 | 804 | # The entered prefix is quoted with ", |
|
805 | 805 | # but the match is quoted with '. |
|
806 | 806 | # A contained " hence needs escaping for comparison: |
|
807 | 807 | rem_repr = rem_repr.replace('"', '\\"') |
|
808 | 808 | |
|
809 | 809 | # then reinsert prefix from start of token |
|
810 | 810 | matched.append('%s%s' % (token_prefix, rem_repr)) |
|
811 | 811 | return quote, token_start, matched |
|
812 | 812 | |
|
813 | 813 | |
|
814 | 814 | def cursor_to_position(text:str, line:int, column:int)->int: |
|
815 | 815 | """ |
|
816 | 816 | |
|
817 | 817 | Convert the (line,column) position of the cursor in text to an offset in a |
|
818 | 818 | string. |
|
819 | 819 | |
|
820 | 820 | Parameters |
|
821 | 821 | ---------- |
|
822 | 822 | |
|
823 | 823 | text : str |
|
824 | 824 | The text in which to calculate the cursor offset |
|
825 | 825 | line : int |
|
826 | 826 | Line of the cursor; 0-indexed |
|
827 | 827 | column : int |
|
828 | 828 | Column of the cursor 0-indexed |
|
829 | 829 | |
|
830 | 830 | Return |
|
831 | 831 | ------ |
|
832 | 832 | Position of the cursor in ``text``, 0-indexed. |
|
833 | 833 | |
|
834 | 834 | See Also |
|
835 | 835 | -------- |
|
836 | 836 | position_to_cursor: reciprocal of this function |
|
837 | 837 | |
|
838 | 838 | """ |
|
839 | 839 | lines = text.split('\n') |
|
840 | 840 | assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines))) |
|
841 | 841 | |
|
842 | 842 | return sum(len(l) + 1 for l in lines[:line]) + column |
|
843 | 843 | |
|
844 | 844 | def position_to_cursor(text:str, offset:int)->Tuple[int, int]: |
|
845 | 845 | """ |
|
846 | 846 | Convert the position of the cursor in text (0 indexed) to a line |
|
847 | 847 | number(0-indexed) and a column number (0-indexed) pair |
|
848 | 848 | |
|
849 | 849 | Position should be a valid position in ``text``. |
|
850 | 850 | |
|
851 | 851 | Parameters |
|
852 | 852 | ---------- |
|
853 | 853 | |
|
854 | 854 | text : str |
|
855 | 855 | The text in which to calculate the cursor offset |
|
856 | 856 | offset : int |
|
857 | 857 | Position of the cursor in ``text``, 0-indexed. |
|
858 | 858 | |
|
859 | 859 | Return |
|
860 | 860 | ------ |
|
861 | 861 | (line, column) : (int, int) |
|
862 | 862 | Line of the cursor; 0-indexed, column of the cursor 0-indexed |
|
863 | 863 | |
|
864 | 864 | |
|
865 | 865 | See Also |
|
866 | 866 | -------- |
|
867 | 867 | cursor_to_position : reciprocal of this function |
|
868 | 868 | |
|
869 | 869 | |
|
870 | 870 | """ |
|
871 | 871 | |
|
872 | 872 | assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text)) |
|
873 | 873 | |
|
874 | 874 | before = text[:offset] |
|
875 | 875 | blines = before.split('\n') # ! splitnes trim trailing \n |
|
876 | 876 | line = before.count('\n') |
|
877 | 877 | col = len(blines[-1]) |
|
878 | 878 | return line, col |
|
879 | 879 | |
|
880 | 880 | |
|
881 | 881 | def _safe_isinstance(obj, module, class_name): |
|
882 | 882 | """Checks if obj is an instance of module.class_name if loaded |
|
883 | 883 | """ |
|
884 | 884 | return (module in sys.modules and |
|
885 | 885 | isinstance(obj, getattr(import_module(module), class_name))) |
|
886 | 886 | |
|
887 | 887 | |
|
888 | 888 | def back_unicode_name_matches(text): |
|
889 | 889 | u"""Match unicode characters back to unicode name |
|
890 | ||
|
890 | ||
|
891 | 891 | This does ``β`` -> ``\\snowman`` |
|
892 | 892 | |
|
893 | 893 | Note that snowman is not a valid python3 combining character but will be expanded. |
|
894 | 894 | Though it will not recombine back to the snowman character by the completion machinery. |
|
895 | 895 | |
|
896 | 896 | This will not either back-complete standard sequences like \\n, \\b ... |
|
897 | ||
|
897 | ||
|
898 | 898 | Used on Python 3 only. |
|
899 | 899 | """ |
|
900 | 900 | if len(text)<2: |
|
901 | 901 | return u'', () |
|
902 | 902 | maybe_slash = text[-2] |
|
903 | 903 | if maybe_slash != '\\': |
|
904 | 904 | return u'', () |
|
905 | 905 | |
|
906 | 906 | char = text[-1] |
|
907 | 907 | # no expand on quote for completion in strings. |
|
908 | 908 | # nor backcomplete standard ascii keys |
|
909 | 909 | if char in string.ascii_letters or char in ['"',"'"]: |
|
910 | 910 | return u'', () |
|
911 | 911 | try : |
|
912 | 912 | unic = unicodedata.name(char) |
|
913 | 913 | return '\\'+char,['\\'+unic] |
|
914 | 914 | except KeyError: |
|
915 | 915 | pass |
|
916 | 916 | return u'', () |
|
917 | 917 | |
|
918 | 918 | def back_latex_name_matches(text:str): |
|
919 | 919 | """Match latex characters back to unicode name |
|
920 | ||
|
920 | ||
|
921 | 921 | This does ``\\β΅`` -> ``\\aleph`` |
|
922 | 922 | |
|
923 | 923 | Used on Python 3 only. |
|
924 | 924 | """ |
|
925 | 925 | if len(text)<2: |
|
926 | 926 | return u'', () |
|
927 | 927 | maybe_slash = text[-2] |
|
928 | 928 | if maybe_slash != '\\': |
|
929 | 929 | return u'', () |
|
930 | 930 | |
|
931 | 931 | |
|
932 | 932 | char = text[-1] |
|
933 | 933 | # no expand on quote for completion in strings. |
|
934 | 934 | # nor backcomplete standard ascii keys |
|
935 | 935 | if char in string.ascii_letters or char in ['"',"'"]: |
|
936 | 936 | return u'', () |
|
937 | 937 | try : |
|
938 | 938 | latex = reverse_latex_symbol[char] |
|
939 | 939 | # '\\' replace the \ as well |
|
940 | 940 | return '\\'+char,[latex] |
|
941 | 941 | except KeyError: |
|
942 | 942 | pass |
|
943 | 943 | return u'', () |
|
944 | 944 | |
|
945 | 945 | |
|
946 | 946 | def _formatparamchildren(parameter) -> str: |
|
947 | 947 | """ |
|
948 | 948 | Get parameter name and value from Jedi Private API |
|
949 | 949 | |
|
950 | 950 | Jedi does not expose a simple way to get `param=value` from its API. |
|
951 | 951 | |
|
952 | 952 | Parameter |
|
953 | 953 | ========= |
|
954 | 954 | |
|
955 | 955 | parameter: |
|
956 | 956 | Jedi's function `Param` |
|
957 | 957 | |
|
958 | 958 | Returns |
|
959 | 959 | ======= |
|
960 | 960 | |
|
961 | 961 | A string like 'a', 'b=1', '*args', '**kwargs' |
|
962 | 962 | |
|
963 | 963 | |
|
964 | 964 | """ |
|
965 | 965 | description = parameter.description |
|
966 | 966 | if not description.startswith('param '): |
|
967 | 967 | raise ValueError('Jedi function parameter description have change format.' |
|
968 | 968 | 'Expected "param ...", found %r".' % description) |
|
969 | 969 | return description[6:] |
|
970 | 970 | |
|
971 | 971 | def _make_signature(completion)-> str: |
|
972 | 972 | """ |
|
973 | 973 | Make the signature from a jedi completion |
|
974 | 974 | |
|
975 | 975 | Parameter |
|
976 | 976 | ========= |
|
977 | 977 | |
|
978 | 978 | completion: jedi.Completion |
|
979 | 979 | object does not complete a function type |
|
980 | 980 | |
|
981 | 981 | Returns |
|
982 | 982 | ======= |
|
983 | 983 | |
|
984 | 984 | a string consisting of the function signature, with the parenthesis but |
|
985 | 985 | without the function name. example: |
|
986 | 986 | `(a, *args, b=1, **kwargs)` |
|
987 | 987 | |
|
988 | 988 | """ |
|
989 | 989 | |
|
990 | 990 | return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f]) |
|
991 | 991 | |
|
992 | 992 | class IPCompleter(Completer): |
|
993 | 993 | """Extension of the completer class with IPython-specific features""" |
|
994 | ||
|
994 | ||
|
995 | 995 | @observe('greedy') |
|
996 | 996 | def _greedy_changed(self, change): |
|
997 | 997 | """update the splitter and readline delims when greedy is changed""" |
|
998 | 998 | if change['new']: |
|
999 | 999 | self.splitter.delims = GREEDY_DELIMS |
|
1000 | 1000 | else: |
|
1001 | 1001 | self.splitter.delims = DELIMS |
|
1002 | ||
|
1002 | ||
|
1003 | dict_keys_only = Bool(False, | |
|
1004 | help="""Whether to show dict key matches only""") | |
|
1005 | ||
|
1003 | 1006 | merge_completions = Bool(True, |
|
1004 | 1007 | help="""Whether to merge completion results into a single list |
|
1005 | ||
|
1008 | ||
|
1006 | 1009 | If False, only the completion results from the first non-empty |
|
1007 | 1010 | completer will be returned. |
|
1008 | 1011 | """ |
|
1009 | 1012 | ).tag(config=True) |
|
1010 | 1013 | omit__names = Enum((0,1,2), default_value=2, |
|
1011 | 1014 | help="""Instruct the completer to omit private method names |
|
1012 | ||
|
1015 | ||
|
1013 | 1016 | Specifically, when completing on ``object.<tab>``. |
|
1014 | ||
|
1017 | ||
|
1015 | 1018 | When 2 [default]: all names that start with '_' will be excluded. |
|
1016 | ||
|
1019 | ||
|
1017 | 1020 | When 1: all 'magic' names (``__foo__``) will be excluded. |
|
1018 | ||
|
1021 | ||
|
1019 | 1022 | When 0: nothing will be excluded. |
|
1020 | 1023 | """ |
|
1021 | 1024 | ).tag(config=True) |
|
1022 | 1025 | limit_to__all__ = Bool(False, |
|
1023 | 1026 | help=""" |
|
1024 | 1027 | DEPRECATED as of version 5.0. |
|
1025 | ||
|
1028 | ||
|
1026 | 1029 | Instruct the completer to use __all__ for the completion |
|
1027 | ||
|
1030 | ||
|
1028 | 1031 | Specifically, when completing on ``object.<tab>``. |
|
1029 | ||
|
1032 | ||
|
1030 | 1033 | When True: only those names in obj.__all__ will be included. |
|
1031 | ||
|
1034 | ||
|
1032 | 1035 | When False [default]: the __all__ attribute is ignored |
|
1033 | 1036 | """, |
|
1034 | 1037 | ).tag(config=True) |
|
1035 | 1038 | |
|
1036 | 1039 | @observe('limit_to__all__') |
|
1037 | 1040 | def _limit_to_all_changed(self, change): |
|
1038 | 1041 | warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration ' |
|
1039 | 1042 | 'value has been deprecated since IPython 5.0, will be made to have ' |
|
1040 | 1043 | 'no effects and then removed in future version of IPython.', |
|
1041 | 1044 | UserWarning) |
|
1042 | 1045 | |
|
1043 | 1046 | def __init__(self, shell=None, namespace=None, global_namespace=None, |
|
1044 | 1047 | use_readline=_deprecation_readline_sentinel, config=None, **kwargs): |
|
1045 | 1048 | """IPCompleter() -> completer |
|
1046 | 1049 | |
|
1047 | 1050 | Return a completer object. |
|
1048 | 1051 | |
|
1049 | 1052 | Parameters |
|
1050 | 1053 | ---------- |
|
1051 | 1054 | |
|
1052 | 1055 | shell |
|
1053 | 1056 | a pointer to the ipython shell itself. This is needed |
|
1054 | 1057 | because this completer knows about magic functions, and those can |
|
1055 | 1058 | only be accessed via the ipython instance. |
|
1056 | 1059 | |
|
1057 | 1060 | namespace : dict, optional |
|
1058 | 1061 | an optional dict where completions are performed. |
|
1059 | 1062 | |
|
1060 | 1063 | global_namespace : dict, optional |
|
1061 | 1064 | secondary optional dict for completions, to |
|
1062 | 1065 | handle cases (such as IPython embedded inside functions) where |
|
1063 | 1066 | both Python scopes are visible. |
|
1064 | ||
|
1067 | ||
|
1065 | 1068 | use_readline : bool, optional |
|
1066 | 1069 | DEPRECATED, ignored since IPython 6.0, will have no effects |
|
1067 | 1070 | """ |
|
1068 | 1071 | |
|
1069 | 1072 | self.magic_escape = ESC_MAGIC |
|
1070 | 1073 | self.splitter = CompletionSplitter() |
|
1071 | 1074 | |
|
1072 | 1075 | if use_readline is not _deprecation_readline_sentinel: |
|
1073 | 1076 | warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.', |
|
1074 | 1077 | DeprecationWarning, stacklevel=2) |
|
1075 | 1078 | |
|
1076 | 1079 | # _greedy_changed() depends on splitter and readline being defined: |
|
1077 | 1080 | Completer.__init__(self, namespace=namespace, global_namespace=global_namespace, |
|
1078 | 1081 | config=config, **kwargs) |
|
1079 | 1082 | |
|
1080 | 1083 | # List where completion matches will be stored |
|
1081 | 1084 | self.matches = [] |
|
1082 | 1085 | self.shell = shell |
|
1083 | 1086 | # Regexp to split filenames with spaces in them |
|
1084 | 1087 | self.space_name_re = re.compile(r'([^\\] )') |
|
1085 | 1088 | # Hold a local ref. to glob.glob for speed |
|
1086 | 1089 | self.glob = glob.glob |
|
1087 | 1090 | |
|
1088 | 1091 | # Determine if we are running on 'dumb' terminals, like (X)Emacs |
|
1089 | 1092 | # buffers, to avoid completion problems. |
|
1090 | 1093 | term = os.environ.get('TERM','xterm') |
|
1091 | 1094 | self.dumb_terminal = term in ['dumb','emacs'] |
|
1092 | 1095 | |
|
1093 | 1096 | # Special handling of backslashes needed in win32 platforms |
|
1094 | 1097 | if sys.platform == "win32": |
|
1095 | 1098 | self.clean_glob = self._clean_glob_win32 |
|
1096 | 1099 | else: |
|
1097 | 1100 | self.clean_glob = self._clean_glob |
|
1098 | 1101 | |
|
1099 | 1102 | #regexp to parse docstring for function signature |
|
1100 | 1103 | self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1101 | 1104 | self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1102 | 1105 | #use this if positional argument name is also needed |
|
1103 | 1106 | #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)') |
|
1104 | 1107 | |
|
1105 | 1108 | self.magic_arg_matchers = [ |
|
1106 | 1109 | self.magic_config_matches, |
|
1107 | 1110 | self.magic_color_matches, |
|
1108 | 1111 | ] |
|
1109 | 1112 | |
|
1110 | 1113 | # This is set externally by InteractiveShell |
|
1111 | 1114 | self.custom_completers = None |
|
1112 | 1115 | |
|
1113 | 1116 | @property |
|
1114 | 1117 | def matchers(self): |
|
1115 | 1118 | """All active matcher routines for completion""" |
|
1119 | if self.dict_keys_only: | |
|
1120 | return [self.dict_key_matches] | |
|
1121 | ||
|
1116 | 1122 | if self.use_jedi: |
|
1117 | 1123 | return [ |
|
1118 | 1124 | self.file_matches, |
|
1119 | 1125 | self.magic_matches, |
|
1120 | 1126 | self.dict_key_matches, |
|
1121 | 1127 | ] |
|
1122 | 1128 | else: |
|
1123 | 1129 | return [ |
|
1124 | 1130 | self.python_matches, |
|
1125 | 1131 | self.file_matches, |
|
1126 | 1132 | self.magic_matches, |
|
1127 | 1133 | self.python_func_kw_matches, |
|
1128 | 1134 | self.dict_key_matches, |
|
1129 | 1135 | ] |
|
1130 | 1136 | |
|
1131 | 1137 | def all_completions(self, text): |
|
1132 | 1138 | """ |
|
1133 | 1139 | Wrapper around the complete method for the benefit of emacs. |
|
1134 | 1140 | """ |
|
1135 | 1141 | return self.complete(text)[1] |
|
1136 | 1142 | |
|
1137 | 1143 | def _clean_glob(self, text): |
|
1138 | 1144 | return self.glob("%s*" % text) |
|
1139 | 1145 | |
|
1140 | 1146 | def _clean_glob_win32(self,text): |
|
1141 | 1147 | return [f.replace("\\","/") |
|
1142 | 1148 | for f in self.glob("%s*" % text)] |
|
1143 | 1149 | |
|
1144 | 1150 | def file_matches(self, text): |
|
1145 | 1151 | """Match filenames, expanding ~USER type strings. |
|
1146 | 1152 | |
|
1147 | 1153 | Most of the seemingly convoluted logic in this completer is an |
|
1148 | 1154 | attempt to handle filenames with spaces in them. And yet it's not |
|
1149 | 1155 | quite perfect, because Python's readline doesn't expose all of the |
|
1150 | 1156 | GNU readline details needed for this to be done correctly. |
|
1151 | 1157 | |
|
1152 | 1158 | For a filename with a space in it, the printed completions will be |
|
1153 | 1159 | only the parts after what's already been typed (instead of the |
|
1154 | 1160 | full completions, as is normally done). I don't think with the |
|
1155 | 1161 | current (as of Python 2.3) Python readline it's possible to do |
|
1156 | 1162 | better.""" |
|
1157 | 1163 | |
|
1158 | 1164 | # chars that require escaping with backslash - i.e. chars |
|
1159 | 1165 | # that readline treats incorrectly as delimiters, but we |
|
1160 | 1166 | # don't want to treat as delimiters in filename matching |
|
1161 | 1167 | # when escaped with backslash |
|
1162 | 1168 | if text.startswith('!'): |
|
1163 | 1169 | text = text[1:] |
|
1164 | 1170 | text_prefix = u'!' |
|
1165 | 1171 | else: |
|
1166 | 1172 | text_prefix = u'' |
|
1167 | 1173 | |
|
1168 | 1174 | text_until_cursor = self.text_until_cursor |
|
1169 | 1175 | # track strings with open quotes |
|
1170 | 1176 | open_quotes = has_open_quotes(text_until_cursor) |
|
1171 | 1177 | |
|
1172 | 1178 | if '(' in text_until_cursor or '[' in text_until_cursor: |
|
1173 | 1179 | lsplit = text |
|
1174 | 1180 | else: |
|
1175 | 1181 | try: |
|
1176 | 1182 | # arg_split ~ shlex.split, but with unicode bugs fixed by us |
|
1177 | 1183 | lsplit = arg_split(text_until_cursor)[-1] |
|
1178 | 1184 | except ValueError: |
|
1179 | 1185 | # typically an unmatched ", or backslash without escaped char. |
|
1180 | 1186 | if open_quotes: |
|
1181 | 1187 | lsplit = text_until_cursor.split(open_quotes)[-1] |
|
1182 | 1188 | else: |
|
1183 | 1189 | return [] |
|
1184 | 1190 | except IndexError: |
|
1185 | 1191 | # tab pressed on empty line |
|
1186 | 1192 | lsplit = "" |
|
1187 | 1193 | |
|
1188 | 1194 | if not open_quotes and lsplit != protect_filename(lsplit): |
|
1189 | 1195 | # if protectables are found, do matching on the whole escaped name |
|
1190 | 1196 | has_protectables = True |
|
1191 | 1197 | text0,text = text,lsplit |
|
1192 | 1198 | else: |
|
1193 | 1199 | has_protectables = False |
|
1194 | 1200 | text = os.path.expanduser(text) |
|
1195 | 1201 | |
|
1196 | 1202 | if text == "": |
|
1197 | 1203 | return [text_prefix + protect_filename(f) for f in self.glob("*")] |
|
1198 | 1204 | |
|
1199 | 1205 | # Compute the matches from the filesystem |
|
1200 | 1206 | if sys.platform == 'win32': |
|
1201 | 1207 | m0 = self.clean_glob(text) |
|
1202 | 1208 | else: |
|
1203 | 1209 | m0 = self.clean_glob(text.replace('\\', '')) |
|
1204 | 1210 | |
|
1205 | 1211 | if has_protectables: |
|
1206 | 1212 | # If we had protectables, we need to revert our changes to the |
|
1207 | 1213 | # beginning of filename so that we don't double-write the part |
|
1208 | 1214 | # of the filename we have so far |
|
1209 | 1215 | len_lsplit = len(lsplit) |
|
1210 | 1216 | matches = [text_prefix + text0 + |
|
1211 | 1217 | protect_filename(f[len_lsplit:]) for f in m0] |
|
1212 | 1218 | else: |
|
1213 | 1219 | if open_quotes: |
|
1214 | 1220 | # if we have a string with an open quote, we don't need to |
|
1215 | 1221 | # protect the names beyond the quote (and we _shouldn't_, as |
|
1216 | 1222 | # it would cause bugs when the filesystem call is made). |
|
1217 | 1223 | matches = m0 if sys.platform == "win32" else\ |
|
1218 | 1224 | [protect_filename(f, open_quotes) for f in m0] |
|
1219 | 1225 | else: |
|
1220 | 1226 | matches = [text_prefix + |
|
1221 | 1227 | protect_filename(f) for f in m0] |
|
1222 | 1228 | |
|
1223 | 1229 | # Mark directories in input list by appending '/' to their names. |
|
1224 | 1230 | return [x+'/' if os.path.isdir(x) else x for x in matches] |
|
1225 | 1231 | |
|
1226 | 1232 | def magic_matches(self, text): |
|
1227 | 1233 | """Match magics""" |
|
1228 | 1234 | # Get all shell magics now rather than statically, so magics loaded at |
|
1229 | 1235 | # runtime show up too. |
|
1230 | 1236 | lsm = self.shell.magics_manager.lsmagic() |
|
1231 | 1237 | line_magics = lsm['line'] |
|
1232 | 1238 | cell_magics = lsm['cell'] |
|
1233 | 1239 | pre = self.magic_escape |
|
1234 | 1240 | pre2 = pre+pre |
|
1235 | 1241 | |
|
1236 | 1242 | explicit_magic = text.startswith(pre) |
|
1237 | 1243 | |
|
1238 | 1244 | # Completion logic: |
|
1239 | 1245 | # - user gives %%: only do cell magics |
|
1240 | 1246 | # - user gives %: do both line and cell magics |
|
1241 | 1247 | # - no prefix: do both |
|
1242 | 1248 | # In other words, line magics are skipped if the user gives %% explicitly |
|
1243 | 1249 | # |
|
1244 | 1250 | # We also exclude magics that match any currently visible names: |
|
1245 | 1251 | # https://github.com/ipython/ipython/issues/4877, unless the user has |
|
1246 | 1252 | # typed a %: |
|
1247 | 1253 | # https://github.com/ipython/ipython/issues/10754 |
|
1248 | 1254 | bare_text = text.lstrip(pre) |
|
1249 | 1255 | global_matches = self.global_matches(bare_text) |
|
1250 | 1256 | if not explicit_magic: |
|
1251 | 1257 | def matches(magic): |
|
1252 | 1258 | """ |
|
1253 | 1259 | Filter magics, in particular remove magics that match |
|
1254 | 1260 | a name present in global namespace. |
|
1255 | 1261 | """ |
|
1256 | 1262 | return ( magic.startswith(bare_text) and |
|
1257 | 1263 | magic not in global_matches ) |
|
1258 | 1264 | else: |
|
1259 | 1265 | def matches(magic): |
|
1260 | 1266 | return magic.startswith(bare_text) |
|
1261 | 1267 | |
|
1262 | 1268 | comp = [ pre2+m for m in cell_magics if matches(m)] |
|
1263 | 1269 | if not text.startswith(pre2): |
|
1264 | 1270 | comp += [ pre+m for m in line_magics if matches(m)] |
|
1265 | 1271 | |
|
1266 | 1272 | return comp |
|
1267 | 1273 | |
|
1268 | 1274 | def magic_config_matches(self, text:str) -> List[str]: |
|
1269 | 1275 | """ Match class names and attributes for %config magic """ |
|
1270 | 1276 | texts = text.strip().split() |
|
1271 | 1277 | |
|
1272 | 1278 | if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'): |
|
1273 | 1279 | # get all configuration classes |
|
1274 | 1280 | classes = sorted(set([ c for c in self.shell.configurables |
|
1275 | 1281 | if c.__class__.class_traits(config=True) |
|
1276 | 1282 | ]), key=lambda x: x.__class__.__name__) |
|
1277 | 1283 | classnames = [ c.__class__.__name__ for c in classes ] |
|
1278 | 1284 | |
|
1279 | 1285 | # return all classnames if config or %config is given |
|
1280 | 1286 | if len(texts) == 1: |
|
1281 | 1287 | return classnames |
|
1282 | 1288 | |
|
1283 | 1289 | # match classname |
|
1284 | 1290 | classname_texts = texts[1].split('.') |
|
1285 | 1291 | classname = classname_texts[0] |
|
1286 | 1292 | classname_matches = [ c for c in classnames |
|
1287 | 1293 | if c.startswith(classname) ] |
|
1288 | 1294 | |
|
1289 | 1295 | # return matched classes or the matched class with attributes |
|
1290 | 1296 | if texts[1].find('.') < 0: |
|
1291 | 1297 | return classname_matches |
|
1292 | 1298 | elif len(classname_matches) == 1 and \ |
|
1293 | 1299 | classname_matches[0] == classname: |
|
1294 | 1300 | cls = classes[classnames.index(classname)].__class__ |
|
1295 | 1301 | help = cls.class_get_help() |
|
1296 | 1302 | # strip leading '--' from cl-args: |
|
1297 | 1303 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) |
|
1298 | 1304 | return [ attr.split('=')[0] |
|
1299 | 1305 | for attr in help.strip().splitlines() |
|
1300 | 1306 | if attr.startswith(texts[1]) ] |
|
1301 | 1307 | return [] |
|
1302 | 1308 | |
|
1303 | 1309 | def magic_color_matches(self, text:str) -> List[str] : |
|
1304 | 1310 | """ Match color schemes for %colors magic""" |
|
1305 | 1311 | texts = text.split() |
|
1306 | 1312 | if text.endswith(' '): |
|
1307 | 1313 | # .split() strips off the trailing whitespace. Add '' back |
|
1308 | 1314 | # so that: '%colors ' -> ['%colors', ''] |
|
1309 | 1315 | texts.append('') |
|
1310 | 1316 | |
|
1311 | 1317 | if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'): |
|
1312 | 1318 | prefix = texts[1] |
|
1313 | 1319 | return [ color for color in InspectColors.keys() |
|
1314 | 1320 | if color.startswith(prefix) ] |
|
1315 | 1321 | return [] |
|
1316 | 1322 | |
|
1317 | 1323 | def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str): |
|
1318 | 1324 | """ |
|
1319 | 1325 | |
|
1320 | 1326 | Return a list of :any:`jedi.api.Completions` object from a ``text`` and |
|
1321 | 1327 | cursor position. |
|
1322 | 1328 | |
|
1323 | 1329 | Parameters |
|
1324 | 1330 | ---------- |
|
1325 | 1331 | cursor_column : int |
|
1326 | 1332 | column position of the cursor in ``text``, 0-indexed. |
|
1327 | 1333 | cursor_line : int |
|
1328 | 1334 | line position of the cursor in ``text``, 0-indexed |
|
1329 | 1335 | text : str |
|
1330 | 1336 | text to complete |
|
1331 | 1337 | |
|
1332 | 1338 | Debugging |
|
1333 | 1339 | --------- |
|
1334 | 1340 | |
|
1335 | 1341 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` |
|
1336 | 1342 | object containing a string with the Jedi debug information attached. |
|
1337 | 1343 | """ |
|
1338 | 1344 | namespaces = [self.namespace] |
|
1339 | 1345 | if self.global_namespace is not None: |
|
1340 | 1346 | namespaces.append(self.global_namespace) |
|
1341 | 1347 | |
|
1342 | 1348 | completion_filter = lambda x:x |
|
1343 | 1349 | offset = cursor_to_position(text, cursor_line, cursor_column) |
|
1344 | 1350 | # filter output if we are completing for object members |
|
1345 | 1351 | if offset: |
|
1346 | 1352 | pre = text[offset-1] |
|
1347 | 1353 | if pre == '.': |
|
1348 | 1354 | if self.omit__names == 2: |
|
1349 | 1355 | completion_filter = lambda c:not c.name.startswith('_') |
|
1350 | 1356 | elif self.omit__names == 1: |
|
1351 | 1357 | completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__')) |
|
1352 | 1358 | elif self.omit__names == 0: |
|
1353 | 1359 | completion_filter = lambda x:x |
|
1354 | 1360 | else: |
|
1355 | 1361 | raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names)) |
|
1356 | 1362 | |
|
1357 | 1363 | interpreter = jedi.Interpreter( |
|
1358 | 1364 | text[:offset], namespaces, column=cursor_column, line=cursor_line + 1) |
|
1359 | 1365 | try_jedi = True |
|
1360 | 1366 | |
|
1361 | 1367 | try: |
|
1362 | 1368 | # should we check the type of the node is Error ? |
|
1363 | 1369 | try: |
|
1364 | 1370 | # jedi < 0.11 |
|
1365 | 1371 | from jedi.parser.tree import ErrorLeaf |
|
1366 | 1372 | except ImportError: |
|
1367 | 1373 | # jedi >= 0.11 |
|
1368 | 1374 | from parso.tree import ErrorLeaf |
|
1369 | 1375 | |
|
1370 | 1376 | next_to_last_tree = interpreter._get_module().tree_node.children[-2] |
|
1371 | 1377 | completing_string = False |
|
1372 | 1378 | if isinstance(next_to_last_tree, ErrorLeaf): |
|
1373 | 1379 | completing_string = next_to_last_tree.value.lstrip()[0] in {'"', "'"} |
|
1374 | 1380 | # if we are in a string jedi is likely not the right candidate for |
|
1375 | 1381 | # now. Skip it. |
|
1376 | 1382 | try_jedi = not completing_string |
|
1377 | 1383 | except Exception as e: |
|
1378 | 1384 | # many of things can go wrong, we are using private API just don't crash. |
|
1379 | 1385 | if self.debug: |
|
1380 | 1386 | print("Error detecting if completing a non-finished string :", e, '|') |
|
1381 | 1387 | |
|
1382 | 1388 | if not try_jedi: |
|
1383 | 1389 | return [] |
|
1384 | 1390 | try: |
|
1385 | 1391 | return filter(completion_filter, interpreter.completions()) |
|
1386 | 1392 | except Exception as e: |
|
1387 | 1393 | if self.debug: |
|
1388 | 1394 | return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))] |
|
1389 | 1395 | else: |
|
1390 | 1396 | return [] |
|
1391 | 1397 | |
|
1392 | 1398 | def python_matches(self, text): |
|
1393 | 1399 | """Match attributes or global python names""" |
|
1394 | 1400 | if "." in text: |
|
1395 | 1401 | try: |
|
1396 | 1402 | matches = self.attr_matches(text) |
|
1397 | 1403 | if text.endswith('.') and self.omit__names: |
|
1398 | 1404 | if self.omit__names == 1: |
|
1399 | 1405 | # true if txt is _not_ a __ name, false otherwise: |
|
1400 | 1406 | no__name = (lambda txt: |
|
1401 | 1407 | re.match(r'.*\.__.*?__',txt) is None) |
|
1402 | 1408 | else: |
|
1403 | 1409 | # true if txt is _not_ a _ name, false otherwise: |
|
1404 | 1410 | no__name = (lambda txt: |
|
1405 | 1411 | re.match(r'\._.*?',txt[txt.rindex('.'):]) is None) |
|
1406 | 1412 | matches = filter(no__name, matches) |
|
1407 | 1413 | except NameError: |
|
1408 | 1414 | # catches <undefined attributes>.<tab> |
|
1409 | 1415 | matches = [] |
|
1410 | 1416 | else: |
|
1411 | 1417 | matches = self.global_matches(text) |
|
1412 | 1418 | return matches |
|
1413 | 1419 | |
|
1414 | 1420 | def _default_arguments_from_docstring(self, doc): |
|
1415 | 1421 | """Parse the first line of docstring for call signature. |
|
1416 | 1422 | |
|
1417 | 1423 | Docstring should be of the form 'min(iterable[, key=func])\n'. |
|
1418 | 1424 | It can also parse cython docstring of the form |
|
1419 | 1425 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'. |
|
1420 | 1426 | """ |
|
1421 | 1427 | if doc is None: |
|
1422 | 1428 | return [] |
|
1423 | 1429 | |
|
1424 | 1430 | #care only the firstline |
|
1425 | 1431 | line = doc.lstrip().splitlines()[0] |
|
1426 | 1432 | |
|
1427 | 1433 | #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1428 | 1434 | #'min(iterable[, key=func])\n' -> 'iterable[, key=func]' |
|
1429 | 1435 | sig = self.docstring_sig_re.search(line) |
|
1430 | 1436 | if sig is None: |
|
1431 | 1437 | return [] |
|
1432 | 1438 | # iterable[, key=func]' -> ['iterable[' ,' key=func]'] |
|
1433 | 1439 | sig = sig.groups()[0].split(',') |
|
1434 | 1440 | ret = [] |
|
1435 | 1441 | for s in sig: |
|
1436 | 1442 | #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1437 | 1443 | ret += self.docstring_kwd_re.findall(s) |
|
1438 | 1444 | return ret |
|
1439 | 1445 | |
|
1440 | 1446 | def _default_arguments(self, obj): |
|
1441 | 1447 | """Return the list of default arguments of obj if it is callable, |
|
1442 | 1448 | or empty list otherwise.""" |
|
1443 | 1449 | call_obj = obj |
|
1444 | 1450 | ret = [] |
|
1445 | 1451 | if inspect.isbuiltin(obj): |
|
1446 | 1452 | pass |
|
1447 | 1453 | elif not (inspect.isfunction(obj) or inspect.ismethod(obj)): |
|
1448 | 1454 | if inspect.isclass(obj): |
|
1449 | 1455 | #for cython embedsignature=True the constructor docstring |
|
1450 | 1456 | #belongs to the object itself not __init__ |
|
1451 | 1457 | ret += self._default_arguments_from_docstring( |
|
1452 | 1458 | getattr(obj, '__doc__', '')) |
|
1453 | 1459 | # for classes, check for __init__,__new__ |
|
1454 | 1460 | call_obj = (getattr(obj, '__init__', None) or |
|
1455 | 1461 | getattr(obj, '__new__', None)) |
|
1456 | 1462 | # for all others, check if they are __call__able |
|
1457 | 1463 | elif hasattr(obj, '__call__'): |
|
1458 | 1464 | call_obj = obj.__call__ |
|
1459 | 1465 | ret += self._default_arguments_from_docstring( |
|
1460 | 1466 | getattr(call_obj, '__doc__', '')) |
|
1461 | 1467 | |
|
1462 | 1468 | _keeps = (inspect.Parameter.KEYWORD_ONLY, |
|
1463 | 1469 | inspect.Parameter.POSITIONAL_OR_KEYWORD) |
|
1464 | 1470 | |
|
1465 | 1471 | try: |
|
1466 | 1472 | sig = inspect.signature(call_obj) |
|
1467 | 1473 | ret.extend(k for k, v in sig.parameters.items() if |
|
1468 | 1474 | v.kind in _keeps) |
|
1469 | 1475 | except ValueError: |
|
1470 | 1476 | pass |
|
1471 | 1477 | |
|
1472 | 1478 | return list(set(ret)) |
|
1473 | 1479 | |
|
1474 | 1480 | def python_func_kw_matches(self,text): |
|
1475 | 1481 | """Match named parameters (kwargs) of the last open function""" |
|
1476 | 1482 | |
|
1477 | 1483 | if "." in text: # a parameter cannot be dotted |
|
1478 | 1484 | return [] |
|
1479 | 1485 | try: regexp = self.__funcParamsRegex |
|
1480 | 1486 | except AttributeError: |
|
1481 | 1487 | regexp = self.__funcParamsRegex = re.compile(r''' |
|
1482 | 1488 | '.*?(?<!\\)' | # single quoted strings or |
|
1483 | 1489 | ".*?(?<!\\)" | # double quoted strings or |
|
1484 | 1490 | \w+ | # identifier |
|
1485 | 1491 | \S # other characters |
|
1486 | 1492 | ''', re.VERBOSE | re.DOTALL) |
|
1487 | 1493 | # 1. find the nearest identifier that comes before an unclosed |
|
1488 | 1494 | # parenthesis before the cursor |
|
1489 | 1495 | # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo" |
|
1490 | 1496 | tokens = regexp.findall(self.text_until_cursor) |
|
1491 | 1497 | iterTokens = reversed(tokens); openPar = 0 |
|
1492 | 1498 | |
|
1493 | 1499 | for token in iterTokens: |
|
1494 | 1500 | if token == ')': |
|
1495 | 1501 | openPar -= 1 |
|
1496 | 1502 | elif token == '(': |
|
1497 | 1503 | openPar += 1 |
|
1498 | 1504 | if openPar > 0: |
|
1499 | 1505 | # found the last unclosed parenthesis |
|
1500 | 1506 | break |
|
1501 | 1507 | else: |
|
1502 | 1508 | return [] |
|
1503 | 1509 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) |
|
1504 | 1510 | ids = [] |
|
1505 | 1511 | isId = re.compile(r'\w+$').match |
|
1506 | 1512 | |
|
1507 | 1513 | while True: |
|
1508 | 1514 | try: |
|
1509 | 1515 | ids.append(next(iterTokens)) |
|
1510 | 1516 | if not isId(ids[-1]): |
|
1511 | 1517 | ids.pop(); break |
|
1512 | 1518 | if not next(iterTokens) == '.': |
|
1513 | 1519 | break |
|
1514 | 1520 | except StopIteration: |
|
1515 | 1521 | break |
|
1516 | 1522 | |
|
1517 | 1523 | # Find all named arguments already assigned to, as to avoid suggesting |
|
1518 | 1524 | # them again |
|
1519 | 1525 | usedNamedArgs = set() |
|
1520 | 1526 | par_level = -1 |
|
1521 | 1527 | for token, next_token in zip(tokens, tokens[1:]): |
|
1522 | 1528 | if token == '(': |
|
1523 | 1529 | par_level += 1 |
|
1524 | 1530 | elif token == ')': |
|
1525 | 1531 | par_level -= 1 |
|
1526 | 1532 | |
|
1527 | 1533 | if par_level != 0: |
|
1528 | 1534 | continue |
|
1529 | 1535 | |
|
1530 | 1536 | if next_token != '=': |
|
1531 | 1537 | continue |
|
1532 | 1538 | |
|
1533 | 1539 | usedNamedArgs.add(token) |
|
1534 | 1540 | |
|
1535 | 1541 | # lookup the candidate callable matches either using global_matches |
|
1536 | 1542 | # or attr_matches for dotted names |
|
1537 | 1543 | if len(ids) == 1: |
|
1538 | 1544 | callableMatches = self.global_matches(ids[0]) |
|
1539 | 1545 | else: |
|
1540 | 1546 | callableMatches = self.attr_matches('.'.join(ids[::-1])) |
|
1541 | 1547 | argMatches = [] |
|
1542 | 1548 | for callableMatch in callableMatches: |
|
1543 | 1549 | try: |
|
1544 | 1550 | namedArgs = self._default_arguments(eval(callableMatch, |
|
1545 | 1551 | self.namespace)) |
|
1546 | 1552 | except: |
|
1547 | 1553 | continue |
|
1548 | 1554 | |
|
1549 | 1555 | # Remove used named arguments from the list, no need to show twice |
|
1550 | 1556 | for namedArg in set(namedArgs) - usedNamedArgs: |
|
1551 | 1557 | if namedArg.startswith(text): |
|
1552 | 1558 | argMatches.append(u"%s=" %namedArg) |
|
1553 | 1559 | return argMatches |
|
1554 | 1560 | |
|
1555 | 1561 | def dict_key_matches(self, text): |
|
1556 | 1562 | "Match string keys in a dictionary, after e.g. 'foo[' " |
|
1557 | 1563 | def get_keys(obj): |
|
1558 | 1564 | # Objects can define their own completions by defining an |
|
1559 | 1565 | # _ipy_key_completions_() method. |
|
1560 | 1566 | method = get_real_method(obj, '_ipython_key_completions_') |
|
1561 | 1567 | if method is not None: |
|
1562 | 1568 | return method() |
|
1563 | 1569 | |
|
1564 | 1570 | # Special case some common in-memory dict-like types |
|
1565 | 1571 | if isinstance(obj, dict) or\ |
|
1566 | 1572 | _safe_isinstance(obj, 'pandas', 'DataFrame'): |
|
1567 | 1573 | try: |
|
1568 | 1574 | return list(obj.keys()) |
|
1569 | 1575 | except Exception: |
|
1570 | 1576 | return [] |
|
1571 | 1577 | elif _safe_isinstance(obj, 'numpy', 'ndarray') or\ |
|
1572 | 1578 | _safe_isinstance(obj, 'numpy', 'void'): |
|
1573 | 1579 | return obj.dtype.names or [] |
|
1574 | 1580 | return [] |
|
1575 | 1581 | |
|
1576 | 1582 | try: |
|
1577 | 1583 | regexps = self.__dict_key_regexps |
|
1578 | 1584 | except AttributeError: |
|
1579 | 1585 | dict_key_re_fmt = r'''(?x) |
|
1580 | 1586 | ( # match dict-referring expression wrt greedy setting |
|
1581 | 1587 | %s |
|
1582 | 1588 | ) |
|
1583 | 1589 | \[ # open bracket |
|
1584 | 1590 | \s* # and optional whitespace |
|
1585 | 1591 | ([uUbB]? # string prefix (r not handled) |
|
1586 | 1592 | (?: # unclosed string |
|
1587 | 1593 | '(?:[^']|(?<!\\)\\')* |
|
1588 | 1594 | | |
|
1589 | 1595 | "(?:[^"]|(?<!\\)\\")* |
|
1590 | 1596 | ) |
|
1591 | 1597 | )? |
|
1592 | 1598 | $ |
|
1593 | 1599 | ''' |
|
1594 | 1600 | regexps = self.__dict_key_regexps = { |
|
1595 | 1601 | False: re.compile(dict_key_re_fmt % r''' |
|
1596 | 1602 | # identifiers separated by . |
|
1597 | 1603 | (?!\d)\w+ |
|
1598 | 1604 | (?:\.(?!\d)\w+)* |
|
1599 | 1605 | '''), |
|
1600 | 1606 | True: re.compile(dict_key_re_fmt % ''' |
|
1601 | 1607 | .+ |
|
1602 | 1608 | ''') |
|
1603 | 1609 | } |
|
1604 | 1610 | |
|
1605 | 1611 | match = regexps[self.greedy].search(self.text_until_cursor) |
|
1606 | 1612 | if match is None: |
|
1607 | 1613 | return [] |
|
1608 | 1614 | |
|
1609 | 1615 | expr, prefix = match.groups() |
|
1610 | 1616 | try: |
|
1611 | 1617 | obj = eval(expr, self.namespace) |
|
1612 | 1618 | except Exception: |
|
1613 | 1619 | try: |
|
1614 | 1620 | obj = eval(expr, self.global_namespace) |
|
1615 | 1621 | except Exception: |
|
1616 | 1622 | return [] |
|
1617 | 1623 | |
|
1618 | 1624 | keys = get_keys(obj) |
|
1619 | 1625 | if not keys: |
|
1620 | 1626 | return keys |
|
1621 | 1627 | closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims) |
|
1622 | 1628 | if not matches: |
|
1623 | 1629 | return matches |
|
1624 | ||
|
1630 | ||
|
1625 | 1631 | # get the cursor position of |
|
1626 | 1632 | # - the text being completed |
|
1627 | 1633 | # - the start of the key text |
|
1628 | 1634 | # - the start of the completion |
|
1629 | 1635 | text_start = len(self.text_until_cursor) - len(text) |
|
1630 | 1636 | if prefix: |
|
1631 | 1637 | key_start = match.start(2) |
|
1632 | 1638 | completion_start = key_start + token_offset |
|
1633 | 1639 | else: |
|
1634 | 1640 | key_start = completion_start = match.end() |
|
1635 | ||
|
1641 | ||
|
1636 | 1642 | # grab the leading prefix, to make sure all completions start with `text` |
|
1637 | 1643 | if text_start > key_start: |
|
1638 | 1644 | leading = '' |
|
1639 | 1645 | else: |
|
1640 | 1646 | leading = text[text_start:completion_start] |
|
1641 | ||
|
1647 | ||
|
1642 | 1648 | # the index of the `[` character |
|
1643 | 1649 | bracket_idx = match.end(1) |
|
1644 | 1650 | |
|
1645 | 1651 | # append closing quote and bracket as appropriate |
|
1646 | 1652 | # this is *not* appropriate if the opening quote or bracket is outside |
|
1647 | 1653 | # the text given to this method |
|
1648 | 1654 | suf = '' |
|
1649 | 1655 | continuation = self.line_buffer[len(self.text_until_cursor):] |
|
1650 | 1656 | if key_start > text_start and closing_quote: |
|
1651 | 1657 | # quotes were opened inside text, maybe close them |
|
1652 | 1658 | if continuation.startswith(closing_quote): |
|
1653 | 1659 | continuation = continuation[len(closing_quote):] |
|
1654 | 1660 | else: |
|
1655 | 1661 | suf += closing_quote |
|
1656 | 1662 | if bracket_idx > text_start: |
|
1657 | 1663 | # brackets were opened inside text, maybe close them |
|
1658 | 1664 | if not continuation.startswith(']'): |
|
1659 | 1665 | suf += ']' |
|
1660 | ||
|
1666 | ||
|
1661 | 1667 | return [leading + k + suf for k in matches] |
|
1662 | 1668 | |
|
1663 | 1669 | def unicode_name_matches(self, text): |
|
1664 | 1670 | u"""Match Latex-like syntax for unicode characters base |
|
1665 | 1671 | on the name of the character. |
|
1666 | ||
|
1672 | ||
|
1667 | 1673 | This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·`` |
|
1668 | 1674 | |
|
1669 | 1675 | Works only on valid python 3 identifier, or on combining characters that |
|
1670 | 1676 | will combine to form a valid identifier. |
|
1671 | ||
|
1677 | ||
|
1672 | 1678 | Used on Python 3 only. |
|
1673 | 1679 | """ |
|
1674 | 1680 | slashpos = text.rfind('\\') |
|
1675 | 1681 | if slashpos > -1: |
|
1676 | 1682 | s = text[slashpos+1:] |
|
1677 | 1683 | try : |
|
1678 | 1684 | unic = unicodedata.lookup(s) |
|
1679 | 1685 | # allow combining chars |
|
1680 | 1686 | if ('a'+unic).isidentifier(): |
|
1681 | 1687 | return '\\'+s,[unic] |
|
1682 | 1688 | except KeyError: |
|
1683 | 1689 | pass |
|
1684 | 1690 | return u'', [] |
|
1685 | 1691 | |
|
1686 | 1692 | |
|
1687 | 1693 | def latex_matches(self, text): |
|
1688 | 1694 | u"""Match Latex syntax for unicode characters. |
|
1689 | ||
|
1695 | ||
|
1690 | 1696 | This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±`` |
|
1691 | 1697 | |
|
1692 | 1698 | Used on Python 3 only. |
|
1693 | 1699 | """ |
|
1694 | 1700 | slashpos = text.rfind('\\') |
|
1695 | 1701 | if slashpos > -1: |
|
1696 | 1702 | s = text[slashpos:] |
|
1697 | 1703 | if s in latex_symbols: |
|
1698 | 1704 | # Try to complete a full latex symbol to unicode |
|
1699 | 1705 | # \\alpha -> Ξ± |
|
1700 | 1706 | return s, [latex_symbols[s]] |
|
1701 | 1707 | else: |
|
1702 | 1708 | # If a user has partially typed a latex symbol, give them |
|
1703 | 1709 | # a full list of options \al -> [\aleph, \alpha] |
|
1704 | 1710 | matches = [k for k in latex_symbols if k.startswith(s)] |
|
1705 | 1711 | return s, matches |
|
1706 | 1712 | return u'', [] |
|
1707 | 1713 | |
|
1708 | 1714 | def dispatch_custom_completer(self, text): |
|
1709 | 1715 | if not self.custom_completers: |
|
1710 | 1716 | return |
|
1711 | 1717 | |
|
1712 | 1718 | line = self.line_buffer |
|
1713 | 1719 | if not line.strip(): |
|
1714 | 1720 | return None |
|
1715 | 1721 | |
|
1716 | 1722 | # Create a little structure to pass all the relevant information about |
|
1717 | 1723 | # the current completion to any custom completer. |
|
1718 | 1724 | event = SimpleNamespace() |
|
1719 | 1725 | event.line = line |
|
1720 | 1726 | event.symbol = text |
|
1721 | 1727 | cmd = line.split(None,1)[0] |
|
1722 | 1728 | event.command = cmd |
|
1723 | 1729 | event.text_until_cursor = self.text_until_cursor |
|
1724 | 1730 | |
|
1725 | 1731 | # for foo etc, try also to find completer for %foo |
|
1726 | 1732 | if not cmd.startswith(self.magic_escape): |
|
1727 | 1733 | try_magic = self.custom_completers.s_matches( |
|
1728 | 1734 | self.magic_escape + cmd) |
|
1729 | 1735 | else: |
|
1730 | 1736 | try_magic = [] |
|
1731 | 1737 | |
|
1732 | 1738 | for c in itertools.chain(self.custom_completers.s_matches(cmd), |
|
1733 | 1739 | try_magic, |
|
1734 | 1740 | self.custom_completers.flat_matches(self.text_until_cursor)): |
|
1735 | 1741 | try: |
|
1736 | 1742 | res = c(event) |
|
1737 | 1743 | if res: |
|
1738 | 1744 | # first, try case sensitive match |
|
1739 | 1745 | withcase = [r for r in res if r.startswith(text)] |
|
1740 | 1746 | if withcase: |
|
1741 | 1747 | return withcase |
|
1742 | 1748 | # if none, then case insensitive ones are ok too |
|
1743 | 1749 | text_low = text.lower() |
|
1744 | 1750 | return [r for r in res if r.lower().startswith(text_low)] |
|
1745 | 1751 | except TryNext: |
|
1746 | 1752 | pass |
|
1747 | 1753 | except KeyboardInterrupt: |
|
1748 | 1754 | """ |
|
1749 | 1755 | If custom completer take too long, |
|
1750 | 1756 | let keyboard interrupt abort and return nothing. |
|
1751 | 1757 | """ |
|
1752 | 1758 | break |
|
1753 | 1759 | |
|
1754 | 1760 | return None |
|
1755 | 1761 | |
|
1756 | 1762 | def completions(self, text: str, offset: int)->Iterator[Completion]: |
|
1757 | 1763 | """ |
|
1758 | 1764 | Returns an iterator over the possible completions |
|
1759 | 1765 | |
|
1760 | 1766 | .. warning:: Unstable |
|
1761 | ||
|
1767 | ||
|
1762 | 1768 | This function is unstable, API may change without warning. |
|
1763 | 1769 | It will also raise unless use in proper context manager. |
|
1764 | 1770 | |
|
1765 | 1771 | Parameters |
|
1766 | 1772 | ---------- |
|
1767 | ||
|
1773 | ||
|
1768 | 1774 | text:str |
|
1769 | 1775 | Full text of the current input, multi line string. |
|
1770 | 1776 | offset:int |
|
1771 | 1777 | Integer representing the position of the cursor in ``text``. Offset |
|
1772 | 1778 | is 0-based indexed. |
|
1773 | 1779 | |
|
1774 | 1780 | Yields |
|
1775 | 1781 | ------ |
|
1776 | 1782 | :any:`Completion` object |
|
1777 | 1783 | |
|
1778 | 1784 | |
|
1779 | 1785 | The cursor on a text can either be seen as being "in between" |
|
1780 | 1786 | characters or "On" a character depending on the interface visible to |
|
1781 | 1787 | the user. For consistency the cursor being on "in between" characters X |
|
1782 | 1788 | and Y is equivalent to the cursor being "on" character Y, that is to say |
|
1783 | 1789 | the character the cursor is on is considered as being after the cursor. |
|
1784 | 1790 | |
|
1785 | 1791 | Combining characters may span more that one position in the |
|
1786 | 1792 | text. |
|
1787 | 1793 | |
|
1788 | 1794 | |
|
1789 | 1795 | .. note:: |
|
1790 | 1796 | |
|
1791 | 1797 | If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--`` |
|
1792 | 1798 | fake Completion token to distinguish completion returned by Jedi |
|
1793 | 1799 | and usual IPython completion. |
|
1794 | 1800 | |
|
1795 | 1801 | .. note:: |
|
1796 | ||
|
1802 | ||
|
1797 | 1803 | Completions are not completely deduplicated yet. If identical |
|
1798 | 1804 | completions are coming from different sources this function does not |
|
1799 | 1805 | ensure that each completion object will only be present once. |
|
1800 | 1806 | """ |
|
1801 | 1807 | warnings.warn("_complete is a provisional API (as of IPython 6.0). " |
|
1802 | 1808 | "It may change without warnings. " |
|
1803 | 1809 | "Use in corresponding context manager.", |
|
1804 | 1810 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
1805 | 1811 | |
|
1806 | 1812 | seen = set() |
|
1807 | 1813 | try: |
|
1808 | 1814 | for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000): |
|
1809 | 1815 | if c and (c in seen): |
|
1810 | 1816 | continue |
|
1811 | 1817 | yield c |
|
1812 | 1818 | seen.add(c) |
|
1813 | 1819 | except KeyboardInterrupt: |
|
1814 | 1820 | """if completions take too long and users send keyboard interrupt, |
|
1815 | 1821 | do not crash and return ASAP. """ |
|
1816 | 1822 | pass |
|
1817 | 1823 | |
|
1818 | 1824 | def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]: |
|
1819 | 1825 | """ |
|
1820 | 1826 | Core completion module.Same signature as :any:`completions`, with the |
|
1821 | 1827 | extra `timeout` parameter (in seconds). |
|
1822 | 1828 | |
|
1823 | 1829 | |
|
1824 | 1830 | Computing jedi's completion ``.type`` can be quite expensive (it is a |
|
1825 | 1831 | lazy property) and can require some warm-up, more warm up than just |
|
1826 | 1832 | computing the ``name`` of a completion. The warm-up can be : |
|
1827 | 1833 | |
|
1828 | 1834 | - Long warm-up the first time a module is encountered after |
|
1829 | 1835 | install/update: actually build parse/inference tree. |
|
1830 | 1836 | |
|
1831 | 1837 | - first time the module is encountered in a session: load tree from |
|
1832 | 1838 | disk. |
|
1833 | 1839 | |
|
1834 | 1840 | We don't want to block completions for tens of seconds so we give the |
|
1835 | 1841 | completer a "budget" of ``_timeout`` seconds per invocation to compute |
|
1836 | 1842 | completions types, the completions that have not yet been computed will |
|
1837 | 1843 | be marked as "unknown" an will have a chance to be computed next round |
|
1838 | 1844 | are things get cached. |
|
1839 | 1845 | |
|
1840 | 1846 | Keep in mind that Jedi is not the only thing treating the completion so |
|
1841 | 1847 | keep the timeout short-ish as if we take more than 0.3 second we still |
|
1842 | 1848 | have lots of processing to do. |
|
1843 | 1849 | |
|
1844 | 1850 | """ |
|
1845 | 1851 | deadline = time.monotonic() + _timeout |
|
1846 | 1852 | |
|
1847 | 1853 | |
|
1848 | 1854 | before = full_text[:offset] |
|
1849 | 1855 | cursor_line, cursor_column = position_to_cursor(full_text, offset) |
|
1850 | 1856 | |
|
1851 | 1857 | matched_text, matches, matches_origin, jedi_matches = self._complete( |
|
1852 | 1858 | full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column) |
|
1853 | 1859 | |
|
1854 | 1860 | iter_jm = iter(jedi_matches) |
|
1855 | 1861 | if _timeout: |
|
1856 | 1862 | for jm in iter_jm: |
|
1857 | 1863 | try: |
|
1858 | 1864 | type_ = jm.type |
|
1859 | 1865 | except Exception: |
|
1860 | 1866 | if self.debug: |
|
1861 | 1867 | print("Error in Jedi getting type of ", jm) |
|
1862 | 1868 | type_ = None |
|
1863 | 1869 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1864 | 1870 | if type_ == 'function': |
|
1865 | 1871 | signature = _make_signature(jm) |
|
1866 | 1872 | else: |
|
1867 | 1873 | signature = '' |
|
1868 | 1874 | yield Completion(start=offset - delta, |
|
1869 | 1875 | end=offset, |
|
1870 | 1876 | text=jm.name_with_symbols, |
|
1871 | 1877 | type=type_, |
|
1872 | 1878 | signature=signature, |
|
1873 | 1879 | _origin='jedi') |
|
1874 | 1880 | |
|
1875 | 1881 | if time.monotonic() > deadline: |
|
1876 | 1882 | break |
|
1877 | 1883 | |
|
1878 | 1884 | for jm in iter_jm: |
|
1879 | 1885 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1880 | 1886 | yield Completion(start=offset - delta, |
|
1881 | 1887 | end=offset, |
|
1882 | 1888 | text=jm.name_with_symbols, |
|
1883 | 1889 | type='<unknown>', # don't compute type for speed |
|
1884 | 1890 | _origin='jedi', |
|
1885 | 1891 | signature='') |
|
1886 | 1892 | |
|
1887 | 1893 | |
|
1888 | 1894 | start_offset = before.rfind(matched_text) |
|
1889 | 1895 | |
|
1890 | 1896 | # TODO: |
|
1891 | 1897 | # Suppress this, right now just for debug. |
|
1892 | 1898 | if jedi_matches and matches and self.debug: |
|
1893 | 1899 | yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', |
|
1894 | 1900 | _origin='debug', type='none', signature='') |
|
1895 | 1901 | |
|
1896 | 1902 | # I'm unsure if this is always true, so let's assert and see if it |
|
1897 | 1903 | # crash |
|
1898 | 1904 | assert before.endswith(matched_text) |
|
1899 | 1905 | for m, t in zip(matches, matches_origin): |
|
1900 | 1906 | yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>') |
|
1901 | 1907 | |
|
1902 | 1908 | |
|
1903 | 1909 | def complete(self, text=None, line_buffer=None, cursor_pos=None): |
|
1904 | 1910 | """Find completions for the given text and line context. |
|
1905 | 1911 | |
|
1906 | 1912 | Note that both the text and the line_buffer are optional, but at least |
|
1907 | 1913 | one of them must be given. |
|
1908 | 1914 | |
|
1909 | 1915 | Parameters |
|
1910 | 1916 | ---------- |
|
1911 | 1917 | text : string, optional |
|
1912 | 1918 | Text to perform the completion on. If not given, the line buffer |
|
1913 | 1919 | is split using the instance's CompletionSplitter object. |
|
1914 | 1920 | |
|
1915 | 1921 | line_buffer : string, optional |
|
1916 | 1922 | If not given, the completer attempts to obtain the current line |
|
1917 | 1923 | buffer via readline. This keyword allows clients which are |
|
1918 | 1924 | requesting for text completions in non-readline contexts to inform |
|
1919 | 1925 | the completer of the entire text. |
|
1920 | 1926 | |
|
1921 | 1927 | cursor_pos : int, optional |
|
1922 | 1928 | Index of the cursor in the full line buffer. Should be provided by |
|
1923 | 1929 | remote frontends where kernel has no access to frontend state. |
|
1924 | 1930 | |
|
1925 | 1931 | Returns |
|
1926 | 1932 | ------- |
|
1927 | 1933 | text : str |
|
1928 | 1934 | Text that was actually used in the completion. |
|
1929 | 1935 | |
|
1930 | 1936 | matches : list |
|
1931 | 1937 | A list of completion matches. |
|
1932 | 1938 | |
|
1933 | 1939 | |
|
1934 | 1940 | .. note:: |
|
1935 | 1941 | |
|
1936 | 1942 | This API is likely to be deprecated and replaced by |
|
1937 | 1943 | :any:`IPCompleter.completions` in the future. |
|
1938 | 1944 | |
|
1939 | 1945 | |
|
1940 | 1946 | """ |
|
1941 | 1947 | warnings.warn('`Completer.complete` is pending deprecation since ' |
|
1942 | 1948 | 'IPython 6.0 and will be replaced by `Completer.completions`.', |
|
1943 | 1949 | PendingDeprecationWarning) |
|
1944 | 1950 | # potential todo, FOLD the 3rd throw away argument of _complete |
|
1945 | 1951 | # into the first 2 one. |
|
1946 | 1952 | return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2] |
|
1947 | 1953 | |
|
1948 | 1954 | def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None, |
|
1949 | 1955 | full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]: |
|
1950 | 1956 | """ |
|
1951 | 1957 | |
|
1952 | 1958 | Like complete but can also returns raw jedi completions as well as the |
|
1953 | 1959 | origin of the completion text. This could (and should) be made much |
|
1954 | 1960 | cleaner but that will be simpler once we drop the old (and stateful) |
|
1955 | 1961 | :any:`complete` API. |
|
1956 | 1962 | |
|
1957 | 1963 | |
|
1958 | 1964 | With current provisional API, cursor_pos act both (depending on the |
|
1959 | 1965 | caller) as the offset in the ``text`` or ``line_buffer``, or as the |
|
1960 | 1966 | ``column`` when passing multiline strings this could/should be renamed |
|
1961 | 1967 | but would add extra noise. |
|
1962 | 1968 | """ |
|
1963 | 1969 | |
|
1964 | 1970 | # if the cursor position isn't given, the only sane assumption we can |
|
1965 | 1971 | # make is that it's at the end of the line (the common case) |
|
1966 | 1972 | if cursor_pos is None: |
|
1967 | 1973 | cursor_pos = len(line_buffer) if text is None else len(text) |
|
1968 | 1974 | |
|
1969 | 1975 | if self.use_main_ns: |
|
1970 | 1976 | self.namespace = __main__.__dict__ |
|
1971 | 1977 | |
|
1972 | 1978 | # if text is either None or an empty string, rely on the line buffer |
|
1973 | 1979 | if (not line_buffer) and full_text: |
|
1974 | 1980 | line_buffer = full_text.split('\n')[cursor_line] |
|
1975 | 1981 | if not text: |
|
1976 | 1982 | text = self.splitter.split_line(line_buffer, cursor_pos) |
|
1977 | 1983 | |
|
1978 | 1984 | if self.backslash_combining_completions: |
|
1979 | 1985 | # allow deactivation of these on windows. |
|
1980 | 1986 | base_text = text if not line_buffer else line_buffer[:cursor_pos] |
|
1981 | 1987 | latex_text, latex_matches = self.latex_matches(base_text) |
|
1982 | 1988 | if latex_matches: |
|
1983 | 1989 | return latex_text, latex_matches, ['latex_matches']*len(latex_matches), () |
|
1984 | 1990 | name_text = '' |
|
1985 | 1991 | name_matches = [] |
|
1986 | 1992 | for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches): |
|
1987 | 1993 | name_text, name_matches = meth(base_text) |
|
1988 | 1994 | if name_text: |
|
1989 | 1995 | return name_text, name_matches[:MATCHES_LIMIT], \ |
|
1990 | 1996 | [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), () |
|
1991 | ||
|
1997 | ||
|
1992 | 1998 | |
|
1993 | 1999 | # If no line buffer is given, assume the input text is all there was |
|
1994 | 2000 | if line_buffer is None: |
|
1995 | 2001 | line_buffer = text |
|
1996 | 2002 | |
|
1997 | 2003 | self.line_buffer = line_buffer |
|
1998 | 2004 | self.text_until_cursor = self.line_buffer[:cursor_pos] |
|
1999 | 2005 | |
|
2000 | 2006 | # Do magic arg matches |
|
2001 | 2007 | for matcher in self.magic_arg_matchers: |
|
2002 | 2008 | matches = list(matcher(line_buffer))[:MATCHES_LIMIT] |
|
2003 | 2009 | if matches: |
|
2004 | 2010 | origins = [matcher.__qualname__] * len(matches) |
|
2005 | 2011 | return text, matches, origins, () |
|
2006 | 2012 | |
|
2007 | 2013 | # Start with a clean slate of completions |
|
2008 | 2014 | matches = [] |
|
2009 | 2015 | custom_res = self.dispatch_custom_completer(text) |
|
2010 | 2016 | # FIXME: we should extend our api to return a dict with completions for |
|
2011 | 2017 | # different types of objects. The rlcomplete() method could then |
|
2012 | 2018 | # simply collapse the dict into a list for readline, but we'd have |
|
2013 | 2019 | # richer completion semantics in other environments. |
|
2014 | 2020 | completions = () |
|
2015 | 2021 | if self.use_jedi: |
|
2016 | 2022 | if not full_text: |
|
2017 | 2023 | full_text = line_buffer |
|
2018 | 2024 | completions = self._jedi_matches( |
|
2019 | 2025 | cursor_pos, cursor_line, full_text) |
|
2020 | 2026 | if custom_res is not None: |
|
2021 | 2027 | # did custom completers produce something? |
|
2022 | 2028 | matches = [(m, 'custom') for m in custom_res] |
|
2023 | 2029 | else: |
|
2024 | 2030 | # Extend the list of completions with the results of each |
|
2025 | 2031 | # matcher, so we return results to the user from all |
|
2026 | 2032 | # namespaces. |
|
2027 | 2033 | if self.merge_completions: |
|
2028 | 2034 | matches = [] |
|
2029 | 2035 | for matcher in self.matchers: |
|
2030 | 2036 | try: |
|
2031 | 2037 | matches.extend([(m, matcher.__qualname__) |
|
2032 | 2038 | for m in matcher(text)]) |
|
2033 | 2039 | except: |
|
2034 | 2040 | # Show the ugly traceback if the matcher causes an |
|
2035 | 2041 | # exception, but do NOT crash the kernel! |
|
2036 | 2042 | sys.excepthook(*sys.exc_info()) |
|
2037 | 2043 | else: |
|
2038 | 2044 | for matcher in self.matchers: |
|
2039 | 2045 | matches = [(m, matcher.__qualname__) |
|
2040 | 2046 | for m in matcher(text)] |
|
2041 | 2047 | if matches: |
|
2042 | 2048 | break |
|
2043 | 2049 | seen = set() |
|
2044 | 2050 | filtered_matches = set() |
|
2045 | 2051 | for m in matches: |
|
2046 | 2052 | t, c = m |
|
2047 | 2053 | if t not in seen: |
|
2048 | 2054 | filtered_matches.add(m) |
|
2049 | 2055 | seen.add(t) |
|
2050 | 2056 | |
|
2051 | 2057 | _filtered_matches = sorted( |
|
2052 | 2058 | set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))\ |
|
2053 | 2059 | [:MATCHES_LIMIT] |
|
2054 | 2060 | |
|
2055 | 2061 | _matches = [m[0] for m in _filtered_matches] |
|
2056 | 2062 | origins = [m[1] for m in _filtered_matches] |
|
2057 | 2063 | |
|
2058 | 2064 | self.matches = _matches |
|
2059 | 2065 | |
|
2060 | 2066 | return text, _matches, origins, completions |
General Comments 0
You need to be logged in to leave comments.
Login now