##// END OF EJS Templates
Make all_completions use new completion code...
memeplex -
Show More
@@ -1,2061 +1,2065 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=JEDI_INSTALLED,
580 580 help="Experimental: Use Jedi to generate autocompletions. "
581 581 "Default to True if jedi is installed.").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 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 1003 dict_keys_only = Bool(False,
1004 1004 help="""Whether to show dict key matches only""")
1005 1005
1006 1006 merge_completions = Bool(True,
1007 1007 help="""Whether to merge completion results into a single list
1008 1008
1009 1009 If False, only the completion results from the first non-empty
1010 1010 completer will be returned.
1011 1011 """
1012 1012 ).tag(config=True)
1013 1013 omit__names = Enum((0,1,2), default_value=2,
1014 1014 help="""Instruct the completer to omit private method names
1015 1015
1016 1016 Specifically, when completing on ``object.<tab>``.
1017 1017
1018 1018 When 2 [default]: all names that start with '_' will be excluded.
1019 1019
1020 1020 When 1: all 'magic' names (``__foo__``) will be excluded.
1021 1021
1022 1022 When 0: nothing will be excluded.
1023 1023 """
1024 1024 ).tag(config=True)
1025 1025 limit_to__all__ = Bool(False,
1026 1026 help="""
1027 1027 DEPRECATED as of version 5.0.
1028 1028
1029 1029 Instruct the completer to use __all__ for the completion
1030 1030
1031 1031 Specifically, when completing on ``object.<tab>``.
1032 1032
1033 1033 When True: only those names in obj.__all__ will be included.
1034 1034
1035 1035 When False [default]: the __all__ attribute is ignored
1036 1036 """,
1037 1037 ).tag(config=True)
1038 1038
1039 1039 @observe('limit_to__all__')
1040 1040 def _limit_to_all_changed(self, change):
1041 1041 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1042 1042 'value has been deprecated since IPython 5.0, will be made to have '
1043 1043 'no effects and then removed in future version of IPython.',
1044 1044 UserWarning)
1045 1045
1046 1046 def __init__(self, shell=None, namespace=None, global_namespace=None,
1047 1047 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
1048 1048 """IPCompleter() -> completer
1049 1049
1050 1050 Return a completer object.
1051 1051
1052 1052 Parameters
1053 1053 ----------
1054 1054
1055 1055 shell
1056 1056 a pointer to the ipython shell itself. This is needed
1057 1057 because this completer knows about magic functions, and those can
1058 1058 only be accessed via the ipython instance.
1059 1059
1060 1060 namespace : dict, optional
1061 1061 an optional dict where completions are performed.
1062 1062
1063 1063 global_namespace : dict, optional
1064 1064 secondary optional dict for completions, to
1065 1065 handle cases (such as IPython embedded inside functions) where
1066 1066 both Python scopes are visible.
1067 1067
1068 1068 use_readline : bool, optional
1069 1069 DEPRECATED, ignored since IPython 6.0, will have no effects
1070 1070 """
1071 1071
1072 1072 self.magic_escape = ESC_MAGIC
1073 1073 self.splitter = CompletionSplitter()
1074 1074
1075 1075 if use_readline is not _deprecation_readline_sentinel:
1076 1076 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1077 1077 DeprecationWarning, stacklevel=2)
1078 1078
1079 1079 # _greedy_changed() depends on splitter and readline being defined:
1080 1080 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1081 1081 config=config, **kwargs)
1082 1082
1083 1083 # List where completion matches will be stored
1084 1084 self.matches = []
1085 1085 self.shell = shell
1086 1086 # Regexp to split filenames with spaces in them
1087 1087 self.space_name_re = re.compile(r'([^\\] )')
1088 1088 # Hold a local ref. to glob.glob for speed
1089 1089 self.glob = glob.glob
1090 1090
1091 1091 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1092 1092 # buffers, to avoid completion problems.
1093 1093 term = os.environ.get('TERM','xterm')
1094 1094 self.dumb_terminal = term in ['dumb','emacs']
1095 1095
1096 1096 # Special handling of backslashes needed in win32 platforms
1097 1097 if sys.platform == "win32":
1098 1098 self.clean_glob = self._clean_glob_win32
1099 1099 else:
1100 1100 self.clean_glob = self._clean_glob
1101 1101
1102 1102 #regexp to parse docstring for function signature
1103 1103 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1104 1104 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1105 1105 #use this if positional argument name is also needed
1106 1106 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1107 1107
1108 1108 self.magic_arg_matchers = [
1109 1109 self.magic_config_matches,
1110 1110 self.magic_color_matches,
1111 1111 ]
1112 1112
1113 1113 # This is set externally by InteractiveShell
1114 1114 self.custom_completers = None
1115 1115
1116 1116 @property
1117 1117 def matchers(self):
1118 1118 """All active matcher routines for completion"""
1119 1119 if self.dict_keys_only:
1120 1120 return [self.dict_key_matches]
1121 1121
1122 1122 if self.use_jedi:
1123 1123 return [
1124 1124 self.file_matches,
1125 1125 self.magic_matches,
1126 1126 self.dict_key_matches,
1127 1127 ]
1128 1128 else:
1129 1129 return [
1130 1130 self.python_matches,
1131 1131 self.file_matches,
1132 1132 self.magic_matches,
1133 1133 self.python_func_kw_matches,
1134 1134 self.dict_key_matches,
1135 1135 ]
1136 1136
1137 1137 def all_completions(self, text):
1138 1138 """
1139 Wrapper around the complete method for the benefit of emacs.
1139 Wrapper around the completions method for the benefit of emacs.
1140 1140 """
1141 prefix = text[:text.rfind(".") + 1]
1142 return map(lambda c: prefix + c.text,
1143 self.completions(text, len(text)))
1144
1141 1145 return self.complete(text)[1]
1142 1146
1143 1147 def _clean_glob(self, text):
1144 1148 return self.glob("%s*" % text)
1145 1149
1146 1150 def _clean_glob_win32(self,text):
1147 1151 return [f.replace("\\","/")
1148 1152 for f in self.glob("%s*" % text)]
1149 1153
1150 1154 def file_matches(self, text):
1151 1155 """Match filenames, expanding ~USER type strings.
1152 1156
1153 1157 Most of the seemingly convoluted logic in this completer is an
1154 1158 attempt to handle filenames with spaces in them. And yet it's not
1155 1159 quite perfect, because Python's readline doesn't expose all of the
1156 1160 GNU readline details needed for this to be done correctly.
1157 1161
1158 1162 For a filename with a space in it, the printed completions will be
1159 1163 only the parts after what's already been typed (instead of the
1160 1164 full completions, as is normally done). I don't think with the
1161 1165 current (as of Python 2.3) Python readline it's possible to do
1162 1166 better."""
1163 1167
1164 1168 # chars that require escaping with backslash - i.e. chars
1165 1169 # that readline treats incorrectly as delimiters, but we
1166 1170 # don't want to treat as delimiters in filename matching
1167 1171 # when escaped with backslash
1168 1172 if text.startswith('!'):
1169 1173 text = text[1:]
1170 1174 text_prefix = u'!'
1171 1175 else:
1172 1176 text_prefix = u''
1173 1177
1174 1178 text_until_cursor = self.text_until_cursor
1175 1179 # track strings with open quotes
1176 1180 open_quotes = has_open_quotes(text_until_cursor)
1177 1181
1178 1182 if '(' in text_until_cursor or '[' in text_until_cursor:
1179 1183 lsplit = text
1180 1184 else:
1181 1185 try:
1182 1186 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1183 1187 lsplit = arg_split(text_until_cursor)[-1]
1184 1188 except ValueError:
1185 1189 # typically an unmatched ", or backslash without escaped char.
1186 1190 if open_quotes:
1187 1191 lsplit = text_until_cursor.split(open_quotes)[-1]
1188 1192 else:
1189 1193 return []
1190 1194 except IndexError:
1191 1195 # tab pressed on empty line
1192 1196 lsplit = ""
1193 1197
1194 1198 if not open_quotes and lsplit != protect_filename(lsplit):
1195 1199 # if protectables are found, do matching on the whole escaped name
1196 1200 has_protectables = True
1197 1201 text0,text = text,lsplit
1198 1202 else:
1199 1203 has_protectables = False
1200 1204 text = os.path.expanduser(text)
1201 1205
1202 1206 if text == "":
1203 1207 return [text_prefix + protect_filename(f) for f in self.glob("*")]
1204 1208
1205 1209 # Compute the matches from the filesystem
1206 1210 if sys.platform == 'win32':
1207 1211 m0 = self.clean_glob(text)
1208 1212 else:
1209 1213 m0 = self.clean_glob(text.replace('\\', ''))
1210 1214
1211 1215 if has_protectables:
1212 1216 # If we had protectables, we need to revert our changes to the
1213 1217 # beginning of filename so that we don't double-write the part
1214 1218 # of the filename we have so far
1215 1219 len_lsplit = len(lsplit)
1216 1220 matches = [text_prefix + text0 +
1217 1221 protect_filename(f[len_lsplit:]) for f in m0]
1218 1222 else:
1219 1223 if open_quotes:
1220 1224 # if we have a string with an open quote, we don't need to
1221 1225 # protect the names beyond the quote (and we _shouldn't_, as
1222 1226 # it would cause bugs when the filesystem call is made).
1223 1227 matches = m0 if sys.platform == "win32" else\
1224 1228 [protect_filename(f, open_quotes) for f in m0]
1225 1229 else:
1226 1230 matches = [text_prefix +
1227 1231 protect_filename(f) for f in m0]
1228 1232
1229 1233 # Mark directories in input list by appending '/' to their names.
1230 1234 return [x+'/' if os.path.isdir(x) else x for x in matches]
1231 1235
1232 1236 def magic_matches(self, text):
1233 1237 """Match magics"""
1234 1238 # Get all shell magics now rather than statically, so magics loaded at
1235 1239 # runtime show up too.
1236 1240 lsm = self.shell.magics_manager.lsmagic()
1237 1241 line_magics = lsm['line']
1238 1242 cell_magics = lsm['cell']
1239 1243 pre = self.magic_escape
1240 1244 pre2 = pre+pre
1241 1245
1242 1246 explicit_magic = text.startswith(pre)
1243 1247
1244 1248 # Completion logic:
1245 1249 # - user gives %%: only do cell magics
1246 1250 # - user gives %: do both line and cell magics
1247 1251 # - no prefix: do both
1248 1252 # In other words, line magics are skipped if the user gives %% explicitly
1249 1253 #
1250 1254 # We also exclude magics that match any currently visible names:
1251 1255 # https://github.com/ipython/ipython/issues/4877, unless the user has
1252 1256 # typed a %:
1253 1257 # https://github.com/ipython/ipython/issues/10754
1254 1258 bare_text = text.lstrip(pre)
1255 1259 global_matches = self.global_matches(bare_text)
1256 1260 if not explicit_magic:
1257 1261 def matches(magic):
1258 1262 """
1259 1263 Filter magics, in particular remove magics that match
1260 1264 a name present in global namespace.
1261 1265 """
1262 1266 return ( magic.startswith(bare_text) and
1263 1267 magic not in global_matches )
1264 1268 else:
1265 1269 def matches(magic):
1266 1270 return magic.startswith(bare_text)
1267 1271
1268 1272 comp = [ pre2+m for m in cell_magics if matches(m)]
1269 1273 if not text.startswith(pre2):
1270 1274 comp += [ pre+m for m in line_magics if matches(m)]
1271 1275
1272 1276 return comp
1273 1277
1274 1278 def magic_config_matches(self, text:str) -> List[str]:
1275 1279 """ Match class names and attributes for %config magic """
1276 1280 texts = text.strip().split()
1277 1281
1278 1282 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
1279 1283 # get all configuration classes
1280 1284 classes = sorted(set([ c for c in self.shell.configurables
1281 1285 if c.__class__.class_traits(config=True)
1282 1286 ]), key=lambda x: x.__class__.__name__)
1283 1287 classnames = [ c.__class__.__name__ for c in classes ]
1284 1288
1285 1289 # return all classnames if config or %config is given
1286 1290 if len(texts) == 1:
1287 1291 return classnames
1288 1292
1289 1293 # match classname
1290 1294 classname_texts = texts[1].split('.')
1291 1295 classname = classname_texts[0]
1292 1296 classname_matches = [ c for c in classnames
1293 1297 if c.startswith(classname) ]
1294 1298
1295 1299 # return matched classes or the matched class with attributes
1296 1300 if texts[1].find('.') < 0:
1297 1301 return classname_matches
1298 1302 elif len(classname_matches) == 1 and \
1299 1303 classname_matches[0] == classname:
1300 1304 cls = classes[classnames.index(classname)].__class__
1301 1305 help = cls.class_get_help()
1302 1306 # strip leading '--' from cl-args:
1303 1307 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1304 1308 return [ attr.split('=')[0]
1305 1309 for attr in help.strip().splitlines()
1306 1310 if attr.startswith(texts[1]) ]
1307 1311 return []
1308 1312
1309 1313 def magic_color_matches(self, text:str) -> List[str] :
1310 1314 """ Match color schemes for %colors magic"""
1311 1315 texts = text.split()
1312 1316 if text.endswith(' '):
1313 1317 # .split() strips off the trailing whitespace. Add '' back
1314 1318 # so that: '%colors ' -> ['%colors', '']
1315 1319 texts.append('')
1316 1320
1317 1321 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
1318 1322 prefix = texts[1]
1319 1323 return [ color for color in InspectColors.keys()
1320 1324 if color.startswith(prefix) ]
1321 1325 return []
1322 1326
1323 1327 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1324 1328 """
1325 1329
1326 1330 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1327 1331 cursor position.
1328 1332
1329 1333 Parameters
1330 1334 ----------
1331 1335 cursor_column : int
1332 1336 column position of the cursor in ``text``, 0-indexed.
1333 1337 cursor_line : int
1334 1338 line position of the cursor in ``text``, 0-indexed
1335 1339 text : str
1336 1340 text to complete
1337 1341
1338 1342 Debugging
1339 1343 ---------
1340 1344
1341 1345 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1342 1346 object containing a string with the Jedi debug information attached.
1343 1347 """
1344 1348 namespaces = [self.namespace]
1345 1349 if self.global_namespace is not None:
1346 1350 namespaces.append(self.global_namespace)
1347 1351
1348 1352 completion_filter = lambda x:x
1349 1353 offset = cursor_to_position(text, cursor_line, cursor_column)
1350 1354 # filter output if we are completing for object members
1351 1355 if offset:
1352 1356 pre = text[offset-1]
1353 1357 if pre == '.':
1354 1358 if self.omit__names == 2:
1355 1359 completion_filter = lambda c:not c.name.startswith('_')
1356 1360 elif self.omit__names == 1:
1357 1361 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1358 1362 elif self.omit__names == 0:
1359 1363 completion_filter = lambda x:x
1360 1364 else:
1361 1365 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1362 1366
1363 1367 interpreter = jedi.Interpreter(
1364 1368 text[:offset], namespaces, column=cursor_column, line=cursor_line + 1)
1365 1369 try_jedi = True
1366 1370
1367 1371 try:
1368 1372 # should we check the type of the node is Error ?
1369 1373 try:
1370 1374 # jedi < 0.11
1371 1375 from jedi.parser.tree import ErrorLeaf
1372 1376 except ImportError:
1373 1377 # jedi >= 0.11
1374 1378 from parso.tree import ErrorLeaf
1375 1379
1376 1380 next_to_last_tree = interpreter._get_module().tree_node.children[-2]
1377 1381 completing_string = False
1378 1382 if isinstance(next_to_last_tree, ErrorLeaf):
1379 1383 completing_string = next_to_last_tree.value.lstrip()[0] in {'"', "'"}
1380 1384 # if we are in a string jedi is likely not the right candidate for
1381 1385 # now. Skip it.
1382 1386 try_jedi = not completing_string
1383 1387 except Exception as e:
1384 1388 # many of things can go wrong, we are using private API just don't crash.
1385 1389 if self.debug:
1386 1390 print("Error detecting if completing a non-finished string :", e, '|')
1387 1391
1388 1392 if not try_jedi:
1389 1393 return []
1390 1394 try:
1391 1395 return filter(completion_filter, interpreter.completions())
1392 1396 except Exception as e:
1393 1397 if self.debug:
1394 1398 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1395 1399 else:
1396 1400 return []
1397 1401
1398 1402 def python_matches(self, text):
1399 1403 """Match attributes or global python names"""
1400 1404 if "." in text:
1401 1405 try:
1402 1406 matches = self.attr_matches(text)
1403 1407 if text.endswith('.') and self.omit__names:
1404 1408 if self.omit__names == 1:
1405 1409 # true if txt is _not_ a __ name, false otherwise:
1406 1410 no__name = (lambda txt:
1407 1411 re.match(r'.*\.__.*?__',txt) is None)
1408 1412 else:
1409 1413 # true if txt is _not_ a _ name, false otherwise:
1410 1414 no__name = (lambda txt:
1411 1415 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1412 1416 matches = filter(no__name, matches)
1413 1417 except NameError:
1414 1418 # catches <undefined attributes>.<tab>
1415 1419 matches = []
1416 1420 else:
1417 1421 matches = self.global_matches(text)
1418 1422 return matches
1419 1423
1420 1424 def _default_arguments_from_docstring(self, doc):
1421 1425 """Parse the first line of docstring for call signature.
1422 1426
1423 1427 Docstring should be of the form 'min(iterable[, key=func])\n'.
1424 1428 It can also parse cython docstring of the form
1425 1429 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1426 1430 """
1427 1431 if doc is None:
1428 1432 return []
1429 1433
1430 1434 #care only the firstline
1431 1435 line = doc.lstrip().splitlines()[0]
1432 1436
1433 1437 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1434 1438 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1435 1439 sig = self.docstring_sig_re.search(line)
1436 1440 if sig is None:
1437 1441 return []
1438 1442 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1439 1443 sig = sig.groups()[0].split(',')
1440 1444 ret = []
1441 1445 for s in sig:
1442 1446 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1443 1447 ret += self.docstring_kwd_re.findall(s)
1444 1448 return ret
1445 1449
1446 1450 def _default_arguments(self, obj):
1447 1451 """Return the list of default arguments of obj if it is callable,
1448 1452 or empty list otherwise."""
1449 1453 call_obj = obj
1450 1454 ret = []
1451 1455 if inspect.isbuiltin(obj):
1452 1456 pass
1453 1457 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1454 1458 if inspect.isclass(obj):
1455 1459 #for cython embedsignature=True the constructor docstring
1456 1460 #belongs to the object itself not __init__
1457 1461 ret += self._default_arguments_from_docstring(
1458 1462 getattr(obj, '__doc__', ''))
1459 1463 # for classes, check for __init__,__new__
1460 1464 call_obj = (getattr(obj, '__init__', None) or
1461 1465 getattr(obj, '__new__', None))
1462 1466 # for all others, check if they are __call__able
1463 1467 elif hasattr(obj, '__call__'):
1464 1468 call_obj = obj.__call__
1465 1469 ret += self._default_arguments_from_docstring(
1466 1470 getattr(call_obj, '__doc__', ''))
1467 1471
1468 1472 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1469 1473 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1470 1474
1471 1475 try:
1472 1476 sig = inspect.signature(call_obj)
1473 1477 ret.extend(k for k, v in sig.parameters.items() if
1474 1478 v.kind in _keeps)
1475 1479 except ValueError:
1476 1480 pass
1477 1481
1478 1482 return list(set(ret))
1479 1483
1480 1484 def python_func_kw_matches(self,text):
1481 1485 """Match named parameters (kwargs) of the last open function"""
1482 1486
1483 1487 if "." in text: # a parameter cannot be dotted
1484 1488 return []
1485 1489 try: regexp = self.__funcParamsRegex
1486 1490 except AttributeError:
1487 1491 regexp = self.__funcParamsRegex = re.compile(r'''
1488 1492 '.*?(?<!\\)' | # single quoted strings or
1489 1493 ".*?(?<!\\)" | # double quoted strings or
1490 1494 \w+ | # identifier
1491 1495 \S # other characters
1492 1496 ''', re.VERBOSE | re.DOTALL)
1493 1497 # 1. find the nearest identifier that comes before an unclosed
1494 1498 # parenthesis before the cursor
1495 1499 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1496 1500 tokens = regexp.findall(self.text_until_cursor)
1497 1501 iterTokens = reversed(tokens); openPar = 0
1498 1502
1499 1503 for token in iterTokens:
1500 1504 if token == ')':
1501 1505 openPar -= 1
1502 1506 elif token == '(':
1503 1507 openPar += 1
1504 1508 if openPar > 0:
1505 1509 # found the last unclosed parenthesis
1506 1510 break
1507 1511 else:
1508 1512 return []
1509 1513 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1510 1514 ids = []
1511 1515 isId = re.compile(r'\w+$').match
1512 1516
1513 1517 while True:
1514 1518 try:
1515 1519 ids.append(next(iterTokens))
1516 1520 if not isId(ids[-1]):
1517 1521 ids.pop(); break
1518 1522 if not next(iterTokens) == '.':
1519 1523 break
1520 1524 except StopIteration:
1521 1525 break
1522 1526
1523 1527 # Find all named arguments already assigned to, as to avoid suggesting
1524 1528 # them again
1525 1529 usedNamedArgs = set()
1526 1530 par_level = -1
1527 1531 for token, next_token in zip(tokens, tokens[1:]):
1528 1532 if token == '(':
1529 1533 par_level += 1
1530 1534 elif token == ')':
1531 1535 par_level -= 1
1532 1536
1533 1537 if par_level != 0:
1534 1538 continue
1535 1539
1536 1540 if next_token != '=':
1537 1541 continue
1538 1542
1539 1543 usedNamedArgs.add(token)
1540 1544
1541 1545 argMatches = []
1542 1546 try:
1543 1547 callableObj = '.'.join(ids[::-1])
1544 1548 namedArgs = self._default_arguments(eval(callableObj,
1545 1549 self.namespace))
1546 1550
1547 1551 # Remove used named arguments from the list, no need to show twice
1548 1552 for namedArg in set(namedArgs) - usedNamedArgs:
1549 1553 if namedArg.startswith(text):
1550 1554 argMatches.append(u"%s=" %namedArg)
1551 1555 except:
1552 1556 pass
1553 1557
1554 1558 return argMatches
1555 1559
1556 1560 def dict_key_matches(self, text):
1557 1561 "Match string keys in a dictionary, after e.g. 'foo[' "
1558 1562 def get_keys(obj):
1559 1563 # Objects can define their own completions by defining an
1560 1564 # _ipy_key_completions_() method.
1561 1565 method = get_real_method(obj, '_ipython_key_completions_')
1562 1566 if method is not None:
1563 1567 return method()
1564 1568
1565 1569 # Special case some common in-memory dict-like types
1566 1570 if isinstance(obj, dict) or\
1567 1571 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1568 1572 try:
1569 1573 return list(obj.keys())
1570 1574 except Exception:
1571 1575 return []
1572 1576 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1573 1577 _safe_isinstance(obj, 'numpy', 'void'):
1574 1578 return obj.dtype.names or []
1575 1579 return []
1576 1580
1577 1581 try:
1578 1582 regexps = self.__dict_key_regexps
1579 1583 except AttributeError:
1580 1584 dict_key_re_fmt = r'''(?x)
1581 1585 ( # match dict-referring expression wrt greedy setting
1582 1586 %s
1583 1587 )
1584 1588 \[ # open bracket
1585 1589 \s* # and optional whitespace
1586 1590 ([uUbB]? # string prefix (r not handled)
1587 1591 (?: # unclosed string
1588 1592 '(?:[^']|(?<!\\)\\')*
1589 1593 |
1590 1594 "(?:[^"]|(?<!\\)\\")*
1591 1595 )
1592 1596 )?
1593 1597 $
1594 1598 '''
1595 1599 regexps = self.__dict_key_regexps = {
1596 1600 False: re.compile(dict_key_re_fmt % r'''
1597 1601 # identifiers separated by .
1598 1602 (?!\d)\w+
1599 1603 (?:\.(?!\d)\w+)*
1600 1604 '''),
1601 1605 True: re.compile(dict_key_re_fmt % '''
1602 1606 .+
1603 1607 ''')
1604 1608 }
1605 1609
1606 1610 match = regexps[self.greedy].search(self.text_until_cursor)
1607 1611 if match is None:
1608 1612 return []
1609 1613
1610 1614 expr, prefix = match.groups()
1611 1615 try:
1612 1616 obj = eval(expr, self.namespace)
1613 1617 except Exception:
1614 1618 try:
1615 1619 obj = eval(expr, self.global_namespace)
1616 1620 except Exception:
1617 1621 return []
1618 1622
1619 1623 keys = get_keys(obj)
1620 1624 if not keys:
1621 1625 return keys
1622 1626 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1623 1627 if not matches:
1624 1628 return matches
1625 1629
1626 1630 # get the cursor position of
1627 1631 # - the text being completed
1628 1632 # - the start of the key text
1629 1633 # - the start of the completion
1630 1634 text_start = len(self.text_until_cursor) - len(text)
1631 1635 if prefix:
1632 1636 key_start = match.start(2)
1633 1637 completion_start = key_start + token_offset
1634 1638 else:
1635 1639 key_start = completion_start = match.end()
1636 1640
1637 1641 # grab the leading prefix, to make sure all completions start with `text`
1638 1642 if text_start > key_start:
1639 1643 leading = ''
1640 1644 else:
1641 1645 leading = text[text_start:completion_start]
1642 1646
1643 1647 # the index of the `[` character
1644 1648 bracket_idx = match.end(1)
1645 1649
1646 1650 # append closing quote and bracket as appropriate
1647 1651 # this is *not* appropriate if the opening quote or bracket is outside
1648 1652 # the text given to this method
1649 1653 suf = ''
1650 1654 continuation = self.line_buffer[len(self.text_until_cursor):]
1651 1655 if key_start > text_start and closing_quote:
1652 1656 # quotes were opened inside text, maybe close them
1653 1657 if continuation.startswith(closing_quote):
1654 1658 continuation = continuation[len(closing_quote):]
1655 1659 else:
1656 1660 suf += closing_quote
1657 1661 if bracket_idx > text_start:
1658 1662 # brackets were opened inside text, maybe close them
1659 1663 if not continuation.startswith(']'):
1660 1664 suf += ']'
1661 1665
1662 1666 return [leading + k + suf for k in matches]
1663 1667
1664 1668 def unicode_name_matches(self, text):
1665 1669 u"""Match Latex-like syntax for unicode characters base
1666 1670 on the name of the character.
1667 1671
1668 1672 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1669 1673
1670 1674 Works only on valid python 3 identifier, or on combining characters that
1671 1675 will combine to form a valid identifier.
1672 1676
1673 1677 Used on Python 3 only.
1674 1678 """
1675 1679 slashpos = text.rfind('\\')
1676 1680 if slashpos > -1:
1677 1681 s = text[slashpos+1:]
1678 1682 try :
1679 1683 unic = unicodedata.lookup(s)
1680 1684 # allow combining chars
1681 1685 if ('a'+unic).isidentifier():
1682 1686 return '\\'+s,[unic]
1683 1687 except KeyError:
1684 1688 pass
1685 1689 return u'', []
1686 1690
1687 1691
1688 1692 def latex_matches(self, text):
1689 1693 u"""Match Latex syntax for unicode characters.
1690 1694
1691 1695 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1692 1696
1693 1697 Used on Python 3 only.
1694 1698 """
1695 1699 slashpos = text.rfind('\\')
1696 1700 if slashpos > -1:
1697 1701 s = text[slashpos:]
1698 1702 if s in latex_symbols:
1699 1703 # Try to complete a full latex symbol to unicode
1700 1704 # \\alpha -> Ξ±
1701 1705 return s, [latex_symbols[s]]
1702 1706 else:
1703 1707 # If a user has partially typed a latex symbol, give them
1704 1708 # a full list of options \al -> [\aleph, \alpha]
1705 1709 matches = [k for k in latex_symbols if k.startswith(s)]
1706 1710 return s, matches
1707 1711 return u'', []
1708 1712
1709 1713 def dispatch_custom_completer(self, text):
1710 1714 if not self.custom_completers:
1711 1715 return
1712 1716
1713 1717 line = self.line_buffer
1714 1718 if not line.strip():
1715 1719 return None
1716 1720
1717 1721 # Create a little structure to pass all the relevant information about
1718 1722 # the current completion to any custom completer.
1719 1723 event = SimpleNamespace()
1720 1724 event.line = line
1721 1725 event.symbol = text
1722 1726 cmd = line.split(None,1)[0]
1723 1727 event.command = cmd
1724 1728 event.text_until_cursor = self.text_until_cursor
1725 1729
1726 1730 # for foo etc, try also to find completer for %foo
1727 1731 if not cmd.startswith(self.magic_escape):
1728 1732 try_magic = self.custom_completers.s_matches(
1729 1733 self.magic_escape + cmd)
1730 1734 else:
1731 1735 try_magic = []
1732 1736
1733 1737 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1734 1738 try_magic,
1735 1739 self.custom_completers.flat_matches(self.text_until_cursor)):
1736 1740 try:
1737 1741 res = c(event)
1738 1742 if res:
1739 1743 # first, try case sensitive match
1740 1744 withcase = [r for r in res if r.startswith(text)]
1741 1745 if withcase:
1742 1746 return withcase
1743 1747 # if none, then case insensitive ones are ok too
1744 1748 text_low = text.lower()
1745 1749 return [r for r in res if r.lower().startswith(text_low)]
1746 1750 except TryNext:
1747 1751 pass
1748 1752 except KeyboardInterrupt:
1749 1753 """
1750 1754 If custom completer take too long,
1751 1755 let keyboard interrupt abort and return nothing.
1752 1756 """
1753 1757 break
1754 1758
1755 1759 return None
1756 1760
1757 1761 def completions(self, text: str, offset: int)->Iterator[Completion]:
1758 1762 """
1759 1763 Returns an iterator over the possible completions
1760 1764
1761 1765 .. warning:: Unstable
1762 1766
1763 1767 This function is unstable, API may change without warning.
1764 1768 It will also raise unless use in proper context manager.
1765 1769
1766 1770 Parameters
1767 1771 ----------
1768 1772
1769 1773 text:str
1770 1774 Full text of the current input, multi line string.
1771 1775 offset:int
1772 1776 Integer representing the position of the cursor in ``text``. Offset
1773 1777 is 0-based indexed.
1774 1778
1775 1779 Yields
1776 1780 ------
1777 1781 :any:`Completion` object
1778 1782
1779 1783
1780 1784 The cursor on a text can either be seen as being "in between"
1781 1785 characters or "On" a character depending on the interface visible to
1782 1786 the user. For consistency the cursor being on "in between" characters X
1783 1787 and Y is equivalent to the cursor being "on" character Y, that is to say
1784 1788 the character the cursor is on is considered as being after the cursor.
1785 1789
1786 1790 Combining characters may span more that one position in the
1787 1791 text.
1788 1792
1789 1793
1790 1794 .. note::
1791 1795
1792 1796 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1793 1797 fake Completion token to distinguish completion returned by Jedi
1794 1798 and usual IPython completion.
1795 1799
1796 1800 .. note::
1797 1801
1798 1802 Completions are not completely deduplicated yet. If identical
1799 1803 completions are coming from different sources this function does not
1800 1804 ensure that each completion object will only be present once.
1801 1805 """
1802 1806 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1803 1807 "It may change without warnings. "
1804 1808 "Use in corresponding context manager.",
1805 1809 category=ProvisionalCompleterWarning, stacklevel=2)
1806 1810
1807 1811 seen = set()
1808 1812 try:
1809 1813 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1810 1814 if c and (c in seen):
1811 1815 continue
1812 1816 yield c
1813 1817 seen.add(c)
1814 1818 except KeyboardInterrupt:
1815 1819 """if completions take too long and users send keyboard interrupt,
1816 1820 do not crash and return ASAP. """
1817 1821 pass
1818 1822
1819 1823 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1820 1824 """
1821 1825 Core completion module.Same signature as :any:`completions`, with the
1822 1826 extra `timeout` parameter (in seconds).
1823 1827
1824 1828
1825 1829 Computing jedi's completion ``.type`` can be quite expensive (it is a
1826 1830 lazy property) and can require some warm-up, more warm up than just
1827 1831 computing the ``name`` of a completion. The warm-up can be :
1828 1832
1829 1833 - Long warm-up the first time a module is encountered after
1830 1834 install/update: actually build parse/inference tree.
1831 1835
1832 1836 - first time the module is encountered in a session: load tree from
1833 1837 disk.
1834 1838
1835 1839 We don't want to block completions for tens of seconds so we give the
1836 1840 completer a "budget" of ``_timeout`` seconds per invocation to compute
1837 1841 completions types, the completions that have not yet been computed will
1838 1842 be marked as "unknown" an will have a chance to be computed next round
1839 1843 are things get cached.
1840 1844
1841 1845 Keep in mind that Jedi is not the only thing treating the completion so
1842 1846 keep the timeout short-ish as if we take more than 0.3 second we still
1843 1847 have lots of processing to do.
1844 1848
1845 1849 """
1846 1850 deadline = time.monotonic() + _timeout
1847 1851
1848 1852
1849 1853 before = full_text[:offset]
1850 1854 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1851 1855
1852 1856 matched_text, matches, matches_origin, jedi_matches = self._complete(
1853 1857 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1854 1858
1855 1859 iter_jm = iter(jedi_matches)
1856 1860 if _timeout:
1857 1861 for jm in iter_jm:
1858 1862 try:
1859 1863 type_ = jm.type
1860 1864 except Exception:
1861 1865 if self.debug:
1862 1866 print("Error in Jedi getting type of ", jm)
1863 1867 type_ = None
1864 1868 delta = len(jm.name_with_symbols) - len(jm.complete)
1865 1869 if type_ == 'function':
1866 1870 signature = _make_signature(jm)
1867 1871 else:
1868 1872 signature = ''
1869 1873 yield Completion(start=offset - delta,
1870 1874 end=offset,
1871 1875 text=jm.name_with_symbols,
1872 1876 type=type_,
1873 1877 signature=signature,
1874 1878 _origin='jedi')
1875 1879
1876 1880 if time.monotonic() > deadline:
1877 1881 break
1878 1882
1879 1883 for jm in iter_jm:
1880 1884 delta = len(jm.name_with_symbols) - len(jm.complete)
1881 1885 yield Completion(start=offset - delta,
1882 1886 end=offset,
1883 1887 text=jm.name_with_symbols,
1884 1888 type='<unknown>', # don't compute type for speed
1885 1889 _origin='jedi',
1886 1890 signature='')
1887 1891
1888 1892
1889 1893 start_offset = before.rfind(matched_text)
1890 1894
1891 1895 # TODO:
1892 1896 # Suppress this, right now just for debug.
1893 1897 if jedi_matches and matches and self.debug:
1894 1898 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--',
1895 1899 _origin='debug', type='none', signature='')
1896 1900
1897 1901 # I'm unsure if this is always true, so let's assert and see if it
1898 1902 # crash
1899 1903 assert before.endswith(matched_text)
1900 1904 for m, t in zip(matches, matches_origin):
1901 1905 yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>')
1902 1906
1903 1907
1904 1908 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1905 1909 """Find completions for the given text and line context.
1906 1910
1907 1911 Note that both the text and the line_buffer are optional, but at least
1908 1912 one of them must be given.
1909 1913
1910 1914 Parameters
1911 1915 ----------
1912 1916 text : string, optional
1913 1917 Text to perform the completion on. If not given, the line buffer
1914 1918 is split using the instance's CompletionSplitter object.
1915 1919
1916 1920 line_buffer : string, optional
1917 1921 If not given, the completer attempts to obtain the current line
1918 1922 buffer via readline. This keyword allows clients which are
1919 1923 requesting for text completions in non-readline contexts to inform
1920 1924 the completer of the entire text.
1921 1925
1922 1926 cursor_pos : int, optional
1923 1927 Index of the cursor in the full line buffer. Should be provided by
1924 1928 remote frontends where kernel has no access to frontend state.
1925 1929
1926 1930 Returns
1927 1931 -------
1928 1932 text : str
1929 1933 Text that was actually used in the completion.
1930 1934
1931 1935 matches : list
1932 1936 A list of completion matches.
1933 1937
1934 1938
1935 1939 .. note::
1936 1940
1937 1941 This API is likely to be deprecated and replaced by
1938 1942 :any:`IPCompleter.completions` in the future.
1939 1943
1940 1944
1941 1945 """
1942 1946 warnings.warn('`Completer.complete` is pending deprecation since '
1943 1947 'IPython 6.0 and will be replaced by `Completer.completions`.',
1944 1948 PendingDeprecationWarning)
1945 1949 # potential todo, FOLD the 3rd throw away argument of _complete
1946 1950 # into the first 2 one.
1947 1951 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1948 1952
1949 1953 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1950 1954 full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]:
1951 1955 """
1952 1956
1953 1957 Like complete but can also returns raw jedi completions as well as the
1954 1958 origin of the completion text. This could (and should) be made much
1955 1959 cleaner but that will be simpler once we drop the old (and stateful)
1956 1960 :any:`complete` API.
1957 1961
1958 1962
1959 1963 With current provisional API, cursor_pos act both (depending on the
1960 1964 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1961 1965 ``column`` when passing multiline strings this could/should be renamed
1962 1966 but would add extra noise.
1963 1967 """
1964 1968
1965 1969 # if the cursor position isn't given, the only sane assumption we can
1966 1970 # make is that it's at the end of the line (the common case)
1967 1971 if cursor_pos is None:
1968 1972 cursor_pos = len(line_buffer) if text is None else len(text)
1969 1973
1970 1974 if self.use_main_ns:
1971 1975 self.namespace = __main__.__dict__
1972 1976
1973 1977 # if text is either None or an empty string, rely on the line buffer
1974 1978 if (not line_buffer) and full_text:
1975 1979 line_buffer = full_text.split('\n')[cursor_line]
1976 1980 if not text:
1977 1981 text = self.splitter.split_line(line_buffer, cursor_pos)
1978 1982
1979 1983 if self.backslash_combining_completions:
1980 1984 # allow deactivation of these on windows.
1981 1985 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1982 1986 latex_text, latex_matches = self.latex_matches(base_text)
1983 1987 if latex_matches:
1984 1988 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1985 1989 name_text = ''
1986 1990 name_matches = []
1987 1991 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches):
1988 1992 name_text, name_matches = meth(base_text)
1989 1993 if name_text:
1990 1994 return name_text, name_matches[:MATCHES_LIMIT], \
1991 1995 [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), ()
1992 1996
1993 1997
1994 1998 # If no line buffer is given, assume the input text is all there was
1995 1999 if line_buffer is None:
1996 2000 line_buffer = text
1997 2001
1998 2002 self.line_buffer = line_buffer
1999 2003 self.text_until_cursor = self.line_buffer[:cursor_pos]
2000 2004
2001 2005 # Do magic arg matches
2002 2006 for matcher in self.magic_arg_matchers:
2003 2007 matches = list(matcher(line_buffer))[:MATCHES_LIMIT]
2004 2008 if matches:
2005 2009 origins = [matcher.__qualname__] * len(matches)
2006 2010 return text, matches, origins, ()
2007 2011
2008 2012 # Start with a clean slate of completions
2009 2013 matches = []
2010 2014 custom_res = self.dispatch_custom_completer(text)
2011 2015 # FIXME: we should extend our api to return a dict with completions for
2012 2016 # different types of objects. The rlcomplete() method could then
2013 2017 # simply collapse the dict into a list for readline, but we'd have
2014 2018 # richer completion semantics in other environments.
2015 2019 completions = ()
2016 2020 if self.use_jedi:
2017 2021 if not full_text:
2018 2022 full_text = line_buffer
2019 2023 completions = self._jedi_matches(
2020 2024 cursor_pos, cursor_line, full_text)
2021 2025 if custom_res is not None:
2022 2026 # did custom completers produce something?
2023 2027 matches = [(m, 'custom') for m in custom_res]
2024 2028 else:
2025 2029 # Extend the list of completions with the results of each
2026 2030 # matcher, so we return results to the user from all
2027 2031 # namespaces.
2028 2032 if self.merge_completions:
2029 2033 matches = []
2030 2034 for matcher in self.matchers:
2031 2035 try:
2032 2036 matches.extend([(m, matcher.__qualname__)
2033 2037 for m in matcher(text)])
2034 2038 except:
2035 2039 # Show the ugly traceback if the matcher causes an
2036 2040 # exception, but do NOT crash the kernel!
2037 2041 sys.excepthook(*sys.exc_info())
2038 2042 else:
2039 2043 for matcher in self.matchers:
2040 2044 matches = [(m, matcher.__qualname__)
2041 2045 for m in matcher(text)]
2042 2046 if matches:
2043 2047 break
2044 2048 seen = set()
2045 2049 filtered_matches = set()
2046 2050 for m in matches:
2047 2051 t, c = m
2048 2052 if t not in seen:
2049 2053 filtered_matches.add(m)
2050 2054 seen.add(t)
2051 2055
2052 2056 _filtered_matches = sorted(
2053 2057 set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))\
2054 2058 [:MATCHES_LIMIT]
2055 2059
2056 2060 _matches = [m[0] for m in _filtered_matches]
2057 2061 origins = [m[1] for m in _filtered_matches]
2058 2062
2059 2063 self.matches = _matches
2060 2064
2061 2065 return text, _matches, origins, completions
General Comments 0
You need to be logged in to leave comments. Login now