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