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