##// END OF EJS Templates
Ensure set_custom_completer is working. Fixes #11272
Nathan Goldbaum -
Show More

The requested changes are too big and content was truncated. Show full diff

@@ -1,2089 +1,2093 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
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 self.custom_matchers = []
630
629 631 super(Completer, self).__init__(**kwargs)
630 632
631 633 def complete(self, text, state):
632 634 """Return the next possible completion for 'text'.
633 635
634 636 This is called successively with state == 0, 1, 2, ... until it
635 637 returns None. The completion should begin with 'text'.
636 638
637 639 """
638 640 if self.use_main_ns:
639 641 self.namespace = __main__.__dict__
640 642
641 643 if state == 0:
642 644 if "." in text:
643 645 self.matches = self.attr_matches(text)
644 646 else:
645 647 self.matches = self.global_matches(text)
646 648 try:
647 649 return self.matches[state]
648 650 except IndexError:
649 651 return None
650 652
651 653 def global_matches(self, text):
652 654 """Compute matches when text is a simple name.
653 655
654 656 Return a list of all keywords, built-in functions and names currently
655 657 defined in self.namespace or self.global_namespace that match.
656 658
657 659 """
658 660 matches = []
659 661 match_append = matches.append
660 662 n = len(text)
661 663 for lst in [keyword.kwlist,
662 664 builtin_mod.__dict__.keys(),
663 665 self.namespace.keys(),
664 666 self.global_namespace.keys()]:
665 667 for word in lst:
666 668 if word[:n] == text and word != "__builtins__":
667 669 match_append(word)
668 670
669 671 snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z")
670 672 for lst in [self.namespace.keys(),
671 673 self.global_namespace.keys()]:
672 674 shortened = {"_".join([sub[0] for sub in word.split('_')]) : word
673 675 for word in lst if snake_case_re.match(word)}
674 676 for word in shortened.keys():
675 677 if word[:n] == text and word != "__builtins__":
676 678 match_append(shortened[word])
677 679 return matches
678 680
679 681 def attr_matches(self, text):
680 682 """Compute matches when text contains a dot.
681 683
682 684 Assuming the text is of the form NAME.NAME....[NAME], and is
683 685 evaluatable in self.namespace or self.global_namespace, it will be
684 686 evaluated and its attributes (as revealed by dir()) are used as
685 687 possible completions. (For class instances, class members are
686 688 also considered.)
687 689
688 690 WARNING: this can still invoke arbitrary C code, if an object
689 691 with a __getattr__ hook is evaluated.
690 692
691 693 """
692 694
693 695 # Another option, seems to work great. Catches things like ''.<tab>
694 696 m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text)
695 697
696 698 if m:
697 699 expr, attr = m.group(1, 3)
698 700 elif self.greedy:
699 701 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
700 702 if not m2:
701 703 return []
702 704 expr, attr = m2.group(1,2)
703 705 else:
704 706 return []
705 707
706 708 try:
707 709 obj = eval(expr, self.namespace)
708 710 except:
709 711 try:
710 712 obj = eval(expr, self.global_namespace)
711 713 except:
712 714 return []
713 715
714 716 if self.limit_to__all__ and hasattr(obj, '__all__'):
715 717 words = get__all__entries(obj)
716 718 else:
717 719 words = dir2(obj)
718 720
719 721 try:
720 722 words = generics.complete_object(obj, words)
721 723 except TryNext:
722 724 pass
723 725 except AssertionError:
724 726 raise
725 727 except Exception:
726 728 # Silence errors from completion function
727 729 #raise # dbg
728 730 pass
729 731 # Build match list to return
730 732 n = len(attr)
731 733 return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ]
732 734
733 735
734 736 def get__all__entries(obj):
735 737 """returns the strings in the __all__ attribute"""
736 738 try:
737 739 words = getattr(obj, '__all__')
738 740 except:
739 741 return []
740 742
741 743 return [w for w in words if isinstance(w, str)]
742 744
743 745
744 746 def match_dict_keys(keys: List[str], prefix: str, delims: str):
745 747 """Used by dict_key_matches, matching the prefix to a list of keys
746 748
747 749 Parameters
748 750 ==========
749 751 keys:
750 752 list of keys in dictionary currently being completed.
751 753 prefix:
752 754 Part of the text already typed by the user. e.g. `mydict[b'fo`
753 755 delims:
754 756 String of delimiters to consider when finding the current key.
755 757
756 758 Returns
757 759 =======
758 760
759 761 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
760 762 ``quote`` being the quote that need to be used to close current string.
761 763 ``token_start`` the position where the replacement should start occurring,
762 764 ``matches`` a list of replacement/completion
763 765
764 766 """
765 767 if not prefix:
766 768 return None, 0, [repr(k) for k in keys
767 769 if isinstance(k, (str, bytes))]
768 770 quote_match = re.search('["\']', prefix)
769 771 quote = quote_match.group()
770 772 try:
771 773 prefix_str = eval(prefix + quote, {})
772 774 except Exception:
773 775 return None, 0, []
774 776
775 777 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
776 778 token_match = re.search(pattern, prefix, re.UNICODE)
777 779 token_start = token_match.start()
778 780 token_prefix = token_match.group()
779 781
780 782 matched = []
781 783 for key in keys:
782 784 try:
783 785 if not key.startswith(prefix_str):
784 786 continue
785 787 except (AttributeError, TypeError, UnicodeError):
786 788 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
787 789 continue
788 790
789 791 # reformat remainder of key to begin with prefix
790 792 rem = key[len(prefix_str):]
791 793 # force repr wrapped in '
792 794 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
793 795 if rem_repr.startswith('u') and prefix[0] not in 'uU':
794 796 # Found key is unicode, but prefix is Py2 string.
795 797 # Therefore attempt to interpret key as string.
796 798 try:
797 799 rem_repr = repr(rem.encode('ascii') + '"')
798 800 except UnicodeEncodeError:
799 801 continue
800 802
801 803 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
802 804 if quote == '"':
803 805 # The entered prefix is quoted with ",
804 806 # but the match is quoted with '.
805 807 # A contained " hence needs escaping for comparison:
806 808 rem_repr = rem_repr.replace('"', '\\"')
807 809
808 810 # then reinsert prefix from start of token
809 811 matched.append('%s%s' % (token_prefix, rem_repr))
810 812 return quote, token_start, matched
811 813
812 814
813 815 def cursor_to_position(text:str, line:int, column:int)->int:
814 816 """
815 817
816 818 Convert the (line,column) position of the cursor in text to an offset in a
817 819 string.
818 820
819 821 Parameters
820 822 ----------
821 823
822 824 text : str
823 825 The text in which to calculate the cursor offset
824 826 line : int
825 827 Line of the cursor; 0-indexed
826 828 column : int
827 829 Column of the cursor 0-indexed
828 830
829 831 Return
830 832 ------
831 833 Position of the cursor in ``text``, 0-indexed.
832 834
833 835 See Also
834 836 --------
835 837 position_to_cursor: reciprocal of this function
836 838
837 839 """
838 840 lines = text.split('\n')
839 841 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
840 842
841 843 return sum(len(l) + 1 for l in lines[:line]) + column
842 844
843 845 def position_to_cursor(text:str, offset:int)->Tuple[int, int]:
844 846 """
845 847 Convert the position of the cursor in text (0 indexed) to a line
846 848 number(0-indexed) and a column number (0-indexed) pair
847 849
848 850 Position should be a valid position in ``text``.
849 851
850 852 Parameters
851 853 ----------
852 854
853 855 text : str
854 856 The text in which to calculate the cursor offset
855 857 offset : int
856 858 Position of the cursor in ``text``, 0-indexed.
857 859
858 860 Return
859 861 ------
860 862 (line, column) : (int, int)
861 863 Line of the cursor; 0-indexed, column of the cursor 0-indexed
862 864
863 865
864 866 See Also
865 867 --------
866 868 cursor_to_position : reciprocal of this function
867 869
868 870
869 871 """
870 872
871 873 assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text))
872 874
873 875 before = text[:offset]
874 876 blines = before.split('\n') # ! splitnes trim trailing \n
875 877 line = before.count('\n')
876 878 col = len(blines[-1])
877 879 return line, col
878 880
879 881
880 882 def _safe_isinstance(obj, module, class_name):
881 883 """Checks if obj is an instance of module.class_name if loaded
882 884 """
883 885 return (module in sys.modules and
884 886 isinstance(obj, getattr(import_module(module), class_name)))
885 887
886 888
887 889 def back_unicode_name_matches(text):
888 890 u"""Match unicode characters back to unicode name
889 891
890 892 This does ``β˜ƒ`` -> ``\\snowman``
891 893
892 894 Note that snowman is not a valid python3 combining character but will be expanded.
893 895 Though it will not recombine back to the snowman character by the completion machinery.
894 896
895 897 This will not either back-complete standard sequences like \\n, \\b ...
896 898
897 899 Used on Python 3 only.
898 900 """
899 901 if len(text)<2:
900 902 return u'', ()
901 903 maybe_slash = text[-2]
902 904 if maybe_slash != '\\':
903 905 return u'', ()
904 906
905 907 char = text[-1]
906 908 # no expand on quote for completion in strings.
907 909 # nor backcomplete standard ascii keys
908 910 if char in string.ascii_letters or char in ['"',"'"]:
909 911 return u'', ()
910 912 try :
911 913 unic = unicodedata.name(char)
912 914 return '\\'+char,['\\'+unic]
913 915 except KeyError:
914 916 pass
915 917 return u'', ()
916 918
917 919 def back_latex_name_matches(text:str):
918 920 """Match latex characters back to unicode name
919 921
920 922 This does ``\\β„΅`` -> ``\\aleph``
921 923
922 924 Used on Python 3 only.
923 925 """
924 926 if len(text)<2:
925 927 return u'', ()
926 928 maybe_slash = text[-2]
927 929 if maybe_slash != '\\':
928 930 return u'', ()
929 931
930 932
931 933 char = text[-1]
932 934 # no expand on quote for completion in strings.
933 935 # nor backcomplete standard ascii keys
934 936 if char in string.ascii_letters or char in ['"',"'"]:
935 937 return u'', ()
936 938 try :
937 939 latex = reverse_latex_symbol[char]
938 940 # '\\' replace the \ as well
939 941 return '\\'+char,[latex]
940 942 except KeyError:
941 943 pass
942 944 return u'', ()
943 945
944 946
945 947 def _formatparamchildren(parameter) -> str:
946 948 """
947 949 Get parameter name and value from Jedi Private API
948 950
949 951 Jedi does not expose a simple way to get `param=value` from its API.
950 952
951 953 Parameter
952 954 =========
953 955
954 956 parameter:
955 957 Jedi's function `Param`
956 958
957 959 Returns
958 960 =======
959 961
960 962 A string like 'a', 'b=1', '*args', '**kwargs'
961 963
962 964
963 965 """
964 966 description = parameter.description
965 967 if not description.startswith('param '):
966 968 raise ValueError('Jedi function parameter description have change format.'
967 969 'Expected "param ...", found %r".' % description)
968 970 return description[6:]
969 971
970 972 def _make_signature(completion)-> str:
971 973 """
972 974 Make the signature from a jedi completion
973 975
974 976 Parameter
975 977 =========
976 978
977 979 completion: jedi.Completion
978 980 object does not complete a function type
979 981
980 982 Returns
981 983 =======
982 984
983 985 a string consisting of the function signature, with the parenthesis but
984 986 without the function name. example:
985 987 `(a, *args, b=1, **kwargs)`
986 988
987 989 """
988 990
989 991 return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f])
990 992
991 993 class IPCompleter(Completer):
992 994 """Extension of the completer class with IPython-specific features"""
993 995
994 996 _names = None
995 997
996 998 @observe('greedy')
997 999 def _greedy_changed(self, change):
998 1000 """update the splitter and readline delims when greedy is changed"""
999 1001 if change['new']:
1000 1002 self.splitter.delims = GREEDY_DELIMS
1001 1003 else:
1002 1004 self.splitter.delims = DELIMS
1003 1005
1004 1006 dict_keys_only = Bool(False,
1005 1007 help="""Whether to show dict key matches only""")
1006 1008
1007 1009 merge_completions = Bool(True,
1008 1010 help="""Whether to merge completion results into a single list
1009 1011
1010 1012 If False, only the completion results from the first non-empty
1011 1013 completer will be returned.
1012 1014 """
1013 1015 ).tag(config=True)
1014 1016 omit__names = Enum((0,1,2), default_value=2,
1015 1017 help="""Instruct the completer to omit private method names
1016 1018
1017 1019 Specifically, when completing on ``object.<tab>``.
1018 1020
1019 1021 When 2 [default]: all names that start with '_' will be excluded.
1020 1022
1021 1023 When 1: all 'magic' names (``__foo__``) will be excluded.
1022 1024
1023 1025 When 0: nothing will be excluded.
1024 1026 """
1025 1027 ).tag(config=True)
1026 1028 limit_to__all__ = Bool(False,
1027 1029 help="""
1028 1030 DEPRECATED as of version 5.0.
1029 1031
1030 1032 Instruct the completer to use __all__ for the completion
1031 1033
1032 1034 Specifically, when completing on ``object.<tab>``.
1033 1035
1034 1036 When True: only those names in obj.__all__ will be included.
1035 1037
1036 1038 When False [default]: the __all__ attribute is ignored
1037 1039 """,
1038 1040 ).tag(config=True)
1039 1041
1040 1042 @observe('limit_to__all__')
1041 1043 def _limit_to_all_changed(self, change):
1042 1044 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1043 1045 'value has been deprecated since IPython 5.0, will be made to have '
1044 1046 'no effects and then removed in future version of IPython.',
1045 1047 UserWarning)
1046 1048
1047 1049 def __init__(self, shell=None, namespace=None, global_namespace=None,
1048 1050 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
1049 1051 """IPCompleter() -> completer
1050 1052
1051 1053 Return a completer object.
1052 1054
1053 1055 Parameters
1054 1056 ----------
1055 1057
1056 1058 shell
1057 1059 a pointer to the ipython shell itself. This is needed
1058 1060 because this completer knows about magic functions, and those can
1059 1061 only be accessed via the ipython instance.
1060 1062
1061 1063 namespace : dict, optional
1062 1064 an optional dict where completions are performed.
1063 1065
1064 1066 global_namespace : dict, optional
1065 1067 secondary optional dict for completions, to
1066 1068 handle cases (such as IPython embedded inside functions) where
1067 1069 both Python scopes are visible.
1068 1070
1069 1071 use_readline : bool, optional
1070 1072 DEPRECATED, ignored since IPython 6.0, will have no effects
1071 1073 """
1072 1074
1073 1075 self.magic_escape = ESC_MAGIC
1074 1076 self.splitter = CompletionSplitter()
1075 1077
1076 1078 if use_readline is not _deprecation_readline_sentinel:
1077 1079 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1078 1080 DeprecationWarning, stacklevel=2)
1079 1081
1080 1082 # _greedy_changed() depends on splitter and readline being defined:
1081 1083 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1082 1084 config=config, **kwargs)
1083 1085
1084 1086 # List where completion matches will be stored
1085 1087 self.matches = []
1086 1088 self.shell = shell
1087 1089 # Regexp to split filenames with spaces in them
1088 1090 self.space_name_re = re.compile(r'([^\\] )')
1089 1091 # Hold a local ref. to glob.glob for speed
1090 1092 self.glob = glob.glob
1091 1093
1092 1094 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1093 1095 # buffers, to avoid completion problems.
1094 1096 term = os.environ.get('TERM','xterm')
1095 1097 self.dumb_terminal = term in ['dumb','emacs']
1096 1098
1097 1099 # Special handling of backslashes needed in win32 platforms
1098 1100 if sys.platform == "win32":
1099 1101 self.clean_glob = self._clean_glob_win32
1100 1102 else:
1101 1103 self.clean_glob = self._clean_glob
1102 1104
1103 1105 #regexp to parse docstring for function signature
1104 1106 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1105 1107 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1106 1108 #use this if positional argument name is also needed
1107 1109 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1108 1110
1109 1111 self.magic_arg_matchers = [
1110 1112 self.magic_config_matches,
1111 1113 self.magic_color_matches,
1112 1114 ]
1113 1115
1114 1116 # This is set externally by InteractiveShell
1115 1117 self.custom_completers = None
1116 1118
1117 1119 @property
1118 1120 def matchers(self):
1119 1121 """All active matcher routines for completion"""
1120 1122 if self.dict_keys_only:
1121 1123 return [self.dict_key_matches]
1122 1124
1123 1125 if self.use_jedi:
1124 1126 return [
1127 *self.custom_matchers,
1125 1128 self.file_matches,
1126 1129 self.magic_matches,
1127 1130 self.dict_key_matches,
1128 1131 ]
1129 1132 else:
1130 1133 return [
1134 *self.custom_matchers,
1131 1135 self.python_matches,
1132 1136 self.file_matches,
1133 1137 self.magic_matches,
1134 1138 self.python_func_kw_matches,
1135 1139 self.dict_key_matches,
1136 1140 ]
1137 1141
1138 1142 def all_completions(self, text) -> List[str]:
1139 1143 """
1140 1144 Wrapper around the completion methods for the benefit of emacs.
1141 1145 """
1142 1146 prefix = text.rpartition('.')[0]
1143 1147 with provisionalcompleter():
1144 1148 return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text
1145 1149 for c in self.completions(text, len(text))]
1146 1150
1147 1151 return self.complete(text)[1]
1148 1152
1149 1153 def _clean_glob(self, text):
1150 1154 return self.glob("%s*" % text)
1151 1155
1152 1156 def _clean_glob_win32(self,text):
1153 1157 return [f.replace("\\","/")
1154 1158 for f in self.glob("%s*" % text)]
1155 1159
1156 1160 def file_matches(self, text):
1157 1161 """Match filenames, expanding ~USER type strings.
1158 1162
1159 1163 Most of the seemingly convoluted logic in this completer is an
1160 1164 attempt to handle filenames with spaces in them. And yet it's not
1161 1165 quite perfect, because Python's readline doesn't expose all of the
1162 1166 GNU readline details needed for this to be done correctly.
1163 1167
1164 1168 For a filename with a space in it, the printed completions will be
1165 1169 only the parts after what's already been typed (instead of the
1166 1170 full completions, as is normally done). I don't think with the
1167 1171 current (as of Python 2.3) Python readline it's possible to do
1168 1172 better."""
1169 1173
1170 1174 # chars that require escaping with backslash - i.e. chars
1171 1175 # that readline treats incorrectly as delimiters, but we
1172 1176 # don't want to treat as delimiters in filename matching
1173 1177 # when escaped with backslash
1174 1178 if text.startswith('!'):
1175 1179 text = text[1:]
1176 1180 text_prefix = u'!'
1177 1181 else:
1178 1182 text_prefix = u''
1179 1183
1180 1184 text_until_cursor = self.text_until_cursor
1181 1185 # track strings with open quotes
1182 1186 open_quotes = has_open_quotes(text_until_cursor)
1183 1187
1184 1188 if '(' in text_until_cursor or '[' in text_until_cursor:
1185 1189 lsplit = text
1186 1190 else:
1187 1191 try:
1188 1192 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1189 1193 lsplit = arg_split(text_until_cursor)[-1]
1190 1194 except ValueError:
1191 1195 # typically an unmatched ", or backslash without escaped char.
1192 1196 if open_quotes:
1193 1197 lsplit = text_until_cursor.split(open_quotes)[-1]
1194 1198 else:
1195 1199 return []
1196 1200 except IndexError:
1197 1201 # tab pressed on empty line
1198 1202 lsplit = ""
1199 1203
1200 1204 if not open_quotes and lsplit != protect_filename(lsplit):
1201 1205 # if protectables are found, do matching on the whole escaped name
1202 1206 has_protectables = True
1203 1207 text0,text = text,lsplit
1204 1208 else:
1205 1209 has_protectables = False
1206 1210 text = os.path.expanduser(text)
1207 1211
1208 1212 if text == "":
1209 1213 return [text_prefix + protect_filename(f) for f in self.glob("*")]
1210 1214
1211 1215 # Compute the matches from the filesystem
1212 1216 if sys.platform == 'win32':
1213 1217 m0 = self.clean_glob(text)
1214 1218 else:
1215 1219 m0 = self.clean_glob(text.replace('\\', ''))
1216 1220
1217 1221 if has_protectables:
1218 1222 # If we had protectables, we need to revert our changes to the
1219 1223 # beginning of filename so that we don't double-write the part
1220 1224 # of the filename we have so far
1221 1225 len_lsplit = len(lsplit)
1222 1226 matches = [text_prefix + text0 +
1223 1227 protect_filename(f[len_lsplit:]) for f in m0]
1224 1228 else:
1225 1229 if open_quotes:
1226 1230 # if we have a string with an open quote, we don't need to
1227 1231 # protect the names beyond the quote (and we _shouldn't_, as
1228 1232 # it would cause bugs when the filesystem call is made).
1229 1233 matches = m0 if sys.platform == "win32" else\
1230 1234 [protect_filename(f, open_quotes) for f in m0]
1231 1235 else:
1232 1236 matches = [text_prefix +
1233 1237 protect_filename(f) for f in m0]
1234 1238
1235 1239 # Mark directories in input list by appending '/' to their names.
1236 1240 return [x+'/' if os.path.isdir(x) else x for x in matches]
1237 1241
1238 1242 def magic_matches(self, text):
1239 1243 """Match magics"""
1240 1244 # Get all shell magics now rather than statically, so magics loaded at
1241 1245 # runtime show up too.
1242 1246 lsm = self.shell.magics_manager.lsmagic()
1243 1247 line_magics = lsm['line']
1244 1248 cell_magics = lsm['cell']
1245 1249 pre = self.magic_escape
1246 1250 pre2 = pre+pre
1247 1251
1248 1252 explicit_magic = text.startswith(pre)
1249 1253
1250 1254 # Completion logic:
1251 1255 # - user gives %%: only do cell magics
1252 1256 # - user gives %: do both line and cell magics
1253 1257 # - no prefix: do both
1254 1258 # In other words, line magics are skipped if the user gives %% explicitly
1255 1259 #
1256 1260 # We also exclude magics that match any currently visible names:
1257 1261 # https://github.com/ipython/ipython/issues/4877, unless the user has
1258 1262 # typed a %:
1259 1263 # https://github.com/ipython/ipython/issues/10754
1260 1264 bare_text = text.lstrip(pre)
1261 1265 global_matches = self.global_matches(bare_text)
1262 1266 if not explicit_magic:
1263 1267 def matches(magic):
1264 1268 """
1265 1269 Filter magics, in particular remove magics that match
1266 1270 a name present in global namespace.
1267 1271 """
1268 1272 return ( magic.startswith(bare_text) and
1269 1273 magic not in global_matches )
1270 1274 else:
1271 1275 def matches(magic):
1272 1276 return magic.startswith(bare_text)
1273 1277
1274 1278 comp = [ pre2+m for m in cell_magics if matches(m)]
1275 1279 if not text.startswith(pre2):
1276 1280 comp += [ pre+m for m in line_magics if matches(m)]
1277 1281
1278 1282 return comp
1279 1283
1280 1284 def magic_config_matches(self, text:str) -> List[str]:
1281 1285 """ Match class names and attributes for %config magic """
1282 1286 texts = text.strip().split()
1283 1287
1284 1288 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
1285 1289 # get all configuration classes
1286 1290 classes = sorted(set([ c for c in self.shell.configurables
1287 1291 if c.__class__.class_traits(config=True)
1288 1292 ]), key=lambda x: x.__class__.__name__)
1289 1293 classnames = [ c.__class__.__name__ for c in classes ]
1290 1294
1291 1295 # return all classnames if config or %config is given
1292 1296 if len(texts) == 1:
1293 1297 return classnames
1294 1298
1295 1299 # match classname
1296 1300 classname_texts = texts[1].split('.')
1297 1301 classname = classname_texts[0]
1298 1302 classname_matches = [ c for c in classnames
1299 1303 if c.startswith(classname) ]
1300 1304
1301 1305 # return matched classes or the matched class with attributes
1302 1306 if texts[1].find('.') < 0:
1303 1307 return classname_matches
1304 1308 elif len(classname_matches) == 1 and \
1305 1309 classname_matches[0] == classname:
1306 1310 cls = classes[classnames.index(classname)].__class__
1307 1311 help = cls.class_get_help()
1308 1312 # strip leading '--' from cl-args:
1309 1313 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1310 1314 return [ attr.split('=')[0]
1311 1315 for attr in help.strip().splitlines()
1312 1316 if attr.startswith(texts[1]) ]
1313 1317 return []
1314 1318
1315 1319 def magic_color_matches(self, text:str) -> List[str] :
1316 1320 """ Match color schemes for %colors magic"""
1317 1321 texts = text.split()
1318 1322 if text.endswith(' '):
1319 1323 # .split() strips off the trailing whitespace. Add '' back
1320 1324 # so that: '%colors ' -> ['%colors', '']
1321 1325 texts.append('')
1322 1326
1323 1327 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
1324 1328 prefix = texts[1]
1325 1329 return [ color for color in InspectColors.keys()
1326 1330 if color.startswith(prefix) ]
1327 1331 return []
1328 1332
1329 1333 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1330 1334 """
1331 1335
1332 1336 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1333 1337 cursor position.
1334 1338
1335 1339 Parameters
1336 1340 ----------
1337 1341 cursor_column : int
1338 1342 column position of the cursor in ``text``, 0-indexed.
1339 1343 cursor_line : int
1340 1344 line position of the cursor in ``text``, 0-indexed
1341 1345 text : str
1342 1346 text to complete
1343 1347
1344 1348 Debugging
1345 1349 ---------
1346 1350
1347 1351 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1348 1352 object containing a string with the Jedi debug information attached.
1349 1353 """
1350 1354 namespaces = [self.namespace]
1351 1355 if self.global_namespace is not None:
1352 1356 namespaces.append(self.global_namespace)
1353 1357
1354 1358 completion_filter = lambda x:x
1355 1359 offset = cursor_to_position(text, cursor_line, cursor_column)
1356 1360 # filter output if we are completing for object members
1357 1361 if offset:
1358 1362 pre = text[offset-1]
1359 1363 if pre == '.':
1360 1364 if self.omit__names == 2:
1361 1365 completion_filter = lambda c:not c.name.startswith('_')
1362 1366 elif self.omit__names == 1:
1363 1367 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1364 1368 elif self.omit__names == 0:
1365 1369 completion_filter = lambda x:x
1366 1370 else:
1367 1371 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1368 1372
1369 1373 interpreter = jedi.Interpreter(
1370 1374 text[:offset], namespaces, column=cursor_column, line=cursor_line + 1)
1371 1375 try_jedi = True
1372 1376
1373 1377 try:
1374 1378 # should we check the type of the node is Error ?
1375 1379 try:
1376 1380 # jedi < 0.11
1377 1381 from jedi.parser.tree import ErrorLeaf
1378 1382 except ImportError:
1379 1383 # jedi >= 0.11
1380 1384 from parso.tree import ErrorLeaf
1381 1385
1382 1386 next_to_last_tree = interpreter._get_module().tree_node.children[-2]
1383 1387 completing_string = False
1384 1388 if isinstance(next_to_last_tree, ErrorLeaf):
1385 1389 completing_string = next_to_last_tree.value.lstrip()[0] in {'"', "'"}
1386 1390 # if we are in a string jedi is likely not the right candidate for
1387 1391 # now. Skip it.
1388 1392 try_jedi = not completing_string
1389 1393 except Exception as e:
1390 1394 # many of things can go wrong, we are using private API just don't crash.
1391 1395 if self.debug:
1392 1396 print("Error detecting if completing a non-finished string :", e, '|')
1393 1397
1394 1398 if not try_jedi:
1395 1399 return []
1396 1400 try:
1397 1401 return filter(completion_filter, interpreter.completions())
1398 1402 except Exception as e:
1399 1403 if self.debug:
1400 1404 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1401 1405 else:
1402 1406 return []
1403 1407
1404 1408 def python_matches(self, text):
1405 1409 """Match attributes or global python names"""
1406 1410 if "." in text:
1407 1411 try:
1408 1412 matches = self.attr_matches(text)
1409 1413 if text.endswith('.') and self.omit__names:
1410 1414 if self.omit__names == 1:
1411 1415 # true if txt is _not_ a __ name, false otherwise:
1412 1416 no__name = (lambda txt:
1413 1417 re.match(r'.*\.__.*?__',txt) is None)
1414 1418 else:
1415 1419 # true if txt is _not_ a _ name, false otherwise:
1416 1420 no__name = (lambda txt:
1417 1421 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1418 1422 matches = filter(no__name, matches)
1419 1423 except NameError:
1420 1424 # catches <undefined attributes>.<tab>
1421 1425 matches = []
1422 1426 else:
1423 1427 matches = self.global_matches(text)
1424 1428 return matches
1425 1429
1426 1430 def _default_arguments_from_docstring(self, doc):
1427 1431 """Parse the first line of docstring for call signature.
1428 1432
1429 1433 Docstring should be of the form 'min(iterable[, key=func])\n'.
1430 1434 It can also parse cython docstring of the form
1431 1435 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1432 1436 """
1433 1437 if doc is None:
1434 1438 return []
1435 1439
1436 1440 #care only the firstline
1437 1441 line = doc.lstrip().splitlines()[0]
1438 1442
1439 1443 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1440 1444 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1441 1445 sig = self.docstring_sig_re.search(line)
1442 1446 if sig is None:
1443 1447 return []
1444 1448 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1445 1449 sig = sig.groups()[0].split(',')
1446 1450 ret = []
1447 1451 for s in sig:
1448 1452 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1449 1453 ret += self.docstring_kwd_re.findall(s)
1450 1454 return ret
1451 1455
1452 1456 def _default_arguments(self, obj):
1453 1457 """Return the list of default arguments of obj if it is callable,
1454 1458 or empty list otherwise."""
1455 1459 call_obj = obj
1456 1460 ret = []
1457 1461 if inspect.isbuiltin(obj):
1458 1462 pass
1459 1463 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1460 1464 if inspect.isclass(obj):
1461 1465 #for cython embedsignature=True the constructor docstring
1462 1466 #belongs to the object itself not __init__
1463 1467 ret += self._default_arguments_from_docstring(
1464 1468 getattr(obj, '__doc__', ''))
1465 1469 # for classes, check for __init__,__new__
1466 1470 call_obj = (getattr(obj, '__init__', None) or
1467 1471 getattr(obj, '__new__', None))
1468 1472 # for all others, check if they are __call__able
1469 1473 elif hasattr(obj, '__call__'):
1470 1474 call_obj = obj.__call__
1471 1475 ret += self._default_arguments_from_docstring(
1472 1476 getattr(call_obj, '__doc__', ''))
1473 1477
1474 1478 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1475 1479 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1476 1480
1477 1481 try:
1478 1482 sig = inspect.signature(call_obj)
1479 1483 ret.extend(k for k, v in sig.parameters.items() if
1480 1484 v.kind in _keeps)
1481 1485 except ValueError:
1482 1486 pass
1483 1487
1484 1488 return list(set(ret))
1485 1489
1486 1490 def python_func_kw_matches(self,text):
1487 1491 """Match named parameters (kwargs) of the last open function"""
1488 1492
1489 1493 if "." in text: # a parameter cannot be dotted
1490 1494 return []
1491 1495 try: regexp = self.__funcParamsRegex
1492 1496 except AttributeError:
1493 1497 regexp = self.__funcParamsRegex = re.compile(r'''
1494 1498 '.*?(?<!\\)' | # single quoted strings or
1495 1499 ".*?(?<!\\)" | # double quoted strings or
1496 1500 \w+ | # identifier
1497 1501 \S # other characters
1498 1502 ''', re.VERBOSE | re.DOTALL)
1499 1503 # 1. find the nearest identifier that comes before an unclosed
1500 1504 # parenthesis before the cursor
1501 1505 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1502 1506 tokens = regexp.findall(self.text_until_cursor)
1503 1507 iterTokens = reversed(tokens); openPar = 0
1504 1508
1505 1509 for token in iterTokens:
1506 1510 if token == ')':
1507 1511 openPar -= 1
1508 1512 elif token == '(':
1509 1513 openPar += 1
1510 1514 if openPar > 0:
1511 1515 # found the last unclosed parenthesis
1512 1516 break
1513 1517 else:
1514 1518 return []
1515 1519 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1516 1520 ids = []
1517 1521 isId = re.compile(r'\w+$').match
1518 1522
1519 1523 while True:
1520 1524 try:
1521 1525 ids.append(next(iterTokens))
1522 1526 if not isId(ids[-1]):
1523 1527 ids.pop(); break
1524 1528 if not next(iterTokens) == '.':
1525 1529 break
1526 1530 except StopIteration:
1527 1531 break
1528 1532
1529 1533 # Find all named arguments already assigned to, as to avoid suggesting
1530 1534 # them again
1531 1535 usedNamedArgs = set()
1532 1536 par_level = -1
1533 1537 for token, next_token in zip(tokens, tokens[1:]):
1534 1538 if token == '(':
1535 1539 par_level += 1
1536 1540 elif token == ')':
1537 1541 par_level -= 1
1538 1542
1539 1543 if par_level != 0:
1540 1544 continue
1541 1545
1542 1546 if next_token != '=':
1543 1547 continue
1544 1548
1545 1549 usedNamedArgs.add(token)
1546 1550
1547 1551 argMatches = []
1548 1552 try:
1549 1553 callableObj = '.'.join(ids[::-1])
1550 1554 namedArgs = self._default_arguments(eval(callableObj,
1551 1555 self.namespace))
1552 1556
1553 1557 # Remove used named arguments from the list, no need to show twice
1554 1558 for namedArg in set(namedArgs) - usedNamedArgs:
1555 1559 if namedArg.startswith(text):
1556 1560 argMatches.append(u"%s=" %namedArg)
1557 1561 except:
1558 1562 pass
1559 1563
1560 1564 return argMatches
1561 1565
1562 1566 def dict_key_matches(self, text):
1563 1567 "Match string keys in a dictionary, after e.g. 'foo[' "
1564 1568 def get_keys(obj):
1565 1569 # Objects can define their own completions by defining an
1566 1570 # _ipy_key_completions_() method.
1567 1571 method = get_real_method(obj, '_ipython_key_completions_')
1568 1572 if method is not None:
1569 1573 return method()
1570 1574
1571 1575 # Special case some common in-memory dict-like types
1572 1576 if isinstance(obj, dict) or\
1573 1577 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1574 1578 try:
1575 1579 return list(obj.keys())
1576 1580 except Exception:
1577 1581 return []
1578 1582 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1579 1583 _safe_isinstance(obj, 'numpy', 'void'):
1580 1584 return obj.dtype.names or []
1581 1585 return []
1582 1586
1583 1587 try:
1584 1588 regexps = self.__dict_key_regexps
1585 1589 except AttributeError:
1586 1590 dict_key_re_fmt = r'''(?x)
1587 1591 ( # match dict-referring expression wrt greedy setting
1588 1592 %s
1589 1593 )
1590 1594 \[ # open bracket
1591 1595 \s* # and optional whitespace
1592 1596 ([uUbB]? # string prefix (r not handled)
1593 1597 (?: # unclosed string
1594 1598 '(?:[^']|(?<!\\)\\')*
1595 1599 |
1596 1600 "(?:[^"]|(?<!\\)\\")*
1597 1601 )
1598 1602 )?
1599 1603 $
1600 1604 '''
1601 1605 regexps = self.__dict_key_regexps = {
1602 1606 False: re.compile(dict_key_re_fmt % r'''
1603 1607 # identifiers separated by .
1604 1608 (?!\d)\w+
1605 1609 (?:\.(?!\d)\w+)*
1606 1610 '''),
1607 1611 True: re.compile(dict_key_re_fmt % '''
1608 1612 .+
1609 1613 ''')
1610 1614 }
1611 1615
1612 1616 match = regexps[self.greedy].search(self.text_until_cursor)
1613 1617 if match is None:
1614 1618 return []
1615 1619
1616 1620 expr, prefix = match.groups()
1617 1621 try:
1618 1622 obj = eval(expr, self.namespace)
1619 1623 except Exception:
1620 1624 try:
1621 1625 obj = eval(expr, self.global_namespace)
1622 1626 except Exception:
1623 1627 return []
1624 1628
1625 1629 keys = get_keys(obj)
1626 1630 if not keys:
1627 1631 return keys
1628 1632 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1629 1633 if not matches:
1630 1634 return matches
1631 1635
1632 1636 # get the cursor position of
1633 1637 # - the text being completed
1634 1638 # - the start of the key text
1635 1639 # - the start of the completion
1636 1640 text_start = len(self.text_until_cursor) - len(text)
1637 1641 if prefix:
1638 1642 key_start = match.start(2)
1639 1643 completion_start = key_start + token_offset
1640 1644 else:
1641 1645 key_start = completion_start = match.end()
1642 1646
1643 1647 # grab the leading prefix, to make sure all completions start with `text`
1644 1648 if text_start > key_start:
1645 1649 leading = ''
1646 1650 else:
1647 1651 leading = text[text_start:completion_start]
1648 1652
1649 1653 # the index of the `[` character
1650 1654 bracket_idx = match.end(1)
1651 1655
1652 1656 # append closing quote and bracket as appropriate
1653 1657 # this is *not* appropriate if the opening quote or bracket is outside
1654 1658 # the text given to this method
1655 1659 suf = ''
1656 1660 continuation = self.line_buffer[len(self.text_until_cursor):]
1657 1661 if key_start > text_start and closing_quote:
1658 1662 # quotes were opened inside text, maybe close them
1659 1663 if continuation.startswith(closing_quote):
1660 1664 continuation = continuation[len(closing_quote):]
1661 1665 else:
1662 1666 suf += closing_quote
1663 1667 if bracket_idx > text_start:
1664 1668 # brackets were opened inside text, maybe close them
1665 1669 if not continuation.startswith(']'):
1666 1670 suf += ']'
1667 1671
1668 1672 return [leading + k + suf for k in matches]
1669 1673
1670 1674 def unicode_name_matches(self, text):
1671 1675 u"""Match Latex-like syntax for unicode characters base
1672 1676 on the name of the character.
1673 1677
1674 1678 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1675 1679
1676 1680 Works only on valid python 3 identifier, or on combining characters that
1677 1681 will combine to form a valid identifier.
1678 1682
1679 1683 Used on Python 3 only.
1680 1684 """
1681 1685 slashpos = text.rfind('\\')
1682 1686 if slashpos > -1:
1683 1687 s = text[slashpos+1:]
1684 1688 try :
1685 1689 unic = unicodedata.lookup(s)
1686 1690 # allow combining chars
1687 1691 if ('a'+unic).isidentifier():
1688 1692 return '\\'+s,[unic]
1689 1693 except KeyError:
1690 1694 pass
1691 1695 return u'', []
1692 1696
1693 1697
1694 1698 def latex_matches(self, text):
1695 1699 u"""Match Latex syntax for unicode characters.
1696 1700
1697 1701 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1698 1702
1699 1703 Used on Python 3 only.
1700 1704 """
1701 1705 slashpos = text.rfind('\\')
1702 1706 if slashpos > -1:
1703 1707 s = text[slashpos:]
1704 1708 if s in latex_symbols:
1705 1709 # Try to complete a full latex symbol to unicode
1706 1710 # \\alpha -> Ξ±
1707 1711 return s, [latex_symbols[s]]
1708 1712 else:
1709 1713 # If a user has partially typed a latex symbol, give them
1710 1714 # a full list of options \al -> [\aleph, \alpha]
1711 1715 matches = [k for k in latex_symbols if k.startswith(s)]
1712 1716 return s, matches
1713 1717 return u'', []
1714 1718
1715 1719 def dispatch_custom_completer(self, text):
1716 1720 if not self.custom_completers:
1717 1721 return
1718 1722
1719 1723 line = self.line_buffer
1720 1724 if not line.strip():
1721 1725 return None
1722 1726
1723 1727 # Create a little structure to pass all the relevant information about
1724 1728 # the current completion to any custom completer.
1725 1729 event = SimpleNamespace()
1726 1730 event.line = line
1727 1731 event.symbol = text
1728 1732 cmd = line.split(None,1)[0]
1729 1733 event.command = cmd
1730 1734 event.text_until_cursor = self.text_until_cursor
1731 1735
1732 1736 # for foo etc, try also to find completer for %foo
1733 1737 if not cmd.startswith(self.magic_escape):
1734 1738 try_magic = self.custom_completers.s_matches(
1735 1739 self.magic_escape + cmd)
1736 1740 else:
1737 1741 try_magic = []
1738 1742
1739 1743 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1740 1744 try_magic,
1741 1745 self.custom_completers.flat_matches(self.text_until_cursor)):
1742 1746 try:
1743 1747 res = c(event)
1744 1748 if res:
1745 1749 # first, try case sensitive match
1746 1750 withcase = [r for r in res if r.startswith(text)]
1747 1751 if withcase:
1748 1752 return withcase
1749 1753 # if none, then case insensitive ones are ok too
1750 1754 text_low = text.lower()
1751 1755 return [r for r in res if r.lower().startswith(text_low)]
1752 1756 except TryNext:
1753 1757 pass
1754 1758 except KeyboardInterrupt:
1755 1759 """
1756 1760 If custom completer take too long,
1757 1761 let keyboard interrupt abort and return nothing.
1758 1762 """
1759 1763 break
1760 1764
1761 1765 return None
1762 1766
1763 1767 def completions(self, text: str, offset: int)->Iterator[Completion]:
1764 1768 """
1765 1769 Returns an iterator over the possible completions
1766 1770
1767 1771 .. warning:: Unstable
1768 1772
1769 1773 This function is unstable, API may change without warning.
1770 1774 It will also raise unless use in proper context manager.
1771 1775
1772 1776 Parameters
1773 1777 ----------
1774 1778
1775 1779 text:str
1776 1780 Full text of the current input, multi line string.
1777 1781 offset:int
1778 1782 Integer representing the position of the cursor in ``text``. Offset
1779 1783 is 0-based indexed.
1780 1784
1781 1785 Yields
1782 1786 ------
1783 1787 :any:`Completion` object
1784 1788
1785 1789
1786 1790 The cursor on a text can either be seen as being "in between"
1787 1791 characters or "On" a character depending on the interface visible to
1788 1792 the user. For consistency the cursor being on "in between" characters X
1789 1793 and Y is equivalent to the cursor being "on" character Y, that is to say
1790 1794 the character the cursor is on is considered as being after the cursor.
1791 1795
1792 1796 Combining characters may span more that one position in the
1793 1797 text.
1794 1798
1795 1799
1796 1800 .. note::
1797 1801
1798 1802 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1799 1803 fake Completion token to distinguish completion returned by Jedi
1800 1804 and usual IPython completion.
1801 1805
1802 1806 .. note::
1803 1807
1804 1808 Completions are not completely deduplicated yet. If identical
1805 1809 completions are coming from different sources this function does not
1806 1810 ensure that each completion object will only be present once.
1807 1811 """
1808 1812 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1809 1813 "It may change without warnings. "
1810 1814 "Use in corresponding context manager.",
1811 1815 category=ProvisionalCompleterWarning, stacklevel=2)
1812 1816
1813 1817 seen = set()
1814 1818 try:
1815 1819 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1816 1820 if c and (c in seen):
1817 1821 continue
1818 1822 yield c
1819 1823 seen.add(c)
1820 1824 except KeyboardInterrupt:
1821 1825 """if completions take too long and users send keyboard interrupt,
1822 1826 do not crash and return ASAP. """
1823 1827 pass
1824 1828
1825 1829 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1826 1830 """
1827 1831 Core completion module.Same signature as :any:`completions`, with the
1828 1832 extra `timeout` parameter (in seconds).
1829 1833
1830 1834
1831 1835 Computing jedi's completion ``.type`` can be quite expensive (it is a
1832 1836 lazy property) and can require some warm-up, more warm up than just
1833 1837 computing the ``name`` of a completion. The warm-up can be :
1834 1838
1835 1839 - Long warm-up the first time a module is encountered after
1836 1840 install/update: actually build parse/inference tree.
1837 1841
1838 1842 - first time the module is encountered in a session: load tree from
1839 1843 disk.
1840 1844
1841 1845 We don't want to block completions for tens of seconds so we give the
1842 1846 completer a "budget" of ``_timeout`` seconds per invocation to compute
1843 1847 completions types, the completions that have not yet been computed will
1844 1848 be marked as "unknown" an will have a chance to be computed next round
1845 1849 are things get cached.
1846 1850
1847 1851 Keep in mind that Jedi is not the only thing treating the completion so
1848 1852 keep the timeout short-ish as if we take more than 0.3 second we still
1849 1853 have lots of processing to do.
1850 1854
1851 1855 """
1852 1856 deadline = time.monotonic() + _timeout
1853 1857
1854 1858
1855 1859 before = full_text[:offset]
1856 1860 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1857 1861
1858 1862 matched_text, matches, matches_origin, jedi_matches = self._complete(
1859 1863 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1860 1864
1861 1865 iter_jm = iter(jedi_matches)
1862 1866 if _timeout:
1863 1867 for jm in iter_jm:
1864 1868 try:
1865 1869 type_ = jm.type
1866 1870 except Exception:
1867 1871 if self.debug:
1868 1872 print("Error in Jedi getting type of ", jm)
1869 1873 type_ = None
1870 1874 delta = len(jm.name_with_symbols) - len(jm.complete)
1871 1875 if type_ == 'function':
1872 1876 signature = _make_signature(jm)
1873 1877 else:
1874 1878 signature = ''
1875 1879 yield Completion(start=offset - delta,
1876 1880 end=offset,
1877 1881 text=jm.name_with_symbols,
1878 1882 type=type_,
1879 1883 signature=signature,
1880 1884 _origin='jedi')
1881 1885
1882 1886 if time.monotonic() > deadline:
1883 1887 break
1884 1888
1885 1889 for jm in iter_jm:
1886 1890 delta = len(jm.name_with_symbols) - len(jm.complete)
1887 1891 yield Completion(start=offset - delta,
1888 1892 end=offset,
1889 1893 text=jm.name_with_symbols,
1890 1894 type='<unknown>', # don't compute type for speed
1891 1895 _origin='jedi',
1892 1896 signature='')
1893 1897
1894 1898
1895 1899 start_offset = before.rfind(matched_text)
1896 1900
1897 1901 # TODO:
1898 1902 # Suppress this, right now just for debug.
1899 1903 if jedi_matches and matches and self.debug:
1900 1904 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--',
1901 1905 _origin='debug', type='none', signature='')
1902 1906
1903 1907 # I'm unsure if this is always true, so let's assert and see if it
1904 1908 # crash
1905 1909 assert before.endswith(matched_text)
1906 1910 for m, t in zip(matches, matches_origin):
1907 1911 yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>')
1908 1912
1909 1913
1910 1914 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1911 1915 """Find completions for the given text and line context.
1912 1916
1913 1917 Note that both the text and the line_buffer are optional, but at least
1914 1918 one of them must be given.
1915 1919
1916 1920 Parameters
1917 1921 ----------
1918 1922 text : string, optional
1919 1923 Text to perform the completion on. If not given, the line buffer
1920 1924 is split using the instance's CompletionSplitter object.
1921 1925
1922 1926 line_buffer : string, optional
1923 1927 If not given, the completer attempts to obtain the current line
1924 1928 buffer via readline. This keyword allows clients which are
1925 1929 requesting for text completions in non-readline contexts to inform
1926 1930 the completer of the entire text.
1927 1931
1928 1932 cursor_pos : int, optional
1929 1933 Index of the cursor in the full line buffer. Should be provided by
1930 1934 remote frontends where kernel has no access to frontend state.
1931 1935
1932 1936 Returns
1933 1937 -------
1934 1938 text : str
1935 1939 Text that was actually used in the completion.
1936 1940
1937 1941 matches : list
1938 1942 A list of completion matches.
1939 1943
1940 1944
1941 1945 .. note::
1942 1946
1943 1947 This API is likely to be deprecated and replaced by
1944 1948 :any:`IPCompleter.completions` in the future.
1945 1949
1946 1950
1947 1951 """
1948 1952 warnings.warn('`Completer.complete` is pending deprecation since '
1949 1953 'IPython 6.0 and will be replaced by `Completer.completions`.',
1950 1954 PendingDeprecationWarning)
1951 1955 # potential todo, FOLD the 3rd throw away argument of _complete
1952 1956 # into the first 2 one.
1953 1957 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1954 1958
1955 1959 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1956 1960 full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]:
1957 1961 """
1958 1962
1959 1963 Like complete but can also returns raw jedi completions as well as the
1960 1964 origin of the completion text. This could (and should) be made much
1961 1965 cleaner but that will be simpler once we drop the old (and stateful)
1962 1966 :any:`complete` API.
1963 1967
1964 1968
1965 1969 With current provisional API, cursor_pos act both (depending on the
1966 1970 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1967 1971 ``column`` when passing multiline strings this could/should be renamed
1968 1972 but would add extra noise.
1969 1973 """
1970 1974
1971 1975 # if the cursor position isn't given, the only sane assumption we can
1972 1976 # make is that it's at the end of the line (the common case)
1973 1977 if cursor_pos is None:
1974 1978 cursor_pos = len(line_buffer) if text is None else len(text)
1975 1979
1976 1980 if self.use_main_ns:
1977 1981 self.namespace = __main__.__dict__
1978 1982
1979 1983 # if text is either None or an empty string, rely on the line buffer
1980 1984 if (not line_buffer) and full_text:
1981 1985 line_buffer = full_text.split('\n')[cursor_line]
1982 1986 if not text:
1983 1987 text = self.splitter.split_line(line_buffer, cursor_pos)
1984 1988
1985 1989 if self.backslash_combining_completions:
1986 1990 # allow deactivation of these on windows.
1987 1991 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1988 1992 latex_text, latex_matches = self.latex_matches(base_text)
1989 1993 if latex_matches:
1990 1994 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1991 1995 name_text = ''
1992 1996 name_matches = []
1993 1997 # need to add self.fwd_unicode_match() function here when done
1994 1998 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches, self.fwd_unicode_match):
1995 1999 name_text, name_matches = meth(base_text)
1996 2000 if name_text:
1997 2001 return name_text, name_matches[:MATCHES_LIMIT], \
1998 2002 [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), ()
1999 2003
2000 2004
2001 2005 # If no line buffer is given, assume the input text is all there was
2002 2006 if line_buffer is None:
2003 2007 line_buffer = text
2004 2008
2005 2009 self.line_buffer = line_buffer
2006 2010 self.text_until_cursor = self.line_buffer[:cursor_pos]
2007 2011
2008 2012 # Do magic arg matches
2009 2013 for matcher in self.magic_arg_matchers:
2010 2014 matches = list(matcher(line_buffer))[:MATCHES_LIMIT]
2011 2015 if matches:
2012 2016 origins = [matcher.__qualname__] * len(matches)
2013 2017 return text, matches, origins, ()
2014 2018
2015 2019 # Start with a clean slate of completions
2016 2020 matches = []
2017 2021
2018 2022 # FIXME: we should extend our api to return a dict with completions for
2019 2023 # different types of objects. The rlcomplete() method could then
2020 2024 # simply collapse the dict into a list for readline, but we'd have
2021 2025 # richer completion semantics in other environments.
2022 2026 completions = ()
2023 2027 if self.use_jedi:
2024 2028 if not full_text:
2025 2029 full_text = line_buffer
2026 2030 completions = self._jedi_matches(
2027 2031 cursor_pos, cursor_line, full_text)
2028 2032
2029 2033 if self.merge_completions:
2030 2034 matches = []
2031 2035 for matcher in self.matchers:
2032 2036 try:
2033 2037 matches.extend([(m, matcher.__qualname__)
2034 2038 for m in matcher(text)])
2035 2039 except:
2036 2040 # Show the ugly traceback if the matcher causes an
2037 2041 # exception, but do NOT crash the kernel!
2038 2042 sys.excepthook(*sys.exc_info())
2039 2043 else:
2040 2044 for matcher in self.matchers:
2041 2045 matches = [(m, matcher.__qualname__)
2042 2046 for m in matcher(text)]
2043 2047 if matches:
2044 2048 break
2045 2049
2046 2050 seen = set()
2047 2051 filtered_matches = set()
2048 2052 for m in matches:
2049 2053 t, c = m
2050 2054 if t not in seen:
2051 2055 filtered_matches.add(m)
2052 2056 seen.add(t)
2053 2057
2054 2058 _filtered_matches = sorted(filtered_matches, key=lambda x: completions_sorting_key(x[0]))
2055 2059
2056 2060 custom_res = [(m, 'custom') for m in self.dispatch_custom_completer(text) or []]
2057 2061
2058 2062 _filtered_matches = custom_res or _filtered_matches
2059 2063
2060 2064 _filtered_matches = _filtered_matches[:MATCHES_LIMIT]
2061 2065 _matches = [m[0] for m in _filtered_matches]
2062 2066 origins = [m[1] for m in _filtered_matches]
2063 2067
2064 2068 self.matches = _matches
2065 2069
2066 2070 return text, _matches, origins, completions
2067 2071
2068 2072 def fwd_unicode_match(self, text:str) -> Tuple[str, list]:
2069 2073 if self._names is None:
2070 2074 self._names = []
2071 2075 for c in range(0,0x10FFFF + 1):
2072 2076 try:
2073 2077 self._names.append(unicodedata.name(chr(c)))
2074 2078 except ValueError:
2075 2079 pass
2076 2080
2077 2081 slashpos = text.rfind('\\')
2078 2082 # if text starts with slash
2079 2083 if slashpos > -1:
2080 2084 s = text[slashpos+1:]
2081 2085 candidates = [x for x in self._names if x.startswith(s)]
2082 2086 if candidates:
2083 2087 return s, candidates
2084 2088 else:
2085 2089 return '', ()
2086 2090
2087 2091 # if text does not start with slash
2088 2092 else:
2089 2093 return u'', ()
1 NO CONTENT: modified file
The requested commit or file is too big and content was truncated. Show full diff
@@ -1,1000 +1,1018 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Tests for the key interactiveshell module.
3 3
4 4 Historically the main classes in interactiveshell have been under-tested. This
5 5 module should grow as many single-method tests as possible to trap many of the
6 6 recurring bugs we seem to encounter with high-level interaction.
7 7 """
8 8
9 9 # Copyright (c) IPython Development Team.
10 10 # Distributed under the terms of the Modified BSD License.
11 11
12 12 import asyncio
13 13 import ast
14 14 import os
15 15 import signal
16 16 import shutil
17 17 import sys
18 18 import tempfile
19 19 import unittest
20 20 from unittest import mock
21 21
22 22 from os.path import join
23 23
24 24 import nose.tools as nt
25 25
26 26 from IPython.core.error import InputRejected
27 27 from IPython.core.inputtransformer import InputTransformer
28 28 from IPython.core import interactiveshell
29 29 from IPython.testing.decorators import (
30 30 skipif, skip_win32, onlyif_unicode_paths, onlyif_cmds_exist,
31 31 )
32 32 from IPython.testing import tools as tt
33 33 from IPython.utils.process import find_cmd
34 34
35 35 #-----------------------------------------------------------------------------
36 36 # Globals
37 37 #-----------------------------------------------------------------------------
38 38 # This is used by every single test, no point repeating it ad nauseam
39 39
40 40 #-----------------------------------------------------------------------------
41 41 # Tests
42 42 #-----------------------------------------------------------------------------
43 43
44 44 class DerivedInterrupt(KeyboardInterrupt):
45 45 pass
46 46
47 47 class InteractiveShellTestCase(unittest.TestCase):
48 48 def test_naked_string_cells(self):
49 49 """Test that cells with only naked strings are fully executed"""
50 50 # First, single-line inputs
51 51 ip.run_cell('"a"\n')
52 52 self.assertEqual(ip.user_ns['_'], 'a')
53 53 # And also multi-line cells
54 54 ip.run_cell('"""a\nb"""\n')
55 55 self.assertEqual(ip.user_ns['_'], 'a\nb')
56 56
57 57 def test_run_empty_cell(self):
58 58 """Just make sure we don't get a horrible error with a blank
59 59 cell of input. Yes, I did overlook that."""
60 60 old_xc = ip.execution_count
61 61 res = ip.run_cell('')
62 62 self.assertEqual(ip.execution_count, old_xc)
63 63 self.assertEqual(res.execution_count, None)
64 64
65 65 def test_run_cell_multiline(self):
66 66 """Multi-block, multi-line cells must execute correctly.
67 67 """
68 68 src = '\n'.join(["x=1",
69 69 "y=2",
70 70 "if 1:",
71 71 " x += 1",
72 72 " y += 1",])
73 73 res = ip.run_cell(src)
74 74 self.assertEqual(ip.user_ns['x'], 2)
75 75 self.assertEqual(ip.user_ns['y'], 3)
76 76 self.assertEqual(res.success, True)
77 77 self.assertEqual(res.result, None)
78 78
79 79 def test_multiline_string_cells(self):
80 80 "Code sprinkled with multiline strings should execute (GH-306)"
81 81 ip.run_cell('tmp=0')
82 82 self.assertEqual(ip.user_ns['tmp'], 0)
83 83 res = ip.run_cell('tmp=1;"""a\nb"""\n')
84 84 self.assertEqual(ip.user_ns['tmp'], 1)
85 85 self.assertEqual(res.success, True)
86 86 self.assertEqual(res.result, "a\nb")
87 87
88 88 def test_dont_cache_with_semicolon(self):
89 89 "Ending a line with semicolon should not cache the returned object (GH-307)"
90 90 oldlen = len(ip.user_ns['Out'])
91 91 for cell in ['1;', '1;1;']:
92 92 res = ip.run_cell(cell, store_history=True)
93 93 newlen = len(ip.user_ns['Out'])
94 94 self.assertEqual(oldlen, newlen)
95 95 self.assertIsNone(res.result)
96 96 i = 0
97 97 #also test the default caching behavior
98 98 for cell in ['1', '1;1']:
99 99 ip.run_cell(cell, store_history=True)
100 100 newlen = len(ip.user_ns['Out'])
101 101 i += 1
102 102 self.assertEqual(oldlen+i, newlen)
103 103
104 104 def test_syntax_error(self):
105 105 res = ip.run_cell("raise = 3")
106 106 self.assertIsInstance(res.error_before_exec, SyntaxError)
107 107
108 108 def test_In_variable(self):
109 109 "Verify that In variable grows with user input (GH-284)"
110 110 oldlen = len(ip.user_ns['In'])
111 111 ip.run_cell('1;', store_history=True)
112 112 newlen = len(ip.user_ns['In'])
113 113 self.assertEqual(oldlen+1, newlen)
114 114 self.assertEqual(ip.user_ns['In'][-1],'1;')
115 115
116 116 def test_magic_names_in_string(self):
117 117 ip.run_cell('a = """\n%exit\n"""')
118 118 self.assertEqual(ip.user_ns['a'], '\n%exit\n')
119 119
120 120 def test_trailing_newline(self):
121 121 """test that running !(command) does not raise a SyntaxError"""
122 122 ip.run_cell('!(true)\n', False)
123 123 ip.run_cell('!(true)\n\n\n', False)
124 124
125 125 def test_gh_597(self):
126 126 """Pretty-printing lists of objects with non-ascii reprs may cause
127 127 problems."""
128 128 class Spam(object):
129 129 def __repr__(self):
130 130 return "\xe9"*50
131 131 import IPython.core.formatters
132 132 f = IPython.core.formatters.PlainTextFormatter()
133 133 f([Spam(),Spam()])
134 134
135 135
136 136 def test_future_flags(self):
137 137 """Check that future flags are used for parsing code (gh-777)"""
138 138 ip.run_cell('from __future__ import barry_as_FLUFL')
139 139 try:
140 140 ip.run_cell('prfunc_return_val = 1 <> 2')
141 141 assert 'prfunc_return_val' in ip.user_ns
142 142 finally:
143 143 # Reset compiler flags so we don't mess up other tests.
144 144 ip.compile.reset_compiler_flags()
145 145
146 146 def test_can_pickle(self):
147 147 "Can we pickle objects defined interactively (GH-29)"
148 148 ip = get_ipython()
149 149 ip.reset()
150 150 ip.run_cell(("class Mylist(list):\n"
151 151 " def __init__(self,x=[]):\n"
152 152 " list.__init__(self,x)"))
153 153 ip.run_cell("w=Mylist([1,2,3])")
154 154
155 155 from pickle import dumps
156 156
157 157 # We need to swap in our main module - this is only necessary
158 158 # inside the test framework, because IPython puts the interactive module
159 159 # in place (but the test framework undoes this).
160 160 _main = sys.modules['__main__']
161 161 sys.modules['__main__'] = ip.user_module
162 162 try:
163 163 res = dumps(ip.user_ns["w"])
164 164 finally:
165 165 sys.modules['__main__'] = _main
166 166 self.assertTrue(isinstance(res, bytes))
167 167
168 168 def test_global_ns(self):
169 169 "Code in functions must be able to access variables outside them."
170 170 ip = get_ipython()
171 171 ip.run_cell("a = 10")
172 172 ip.run_cell(("def f(x):\n"
173 173 " return x + a"))
174 174 ip.run_cell("b = f(12)")
175 175 self.assertEqual(ip.user_ns["b"], 22)
176 176
177 177 def test_bad_custom_tb(self):
178 178 """Check that InteractiveShell is protected from bad custom exception handlers"""
179 179 ip.set_custom_exc((IOError,), lambda etype,value,tb: 1/0)
180 180 self.assertEqual(ip.custom_exceptions, (IOError,))
181 181 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
182 182 ip.run_cell(u'raise IOError("foo")')
183 183 self.assertEqual(ip.custom_exceptions, ())
184 184
185 185 def test_bad_custom_tb_return(self):
186 186 """Check that InteractiveShell is protected from bad return types in custom exception handlers"""
187 187 ip.set_custom_exc((NameError,),lambda etype,value,tb, tb_offset=None: 1)
188 188 self.assertEqual(ip.custom_exceptions, (NameError,))
189 189 with tt.AssertPrints("Custom TB Handler failed", channel='stderr'):
190 190 ip.run_cell(u'a=abracadabra')
191 191 self.assertEqual(ip.custom_exceptions, ())
192 192
193 193 def test_drop_by_id(self):
194 194 myvars = {"a":object(), "b":object(), "c": object()}
195 195 ip.push(myvars, interactive=False)
196 196 for name in myvars:
197 197 assert name in ip.user_ns, name
198 198 assert name in ip.user_ns_hidden, name
199 199 ip.user_ns['b'] = 12
200 200 ip.drop_by_id(myvars)
201 201 for name in ["a", "c"]:
202 202 assert name not in ip.user_ns, name
203 203 assert name not in ip.user_ns_hidden, name
204 204 assert ip.user_ns['b'] == 12
205 205 ip.reset()
206 206
207 207 def test_var_expand(self):
208 208 ip.user_ns['f'] = u'Ca\xf1o'
209 209 self.assertEqual(ip.var_expand(u'echo $f'), u'echo Ca\xf1o')
210 210 self.assertEqual(ip.var_expand(u'echo {f}'), u'echo Ca\xf1o')
211 211 self.assertEqual(ip.var_expand(u'echo {f[:-1]}'), u'echo Ca\xf1')
212 212 self.assertEqual(ip.var_expand(u'echo {1*2}'), u'echo 2')
213 213
214 214 self.assertEqual(ip.var_expand(u"grep x | awk '{print $1}'"), u"grep x | awk '{print $1}'")
215 215
216 216 ip.user_ns['f'] = b'Ca\xc3\xb1o'
217 217 # This should not raise any exception:
218 218 ip.var_expand(u'echo $f')
219 219
220 220 def test_var_expand_local(self):
221 221 """Test local variable expansion in !system and %magic calls"""
222 222 # !system
223 223 ip.run_cell('def test():\n'
224 224 ' lvar = "ttt"\n'
225 225 ' ret = !echo {lvar}\n'
226 226 ' return ret[0]\n')
227 227 res = ip.user_ns['test']()
228 228 nt.assert_in('ttt', res)
229 229
230 230 # %magic
231 231 ip.run_cell('def makemacro():\n'
232 232 ' macroname = "macro_var_expand_locals"\n'
233 233 ' %macro {macroname} codestr\n')
234 234 ip.user_ns['codestr'] = "str(12)"
235 235 ip.run_cell('makemacro()')
236 236 nt.assert_in('macro_var_expand_locals', ip.user_ns)
237 237
238 238 def test_var_expand_self(self):
239 239 """Test variable expansion with the name 'self', which was failing.
240 240
241 241 See https://github.com/ipython/ipython/issues/1878#issuecomment-7698218
242 242 """
243 243 ip.run_cell('class cTest:\n'
244 244 ' classvar="see me"\n'
245 245 ' def test(self):\n'
246 246 ' res = !echo Variable: {self.classvar}\n'
247 247 ' return res[0]\n')
248 248 nt.assert_in('see me', ip.user_ns['cTest']().test())
249 249
250 250 def test_bad_var_expand(self):
251 251 """var_expand on invalid formats shouldn't raise"""
252 252 # SyntaxError
253 253 self.assertEqual(ip.var_expand(u"{'a':5}"), u"{'a':5}")
254 254 # NameError
255 255 self.assertEqual(ip.var_expand(u"{asdf}"), u"{asdf}")
256 256 # ZeroDivisionError
257 257 self.assertEqual(ip.var_expand(u"{1/0}"), u"{1/0}")
258 258
259 259 def test_silent_postexec(self):
260 260 """run_cell(silent=True) doesn't invoke pre/post_run_cell callbacks"""
261 261 pre_explicit = mock.Mock()
262 262 pre_always = mock.Mock()
263 263 post_explicit = mock.Mock()
264 264 post_always = mock.Mock()
265 265 all_mocks = [pre_explicit, pre_always, post_explicit, post_always]
266 266
267 267 ip.events.register('pre_run_cell', pre_explicit)
268 268 ip.events.register('pre_execute', pre_always)
269 269 ip.events.register('post_run_cell', post_explicit)
270 270 ip.events.register('post_execute', post_always)
271 271
272 272 try:
273 273 ip.run_cell("1", silent=True)
274 274 assert pre_always.called
275 275 assert not pre_explicit.called
276 276 assert post_always.called
277 277 assert not post_explicit.called
278 278 # double-check that non-silent exec did what we expected
279 279 # silent to avoid
280 280 ip.run_cell("1")
281 281 assert pre_explicit.called
282 282 assert post_explicit.called
283 283 info, = pre_explicit.call_args[0]
284 284 result, = post_explicit.call_args[0]
285 285 self.assertEqual(info, result.info)
286 286 # check that post hooks are always called
287 287 [m.reset_mock() for m in all_mocks]
288 288 ip.run_cell("syntax error")
289 289 assert pre_always.called
290 290 assert pre_explicit.called
291 291 assert post_always.called
292 292 assert post_explicit.called
293 293 info, = pre_explicit.call_args[0]
294 294 result, = post_explicit.call_args[0]
295 295 self.assertEqual(info, result.info)
296 296 finally:
297 297 # remove post-exec
298 298 ip.events.unregister('pre_run_cell', pre_explicit)
299 299 ip.events.unregister('pre_execute', pre_always)
300 300 ip.events.unregister('post_run_cell', post_explicit)
301 301 ip.events.unregister('post_execute', post_always)
302 302
303 303 def test_silent_noadvance(self):
304 304 """run_cell(silent=True) doesn't advance execution_count"""
305 305 ec = ip.execution_count
306 306 # silent should force store_history=False
307 307 ip.run_cell("1", store_history=True, silent=True)
308 308
309 309 self.assertEqual(ec, ip.execution_count)
310 310 # double-check that non-silent exec did what we expected
311 311 # silent to avoid
312 312 ip.run_cell("1", store_history=True)
313 313 self.assertEqual(ec+1, ip.execution_count)
314 314
315 315 def test_silent_nodisplayhook(self):
316 316 """run_cell(silent=True) doesn't trigger displayhook"""
317 317 d = dict(called=False)
318 318
319 319 trap = ip.display_trap
320 320 save_hook = trap.hook
321 321
322 322 def failing_hook(*args, **kwargs):
323 323 d['called'] = True
324 324
325 325 try:
326 326 trap.hook = failing_hook
327 327 res = ip.run_cell("1", silent=True)
328 328 self.assertFalse(d['called'])
329 329 self.assertIsNone(res.result)
330 330 # double-check that non-silent exec did what we expected
331 331 # silent to avoid
332 332 ip.run_cell("1")
333 333 self.assertTrue(d['called'])
334 334 finally:
335 335 trap.hook = save_hook
336 336
337 337 def test_ofind_line_magic(self):
338 338 from IPython.core.magic import register_line_magic
339 339
340 340 @register_line_magic
341 341 def lmagic(line):
342 342 "A line magic"
343 343
344 344 # Get info on line magic
345 345 lfind = ip._ofind('lmagic')
346 346 info = dict(found=True, isalias=False, ismagic=True,
347 347 namespace = 'IPython internal', obj= lmagic.__wrapped__,
348 348 parent = None)
349 349 nt.assert_equal(lfind, info)
350 350
351 351 def test_ofind_cell_magic(self):
352 352 from IPython.core.magic import register_cell_magic
353 353
354 354 @register_cell_magic
355 355 def cmagic(line, cell):
356 356 "A cell magic"
357 357
358 358 # Get info on cell magic
359 359 find = ip._ofind('cmagic')
360 360 info = dict(found=True, isalias=False, ismagic=True,
361 361 namespace = 'IPython internal', obj= cmagic.__wrapped__,
362 362 parent = None)
363 363 nt.assert_equal(find, info)
364 364
365 365 def test_ofind_property_with_error(self):
366 366 class A(object):
367 367 @property
368 368 def foo(self):
369 369 raise NotImplementedError()
370 370 a = A()
371 371
372 372 found = ip._ofind('a.foo', [('locals', locals())])
373 373 info = dict(found=True, isalias=False, ismagic=False,
374 374 namespace='locals', obj=A.foo, parent=a)
375 375 nt.assert_equal(found, info)
376 376
377 377 def test_ofind_multiple_attribute_lookups(self):
378 378 class A(object):
379 379 @property
380 380 def foo(self):
381 381 raise NotImplementedError()
382 382
383 383 a = A()
384 384 a.a = A()
385 385 a.a.a = A()
386 386
387 387 found = ip._ofind('a.a.a.foo', [('locals', locals())])
388 388 info = dict(found=True, isalias=False, ismagic=False,
389 389 namespace='locals', obj=A.foo, parent=a.a.a)
390 390 nt.assert_equal(found, info)
391 391
392 392 def test_ofind_slotted_attributes(self):
393 393 class A(object):
394 394 __slots__ = ['foo']
395 395 def __init__(self):
396 396 self.foo = 'bar'
397 397
398 398 a = A()
399 399 found = ip._ofind('a.foo', [('locals', locals())])
400 400 info = dict(found=True, isalias=False, ismagic=False,
401 401 namespace='locals', obj=a.foo, parent=a)
402 402 nt.assert_equal(found, info)
403 403
404 404 found = ip._ofind('a.bar', [('locals', locals())])
405 405 info = dict(found=False, isalias=False, ismagic=False,
406 406 namespace=None, obj=None, parent=a)
407 407 nt.assert_equal(found, info)
408 408
409 409 def test_ofind_prefers_property_to_instance_level_attribute(self):
410 410 class A(object):
411 411 @property
412 412 def foo(self):
413 413 return 'bar'
414 414 a = A()
415 415 a.__dict__['foo'] = 'baz'
416 416 nt.assert_equal(a.foo, 'bar')
417 417 found = ip._ofind('a.foo', [('locals', locals())])
418 418 nt.assert_is(found['obj'], A.foo)
419 419
420 420 def test_custom_syntaxerror_exception(self):
421 421 called = []
422 422 def my_handler(shell, etype, value, tb, tb_offset=None):
423 423 called.append(etype)
424 424 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
425 425
426 426 ip.set_custom_exc((SyntaxError,), my_handler)
427 427 try:
428 428 ip.run_cell("1f")
429 429 # Check that this was called, and only once.
430 430 self.assertEqual(called, [SyntaxError])
431 431 finally:
432 432 # Reset the custom exception hook
433 433 ip.set_custom_exc((), None)
434 434
435 435 def test_custom_exception(self):
436 436 called = []
437 437 def my_handler(shell, etype, value, tb, tb_offset=None):
438 438 called.append(etype)
439 439 shell.showtraceback((etype, value, tb), tb_offset=tb_offset)
440 440
441 441 ip.set_custom_exc((ValueError,), my_handler)
442 442 try:
443 443 res = ip.run_cell("raise ValueError('test')")
444 444 # Check that this was called, and only once.
445 445 self.assertEqual(called, [ValueError])
446 446 # Check that the error is on the result object
447 447 self.assertIsInstance(res.error_in_exec, ValueError)
448 448 finally:
449 449 # Reset the custom exception hook
450 450 ip.set_custom_exc((), None)
451 451
452 452 def test_mktempfile(self):
453 453 filename = ip.mktempfile()
454 454 # Check that we can open the file again on Windows
455 455 with open(filename, 'w') as f:
456 456 f.write('abc')
457 457
458 458 filename = ip.mktempfile(data='blah')
459 459 with open(filename, 'r') as f:
460 460 self.assertEqual(f.read(), 'blah')
461 461
462 462 def test_new_main_mod(self):
463 463 # Smoketest to check that this accepts a unicode module name
464 464 name = u'jiefmw'
465 465 mod = ip.new_main_mod(u'%s.py' % name, name)
466 466 self.assertEqual(mod.__name__, name)
467 467
468 468 def test_get_exception_only(self):
469 469 try:
470 470 raise KeyboardInterrupt
471 471 except KeyboardInterrupt:
472 472 msg = ip.get_exception_only()
473 473 self.assertEqual(msg, 'KeyboardInterrupt\n')
474 474
475 475 try:
476 476 raise DerivedInterrupt("foo")
477 477 except KeyboardInterrupt:
478 478 msg = ip.get_exception_only()
479 479 self.assertEqual(msg, 'IPython.core.tests.test_interactiveshell.DerivedInterrupt: foo\n')
480 480
481 481 def test_inspect_text(self):
482 482 ip.run_cell('a = 5')
483 483 text = ip.object_inspect_text('a')
484 484 self.assertIsInstance(text, str)
485 485
486 486 def test_last_execution_result(self):
487 487 """ Check that last execution result gets set correctly (GH-10702) """
488 488 result = ip.run_cell('a = 5; a')
489 489 self.assertTrue(ip.last_execution_succeeded)
490 490 self.assertEqual(ip.last_execution_result.result, 5)
491 491
492 492 result = ip.run_cell('a = x_invalid_id_x')
493 493 self.assertFalse(ip.last_execution_succeeded)
494 494 self.assertFalse(ip.last_execution_result.success)
495 495 self.assertIsInstance(ip.last_execution_result.error_in_exec, NameError)
496 496
497 497 def test_reset_aliasing(self):
498 498 """ Check that standard posix aliases work after %reset. """
499 499 if os.name != 'posix':
500 500 return
501 501
502 502 ip.reset()
503 503 for cmd in ('clear', 'more', 'less', 'man'):
504 504 res = ip.run_cell('%' + cmd)
505 505 self.assertEqual(res.success, True)
506 506
507 507
508 508 class TestSafeExecfileNonAsciiPath(unittest.TestCase):
509 509
510 510 @onlyif_unicode_paths
511 511 def setUp(self):
512 512 self.BASETESTDIR = tempfile.mkdtemp()
513 513 self.TESTDIR = join(self.BASETESTDIR, u"Γ₯Àâ")
514 514 os.mkdir(self.TESTDIR)
515 515 with open(join(self.TESTDIR, u"Γ₯Àâtestscript.py"), "w") as sfile:
516 516 sfile.write("pass\n")
517 517 self.oldpath = os.getcwd()
518 518 os.chdir(self.TESTDIR)
519 519 self.fname = u"Γ₯Àâtestscript.py"
520 520
521 521 def tearDown(self):
522 522 os.chdir(self.oldpath)
523 523 shutil.rmtree(self.BASETESTDIR)
524 524
525 525 @onlyif_unicode_paths
526 526 def test_1(self):
527 527 """Test safe_execfile with non-ascii path
528 528 """
529 529 ip.safe_execfile(self.fname, {}, raise_exceptions=True)
530 530
531 531 class ExitCodeChecks(tt.TempFileMixin):
532 532
533 533 def setUp(self):
534 534 self.system = ip.system_raw
535 535
536 536 def test_exit_code_ok(self):
537 537 self.system('exit 0')
538 538 self.assertEqual(ip.user_ns['_exit_code'], 0)
539 539
540 540 def test_exit_code_error(self):
541 541 self.system('exit 1')
542 542 self.assertEqual(ip.user_ns['_exit_code'], 1)
543 543
544 544 @skipif(not hasattr(signal, 'SIGALRM'))
545 545 def test_exit_code_signal(self):
546 546 self.mktmp("import signal, time\n"
547 547 "signal.setitimer(signal.ITIMER_REAL, 0.1)\n"
548 548 "time.sleep(1)\n")
549 549 self.system("%s %s" % (sys.executable, self.fname))
550 550 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGALRM)
551 551
552 552 @onlyif_cmds_exist("csh")
553 553 def test_exit_code_signal_csh(self):
554 554 SHELL = os.environ.get('SHELL', None)
555 555 os.environ['SHELL'] = find_cmd("csh")
556 556 try:
557 557 self.test_exit_code_signal()
558 558 finally:
559 559 if SHELL is not None:
560 560 os.environ['SHELL'] = SHELL
561 561 else:
562 562 del os.environ['SHELL']
563 563
564 564
565 565 class TestSystemRaw(ExitCodeChecks):
566 566
567 567 def setUp(self):
568 568 super().setUp()
569 569 self.system = ip.system_raw
570 570
571 571 @onlyif_unicode_paths
572 572 def test_1(self):
573 573 """Test system_raw with non-ascii cmd
574 574 """
575 575 cmd = u'''python -c "'Γ₯Àâ'" '''
576 576 ip.system_raw(cmd)
577 577
578 578 @mock.patch('subprocess.call', side_effect=KeyboardInterrupt)
579 579 @mock.patch('os.system', side_effect=KeyboardInterrupt)
580 580 def test_control_c(self, *mocks):
581 581 try:
582 582 self.system("sleep 1 # wont happen")
583 583 except KeyboardInterrupt:
584 584 self.fail("system call should intercept "
585 585 "keyboard interrupt from subprocess.call")
586 586 self.assertEqual(ip.user_ns['_exit_code'], -signal.SIGINT)
587 587
588 588 # TODO: Exit codes are currently ignored on Windows.
589 589 class TestSystemPipedExitCode(ExitCodeChecks):
590 590
591 591 def setUp(self):
592 592 super().setUp()
593 593 self.system = ip.system_piped
594 594
595 595 @skip_win32
596 596 def test_exit_code_ok(self):
597 597 ExitCodeChecks.test_exit_code_ok(self)
598 598
599 599 @skip_win32
600 600 def test_exit_code_error(self):
601 601 ExitCodeChecks.test_exit_code_error(self)
602 602
603 603 @skip_win32
604 604 def test_exit_code_signal(self):
605 605 ExitCodeChecks.test_exit_code_signal(self)
606 606
607 607 class TestModules(tt.TempFileMixin):
608 608 def test_extraneous_loads(self):
609 609 """Test we're not loading modules on startup that we shouldn't.
610 610 """
611 611 self.mktmp("import sys\n"
612 612 "print('numpy' in sys.modules)\n"
613 613 "print('ipyparallel' in sys.modules)\n"
614 614 "print('ipykernel' in sys.modules)\n"
615 615 )
616 616 out = "False\nFalse\nFalse\n"
617 617 tt.ipexec_validate(self.fname, out)
618 618
619 619 class Negator(ast.NodeTransformer):
620 620 """Negates all number literals in an AST."""
621 621
622 622 # for python 3.7 and earlier
623 623 def visit_Num(self, node):
624 624 node.n = -node.n
625 625 return node
626 626
627 627 # for python 3.8+
628 628 def visit_Constant(self, node):
629 629 if isinstance(node.value, int):
630 630 return self.visit_Num(node)
631 631 return node
632 632
633 633 class TestAstTransform(unittest.TestCase):
634 634 def setUp(self):
635 635 self.negator = Negator()
636 636 ip.ast_transformers.append(self.negator)
637 637
638 638 def tearDown(self):
639 639 ip.ast_transformers.remove(self.negator)
640 640
641 641 def test_run_cell(self):
642 642 with tt.AssertPrints('-34'):
643 643 ip.run_cell('print (12 + 22)')
644 644
645 645 # A named reference to a number shouldn't be transformed.
646 646 ip.user_ns['n'] = 55
647 647 with tt.AssertNotPrints('-55'):
648 648 ip.run_cell('print (n)')
649 649
650 650 def test_timeit(self):
651 651 called = set()
652 652 def f(x):
653 653 called.add(x)
654 654 ip.push({'f':f})
655 655
656 656 with tt.AssertPrints("std. dev. of"):
657 657 ip.run_line_magic("timeit", "-n1 f(1)")
658 658 self.assertEqual(called, {-1})
659 659 called.clear()
660 660
661 661 with tt.AssertPrints("std. dev. of"):
662 662 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
663 663 self.assertEqual(called, {-2, -3})
664 664
665 665 def test_time(self):
666 666 called = []
667 667 def f(x):
668 668 called.append(x)
669 669 ip.push({'f':f})
670 670
671 671 # Test with an expression
672 672 with tt.AssertPrints("Wall time: "):
673 673 ip.run_line_magic("time", "f(5+9)")
674 674 self.assertEqual(called, [-14])
675 675 called[:] = []
676 676
677 677 # Test with a statement (different code path)
678 678 with tt.AssertPrints("Wall time: "):
679 679 ip.run_line_magic("time", "a = f(-3 + -2)")
680 680 self.assertEqual(called, [5])
681 681
682 682 def test_macro(self):
683 683 ip.push({'a':10})
684 684 # The AST transformation makes this do a+=-1
685 685 ip.define_macro("amacro", "a+=1\nprint(a)")
686 686
687 687 with tt.AssertPrints("9"):
688 688 ip.run_cell("amacro")
689 689 with tt.AssertPrints("8"):
690 690 ip.run_cell("amacro")
691 691
692 692 class IntegerWrapper(ast.NodeTransformer):
693 693 """Wraps all integers in a call to Integer()"""
694 694
695 695 # for Python 3.7 and earlier
696 696
697 697 # for Python 3.7 and earlier
698 698 def visit_Num(self, node):
699 699 if isinstance(node.n, int):
700 700 return ast.Call(func=ast.Name(id='Integer', ctx=ast.Load()),
701 701 args=[node], keywords=[])
702 702 return node
703 703
704 704 # For Python 3.8+
705 705 def visit_Constant(self, node):
706 706 if isinstance(node.value, int):
707 707 return self.visit_Num(node)
708 708 return node
709 709
710 710
711 711 class TestAstTransform2(unittest.TestCase):
712 712 def setUp(self):
713 713 self.intwrapper = IntegerWrapper()
714 714 ip.ast_transformers.append(self.intwrapper)
715 715
716 716 self.calls = []
717 717 def Integer(*args):
718 718 self.calls.append(args)
719 719 return args
720 720 ip.push({"Integer": Integer})
721 721
722 722 def tearDown(self):
723 723 ip.ast_transformers.remove(self.intwrapper)
724 724 del ip.user_ns['Integer']
725 725
726 726 def test_run_cell(self):
727 727 ip.run_cell("n = 2")
728 728 self.assertEqual(self.calls, [(2,)])
729 729
730 730 # This shouldn't throw an error
731 731 ip.run_cell("o = 2.0")
732 732 self.assertEqual(ip.user_ns['o'], 2.0)
733 733
734 734 def test_timeit(self):
735 735 called = set()
736 736 def f(x):
737 737 called.add(x)
738 738 ip.push({'f':f})
739 739
740 740 with tt.AssertPrints("std. dev. of"):
741 741 ip.run_line_magic("timeit", "-n1 f(1)")
742 742 self.assertEqual(called, {(1,)})
743 743 called.clear()
744 744
745 745 with tt.AssertPrints("std. dev. of"):
746 746 ip.run_cell_magic("timeit", "-n1 f(2)", "f(3)")
747 747 self.assertEqual(called, {(2,), (3,)})
748 748
749 749 class ErrorTransformer(ast.NodeTransformer):
750 750 """Throws an error when it sees a number."""
751 751
752 752 # for Python 3.7 and earlier
753 753 def visit_Num(self, node):
754 754 raise ValueError("test")
755 755
756 756 # for Python 3.8+
757 757 def visit_Constant(self, node):
758 758 if isinstance(node.value, int):
759 759 return self.visit_Num(node)
760 760 return node
761 761
762 762
763 763 class TestAstTransformError(unittest.TestCase):
764 764 def test_unregistering(self):
765 765 err_transformer = ErrorTransformer()
766 766 ip.ast_transformers.append(err_transformer)
767 767
768 768 with self.assertWarnsRegex(UserWarning, "It will be unregistered"):
769 769 ip.run_cell("1 + 2")
770 770
771 771 # This should have been removed.
772 772 nt.assert_not_in(err_transformer, ip.ast_transformers)
773 773
774 774
775 775 class StringRejector(ast.NodeTransformer):
776 776 """Throws an InputRejected when it sees a string literal.
777 777
778 778 Used to verify that NodeTransformers can signal that a piece of code should
779 779 not be executed by throwing an InputRejected.
780 780 """
781 781
782 782 #for python 3.7 and earlier
783 783 def visit_Str(self, node):
784 784 raise InputRejected("test")
785 785
786 786 # 3.8 only
787 787 def visit_Constant(self, node):
788 788 if isinstance(node.value, str):
789 789 raise InputRejected("test")
790 790 return node
791 791
792 792
793 793 class TestAstTransformInputRejection(unittest.TestCase):
794 794
795 795 def setUp(self):
796 796 self.transformer = StringRejector()
797 797 ip.ast_transformers.append(self.transformer)
798 798
799 799 def tearDown(self):
800 800 ip.ast_transformers.remove(self.transformer)
801 801
802 802 def test_input_rejection(self):
803 803 """Check that NodeTransformers can reject input."""
804 804
805 805 expect_exception_tb = tt.AssertPrints("InputRejected: test")
806 806 expect_no_cell_output = tt.AssertNotPrints("'unsafe'", suppress=False)
807 807
808 808 # Run the same check twice to verify that the transformer is not
809 809 # disabled after raising.
810 810 with expect_exception_tb, expect_no_cell_output:
811 811 ip.run_cell("'unsafe'")
812 812
813 813 with expect_exception_tb, expect_no_cell_output:
814 814 res = ip.run_cell("'unsafe'")
815 815
816 816 self.assertIsInstance(res.error_before_exec, InputRejected)
817 817
818 818 def test__IPYTHON__():
819 819 # This shouldn't raise a NameError, that's all
820 820 __IPYTHON__
821 821
822 822
823 823 class DummyRepr(object):
824 824 def __repr__(self):
825 825 return "DummyRepr"
826 826
827 827 def _repr_html_(self):
828 828 return "<b>dummy</b>"
829 829
830 830 def _repr_javascript_(self):
831 831 return "console.log('hi');", {'key': 'value'}
832 832
833 833
834 834 def test_user_variables():
835 835 # enable all formatters
836 836 ip.display_formatter.active_types = ip.display_formatter.format_types
837 837
838 838 ip.user_ns['dummy'] = d = DummyRepr()
839 839 keys = {'dummy', 'doesnotexist'}
840 840 r = ip.user_expressions({ key:key for key in keys})
841 841
842 842 nt.assert_equal(keys, set(r.keys()))
843 843 dummy = r['dummy']
844 844 nt.assert_equal({'status', 'data', 'metadata'}, set(dummy.keys()))
845 845 nt.assert_equal(dummy['status'], 'ok')
846 846 data = dummy['data']
847 847 metadata = dummy['metadata']
848 848 nt.assert_equal(data.get('text/html'), d._repr_html_())
849 849 js, jsmd = d._repr_javascript_()
850 850 nt.assert_equal(data.get('application/javascript'), js)
851 851 nt.assert_equal(metadata.get('application/javascript'), jsmd)
852 852
853 853 dne = r['doesnotexist']
854 854 nt.assert_equal(dne['status'], 'error')
855 855 nt.assert_equal(dne['ename'], 'NameError')
856 856
857 857 # back to text only
858 858 ip.display_formatter.active_types = ['text/plain']
859 859
860 860 def test_user_expression():
861 861 # enable all formatters
862 862 ip.display_formatter.active_types = ip.display_formatter.format_types
863 863 query = {
864 864 'a' : '1 + 2',
865 865 'b' : '1/0',
866 866 }
867 867 r = ip.user_expressions(query)
868 868 import pprint
869 869 pprint.pprint(r)
870 870 nt.assert_equal(set(r.keys()), set(query.keys()))
871 871 a = r['a']
872 872 nt.assert_equal({'status', 'data', 'metadata'}, set(a.keys()))
873 873 nt.assert_equal(a['status'], 'ok')
874 874 data = a['data']
875 875 metadata = a['metadata']
876 876 nt.assert_equal(data.get('text/plain'), '3')
877 877
878 878 b = r['b']
879 879 nt.assert_equal(b['status'], 'error')
880 880 nt.assert_equal(b['ename'], 'ZeroDivisionError')
881 881
882 882 # back to text only
883 883 ip.display_formatter.active_types = ['text/plain']
884 884
885 885
886 886 class TestSyntaxErrorTransformer(unittest.TestCase):
887 887 """Check that SyntaxError raised by an input transformer is handled by run_cell()"""
888 888
889 889 @staticmethod
890 890 def transformer(lines):
891 891 for line in lines:
892 892 pos = line.find('syntaxerror')
893 893 if pos >= 0:
894 894 e = SyntaxError('input contains "syntaxerror"')
895 895 e.text = line
896 896 e.offset = pos + 1
897 897 raise e
898 898 return lines
899 899
900 900 def setUp(self):
901 901 ip.input_transformers_post.append(self.transformer)
902 902
903 903 def tearDown(self):
904 904 ip.input_transformers_post.remove(self.transformer)
905 905
906 906 def test_syntaxerror_input_transformer(self):
907 907 with tt.AssertPrints('1234'):
908 908 ip.run_cell('1234')
909 909 with tt.AssertPrints('SyntaxError: invalid syntax'):
910 910 ip.run_cell('1 2 3') # plain python syntax error
911 911 with tt.AssertPrints('SyntaxError: input contains "syntaxerror"'):
912 912 ip.run_cell('2345 # syntaxerror') # input transformer syntax error
913 913 with tt.AssertPrints('3456'):
914 914 ip.run_cell('3456')
915 915
916 916
917 917 class TestWarningSuppression(unittest.TestCase):
918 918 def test_warning_suppression(self):
919 919 ip.run_cell("import warnings")
920 920 try:
921 921 with self.assertWarnsRegex(UserWarning, "asdf"):
922 922 ip.run_cell("warnings.warn('asdf')")
923 923 # Here's the real test -- if we run that again, we should get the
924 924 # warning again. Traditionally, each warning was only issued once per
925 925 # IPython session (approximately), even if the user typed in new and
926 926 # different code that should have also triggered the warning, leading
927 927 # to much confusion.
928 928 with self.assertWarnsRegex(UserWarning, "asdf"):
929 929 ip.run_cell("warnings.warn('asdf')")
930 930 finally:
931 931 ip.run_cell("del warnings")
932 932
933 933
934 934 def test_deprecation_warning(self):
935 935 ip.run_cell("""
936 936 import warnings
937 937 def wrn():
938 938 warnings.warn(
939 939 "I AM A WARNING",
940 940 DeprecationWarning
941 941 )
942 942 """)
943 943 try:
944 944 with self.assertWarnsRegex(DeprecationWarning, "I AM A WARNING"):
945 945 ip.run_cell("wrn()")
946 946 finally:
947 947 ip.run_cell("del warnings")
948 948 ip.run_cell("del wrn")
949 949
950 950
951 951 class TestImportNoDeprecate(tt.TempFileMixin):
952 952
953 953 def setUp(self):
954 954 """Make a valid python temp file."""
955 955 self.mktmp("""
956 956 import warnings
957 957 def wrn():
958 958 warnings.warn(
959 959 "I AM A WARNING",
960 960 DeprecationWarning
961 961 )
962 962 """)
963 963 super().setUp()
964 964
965 965 def test_no_dep(self):
966 966 """
967 967 No deprecation warning should be raised from imported functions
968 968 """
969 969 ip.run_cell("from {} import wrn".format(self.fname))
970 970
971 971 with tt.AssertNotPrints("I AM A WARNING"):
972 972 ip.run_cell("wrn()")
973 973 ip.run_cell("del wrn")
974 974
975 975
976 976 def test_custom_exc_count():
977 977 hook = mock.Mock(return_value=None)
978 978 ip.set_custom_exc((SyntaxError,), hook)
979 979 before = ip.execution_count
980 980 ip.run_cell("def foo()", store_history=True)
981 981 # restore default excepthook
982 982 ip.set_custom_exc((), None)
983 983 nt.assert_equal(hook.call_count, 1)
984 984 nt.assert_equal(ip.execution_count, before + 1)
985 985
986 986
987 987 def test_run_cell_async():
988 988 loop = asyncio.get_event_loop()
989 989 ip.run_cell("import asyncio")
990 990 coro = ip.run_cell_async("await asyncio.sleep(0.01)\n5")
991 991 assert asyncio.iscoroutine(coro)
992 992 result = loop.run_until_complete(coro)
993 993 assert isinstance(result, interactiveshell.ExecutionResult)
994 994 assert result.result == 5
995 995
996 996
997 997 def test_should_run_async():
998 998 assert not ip.should_run_async("a = 5")
999 999 assert ip.should_run_async("await x")
1000 1000 assert ip.should_run_async("import asyncio; await asyncio.sleep(1)")
1001
1002
1003 def test_set_custom_completer():
1004 num_completers = len(ip.Completer.matchers)
1005
1006 def foo(*args, **kwargs):
1007 return "I'm a completer!"
1008
1009 ip.set_custom_completer(foo, 0)
1010
1011 # check that we've really added a new completer
1012 assert len(ip.Completer.matchers) == num_completers + 1
1013
1014 # check that the first completer is the function we defined
1015 assert ip.Completer.matchers[0]() == "I'm a completer!"
1016
1017 # clean up
1018 ip.Completer.custom_matchers.pop()
General Comments 0
You need to be logged in to leave comments. Login now