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