##// END OF EJS Templates
Revert "Backport PR #12207 on branch 7.x (Bump jedi to at least 0.16.0 and fix deprecated function usage)"
Matthias Bussonnier -
Show More
@@ -1,2093 +1,2092 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 629 self.custom_matchers = []
630 630
631 631 super(Completer, self).__init__(**kwargs)
632 632
633 633 def complete(self, text, state):
634 634 """Return the next possible completion for 'text'.
635 635
636 636 This is called successively with state == 0, 1, 2, ... until it
637 637 returns None. The completion should begin with 'text'.
638 638
639 639 """
640 640 if self.use_main_ns:
641 641 self.namespace = __main__.__dict__
642 642
643 643 if state == 0:
644 644 if "." in text:
645 645 self.matches = self.attr_matches(text)
646 646 else:
647 647 self.matches = self.global_matches(text)
648 648 try:
649 649 return self.matches[state]
650 650 except IndexError:
651 651 return None
652 652
653 653 def global_matches(self, text):
654 654 """Compute matches when text is a simple name.
655 655
656 656 Return a list of all keywords, built-in functions and names currently
657 657 defined in self.namespace or self.global_namespace that match.
658 658
659 659 """
660 660 matches = []
661 661 match_append = matches.append
662 662 n = len(text)
663 663 for lst in [keyword.kwlist,
664 664 builtin_mod.__dict__.keys(),
665 665 self.namespace.keys(),
666 666 self.global_namespace.keys()]:
667 667 for word in lst:
668 668 if word[:n] == text and word != "__builtins__":
669 669 match_append(word)
670 670
671 671 snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z")
672 672 for lst in [self.namespace.keys(),
673 673 self.global_namespace.keys()]:
674 674 shortened = {"_".join([sub[0] for sub in word.split('_')]) : word
675 675 for word in lst if snake_case_re.match(word)}
676 676 for word in shortened.keys():
677 677 if word[:n] == text and word != "__builtins__":
678 678 match_append(shortened[word])
679 679 return matches
680 680
681 681 def attr_matches(self, text):
682 682 """Compute matches when text contains a dot.
683 683
684 684 Assuming the text is of the form NAME.NAME....[NAME], and is
685 685 evaluatable in self.namespace or self.global_namespace, it will be
686 686 evaluated and its attributes (as revealed by dir()) are used as
687 687 possible completions. (For class instances, class members are
688 688 also considered.)
689 689
690 690 WARNING: this can still invoke arbitrary C code, if an object
691 691 with a __getattr__ hook is evaluated.
692 692
693 693 """
694 694
695 695 # Another option, seems to work great. Catches things like ''.<tab>
696 696 m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text)
697 697
698 698 if m:
699 699 expr, attr = m.group(1, 3)
700 700 elif self.greedy:
701 701 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
702 702 if not m2:
703 703 return []
704 704 expr, attr = m2.group(1,2)
705 705 else:
706 706 return []
707 707
708 708 try:
709 709 obj = eval(expr, self.namespace)
710 710 except:
711 711 try:
712 712 obj = eval(expr, self.global_namespace)
713 713 except:
714 714 return []
715 715
716 716 if self.limit_to__all__ and hasattr(obj, '__all__'):
717 717 words = get__all__entries(obj)
718 718 else:
719 719 words = dir2(obj)
720 720
721 721 try:
722 722 words = generics.complete_object(obj, words)
723 723 except TryNext:
724 724 pass
725 725 except AssertionError:
726 726 raise
727 727 except Exception:
728 728 # Silence errors from completion function
729 729 #raise # dbg
730 730 pass
731 731 # Build match list to return
732 732 n = len(attr)
733 733 return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ]
734 734
735 735
736 736 def get__all__entries(obj):
737 737 """returns the strings in the __all__ attribute"""
738 738 try:
739 739 words = getattr(obj, '__all__')
740 740 except:
741 741 return []
742 742
743 743 return [w for w in words if isinstance(w, str)]
744 744
745 745
746 746 def match_dict_keys(keys: List[str], prefix: str, delims: str):
747 747 """Used by dict_key_matches, matching the prefix to a list of keys
748 748
749 749 Parameters
750 750 ==========
751 751 keys:
752 752 list of keys in dictionary currently being completed.
753 753 prefix:
754 754 Part of the text already typed by the user. e.g. `mydict[b'fo`
755 755 delims:
756 756 String of delimiters to consider when finding the current key.
757 757
758 758 Returns
759 759 =======
760 760
761 761 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
762 762 ``quote`` being the quote that need to be used to close current string.
763 763 ``token_start`` the position where the replacement should start occurring,
764 764 ``matches`` a list of replacement/completion
765 765
766 766 """
767 767 if not prefix:
768 768 return None, 0, [repr(k) for k in keys
769 769 if isinstance(k, (str, bytes))]
770 770 quote_match = re.search('["\']', prefix)
771 771 quote = quote_match.group()
772 772 try:
773 773 prefix_str = eval(prefix + quote, {})
774 774 except Exception:
775 775 return None, 0, []
776 776
777 777 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
778 778 token_match = re.search(pattern, prefix, re.UNICODE)
779 779 token_start = token_match.start()
780 780 token_prefix = token_match.group()
781 781
782 782 matched = []
783 783 for key in keys:
784 784 try:
785 785 if not key.startswith(prefix_str):
786 786 continue
787 787 except (AttributeError, TypeError, UnicodeError):
788 788 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
789 789 continue
790 790
791 791 # reformat remainder of key to begin with prefix
792 792 rem = key[len(prefix_str):]
793 793 # force repr wrapped in '
794 794 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
795 795 if rem_repr.startswith('u') and prefix[0] not in 'uU':
796 796 # Found key is unicode, but prefix is Py2 string.
797 797 # Therefore attempt to interpret key as string.
798 798 try:
799 799 rem_repr = repr(rem.encode('ascii') + '"')
800 800 except UnicodeEncodeError:
801 801 continue
802 802
803 803 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
804 804 if quote == '"':
805 805 # The entered prefix is quoted with ",
806 806 # but the match is quoted with '.
807 807 # A contained " hence needs escaping for comparison:
808 808 rem_repr = rem_repr.replace('"', '\\"')
809 809
810 810 # then reinsert prefix from start of token
811 811 matched.append('%s%s' % (token_prefix, rem_repr))
812 812 return quote, token_start, matched
813 813
814 814
815 815 def cursor_to_position(text:str, line:int, column:int)->int:
816 816 """
817 817
818 818 Convert the (line,column) position of the cursor in text to an offset in a
819 819 string.
820 820
821 821 Parameters
822 822 ----------
823 823
824 824 text : str
825 825 The text in which to calculate the cursor offset
826 826 line : int
827 827 Line of the cursor; 0-indexed
828 828 column : int
829 829 Column of the cursor 0-indexed
830 830
831 831 Return
832 832 ------
833 833 Position of the cursor in ``text``, 0-indexed.
834 834
835 835 See Also
836 836 --------
837 837 position_to_cursor: reciprocal of this function
838 838
839 839 """
840 840 lines = text.split('\n')
841 841 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
842 842
843 843 return sum(len(l) + 1 for l in lines[:line]) + column
844 844
845 845 def position_to_cursor(text:str, offset:int)->Tuple[int, int]:
846 846 """
847 847 Convert the position of the cursor in text (0 indexed) to a line
848 848 number(0-indexed) and a column number (0-indexed) pair
849 849
850 850 Position should be a valid position in ``text``.
851 851
852 852 Parameters
853 853 ----------
854 854
855 855 text : str
856 856 The text in which to calculate the cursor offset
857 857 offset : int
858 858 Position of the cursor in ``text``, 0-indexed.
859 859
860 860 Return
861 861 ------
862 862 (line, column) : (int, int)
863 863 Line of the cursor; 0-indexed, column of the cursor 0-indexed
864 864
865 865
866 866 See Also
867 867 --------
868 868 cursor_to_position : reciprocal of this function
869 869
870 870
871 871 """
872 872
873 873 assert 0 <= offset <= len(text) , "0 <= %s <= %s" % (offset , len(text))
874 874
875 875 before = text[:offset]
876 876 blines = before.split('\n') # ! splitnes trim trailing \n
877 877 line = before.count('\n')
878 878 col = len(blines[-1])
879 879 return line, col
880 880
881 881
882 882 def _safe_isinstance(obj, module, class_name):
883 883 """Checks if obj is an instance of module.class_name if loaded
884 884 """
885 885 return (module in sys.modules and
886 886 isinstance(obj, getattr(import_module(module), class_name)))
887 887
888 888
889 889 def back_unicode_name_matches(text):
890 890 u"""Match unicode characters back to unicode name
891 891
892 892 This does ``β˜ƒ`` -> ``\\snowman``
893 893
894 894 Note that snowman is not a valid python3 combining character but will be expanded.
895 895 Though it will not recombine back to the snowman character by the completion machinery.
896 896
897 897 This will not either back-complete standard sequences like \\n, \\b ...
898 898
899 899 Used on Python 3 only.
900 900 """
901 901 if len(text)<2:
902 902 return u'', ()
903 903 maybe_slash = text[-2]
904 904 if maybe_slash != '\\':
905 905 return u'', ()
906 906
907 907 char = text[-1]
908 908 # no expand on quote for completion in strings.
909 909 # nor backcomplete standard ascii keys
910 910 if char in string.ascii_letters or char in ['"',"'"]:
911 911 return u'', ()
912 912 try :
913 913 unic = unicodedata.name(char)
914 914 return '\\'+char,['\\'+unic]
915 915 except KeyError:
916 916 pass
917 917 return u'', ()
918 918
919 919 def back_latex_name_matches(text:str):
920 920 """Match latex characters back to unicode name
921 921
922 922 This does ``\\β„΅`` -> ``\\aleph``
923 923
924 924 Used on Python 3 only.
925 925 """
926 926 if len(text)<2:
927 927 return u'', ()
928 928 maybe_slash = text[-2]
929 929 if maybe_slash != '\\':
930 930 return u'', ()
931 931
932 932
933 933 char = text[-1]
934 934 # no expand on quote for completion in strings.
935 935 # nor backcomplete standard ascii keys
936 936 if char in string.ascii_letters or char in ['"',"'"]:
937 937 return u'', ()
938 938 try :
939 939 latex = reverse_latex_symbol[char]
940 940 # '\\' replace the \ as well
941 941 return '\\'+char,[latex]
942 942 except KeyError:
943 943 pass
944 944 return u'', ()
945 945
946 946
947 947 def _formatparamchildren(parameter) -> str:
948 948 """
949 949 Get parameter name and value from Jedi Private API
950 950
951 951 Jedi does not expose a simple way to get `param=value` from its API.
952 952
953 953 Parameter
954 954 =========
955 955
956 956 parameter:
957 957 Jedi's function `Param`
958 958
959 959 Returns
960 960 =======
961 961
962 962 A string like 'a', 'b=1', '*args', '**kwargs'
963 963
964 964
965 965 """
966 966 description = parameter.description
967 967 if not description.startswith('param '):
968 968 raise ValueError('Jedi function parameter description have change format.'
969 969 'Expected "param ...", found %r".' % description)
970 970 return description[6:]
971 971
972 972 def _make_signature(completion)-> str:
973 973 """
974 974 Make the signature from a jedi completion
975 975
976 976 Parameter
977 977 =========
978 978
979 979 completion: jedi.Completion
980 980 object does not complete a function type
981 981
982 982 Returns
983 983 =======
984 984
985 985 a string consisting of the function signature, with the parenthesis but
986 986 without the function name. example:
987 987 `(a, *args, b=1, **kwargs)`
988 988
989 989 """
990 990
991 return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for signature in completion.get_signatures()
992 for p in signature.defined_names()) if f])
991 return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f])
993 992
994 993 class IPCompleter(Completer):
995 994 """Extension of the completer class with IPython-specific features"""
996 995
997 996 _names = None
998 997
999 998 @observe('greedy')
1000 999 def _greedy_changed(self, change):
1001 1000 """update the splitter and readline delims when greedy is changed"""
1002 1001 if change['new']:
1003 1002 self.splitter.delims = GREEDY_DELIMS
1004 1003 else:
1005 1004 self.splitter.delims = DELIMS
1006 1005
1007 1006 dict_keys_only = Bool(False,
1008 1007 help="""Whether to show dict key matches only""")
1009 1008
1010 1009 merge_completions = Bool(True,
1011 1010 help="""Whether to merge completion results into a single list
1012 1011
1013 1012 If False, only the completion results from the first non-empty
1014 1013 completer will be returned.
1015 1014 """
1016 1015 ).tag(config=True)
1017 1016 omit__names = Enum((0,1,2), default_value=2,
1018 1017 help="""Instruct the completer to omit private method names
1019 1018
1020 1019 Specifically, when completing on ``object.<tab>``.
1021 1020
1022 1021 When 2 [default]: all names that start with '_' will be excluded.
1023 1022
1024 1023 When 1: all 'magic' names (``__foo__``) will be excluded.
1025 1024
1026 1025 When 0: nothing will be excluded.
1027 1026 """
1028 1027 ).tag(config=True)
1029 1028 limit_to__all__ = Bool(False,
1030 1029 help="""
1031 1030 DEPRECATED as of version 5.0.
1032 1031
1033 1032 Instruct the completer to use __all__ for the completion
1034 1033
1035 1034 Specifically, when completing on ``object.<tab>``.
1036 1035
1037 1036 When True: only those names in obj.__all__ will be included.
1038 1037
1039 1038 When False [default]: the __all__ attribute is ignored
1040 1039 """,
1041 1040 ).tag(config=True)
1042 1041
1043 1042 @observe('limit_to__all__')
1044 1043 def _limit_to_all_changed(self, change):
1045 1044 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
1046 1045 'value has been deprecated since IPython 5.0, will be made to have '
1047 1046 'no effects and then removed in future version of IPython.',
1048 1047 UserWarning)
1049 1048
1050 1049 def __init__(self, shell=None, namespace=None, global_namespace=None,
1051 1050 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
1052 1051 """IPCompleter() -> completer
1053 1052
1054 1053 Return a completer object.
1055 1054
1056 1055 Parameters
1057 1056 ----------
1058 1057
1059 1058 shell
1060 1059 a pointer to the ipython shell itself. This is needed
1061 1060 because this completer knows about magic functions, and those can
1062 1061 only be accessed via the ipython instance.
1063 1062
1064 1063 namespace : dict, optional
1065 1064 an optional dict where completions are performed.
1066 1065
1067 1066 global_namespace : dict, optional
1068 1067 secondary optional dict for completions, to
1069 1068 handle cases (such as IPython embedded inside functions) where
1070 1069 both Python scopes are visible.
1071 1070
1072 1071 use_readline : bool, optional
1073 1072 DEPRECATED, ignored since IPython 6.0, will have no effects
1074 1073 """
1075 1074
1076 1075 self.magic_escape = ESC_MAGIC
1077 1076 self.splitter = CompletionSplitter()
1078 1077
1079 1078 if use_readline is not _deprecation_readline_sentinel:
1080 1079 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1081 1080 DeprecationWarning, stacklevel=2)
1082 1081
1083 1082 # _greedy_changed() depends on splitter and readline being defined:
1084 1083 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1085 1084 config=config, **kwargs)
1086 1085
1087 1086 # List where completion matches will be stored
1088 1087 self.matches = []
1089 1088 self.shell = shell
1090 1089 # Regexp to split filenames with spaces in them
1091 1090 self.space_name_re = re.compile(r'([^\\] )')
1092 1091 # Hold a local ref. to glob.glob for speed
1093 1092 self.glob = glob.glob
1094 1093
1095 1094 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1096 1095 # buffers, to avoid completion problems.
1097 1096 term = os.environ.get('TERM','xterm')
1098 1097 self.dumb_terminal = term in ['dumb','emacs']
1099 1098
1100 1099 # Special handling of backslashes needed in win32 platforms
1101 1100 if sys.platform == "win32":
1102 1101 self.clean_glob = self._clean_glob_win32
1103 1102 else:
1104 1103 self.clean_glob = self._clean_glob
1105 1104
1106 1105 #regexp to parse docstring for function signature
1107 1106 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1108 1107 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1109 1108 #use this if positional argument name is also needed
1110 1109 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1111 1110
1112 1111 self.magic_arg_matchers = [
1113 1112 self.magic_config_matches,
1114 1113 self.magic_color_matches,
1115 1114 ]
1116 1115
1117 1116 # This is set externally by InteractiveShell
1118 1117 self.custom_completers = None
1119 1118
1120 1119 @property
1121 1120 def matchers(self):
1122 1121 """All active matcher routines for completion"""
1123 1122 if self.dict_keys_only:
1124 1123 return [self.dict_key_matches]
1125 1124
1126 1125 if self.use_jedi:
1127 1126 return [
1128 1127 *self.custom_matchers,
1129 1128 self.file_matches,
1130 1129 self.magic_matches,
1131 1130 self.dict_key_matches,
1132 1131 ]
1133 1132 else:
1134 1133 return [
1135 1134 *self.custom_matchers,
1136 1135 self.python_matches,
1137 1136 self.file_matches,
1138 1137 self.magic_matches,
1139 1138 self.python_func_kw_matches,
1140 1139 self.dict_key_matches,
1141 1140 ]
1142 1141
1143 1142 def all_completions(self, text) -> List[str]:
1144 1143 """
1145 1144 Wrapper around the completion methods for the benefit of emacs.
1146 1145 """
1147 1146 prefix = text.rpartition('.')[0]
1148 1147 with provisionalcompleter():
1149 1148 return ['.'.join([prefix, c.text]) if prefix and self.use_jedi else c.text
1150 1149 for c in self.completions(text, len(text))]
1151 1150
1152 1151 return self.complete(text)[1]
1153 1152
1154 1153 def _clean_glob(self, text):
1155 1154 return self.glob("%s*" % text)
1156 1155
1157 1156 def _clean_glob_win32(self,text):
1158 1157 return [f.replace("\\","/")
1159 1158 for f in self.glob("%s*" % text)]
1160 1159
1161 1160 def file_matches(self, text):
1162 1161 """Match filenames, expanding ~USER type strings.
1163 1162
1164 1163 Most of the seemingly convoluted logic in this completer is an
1165 1164 attempt to handle filenames with spaces in them. And yet it's not
1166 1165 quite perfect, because Python's readline doesn't expose all of the
1167 1166 GNU readline details needed for this to be done correctly.
1168 1167
1169 1168 For a filename with a space in it, the printed completions will be
1170 1169 only the parts after what's already been typed (instead of the
1171 1170 full completions, as is normally done). I don't think with the
1172 1171 current (as of Python 2.3) Python readline it's possible to do
1173 1172 better."""
1174 1173
1175 1174 # chars that require escaping with backslash - i.e. chars
1176 1175 # that readline treats incorrectly as delimiters, but we
1177 1176 # don't want to treat as delimiters in filename matching
1178 1177 # when escaped with backslash
1179 1178 if text.startswith('!'):
1180 1179 text = text[1:]
1181 1180 text_prefix = u'!'
1182 1181 else:
1183 1182 text_prefix = u''
1184 1183
1185 1184 text_until_cursor = self.text_until_cursor
1186 1185 # track strings with open quotes
1187 1186 open_quotes = has_open_quotes(text_until_cursor)
1188 1187
1189 1188 if '(' in text_until_cursor or '[' in text_until_cursor:
1190 1189 lsplit = text
1191 1190 else:
1192 1191 try:
1193 1192 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1194 1193 lsplit = arg_split(text_until_cursor)[-1]
1195 1194 except ValueError:
1196 1195 # typically an unmatched ", or backslash without escaped char.
1197 1196 if open_quotes:
1198 1197 lsplit = text_until_cursor.split(open_quotes)[-1]
1199 1198 else:
1200 1199 return []
1201 1200 except IndexError:
1202 1201 # tab pressed on empty line
1203 1202 lsplit = ""
1204 1203
1205 1204 if not open_quotes and lsplit != protect_filename(lsplit):
1206 1205 # if protectables are found, do matching on the whole escaped name
1207 1206 has_protectables = True
1208 1207 text0,text = text,lsplit
1209 1208 else:
1210 1209 has_protectables = False
1211 1210 text = os.path.expanduser(text)
1212 1211
1213 1212 if text == "":
1214 1213 return [text_prefix + protect_filename(f) for f in self.glob("*")]
1215 1214
1216 1215 # Compute the matches from the filesystem
1217 1216 if sys.platform == 'win32':
1218 1217 m0 = self.clean_glob(text)
1219 1218 else:
1220 1219 m0 = self.clean_glob(text.replace('\\', ''))
1221 1220
1222 1221 if has_protectables:
1223 1222 # If we had protectables, we need to revert our changes to the
1224 1223 # beginning of filename so that we don't double-write the part
1225 1224 # of the filename we have so far
1226 1225 len_lsplit = len(lsplit)
1227 1226 matches = [text_prefix + text0 +
1228 1227 protect_filename(f[len_lsplit:]) for f in m0]
1229 1228 else:
1230 1229 if open_quotes:
1231 1230 # if we have a string with an open quote, we don't need to
1232 1231 # protect the names beyond the quote (and we _shouldn't_, as
1233 1232 # it would cause bugs when the filesystem call is made).
1234 1233 matches = m0 if sys.platform == "win32" else\
1235 1234 [protect_filename(f, open_quotes) for f in m0]
1236 1235 else:
1237 1236 matches = [text_prefix +
1238 1237 protect_filename(f) for f in m0]
1239 1238
1240 1239 # Mark directories in input list by appending '/' to their names.
1241 1240 return [x+'/' if os.path.isdir(x) else x for x in matches]
1242 1241
1243 1242 def magic_matches(self, text):
1244 1243 """Match magics"""
1245 1244 # Get all shell magics now rather than statically, so magics loaded at
1246 1245 # runtime show up too.
1247 1246 lsm = self.shell.magics_manager.lsmagic()
1248 1247 line_magics = lsm['line']
1249 1248 cell_magics = lsm['cell']
1250 1249 pre = self.magic_escape
1251 1250 pre2 = pre+pre
1252 1251
1253 1252 explicit_magic = text.startswith(pre)
1254 1253
1255 1254 # Completion logic:
1256 1255 # - user gives %%: only do cell magics
1257 1256 # - user gives %: do both line and cell magics
1258 1257 # - no prefix: do both
1259 1258 # In other words, line magics are skipped if the user gives %% explicitly
1260 1259 #
1261 1260 # We also exclude magics that match any currently visible names:
1262 1261 # https://github.com/ipython/ipython/issues/4877, unless the user has
1263 1262 # typed a %:
1264 1263 # https://github.com/ipython/ipython/issues/10754
1265 1264 bare_text = text.lstrip(pre)
1266 1265 global_matches = self.global_matches(bare_text)
1267 1266 if not explicit_magic:
1268 1267 def matches(magic):
1269 1268 """
1270 1269 Filter magics, in particular remove magics that match
1271 1270 a name present in global namespace.
1272 1271 """
1273 1272 return ( magic.startswith(bare_text) and
1274 1273 magic not in global_matches )
1275 1274 else:
1276 1275 def matches(magic):
1277 1276 return magic.startswith(bare_text)
1278 1277
1279 1278 comp = [ pre2+m for m in cell_magics if matches(m)]
1280 1279 if not text.startswith(pre2):
1281 1280 comp += [ pre+m for m in line_magics if matches(m)]
1282 1281
1283 1282 return comp
1284 1283
1285 1284 def magic_config_matches(self, text:str) -> List[str]:
1286 1285 """ Match class names and attributes for %config magic """
1287 1286 texts = text.strip().split()
1288 1287
1289 1288 if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'):
1290 1289 # get all configuration classes
1291 1290 classes = sorted(set([ c for c in self.shell.configurables
1292 1291 if c.__class__.class_traits(config=True)
1293 1292 ]), key=lambda x: x.__class__.__name__)
1294 1293 classnames = [ c.__class__.__name__ for c in classes ]
1295 1294
1296 1295 # return all classnames if config or %config is given
1297 1296 if len(texts) == 1:
1298 1297 return classnames
1299 1298
1300 1299 # match classname
1301 1300 classname_texts = texts[1].split('.')
1302 1301 classname = classname_texts[0]
1303 1302 classname_matches = [ c for c in classnames
1304 1303 if c.startswith(classname) ]
1305 1304
1306 1305 # return matched classes or the matched class with attributes
1307 1306 if texts[1].find('.') < 0:
1308 1307 return classname_matches
1309 1308 elif len(classname_matches) == 1 and \
1310 1309 classname_matches[0] == classname:
1311 1310 cls = classes[classnames.index(classname)].__class__
1312 1311 help = cls.class_get_help()
1313 1312 # strip leading '--' from cl-args:
1314 1313 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1315 1314 return [ attr.split('=')[0]
1316 1315 for attr in help.strip().splitlines()
1317 1316 if attr.startswith(texts[1]) ]
1318 1317 return []
1319 1318
1320 1319 def magic_color_matches(self, text:str) -> List[str] :
1321 1320 """ Match color schemes for %colors magic"""
1322 1321 texts = text.split()
1323 1322 if text.endswith(' '):
1324 1323 # .split() strips off the trailing whitespace. Add '' back
1325 1324 # so that: '%colors ' -> ['%colors', '']
1326 1325 texts.append('')
1327 1326
1328 1327 if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'):
1329 1328 prefix = texts[1]
1330 1329 return [ color for color in InspectColors.keys()
1331 1330 if color.startswith(prefix) ]
1332 1331 return []
1333 1332
1334 1333 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1335 1334 """
1336 1335
1337 1336 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1338 1337 cursor position.
1339 1338
1340 1339 Parameters
1341 1340 ----------
1342 1341 cursor_column : int
1343 1342 column position of the cursor in ``text``, 0-indexed.
1344 1343 cursor_line : int
1345 1344 line position of the cursor in ``text``, 0-indexed
1346 1345 text : str
1347 1346 text to complete
1348 1347
1349 1348 Debugging
1350 1349 ---------
1351 1350
1352 1351 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1353 1352 object containing a string with the Jedi debug information attached.
1354 1353 """
1355 1354 namespaces = [self.namespace]
1356 1355 if self.global_namespace is not None:
1357 1356 namespaces.append(self.global_namespace)
1358 1357
1359 1358 completion_filter = lambda x:x
1360 1359 offset = cursor_to_position(text, cursor_line, cursor_column)
1361 1360 # filter output if we are completing for object members
1362 1361 if offset:
1363 1362 pre = text[offset-1]
1364 1363 if pre == '.':
1365 1364 if self.omit__names == 2:
1366 1365 completion_filter = lambda c:not c.name.startswith('_')
1367 1366 elif self.omit__names == 1:
1368 1367 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1369 1368 elif self.omit__names == 0:
1370 1369 completion_filter = lambda x:x
1371 1370 else:
1372 1371 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1373 1372
1374 1373 interpreter = jedi.Interpreter(
1375 1374 text[:offset], namespaces, column=cursor_column, line=cursor_line + 1)
1376 1375 try_jedi = True
1377 1376
1378 1377 try:
1379 1378 # find the first token in the current tree -- if it is a ' or " then we are in a string
1380 1379 completing_string = False
1381 1380 try:
1382 1381 first_child = next(c for c in interpreter._get_module().tree_node.children if hasattr(c, 'value'))
1383 1382 except StopIteration:
1384 1383 pass
1385 1384 else:
1386 1385 # note the value may be ', ", or it may also be ''' or """, or
1387 1386 # in some cases, """what/you/typed..., but all of these are
1388 1387 # strings.
1389 1388 completing_string = len(first_child.value) > 0 and first_child.value[0] in {"'", '"'}
1390 1389
1391 1390 # if we are in a string jedi is likely not the right candidate for
1392 1391 # now. Skip it.
1393 1392 try_jedi = not completing_string
1394 1393 except Exception as e:
1395 1394 # many of things can go wrong, we are using private API just don't crash.
1396 1395 if self.debug:
1397 1396 print("Error detecting if completing a non-finished string :", e, '|')
1398 1397
1399 1398 if not try_jedi:
1400 1399 return []
1401 1400 try:
1402 return filter(completion_filter, interpreter.complete())
1401 return filter(completion_filter, interpreter.completions())
1403 1402 except Exception as e:
1404 1403 if self.debug:
1405 1404 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1406 1405 else:
1407 1406 return []
1408 1407
1409 1408 def python_matches(self, text):
1410 1409 """Match attributes or global python names"""
1411 1410 if "." in text:
1412 1411 try:
1413 1412 matches = self.attr_matches(text)
1414 1413 if text.endswith('.') and self.omit__names:
1415 1414 if self.omit__names == 1:
1416 1415 # true if txt is _not_ a __ name, false otherwise:
1417 1416 no__name = (lambda txt:
1418 1417 re.match(r'.*\.__.*?__',txt) is None)
1419 1418 else:
1420 1419 # true if txt is _not_ a _ name, false otherwise:
1421 1420 no__name = (lambda txt:
1422 1421 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1423 1422 matches = filter(no__name, matches)
1424 1423 except NameError:
1425 1424 # catches <undefined attributes>.<tab>
1426 1425 matches = []
1427 1426 else:
1428 1427 matches = self.global_matches(text)
1429 1428 return matches
1430 1429
1431 1430 def _default_arguments_from_docstring(self, doc):
1432 1431 """Parse the first line of docstring for call signature.
1433 1432
1434 1433 Docstring should be of the form 'min(iterable[, key=func])\n'.
1435 1434 It can also parse cython docstring of the form
1436 1435 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1437 1436 """
1438 1437 if doc is None:
1439 1438 return []
1440 1439
1441 1440 #care only the firstline
1442 1441 line = doc.lstrip().splitlines()[0]
1443 1442
1444 1443 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1445 1444 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1446 1445 sig = self.docstring_sig_re.search(line)
1447 1446 if sig is None:
1448 1447 return []
1449 1448 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1450 1449 sig = sig.groups()[0].split(',')
1451 1450 ret = []
1452 1451 for s in sig:
1453 1452 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1454 1453 ret += self.docstring_kwd_re.findall(s)
1455 1454 return ret
1456 1455
1457 1456 def _default_arguments(self, obj):
1458 1457 """Return the list of default arguments of obj if it is callable,
1459 1458 or empty list otherwise."""
1460 1459 call_obj = obj
1461 1460 ret = []
1462 1461 if inspect.isbuiltin(obj):
1463 1462 pass
1464 1463 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1465 1464 if inspect.isclass(obj):
1466 1465 #for cython embedsignature=True the constructor docstring
1467 1466 #belongs to the object itself not __init__
1468 1467 ret += self._default_arguments_from_docstring(
1469 1468 getattr(obj, '__doc__', ''))
1470 1469 # for classes, check for __init__,__new__
1471 1470 call_obj = (getattr(obj, '__init__', None) or
1472 1471 getattr(obj, '__new__', None))
1473 1472 # for all others, check if they are __call__able
1474 1473 elif hasattr(obj, '__call__'):
1475 1474 call_obj = obj.__call__
1476 1475 ret += self._default_arguments_from_docstring(
1477 1476 getattr(call_obj, '__doc__', ''))
1478 1477
1479 1478 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1480 1479 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1481 1480
1482 1481 try:
1483 1482 sig = inspect.signature(call_obj)
1484 1483 ret.extend(k for k, v in sig.parameters.items() if
1485 1484 v.kind in _keeps)
1486 1485 except ValueError:
1487 1486 pass
1488 1487
1489 1488 return list(set(ret))
1490 1489
1491 1490 def python_func_kw_matches(self,text):
1492 1491 """Match named parameters (kwargs) of the last open function"""
1493 1492
1494 1493 if "." in text: # a parameter cannot be dotted
1495 1494 return []
1496 1495 try: regexp = self.__funcParamsRegex
1497 1496 except AttributeError:
1498 1497 regexp = self.__funcParamsRegex = re.compile(r'''
1499 1498 '.*?(?<!\\)' | # single quoted strings or
1500 1499 ".*?(?<!\\)" | # double quoted strings or
1501 1500 \w+ | # identifier
1502 1501 \S # other characters
1503 1502 ''', re.VERBOSE | re.DOTALL)
1504 1503 # 1. find the nearest identifier that comes before an unclosed
1505 1504 # parenthesis before the cursor
1506 1505 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1507 1506 tokens = regexp.findall(self.text_until_cursor)
1508 1507 iterTokens = reversed(tokens); openPar = 0
1509 1508
1510 1509 for token in iterTokens:
1511 1510 if token == ')':
1512 1511 openPar -= 1
1513 1512 elif token == '(':
1514 1513 openPar += 1
1515 1514 if openPar > 0:
1516 1515 # found the last unclosed parenthesis
1517 1516 break
1518 1517 else:
1519 1518 return []
1520 1519 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1521 1520 ids = []
1522 1521 isId = re.compile(r'\w+$').match
1523 1522
1524 1523 while True:
1525 1524 try:
1526 1525 ids.append(next(iterTokens))
1527 1526 if not isId(ids[-1]):
1528 1527 ids.pop(); break
1529 1528 if not next(iterTokens) == '.':
1530 1529 break
1531 1530 except StopIteration:
1532 1531 break
1533 1532
1534 1533 # Find all named arguments already assigned to, as to avoid suggesting
1535 1534 # them again
1536 1535 usedNamedArgs = set()
1537 1536 par_level = -1
1538 1537 for token, next_token in zip(tokens, tokens[1:]):
1539 1538 if token == '(':
1540 1539 par_level += 1
1541 1540 elif token == ')':
1542 1541 par_level -= 1
1543 1542
1544 1543 if par_level != 0:
1545 1544 continue
1546 1545
1547 1546 if next_token != '=':
1548 1547 continue
1549 1548
1550 1549 usedNamedArgs.add(token)
1551 1550
1552 1551 argMatches = []
1553 1552 try:
1554 1553 callableObj = '.'.join(ids[::-1])
1555 1554 namedArgs = self._default_arguments(eval(callableObj,
1556 1555 self.namespace))
1557 1556
1558 1557 # Remove used named arguments from the list, no need to show twice
1559 1558 for namedArg in set(namedArgs) - usedNamedArgs:
1560 1559 if namedArg.startswith(text):
1561 1560 argMatches.append(u"%s=" %namedArg)
1562 1561 except:
1563 1562 pass
1564 1563
1565 1564 return argMatches
1566 1565
1567 1566 def dict_key_matches(self, text):
1568 1567 "Match string keys in a dictionary, after e.g. 'foo[' "
1569 1568 def get_keys(obj):
1570 1569 # Objects can define their own completions by defining an
1571 1570 # _ipy_key_completions_() method.
1572 1571 method = get_real_method(obj, '_ipython_key_completions_')
1573 1572 if method is not None:
1574 1573 return method()
1575 1574
1576 1575 # Special case some common in-memory dict-like types
1577 1576 if isinstance(obj, dict) or\
1578 1577 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1579 1578 try:
1580 1579 return list(obj.keys())
1581 1580 except Exception:
1582 1581 return []
1583 1582 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1584 1583 _safe_isinstance(obj, 'numpy', 'void'):
1585 1584 return obj.dtype.names or []
1586 1585 return []
1587 1586
1588 1587 try:
1589 1588 regexps = self.__dict_key_regexps
1590 1589 except AttributeError:
1591 1590 dict_key_re_fmt = r'''(?x)
1592 1591 ( # match dict-referring expression wrt greedy setting
1593 1592 %s
1594 1593 )
1595 1594 \[ # open bracket
1596 1595 \s* # and optional whitespace
1597 1596 ([uUbB]? # string prefix (r not handled)
1598 1597 (?: # unclosed string
1599 1598 '(?:[^']|(?<!\\)\\')*
1600 1599 |
1601 1600 "(?:[^"]|(?<!\\)\\")*
1602 1601 )
1603 1602 )?
1604 1603 $
1605 1604 '''
1606 1605 regexps = self.__dict_key_regexps = {
1607 1606 False: re.compile(dict_key_re_fmt % r'''
1608 1607 # identifiers separated by .
1609 1608 (?!\d)\w+
1610 1609 (?:\.(?!\d)\w+)*
1611 1610 '''),
1612 1611 True: re.compile(dict_key_re_fmt % '''
1613 1612 .+
1614 1613 ''')
1615 1614 }
1616 1615
1617 1616 match = regexps[self.greedy].search(self.text_until_cursor)
1618 1617 if match is None:
1619 1618 return []
1620 1619
1621 1620 expr, prefix = match.groups()
1622 1621 try:
1623 1622 obj = eval(expr, self.namespace)
1624 1623 except Exception:
1625 1624 try:
1626 1625 obj = eval(expr, self.global_namespace)
1627 1626 except Exception:
1628 1627 return []
1629 1628
1630 1629 keys = get_keys(obj)
1631 1630 if not keys:
1632 1631 return keys
1633 1632 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1634 1633 if not matches:
1635 1634 return matches
1636 1635
1637 1636 # get the cursor position of
1638 1637 # - the text being completed
1639 1638 # - the start of the key text
1640 1639 # - the start of the completion
1641 1640 text_start = len(self.text_until_cursor) - len(text)
1642 1641 if prefix:
1643 1642 key_start = match.start(2)
1644 1643 completion_start = key_start + token_offset
1645 1644 else:
1646 1645 key_start = completion_start = match.end()
1647 1646
1648 1647 # grab the leading prefix, to make sure all completions start with `text`
1649 1648 if text_start > key_start:
1650 1649 leading = ''
1651 1650 else:
1652 1651 leading = text[text_start:completion_start]
1653 1652
1654 1653 # the index of the `[` character
1655 1654 bracket_idx = match.end(1)
1656 1655
1657 1656 # append closing quote and bracket as appropriate
1658 1657 # this is *not* appropriate if the opening quote or bracket is outside
1659 1658 # the text given to this method
1660 1659 suf = ''
1661 1660 continuation = self.line_buffer[len(self.text_until_cursor):]
1662 1661 if key_start > text_start and closing_quote:
1663 1662 # quotes were opened inside text, maybe close them
1664 1663 if continuation.startswith(closing_quote):
1665 1664 continuation = continuation[len(closing_quote):]
1666 1665 else:
1667 1666 suf += closing_quote
1668 1667 if bracket_idx > text_start:
1669 1668 # brackets were opened inside text, maybe close them
1670 1669 if not continuation.startswith(']'):
1671 1670 suf += ']'
1672 1671
1673 1672 return [leading + k + suf for k in matches]
1674 1673
1675 1674 def unicode_name_matches(self, text):
1676 1675 u"""Match Latex-like syntax for unicode characters base
1677 1676 on the name of the character.
1678 1677
1679 1678 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1680 1679
1681 1680 Works only on valid python 3 identifier, or on combining characters that
1682 1681 will combine to form a valid identifier.
1683 1682
1684 1683 Used on Python 3 only.
1685 1684 """
1686 1685 slashpos = text.rfind('\\')
1687 1686 if slashpos > -1:
1688 1687 s = text[slashpos+1:]
1689 1688 try :
1690 1689 unic = unicodedata.lookup(s)
1691 1690 # allow combining chars
1692 1691 if ('a'+unic).isidentifier():
1693 1692 return '\\'+s,[unic]
1694 1693 except KeyError:
1695 1694 pass
1696 1695 return u'', []
1697 1696
1698 1697
1699 1698 def latex_matches(self, text):
1700 1699 u"""Match Latex syntax for unicode characters.
1701 1700
1702 1701 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1703 1702 """
1704 1703 slashpos = text.rfind('\\')
1705 1704 if slashpos > -1:
1706 1705 s = text[slashpos:]
1707 1706 if s in latex_symbols:
1708 1707 # Try to complete a full latex symbol to unicode
1709 1708 # \\alpha -> Ξ±
1710 1709 return s, [latex_symbols[s]]
1711 1710 else:
1712 1711 # If a user has partially typed a latex symbol, give them
1713 1712 # a full list of options \al -> [\aleph, \alpha]
1714 1713 matches = [k for k in latex_symbols if k.startswith(s)]
1715 1714 if matches:
1716 1715 return s, matches
1717 1716 return u'', []
1718 1717
1719 1718 def dispatch_custom_completer(self, text):
1720 1719 if not self.custom_completers:
1721 1720 return
1722 1721
1723 1722 line = self.line_buffer
1724 1723 if not line.strip():
1725 1724 return None
1726 1725
1727 1726 # Create a little structure to pass all the relevant information about
1728 1727 # the current completion to any custom completer.
1729 1728 event = SimpleNamespace()
1730 1729 event.line = line
1731 1730 event.symbol = text
1732 1731 cmd = line.split(None,1)[0]
1733 1732 event.command = cmd
1734 1733 event.text_until_cursor = self.text_until_cursor
1735 1734
1736 1735 # for foo etc, try also to find completer for %foo
1737 1736 if not cmd.startswith(self.magic_escape):
1738 1737 try_magic = self.custom_completers.s_matches(
1739 1738 self.magic_escape + cmd)
1740 1739 else:
1741 1740 try_magic = []
1742 1741
1743 1742 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1744 1743 try_magic,
1745 1744 self.custom_completers.flat_matches(self.text_until_cursor)):
1746 1745 try:
1747 1746 res = c(event)
1748 1747 if res:
1749 1748 # first, try case sensitive match
1750 1749 withcase = [r for r in res if r.startswith(text)]
1751 1750 if withcase:
1752 1751 return withcase
1753 1752 # if none, then case insensitive ones are ok too
1754 1753 text_low = text.lower()
1755 1754 return [r for r in res if r.lower().startswith(text_low)]
1756 1755 except TryNext:
1757 1756 pass
1758 1757 except KeyboardInterrupt:
1759 1758 """
1760 1759 If custom completer take too long,
1761 1760 let keyboard interrupt abort and return nothing.
1762 1761 """
1763 1762 break
1764 1763
1765 1764 return None
1766 1765
1767 1766 def completions(self, text: str, offset: int)->Iterator[Completion]:
1768 1767 """
1769 1768 Returns an iterator over the possible completions
1770 1769
1771 1770 .. warning:: Unstable
1772 1771
1773 1772 This function is unstable, API may change without warning.
1774 1773 It will also raise unless use in proper context manager.
1775 1774
1776 1775 Parameters
1777 1776 ----------
1778 1777
1779 1778 text:str
1780 1779 Full text of the current input, multi line string.
1781 1780 offset:int
1782 1781 Integer representing the position of the cursor in ``text``. Offset
1783 1782 is 0-based indexed.
1784 1783
1785 1784 Yields
1786 1785 ------
1787 1786 :any:`Completion` object
1788 1787
1789 1788
1790 1789 The cursor on a text can either be seen as being "in between"
1791 1790 characters or "On" a character depending on the interface visible to
1792 1791 the user. For consistency the cursor being on "in between" characters X
1793 1792 and Y is equivalent to the cursor being "on" character Y, that is to say
1794 1793 the character the cursor is on is considered as being after the cursor.
1795 1794
1796 1795 Combining characters may span more that one position in the
1797 1796 text.
1798 1797
1799 1798
1800 1799 .. note::
1801 1800
1802 1801 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1803 1802 fake Completion token to distinguish completion returned by Jedi
1804 1803 and usual IPython completion.
1805 1804
1806 1805 .. note::
1807 1806
1808 1807 Completions are not completely deduplicated yet. If identical
1809 1808 completions are coming from different sources this function does not
1810 1809 ensure that each completion object will only be present once.
1811 1810 """
1812 1811 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1813 1812 "It may change without warnings. "
1814 1813 "Use in corresponding context manager.",
1815 1814 category=ProvisionalCompleterWarning, stacklevel=2)
1816 1815
1817 1816 seen = set()
1818 1817 try:
1819 1818 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1820 1819 if c and (c in seen):
1821 1820 continue
1822 1821 yield c
1823 1822 seen.add(c)
1824 1823 except KeyboardInterrupt:
1825 1824 """if completions take too long and users send keyboard interrupt,
1826 1825 do not crash and return ASAP. """
1827 1826 pass
1828 1827
1829 1828 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1830 1829 """
1831 1830 Core completion module.Same signature as :any:`completions`, with the
1832 1831 extra `timeout` parameter (in seconds).
1833 1832
1834 1833
1835 1834 Computing jedi's completion ``.type`` can be quite expensive (it is a
1836 1835 lazy property) and can require some warm-up, more warm up than just
1837 1836 computing the ``name`` of a completion. The warm-up can be :
1838 1837
1839 1838 - Long warm-up the first time a module is encountered after
1840 1839 install/update: actually build parse/inference tree.
1841 1840
1842 1841 - first time the module is encountered in a session: load tree from
1843 1842 disk.
1844 1843
1845 1844 We don't want to block completions for tens of seconds so we give the
1846 1845 completer a "budget" of ``_timeout`` seconds per invocation to compute
1847 1846 completions types, the completions that have not yet been computed will
1848 1847 be marked as "unknown" an will have a chance to be computed next round
1849 1848 are things get cached.
1850 1849
1851 1850 Keep in mind that Jedi is not the only thing treating the completion so
1852 1851 keep the timeout short-ish as if we take more than 0.3 second we still
1853 1852 have lots of processing to do.
1854 1853
1855 1854 """
1856 1855 deadline = time.monotonic() + _timeout
1857 1856
1858 1857
1859 1858 before = full_text[:offset]
1860 1859 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1861 1860
1862 1861 matched_text, matches, matches_origin, jedi_matches = self._complete(
1863 1862 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1864 1863
1865 1864 iter_jm = iter(jedi_matches)
1866 1865 if _timeout:
1867 1866 for jm in iter_jm:
1868 1867 try:
1869 1868 type_ = jm.type
1870 1869 except Exception:
1871 1870 if self.debug:
1872 1871 print("Error in Jedi getting type of ", jm)
1873 1872 type_ = None
1874 1873 delta = len(jm.name_with_symbols) - len(jm.complete)
1875 1874 if type_ == 'function':
1876 1875 signature = _make_signature(jm)
1877 1876 else:
1878 1877 signature = ''
1879 1878 yield Completion(start=offset - delta,
1880 1879 end=offset,
1881 1880 text=jm.name_with_symbols,
1882 1881 type=type_,
1883 1882 signature=signature,
1884 1883 _origin='jedi')
1885 1884
1886 1885 if time.monotonic() > deadline:
1887 1886 break
1888 1887
1889 1888 for jm in iter_jm:
1890 1889 delta = len(jm.name_with_symbols) - len(jm.complete)
1891 1890 yield Completion(start=offset - delta,
1892 1891 end=offset,
1893 1892 text=jm.name_with_symbols,
1894 1893 type='<unknown>', # don't compute type for speed
1895 1894 _origin='jedi',
1896 1895 signature='')
1897 1896
1898 1897
1899 1898 start_offset = before.rfind(matched_text)
1900 1899
1901 1900 # TODO:
1902 1901 # Suppress this, right now just for debug.
1903 1902 if jedi_matches and matches and self.debug:
1904 1903 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--',
1905 1904 _origin='debug', type='none', signature='')
1906 1905
1907 1906 # I'm unsure if this is always true, so let's assert and see if it
1908 1907 # crash
1909 1908 assert before.endswith(matched_text)
1910 1909 for m, t in zip(matches, matches_origin):
1911 1910 yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>')
1912 1911
1913 1912
1914 1913 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1915 1914 """Find completions for the given text and line context.
1916 1915
1917 1916 Note that both the text and the line_buffer are optional, but at least
1918 1917 one of them must be given.
1919 1918
1920 1919 Parameters
1921 1920 ----------
1922 1921 text : string, optional
1923 1922 Text to perform the completion on. If not given, the line buffer
1924 1923 is split using the instance's CompletionSplitter object.
1925 1924
1926 1925 line_buffer : string, optional
1927 1926 If not given, the completer attempts to obtain the current line
1928 1927 buffer via readline. This keyword allows clients which are
1929 1928 requesting for text completions in non-readline contexts to inform
1930 1929 the completer of the entire text.
1931 1930
1932 1931 cursor_pos : int, optional
1933 1932 Index of the cursor in the full line buffer. Should be provided by
1934 1933 remote frontends where kernel has no access to frontend state.
1935 1934
1936 1935 Returns
1937 1936 -------
1938 1937 text : str
1939 1938 Text that was actually used in the completion.
1940 1939
1941 1940 matches : list
1942 1941 A list of completion matches.
1943 1942
1944 1943
1945 1944 .. note::
1946 1945
1947 1946 This API is likely to be deprecated and replaced by
1948 1947 :any:`IPCompleter.completions` in the future.
1949 1948
1950 1949
1951 1950 """
1952 1951 warnings.warn('`Completer.complete` is pending deprecation since '
1953 1952 'IPython 6.0 and will be replaced by `Completer.completions`.',
1954 1953 PendingDeprecationWarning)
1955 1954 # potential todo, FOLD the 3rd throw away argument of _complete
1956 1955 # into the first 2 one.
1957 1956 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1958 1957
1959 1958 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1960 1959 full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]:
1961 1960 """
1962 1961
1963 1962 Like complete but can also returns raw jedi completions as well as the
1964 1963 origin of the completion text. This could (and should) be made much
1965 1964 cleaner but that will be simpler once we drop the old (and stateful)
1966 1965 :any:`complete` API.
1967 1966
1968 1967
1969 1968 With current provisional API, cursor_pos act both (depending on the
1970 1969 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1971 1970 ``column`` when passing multiline strings this could/should be renamed
1972 1971 but would add extra noise.
1973 1972 """
1974 1973
1975 1974 # if the cursor position isn't given, the only sane assumption we can
1976 1975 # make is that it's at the end of the line (the common case)
1977 1976 if cursor_pos is None:
1978 1977 cursor_pos = len(line_buffer) if text is None else len(text)
1979 1978
1980 1979 if self.use_main_ns:
1981 1980 self.namespace = __main__.__dict__
1982 1981
1983 1982 # if text is either None or an empty string, rely on the line buffer
1984 1983 if (not line_buffer) and full_text:
1985 1984 line_buffer = full_text.split('\n')[cursor_line]
1986 1985 if not text: # issue #11508: check line_buffer before calling split_line
1987 1986 text = self.splitter.split_line(line_buffer, cursor_pos) if line_buffer else ''
1988 1987
1989 1988 if self.backslash_combining_completions:
1990 1989 # allow deactivation of these on windows.
1991 1990 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1992 1991 latex_text, latex_matches = self.latex_matches(base_text)
1993 1992 if latex_matches:
1994 1993 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1995 1994 name_text = ''
1996 1995 name_matches = []
1997 1996 # need to add self.fwd_unicode_match() function here when done
1998 1997 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches, self.fwd_unicode_match):
1999 1998 name_text, name_matches = meth(base_text)
2000 1999 if name_text:
2001 2000 return name_text, name_matches[:MATCHES_LIMIT], \
2002 2001 [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), ()
2003 2002
2004 2003
2005 2004 # If no line buffer is given, assume the input text is all there was
2006 2005 if line_buffer is None:
2007 2006 line_buffer = text
2008 2007
2009 2008 self.line_buffer = line_buffer
2010 2009 self.text_until_cursor = self.line_buffer[:cursor_pos]
2011 2010
2012 2011 # Do magic arg matches
2013 2012 for matcher in self.magic_arg_matchers:
2014 2013 matches = list(matcher(line_buffer))[:MATCHES_LIMIT]
2015 2014 if matches:
2016 2015 origins = [matcher.__qualname__] * len(matches)
2017 2016 return text, matches, origins, ()
2018 2017
2019 2018 # Start with a clean slate of completions
2020 2019 matches = []
2021 2020
2022 2021 # FIXME: we should extend our api to return a dict with completions for
2023 2022 # different types of objects. The rlcomplete() method could then
2024 2023 # simply collapse the dict into a list for readline, but we'd have
2025 2024 # richer completion semantics in other environments.
2026 2025 completions = ()
2027 2026 if self.use_jedi:
2028 2027 if not full_text:
2029 2028 full_text = line_buffer
2030 2029 completions = self._jedi_matches(
2031 2030 cursor_pos, cursor_line, full_text)
2032 2031
2033 2032 if self.merge_completions:
2034 2033 matches = []
2035 2034 for matcher in self.matchers:
2036 2035 try:
2037 2036 matches.extend([(m, matcher.__qualname__)
2038 2037 for m in matcher(text)])
2039 2038 except:
2040 2039 # Show the ugly traceback if the matcher causes an
2041 2040 # exception, but do NOT crash the kernel!
2042 2041 sys.excepthook(*sys.exc_info())
2043 2042 else:
2044 2043 for matcher in self.matchers:
2045 2044 matches = [(m, matcher.__qualname__)
2046 2045 for m in matcher(text)]
2047 2046 if matches:
2048 2047 break
2049 2048
2050 2049 seen = set()
2051 2050 filtered_matches = set()
2052 2051 for m in matches:
2053 2052 t, c = m
2054 2053 if t not in seen:
2055 2054 filtered_matches.add(m)
2056 2055 seen.add(t)
2057 2056
2058 2057 _filtered_matches = sorted(filtered_matches, key=lambda x: completions_sorting_key(x[0]))
2059 2058
2060 2059 custom_res = [(m, 'custom') for m in self.dispatch_custom_completer(text) or []]
2061 2060
2062 2061 _filtered_matches = custom_res or _filtered_matches
2063 2062
2064 2063 _filtered_matches = _filtered_matches[:MATCHES_LIMIT]
2065 2064 _matches = [m[0] for m in _filtered_matches]
2066 2065 origins = [m[1] for m in _filtered_matches]
2067 2066
2068 2067 self.matches = _matches
2069 2068
2070 2069 return text, _matches, origins, completions
2071 2070
2072 2071 def fwd_unicode_match(self, text:str) -> Tuple[str, list]:
2073 2072 if self._names is None:
2074 2073 self._names = []
2075 2074 for c in range(0,0x10FFFF + 1):
2076 2075 try:
2077 2076 self._names.append(unicodedata.name(chr(c)))
2078 2077 except ValueError:
2079 2078 pass
2080 2079
2081 2080 slashpos = text.rfind('\\')
2082 2081 # if text starts with slash
2083 2082 if slashpos > -1:
2084 2083 s = text[slashpos+1:]
2085 2084 candidates = [x for x in self._names if x.startswith(s)]
2086 2085 if candidates:
2087 2086 return s, candidates
2088 2087 else:
2089 2088 return '', ()
2090 2089
2091 2090 # if text does not start with slash
2092 2091 else:
2093 2092 return u'', ()
@@ -1,265 +1,265 b''
1 1 #!/usr/bin/env python3
2 2 # -*- coding: utf-8 -*-
3 3 """Setup script for IPython.
4 4
5 5 Under Posix environments it works like a typical setup.py script.
6 6 Under Windows, the command sdist is not supported, since IPython
7 7 requires utilities which are not available under Windows."""
8 8
9 9 #-----------------------------------------------------------------------------
10 10 # Copyright (c) 2008-2011, IPython Development Team.
11 11 # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu>
12 12 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
13 13 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
14 14 #
15 15 # Distributed under the terms of the Modified BSD License.
16 16 #
17 17 # The full license is in the file COPYING.rst, distributed with this software.
18 18 #-----------------------------------------------------------------------------
19 19
20 20 from __future__ import print_function
21 21
22 22 import os
23 23 import sys
24 24
25 25 # **Python version check**
26 26 #
27 27 # This check is also made in IPython/__init__, don't forget to update both when
28 28 # changing Python version requirements.
29 29 if sys.version_info < (3, 7):
30 30 pip_message = 'This may be due to an out of date pip. Make sure you have pip >= 9.0.1.'
31 31 try:
32 32 import pip
33 33 pip_version = tuple([int(x) for x in pip.__version__.split('.')[:3]])
34 34 if pip_version < (9, 0, 1) :
35 35 pip_message = 'Your pip version is out of date, please install pip >= 9.0.1. '\
36 36 'pip {} detected.'.format(pip.__version__)
37 37 else:
38 38 # pip is new enough - it must be something else
39 39 pip_message = ''
40 40 except Exception:
41 41 pass
42 42
43 43
44 44 error = """
45 45 IPython 7.17+ supports Python 3.7 and above, following NEP 29.
46 46 When using Python 2.7, please install IPython 5.x LTS Long Term Support version.
47 47 Python 3.3 and 3.4 were supported up to IPython 6.x.
48 48 Python 3.5 was supported with IPython 7.0 to 7.9.
49 49 Python 3.6 was supported with IPython up to 7.16.
50 50
51 51 See IPython `README.rst` file for more information:
52 52
53 53 https://github.com/ipython/ipython/blob/master/README.rst
54 54
55 55 Python {py} detected.
56 56 {pip}
57 57 """.format(py=sys.version_info, pip=pip_message )
58 58
59 59 print(error, file=sys.stderr)
60 60 sys.exit(1)
61 61
62 62 # At least we're on the python version we need, move on.
63 63
64 64 # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
65 65 # update it when the contents of directories change.
66 66 if os.path.exists('MANIFEST'): os.remove('MANIFEST')
67 67
68 68 from distutils.core import setup
69 69
70 70 # Our own imports
71 71 from setupbase import target_update
72 72
73 73 from setupbase import (
74 74 setup_args,
75 75 find_packages,
76 76 find_package_data,
77 77 check_package_data_first,
78 78 find_entry_points,
79 79 build_scripts_entrypt,
80 80 find_data_files,
81 81 git_prebuild,
82 82 install_symlinked,
83 83 install_lib_symlink,
84 84 install_scripts_for_symlink,
85 85 unsymlink,
86 86 )
87 87
88 88 isfile = os.path.isfile
89 89 pjoin = os.path.join
90 90
91 91 #-------------------------------------------------------------------------------
92 92 # Handle OS specific things
93 93 #-------------------------------------------------------------------------------
94 94
95 95 if os.name in ('nt','dos'):
96 96 os_name = 'windows'
97 97 else:
98 98 os_name = os.name
99 99
100 100 # Under Windows, 'sdist' has not been supported. Now that the docs build with
101 101 # Sphinx it might work, but let's not turn it on until someone confirms that it
102 102 # actually works.
103 103 if os_name == 'windows' and 'sdist' in sys.argv:
104 104 print('The sdist command is not available under Windows. Exiting.')
105 105 sys.exit(1)
106 106
107 107
108 108 #-------------------------------------------------------------------------------
109 109 # Things related to the IPython documentation
110 110 #-------------------------------------------------------------------------------
111 111
112 112 # update the manuals when building a source dist
113 113 if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):
114 114
115 115 # List of things to be updated. Each entry is a triplet of args for
116 116 # target_update()
117 117 to_update = [
118 118 ('docs/man/ipython.1.gz',
119 119 ['docs/man/ipython.1'],
120 120 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'),
121 121 ]
122 122
123 123
124 124 [ target_update(*t) for t in to_update ]
125 125
126 126 #---------------------------------------------------------------------------
127 127 # Find all the packages, package data, and data_files
128 128 #---------------------------------------------------------------------------
129 129
130 130 packages = find_packages()
131 131 package_data = find_package_data()
132 132
133 133 data_files = find_data_files()
134 134
135 135 setup_args['packages'] = packages
136 136 setup_args['package_data'] = package_data
137 137 setup_args['data_files'] = data_files
138 138
139 139 #---------------------------------------------------------------------------
140 140 # custom distutils commands
141 141 #---------------------------------------------------------------------------
142 142 # imports here, so they are after setuptools import if there was one
143 143 from distutils.command.sdist import sdist
144 144
145 145 setup_args['cmdclass'] = {
146 146 'build_py': \
147 147 check_package_data_first(git_prebuild('IPython')),
148 148 'sdist' : git_prebuild('IPython', sdist),
149 149 'symlink': install_symlinked,
150 150 'install_lib_symlink': install_lib_symlink,
151 151 'install_scripts_sym': install_scripts_for_symlink,
152 152 'unsymlink': unsymlink,
153 153 }
154 154
155 155
156 156 #---------------------------------------------------------------------------
157 157 # Handle scripts, dependencies, and setuptools specific things
158 158 #---------------------------------------------------------------------------
159 159
160 160 # For some commands, use setuptools. Note that we do NOT list install here!
161 161 # If you want a setuptools-enhanced install, just run 'setupegg.py install'
162 162 needs_setuptools = {'develop', 'release', 'bdist_egg', 'bdist_rpm',
163 163 'bdist', 'bdist_dumb', 'bdist_wininst', 'bdist_wheel',
164 164 'egg_info', 'easy_install', 'upload', 'install_egg_info',
165 165 }
166 166
167 167 if len(needs_setuptools.intersection(sys.argv)) > 0:
168 168 import setuptools
169 169
170 170 # This dict is used for passing extra arguments that are setuptools
171 171 # specific to setup
172 172 setuptools_extra_args = {}
173 173
174 174 # setuptools requirements
175 175
176 176 extras_require = dict(
177 177 parallel = ['ipyparallel'],
178 178 qtconsole = ['qtconsole'],
179 179 doc = ['Sphinx>=1.3'],
180 180 test = ['nose>=0.10.1', 'requests', 'testpath', 'pygments', 'nbformat', 'ipykernel', 'numpy>=1.14'],
181 181 terminal = [],
182 182 kernel = ['ipykernel'],
183 183 nbformat = ['nbformat'],
184 184 notebook = ['notebook', 'ipywidgets'],
185 185 nbconvert = ['nbconvert'],
186 186 )
187 187
188 188 install_requires = [
189 189 'setuptools>=18.5',
190 'jedi>=0.16',
190 'jedi>=0.10',
191 191 'decorator',
192 192 'pickleshare',
193 193 'traitlets>=4.2',
194 194 'prompt_toolkit>=2.0.0,<3.1.0,!=3.0.0,!=3.0.1',
195 195 'pygments',
196 196 'backcall',
197 197 ]
198 198
199 199 # Platform-specific dependencies:
200 200 # This is the correct way to specify these,
201 201 # but requires pip >= 6. pip < 6 ignores these.
202 202
203 203 extras_require.update(
204 204 {
205 205 ':sys_platform != "win32"': ["pexpect>4.3"],
206 206 ':sys_platform == "darwin"': ["appnope"],
207 207 ':sys_platform == "win32"': ["colorama"],
208 208 }
209 209 )
210 210 # FIXME: re-specify above platform dependencies for pip < 6
211 211 # These would result in non-portable bdists.
212 212 if not any(arg.startswith('bdist') for arg in sys.argv):
213 213 if sys.platform == 'darwin':
214 214 install_requires.extend(['appnope'])
215 215
216 216 if not sys.platform.startswith("win"):
217 217 install_requires.append("pexpect>4.3")
218 218
219 219 # workaround pypa/setuptools#147, where setuptools misspells
220 220 # platform_python_implementation as python_implementation
221 221 if 'setuptools' in sys.modules:
222 222 for key in list(extras_require):
223 223 if 'platform_python_implementation' in key:
224 224 new_key = key.replace('platform_python_implementation', 'python_implementation')
225 225 extras_require[new_key] = extras_require.pop(key)
226 226
227 227 everything = set()
228 228 for key, deps in extras_require.items():
229 229 if ':' not in key:
230 230 everything.update(deps)
231 231 extras_require['all'] = list(sorted(everything))
232 232
233 233 if 'setuptools' in sys.modules:
234 234 setuptools_extra_args['python_requires'] = '>=3.7'
235 235 setuptools_extra_args['zip_safe'] = False
236 236 setuptools_extra_args['entry_points'] = {
237 237 'console_scripts': find_entry_points(),
238 238 'pygments.lexers': [
239 239 'ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer',
240 240 'ipython = IPython.lib.lexers:IPythonLexer',
241 241 'ipython3 = IPython.lib.lexers:IPython3Lexer',
242 242 ],
243 243 }
244 244 setup_args['extras_require'] = extras_require
245 245 setup_args['install_requires'] = install_requires
246 246
247 247 else:
248 248 # scripts has to be a non-empty list, or install_scripts isn't called
249 249 setup_args['scripts'] = [e.split('=')[0].strip() for e in find_entry_points()]
250 250
251 251 setup_args['cmdclass']['build_scripts'] = build_scripts_entrypt
252 252
253 253 #---------------------------------------------------------------------------
254 254 # Do the actual setup now
255 255 #---------------------------------------------------------------------------
256 256
257 257 setup_args.update(setuptools_extra_args)
258 258
259 259
260 260
261 261 def main():
262 262 setup(**setup_args)
263 263
264 264 if __name__ == '__main__':
265 265 main()
General Comments 0
You need to be logged in to leave comments. Login now