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