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