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