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