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