##// END OF EJS Templates
typo: undefinied variable completion
Matthias Bussonnier -
Show More
@@ -1,1879 +1,1879 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
132 from typing import Iterator, List
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.utils import generics
139 from IPython.utils import generics
140 from IPython.utils.dir2 import dir2, get_real_method
140 from IPython.utils.dir2 import dir2, get_real_method
141 from IPython.utils.process import arg_split
141 from IPython.utils.process import arg_split
142 from IPython.utils.py3compat import cast_unicode_py2
142 from IPython.utils.py3compat import cast_unicode_py2
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):
229 def protect_filename(s):
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=''):
369 def __init__(self, start: int, end: int, text: str, *, type: str=None, _origin=''):
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 = Iterator[Completion]
402 _IC = Iterator[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(completion)
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 return [cast_unicode_py2(m) for m in matches]
659 return [cast_unicode_py2(m) for m in matches]
660
660
661 def attr_matches(self, text):
661 def attr_matches(self, text):
662 """Compute matches when text contains a dot.
662 """Compute matches when text contains a dot.
663
663
664 Assuming the text is of the form NAME.NAME....[NAME], and is
664 Assuming the text is of the form NAME.NAME....[NAME], and is
665 evaluatable in self.namespace or self.global_namespace, it will be
665 evaluatable in self.namespace or self.global_namespace, it will be
666 evaluated and its attributes (as revealed by dir()) are used as
666 evaluated and its attributes (as revealed by dir()) are used as
667 possible completions. (For class instances, class members are are
667 possible completions. (For class instances, class members are are
668 also considered.)
668 also considered.)
669
669
670 WARNING: this can still invoke arbitrary C code, if an object
670 WARNING: this can still invoke arbitrary C code, if an object
671 with a __getattr__ hook is evaluated.
671 with a __getattr__ hook is evaluated.
672
672
673 """
673 """
674
674
675 # Another option, seems to work great. Catches things like ''.<tab>
675 # Another option, seems to work great. Catches things like ''.<tab>
676 m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text)
676 m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text)
677
677
678 if m:
678 if m:
679 expr, attr = m.group(1, 3)
679 expr, attr = m.group(1, 3)
680 elif self.greedy:
680 elif self.greedy:
681 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
681 m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer)
682 if not m2:
682 if not m2:
683 return []
683 return []
684 expr, attr = m2.group(1,2)
684 expr, attr = m2.group(1,2)
685 else:
685 else:
686 return []
686 return []
687
687
688 try:
688 try:
689 obj = eval(expr, self.namespace)
689 obj = eval(expr, self.namespace)
690 except:
690 except:
691 try:
691 try:
692 obj = eval(expr, self.global_namespace)
692 obj = eval(expr, self.global_namespace)
693 except:
693 except:
694 return []
694 return []
695
695
696 if self.limit_to__all__ and hasattr(obj, '__all__'):
696 if self.limit_to__all__ and hasattr(obj, '__all__'):
697 words = get__all__entries(obj)
697 words = get__all__entries(obj)
698 else:
698 else:
699 words = dir2(obj)
699 words = dir2(obj)
700
700
701 try:
701 try:
702 words = generics.complete_object(obj, words)
702 words = generics.complete_object(obj, words)
703 except TryNext:
703 except TryNext:
704 pass
704 pass
705 except AssertionError:
705 except AssertionError:
706 raise
706 raise
707 except Exception:
707 except Exception:
708 # Silence errors from completion function
708 # Silence errors from completion function
709 #raise # dbg
709 #raise # dbg
710 pass
710 pass
711 # Build match list to return
711 # Build match list to return
712 n = len(attr)
712 n = len(attr)
713 return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ]
713 return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ]
714
714
715
715
716 def get__all__entries(obj):
716 def get__all__entries(obj):
717 """returns the strings in the __all__ attribute"""
717 """returns the strings in the __all__ attribute"""
718 try:
718 try:
719 words = getattr(obj, '__all__')
719 words = getattr(obj, '__all__')
720 except:
720 except:
721 return []
721 return []
722
722
723 return [cast_unicode_py2(w) for w in words if isinstance(w, str)]
723 return [cast_unicode_py2(w) for w in words if isinstance(w, str)]
724
724
725
725
726 def match_dict_keys(keys: List[str], prefix: str, delims: str):
726 def match_dict_keys(keys: List[str], prefix: str, delims: str):
727 """Used by dict_key_matches, matching the prefix to a list of keys
727 """Used by dict_key_matches, matching the prefix to a list of keys
728
728
729 Parameters
729 Parameters
730 ==========
730 ==========
731 keys:
731 keys:
732 list of keys in dictionary currently being completed.
732 list of keys in dictionary currently being completed.
733 prefix:
733 prefix:
734 Part of the text already typed by the user. e.g. `mydict[b'fo`
734 Part of the text already typed by the user. e.g. `mydict[b'fo`
735 delims:
735 delims:
736 String of delimiters to consider when finding the current key.
736 String of delimiters to consider when finding the current key.
737
737
738 Returns
738 Returns
739 =======
739 =======
740
740
741 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
741 A tuple of three elements: ``quote``, ``token_start``, ``matched``, with
742 ``quote`` being the quote that need to be used to close current string.
742 ``quote`` being the quote that need to be used to close current string.
743 ``token_start`` the position where the replacement should start occurring,
743 ``token_start`` the position where the replacement should start occurring,
744 ``matches`` a list of replacement/completion
744 ``matches`` a list of replacement/completion
745
745
746 """
746 """
747 if not prefix:
747 if not prefix:
748 return None, 0, [repr(k) for k in keys
748 return None, 0, [repr(k) for k in keys
749 if isinstance(k, (str, bytes))]
749 if isinstance(k, (str, bytes))]
750 quote_match = re.search('["\']', prefix)
750 quote_match = re.search('["\']', prefix)
751 quote = quote_match.group()
751 quote = quote_match.group()
752 try:
752 try:
753 prefix_str = eval(prefix + quote, {})
753 prefix_str = eval(prefix + quote, {})
754 except Exception:
754 except Exception:
755 return None, 0, []
755 return None, 0, []
756
756
757 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
757 pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$'
758 token_match = re.search(pattern, prefix, re.UNICODE)
758 token_match = re.search(pattern, prefix, re.UNICODE)
759 token_start = token_match.start()
759 token_start = token_match.start()
760 token_prefix = token_match.group()
760 token_prefix = token_match.group()
761
761
762 matched = []
762 matched = []
763 for key in keys:
763 for key in keys:
764 try:
764 try:
765 if not key.startswith(prefix_str):
765 if not key.startswith(prefix_str):
766 continue
766 continue
767 except (AttributeError, TypeError, UnicodeError):
767 except (AttributeError, TypeError, UnicodeError):
768 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
768 # Python 3+ TypeError on b'a'.startswith('a') or vice-versa
769 continue
769 continue
770
770
771 # reformat remainder of key to begin with prefix
771 # reformat remainder of key to begin with prefix
772 rem = key[len(prefix_str):]
772 rem = key[len(prefix_str):]
773 # force repr wrapped in '
773 # force repr wrapped in '
774 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
774 rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"')
775 if rem_repr.startswith('u') and prefix[0] not in 'uU':
775 if rem_repr.startswith('u') and prefix[0] not in 'uU':
776 # Found key is unicode, but prefix is Py2 string.
776 # Found key is unicode, but prefix is Py2 string.
777 # Therefore attempt to interpret key as string.
777 # Therefore attempt to interpret key as string.
778 try:
778 try:
779 rem_repr = repr(rem.encode('ascii') + '"')
779 rem_repr = repr(rem.encode('ascii') + '"')
780 except UnicodeEncodeError:
780 except UnicodeEncodeError:
781 continue
781 continue
782
782
783 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
783 rem_repr = rem_repr[1 + rem_repr.index("'"):-2]
784 if quote == '"':
784 if quote == '"':
785 # The entered prefix is quoted with ",
785 # The entered prefix is quoted with ",
786 # but the match is quoted with '.
786 # but the match is quoted with '.
787 # A contained " hence needs escaping for comparison:
787 # A contained " hence needs escaping for comparison:
788 rem_repr = rem_repr.replace('"', '\\"')
788 rem_repr = rem_repr.replace('"', '\\"')
789
789
790 # then reinsert prefix from start of token
790 # then reinsert prefix from start of token
791 matched.append('%s%s' % (token_prefix, rem_repr))
791 matched.append('%s%s' % (token_prefix, rem_repr))
792 return quote, token_start, matched
792 return quote, token_start, matched
793
793
794
794
795 def cursor_to_position(text:int, line:int, column:int)->int:
795 def cursor_to_position(text:int, line:int, column:int)->int:
796 """
796 """
797
797
798 Convert the (line,column) position of the cursor in text to an offset in a
798 Convert the (line,column) position of the cursor in text to an offset in a
799 string.
799 string.
800
800
801 Parameters
801 Parameters
802 ----------
802 ----------
803
803
804 text : str
804 text : str
805 The text in which to calculate the cursor offset
805 The text in which to calculate the cursor offset
806 line : int
806 line : int
807 Line of the cursor; 0-indexed
807 Line of the cursor; 0-indexed
808 column : int
808 column : int
809 Column of the cursor 0-indexed
809 Column of the cursor 0-indexed
810
810
811 Return
811 Return
812 ------
812 ------
813 Position of the cursor in ``text``, 0-indexed.
813 Position of the cursor in ``text``, 0-indexed.
814
814
815 See Also
815 See Also
816 --------
816 --------
817 position_to_cursor: reciprocal of this function
817 position_to_cursor: reciprocal of this function
818
818
819 """
819 """
820 lines = text.split('\n')
820 lines = text.split('\n')
821 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
821 assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines)))
822
822
823 return sum(len(l) + 1 for l in lines[:line]) + column
823 return sum(len(l) + 1 for l in lines[:line]) + column
824
824
825 def position_to_cursor(text:str, offset:int)->(int, int):
825 def position_to_cursor(text:str, offset:int)->(int, int):
826 """
826 """
827 Convert the position of the cursor in text (0 indexed) to a line
827 Convert the position of the cursor in text (0 indexed) to a line
828 number(0-indexed) and a column number (0-indexed) pair
828 number(0-indexed) and a column number (0-indexed) pair
829
829
830 Position should be a valid position in ``text``.
830 Position should be a valid position in ``text``.
831
831
832 Parameters
832 Parameters
833 ----------
833 ----------
834
834
835 text : str
835 text : str
836 The text in which to calculate the cursor offset
836 The text in which to calculate the cursor offset
837 offset : int
837 offset : int
838 Position of the cursor in ``text``, 0-indexed.
838 Position of the cursor in ``text``, 0-indexed.
839
839
840 Return
840 Return
841 ------
841 ------
842 (line, column) : (int, int)
842 (line, column) : (int, int)
843 Line of the cursor; 0-indexed, column of the cursor 0-indexed
843 Line of the cursor; 0-indexed, column of the cursor 0-indexed
844
844
845
845
846 See Also
846 See Also
847 --------
847 --------
848 cursor_to_position : reciprocal of this function
848 cursor_to_position : reciprocal of this function
849
849
850
850
851 """
851 """
852
852
853 assert 0 < offset <= len(text) , "0 < %s <= %s" % (offset , len(text))
853 assert 0 < offset <= len(text) , "0 < %s <= %s" % (offset , len(text))
854
854
855 before = text[:offset]
855 before = text[:offset]
856 blines = before.split('\n') # ! splitnes trim trailing \n
856 blines = before.split('\n') # ! splitnes trim trailing \n
857 line = before.count('\n')
857 line = before.count('\n')
858 col = len(blines[-1])
858 col = len(blines[-1])
859 return line, col
859 return line, col
860
860
861
861
862 def _safe_isinstance(obj, module, class_name):
862 def _safe_isinstance(obj, module, class_name):
863 """Checks if obj is an instance of module.class_name if loaded
863 """Checks if obj is an instance of module.class_name if loaded
864 """
864 """
865 return (module in sys.modules and
865 return (module in sys.modules and
866 isinstance(obj, getattr(import_module(module), class_name)))
866 isinstance(obj, getattr(import_module(module), class_name)))
867
867
868
868
869 def back_unicode_name_matches(text):
869 def back_unicode_name_matches(text):
870 u"""Match unicode characters back to unicode name
870 u"""Match unicode characters back to unicode name
871
871
872 This does ``β˜ƒ`` -> ``\\snowman``
872 This does ``β˜ƒ`` -> ``\\snowman``
873
873
874 Note that snowman is not a valid python3 combining character but will be expanded.
874 Note that snowman is not a valid python3 combining character but will be expanded.
875 Though it will not recombine back to the snowman character by the completion machinery.
875 Though it will not recombine back to the snowman character by the completion machinery.
876
876
877 This will not either back-complete standard sequences like \\n, \\b ...
877 This will not either back-complete standard sequences like \\n, \\b ...
878
878
879 Used on Python 3 only.
879 Used on Python 3 only.
880 """
880 """
881 if len(text)<2:
881 if len(text)<2:
882 return u'', ()
882 return u'', ()
883 maybe_slash = text[-2]
883 maybe_slash = text[-2]
884 if maybe_slash != '\\':
884 if maybe_slash != '\\':
885 return u'', ()
885 return u'', ()
886
886
887 char = text[-1]
887 char = text[-1]
888 # no expand on quote for completion in strings.
888 # no expand on quote for completion in strings.
889 # nor backcomplete standard ascii keys
889 # nor backcomplete standard ascii keys
890 if char in string.ascii_letters or char in ['"',"'"]:
890 if char in string.ascii_letters or char in ['"',"'"]:
891 return u'', ()
891 return u'', ()
892 try :
892 try :
893 unic = unicodedata.name(char)
893 unic = unicodedata.name(char)
894 return '\\'+char,['\\'+unic]
894 return '\\'+char,['\\'+unic]
895 except KeyError:
895 except KeyError:
896 pass
896 pass
897 return u'', ()
897 return u'', ()
898
898
899 def back_latex_name_matches(text:str):
899 def back_latex_name_matches(text:str):
900 """Match latex characters back to unicode name
900 """Match latex characters back to unicode name
901
901
902 This does ``\\β„΅`` -> ``\\aleph``
902 This does ``\\β„΅`` -> ``\\aleph``
903
903
904 Used on Python 3 only.
904 Used on Python 3 only.
905 """
905 """
906 if len(text)<2:
906 if len(text)<2:
907 return u'', ()
907 return u'', ()
908 maybe_slash = text[-2]
908 maybe_slash = text[-2]
909 if maybe_slash != '\\':
909 if maybe_slash != '\\':
910 return u'', ()
910 return u'', ()
911
911
912
912
913 char = text[-1]
913 char = text[-1]
914 # no expand on quote for completion in strings.
914 # no expand on quote for completion in strings.
915 # nor backcomplete standard ascii keys
915 # nor backcomplete standard ascii keys
916 if char in string.ascii_letters or char in ['"',"'"]:
916 if char in string.ascii_letters or char in ['"',"'"]:
917 return u'', ()
917 return u'', ()
918 try :
918 try :
919 latex = reverse_latex_symbol[char]
919 latex = reverse_latex_symbol[char]
920 # '\\' replace the \ as well
920 # '\\' replace the \ as well
921 return '\\'+char,[latex]
921 return '\\'+char,[latex]
922 except KeyError:
922 except KeyError:
923 pass
923 pass
924 return u'', ()
924 return u'', ()
925
925
926
926
927 class IPCompleter(Completer):
927 class IPCompleter(Completer):
928 """Extension of the completer class with IPython-specific features"""
928 """Extension of the completer class with IPython-specific features"""
929
929
930 @observe('greedy')
930 @observe('greedy')
931 def _greedy_changed(self, change):
931 def _greedy_changed(self, change):
932 """update the splitter and readline delims when greedy is changed"""
932 """update the splitter and readline delims when greedy is changed"""
933 if change['new']:
933 if change['new']:
934 self.splitter.delims = GREEDY_DELIMS
934 self.splitter.delims = GREEDY_DELIMS
935 else:
935 else:
936 self.splitter.delims = DELIMS
936 self.splitter.delims = DELIMS
937
937
938 merge_completions = Bool(True,
938 merge_completions = Bool(True,
939 help="""Whether to merge completion results into a single list
939 help="""Whether to merge completion results into a single list
940
940
941 If False, only the completion results from the first non-empty
941 If False, only the completion results from the first non-empty
942 completer will be returned.
942 completer will be returned.
943 """
943 """
944 ).tag(config=True)
944 ).tag(config=True)
945 omit__names = Enum((0,1,2), default_value=2,
945 omit__names = Enum((0,1,2), default_value=2,
946 help="""Instruct the completer to omit private method names
946 help="""Instruct the completer to omit private method names
947
947
948 Specifically, when completing on ``object.<tab>``.
948 Specifically, when completing on ``object.<tab>``.
949
949
950 When 2 [default]: all names that start with '_' will be excluded.
950 When 2 [default]: all names that start with '_' will be excluded.
951
951
952 When 1: all 'magic' names (``__foo__``) will be excluded.
952 When 1: all 'magic' names (``__foo__``) will be excluded.
953
953
954 When 0: nothing will be excluded.
954 When 0: nothing will be excluded.
955 """
955 """
956 ).tag(config=True)
956 ).tag(config=True)
957 limit_to__all__ = Bool(False,
957 limit_to__all__ = Bool(False,
958 help="""
958 help="""
959 DEPRECATED as of version 5.0.
959 DEPRECATED as of version 5.0.
960
960
961 Instruct the completer to use __all__ for the completion
961 Instruct the completer to use __all__ for the completion
962
962
963 Specifically, when completing on ``object.<tab>``.
963 Specifically, when completing on ``object.<tab>``.
964
964
965 When True: only those names in obj.__all__ will be included.
965 When True: only those names in obj.__all__ will be included.
966
966
967 When False [default]: the __all__ attribute is ignored
967 When False [default]: the __all__ attribute is ignored
968 """,
968 """,
969 ).tag(config=True)
969 ).tag(config=True)
970
970
971 @observe('limit_to__all__')
971 @observe('limit_to__all__')
972 def _limit_to_all_changed(self, change):
972 def _limit_to_all_changed(self, change):
973 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
973 warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration '
974 'value has been deprecated since IPython 5.0, will be made to have '
974 'value has been deprecated since IPython 5.0, will be made to have '
975 'no effects and then removed in future version of IPython.',
975 'no effects and then removed in future version of IPython.',
976 UserWarning)
976 UserWarning)
977
977
978 def __init__(self, shell=None, namespace=None, global_namespace=None,
978 def __init__(self, shell=None, namespace=None, global_namespace=None,
979 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
979 use_readline=_deprecation_readline_sentinel, config=None, **kwargs):
980 """IPCompleter() -> completer
980 """IPCompleter() -> completer
981
981
982 Return a completer object.
982 Return a completer object.
983
983
984 Parameters
984 Parameters
985 ----------
985 ----------
986
986
987 shell
987 shell
988 a pointer to the ipython shell itself. This is needed
988 a pointer to the ipython shell itself. This is needed
989 because this completer knows about magic functions, and those can
989 because this completer knows about magic functions, and those can
990 only be accessed via the ipython instance.
990 only be accessed via the ipython instance.
991
991
992 namespace : dict, optional
992 namespace : dict, optional
993 an optional dict where completions are performed.
993 an optional dict where completions are performed.
994
994
995 global_namespace : dict, optional
995 global_namespace : dict, optional
996 secondary optional dict for completions, to
996 secondary optional dict for completions, to
997 handle cases (such as IPython embedded inside functions) where
997 handle cases (such as IPython embedded inside functions) where
998 both Python scopes are visible.
998 both Python scopes are visible.
999
999
1000 use_readline : bool, optional
1000 use_readline : bool, optional
1001 DEPRECATED, ignored since IPython 6.0, will have no effects
1001 DEPRECATED, ignored since IPython 6.0, will have no effects
1002 """
1002 """
1003
1003
1004 self.magic_escape = ESC_MAGIC
1004 self.magic_escape = ESC_MAGIC
1005 self.splitter = CompletionSplitter()
1005 self.splitter = CompletionSplitter()
1006
1006
1007 if use_readline is not _deprecation_readline_sentinel:
1007 if use_readline is not _deprecation_readline_sentinel:
1008 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1008 warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.',
1009 DeprecationWarning, stacklevel=2)
1009 DeprecationWarning, stacklevel=2)
1010
1010
1011 # _greedy_changed() depends on splitter and readline being defined:
1011 # _greedy_changed() depends on splitter and readline being defined:
1012 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1012 Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
1013 config=config, **kwargs)
1013 config=config, **kwargs)
1014
1014
1015 # List where completion matches will be stored
1015 # List where completion matches will be stored
1016 self.matches = []
1016 self.matches = []
1017 self.shell = shell
1017 self.shell = shell
1018 # Regexp to split filenames with spaces in them
1018 # Regexp to split filenames with spaces in them
1019 self.space_name_re = re.compile(r'([^\\] )')
1019 self.space_name_re = re.compile(r'([^\\] )')
1020 # Hold a local ref. to glob.glob for speed
1020 # Hold a local ref. to glob.glob for speed
1021 self.glob = glob.glob
1021 self.glob = glob.glob
1022
1022
1023 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1023 # Determine if we are running on 'dumb' terminals, like (X)Emacs
1024 # buffers, to avoid completion problems.
1024 # buffers, to avoid completion problems.
1025 term = os.environ.get('TERM','xterm')
1025 term = os.environ.get('TERM','xterm')
1026 self.dumb_terminal = term in ['dumb','emacs']
1026 self.dumb_terminal = term in ['dumb','emacs']
1027
1027
1028 # Special handling of backslashes needed in win32 platforms
1028 # Special handling of backslashes needed in win32 platforms
1029 if sys.platform == "win32":
1029 if sys.platform == "win32":
1030 self.clean_glob = self._clean_glob_win32
1030 self.clean_glob = self._clean_glob_win32
1031 else:
1031 else:
1032 self.clean_glob = self._clean_glob
1032 self.clean_glob = self._clean_glob
1033
1033
1034 #regexp to parse docstring for function signature
1034 #regexp to parse docstring for function signature
1035 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1035 self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1036 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1036 self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1037 #use this if positional argument name is also needed
1037 #use this if positional argument name is also needed
1038 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1038 #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)')
1039
1039
1040 # All active matcher routines for completion
1040 # All active matcher routines for completion
1041 self.matchers = [
1041 self.matchers = [
1042 self.python_matches,
1042 self.python_matches,
1043 self.file_matches,
1043 self.file_matches,
1044 self.magic_matches,
1044 self.magic_matches,
1045 self.python_func_kw_matches,
1045 self.python_func_kw_matches,
1046 self.dict_key_matches,
1046 self.dict_key_matches,
1047 ]
1047 ]
1048
1048
1049 # This is set externally by InteractiveShell
1049 # This is set externally by InteractiveShell
1050 self.custom_completers = None
1050 self.custom_completers = None
1051
1051
1052 def all_completions(self, text):
1052 def all_completions(self, text):
1053 """
1053 """
1054 Wrapper around the complete method for the benefit of emacs.
1054 Wrapper around the complete method for the benefit of emacs.
1055 """
1055 """
1056 return self.complete(text)[1]
1056 return self.complete(text)[1]
1057
1057
1058 def _clean_glob(self, text):
1058 def _clean_glob(self, text):
1059 return self.glob("%s*" % text)
1059 return self.glob("%s*" % text)
1060
1060
1061 def _clean_glob_win32(self,text):
1061 def _clean_glob_win32(self,text):
1062 return [f.replace("\\","/")
1062 return [f.replace("\\","/")
1063 for f in self.glob("%s*" % text)]
1063 for f in self.glob("%s*" % text)]
1064
1064
1065 def file_matches(self, text):
1065 def file_matches(self, text):
1066 """Match filenames, expanding ~USER type strings.
1066 """Match filenames, expanding ~USER type strings.
1067
1067
1068 Most of the seemingly convoluted logic in this completer is an
1068 Most of the seemingly convoluted logic in this completer is an
1069 attempt to handle filenames with spaces in them. And yet it's not
1069 attempt to handle filenames with spaces in them. And yet it's not
1070 quite perfect, because Python's readline doesn't expose all of the
1070 quite perfect, because Python's readline doesn't expose all of the
1071 GNU readline details needed for this to be done correctly.
1071 GNU readline details needed for this to be done correctly.
1072
1072
1073 For a filename with a space in it, the printed completions will be
1073 For a filename with a space in it, the printed completions will be
1074 only the parts after what's already been typed (instead of the
1074 only the parts after what's already been typed (instead of the
1075 full completions, as is normally done). I don't think with the
1075 full completions, as is normally done). I don't think with the
1076 current (as of Python 2.3) Python readline it's possible to do
1076 current (as of Python 2.3) Python readline it's possible to do
1077 better."""
1077 better."""
1078
1078
1079 # chars that require escaping with backslash - i.e. chars
1079 # chars that require escaping with backslash - i.e. chars
1080 # that readline treats incorrectly as delimiters, but we
1080 # that readline treats incorrectly as delimiters, but we
1081 # don't want to treat as delimiters in filename matching
1081 # don't want to treat as delimiters in filename matching
1082 # when escaped with backslash
1082 # when escaped with backslash
1083 if text.startswith('!'):
1083 if text.startswith('!'):
1084 text = text[1:]
1084 text = text[1:]
1085 text_prefix = u'!'
1085 text_prefix = u'!'
1086 else:
1086 else:
1087 text_prefix = u''
1087 text_prefix = u''
1088
1088
1089 text_until_cursor = self.text_until_cursor
1089 text_until_cursor = self.text_until_cursor
1090 # track strings with open quotes
1090 # track strings with open quotes
1091 open_quotes = has_open_quotes(text_until_cursor)
1091 open_quotes = has_open_quotes(text_until_cursor)
1092
1092
1093 if '(' in text_until_cursor or '[' in text_until_cursor:
1093 if '(' in text_until_cursor or '[' in text_until_cursor:
1094 lsplit = text
1094 lsplit = text
1095 else:
1095 else:
1096 try:
1096 try:
1097 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1097 # arg_split ~ shlex.split, but with unicode bugs fixed by us
1098 lsplit = arg_split(text_until_cursor)[-1]
1098 lsplit = arg_split(text_until_cursor)[-1]
1099 except ValueError:
1099 except ValueError:
1100 # typically an unmatched ", or backslash without escaped char.
1100 # typically an unmatched ", or backslash without escaped char.
1101 if open_quotes:
1101 if open_quotes:
1102 lsplit = text_until_cursor.split(open_quotes)[-1]
1102 lsplit = text_until_cursor.split(open_quotes)[-1]
1103 else:
1103 else:
1104 return []
1104 return []
1105 except IndexError:
1105 except IndexError:
1106 # tab pressed on empty line
1106 # tab pressed on empty line
1107 lsplit = ""
1107 lsplit = ""
1108
1108
1109 if not open_quotes and lsplit != protect_filename(lsplit):
1109 if not open_quotes and lsplit != protect_filename(lsplit):
1110 # if protectables are found, do matching on the whole escaped name
1110 # if protectables are found, do matching on the whole escaped name
1111 has_protectables = True
1111 has_protectables = True
1112 text0,text = text,lsplit
1112 text0,text = text,lsplit
1113 else:
1113 else:
1114 has_protectables = False
1114 has_protectables = False
1115 text = os.path.expanduser(text)
1115 text = os.path.expanduser(text)
1116
1116
1117 if text == "":
1117 if text == "":
1118 return [text_prefix + cast_unicode_py2(protect_filename(f)) for f in self.glob("*")]
1118 return [text_prefix + cast_unicode_py2(protect_filename(f)) for f in self.glob("*")]
1119
1119
1120 # Compute the matches from the filesystem
1120 # Compute the matches from the filesystem
1121 if sys.platform == 'win32':
1121 if sys.platform == 'win32':
1122 m0 = self.clean_glob(text)
1122 m0 = self.clean_glob(text)
1123 else:
1123 else:
1124 m0 = self.clean_glob(text.replace('\\', ''))
1124 m0 = self.clean_glob(text.replace('\\', ''))
1125
1125
1126 if has_protectables:
1126 if has_protectables:
1127 # If we had protectables, we need to revert our changes to the
1127 # If we had protectables, we need to revert our changes to the
1128 # beginning of filename so that we don't double-write the part
1128 # beginning of filename so that we don't double-write the part
1129 # of the filename we have so far
1129 # of the filename we have so far
1130 len_lsplit = len(lsplit)
1130 len_lsplit = len(lsplit)
1131 matches = [text_prefix + text0 +
1131 matches = [text_prefix + text0 +
1132 protect_filename(f[len_lsplit:]) for f in m0]
1132 protect_filename(f[len_lsplit:]) for f in m0]
1133 else:
1133 else:
1134 if open_quotes:
1134 if open_quotes:
1135 # if we have a string with an open quote, we don't need to
1135 # if we have a string with an open quote, we don't need to
1136 # protect the names at all (and we _shouldn't_, as it
1136 # protect the names at all (and we _shouldn't_, as it
1137 # would cause bugs when the filesystem call is made).
1137 # would cause bugs when the filesystem call is made).
1138 matches = m0
1138 matches = m0
1139 else:
1139 else:
1140 matches = [text_prefix +
1140 matches = [text_prefix +
1141 protect_filename(f) for f in m0]
1141 protect_filename(f) for f in m0]
1142
1142
1143 # Mark directories in input list by appending '/' to their names.
1143 # Mark directories in input list by appending '/' to their names.
1144 return [cast_unicode_py2(x+'/') if os.path.isdir(x) else x for x in matches]
1144 return [cast_unicode_py2(x+'/') if os.path.isdir(x) else x for x in matches]
1145
1145
1146 def magic_matches(self, text):
1146 def magic_matches(self, text):
1147 """Match magics"""
1147 """Match magics"""
1148 # Get all shell magics now rather than statically, so magics loaded at
1148 # Get all shell magics now rather than statically, so magics loaded at
1149 # runtime show up too.
1149 # runtime show up too.
1150 lsm = self.shell.magics_manager.lsmagic()
1150 lsm = self.shell.magics_manager.lsmagic()
1151 line_magics = lsm['line']
1151 line_magics = lsm['line']
1152 cell_magics = lsm['cell']
1152 cell_magics = lsm['cell']
1153 pre = self.magic_escape
1153 pre = self.magic_escape
1154 pre2 = pre+pre
1154 pre2 = pre+pre
1155
1155
1156 # Completion logic:
1156 # Completion logic:
1157 # - user gives %%: only do cell magics
1157 # - user gives %%: only do cell magics
1158 # - user gives %: do both line and cell magics
1158 # - user gives %: do both line and cell magics
1159 # - no prefix: do both
1159 # - no prefix: do both
1160 # In other words, line magics are skipped if the user gives %% explicitly
1160 # In other words, line magics are skipped if the user gives %% explicitly
1161 bare_text = text.lstrip(pre)
1161 bare_text = text.lstrip(pre)
1162 comp = [ pre2+m for m in cell_magics if m.startswith(bare_text)]
1162 comp = [ pre2+m for m in cell_magics if m.startswith(bare_text)]
1163 if not text.startswith(pre2):
1163 if not text.startswith(pre2):
1164 comp += [ pre+m for m in line_magics if m.startswith(bare_text)]
1164 comp += [ pre+m for m in line_magics if m.startswith(bare_text)]
1165 return [cast_unicode_py2(c) for c in comp]
1165 return [cast_unicode_py2(c) for c in comp]
1166
1166
1167 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1167 def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str):
1168 """
1168 """
1169
1169
1170 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1170 Return a list of :any:`jedi.api.Completions` object from a ``text`` and
1171 cursor position.
1171 cursor position.
1172
1172
1173 Parameters
1173 Parameters
1174 ----------
1174 ----------
1175 cursor_column : int
1175 cursor_column : int
1176 column position of the cursor in ``text``, 0-indexed.
1176 column position of the cursor in ``text``, 0-indexed.
1177 cursor_line : int
1177 cursor_line : int
1178 line position of the cursor in ``text``, 0-indexed
1178 line position of the cursor in ``text``, 0-indexed
1179 text : str
1179 text : str
1180 text to complete
1180 text to complete
1181
1181
1182 Debugging
1182 Debugging
1183 ---------
1183 ---------
1184
1184
1185 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1185 If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion`
1186 object containing a string with the Jedi debug information attached.
1186 object containing a string with the Jedi debug information attached.
1187 """
1187 """
1188 namespaces = [self.namespace]
1188 namespaces = [self.namespace]
1189 if self.global_namespace is not None:
1189 if self.global_namespace is not None:
1190 namespaces.append(self.global_namespace)
1190 namespaces.append(self.global_namespace)
1191
1191
1192 completion_filter = lambda x:x
1192 completion_filter = lambda x:x
1193 # cursor_pos is an it, jedi wants line and column
1193 # cursor_pos is an it, jedi wants line and column
1194 offset = cursor_to_position(text, cursor_line, cursor_column)
1194 offset = cursor_to_position(text, cursor_line, cursor_column)
1195 # filter output if we are completing for object members
1195 # filter output if we are completing for object members
1196 if offset:
1196 if offset:
1197 pre = text[offset-1]
1197 pre = text[offset-1]
1198 if pre == '.':
1198 if pre == '.':
1199 if self.omit__names == 2:
1199 if self.omit__names == 2:
1200 completion_filter = lambda c:not c.name.startswith('_')
1200 completion_filter = lambda c:not c.name.startswith('_')
1201 elif self.omit__names == 1:
1201 elif self.omit__names == 1:
1202 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1202 completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__'))
1203 elif self.omit__names == 0:
1203 elif self.omit__names == 0:
1204 completion_filter = lambda x:x
1204 completion_filter = lambda x:x
1205 else:
1205 else:
1206 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1206 raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names))
1207
1207
1208 interpreter = jedi.Interpreter(
1208 interpreter = jedi.Interpreter(
1209 text, namespaces, column=cursor_column, line=cursor_line + 1)
1209 text, namespaces, column=cursor_column, line=cursor_line + 1)
1210
1210
1211 try_jedi = False
1211 try_jedi = False
1212
1212
1213 try:
1213 try:
1214 # should we check the type of the node is Error ?
1214 # should we check the type of the node is Error ?
1215 from jedi.parser.tree import ErrorLeaf
1215 from jedi.parser.tree import ErrorLeaf
1216 next_to_last_tree = interpreter._get_module().tree_node.children[-2]
1216 next_to_last_tree = interpreter._get_module().tree_node.children[-2]
1217 completing_string = False
1217 completing_string = False
1218 if isinstance(next_to_last_tree, ErrorLeaf):
1218 if isinstance(next_to_last_tree, ErrorLeaf):
1219 completing_string = interpreter._get_module().tree_node.children[-2].value[0] in {'"', "'"}
1219 completing_string = interpreter._get_module().tree_node.children[-2].value[0] in {'"', "'"}
1220 # if we are in a string jedi is likely not the right candidate for
1220 # if we are in a string jedi is likely not the right candidate for
1221 # now. Skip it.
1221 # now. Skip it.
1222 try_jedi = not completing_string
1222 try_jedi = not completing_string
1223 except Exception as e:
1223 except Exception as e:
1224 # many of things can go wrong, we are using private API just don't crash.
1224 # many of things can go wrong, we are using private API just don't crash.
1225 if self.debug:
1225 if self.debug:
1226 print("Error detecting if completing a non-finished string :", e, '|')
1226 print("Error detecting if completing a non-finished string :", e, '|')
1227
1227
1228 if not try_jedi:
1228 if not try_jedi:
1229 return []
1229 return []
1230 try:
1230 try:
1231 return filter(completion_filter, interpreter.completions())
1231 return filter(completion_filter, interpreter.completions())
1232 except Exception as e:
1232 except Exception as e:
1233 if self.debug:
1233 if self.debug:
1234 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1234 return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))]
1235 else:
1235 else:
1236 return []
1236 return []
1237
1237
1238 def python_matches(self, text):
1238 def python_matches(self, text):
1239 """Match attributes or global python names"""
1239 """Match attributes or global python names"""
1240 if "." in text:
1240 if "." in text:
1241 try:
1241 try:
1242 matches = self.attr_matches(text)
1242 matches = self.attr_matches(text)
1243 if text.endswith('.') and self.omit__names:
1243 if text.endswith('.') and self.omit__names:
1244 if self.omit__names == 1:
1244 if self.omit__names == 1:
1245 # true if txt is _not_ a __ name, false otherwise:
1245 # true if txt is _not_ a __ name, false otherwise:
1246 no__name = (lambda txt:
1246 no__name = (lambda txt:
1247 re.match(r'.*\.__.*?__',txt) is None)
1247 re.match(r'.*\.__.*?__',txt) is None)
1248 else:
1248 else:
1249 # true if txt is _not_ a _ name, false otherwise:
1249 # true if txt is _not_ a _ name, false otherwise:
1250 no__name = (lambda txt:
1250 no__name = (lambda txt:
1251 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1251 re.match(r'\._.*?',txt[txt.rindex('.'):]) is None)
1252 matches = filter(no__name, matches)
1252 matches = filter(no__name, matches)
1253 except NameError:
1253 except NameError:
1254 # catches <undefined attributes>.<tab>
1254 # catches <undefined attributes>.<tab>
1255 matches = []
1255 matches = []
1256 else:
1256 else:
1257 matches = self.global_matches(text)
1257 matches = self.global_matches(text)
1258 return matches
1258 return matches
1259
1259
1260 def _default_arguments_from_docstring(self, doc):
1260 def _default_arguments_from_docstring(self, doc):
1261 """Parse the first line of docstring for call signature.
1261 """Parse the first line of docstring for call signature.
1262
1262
1263 Docstring should be of the form 'min(iterable[, key=func])\n'.
1263 Docstring should be of the form 'min(iterable[, key=func])\n'.
1264 It can also parse cython docstring of the form
1264 It can also parse cython docstring of the form
1265 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1265 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'.
1266 """
1266 """
1267 if doc is None:
1267 if doc is None:
1268 return []
1268 return []
1269
1269
1270 #care only the firstline
1270 #care only the firstline
1271 line = doc.lstrip().splitlines()[0]
1271 line = doc.lstrip().splitlines()[0]
1272
1272
1273 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1273 #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*')
1274 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1274 #'min(iterable[, key=func])\n' -> 'iterable[, key=func]'
1275 sig = self.docstring_sig_re.search(line)
1275 sig = self.docstring_sig_re.search(line)
1276 if sig is None:
1276 if sig is None:
1277 return []
1277 return []
1278 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1278 # iterable[, key=func]' -> ['iterable[' ,' key=func]']
1279 sig = sig.groups()[0].split(',')
1279 sig = sig.groups()[0].split(',')
1280 ret = []
1280 ret = []
1281 for s in sig:
1281 for s in sig:
1282 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1282 #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)')
1283 ret += self.docstring_kwd_re.findall(s)
1283 ret += self.docstring_kwd_re.findall(s)
1284 return ret
1284 return ret
1285
1285
1286 def _default_arguments(self, obj):
1286 def _default_arguments(self, obj):
1287 """Return the list of default arguments of obj if it is callable,
1287 """Return the list of default arguments of obj if it is callable,
1288 or empty list otherwise."""
1288 or empty list otherwise."""
1289 call_obj = obj
1289 call_obj = obj
1290 ret = []
1290 ret = []
1291 if inspect.isbuiltin(obj):
1291 if inspect.isbuiltin(obj):
1292 pass
1292 pass
1293 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1293 elif not (inspect.isfunction(obj) or inspect.ismethod(obj)):
1294 if inspect.isclass(obj):
1294 if inspect.isclass(obj):
1295 #for cython embededsignature=True the constructor docstring
1295 #for cython embededsignature=True the constructor docstring
1296 #belongs to the object itself not __init__
1296 #belongs to the object itself not __init__
1297 ret += self._default_arguments_from_docstring(
1297 ret += self._default_arguments_from_docstring(
1298 getattr(obj, '__doc__', ''))
1298 getattr(obj, '__doc__', ''))
1299 # for classes, check for __init__,__new__
1299 # for classes, check for __init__,__new__
1300 call_obj = (getattr(obj, '__init__', None) or
1300 call_obj = (getattr(obj, '__init__', None) or
1301 getattr(obj, '__new__', None))
1301 getattr(obj, '__new__', None))
1302 # for all others, check if they are __call__able
1302 # for all others, check if they are __call__able
1303 elif hasattr(obj, '__call__'):
1303 elif hasattr(obj, '__call__'):
1304 call_obj = obj.__call__
1304 call_obj = obj.__call__
1305 ret += self._default_arguments_from_docstring(
1305 ret += self._default_arguments_from_docstring(
1306 getattr(call_obj, '__doc__', ''))
1306 getattr(call_obj, '__doc__', ''))
1307
1307
1308 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1308 _keeps = (inspect.Parameter.KEYWORD_ONLY,
1309 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1309 inspect.Parameter.POSITIONAL_OR_KEYWORD)
1310
1310
1311 try:
1311 try:
1312 sig = inspect.signature(call_obj)
1312 sig = inspect.signature(call_obj)
1313 ret.extend(k for k, v in sig.parameters.items() if
1313 ret.extend(k for k, v in sig.parameters.items() if
1314 v.kind in _keeps)
1314 v.kind in _keeps)
1315 except ValueError:
1315 except ValueError:
1316 pass
1316 pass
1317
1317
1318 return list(set(ret))
1318 return list(set(ret))
1319
1319
1320 def python_func_kw_matches(self,text):
1320 def python_func_kw_matches(self,text):
1321 """Match named parameters (kwargs) of the last open function"""
1321 """Match named parameters (kwargs) of the last open function"""
1322
1322
1323 if "." in text: # a parameter cannot be dotted
1323 if "." in text: # a parameter cannot be dotted
1324 return []
1324 return []
1325 try: regexp = self.__funcParamsRegex
1325 try: regexp = self.__funcParamsRegex
1326 except AttributeError:
1326 except AttributeError:
1327 regexp = self.__funcParamsRegex = re.compile(r'''
1327 regexp = self.__funcParamsRegex = re.compile(r'''
1328 '.*?(?<!\\)' | # single quoted strings or
1328 '.*?(?<!\\)' | # single quoted strings or
1329 ".*?(?<!\\)" | # double quoted strings or
1329 ".*?(?<!\\)" | # double quoted strings or
1330 \w+ | # identifier
1330 \w+ | # identifier
1331 \S # other characters
1331 \S # other characters
1332 ''', re.VERBOSE | re.DOTALL)
1332 ''', re.VERBOSE | re.DOTALL)
1333 # 1. find the nearest identifier that comes before an unclosed
1333 # 1. find the nearest identifier that comes before an unclosed
1334 # parenthesis before the cursor
1334 # parenthesis before the cursor
1335 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1335 # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo"
1336 tokens = regexp.findall(self.text_until_cursor)
1336 tokens = regexp.findall(self.text_until_cursor)
1337 iterTokens = reversed(tokens); openPar = 0
1337 iterTokens = reversed(tokens); openPar = 0
1338
1338
1339 for token in iterTokens:
1339 for token in iterTokens:
1340 if token == ')':
1340 if token == ')':
1341 openPar -= 1
1341 openPar -= 1
1342 elif token == '(':
1342 elif token == '(':
1343 openPar += 1
1343 openPar += 1
1344 if openPar > 0:
1344 if openPar > 0:
1345 # found the last unclosed parenthesis
1345 # found the last unclosed parenthesis
1346 break
1346 break
1347 else:
1347 else:
1348 return []
1348 return []
1349 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1349 # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" )
1350 ids = []
1350 ids = []
1351 isId = re.compile(r'\w+$').match
1351 isId = re.compile(r'\w+$').match
1352
1352
1353 while True:
1353 while True:
1354 try:
1354 try:
1355 ids.append(next(iterTokens))
1355 ids.append(next(iterTokens))
1356 if not isId(ids[-1]):
1356 if not isId(ids[-1]):
1357 ids.pop(); break
1357 ids.pop(); break
1358 if not next(iterTokens) == '.':
1358 if not next(iterTokens) == '.':
1359 break
1359 break
1360 except StopIteration:
1360 except StopIteration:
1361 break
1361 break
1362
1362
1363 # Find all named arguments already assigned to, as to avoid suggesting
1363 # Find all named arguments already assigned to, as to avoid suggesting
1364 # them again
1364 # them again
1365 usedNamedArgs = set()
1365 usedNamedArgs = set()
1366 par_level = -1
1366 par_level = -1
1367 for token, next_token in zip(tokens, tokens[1:]):
1367 for token, next_token in zip(tokens, tokens[1:]):
1368 if token == '(':
1368 if token == '(':
1369 par_level += 1
1369 par_level += 1
1370 elif token == ')':
1370 elif token == ')':
1371 par_level -= 1
1371 par_level -= 1
1372
1372
1373 if par_level != 0:
1373 if par_level != 0:
1374 continue
1374 continue
1375
1375
1376 if next_token != '=':
1376 if next_token != '=':
1377 continue
1377 continue
1378
1378
1379 usedNamedArgs.add(token)
1379 usedNamedArgs.add(token)
1380
1380
1381 # lookup the candidate callable matches either using global_matches
1381 # lookup the candidate callable matches either using global_matches
1382 # or attr_matches for dotted names
1382 # or attr_matches for dotted names
1383 if len(ids) == 1:
1383 if len(ids) == 1:
1384 callableMatches = self.global_matches(ids[0])
1384 callableMatches = self.global_matches(ids[0])
1385 else:
1385 else:
1386 callableMatches = self.attr_matches('.'.join(ids[::-1]))
1386 callableMatches = self.attr_matches('.'.join(ids[::-1]))
1387 argMatches = []
1387 argMatches = []
1388 for callableMatch in callableMatches:
1388 for callableMatch in callableMatches:
1389 try:
1389 try:
1390 namedArgs = self._default_arguments(eval(callableMatch,
1390 namedArgs = self._default_arguments(eval(callableMatch,
1391 self.namespace))
1391 self.namespace))
1392 except:
1392 except:
1393 continue
1393 continue
1394
1394
1395 # Remove used named arguments from the list, no need to show twice
1395 # Remove used named arguments from the list, no need to show twice
1396 for namedArg in set(namedArgs) - usedNamedArgs:
1396 for namedArg in set(namedArgs) - usedNamedArgs:
1397 if namedArg.startswith(text):
1397 if namedArg.startswith(text):
1398 argMatches.append(u"%s=" %namedArg)
1398 argMatches.append(u"%s=" %namedArg)
1399 return argMatches
1399 return argMatches
1400
1400
1401 def dict_key_matches(self, text):
1401 def dict_key_matches(self, text):
1402 "Match string keys in a dictionary, after e.g. 'foo[' "
1402 "Match string keys in a dictionary, after e.g. 'foo[' "
1403 def get_keys(obj):
1403 def get_keys(obj):
1404 # Objects can define their own completions by defining an
1404 # Objects can define their own completions by defining an
1405 # _ipy_key_completions_() method.
1405 # _ipy_key_completions_() method.
1406 method = get_real_method(obj, '_ipython_key_completions_')
1406 method = get_real_method(obj, '_ipython_key_completions_')
1407 if method is not None:
1407 if method is not None:
1408 return method()
1408 return method()
1409
1409
1410 # Special case some common in-memory dict-like types
1410 # Special case some common in-memory dict-like types
1411 if isinstance(obj, dict) or\
1411 if isinstance(obj, dict) or\
1412 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1412 _safe_isinstance(obj, 'pandas', 'DataFrame'):
1413 try:
1413 try:
1414 return list(obj.keys())
1414 return list(obj.keys())
1415 except Exception:
1415 except Exception:
1416 return []
1416 return []
1417 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1417 elif _safe_isinstance(obj, 'numpy', 'ndarray') or\
1418 _safe_isinstance(obj, 'numpy', 'void'):
1418 _safe_isinstance(obj, 'numpy', 'void'):
1419 return obj.dtype.names or []
1419 return obj.dtype.names or []
1420 return []
1420 return []
1421
1421
1422 try:
1422 try:
1423 regexps = self.__dict_key_regexps
1423 regexps = self.__dict_key_regexps
1424 except AttributeError:
1424 except AttributeError:
1425 dict_key_re_fmt = r'''(?x)
1425 dict_key_re_fmt = r'''(?x)
1426 ( # match dict-referring expression wrt greedy setting
1426 ( # match dict-referring expression wrt greedy setting
1427 %s
1427 %s
1428 )
1428 )
1429 \[ # open bracket
1429 \[ # open bracket
1430 \s* # and optional whitespace
1430 \s* # and optional whitespace
1431 ([uUbB]? # string prefix (r not handled)
1431 ([uUbB]? # string prefix (r not handled)
1432 (?: # unclosed string
1432 (?: # unclosed string
1433 '(?:[^']|(?<!\\)\\')*
1433 '(?:[^']|(?<!\\)\\')*
1434 |
1434 |
1435 "(?:[^"]|(?<!\\)\\")*
1435 "(?:[^"]|(?<!\\)\\")*
1436 )
1436 )
1437 )?
1437 )?
1438 $
1438 $
1439 '''
1439 '''
1440 regexps = self.__dict_key_regexps = {
1440 regexps = self.__dict_key_regexps = {
1441 False: re.compile(dict_key_re_fmt % '''
1441 False: re.compile(dict_key_re_fmt % '''
1442 # identifiers separated by .
1442 # identifiers separated by .
1443 (?!\d)\w+
1443 (?!\d)\w+
1444 (?:\.(?!\d)\w+)*
1444 (?:\.(?!\d)\w+)*
1445 '''),
1445 '''),
1446 True: re.compile(dict_key_re_fmt % '''
1446 True: re.compile(dict_key_re_fmt % '''
1447 .+
1447 .+
1448 ''')
1448 ''')
1449 }
1449 }
1450
1450
1451 match = regexps[self.greedy].search(self.text_until_cursor)
1451 match = regexps[self.greedy].search(self.text_until_cursor)
1452 if match is None:
1452 if match is None:
1453 return []
1453 return []
1454
1454
1455 expr, prefix = match.groups()
1455 expr, prefix = match.groups()
1456 try:
1456 try:
1457 obj = eval(expr, self.namespace)
1457 obj = eval(expr, self.namespace)
1458 except Exception:
1458 except Exception:
1459 try:
1459 try:
1460 obj = eval(expr, self.global_namespace)
1460 obj = eval(expr, self.global_namespace)
1461 except Exception:
1461 except Exception:
1462 return []
1462 return []
1463
1463
1464 keys = get_keys(obj)
1464 keys = get_keys(obj)
1465 if not keys:
1465 if not keys:
1466 return keys
1466 return keys
1467 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1467 closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims)
1468 if not matches:
1468 if not matches:
1469 return matches
1469 return matches
1470
1470
1471 # get the cursor position of
1471 # get the cursor position of
1472 # - the text being completed
1472 # - the text being completed
1473 # - the start of the key text
1473 # - the start of the key text
1474 # - the start of the completion
1474 # - the start of the completion
1475 text_start = len(self.text_until_cursor) - len(text)
1475 text_start = len(self.text_until_cursor) - len(text)
1476 if prefix:
1476 if prefix:
1477 key_start = match.start(2)
1477 key_start = match.start(2)
1478 completion_start = key_start + token_offset
1478 completion_start = key_start + token_offset
1479 else:
1479 else:
1480 key_start = completion_start = match.end()
1480 key_start = completion_start = match.end()
1481
1481
1482 # grab the leading prefix, to make sure all completions start with `text`
1482 # grab the leading prefix, to make sure all completions start with `text`
1483 if text_start > key_start:
1483 if text_start > key_start:
1484 leading = ''
1484 leading = ''
1485 else:
1485 else:
1486 leading = text[text_start:completion_start]
1486 leading = text[text_start:completion_start]
1487
1487
1488 # the index of the `[` character
1488 # the index of the `[` character
1489 bracket_idx = match.end(1)
1489 bracket_idx = match.end(1)
1490
1490
1491 # append closing quote and bracket as appropriate
1491 # append closing quote and bracket as appropriate
1492 # this is *not* appropriate if the opening quote or bracket is outside
1492 # this is *not* appropriate if the opening quote or bracket is outside
1493 # the text given to this method
1493 # the text given to this method
1494 suf = ''
1494 suf = ''
1495 continuation = self.line_buffer[len(self.text_until_cursor):]
1495 continuation = self.line_buffer[len(self.text_until_cursor):]
1496 if key_start > text_start and closing_quote:
1496 if key_start > text_start and closing_quote:
1497 # quotes were opened inside text, maybe close them
1497 # quotes were opened inside text, maybe close them
1498 if continuation.startswith(closing_quote):
1498 if continuation.startswith(closing_quote):
1499 continuation = continuation[len(closing_quote):]
1499 continuation = continuation[len(closing_quote):]
1500 else:
1500 else:
1501 suf += closing_quote
1501 suf += closing_quote
1502 if bracket_idx > text_start:
1502 if bracket_idx > text_start:
1503 # brackets were opened inside text, maybe close them
1503 # brackets were opened inside text, maybe close them
1504 if not continuation.startswith(']'):
1504 if not continuation.startswith(']'):
1505 suf += ']'
1505 suf += ']'
1506
1506
1507 return [leading + k + suf for k in matches]
1507 return [leading + k + suf for k in matches]
1508
1508
1509 def unicode_name_matches(self, text):
1509 def unicode_name_matches(self, text):
1510 u"""Match Latex-like syntax for unicode characters base
1510 u"""Match Latex-like syntax for unicode characters base
1511 on the name of the character.
1511 on the name of the character.
1512
1512
1513 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1513 This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·``
1514
1514
1515 Works only on valid python 3 identifier, or on combining characters that
1515 Works only on valid python 3 identifier, or on combining characters that
1516 will combine to form a valid identifier.
1516 will combine to form a valid identifier.
1517
1517
1518 Used on Python 3 only.
1518 Used on Python 3 only.
1519 """
1519 """
1520 slashpos = text.rfind('\\')
1520 slashpos = text.rfind('\\')
1521 if slashpos > -1:
1521 if slashpos > -1:
1522 s = text[slashpos+1:]
1522 s = text[slashpos+1:]
1523 try :
1523 try :
1524 unic = unicodedata.lookup(s)
1524 unic = unicodedata.lookup(s)
1525 # allow combining chars
1525 # allow combining chars
1526 if ('a'+unic).isidentifier():
1526 if ('a'+unic).isidentifier():
1527 return '\\'+s,[unic]
1527 return '\\'+s,[unic]
1528 except KeyError:
1528 except KeyError:
1529 pass
1529 pass
1530 return u'', []
1530 return u'', []
1531
1531
1532
1532
1533 def latex_matches(self, text):
1533 def latex_matches(self, text):
1534 u"""Match Latex syntax for unicode characters.
1534 u"""Match Latex syntax for unicode characters.
1535
1535
1536 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1536 This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±``
1537
1537
1538 Used on Python 3 only.
1538 Used on Python 3 only.
1539 """
1539 """
1540 slashpos = text.rfind('\\')
1540 slashpos = text.rfind('\\')
1541 if slashpos > -1:
1541 if slashpos > -1:
1542 s = text[slashpos:]
1542 s = text[slashpos:]
1543 if s in latex_symbols:
1543 if s in latex_symbols:
1544 # Try to complete a full latex symbol to unicode
1544 # Try to complete a full latex symbol to unicode
1545 # \\alpha -> Ξ±
1545 # \\alpha -> Ξ±
1546 return s, [latex_symbols[s]]
1546 return s, [latex_symbols[s]]
1547 else:
1547 else:
1548 # If a user has partially typed a latex symbol, give them
1548 # If a user has partially typed a latex symbol, give them
1549 # a full list of options \al -> [\aleph, \alpha]
1549 # a full list of options \al -> [\aleph, \alpha]
1550 matches = [k for k in latex_symbols if k.startswith(s)]
1550 matches = [k for k in latex_symbols if k.startswith(s)]
1551 return s, matches
1551 return s, matches
1552 return u'', []
1552 return u'', []
1553
1553
1554 def dispatch_custom_completer(self, text):
1554 def dispatch_custom_completer(self, text):
1555 if not self.custom_completers:
1555 if not self.custom_completers:
1556 return
1556 return
1557
1557
1558 line = self.line_buffer
1558 line = self.line_buffer
1559 if not line.strip():
1559 if not line.strip():
1560 return None
1560 return None
1561
1561
1562 # Create a little structure to pass all the relevant information about
1562 # Create a little structure to pass all the relevant information about
1563 # the current completion to any custom completer.
1563 # the current completion to any custom completer.
1564 event = SimpleNamespace()
1564 event = SimpleNamespace()
1565 event.line = line
1565 event.line = line
1566 event.symbol = text
1566 event.symbol = text
1567 cmd = line.split(None,1)[0]
1567 cmd = line.split(None,1)[0]
1568 event.command = cmd
1568 event.command = cmd
1569 event.text_until_cursor = self.text_until_cursor
1569 event.text_until_cursor = self.text_until_cursor
1570
1570
1571 # for foo etc, try also to find completer for %foo
1571 # for foo etc, try also to find completer for %foo
1572 if not cmd.startswith(self.magic_escape):
1572 if not cmd.startswith(self.magic_escape):
1573 try_magic = self.custom_completers.s_matches(
1573 try_magic = self.custom_completers.s_matches(
1574 self.magic_escape + cmd)
1574 self.magic_escape + cmd)
1575 else:
1575 else:
1576 try_magic = []
1576 try_magic = []
1577
1577
1578 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1578 for c in itertools.chain(self.custom_completers.s_matches(cmd),
1579 try_magic,
1579 try_magic,
1580 self.custom_completers.flat_matches(self.text_until_cursor)):
1580 self.custom_completers.flat_matches(self.text_until_cursor)):
1581 try:
1581 try:
1582 res = c(event)
1582 res = c(event)
1583 if res:
1583 if res:
1584 # first, try case sensitive match
1584 # first, try case sensitive match
1585 withcase = [cast_unicode_py2(r) for r in res if r.startswith(text)]
1585 withcase = [cast_unicode_py2(r) for r in res if r.startswith(text)]
1586 if withcase:
1586 if withcase:
1587 return withcase
1587 return withcase
1588 # if none, then case insensitive ones are ok too
1588 # if none, then case insensitive ones are ok too
1589 text_low = text.lower()
1589 text_low = text.lower()
1590 return [cast_unicode_py2(r) for r in res if r.lower().startswith(text_low)]
1590 return [cast_unicode_py2(r) for r in res if r.lower().startswith(text_low)]
1591 except TryNext:
1591 except TryNext:
1592 pass
1592 pass
1593
1593
1594 return None
1594 return None
1595
1595
1596 def completions(self, text: str, offset: int)->Iterator[Completion]:
1596 def completions(self, text: str, offset: int)->Iterator[Completion]:
1597 """
1597 """
1598 Returns an iterator over the possible completions
1598 Returns an iterator over the possible completions
1599
1599
1600 .. warning:: Unstable
1600 .. warning:: Unstable
1601
1601
1602 This function is unstable, API may change without warning.
1602 This function is unstable, API may change without warning.
1603 It will also raise unless use in proper context manager.
1603 It will also raise unless use in proper context manager.
1604
1604
1605 Parameters
1605 Parameters
1606 ----------
1606 ----------
1607
1607
1608 text:str
1608 text:str
1609 Full text of the current input, multi line string.
1609 Full text of the current input, multi line string.
1610 offset:int
1610 offset:int
1611 Integer representing the position of the cursor in ``text``. Offset
1611 Integer representing the position of the cursor in ``text``. Offset
1612 is 0-based indexed.
1612 is 0-based indexed.
1613
1613
1614 Yields
1614 Yields
1615 ------
1615 ------
1616 :any:`Completion` object
1616 :any:`Completion` object
1617
1617
1618
1618
1619 The cursor on a text can either be seen as being "in between"
1619 The cursor on a text can either be seen as being "in between"
1620 characters or "On" a character depending on the interface visible to
1620 characters or "On" a character depending on the interface visible to
1621 the user. For consistency the cursor being on "in between" characters X
1621 the user. For consistency the cursor being on "in between" characters X
1622 and Y is equivalent to the cursor being "on" character Y, that is to say
1622 and Y is equivalent to the cursor being "on" character Y, that is to say
1623 the character the cursor is on is considered as being after the cursor.
1623 the character the cursor is on is considered as being after the cursor.
1624
1624
1625 Combining characters may span more that one position in the
1625 Combining characters may span more that one position in the
1626 text.
1626 text.
1627
1627
1628
1628
1629 .. note::
1629 .. note::
1630
1630
1631 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1631 If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--``
1632 fake Completion token to distinguish completion returned by Jedi
1632 fake Completion token to distinguish completion returned by Jedi
1633 and usual IPython completion.
1633 and usual IPython completion.
1634
1634
1635 .. note::
1635 .. note::
1636
1636
1637 Completions are not completely deduplicated yet. If identical
1637 Completions are not completely deduplicated yet. If identical
1638 completions are coming from different sources this function does not
1638 completions are coming from different sources this function does not
1639 ensure that each completion object will only be present once.
1639 ensure that each completion object will only be present once.
1640 """
1640 """
1641 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1641 warnings.warn("_complete is a provisional API (as of IPython 6.0). "
1642 "It may change without warnings. "
1642 "It may change without warnings. "
1643 "Use in corresponding context manager.",
1643 "Use in corresponding context manager.",
1644 category=ProvisionalCompleterWarning, stacklevel=2)
1644 category=ProvisionalCompleterWarning, stacklevel=2)
1645
1645
1646 seen = set()
1646 seen = set()
1647 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1647 for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000):
1648 if c and (c in seen):
1648 if c and (c in seen):
1649 continue
1649 continue
1650 yield c
1650 yield c
1651 seen.add(c)
1651 seen.add(c)
1652
1652
1653 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1653 def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]:
1654 """
1654 """
1655 Core completion module.Same signature as :any:`completions`, with the
1655 Core completion module.Same signature as :any:`completions`, with the
1656 extra `timeout` parameter (in seconds).
1656 extra `timeout` parameter (in seconds).
1657
1657
1658
1658
1659 Computing jedi's completion ``.type`` can be quite expensive (it is a
1659 Computing jedi's completion ``.type`` can be quite expensive (it is a
1660 lazy property) and can require some warm-up, more warm up than just
1660 lazy property) and can require some warm-up, more warm up than just
1661 computing the ``name`` of a completion. The warm-up can be :
1661 computing the ``name`` of a completion. The warm-up can be :
1662
1662
1663 - Long warm-up the fisrt time a module is encountered after
1663 - Long warm-up the fisrt time a module is encountered after
1664 install/update: actually build parse/inference tree.
1664 install/update: actually build parse/inference tree.
1665
1665
1666 - first time the module is encountered in a session: load tree from
1666 - first time the module is encountered in a session: load tree from
1667 disk.
1667 disk.
1668
1668
1669 We don't want to block completions for tens of seconds so we give the
1669 We don't want to block completions for tens of seconds so we give the
1670 completer a "budget" of ``_timeout`` seconds per invocation to compute
1670 completer a "budget" of ``_timeout`` seconds per invocation to compute
1671 completions types, the completions that have not yet been computed will
1671 completions types, the completions that have not yet been computed will
1672 be marked as "unknown" an will have a chance to be computed next round
1672 be marked as "unknown" an will have a chance to be computed next round
1673 are things get cached.
1673 are things get cached.
1674
1674
1675 Keep in mind that Jedi is not the only thing treating the completion so
1675 Keep in mind that Jedi is not the only thing treating the completion so
1676 keep the timeout short-ish as if we take more than 0.3 second we still
1676 keep the timeout short-ish as if we take more than 0.3 second we still
1677 have lots of processing to do.
1677 have lots of processing to do.
1678
1678
1679 """
1679 """
1680 deadline = time.monotonic() + _timeout
1680 deadline = time.monotonic() + _timeout
1681
1681
1682
1682
1683 before = full_text[:offset]
1683 before = full_text[:offset]
1684 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1684 cursor_line, cursor_column = position_to_cursor(full_text, offset)
1685
1685
1686 matched_text, matches, matches_origin, jedi_matches = self._complete(
1686 matched_text, matches, matches_origin, jedi_matches = self._complete(
1687 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1687 full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column)
1688
1688
1689 iter_jm = iter(jedi_matches)
1689 iter_jm = iter(jedi_matches)
1690 if _timeout:
1690 if _timeout:
1691 for jm in iter_jm:
1691 for jm in iter_jm:
1692 try:
1692 try:
1693 type_ = jm.type
1693 type_ = jm.type
1694 except Exception:
1694 except Exception:
1695 if self.debug:
1695 if self.debug:
1696 print("Error in Jedi getting type of ", jm)
1696 print("Error in Jedi getting type of ", jm)
1697 type_ = None
1697 type_ = None
1698 delta = len(jm.name_with_symbols) - len(jm.complete)
1698 delta = len(jm.name_with_symbols) - len(jm.complete)
1699 yield Completion(start=offset - delta,
1699 yield Completion(start=offset - delta,
1700 end=offset,
1700 end=offset,
1701 text=jm.name_with_symbols,
1701 text=jm.name_with_symbols,
1702 type=type_,
1702 type=type_,
1703 _origin='jedi')
1703 _origin='jedi')
1704
1704
1705 if time.monotonic() > deadline:
1705 if time.monotonic() > deadline:
1706 break
1706 break
1707
1707
1708 for jm in iter_jm:
1708 for jm in iter_jm:
1709 delta = len(jm.name_with_symbols) - len(jm.complete)
1709 delta = len(jm.name_with_symbols) - len(jm.complete)
1710 yield Completion(start=offset - delta,
1710 yield Completion(start=offset - delta,
1711 end=offset,
1711 end=offset,
1712 text=jm.name_with_symbols,
1712 text=jm.name_with_symbols,
1713 type='<unknown>', # don't compute type for speed
1713 type='<unknown>', # don't compute type for speed
1714 _origin='jedi')
1714 _origin='jedi')
1715
1715
1716
1716
1717 start_offset = before.rfind(matched_text)
1717 start_offset = before.rfind(matched_text)
1718
1718
1719 # TODO:
1719 # TODO:
1720 # Supress this, right now just for debug.
1720 # Supress this, right now just for debug.
1721 if jedi_matches and matches and self.debug:
1721 if jedi_matches and matches and self.debug:
1722 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', _origin='debug')
1722 yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', _origin='debug')
1723
1723
1724 # I'm unsure if this is always true, so let's assert and see if it
1724 # I'm unsure if this is always true, so let's assert and see if it
1725 # crash
1725 # crash
1726 assert before.endswith(matched_text)
1726 assert before.endswith(matched_text)
1727 for m, t in zip(matches, matches_origin):
1727 for m, t in zip(matches, matches_origin):
1728 yield Completion(start=start_offset, end=offset, text=m, _origin=t)
1728 yield Completion(start=start_offset, end=offset, text=m, _origin=t)
1729
1729
1730
1730
1731 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1731 def complete(self, text=None, line_buffer=None, cursor_pos=None):
1732 """Find completions for the given text and line context.
1732 """Find completions for the given text and line context.
1733
1733
1734 Note that both the text and the line_buffer are optional, but at least
1734 Note that both the text and the line_buffer are optional, but at least
1735 one of them must be given.
1735 one of them must be given.
1736
1736
1737 Parameters
1737 Parameters
1738 ----------
1738 ----------
1739 text : string, optional
1739 text : string, optional
1740 Text to perform the completion on. If not given, the line buffer
1740 Text to perform the completion on. If not given, the line buffer
1741 is split using the instance's CompletionSplitter object.
1741 is split using the instance's CompletionSplitter object.
1742
1742
1743 line_buffer : string, optional
1743 line_buffer : string, optional
1744 If not given, the completer attempts to obtain the current line
1744 If not given, the completer attempts to obtain the current line
1745 buffer via readline. This keyword allows clients which are
1745 buffer via readline. This keyword allows clients which are
1746 requesting for text completions in non-readline contexts to inform
1746 requesting for text completions in non-readline contexts to inform
1747 the completer of the entire text.
1747 the completer of the entire text.
1748
1748
1749 cursor_pos : int, optional
1749 cursor_pos : int, optional
1750 Index of the cursor in the full line buffer. Should be provided by
1750 Index of the cursor in the full line buffer. Should be provided by
1751 remote frontends where kernel has no access to frontend state.
1751 remote frontends where kernel has no access to frontend state.
1752
1752
1753 Returns
1753 Returns
1754 -------
1754 -------
1755 text : str
1755 text : str
1756 Text that was actually used in the completion.
1756 Text that was actually used in the completion.
1757
1757
1758 matches : list
1758 matches : list
1759 A list of completion matches.
1759 A list of completion matches.
1760
1760
1761
1761
1762 .. note::
1762 .. note::
1763
1763
1764 This API is likely to be deprecated and replaced by
1764 This API is likely to be deprecated and replaced by
1765 :any:`IPCompleter.completions` in the future.
1765 :any:`IPCompleter.completions` in the future.
1766
1766
1767
1767
1768 """
1768 """
1769 warnings.warn('`Completer.complete` is pending deprecation since '
1769 warnings.warn('`Completer.complete` is pending deprecation since '
1770 'IPython 6.0 and will be replaced by `Completer.completions`.',
1770 'IPython 6.0 and will be replaced by `Completer.completions`.',
1771 PendingDeprecationWarning)
1771 PendingDeprecationWarning)
1772 # potential todo, FOLD the 3rd throw away argument of _complete
1772 # potential todo, FOLD the 3rd throw away argument of _complete
1773 # into the first 2 one.
1773 # into the first 2 one.
1774 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1774 return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2]
1775
1775
1776 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1776 def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None,
1777 full_text=None, return_jedi_results=True) -> (str, List[str], List[object]):
1777 full_text=None, return_jedi_results=True) -> (str, List[str], List[object]):
1778 """
1778 """
1779
1779
1780 Like complete but can also returns raw jedi completions as well as the
1780 Like complete but can also returns raw jedi completions as well as the
1781 origin of the completion text. This could (and should) be made much
1781 origin of the completion text. This could (and should) be made much
1782 cleaner but that will be simpler once we drop the old (and stateful)
1782 cleaner but that will be simpler once we drop the old (and stateful)
1783 :any:`complete` API.
1783 :any:`complete` API.
1784
1784
1785
1785
1786 With current provisional API, cursor_pos act both (depending on the
1786 With current provisional API, cursor_pos act both (depending on the
1787 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1787 caller) as the offset in the ``text`` or ``line_buffer``, or as the
1788 ``column`` when passing multiline strings this could/should be renamed
1788 ``column`` when passing multiline strings this could/should be renamed
1789 but would add extra noise.
1789 but would add extra noise.
1790 """
1790 """
1791
1791
1792 # if the cursor position isn't given, the only sane assumption we can
1792 # if the cursor position isn't given, the only sane assumption we can
1793 # make is that it's at the end of the line (the common case)
1793 # make is that it's at the end of the line (the common case)
1794 if cursor_pos is None:
1794 if cursor_pos is None:
1795 cursor_pos = len(line_buffer) if text is None else len(text)
1795 cursor_pos = len(line_buffer) if text is None else len(text)
1796
1796
1797 if self.use_main_ns:
1797 if self.use_main_ns:
1798 self.namespace = __main__.__dict__
1798 self.namespace = __main__.__dict__
1799
1799
1800 # if text is either None or an empty string, rely on the line buffer
1800 # if text is either None or an empty string, rely on the line buffer
1801 if (not line_buffer) and full_text:
1801 if (not line_buffer) and full_text:
1802 line_buffer = full_text.split('\n')[cursor_line]
1802 line_buffer = full_text.split('\n')[cursor_line]
1803 if not text:
1803 if not text:
1804 text = self.splitter.split_line(line_buffer, cursor_pos)
1804 text = self.splitter.split_line(line_buffer, cursor_pos)
1805
1805
1806 if self.backslash_combining_completions:
1806 if self.backslash_combining_completions:
1807 # allow deactivation of these on windows.
1807 # allow deactivation of these on windows.
1808 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1808 base_text = text if not line_buffer else line_buffer[:cursor_pos]
1809 latex_text, latex_matches = self.latex_matches(base_text)
1809 latex_text, latex_matches = self.latex_matches(base_text)
1810 if latex_matches:
1810 if latex_matches:
1811 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1811 return latex_text, latex_matches, ['latex_matches']*len(latex_matches), ()
1812 name_text = ''
1812 name_text = ''
1813 name_matches = []
1813 name_matches = []
1814 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches):
1814 for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches):
1815 name_text, name_matches = meth(base_text)
1815 name_text, name_matches = meth(base_text)
1816 if name_text:
1816 if name_text:
1817 return name_text, name_matches, [meth.__qualname__]*len(name_matches), {}
1817 return name_text, name_matches, [meth.__qualname__]*len(name_matches), {}
1818
1818
1819
1819
1820 # If no line buffer is given, assume the input text is all there was
1820 # If no line buffer is given, assume the input text is all there was
1821 if line_buffer is None:
1821 if line_buffer is None:
1822 line_buffer = text
1822 line_buffer = text
1823
1823
1824 self.line_buffer = line_buffer
1824 self.line_buffer = line_buffer
1825 self.text_until_cursor = self.line_buffer[:cursor_pos]
1825 self.text_until_cursor = self.line_buffer[:cursor_pos]
1826
1826
1827 # Start with a clean slate of completions
1827 # Start with a clean slate of completions
1828 matches = []
1828 matches = []
1829 custom_res = self.dispatch_custom_completer(text)
1829 custom_res = self.dispatch_custom_completer(text)
1830 # FIXME: we should extend our api to return a dict with completions for
1830 # FIXME: we should extend our api to return a dict with completions for
1831 # different types of objects. The rlcomplete() method could then
1831 # different types of objects. The rlcomplete() method could then
1832 # simply collapse the dict into a list for readline, but we'd have
1832 # simply collapse the dict into a list for readline, but we'd have
1833 # richer completion semantics in other evironments.
1833 # richer completion semantics in other evironments.
1834 completions = ()
1834 completions = ()
1835 if self.use_jedi and return_jedi_results:
1835 if self.use_jedi and return_jedi_results:
1836 if not full_text:
1836 if not full_text:
1837 full_text = line_buffer
1837 full_text = line_buffer
1838 completions = self._jedi_matches(
1838 completions = self._jedi_matches(
1839 cursor_pos, cursor_line, full_text)
1839 cursor_pos, cursor_line, full_text)
1840 if custom_res is not None:
1840 if custom_res is not None:
1841 # did custom completers produce something?
1841 # did custom completers produce something?
1842 matches = [(m, 'custom') for m in custom_res]
1842 matches = [(m, 'custom') for m in custom_res]
1843 else:
1843 else:
1844 # Extend the list of completions with the results of each
1844 # Extend the list of completions with the results of each
1845 # matcher, so we return results to the user from all
1845 # matcher, so we return results to the user from all
1846 # namespaces.
1846 # namespaces.
1847 if self.merge_completions:
1847 if self.merge_completions:
1848 matches = []
1848 matches = []
1849 for matcher in self.matchers:
1849 for matcher in self.matchers:
1850 try:
1850 try:
1851 matches.extend([(m, matcher.__qualname__)
1851 matches.extend([(m, matcher.__qualname__)
1852 for m in matcher(text)])
1852 for m in matcher(text)])
1853 except:
1853 except:
1854 # Show the ugly traceback if the matcher causes an
1854 # Show the ugly traceback if the matcher causes an
1855 # exception, but do NOT crash the kernel!
1855 # exception, but do NOT crash the kernel!
1856 sys.excepthook(*sys.exc_info())
1856 sys.excepthook(*sys.exc_info())
1857 else:
1857 else:
1858 for matcher in self.matchers:
1858 for matcher in self.matchers:
1859 matches = [(m, matcher.__qualname__)
1859 matches = [(m, matcher.__qualname__)
1860 for m in matcher(text)]
1860 for m in matcher(text)]
1861 if matches:
1861 if matches:
1862 break
1862 break
1863 seen = set()
1863 seen = set()
1864 filtered_matches = set()
1864 filtered_matches = set()
1865 for m in matches:
1865 for m in matches:
1866 t, c = m
1866 t, c = m
1867 if t not in seen:
1867 if t not in seen:
1868 filtered_matches.add(m)
1868 filtered_matches.add(m)
1869 seen.add(t)
1869 seen.add(t)
1870
1870
1871 filtered_matches = sorted(
1871 filtered_matches = sorted(
1872 set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))
1872 set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))
1873
1873
1874 matches = [m[0] for m in filtered_matches]
1874 matches = [m[0] for m in filtered_matches]
1875 origins = [m[1] for m in filtered_matches]
1875 origins = [m[1] for m in filtered_matches]
1876
1876
1877 self.matches = matches
1877 self.matches = matches
1878
1878
1879 return text, matches, origins, completions
1879 return text, matches, origins, completions
General Comments 0
You need to be logged in to leave comments. Login now