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