##// END OF EJS Templates
A test for completely builtin names
Tony Fast -
Show More
@@ -1,2091 +1,2089 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 171
172 172 class ProvisionalCompleterWarning(FutureWarning):
173 173 """
174 174 Exception raise by an experimental feature in this module.
175 175
176 176 Wrap code in :any:`provisionalcompleter` context manager if you
177 177 are certain you want to use an unstable feature.
178 178 """
179 179 pass
180 180
181 181 warnings.filterwarnings('error', category=ProvisionalCompleterWarning)
182 182
183 183 @contextmanager
184 184 def provisionalcompleter(action='ignore'):
185 185 """
186 186
187 187
188 188 This context manager has to be used in any place where unstable completer
189 189 behavior and API may be called.
190 190
191 191 >>> with provisionalcompleter():
192 192 ... completer.do_experimental_things() # works
193 193
194 194 >>> completer.do_experimental_things() # raises.
195 195
196 196 .. note:: Unstable
197 197
198 198 By using this context manager you agree that the API in use may change
199 199 without warning, and that you won't complain if they do so.
200 200
201 201 You also understand that, if the API is not to your liking, you should report
202 202 a bug to explain your use case upstream.
203 203
204 204 We'll be happy to get your feedback, feature requests, and improvements 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 information 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
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 Parameter
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 _names = None
995 995
996 996 @observe('greedy')
997 997 def _greedy_changed(self, change):
998 998 """update the splitter and readline delims when greedy is changed"""
999 999 if change['new']:
1000 1000 self.splitter.delims = GREEDY_DELIMS
1001 1001 else:
1002 1002 self.splitter.delims = DELIMS
1003 1003
1004 1004 dict_keys_only = Bool(False,
1005 1005 help="""Whether to show dict key matches only""")
1006 1006
1007 1007 merge_completions = Bool(True,
1008 1008 help="""Whether to merge completion results into a single list
1009 1009
1010 1010 If False, only the completion results from the first non-empty
1011 1011 completer will be returned.
1012 1012 """
1013 1013 ).tag(config=True)
1014 1014 omit__names = Enum((0,1,2), default_value=2,
1015 1015 help="""Instruct the completer to omit private method names
1016 1016
1017 1017 Specifically, when completing on ``object.<tab>``.
1018 1018
1019 1019 When 2 [default]: all names that start with '_' will be excluded.
1020 1020
1021 1021 When 1: all 'magic' names (``__foo__``) will be excluded.
1022 1022
1023 1023 When 0: nothing will be excluded.
1024 1024 """
1025 1025 ).tag(config=True)
1026 1026 limit_to__all__ = Bool(False,
1027 1027 help="""
1028 1028 DEPRECATED as of version 5.0.
1029 1029
1030 1030 Instruct the completer to use __all__ for the completion
1031 1031
1032 1032 Specifically, when completing on ``object.<tab>``.
1033 1033
1034 1034 When True: only those names in obj.__all__ will be included.
1035 1035
1036 1036 When False [default]: the __all__ attribute is ignored
1037 1037 """,
1038 1038 ).tag(config=True)
1039 1039
1040 1040 @observe('limit_to__all__')
1041 1041 def _limit_to_all_changed(self, change):
1042 1042 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1043 1043 'value has been deprecated since IPython 5.0, will be made to have '
1044 1044 'no effects and then removed in future version of IPython.',
1045 1045 UserWarning)
1046 1046
1047 1047 def __init__(self, shell=None, namespace=None, global_namespace=None,
1048 1048 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
1049 1049 """IPCompleter() -> completer
1050 1050
1051 1051 Return a completer object.
1052 1052
1053 1053 Parameters
1054 1054 ----------
1055 1055
1056 1056 shell
1057 1057 a pointer to the ipython shell itself. This is needed
1058 1058 because this completer knows about magic functions, and those can
1059 1059 only be accessed via the ipython instance.
1060 1060
1061 1061 namespace : dict, optional
1062 1062 an optional dict where completions are performed.
1063 1063
1064 1064 global_namespace : dict, optional
1065 1065 secondary optional dict for completions, to
1066 1066 handle cases (such as IPython embedded inside functions) where
1067 1067 both Python scopes are visible.
1068 1068
1069 1069 use_readline : bool, optional
1070 1070 DEPRECATED, ignored since IPython 6.0, will have no effects
1071 1071 """
1072 1072
1073 1073 self.magic_escape = ESC_MAGIC
1074 1074 self.splitter = CompletionSplitter()
1075 1075
1076 1076 if use_readline is not _deprecation_readline_sentinel:
1077 1077 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1078 1078 DeprecationWarning, stacklevel=2)
1079 1079
1080 1080 # _greedy_changed() depends on splitter and readline being defined:
1081 1081 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1082 1082 config=config, **kwargs)
1083 1083
1084 1084 # List where completion matches will be stored
1085 1085 self.matches = []
1086 1086 self.shell = shell
1087 1087 # Regexp to split filenames with spaces in them
1088 1088 self.space_name_re = re.compile(r'([^\\] )')
1089 1089 # Hold a local ref. to glob.glob for speed
1090 1090 self.glob = glob.glob
1091 1091
1092 1092 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1093 1093 # buffers, to avoid completion problems.
1094 1094 term = os.environ.get('TERM','xterm')
1095 1095 self.dumb_terminal = term in ['dumb','emacs']
1096 1096
1097 1097 # Special handling of backslashes needed in win32 platforms
1098 1098 if sys.platform == "win32":
1099 1099 self.clean_glob = self._clean_glob_win32
1100 1100 else:
1101 1101 self.clean_glob = self._clean_glob
1102 1102
1103 1103 #regexp to parse docstring for function signature
1104 1104 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1105 1105 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1106 1106 #use this if positional argument name is also needed
1107 1107 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1108 1108
1109 1109 self.magic_arg_matchers = [
1110 1110 self.magic_config_matches,
1111 1111 self.magic_color_matches,
1112 1112 ]
1113 1113
1114 1114 # This is set externally by InteractiveShell
1115 1115 self.custom_completers = None
1116 1116
1117 1117 @property
1118 1118 def matchers(self):
1119 1119 """All active matcher routines for completion"""
1120 1120 if self.dict_keys_only:
1121 1121 return [self.dict_key_matches]
1122 1122
1123 1123 if self.use_jedi:
1124 1124 return [
1125 1125 self.file_matches,
1126 1126 self.magic_matches,
1127 1127 self.dict_key_matches,
1128 1128 ]
1129 1129 else:
1130 1130 return [
1131 1131 self.python_matches,
1132 1132 self.file_matches,
1133 1133 self.magic_matches,
1134 1134 self.python_func_kw_matches,
1135 1135 self.dict_key_matches,
1136 1136 ]
1137 1137
1138 1138 def all_completions(self, text) -> List[str]:
1139 1139 """
1140 1140 Wrapper around the completion methods for the benefit of emacs.
1141 1141 """
1142 1142 prefix = text.rpartition('.')[0]
1143 1143 with provisionalcompleter():
1144 1144 return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text
1145 1145 for c in self.completions(text, len(text))]
1146 1146
1147 1147 return self.complete(text)[1]
1148 1148
1149 1149 def _clean_glob(self, text):
1150 1150 return self.glob("%s*" % text)
1151 1151
1152 1152 def _clean_glob_win32(self,text):
1153 1153 return [f.replace("\\","/")
1154 1154 for f in self.glob("%s*" % text)]
1155 1155
1156 1156 def file_matches(self, text):
1157 1157 """Match filenames, expanding ~USER type strings.
1158 1158
1159 1159 Most of the seemingly convoluted logic in this completer is an
1160 1160 attempt to handle filenames with spaces in them. And yet it's not
1161 1161 quite perfect, because Python's readline doesn't expose all of the
1162 1162 GNU readline details needed for this to be done correctly.
1163 1163
1164 1164 For a filename with a space in it, the printed completions will be
1165 1165 only the parts after what's already been typed (instead of the
1166 1166 full completions, as is normally done). I don't think with the
1167 1167 current (as of Python 2.3) Python readline it's possible to do
1168 1168 better."""
1169 1169
1170 1170 # chars that require escaping with backslash - i.e. chars
1171 1171 # that readline treats incorrectly as delimiters, but we
1172 1172 # don't want to treat as delimiters in filename matching
1173 1173 # when escaped with backslash
1174 1174 if text.startswith('!'):
1175 1175 text = text[1:]
1176 1176 text_prefix = u'!'
1177 1177 else:
1178 1178 text_prefix = u''
1179 1179
1180 1180 text_until_cursor = self.text_until_cursor
1181 1181 # track strings with open quotes
1182 1182 open_quotes = has_open_quotes(text_until_cursor)
1183 1183
1184 1184 if '(' in text_until_cursor or '[' in text_until_cursor:
1185 1185 lsplit = text
1186 1186 else:
1187 1187 try:
1188 1188 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1189 1189 lsplit = arg_split(text_until_cursor)[-1]
1190 1190 except ValueError:
1191 1191 # typically an unmatched ", or backslash without escaped char.
1192 1192 if open_quotes:
1193 1193 lsplit = text_until_cursor.split(open_quotes)[-1]
1194 1194 else:
1195 1195 return []
1196 1196 except IndexError:
1197 1197 # tab pressed on empty line
1198 1198 lsplit = ""
1199 1199
1200 1200 if not open_quotes and lsplit != protect_filename(lsplit):
1201 1201 # if protectables are found, do matching on the whole escaped name
1202 1202 has_protectables = True
1203 1203 text0,text = text,lsplit
1204 1204 else:
1205 1205 has_protectables = False
1206 1206 text = os.path.expanduser(text)
1207 1207
1208 1208 if text == "":
1209 1209 return [text_prefix + protect_filename(f) for f in self.glob("*")]
1210 1210
1211 1211 # Compute the matches from the filesystem
1212 1212 if sys.platform == 'win32':
1213 1213 m0 = self.clean_glob(text)
1214 1214 else:
1215 1215 m0 = self.clean_glob(text.replace('\\', ''))
1216 1216
1217 1217 if has_protectables:
1218 1218 # If we had protectables, we need to revert our changes to the
1219 1219 # beginning of filename so that we don't double-write the part
1220 1220 # of the filename we have so far
1221 1221 len_lsplit = len(lsplit)
1222 1222 matches = [text_prefix + text0 +
1223 1223 protect_filename(f[len_lsplit:]) for f in m0]
1224 1224 else:
1225 1225 if open_quotes:
1226 1226 # if we have a string with an open quote, we don't need to
1227 1227 # protect the names beyond the quote (and we _shouldn't_, as
1228 1228 # it would cause bugs when the filesystem call is made).
1229 1229 matches = m0 if sys.platform == "win32" else\
1230 1230 [protect_filename(f, open_quotes) for f in m0]
1231 1231 else:
1232 1232 matches = [text_prefix +
1233 1233 protect_filename(f) for f in m0]
1234 1234
1235 1235 # Mark directories in input list by appending '/' to their names.
1236 1236 return [x+'/' if os.path.isdir(x) else x for x in matches]
1237 1237
1238 1238 def magic_matches(self, text):
1239 1239 """Match magics"""
1240 1240 # Get all shell magics now rather than statically, so magics loaded at
1241 1241 # runtime show up too.
1242 1242 lsm = self.shell.magics_manager.lsmagic()
1243 1243 line_magics = lsm['line']
1244 1244 cell_magics = lsm['cell']
1245 1245 pre = self.magic_escape
1246 1246 pre2 = pre+pre
1247 1247
1248 1248 explicit_magic = text.startswith(pre)
1249 1249
1250 1250 # Completion logic:
1251 1251 # - user gives %%: only do cell magics
1252 1252 # - user gives %: do both line and cell magics
1253 1253 # - no prefix: do both
1254 1254 # In other words, line magics are skipped if the user gives %% explicitly
1255 1255 #
1256 1256 # We also exclude magics that match any currently visible names:
1257 1257 # https://github.com/ipython/ipython/issues/4877, unless the user has
1258 1258 # typed a %:
1259 1259 # https://github.com/ipython/ipython/issues/10754
1260 1260 bare_text = text.lstrip(pre)
1261 1261 global_matches = self.global_matches(bare_text)
1262 1262 if not explicit_magic:
1263 1263 def matches(magic):
1264 1264 """
1265 1265 Filter magics, in particular remove magics that match
1266 1266 a name present in global namespace.
1267 1267 """
1268 1268 return ( magic.startswith(bare_text) and
1269 1269 magic not in global_matches )
1270 1270 else:
1271 1271 def matches(magic):
1272 1272 return magic.startswith(bare_text)
1273 1273
1274 1274 comp = [ pre2+m for m in cell_magics if matches(m)]
1275 1275 if not text.startswith(pre2):
1276 1276 comp += [ pre+m for m in line_magics if matches(m)]
1277 1277
1278 1278 return comp
1279 1279
1280 1280 def magic_config_matches(self, text:str) -> List[str]:
1281 1281 """ Match class names and attributes for %config magic """
1282 1282 texts = text.strip().split()
1283 1283
1284 1284 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
1285 1285 # get all configuration classes
1286 1286 classes = sorted(set([ c for c in self.shell.configurables
1287 1287 if c.__class__.class_traits(config=True)
1288 1288 ]), key=lambda x: x.__class__.__name__)
1289 1289 classnames = [ c.__class__.__name__ for c in classes ]
1290 1290
1291 1291 # return all classnames if config or %config is given
1292 1292 if len(texts) == 1:
1293 1293 return classnames
1294 1294
1295 1295 # match classname
1296 1296 classname_texts = texts[1].split('.')
1297 1297 classname = classname_texts[0]
1298 1298 classname_matches = [ c for c in classnames
1299 1299 if c.startswith(classname) ]
1300 1300
1301 1301 # return matched classes or the matched class with attributes
1302 1302 if texts[1].find('.') < 0:
1303 1303 return classname_matches
1304 1304 elif len(classname_matches) == 1 and \
1305 1305 classname_matches[0] == classname:
1306 1306 cls = classes[classnames.index(classname)].__class__
1307 1307 help = cls.class_get_help()
1308 1308 # strip leading '--' from cl-args:
1309 1309 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1310 1310 return [ attr.split('=')[0]
1311 1311 for attr in help.strip().splitlines()
1312 1312 if attr.startswith(texts[1]) ]
1313 1313 return []
1314 1314
1315 1315 def magic_color_matches(self, text:str) -> List[str] :
1316 1316 """ Match color schemes for %colors magic"""
1317 1317 texts = text.split()
1318 1318 if text.endswith(' '):
1319 1319 # .split() strips off the trailing whitespace. Add '' back
1320 1320 # so that: '%colors ' -> ['%colors', '']
1321 1321 texts.append('')
1322 1322
1323 1323 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
1324 1324 prefix = texts[1]
1325 1325 return [ color for color in InspectColors.keys()
1326 1326 if color.startswith(prefix) ]
1327 1327 return []
1328 1328
1329 1329 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1330 1330 """
1331 1331
1332 1332 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1333 1333 cursor position.
1334 1334
1335 1335 Parameters
1336 1336 ----------
1337 1337 cursor_column : int
1338 1338 column position of the cursor in ``text``, 0-indexed.
1339 1339 cursor_line : int
1340 1340 line position of the cursor in ``text``, 0-indexed
1341 1341 text : str
1342 1342 text to complete
1343 1343
1344 1344 Debugging
1345 1345 ---------
1346 1346
1347 1347 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1348 1348 object containing a string with the Jedi debug information attached.
1349 1349 """
1350 1350 namespaces = [self.namespace]
1351 1351 if self.global_namespace is not None:
1352 1352 namespaces.append(self.global_namespace)
1353 1353
1354 1354 completion_filter = lambda x:x
1355 1355 offset = cursor_to_position(text, cursor_line, cursor_column)
1356 1356 # filter output if we are completing for object members
1357 1357 if offset:
1358 1358 pre = text[offset-1]
1359 1359 if pre == '.':
1360 1360 if self.omit__names == 2:
1361 1361 completion_filter = lambda c:not c.name.startswith('_')
1362 1362 elif self.omit__names == 1:
1363 1363 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1364 1364 elif self.omit__names == 0:
1365 1365 completion_filter = lambda x:x
1366 1366 else:
1367 1367 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1368 1368
1369 1369 interpreter = jedi.Interpreter(
1370 1370 text[:offset], namespaces, column=cursor_column, line=cursor_line + 1)
1371 1371 try_jedi = True
1372 1372
1373 1373 try:
1374 1374 # should we check the type of the node is Error ?
1375 1375 try:
1376 1376 # jedi < 0.11
1377 1377 from jedi.parser.tree import ErrorLeaf
1378 1378 except ImportError:
1379 1379 # jedi >= 0.11
1380 1380 from parso.tree import ErrorLeaf
1381 1381
1382 1382 next_to_last_tree = interpreter._get_module().tree_node.children[-2]
1383 1383 completing_string = False
1384 1384 if isinstance(next_to_last_tree, ErrorLeaf):
1385 1385 completing_string = next_to_last_tree.value.lstrip()[0] in {'"', "'"}
1386 1386 # if we are in a string jedi is likely not the right candidate for
1387 1387 # now. Skip it.
1388 1388 try_jedi = not completing_string
1389 1389 except Exception as e:
1390 1390 # many of things can go wrong, we are using private API just don't crash.
1391 1391 if self.debug:
1392 1392 print("Error detecting if completing a non-finished string :", e, '|')
1393 1393
1394 1394 if not try_jedi:
1395 1395 return []
1396 1396 try:
1397 1397 return filter(completion_filter, interpreter.completions())
1398 1398 except Exception as e:
1399 1399 if self.debug:
1400 1400 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1401 1401 else:
1402 1402 return []
1403 1403
1404 1404 def python_matches(self, text):
1405 1405 """Match attributes or global python names"""
1406 1406 if "." in text:
1407 1407 try:
1408 1408 matches = self.attr_matches(text)
1409 1409 if text.endswith('.') and self.omit__names:
1410 1410 if self.omit__names == 1:
1411 1411 # true if txt is _not_ a __ name, false otherwise:
1412 1412 no__name = (lambda txt:
1413 1413 re.match(r'.*\.__.*?__',txt) is None)
1414 1414 else:
1415 1415 # true if txt is _not_ a _ name, false otherwise:
1416 1416 no__name = (lambda txt:
1417 1417 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1418 1418 matches = filter(no__name, matches)
1419 1419 except NameError:
1420 1420 # catches <undefined attributes>.<tab>
1421 1421 matches = []
1422 1422 else:
1423 1423 matches = self.global_matches(text)
1424 1424 return matches
1425 1425
1426 1426 def _default_arguments_from_docstring(self, doc):
1427 1427 """Parse the first line of docstring for call signature.
1428 1428
1429 1429 Docstring should be of the form 'min(iterable[, key=func])\n'.
1430 1430 It can also parse cython docstring of the form
1431 1431 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1432 1432 """
1433 1433 if doc is None:
1434 1434 return []
1435 1435
1436 1436 #care only the firstline
1437 1437 line = doc.lstrip().splitlines()[0]
1438 1438
1439 1439 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1440 1440 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1441 1441 sig = self.docstring_sig_re.search(line)
1442 1442 if sig is None:
1443 1443 return []
1444 1444 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1445 1445 sig = sig.groups()[0].split(',')
1446 1446 ret = []
1447 1447 for s in sig:
1448 1448 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1449 1449 ret += self.docstring_kwd_re.findall(s)
1450 1450 return ret
1451 1451
1452 1452 def _default_arguments(self, obj):
1453 1453 """Return the list of default arguments of obj if it is callable,
1454 1454 or empty list otherwise."""
1455 1455 call_obj = obj
1456 1456 ret = []
1457 1457 if inspect.isbuiltin(obj):
1458 1458 pass
1459 1459 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1460 1460 if inspect.isclass(obj):
1461 1461 #for cython embedsignature=True the constructor docstring
1462 1462 #belongs to the object itself not __init__
1463 1463 ret += self._default_arguments_from_docstring(
1464 1464 getattr(obj, '__doc__', ''))
1465 1465 # for classes, check for __init__,__new__
1466 1466 call_obj = (getattr(obj, '__init__', None) or
1467 1467 getattr(obj, '__new__', None))
1468 1468 # for all others, check if they are __call__able
1469 1469 elif hasattr(obj, '__call__'):
1470 1470 call_obj = obj.__call__
1471 1471 ret += self._default_arguments_from_docstring(
1472 1472 getattr(call_obj, '__doc__', ''))
1473 1473
1474 1474 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1475 1475 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1476 1476
1477 1477 try:
1478 1478 sig = inspect.signature(call_obj)
1479 1479 ret.extend(k for k, v in sig.parameters.items() if
1480 1480 v.kind in _keeps)
1481 1481 except ValueError:
1482 1482 pass
1483 1483
1484 1484 return list(set(ret))
1485 1485
1486 1486 def python_func_kw_matches(self,text):
1487 1487 """Match named parameters (kwargs) of the last open function"""
1488 1488
1489 1489 if "." in text: # a parameter cannot be dotted
1490 1490 return []
1491 1491 try: regexp = self.__funcParamsRegex
1492 1492 except AttributeError:
1493 1493 regexp = self.__funcParamsRegex = re.compile(r'''
1494 1494 '.*?(?<!\\)' | # single quoted strings or
1495 1495 ".*?(?<!\\)" | # double quoted strings or
1496 1496 \w+ | # identifier
1497 1497 \S # other characters
1498 1498 ''', re.VERBOSE | re.DOTALL)
1499 1499 # 1. find the nearest identifier that comes before an unclosed
1500 1500 # parenthesis before the cursor
1501 1501 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1502 1502 tokens = regexp.findall(self.text_until_cursor)
1503 1503 iterTokens = reversed(tokens); openPar = 0
1504 1504
1505 1505 for token in iterTokens:
1506 1506 if token == ')':
1507 1507 openPar -= 1
1508 1508 elif token == '(':
1509 1509 openPar += 1
1510 1510 if openPar > 0:
1511 1511 # found the last unclosed parenthesis
1512 1512 break
1513 1513 else:
1514 1514 return []
1515 1515 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1516 1516 ids = []
1517 1517 isId = re.compile(r'\w+$').match
1518 1518
1519 1519 while True:
1520 1520 try:
1521 1521 ids.append(next(iterTokens))
1522 1522 if not isId(ids[-1]):
1523 1523 ids.pop(); break
1524 1524 if not next(iterTokens) == '.':
1525 1525 break
1526 1526 except StopIteration:
1527 1527 break
1528 1528
1529 1529 # Find all named arguments already assigned to, as to avoid suggesting
1530 1530 # them again
1531 1531 usedNamedArgs = set()
1532 1532 par_level = -1
1533 1533 for token, next_token in zip(tokens, tokens[1:]):
1534 1534 if token == '(':
1535 1535 par_level += 1
1536 1536 elif token == ')':
1537 1537 par_level -= 1
1538 1538
1539 1539 if par_level != 0:
1540 1540 continue
1541 1541
1542 1542 if next_token != '=':
1543 1543 continue
1544 1544
1545 1545 usedNamedArgs.add(token)
1546 1546
1547 1547 argMatches = []
1548 1548 try:
1549 1549 callableObj = '.'.join(ids[::-1])
1550 1550 namedArgs = self._default_arguments(eval(callableObj,
1551 1551 self.namespace))
1552 1552
1553 1553 # Remove used named arguments from the list, no need to show twice
1554 1554 for namedArg in set(namedArgs) - usedNamedArgs:
1555 1555 if namedArg.startswith(text):
1556 1556 argMatches.append(u"%s=" %namedArg)
1557 1557 except:
1558 1558 pass
1559 1559
1560 1560 return argMatches
1561 1561
1562 1562 def dict_key_matches(self, text):
1563 1563 "Match string keys in a dictionary, after e.g. 'foo[' "
1564 1564 def get_keys(obj):
1565 1565 # Objects can define their own completions by defining an
1566 1566 # _ipy_key_completions_() method.
1567 1567 method = get_real_method(obj, '_ipython_key_completions_')
1568 1568 if method is not None:
1569 1569 return method()
1570 1570
1571 1571 # Special case some common in-memory dict-like types
1572 1572 if isinstance(obj, dict) or\
1573 1573 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1574 1574 try:
1575 1575 return list(obj.keys())
1576 1576 except Exception:
1577 1577 return []
1578 1578 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1579 1579 _safe_isinstance(obj, 'numpy', 'void'):
1580 1580 return obj.dtype.names or []
1581 1581 return []
1582 1582
1583 1583 try:
1584 1584 regexps = self.__dict_key_regexps
1585 1585 except AttributeError:
1586 1586 dict_key_re_fmt = r'''(?x)
1587 1587 ( # match dict-referring expression wrt greedy setting
1588 1588 %s
1589 1589 )
1590 1590 \[ # open bracket
1591 1591 \s* # and optional whitespace
1592 1592 ([uUbB]? # string prefix (r not handled)
1593 1593 (?: # unclosed string
1594 1594 '(?:[^']|(?<!\\)\\')*
1595 1595 |
1596 1596 "(?:[^"]|(?<!\\)\\")*
1597 1597 )
1598 1598 )?
1599 1599 $
1600 1600 '''
1601 1601 regexps = self.__dict_key_regexps = {
1602 1602 False: re.compile(dict_key_re_fmt % r'''
1603 1603 # identifiers separated by .
1604 1604 (?!\d)\w+
1605 1605 (?:\.(?!\d)\w+)*
1606 1606 '''),
1607 1607 True: re.compile(dict_key_re_fmt % '''
1608 1608 .+
1609 1609 ''')
1610 1610 }
1611 1611
1612 1612 match = regexps[self.greedy].search(self.text_until_cursor)
1613 1613 if match is None:
1614 1614 return []
1615 1615
1616 1616 expr, prefix = match.groups()
1617 1617 try:
1618 1618 obj = eval(expr, self.namespace)
1619 1619 except Exception:
1620 1620 try:
1621 1621 obj = eval(expr, self.global_namespace)
1622 1622 except Exception:
1623 1623 return []
1624 1624
1625 1625 keys = get_keys(obj)
1626 1626 if not keys:
1627 1627 return keys
1628 1628 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1629 1629 if not matches:
1630 1630 return matches
1631 1631
1632 1632 # get the cursor position of
1633 1633 # - the text being completed
1634 1634 # - the start of the key text
1635 1635 # - the start of the completion
1636 1636 text_start = len(self.text_until_cursor) - len(text)
1637 1637 if prefix:
1638 1638 key_start = match.start(2)
1639 1639 completion_start = key_start + token_offset
1640 1640 else:
1641 1641 key_start = completion_start = match.end()
1642 1642
1643 1643 # grab the leading prefix, to make sure all completions start with `text`
1644 1644 if text_start > key_start:
1645 1645 leading = ''
1646 1646 else:
1647 1647 leading = text[text_start:completion_start]
1648 1648
1649 1649 # the index of the `[` character
1650 1650 bracket_idx = match.end(1)
1651 1651
1652 1652 # append closing quote and bracket as appropriate
1653 1653 # this is *not* appropriate if the opening quote or bracket is outside
1654 1654 # the text given to this method
1655 1655 suf = ''
1656 1656 continuation = self.line_buffer[len(self.text_until_cursor):]
1657 1657 if key_start > text_start and closing_quote:
1658 1658 # quotes were opened inside text, maybe close them
1659 1659 if continuation.startswith(closing_quote):
1660 1660 continuation = continuation[len(closing_quote):]
1661 1661 else:
1662 1662 suf += closing_quote
1663 1663 if bracket_idx > text_start:
1664 1664 # brackets were opened inside text, maybe close them
1665 1665 if not continuation.startswith(']'):
1666 1666 suf += ']'
1667 1667
1668 1668 return [leading + k + suf for k in matches]
1669 1669
1670 1670 def unicode_name_matches(self, text):
1671 1671 u"""Match Latex-like syntax for unicode characters base
1672 1672 on the name of the character.
1673 1673
1674 1674 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1675 1675
1676 1676 Works only on valid python 3 identifier, or on combining characters that
1677 1677 will combine to form a valid identifier.
1678 1678
1679 1679 Used on Python 3 only.
1680 1680 """
1681 1681 slashpos = text.rfind('\\')
1682 1682 if slashpos > -1:
1683 1683 s = text[slashpos+1:]
1684 1684 try :
1685 1685 unic = unicodedata.lookup(s)
1686 1686 # allow combining chars
1687 1687 if ('a'+unic).isidentifier():
1688 1688 return '\\'+s,[unic]
1689 1689 except KeyError:
1690 1690 pass
1691 1691 return u'', []
1692 1692
1693 1693
1694 1694 def latex_matches(self, text):
1695 1695 u"""Match Latex syntax for unicode characters.
1696 1696
1697 1697 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1698 1698
1699 1699 Used on Python 3 only.
1700 1700 """
1701 1701 slashpos = text.rfind('\\')
1702 1702 if slashpos > -1:
1703 1703 s = text[slashpos:]
1704 1704 if s in latex_symbols:
1705 1705 # Try to complete a full latex symbol to unicode
1706 1706 # \\alpha -> Ξ±
1707 1707 return s, [latex_symbols[s]]
1708 1708 else:
1709 1709 # If a user has partially typed a latex symbol, give them
1710 1710 # a full list of options \al -> [\aleph, \alpha]
1711 1711 matches = [k for k in latex_symbols if k.startswith(s)]
1712 1712 return s, matches
1713 1713 return u'', []
1714 1714
1715 1715 def dispatch_custom_completer(self, text):
1716 1716 if not self.custom_completers:
1717 1717 return
1718 1718
1719 1719 line = self.line_buffer
1720 1720 if not line.strip():
1721 1721 return None
1722 1722
1723 1723 # Create a little structure to pass all the relevant information about
1724 1724 # the current completion to any custom completer.
1725 1725 event = SimpleNamespace()
1726 1726 event.line = line
1727 1727 event.symbol = text
1728 1728 cmd = line.split(None,1)[0]
1729 1729 event.command = cmd
1730 1730 event.text_until_cursor = self.text_until_cursor
1731 1731
1732 1732 # for foo etc, try also to find completer for %foo
1733 1733 if not cmd.startswith(self.magic_escape):
1734 1734 try_magic = self.custom_completers.s_matches(
1735 1735 self.magic_escape + cmd)
1736 1736 else:
1737 1737 try_magic = []
1738 1738
1739 1739 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1740 1740 try_magic,
1741 1741 self.custom_completers.flat_matches(self.text_until_cursor)):
1742 1742 try:
1743 1743 res = c(event)
1744 1744 if res:
1745 1745 # first, try case sensitive match
1746 1746 withcase = [r for r in res if r.startswith(text)]
1747 1747 if withcase:
1748 1748 return withcase
1749 1749 # if none, then case insensitive ones are ok too
1750 1750 text_low = text.lower()
1751 1751 return [r for r in res if r.lower().startswith(text_low)]
1752 1752 except TryNext:
1753 1753 pass
1754 1754 except KeyboardInterrupt:
1755 1755 """
1756 1756 If custom completer take too long,
1757 1757 let keyboard interrupt abort and return nothing.
1758 1758 """
1759 1759 break
1760 1760
1761 1761 return None
1762 1762
1763 1763 def completions(self, text: str, offset: int)->Iterator[Completion]:
1764 1764 """
1765 1765 Returns an iterator over the possible completions
1766 1766
1767 1767 .. warning:: Unstable
1768 1768
1769 1769 This function is unstable, API may change without warning.
1770 1770 It will also raise unless use in proper context manager.
1771 1771
1772 1772 Parameters
1773 1773 ----------
1774 1774
1775 1775 text:str
1776 1776 Full text of the current input, multi line string.
1777 1777 offset:int
1778 1778 Integer representing the position of the cursor in ``text``. Offset
1779 1779 is 0-based indexed.
1780 1780
1781 1781 Yields
1782 1782 ------
1783 1783 :any:`Completion` object
1784 1784
1785 1785
1786 1786 The cursor on a text can either be seen as being "in between"
1787 1787 characters or "On" a character depending on the interface visible to
1788 1788 the user. For consistency the cursor being on "in between" characters X
1789 1789 and Y is equivalent to the cursor being "on" character Y, that is to say
1790 1790 the character the cursor is on is considered as being after the cursor.
1791 1791
1792 1792 Combining characters may span more that one position in the
1793 1793 text.
1794 1794
1795 1795
1796 1796 .. note::
1797 1797
1798 1798 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1799 1799 fake Completion token to distinguish completion returned by Jedi
1800 1800 and usual IPython completion.
1801 1801
1802 1802 .. note::
1803 1803
1804 1804 Completions are not completely deduplicated yet. If identical
1805 1805 completions are coming from different sources this function does not
1806 1806 ensure that each completion object will only be present once.
1807 1807 """
1808 1808 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1809 1809 "It may change without warnings. "
1810 1810 "Use in corresponding context manager.",
1811 1811 category=ProvisionalCompleterWarning, stacklevel=2)
1812 1812
1813 1813 seen = set()
1814 1814 try:
1815 1815 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1816 1816 if c and (c in seen):
1817 1817 continue
1818 1818 yield c
1819 1819 seen.add(c)
1820 1820 except KeyboardInterrupt:
1821 1821 """if completions take too long and users send keyboard interrupt,
1822 1822 do not crash and return ASAP. """
1823 1823 pass
1824 1824
1825 1825 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1826 1826 """
1827 1827 Core completion module.Same signature as :any:`completions`, with the
1828 1828 extra `timeout` parameter (in seconds).
1829 1829
1830 1830
1831 1831 Computing jedi's completion ``.type`` can be quite expensive (it is a
1832 1832 lazy property) and can require some warm-up, more warm up than just
1833 1833 computing the ``name`` of a completion. The warm-up can be :
1834 1834
1835 1835 - Long warm-up the first time a module is encountered after
1836 1836 install/update: actually build parse/inference tree.
1837 1837
1838 1838 - first time the module is encountered in a session: load tree from
1839 1839 disk.
1840 1840
1841 1841 We don't want to block completions for tens of seconds so we give the
1842 1842 completer a "budget" of ``_timeout`` seconds per invocation to compute
1843 1843 completions types, the completions that have not yet been computed will
1844 1844 be marked as "unknown" an will have a chance to be computed next round
1845 1845 are things get cached.
1846 1846
1847 1847 Keep in mind that Jedi is not the only thing treating the completion so
1848 1848 keep the timeout short-ish as if we take more than 0.3 second we still
1849 1849 have lots of processing to do.
1850 1850
1851 1851 """
1852 1852 deadline = time.monotonic() + _timeout
1853 1853
1854 1854
1855 1855 before = full_text[:offset]
1856 1856 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1857 1857
1858 1858 matched_text, matches, matches_origin, jedi_matches = self._complete(
1859 1859 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1860 1860
1861 1861 iter_jm = iter(jedi_matches)
1862 1862 if _timeout:
1863 1863 for jm in iter_jm:
1864 1864 try:
1865 1865 type_ = jm.type
1866 1866 except Exception:
1867 1867 if self.debug:
1868 1868 print("Error in Jedi getting type of ", jm)
1869 1869 type_ = None
1870 1870 delta = len(jm.name_with_symbols) - len(jm.complete)
1871 1871 if type_ == 'function':
1872 1872 signature = _make_signature(jm)
1873 1873 else:
1874 1874 signature = ''
1875 1875 yield Completion(start=offset - delta,
1876 1876 end=offset,
1877 1877 text=jm.name_with_symbols,
1878 1878 type=type_,
1879 1879 signature=signature,
1880 1880 _origin='jedi')
1881 1881
1882 1882 if time.monotonic() > deadline:
1883 1883 break
1884 1884
1885 1885 for jm in iter_jm:
1886 1886 delta = len(jm.name_with_symbols) - len(jm.complete)
1887 1887 yield Completion(start=offset - delta,
1888 1888 end=offset,
1889 1889 text=jm.name_with_symbols,
1890 1890 type='<unknown>', # don't compute type for speed
1891 1891 _origin='jedi',
1892 1892 signature='')
1893 1893
1894 1894
1895 1895 start_offset = before.rfind(matched_text)
1896 1896
1897 1897 # TODO:
1898 1898 # Suppress this, right now just for debug.
1899 1899 if jedi_matches and matches and self.debug:
1900 1900 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--',
1901 1901 _origin='debug', type='none', signature='')
1902 1902
1903 1903 # I'm unsure if this is always true, so let's assert and see if it
1904 1904 # crash
1905 1905 assert before.endswith(matched_text)
1906 1906 for m, t in zip(matches, matches_origin):
1907 1907 yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>')
1908 1908
1909 1909
1910 1910 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1911 1911 """Find completions for the given text and line context.
1912 1912
1913 1913 Note that both the text and the line_buffer are optional, but at least
1914 1914 one of them must be given.
1915 1915
1916 1916 Parameters
1917 1917 ----------
1918 1918 text : string, optional
1919 1919 Text to perform the completion on. If not given, the line buffer
1920 1920 is split using the instance's CompletionSplitter object.
1921 1921
1922 1922 line_buffer : string, optional
1923 1923 If not given, the completer attempts to obtain the current line
1924 1924 buffer via readline. This keyword allows clients which are
1925 1925 requesting for text completions in non-readline contexts to inform
1926 1926 the completer of the entire text.
1927 1927
1928 1928 cursor_pos : int, optional
1929 1929 Index of the cursor in the full line buffer. Should be provided by
1930 1930 remote frontends where kernel has no access to frontend state.
1931 1931
1932 1932 Returns
1933 1933 -------
1934 1934 text : str
1935 1935 Text that was actually used in the completion.
1936 1936
1937 1937 matches : list
1938 1938 A list of completion matches.
1939 1939
1940 1940
1941 1941 .. note::
1942 1942
1943 1943 This API is likely to be deprecated and replaced by
1944 1944 :any:`IPCompleter.completions` in the future.
1945 1945
1946 1946
1947 1947 """
1948 1948 warnings.warn('`Completer.complete` is pending deprecation since '
1949 1949 'IPython 6.0 and will be replaced by `Completer.completions`.',
1950 1950 PendingDeprecationWarning)
1951 1951 # potential todo, FOLD the 3rd throw away argument of _complete
1952 1952 # into the first 2 one.
1953 1953 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1954 1954
1955 1955 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1956 1956 full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]:
1957 1957 """
1958 1958
1959 1959 Like complete but can also returns raw jedi completions as well as the
1960 1960 origin of the completion text. This could (and should) be made much
1961 1961 cleaner but that will be simpler once we drop the old (and stateful)
1962 1962 :any:`complete` API.
1963 1963
1964 1964
1965 1965 With current provisional API, cursor_pos act both (depending on the
1966 1966 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1967 1967 ``column`` when passing multiline strings this could/should be renamed
1968 1968 but would add extra noise.
1969 1969 """
1970 1970
1971 1971 # if the cursor position isn't given, the only sane assumption we can
1972 1972 # make is that it's at the end of the line (the common case)
1973 1973 if cursor_pos is None:
1974 1974 cursor_pos = len(line_buffer) if text is None else len(text)
1975 1975
1976 1976 if self.use_main_ns:
1977 1977 self.namespace = __main__.__dict__
1978 1978
1979 1979 # if text is either None or an empty string, rely on the line buffer
1980 1980 if (not line_buffer) and full_text:
1981 1981 line_buffer = full_text.split('\n')[cursor_line]
1982 1982 if not text:
1983 1983 text = self.splitter.split_line(line_buffer, cursor_pos)
1984 1984
1985 1985 if self.backslash_combining_completions:
1986 1986 # allow deactivation of these on windows.
1987 1987 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1988 1988 latex_text, latex_matches = self.latex_matches(base_text)
1989 1989 if latex_matches:
1990 1990 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1991 1991 name_text = ''
1992 1992 name_matches = []
1993 1993 # need to add self.fwd_unicode_match() function here when done
1994 1994 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches, self.fwd_unicode_match):
1995 1995 name_text, name_matches = meth(base_text)
1996 1996 if name_text:
1997 1997 return name_text, name_matches[:MATCHES_LIMIT], \
1998 1998 [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), ()
1999 1999
2000 2000
2001 2001 # If no line buffer is given, assume the input text is all there was
2002 2002 if line_buffer is None:
2003 2003 line_buffer = text
2004 2004
2005 2005 self.line_buffer = line_buffer
2006 2006 self.text_until_cursor = self.line_buffer[:cursor_pos]
2007 2007
2008 2008 # Do magic arg matches
2009 2009 for matcher in self.magic_arg_matchers:
2010 2010 matches = list(matcher(line_buffer))[:MATCHES_LIMIT]
2011 2011 if matches:
2012 2012 origins = [matcher.__qualname__] * len(matches)
2013 2013 return text, matches, origins, ()
2014 2014
2015 2015 # Start with a clean slate of completions
2016 2016 matches = []
2017 custom_res = self.dispatch_custom_completer(text)
2017
2018 2018 # FIXME: we should extend our api to return a dict with completions for
2019 2019 # different types of objects. The rlcomplete() method could then
2020 2020 # simply collapse the dict into a list for readline, but we'd have
2021 2021 # richer completion semantics in other environments.
2022 2022 completions = ()
2023 2023 if self.use_jedi:
2024 2024 if not full_text:
2025 2025 full_text = line_buffer
2026 2026 completions = self._jedi_matches(
2027 2027 cursor_pos, cursor_line, full_text)
2028 if custom_res is not None:
2029 # did custom completers produce something?
2030 matches = [(m, 'custom') for m in custom_res]
2028
2029 if self.merge_completions:
2030 matches = []
2031 for matcher in self.matchers:
2032 try:
2033 matches.extend([(m, matcher.__qualname__)
2034 for m in matcher(text)])
2035 except:
2036 # Show the ugly traceback if the matcher causes an
2037 # exception, but do NOT crash the kernel!
2038 sys.excepthook(*sys.exc_info())
2031 2039 else:
2032 # Extend the list of completions with the results of each
2033 # matcher, so we return results to the user from all
2034 # namespaces.
2035 if self.merge_completions:
2036 matches = []
2037 for matcher in self.matchers:
2038 try:
2039 matches.extend([(m, matcher.__qualname__)
2040 for m in matcher(text)])
2041 except:
2042 # Show the ugly traceback if the matcher causes an
2043 # exception, but do NOT crash the kernel!
2044 sys.excepthook(*sys.exc_info())
2045 else:
2046 for matcher in self.matchers:
2047 matches = [(m, matcher.__qualname__)
2048 for m in matcher(text)]
2049 if matches:
2050 break
2040 for matcher in self.matchers:
2041 matches = [(m, matcher.__qualname__)
2042 for m in matcher(text)]
2043 if matches:
2044 break
2045
2051 2046 seen = set()
2052 2047 filtered_matches = set()
2053 2048 for m in matches:
2054 2049 t, c = m
2055 2050 if t not in seen:
2056 2051 filtered_matches.add(m)
2057 2052 seen.add(t)
2058 2053
2059 _filtered_matches = sorted(
2060 set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))\
2061 [:MATCHES_LIMIT]
2054 _filtered_matches = sorted(filtered_matches, key=lambda x: completions_sorting_key(x[0]))
2062 2055
2056 custom_res = [(m, 'custom') for m in self.dispatch_custom_completer(text) or []]
2057
2058 _filtered_matches = custom_res or _filtered_matches
2059
2060 _filtered_matches = _filtered_matches[:MATCHES_LIMIT]
2063 2061 _matches = [m[0] for m in _filtered_matches]
2064 2062 origins = [m[1] for m in _filtered_matches]
2065 2063
2066 2064 self.matches = _matches
2067 2065
2068 2066 return text, _matches, origins, completions
2069
2067
2070 2068 def fwd_unicode_match(self, text:str) -> Tuple[str, list]:
2071 2069 if self._names is None:
2072 2070 self._names = []
2073 2071 for c in range(0,0x10FFFF + 1):
2074 2072 try:
2075 2073 self._names.append(unicodedata.name(chr(c)))
2076 2074 except ValueError:
2077 2075 pass
2078 2076
2079 2077 slashpos = text.rfind('\\')
2080 2078 # if text starts with slash
2081 2079 if slashpos > -1:
2082 2080 s = text[slashpos+1:]
2083 2081 candidates = [x for x in self._names if x.startswith(s)]
2084 2082 if candidates:
2085 2083 return s, candidates
2086 2084 else:
2087 2085 return '', ()
2088 2086
2089 2087 # if text does not start with slash
2090 2088 else:
2091 2089 return u'', ()
@@ -1,1091 +1,1105 b''
1 1 # encoding: utf-8
2 2 """Tests for the IPython tab-completion machinery."""
3 3
4 4 # Copyright (c) IPython Development Team.
5 5 # Distributed under the terms of the Modified BSD License.
6 6
7 7 import os
8 8 import sys
9 9 import textwrap
10 10 import unittest
11 11
12 12 from contextlib import contextmanager
13 13
14 14 import nose.tools as nt
15 15
16 16 from traitlets.config.loader import Config
17 17 from IPython import get_ipython
18 18 from IPython.core import completer
19 19 from IPython.external import decorators
20 20 from IPython.utils.tempdir import TemporaryDirectory, TemporaryWorkingDirectory
21 21 from IPython.utils.generics import complete_object
22 22 from IPython.testing import decorators as dec
23 23
24 24 from IPython.core.completer import (
25 25 Completion,
26 26 provisionalcompleter,
27 27 match_dict_keys,
28 28 _deduplicate_completions,
29 29 )
30 30 from nose.tools import assert_in, assert_not_in
31 31
32 32 # -----------------------------------------------------------------------------
33 33 # Test functions
34 34 # -----------------------------------------------------------------------------
35 35
36 36
37 37 @contextmanager
38 38 def greedy_completion():
39 39 ip = get_ipython()
40 40 greedy_original = ip.Completer.greedy
41 41 try:
42 42 ip.Completer.greedy = True
43 43 yield
44 44 finally:
45 45 ip.Completer.greedy = greedy_original
46 46
47 47
48 48 def test_protect_filename():
49 49 if sys.platform == "win32":
50 50 pairs = [
51 51 ("abc", "abc"),
52 52 (" abc", '" abc"'),
53 53 ("a bc", '"a bc"'),
54 54 ("a bc", '"a bc"'),
55 55 (" bc", '" bc"'),
56 56 ]
57 57 else:
58 58 pairs = [
59 59 ("abc", "abc"),
60 60 (" abc", r"\ abc"),
61 61 ("a bc", r"a\ bc"),
62 62 ("a bc", r"a\ \ bc"),
63 63 (" bc", r"\ \ bc"),
64 64 # On posix, we also protect parens and other special characters.
65 65 ("a(bc", r"a\(bc"),
66 66 ("a)bc", r"a\)bc"),
67 67 ("a( )bc", r"a\(\ \)bc"),
68 68 ("a[1]bc", r"a\[1\]bc"),
69 69 ("a{1}bc", r"a\{1\}bc"),
70 70 ("a#bc", r"a\#bc"),
71 71 ("a?bc", r"a\?bc"),
72 72 ("a=bc", r"a\=bc"),
73 73 ("a\\bc", r"a\\bc"),
74 74 ("a|bc", r"a\|bc"),
75 75 ("a;bc", r"a\;bc"),
76 76 ("a:bc", r"a\:bc"),
77 77 ("a'bc", r"a\'bc"),
78 78 ("a*bc", r"a\*bc"),
79 79 ('a"bc', r"a\"bc"),
80 80 ("a^bc", r"a\^bc"),
81 81 ("a&bc", r"a\&bc"),
82 82 ]
83 83 # run the actual tests
84 84 for s1, s2 in pairs:
85 85 s1p = completer.protect_filename(s1)
86 86 nt.assert_equal(s1p, s2)
87 87
88 88
89 89 def check_line_split(splitter, test_specs):
90 90 for part1, part2, split in test_specs:
91 91 cursor_pos = len(part1)
92 92 line = part1 + part2
93 93 out = splitter.split_line(line, cursor_pos)
94 94 nt.assert_equal(out, split)
95 95
96 96
97 97 def test_line_split():
98 98 """Basic line splitter test with default specs."""
99 99 sp = completer.CompletionSplitter()
100 100 # The format of the test specs is: part1, part2, expected answer. Parts 1
101 101 # and 2 are joined into the 'line' sent to the splitter, as if the cursor
102 102 # was at the end of part1. So an empty part2 represents someone hitting
103 103 # tab at the end of the line, the most common case.
104 104 t = [
105 105 ("run some/scrip", "", "some/scrip"),
106 106 ("run scripts/er", "ror.py foo", "scripts/er"),
107 107 ("echo $HOM", "", "HOM"),
108 108 ("print sys.pa", "", "sys.pa"),
109 109 ("print(sys.pa", "", "sys.pa"),
110 110 ("execfile('scripts/er", "", "scripts/er"),
111 111 ("a[x.", "", "x."),
112 112 ("a[x.", "y", "x."),
113 113 ('cd "some_file/', "", "some_file/"),
114 114 ]
115 115 check_line_split(sp, t)
116 116 # Ensure splitting works OK with unicode by re-running the tests with
117 117 # all inputs turned into unicode
118 118 check_line_split(sp, [map(str, p) for p in t])
119 119
120 120
121 121 class NamedInstanceMetaclass(type):
122 122 def __getitem__(cls, item):
123 123 return cls.get_instance(item)
124 124
125 125
126 126 class NamedInstanceClass(metaclass=NamedInstanceMetaclass):
127 127 def __init__(self, name):
128 128 if not hasattr(self.__class__, "instances"):
129 129 self.__class__.instances = {}
130 130 self.__class__.instances[name] = self
131 131
132 132 @classmethod
133 133 def _ipython_key_completions_(cls):
134 134 return cls.instances.keys()
135 135
136 136 @classmethod
137 137 def get_instance(cls, name):
138 138 return cls.instances[name]
139 139
140 140
141 141 class KeyCompletable:
142 142 def __init__(self, things=()):
143 143 self.things = things
144 144
145 145 def _ipython_key_completions_(self):
146 146 return list(self.things)
147 147
148 148
149 149 class TestCompleter(unittest.TestCase):
150 150 def setUp(self):
151 151 """
152 152 We want to silence all PendingDeprecationWarning when testing the completer
153 153 """
154 154 self._assertwarns = self.assertWarns(PendingDeprecationWarning)
155 155 self._assertwarns.__enter__()
156 156
157 157 def tearDown(self):
158 158 try:
159 159 self._assertwarns.__exit__(None, None, None)
160 160 except AssertionError:
161 161 pass
162 162
163 163 def test_custom_completion_error(self):
164 164 """Test that errors from custom attribute completers are silenced."""
165 165 ip = get_ipython()
166 166
167 167 class A:
168 168 pass
169 169
170 170 ip.user_ns["x"] = A()
171 171
172 172 @complete_object.register(A)
173 173 def complete_A(a, existing_completions):
174 174 raise TypeError("this should be silenced")
175 175
176 176 ip.complete("x.")
177 177
178 def test_custom_completion_ordering(self):
179 """Test that errors from custom attribute completers are silenced."""
180 ip = get_ipython()
181
182 _, matches = ip.complete('in')
183 assert matches.index('input') < matches.index('int')
184
185 def complete_example(a):
186 return ['example2', 'example1']
187
188 ip.Completer.custom_completers.add_re('ex*', complete_example)
189 _, matches = ip.complete('ex')
190 assert matches.index('example2') < matches.index('example1')
191
178 192 def test_unicode_completions(self):
179 193 ip = get_ipython()
180 194 # Some strings that trigger different types of completion. Check them both
181 195 # in str and unicode forms
182 196 s = ["ru", "%ru", "cd /", "floa", "float(x)/"]
183 197 for t in s + list(map(str, s)):
184 198 # We don't need to check exact completion values (they may change
185 199 # depending on the state of the namespace, but at least no exceptions
186 200 # should be thrown and the return value should be a pair of text, list
187 201 # values.
188 202 text, matches = ip.complete(t)
189 203 nt.assert_true(isinstance(text, str))
190 204 nt.assert_true(isinstance(matches, list))
191 205
192 206 def test_latex_completions(self):
193 207 from IPython.core.latex_symbols import latex_symbols
194 208 import random
195 209
196 210 ip = get_ipython()
197 211 # Test some random unicode symbols
198 212 keys = random.sample(latex_symbols.keys(), 10)
199 213 for k in keys:
200 214 text, matches = ip.complete(k)
201 215 nt.assert_equal(len(matches), 1)
202 216 nt.assert_equal(text, k)
203 217 nt.assert_equal(matches[0], latex_symbols[k])
204 218 # Test a more complex line
205 219 text, matches = ip.complete("print(\\alpha")
206 220 nt.assert_equal(text, "\\alpha")
207 221 nt.assert_equal(matches[0], latex_symbols["\\alpha"])
208 222 # Test multiple matching latex symbols
209 223 text, matches = ip.complete("\\al")
210 224 nt.assert_in("\\alpha", matches)
211 225 nt.assert_in("\\aleph", matches)
212 226
213 227 def test_back_latex_completion(self):
214 228 ip = get_ipython()
215 229
216 230 # do not return more than 1 matches fro \beta, only the latex one.
217 231 name, matches = ip.complete("\\Ξ²")
218 232 nt.assert_equal(len(matches), 1)
219 233 nt.assert_equal(matches[0], "\\beta")
220 234
221 235 def test_back_unicode_completion(self):
222 236 ip = get_ipython()
223 237
224 238 name, matches = ip.complete("\\β…€")
225 239 nt.assert_equal(len(matches), 1)
226 240 nt.assert_equal(matches[0], "\\ROMAN NUMERAL FIVE")
227 241
228 242 def test_forward_unicode_completion(self):
229 243 ip = get_ipython()
230 244
231 245 name, matches = ip.complete("\\ROMAN NUMERAL FIVE")
232 246 nt.assert_equal(len(matches), 1)
233 247 nt.assert_equal(matches[0], "β…€")
234 248
235 249 @nt.nottest # now we have a completion for \jmath
236 250 @decorators.knownfailureif(
237 251 sys.platform == "win32", "Fails if there is a C:\\j... path"
238 252 )
239 253 def test_no_ascii_back_completion(self):
240 254 ip = get_ipython()
241 255 with TemporaryWorkingDirectory(): # Avoid any filename completions
242 256 # single ascii letter that don't have yet completions
243 257 for letter in "jJ":
244 258 name, matches = ip.complete("\\" + letter)
245 259 nt.assert_equal(matches, [])
246 260
247 261 class CompletionSplitterTestCase(unittest.TestCase):
248 262 def setUp(self):
249 263 self.sp = completer.CompletionSplitter()
250 264
251 265 def test_delim_setting(self):
252 266 self.sp.delims = " "
253 267 nt.assert_equal(self.sp.delims, " ")
254 268 nt.assert_equal(self.sp._delim_expr, r"[\ ]")
255 269
256 270 def test_spaces(self):
257 271 """Test with only spaces as split chars."""
258 272 self.sp.delims = " "
259 273 t = [("foo", "", "foo"), ("run foo", "", "foo"), ("run foo", "bar", "foo")]
260 274 check_line_split(self.sp, t)
261 275
262 276 def test_has_open_quotes1(self):
263 277 for s in ["'", "'''", "'hi' '"]:
264 278 nt.assert_equal(completer.has_open_quotes(s), "'")
265 279
266 280 def test_has_open_quotes2(self):
267 281 for s in ['"', '"""', '"hi" "']:
268 282 nt.assert_equal(completer.has_open_quotes(s), '"')
269 283
270 284 def test_has_open_quotes3(self):
271 285 for s in ["''", "''' '''", "'hi' 'ipython'"]:
272 286 nt.assert_false(completer.has_open_quotes(s))
273 287
274 288 def test_has_open_quotes4(self):
275 289 for s in ['""', '""" """', '"hi" "ipython"']:
276 290 nt.assert_false(completer.has_open_quotes(s))
277 291
278 292 @decorators.knownfailureif(
279 293 sys.platform == "win32", "abspath completions fail on Windows"
280 294 )
281 295 def test_abspath_file_completions(self):
282 296 ip = get_ipython()
283 297 with TemporaryDirectory() as tmpdir:
284 298 prefix = os.path.join(tmpdir, "foo")
285 299 suffixes = ["1", "2"]
286 300 names = [prefix + s for s in suffixes]
287 301 for n in names:
288 302 open(n, "w").close()
289 303
290 304 # Check simple completion
291 305 c = ip.complete(prefix)[1]
292 306 nt.assert_equal(c, names)
293 307
294 308 # Now check with a function call
295 309 cmd = 'a = f("%s' % prefix
296 310 c = ip.complete(prefix, cmd)[1]
297 311 comp = [prefix + s for s in suffixes]
298 312 nt.assert_equal(c, comp)
299 313
300 314 def test_local_file_completions(self):
301 315 ip = get_ipython()
302 316 with TemporaryWorkingDirectory():
303 317 prefix = "./foo"
304 318 suffixes = ["1", "2"]
305 319 names = [prefix + s for s in suffixes]
306 320 for n in names:
307 321 open(n, "w").close()
308 322
309 323 # Check simple completion
310 324 c = ip.complete(prefix)[1]
311 325 nt.assert_equal(c, names)
312 326
313 327 # Now check with a function call
314 328 cmd = 'a = f("%s' % prefix
315 329 c = ip.complete(prefix, cmd)[1]
316 330 comp = {prefix + s for s in suffixes}
317 331 nt.assert_true(comp.issubset(set(c)))
318 332
319 333 def test_quoted_file_completions(self):
320 334 ip = get_ipython()
321 335 with TemporaryWorkingDirectory():
322 336 name = "foo'bar"
323 337 open(name, "w").close()
324 338
325 339 # Don't escape Windows
326 340 escaped = name if sys.platform == "win32" else "foo\\'bar"
327 341
328 342 # Single quote matches embedded single quote
329 343 text = "open('foo"
330 344 c = ip.Completer._complete(
331 345 cursor_line=0, cursor_pos=len(text), full_text=text
332 346 )[1]
333 347 nt.assert_equal(c, [escaped])
334 348
335 349 # Double quote requires no escape
336 350 text = 'open("foo'
337 351 c = ip.Completer._complete(
338 352 cursor_line=0, cursor_pos=len(text), full_text=text
339 353 )[1]
340 354 nt.assert_equal(c, [name])
341 355
342 356 # No quote requires an escape
343 357 text = "%ls foo"
344 358 c = ip.Completer._complete(
345 359 cursor_line=0, cursor_pos=len(text), full_text=text
346 360 )[1]
347 361 nt.assert_equal(c, [escaped])
348 362
349 363 def test_all_completions_dups(self):
350 364 """
351 365 Make sure the output of `IPCompleter.all_completions` does not have
352 366 duplicated prefixes.
353 367 """
354 368 ip = get_ipython()
355 369 c = ip.Completer
356 370 ip.ex("class TestClass():\n\ta=1\n\ta1=2")
357 371 for jedi_status in [True, False]:
358 372 with provisionalcompleter():
359 373 ip.Completer.use_jedi = jedi_status
360 374 matches = c.all_completions("TestCl")
361 375 assert matches == ['TestClass'], jedi_status
362 376 matches = c.all_completions("TestClass.")
363 377 assert len(matches) > 2, jedi_status
364 378 matches = c.all_completions("TestClass.a")
365 379 assert matches == ['TestClass.a', 'TestClass.a1'], jedi_status
366 380
367 381 def test_jedi(self):
368 382 """
369 383 A couple of issue we had with Jedi
370 384 """
371 385 ip = get_ipython()
372 386
373 387 def _test_complete(reason, s, comp, start=None, end=None):
374 388 l = len(s)
375 389 start = start if start is not None else l
376 390 end = end if end is not None else l
377 391 with provisionalcompleter():
378 392 ip.Completer.use_jedi = True
379 393 completions = set(ip.Completer.completions(s, l))
380 394 ip.Completer.use_jedi = False
381 395 assert_in(Completion(start, end, comp), completions, reason)
382 396
383 397 def _test_not_complete(reason, s, comp):
384 398 l = len(s)
385 399 with provisionalcompleter():
386 400 ip.Completer.use_jedi = True
387 401 completions = set(ip.Completer.completions(s, l))
388 402 ip.Completer.use_jedi = False
389 403 assert_not_in(Completion(l, l, comp), completions, reason)
390 404
391 405 import jedi
392 406
393 407 jedi_version = tuple(int(i) for i in jedi.__version__.split(".")[:3])
394 408 if jedi_version > (0, 10):
395 409 yield _test_complete, "jedi >0.9 should complete and not crash", "a=1;a.", "real"
396 410 yield _test_complete, "can infer first argument", 'a=(1,"foo");a[0].', "real"
397 411 yield _test_complete, "can infer second argument", 'a=(1,"foo");a[1].', "capitalize"
398 412 yield _test_complete, "cover duplicate completions", "im", "import", 0, 2
399 413
400 414 yield _test_not_complete, "does not mix types", 'a=(1,"foo");a[0].', "capitalize"
401 415
402 416 def test_completion_have_signature(self):
403 417 """
404 418 Lets make sure jedi is capable of pulling out the signature of the function we are completing.
405 419 """
406 420 ip = get_ipython()
407 421 with provisionalcompleter():
408 422 ip.Completer.use_jedi = True
409 423 completions = ip.Completer.completions("ope", 3)
410 424 c = next(completions) # should be `open`
411 425 ip.Completer.use_jedi = False
412 426 assert "file" in c.signature, "Signature of function was not found by completer"
413 427 assert (
414 428 "encoding" in c.signature
415 429 ), "Signature of function was not found by completer"
416 430
417 431 def test_deduplicate_completions(self):
418 432 """
419 433 Test that completions are correctly deduplicated (even if ranges are not the same)
420 434 """
421 435 ip = get_ipython()
422 436 ip.ex(
423 437 textwrap.dedent(
424 438 """
425 439 class Z:
426 440 zoo = 1
427 441 """
428 442 )
429 443 )
430 444 with provisionalcompleter():
431 445 ip.Completer.use_jedi = True
432 446 l = list(
433 447 _deduplicate_completions("Z.z", ip.Completer.completions("Z.z", 3))
434 448 )
435 449 ip.Completer.use_jedi = False
436 450
437 451 assert len(l) == 1, "Completions (Z.z<tab>) correctly deduplicate: %s " % l
438 452 assert l[0].text == "zoo" # and not `it.accumulate`
439 453
440 454 def test_greedy_completions(self):
441 455 """
442 456 Test the capability of the Greedy completer.
443 457
444 458 Most of the test here does not really show off the greedy completer, for proof
445 459 each of the text below now pass with Jedi. The greedy completer is capable of more.
446 460
447 461 See the :any:`test_dict_key_completion_contexts`
448 462
449 463 """
450 464 ip = get_ipython()
451 465 ip.ex("a=list(range(5))")
452 466 _, c = ip.complete(".", line="a[0].")
453 467 nt.assert_false(".real" in c, "Shouldn't have completed on a[0]: %s" % c)
454 468
455 469 def _(line, cursor_pos, expect, message, completion):
456 470 with greedy_completion(), provisionalcompleter():
457 471 ip.Completer.use_jedi = False
458 472 _, c = ip.complete(".", line=line, cursor_pos=cursor_pos)
459 473 nt.assert_in(expect, c, message % c)
460 474
461 475 ip.Completer.use_jedi = True
462 476 with provisionalcompleter():
463 477 completions = ip.Completer.completions(line, cursor_pos)
464 478 nt.assert_in(completion, completions)
465 479
466 480 with provisionalcompleter():
467 481 yield _, "a[0].", 5, "a[0].real", "Should have completed on a[0].: %s", Completion(
468 482 5, 5, "real"
469 483 )
470 484 yield _, "a[0].r", 6, "a[0].real", "Should have completed on a[0].r: %s", Completion(
471 485 5, 6, "real"
472 486 )
473 487
474 488 if sys.version_info > (3, 4):
475 489 yield _, "a[0].from_", 10, "a[0].from_bytes", "Should have completed on a[0].from_: %s", Completion(
476 490 5, 10, "from_bytes"
477 491 )
478 492
479 493 def test_omit__names(self):
480 494 # also happens to test IPCompleter as a configurable
481 495 ip = get_ipython()
482 496 ip._hidden_attr = 1
483 497 ip._x = {}
484 498 c = ip.Completer
485 499 ip.ex("ip=get_ipython()")
486 500 cfg = Config()
487 501 cfg.IPCompleter.omit__names = 0
488 502 c.update_config(cfg)
489 503 with provisionalcompleter():
490 504 c.use_jedi = False
491 505 s, matches = c.complete("ip.")
492 506 nt.assert_in("ip.__str__", matches)
493 507 nt.assert_in("ip._hidden_attr", matches)
494 508
495 509 # c.use_jedi = True
496 510 # completions = set(c.completions('ip.', 3))
497 511 # nt.assert_in(Completion(3, 3, '__str__'), completions)
498 512 # nt.assert_in(Completion(3,3, "_hidden_attr"), completions)
499 513
500 514 cfg = Config()
501 515 cfg.IPCompleter.omit__names = 1
502 516 c.update_config(cfg)
503 517 with provisionalcompleter():
504 518 c.use_jedi = False
505 519 s, matches = c.complete("ip.")
506 520 nt.assert_not_in("ip.__str__", matches)
507 521 # nt.assert_in('ip._hidden_attr', matches)
508 522
509 523 # c.use_jedi = True
510 524 # completions = set(c.completions('ip.', 3))
511 525 # nt.assert_not_in(Completion(3,3,'__str__'), completions)
512 526 # nt.assert_in(Completion(3,3, "_hidden_attr"), completions)
513 527
514 528 cfg = Config()
515 529 cfg.IPCompleter.omit__names = 2
516 530 c.update_config(cfg)
517 531 with provisionalcompleter():
518 532 c.use_jedi = False
519 533 s, matches = c.complete("ip.")
520 534 nt.assert_not_in("ip.__str__", matches)
521 535 nt.assert_not_in("ip._hidden_attr", matches)
522 536
523 537 # c.use_jedi = True
524 538 # completions = set(c.completions('ip.', 3))
525 539 # nt.assert_not_in(Completion(3,3,'__str__'), completions)
526 540 # nt.assert_not_in(Completion(3,3, "_hidden_attr"), completions)
527 541
528 542 with provisionalcompleter():
529 543 c.use_jedi = False
530 544 s, matches = c.complete("ip._x.")
531 545 nt.assert_in("ip._x.keys", matches)
532 546
533 547 # c.use_jedi = True
534 548 # completions = set(c.completions('ip._x.', 6))
535 549 # nt.assert_in(Completion(6,6, "keys"), completions)
536 550
537 551 del ip._hidden_attr
538 552 del ip._x
539 553
540 554 def test_limit_to__all__False_ok(self):
541 555 """
542 556 Limit to all is deprecated, once we remove it this test can go away.
543 557 """
544 558 ip = get_ipython()
545 559 c = ip.Completer
546 560 c.use_jedi = False
547 561 ip.ex("class D: x=24")
548 562 ip.ex("d=D()")
549 563 cfg = Config()
550 564 cfg.IPCompleter.limit_to__all__ = False
551 565 c.update_config(cfg)
552 566 s, matches = c.complete("d.")
553 567 nt.assert_in("d.x", matches)
554 568
555 569 def test_get__all__entries_ok(self):
556 570 class A:
557 571 __all__ = ["x", 1]
558 572
559 573 words = completer.get__all__entries(A())
560 574 nt.assert_equal(words, ["x"])
561 575
562 576 def test_get__all__entries_no__all__ok(self):
563 577 class A:
564 578 pass
565 579
566 580 words = completer.get__all__entries(A())
567 581 nt.assert_equal(words, [])
568 582
569 583 def test_func_kw_completions(self):
570 584 ip = get_ipython()
571 585 c = ip.Completer
572 586 c.use_jedi = False
573 587 ip.ex("def myfunc(a=1,b=2): return a+b")
574 588 s, matches = c.complete(None, "myfunc(1,b")
575 589 nt.assert_in("b=", matches)
576 590 # Simulate completing with cursor right after b (pos==10):
577 591 s, matches = c.complete(None, "myfunc(1,b)", 10)
578 592 nt.assert_in("b=", matches)
579 593 s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b')
580 594 nt.assert_in("b=", matches)
581 595 # builtin function
582 596 s, matches = c.complete(None, "min(k, k")
583 597 nt.assert_in("key=", matches)
584 598
585 599 def test_default_arguments_from_docstring(self):
586 600 ip = get_ipython()
587 601 c = ip.Completer
588 602 kwd = c._default_arguments_from_docstring("min(iterable[, key=func]) -> value")
589 603 nt.assert_equal(kwd, ["key"])
590 604 # with cython type etc
591 605 kwd = c._default_arguments_from_docstring(
592 606 "Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n"
593 607 )
594 608 nt.assert_equal(kwd, ["ncall", "resume", "nsplit"])
595 609 # white spaces
596 610 kwd = c._default_arguments_from_docstring(
597 611 "\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n"
598 612 )
599 613 nt.assert_equal(kwd, ["ncall", "resume", "nsplit"])
600 614
601 615 def test_line_magics(self):
602 616 ip = get_ipython()
603 617 c = ip.Completer
604 618 s, matches = c.complete(None, "lsmag")
605 619 nt.assert_in("%lsmagic", matches)
606 620 s, matches = c.complete(None, "%lsmag")
607 621 nt.assert_in("%lsmagic", matches)
608 622
609 623 def test_cell_magics(self):
610 624 from IPython.core.magic import register_cell_magic
611 625
612 626 @register_cell_magic
613 627 def _foo_cellm(line, cell):
614 628 pass
615 629
616 630 ip = get_ipython()
617 631 c = ip.Completer
618 632
619 633 s, matches = c.complete(None, "_foo_ce")
620 634 nt.assert_in("%%_foo_cellm", matches)
621 635 s, matches = c.complete(None, "%%_foo_ce")
622 636 nt.assert_in("%%_foo_cellm", matches)
623 637
624 638 def test_line_cell_magics(self):
625 639 from IPython.core.magic import register_line_cell_magic
626 640
627 641 @register_line_cell_magic
628 642 def _bar_cellm(line, cell):
629 643 pass
630 644
631 645 ip = get_ipython()
632 646 c = ip.Completer
633 647
634 648 # The policy here is trickier, see comments in completion code. The
635 649 # returned values depend on whether the user passes %% or not explicitly,
636 650 # and this will show a difference if the same name is both a line and cell
637 651 # magic.
638 652 s, matches = c.complete(None, "_bar_ce")
639 653 nt.assert_in("%_bar_cellm", matches)
640 654 nt.assert_in("%%_bar_cellm", matches)
641 655 s, matches = c.complete(None, "%_bar_ce")
642 656 nt.assert_in("%_bar_cellm", matches)
643 657 nt.assert_in("%%_bar_cellm", matches)
644 658 s, matches = c.complete(None, "%%_bar_ce")
645 659 nt.assert_not_in("%_bar_cellm", matches)
646 660 nt.assert_in("%%_bar_cellm", matches)
647 661
648 662 def test_magic_completion_order(self):
649 663 ip = get_ipython()
650 664 c = ip.Completer
651 665
652 666 # Test ordering of line and cell magics.
653 667 text, matches = c.complete("timeit")
654 668 nt.assert_equal(matches, ["%timeit", "%%timeit"])
655 669
656 670 def test_magic_completion_shadowing(self):
657 671 ip = get_ipython()
658 672 c = ip.Completer
659 673 c.use_jedi = False
660 674
661 675 # Before importing matplotlib, %matplotlib magic should be the only option.
662 676 text, matches = c.complete("mat")
663 677 nt.assert_equal(matches, ["%matplotlib"])
664 678
665 679 # The newly introduced name should shadow the magic.
666 680 ip.run_cell("matplotlib = 1")
667 681 text, matches = c.complete("mat")
668 682 nt.assert_equal(matches, ["matplotlib"])
669 683
670 684 # After removing matplotlib from namespace, the magic should again be
671 685 # the only option.
672 686 del ip.user_ns["matplotlib"]
673 687 text, matches = c.complete("mat")
674 688 nt.assert_equal(matches, ["%matplotlib"])
675 689
676 690 def test_magic_completion_shadowing_explicit(self):
677 691 """
678 692 If the user try to complete a shadowed magic, and explicit % start should
679 693 still return the completions.
680 694 """
681 695 ip = get_ipython()
682 696 c = ip.Completer
683 697
684 698 # Before importing matplotlib, %matplotlib magic should be the only option.
685 699 text, matches = c.complete("%mat")
686 700 nt.assert_equal(matches, ["%matplotlib"])
687 701
688 702 ip.run_cell("matplotlib = 1")
689 703
690 704 # After removing matplotlib from namespace, the magic should still be
691 705 # the only option.
692 706 text, matches = c.complete("%mat")
693 707 nt.assert_equal(matches, ["%matplotlib"])
694 708
695 709 def test_magic_config(self):
696 710 ip = get_ipython()
697 711 c = ip.Completer
698 712
699 713 s, matches = c.complete(None, "conf")
700 714 nt.assert_in("%config", matches)
701 715 s, matches = c.complete(None, "conf")
702 716 nt.assert_not_in("AliasManager", matches)
703 717 s, matches = c.complete(None, "config ")
704 718 nt.assert_in("AliasManager", matches)
705 719 s, matches = c.complete(None, "%config ")
706 720 nt.assert_in("AliasManager", matches)
707 721 s, matches = c.complete(None, "config Ali")
708 722 nt.assert_list_equal(["AliasManager"], matches)
709 723 s, matches = c.complete(None, "%config Ali")
710 724 nt.assert_list_equal(["AliasManager"], matches)
711 725 s, matches = c.complete(None, "config AliasManager")
712 726 nt.assert_list_equal(["AliasManager"], matches)
713 727 s, matches = c.complete(None, "%config AliasManager")
714 728 nt.assert_list_equal(["AliasManager"], matches)
715 729 s, matches = c.complete(None, "config AliasManager.")
716 730 nt.assert_in("AliasManager.default_aliases", matches)
717 731 s, matches = c.complete(None, "%config AliasManager.")
718 732 nt.assert_in("AliasManager.default_aliases", matches)
719 733 s, matches = c.complete(None, "config AliasManager.de")
720 734 nt.assert_list_equal(["AliasManager.default_aliases"], matches)
721 735 s, matches = c.complete(None, "config AliasManager.de")
722 736 nt.assert_list_equal(["AliasManager.default_aliases"], matches)
723 737
724 738 def test_magic_color(self):
725 739 ip = get_ipython()
726 740 c = ip.Completer
727 741
728 742 s, matches = c.complete(None, "colo")
729 743 nt.assert_in("%colors", matches)
730 744 s, matches = c.complete(None, "colo")
731 745 nt.assert_not_in("NoColor", matches)
732 746 s, matches = c.complete(None, "%colors") # No trailing space
733 747 nt.assert_not_in("NoColor", matches)
734 748 s, matches = c.complete(None, "colors ")
735 749 nt.assert_in("NoColor", matches)
736 750 s, matches = c.complete(None, "%colors ")
737 751 nt.assert_in("NoColor", matches)
738 752 s, matches = c.complete(None, "colors NoCo")
739 753 nt.assert_list_equal(["NoColor"], matches)
740 754 s, matches = c.complete(None, "%colors NoCo")
741 755 nt.assert_list_equal(["NoColor"], matches)
742 756
743 757 def test_match_dict_keys(self):
744 758 """
745 759 Test that match_dict_keys works on a couple of use case does return what
746 760 expected, and does not crash
747 761 """
748 762 delims = " \t\n`!@#$^&*()=+[{]}\\|;:'\",<>?"
749 763
750 764 keys = ["foo", b"far"]
751 765 assert match_dict_keys(keys, "b'", delims=delims) == ("'", 2, ["far"])
752 766 assert match_dict_keys(keys, "b'f", delims=delims) == ("'", 2, ["far"])
753 767 assert match_dict_keys(keys, 'b"', delims=delims) == ('"', 2, ["far"])
754 768 assert match_dict_keys(keys, 'b"f', delims=delims) == ('"', 2, ["far"])
755 769
756 770 assert match_dict_keys(keys, "'", delims=delims) == ("'", 1, ["foo"])
757 771 assert match_dict_keys(keys, "'f", delims=delims) == ("'", 1, ["foo"])
758 772 assert match_dict_keys(keys, '"', delims=delims) == ('"', 1, ["foo"])
759 773 assert match_dict_keys(keys, '"f', delims=delims) == ('"', 1, ["foo"])
760 774
761 775 match_dict_keys
762 776
763 777 def test_dict_key_completion_string(self):
764 778 """Test dictionary key completion for string keys"""
765 779 ip = get_ipython()
766 780 complete = ip.Completer.complete
767 781
768 782 ip.user_ns["d"] = {"abc": None}
769 783
770 784 # check completion at different stages
771 785 _, matches = complete(line_buffer="d[")
772 786 nt.assert_in("'abc'", matches)
773 787 nt.assert_not_in("'abc']", matches)
774 788
775 789 _, matches = complete(line_buffer="d['")
776 790 nt.assert_in("abc", matches)
777 791 nt.assert_not_in("abc']", matches)
778 792
779 793 _, matches = complete(line_buffer="d['a")
780 794 nt.assert_in("abc", matches)
781 795 nt.assert_not_in("abc']", matches)
782 796
783 797 # check use of different quoting
784 798 _, matches = complete(line_buffer='d["')
785 799 nt.assert_in("abc", matches)
786 800 nt.assert_not_in('abc"]', matches)
787 801
788 802 _, matches = complete(line_buffer='d["a')
789 803 nt.assert_in("abc", matches)
790 804 nt.assert_not_in('abc"]', matches)
791 805
792 806 # check sensitivity to following context
793 807 _, matches = complete(line_buffer="d[]", cursor_pos=2)
794 808 nt.assert_in("'abc'", matches)
795 809
796 810 _, matches = complete(line_buffer="d['']", cursor_pos=3)
797 811 nt.assert_in("abc", matches)
798 812 nt.assert_not_in("abc'", matches)
799 813 nt.assert_not_in("abc']", matches)
800 814
801 815 # check multiple solutions are correctly returned and that noise is not
802 816 ip.user_ns["d"] = {
803 817 "abc": None,
804 818 "abd": None,
805 819 "bad": None,
806 820 object(): None,
807 821 5: None,
808 822 }
809 823
810 824 _, matches = complete(line_buffer="d['a")
811 825 nt.assert_in("abc", matches)
812 826 nt.assert_in("abd", matches)
813 827 nt.assert_not_in("bad", matches)
814 828 assert not any(m.endswith(("]", '"', "'")) for m in matches), matches
815 829
816 830 # check escaping and whitespace
817 831 ip.user_ns["d"] = {"a\nb": None, "a'b": None, 'a"b': None, "a word": None}
818 832 _, matches = complete(line_buffer="d['a")
819 833 nt.assert_in("a\\nb", matches)
820 834 nt.assert_in("a\\'b", matches)
821 835 nt.assert_in('a"b', matches)
822 836 nt.assert_in("a word", matches)
823 837 assert not any(m.endswith(("]", '"', "'")) for m in matches), matches
824 838
825 839 # - can complete on non-initial word of the string
826 840 _, matches = complete(line_buffer="d['a w")
827 841 nt.assert_in("word", matches)
828 842
829 843 # - understands quote escaping
830 844 _, matches = complete(line_buffer="d['a\\'")
831 845 nt.assert_in("b", matches)
832 846
833 847 # - default quoting should work like repr
834 848 _, matches = complete(line_buffer="d[")
835 849 nt.assert_in('"a\'b"', matches)
836 850
837 851 # - when opening quote with ", possible to match with unescaped apostrophe
838 852 _, matches = complete(line_buffer="d[\"a'")
839 853 nt.assert_in("b", matches)
840 854
841 855 # need to not split at delims that readline won't split at
842 856 if "-" not in ip.Completer.splitter.delims:
843 857 ip.user_ns["d"] = {"before-after": None}
844 858 _, matches = complete(line_buffer="d['before-af")
845 859 nt.assert_in("before-after", matches)
846 860
847 861 def test_dict_key_completion_contexts(self):
848 862 """Test expression contexts in which dict key completion occurs"""
849 863 ip = get_ipython()
850 864 complete = ip.Completer.complete
851 865 d = {"abc": None}
852 866 ip.user_ns["d"] = d
853 867
854 868 class C:
855 869 data = d
856 870
857 871 ip.user_ns["C"] = C
858 872 ip.user_ns["get"] = lambda: d
859 873
860 874 def assert_no_completion(**kwargs):
861 875 _, matches = complete(**kwargs)
862 876 nt.assert_not_in("abc", matches)
863 877 nt.assert_not_in("abc'", matches)
864 878 nt.assert_not_in("abc']", matches)
865 879 nt.assert_not_in("'abc'", matches)
866 880 nt.assert_not_in("'abc']", matches)
867 881
868 882 def assert_completion(**kwargs):
869 883 _, matches = complete(**kwargs)
870 884 nt.assert_in("'abc'", matches)
871 885 nt.assert_not_in("'abc']", matches)
872 886
873 887 # no completion after string closed, even if reopened
874 888 assert_no_completion(line_buffer="d['a'")
875 889 assert_no_completion(line_buffer='d["a"')
876 890 assert_no_completion(line_buffer="d['a' + ")
877 891 assert_no_completion(line_buffer="d['a' + '")
878 892
879 893 # completion in non-trivial expressions
880 894 assert_completion(line_buffer="+ d[")
881 895 assert_completion(line_buffer="(d[")
882 896 assert_completion(line_buffer="C.data[")
883 897
884 898 # greedy flag
885 899 def assert_completion(**kwargs):
886 900 _, matches = complete(**kwargs)
887 901 nt.assert_in("get()['abc']", matches)
888 902
889 903 assert_no_completion(line_buffer="get()[")
890 904 with greedy_completion():
891 905 assert_completion(line_buffer="get()[")
892 906 assert_completion(line_buffer="get()['")
893 907 assert_completion(line_buffer="get()['a")
894 908 assert_completion(line_buffer="get()['ab")
895 909 assert_completion(line_buffer="get()['abc")
896 910
897 911 def test_dict_key_completion_bytes(self):
898 912 """Test handling of bytes in dict key completion"""
899 913 ip = get_ipython()
900 914 complete = ip.Completer.complete
901 915
902 916 ip.user_ns["d"] = {"abc": None, b"abd": None}
903 917
904 918 _, matches = complete(line_buffer="d[")
905 919 nt.assert_in("'abc'", matches)
906 920 nt.assert_in("b'abd'", matches)
907 921
908 922 if False: # not currently implemented
909 923 _, matches = complete(line_buffer="d[b")
910 924 nt.assert_in("b'abd'", matches)
911 925 nt.assert_not_in("b'abc'", matches)
912 926
913 927 _, matches = complete(line_buffer="d[b'")
914 928 nt.assert_in("abd", matches)
915 929 nt.assert_not_in("abc", matches)
916 930
917 931 _, matches = complete(line_buffer="d[B'")
918 932 nt.assert_in("abd", matches)
919 933 nt.assert_not_in("abc", matches)
920 934
921 935 _, matches = complete(line_buffer="d['")
922 936 nt.assert_in("abc", matches)
923 937 nt.assert_not_in("abd", matches)
924 938
925 939 def test_dict_key_completion_unicode_py3(self):
926 940 """Test handling of unicode in dict key completion"""
927 941 ip = get_ipython()
928 942 complete = ip.Completer.complete
929 943
930 944 ip.user_ns["d"] = {"a\u05d0": None}
931 945
932 946 # query using escape
933 947 if sys.platform != "win32":
934 948 # Known failure on Windows
935 949 _, matches = complete(line_buffer="d['a\\u05d0")
936 950 nt.assert_in("u05d0", matches) # tokenized after \\
937 951
938 952 # query using character
939 953 _, matches = complete(line_buffer="d['a\u05d0")
940 954 nt.assert_in("a\u05d0", matches)
941 955
942 956 with greedy_completion():
943 957 # query using escape
944 958 _, matches = complete(line_buffer="d['a\\u05d0")
945 959 nt.assert_in("d['a\\u05d0']", matches) # tokenized after \\
946 960
947 961 # query using character
948 962 _, matches = complete(line_buffer="d['a\u05d0")
949 963 nt.assert_in("d['a\u05d0']", matches)
950 964
951 965 @dec.skip_without("numpy")
952 966 def test_struct_array_key_completion(self):
953 967 """Test dict key completion applies to numpy struct arrays"""
954 968 import numpy
955 969
956 970 ip = get_ipython()
957 971 complete = ip.Completer.complete
958 972 ip.user_ns["d"] = numpy.array([], dtype=[("hello", "f"), ("world", "f")])
959 973 _, matches = complete(line_buffer="d['")
960 974 nt.assert_in("hello", matches)
961 975 nt.assert_in("world", matches)
962 976 # complete on the numpy struct itself
963 977 dt = numpy.dtype(
964 978 [("my_head", [("my_dt", ">u4"), ("my_df", ">u4")]), ("my_data", ">f4", 5)]
965 979 )
966 980 x = numpy.zeros(2, dtype=dt)
967 981 ip.user_ns["d"] = x[1]
968 982 _, matches = complete(line_buffer="d['")
969 983 nt.assert_in("my_head", matches)
970 984 nt.assert_in("my_data", matches)
971 985 # complete on a nested level
972 986 with greedy_completion():
973 987 ip.user_ns["d"] = numpy.zeros(2, dtype=dt)
974 988 _, matches = complete(line_buffer="d[1]['my_head']['")
975 989 nt.assert_true(any(["my_dt" in m for m in matches]))
976 990 nt.assert_true(any(["my_df" in m for m in matches]))
977 991
978 992 @dec.skip_without("pandas")
979 993 def test_dataframe_key_completion(self):
980 994 """Test dict key completion applies to pandas DataFrames"""
981 995 import pandas
982 996
983 997 ip = get_ipython()
984 998 complete = ip.Completer.complete
985 999 ip.user_ns["d"] = pandas.DataFrame({"hello": [1], "world": [2]})
986 1000 _, matches = complete(line_buffer="d['")
987 1001 nt.assert_in("hello", matches)
988 1002 nt.assert_in("world", matches)
989 1003
990 1004 def test_dict_key_completion_invalids(self):
991 1005 """Smoke test cases dict key completion can't handle"""
992 1006 ip = get_ipython()
993 1007 complete = ip.Completer.complete
994 1008
995 1009 ip.user_ns["no_getitem"] = None
996 1010 ip.user_ns["no_keys"] = []
997 1011 ip.user_ns["cant_call_keys"] = dict
998 1012 ip.user_ns["empty"] = {}
999 1013 ip.user_ns["d"] = {"abc": 5}
1000 1014
1001 1015 _, matches = complete(line_buffer="no_getitem['")
1002 1016 _, matches = complete(line_buffer="no_keys['")
1003 1017 _, matches = complete(line_buffer="cant_call_keys['")
1004 1018 _, matches = complete(line_buffer="empty['")
1005 1019 _, matches = complete(line_buffer="name_error['")
1006 1020 _, matches = complete(line_buffer="d['\\") # incomplete escape
1007 1021
1008 1022 def test_object_key_completion(self):
1009 1023 ip = get_ipython()
1010 1024 ip.user_ns["key_completable"] = KeyCompletable(["qwerty", "qwick"])
1011 1025
1012 1026 _, matches = ip.Completer.complete(line_buffer="key_completable['qw")
1013 1027 nt.assert_in("qwerty", matches)
1014 1028 nt.assert_in("qwick", matches)
1015 1029
1016 1030 def test_class_key_completion(self):
1017 1031 ip = get_ipython()
1018 1032 NamedInstanceClass("qwerty")
1019 1033 NamedInstanceClass("qwick")
1020 1034 ip.user_ns["named_instance_class"] = NamedInstanceClass
1021 1035
1022 1036 _, matches = ip.Completer.complete(line_buffer="named_instance_class['qw")
1023 1037 nt.assert_in("qwerty", matches)
1024 1038 nt.assert_in("qwick", matches)
1025 1039
1026 1040 def test_tryimport(self):
1027 1041 """
1028 1042 Test that try-import don't crash on trailing dot, and import modules before
1029 1043 """
1030 1044 from IPython.core.completerlib import try_import
1031 1045
1032 1046 assert try_import("IPython.")
1033 1047
1034 1048 def test_aimport_module_completer(self):
1035 1049 ip = get_ipython()
1036 1050 _, matches = ip.complete("i", "%aimport i")
1037 1051 nt.assert_in("io", matches)
1038 1052 nt.assert_not_in("int", matches)
1039 1053
1040 1054 def test_nested_import_module_completer(self):
1041 1055 ip = get_ipython()
1042 1056 _, matches = ip.complete(None, "import IPython.co", 17)
1043 1057 nt.assert_in("IPython.core", matches)
1044 1058 nt.assert_not_in("import IPython.core", matches)
1045 1059 nt.assert_not_in("IPython.display", matches)
1046 1060
1047 1061 def test_import_module_completer(self):
1048 1062 ip = get_ipython()
1049 1063 _, matches = ip.complete("i", "import i")
1050 1064 nt.assert_in("io", matches)
1051 1065 nt.assert_not_in("int", matches)
1052 1066
1053 1067 def test_from_module_completer(self):
1054 1068 ip = get_ipython()
1055 1069 _, matches = ip.complete("B", "from io import B", 16)
1056 1070 nt.assert_in("BytesIO", matches)
1057 1071 nt.assert_not_in("BaseException", matches)
1058 1072
1059 1073 def test_snake_case_completion(self):
1060 1074 ip = get_ipython()
1061 1075 ip.Completer.use_jedi = False
1062 1076 ip.user_ns["some_three"] = 3
1063 1077 ip.user_ns["some_four"] = 4
1064 1078 _, matches = ip.complete("s_", "print(s_f")
1065 1079 nt.assert_in("some_three", matches)
1066 1080 nt.assert_in("some_four", matches)
1067 1081
1068 1082 def test_mix_terms(self):
1069 1083 ip = get_ipython()
1070 1084 from textwrap import dedent
1071 1085
1072 1086 ip.Completer.use_jedi = False
1073 1087 ip.ex(
1074 1088 dedent(
1075 1089 """
1076 1090 class Test:
1077 1091 def meth(self, meth_arg1):
1078 1092 print("meth")
1079 1093
1080 1094 def meth_1(self, meth1_arg1, meth1_arg2):
1081 1095 print("meth1")
1082 1096
1083 1097 def meth_2(self, meth2_arg1, meth2_arg2):
1084 1098 print("meth2")
1085 1099 test = Test()
1086 1100 """
1087 1101 )
1088 1102 )
1089 1103 _, matches = ip.complete(None, "test.meth(")
1090 1104 nt.assert_in("meth_arg1=", matches)
1091 1105 nt.assert_not_in("meth2_arg1=", matches)
General Comments 0
You need to be logged in to leave comments. Login now