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