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