Show More
@@ -1,2045 +1,2055 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. The APIs attached to this new mechanism is |
|
70 | inspecting multiple namespaces. The APIs attached to this new mechanism is | |
71 | unstable and will raise unless use in an :any:`provisionalcompleter` context |
|
71 | unstable and will raise unless use in an :any:`provisionalcompleter` context | |
72 | manager. |
|
72 | 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 is :any:`jedi` is crashing, or if current |
|
87 | to have extra logging information is :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, Union |
|
129 | from typing import Iterator, List, Tuple, Iterable, Union | |
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.inputsplitter import ESC_MAGIC |
|
134 | from IPython.core.inputsplitter 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 | import jedi.api.helpers |
|
147 | import jedi.api.helpers | |
148 | import jedi.api.classes |
|
148 | import jedi.api.classes | |
149 | JEDI_INSTALLED = True |
|
149 | JEDI_INSTALLED = True | |
150 | except ImportError: |
|
150 | except ImportError: | |
151 | JEDI_INSTALLED = False |
|
151 | JEDI_INSTALLED = False | |
152 | #----------------------------------------------------------------------------- |
|
152 | #----------------------------------------------------------------------------- | |
153 | # Globals |
|
153 | # Globals | |
154 | #----------------------------------------------------------------------------- |
|
154 | #----------------------------------------------------------------------------- | |
155 |
|
155 | |||
156 | # Public API |
|
156 | # Public API | |
157 | __all__ = ['Completer','IPCompleter'] |
|
157 | __all__ = ['Completer','IPCompleter'] | |
158 |
|
158 | |||
159 | if sys.platform == 'win32': |
|
159 | if sys.platform == 'win32': | |
160 | PROTECTABLES = ' ' |
|
160 | PROTECTABLES = ' ' | |
161 | else: |
|
161 | else: | |
162 | PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&' |
|
162 | PROTECTABLES = ' ()[]{}?=\\|;:\'#*"^&' | |
163 |
|
163 | |||
164 | # Protect against returning an enormous number of completions which the frontend |
|
164 | # Protect against returning an enormous number of completions which the frontend | |
165 | # may have trouble processing. |
|
165 | # may have trouble processing. | |
166 | MATCHES_LIMIT = 500 |
|
166 | MATCHES_LIMIT = 500 | |
167 |
|
167 | |||
168 | _deprecation_readline_sentinel = object() |
|
168 | _deprecation_readline_sentinel = object() | |
169 |
|
169 | |||
170 |
|
170 | |||
171 | class ProvisionalCompleterWarning(FutureWarning): |
|
171 | class ProvisionalCompleterWarning(FutureWarning): | |
172 | """ |
|
172 | """ | |
173 | Exception raise by an experimental feature in this module. |
|
173 | Exception raise by an experimental feature in this module. | |
174 |
|
174 | |||
175 | Wrap code in :any:`provisionalcompleter` context manager if you |
|
175 | Wrap code in :any:`provisionalcompleter` context manager if you | |
176 | are certain you want to use an unstable feature. |
|
176 | are certain you want to use an unstable feature. | |
177 | """ |
|
177 | """ | |
178 | pass |
|
178 | pass | |
179 |
|
179 | |||
180 | warnings.filterwarnings('error', category=ProvisionalCompleterWarning) |
|
180 | warnings.filterwarnings('error', category=ProvisionalCompleterWarning) | |
181 |
|
181 | |||
182 | @contextmanager |
|
182 | @contextmanager | |
183 | def provisionalcompleter(action='ignore'): |
|
183 | def provisionalcompleter(action='ignore'): | |
184 | """ |
|
184 | """ | |
185 |
|
185 | |||
186 |
|
186 | |||
187 | This contest manager has to be used in any place where unstable completer |
|
187 | This contest manager has to be used in any place where unstable completer | |
188 | behavior and API may be called. |
|
188 | behavior and API may be called. | |
189 |
|
189 | |||
190 | >>> with provisionalcompleter(): |
|
190 | >>> with provisionalcompleter(): | |
191 | ... completer.do_experimetal_things() # works |
|
191 | ... completer.do_experimetal_things() # works | |
192 |
|
192 | |||
193 | >>> completer.do_experimental_things() # raises. |
|
193 | >>> completer.do_experimental_things() # raises. | |
194 |
|
194 | |||
195 | .. note:: Unstable |
|
195 | .. note:: Unstable | |
196 |
|
196 | |||
197 | By using this context manager you agree that the API in use may change |
|
197 | By using this context manager you agree that the API in use may change | |
198 | without warning, and that you won't complain if they do so. |
|
198 | without warning, and that you won't complain if they do so. | |
199 |
|
199 | |||
200 | You also understand that if the API is not to you liking you should report |
|
200 | You also understand that if the API is not to you liking you should report | |
201 | a bug to explain your use case upstream and improve the API and will loose |
|
201 | a bug to explain your use case upstream and improve the API and will loose | |
202 | credibility if you complain after the API is make stable. |
|
202 | credibility if you complain after the API is make stable. | |
203 |
|
203 | |||
204 | We'll be happy to get your feedback , feature request and improvement on |
|
204 | We'll be happy to get your feedback , feature request and improvement on | |
205 | any of the unstable APIs ! |
|
205 | any of the unstable APIs ! | |
206 | """ |
|
206 | """ | |
207 | with warnings.catch_warnings(): |
|
207 | with warnings.catch_warnings(): | |
208 | warnings.filterwarnings(action, category=ProvisionalCompleterWarning) |
|
208 | warnings.filterwarnings(action, category=ProvisionalCompleterWarning) | |
209 | yield |
|
209 | yield | |
210 |
|
210 | |||
211 |
|
211 | |||
212 | def has_open_quotes(s): |
|
212 | def has_open_quotes(s): | |
213 | """Return whether a string has open quotes. |
|
213 | """Return whether a string has open quotes. | |
214 |
|
214 | |||
215 | This simply counts whether the number of quote characters of either type in |
|
215 | This simply counts whether the number of quote characters of either type in | |
216 | the string is odd. |
|
216 | the string is odd. | |
217 |
|
217 | |||
218 | Returns |
|
218 | Returns | |
219 | ------- |
|
219 | ------- | |
220 | If there is an open quote, the quote character is returned. Else, return |
|
220 | If there is an open quote, the quote character is returned. Else, return | |
221 | False. |
|
221 | False. | |
222 | """ |
|
222 | """ | |
223 | # We check " first, then ', so complex cases with nested quotes will get |
|
223 | # We check " first, then ', so complex cases with nested quotes will get | |
224 | # the " to take precedence. |
|
224 | # the " to take precedence. | |
225 | if s.count('"') % 2: |
|
225 | if s.count('"') % 2: | |
226 | return '"' |
|
226 | return '"' | |
227 | elif s.count("'") % 2: |
|
227 | elif s.count("'") % 2: | |
228 | return "'" |
|
228 | return "'" | |
229 | else: |
|
229 | else: | |
230 | return False |
|
230 | return False | |
231 |
|
231 | |||
232 |
|
232 | |||
233 | def protect_filename(s, protectables=PROTECTABLES): |
|
233 | def protect_filename(s, protectables=PROTECTABLES): | |
234 | """Escape a string to protect certain characters.""" |
|
234 | """Escape a string to protect certain characters.""" | |
235 | if set(s) & set(protectables): |
|
235 | if set(s) & set(protectables): | |
236 | if sys.platform == "win32": |
|
236 | if sys.platform == "win32": | |
237 | return '"' + s + '"' |
|
237 | return '"' + s + '"' | |
238 | else: |
|
238 | else: | |
239 | return "".join(("\\" + c if c in protectables else c) for c in s) |
|
239 | return "".join(("\\" + c if c in protectables else c) for c in s) | |
240 | else: |
|
240 | else: | |
241 | return s |
|
241 | return s | |
242 |
|
242 | |||
243 |
|
243 | |||
244 | def expand_user(path:str) -> Tuple[str, bool, str]: |
|
244 | def expand_user(path:str) -> Tuple[str, bool, str]: | |
245 | """Expand ``~``-style usernames in strings. |
|
245 | """Expand ``~``-style usernames in strings. | |
246 |
|
246 | |||
247 | This is similar to :func:`os.path.expanduser`, but it computes and returns |
|
247 | This is similar to :func:`os.path.expanduser`, but it computes and returns | |
248 | extra information that will be useful if the input was being used in |
|
248 | extra information that will be useful if the input was being used in | |
249 | computing completions, and you wish to return the completions with the |
|
249 | computing completions, and you wish to return the completions with the | |
250 | original '~' instead of its expanded value. |
|
250 | original '~' instead of its expanded value. | |
251 |
|
251 | |||
252 | Parameters |
|
252 | Parameters | |
253 | ---------- |
|
253 | ---------- | |
254 | path : str |
|
254 | path : str | |
255 | String to be expanded. If no ~ is present, the output is the same as the |
|
255 | String to be expanded. If no ~ is present, the output is the same as the | |
256 | input. |
|
256 | input. | |
257 |
|
257 | |||
258 | Returns |
|
258 | Returns | |
259 | ------- |
|
259 | ------- | |
260 | newpath : str |
|
260 | newpath : str | |
261 | Result of ~ expansion in the input path. |
|
261 | Result of ~ expansion in the input path. | |
262 | tilde_expand : bool |
|
262 | tilde_expand : bool | |
263 | Whether any expansion was performed or not. |
|
263 | Whether any expansion was performed or not. | |
264 | tilde_val : str |
|
264 | tilde_val : str | |
265 | The value that ~ was replaced with. |
|
265 | The value that ~ was replaced with. | |
266 | """ |
|
266 | """ | |
267 | # Default values |
|
267 | # Default values | |
268 | tilde_expand = False |
|
268 | tilde_expand = False | |
269 | tilde_val = '' |
|
269 | tilde_val = '' | |
270 | newpath = path |
|
270 | newpath = path | |
271 |
|
271 | |||
272 | if path.startswith('~'): |
|
272 | if path.startswith('~'): | |
273 | tilde_expand = True |
|
273 | tilde_expand = True | |
274 | rest = len(path)-1 |
|
274 | rest = len(path)-1 | |
275 | newpath = os.path.expanduser(path) |
|
275 | newpath = os.path.expanduser(path) | |
276 | if rest: |
|
276 | if rest: | |
277 | tilde_val = newpath[:-rest] |
|
277 | tilde_val = newpath[:-rest] | |
278 | else: |
|
278 | else: | |
279 | tilde_val = newpath |
|
279 | tilde_val = newpath | |
280 |
|
280 | |||
281 | return newpath, tilde_expand, tilde_val |
|
281 | return newpath, tilde_expand, tilde_val | |
282 |
|
282 | |||
283 |
|
283 | |||
284 | def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str: |
|
284 | def compress_user(path:str, tilde_expand:bool, tilde_val:str) -> str: | |
285 | """Does the opposite of expand_user, with its outputs. |
|
285 | """Does the opposite of expand_user, with its outputs. | |
286 | """ |
|
286 | """ | |
287 | if tilde_expand: |
|
287 | if tilde_expand: | |
288 | return path.replace(tilde_val, '~') |
|
288 | return path.replace(tilde_val, '~') | |
289 | else: |
|
289 | else: | |
290 | return path |
|
290 | return path | |
291 |
|
291 | |||
292 |
|
292 | |||
293 | def completions_sorting_key(word): |
|
293 | def completions_sorting_key(word): | |
294 | """key for sorting completions |
|
294 | """key for sorting completions | |
295 |
|
295 | |||
296 | This does several things: |
|
296 | This does several things: | |
297 |
|
297 | |||
298 | - Demote any completions starting with underscores to the end |
|
298 | - Demote any completions starting with underscores to the end | |
299 | - Insert any %magic and %%cellmagic completions in the alphabetical order |
|
299 | - Insert any %magic and %%cellmagic completions in the alphabetical order | |
300 | by their name |
|
300 | by their name | |
301 | """ |
|
301 | """ | |
302 | prio1, prio2 = 0, 0 |
|
302 | prio1, prio2 = 0, 0 | |
303 |
|
303 | |||
304 | if word.startswith('__'): |
|
304 | if word.startswith('__'): | |
305 | prio1 = 2 |
|
305 | prio1 = 2 | |
306 | elif word.startswith('_'): |
|
306 | elif word.startswith('_'): | |
307 | prio1 = 1 |
|
307 | prio1 = 1 | |
308 |
|
308 | |||
309 | if word.endswith('='): |
|
309 | if word.endswith('='): | |
310 | prio1 = -1 |
|
310 | prio1 = -1 | |
311 |
|
311 | |||
312 | if word.startswith('%%'): |
|
312 | if word.startswith('%%'): | |
313 | # If there's another % in there, this is something else, so leave it alone |
|
313 | # If there's another % in there, this is something else, so leave it alone | |
314 | if not "%" in word[2:]: |
|
314 | if not "%" in word[2:]: | |
315 | word = word[2:] |
|
315 | word = word[2:] | |
316 | prio2 = 2 |
|
316 | prio2 = 2 | |
317 | elif word.startswith('%'): |
|
317 | elif word.startswith('%'): | |
318 | if not "%" in word[1:]: |
|
318 | if not "%" in word[1:]: | |
319 | word = word[1:] |
|
319 | word = word[1:] | |
320 | prio2 = 1 |
|
320 | prio2 = 1 | |
321 |
|
321 | |||
322 | return prio1, word, prio2 |
|
322 | return prio1, word, prio2 | |
323 |
|
323 | |||
324 |
|
324 | |||
325 | class _FakeJediCompletion: |
|
325 | class _FakeJediCompletion: | |
326 | """ |
|
326 | """ | |
327 | This is a workaround to communicate to the UI that Jedi has crashed and to |
|
327 | This is a workaround to communicate to the UI that Jedi has crashed and to | |
328 | report a bug. Will be used only id :any:`IPCompleter.debug` is set to true. |
|
328 | report a bug. Will be used only id :any:`IPCompleter.debug` is set to true. | |
329 |
|
329 | |||
330 | Added in IPython 6.0 so should likely be removed for 7.0 |
|
330 | Added in IPython 6.0 so should likely be removed for 7.0 | |
331 |
|
331 | |||
332 | """ |
|
332 | """ | |
333 |
|
333 | |||
334 | def __init__(self, name): |
|
334 | def __init__(self, name): | |
335 |
|
335 | |||
336 | self.name = name |
|
336 | self.name = name | |
337 | self.complete = name |
|
337 | self.complete = name | |
338 | self.type = 'crashed' |
|
338 | self.type = 'crashed' | |
339 | self.name_with_symbols = name |
|
339 | self.name_with_symbols = name | |
340 | self.signature = '' |
|
340 | self.signature = '' | |
341 | self._origin = 'fake' |
|
341 | self._origin = 'fake' | |
342 |
|
342 | |||
343 | def __repr__(self): |
|
343 | def __repr__(self): | |
344 | return '<Fake completion object jedi has crashed>' |
|
344 | return '<Fake completion object jedi has crashed>' | |
345 |
|
345 | |||
346 |
|
346 | |||
347 | class Completion: |
|
347 | class Completion: | |
348 | """ |
|
348 | """ | |
349 | Completion object used and return by IPython completers. |
|
349 | Completion object used and return by IPython completers. | |
350 |
|
350 | |||
351 | .. warning:: Unstable |
|
351 | .. warning:: Unstable | |
352 |
|
352 | |||
353 | This function is unstable, API may change without warning. |
|
353 | This function is unstable, API may change without warning. | |
354 | It will also raise unless use in proper context manager. |
|
354 | It will also raise unless use in proper context manager. | |
355 |
|
355 | |||
356 | This act as a middle ground :any:`Completion` object between the |
|
356 | This act as a middle ground :any:`Completion` object between the | |
357 | :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion |
|
357 | :any:`jedi.api.classes.Completion` object and the Prompt Toolkit completion | |
358 | object. While Jedi need a lot of information about evaluator and how the |
|
358 | object. While Jedi need a lot of information about evaluator and how the | |
359 | code should be ran/inspected, PromptToolkit (and other frontend) mostly |
|
359 | code should be ran/inspected, PromptToolkit (and other frontend) mostly | |
360 | need user facing information. |
|
360 | need user facing information. | |
361 |
|
361 | |||
362 | - Which range should be replaced replaced by what. |
|
362 | - Which range should be replaced replaced by what. | |
363 | - Some metadata (like completion type), or meta information to displayed to |
|
363 | - Some metadata (like completion type), or meta information to displayed to | |
364 | the use user. |
|
364 | the use user. | |
365 |
|
365 | |||
366 | For debugging purpose we can also store the origin of the completion (``jedi``, |
|
366 | For debugging purpose we can also store the origin of the completion (``jedi``, | |
367 | ``IPython.python_matches``, ``IPython.magics_matches``...). |
|
367 | ``IPython.python_matches``, ``IPython.magics_matches``...). | |
368 | """ |
|
368 | """ | |
369 |
|
369 | |||
370 | __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin'] |
|
370 | __slots__ = ['start', 'end', 'text', 'type', 'signature', '_origin'] | |
371 |
|
371 | |||
372 | def __init__(self, start: int, end: int, text: str, *, type: str=None, _origin='', signature='') -> None: |
|
372 | def __init__(self, start: int, end: int, text: str, *, type: str=None, _origin='', signature='') -> None: | |
373 | warnings.warn("``Completion`` is a provisional API (as of IPython 6.0). " |
|
373 | warnings.warn("``Completion`` is a provisional API (as of IPython 6.0). " | |
374 | "It may change without warnings. " |
|
374 | "It may change without warnings. " | |
375 | "Use in corresponding context manager.", |
|
375 | "Use in corresponding context manager.", | |
376 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
376 | category=ProvisionalCompleterWarning, stacklevel=2) | |
377 |
|
377 | |||
378 | self.start = start |
|
378 | self.start = start | |
379 | self.end = end |
|
379 | self.end = end | |
380 | self.text = text |
|
380 | self.text = text | |
381 | self.type = type |
|
381 | self.type = type | |
382 | self.signature = signature |
|
382 | self.signature = signature | |
383 | self._origin = _origin |
|
383 | self._origin = _origin | |
384 |
|
384 | |||
385 | def __repr__(self): |
|
385 | def __repr__(self): | |
386 | return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \ |
|
386 | return '<Completion start=%s end=%s text=%r type=%r, signature=%r,>' % \ | |
387 | (self.start, self.end, self.text, self.type or '?', self.signature or '?') |
|
387 | (self.start, self.end, self.text, self.type or '?', self.signature or '?') | |
388 |
|
388 | |||
389 | def __eq__(self, other)->Bool: |
|
389 | def __eq__(self, other)->Bool: | |
390 | """ |
|
390 | """ | |
391 | Equality and hash do not hash the type (as some completer may not be |
|
391 | Equality and hash do not hash the type (as some completer may not be | |
392 | able to infer the type), but are use to (partially) de-duplicate |
|
392 | able to infer the type), but are use to (partially) de-duplicate | |
393 | completion. |
|
393 | completion. | |
394 |
|
394 | |||
395 | Completely de-duplicating completion is a bit tricker that just |
|
395 | Completely de-duplicating completion is a bit tricker that just | |
396 | comparing as it depends on surrounding text, which Completions are not |
|
396 | comparing as it depends on surrounding text, which Completions are not | |
397 | aware of. |
|
397 | aware of. | |
398 | """ |
|
398 | """ | |
399 | return self.start == other.start and \ |
|
399 | return self.start == other.start and \ | |
400 | self.end == other.end and \ |
|
400 | self.end == other.end and \ | |
401 | self.text == other.text |
|
401 | self.text == other.text | |
402 |
|
402 | |||
403 | def __hash__(self): |
|
403 | def __hash__(self): | |
404 | return hash((self.start, self.end, self.text)) |
|
404 | return hash((self.start, self.end, self.text)) | |
405 |
|
405 | |||
406 |
|
406 | |||
407 | _IC = Iterable[Completion] |
|
407 | _IC = Iterable[Completion] | |
408 |
|
408 | |||
409 |
|
409 | |||
410 | def _deduplicate_completions(text: str, completions: _IC)-> _IC: |
|
410 | def _deduplicate_completions(text: str, completions: _IC)-> _IC: | |
411 | """ |
|
411 | """ | |
412 | Deduplicate a set of completions. |
|
412 | Deduplicate a set of completions. | |
413 |
|
413 | |||
414 | .. warning:: Unstable |
|
414 | .. warning:: Unstable | |
415 |
|
415 | |||
416 | This function is unstable, API may change without warning. |
|
416 | This function is unstable, API may change without warning. | |
417 |
|
417 | |||
418 | Parameters |
|
418 | Parameters | |
419 | ---------- |
|
419 | ---------- | |
420 | text: str |
|
420 | text: str | |
421 | text that should be completed. |
|
421 | text that should be completed. | |
422 | completions: Iterator[Completion] |
|
422 | completions: Iterator[Completion] | |
423 | iterator over the completions to deduplicate |
|
423 | iterator over the completions to deduplicate | |
424 |
|
424 | |||
425 | Yields |
|
425 | Yields | |
426 | ------ |
|
426 | ------ | |
427 | `Completions` objects |
|
427 | `Completions` objects | |
428 |
|
428 | |||
429 |
|
429 | |||
430 | Completions coming from multiple sources, may be different but end up having |
|
430 | Completions coming from multiple sources, may be different but end up having | |
431 | the same effect when applied to ``text``. If this is the case, this will |
|
431 | the same effect when applied to ``text``. If this is the case, this will | |
432 | consider completions as equal and only emit the first encountered. |
|
432 | consider completions as equal and only emit the first encountered. | |
433 |
|
433 | |||
434 | Not folded in `completions()` yet for debugging purpose, and to detect when |
|
434 | Not folded in `completions()` yet for debugging purpose, and to detect when | |
435 | the IPython completer does return things that Jedi does not, but should be |
|
435 | the IPython completer does return things that Jedi does not, but should be | |
436 | at some point. |
|
436 | at some point. | |
437 | """ |
|
437 | """ | |
438 | completions = list(completions) |
|
438 | completions = list(completions) | |
439 | if not completions: |
|
439 | if not completions: | |
440 | return |
|
440 | return | |
441 |
|
441 | |||
442 | new_start = min(c.start for c in completions) |
|
442 | new_start = min(c.start for c in completions) | |
443 | new_end = max(c.end for c in completions) |
|
443 | new_end = max(c.end for c in completions) | |
444 |
|
444 | |||
445 | seen = set() |
|
445 | seen = set() | |
446 | for c in completions: |
|
446 | for c in completions: | |
447 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
447 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] | |
448 | if new_text not in seen: |
|
448 | if new_text not in seen: | |
449 | yield c |
|
449 | yield c | |
450 | seen.add(new_text) |
|
450 | seen.add(new_text) | |
451 |
|
451 | |||
452 |
|
452 | |||
453 | def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC: |
|
453 | def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC: | |
454 | """ |
|
454 | """ | |
455 | Rectify a set of completions to all have the same ``start`` and ``end`` |
|
455 | Rectify a set of completions to all have the same ``start`` and ``end`` | |
456 |
|
456 | |||
457 | .. warning:: Unstable |
|
457 | .. warning:: Unstable | |
458 |
|
458 | |||
459 | This function is unstable, API may change without warning. |
|
459 | This function is unstable, API may change without warning. | |
460 | It will also raise unless use in proper context manager. |
|
460 | It will also raise unless use in proper context manager. | |
461 |
|
461 | |||
462 | Parameters |
|
462 | Parameters | |
463 | ---------- |
|
463 | ---------- | |
464 | text: str |
|
464 | text: str | |
465 | text that should be completed. |
|
465 | text that should be completed. | |
466 | completions: Iterator[Completion] |
|
466 | completions: Iterator[Completion] | |
467 | iterator over the completions to rectify |
|
467 | iterator over the completions to rectify | |
468 |
|
468 | |||
469 |
|
469 | |||
470 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though |
|
470 | :any:`jedi.api.classes.Completion` s returned by Jedi may not have the same start and end, though | |
471 | the Jupyter Protocol requires them to behave like so. This will readjust |
|
471 | the Jupyter Protocol requires them to behave like so. This will readjust | |
472 | the completion to have the same ``start`` and ``end`` by padding both |
|
472 | the completion to have the same ``start`` and ``end`` by padding both | |
473 | extremities with surrounding text. |
|
473 | extremities with surrounding text. | |
474 |
|
474 | |||
475 | During stabilisation should support a ``_debug`` option to log which |
|
475 | During stabilisation should support a ``_debug`` option to log which | |
476 | completion are return by the IPython completer and not found in Jedi in |
|
476 | completion are return by the IPython completer and not found in Jedi in | |
477 | order to make upstream bug report. |
|
477 | order to make upstream bug report. | |
478 | """ |
|
478 | """ | |
479 | warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). " |
|
479 | warnings.warn("`rectify_completions` is a provisional API (as of IPython 6.0). " | |
480 | "It may change without warnings. " |
|
480 | "It may change without warnings. " | |
481 | "Use in corresponding context manager.", |
|
481 | "Use in corresponding context manager.", | |
482 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
482 | category=ProvisionalCompleterWarning, stacklevel=2) | |
483 |
|
483 | |||
484 | completions = list(completions) |
|
484 | completions = list(completions) | |
485 | if not completions: |
|
485 | if not completions: | |
486 | return |
|
486 | return | |
487 | starts = (c.start for c in completions) |
|
487 | starts = (c.start for c in completions) | |
488 | ends = (c.end for c in completions) |
|
488 | ends = (c.end for c in completions) | |
489 |
|
489 | |||
490 | new_start = min(starts) |
|
490 | new_start = min(starts) | |
491 | new_end = max(ends) |
|
491 | new_end = max(ends) | |
492 |
|
492 | |||
493 | seen_jedi = set() |
|
493 | seen_jedi = set() | |
494 | seen_python_matches = set() |
|
494 | seen_python_matches = set() | |
495 | for c in completions: |
|
495 | for c in completions: | |
496 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] |
|
496 | new_text = text[new_start:c.start] + c.text + text[c.end:new_end] | |
497 | if c._origin == 'jedi': |
|
497 | if c._origin == 'jedi': | |
498 | seen_jedi.add(new_text) |
|
498 | seen_jedi.add(new_text) | |
499 | elif c._origin == 'IPCompleter.python_matches': |
|
499 | elif c._origin == 'IPCompleter.python_matches': | |
500 | seen_python_matches.add(new_text) |
|
500 | seen_python_matches.add(new_text) | |
501 | yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature) |
|
501 | yield Completion(new_start, new_end, new_text, type=c.type, _origin=c._origin, signature=c.signature) | |
502 | diff = seen_python_matches.difference(seen_jedi) |
|
502 | diff = seen_python_matches.difference(seen_jedi) | |
503 | if diff and _debug: |
|
503 | if diff and _debug: | |
504 | print('IPython.python matches have extras:', diff) |
|
504 | print('IPython.python matches have extras:', diff) | |
505 |
|
505 | |||
506 |
|
506 | |||
507 | if sys.platform == 'win32': |
|
507 | if sys.platform == 'win32': | |
508 | DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?' |
|
508 | DELIMS = ' \t\n`!@#$^&*()=+[{]}|;\'",<>?' | |
509 | else: |
|
509 | else: | |
510 | DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' |
|
510 | DELIMS = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' | |
511 |
|
511 | |||
512 | GREEDY_DELIMS = ' =\r\n' |
|
512 | GREEDY_DELIMS = ' =\r\n' | |
513 |
|
513 | |||
514 |
|
514 | |||
515 | class CompletionSplitter(object): |
|
515 | class CompletionSplitter(object): | |
516 | """An object to split an input line in a manner similar to readline. |
|
516 | """An object to split an input line in a manner similar to readline. | |
517 |
|
517 | |||
518 | By having our own implementation, we can expose readline-like completion in |
|
518 | By having our own implementation, we can expose readline-like completion in | |
519 | a uniform manner to all frontends. This object only needs to be given the |
|
519 | a uniform manner to all frontends. This object only needs to be given the | |
520 | line of text to be split and the cursor position on said line, and it |
|
520 | line of text to be split and the cursor position on said line, and it | |
521 | returns the 'word' to be completed on at the cursor after splitting the |
|
521 | returns the 'word' to be completed on at the cursor after splitting the | |
522 | entire line. |
|
522 | entire line. | |
523 |
|
523 | |||
524 | What characters are used as splitting delimiters can be controlled by |
|
524 | What characters are used as splitting delimiters can be controlled by | |
525 | setting the ``delims`` attribute (this is a property that internally |
|
525 | setting the ``delims`` attribute (this is a property that internally | |
526 | automatically builds the necessary regular expression)""" |
|
526 | automatically builds the necessary regular expression)""" | |
527 |
|
527 | |||
528 | # Private interface |
|
528 | # Private interface | |
529 |
|
529 | |||
530 | # A string of delimiter characters. The default value makes sense for |
|
530 | # A string of delimiter characters. The default value makes sense for | |
531 | # IPython's most typical usage patterns. |
|
531 | # IPython's most typical usage patterns. | |
532 | _delims = DELIMS |
|
532 | _delims = DELIMS | |
533 |
|
533 | |||
534 | # The expression (a normal string) to be compiled into a regular expression |
|
534 | # The expression (a normal string) to be compiled into a regular expression | |
535 | # for actual splitting. We store it as an attribute mostly for ease of |
|
535 | # for actual splitting. We store it as an attribute mostly for ease of | |
536 | # debugging, since this type of code can be so tricky to debug. |
|
536 | # debugging, since this type of code can be so tricky to debug. | |
537 | _delim_expr = None |
|
537 | _delim_expr = None | |
538 |
|
538 | |||
539 | # The regular expression that does the actual splitting |
|
539 | # The regular expression that does the actual splitting | |
540 | _delim_re = None |
|
540 | _delim_re = None | |
541 |
|
541 | |||
542 | def __init__(self, delims=None): |
|
542 | def __init__(self, delims=None): | |
543 | delims = CompletionSplitter._delims if delims is None else delims |
|
543 | delims = CompletionSplitter._delims if delims is None else delims | |
544 | self.delims = delims |
|
544 | self.delims = delims | |
545 |
|
545 | |||
546 | @property |
|
546 | @property | |
547 | def delims(self): |
|
547 | def delims(self): | |
548 | """Return the string of delimiter characters.""" |
|
548 | """Return the string of delimiter characters.""" | |
549 | return self._delims |
|
549 | return self._delims | |
550 |
|
550 | |||
551 | @delims.setter |
|
551 | @delims.setter | |
552 | def delims(self, delims): |
|
552 | def delims(self, delims): | |
553 | """Set the delimiters for line splitting.""" |
|
553 | """Set the delimiters for line splitting.""" | |
554 | expr = '[' + ''.join('\\'+ c for c in delims) + ']' |
|
554 | expr = '[' + ''.join('\\'+ c for c in delims) + ']' | |
555 | self._delim_re = re.compile(expr) |
|
555 | self._delim_re = re.compile(expr) | |
556 | self._delims = delims |
|
556 | self._delims = delims | |
557 | self._delim_expr = expr |
|
557 | self._delim_expr = expr | |
558 |
|
558 | |||
559 | def split_line(self, line, cursor_pos=None): |
|
559 | def split_line(self, line, cursor_pos=None): | |
560 | """Split a line of text with a cursor at the given position. |
|
560 | """Split a line of text with a cursor at the given position. | |
561 | """ |
|
561 | """ | |
562 | l = line if cursor_pos is None else line[:cursor_pos] |
|
562 | l = line if cursor_pos is None else line[:cursor_pos] | |
563 | return self._delim_re.split(l)[-1] |
|
563 | return self._delim_re.split(l)[-1] | |
564 |
|
564 | |||
565 |
|
565 | |||
566 |
|
566 | |||
567 | class Completer(Configurable): |
|
567 | class Completer(Configurable): | |
568 |
|
568 | |||
569 | greedy = Bool(False, |
|
569 | greedy = Bool(False, | |
570 | help="""Activate greedy completion |
|
570 | help="""Activate greedy completion | |
571 | PENDING DEPRECTION. this is now mostly taken care of with Jedi. |
|
571 | PENDING DEPRECTION. this is now mostly taken care of with Jedi. | |
572 |
|
572 | |||
573 | This will enable completion on elements of lists, results of function calls, etc., |
|
573 | This will enable completion on elements of lists, results of function calls, etc., | |
574 | but can be unsafe because the code is actually evaluated on TAB. |
|
574 | but can be unsafe because the code is actually evaluated on TAB. | |
575 | """ |
|
575 | """ | |
576 | ).tag(config=True) |
|
576 | ).tag(config=True) | |
577 |
|
577 | |||
578 | use_jedi = Bool(default_value=JEDI_INSTALLED, |
|
578 | use_jedi = Bool(default_value=JEDI_INSTALLED, | |
579 | help="Experimental: Use Jedi to generate autocompletions. " |
|
579 | help="Experimental: Use Jedi to generate autocompletions. " | |
580 | "Default to True if jedi is installed").tag(config=True) |
|
580 | "Default to True if jedi is installed").tag(config=True) | |
581 |
|
581 | |||
582 | jedi_compute_type_timeout = Int(default_value=400, |
|
582 | jedi_compute_type_timeout = Int(default_value=400, | |
583 | help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types. |
|
583 | help="""Experimental: restrict time (in milliseconds) during which Jedi can compute types. | |
584 | Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt |
|
584 | Set to 0 to stop computing types. Non-zero value lower than 100ms may hurt | |
585 | performance by preventing jedi to build its cache. |
|
585 | performance by preventing jedi to build its cache. | |
586 | """).tag(config=True) |
|
586 | """).tag(config=True) | |
587 |
|
587 | |||
588 | debug = Bool(default_value=False, |
|
588 | debug = Bool(default_value=False, | |
589 | help='Enable debug for the Completer. Mostly print extra ' |
|
589 | help='Enable debug for the Completer. Mostly print extra ' | |
590 | 'information for experimental jedi integration.')\ |
|
590 | 'information for experimental jedi integration.')\ | |
591 | .tag(config=True) |
|
591 | .tag(config=True) | |
592 |
|
592 | |||
593 | backslash_combining_completions = Bool(True, |
|
593 | backslash_combining_completions = Bool(True, | |
594 | help="Enable unicode completions, e.g. \\alpha<tab> . " |
|
594 | help="Enable unicode completions, e.g. \\alpha<tab> . " | |
595 | "Includes completion of latex commands, unicode names, and expanding " |
|
595 | "Includes completion of latex commands, unicode names, and expanding " | |
596 | "unicode characters back to latex commands.").tag(config=True) |
|
596 | "unicode characters back to latex commands.").tag(config=True) | |
597 |
|
597 | |||
598 |
|
598 | |||
599 |
|
599 | |||
600 | def __init__(self, namespace=None, global_namespace=None, **kwargs): |
|
600 | def __init__(self, namespace=None, global_namespace=None, **kwargs): | |
601 | """Create a new completer for the command line. |
|
601 | """Create a new completer for the command line. | |
602 |
|
602 | |||
603 | Completer(namespace=ns, global_namespace=ns2) -> completer instance. |
|
603 | Completer(namespace=ns, global_namespace=ns2) -> completer instance. | |
604 |
|
604 | |||
605 | If unspecified, the default namespace where completions are performed |
|
605 | If unspecified, the default namespace where completions are performed | |
606 | is __main__ (technically, __main__.__dict__). Namespaces should be |
|
606 | is __main__ (technically, __main__.__dict__). Namespaces should be | |
607 | given as dictionaries. |
|
607 | given as dictionaries. | |
608 |
|
608 | |||
609 | An optional second namespace can be given. This allows the completer |
|
609 | An optional second namespace can be given. This allows the completer | |
610 | to handle cases where both the local and global scopes need to be |
|
610 | to handle cases where both the local and global scopes need to be | |
611 | distinguished. |
|
611 | distinguished. | |
612 | """ |
|
612 | """ | |
613 |
|
613 | |||
614 | # Don't bind to namespace quite yet, but flag whether the user wants a |
|
614 | # Don't bind to namespace quite yet, but flag whether the user wants a | |
615 | # specific namespace or to use __main__.__dict__. This will allow us |
|
615 | # specific namespace or to use __main__.__dict__. This will allow us | |
616 | # to bind to __main__.__dict__ at completion time, not now. |
|
616 | # to bind to __main__.__dict__ at completion time, not now. | |
617 | if namespace is None: |
|
617 | if namespace is None: | |
618 | self.use_main_ns = True |
|
618 | self.use_main_ns = True | |
619 | else: |
|
619 | else: | |
620 | self.use_main_ns = False |
|
620 | self.use_main_ns = False | |
621 | self.namespace = namespace |
|
621 | self.namespace = namespace | |
622 |
|
622 | |||
623 | # The global namespace, if given, can be bound directly |
|
623 | # The global namespace, if given, can be bound directly | |
624 | if global_namespace is None: |
|
624 | if global_namespace is None: | |
625 | self.global_namespace = {} |
|
625 | self.global_namespace = {} | |
626 | else: |
|
626 | else: | |
627 | self.global_namespace = global_namespace |
|
627 | self.global_namespace = global_namespace | |
628 |
|
628 | |||
629 | super(Completer, self).__init__(**kwargs) |
|
629 | super(Completer, self).__init__(**kwargs) | |
630 |
|
630 | |||
631 | def complete(self, text, state): |
|
631 | def complete(self, text, state): | |
632 | """Return the next possible completion for 'text'. |
|
632 | """Return the next possible completion for 'text'. | |
633 |
|
633 | |||
634 | This is called successively with state == 0, 1, 2, ... until it |
|
634 | This is called successively with state == 0, 1, 2, ... until it | |
635 | returns None. The completion should begin with 'text'. |
|
635 | returns None. The completion should begin with 'text'. | |
636 |
|
636 | |||
637 | """ |
|
637 | """ | |
638 | if self.use_main_ns: |
|
638 | if self.use_main_ns: | |
639 | self.namespace = __main__.__dict__ |
|
639 | self.namespace = __main__.__dict__ | |
640 |
|
640 | |||
641 | if state == 0: |
|
641 | if state == 0: | |
642 | if "." in text: |
|
642 | if "." in text: | |
643 | self.matches = self.attr_matches(text) |
|
643 | self.matches = self.attr_matches(text) | |
644 | else: |
|
644 | else: | |
645 | self.matches = self.global_matches(text) |
|
645 | self.matches = self.global_matches(text) | |
646 | try: |
|
646 | try: | |
647 | return self.matches[state] |
|
647 | return self.matches[state] | |
648 | except IndexError: |
|
648 | except IndexError: | |
649 | return None |
|
649 | return None | |
650 |
|
650 | |||
651 | def global_matches(self, text): |
|
651 | def global_matches(self, text): | |
652 | """Compute matches when text is a simple name. |
|
652 | """Compute matches when text is a simple name. | |
653 |
|
653 | |||
654 | Return a list of all keywords, built-in functions and names currently |
|
654 | Return a list of all keywords, built-in functions and names currently | |
655 | defined in self.namespace or self.global_namespace that match. |
|
655 | defined in self.namespace or self.global_namespace that match. | |
656 |
|
656 | |||
657 | """ |
|
657 | """ | |
658 | matches = [] |
|
658 | matches = [] | |
659 | match_append = matches.append |
|
659 | match_append = matches.append | |
660 | n = len(text) |
|
660 | n = len(text) | |
661 | for lst in [keyword.kwlist, |
|
661 | for lst in [keyword.kwlist, | |
662 | builtin_mod.__dict__.keys(), |
|
662 | builtin_mod.__dict__.keys(), | |
663 | self.namespace.keys(), |
|
663 | self.namespace.keys(), | |
664 | self.global_namespace.keys()]: |
|
664 | self.global_namespace.keys()]: | |
665 | for word in lst: |
|
665 | for word in lst: | |
666 | if word[:n] == text and word != "__builtins__": |
|
666 | if word[:n] == text and word != "__builtins__": | |
667 | match_append(word) |
|
667 | match_append(word) | |
668 |
|
668 | |||
669 | snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z") |
|
669 | snake_case_re = re.compile(r"[^_]+(_[^_]+)+?\Z") | |
670 | for lst in [self.namespace.keys(), |
|
670 | for lst in [self.namespace.keys(), | |
671 | self.global_namespace.keys()]: |
|
671 | self.global_namespace.keys()]: | |
672 | shortened = {"_".join([sub[0] for sub in word.split('_')]) : word |
|
672 | shortened = {"_".join([sub[0] for sub in word.split('_')]) : word | |
673 | for word in lst if snake_case_re.match(word)} |
|
673 | for word in lst if snake_case_re.match(word)} | |
674 | for word in shortened.keys(): |
|
674 | for word in shortened.keys(): | |
675 | if word[:n] == text and word != "__builtins__": |
|
675 | if word[:n] == text and word != "__builtins__": | |
676 | match_append(shortened[word]) |
|
676 | match_append(shortened[word]) | |
677 | return matches |
|
677 | return matches | |
678 |
|
678 | |||
679 | def attr_matches(self, text): |
|
679 | def attr_matches(self, text): | |
680 | """Compute matches when text contains a dot. |
|
680 | """Compute matches when text contains a dot. | |
681 |
|
681 | |||
682 | Assuming the text is of the form NAME.NAME....[NAME], and is |
|
682 | Assuming the text is of the form NAME.NAME....[NAME], and is | |
683 | evaluatable in self.namespace or self.global_namespace, it will be |
|
683 | evaluatable in self.namespace or self.global_namespace, it will be | |
684 | evaluated and its attributes (as revealed by dir()) are used as |
|
684 | evaluated and its attributes (as revealed by dir()) are used as | |
685 | possible completions. (For class instances, class members are are |
|
685 | possible completions. (For class instances, class members are are | |
686 | also considered.) |
|
686 | also considered.) | |
687 |
|
687 | |||
688 | WARNING: this can still invoke arbitrary C code, if an object |
|
688 | WARNING: this can still invoke arbitrary C code, if an object | |
689 | with a __getattr__ hook is evaluated. |
|
689 | with a __getattr__ hook is evaluated. | |
690 |
|
690 | |||
691 | """ |
|
691 | """ | |
692 |
|
692 | |||
693 | # Another option, seems to work great. Catches things like ''.<tab> |
|
693 | # Another option, seems to work great. Catches things like ''.<tab> | |
694 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) |
|
694 | m = re.match(r"(\S+(\.\w+)*)\.(\w*)$", text) | |
695 |
|
695 | |||
696 | if m: |
|
696 | if m: | |
697 | expr, attr = m.group(1, 3) |
|
697 | expr, attr = m.group(1, 3) | |
698 | elif self.greedy: |
|
698 | elif self.greedy: | |
699 | m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer) |
|
699 | m2 = re.match(r"(.+)\.(\w*)$", self.line_buffer) | |
700 | if not m2: |
|
700 | if not m2: | |
701 | return [] |
|
701 | return [] | |
702 | expr, attr = m2.group(1,2) |
|
702 | expr, attr = m2.group(1,2) | |
703 | else: |
|
703 | else: | |
704 | return [] |
|
704 | return [] | |
705 |
|
705 | |||
706 | try: |
|
706 | try: | |
707 | obj = eval(expr, self.namespace) |
|
707 | obj = eval(expr, self.namespace) | |
708 | except: |
|
708 | except: | |
709 | try: |
|
709 | try: | |
710 | obj = eval(expr, self.global_namespace) |
|
710 | obj = eval(expr, self.global_namespace) | |
711 | except: |
|
711 | except: | |
712 | return [] |
|
712 | return [] | |
713 |
|
713 | |||
714 | if self.limit_to__all__ and hasattr(obj, '__all__'): |
|
714 | if self.limit_to__all__ and hasattr(obj, '__all__'): | |
715 | words = get__all__entries(obj) |
|
715 | words = get__all__entries(obj) | |
716 | else: |
|
716 | else: | |
717 | words = dir2(obj) |
|
717 | words = dir2(obj) | |
718 |
|
718 | |||
719 | try: |
|
719 | try: | |
720 | words = generics.complete_object(obj, words) |
|
720 | words = generics.complete_object(obj, words) | |
721 | except TryNext: |
|
721 | except TryNext: | |
722 | pass |
|
722 | pass | |
723 | except AssertionError: |
|
723 | except AssertionError: | |
724 | raise |
|
724 | raise | |
725 | except Exception: |
|
725 | except Exception: | |
726 | # Silence errors from completion function |
|
726 | # Silence errors from completion function | |
727 | #raise # dbg |
|
727 | #raise # dbg | |
728 | pass |
|
728 | pass | |
729 | # Build match list to return |
|
729 | # Build match list to return | |
730 | n = len(attr) |
|
730 | n = len(attr) | |
731 | return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ] |
|
731 | return [u"%s.%s" % (expr, w) for w in words if w[:n] == attr ] | |
732 |
|
732 | |||
733 |
|
733 | |||
734 | def get__all__entries(obj): |
|
734 | def get__all__entries(obj): | |
735 | """returns the strings in the __all__ attribute""" |
|
735 | """returns the strings in the __all__ attribute""" | |
736 | try: |
|
736 | try: | |
737 | words = getattr(obj, '__all__') |
|
737 | words = getattr(obj, '__all__') | |
738 | except: |
|
738 | except: | |
739 | return [] |
|
739 | return [] | |
740 |
|
740 | |||
741 | return [w for w in words if isinstance(w, str)] |
|
741 | return [w for w in words if isinstance(w, str)] | |
742 |
|
742 | |||
743 |
|
743 | |||
744 | def match_dict_keys(keys: List[str], prefix: str, delims: str): |
|
744 | def match_dict_keys(keys: List[str], prefix: str, delims: str): | |
745 | """Used by dict_key_matches, matching the prefix to a list of keys |
|
745 | """Used by dict_key_matches, matching the prefix to a list of keys | |
746 |
|
746 | |||
747 | Parameters |
|
747 | Parameters | |
748 | ========== |
|
748 | ========== | |
749 | keys: |
|
749 | keys: | |
750 | list of keys in dictionary currently being completed. |
|
750 | list of keys in dictionary currently being completed. | |
751 | prefix: |
|
751 | prefix: | |
752 | Part of the text already typed by the user. e.g. `mydict[b'fo` |
|
752 | Part of the text already typed by the user. e.g. `mydict[b'fo` | |
753 | delims: |
|
753 | delims: | |
754 | String of delimiters to consider when finding the current key. |
|
754 | String of delimiters to consider when finding the current key. | |
755 |
|
755 | |||
756 | Returns |
|
756 | Returns | |
757 | ======= |
|
757 | ======= | |
758 |
|
758 | |||
759 | A tuple of three elements: ``quote``, ``token_start``, ``matched``, with |
|
759 | A tuple of three elements: ``quote``, ``token_start``, ``matched``, with | |
760 | ``quote`` being the quote that need to be used to close current string. |
|
760 | ``quote`` being the quote that need to be used to close current string. | |
761 | ``token_start`` the position where the replacement should start occurring, |
|
761 | ``token_start`` the position where the replacement should start occurring, | |
762 | ``matches`` a list of replacement/completion |
|
762 | ``matches`` a list of replacement/completion | |
763 |
|
763 | |||
764 | """ |
|
764 | """ | |
765 | if not prefix: |
|
765 | if not prefix: | |
766 | return None, 0, [repr(k) for k in keys |
|
766 | return None, 0, [repr(k) for k in keys | |
767 | if isinstance(k, (str, bytes))] |
|
767 | if isinstance(k, (str, bytes))] | |
768 | quote_match = re.search('["\']', prefix) |
|
768 | quote_match = re.search('["\']', prefix) | |
769 | quote = quote_match.group() |
|
769 | quote = quote_match.group() | |
770 | try: |
|
770 | try: | |
771 | prefix_str = eval(prefix + quote, {}) |
|
771 | prefix_str = eval(prefix + quote, {}) | |
772 | except Exception: |
|
772 | except Exception: | |
773 | return None, 0, [] |
|
773 | return None, 0, [] | |
774 |
|
774 | |||
775 | pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$' |
|
775 | pattern = '[^' + ''.join('\\' + c for c in delims) + ']*$' | |
776 | token_match = re.search(pattern, prefix, re.UNICODE) |
|
776 | token_match = re.search(pattern, prefix, re.UNICODE) | |
777 | token_start = token_match.start() |
|
777 | token_start = token_match.start() | |
778 | token_prefix = token_match.group() |
|
778 | token_prefix = token_match.group() | |
779 |
|
779 | |||
780 | matched = [] |
|
780 | matched = [] | |
781 | for key in keys: |
|
781 | for key in keys: | |
782 | try: |
|
782 | try: | |
783 | if not key.startswith(prefix_str): |
|
783 | if not key.startswith(prefix_str): | |
784 | continue |
|
784 | continue | |
785 | except (AttributeError, TypeError, UnicodeError): |
|
785 | except (AttributeError, TypeError, UnicodeError): | |
786 | # Python 3+ TypeError on b'a'.startswith('a') or vice-versa |
|
786 | # Python 3+ TypeError on b'a'.startswith('a') or vice-versa | |
787 | continue |
|
787 | continue | |
788 |
|
788 | |||
789 | # reformat remainder of key to begin with prefix |
|
789 | # reformat remainder of key to begin with prefix | |
790 | rem = key[len(prefix_str):] |
|
790 | rem = key[len(prefix_str):] | |
791 | # force repr wrapped in ' |
|
791 | # force repr wrapped in ' | |
792 | rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"') |
|
792 | rem_repr = repr(rem + '"') if isinstance(rem, str) else repr(rem + b'"') | |
793 | if rem_repr.startswith('u') and prefix[0] not in 'uU': |
|
793 | if rem_repr.startswith('u') and prefix[0] not in 'uU': | |
794 | # Found key is unicode, but prefix is Py2 string. |
|
794 | # Found key is unicode, but prefix is Py2 string. | |
795 | # Therefore attempt to interpret key as string. |
|
795 | # Therefore attempt to interpret key as string. | |
796 | try: |
|
796 | try: | |
797 | rem_repr = repr(rem.encode('ascii') + '"') |
|
797 | rem_repr = repr(rem.encode('ascii') + '"') | |
798 | except UnicodeEncodeError: |
|
798 | except UnicodeEncodeError: | |
799 | continue |
|
799 | continue | |
800 |
|
800 | |||
801 | rem_repr = rem_repr[1 + rem_repr.index("'"):-2] |
|
801 | rem_repr = rem_repr[1 + rem_repr.index("'"):-2] | |
802 | if quote == '"': |
|
802 | if quote == '"': | |
803 | # The entered prefix is quoted with ", |
|
803 | # The entered prefix is quoted with ", | |
804 | # but the match is quoted with '. |
|
804 | # but the match is quoted with '. | |
805 | # A contained " hence needs escaping for comparison: |
|
805 | # A contained " hence needs escaping for comparison: | |
806 | rem_repr = rem_repr.replace('"', '\\"') |
|
806 | rem_repr = rem_repr.replace('"', '\\"') | |
807 |
|
807 | |||
808 | # then reinsert prefix from start of token |
|
808 | # then reinsert prefix from start of token | |
809 | matched.append('%s%s' % (token_prefix, rem_repr)) |
|
809 | matched.append('%s%s' % (token_prefix, rem_repr)) | |
810 | return quote, token_start, matched |
|
810 | return quote, token_start, matched | |
811 |
|
811 | |||
812 |
|
812 | |||
813 | def cursor_to_position(text:str, line:int, column:int)->int: |
|
813 | def cursor_to_position(text:str, line:int, column:int)->int: | |
814 | """ |
|
814 | """ | |
815 |
|
815 | |||
816 | Convert the (line,column) position of the cursor in text to an offset in a |
|
816 | Convert the (line,column) position of the cursor in text to an offset in a | |
817 | string. |
|
817 | string. | |
818 |
|
818 | |||
819 | Parameters |
|
819 | Parameters | |
820 | ---------- |
|
820 | ---------- | |
821 |
|
821 | |||
822 | text : str |
|
822 | text : str | |
823 | The text in which to calculate the cursor offset |
|
823 | The text in which to calculate the cursor offset | |
824 | line : int |
|
824 | line : int | |
825 | Line of the cursor; 0-indexed |
|
825 | Line of the cursor; 0-indexed | |
826 | column : int |
|
826 | column : int | |
827 | Column of the cursor 0-indexed |
|
827 | Column of the cursor 0-indexed | |
828 |
|
828 | |||
829 | Return |
|
829 | Return | |
830 | ------ |
|
830 | ------ | |
831 | Position of the cursor in ``text``, 0-indexed. |
|
831 | Position of the cursor in ``text``, 0-indexed. | |
832 |
|
832 | |||
833 | See Also |
|
833 | See Also | |
834 | -------- |
|
834 | -------- | |
835 | position_to_cursor: reciprocal of this function |
|
835 | position_to_cursor: reciprocal of this function | |
836 |
|
836 | |||
837 | """ |
|
837 | """ | |
838 | lines = text.split('\n') |
|
838 | lines = text.split('\n') | |
839 | assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines))) |
|
839 | assert line <= len(lines), '{} <= {}'.format(str(line), str(len(lines))) | |
840 |
|
840 | |||
841 | return sum(len(l) + 1 for l in lines[:line]) + column |
|
841 | return sum(len(l) + 1 for l in lines[:line]) + column | |
842 |
|
842 | |||
843 | def position_to_cursor(text:str, offset:int)->Tuple[int, int]: |
|
843 | def position_to_cursor(text:str, offset:int)->Tuple[int, int]: | |
844 | """ |
|
844 | """ | |
845 | Convert the position of the cursor in text (0 indexed) to a line |
|
845 | Convert the position of the cursor in text (0 indexed) to a line | |
846 | number(0-indexed) and a column number (0-indexed) pair |
|
846 | number(0-indexed) and a column number (0-indexed) pair | |
847 |
|
847 | |||
848 | Position should be a valid position in ``text``. |
|
848 | Position should be a valid position in ``text``. | |
849 |
|
849 | |||
850 | Parameters |
|
850 | Parameters | |
851 | ---------- |
|
851 | ---------- | |
852 |
|
852 | |||
853 | text : str |
|
853 | text : str | |
854 | The text in which to calculate the cursor offset |
|
854 | The text in which to calculate the cursor offset | |
855 | offset : int |
|
855 | offset : int | |
856 | Position of the cursor in ``text``, 0-indexed. |
|
856 | Position of the cursor in ``text``, 0-indexed. | |
857 |
|
857 | |||
858 | Return |
|
858 | Return | |
859 | ------ |
|
859 | ------ | |
860 | (line, column) : (int, int) |
|
860 | (line, column) : (int, int) | |
861 | Line of the cursor; 0-indexed, column of the cursor 0-indexed |
|
861 | Line of the cursor; 0-indexed, column of the cursor 0-indexed | |
862 |
|
862 | |||
863 |
|
863 | |||
864 | See Also |
|
864 | See Also | |
865 | -------- |
|
865 | -------- | |
866 | cursor_to_position : reciprocal of this function |
|
866 | cursor_to_position : reciprocal of this function | |
867 |
|
867 | |||
868 |
|
868 | |||
869 | """ |
|
869 | """ | |
870 |
|
870 | |||
871 | assert 0 < offset <= len(text) , "0 < %s <= %s" % (offset , len(text)) |
|
871 | assert 0 < offset <= len(text) , "0 < %s <= %s" % (offset , len(text)) | |
872 |
|
872 | |||
873 | before = text[:offset] |
|
873 | before = text[:offset] | |
874 | blines = before.split('\n') # ! splitnes trim trailing \n |
|
874 | blines = before.split('\n') # ! splitnes trim trailing \n | |
875 | line = before.count('\n') |
|
875 | line = before.count('\n') | |
876 | col = len(blines[-1]) |
|
876 | col = len(blines[-1]) | |
877 | return line, col |
|
877 | return line, col | |
878 |
|
878 | |||
879 |
|
879 | |||
880 | def _safe_isinstance(obj, module, class_name): |
|
880 | def _safe_isinstance(obj, module, class_name): | |
881 | """Checks if obj is an instance of module.class_name if loaded |
|
881 | """Checks if obj is an instance of module.class_name if loaded | |
882 | """ |
|
882 | """ | |
883 | return (module in sys.modules and |
|
883 | return (module in sys.modules and | |
884 | isinstance(obj, getattr(import_module(module), class_name))) |
|
884 | isinstance(obj, getattr(import_module(module), class_name))) | |
885 |
|
885 | |||
886 |
|
886 | |||
887 | def back_unicode_name_matches(text): |
|
887 | def back_unicode_name_matches(text): | |
888 | u"""Match unicode characters back to unicode name |
|
888 | u"""Match unicode characters back to unicode name | |
889 |
|
889 | |||
890 | This does ``β`` -> ``\\snowman`` |
|
890 | This does ``β`` -> ``\\snowman`` | |
891 |
|
891 | |||
892 | Note that snowman is not a valid python3 combining character but will be expanded. |
|
892 | Note that snowman is not a valid python3 combining character but will be expanded. | |
893 | Though it will not recombine back to the snowman character by the completion machinery. |
|
893 | Though it will not recombine back to the snowman character by the completion machinery. | |
894 |
|
894 | |||
895 | This will not either back-complete standard sequences like \\n, \\b ... |
|
895 | This will not either back-complete standard sequences like \\n, \\b ... | |
896 |
|
896 | |||
897 | Used on Python 3 only. |
|
897 | Used on Python 3 only. | |
898 | """ |
|
898 | """ | |
899 | if len(text)<2: |
|
899 | if len(text)<2: | |
900 | return u'', () |
|
900 | return u'', () | |
901 | maybe_slash = text[-2] |
|
901 | maybe_slash = text[-2] | |
902 | if maybe_slash != '\\': |
|
902 | if maybe_slash != '\\': | |
903 | return u'', () |
|
903 | return u'', () | |
904 |
|
904 | |||
905 | char = text[-1] |
|
905 | char = text[-1] | |
906 | # no expand on quote for completion in strings. |
|
906 | # no expand on quote for completion in strings. | |
907 | # nor backcomplete standard ascii keys |
|
907 | # nor backcomplete standard ascii keys | |
908 | if char in string.ascii_letters or char in ['"',"'"]: |
|
908 | if char in string.ascii_letters or char in ['"',"'"]: | |
909 | return u'', () |
|
909 | return u'', () | |
910 | try : |
|
910 | try : | |
911 | unic = unicodedata.name(char) |
|
911 | unic = unicodedata.name(char) | |
912 | return '\\'+char,['\\'+unic] |
|
912 | return '\\'+char,['\\'+unic] | |
913 | except KeyError: |
|
913 | except KeyError: | |
914 | pass |
|
914 | pass | |
915 | return u'', () |
|
915 | return u'', () | |
916 |
|
916 | |||
917 | def back_latex_name_matches(text:str): |
|
917 | def back_latex_name_matches(text:str): | |
918 | """Match latex characters back to unicode name |
|
918 | """Match latex characters back to unicode name | |
919 |
|
919 | |||
920 | This does ``\\β΅`` -> ``\\aleph`` |
|
920 | This does ``\\β΅`` -> ``\\aleph`` | |
921 |
|
921 | |||
922 | Used on Python 3 only. |
|
922 | Used on Python 3 only. | |
923 | """ |
|
923 | """ | |
924 | if len(text)<2: |
|
924 | if len(text)<2: | |
925 | return u'', () |
|
925 | return u'', () | |
926 | maybe_slash = text[-2] |
|
926 | maybe_slash = text[-2] | |
927 | if maybe_slash != '\\': |
|
927 | if maybe_slash != '\\': | |
928 | return u'', () |
|
928 | return u'', () | |
929 |
|
929 | |||
930 |
|
930 | |||
931 | char = text[-1] |
|
931 | char = text[-1] | |
932 | # no expand on quote for completion in strings. |
|
932 | # no expand on quote for completion in strings. | |
933 | # nor backcomplete standard ascii keys |
|
933 | # nor backcomplete standard ascii keys | |
934 | if char in string.ascii_letters or char in ['"',"'"]: |
|
934 | if char in string.ascii_letters or char in ['"',"'"]: | |
935 | return u'', () |
|
935 | return u'', () | |
936 | try : |
|
936 | try : | |
937 | latex = reverse_latex_symbol[char] |
|
937 | latex = reverse_latex_symbol[char] | |
938 | # '\\' replace the \ as well |
|
938 | # '\\' replace the \ as well | |
939 | return '\\'+char,[latex] |
|
939 | return '\\'+char,[latex] | |
940 | except KeyError: |
|
940 | except KeyError: | |
941 | pass |
|
941 | pass | |
942 | return u'', () |
|
942 | return u'', () | |
943 |
|
943 | |||
944 |
|
944 | |||
945 | def _formatparamchildren(parameter) -> str: |
|
945 | def _formatparamchildren(parameter) -> str: | |
946 | """ |
|
946 | """ | |
947 | Get parameter name and value from Jedi Private API |
|
947 | Get parameter name and value from Jedi Private API | |
948 |
|
948 | |||
949 | Jedi does not expose a simple way to get `param=value` from its API. |
|
949 | Jedi does not expose a simple way to get `param=value` from its API. | |
950 |
|
950 | |||
951 | Prameter |
|
951 | Prameter | |
952 | ======== |
|
952 | ======== | |
953 |
|
953 | |||
954 | parameter: |
|
954 | parameter: | |
955 | Jedi's function `Param` |
|
955 | Jedi's function `Param` | |
956 |
|
956 | |||
957 | Returns |
|
957 | Returns | |
958 | ======= |
|
958 | ======= | |
959 |
|
959 | |||
960 | A string like 'a', 'b=1', '*args', '**kwargs' |
|
960 | A string like 'a', 'b=1', '*args', '**kwargs' | |
961 |
|
961 | |||
962 |
|
962 | |||
963 | """ |
|
963 | """ | |
964 | description = parameter.description |
|
964 | description = parameter.description | |
965 | if not description.startswith('param '): |
|
965 | if not description.startswith('param '): | |
966 | raise ValueError('Jedi function parameter description have change format.' |
|
966 | raise ValueError('Jedi function parameter description have change format.' | |
967 | 'Expected "param ...", found %r".' % description) |
|
967 | 'Expected "param ...", found %r".' % description) | |
968 | return description[6:] |
|
968 | return description[6:] | |
969 |
|
969 | |||
970 | def _make_signature(completion)-> str: |
|
970 | def _make_signature(completion)-> str: | |
971 | """ |
|
971 | """ | |
972 | Make the signature from a jedi completion |
|
972 | Make the signature from a jedi completion | |
973 |
|
973 | |||
974 | Parameter |
|
974 | Parameter | |
975 | ========= |
|
975 | ========= | |
976 |
|
976 | |||
977 | completion: jedi.Completion |
|
977 | completion: jedi.Completion | |
978 | object does not complete a function type |
|
978 | object does not complete a function type | |
979 |
|
979 | |||
980 | Returns |
|
980 | Returns | |
981 | ======= |
|
981 | ======= | |
982 |
|
982 | |||
983 | a string consisting of the function signature, with the parenthesis but |
|
983 | a string consisting of the function signature, with the parenthesis but | |
984 | without the function name. example: |
|
984 | without the function name. example: | |
985 | `(a, *args, b=1, **kwargs)` |
|
985 | `(a, *args, b=1, **kwargs)` | |
986 |
|
986 | |||
987 | """ |
|
987 | """ | |
988 |
|
988 | |||
989 | return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f]) |
|
989 | return '(%s)'% ', '.join([f for f in (_formatparamchildren(p) for p in completion.params) if f]) | |
990 |
|
990 | |||
991 | class IPCompleter(Completer): |
|
991 | class IPCompleter(Completer): | |
992 | """Extension of the completer class with IPython-specific features""" |
|
992 | """Extension of the completer class with IPython-specific features""" | |
993 |
|
993 | |||
994 | @observe('greedy') |
|
994 | @observe('greedy') | |
995 | def _greedy_changed(self, change): |
|
995 | def _greedy_changed(self, change): | |
996 | """update the splitter and readline delims when greedy is changed""" |
|
996 | """update the splitter and readline delims when greedy is changed""" | |
997 | if change['new']: |
|
997 | if change['new']: | |
998 | self.splitter.delims = GREEDY_DELIMS |
|
998 | self.splitter.delims = GREEDY_DELIMS | |
999 | else: |
|
999 | else: | |
1000 | self.splitter.delims = DELIMS |
|
1000 | self.splitter.delims = DELIMS | |
1001 |
|
1001 | |||
1002 | merge_completions = Bool(True, |
|
1002 | merge_completions = Bool(True, | |
1003 | help="""Whether to merge completion results into a single list |
|
1003 | help="""Whether to merge completion results into a single list | |
1004 |
|
1004 | |||
1005 | If False, only the completion results from the first non-empty |
|
1005 | If False, only the completion results from the first non-empty | |
1006 | completer will be returned. |
|
1006 | completer will be returned. | |
1007 | """ |
|
1007 | """ | |
1008 | ).tag(config=True) |
|
1008 | ).tag(config=True) | |
1009 | omit__names = Enum((0,1,2), default_value=2, |
|
1009 | omit__names = Enum((0,1,2), default_value=2, | |
1010 | help="""Instruct the completer to omit private method names |
|
1010 | help="""Instruct the completer to omit private method names | |
1011 |
|
1011 | |||
1012 | Specifically, when completing on ``object.<tab>``. |
|
1012 | Specifically, when completing on ``object.<tab>``. | |
1013 |
|
1013 | |||
1014 | When 2 [default]: all names that start with '_' will be excluded. |
|
1014 | When 2 [default]: all names that start with '_' will be excluded. | |
1015 |
|
1015 | |||
1016 | When 1: all 'magic' names (``__foo__``) will be excluded. |
|
1016 | When 1: all 'magic' names (``__foo__``) will be excluded. | |
1017 |
|
1017 | |||
1018 | When 0: nothing will be excluded. |
|
1018 | When 0: nothing will be excluded. | |
1019 | """ |
|
1019 | """ | |
1020 | ).tag(config=True) |
|
1020 | ).tag(config=True) | |
1021 | limit_to__all__ = Bool(False, |
|
1021 | limit_to__all__ = Bool(False, | |
1022 | help=""" |
|
1022 | help=""" | |
1023 | DEPRECATED as of version 5.0. |
|
1023 | DEPRECATED as of version 5.0. | |
1024 |
|
1024 | |||
1025 | Instruct the completer to use __all__ for the completion |
|
1025 | Instruct the completer to use __all__ for the completion | |
1026 |
|
1026 | |||
1027 | Specifically, when completing on ``object.<tab>``. |
|
1027 | Specifically, when completing on ``object.<tab>``. | |
1028 |
|
1028 | |||
1029 | When True: only those names in obj.__all__ will be included. |
|
1029 | When True: only those names in obj.__all__ will be included. | |
1030 |
|
1030 | |||
1031 | When False [default]: the __all__ attribute is ignored |
|
1031 | When False [default]: the __all__ attribute is ignored | |
1032 | """, |
|
1032 | """, | |
1033 | ).tag(config=True) |
|
1033 | ).tag(config=True) | |
1034 |
|
1034 | |||
1035 | @observe('limit_to__all__') |
|
1035 | @observe('limit_to__all__') | |
1036 | def _limit_to_all_changed(self, change): |
|
1036 | def _limit_to_all_changed(self, change): | |
1037 | warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration ' |
|
1037 | warnings.warn('`IPython.core.IPCompleter.limit_to__all__` configuration ' | |
1038 | 'value has been deprecated since IPython 5.0, will be made to have ' |
|
1038 | 'value has been deprecated since IPython 5.0, will be made to have ' | |
1039 | 'no effects and then removed in future version of IPython.', |
|
1039 | 'no effects and then removed in future version of IPython.', | |
1040 | UserWarning) |
|
1040 | UserWarning) | |
1041 |
|
1041 | |||
1042 | def __init__(self, shell=None, namespace=None, global_namespace=None, |
|
1042 | def __init__(self, shell=None, namespace=None, global_namespace=None, | |
1043 | use_readline=_deprecation_readline_sentinel, config=None, **kwargs): |
|
1043 | use_readline=_deprecation_readline_sentinel, config=None, **kwargs): | |
1044 | """IPCompleter() -> completer |
|
1044 | """IPCompleter() -> completer | |
1045 |
|
1045 | |||
1046 | Return a completer object. |
|
1046 | Return a completer object. | |
1047 |
|
1047 | |||
1048 | Parameters |
|
1048 | Parameters | |
1049 | ---------- |
|
1049 | ---------- | |
1050 |
|
1050 | |||
1051 | shell |
|
1051 | shell | |
1052 | a pointer to the ipython shell itself. This is needed |
|
1052 | a pointer to the ipython shell itself. This is needed | |
1053 | because this completer knows about magic functions, and those can |
|
1053 | because this completer knows about magic functions, and those can | |
1054 | only be accessed via the ipython instance. |
|
1054 | only be accessed via the ipython instance. | |
1055 |
|
1055 | |||
1056 | namespace : dict, optional |
|
1056 | namespace : dict, optional | |
1057 | an optional dict where completions are performed. |
|
1057 | an optional dict where completions are performed. | |
1058 |
|
1058 | |||
1059 | global_namespace : dict, optional |
|
1059 | global_namespace : dict, optional | |
1060 | secondary optional dict for completions, to |
|
1060 | secondary optional dict for completions, to | |
1061 | handle cases (such as IPython embedded inside functions) where |
|
1061 | handle cases (such as IPython embedded inside functions) where | |
1062 | both Python scopes are visible. |
|
1062 | both Python scopes are visible. | |
1063 |
|
1063 | |||
1064 | use_readline : bool, optional |
|
1064 | use_readline : bool, optional | |
1065 | DEPRECATED, ignored since IPython 6.0, will have no effects |
|
1065 | DEPRECATED, ignored since IPython 6.0, will have no effects | |
1066 | """ |
|
1066 | """ | |
1067 |
|
1067 | |||
1068 | self.magic_escape = ESC_MAGIC |
|
1068 | self.magic_escape = ESC_MAGIC | |
1069 | self.splitter = CompletionSplitter() |
|
1069 | self.splitter = CompletionSplitter() | |
1070 |
|
1070 | |||
1071 | if use_readline is not _deprecation_readline_sentinel: |
|
1071 | if use_readline is not _deprecation_readline_sentinel: | |
1072 | warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.', |
|
1072 | warnings.warn('The `use_readline` parameter is deprecated and ignored since IPython 6.0.', | |
1073 | DeprecationWarning, stacklevel=2) |
|
1073 | DeprecationWarning, stacklevel=2) | |
1074 |
|
1074 | |||
1075 | # _greedy_changed() depends on splitter and readline being defined: |
|
1075 | # _greedy_changed() depends on splitter and readline being defined: | |
1076 | Completer.__init__(self, namespace=namespace, global_namespace=global_namespace, |
|
1076 | Completer.__init__(self, namespace=namespace, global_namespace=global_namespace, | |
1077 | config=config, **kwargs) |
|
1077 | config=config, **kwargs) | |
1078 |
|
1078 | |||
1079 | # List where completion matches will be stored |
|
1079 | # List where completion matches will be stored | |
1080 | self.matches = [] |
|
1080 | self.matches = [] | |
1081 | self.shell = shell |
|
1081 | self.shell = shell | |
1082 | # Regexp to split filenames with spaces in them |
|
1082 | # Regexp to split filenames with spaces in them | |
1083 | self.space_name_re = re.compile(r'([^\\] )') |
|
1083 | self.space_name_re = re.compile(r'([^\\] )') | |
1084 | # Hold a local ref. to glob.glob for speed |
|
1084 | # Hold a local ref. to glob.glob for speed | |
1085 | self.glob = glob.glob |
|
1085 | self.glob = glob.glob | |
1086 |
|
1086 | |||
1087 | # Determine if we are running on 'dumb' terminals, like (X)Emacs |
|
1087 | # Determine if we are running on 'dumb' terminals, like (X)Emacs | |
1088 | # buffers, to avoid completion problems. |
|
1088 | # buffers, to avoid completion problems. | |
1089 | term = os.environ.get('TERM','xterm') |
|
1089 | term = os.environ.get('TERM','xterm') | |
1090 | self.dumb_terminal = term in ['dumb','emacs'] |
|
1090 | self.dumb_terminal = term in ['dumb','emacs'] | |
1091 |
|
1091 | |||
1092 | # Special handling of backslashes needed in win32 platforms |
|
1092 | # Special handling of backslashes needed in win32 platforms | |
1093 | if sys.platform == "win32": |
|
1093 | if sys.platform == "win32": | |
1094 | self.clean_glob = self._clean_glob_win32 |
|
1094 | self.clean_glob = self._clean_glob_win32 | |
1095 | else: |
|
1095 | else: | |
1096 | self.clean_glob = self._clean_glob |
|
1096 | self.clean_glob = self._clean_glob | |
1097 |
|
1097 | |||
1098 | #regexp to parse docstring for function signature |
|
1098 | #regexp to parse docstring for function signature | |
1099 | self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1099 | self.docstring_sig_re = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') | |
1100 | self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1100 | self.docstring_kwd_re = re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') | |
1101 | #use this if positional argument name is also needed |
|
1101 | #use this if positional argument name is also needed | |
1102 | #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)') |
|
1102 | #= re.compile(r'[\s|\[]*(\w+)(?:\s*=?\s*.*)') | |
1103 |
|
1103 | |||
1104 | # All active matcher routines for completion |
|
|||
1105 | self.matchers = [ |
|
|||
1106 | self.python_matches, |
|
|||
1107 | self.file_matches, |
|
|||
1108 | self.magic_matches, |
|
|||
1109 | self.python_func_kw_matches, |
|
|||
1110 | self.dict_key_matches, |
|
|||
1111 | ] |
|
|||
1112 | self.magic_arg_matchers = [ |
|
1104 | self.magic_arg_matchers = [ | |
1113 | self.magic_config_matches, |
|
1105 | self.magic_config_matches, | |
1114 | self.magic_color_matches, |
|
1106 | self.magic_color_matches, | |
1115 | ] |
|
1107 | ] | |
1116 |
|
1108 | |||
1117 | # This is set externally by InteractiveShell |
|
1109 | # This is set externally by InteractiveShell | |
1118 | self.custom_completers = None |
|
1110 | self.custom_completers = None | |
1119 |
|
1111 | |||
|
1112 | @property | |||
|
1113 | def matchers(self): | |||
|
1114 | """All active matcher routines for completion""" | |||
|
1115 | if self.use_jedi: | |||
|
1116 | return [ | |||
|
1117 | self.file_matches, | |||
|
1118 | self.magic_matches, | |||
|
1119 | self.dict_key_matches, | |||
|
1120 | ] | |||
|
1121 | else: | |||
|
1122 | return [ | |||
|
1123 | self.python_matches, | |||
|
1124 | self.file_matches, | |||
|
1125 | self.magic_matches, | |||
|
1126 | self.python_func_kw_matches, | |||
|
1127 | self.dict_key_matches, | |||
|
1128 | ] | |||
|
1129 | ||||
1120 | def all_completions(self, text): |
|
1130 | def all_completions(self, text): | |
1121 | """ |
|
1131 | """ | |
1122 | Wrapper around the complete method for the benefit of emacs. |
|
1132 | Wrapper around the complete method for the benefit of emacs. | |
1123 | """ |
|
1133 | """ | |
1124 | return self.complete(text)[1] |
|
1134 | return self.complete(text)[1] | |
1125 |
|
1135 | |||
1126 | def _clean_glob(self, text): |
|
1136 | def _clean_glob(self, text): | |
1127 | return self.glob("%s*" % text) |
|
1137 | return self.glob("%s*" % text) | |
1128 |
|
1138 | |||
1129 | def _clean_glob_win32(self,text): |
|
1139 | def _clean_glob_win32(self,text): | |
1130 | return [f.replace("\\","/") |
|
1140 | return [f.replace("\\","/") | |
1131 | for f in self.glob("%s*" % text)] |
|
1141 | for f in self.glob("%s*" % text)] | |
1132 |
|
1142 | |||
1133 | def file_matches(self, text): |
|
1143 | def file_matches(self, text): | |
1134 | """Match filenames, expanding ~USER type strings. |
|
1144 | """Match filenames, expanding ~USER type strings. | |
1135 |
|
1145 | |||
1136 | Most of the seemingly convoluted logic in this completer is an |
|
1146 | Most of the seemingly convoluted logic in this completer is an | |
1137 | attempt to handle filenames with spaces in them. And yet it's not |
|
1147 | attempt to handle filenames with spaces in them. And yet it's not | |
1138 | quite perfect, because Python's readline doesn't expose all of the |
|
1148 | quite perfect, because Python's readline doesn't expose all of the | |
1139 | GNU readline details needed for this to be done correctly. |
|
1149 | GNU readline details needed for this to be done correctly. | |
1140 |
|
1150 | |||
1141 | For a filename with a space in it, the printed completions will be |
|
1151 | For a filename with a space in it, the printed completions will be | |
1142 | only the parts after what's already been typed (instead of the |
|
1152 | only the parts after what's already been typed (instead of the | |
1143 | full completions, as is normally done). I don't think with the |
|
1153 | full completions, as is normally done). I don't think with the | |
1144 | current (as of Python 2.3) Python readline it's possible to do |
|
1154 | current (as of Python 2.3) Python readline it's possible to do | |
1145 | better.""" |
|
1155 | better.""" | |
1146 |
|
1156 | |||
1147 | # chars that require escaping with backslash - i.e. chars |
|
1157 | # chars that require escaping with backslash - i.e. chars | |
1148 | # that readline treats incorrectly as delimiters, but we |
|
1158 | # that readline treats incorrectly as delimiters, but we | |
1149 | # don't want to treat as delimiters in filename matching |
|
1159 | # don't want to treat as delimiters in filename matching | |
1150 | # when escaped with backslash |
|
1160 | # when escaped with backslash | |
1151 | if text.startswith('!'): |
|
1161 | if text.startswith('!'): | |
1152 | text = text[1:] |
|
1162 | text = text[1:] | |
1153 | text_prefix = u'!' |
|
1163 | text_prefix = u'!' | |
1154 | else: |
|
1164 | else: | |
1155 | text_prefix = u'' |
|
1165 | text_prefix = u'' | |
1156 |
|
1166 | |||
1157 | text_until_cursor = self.text_until_cursor |
|
1167 | text_until_cursor = self.text_until_cursor | |
1158 | # track strings with open quotes |
|
1168 | # track strings with open quotes | |
1159 | open_quotes = has_open_quotes(text_until_cursor) |
|
1169 | open_quotes = has_open_quotes(text_until_cursor) | |
1160 |
|
1170 | |||
1161 | if '(' in text_until_cursor or '[' in text_until_cursor: |
|
1171 | if '(' in text_until_cursor or '[' in text_until_cursor: | |
1162 | lsplit = text |
|
1172 | lsplit = text | |
1163 | else: |
|
1173 | else: | |
1164 | try: |
|
1174 | try: | |
1165 | # arg_split ~ shlex.split, but with unicode bugs fixed by us |
|
1175 | # arg_split ~ shlex.split, but with unicode bugs fixed by us | |
1166 | lsplit = arg_split(text_until_cursor)[-1] |
|
1176 | lsplit = arg_split(text_until_cursor)[-1] | |
1167 | except ValueError: |
|
1177 | except ValueError: | |
1168 | # typically an unmatched ", or backslash without escaped char. |
|
1178 | # typically an unmatched ", or backslash without escaped char. | |
1169 | if open_quotes: |
|
1179 | if open_quotes: | |
1170 | lsplit = text_until_cursor.split(open_quotes)[-1] |
|
1180 | lsplit = text_until_cursor.split(open_quotes)[-1] | |
1171 | else: |
|
1181 | else: | |
1172 | return [] |
|
1182 | return [] | |
1173 | except IndexError: |
|
1183 | except IndexError: | |
1174 | # tab pressed on empty line |
|
1184 | # tab pressed on empty line | |
1175 | lsplit = "" |
|
1185 | lsplit = "" | |
1176 |
|
1186 | |||
1177 | if not open_quotes and lsplit != protect_filename(lsplit): |
|
1187 | if not open_quotes and lsplit != protect_filename(lsplit): | |
1178 | # if protectables are found, do matching on the whole escaped name |
|
1188 | # if protectables are found, do matching on the whole escaped name | |
1179 | has_protectables = True |
|
1189 | has_protectables = True | |
1180 | text0,text = text,lsplit |
|
1190 | text0,text = text,lsplit | |
1181 | else: |
|
1191 | else: | |
1182 | has_protectables = False |
|
1192 | has_protectables = False | |
1183 | text = os.path.expanduser(text) |
|
1193 | text = os.path.expanduser(text) | |
1184 |
|
1194 | |||
1185 | if text == "": |
|
1195 | if text == "": | |
1186 | return [text_prefix + protect_filename(f) for f in self.glob("*")] |
|
1196 | return [text_prefix + protect_filename(f) for f in self.glob("*")] | |
1187 |
|
1197 | |||
1188 | # Compute the matches from the filesystem |
|
1198 | # Compute the matches from the filesystem | |
1189 | if sys.platform == 'win32': |
|
1199 | if sys.platform == 'win32': | |
1190 | m0 = self.clean_glob(text) |
|
1200 | m0 = self.clean_glob(text) | |
1191 | else: |
|
1201 | else: | |
1192 | m0 = self.clean_glob(text.replace('\\', '')) |
|
1202 | m0 = self.clean_glob(text.replace('\\', '')) | |
1193 |
|
1203 | |||
1194 | if has_protectables: |
|
1204 | if has_protectables: | |
1195 | # If we had protectables, we need to revert our changes to the |
|
1205 | # If we had protectables, we need to revert our changes to the | |
1196 | # beginning of filename so that we don't double-write the part |
|
1206 | # beginning of filename so that we don't double-write the part | |
1197 | # of the filename we have so far |
|
1207 | # of the filename we have so far | |
1198 | len_lsplit = len(lsplit) |
|
1208 | len_lsplit = len(lsplit) | |
1199 | matches = [text_prefix + text0 + |
|
1209 | matches = [text_prefix + text0 + | |
1200 | protect_filename(f[len_lsplit:]) for f in m0] |
|
1210 | protect_filename(f[len_lsplit:]) for f in m0] | |
1201 | else: |
|
1211 | else: | |
1202 | if open_quotes: |
|
1212 | if open_quotes: | |
1203 | # if we have a string with an open quote, we don't need to |
|
1213 | # if we have a string with an open quote, we don't need to | |
1204 | # protect the names beyond the quote (and we _shouldn't_, as |
|
1214 | # protect the names beyond the quote (and we _shouldn't_, as | |
1205 | # it would cause bugs when the filesystem call is made). |
|
1215 | # it would cause bugs when the filesystem call is made). | |
1206 | matches = m0 if sys.platform == "win32" else\ |
|
1216 | matches = m0 if sys.platform == "win32" else\ | |
1207 | [protect_filename(f, open_quotes) for f in m0] |
|
1217 | [protect_filename(f, open_quotes) for f in m0] | |
1208 | else: |
|
1218 | else: | |
1209 | matches = [text_prefix + |
|
1219 | matches = [text_prefix + | |
1210 | protect_filename(f) for f in m0] |
|
1220 | protect_filename(f) for f in m0] | |
1211 |
|
1221 | |||
1212 | # Mark directories in input list by appending '/' to their names. |
|
1222 | # Mark directories in input list by appending '/' to their names. | |
1213 | return [x+'/' if os.path.isdir(x) else x for x in matches] |
|
1223 | return [x+'/' if os.path.isdir(x) else x for x in matches] | |
1214 |
|
1224 | |||
1215 | def magic_matches(self, text): |
|
1225 | def magic_matches(self, text): | |
1216 | """Match magics""" |
|
1226 | """Match magics""" | |
1217 | # Get all shell magics now rather than statically, so magics loaded at |
|
1227 | # Get all shell magics now rather than statically, so magics loaded at | |
1218 | # runtime show up too. |
|
1228 | # runtime show up too. | |
1219 | lsm = self.shell.magics_manager.lsmagic() |
|
1229 | lsm = self.shell.magics_manager.lsmagic() | |
1220 | line_magics = lsm['line'] |
|
1230 | line_magics = lsm['line'] | |
1221 | cell_magics = lsm['cell'] |
|
1231 | cell_magics = lsm['cell'] | |
1222 | pre = self.magic_escape |
|
1232 | pre = self.magic_escape | |
1223 | pre2 = pre+pre |
|
1233 | pre2 = pre+pre | |
1224 |
|
1234 | |||
1225 | explicit_magic = text.startswith(pre) |
|
1235 | explicit_magic = text.startswith(pre) | |
1226 |
|
1236 | |||
1227 | # Completion logic: |
|
1237 | # Completion logic: | |
1228 | # - user gives %%: only do cell magics |
|
1238 | # - user gives %%: only do cell magics | |
1229 | # - user gives %: do both line and cell magics |
|
1239 | # - user gives %: do both line and cell magics | |
1230 | # - no prefix: do both |
|
1240 | # - no prefix: do both | |
1231 | # In other words, line magics are skipped if the user gives %% explicitly |
|
1241 | # In other words, line magics are skipped if the user gives %% explicitly | |
1232 | # |
|
1242 | # | |
1233 | # We also exclude magics that match any currently visible names: |
|
1243 | # We also exclude magics that match any currently visible names: | |
1234 | # https://github.com/ipython/ipython/issues/4877, unless the user has |
|
1244 | # https://github.com/ipython/ipython/issues/4877, unless the user has | |
1235 | # typed a %: |
|
1245 | # typed a %: | |
1236 | # https://github.com/ipython/ipython/issues/10754 |
|
1246 | # https://github.com/ipython/ipython/issues/10754 | |
1237 | bare_text = text.lstrip(pre) |
|
1247 | bare_text = text.lstrip(pre) | |
1238 | global_matches = self.global_matches(bare_text) |
|
1248 | global_matches = self.global_matches(bare_text) | |
1239 | if not explicit_magic: |
|
1249 | if not explicit_magic: | |
1240 | def matches(magic): |
|
1250 | def matches(magic): | |
1241 | """ |
|
1251 | """ | |
1242 | Filter magics, in particular remove magics that match |
|
1252 | Filter magics, in particular remove magics that match | |
1243 | a name present in global namespace. |
|
1253 | a name present in global namespace. | |
1244 | """ |
|
1254 | """ | |
1245 | return ( magic.startswith(bare_text) and |
|
1255 | return ( magic.startswith(bare_text) and | |
1246 | magic not in global_matches ) |
|
1256 | magic not in global_matches ) | |
1247 | else: |
|
1257 | else: | |
1248 | def matches(magic): |
|
1258 | def matches(magic): | |
1249 | return magic.startswith(bare_text) |
|
1259 | return magic.startswith(bare_text) | |
1250 |
|
1260 | |||
1251 | comp = [ pre2+m for m in cell_magics if matches(m)] |
|
1261 | comp = [ pre2+m for m in cell_magics if matches(m)] | |
1252 | if not text.startswith(pre2): |
|
1262 | if not text.startswith(pre2): | |
1253 | comp += [ pre+m for m in line_magics if matches(m)] |
|
1263 | comp += [ pre+m for m in line_magics if matches(m)] | |
1254 |
|
1264 | |||
1255 | return comp |
|
1265 | return comp | |
1256 |
|
1266 | |||
1257 | def magic_config_matches(self, text:str) -> List[str]: |
|
1267 | def magic_config_matches(self, text:str) -> List[str]: | |
1258 | """ Match class names and attributes for %config magic """ |
|
1268 | """ Match class names and attributes for %config magic """ | |
1259 | texts = text.strip().split() |
|
1269 | texts = text.strip().split() | |
1260 |
|
1270 | |||
1261 | if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'): |
|
1271 | if len(texts) > 0 and (texts[0] == 'config' or texts[0] == '%config'): | |
1262 | # get all configuration classes |
|
1272 | # get all configuration classes | |
1263 | classes = sorted(set([ c for c in self.shell.configurables |
|
1273 | classes = sorted(set([ c for c in self.shell.configurables | |
1264 | if c.__class__.class_traits(config=True) |
|
1274 | if c.__class__.class_traits(config=True) | |
1265 | ]), key=lambda x: x.__class__.__name__) |
|
1275 | ]), key=lambda x: x.__class__.__name__) | |
1266 | classnames = [ c.__class__.__name__ for c in classes ] |
|
1276 | classnames = [ c.__class__.__name__ for c in classes ] | |
1267 |
|
1277 | |||
1268 | # return all classnames if config or %config is given |
|
1278 | # return all classnames if config or %config is given | |
1269 | if len(texts) == 1: |
|
1279 | if len(texts) == 1: | |
1270 | return classnames |
|
1280 | return classnames | |
1271 |
|
1281 | |||
1272 | # match classname |
|
1282 | # match classname | |
1273 | classname_texts = texts[1].split('.') |
|
1283 | classname_texts = texts[1].split('.') | |
1274 | classname = classname_texts[0] |
|
1284 | classname = classname_texts[0] | |
1275 | classname_matches = [ c for c in classnames |
|
1285 | classname_matches = [ c for c in classnames | |
1276 | if c.startswith(classname) ] |
|
1286 | if c.startswith(classname) ] | |
1277 |
|
1287 | |||
1278 | # return matched classes or the matched class with attributes |
|
1288 | # return matched classes or the matched class with attributes | |
1279 | if texts[1].find('.') < 0: |
|
1289 | if texts[1].find('.') < 0: | |
1280 | return classname_matches |
|
1290 | return classname_matches | |
1281 | elif len(classname_matches) == 1 and \ |
|
1291 | elif len(classname_matches) == 1 and \ | |
1282 | classname_matches[0] == classname: |
|
1292 | classname_matches[0] == classname: | |
1283 | cls = classes[classnames.index(classname)].__class__ |
|
1293 | cls = classes[classnames.index(classname)].__class__ | |
1284 | help = cls.class_get_help() |
|
1294 | help = cls.class_get_help() | |
1285 | # strip leading '--' from cl-args: |
|
1295 | # strip leading '--' from cl-args: | |
1286 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) |
|
1296 | help = re.sub(re.compile(r'^--', re.MULTILINE), '', help) | |
1287 | return [ attr.split('=')[0] |
|
1297 | return [ attr.split('=')[0] | |
1288 | for attr in help.strip().splitlines() |
|
1298 | for attr in help.strip().splitlines() | |
1289 | if attr.startswith(texts[1]) ] |
|
1299 | if attr.startswith(texts[1]) ] | |
1290 | return [] |
|
1300 | return [] | |
1291 |
|
1301 | |||
1292 | def magic_color_matches(self, text:str) -> List[str] : |
|
1302 | def magic_color_matches(self, text:str) -> List[str] : | |
1293 | """ Match color schemes for %colors magic""" |
|
1303 | """ Match color schemes for %colors magic""" | |
1294 | texts = text.split() |
|
1304 | texts = text.split() | |
1295 | if text.endswith(' '): |
|
1305 | if text.endswith(' '): | |
1296 | # .split() strips off the trailing whitespace. Add '' back |
|
1306 | # .split() strips off the trailing whitespace. Add '' back | |
1297 | # so that: '%colors ' -> ['%colors', ''] |
|
1307 | # so that: '%colors ' -> ['%colors', ''] | |
1298 | texts.append('') |
|
1308 | texts.append('') | |
1299 |
|
1309 | |||
1300 | if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'): |
|
1310 | if len(texts) == 2 and (texts[0] == 'colors' or texts[0] == '%colors'): | |
1301 | prefix = texts[1] |
|
1311 | prefix = texts[1] | |
1302 | return [ color for color in InspectColors.keys() |
|
1312 | return [ color for color in InspectColors.keys() | |
1303 | if color.startswith(prefix) ] |
|
1313 | if color.startswith(prefix) ] | |
1304 | return [] |
|
1314 | return [] | |
1305 |
|
1315 | |||
1306 | def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str): |
|
1316 | def _jedi_matches(self, cursor_column:int, cursor_line:int, text:str): | |
1307 | """ |
|
1317 | """ | |
1308 |
|
1318 | |||
1309 | Return a list of :any:`jedi.api.Completions` object from a ``text`` and |
|
1319 | Return a list of :any:`jedi.api.Completions` object from a ``text`` and | |
1310 | cursor position. |
|
1320 | cursor position. | |
1311 |
|
1321 | |||
1312 | Parameters |
|
1322 | Parameters | |
1313 | ---------- |
|
1323 | ---------- | |
1314 | cursor_column : int |
|
1324 | cursor_column : int | |
1315 | column position of the cursor in ``text``, 0-indexed. |
|
1325 | column position of the cursor in ``text``, 0-indexed. | |
1316 | cursor_line : int |
|
1326 | cursor_line : int | |
1317 | line position of the cursor in ``text``, 0-indexed |
|
1327 | line position of the cursor in ``text``, 0-indexed | |
1318 | text : str |
|
1328 | text : str | |
1319 | text to complete |
|
1329 | text to complete | |
1320 |
|
1330 | |||
1321 | Debugging |
|
1331 | Debugging | |
1322 | --------- |
|
1332 | --------- | |
1323 |
|
1333 | |||
1324 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` |
|
1334 | If ``IPCompleter.debug`` is ``True`` may return a :any:`_FakeJediCompletion` | |
1325 | object containing a string with the Jedi debug information attached. |
|
1335 | object containing a string with the Jedi debug information attached. | |
1326 | """ |
|
1336 | """ | |
1327 | namespaces = [self.namespace] |
|
1337 | namespaces = [self.namespace] | |
1328 | if self.global_namespace is not None: |
|
1338 | if self.global_namespace is not None: | |
1329 | namespaces.append(self.global_namespace) |
|
1339 | namespaces.append(self.global_namespace) | |
1330 |
|
1340 | |||
1331 | completion_filter = lambda x:x |
|
1341 | completion_filter = lambda x:x | |
1332 | # cursor_pos is an it, jedi wants line and column |
|
1342 | # cursor_pos is an it, jedi wants line and column | |
1333 | offset = cursor_to_position(text, cursor_line, cursor_column) |
|
1343 | offset = cursor_to_position(text, cursor_line, cursor_column) | |
1334 | # filter output if we are completing for object members |
|
1344 | # filter output if we are completing for object members | |
1335 | if offset: |
|
1345 | if offset: | |
1336 | pre = text[offset-1] |
|
1346 | pre = text[offset-1] | |
1337 | if pre == '.': |
|
1347 | if pre == '.': | |
1338 | if self.omit__names == 2: |
|
1348 | if self.omit__names == 2: | |
1339 | completion_filter = lambda c:not c.name.startswith('_') |
|
1349 | completion_filter = lambda c:not c.name.startswith('_') | |
1340 | elif self.omit__names == 1: |
|
1350 | elif self.omit__names == 1: | |
1341 | completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__')) |
|
1351 | completion_filter = lambda c:not (c.name.startswith('__') and c.name.endswith('__')) | |
1342 | elif self.omit__names == 0: |
|
1352 | elif self.omit__names == 0: | |
1343 | completion_filter = lambda x:x |
|
1353 | completion_filter = lambda x:x | |
1344 | else: |
|
1354 | else: | |
1345 | raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names)) |
|
1355 | raise ValueError("Don't understand self.omit__names == {}".format(self.omit__names)) | |
1346 |
|
1356 | |||
1347 | interpreter = jedi.Interpreter( |
|
1357 | interpreter = jedi.Interpreter( | |
1348 | text, namespaces, column=cursor_column, line=cursor_line + 1) |
|
1358 | text, namespaces, column=cursor_column, line=cursor_line + 1) | |
1349 | try_jedi = True |
|
1359 | try_jedi = True | |
1350 |
|
1360 | |||
1351 | try: |
|
1361 | try: | |
1352 | # should we check the type of the node is Error ? |
|
1362 | # should we check the type of the node is Error ? | |
1353 | try: |
|
1363 | try: | |
1354 | # jedi < 0.11 |
|
1364 | # jedi < 0.11 | |
1355 | from jedi.parser.tree import ErrorLeaf |
|
1365 | from jedi.parser.tree import ErrorLeaf | |
1356 | except ImportError: |
|
1366 | except ImportError: | |
1357 | # jedi >= 0.11 |
|
1367 | # jedi >= 0.11 | |
1358 | from parso.tree import ErrorLeaf |
|
1368 | from parso.tree import ErrorLeaf | |
1359 |
|
1369 | |||
1360 | next_to_last_tree = interpreter._get_module().tree_node.children[-2] |
|
1370 | next_to_last_tree = interpreter._get_module().tree_node.children[-2] | |
1361 | completing_string = False |
|
1371 | completing_string = False | |
1362 | if isinstance(next_to_last_tree, ErrorLeaf): |
|
1372 | if isinstance(next_to_last_tree, ErrorLeaf): | |
1363 | completing_string = next_to_last_tree.value[0] in {'"', "'"} |
|
1373 | completing_string = next_to_last_tree.value[0] in {'"', "'"} | |
1364 | # if we are in a string jedi is likely not the right candidate for |
|
1374 | # if we are in a string jedi is likely not the right candidate for | |
1365 | # now. Skip it. |
|
1375 | # now. Skip it. | |
1366 | try_jedi = not completing_string |
|
1376 | try_jedi = not completing_string | |
1367 | except Exception as e: |
|
1377 | except Exception as e: | |
1368 | # many of things can go wrong, we are using private API just don't crash. |
|
1378 | # many of things can go wrong, we are using private API just don't crash. | |
1369 | if self.debug: |
|
1379 | if self.debug: | |
1370 | print("Error detecting if completing a non-finished string :", e, '|') |
|
1380 | print("Error detecting if completing a non-finished string :", e, '|') | |
1371 |
|
1381 | |||
1372 | if not try_jedi: |
|
1382 | if not try_jedi: | |
1373 | return [] |
|
1383 | return [] | |
1374 | try: |
|
1384 | try: | |
1375 | return filter(completion_filter, interpreter.completions()) |
|
1385 | return filter(completion_filter, interpreter.completions()) | |
1376 | except Exception as e: |
|
1386 | except Exception as e: | |
1377 | if self.debug: |
|
1387 | if self.debug: | |
1378 | return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))] |
|
1388 | return [_FakeJediCompletion('Oops Jedi has crashed, please report a bug with the following:\n"""\n%s\ns"""' % (e))] | |
1379 | else: |
|
1389 | else: | |
1380 | return [] |
|
1390 | return [] | |
1381 |
|
1391 | |||
1382 | def python_matches(self, text): |
|
1392 | def python_matches(self, text): | |
1383 | """Match attributes or global python names""" |
|
1393 | """Match attributes or global python names""" | |
1384 | if "." in text: |
|
1394 | if "." in text: | |
1385 | try: |
|
1395 | try: | |
1386 | matches = self.attr_matches(text) |
|
1396 | matches = self.attr_matches(text) | |
1387 | if text.endswith('.') and self.omit__names: |
|
1397 | if text.endswith('.') and self.omit__names: | |
1388 | if self.omit__names == 1: |
|
1398 | if self.omit__names == 1: | |
1389 | # true if txt is _not_ a __ name, false otherwise: |
|
1399 | # true if txt is _not_ a __ name, false otherwise: | |
1390 | no__name = (lambda txt: |
|
1400 | no__name = (lambda txt: | |
1391 | re.match(r'.*\.__.*?__',txt) is None) |
|
1401 | re.match(r'.*\.__.*?__',txt) is None) | |
1392 | else: |
|
1402 | else: | |
1393 | # true if txt is _not_ a _ name, false otherwise: |
|
1403 | # true if txt is _not_ a _ name, false otherwise: | |
1394 | no__name = (lambda txt: |
|
1404 | no__name = (lambda txt: | |
1395 | re.match(r'\._.*?',txt[txt.rindex('.'):]) is None) |
|
1405 | re.match(r'\._.*?',txt[txt.rindex('.'):]) is None) | |
1396 | matches = filter(no__name, matches) |
|
1406 | matches = filter(no__name, matches) | |
1397 | except NameError: |
|
1407 | except NameError: | |
1398 | # catches <undefined attributes>.<tab> |
|
1408 | # catches <undefined attributes>.<tab> | |
1399 | matches = [] |
|
1409 | matches = [] | |
1400 | else: |
|
1410 | else: | |
1401 | matches = self.global_matches(text) |
|
1411 | matches = self.global_matches(text) | |
1402 | return matches |
|
1412 | return matches | |
1403 |
|
1413 | |||
1404 | def _default_arguments_from_docstring(self, doc): |
|
1414 | def _default_arguments_from_docstring(self, doc): | |
1405 | """Parse the first line of docstring for call signature. |
|
1415 | """Parse the first line of docstring for call signature. | |
1406 |
|
1416 | |||
1407 | Docstring should be of the form 'min(iterable[, key=func])\n'. |
|
1417 | Docstring should be of the form 'min(iterable[, key=func])\n'. | |
1408 | It can also parse cython docstring of the form |
|
1418 | It can also parse cython docstring of the form | |
1409 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'. |
|
1419 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)'. | |
1410 | """ |
|
1420 | """ | |
1411 | if doc is None: |
|
1421 | if doc is None: | |
1412 | return [] |
|
1422 | return [] | |
1413 |
|
1423 | |||
1414 | #care only the firstline |
|
1424 | #care only the firstline | |
1415 | line = doc.lstrip().splitlines()[0] |
|
1425 | line = doc.lstrip().splitlines()[0] | |
1416 |
|
1426 | |||
1417 | #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') |
|
1427 | #p = re.compile(r'^[\w|\s.]+\(([^)]*)\).*') | |
1418 | #'min(iterable[, key=func])\n' -> 'iterable[, key=func]' |
|
1428 | #'min(iterable[, key=func])\n' -> 'iterable[, key=func]' | |
1419 | sig = self.docstring_sig_re.search(line) |
|
1429 | sig = self.docstring_sig_re.search(line) | |
1420 | if sig is None: |
|
1430 | if sig is None: | |
1421 | return [] |
|
1431 | return [] | |
1422 | # iterable[, key=func]' -> ['iterable[' ,' key=func]'] |
|
1432 | # iterable[, key=func]' -> ['iterable[' ,' key=func]'] | |
1423 | sig = sig.groups()[0].split(',') |
|
1433 | sig = sig.groups()[0].split(',') | |
1424 | ret = [] |
|
1434 | ret = [] | |
1425 | for s in sig: |
|
1435 | for s in sig: | |
1426 | #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') |
|
1436 | #re.compile(r'[\s|\[]*(\w+)(?:\s*=\s*.*)') | |
1427 | ret += self.docstring_kwd_re.findall(s) |
|
1437 | ret += self.docstring_kwd_re.findall(s) | |
1428 | return ret |
|
1438 | return ret | |
1429 |
|
1439 | |||
1430 | def _default_arguments(self, obj): |
|
1440 | def _default_arguments(self, obj): | |
1431 | """Return the list of default arguments of obj if it is callable, |
|
1441 | """Return the list of default arguments of obj if it is callable, | |
1432 | or empty list otherwise.""" |
|
1442 | or empty list otherwise.""" | |
1433 | call_obj = obj |
|
1443 | call_obj = obj | |
1434 | ret = [] |
|
1444 | ret = [] | |
1435 | if inspect.isbuiltin(obj): |
|
1445 | if inspect.isbuiltin(obj): | |
1436 | pass |
|
1446 | pass | |
1437 | elif not (inspect.isfunction(obj) or inspect.ismethod(obj)): |
|
1447 | elif not (inspect.isfunction(obj) or inspect.ismethod(obj)): | |
1438 | if inspect.isclass(obj): |
|
1448 | if inspect.isclass(obj): | |
1439 | #for cython embedsignature=True the constructor docstring |
|
1449 | #for cython embedsignature=True the constructor docstring | |
1440 | #belongs to the object itself not __init__ |
|
1450 | #belongs to the object itself not __init__ | |
1441 | ret += self._default_arguments_from_docstring( |
|
1451 | ret += self._default_arguments_from_docstring( | |
1442 | getattr(obj, '__doc__', '')) |
|
1452 | getattr(obj, '__doc__', '')) | |
1443 | # for classes, check for __init__,__new__ |
|
1453 | # for classes, check for __init__,__new__ | |
1444 | call_obj = (getattr(obj, '__init__', None) or |
|
1454 | call_obj = (getattr(obj, '__init__', None) or | |
1445 | getattr(obj, '__new__', None)) |
|
1455 | getattr(obj, '__new__', None)) | |
1446 | # for all others, check if they are __call__able |
|
1456 | # for all others, check if they are __call__able | |
1447 | elif hasattr(obj, '__call__'): |
|
1457 | elif hasattr(obj, '__call__'): | |
1448 | call_obj = obj.__call__ |
|
1458 | call_obj = obj.__call__ | |
1449 | ret += self._default_arguments_from_docstring( |
|
1459 | ret += self._default_arguments_from_docstring( | |
1450 | getattr(call_obj, '__doc__', '')) |
|
1460 | getattr(call_obj, '__doc__', '')) | |
1451 |
|
1461 | |||
1452 | _keeps = (inspect.Parameter.KEYWORD_ONLY, |
|
1462 | _keeps = (inspect.Parameter.KEYWORD_ONLY, | |
1453 | inspect.Parameter.POSITIONAL_OR_KEYWORD) |
|
1463 | inspect.Parameter.POSITIONAL_OR_KEYWORD) | |
1454 |
|
1464 | |||
1455 | try: |
|
1465 | try: | |
1456 | sig = inspect.signature(call_obj) |
|
1466 | sig = inspect.signature(call_obj) | |
1457 | ret.extend(k for k, v in sig.parameters.items() if |
|
1467 | ret.extend(k for k, v in sig.parameters.items() if | |
1458 | v.kind in _keeps) |
|
1468 | v.kind in _keeps) | |
1459 | except ValueError: |
|
1469 | except ValueError: | |
1460 | pass |
|
1470 | pass | |
1461 |
|
1471 | |||
1462 | return list(set(ret)) |
|
1472 | return list(set(ret)) | |
1463 |
|
1473 | |||
1464 | def python_func_kw_matches(self,text): |
|
1474 | def python_func_kw_matches(self,text): | |
1465 | """Match named parameters (kwargs) of the last open function""" |
|
1475 | """Match named parameters (kwargs) of the last open function""" | |
1466 |
|
1476 | |||
1467 | if "." in text: # a parameter cannot be dotted |
|
1477 | if "." in text: # a parameter cannot be dotted | |
1468 | return [] |
|
1478 | return [] | |
1469 | try: regexp = self.__funcParamsRegex |
|
1479 | try: regexp = self.__funcParamsRegex | |
1470 | except AttributeError: |
|
1480 | except AttributeError: | |
1471 | regexp = self.__funcParamsRegex = re.compile(r''' |
|
1481 | regexp = self.__funcParamsRegex = re.compile(r''' | |
1472 | '.*?(?<!\\)' | # single quoted strings or |
|
1482 | '.*?(?<!\\)' | # single quoted strings or | |
1473 | ".*?(?<!\\)" | # double quoted strings or |
|
1483 | ".*?(?<!\\)" | # double quoted strings or | |
1474 | \w+ | # identifier |
|
1484 | \w+ | # identifier | |
1475 | \S # other characters |
|
1485 | \S # other characters | |
1476 | ''', re.VERBOSE | re.DOTALL) |
|
1486 | ''', re.VERBOSE | re.DOTALL) | |
1477 | # 1. find the nearest identifier that comes before an unclosed |
|
1487 | # 1. find the nearest identifier that comes before an unclosed | |
1478 | # parenthesis before the cursor |
|
1488 | # parenthesis before the cursor | |
1479 | # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo" |
|
1489 | # e.g. for "foo (1+bar(x), pa<cursor>,a=1)", the candidate is "foo" | |
1480 | tokens = regexp.findall(self.text_until_cursor) |
|
1490 | tokens = regexp.findall(self.text_until_cursor) | |
1481 | iterTokens = reversed(tokens); openPar = 0 |
|
1491 | iterTokens = reversed(tokens); openPar = 0 | |
1482 |
|
1492 | |||
1483 | for token in iterTokens: |
|
1493 | for token in iterTokens: | |
1484 | if token == ')': |
|
1494 | if token == ')': | |
1485 | openPar -= 1 |
|
1495 | openPar -= 1 | |
1486 | elif token == '(': |
|
1496 | elif token == '(': | |
1487 | openPar += 1 |
|
1497 | openPar += 1 | |
1488 | if openPar > 0: |
|
1498 | if openPar > 0: | |
1489 | # found the last unclosed parenthesis |
|
1499 | # found the last unclosed parenthesis | |
1490 | break |
|
1500 | break | |
1491 | else: |
|
1501 | else: | |
1492 | return [] |
|
1502 | return [] | |
1493 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) |
|
1503 | # 2. Concatenate dotted names ("foo.bar" for "foo.bar(x, pa" ) | |
1494 | ids = [] |
|
1504 | ids = [] | |
1495 | isId = re.compile(r'\w+$').match |
|
1505 | isId = re.compile(r'\w+$').match | |
1496 |
|
1506 | |||
1497 | while True: |
|
1507 | while True: | |
1498 | try: |
|
1508 | try: | |
1499 | ids.append(next(iterTokens)) |
|
1509 | ids.append(next(iterTokens)) | |
1500 | if not isId(ids[-1]): |
|
1510 | if not isId(ids[-1]): | |
1501 | ids.pop(); break |
|
1511 | ids.pop(); break | |
1502 | if not next(iterTokens) == '.': |
|
1512 | if not next(iterTokens) == '.': | |
1503 | break |
|
1513 | break | |
1504 | except StopIteration: |
|
1514 | except StopIteration: | |
1505 | break |
|
1515 | break | |
1506 |
|
1516 | |||
1507 | # Find all named arguments already assigned to, as to avoid suggesting |
|
1517 | # Find all named arguments already assigned to, as to avoid suggesting | |
1508 | # them again |
|
1518 | # them again | |
1509 | usedNamedArgs = set() |
|
1519 | usedNamedArgs = set() | |
1510 | par_level = -1 |
|
1520 | par_level = -1 | |
1511 | for token, next_token in zip(tokens, tokens[1:]): |
|
1521 | for token, next_token in zip(tokens, tokens[1:]): | |
1512 | if token == '(': |
|
1522 | if token == '(': | |
1513 | par_level += 1 |
|
1523 | par_level += 1 | |
1514 | elif token == ')': |
|
1524 | elif token == ')': | |
1515 | par_level -= 1 |
|
1525 | par_level -= 1 | |
1516 |
|
1526 | |||
1517 | if par_level != 0: |
|
1527 | if par_level != 0: | |
1518 | continue |
|
1528 | continue | |
1519 |
|
1529 | |||
1520 | if next_token != '=': |
|
1530 | if next_token != '=': | |
1521 | continue |
|
1531 | continue | |
1522 |
|
1532 | |||
1523 | usedNamedArgs.add(token) |
|
1533 | usedNamedArgs.add(token) | |
1524 |
|
1534 | |||
1525 | # lookup the candidate callable matches either using global_matches |
|
1535 | # lookup the candidate callable matches either using global_matches | |
1526 | # or attr_matches for dotted names |
|
1536 | # or attr_matches for dotted names | |
1527 | if len(ids) == 1: |
|
1537 | if len(ids) == 1: | |
1528 | callableMatches = self.global_matches(ids[0]) |
|
1538 | callableMatches = self.global_matches(ids[0]) | |
1529 | else: |
|
1539 | else: | |
1530 | callableMatches = self.attr_matches('.'.join(ids[::-1])) |
|
1540 | callableMatches = self.attr_matches('.'.join(ids[::-1])) | |
1531 | argMatches = [] |
|
1541 | argMatches = [] | |
1532 | for callableMatch in callableMatches: |
|
1542 | for callableMatch in callableMatches: | |
1533 | try: |
|
1543 | try: | |
1534 | namedArgs = self._default_arguments(eval(callableMatch, |
|
1544 | namedArgs = self._default_arguments(eval(callableMatch, | |
1535 | self.namespace)) |
|
1545 | self.namespace)) | |
1536 | except: |
|
1546 | except: | |
1537 | continue |
|
1547 | continue | |
1538 |
|
1548 | |||
1539 | # Remove used named arguments from the list, no need to show twice |
|
1549 | # Remove used named arguments from the list, no need to show twice | |
1540 | for namedArg in set(namedArgs) - usedNamedArgs: |
|
1550 | for namedArg in set(namedArgs) - usedNamedArgs: | |
1541 | if namedArg.startswith(text): |
|
1551 | if namedArg.startswith(text): | |
1542 | argMatches.append(u"%s=" %namedArg) |
|
1552 | argMatches.append(u"%s=" %namedArg) | |
1543 | return argMatches |
|
1553 | return argMatches | |
1544 |
|
1554 | |||
1545 | def dict_key_matches(self, text): |
|
1555 | def dict_key_matches(self, text): | |
1546 | "Match string keys in a dictionary, after e.g. 'foo[' " |
|
1556 | "Match string keys in a dictionary, after e.g. 'foo[' " | |
1547 | def get_keys(obj): |
|
1557 | def get_keys(obj): | |
1548 | # Objects can define their own completions by defining an |
|
1558 | # Objects can define their own completions by defining an | |
1549 | # _ipy_key_completions_() method. |
|
1559 | # _ipy_key_completions_() method. | |
1550 | method = get_real_method(obj, '_ipython_key_completions_') |
|
1560 | method = get_real_method(obj, '_ipython_key_completions_') | |
1551 | if method is not None: |
|
1561 | if method is not None: | |
1552 | return method() |
|
1562 | return method() | |
1553 |
|
1563 | |||
1554 | # Special case some common in-memory dict-like types |
|
1564 | # Special case some common in-memory dict-like types | |
1555 | if isinstance(obj, dict) or\ |
|
1565 | if isinstance(obj, dict) or\ | |
1556 | _safe_isinstance(obj, 'pandas', 'DataFrame'): |
|
1566 | _safe_isinstance(obj, 'pandas', 'DataFrame'): | |
1557 | try: |
|
1567 | try: | |
1558 | return list(obj.keys()) |
|
1568 | return list(obj.keys()) | |
1559 | except Exception: |
|
1569 | except Exception: | |
1560 | return [] |
|
1570 | return [] | |
1561 | elif _safe_isinstance(obj, 'numpy', 'ndarray') or\ |
|
1571 | elif _safe_isinstance(obj, 'numpy', 'ndarray') or\ | |
1562 | _safe_isinstance(obj, 'numpy', 'void'): |
|
1572 | _safe_isinstance(obj, 'numpy', 'void'): | |
1563 | return obj.dtype.names or [] |
|
1573 | return obj.dtype.names or [] | |
1564 | return [] |
|
1574 | return [] | |
1565 |
|
1575 | |||
1566 | try: |
|
1576 | try: | |
1567 | regexps = self.__dict_key_regexps |
|
1577 | regexps = self.__dict_key_regexps | |
1568 | except AttributeError: |
|
1578 | except AttributeError: | |
1569 | dict_key_re_fmt = r'''(?x) |
|
1579 | dict_key_re_fmt = r'''(?x) | |
1570 | ( # match dict-referring expression wrt greedy setting |
|
1580 | ( # match dict-referring expression wrt greedy setting | |
1571 | %s |
|
1581 | %s | |
1572 | ) |
|
1582 | ) | |
1573 | \[ # open bracket |
|
1583 | \[ # open bracket | |
1574 | \s* # and optional whitespace |
|
1584 | \s* # and optional whitespace | |
1575 | ([uUbB]? # string prefix (r not handled) |
|
1585 | ([uUbB]? # string prefix (r not handled) | |
1576 | (?: # unclosed string |
|
1586 | (?: # unclosed string | |
1577 | '(?:[^']|(?<!\\)\\')* |
|
1587 | '(?:[^']|(?<!\\)\\')* | |
1578 | | |
|
1588 | | | |
1579 | "(?:[^"]|(?<!\\)\\")* |
|
1589 | "(?:[^"]|(?<!\\)\\")* | |
1580 | ) |
|
1590 | ) | |
1581 | )? |
|
1591 | )? | |
1582 | $ |
|
1592 | $ | |
1583 | ''' |
|
1593 | ''' | |
1584 | regexps = self.__dict_key_regexps = { |
|
1594 | regexps = self.__dict_key_regexps = { | |
1585 | False: re.compile(dict_key_re_fmt % ''' |
|
1595 | False: re.compile(dict_key_re_fmt % ''' | |
1586 | # identifiers separated by . |
|
1596 | # identifiers separated by . | |
1587 | (?!\d)\w+ |
|
1597 | (?!\d)\w+ | |
1588 | (?:\.(?!\d)\w+)* |
|
1598 | (?:\.(?!\d)\w+)* | |
1589 | '''), |
|
1599 | '''), | |
1590 | True: re.compile(dict_key_re_fmt % ''' |
|
1600 | True: re.compile(dict_key_re_fmt % ''' | |
1591 | .+ |
|
1601 | .+ | |
1592 | ''') |
|
1602 | ''') | |
1593 | } |
|
1603 | } | |
1594 |
|
1604 | |||
1595 | match = regexps[self.greedy].search(self.text_until_cursor) |
|
1605 | match = regexps[self.greedy].search(self.text_until_cursor) | |
1596 | if match is None: |
|
1606 | if match is None: | |
1597 | return [] |
|
1607 | return [] | |
1598 |
|
1608 | |||
1599 | expr, prefix = match.groups() |
|
1609 | expr, prefix = match.groups() | |
1600 | try: |
|
1610 | try: | |
1601 | obj = eval(expr, self.namespace) |
|
1611 | obj = eval(expr, self.namespace) | |
1602 | except Exception: |
|
1612 | except Exception: | |
1603 | try: |
|
1613 | try: | |
1604 | obj = eval(expr, self.global_namespace) |
|
1614 | obj = eval(expr, self.global_namespace) | |
1605 | except Exception: |
|
1615 | except Exception: | |
1606 | return [] |
|
1616 | return [] | |
1607 |
|
1617 | |||
1608 | keys = get_keys(obj) |
|
1618 | keys = get_keys(obj) | |
1609 | if not keys: |
|
1619 | if not keys: | |
1610 | return keys |
|
1620 | return keys | |
1611 | closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims) |
|
1621 | closing_quote, token_offset, matches = match_dict_keys(keys, prefix, self.splitter.delims) | |
1612 | if not matches: |
|
1622 | if not matches: | |
1613 | return matches |
|
1623 | return matches | |
1614 |
|
1624 | |||
1615 | # get the cursor position of |
|
1625 | # get the cursor position of | |
1616 | # - the text being completed |
|
1626 | # - the text being completed | |
1617 | # - the start of the key text |
|
1627 | # - the start of the key text | |
1618 | # - the start of the completion |
|
1628 | # - the start of the completion | |
1619 | text_start = len(self.text_until_cursor) - len(text) |
|
1629 | text_start = len(self.text_until_cursor) - len(text) | |
1620 | if prefix: |
|
1630 | if prefix: | |
1621 | key_start = match.start(2) |
|
1631 | key_start = match.start(2) | |
1622 | completion_start = key_start + token_offset |
|
1632 | completion_start = key_start + token_offset | |
1623 | else: |
|
1633 | else: | |
1624 | key_start = completion_start = match.end() |
|
1634 | key_start = completion_start = match.end() | |
1625 |
|
1635 | |||
1626 | # grab the leading prefix, to make sure all completions start with `text` |
|
1636 | # grab the leading prefix, to make sure all completions start with `text` | |
1627 | if text_start > key_start: |
|
1637 | if text_start > key_start: | |
1628 | leading = '' |
|
1638 | leading = '' | |
1629 | else: |
|
1639 | else: | |
1630 | leading = text[text_start:completion_start] |
|
1640 | leading = text[text_start:completion_start] | |
1631 |
|
1641 | |||
1632 | # the index of the `[` character |
|
1642 | # the index of the `[` character | |
1633 | bracket_idx = match.end(1) |
|
1643 | bracket_idx = match.end(1) | |
1634 |
|
1644 | |||
1635 | # append closing quote and bracket as appropriate |
|
1645 | # append closing quote and bracket as appropriate | |
1636 | # this is *not* appropriate if the opening quote or bracket is outside |
|
1646 | # this is *not* appropriate if the opening quote or bracket is outside | |
1637 | # the text given to this method |
|
1647 | # the text given to this method | |
1638 | suf = '' |
|
1648 | suf = '' | |
1639 | continuation = self.line_buffer[len(self.text_until_cursor):] |
|
1649 | continuation = self.line_buffer[len(self.text_until_cursor):] | |
1640 | if key_start > text_start and closing_quote: |
|
1650 | if key_start > text_start and closing_quote: | |
1641 | # quotes were opened inside text, maybe close them |
|
1651 | # quotes were opened inside text, maybe close them | |
1642 | if continuation.startswith(closing_quote): |
|
1652 | if continuation.startswith(closing_quote): | |
1643 | continuation = continuation[len(closing_quote):] |
|
1653 | continuation = continuation[len(closing_quote):] | |
1644 | else: |
|
1654 | else: | |
1645 | suf += closing_quote |
|
1655 | suf += closing_quote | |
1646 | if bracket_idx > text_start: |
|
1656 | if bracket_idx > text_start: | |
1647 | # brackets were opened inside text, maybe close them |
|
1657 | # brackets were opened inside text, maybe close them | |
1648 | if not continuation.startswith(']'): |
|
1658 | if not continuation.startswith(']'): | |
1649 | suf += ']' |
|
1659 | suf += ']' | |
1650 |
|
1660 | |||
1651 | return [leading + k + suf for k in matches] |
|
1661 | return [leading + k + suf for k in matches] | |
1652 |
|
1662 | |||
1653 | def unicode_name_matches(self, text): |
|
1663 | def unicode_name_matches(self, text): | |
1654 | u"""Match Latex-like syntax for unicode characters base |
|
1664 | u"""Match Latex-like syntax for unicode characters base | |
1655 | on the name of the character. |
|
1665 | on the name of the character. | |
1656 |
|
1666 | |||
1657 | This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·`` |
|
1667 | This does ``\\GREEK SMALL LETTER ETA`` -> ``Ξ·`` | |
1658 |
|
1668 | |||
1659 | Works only on valid python 3 identifier, or on combining characters that |
|
1669 | Works only on valid python 3 identifier, or on combining characters that | |
1660 | will combine to form a valid identifier. |
|
1670 | will combine to form a valid identifier. | |
1661 |
|
1671 | |||
1662 | Used on Python 3 only. |
|
1672 | Used on Python 3 only. | |
1663 | """ |
|
1673 | """ | |
1664 | slashpos = text.rfind('\\') |
|
1674 | slashpos = text.rfind('\\') | |
1665 | if slashpos > -1: |
|
1675 | if slashpos > -1: | |
1666 | s = text[slashpos+1:] |
|
1676 | s = text[slashpos+1:] | |
1667 | try : |
|
1677 | try : | |
1668 | unic = unicodedata.lookup(s) |
|
1678 | unic = unicodedata.lookup(s) | |
1669 | # allow combining chars |
|
1679 | # allow combining chars | |
1670 | if ('a'+unic).isidentifier(): |
|
1680 | if ('a'+unic).isidentifier(): | |
1671 | return '\\'+s,[unic] |
|
1681 | return '\\'+s,[unic] | |
1672 | except KeyError: |
|
1682 | except KeyError: | |
1673 | pass |
|
1683 | pass | |
1674 | return u'', [] |
|
1684 | return u'', [] | |
1675 |
|
1685 | |||
1676 |
|
1686 | |||
1677 | def latex_matches(self, text): |
|
1687 | def latex_matches(self, text): | |
1678 | u"""Match Latex syntax for unicode characters. |
|
1688 | u"""Match Latex syntax for unicode characters. | |
1679 |
|
1689 | |||
1680 | This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±`` |
|
1690 | This does both ``\\alp`` -> ``\\alpha`` and ``\\alpha`` -> ``Ξ±`` | |
1681 |
|
1691 | |||
1682 | Used on Python 3 only. |
|
1692 | Used on Python 3 only. | |
1683 | """ |
|
1693 | """ | |
1684 | slashpos = text.rfind('\\') |
|
1694 | slashpos = text.rfind('\\') | |
1685 | if slashpos > -1: |
|
1695 | if slashpos > -1: | |
1686 | s = text[slashpos:] |
|
1696 | s = text[slashpos:] | |
1687 | if s in latex_symbols: |
|
1697 | if s in latex_symbols: | |
1688 | # Try to complete a full latex symbol to unicode |
|
1698 | # Try to complete a full latex symbol to unicode | |
1689 | # \\alpha -> Ξ± |
|
1699 | # \\alpha -> Ξ± | |
1690 | return s, [latex_symbols[s]] |
|
1700 | return s, [latex_symbols[s]] | |
1691 | else: |
|
1701 | else: | |
1692 | # If a user has partially typed a latex symbol, give them |
|
1702 | # If a user has partially typed a latex symbol, give them | |
1693 | # a full list of options \al -> [\aleph, \alpha] |
|
1703 | # a full list of options \al -> [\aleph, \alpha] | |
1694 | matches = [k for k in latex_symbols if k.startswith(s)] |
|
1704 | matches = [k for k in latex_symbols if k.startswith(s)] | |
1695 | return s, matches |
|
1705 | return s, matches | |
1696 | return u'', [] |
|
1706 | return u'', [] | |
1697 |
|
1707 | |||
1698 | def dispatch_custom_completer(self, text): |
|
1708 | def dispatch_custom_completer(self, text): | |
1699 | if not self.custom_completers: |
|
1709 | if not self.custom_completers: | |
1700 | return |
|
1710 | return | |
1701 |
|
1711 | |||
1702 | line = self.line_buffer |
|
1712 | line = self.line_buffer | |
1703 | if not line.strip(): |
|
1713 | if not line.strip(): | |
1704 | return None |
|
1714 | return None | |
1705 |
|
1715 | |||
1706 | # Create a little structure to pass all the relevant information about |
|
1716 | # Create a little structure to pass all the relevant information about | |
1707 | # the current completion to any custom completer. |
|
1717 | # the current completion to any custom completer. | |
1708 | event = SimpleNamespace() |
|
1718 | event = SimpleNamespace() | |
1709 | event.line = line |
|
1719 | event.line = line | |
1710 | event.symbol = text |
|
1720 | event.symbol = text | |
1711 | cmd = line.split(None,1)[0] |
|
1721 | cmd = line.split(None,1)[0] | |
1712 | event.command = cmd |
|
1722 | event.command = cmd | |
1713 | event.text_until_cursor = self.text_until_cursor |
|
1723 | event.text_until_cursor = self.text_until_cursor | |
1714 |
|
1724 | |||
1715 | # for foo etc, try also to find completer for %foo |
|
1725 | # for foo etc, try also to find completer for %foo | |
1716 | if not cmd.startswith(self.magic_escape): |
|
1726 | if not cmd.startswith(self.magic_escape): | |
1717 | try_magic = self.custom_completers.s_matches( |
|
1727 | try_magic = self.custom_completers.s_matches( | |
1718 | self.magic_escape + cmd) |
|
1728 | self.magic_escape + cmd) | |
1719 | else: |
|
1729 | else: | |
1720 | try_magic = [] |
|
1730 | try_magic = [] | |
1721 |
|
1731 | |||
1722 | for c in itertools.chain(self.custom_completers.s_matches(cmd), |
|
1732 | for c in itertools.chain(self.custom_completers.s_matches(cmd), | |
1723 | try_magic, |
|
1733 | try_magic, | |
1724 | self.custom_completers.flat_matches(self.text_until_cursor)): |
|
1734 | self.custom_completers.flat_matches(self.text_until_cursor)): | |
1725 | try: |
|
1735 | try: | |
1726 | res = c(event) |
|
1736 | res = c(event) | |
1727 | if res: |
|
1737 | if res: | |
1728 | # first, try case sensitive match |
|
1738 | # first, try case sensitive match | |
1729 | withcase = [r for r in res if r.startswith(text)] |
|
1739 | withcase = [r for r in res if r.startswith(text)] | |
1730 | if withcase: |
|
1740 | if withcase: | |
1731 | return withcase |
|
1741 | return withcase | |
1732 | # if none, then case insensitive ones are ok too |
|
1742 | # if none, then case insensitive ones are ok too | |
1733 | text_low = text.lower() |
|
1743 | text_low = text.lower() | |
1734 | return [r for r in res if r.lower().startswith(text_low)] |
|
1744 | return [r for r in res if r.lower().startswith(text_low)] | |
1735 | except TryNext: |
|
1745 | except TryNext: | |
1736 | pass |
|
1746 | pass | |
1737 | except KeyboardInterrupt: |
|
1747 | except KeyboardInterrupt: | |
1738 | """ |
|
1748 | """ | |
1739 | If custom completer take too long, |
|
1749 | If custom completer take too long, | |
1740 | let keyboard interrupt abort and return nothing. |
|
1750 | let keyboard interrupt abort and return nothing. | |
1741 | """ |
|
1751 | """ | |
1742 | break |
|
1752 | break | |
1743 |
|
1753 | |||
1744 | return None |
|
1754 | return None | |
1745 |
|
1755 | |||
1746 | def completions(self, text: str, offset: int)->Iterator[Completion]: |
|
1756 | def completions(self, text: str, offset: int)->Iterator[Completion]: | |
1747 | """ |
|
1757 | """ | |
1748 | Returns an iterator over the possible completions |
|
1758 | Returns an iterator over the possible completions | |
1749 |
|
1759 | |||
1750 | .. warning:: Unstable |
|
1760 | .. warning:: Unstable | |
1751 |
|
1761 | |||
1752 | This function is unstable, API may change without warning. |
|
1762 | This function is unstable, API may change without warning. | |
1753 | It will also raise unless use in proper context manager. |
|
1763 | It will also raise unless use in proper context manager. | |
1754 |
|
1764 | |||
1755 | Parameters |
|
1765 | Parameters | |
1756 | ---------- |
|
1766 | ---------- | |
1757 |
|
1767 | |||
1758 | text:str |
|
1768 | text:str | |
1759 | Full text of the current input, multi line string. |
|
1769 | Full text of the current input, multi line string. | |
1760 | offset:int |
|
1770 | offset:int | |
1761 | Integer representing the position of the cursor in ``text``. Offset |
|
1771 | Integer representing the position of the cursor in ``text``. Offset | |
1762 | is 0-based indexed. |
|
1772 | is 0-based indexed. | |
1763 |
|
1773 | |||
1764 | Yields |
|
1774 | Yields | |
1765 | ------ |
|
1775 | ------ | |
1766 | :any:`Completion` object |
|
1776 | :any:`Completion` object | |
1767 |
|
1777 | |||
1768 |
|
1778 | |||
1769 | The cursor on a text can either be seen as being "in between" |
|
1779 | The cursor on a text can either be seen as being "in between" | |
1770 | characters or "On" a character depending on the interface visible to |
|
1780 | characters or "On" a character depending on the interface visible to | |
1771 | the user. For consistency the cursor being on "in between" characters X |
|
1781 | the user. For consistency the cursor being on "in between" characters X | |
1772 | and Y is equivalent to the cursor being "on" character Y, that is to say |
|
1782 | and Y is equivalent to the cursor being "on" character Y, that is to say | |
1773 | the character the cursor is on is considered as being after the cursor. |
|
1783 | the character the cursor is on is considered as being after the cursor. | |
1774 |
|
1784 | |||
1775 | Combining characters may span more that one position in the |
|
1785 | Combining characters may span more that one position in the | |
1776 | text. |
|
1786 | text. | |
1777 |
|
1787 | |||
1778 |
|
1788 | |||
1779 | .. note:: |
|
1789 | .. note:: | |
1780 |
|
1790 | |||
1781 | If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--`` |
|
1791 | If ``IPCompleter.debug`` is :any:`True` will yield a ``--jedi/ipython--`` | |
1782 | fake Completion token to distinguish completion returned by Jedi |
|
1792 | fake Completion token to distinguish completion returned by Jedi | |
1783 | and usual IPython completion. |
|
1793 | and usual IPython completion. | |
1784 |
|
1794 | |||
1785 | .. note:: |
|
1795 | .. note:: | |
1786 |
|
1796 | |||
1787 | Completions are not completely deduplicated yet. If identical |
|
1797 | Completions are not completely deduplicated yet. If identical | |
1788 | completions are coming from different sources this function does not |
|
1798 | completions are coming from different sources this function does not | |
1789 | ensure that each completion object will only be present once. |
|
1799 | ensure that each completion object will only be present once. | |
1790 | """ |
|
1800 | """ | |
1791 | warnings.warn("_complete is a provisional API (as of IPython 6.0). " |
|
1801 | warnings.warn("_complete is a provisional API (as of IPython 6.0). " | |
1792 | "It may change without warnings. " |
|
1802 | "It may change without warnings. " | |
1793 | "Use in corresponding context manager.", |
|
1803 | "Use in corresponding context manager.", | |
1794 | category=ProvisionalCompleterWarning, stacklevel=2) |
|
1804 | category=ProvisionalCompleterWarning, stacklevel=2) | |
1795 |
|
1805 | |||
1796 | seen = set() |
|
1806 | seen = set() | |
1797 | for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000): |
|
1807 | for c in self._completions(text, offset, _timeout=self.jedi_compute_type_timeout/1000): | |
1798 | if c and (c in seen): |
|
1808 | if c and (c in seen): | |
1799 | continue |
|
1809 | continue | |
1800 | yield c |
|
1810 | yield c | |
1801 | seen.add(c) |
|
1811 | seen.add(c) | |
1802 |
|
1812 | |||
1803 | def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]: |
|
1813 | def _completions(self, full_text: str, offset: int, *, _timeout)->Iterator[Completion]: | |
1804 | """ |
|
1814 | """ | |
1805 | Core completion module.Same signature as :any:`completions`, with the |
|
1815 | Core completion module.Same signature as :any:`completions`, with the | |
1806 | extra `timeout` parameter (in seconds). |
|
1816 | extra `timeout` parameter (in seconds). | |
1807 |
|
1817 | |||
1808 |
|
1818 | |||
1809 | Computing jedi's completion ``.type`` can be quite expensive (it is a |
|
1819 | Computing jedi's completion ``.type`` can be quite expensive (it is a | |
1810 | lazy property) and can require some warm-up, more warm up than just |
|
1820 | lazy property) and can require some warm-up, more warm up than just | |
1811 | computing the ``name`` of a completion. The warm-up can be : |
|
1821 | computing the ``name`` of a completion. The warm-up can be : | |
1812 |
|
1822 | |||
1813 | - Long warm-up the first time a module is encountered after |
|
1823 | - Long warm-up the first time a module is encountered after | |
1814 | install/update: actually build parse/inference tree. |
|
1824 | install/update: actually build parse/inference tree. | |
1815 |
|
1825 | |||
1816 | - first time the module is encountered in a session: load tree from |
|
1826 | - first time the module is encountered in a session: load tree from | |
1817 | disk. |
|
1827 | disk. | |
1818 |
|
1828 | |||
1819 | We don't want to block completions for tens of seconds so we give the |
|
1829 | We don't want to block completions for tens of seconds so we give the | |
1820 | completer a "budget" of ``_timeout`` seconds per invocation to compute |
|
1830 | completer a "budget" of ``_timeout`` seconds per invocation to compute | |
1821 | completions types, the completions that have not yet been computed will |
|
1831 | completions types, the completions that have not yet been computed will | |
1822 | be marked as "unknown" an will have a chance to be computed next round |
|
1832 | be marked as "unknown" an will have a chance to be computed next round | |
1823 | are things get cached. |
|
1833 | are things get cached. | |
1824 |
|
1834 | |||
1825 | Keep in mind that Jedi is not the only thing treating the completion so |
|
1835 | Keep in mind that Jedi is not the only thing treating the completion so | |
1826 | keep the timeout short-ish as if we take more than 0.3 second we still |
|
1836 | keep the timeout short-ish as if we take more than 0.3 second we still | |
1827 | have lots of processing to do. |
|
1837 | have lots of processing to do. | |
1828 |
|
1838 | |||
1829 | """ |
|
1839 | """ | |
1830 | deadline = time.monotonic() + _timeout |
|
1840 | deadline = time.monotonic() + _timeout | |
1831 |
|
1841 | |||
1832 |
|
1842 | |||
1833 | before = full_text[:offset] |
|
1843 | before = full_text[:offset] | |
1834 | cursor_line, cursor_column = position_to_cursor(full_text, offset) |
|
1844 | cursor_line, cursor_column = position_to_cursor(full_text, offset) | |
1835 |
|
1845 | |||
1836 | matched_text, matches, matches_origin, jedi_matches = self._complete( |
|
1846 | matched_text, matches, matches_origin, jedi_matches = self._complete( | |
1837 | full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column) |
|
1847 | full_text=full_text, cursor_line=cursor_line, cursor_pos=cursor_column) | |
1838 |
|
1848 | |||
1839 | iter_jm = iter(jedi_matches) |
|
1849 | iter_jm = iter(jedi_matches) | |
1840 | if _timeout: |
|
1850 | if _timeout: | |
1841 | for jm in iter_jm: |
|
1851 | for jm in iter_jm: | |
1842 | try: |
|
1852 | try: | |
1843 | type_ = jm.type |
|
1853 | type_ = jm.type | |
1844 | except Exception: |
|
1854 | except Exception: | |
1845 | if self.debug: |
|
1855 | if self.debug: | |
1846 | print("Error in Jedi getting type of ", jm) |
|
1856 | print("Error in Jedi getting type of ", jm) | |
1847 | type_ = None |
|
1857 | type_ = None | |
1848 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1858 | delta = len(jm.name_with_symbols) - len(jm.complete) | |
1849 | if type_ == 'function': |
|
1859 | if type_ == 'function': | |
1850 | signature = _make_signature(jm) |
|
1860 | signature = _make_signature(jm) | |
1851 | else: |
|
1861 | else: | |
1852 | signature = '' |
|
1862 | signature = '' | |
1853 | yield Completion(start=offset - delta, |
|
1863 | yield Completion(start=offset - delta, | |
1854 | end=offset, |
|
1864 | end=offset, | |
1855 | text=jm.name_with_symbols, |
|
1865 | text=jm.name_with_symbols, | |
1856 | type=type_, |
|
1866 | type=type_, | |
1857 | signature=signature, |
|
1867 | signature=signature, | |
1858 | _origin='jedi') |
|
1868 | _origin='jedi') | |
1859 |
|
1869 | |||
1860 | if time.monotonic() > deadline: |
|
1870 | if time.monotonic() > deadline: | |
1861 | break |
|
1871 | break | |
1862 |
|
1872 | |||
1863 | for jm in iter_jm: |
|
1873 | for jm in iter_jm: | |
1864 | delta = len(jm.name_with_symbols) - len(jm.complete) |
|
1874 | delta = len(jm.name_with_symbols) - len(jm.complete) | |
1865 | yield Completion(start=offset - delta, |
|
1875 | yield Completion(start=offset - delta, | |
1866 | end=offset, |
|
1876 | end=offset, | |
1867 | text=jm.name_with_symbols, |
|
1877 | text=jm.name_with_symbols, | |
1868 | type='<unknown>', # don't compute type for speed |
|
1878 | type='<unknown>', # don't compute type for speed | |
1869 | _origin='jedi', |
|
1879 | _origin='jedi', | |
1870 | signature='') |
|
1880 | signature='') | |
1871 |
|
1881 | |||
1872 |
|
1882 | |||
1873 | start_offset = before.rfind(matched_text) |
|
1883 | start_offset = before.rfind(matched_text) | |
1874 |
|
1884 | |||
1875 | # TODO: |
|
1885 | # TODO: | |
1876 | # Suppress this, right now just for debug. |
|
1886 | # Suppress this, right now just for debug. | |
1877 | if jedi_matches and matches and self.debug: |
|
1887 | if jedi_matches and matches and self.debug: | |
1878 | yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', |
|
1888 | yield Completion(start=start_offset, end=offset, text='--jedi/ipython--', | |
1879 | _origin='debug', type='none', signature='') |
|
1889 | _origin='debug', type='none', signature='') | |
1880 |
|
1890 | |||
1881 | # I'm unsure if this is always true, so let's assert and see if it |
|
1891 | # I'm unsure if this is always true, so let's assert and see if it | |
1882 | # crash |
|
1892 | # crash | |
1883 | assert before.endswith(matched_text) |
|
1893 | assert before.endswith(matched_text) | |
1884 | for m, t in zip(matches, matches_origin): |
|
1894 | for m, t in zip(matches, matches_origin): | |
1885 | yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>') |
|
1895 | yield Completion(start=start_offset, end=offset, text=m, _origin=t, signature='', type='<unknown>') | |
1886 |
|
1896 | |||
1887 |
|
1897 | |||
1888 | def complete(self, text=None, line_buffer=None, cursor_pos=None): |
|
1898 | def complete(self, text=None, line_buffer=None, cursor_pos=None): | |
1889 | """Find completions for the given text and line context. |
|
1899 | """Find completions for the given text and line context. | |
1890 |
|
1900 | |||
1891 | Note that both the text and the line_buffer are optional, but at least |
|
1901 | Note that both the text and the line_buffer are optional, but at least | |
1892 | one of them must be given. |
|
1902 | one of them must be given. | |
1893 |
|
1903 | |||
1894 | Parameters |
|
1904 | Parameters | |
1895 | ---------- |
|
1905 | ---------- | |
1896 | text : string, optional |
|
1906 | text : string, optional | |
1897 | Text to perform the completion on. If not given, the line buffer |
|
1907 | Text to perform the completion on. If not given, the line buffer | |
1898 | is split using the instance's CompletionSplitter object. |
|
1908 | is split using the instance's CompletionSplitter object. | |
1899 |
|
1909 | |||
1900 | line_buffer : string, optional |
|
1910 | line_buffer : string, optional | |
1901 | If not given, the completer attempts to obtain the current line |
|
1911 | If not given, the completer attempts to obtain the current line | |
1902 | buffer via readline. This keyword allows clients which are |
|
1912 | buffer via readline. This keyword allows clients which are | |
1903 | requesting for text completions in non-readline contexts to inform |
|
1913 | requesting for text completions in non-readline contexts to inform | |
1904 | the completer of the entire text. |
|
1914 | the completer of the entire text. | |
1905 |
|
1915 | |||
1906 | cursor_pos : int, optional |
|
1916 | cursor_pos : int, optional | |
1907 | Index of the cursor in the full line buffer. Should be provided by |
|
1917 | Index of the cursor in the full line buffer. Should be provided by | |
1908 | remote frontends where kernel has no access to frontend state. |
|
1918 | remote frontends where kernel has no access to frontend state. | |
1909 |
|
1919 | |||
1910 | Returns |
|
1920 | Returns | |
1911 | ------- |
|
1921 | ------- | |
1912 | text : str |
|
1922 | text : str | |
1913 | Text that was actually used in the completion. |
|
1923 | Text that was actually used in the completion. | |
1914 |
|
1924 | |||
1915 | matches : list |
|
1925 | matches : list | |
1916 | A list of completion matches. |
|
1926 | A list of completion matches. | |
1917 |
|
1927 | |||
1918 |
|
1928 | |||
1919 | .. note:: |
|
1929 | .. note:: | |
1920 |
|
1930 | |||
1921 | This API is likely to be deprecated and replaced by |
|
1931 | This API is likely to be deprecated and replaced by | |
1922 | :any:`IPCompleter.completions` in the future. |
|
1932 | :any:`IPCompleter.completions` in the future. | |
1923 |
|
1933 | |||
1924 |
|
1934 | |||
1925 | """ |
|
1935 | """ | |
1926 | warnings.warn('`Completer.complete` is pending deprecation since ' |
|
1936 | warnings.warn('`Completer.complete` is pending deprecation since ' | |
1927 | 'IPython 6.0 and will be replaced by `Completer.completions`.', |
|
1937 | 'IPython 6.0 and will be replaced by `Completer.completions`.', | |
1928 | PendingDeprecationWarning) |
|
1938 | PendingDeprecationWarning) | |
1929 | # potential todo, FOLD the 3rd throw away argument of _complete |
|
1939 | # potential todo, FOLD the 3rd throw away argument of _complete | |
1930 | # into the first 2 one. |
|
1940 | # into the first 2 one. | |
1931 | return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2] |
|
1941 | return self._complete(line_buffer=line_buffer, cursor_pos=cursor_pos, text=text, cursor_line=0)[:2] | |
1932 |
|
1942 | |||
1933 | def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None, |
|
1943 | def _complete(self, *, cursor_line, cursor_pos, line_buffer=None, text=None, | |
1934 |
full_text=None |
|
1944 | full_text=None) -> Tuple[str, List[str], List[str], Iterable[_FakeJediCompletion]]: | |
1935 | """ |
|
1945 | """ | |
1936 |
|
1946 | |||
1937 | Like complete but can also returns raw jedi completions as well as the |
|
1947 | Like complete but can also returns raw jedi completions as well as the | |
1938 | origin of the completion text. This could (and should) be made much |
|
1948 | origin of the completion text. This could (and should) be made much | |
1939 | cleaner but that will be simpler once we drop the old (and stateful) |
|
1949 | cleaner but that will be simpler once we drop the old (and stateful) | |
1940 | :any:`complete` API. |
|
1950 | :any:`complete` API. | |
1941 |
|
1951 | |||
1942 |
|
1952 | |||
1943 | With current provisional API, cursor_pos act both (depending on the |
|
1953 | With current provisional API, cursor_pos act both (depending on the | |
1944 | caller) as the offset in the ``text`` or ``line_buffer``, or as the |
|
1954 | caller) as the offset in the ``text`` or ``line_buffer``, or as the | |
1945 | ``column`` when passing multiline strings this could/should be renamed |
|
1955 | ``column`` when passing multiline strings this could/should be renamed | |
1946 | but would add extra noise. |
|
1956 | but would add extra noise. | |
1947 | """ |
|
1957 | """ | |
1948 |
|
1958 | |||
1949 | # if the cursor position isn't given, the only sane assumption we can |
|
1959 | # if the cursor position isn't given, the only sane assumption we can | |
1950 | # make is that it's at the end of the line (the common case) |
|
1960 | # make is that it's at the end of the line (the common case) | |
1951 | if cursor_pos is None: |
|
1961 | if cursor_pos is None: | |
1952 | cursor_pos = len(line_buffer) if text is None else len(text) |
|
1962 | cursor_pos = len(line_buffer) if text is None else len(text) | |
1953 |
|
1963 | |||
1954 | if self.use_main_ns: |
|
1964 | if self.use_main_ns: | |
1955 | self.namespace = __main__.__dict__ |
|
1965 | self.namespace = __main__.__dict__ | |
1956 |
|
1966 | |||
1957 | # if text is either None or an empty string, rely on the line buffer |
|
1967 | # if text is either None or an empty string, rely on the line buffer | |
1958 | if (not line_buffer) and full_text: |
|
1968 | if (not line_buffer) and full_text: | |
1959 | line_buffer = full_text.split('\n')[cursor_line] |
|
1969 | line_buffer = full_text.split('\n')[cursor_line] | |
1960 | if not text: |
|
1970 | if not text: | |
1961 | text = self.splitter.split_line(line_buffer, cursor_pos) |
|
1971 | text = self.splitter.split_line(line_buffer, cursor_pos) | |
1962 |
|
1972 | |||
1963 | if self.backslash_combining_completions: |
|
1973 | if self.backslash_combining_completions: | |
1964 | # allow deactivation of these on windows. |
|
1974 | # allow deactivation of these on windows. | |
1965 | base_text = text if not line_buffer else line_buffer[:cursor_pos] |
|
1975 | base_text = text if not line_buffer else line_buffer[:cursor_pos] | |
1966 | latex_text, latex_matches = self.latex_matches(base_text) |
|
1976 | latex_text, latex_matches = self.latex_matches(base_text) | |
1967 | if latex_matches: |
|
1977 | if latex_matches: | |
1968 | return latex_text, latex_matches, ['latex_matches']*len(latex_matches), () |
|
1978 | return latex_text, latex_matches, ['latex_matches']*len(latex_matches), () | |
1969 | name_text = '' |
|
1979 | name_text = '' | |
1970 | name_matches = [] |
|
1980 | name_matches = [] | |
1971 | for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches): |
|
1981 | for meth in (self.unicode_name_matches, back_latex_name_matches, back_unicode_name_matches): | |
1972 | name_text, name_matches = meth(base_text) |
|
1982 | name_text, name_matches = meth(base_text) | |
1973 | if name_text: |
|
1983 | if name_text: | |
1974 | return name_text, name_matches[:MATCHES_LIMIT], \ |
|
1984 | return name_text, name_matches[:MATCHES_LIMIT], \ | |
1975 | [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), () |
|
1985 | [meth.__qualname__]*min(len(name_matches), MATCHES_LIMIT), () | |
1976 |
|
1986 | |||
1977 |
|
1987 | |||
1978 | # If no line buffer is given, assume the input text is all there was |
|
1988 | # If no line buffer is given, assume the input text is all there was | |
1979 | if line_buffer is None: |
|
1989 | if line_buffer is None: | |
1980 | line_buffer = text |
|
1990 | line_buffer = text | |
1981 |
|
1991 | |||
1982 | self.line_buffer = line_buffer |
|
1992 | self.line_buffer = line_buffer | |
1983 | self.text_until_cursor = self.line_buffer[:cursor_pos] |
|
1993 | self.text_until_cursor = self.line_buffer[:cursor_pos] | |
1984 |
|
1994 | |||
1985 | # Do magic arg matches |
|
1995 | # Do magic arg matches | |
1986 | for matcher in self.magic_arg_matchers: |
|
1996 | for matcher in self.magic_arg_matchers: | |
1987 | matches = list(matcher(line_buffer))[:MATCHES_LIMIT] |
|
1997 | matches = list(matcher(line_buffer))[:MATCHES_LIMIT] | |
1988 | if matches: |
|
1998 | if matches: | |
1989 | origins = [matcher.__qualname__] * len(matches) |
|
1999 | origins = [matcher.__qualname__] * len(matches) | |
1990 | return text, matches, origins, () |
|
2000 | return text, matches, origins, () | |
1991 |
|
2001 | |||
1992 | # Start with a clean slate of completions |
|
2002 | # Start with a clean slate of completions | |
1993 | matches = [] |
|
2003 | matches = [] | |
1994 | custom_res = self.dispatch_custom_completer(text) |
|
2004 | custom_res = self.dispatch_custom_completer(text) | |
1995 | # FIXME: we should extend our api to return a dict with completions for |
|
2005 | # FIXME: we should extend our api to return a dict with completions for | |
1996 | # different types of objects. The rlcomplete() method could then |
|
2006 | # different types of objects. The rlcomplete() method could then | |
1997 | # simply collapse the dict into a list for readline, but we'd have |
|
2007 | # simply collapse the dict into a list for readline, but we'd have | |
1998 | # richer completion semantics in other evironments. |
|
2008 | # richer completion semantics in other evironments. | |
1999 | completions = () |
|
2009 | completions = () | |
2000 |
if self.use_jedi |
|
2010 | if self.use_jedi: | |
2001 | if not full_text: |
|
2011 | if not full_text: | |
2002 | full_text = line_buffer |
|
2012 | full_text = line_buffer | |
2003 | completions = self._jedi_matches( |
|
2013 | completions = self._jedi_matches( | |
2004 | cursor_pos, cursor_line, full_text) |
|
2014 | cursor_pos, cursor_line, full_text) | |
2005 | if custom_res is not None: |
|
2015 | if custom_res is not None: | |
2006 | # did custom completers produce something? |
|
2016 | # did custom completers produce something? | |
2007 | matches = [(m, 'custom') for m in custom_res] |
|
2017 | matches = [(m, 'custom') for m in custom_res] | |
2008 | else: |
|
2018 | else: | |
2009 | # Extend the list of completions with the results of each |
|
2019 | # Extend the list of completions with the results of each | |
2010 | # matcher, so we return results to the user from all |
|
2020 | # matcher, so we return results to the user from all | |
2011 | # namespaces. |
|
2021 | # namespaces. | |
2012 | if self.merge_completions: |
|
2022 | if self.merge_completions: | |
2013 | matches = [] |
|
2023 | matches = [] | |
2014 | for matcher in self.matchers: |
|
2024 | for matcher in self.matchers: | |
2015 | try: |
|
2025 | try: | |
2016 | matches.extend([(m, matcher.__qualname__) |
|
2026 | matches.extend([(m, matcher.__qualname__) | |
2017 | for m in matcher(text)]) |
|
2027 | for m in matcher(text)]) | |
2018 | except: |
|
2028 | except: | |
2019 | # Show the ugly traceback if the matcher causes an |
|
2029 | # Show the ugly traceback if the matcher causes an | |
2020 | # exception, but do NOT crash the kernel! |
|
2030 | # exception, but do NOT crash the kernel! | |
2021 | sys.excepthook(*sys.exc_info()) |
|
2031 | sys.excepthook(*sys.exc_info()) | |
2022 | else: |
|
2032 | else: | |
2023 | for matcher in self.matchers: |
|
2033 | for matcher in self.matchers: | |
2024 | matches = [(m, matcher.__qualname__) |
|
2034 | matches = [(m, matcher.__qualname__) | |
2025 | for m in matcher(text)] |
|
2035 | for m in matcher(text)] | |
2026 | if matches: |
|
2036 | if matches: | |
2027 | break |
|
2037 | break | |
2028 | seen = set() |
|
2038 | seen = set() | |
2029 | filtered_matches = set() |
|
2039 | filtered_matches = set() | |
2030 | for m in matches: |
|
2040 | for m in matches: | |
2031 | t, c = m |
|
2041 | t, c = m | |
2032 | if t not in seen: |
|
2042 | if t not in seen: | |
2033 | filtered_matches.add(m) |
|
2043 | filtered_matches.add(m) | |
2034 | seen.add(t) |
|
2044 | seen.add(t) | |
2035 |
|
2045 | |||
2036 | _filtered_matches = sorted( |
|
2046 | _filtered_matches = sorted( | |
2037 | set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))\ |
|
2047 | set(filtered_matches), key=lambda x: completions_sorting_key(x[0]))\ | |
2038 | [:MATCHES_LIMIT] |
|
2048 | [:MATCHES_LIMIT] | |
2039 |
|
2049 | |||
2040 | _matches = [m[0] for m in _filtered_matches] |
|
2050 | _matches = [m[0] for m in _filtered_matches] | |
2041 | origins = [m[1] for m in _filtered_matches] |
|
2051 | origins = [m[1] for m in _filtered_matches] | |
2042 |
|
2052 | |||
2043 | self.matches = _matches |
|
2053 | self.matches = _matches | |
2044 |
|
2054 | |||
2045 | return text, _matches, origins, completions |
|
2055 | return text, _matches, origins, completions |
@@ -1,3329 +1,3330 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | # -*- coding: utf-8 -*- | |
2 | """Main IPython class.""" |
|
2 | """Main IPython class.""" | |
3 |
|
3 | |||
4 | #----------------------------------------------------------------------------- |
|
4 | #----------------------------------------------------------------------------- | |
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> | |
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> | |
7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
7 | # Copyright (C) 2008-2011 The IPython Development Team | |
8 | # |
|
8 | # | |
9 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | # Distributed under the terms of the BSD License. The full license is in | |
10 | # the file COPYING, distributed as part of this software. |
|
10 | # the file COPYING, distributed as part of this software. | |
11 | #----------------------------------------------------------------------------- |
|
11 | #----------------------------------------------------------------------------- | |
12 |
|
12 | |||
13 |
|
13 | |||
14 | import abc |
|
14 | import abc | |
15 | import ast |
|
15 | import ast | |
16 | import atexit |
|
16 | import atexit | |
17 | import builtins as builtin_mod |
|
17 | import builtins as builtin_mod | |
18 | import functools |
|
18 | import functools | |
19 | import os |
|
19 | import os | |
20 | import re |
|
20 | import re | |
21 | import runpy |
|
21 | import runpy | |
22 | import sys |
|
22 | import sys | |
23 | import tempfile |
|
23 | import tempfile | |
24 | import traceback |
|
24 | import traceback | |
25 | import types |
|
25 | import types | |
26 | import subprocess |
|
26 | import subprocess | |
27 | import warnings |
|
27 | import warnings | |
28 | from io import open as io_open |
|
28 | from io import open as io_open | |
29 |
|
29 | |||
30 | from pickleshare import PickleShareDB |
|
30 | from pickleshare import PickleShareDB | |
31 |
|
31 | |||
32 | from traitlets.config.configurable import SingletonConfigurable |
|
32 | from traitlets.config.configurable import SingletonConfigurable | |
33 | from IPython.core import oinspect |
|
33 | from IPython.core import oinspect | |
34 | from IPython.core import magic |
|
34 | from IPython.core import magic | |
35 | from IPython.core import page |
|
35 | from IPython.core import page | |
36 | from IPython.core import prefilter |
|
36 | from IPython.core import prefilter | |
37 | from IPython.core import ultratb |
|
37 | from IPython.core import ultratb | |
38 | from IPython.core.alias import Alias, AliasManager |
|
38 | from IPython.core.alias import Alias, AliasManager | |
39 | from IPython.core.autocall import ExitAutocall |
|
39 | from IPython.core.autocall import ExitAutocall | |
40 | from IPython.core.builtin_trap import BuiltinTrap |
|
40 | from IPython.core.builtin_trap import BuiltinTrap | |
41 | from IPython.core.events import EventManager, available_events |
|
41 | from IPython.core.events import EventManager, available_events | |
42 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
42 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython | |
43 | from IPython.core.debugger import Pdb |
|
43 | from IPython.core.debugger import Pdb | |
44 | from IPython.core.display_trap import DisplayTrap |
|
44 | from IPython.core.display_trap import DisplayTrap | |
45 | from IPython.core.displayhook import DisplayHook |
|
45 | from IPython.core.displayhook import DisplayHook | |
46 | from IPython.core.displaypub import DisplayPublisher |
|
46 | from IPython.core.displaypub import DisplayPublisher | |
47 | from IPython.core.error import InputRejected, UsageError |
|
47 | from IPython.core.error import InputRejected, UsageError | |
48 | from IPython.core.extensions import ExtensionManager |
|
48 | from IPython.core.extensions import ExtensionManager | |
49 | from IPython.core.formatters import DisplayFormatter |
|
49 | from IPython.core.formatters import DisplayFormatter | |
50 | from IPython.core.history import HistoryManager |
|
50 | from IPython.core.history import HistoryManager | |
51 | from IPython.core.inputsplitter import ESC_MAGIC, ESC_MAGIC2 |
|
51 | from IPython.core.inputsplitter import ESC_MAGIC, ESC_MAGIC2 | |
52 | from IPython.core.logger import Logger |
|
52 | from IPython.core.logger import Logger | |
53 | from IPython.core.macro import Macro |
|
53 | from IPython.core.macro import Macro | |
54 | from IPython.core.payload import PayloadManager |
|
54 | from IPython.core.payload import PayloadManager | |
55 | from IPython.core.prefilter import PrefilterManager |
|
55 | from IPython.core.prefilter import PrefilterManager | |
56 | from IPython.core.profiledir import ProfileDir |
|
56 | from IPython.core.profiledir import ProfileDir | |
57 | from IPython.core.usage import default_banner |
|
57 | from IPython.core.usage import default_banner | |
58 | from IPython.display import display |
|
58 | from IPython.display import display | |
59 | from IPython.testing.skipdoctest import skip_doctest |
|
59 | from IPython.testing.skipdoctest import skip_doctest | |
60 | from IPython.utils import PyColorize |
|
60 | from IPython.utils import PyColorize | |
61 | from IPython.utils import io |
|
61 | from IPython.utils import io | |
62 | from IPython.utils import py3compat |
|
62 | from IPython.utils import py3compat | |
63 | from IPython.utils import openpy |
|
63 | from IPython.utils import openpy | |
64 | from IPython.utils.decorators import undoc |
|
64 | from IPython.utils.decorators import undoc | |
65 | from IPython.utils.io import ask_yes_no |
|
65 | from IPython.utils.io import ask_yes_no | |
66 | from IPython.utils.ipstruct import Struct |
|
66 | from IPython.utils.ipstruct import Struct | |
67 | from IPython.paths import get_ipython_dir |
|
67 | from IPython.paths import get_ipython_dir | |
68 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
68 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists | |
69 | from IPython.utils.process import system, getoutput |
|
69 | from IPython.utils.process import system, getoutput | |
70 | from IPython.utils.strdispatch import StrDispatch |
|
70 | from IPython.utils.strdispatch import StrDispatch | |
71 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
71 | from IPython.utils.syspathcontext import prepended_to_syspath | |
72 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
72 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter | |
73 | from IPython.utils.tempdir import TemporaryDirectory |
|
73 | from IPython.utils.tempdir import TemporaryDirectory | |
74 | from traitlets import ( |
|
74 | from traitlets import ( | |
75 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
75 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, | |
76 | observe, default, |
|
76 | observe, default, | |
77 | ) |
|
77 | ) | |
78 | from warnings import warn |
|
78 | from warnings import warn | |
79 | from logging import error |
|
79 | from logging import error | |
80 | import IPython.core.hooks |
|
80 | import IPython.core.hooks | |
81 |
|
81 | |||
82 | from typing import List as ListType |
|
82 | from typing import List as ListType | |
83 | from ast import AST |
|
83 | from ast import AST | |
84 |
|
84 | |||
85 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
85 | # NoOpContext is deprecated, but ipykernel imports it from here. | |
86 | # See https://github.com/ipython/ipykernel/issues/157 |
|
86 | # See https://github.com/ipython/ipykernel/issues/157 | |
87 | from IPython.utils.contexts import NoOpContext |
|
87 | from IPython.utils.contexts import NoOpContext | |
88 |
|
88 | |||
89 | try: |
|
89 | try: | |
90 | import docrepr.sphinxify as sphx |
|
90 | import docrepr.sphinxify as sphx | |
91 |
|
91 | |||
92 | def sphinxify(doc): |
|
92 | def sphinxify(doc): | |
93 | with TemporaryDirectory() as dirname: |
|
93 | with TemporaryDirectory() as dirname: | |
94 | return { |
|
94 | return { | |
95 | 'text/html': sphx.sphinxify(doc, dirname), |
|
95 | 'text/html': sphx.sphinxify(doc, dirname), | |
96 | 'text/plain': doc |
|
96 | 'text/plain': doc | |
97 | } |
|
97 | } | |
98 | except ImportError: |
|
98 | except ImportError: | |
99 | sphinxify = None |
|
99 | sphinxify = None | |
100 |
|
100 | |||
101 |
|
101 | |||
102 | class ProvisionalWarning(DeprecationWarning): |
|
102 | class ProvisionalWarning(DeprecationWarning): | |
103 | """ |
|
103 | """ | |
104 | Warning class for unstable features |
|
104 | Warning class for unstable features | |
105 | """ |
|
105 | """ | |
106 | pass |
|
106 | pass | |
107 |
|
107 | |||
108 | if sys.version_info > (3,6): |
|
108 | if sys.version_info > (3,6): | |
109 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
109 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) | |
110 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
110 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) | |
111 | else: |
|
111 | else: | |
112 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
112 | _assign_nodes = (ast.AugAssign, ast.Assign ) | |
113 | _single_targets_nodes = (ast.AugAssign, ) |
|
113 | _single_targets_nodes = (ast.AugAssign, ) | |
114 |
|
114 | |||
115 | #----------------------------------------------------------------------------- |
|
115 | #----------------------------------------------------------------------------- | |
116 | # Globals |
|
116 | # Globals | |
117 | #----------------------------------------------------------------------------- |
|
117 | #----------------------------------------------------------------------------- | |
118 |
|
118 | |||
119 | # compiled regexps for autoindent management |
|
119 | # compiled regexps for autoindent management | |
120 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
120 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
121 |
|
121 | |||
122 | #----------------------------------------------------------------------------- |
|
122 | #----------------------------------------------------------------------------- | |
123 | # Utilities |
|
123 | # Utilities | |
124 | #----------------------------------------------------------------------------- |
|
124 | #----------------------------------------------------------------------------- | |
125 |
|
125 | |||
126 | @undoc |
|
126 | @undoc | |
127 | def softspace(file, newvalue): |
|
127 | def softspace(file, newvalue): | |
128 | """Copied from code.py, to remove the dependency""" |
|
128 | """Copied from code.py, to remove the dependency""" | |
129 |
|
129 | |||
130 | oldvalue = 0 |
|
130 | oldvalue = 0 | |
131 | try: |
|
131 | try: | |
132 | oldvalue = file.softspace |
|
132 | oldvalue = file.softspace | |
133 | except AttributeError: |
|
133 | except AttributeError: | |
134 | pass |
|
134 | pass | |
135 | try: |
|
135 | try: | |
136 | file.softspace = newvalue |
|
136 | file.softspace = newvalue | |
137 | except (AttributeError, TypeError): |
|
137 | except (AttributeError, TypeError): | |
138 | # "attribute-less object" or "read-only attributes" |
|
138 | # "attribute-less object" or "read-only attributes" | |
139 | pass |
|
139 | pass | |
140 | return oldvalue |
|
140 | return oldvalue | |
141 |
|
141 | |||
142 | @undoc |
|
142 | @undoc | |
143 | def no_op(*a, **kw): |
|
143 | def no_op(*a, **kw): | |
144 | pass |
|
144 | pass | |
145 |
|
145 | |||
146 |
|
146 | |||
147 | class SpaceInInput(Exception): pass |
|
147 | class SpaceInInput(Exception): pass | |
148 |
|
148 | |||
149 |
|
149 | |||
150 | def get_default_colors(): |
|
150 | def get_default_colors(): | |
151 | "DEPRECATED" |
|
151 | "DEPRECATED" | |
152 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', |
|
152 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', | |
153 | DeprecationWarning, stacklevel=2) |
|
153 | DeprecationWarning, stacklevel=2) | |
154 | return 'Neutral' |
|
154 | return 'Neutral' | |
155 |
|
155 | |||
156 |
|
156 | |||
157 | class SeparateUnicode(Unicode): |
|
157 | class SeparateUnicode(Unicode): | |
158 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
158 | r"""A Unicode subclass to validate separate_in, separate_out, etc. | |
159 |
|
159 | |||
160 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
160 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. | |
161 | """ |
|
161 | """ | |
162 |
|
162 | |||
163 | def validate(self, obj, value): |
|
163 | def validate(self, obj, value): | |
164 | if value == '0': value = '' |
|
164 | if value == '0': value = '' | |
165 | value = value.replace('\\n','\n') |
|
165 | value = value.replace('\\n','\n') | |
166 | return super(SeparateUnicode, self).validate(obj, value) |
|
166 | return super(SeparateUnicode, self).validate(obj, value) | |
167 |
|
167 | |||
168 |
|
168 | |||
169 | @undoc |
|
169 | @undoc | |
170 | class DummyMod(object): |
|
170 | class DummyMod(object): | |
171 | """A dummy module used for IPython's interactive module when |
|
171 | """A dummy module used for IPython's interactive module when | |
172 | a namespace must be assigned to the module's __dict__.""" |
|
172 | a namespace must be assigned to the module's __dict__.""" | |
173 | pass |
|
173 | pass | |
174 |
|
174 | |||
175 |
|
175 | |||
176 | class ExecutionInfo(object): |
|
176 | class ExecutionInfo(object): | |
177 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` |
|
177 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` | |
178 |
|
178 | |||
179 | Stores information about what is going to happen. |
|
179 | Stores information about what is going to happen. | |
180 | """ |
|
180 | """ | |
181 | raw_cell = None |
|
181 | raw_cell = None | |
182 | store_history = False |
|
182 | store_history = False | |
183 | silent = False |
|
183 | silent = False | |
184 | shell_futures = True |
|
184 | shell_futures = True | |
185 |
|
185 | |||
186 | def __init__(self, raw_cell, store_history, silent, shell_futures): |
|
186 | def __init__(self, raw_cell, store_history, silent, shell_futures): | |
187 | self.raw_cell = raw_cell |
|
187 | self.raw_cell = raw_cell | |
188 | self.store_history = store_history |
|
188 | self.store_history = store_history | |
189 | self.silent = silent |
|
189 | self.silent = silent | |
190 | self.shell_futures = shell_futures |
|
190 | self.shell_futures = shell_futures | |
191 |
|
191 | |||
192 | def __repr__(self): |
|
192 | def __repr__(self): | |
193 | name = self.__class__.__qualname__ |
|
193 | name = self.__class__.__qualname__ | |
194 | raw_cell = ((self.raw_cell[:50] + '..') |
|
194 | raw_cell = ((self.raw_cell[:50] + '..') | |
195 | if len(self.raw_cell) > 50 else self.raw_cell) |
|
195 | if len(self.raw_cell) > 50 else self.raw_cell) | |
196 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ |
|
196 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ | |
197 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) |
|
197 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) | |
198 |
|
198 | |||
199 |
|
199 | |||
200 | class ExecutionResult(object): |
|
200 | class ExecutionResult(object): | |
201 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
201 | """The result of a call to :meth:`InteractiveShell.run_cell` | |
202 |
|
202 | |||
203 | Stores information about what took place. |
|
203 | Stores information about what took place. | |
204 | """ |
|
204 | """ | |
205 | execution_count = None |
|
205 | execution_count = None | |
206 | error_before_exec = None |
|
206 | error_before_exec = None | |
207 | error_in_exec = None |
|
207 | error_in_exec = None | |
208 | info = None |
|
208 | info = None | |
209 | result = None |
|
209 | result = None | |
210 |
|
210 | |||
211 | def __init__(self, info): |
|
211 | def __init__(self, info): | |
212 | self.info = info |
|
212 | self.info = info | |
213 |
|
213 | |||
214 | @property |
|
214 | @property | |
215 | def success(self): |
|
215 | def success(self): | |
216 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
216 | return (self.error_before_exec is None) and (self.error_in_exec is None) | |
217 |
|
217 | |||
218 | def raise_error(self): |
|
218 | def raise_error(self): | |
219 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
219 | """Reraises error if `success` is `False`, otherwise does nothing""" | |
220 | if self.error_before_exec is not None: |
|
220 | if self.error_before_exec is not None: | |
221 | raise self.error_before_exec |
|
221 | raise self.error_before_exec | |
222 | if self.error_in_exec is not None: |
|
222 | if self.error_in_exec is not None: | |
223 | raise self.error_in_exec |
|
223 | raise self.error_in_exec | |
224 |
|
224 | |||
225 | def __repr__(self): |
|
225 | def __repr__(self): | |
226 | name = self.__class__.__qualname__ |
|
226 | name = self.__class__.__qualname__ | |
227 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ |
|
227 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ | |
228 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) |
|
228 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) | |
229 |
|
229 | |||
230 |
|
230 | |||
231 | class InteractiveShell(SingletonConfigurable): |
|
231 | class InteractiveShell(SingletonConfigurable): | |
232 | """An enhanced, interactive shell for Python.""" |
|
232 | """An enhanced, interactive shell for Python.""" | |
233 |
|
233 | |||
234 | _instance = None |
|
234 | _instance = None | |
235 |
|
235 | |||
236 | ast_transformers = List([], help= |
|
236 | ast_transformers = List([], help= | |
237 | """ |
|
237 | """ | |
238 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
238 | A list of ast.NodeTransformer subclass instances, which will be applied | |
239 | to user input before code is run. |
|
239 | to user input before code is run. | |
240 | """ |
|
240 | """ | |
241 | ).tag(config=True) |
|
241 | ).tag(config=True) | |
242 |
|
242 | |||
243 | autocall = Enum((0,1,2), default_value=0, help= |
|
243 | autocall = Enum((0,1,2), default_value=0, help= | |
244 | """ |
|
244 | """ | |
245 | Make IPython automatically call any callable object even if you didn't |
|
245 | Make IPython automatically call any callable object even if you didn't | |
246 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
246 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
247 | automatically. The value can be '0' to disable the feature, '1' for |
|
247 | automatically. The value can be '0' to disable the feature, '1' for | |
248 | 'smart' autocall, where it is not applied if there are no more |
|
248 | 'smart' autocall, where it is not applied if there are no more | |
249 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
249 | arguments on the line, and '2' for 'full' autocall, where all callable | |
250 | objects are automatically called (even if no arguments are present). |
|
250 | objects are automatically called (even if no arguments are present). | |
251 | """ |
|
251 | """ | |
252 | ).tag(config=True) |
|
252 | ).tag(config=True) | |
253 | # TODO: remove all autoindent logic and put into frontends. |
|
253 | # TODO: remove all autoindent logic and put into frontends. | |
254 | # We can't do this yet because even runlines uses the autoindent. |
|
254 | # We can't do this yet because even runlines uses the autoindent. | |
255 | autoindent = Bool(True, help= |
|
255 | autoindent = Bool(True, help= | |
256 | """ |
|
256 | """ | |
257 | Autoindent IPython code entered interactively. |
|
257 | Autoindent IPython code entered interactively. | |
258 | """ |
|
258 | """ | |
259 | ).tag(config=True) |
|
259 | ).tag(config=True) | |
260 |
|
260 | |||
261 | automagic = Bool(True, help= |
|
261 | automagic = Bool(True, help= | |
262 | """ |
|
262 | """ | |
263 | Enable magic commands to be called without the leading %. |
|
263 | Enable magic commands to be called without the leading %. | |
264 | """ |
|
264 | """ | |
265 | ).tag(config=True) |
|
265 | ).tag(config=True) | |
266 |
|
266 | |||
267 | banner1 = Unicode(default_banner, |
|
267 | banner1 = Unicode(default_banner, | |
268 | help="""The part of the banner to be printed before the profile""" |
|
268 | help="""The part of the banner to be printed before the profile""" | |
269 | ).tag(config=True) |
|
269 | ).tag(config=True) | |
270 | banner2 = Unicode('', |
|
270 | banner2 = Unicode('', | |
271 | help="""The part of the banner to be printed after the profile""" |
|
271 | help="""The part of the banner to be printed after the profile""" | |
272 | ).tag(config=True) |
|
272 | ).tag(config=True) | |
273 |
|
273 | |||
274 | cache_size = Integer(1000, help= |
|
274 | cache_size = Integer(1000, help= | |
275 | """ |
|
275 | """ | |
276 | Set the size of the output cache. The default is 1000, you can |
|
276 | Set the size of the output cache. The default is 1000, you can | |
277 | change it permanently in your config file. Setting it to 0 completely |
|
277 | change it permanently in your config file. Setting it to 0 completely | |
278 | disables the caching system, and the minimum value accepted is 3 (if |
|
278 | disables the caching system, and the minimum value accepted is 3 (if | |
279 | you provide a value less than 3, it is reset to 0 and a warning is |
|
279 | you provide a value less than 3, it is reset to 0 and a warning is | |
280 | issued). This limit is defined because otherwise you'll spend more |
|
280 | issued). This limit is defined because otherwise you'll spend more | |
281 | time re-flushing a too small cache than working |
|
281 | time re-flushing a too small cache than working | |
282 | """ |
|
282 | """ | |
283 | ).tag(config=True) |
|
283 | ).tag(config=True) | |
284 | color_info = Bool(True, help= |
|
284 | color_info = Bool(True, help= | |
285 | """ |
|
285 | """ | |
286 | Use colors for displaying information about objects. Because this |
|
286 | Use colors for displaying information about objects. Because this | |
287 | information is passed through a pager (like 'less'), and some pagers |
|
287 | information is passed through a pager (like 'less'), and some pagers | |
288 | get confused with color codes, this capability can be turned off. |
|
288 | get confused with color codes, this capability can be turned off. | |
289 | """ |
|
289 | """ | |
290 | ).tag(config=True) |
|
290 | ).tag(config=True) | |
291 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
291 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), | |
292 | default_value='Neutral', |
|
292 | default_value='Neutral', | |
293 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
293 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." | |
294 | ).tag(config=True) |
|
294 | ).tag(config=True) | |
295 | debug = Bool(False).tag(config=True) |
|
295 | debug = Bool(False).tag(config=True) | |
296 | disable_failing_post_execute = Bool(False, |
|
296 | disable_failing_post_execute = Bool(False, | |
297 | help="Don't call post-execute functions that have failed in the past." |
|
297 | help="Don't call post-execute functions that have failed in the past." | |
298 | ).tag(config=True) |
|
298 | ).tag(config=True) | |
299 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
299 | display_formatter = Instance(DisplayFormatter, allow_none=True) | |
300 | displayhook_class = Type(DisplayHook) |
|
300 | displayhook_class = Type(DisplayHook) | |
301 | display_pub_class = Type(DisplayPublisher) |
|
301 | display_pub_class = Type(DisplayPublisher) | |
302 |
|
302 | |||
303 | sphinxify_docstring = Bool(False, help= |
|
303 | sphinxify_docstring = Bool(False, help= | |
304 | """ |
|
304 | """ | |
305 | Enables rich html representation of docstrings. (This requires the |
|
305 | Enables rich html representation of docstrings. (This requires the | |
306 | docrepr module). |
|
306 | docrepr module). | |
307 | """).tag(config=True) |
|
307 | """).tag(config=True) | |
308 |
|
308 | |||
309 | @observe("sphinxify_docstring") |
|
309 | @observe("sphinxify_docstring") | |
310 | def _sphinxify_docstring_changed(self, change): |
|
310 | def _sphinxify_docstring_changed(self, change): | |
311 | if change['new']: |
|
311 | if change['new']: | |
312 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
312 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) | |
313 |
|
313 | |||
314 | enable_html_pager = Bool(False, help= |
|
314 | enable_html_pager = Bool(False, help= | |
315 | """ |
|
315 | """ | |
316 | (Provisional API) enables html representation in mime bundles sent |
|
316 | (Provisional API) enables html representation in mime bundles sent | |
317 | to pagers. |
|
317 | to pagers. | |
318 | """).tag(config=True) |
|
318 | """).tag(config=True) | |
319 |
|
319 | |||
320 | @observe("enable_html_pager") |
|
320 | @observe("enable_html_pager") | |
321 | def _enable_html_pager_changed(self, change): |
|
321 | def _enable_html_pager_changed(self, change): | |
322 | if change['new']: |
|
322 | if change['new']: | |
323 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
323 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) | |
324 |
|
324 | |||
325 | data_pub_class = None |
|
325 | data_pub_class = None | |
326 |
|
326 | |||
327 | exit_now = Bool(False) |
|
327 | exit_now = Bool(False) | |
328 | exiter = Instance(ExitAutocall) |
|
328 | exiter = Instance(ExitAutocall) | |
329 | @default('exiter') |
|
329 | @default('exiter') | |
330 | def _exiter_default(self): |
|
330 | def _exiter_default(self): | |
331 | return ExitAutocall(self) |
|
331 | return ExitAutocall(self) | |
332 | # Monotonically increasing execution counter |
|
332 | # Monotonically increasing execution counter | |
333 | execution_count = Integer(1) |
|
333 | execution_count = Integer(1) | |
334 | filename = Unicode("<ipython console>") |
|
334 | filename = Unicode("<ipython console>") | |
335 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
335 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ | |
336 |
|
336 | |||
337 | # Input splitter, to transform input line by line and detect when a block |
|
337 | # Input splitter, to transform input line by line and detect when a block | |
338 | # is ready to be executed. |
|
338 | # is ready to be executed. | |
339 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
339 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
340 | (), {'line_input_checker': True}) |
|
340 | (), {'line_input_checker': True}) | |
341 |
|
341 | |||
342 | # This InputSplitter instance is used to transform completed cells before |
|
342 | # This InputSplitter instance is used to transform completed cells before | |
343 | # running them. It allows cell magics to contain blank lines. |
|
343 | # running them. It allows cell magics to contain blank lines. | |
344 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
344 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
345 | (), {'line_input_checker': False}) |
|
345 | (), {'line_input_checker': False}) | |
346 |
|
346 | |||
347 | logstart = Bool(False, help= |
|
347 | logstart = Bool(False, help= | |
348 | """ |
|
348 | """ | |
349 | Start logging to the default log file in overwrite mode. |
|
349 | Start logging to the default log file in overwrite mode. | |
350 | Use `logappend` to specify a log file to **append** logs to. |
|
350 | Use `logappend` to specify a log file to **append** logs to. | |
351 | """ |
|
351 | """ | |
352 | ).tag(config=True) |
|
352 | ).tag(config=True) | |
353 | logfile = Unicode('', help= |
|
353 | logfile = Unicode('', help= | |
354 | """ |
|
354 | """ | |
355 | The name of the logfile to use. |
|
355 | The name of the logfile to use. | |
356 | """ |
|
356 | """ | |
357 | ).tag(config=True) |
|
357 | ).tag(config=True) | |
358 | logappend = Unicode('', help= |
|
358 | logappend = Unicode('', help= | |
359 | """ |
|
359 | """ | |
360 | Start logging to the given file in append mode. |
|
360 | Start logging to the given file in append mode. | |
361 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
361 | Use `logfile` to specify a log file to **overwrite** logs to. | |
362 | """ |
|
362 | """ | |
363 | ).tag(config=True) |
|
363 | ).tag(config=True) | |
364 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
364 | object_info_string_level = Enum((0,1,2), default_value=0, | |
365 | ).tag(config=True) |
|
365 | ).tag(config=True) | |
366 | pdb = Bool(False, help= |
|
366 | pdb = Bool(False, help= | |
367 | """ |
|
367 | """ | |
368 | Automatically call the pdb debugger after every exception. |
|
368 | Automatically call the pdb debugger after every exception. | |
369 | """ |
|
369 | """ | |
370 | ).tag(config=True) |
|
370 | ).tag(config=True) | |
371 | display_page = Bool(False, |
|
371 | display_page = Bool(False, | |
372 | help="""If True, anything that would be passed to the pager |
|
372 | help="""If True, anything that would be passed to the pager | |
373 | will be displayed as regular output instead.""" |
|
373 | will be displayed as regular output instead.""" | |
374 | ).tag(config=True) |
|
374 | ).tag(config=True) | |
375 |
|
375 | |||
376 | # deprecated prompt traits: |
|
376 | # deprecated prompt traits: | |
377 |
|
377 | |||
378 | prompt_in1 = Unicode('In [\\#]: ', |
|
378 | prompt_in1 = Unicode('In [\\#]: ', | |
379 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
379 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
380 | ).tag(config=True) |
|
380 | ).tag(config=True) | |
381 | prompt_in2 = Unicode(' .\\D.: ', |
|
381 | prompt_in2 = Unicode(' .\\D.: ', | |
382 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
382 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
383 | ).tag(config=True) |
|
383 | ).tag(config=True) | |
384 | prompt_out = Unicode('Out[\\#]: ', |
|
384 | prompt_out = Unicode('Out[\\#]: ', | |
385 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
385 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
386 | ).tag(config=True) |
|
386 | ).tag(config=True) | |
387 | prompts_pad_left = Bool(True, |
|
387 | prompts_pad_left = Bool(True, | |
388 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
388 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." | |
389 | ).tag(config=True) |
|
389 | ).tag(config=True) | |
390 |
|
390 | |||
391 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
391 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') | |
392 | def _prompt_trait_changed(self, change): |
|
392 | def _prompt_trait_changed(self, change): | |
393 | name = change['name'] |
|
393 | name = change['name'] | |
394 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
394 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" | |
395 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
395 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" | |
396 | " object directly.".format(name=name)) |
|
396 | " object directly.".format(name=name)) | |
397 |
|
397 | |||
398 | # protect against weird cases where self.config may not exist: |
|
398 | # protect against weird cases where self.config may not exist: | |
399 |
|
399 | |||
400 | show_rewritten_input = Bool(True, |
|
400 | show_rewritten_input = Bool(True, | |
401 | help="Show rewritten input, e.g. for autocall." |
|
401 | help="Show rewritten input, e.g. for autocall." | |
402 | ).tag(config=True) |
|
402 | ).tag(config=True) | |
403 |
|
403 | |||
404 | quiet = Bool(False).tag(config=True) |
|
404 | quiet = Bool(False).tag(config=True) | |
405 |
|
405 | |||
406 | history_length = Integer(10000, |
|
406 | history_length = Integer(10000, | |
407 | help='Total length of command history' |
|
407 | help='Total length of command history' | |
408 | ).tag(config=True) |
|
408 | ).tag(config=True) | |
409 |
|
409 | |||
410 | history_load_length = Integer(1000, help= |
|
410 | history_load_length = Integer(1000, help= | |
411 | """ |
|
411 | """ | |
412 | The number of saved history entries to be loaded |
|
412 | The number of saved history entries to be loaded | |
413 | into the history buffer at startup. |
|
413 | into the history buffer at startup. | |
414 | """ |
|
414 | """ | |
415 | ).tag(config=True) |
|
415 | ).tag(config=True) | |
416 |
|
416 | |||
417 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
417 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], | |
418 | default_value='last_expr', |
|
418 | default_value='last_expr', | |
419 | help=""" |
|
419 | help=""" | |
420 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
420 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying | |
421 | which nodes should be run interactively (displaying output from expressions). |
|
421 | which nodes should be run interactively (displaying output from expressions). | |
422 | """ |
|
422 | """ | |
423 | ).tag(config=True) |
|
423 | ).tag(config=True) | |
424 |
|
424 | |||
425 | # TODO: this part of prompt management should be moved to the frontends. |
|
425 | # TODO: this part of prompt management should be moved to the frontends. | |
426 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
426 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
427 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
427 | separate_in = SeparateUnicode('\n').tag(config=True) | |
428 | separate_out = SeparateUnicode('').tag(config=True) |
|
428 | separate_out = SeparateUnicode('').tag(config=True) | |
429 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
429 | separate_out2 = SeparateUnicode('').tag(config=True) | |
430 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
430 | wildcards_case_sensitive = Bool(True).tag(config=True) | |
431 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
431 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
432 | default_value='Context', |
|
432 | default_value='Context', | |
433 | help="Switch modes for the IPython exception handlers." |
|
433 | help="Switch modes for the IPython exception handlers." | |
434 | ).tag(config=True) |
|
434 | ).tag(config=True) | |
435 |
|
435 | |||
436 | # Subcomponents of InteractiveShell |
|
436 | # Subcomponents of InteractiveShell | |
437 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
437 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) | |
438 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
438 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) | |
439 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
439 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) | |
440 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
440 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) | |
441 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
441 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) | |
442 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
442 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) | |
443 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
443 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) | |
444 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
444 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) | |
445 |
|
445 | |||
446 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
446 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) | |
447 | @property |
|
447 | @property | |
448 | def profile(self): |
|
448 | def profile(self): | |
449 | if self.profile_dir is not None: |
|
449 | if self.profile_dir is not None: | |
450 | name = os.path.basename(self.profile_dir.location) |
|
450 | name = os.path.basename(self.profile_dir.location) | |
451 | return name.replace('profile_','') |
|
451 | return name.replace('profile_','') | |
452 |
|
452 | |||
453 |
|
453 | |||
454 | # Private interface |
|
454 | # Private interface | |
455 | _post_execute = Dict() |
|
455 | _post_execute = Dict() | |
456 |
|
456 | |||
457 | # Tracks any GUI loop loaded for pylab |
|
457 | # Tracks any GUI loop loaded for pylab | |
458 | pylab_gui_select = None |
|
458 | pylab_gui_select = None | |
459 |
|
459 | |||
460 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
460 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') | |
461 |
|
461 | |||
462 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
462 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) | |
463 |
|
463 | |||
464 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
464 | def __init__(self, ipython_dir=None, profile_dir=None, | |
465 | user_module=None, user_ns=None, |
|
465 | user_module=None, user_ns=None, | |
466 | custom_exceptions=((), None), **kwargs): |
|
466 | custom_exceptions=((), None), **kwargs): | |
467 |
|
467 | |||
468 | # This is where traits with a config_key argument are updated |
|
468 | # This is where traits with a config_key argument are updated | |
469 | # from the values on config. |
|
469 | # from the values on config. | |
470 | super(InteractiveShell, self).__init__(**kwargs) |
|
470 | super(InteractiveShell, self).__init__(**kwargs) | |
471 | if 'PromptManager' in self.config: |
|
471 | if 'PromptManager' in self.config: | |
472 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
472 | warn('As of IPython 5.0 `PromptManager` config will have no effect' | |
473 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
473 | ' and has been replaced by TerminalInteractiveShell.prompts_class') | |
474 | self.configurables = [self] |
|
474 | self.configurables = [self] | |
475 |
|
475 | |||
476 | # These are relatively independent and stateless |
|
476 | # These are relatively independent and stateless | |
477 | self.init_ipython_dir(ipython_dir) |
|
477 | self.init_ipython_dir(ipython_dir) | |
478 | self.init_profile_dir(profile_dir) |
|
478 | self.init_profile_dir(profile_dir) | |
479 | self.init_instance_attrs() |
|
479 | self.init_instance_attrs() | |
480 | self.init_environment() |
|
480 | self.init_environment() | |
481 |
|
481 | |||
482 | # Check if we're in a virtualenv, and set up sys.path. |
|
482 | # Check if we're in a virtualenv, and set up sys.path. | |
483 | self.init_virtualenv() |
|
483 | self.init_virtualenv() | |
484 |
|
484 | |||
485 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
485 | # Create namespaces (user_ns, user_global_ns, etc.) | |
486 | self.init_create_namespaces(user_module, user_ns) |
|
486 | self.init_create_namespaces(user_module, user_ns) | |
487 | # This has to be done after init_create_namespaces because it uses |
|
487 | # This has to be done after init_create_namespaces because it uses | |
488 | # something in self.user_ns, but before init_sys_modules, which |
|
488 | # something in self.user_ns, but before init_sys_modules, which | |
489 | # is the first thing to modify sys. |
|
489 | # is the first thing to modify sys. | |
490 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
490 | # TODO: When we override sys.stdout and sys.stderr before this class | |
491 | # is created, we are saving the overridden ones here. Not sure if this |
|
491 | # is created, we are saving the overridden ones here. Not sure if this | |
492 | # is what we want to do. |
|
492 | # is what we want to do. | |
493 | self.save_sys_module_state() |
|
493 | self.save_sys_module_state() | |
494 | self.init_sys_modules() |
|
494 | self.init_sys_modules() | |
495 |
|
495 | |||
496 | # While we're trying to have each part of the code directly access what |
|
496 | # While we're trying to have each part of the code directly access what | |
497 | # it needs without keeping redundant references to objects, we have too |
|
497 | # it needs without keeping redundant references to objects, we have too | |
498 | # much legacy code that expects ip.db to exist. |
|
498 | # much legacy code that expects ip.db to exist. | |
499 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
499 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
500 |
|
500 | |||
501 | self.init_history() |
|
501 | self.init_history() | |
502 | self.init_encoding() |
|
502 | self.init_encoding() | |
503 | self.init_prefilter() |
|
503 | self.init_prefilter() | |
504 |
|
504 | |||
505 | self.init_syntax_highlighting() |
|
505 | self.init_syntax_highlighting() | |
506 | self.init_hooks() |
|
506 | self.init_hooks() | |
507 | self.init_events() |
|
507 | self.init_events() | |
508 | self.init_pushd_popd_magic() |
|
508 | self.init_pushd_popd_magic() | |
509 | self.init_user_ns() |
|
509 | self.init_user_ns() | |
510 | self.init_logger() |
|
510 | self.init_logger() | |
511 | self.init_builtins() |
|
511 | self.init_builtins() | |
512 |
|
512 | |||
513 | # The following was in post_config_initialization |
|
513 | # The following was in post_config_initialization | |
514 | self.init_inspector() |
|
514 | self.init_inspector() | |
515 | self.raw_input_original = input |
|
515 | self.raw_input_original = input | |
516 | self.init_completer() |
|
516 | self.init_completer() | |
517 | # TODO: init_io() needs to happen before init_traceback handlers |
|
517 | # TODO: init_io() needs to happen before init_traceback handlers | |
518 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
518 | # because the traceback handlers hardcode the stdout/stderr streams. | |
519 | # This logic in in debugger.Pdb and should eventually be changed. |
|
519 | # This logic in in debugger.Pdb and should eventually be changed. | |
520 | self.init_io() |
|
520 | self.init_io() | |
521 | self.init_traceback_handlers(custom_exceptions) |
|
521 | self.init_traceback_handlers(custom_exceptions) | |
522 | self.init_prompts() |
|
522 | self.init_prompts() | |
523 | self.init_display_formatter() |
|
523 | self.init_display_formatter() | |
524 | self.init_display_pub() |
|
524 | self.init_display_pub() | |
525 | self.init_data_pub() |
|
525 | self.init_data_pub() | |
526 | self.init_displayhook() |
|
526 | self.init_displayhook() | |
527 | self.init_magics() |
|
527 | self.init_magics() | |
528 | self.init_alias() |
|
528 | self.init_alias() | |
529 | self.init_logstart() |
|
529 | self.init_logstart() | |
530 | self.init_pdb() |
|
530 | self.init_pdb() | |
531 | self.init_extension_manager() |
|
531 | self.init_extension_manager() | |
532 | self.init_payload() |
|
532 | self.init_payload() | |
533 | self.init_deprecation_warnings() |
|
533 | self.init_deprecation_warnings() | |
534 | self.hooks.late_startup_hook() |
|
534 | self.hooks.late_startup_hook() | |
535 | self.events.trigger('shell_initialized', self) |
|
535 | self.events.trigger('shell_initialized', self) | |
536 | atexit.register(self.atexit_operations) |
|
536 | atexit.register(self.atexit_operations) | |
537 |
|
537 | |||
538 | def get_ipython(self): |
|
538 | def get_ipython(self): | |
539 | """Return the currently running IPython instance.""" |
|
539 | """Return the currently running IPython instance.""" | |
540 | return self |
|
540 | return self | |
541 |
|
541 | |||
542 | #------------------------------------------------------------------------- |
|
542 | #------------------------------------------------------------------------- | |
543 | # Trait changed handlers |
|
543 | # Trait changed handlers | |
544 | #------------------------------------------------------------------------- |
|
544 | #------------------------------------------------------------------------- | |
545 | @observe('ipython_dir') |
|
545 | @observe('ipython_dir') | |
546 | def _ipython_dir_changed(self, change): |
|
546 | def _ipython_dir_changed(self, change): | |
547 | ensure_dir_exists(change['new']) |
|
547 | ensure_dir_exists(change['new']) | |
548 |
|
548 | |||
549 | def set_autoindent(self,value=None): |
|
549 | def set_autoindent(self,value=None): | |
550 | """Set the autoindent flag. |
|
550 | """Set the autoindent flag. | |
551 |
|
551 | |||
552 | If called with no arguments, it acts as a toggle.""" |
|
552 | If called with no arguments, it acts as a toggle.""" | |
553 | if value is None: |
|
553 | if value is None: | |
554 | self.autoindent = not self.autoindent |
|
554 | self.autoindent = not self.autoindent | |
555 | else: |
|
555 | else: | |
556 | self.autoindent = value |
|
556 | self.autoindent = value | |
557 |
|
557 | |||
558 | #------------------------------------------------------------------------- |
|
558 | #------------------------------------------------------------------------- | |
559 | # init_* methods called by __init__ |
|
559 | # init_* methods called by __init__ | |
560 | #------------------------------------------------------------------------- |
|
560 | #------------------------------------------------------------------------- | |
561 |
|
561 | |||
562 | def init_ipython_dir(self, ipython_dir): |
|
562 | def init_ipython_dir(self, ipython_dir): | |
563 | if ipython_dir is not None: |
|
563 | if ipython_dir is not None: | |
564 | self.ipython_dir = ipython_dir |
|
564 | self.ipython_dir = ipython_dir | |
565 | return |
|
565 | return | |
566 |
|
566 | |||
567 | self.ipython_dir = get_ipython_dir() |
|
567 | self.ipython_dir = get_ipython_dir() | |
568 |
|
568 | |||
569 | def init_profile_dir(self, profile_dir): |
|
569 | def init_profile_dir(self, profile_dir): | |
570 | if profile_dir is not None: |
|
570 | if profile_dir is not None: | |
571 | self.profile_dir = profile_dir |
|
571 | self.profile_dir = profile_dir | |
572 | return |
|
572 | return | |
573 | self.profile_dir =\ |
|
573 | self.profile_dir =\ | |
574 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
574 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
575 |
|
575 | |||
576 | def init_instance_attrs(self): |
|
576 | def init_instance_attrs(self): | |
577 | self.more = False |
|
577 | self.more = False | |
578 |
|
578 | |||
579 | # command compiler |
|
579 | # command compiler | |
580 | self.compile = CachingCompiler() |
|
580 | self.compile = CachingCompiler() | |
581 |
|
581 | |||
582 | # Make an empty namespace, which extension writers can rely on both |
|
582 | # Make an empty namespace, which extension writers can rely on both | |
583 | # existing and NEVER being used by ipython itself. This gives them a |
|
583 | # existing and NEVER being used by ipython itself. This gives them a | |
584 | # convenient location for storing additional information and state |
|
584 | # convenient location for storing additional information and state | |
585 | # their extensions may require, without fear of collisions with other |
|
585 | # their extensions may require, without fear of collisions with other | |
586 | # ipython names that may develop later. |
|
586 | # ipython names that may develop later. | |
587 | self.meta = Struct() |
|
587 | self.meta = Struct() | |
588 |
|
588 | |||
589 | # Temporary files used for various purposes. Deleted at exit. |
|
589 | # Temporary files used for various purposes. Deleted at exit. | |
590 | self.tempfiles = [] |
|
590 | self.tempfiles = [] | |
591 | self.tempdirs = [] |
|
591 | self.tempdirs = [] | |
592 |
|
592 | |||
593 | # keep track of where we started running (mainly for crash post-mortem) |
|
593 | # keep track of where we started running (mainly for crash post-mortem) | |
594 | # This is not being used anywhere currently. |
|
594 | # This is not being used anywhere currently. | |
595 | self.starting_dir = os.getcwd() |
|
595 | self.starting_dir = os.getcwd() | |
596 |
|
596 | |||
597 | # Indentation management |
|
597 | # Indentation management | |
598 | self.indent_current_nsp = 0 |
|
598 | self.indent_current_nsp = 0 | |
599 |
|
599 | |||
600 | # Dict to track post-execution functions that have been registered |
|
600 | # Dict to track post-execution functions that have been registered | |
601 | self._post_execute = {} |
|
601 | self._post_execute = {} | |
602 |
|
602 | |||
603 | def init_environment(self): |
|
603 | def init_environment(self): | |
604 | """Any changes we need to make to the user's environment.""" |
|
604 | """Any changes we need to make to the user's environment.""" | |
605 | pass |
|
605 | pass | |
606 |
|
606 | |||
607 | def init_encoding(self): |
|
607 | def init_encoding(self): | |
608 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
608 | # Get system encoding at startup time. Certain terminals (like Emacs | |
609 | # under Win32 have it set to None, and we need to have a known valid |
|
609 | # under Win32 have it set to None, and we need to have a known valid | |
610 | # encoding to use in the raw_input() method |
|
610 | # encoding to use in the raw_input() method | |
611 | try: |
|
611 | try: | |
612 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
612 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
613 | except AttributeError: |
|
613 | except AttributeError: | |
614 | self.stdin_encoding = 'ascii' |
|
614 | self.stdin_encoding = 'ascii' | |
615 |
|
615 | |||
616 |
|
616 | |||
617 | @observe('colors') |
|
617 | @observe('colors') | |
618 | def init_syntax_highlighting(self, changes=None): |
|
618 | def init_syntax_highlighting(self, changes=None): | |
619 | # Python source parser/formatter for syntax highlighting |
|
619 | # Python source parser/formatter for syntax highlighting | |
620 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
620 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format | |
621 | self.pycolorize = lambda src: pyformat(src,'str') |
|
621 | self.pycolorize = lambda src: pyformat(src,'str') | |
622 |
|
622 | |||
623 | def refresh_style(self): |
|
623 | def refresh_style(self): | |
624 | # No-op here, used in subclass |
|
624 | # No-op here, used in subclass | |
625 | pass |
|
625 | pass | |
626 |
|
626 | |||
627 | def init_pushd_popd_magic(self): |
|
627 | def init_pushd_popd_magic(self): | |
628 | # for pushd/popd management |
|
628 | # for pushd/popd management | |
629 | self.home_dir = get_home_dir() |
|
629 | self.home_dir = get_home_dir() | |
630 |
|
630 | |||
631 | self.dir_stack = [] |
|
631 | self.dir_stack = [] | |
632 |
|
632 | |||
633 | def init_logger(self): |
|
633 | def init_logger(self): | |
634 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
634 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
635 | logmode='rotate') |
|
635 | logmode='rotate') | |
636 |
|
636 | |||
637 | def init_logstart(self): |
|
637 | def init_logstart(self): | |
638 | """Initialize logging in case it was requested at the command line. |
|
638 | """Initialize logging in case it was requested at the command line. | |
639 | """ |
|
639 | """ | |
640 | if self.logappend: |
|
640 | if self.logappend: | |
641 | self.magic('logstart %s append' % self.logappend) |
|
641 | self.magic('logstart %s append' % self.logappend) | |
642 | elif self.logfile: |
|
642 | elif self.logfile: | |
643 | self.magic('logstart %s' % self.logfile) |
|
643 | self.magic('logstart %s' % self.logfile) | |
644 | elif self.logstart: |
|
644 | elif self.logstart: | |
645 | self.magic('logstart') |
|
645 | self.magic('logstart') | |
646 |
|
646 | |||
647 | def init_deprecation_warnings(self): |
|
647 | def init_deprecation_warnings(self): | |
648 | """ |
|
648 | """ | |
649 | register default filter for deprecation warning. |
|
649 | register default filter for deprecation warning. | |
650 |
|
650 | |||
651 | This will allow deprecation warning of function used interactively to show |
|
651 | This will allow deprecation warning of function used interactively to show | |
652 | warning to users, and still hide deprecation warning from libraries import. |
|
652 | warning to users, and still hide deprecation warning from libraries import. | |
653 | """ |
|
653 | """ | |
654 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
654 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) | |
655 |
|
655 | |||
656 | def init_builtins(self): |
|
656 | def init_builtins(self): | |
657 | # A single, static flag that we set to True. Its presence indicates |
|
657 | # A single, static flag that we set to True. Its presence indicates | |
658 | # that an IPython shell has been created, and we make no attempts at |
|
658 | # that an IPython shell has been created, and we make no attempts at | |
659 | # removing on exit or representing the existence of more than one |
|
659 | # removing on exit or representing the existence of more than one | |
660 | # IPython at a time. |
|
660 | # IPython at a time. | |
661 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
661 | builtin_mod.__dict__['__IPYTHON__'] = True | |
662 | builtin_mod.__dict__['display'] = display |
|
662 | builtin_mod.__dict__['display'] = display | |
663 |
|
663 | |||
664 | self.builtin_trap = BuiltinTrap(shell=self) |
|
664 | self.builtin_trap = BuiltinTrap(shell=self) | |
665 |
|
665 | |||
666 | @observe('colors') |
|
666 | @observe('colors') | |
667 | def init_inspector(self, changes=None): |
|
667 | def init_inspector(self, changes=None): | |
668 | # Object inspector |
|
668 | # Object inspector | |
669 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
669 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
670 | PyColorize.ANSICodeColors, |
|
670 | PyColorize.ANSICodeColors, | |
671 | self.colors, |
|
671 | self.colors, | |
672 | self.object_info_string_level) |
|
672 | self.object_info_string_level) | |
673 |
|
673 | |||
674 | def init_io(self): |
|
674 | def init_io(self): | |
675 | # This will just use sys.stdout and sys.stderr. If you want to |
|
675 | # This will just use sys.stdout and sys.stderr. If you want to | |
676 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
676 | # override sys.stdout and sys.stderr themselves, you need to do that | |
677 | # *before* instantiating this class, because io holds onto |
|
677 | # *before* instantiating this class, because io holds onto | |
678 | # references to the underlying streams. |
|
678 | # references to the underlying streams. | |
679 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
679 | # io.std* are deprecated, but don't show our own deprecation warnings | |
680 | # during initialization of the deprecated API. |
|
680 | # during initialization of the deprecated API. | |
681 | with warnings.catch_warnings(): |
|
681 | with warnings.catch_warnings(): | |
682 | warnings.simplefilter('ignore', DeprecationWarning) |
|
682 | warnings.simplefilter('ignore', DeprecationWarning) | |
683 | io.stdout = io.IOStream(sys.stdout) |
|
683 | io.stdout = io.IOStream(sys.stdout) | |
684 | io.stderr = io.IOStream(sys.stderr) |
|
684 | io.stderr = io.IOStream(sys.stderr) | |
685 |
|
685 | |||
686 | def init_prompts(self): |
|
686 | def init_prompts(self): | |
687 | # Set system prompts, so that scripts can decide if they are running |
|
687 | # Set system prompts, so that scripts can decide if they are running | |
688 | # interactively. |
|
688 | # interactively. | |
689 | sys.ps1 = 'In : ' |
|
689 | sys.ps1 = 'In : ' | |
690 | sys.ps2 = '...: ' |
|
690 | sys.ps2 = '...: ' | |
691 | sys.ps3 = 'Out: ' |
|
691 | sys.ps3 = 'Out: ' | |
692 |
|
692 | |||
693 | def init_display_formatter(self): |
|
693 | def init_display_formatter(self): | |
694 | self.display_formatter = DisplayFormatter(parent=self) |
|
694 | self.display_formatter = DisplayFormatter(parent=self) | |
695 | self.configurables.append(self.display_formatter) |
|
695 | self.configurables.append(self.display_formatter) | |
696 |
|
696 | |||
697 | def init_display_pub(self): |
|
697 | def init_display_pub(self): | |
698 | self.display_pub = self.display_pub_class(parent=self) |
|
698 | self.display_pub = self.display_pub_class(parent=self) | |
699 | self.configurables.append(self.display_pub) |
|
699 | self.configurables.append(self.display_pub) | |
700 |
|
700 | |||
701 | def init_data_pub(self): |
|
701 | def init_data_pub(self): | |
702 | if not self.data_pub_class: |
|
702 | if not self.data_pub_class: | |
703 | self.data_pub = None |
|
703 | self.data_pub = None | |
704 | return |
|
704 | return | |
705 | self.data_pub = self.data_pub_class(parent=self) |
|
705 | self.data_pub = self.data_pub_class(parent=self) | |
706 | self.configurables.append(self.data_pub) |
|
706 | self.configurables.append(self.data_pub) | |
707 |
|
707 | |||
708 | def init_displayhook(self): |
|
708 | def init_displayhook(self): | |
709 | # Initialize displayhook, set in/out prompts and printing system |
|
709 | # Initialize displayhook, set in/out prompts and printing system | |
710 | self.displayhook = self.displayhook_class( |
|
710 | self.displayhook = self.displayhook_class( | |
711 | parent=self, |
|
711 | parent=self, | |
712 | shell=self, |
|
712 | shell=self, | |
713 | cache_size=self.cache_size, |
|
713 | cache_size=self.cache_size, | |
714 | ) |
|
714 | ) | |
715 | self.configurables.append(self.displayhook) |
|
715 | self.configurables.append(self.displayhook) | |
716 | # This is a context manager that installs/revmoes the displayhook at |
|
716 | # This is a context manager that installs/revmoes the displayhook at | |
717 | # the appropriate time. |
|
717 | # the appropriate time. | |
718 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
718 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
719 |
|
719 | |||
720 | def init_virtualenv(self): |
|
720 | def init_virtualenv(self): | |
721 | """Add a virtualenv to sys.path so the user can import modules from it. |
|
721 | """Add a virtualenv to sys.path so the user can import modules from it. | |
722 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
722 | This isn't perfect: it doesn't use the Python interpreter with which the | |
723 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
723 | virtualenv was built, and it ignores the --no-site-packages option. A | |
724 | warning will appear suggesting the user installs IPython in the |
|
724 | warning will appear suggesting the user installs IPython in the | |
725 | virtualenv, but for many cases, it probably works well enough. |
|
725 | virtualenv, but for many cases, it probably works well enough. | |
726 |
|
726 | |||
727 | Adapted from code snippets online. |
|
727 | Adapted from code snippets online. | |
728 |
|
728 | |||
729 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
729 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv | |
730 | """ |
|
730 | """ | |
731 | if 'VIRTUAL_ENV' not in os.environ: |
|
731 | if 'VIRTUAL_ENV' not in os.environ: | |
732 | # Not in a virtualenv |
|
732 | # Not in a virtualenv | |
733 | return |
|
733 | return | |
734 |
|
734 | |||
735 | p = os.path.normcase(sys.executable) |
|
735 | p = os.path.normcase(sys.executable) | |
736 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) |
|
736 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) | |
737 |
|
737 | |||
738 | # executable path should end like /bin/python or \\scripts\\python.exe |
|
738 | # executable path should end like /bin/python or \\scripts\\python.exe | |
739 | p_exe_up2 = os.path.dirname(os.path.dirname(p)) |
|
739 | p_exe_up2 = os.path.dirname(os.path.dirname(p)) | |
740 | if p_exe_up2 and os.path.samefile(p_exe_up2, p_venv): |
|
740 | if p_exe_up2 and os.path.samefile(p_exe_up2, p_venv): | |
741 | # Our exe is inside the virtualenv, don't need to do anything. |
|
741 | # Our exe is inside the virtualenv, don't need to do anything. | |
742 | return |
|
742 | return | |
743 |
|
743 | |||
744 | # fallback venv detection: |
|
744 | # fallback venv detection: | |
745 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
745 | # stdlib venv may symlink sys.executable, so we can't use realpath. | |
746 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
746 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. | |
747 | # So we just check every item in the symlink tree (generally <= 3) |
|
747 | # So we just check every item in the symlink tree (generally <= 3) | |
748 | paths = [p] |
|
748 | paths = [p] | |
749 | while os.path.islink(p): |
|
749 | while os.path.islink(p): | |
750 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) |
|
750 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) | |
751 | paths.append(p) |
|
751 | paths.append(p) | |
752 |
|
752 | |||
753 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
753 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible | |
754 | if p_venv.startswith('\\cygdrive'): |
|
754 | if p_venv.startswith('\\cygdrive'): | |
755 | p_venv = p_venv[11:] |
|
755 | p_venv = p_venv[11:] | |
756 | elif len(p_venv) >= 2 and p_venv[1] == ':': |
|
756 | elif len(p_venv) >= 2 and p_venv[1] == ':': | |
757 | p_venv = p_venv[2:] |
|
757 | p_venv = p_venv[2:] | |
758 |
|
758 | |||
759 | if any(p_venv in p for p in paths): |
|
759 | if any(p_venv in p for p in paths): | |
760 | # Running properly in the virtualenv, don't need to do anything |
|
760 | # Running properly in the virtualenv, don't need to do anything | |
761 | return |
|
761 | return | |
762 |
|
762 | |||
763 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
763 | warn("Attempting to work in a virtualenv. If you encounter problems, please " | |
764 | "install IPython inside the virtualenv.") |
|
764 | "install IPython inside the virtualenv.") | |
765 | if sys.platform == "win32": |
|
765 | if sys.platform == "win32": | |
766 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
766 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') | |
767 | else: |
|
767 | else: | |
768 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
768 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', | |
769 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
769 | 'python%d.%d' % sys.version_info[:2], 'site-packages') | |
770 |
|
770 | |||
771 | import site |
|
771 | import site | |
772 | sys.path.insert(0, virtual_env) |
|
772 | sys.path.insert(0, virtual_env) | |
773 | site.addsitedir(virtual_env) |
|
773 | site.addsitedir(virtual_env) | |
774 |
|
774 | |||
775 | #------------------------------------------------------------------------- |
|
775 | #------------------------------------------------------------------------- | |
776 | # Things related to injections into the sys module |
|
776 | # Things related to injections into the sys module | |
777 | #------------------------------------------------------------------------- |
|
777 | #------------------------------------------------------------------------- | |
778 |
|
778 | |||
779 | def save_sys_module_state(self): |
|
779 | def save_sys_module_state(self): | |
780 | """Save the state of hooks in the sys module. |
|
780 | """Save the state of hooks in the sys module. | |
781 |
|
781 | |||
782 | This has to be called after self.user_module is created. |
|
782 | This has to be called after self.user_module is created. | |
783 | """ |
|
783 | """ | |
784 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
784 | self._orig_sys_module_state = {'stdin': sys.stdin, | |
785 | 'stdout': sys.stdout, |
|
785 | 'stdout': sys.stdout, | |
786 | 'stderr': sys.stderr, |
|
786 | 'stderr': sys.stderr, | |
787 | 'excepthook': sys.excepthook} |
|
787 | 'excepthook': sys.excepthook} | |
788 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
788 | self._orig_sys_modules_main_name = self.user_module.__name__ | |
789 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
789 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) | |
790 |
|
790 | |||
791 | def restore_sys_module_state(self): |
|
791 | def restore_sys_module_state(self): | |
792 | """Restore the state of the sys module.""" |
|
792 | """Restore the state of the sys module.""" | |
793 | try: |
|
793 | try: | |
794 | for k, v in self._orig_sys_module_state.items(): |
|
794 | for k, v in self._orig_sys_module_state.items(): | |
795 | setattr(sys, k, v) |
|
795 | setattr(sys, k, v) | |
796 | except AttributeError: |
|
796 | except AttributeError: | |
797 | pass |
|
797 | pass | |
798 | # Reset what what done in self.init_sys_modules |
|
798 | # Reset what what done in self.init_sys_modules | |
799 | if self._orig_sys_modules_main_mod is not None: |
|
799 | if self._orig_sys_modules_main_mod is not None: | |
800 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
800 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod | |
801 |
|
801 | |||
802 | #------------------------------------------------------------------------- |
|
802 | #------------------------------------------------------------------------- | |
803 | # Things related to the banner |
|
803 | # Things related to the banner | |
804 | #------------------------------------------------------------------------- |
|
804 | #------------------------------------------------------------------------- | |
805 |
|
805 | |||
806 | @property |
|
806 | @property | |
807 | def banner(self): |
|
807 | def banner(self): | |
808 | banner = self.banner1 |
|
808 | banner = self.banner1 | |
809 | if self.profile and self.profile != 'default': |
|
809 | if self.profile and self.profile != 'default': | |
810 | banner += '\nIPython profile: %s\n' % self.profile |
|
810 | banner += '\nIPython profile: %s\n' % self.profile | |
811 | if self.banner2: |
|
811 | if self.banner2: | |
812 | banner += '\n' + self.banner2 |
|
812 | banner += '\n' + self.banner2 | |
813 | return banner |
|
813 | return banner | |
814 |
|
814 | |||
815 | def show_banner(self, banner=None): |
|
815 | def show_banner(self, banner=None): | |
816 | if banner is None: |
|
816 | if banner is None: | |
817 | banner = self.banner |
|
817 | banner = self.banner | |
818 | sys.stdout.write(banner) |
|
818 | sys.stdout.write(banner) | |
819 |
|
819 | |||
820 | #------------------------------------------------------------------------- |
|
820 | #------------------------------------------------------------------------- | |
821 | # Things related to hooks |
|
821 | # Things related to hooks | |
822 | #------------------------------------------------------------------------- |
|
822 | #------------------------------------------------------------------------- | |
823 |
|
823 | |||
824 | def init_hooks(self): |
|
824 | def init_hooks(self): | |
825 | # hooks holds pointers used for user-side customizations |
|
825 | # hooks holds pointers used for user-side customizations | |
826 | self.hooks = Struct() |
|
826 | self.hooks = Struct() | |
827 |
|
827 | |||
828 | self.strdispatchers = {} |
|
828 | self.strdispatchers = {} | |
829 |
|
829 | |||
830 | # Set all default hooks, defined in the IPython.hooks module. |
|
830 | # Set all default hooks, defined in the IPython.hooks module. | |
831 | hooks = IPython.core.hooks |
|
831 | hooks = IPython.core.hooks | |
832 | for hook_name in hooks.__all__: |
|
832 | for hook_name in hooks.__all__: | |
833 | # default hooks have priority 100, i.e. low; user hooks should have |
|
833 | # default hooks have priority 100, i.e. low; user hooks should have | |
834 | # 0-100 priority |
|
834 | # 0-100 priority | |
835 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
835 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) | |
836 |
|
836 | |||
837 | if self.display_page: |
|
837 | if self.display_page: | |
838 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
838 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) | |
839 |
|
839 | |||
840 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
840 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, | |
841 | _warn_deprecated=True): |
|
841 | _warn_deprecated=True): | |
842 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
842 | """set_hook(name,hook) -> sets an internal IPython hook. | |
843 |
|
843 | |||
844 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
844 | IPython exposes some of its internal API as user-modifiable hooks. By | |
845 | adding your function to one of these hooks, you can modify IPython's |
|
845 | adding your function to one of these hooks, you can modify IPython's | |
846 | behavior to call at runtime your own routines.""" |
|
846 | behavior to call at runtime your own routines.""" | |
847 |
|
847 | |||
848 | # At some point in the future, this should validate the hook before it |
|
848 | # At some point in the future, this should validate the hook before it | |
849 | # accepts it. Probably at least check that the hook takes the number |
|
849 | # accepts it. Probably at least check that the hook takes the number | |
850 | # of args it's supposed to. |
|
850 | # of args it's supposed to. | |
851 |
|
851 | |||
852 | f = types.MethodType(hook,self) |
|
852 | f = types.MethodType(hook,self) | |
853 |
|
853 | |||
854 | # check if the hook is for strdispatcher first |
|
854 | # check if the hook is for strdispatcher first | |
855 | if str_key is not None: |
|
855 | if str_key is not None: | |
856 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
856 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
857 | sdp.add_s(str_key, f, priority ) |
|
857 | sdp.add_s(str_key, f, priority ) | |
858 | self.strdispatchers[name] = sdp |
|
858 | self.strdispatchers[name] = sdp | |
859 | return |
|
859 | return | |
860 | if re_key is not None: |
|
860 | if re_key is not None: | |
861 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
861 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
862 | sdp.add_re(re.compile(re_key), f, priority ) |
|
862 | sdp.add_re(re.compile(re_key), f, priority ) | |
863 | self.strdispatchers[name] = sdp |
|
863 | self.strdispatchers[name] = sdp | |
864 | return |
|
864 | return | |
865 |
|
865 | |||
866 | dp = getattr(self.hooks, name, None) |
|
866 | dp = getattr(self.hooks, name, None) | |
867 | if name not in IPython.core.hooks.__all__: |
|
867 | if name not in IPython.core.hooks.__all__: | |
868 | print("Warning! Hook '%s' is not one of %s" % \ |
|
868 | print("Warning! Hook '%s' is not one of %s" % \ | |
869 | (name, IPython.core.hooks.__all__ )) |
|
869 | (name, IPython.core.hooks.__all__ )) | |
870 |
|
870 | |||
871 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
871 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): | |
872 | alternative = IPython.core.hooks.deprecated[name] |
|
872 | alternative = IPython.core.hooks.deprecated[name] | |
873 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
873 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) | |
874 |
|
874 | |||
875 | if not dp: |
|
875 | if not dp: | |
876 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
876 | dp = IPython.core.hooks.CommandChainDispatcher() | |
877 |
|
877 | |||
878 | try: |
|
878 | try: | |
879 | dp.add(f,priority) |
|
879 | dp.add(f,priority) | |
880 | except AttributeError: |
|
880 | except AttributeError: | |
881 | # it was not commandchain, plain old func - replace |
|
881 | # it was not commandchain, plain old func - replace | |
882 | dp = f |
|
882 | dp = f | |
883 |
|
883 | |||
884 | setattr(self.hooks,name, dp) |
|
884 | setattr(self.hooks,name, dp) | |
885 |
|
885 | |||
886 | #------------------------------------------------------------------------- |
|
886 | #------------------------------------------------------------------------- | |
887 | # Things related to events |
|
887 | # Things related to events | |
888 | #------------------------------------------------------------------------- |
|
888 | #------------------------------------------------------------------------- | |
889 |
|
889 | |||
890 | def init_events(self): |
|
890 | def init_events(self): | |
891 | self.events = EventManager(self, available_events) |
|
891 | self.events = EventManager(self, available_events) | |
892 |
|
892 | |||
893 | self.events.register("pre_execute", self._clear_warning_registry) |
|
893 | self.events.register("pre_execute", self._clear_warning_registry) | |
894 |
|
894 | |||
895 | def register_post_execute(self, func): |
|
895 | def register_post_execute(self, func): | |
896 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
896 | """DEPRECATED: Use ip.events.register('post_run_cell', func) | |
897 |
|
897 | |||
898 | Register a function for calling after code execution. |
|
898 | Register a function for calling after code execution. | |
899 | """ |
|
899 | """ | |
900 | warn("ip.register_post_execute is deprecated, use " |
|
900 | warn("ip.register_post_execute is deprecated, use " | |
901 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
901 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) | |
902 | self.events.register('post_run_cell', func) |
|
902 | self.events.register('post_run_cell', func) | |
903 |
|
903 | |||
904 | def _clear_warning_registry(self): |
|
904 | def _clear_warning_registry(self): | |
905 | # clear the warning registry, so that different code blocks with |
|
905 | # clear the warning registry, so that different code blocks with | |
906 | # overlapping line number ranges don't cause spurious suppression of |
|
906 | # overlapping line number ranges don't cause spurious suppression of | |
907 | # warnings (see gh-6611 for details) |
|
907 | # warnings (see gh-6611 for details) | |
908 | if "__warningregistry__" in self.user_global_ns: |
|
908 | if "__warningregistry__" in self.user_global_ns: | |
909 | del self.user_global_ns["__warningregistry__"] |
|
909 | del self.user_global_ns["__warningregistry__"] | |
910 |
|
910 | |||
911 | #------------------------------------------------------------------------- |
|
911 | #------------------------------------------------------------------------- | |
912 | # Things related to the "main" module |
|
912 | # Things related to the "main" module | |
913 | #------------------------------------------------------------------------- |
|
913 | #------------------------------------------------------------------------- | |
914 |
|
914 | |||
915 | def new_main_mod(self, filename, modname): |
|
915 | def new_main_mod(self, filename, modname): | |
916 | """Return a new 'main' module object for user code execution. |
|
916 | """Return a new 'main' module object for user code execution. | |
917 |
|
917 | |||
918 | ``filename`` should be the path of the script which will be run in the |
|
918 | ``filename`` should be the path of the script which will be run in the | |
919 | module. Requests with the same filename will get the same module, with |
|
919 | module. Requests with the same filename will get the same module, with | |
920 | its namespace cleared. |
|
920 | its namespace cleared. | |
921 |
|
921 | |||
922 | ``modname`` should be the module name - normally either '__main__' or |
|
922 | ``modname`` should be the module name - normally either '__main__' or | |
923 | the basename of the file without the extension. |
|
923 | the basename of the file without the extension. | |
924 |
|
924 | |||
925 | When scripts are executed via %run, we must keep a reference to their |
|
925 | When scripts are executed via %run, we must keep a reference to their | |
926 | __main__ module around so that Python doesn't |
|
926 | __main__ module around so that Python doesn't | |
927 | clear it, rendering references to module globals useless. |
|
927 | clear it, rendering references to module globals useless. | |
928 |
|
928 | |||
929 | This method keeps said reference in a private dict, keyed by the |
|
929 | This method keeps said reference in a private dict, keyed by the | |
930 | absolute path of the script. This way, for multiple executions of the |
|
930 | absolute path of the script. This way, for multiple executions of the | |
931 | same script we only keep one copy of the namespace (the last one), |
|
931 | same script we only keep one copy of the namespace (the last one), | |
932 | thus preventing memory leaks from old references while allowing the |
|
932 | thus preventing memory leaks from old references while allowing the | |
933 | objects from the last execution to be accessible. |
|
933 | objects from the last execution to be accessible. | |
934 | """ |
|
934 | """ | |
935 | filename = os.path.abspath(filename) |
|
935 | filename = os.path.abspath(filename) | |
936 | try: |
|
936 | try: | |
937 | main_mod = self._main_mod_cache[filename] |
|
937 | main_mod = self._main_mod_cache[filename] | |
938 | except KeyError: |
|
938 | except KeyError: | |
939 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
939 | main_mod = self._main_mod_cache[filename] = types.ModuleType( | |
940 | modname, |
|
940 | modname, | |
941 | doc="Module created for script run in IPython") |
|
941 | doc="Module created for script run in IPython") | |
942 | else: |
|
942 | else: | |
943 | main_mod.__dict__.clear() |
|
943 | main_mod.__dict__.clear() | |
944 | main_mod.__name__ = modname |
|
944 | main_mod.__name__ = modname | |
945 |
|
945 | |||
946 | main_mod.__file__ = filename |
|
946 | main_mod.__file__ = filename | |
947 | # It seems pydoc (and perhaps others) needs any module instance to |
|
947 | # It seems pydoc (and perhaps others) needs any module instance to | |
948 | # implement a __nonzero__ method |
|
948 | # implement a __nonzero__ method | |
949 | main_mod.__nonzero__ = lambda : True |
|
949 | main_mod.__nonzero__ = lambda : True | |
950 |
|
950 | |||
951 | return main_mod |
|
951 | return main_mod | |
952 |
|
952 | |||
953 | def clear_main_mod_cache(self): |
|
953 | def clear_main_mod_cache(self): | |
954 | """Clear the cache of main modules. |
|
954 | """Clear the cache of main modules. | |
955 |
|
955 | |||
956 | Mainly for use by utilities like %reset. |
|
956 | Mainly for use by utilities like %reset. | |
957 |
|
957 | |||
958 | Examples |
|
958 | Examples | |
959 | -------- |
|
959 | -------- | |
960 |
|
960 | |||
961 | In [15]: import IPython |
|
961 | In [15]: import IPython | |
962 |
|
962 | |||
963 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
963 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') | |
964 |
|
964 | |||
965 | In [17]: len(_ip._main_mod_cache) > 0 |
|
965 | In [17]: len(_ip._main_mod_cache) > 0 | |
966 | Out[17]: True |
|
966 | Out[17]: True | |
967 |
|
967 | |||
968 | In [18]: _ip.clear_main_mod_cache() |
|
968 | In [18]: _ip.clear_main_mod_cache() | |
969 |
|
969 | |||
970 | In [19]: len(_ip._main_mod_cache) == 0 |
|
970 | In [19]: len(_ip._main_mod_cache) == 0 | |
971 | Out[19]: True |
|
971 | Out[19]: True | |
972 | """ |
|
972 | """ | |
973 | self._main_mod_cache.clear() |
|
973 | self._main_mod_cache.clear() | |
974 |
|
974 | |||
975 | #------------------------------------------------------------------------- |
|
975 | #------------------------------------------------------------------------- | |
976 | # Things related to debugging |
|
976 | # Things related to debugging | |
977 | #------------------------------------------------------------------------- |
|
977 | #------------------------------------------------------------------------- | |
978 |
|
978 | |||
979 | def init_pdb(self): |
|
979 | def init_pdb(self): | |
980 | # Set calling of pdb on exceptions |
|
980 | # Set calling of pdb on exceptions | |
981 | # self.call_pdb is a property |
|
981 | # self.call_pdb is a property | |
982 | self.call_pdb = self.pdb |
|
982 | self.call_pdb = self.pdb | |
983 |
|
983 | |||
984 | def _get_call_pdb(self): |
|
984 | def _get_call_pdb(self): | |
985 | return self._call_pdb |
|
985 | return self._call_pdb | |
986 |
|
986 | |||
987 | def _set_call_pdb(self,val): |
|
987 | def _set_call_pdb(self,val): | |
988 |
|
988 | |||
989 | if val not in (0,1,False,True): |
|
989 | if val not in (0,1,False,True): | |
990 | raise ValueError('new call_pdb value must be boolean') |
|
990 | raise ValueError('new call_pdb value must be boolean') | |
991 |
|
991 | |||
992 | # store value in instance |
|
992 | # store value in instance | |
993 | self._call_pdb = val |
|
993 | self._call_pdb = val | |
994 |
|
994 | |||
995 | # notify the actual exception handlers |
|
995 | # notify the actual exception handlers | |
996 | self.InteractiveTB.call_pdb = val |
|
996 | self.InteractiveTB.call_pdb = val | |
997 |
|
997 | |||
998 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
998 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
999 | 'Control auto-activation of pdb at exceptions') |
|
999 | 'Control auto-activation of pdb at exceptions') | |
1000 |
|
1000 | |||
1001 | def debugger(self,force=False): |
|
1001 | def debugger(self,force=False): | |
1002 | """Call the pdb debugger. |
|
1002 | """Call the pdb debugger. | |
1003 |
|
1003 | |||
1004 | Keywords: |
|
1004 | Keywords: | |
1005 |
|
1005 | |||
1006 | - force(False): by default, this routine checks the instance call_pdb |
|
1006 | - force(False): by default, this routine checks the instance call_pdb | |
1007 | flag and does not actually invoke the debugger if the flag is false. |
|
1007 | flag and does not actually invoke the debugger if the flag is false. | |
1008 | The 'force' option forces the debugger to activate even if the flag |
|
1008 | The 'force' option forces the debugger to activate even if the flag | |
1009 | is false. |
|
1009 | is false. | |
1010 | """ |
|
1010 | """ | |
1011 |
|
1011 | |||
1012 | if not (force or self.call_pdb): |
|
1012 | if not (force or self.call_pdb): | |
1013 | return |
|
1013 | return | |
1014 |
|
1014 | |||
1015 | if not hasattr(sys,'last_traceback'): |
|
1015 | if not hasattr(sys,'last_traceback'): | |
1016 | error('No traceback has been produced, nothing to debug.') |
|
1016 | error('No traceback has been produced, nothing to debug.') | |
1017 | return |
|
1017 | return | |
1018 |
|
1018 | |||
1019 | self.InteractiveTB.debugger(force=True) |
|
1019 | self.InteractiveTB.debugger(force=True) | |
1020 |
|
1020 | |||
1021 | #------------------------------------------------------------------------- |
|
1021 | #------------------------------------------------------------------------- | |
1022 | # Things related to IPython's various namespaces |
|
1022 | # Things related to IPython's various namespaces | |
1023 | #------------------------------------------------------------------------- |
|
1023 | #------------------------------------------------------------------------- | |
1024 | default_user_namespaces = True |
|
1024 | default_user_namespaces = True | |
1025 |
|
1025 | |||
1026 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1026 | def init_create_namespaces(self, user_module=None, user_ns=None): | |
1027 | # Create the namespace where the user will operate. user_ns is |
|
1027 | # Create the namespace where the user will operate. user_ns is | |
1028 | # normally the only one used, and it is passed to the exec calls as |
|
1028 | # normally the only one used, and it is passed to the exec calls as | |
1029 | # the locals argument. But we do carry a user_global_ns namespace |
|
1029 | # the locals argument. But we do carry a user_global_ns namespace | |
1030 | # given as the exec 'globals' argument, This is useful in embedding |
|
1030 | # given as the exec 'globals' argument, This is useful in embedding | |
1031 | # situations where the ipython shell opens in a context where the |
|
1031 | # situations where the ipython shell opens in a context where the | |
1032 | # distinction between locals and globals is meaningful. For |
|
1032 | # distinction between locals and globals is meaningful. For | |
1033 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1033 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
1034 |
|
1034 | |||
1035 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1035 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
1036 | # level as a dict instead of a module. This is a manual fix, but I |
|
1036 | # level as a dict instead of a module. This is a manual fix, but I | |
1037 | # should really track down where the problem is coming from. Alex |
|
1037 | # should really track down where the problem is coming from. Alex | |
1038 | # Schmolck reported this problem first. |
|
1038 | # Schmolck reported this problem first. | |
1039 |
|
1039 | |||
1040 | # A useful post by Alex Martelli on this topic: |
|
1040 | # A useful post by Alex Martelli on this topic: | |
1041 | # Re: inconsistent value from __builtins__ |
|
1041 | # Re: inconsistent value from __builtins__ | |
1042 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1042 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
1043 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1043 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
1044 | # Gruppen: comp.lang.python |
|
1044 | # Gruppen: comp.lang.python | |
1045 |
|
1045 | |||
1046 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1046 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
1047 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1047 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
1048 | # > <type 'dict'> |
|
1048 | # > <type 'dict'> | |
1049 | # > >>> print type(__builtins__) |
|
1049 | # > >>> print type(__builtins__) | |
1050 | # > <type 'module'> |
|
1050 | # > <type 'module'> | |
1051 | # > Is this difference in return value intentional? |
|
1051 | # > Is this difference in return value intentional? | |
1052 |
|
1052 | |||
1053 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1053 | # Well, it's documented that '__builtins__' can be either a dictionary | |
1054 | # or a module, and it's been that way for a long time. Whether it's |
|
1054 | # or a module, and it's been that way for a long time. Whether it's | |
1055 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1055 | # intentional (or sensible), I don't know. In any case, the idea is | |
1056 | # that if you need to access the built-in namespace directly, you |
|
1056 | # that if you need to access the built-in namespace directly, you | |
1057 | # should start with "import __builtin__" (note, no 's') which will |
|
1057 | # should start with "import __builtin__" (note, no 's') which will | |
1058 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1058 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
1059 |
|
1059 | |||
1060 | # These routines return a properly built module and dict as needed by |
|
1060 | # These routines return a properly built module and dict as needed by | |
1061 | # the rest of the code, and can also be used by extension writers to |
|
1061 | # the rest of the code, and can also be used by extension writers to | |
1062 | # generate properly initialized namespaces. |
|
1062 | # generate properly initialized namespaces. | |
1063 | if (user_ns is not None) or (user_module is not None): |
|
1063 | if (user_ns is not None) or (user_module is not None): | |
1064 | self.default_user_namespaces = False |
|
1064 | self.default_user_namespaces = False | |
1065 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1065 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) | |
1066 |
|
1066 | |||
1067 | # A record of hidden variables we have added to the user namespace, so |
|
1067 | # A record of hidden variables we have added to the user namespace, so | |
1068 | # we can list later only variables defined in actual interactive use. |
|
1068 | # we can list later only variables defined in actual interactive use. | |
1069 | self.user_ns_hidden = {} |
|
1069 | self.user_ns_hidden = {} | |
1070 |
|
1070 | |||
1071 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1071 | # Now that FakeModule produces a real module, we've run into a nasty | |
1072 | # problem: after script execution (via %run), the module where the user |
|
1072 | # problem: after script execution (via %run), the module where the user | |
1073 | # code ran is deleted. Now that this object is a true module (needed |
|
1073 | # code ran is deleted. Now that this object is a true module (needed | |
1074 | # so doctest and other tools work correctly), the Python module |
|
1074 | # so doctest and other tools work correctly), the Python module | |
1075 | # teardown mechanism runs over it, and sets to None every variable |
|
1075 | # teardown mechanism runs over it, and sets to None every variable | |
1076 | # present in that module. Top-level references to objects from the |
|
1076 | # present in that module. Top-level references to objects from the | |
1077 | # script survive, because the user_ns is updated with them. However, |
|
1077 | # script survive, because the user_ns is updated with them. However, | |
1078 | # calling functions defined in the script that use other things from |
|
1078 | # calling functions defined in the script that use other things from | |
1079 | # the script will fail, because the function's closure had references |
|
1079 | # the script will fail, because the function's closure had references | |
1080 | # to the original objects, which are now all None. So we must protect |
|
1080 | # to the original objects, which are now all None. So we must protect | |
1081 | # these modules from deletion by keeping a cache. |
|
1081 | # these modules from deletion by keeping a cache. | |
1082 | # |
|
1082 | # | |
1083 | # To avoid keeping stale modules around (we only need the one from the |
|
1083 | # To avoid keeping stale modules around (we only need the one from the | |
1084 | # last run), we use a dict keyed with the full path to the script, so |
|
1084 | # last run), we use a dict keyed with the full path to the script, so | |
1085 | # only the last version of the module is held in the cache. Note, |
|
1085 | # only the last version of the module is held in the cache. Note, | |
1086 | # however, that we must cache the module *namespace contents* (their |
|
1086 | # however, that we must cache the module *namespace contents* (their | |
1087 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1087 | # __dict__). Because if we try to cache the actual modules, old ones | |
1088 | # (uncached) could be destroyed while still holding references (such as |
|
1088 | # (uncached) could be destroyed while still holding references (such as | |
1089 | # those held by GUI objects that tend to be long-lived)> |
|
1089 | # those held by GUI objects that tend to be long-lived)> | |
1090 | # |
|
1090 | # | |
1091 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1091 | # The %reset command will flush this cache. See the cache_main_mod() | |
1092 | # and clear_main_mod_cache() methods for details on use. |
|
1092 | # and clear_main_mod_cache() methods for details on use. | |
1093 |
|
1093 | |||
1094 | # This is the cache used for 'main' namespaces |
|
1094 | # This is the cache used for 'main' namespaces | |
1095 | self._main_mod_cache = {} |
|
1095 | self._main_mod_cache = {} | |
1096 |
|
1096 | |||
1097 | # A table holding all the namespaces IPython deals with, so that |
|
1097 | # A table holding all the namespaces IPython deals with, so that | |
1098 | # introspection facilities can search easily. |
|
1098 | # introspection facilities can search easily. | |
1099 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1099 | self.ns_table = {'user_global':self.user_module.__dict__, | |
1100 | 'user_local':self.user_ns, |
|
1100 | 'user_local':self.user_ns, | |
1101 | 'builtin':builtin_mod.__dict__ |
|
1101 | 'builtin':builtin_mod.__dict__ | |
1102 | } |
|
1102 | } | |
1103 |
|
1103 | |||
1104 | @property |
|
1104 | @property | |
1105 | def user_global_ns(self): |
|
1105 | def user_global_ns(self): | |
1106 | return self.user_module.__dict__ |
|
1106 | return self.user_module.__dict__ | |
1107 |
|
1107 | |||
1108 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1108 | def prepare_user_module(self, user_module=None, user_ns=None): | |
1109 | """Prepare the module and namespace in which user code will be run. |
|
1109 | """Prepare the module and namespace in which user code will be run. | |
1110 |
|
1110 | |||
1111 | When IPython is started normally, both parameters are None: a new module |
|
1111 | When IPython is started normally, both parameters are None: a new module | |
1112 | is created automatically, and its __dict__ used as the namespace. |
|
1112 | is created automatically, and its __dict__ used as the namespace. | |
1113 |
|
1113 | |||
1114 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1114 | If only user_module is provided, its __dict__ is used as the namespace. | |
1115 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1115 | If only user_ns is provided, a dummy module is created, and user_ns | |
1116 | becomes the global namespace. If both are provided (as they may be |
|
1116 | becomes the global namespace. If both are provided (as they may be | |
1117 | when embedding), user_ns is the local namespace, and user_module |
|
1117 | when embedding), user_ns is the local namespace, and user_module | |
1118 | provides the global namespace. |
|
1118 | provides the global namespace. | |
1119 |
|
1119 | |||
1120 | Parameters |
|
1120 | Parameters | |
1121 | ---------- |
|
1121 | ---------- | |
1122 | user_module : module, optional |
|
1122 | user_module : module, optional | |
1123 | The current user module in which IPython is being run. If None, |
|
1123 | The current user module in which IPython is being run. If None, | |
1124 | a clean module will be created. |
|
1124 | a clean module will be created. | |
1125 | user_ns : dict, optional |
|
1125 | user_ns : dict, optional | |
1126 | A namespace in which to run interactive commands. |
|
1126 | A namespace in which to run interactive commands. | |
1127 |
|
1127 | |||
1128 | Returns |
|
1128 | Returns | |
1129 | ------- |
|
1129 | ------- | |
1130 | A tuple of user_module and user_ns, each properly initialised. |
|
1130 | A tuple of user_module and user_ns, each properly initialised. | |
1131 | """ |
|
1131 | """ | |
1132 | if user_module is None and user_ns is not None: |
|
1132 | if user_module is None and user_ns is not None: | |
1133 | user_ns.setdefault("__name__", "__main__") |
|
1133 | user_ns.setdefault("__name__", "__main__") | |
1134 | user_module = DummyMod() |
|
1134 | user_module = DummyMod() | |
1135 | user_module.__dict__ = user_ns |
|
1135 | user_module.__dict__ = user_ns | |
1136 |
|
1136 | |||
1137 | if user_module is None: |
|
1137 | if user_module is None: | |
1138 | user_module = types.ModuleType("__main__", |
|
1138 | user_module = types.ModuleType("__main__", | |
1139 | doc="Automatically created module for IPython interactive environment") |
|
1139 | doc="Automatically created module for IPython interactive environment") | |
1140 |
|
1140 | |||
1141 | # We must ensure that __builtin__ (without the final 's') is always |
|
1141 | # We must ensure that __builtin__ (without the final 's') is always | |
1142 | # available and pointing to the __builtin__ *module*. For more details: |
|
1142 | # available and pointing to the __builtin__ *module*. For more details: | |
1143 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1143 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1144 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1144 | user_module.__dict__.setdefault('__builtin__', builtin_mod) | |
1145 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1145 | user_module.__dict__.setdefault('__builtins__', builtin_mod) | |
1146 |
|
1146 | |||
1147 | if user_ns is None: |
|
1147 | if user_ns is None: | |
1148 | user_ns = user_module.__dict__ |
|
1148 | user_ns = user_module.__dict__ | |
1149 |
|
1149 | |||
1150 | return user_module, user_ns |
|
1150 | return user_module, user_ns | |
1151 |
|
1151 | |||
1152 | def init_sys_modules(self): |
|
1152 | def init_sys_modules(self): | |
1153 | # We need to insert into sys.modules something that looks like a |
|
1153 | # We need to insert into sys.modules something that looks like a | |
1154 | # module but which accesses the IPython namespace, for shelve and |
|
1154 | # module but which accesses the IPython namespace, for shelve and | |
1155 | # pickle to work interactively. Normally they rely on getting |
|
1155 | # pickle to work interactively. Normally they rely on getting | |
1156 | # everything out of __main__, but for embedding purposes each IPython |
|
1156 | # everything out of __main__, but for embedding purposes each IPython | |
1157 | # instance has its own private namespace, so we can't go shoving |
|
1157 | # instance has its own private namespace, so we can't go shoving | |
1158 | # everything into __main__. |
|
1158 | # everything into __main__. | |
1159 |
|
1159 | |||
1160 | # note, however, that we should only do this for non-embedded |
|
1160 | # note, however, that we should only do this for non-embedded | |
1161 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1161 | # ipythons, which really mimic the __main__.__dict__ with their own | |
1162 | # namespace. Embedded instances, on the other hand, should not do |
|
1162 | # namespace. Embedded instances, on the other hand, should not do | |
1163 | # this because they need to manage the user local/global namespaces |
|
1163 | # this because they need to manage the user local/global namespaces | |
1164 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1164 | # only, but they live within a 'normal' __main__ (meaning, they | |
1165 | # shouldn't overtake the execution environment of the script they're |
|
1165 | # shouldn't overtake the execution environment of the script they're | |
1166 | # embedded in). |
|
1166 | # embedded in). | |
1167 |
|
1167 | |||
1168 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1168 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1169 | main_name = self.user_module.__name__ |
|
1169 | main_name = self.user_module.__name__ | |
1170 | sys.modules[main_name] = self.user_module |
|
1170 | sys.modules[main_name] = self.user_module | |
1171 |
|
1171 | |||
1172 | def init_user_ns(self): |
|
1172 | def init_user_ns(self): | |
1173 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1173 | """Initialize all user-visible namespaces to their minimum defaults. | |
1174 |
|
1174 | |||
1175 | Certain history lists are also initialized here, as they effectively |
|
1175 | Certain history lists are also initialized here, as they effectively | |
1176 | act as user namespaces. |
|
1176 | act as user namespaces. | |
1177 |
|
1177 | |||
1178 | Notes |
|
1178 | Notes | |
1179 | ----- |
|
1179 | ----- | |
1180 | All data structures here are only filled in, they are NOT reset by this |
|
1180 | All data structures here are only filled in, they are NOT reset by this | |
1181 | method. If they were not empty before, data will simply be added to |
|
1181 | method. If they were not empty before, data will simply be added to | |
1182 | therm. |
|
1182 | therm. | |
1183 | """ |
|
1183 | """ | |
1184 | # This function works in two parts: first we put a few things in |
|
1184 | # This function works in two parts: first we put a few things in | |
1185 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1185 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1186 | # initial variables aren't shown by %who. After the sync, we add the |
|
1186 | # initial variables aren't shown by %who. After the sync, we add the | |
1187 | # rest of what we *do* want the user to see with %who even on a new |
|
1187 | # rest of what we *do* want the user to see with %who even on a new | |
1188 | # session (probably nothing, so they really only see their own stuff) |
|
1188 | # session (probably nothing, so they really only see their own stuff) | |
1189 |
|
1189 | |||
1190 | # The user dict must *always* have a __builtin__ reference to the |
|
1190 | # The user dict must *always* have a __builtin__ reference to the | |
1191 | # Python standard __builtin__ namespace, which must be imported. |
|
1191 | # Python standard __builtin__ namespace, which must be imported. | |
1192 | # This is so that certain operations in prompt evaluation can be |
|
1192 | # This is so that certain operations in prompt evaluation can be | |
1193 | # reliably executed with builtins. Note that we can NOT use |
|
1193 | # reliably executed with builtins. Note that we can NOT use | |
1194 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1194 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1195 | # module, and can even mutate at runtime, depending on the context |
|
1195 | # module, and can even mutate at runtime, depending on the context | |
1196 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1196 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1197 | # always a module object, though it must be explicitly imported. |
|
1197 | # always a module object, though it must be explicitly imported. | |
1198 |
|
1198 | |||
1199 | # For more details: |
|
1199 | # For more details: | |
1200 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1200 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1201 | ns = {} |
|
1201 | ns = {} | |
1202 |
|
1202 | |||
1203 | # make global variables for user access to the histories |
|
1203 | # make global variables for user access to the histories | |
1204 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1204 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1205 | ns['_oh'] = self.history_manager.output_hist |
|
1205 | ns['_oh'] = self.history_manager.output_hist | |
1206 | ns['_dh'] = self.history_manager.dir_hist |
|
1206 | ns['_dh'] = self.history_manager.dir_hist | |
1207 |
|
1207 | |||
1208 | # user aliases to input and output histories. These shouldn't show up |
|
1208 | # user aliases to input and output histories. These shouldn't show up | |
1209 | # in %who, as they can have very large reprs. |
|
1209 | # in %who, as they can have very large reprs. | |
1210 | ns['In'] = self.history_manager.input_hist_parsed |
|
1210 | ns['In'] = self.history_manager.input_hist_parsed | |
1211 | ns['Out'] = self.history_manager.output_hist |
|
1211 | ns['Out'] = self.history_manager.output_hist | |
1212 |
|
1212 | |||
1213 | # Store myself as the public api!!! |
|
1213 | # Store myself as the public api!!! | |
1214 | ns['get_ipython'] = self.get_ipython |
|
1214 | ns['get_ipython'] = self.get_ipython | |
1215 |
|
1215 | |||
1216 | ns['exit'] = self.exiter |
|
1216 | ns['exit'] = self.exiter | |
1217 | ns['quit'] = self.exiter |
|
1217 | ns['quit'] = self.exiter | |
1218 |
|
1218 | |||
1219 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1219 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1220 | # by %who |
|
1220 | # by %who | |
1221 | self.user_ns_hidden.update(ns) |
|
1221 | self.user_ns_hidden.update(ns) | |
1222 |
|
1222 | |||
1223 | # Anything put into ns now would show up in %who. Think twice before |
|
1223 | # Anything put into ns now would show up in %who. Think twice before | |
1224 | # putting anything here, as we really want %who to show the user their |
|
1224 | # putting anything here, as we really want %who to show the user their | |
1225 | # stuff, not our variables. |
|
1225 | # stuff, not our variables. | |
1226 |
|
1226 | |||
1227 | # Finally, update the real user's namespace |
|
1227 | # Finally, update the real user's namespace | |
1228 | self.user_ns.update(ns) |
|
1228 | self.user_ns.update(ns) | |
1229 |
|
1229 | |||
1230 | @property |
|
1230 | @property | |
1231 | def all_ns_refs(self): |
|
1231 | def all_ns_refs(self): | |
1232 | """Get a list of references to all the namespace dictionaries in which |
|
1232 | """Get a list of references to all the namespace dictionaries in which | |
1233 | IPython might store a user-created object. |
|
1233 | IPython might store a user-created object. | |
1234 |
|
1234 | |||
1235 | Note that this does not include the displayhook, which also caches |
|
1235 | Note that this does not include the displayhook, which also caches | |
1236 | objects from the output.""" |
|
1236 | objects from the output.""" | |
1237 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1237 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ | |
1238 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1238 | [m.__dict__ for m in self._main_mod_cache.values()] | |
1239 |
|
1239 | |||
1240 | def reset(self, new_session=True): |
|
1240 | def reset(self, new_session=True): | |
1241 | """Clear all internal namespaces, and attempt to release references to |
|
1241 | """Clear all internal namespaces, and attempt to release references to | |
1242 | user objects. |
|
1242 | user objects. | |
1243 |
|
1243 | |||
1244 | If new_session is True, a new history session will be opened. |
|
1244 | If new_session is True, a new history session will be opened. | |
1245 | """ |
|
1245 | """ | |
1246 | # Clear histories |
|
1246 | # Clear histories | |
1247 | self.history_manager.reset(new_session) |
|
1247 | self.history_manager.reset(new_session) | |
1248 | # Reset counter used to index all histories |
|
1248 | # Reset counter used to index all histories | |
1249 | if new_session: |
|
1249 | if new_session: | |
1250 | self.execution_count = 1 |
|
1250 | self.execution_count = 1 | |
1251 |
|
1251 | |||
1252 | # Reset last execution result |
|
1252 | # Reset last execution result | |
1253 | self.last_execution_succeeded = True |
|
1253 | self.last_execution_succeeded = True | |
1254 | self.last_execution_result = None |
|
1254 | self.last_execution_result = None | |
1255 |
|
1255 | |||
1256 | # Flush cached output items |
|
1256 | # Flush cached output items | |
1257 | if self.displayhook.do_full_cache: |
|
1257 | if self.displayhook.do_full_cache: | |
1258 | self.displayhook.flush() |
|
1258 | self.displayhook.flush() | |
1259 |
|
1259 | |||
1260 | # The main execution namespaces must be cleared very carefully, |
|
1260 | # The main execution namespaces must be cleared very carefully, | |
1261 | # skipping the deletion of the builtin-related keys, because doing so |
|
1261 | # skipping the deletion of the builtin-related keys, because doing so | |
1262 | # would cause errors in many object's __del__ methods. |
|
1262 | # would cause errors in many object's __del__ methods. | |
1263 | if self.user_ns is not self.user_global_ns: |
|
1263 | if self.user_ns is not self.user_global_ns: | |
1264 | self.user_ns.clear() |
|
1264 | self.user_ns.clear() | |
1265 | ns = self.user_global_ns |
|
1265 | ns = self.user_global_ns | |
1266 | drop_keys = set(ns.keys()) |
|
1266 | drop_keys = set(ns.keys()) | |
1267 | drop_keys.discard('__builtin__') |
|
1267 | drop_keys.discard('__builtin__') | |
1268 | drop_keys.discard('__builtins__') |
|
1268 | drop_keys.discard('__builtins__') | |
1269 | drop_keys.discard('__name__') |
|
1269 | drop_keys.discard('__name__') | |
1270 | for k in drop_keys: |
|
1270 | for k in drop_keys: | |
1271 | del ns[k] |
|
1271 | del ns[k] | |
1272 |
|
1272 | |||
1273 | self.user_ns_hidden.clear() |
|
1273 | self.user_ns_hidden.clear() | |
1274 |
|
1274 | |||
1275 | # Restore the user namespaces to minimal usability |
|
1275 | # Restore the user namespaces to minimal usability | |
1276 | self.init_user_ns() |
|
1276 | self.init_user_ns() | |
1277 |
|
1277 | |||
1278 | # Restore the default and user aliases |
|
1278 | # Restore the default and user aliases | |
1279 | self.alias_manager.clear_aliases() |
|
1279 | self.alias_manager.clear_aliases() | |
1280 | self.alias_manager.init_aliases() |
|
1280 | self.alias_manager.init_aliases() | |
1281 |
|
1281 | |||
1282 | # Flush the private list of module references kept for script |
|
1282 | # Flush the private list of module references kept for script | |
1283 | # execution protection |
|
1283 | # execution protection | |
1284 | self.clear_main_mod_cache() |
|
1284 | self.clear_main_mod_cache() | |
1285 |
|
1285 | |||
1286 | def del_var(self, varname, by_name=False): |
|
1286 | def del_var(self, varname, by_name=False): | |
1287 | """Delete a variable from the various namespaces, so that, as |
|
1287 | """Delete a variable from the various namespaces, so that, as | |
1288 | far as possible, we're not keeping any hidden references to it. |
|
1288 | far as possible, we're not keeping any hidden references to it. | |
1289 |
|
1289 | |||
1290 | Parameters |
|
1290 | Parameters | |
1291 | ---------- |
|
1291 | ---------- | |
1292 | varname : str |
|
1292 | varname : str | |
1293 | The name of the variable to delete. |
|
1293 | The name of the variable to delete. | |
1294 | by_name : bool |
|
1294 | by_name : bool | |
1295 | If True, delete variables with the given name in each |
|
1295 | If True, delete variables with the given name in each | |
1296 | namespace. If False (default), find the variable in the user |
|
1296 | namespace. If False (default), find the variable in the user | |
1297 | namespace, and delete references to it. |
|
1297 | namespace, and delete references to it. | |
1298 | """ |
|
1298 | """ | |
1299 | if varname in ('__builtin__', '__builtins__'): |
|
1299 | if varname in ('__builtin__', '__builtins__'): | |
1300 | raise ValueError("Refusing to delete %s" % varname) |
|
1300 | raise ValueError("Refusing to delete %s" % varname) | |
1301 |
|
1301 | |||
1302 | ns_refs = self.all_ns_refs |
|
1302 | ns_refs = self.all_ns_refs | |
1303 |
|
1303 | |||
1304 | if by_name: # Delete by name |
|
1304 | if by_name: # Delete by name | |
1305 | for ns in ns_refs: |
|
1305 | for ns in ns_refs: | |
1306 | try: |
|
1306 | try: | |
1307 | del ns[varname] |
|
1307 | del ns[varname] | |
1308 | except KeyError: |
|
1308 | except KeyError: | |
1309 | pass |
|
1309 | pass | |
1310 | else: # Delete by object |
|
1310 | else: # Delete by object | |
1311 | try: |
|
1311 | try: | |
1312 | obj = self.user_ns[varname] |
|
1312 | obj = self.user_ns[varname] | |
1313 | except KeyError: |
|
1313 | except KeyError: | |
1314 | raise NameError("name '%s' is not defined" % varname) |
|
1314 | raise NameError("name '%s' is not defined" % varname) | |
1315 | # Also check in output history |
|
1315 | # Also check in output history | |
1316 | ns_refs.append(self.history_manager.output_hist) |
|
1316 | ns_refs.append(self.history_manager.output_hist) | |
1317 | for ns in ns_refs: |
|
1317 | for ns in ns_refs: | |
1318 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1318 | to_delete = [n for n, o in ns.items() if o is obj] | |
1319 | for name in to_delete: |
|
1319 | for name in to_delete: | |
1320 | del ns[name] |
|
1320 | del ns[name] | |
1321 |
|
1321 | |||
1322 | # Ensure it is removed from the last execution result |
|
1322 | # Ensure it is removed from the last execution result | |
1323 | if self.last_execution_result.result is obj: |
|
1323 | if self.last_execution_result.result is obj: | |
1324 | self.last_execution_result = None |
|
1324 | self.last_execution_result = None | |
1325 |
|
1325 | |||
1326 | # displayhook keeps extra references, but not in a dictionary |
|
1326 | # displayhook keeps extra references, but not in a dictionary | |
1327 | for name in ('_', '__', '___'): |
|
1327 | for name in ('_', '__', '___'): | |
1328 | if getattr(self.displayhook, name) is obj: |
|
1328 | if getattr(self.displayhook, name) is obj: | |
1329 | setattr(self.displayhook, name, None) |
|
1329 | setattr(self.displayhook, name, None) | |
1330 |
|
1330 | |||
1331 | def reset_selective(self, regex=None): |
|
1331 | def reset_selective(self, regex=None): | |
1332 | """Clear selective variables from internal namespaces based on a |
|
1332 | """Clear selective variables from internal namespaces based on a | |
1333 | specified regular expression. |
|
1333 | specified regular expression. | |
1334 |
|
1334 | |||
1335 | Parameters |
|
1335 | Parameters | |
1336 | ---------- |
|
1336 | ---------- | |
1337 | regex : string or compiled pattern, optional |
|
1337 | regex : string or compiled pattern, optional | |
1338 | A regular expression pattern that will be used in searching |
|
1338 | A regular expression pattern that will be used in searching | |
1339 | variable names in the users namespaces. |
|
1339 | variable names in the users namespaces. | |
1340 | """ |
|
1340 | """ | |
1341 | if regex is not None: |
|
1341 | if regex is not None: | |
1342 | try: |
|
1342 | try: | |
1343 | m = re.compile(regex) |
|
1343 | m = re.compile(regex) | |
1344 | except TypeError: |
|
1344 | except TypeError: | |
1345 | raise TypeError('regex must be a string or compiled pattern') |
|
1345 | raise TypeError('regex must be a string or compiled pattern') | |
1346 | # Search for keys in each namespace that match the given regex |
|
1346 | # Search for keys in each namespace that match the given regex | |
1347 | # If a match is found, delete the key/value pair. |
|
1347 | # If a match is found, delete the key/value pair. | |
1348 | for ns in self.all_ns_refs: |
|
1348 | for ns in self.all_ns_refs: | |
1349 | for var in ns: |
|
1349 | for var in ns: | |
1350 | if m.search(var): |
|
1350 | if m.search(var): | |
1351 | del ns[var] |
|
1351 | del ns[var] | |
1352 |
|
1352 | |||
1353 | def push(self, variables, interactive=True): |
|
1353 | def push(self, variables, interactive=True): | |
1354 | """Inject a group of variables into the IPython user namespace. |
|
1354 | """Inject a group of variables into the IPython user namespace. | |
1355 |
|
1355 | |||
1356 | Parameters |
|
1356 | Parameters | |
1357 | ---------- |
|
1357 | ---------- | |
1358 | variables : dict, str or list/tuple of str |
|
1358 | variables : dict, str or list/tuple of str | |
1359 | The variables to inject into the user's namespace. If a dict, a |
|
1359 | The variables to inject into the user's namespace. If a dict, a | |
1360 | simple update is done. If a str, the string is assumed to have |
|
1360 | simple update is done. If a str, the string is assumed to have | |
1361 | variable names separated by spaces. A list/tuple of str can also |
|
1361 | variable names separated by spaces. A list/tuple of str can also | |
1362 | be used to give the variable names. If just the variable names are |
|
1362 | be used to give the variable names. If just the variable names are | |
1363 | give (list/tuple/str) then the variable values looked up in the |
|
1363 | give (list/tuple/str) then the variable values looked up in the | |
1364 | callers frame. |
|
1364 | callers frame. | |
1365 | interactive : bool |
|
1365 | interactive : bool | |
1366 | If True (default), the variables will be listed with the ``who`` |
|
1366 | If True (default), the variables will be listed with the ``who`` | |
1367 | magic. |
|
1367 | magic. | |
1368 | """ |
|
1368 | """ | |
1369 | vdict = None |
|
1369 | vdict = None | |
1370 |
|
1370 | |||
1371 | # We need a dict of name/value pairs to do namespace updates. |
|
1371 | # We need a dict of name/value pairs to do namespace updates. | |
1372 | if isinstance(variables, dict): |
|
1372 | if isinstance(variables, dict): | |
1373 | vdict = variables |
|
1373 | vdict = variables | |
1374 | elif isinstance(variables, (str, list, tuple)): |
|
1374 | elif isinstance(variables, (str, list, tuple)): | |
1375 | if isinstance(variables, str): |
|
1375 | if isinstance(variables, str): | |
1376 | vlist = variables.split() |
|
1376 | vlist = variables.split() | |
1377 | else: |
|
1377 | else: | |
1378 | vlist = variables |
|
1378 | vlist = variables | |
1379 | vdict = {} |
|
1379 | vdict = {} | |
1380 | cf = sys._getframe(1) |
|
1380 | cf = sys._getframe(1) | |
1381 | for name in vlist: |
|
1381 | for name in vlist: | |
1382 | try: |
|
1382 | try: | |
1383 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1383 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1384 | except: |
|
1384 | except: | |
1385 | print('Could not get variable %s from %s' % |
|
1385 | print('Could not get variable %s from %s' % | |
1386 | (name,cf.f_code.co_name)) |
|
1386 | (name,cf.f_code.co_name)) | |
1387 | else: |
|
1387 | else: | |
1388 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1388 | raise ValueError('variables must be a dict/str/list/tuple') | |
1389 |
|
1389 | |||
1390 | # Propagate variables to user namespace |
|
1390 | # Propagate variables to user namespace | |
1391 | self.user_ns.update(vdict) |
|
1391 | self.user_ns.update(vdict) | |
1392 |
|
1392 | |||
1393 | # And configure interactive visibility |
|
1393 | # And configure interactive visibility | |
1394 | user_ns_hidden = self.user_ns_hidden |
|
1394 | user_ns_hidden = self.user_ns_hidden | |
1395 | if interactive: |
|
1395 | if interactive: | |
1396 | for name in vdict: |
|
1396 | for name in vdict: | |
1397 | user_ns_hidden.pop(name, None) |
|
1397 | user_ns_hidden.pop(name, None) | |
1398 | else: |
|
1398 | else: | |
1399 | user_ns_hidden.update(vdict) |
|
1399 | user_ns_hidden.update(vdict) | |
1400 |
|
1400 | |||
1401 | def drop_by_id(self, variables): |
|
1401 | def drop_by_id(self, variables): | |
1402 | """Remove a dict of variables from the user namespace, if they are the |
|
1402 | """Remove a dict of variables from the user namespace, if they are the | |
1403 | same as the values in the dictionary. |
|
1403 | same as the values in the dictionary. | |
1404 |
|
1404 | |||
1405 | This is intended for use by extensions: variables that they've added can |
|
1405 | This is intended for use by extensions: variables that they've added can | |
1406 | be taken back out if they are unloaded, without removing any that the |
|
1406 | be taken back out if they are unloaded, without removing any that the | |
1407 | user has overwritten. |
|
1407 | user has overwritten. | |
1408 |
|
1408 | |||
1409 | Parameters |
|
1409 | Parameters | |
1410 | ---------- |
|
1410 | ---------- | |
1411 | variables : dict |
|
1411 | variables : dict | |
1412 | A dictionary mapping object names (as strings) to the objects. |
|
1412 | A dictionary mapping object names (as strings) to the objects. | |
1413 | """ |
|
1413 | """ | |
1414 | for name, obj in variables.items(): |
|
1414 | for name, obj in variables.items(): | |
1415 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1415 | if name in self.user_ns and self.user_ns[name] is obj: | |
1416 | del self.user_ns[name] |
|
1416 | del self.user_ns[name] | |
1417 | self.user_ns_hidden.pop(name, None) |
|
1417 | self.user_ns_hidden.pop(name, None) | |
1418 |
|
1418 | |||
1419 | #------------------------------------------------------------------------- |
|
1419 | #------------------------------------------------------------------------- | |
1420 | # Things related to object introspection |
|
1420 | # Things related to object introspection | |
1421 | #------------------------------------------------------------------------- |
|
1421 | #------------------------------------------------------------------------- | |
1422 |
|
1422 | |||
1423 | def _ofind(self, oname, namespaces=None): |
|
1423 | def _ofind(self, oname, namespaces=None): | |
1424 | """Find an object in the available namespaces. |
|
1424 | """Find an object in the available namespaces. | |
1425 |
|
1425 | |||
1426 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1426 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1427 |
|
1427 | |||
1428 | Has special code to detect magic functions. |
|
1428 | Has special code to detect magic functions. | |
1429 | """ |
|
1429 | """ | |
1430 | oname = oname.strip() |
|
1430 | oname = oname.strip() | |
1431 | if not oname.startswith(ESC_MAGIC) and \ |
|
1431 | if not oname.startswith(ESC_MAGIC) and \ | |
1432 | not oname.startswith(ESC_MAGIC2) and \ |
|
1432 | not oname.startswith(ESC_MAGIC2) and \ | |
1433 | not all(a.isidentifier() for a in oname.split(".")): |
|
1433 | not all(a.isidentifier() for a in oname.split(".")): | |
1434 | return {'found': False} |
|
1434 | return {'found': False} | |
1435 |
|
1435 | |||
1436 | if namespaces is None: |
|
1436 | if namespaces is None: | |
1437 | # Namespaces to search in: |
|
1437 | # Namespaces to search in: | |
1438 | # Put them in a list. The order is important so that we |
|
1438 | # Put them in a list. The order is important so that we | |
1439 | # find things in the same order that Python finds them. |
|
1439 | # find things in the same order that Python finds them. | |
1440 | namespaces = [ ('Interactive', self.user_ns), |
|
1440 | namespaces = [ ('Interactive', self.user_ns), | |
1441 | ('Interactive (global)', self.user_global_ns), |
|
1441 | ('Interactive (global)', self.user_global_ns), | |
1442 | ('Python builtin', builtin_mod.__dict__), |
|
1442 | ('Python builtin', builtin_mod.__dict__), | |
1443 | ] |
|
1443 | ] | |
1444 |
|
1444 | |||
1445 | ismagic = False |
|
1445 | ismagic = False | |
1446 | isalias = False |
|
1446 | isalias = False | |
1447 | found = False |
|
1447 | found = False | |
1448 | ospace = None |
|
1448 | ospace = None | |
1449 | parent = None |
|
1449 | parent = None | |
1450 | obj = None |
|
1450 | obj = None | |
1451 |
|
1451 | |||
1452 | # Look for the given name by splitting it in parts. If the head is |
|
1452 | # Look for the given name by splitting it in parts. If the head is | |
1453 | # found, then we look for all the remaining parts as members, and only |
|
1453 | # found, then we look for all the remaining parts as members, and only | |
1454 | # declare success if we can find them all. |
|
1454 | # declare success if we can find them all. | |
1455 | oname_parts = oname.split('.') |
|
1455 | oname_parts = oname.split('.') | |
1456 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1456 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1457 | for nsname,ns in namespaces: |
|
1457 | for nsname,ns in namespaces: | |
1458 | try: |
|
1458 | try: | |
1459 | obj = ns[oname_head] |
|
1459 | obj = ns[oname_head] | |
1460 | except KeyError: |
|
1460 | except KeyError: | |
1461 | continue |
|
1461 | continue | |
1462 | else: |
|
1462 | else: | |
1463 | for idx, part in enumerate(oname_rest): |
|
1463 | for idx, part in enumerate(oname_rest): | |
1464 | try: |
|
1464 | try: | |
1465 | parent = obj |
|
1465 | parent = obj | |
1466 | # The last part is looked up in a special way to avoid |
|
1466 | # The last part is looked up in a special way to avoid | |
1467 | # descriptor invocation as it may raise or have side |
|
1467 | # descriptor invocation as it may raise or have side | |
1468 | # effects. |
|
1468 | # effects. | |
1469 | if idx == len(oname_rest) - 1: |
|
1469 | if idx == len(oname_rest) - 1: | |
1470 | obj = self._getattr_property(obj, part) |
|
1470 | obj = self._getattr_property(obj, part) | |
1471 | else: |
|
1471 | else: | |
1472 | obj = getattr(obj, part) |
|
1472 | obj = getattr(obj, part) | |
1473 | except: |
|
1473 | except: | |
1474 | # Blanket except b/c some badly implemented objects |
|
1474 | # Blanket except b/c some badly implemented objects | |
1475 | # allow __getattr__ to raise exceptions other than |
|
1475 | # allow __getattr__ to raise exceptions other than | |
1476 | # AttributeError, which then crashes IPython. |
|
1476 | # AttributeError, which then crashes IPython. | |
1477 | break |
|
1477 | break | |
1478 | else: |
|
1478 | else: | |
1479 | # If we finish the for loop (no break), we got all members |
|
1479 | # If we finish the for loop (no break), we got all members | |
1480 | found = True |
|
1480 | found = True | |
1481 | ospace = nsname |
|
1481 | ospace = nsname | |
1482 | break # namespace loop |
|
1482 | break # namespace loop | |
1483 |
|
1483 | |||
1484 | # Try to see if it's magic |
|
1484 | # Try to see if it's magic | |
1485 | if not found: |
|
1485 | if not found: | |
1486 | obj = None |
|
1486 | obj = None | |
1487 | if oname.startswith(ESC_MAGIC2): |
|
1487 | if oname.startswith(ESC_MAGIC2): | |
1488 | oname = oname.lstrip(ESC_MAGIC2) |
|
1488 | oname = oname.lstrip(ESC_MAGIC2) | |
1489 | obj = self.find_cell_magic(oname) |
|
1489 | obj = self.find_cell_magic(oname) | |
1490 | elif oname.startswith(ESC_MAGIC): |
|
1490 | elif oname.startswith(ESC_MAGIC): | |
1491 | oname = oname.lstrip(ESC_MAGIC) |
|
1491 | oname = oname.lstrip(ESC_MAGIC) | |
1492 | obj = self.find_line_magic(oname) |
|
1492 | obj = self.find_line_magic(oname) | |
1493 | else: |
|
1493 | else: | |
1494 | # search without prefix, so run? will find %run? |
|
1494 | # search without prefix, so run? will find %run? | |
1495 | obj = self.find_line_magic(oname) |
|
1495 | obj = self.find_line_magic(oname) | |
1496 | if obj is None: |
|
1496 | if obj is None: | |
1497 | obj = self.find_cell_magic(oname) |
|
1497 | obj = self.find_cell_magic(oname) | |
1498 | if obj is not None: |
|
1498 | if obj is not None: | |
1499 | found = True |
|
1499 | found = True | |
1500 | ospace = 'IPython internal' |
|
1500 | ospace = 'IPython internal' | |
1501 | ismagic = True |
|
1501 | ismagic = True | |
1502 | isalias = isinstance(obj, Alias) |
|
1502 | isalias = isinstance(obj, Alias) | |
1503 |
|
1503 | |||
1504 | # Last try: special-case some literals like '', [], {}, etc: |
|
1504 | # Last try: special-case some literals like '', [], {}, etc: | |
1505 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1505 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1506 | obj = eval(oname_head) |
|
1506 | obj = eval(oname_head) | |
1507 | found = True |
|
1507 | found = True | |
1508 | ospace = 'Interactive' |
|
1508 | ospace = 'Interactive' | |
1509 |
|
1509 | |||
1510 | return { |
|
1510 | return { | |
1511 | 'obj':obj, |
|
1511 | 'obj':obj, | |
1512 | 'found':found, |
|
1512 | 'found':found, | |
1513 | 'parent':parent, |
|
1513 | 'parent':parent, | |
1514 | 'ismagic':ismagic, |
|
1514 | 'ismagic':ismagic, | |
1515 | 'isalias':isalias, |
|
1515 | 'isalias':isalias, | |
1516 | 'namespace':ospace |
|
1516 | 'namespace':ospace | |
1517 | } |
|
1517 | } | |
1518 |
|
1518 | |||
1519 | @staticmethod |
|
1519 | @staticmethod | |
1520 | def _getattr_property(obj, attrname): |
|
1520 | def _getattr_property(obj, attrname): | |
1521 | """Property-aware getattr to use in object finding. |
|
1521 | """Property-aware getattr to use in object finding. | |
1522 |
|
1522 | |||
1523 | If attrname represents a property, return it unevaluated (in case it has |
|
1523 | If attrname represents a property, return it unevaluated (in case it has | |
1524 | side effects or raises an error. |
|
1524 | side effects or raises an error. | |
1525 |
|
1525 | |||
1526 | """ |
|
1526 | """ | |
1527 | if not isinstance(obj, type): |
|
1527 | if not isinstance(obj, type): | |
1528 | try: |
|
1528 | try: | |
1529 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1529 | # `getattr(type(obj), attrname)` is not guaranteed to return | |
1530 | # `obj`, but does so for property: |
|
1530 | # `obj`, but does so for property: | |
1531 | # |
|
1531 | # | |
1532 | # property.__get__(self, None, cls) -> self |
|
1532 | # property.__get__(self, None, cls) -> self | |
1533 | # |
|
1533 | # | |
1534 | # The universal alternative is to traverse the mro manually |
|
1534 | # The universal alternative is to traverse the mro manually | |
1535 | # searching for attrname in class dicts. |
|
1535 | # searching for attrname in class dicts. | |
1536 | attr = getattr(type(obj), attrname) |
|
1536 | attr = getattr(type(obj), attrname) | |
1537 | except AttributeError: |
|
1537 | except AttributeError: | |
1538 | pass |
|
1538 | pass | |
1539 | else: |
|
1539 | else: | |
1540 | # This relies on the fact that data descriptors (with both |
|
1540 | # This relies on the fact that data descriptors (with both | |
1541 | # __get__ & __set__ magic methods) take precedence over |
|
1541 | # __get__ & __set__ magic methods) take precedence over | |
1542 | # instance-level attributes: |
|
1542 | # instance-level attributes: | |
1543 | # |
|
1543 | # | |
1544 | # class A(object): |
|
1544 | # class A(object): | |
1545 | # @property |
|
1545 | # @property | |
1546 | # def foobar(self): return 123 |
|
1546 | # def foobar(self): return 123 | |
1547 | # a = A() |
|
1547 | # a = A() | |
1548 | # a.__dict__['foobar'] = 345 |
|
1548 | # a.__dict__['foobar'] = 345 | |
1549 | # a.foobar # == 123 |
|
1549 | # a.foobar # == 123 | |
1550 | # |
|
1550 | # | |
1551 | # So, a property may be returned right away. |
|
1551 | # So, a property may be returned right away. | |
1552 | if isinstance(attr, property): |
|
1552 | if isinstance(attr, property): | |
1553 | return attr |
|
1553 | return attr | |
1554 |
|
1554 | |||
1555 | # Nothing helped, fall back. |
|
1555 | # Nothing helped, fall back. | |
1556 | return getattr(obj, attrname) |
|
1556 | return getattr(obj, attrname) | |
1557 |
|
1557 | |||
1558 | def _object_find(self, oname, namespaces=None): |
|
1558 | def _object_find(self, oname, namespaces=None): | |
1559 | """Find an object and return a struct with info about it.""" |
|
1559 | """Find an object and return a struct with info about it.""" | |
1560 | return Struct(self._ofind(oname, namespaces)) |
|
1560 | return Struct(self._ofind(oname, namespaces)) | |
1561 |
|
1561 | |||
1562 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1562 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1563 | """Generic interface to the inspector system. |
|
1563 | """Generic interface to the inspector system. | |
1564 |
|
1564 | |||
1565 | This function is meant to be called by pdef, pdoc & friends. |
|
1565 | This function is meant to be called by pdef, pdoc & friends. | |
1566 | """ |
|
1566 | """ | |
1567 | info = self._object_find(oname, namespaces) |
|
1567 | info = self._object_find(oname, namespaces) | |
1568 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1568 | docformat = sphinxify if self.sphinxify_docstring else None | |
1569 | if info.found: |
|
1569 | if info.found: | |
1570 | pmethod = getattr(self.inspector, meth) |
|
1570 | pmethod = getattr(self.inspector, meth) | |
1571 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1571 | # TODO: only apply format_screen to the plain/text repr of the mime | |
1572 | # bundle. |
|
1572 | # bundle. | |
1573 | formatter = format_screen if info.ismagic else docformat |
|
1573 | formatter = format_screen if info.ismagic else docformat | |
1574 | if meth == 'pdoc': |
|
1574 | if meth == 'pdoc': | |
1575 | pmethod(info.obj, oname, formatter) |
|
1575 | pmethod(info.obj, oname, formatter) | |
1576 | elif meth == 'pinfo': |
|
1576 | elif meth == 'pinfo': | |
1577 | pmethod(info.obj, oname, formatter, info, |
|
1577 | pmethod(info.obj, oname, formatter, info, | |
1578 | enable_html_pager=self.enable_html_pager, **kw) |
|
1578 | enable_html_pager=self.enable_html_pager, **kw) | |
1579 | else: |
|
1579 | else: | |
1580 | pmethod(info.obj, oname) |
|
1580 | pmethod(info.obj, oname) | |
1581 | else: |
|
1581 | else: | |
1582 | print('Object `%s` not found.' % oname) |
|
1582 | print('Object `%s` not found.' % oname) | |
1583 | return 'not found' # so callers can take other action |
|
1583 | return 'not found' # so callers can take other action | |
1584 |
|
1584 | |||
1585 | def object_inspect(self, oname, detail_level=0): |
|
1585 | def object_inspect(self, oname, detail_level=0): | |
1586 | """Get object info about oname""" |
|
1586 | """Get object info about oname""" | |
1587 | with self.builtin_trap: |
|
1587 | with self.builtin_trap: | |
1588 | info = self._object_find(oname) |
|
1588 | info = self._object_find(oname) | |
1589 | if info.found: |
|
1589 | if info.found: | |
1590 | return self.inspector.info(info.obj, oname, info=info, |
|
1590 | return self.inspector.info(info.obj, oname, info=info, | |
1591 | detail_level=detail_level |
|
1591 | detail_level=detail_level | |
1592 | ) |
|
1592 | ) | |
1593 | else: |
|
1593 | else: | |
1594 | return oinspect.object_info(name=oname, found=False) |
|
1594 | return oinspect.object_info(name=oname, found=False) | |
1595 |
|
1595 | |||
1596 | def object_inspect_text(self, oname, detail_level=0): |
|
1596 | def object_inspect_text(self, oname, detail_level=0): | |
1597 | """Get object info as formatted text""" |
|
1597 | """Get object info as formatted text""" | |
1598 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1598 | return self.object_inspect_mime(oname, detail_level)['text/plain'] | |
1599 |
|
1599 | |||
1600 | def object_inspect_mime(self, oname, detail_level=0): |
|
1600 | def object_inspect_mime(self, oname, detail_level=0): | |
1601 | """Get object info as a mimebundle of formatted representations. |
|
1601 | """Get object info as a mimebundle of formatted representations. | |
1602 |
|
1602 | |||
1603 | A mimebundle is a dictionary, keyed by mime-type. |
|
1603 | A mimebundle is a dictionary, keyed by mime-type. | |
1604 | It must always have the key `'text/plain'`. |
|
1604 | It must always have the key `'text/plain'`. | |
1605 | """ |
|
1605 | """ | |
1606 | with self.builtin_trap: |
|
1606 | with self.builtin_trap: | |
1607 | info = self._object_find(oname) |
|
1607 | info = self._object_find(oname) | |
1608 | if info.found: |
|
1608 | if info.found: | |
1609 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1609 | return self.inspector._get_info(info.obj, oname, info=info, | |
1610 | detail_level=detail_level |
|
1610 | detail_level=detail_level | |
1611 | ) |
|
1611 | ) | |
1612 | else: |
|
1612 | else: | |
1613 | raise KeyError(oname) |
|
1613 | raise KeyError(oname) | |
1614 |
|
1614 | |||
1615 | #------------------------------------------------------------------------- |
|
1615 | #------------------------------------------------------------------------- | |
1616 | # Things related to history management |
|
1616 | # Things related to history management | |
1617 | #------------------------------------------------------------------------- |
|
1617 | #------------------------------------------------------------------------- | |
1618 |
|
1618 | |||
1619 | def init_history(self): |
|
1619 | def init_history(self): | |
1620 | """Sets up the command history, and starts regular autosaves.""" |
|
1620 | """Sets up the command history, and starts regular autosaves.""" | |
1621 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1621 | self.history_manager = HistoryManager(shell=self, parent=self) | |
1622 | self.configurables.append(self.history_manager) |
|
1622 | self.configurables.append(self.history_manager) | |
1623 |
|
1623 | |||
1624 | #------------------------------------------------------------------------- |
|
1624 | #------------------------------------------------------------------------- | |
1625 | # Things related to exception handling and tracebacks (not debugging) |
|
1625 | # Things related to exception handling and tracebacks (not debugging) | |
1626 | #------------------------------------------------------------------------- |
|
1626 | #------------------------------------------------------------------------- | |
1627 |
|
1627 | |||
1628 | debugger_cls = Pdb |
|
1628 | debugger_cls = Pdb | |
1629 |
|
1629 | |||
1630 | def init_traceback_handlers(self, custom_exceptions): |
|
1630 | def init_traceback_handlers(self, custom_exceptions): | |
1631 | # Syntax error handler. |
|
1631 | # Syntax error handler. | |
1632 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1632 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) | |
1633 |
|
1633 | |||
1634 | # The interactive one is initialized with an offset, meaning we always |
|
1634 | # The interactive one is initialized with an offset, meaning we always | |
1635 | # want to remove the topmost item in the traceback, which is our own |
|
1635 | # want to remove the topmost item in the traceback, which is our own | |
1636 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1636 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1637 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1637 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1638 | color_scheme='NoColor', |
|
1638 | color_scheme='NoColor', | |
1639 | tb_offset = 1, |
|
1639 | tb_offset = 1, | |
1640 | check_cache=check_linecache_ipython, |
|
1640 | check_cache=check_linecache_ipython, | |
1641 | debugger_cls=self.debugger_cls, parent=self) |
|
1641 | debugger_cls=self.debugger_cls, parent=self) | |
1642 |
|
1642 | |||
1643 | # The instance will store a pointer to the system-wide exception hook, |
|
1643 | # The instance will store a pointer to the system-wide exception hook, | |
1644 | # so that runtime code (such as magics) can access it. This is because |
|
1644 | # so that runtime code (such as magics) can access it. This is because | |
1645 | # during the read-eval loop, it may get temporarily overwritten. |
|
1645 | # during the read-eval loop, it may get temporarily overwritten. | |
1646 | self.sys_excepthook = sys.excepthook |
|
1646 | self.sys_excepthook = sys.excepthook | |
1647 |
|
1647 | |||
1648 | # and add any custom exception handlers the user may have specified |
|
1648 | # and add any custom exception handlers the user may have specified | |
1649 | self.set_custom_exc(*custom_exceptions) |
|
1649 | self.set_custom_exc(*custom_exceptions) | |
1650 |
|
1650 | |||
1651 | # Set the exception mode |
|
1651 | # Set the exception mode | |
1652 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1652 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1653 |
|
1653 | |||
1654 | def set_custom_exc(self, exc_tuple, handler): |
|
1654 | def set_custom_exc(self, exc_tuple, handler): | |
1655 | """set_custom_exc(exc_tuple, handler) |
|
1655 | """set_custom_exc(exc_tuple, handler) | |
1656 |
|
1656 | |||
1657 | Set a custom exception handler, which will be called if any of the |
|
1657 | Set a custom exception handler, which will be called if any of the | |
1658 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1658 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1659 | run_code() method). |
|
1659 | run_code() method). | |
1660 |
|
1660 | |||
1661 | Parameters |
|
1661 | Parameters | |
1662 | ---------- |
|
1662 | ---------- | |
1663 |
|
1663 | |||
1664 | exc_tuple : tuple of exception classes |
|
1664 | exc_tuple : tuple of exception classes | |
1665 | A *tuple* of exception classes, for which to call the defined |
|
1665 | A *tuple* of exception classes, for which to call the defined | |
1666 | handler. It is very important that you use a tuple, and NOT A |
|
1666 | handler. It is very important that you use a tuple, and NOT A | |
1667 | LIST here, because of the way Python's except statement works. If |
|
1667 | LIST here, because of the way Python's except statement works. If | |
1668 | you only want to trap a single exception, use a singleton tuple:: |
|
1668 | you only want to trap a single exception, use a singleton tuple:: | |
1669 |
|
1669 | |||
1670 | exc_tuple == (MyCustomException,) |
|
1670 | exc_tuple == (MyCustomException,) | |
1671 |
|
1671 | |||
1672 | handler : callable |
|
1672 | handler : callable | |
1673 | handler must have the following signature:: |
|
1673 | handler must have the following signature:: | |
1674 |
|
1674 | |||
1675 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1675 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1676 | ... |
|
1676 | ... | |
1677 | return structured_traceback |
|
1677 | return structured_traceback | |
1678 |
|
1678 | |||
1679 | Your handler must return a structured traceback (a list of strings), |
|
1679 | Your handler must return a structured traceback (a list of strings), | |
1680 | or None. |
|
1680 | or None. | |
1681 |
|
1681 | |||
1682 | This will be made into an instance method (via types.MethodType) |
|
1682 | This will be made into an instance method (via types.MethodType) | |
1683 | of IPython itself, and it will be called if any of the exceptions |
|
1683 | of IPython itself, and it will be called if any of the exceptions | |
1684 | listed in the exc_tuple are caught. If the handler is None, an |
|
1684 | listed in the exc_tuple are caught. If the handler is None, an | |
1685 | internal basic one is used, which just prints basic info. |
|
1685 | internal basic one is used, which just prints basic info. | |
1686 |
|
1686 | |||
1687 | To protect IPython from crashes, if your handler ever raises an |
|
1687 | To protect IPython from crashes, if your handler ever raises an | |
1688 | exception or returns an invalid result, it will be immediately |
|
1688 | exception or returns an invalid result, it will be immediately | |
1689 | disabled. |
|
1689 | disabled. | |
1690 |
|
1690 | |||
1691 | WARNING: by putting in your own exception handler into IPython's main |
|
1691 | WARNING: by putting in your own exception handler into IPython's main | |
1692 | execution loop, you run a very good chance of nasty crashes. This |
|
1692 | execution loop, you run a very good chance of nasty crashes. This | |
1693 | facility should only be used if you really know what you are doing.""" |
|
1693 | facility should only be used if you really know what you are doing.""" | |
1694 | if not isinstance(exc_tuple, tuple): |
|
1694 | if not isinstance(exc_tuple, tuple): | |
1695 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1695 | raise TypeError("The custom exceptions must be given as a tuple.") | |
1696 |
|
1696 | |||
1697 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1697 | def dummy_handler(self, etype, value, tb, tb_offset=None): | |
1698 | print('*** Simple custom exception handler ***') |
|
1698 | print('*** Simple custom exception handler ***') | |
1699 | print('Exception type :', etype) |
|
1699 | print('Exception type :', etype) | |
1700 | print('Exception value:', value) |
|
1700 | print('Exception value:', value) | |
1701 | print('Traceback :', tb) |
|
1701 | print('Traceback :', tb) | |
1702 |
|
1702 | |||
1703 | def validate_stb(stb): |
|
1703 | def validate_stb(stb): | |
1704 | """validate structured traceback return type |
|
1704 | """validate structured traceback return type | |
1705 |
|
1705 | |||
1706 | return type of CustomTB *should* be a list of strings, but allow |
|
1706 | return type of CustomTB *should* be a list of strings, but allow | |
1707 | single strings or None, which are harmless. |
|
1707 | single strings or None, which are harmless. | |
1708 |
|
1708 | |||
1709 | This function will *always* return a list of strings, |
|
1709 | This function will *always* return a list of strings, | |
1710 | and will raise a TypeError if stb is inappropriate. |
|
1710 | and will raise a TypeError if stb is inappropriate. | |
1711 | """ |
|
1711 | """ | |
1712 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1712 | msg = "CustomTB must return list of strings, not %r" % stb | |
1713 | if stb is None: |
|
1713 | if stb is None: | |
1714 | return [] |
|
1714 | return [] | |
1715 | elif isinstance(stb, str): |
|
1715 | elif isinstance(stb, str): | |
1716 | return [stb] |
|
1716 | return [stb] | |
1717 | elif not isinstance(stb, list): |
|
1717 | elif not isinstance(stb, list): | |
1718 | raise TypeError(msg) |
|
1718 | raise TypeError(msg) | |
1719 | # it's a list |
|
1719 | # it's a list | |
1720 | for line in stb: |
|
1720 | for line in stb: | |
1721 | # check every element |
|
1721 | # check every element | |
1722 | if not isinstance(line, str): |
|
1722 | if not isinstance(line, str): | |
1723 | raise TypeError(msg) |
|
1723 | raise TypeError(msg) | |
1724 | return stb |
|
1724 | return stb | |
1725 |
|
1725 | |||
1726 | if handler is None: |
|
1726 | if handler is None: | |
1727 | wrapped = dummy_handler |
|
1727 | wrapped = dummy_handler | |
1728 | else: |
|
1728 | else: | |
1729 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1729 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1730 | """wrap CustomTB handler, to protect IPython from user code |
|
1730 | """wrap CustomTB handler, to protect IPython from user code | |
1731 |
|
1731 | |||
1732 | This makes it harder (but not impossible) for custom exception |
|
1732 | This makes it harder (but not impossible) for custom exception | |
1733 | handlers to crash IPython. |
|
1733 | handlers to crash IPython. | |
1734 | """ |
|
1734 | """ | |
1735 | try: |
|
1735 | try: | |
1736 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1736 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1737 | return validate_stb(stb) |
|
1737 | return validate_stb(stb) | |
1738 | except: |
|
1738 | except: | |
1739 | # clear custom handler immediately |
|
1739 | # clear custom handler immediately | |
1740 | self.set_custom_exc((), None) |
|
1740 | self.set_custom_exc((), None) | |
1741 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1741 | print("Custom TB Handler failed, unregistering", file=sys.stderr) | |
1742 | # show the exception in handler first |
|
1742 | # show the exception in handler first | |
1743 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1743 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1744 | print(self.InteractiveTB.stb2text(stb)) |
|
1744 | print(self.InteractiveTB.stb2text(stb)) | |
1745 | print("The original exception:") |
|
1745 | print("The original exception:") | |
1746 | stb = self.InteractiveTB.structured_traceback( |
|
1746 | stb = self.InteractiveTB.structured_traceback( | |
1747 | (etype,value,tb), tb_offset=tb_offset |
|
1747 | (etype,value,tb), tb_offset=tb_offset | |
1748 | ) |
|
1748 | ) | |
1749 | return stb |
|
1749 | return stb | |
1750 |
|
1750 | |||
1751 | self.CustomTB = types.MethodType(wrapped,self) |
|
1751 | self.CustomTB = types.MethodType(wrapped,self) | |
1752 | self.custom_exceptions = exc_tuple |
|
1752 | self.custom_exceptions = exc_tuple | |
1753 |
|
1753 | |||
1754 | def excepthook(self, etype, value, tb): |
|
1754 | def excepthook(self, etype, value, tb): | |
1755 | """One more defense for GUI apps that call sys.excepthook. |
|
1755 | """One more defense for GUI apps that call sys.excepthook. | |
1756 |
|
1756 | |||
1757 | GUI frameworks like wxPython trap exceptions and call |
|
1757 | GUI frameworks like wxPython trap exceptions and call | |
1758 | sys.excepthook themselves. I guess this is a feature that |
|
1758 | sys.excepthook themselves. I guess this is a feature that | |
1759 | enables them to keep running after exceptions that would |
|
1759 | enables them to keep running after exceptions that would | |
1760 | otherwise kill their mainloop. This is a bother for IPython |
|
1760 | otherwise kill their mainloop. This is a bother for IPython | |
1761 | which excepts to catch all of the program exceptions with a try: |
|
1761 | which excepts to catch all of the program exceptions with a try: | |
1762 | except: statement. |
|
1762 | except: statement. | |
1763 |
|
1763 | |||
1764 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1764 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1765 | any app directly invokes sys.excepthook, it will look to the user like |
|
1765 | any app directly invokes sys.excepthook, it will look to the user like | |
1766 | IPython crashed. In order to work around this, we can disable the |
|
1766 | IPython crashed. In order to work around this, we can disable the | |
1767 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1767 | CrashHandler and replace it with this excepthook instead, which prints a | |
1768 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1768 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1769 | call sys.excepthook will generate a regular-looking exception from |
|
1769 | call sys.excepthook will generate a regular-looking exception from | |
1770 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1770 | IPython, and the CrashHandler will only be triggered by real IPython | |
1771 | crashes. |
|
1771 | crashes. | |
1772 |
|
1772 | |||
1773 | This hook should be used sparingly, only in places which are not likely |
|
1773 | This hook should be used sparingly, only in places which are not likely | |
1774 | to be true IPython errors. |
|
1774 | to be true IPython errors. | |
1775 | """ |
|
1775 | """ | |
1776 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1776 | self.showtraceback((etype, value, tb), tb_offset=0) | |
1777 |
|
1777 | |||
1778 | def _get_exc_info(self, exc_tuple=None): |
|
1778 | def _get_exc_info(self, exc_tuple=None): | |
1779 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1779 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. | |
1780 |
|
1780 | |||
1781 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1781 | Ensures sys.last_type,value,traceback hold the exc_info we found, | |
1782 | from whichever source. |
|
1782 | from whichever source. | |
1783 |
|
1783 | |||
1784 | raises ValueError if none of these contain any information |
|
1784 | raises ValueError if none of these contain any information | |
1785 | """ |
|
1785 | """ | |
1786 | if exc_tuple is None: |
|
1786 | if exc_tuple is None: | |
1787 | etype, value, tb = sys.exc_info() |
|
1787 | etype, value, tb = sys.exc_info() | |
1788 | else: |
|
1788 | else: | |
1789 | etype, value, tb = exc_tuple |
|
1789 | etype, value, tb = exc_tuple | |
1790 |
|
1790 | |||
1791 | if etype is None: |
|
1791 | if etype is None: | |
1792 | if hasattr(sys, 'last_type'): |
|
1792 | if hasattr(sys, 'last_type'): | |
1793 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1793 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1794 | sys.last_traceback |
|
1794 | sys.last_traceback | |
1795 |
|
1795 | |||
1796 | if etype is None: |
|
1796 | if etype is None: | |
1797 | raise ValueError("No exception to find") |
|
1797 | raise ValueError("No exception to find") | |
1798 |
|
1798 | |||
1799 | # Now store the exception info in sys.last_type etc. |
|
1799 | # Now store the exception info in sys.last_type etc. | |
1800 | # WARNING: these variables are somewhat deprecated and not |
|
1800 | # WARNING: these variables are somewhat deprecated and not | |
1801 | # necessarily safe to use in a threaded environment, but tools |
|
1801 | # necessarily safe to use in a threaded environment, but tools | |
1802 | # like pdb depend on their existence, so let's set them. If we |
|
1802 | # like pdb depend on their existence, so let's set them. If we | |
1803 | # find problems in the field, we'll need to revisit their use. |
|
1803 | # find problems in the field, we'll need to revisit their use. | |
1804 | sys.last_type = etype |
|
1804 | sys.last_type = etype | |
1805 | sys.last_value = value |
|
1805 | sys.last_value = value | |
1806 | sys.last_traceback = tb |
|
1806 | sys.last_traceback = tb | |
1807 |
|
1807 | |||
1808 | return etype, value, tb |
|
1808 | return etype, value, tb | |
1809 |
|
1809 | |||
1810 | def show_usage_error(self, exc): |
|
1810 | def show_usage_error(self, exc): | |
1811 | """Show a short message for UsageErrors |
|
1811 | """Show a short message for UsageErrors | |
1812 |
|
1812 | |||
1813 | These are special exceptions that shouldn't show a traceback. |
|
1813 | These are special exceptions that shouldn't show a traceback. | |
1814 | """ |
|
1814 | """ | |
1815 | print("UsageError: %s" % exc, file=sys.stderr) |
|
1815 | print("UsageError: %s" % exc, file=sys.stderr) | |
1816 |
|
1816 | |||
1817 | def get_exception_only(self, exc_tuple=None): |
|
1817 | def get_exception_only(self, exc_tuple=None): | |
1818 | """ |
|
1818 | """ | |
1819 | Return as a string (ending with a newline) the exception that |
|
1819 | Return as a string (ending with a newline) the exception that | |
1820 | just occurred, without any traceback. |
|
1820 | just occurred, without any traceback. | |
1821 | """ |
|
1821 | """ | |
1822 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1822 | etype, value, tb = self._get_exc_info(exc_tuple) | |
1823 | msg = traceback.format_exception_only(etype, value) |
|
1823 | msg = traceback.format_exception_only(etype, value) | |
1824 | return ''.join(msg) |
|
1824 | return ''.join(msg) | |
1825 |
|
1825 | |||
1826 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
1826 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, | |
1827 | exception_only=False, running_compiled_code=False): |
|
1827 | exception_only=False, running_compiled_code=False): | |
1828 | """Display the exception that just occurred. |
|
1828 | """Display the exception that just occurred. | |
1829 |
|
1829 | |||
1830 | If nothing is known about the exception, this is the method which |
|
1830 | If nothing is known about the exception, this is the method which | |
1831 | should be used throughout the code for presenting user tracebacks, |
|
1831 | should be used throughout the code for presenting user tracebacks, | |
1832 | rather than directly invoking the InteractiveTB object. |
|
1832 | rather than directly invoking the InteractiveTB object. | |
1833 |
|
1833 | |||
1834 | A specific showsyntaxerror() also exists, but this method can take |
|
1834 | A specific showsyntaxerror() also exists, but this method can take | |
1835 | care of calling it if needed, so unless you are explicitly catching a |
|
1835 | care of calling it if needed, so unless you are explicitly catching a | |
1836 | SyntaxError exception, don't try to analyze the stack manually and |
|
1836 | SyntaxError exception, don't try to analyze the stack manually and | |
1837 | simply call this method.""" |
|
1837 | simply call this method.""" | |
1838 |
|
1838 | |||
1839 | try: |
|
1839 | try: | |
1840 | try: |
|
1840 | try: | |
1841 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1841 | etype, value, tb = self._get_exc_info(exc_tuple) | |
1842 | except ValueError: |
|
1842 | except ValueError: | |
1843 | print('No traceback available to show.', file=sys.stderr) |
|
1843 | print('No traceback available to show.', file=sys.stderr) | |
1844 | return |
|
1844 | return | |
1845 |
|
1845 | |||
1846 | if issubclass(etype, SyntaxError): |
|
1846 | if issubclass(etype, SyntaxError): | |
1847 | # Though this won't be called by syntax errors in the input |
|
1847 | # Though this won't be called by syntax errors in the input | |
1848 | # line, there may be SyntaxError cases with imported code. |
|
1848 | # line, there may be SyntaxError cases with imported code. | |
1849 | self.showsyntaxerror(filename, running_compiled_code) |
|
1849 | self.showsyntaxerror(filename, running_compiled_code) | |
1850 | elif etype is UsageError: |
|
1850 | elif etype is UsageError: | |
1851 | self.show_usage_error(value) |
|
1851 | self.show_usage_error(value) | |
1852 | else: |
|
1852 | else: | |
1853 | if exception_only: |
|
1853 | if exception_only: | |
1854 | stb = ['An exception has occurred, use %tb to see ' |
|
1854 | stb = ['An exception has occurred, use %tb to see ' | |
1855 | 'the full traceback.\n'] |
|
1855 | 'the full traceback.\n'] | |
1856 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1856 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1857 | value)) |
|
1857 | value)) | |
1858 | else: |
|
1858 | else: | |
1859 | try: |
|
1859 | try: | |
1860 | # Exception classes can customise their traceback - we |
|
1860 | # Exception classes can customise their traceback - we | |
1861 | # use this in IPython.parallel for exceptions occurring |
|
1861 | # use this in IPython.parallel for exceptions occurring | |
1862 | # in the engines. This should return a list of strings. |
|
1862 | # in the engines. This should return a list of strings. | |
1863 | stb = value._render_traceback_() |
|
1863 | stb = value._render_traceback_() | |
1864 | except Exception: |
|
1864 | except Exception: | |
1865 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1865 | stb = self.InteractiveTB.structured_traceback(etype, | |
1866 | value, tb, tb_offset=tb_offset) |
|
1866 | value, tb, tb_offset=tb_offset) | |
1867 |
|
1867 | |||
1868 | self._showtraceback(etype, value, stb) |
|
1868 | self._showtraceback(etype, value, stb) | |
1869 | if self.call_pdb: |
|
1869 | if self.call_pdb: | |
1870 | # drop into debugger |
|
1870 | # drop into debugger | |
1871 | self.debugger(force=True) |
|
1871 | self.debugger(force=True) | |
1872 | return |
|
1872 | return | |
1873 |
|
1873 | |||
1874 | # Actually show the traceback |
|
1874 | # Actually show the traceback | |
1875 | self._showtraceback(etype, value, stb) |
|
1875 | self._showtraceback(etype, value, stb) | |
1876 |
|
1876 | |||
1877 | except KeyboardInterrupt: |
|
1877 | except KeyboardInterrupt: | |
1878 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
1878 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
1879 |
|
1879 | |||
1880 | def _showtraceback(self, etype, evalue, stb): |
|
1880 | def _showtraceback(self, etype, evalue, stb): | |
1881 | """Actually show a traceback. |
|
1881 | """Actually show a traceback. | |
1882 |
|
1882 | |||
1883 | Subclasses may override this method to put the traceback on a different |
|
1883 | Subclasses may override this method to put the traceback on a different | |
1884 | place, like a side channel. |
|
1884 | place, like a side channel. | |
1885 | """ |
|
1885 | """ | |
1886 | print(self.InteractiveTB.stb2text(stb)) |
|
1886 | print(self.InteractiveTB.stb2text(stb)) | |
1887 |
|
1887 | |||
1888 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
1888 | def showsyntaxerror(self, filename=None, running_compiled_code=False): | |
1889 | """Display the syntax error that just occurred. |
|
1889 | """Display the syntax error that just occurred. | |
1890 |
|
1890 | |||
1891 | This doesn't display a stack trace because there isn't one. |
|
1891 | This doesn't display a stack trace because there isn't one. | |
1892 |
|
1892 | |||
1893 | If a filename is given, it is stuffed in the exception instead |
|
1893 | If a filename is given, it is stuffed in the exception instead | |
1894 | of what was there before (because Python's parser always uses |
|
1894 | of what was there before (because Python's parser always uses | |
1895 | "<string>" when reading from a string). |
|
1895 | "<string>" when reading from a string). | |
1896 |
|
1896 | |||
1897 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
1897 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), | |
1898 | longer stack trace will be displayed. |
|
1898 | longer stack trace will be displayed. | |
1899 | """ |
|
1899 | """ | |
1900 | etype, value, last_traceback = self._get_exc_info() |
|
1900 | etype, value, last_traceback = self._get_exc_info() | |
1901 |
|
1901 | |||
1902 | if filename and issubclass(etype, SyntaxError): |
|
1902 | if filename and issubclass(etype, SyntaxError): | |
1903 | try: |
|
1903 | try: | |
1904 | value.filename = filename |
|
1904 | value.filename = filename | |
1905 | except: |
|
1905 | except: | |
1906 | # Not the format we expect; leave it alone |
|
1906 | # Not the format we expect; leave it alone | |
1907 | pass |
|
1907 | pass | |
1908 |
|
1908 | |||
1909 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
1909 | # If the error occurred when executing compiled code, we should provide full stacktrace. | |
1910 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
1910 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] | |
1911 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
1911 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) | |
1912 | self._showtraceback(etype, value, stb) |
|
1912 | self._showtraceback(etype, value, stb) | |
1913 |
|
1913 | |||
1914 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1914 | # This is overridden in TerminalInteractiveShell to show a message about | |
1915 | # the %paste magic. |
|
1915 | # the %paste magic. | |
1916 | def showindentationerror(self): |
|
1916 | def showindentationerror(self): | |
1917 | """Called by _run_cell when there's an IndentationError in code entered |
|
1917 | """Called by _run_cell when there's an IndentationError in code entered | |
1918 | at the prompt. |
|
1918 | at the prompt. | |
1919 |
|
1919 | |||
1920 | This is overridden in TerminalInteractiveShell to show a message about |
|
1920 | This is overridden in TerminalInteractiveShell to show a message about | |
1921 | the %paste magic.""" |
|
1921 | the %paste magic.""" | |
1922 | self.showsyntaxerror() |
|
1922 | self.showsyntaxerror() | |
1923 |
|
1923 | |||
1924 | #------------------------------------------------------------------------- |
|
1924 | #------------------------------------------------------------------------- | |
1925 | # Things related to readline |
|
1925 | # Things related to readline | |
1926 | #------------------------------------------------------------------------- |
|
1926 | #------------------------------------------------------------------------- | |
1927 |
|
1927 | |||
1928 | def init_readline(self): |
|
1928 | def init_readline(self): | |
1929 | """DEPRECATED |
|
1929 | """DEPRECATED | |
1930 |
|
1930 | |||
1931 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
1931 | Moved to terminal subclass, here only to simplify the init logic.""" | |
1932 | # Set a number of methods that depend on readline to be no-op |
|
1932 | # Set a number of methods that depend on readline to be no-op | |
1933 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
1933 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', | |
1934 | DeprecationWarning, stacklevel=2) |
|
1934 | DeprecationWarning, stacklevel=2) | |
1935 | self.set_custom_completer = no_op |
|
1935 | self.set_custom_completer = no_op | |
1936 |
|
1936 | |||
1937 | @skip_doctest |
|
1937 | @skip_doctest | |
1938 | def set_next_input(self, s, replace=False): |
|
1938 | def set_next_input(self, s, replace=False): | |
1939 | """ Sets the 'default' input string for the next command line. |
|
1939 | """ Sets the 'default' input string for the next command line. | |
1940 |
|
1940 | |||
1941 | Example:: |
|
1941 | Example:: | |
1942 |
|
1942 | |||
1943 | In [1]: _ip.set_next_input("Hello Word") |
|
1943 | In [1]: _ip.set_next_input("Hello Word") | |
1944 | In [2]: Hello Word_ # cursor is here |
|
1944 | In [2]: Hello Word_ # cursor is here | |
1945 | """ |
|
1945 | """ | |
1946 | self.rl_next_input = s |
|
1946 | self.rl_next_input = s | |
1947 |
|
1947 | |||
1948 | def _indent_current_str(self): |
|
1948 | def _indent_current_str(self): | |
1949 | """return the current level of indentation as a string""" |
|
1949 | """return the current level of indentation as a string""" | |
1950 | return self.input_splitter.get_indent_spaces() * ' ' |
|
1950 | return self.input_splitter.get_indent_spaces() * ' ' | |
1951 |
|
1951 | |||
1952 | #------------------------------------------------------------------------- |
|
1952 | #------------------------------------------------------------------------- | |
1953 | # Things related to text completion |
|
1953 | # Things related to text completion | |
1954 | #------------------------------------------------------------------------- |
|
1954 | #------------------------------------------------------------------------- | |
1955 |
|
1955 | |||
1956 | def init_completer(self): |
|
1956 | def init_completer(self): | |
1957 | """Initialize the completion machinery. |
|
1957 | """Initialize the completion machinery. | |
1958 |
|
1958 | |||
1959 | This creates completion machinery that can be used by client code, |
|
1959 | This creates completion machinery that can be used by client code, | |
1960 | either interactively in-process (typically triggered by the readline |
|
1960 | either interactively in-process (typically triggered by the readline | |
1961 | library), programmatically (such as in test suites) or out-of-process |
|
1961 | library), programmatically (such as in test suites) or out-of-process | |
1962 | (typically over the network by remote frontends). |
|
1962 | (typically over the network by remote frontends). | |
1963 | """ |
|
1963 | """ | |
1964 | from IPython.core.completer import IPCompleter |
|
1964 | from IPython.core.completer import IPCompleter | |
1965 | from IPython.core.completerlib import (module_completer, |
|
1965 | from IPython.core.completerlib import (module_completer, | |
1966 | magic_run_completer, cd_completer, reset_completer) |
|
1966 | magic_run_completer, cd_completer, reset_completer) | |
1967 |
|
1967 | |||
1968 | self.Completer = IPCompleter(shell=self, |
|
1968 | self.Completer = IPCompleter(shell=self, | |
1969 | namespace=self.user_ns, |
|
1969 | namespace=self.user_ns, | |
1970 | global_namespace=self.user_global_ns, |
|
1970 | global_namespace=self.user_global_ns, | |
1971 | parent=self, |
|
1971 | parent=self, | |
1972 | ) |
|
1972 | ) | |
1973 | self.configurables.append(self.Completer) |
|
1973 | self.configurables.append(self.Completer) | |
1974 |
|
1974 | |||
1975 | # Add custom completers to the basic ones built into IPCompleter |
|
1975 | # Add custom completers to the basic ones built into IPCompleter | |
1976 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1976 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
1977 | self.strdispatchers['complete_command'] = sdisp |
|
1977 | self.strdispatchers['complete_command'] = sdisp | |
1978 | self.Completer.custom_completers = sdisp |
|
1978 | self.Completer.custom_completers = sdisp | |
1979 |
|
1979 | |||
1980 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1980 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
1981 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1981 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
1982 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
1982 | self.set_hook('complete_command', module_completer, str_key = '%aimport') | |
1983 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1983 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
1984 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1984 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
1985 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
1985 | self.set_hook('complete_command', reset_completer, str_key = '%reset') | |
1986 |
|
1986 | |||
1987 |
|
1987 | |||
|
1988 | @skip_doctest | |||
1988 | def complete(self, text, line=None, cursor_pos=None): |
|
1989 | def complete(self, text, line=None, cursor_pos=None): | |
1989 | """Return the completed text and a list of completions. |
|
1990 | """Return the completed text and a list of completions. | |
1990 |
|
1991 | |||
1991 | Parameters |
|
1992 | Parameters | |
1992 | ---------- |
|
1993 | ---------- | |
1993 |
|
1994 | |||
1994 | text : string |
|
1995 | text : string | |
1995 | A string of text to be completed on. It can be given as empty and |
|
1996 | A string of text to be completed on. It can be given as empty and | |
1996 | instead a line/position pair are given. In this case, the |
|
1997 | instead a line/position pair are given. In this case, the | |
1997 | completer itself will split the line like readline does. |
|
1998 | completer itself will split the line like readline does. | |
1998 |
|
1999 | |||
1999 | line : string, optional |
|
2000 | line : string, optional | |
2000 | The complete line that text is part of. |
|
2001 | The complete line that text is part of. | |
2001 |
|
2002 | |||
2002 | cursor_pos : int, optional |
|
2003 | cursor_pos : int, optional | |
2003 | The position of the cursor on the input line. |
|
2004 | The position of the cursor on the input line. | |
2004 |
|
2005 | |||
2005 | Returns |
|
2006 | Returns | |
2006 | ------- |
|
2007 | ------- | |
2007 | text : string |
|
2008 | text : string | |
2008 | The actual text that was completed. |
|
2009 | The actual text that was completed. | |
2009 |
|
2010 | |||
2010 | matches : list |
|
2011 | matches : list | |
2011 | A sorted list with all possible completions. |
|
2012 | A sorted list with all possible completions. | |
2012 |
|
2013 | |||
2013 | The optional arguments allow the completion to take more context into |
|
2014 | The optional arguments allow the completion to take more context into | |
2014 | account, and are part of the low-level completion API. |
|
2015 | account, and are part of the low-level completion API. | |
2015 |
|
2016 | |||
2016 | This is a wrapper around the completion mechanism, similar to what |
|
2017 | This is a wrapper around the completion mechanism, similar to what | |
2017 | readline does at the command line when the TAB key is hit. By |
|
2018 | readline does at the command line when the TAB key is hit. By | |
2018 | exposing it as a method, it can be used by other non-readline |
|
2019 | exposing it as a method, it can be used by other non-readline | |
2019 | environments (such as GUIs) for text completion. |
|
2020 | environments (such as GUIs) for text completion. | |
2020 |
|
2021 | |||
2021 | Simple usage example: |
|
2022 | Simple usage example: | |
2022 |
|
2023 | |||
2023 | In [1]: x = 'hello' |
|
2024 | In [1]: x = 'hello' | |
2024 |
|
2025 | |||
2025 | In [2]: _ip.complete('x.l') |
|
2026 | In [2]: _ip.complete('x.l') | |
2026 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2027 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
2027 | """ |
|
2028 | """ | |
2028 |
|
2029 | |||
2029 | # Inject names into __builtin__ so we can complete on the added names. |
|
2030 | # Inject names into __builtin__ so we can complete on the added names. | |
2030 | with self.builtin_trap: |
|
2031 | with self.builtin_trap: | |
2031 | return self.Completer.complete(text, line, cursor_pos) |
|
2032 | return self.Completer.complete(text, line, cursor_pos) | |
2032 |
|
2033 | |||
2033 | def set_custom_completer(self, completer, pos=0): |
|
2034 | def set_custom_completer(self, completer, pos=0): | |
2034 | """Adds a new custom completer function. |
|
2035 | """Adds a new custom completer function. | |
2035 |
|
2036 | |||
2036 | The position argument (defaults to 0) is the index in the completers |
|
2037 | The position argument (defaults to 0) is the index in the completers | |
2037 | list where you want the completer to be inserted.""" |
|
2038 | list where you want the completer to be inserted.""" | |
2038 |
|
2039 | |||
2039 | newcomp = types.MethodType(completer,self.Completer) |
|
2040 | newcomp = types.MethodType(completer,self.Completer) | |
2040 | self.Completer.matchers.insert(pos,newcomp) |
|
2041 | self.Completer.matchers.insert(pos,newcomp) | |
2041 |
|
2042 | |||
2042 | def set_completer_frame(self, frame=None): |
|
2043 | def set_completer_frame(self, frame=None): | |
2043 | """Set the frame of the completer.""" |
|
2044 | """Set the frame of the completer.""" | |
2044 | if frame: |
|
2045 | if frame: | |
2045 | self.Completer.namespace = frame.f_locals |
|
2046 | self.Completer.namespace = frame.f_locals | |
2046 | self.Completer.global_namespace = frame.f_globals |
|
2047 | self.Completer.global_namespace = frame.f_globals | |
2047 | else: |
|
2048 | else: | |
2048 | self.Completer.namespace = self.user_ns |
|
2049 | self.Completer.namespace = self.user_ns | |
2049 | self.Completer.global_namespace = self.user_global_ns |
|
2050 | self.Completer.global_namespace = self.user_global_ns | |
2050 |
|
2051 | |||
2051 | #------------------------------------------------------------------------- |
|
2052 | #------------------------------------------------------------------------- | |
2052 | # Things related to magics |
|
2053 | # Things related to magics | |
2053 | #------------------------------------------------------------------------- |
|
2054 | #------------------------------------------------------------------------- | |
2054 |
|
2055 | |||
2055 | def init_magics(self): |
|
2056 | def init_magics(self): | |
2056 | from IPython.core import magics as m |
|
2057 | from IPython.core import magics as m | |
2057 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2058 | self.magics_manager = magic.MagicsManager(shell=self, | |
2058 | parent=self, |
|
2059 | parent=self, | |
2059 | user_magics=m.UserMagics(self)) |
|
2060 | user_magics=m.UserMagics(self)) | |
2060 | self.configurables.append(self.magics_manager) |
|
2061 | self.configurables.append(self.magics_manager) | |
2061 |
|
2062 | |||
2062 | # Expose as public API from the magics manager |
|
2063 | # Expose as public API from the magics manager | |
2063 | self.register_magics = self.magics_manager.register |
|
2064 | self.register_magics = self.magics_manager.register | |
2064 |
|
2065 | |||
2065 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2066 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, | |
2066 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2067 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, | |
2067 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2068 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, | |
2068 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, |
|
2069 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, | |
2069 | ) |
|
2070 | ) | |
2070 |
|
2071 | |||
2071 | # Register Magic Aliases |
|
2072 | # Register Magic Aliases | |
2072 | mman = self.magics_manager |
|
2073 | mman = self.magics_manager | |
2073 | # FIXME: magic aliases should be defined by the Magics classes |
|
2074 | # FIXME: magic aliases should be defined by the Magics classes | |
2074 | # or in MagicsManager, not here |
|
2075 | # or in MagicsManager, not here | |
2075 | mman.register_alias('ed', 'edit') |
|
2076 | mman.register_alias('ed', 'edit') | |
2076 | mman.register_alias('hist', 'history') |
|
2077 | mman.register_alias('hist', 'history') | |
2077 | mman.register_alias('rep', 'recall') |
|
2078 | mman.register_alias('rep', 'recall') | |
2078 | mman.register_alias('SVG', 'svg', 'cell') |
|
2079 | mman.register_alias('SVG', 'svg', 'cell') | |
2079 | mman.register_alias('HTML', 'html', 'cell') |
|
2080 | mman.register_alias('HTML', 'html', 'cell') | |
2080 | mman.register_alias('file', 'writefile', 'cell') |
|
2081 | mman.register_alias('file', 'writefile', 'cell') | |
2081 |
|
2082 | |||
2082 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2083 | # FIXME: Move the color initialization to the DisplayHook, which | |
2083 | # should be split into a prompt manager and displayhook. We probably |
|
2084 | # should be split into a prompt manager and displayhook. We probably | |
2084 | # even need a centralize colors management object. |
|
2085 | # even need a centralize colors management object. | |
2085 | self.run_line_magic('colors', self.colors) |
|
2086 | self.run_line_magic('colors', self.colors) | |
2086 |
|
2087 | |||
2087 | # Defined here so that it's included in the documentation |
|
2088 | # Defined here so that it's included in the documentation | |
2088 | @functools.wraps(magic.MagicsManager.register_function) |
|
2089 | @functools.wraps(magic.MagicsManager.register_function) | |
2089 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2090 | def register_magic_function(self, func, magic_kind='line', magic_name=None): | |
2090 | self.magics_manager.register_function(func, |
|
2091 | self.magics_manager.register_function(func, | |
2091 | magic_kind=magic_kind, magic_name=magic_name) |
|
2092 | magic_kind=magic_kind, magic_name=magic_name) | |
2092 |
|
2093 | |||
2093 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2094 | def run_line_magic(self, magic_name, line, _stack_depth=1): | |
2094 | """Execute the given line magic. |
|
2095 | """Execute the given line magic. | |
2095 |
|
2096 | |||
2096 | Parameters |
|
2097 | Parameters | |
2097 | ---------- |
|
2098 | ---------- | |
2098 | magic_name : str |
|
2099 | magic_name : str | |
2099 | Name of the desired magic function, without '%' prefix. |
|
2100 | Name of the desired magic function, without '%' prefix. | |
2100 |
|
2101 | |||
2101 | line : str |
|
2102 | line : str | |
2102 | The rest of the input line as a single string. |
|
2103 | The rest of the input line as a single string. | |
2103 |
|
2104 | |||
2104 | _stack_depth : int |
|
2105 | _stack_depth : int | |
2105 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2106 | If run_line_magic() is called from magic() then _stack_depth=2. | |
2106 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2107 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' | |
2107 | """ |
|
2108 | """ | |
2108 | fn = self.find_line_magic(magic_name) |
|
2109 | fn = self.find_line_magic(magic_name) | |
2109 | if fn is None: |
|
2110 | if fn is None: | |
2110 | cm = self.find_cell_magic(magic_name) |
|
2111 | cm = self.find_cell_magic(magic_name) | |
2111 | etpl = "Line magic function `%%%s` not found%s." |
|
2112 | etpl = "Line magic function `%%%s` not found%s." | |
2112 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2113 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' | |
2113 | 'did you mean that instead?)' % magic_name ) |
|
2114 | 'did you mean that instead?)' % magic_name ) | |
2114 | raise UsageError(etpl % (magic_name, extra)) |
|
2115 | raise UsageError(etpl % (magic_name, extra)) | |
2115 | else: |
|
2116 | else: | |
2116 | # Note: this is the distance in the stack to the user's frame. |
|
2117 | # Note: this is the distance in the stack to the user's frame. | |
2117 | # This will need to be updated if the internal calling logic gets |
|
2118 | # This will need to be updated if the internal calling logic gets | |
2118 | # refactored, or else we'll be expanding the wrong variables. |
|
2119 | # refactored, or else we'll be expanding the wrong variables. | |
2119 |
|
2120 | |||
2120 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2121 | # Determine stack_depth depending on where run_line_magic() has been called | |
2121 | stack_depth = _stack_depth |
|
2122 | stack_depth = _stack_depth | |
2122 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2123 | magic_arg_s = self.var_expand(line, stack_depth) | |
2123 | # Put magic args in a list so we can call with f(*a) syntax |
|
2124 | # Put magic args in a list so we can call with f(*a) syntax | |
2124 | args = [magic_arg_s] |
|
2125 | args = [magic_arg_s] | |
2125 | kwargs = {} |
|
2126 | kwargs = {} | |
2126 | # Grab local namespace if we need it: |
|
2127 | # Grab local namespace if we need it: | |
2127 | if getattr(fn, "needs_local_scope", False): |
|
2128 | if getattr(fn, "needs_local_scope", False): | |
2128 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2129 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals | |
2129 | with self.builtin_trap: |
|
2130 | with self.builtin_trap: | |
2130 | result = fn(*args,**kwargs) |
|
2131 | result = fn(*args,**kwargs) | |
2131 | return result |
|
2132 | return result | |
2132 |
|
2133 | |||
2133 | def run_cell_magic(self, magic_name, line, cell): |
|
2134 | def run_cell_magic(self, magic_name, line, cell): | |
2134 | """Execute the given cell magic. |
|
2135 | """Execute the given cell magic. | |
2135 |
|
2136 | |||
2136 | Parameters |
|
2137 | Parameters | |
2137 | ---------- |
|
2138 | ---------- | |
2138 | magic_name : str |
|
2139 | magic_name : str | |
2139 | Name of the desired magic function, without '%' prefix. |
|
2140 | Name of the desired magic function, without '%' prefix. | |
2140 |
|
2141 | |||
2141 | line : str |
|
2142 | line : str | |
2142 | The rest of the first input line as a single string. |
|
2143 | The rest of the first input line as a single string. | |
2143 |
|
2144 | |||
2144 | cell : str |
|
2145 | cell : str | |
2145 | The body of the cell as a (possibly multiline) string. |
|
2146 | The body of the cell as a (possibly multiline) string. | |
2146 | """ |
|
2147 | """ | |
2147 | fn = self.find_cell_magic(magic_name) |
|
2148 | fn = self.find_cell_magic(magic_name) | |
2148 | if fn is None: |
|
2149 | if fn is None: | |
2149 | lm = self.find_line_magic(magic_name) |
|
2150 | lm = self.find_line_magic(magic_name) | |
2150 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2151 | etpl = "Cell magic `%%{0}` not found{1}." | |
2151 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2152 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' | |
2152 | 'did you mean that instead?)'.format(magic_name)) |
|
2153 | 'did you mean that instead?)'.format(magic_name)) | |
2153 | raise UsageError(etpl.format(magic_name, extra)) |
|
2154 | raise UsageError(etpl.format(magic_name, extra)) | |
2154 | elif cell == '': |
|
2155 | elif cell == '': | |
2155 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2156 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) | |
2156 | if self.find_line_magic(magic_name) is not None: |
|
2157 | if self.find_line_magic(magic_name) is not None: | |
2157 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2158 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) | |
2158 | raise UsageError(message) |
|
2159 | raise UsageError(message) | |
2159 | else: |
|
2160 | else: | |
2160 | # Note: this is the distance in the stack to the user's frame. |
|
2161 | # Note: this is the distance in the stack to the user's frame. | |
2161 | # This will need to be updated if the internal calling logic gets |
|
2162 | # This will need to be updated if the internal calling logic gets | |
2162 | # refactored, or else we'll be expanding the wrong variables. |
|
2163 | # refactored, or else we'll be expanding the wrong variables. | |
2163 | stack_depth = 2 |
|
2164 | stack_depth = 2 | |
2164 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2165 | magic_arg_s = self.var_expand(line, stack_depth) | |
2165 | with self.builtin_trap: |
|
2166 | with self.builtin_trap: | |
2166 | result = fn(magic_arg_s, cell) |
|
2167 | result = fn(magic_arg_s, cell) | |
2167 | return result |
|
2168 | return result | |
2168 |
|
2169 | |||
2169 | def find_line_magic(self, magic_name): |
|
2170 | def find_line_magic(self, magic_name): | |
2170 | """Find and return a line magic by name. |
|
2171 | """Find and return a line magic by name. | |
2171 |
|
2172 | |||
2172 | Returns None if the magic isn't found.""" |
|
2173 | Returns None if the magic isn't found.""" | |
2173 | return self.magics_manager.magics['line'].get(magic_name) |
|
2174 | return self.magics_manager.magics['line'].get(magic_name) | |
2174 |
|
2175 | |||
2175 | def find_cell_magic(self, magic_name): |
|
2176 | def find_cell_magic(self, magic_name): | |
2176 | """Find and return a cell magic by name. |
|
2177 | """Find and return a cell magic by name. | |
2177 |
|
2178 | |||
2178 | Returns None if the magic isn't found.""" |
|
2179 | Returns None if the magic isn't found.""" | |
2179 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2180 | return self.magics_manager.magics['cell'].get(magic_name) | |
2180 |
|
2181 | |||
2181 | def find_magic(self, magic_name, magic_kind='line'): |
|
2182 | def find_magic(self, magic_name, magic_kind='line'): | |
2182 | """Find and return a magic of the given type by name. |
|
2183 | """Find and return a magic of the given type by name. | |
2183 |
|
2184 | |||
2184 | Returns None if the magic isn't found.""" |
|
2185 | Returns None if the magic isn't found.""" | |
2185 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2186 | return self.magics_manager.magics[magic_kind].get(magic_name) | |
2186 |
|
2187 | |||
2187 | def magic(self, arg_s): |
|
2188 | def magic(self, arg_s): | |
2188 | """DEPRECATED. Use run_line_magic() instead. |
|
2189 | """DEPRECATED. Use run_line_magic() instead. | |
2189 |
|
2190 | |||
2190 | Call a magic function by name. |
|
2191 | Call a magic function by name. | |
2191 |
|
2192 | |||
2192 | Input: a string containing the name of the magic function to call and |
|
2193 | Input: a string containing the name of the magic function to call and | |
2193 | any additional arguments to be passed to the magic. |
|
2194 | any additional arguments to be passed to the magic. | |
2194 |
|
2195 | |||
2195 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2196 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
2196 | prompt: |
|
2197 | prompt: | |
2197 |
|
2198 | |||
2198 | In[1]: %name -opt foo bar |
|
2199 | In[1]: %name -opt foo bar | |
2199 |
|
2200 | |||
2200 | To call a magic without arguments, simply use magic('name'). |
|
2201 | To call a magic without arguments, simply use magic('name'). | |
2201 |
|
2202 | |||
2202 | This provides a proper Python function to call IPython's magics in any |
|
2203 | This provides a proper Python function to call IPython's magics in any | |
2203 | valid Python code you can type at the interpreter, including loops and |
|
2204 | valid Python code you can type at the interpreter, including loops and | |
2204 | compound statements. |
|
2205 | compound statements. | |
2205 | """ |
|
2206 | """ | |
2206 | # TODO: should we issue a loud deprecation warning here? |
|
2207 | # TODO: should we issue a loud deprecation warning here? | |
2207 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2208 | magic_name, _, magic_arg_s = arg_s.partition(' ') | |
2208 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2209 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
2209 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2210 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) | |
2210 |
|
2211 | |||
2211 | #------------------------------------------------------------------------- |
|
2212 | #------------------------------------------------------------------------- | |
2212 | # Things related to macros |
|
2213 | # Things related to macros | |
2213 | #------------------------------------------------------------------------- |
|
2214 | #------------------------------------------------------------------------- | |
2214 |
|
2215 | |||
2215 | def define_macro(self, name, themacro): |
|
2216 | def define_macro(self, name, themacro): | |
2216 | """Define a new macro |
|
2217 | """Define a new macro | |
2217 |
|
2218 | |||
2218 | Parameters |
|
2219 | Parameters | |
2219 | ---------- |
|
2220 | ---------- | |
2220 | name : str |
|
2221 | name : str | |
2221 | The name of the macro. |
|
2222 | The name of the macro. | |
2222 | themacro : str or Macro |
|
2223 | themacro : str or Macro | |
2223 | The action to do upon invoking the macro. If a string, a new |
|
2224 | The action to do upon invoking the macro. If a string, a new | |
2224 | Macro object is created by passing the string to it. |
|
2225 | Macro object is created by passing the string to it. | |
2225 | """ |
|
2226 | """ | |
2226 |
|
2227 | |||
2227 | from IPython.core import macro |
|
2228 | from IPython.core import macro | |
2228 |
|
2229 | |||
2229 | if isinstance(themacro, str): |
|
2230 | if isinstance(themacro, str): | |
2230 | themacro = macro.Macro(themacro) |
|
2231 | themacro = macro.Macro(themacro) | |
2231 | if not isinstance(themacro, macro.Macro): |
|
2232 | if not isinstance(themacro, macro.Macro): | |
2232 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2233 | raise ValueError('A macro must be a string or a Macro instance.') | |
2233 | self.user_ns[name] = themacro |
|
2234 | self.user_ns[name] = themacro | |
2234 |
|
2235 | |||
2235 | #------------------------------------------------------------------------- |
|
2236 | #------------------------------------------------------------------------- | |
2236 | # Things related to the running of system commands |
|
2237 | # Things related to the running of system commands | |
2237 | #------------------------------------------------------------------------- |
|
2238 | #------------------------------------------------------------------------- | |
2238 |
|
2239 | |||
2239 | def system_piped(self, cmd): |
|
2240 | def system_piped(self, cmd): | |
2240 | """Call the given cmd in a subprocess, piping stdout/err |
|
2241 | """Call the given cmd in a subprocess, piping stdout/err | |
2241 |
|
2242 | |||
2242 | Parameters |
|
2243 | Parameters | |
2243 | ---------- |
|
2244 | ---------- | |
2244 | cmd : str |
|
2245 | cmd : str | |
2245 | Command to execute (can not end in '&', as background processes are |
|
2246 | Command to execute (can not end in '&', as background processes are | |
2246 | not supported. Should not be a command that expects input |
|
2247 | not supported. Should not be a command that expects input | |
2247 | other than simple text. |
|
2248 | other than simple text. | |
2248 | """ |
|
2249 | """ | |
2249 | if cmd.rstrip().endswith('&'): |
|
2250 | if cmd.rstrip().endswith('&'): | |
2250 | # this is *far* from a rigorous test |
|
2251 | # this is *far* from a rigorous test | |
2251 | # We do not support backgrounding processes because we either use |
|
2252 | # We do not support backgrounding processes because we either use | |
2252 | # pexpect or pipes to read from. Users can always just call |
|
2253 | # pexpect or pipes to read from. Users can always just call | |
2253 | # os.system() or use ip.system=ip.system_raw |
|
2254 | # os.system() or use ip.system=ip.system_raw | |
2254 | # if they really want a background process. |
|
2255 | # if they really want a background process. | |
2255 | raise OSError("Background processes not supported.") |
|
2256 | raise OSError("Background processes not supported.") | |
2256 |
|
2257 | |||
2257 | # we explicitly do NOT return the subprocess status code, because |
|
2258 | # we explicitly do NOT return the subprocess status code, because | |
2258 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2259 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2259 | # Instead, we store the exit_code in user_ns. |
|
2260 | # Instead, we store the exit_code in user_ns. | |
2260 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2261 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) | |
2261 |
|
2262 | |||
2262 | def system_raw(self, cmd): |
|
2263 | def system_raw(self, cmd): | |
2263 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2264 | """Call the given cmd in a subprocess using os.system on Windows or | |
2264 | subprocess.call using the system shell on other platforms. |
|
2265 | subprocess.call using the system shell on other platforms. | |
2265 |
|
2266 | |||
2266 | Parameters |
|
2267 | Parameters | |
2267 | ---------- |
|
2268 | ---------- | |
2268 | cmd : str |
|
2269 | cmd : str | |
2269 | Command to execute. |
|
2270 | Command to execute. | |
2270 | """ |
|
2271 | """ | |
2271 | cmd = self.var_expand(cmd, depth=1) |
|
2272 | cmd = self.var_expand(cmd, depth=1) | |
2272 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2273 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2273 | if sys.platform == 'win32': |
|
2274 | if sys.platform == 'win32': | |
2274 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2275 | from IPython.utils._process_win32 import AvoidUNCPath | |
2275 | with AvoidUNCPath() as path: |
|
2276 | with AvoidUNCPath() as path: | |
2276 | if path is not None: |
|
2277 | if path is not None: | |
2277 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2278 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
2278 | try: |
|
2279 | try: | |
2279 | ec = os.system(cmd) |
|
2280 | ec = os.system(cmd) | |
2280 | except KeyboardInterrupt: |
|
2281 | except KeyboardInterrupt: | |
2281 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2282 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
2282 | ec = -2 |
|
2283 | ec = -2 | |
2283 | else: |
|
2284 | else: | |
2284 | # For posix the result of the subprocess.call() below is an exit |
|
2285 | # For posix the result of the subprocess.call() below is an exit | |
2285 | # code, which by convention is zero for success, positive for |
|
2286 | # code, which by convention is zero for success, positive for | |
2286 | # program failure. Exit codes above 128 are reserved for signals, |
|
2287 | # program failure. Exit codes above 128 are reserved for signals, | |
2287 | # and the formula for converting a signal to an exit code is usually |
|
2288 | # and the formula for converting a signal to an exit code is usually | |
2288 | # signal_number+128. To more easily differentiate between exit |
|
2289 | # signal_number+128. To more easily differentiate between exit | |
2289 | # codes and signals, ipython uses negative numbers. For instance |
|
2290 | # codes and signals, ipython uses negative numbers. For instance | |
2290 | # since control-c is signal 2 but exit code 130, ipython's |
|
2291 | # since control-c is signal 2 but exit code 130, ipython's | |
2291 | # _exit_code variable will read -2. Note that some shells like |
|
2292 | # _exit_code variable will read -2. Note that some shells like | |
2292 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2293 | # csh and fish don't follow sh/bash conventions for exit codes. | |
2293 | executable = os.environ.get('SHELL', None) |
|
2294 | executable = os.environ.get('SHELL', None) | |
2294 | try: |
|
2295 | try: | |
2295 | # Use env shell instead of default /bin/sh |
|
2296 | # Use env shell instead of default /bin/sh | |
2296 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2297 | ec = subprocess.call(cmd, shell=True, executable=executable) | |
2297 | except KeyboardInterrupt: |
|
2298 | except KeyboardInterrupt: | |
2298 | # intercept control-C; a long traceback is not useful here |
|
2299 | # intercept control-C; a long traceback is not useful here | |
2299 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2300 | print('\n' + self.get_exception_only(), file=sys.stderr) | |
2300 | ec = 130 |
|
2301 | ec = 130 | |
2301 | if ec > 128: |
|
2302 | if ec > 128: | |
2302 | ec = -(ec - 128) |
|
2303 | ec = -(ec - 128) | |
2303 |
|
2304 | |||
2304 | # We explicitly do NOT return the subprocess status code, because |
|
2305 | # We explicitly do NOT return the subprocess status code, because | |
2305 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2306 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2306 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2307 | # Instead, we store the exit_code in user_ns. Note the semantics | |
2307 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2308 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, | |
2308 | # but raising SystemExit(_exit_code) will give status 254! |
|
2309 | # but raising SystemExit(_exit_code) will give status 254! | |
2309 | self.user_ns['_exit_code'] = ec |
|
2310 | self.user_ns['_exit_code'] = ec | |
2310 |
|
2311 | |||
2311 | # use piped system by default, because it is better behaved |
|
2312 | # use piped system by default, because it is better behaved | |
2312 | system = system_piped |
|
2313 | system = system_piped | |
2313 |
|
2314 | |||
2314 | def getoutput(self, cmd, split=True, depth=0): |
|
2315 | def getoutput(self, cmd, split=True, depth=0): | |
2315 | """Get output (possibly including stderr) from a subprocess. |
|
2316 | """Get output (possibly including stderr) from a subprocess. | |
2316 |
|
2317 | |||
2317 | Parameters |
|
2318 | Parameters | |
2318 | ---------- |
|
2319 | ---------- | |
2319 | cmd : str |
|
2320 | cmd : str | |
2320 | Command to execute (can not end in '&', as background processes are |
|
2321 | Command to execute (can not end in '&', as background processes are | |
2321 | not supported. |
|
2322 | not supported. | |
2322 | split : bool, optional |
|
2323 | split : bool, optional | |
2323 | If True, split the output into an IPython SList. Otherwise, an |
|
2324 | If True, split the output into an IPython SList. Otherwise, an | |
2324 | IPython LSString is returned. These are objects similar to normal |
|
2325 | IPython LSString is returned. These are objects similar to normal | |
2325 | lists and strings, with a few convenience attributes for easier |
|
2326 | lists and strings, with a few convenience attributes for easier | |
2326 | manipulation of line-based output. You can use '?' on them for |
|
2327 | manipulation of line-based output. You can use '?' on them for | |
2327 | details. |
|
2328 | details. | |
2328 | depth : int, optional |
|
2329 | depth : int, optional | |
2329 | How many frames above the caller are the local variables which should |
|
2330 | How many frames above the caller are the local variables which should | |
2330 | be expanded in the command string? The default (0) assumes that the |
|
2331 | be expanded in the command string? The default (0) assumes that the | |
2331 | expansion variables are in the stack frame calling this function. |
|
2332 | expansion variables are in the stack frame calling this function. | |
2332 | """ |
|
2333 | """ | |
2333 | if cmd.rstrip().endswith('&'): |
|
2334 | if cmd.rstrip().endswith('&'): | |
2334 | # this is *far* from a rigorous test |
|
2335 | # this is *far* from a rigorous test | |
2335 | raise OSError("Background processes not supported.") |
|
2336 | raise OSError("Background processes not supported.") | |
2336 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2337 | out = getoutput(self.var_expand(cmd, depth=depth+1)) | |
2337 | if split: |
|
2338 | if split: | |
2338 | out = SList(out.splitlines()) |
|
2339 | out = SList(out.splitlines()) | |
2339 | else: |
|
2340 | else: | |
2340 | out = LSString(out) |
|
2341 | out = LSString(out) | |
2341 | return out |
|
2342 | return out | |
2342 |
|
2343 | |||
2343 | #------------------------------------------------------------------------- |
|
2344 | #------------------------------------------------------------------------- | |
2344 | # Things related to aliases |
|
2345 | # Things related to aliases | |
2345 | #------------------------------------------------------------------------- |
|
2346 | #------------------------------------------------------------------------- | |
2346 |
|
2347 | |||
2347 | def init_alias(self): |
|
2348 | def init_alias(self): | |
2348 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2349 | self.alias_manager = AliasManager(shell=self, parent=self) | |
2349 | self.configurables.append(self.alias_manager) |
|
2350 | self.configurables.append(self.alias_manager) | |
2350 |
|
2351 | |||
2351 | #------------------------------------------------------------------------- |
|
2352 | #------------------------------------------------------------------------- | |
2352 | # Things related to extensions |
|
2353 | # Things related to extensions | |
2353 | #------------------------------------------------------------------------- |
|
2354 | #------------------------------------------------------------------------- | |
2354 |
|
2355 | |||
2355 | def init_extension_manager(self): |
|
2356 | def init_extension_manager(self): | |
2356 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2357 | self.extension_manager = ExtensionManager(shell=self, parent=self) | |
2357 | self.configurables.append(self.extension_manager) |
|
2358 | self.configurables.append(self.extension_manager) | |
2358 |
|
2359 | |||
2359 | #------------------------------------------------------------------------- |
|
2360 | #------------------------------------------------------------------------- | |
2360 | # Things related to payloads |
|
2361 | # Things related to payloads | |
2361 | #------------------------------------------------------------------------- |
|
2362 | #------------------------------------------------------------------------- | |
2362 |
|
2363 | |||
2363 | def init_payload(self): |
|
2364 | def init_payload(self): | |
2364 | self.payload_manager = PayloadManager(parent=self) |
|
2365 | self.payload_manager = PayloadManager(parent=self) | |
2365 | self.configurables.append(self.payload_manager) |
|
2366 | self.configurables.append(self.payload_manager) | |
2366 |
|
2367 | |||
2367 | #------------------------------------------------------------------------- |
|
2368 | #------------------------------------------------------------------------- | |
2368 | # Things related to the prefilter |
|
2369 | # Things related to the prefilter | |
2369 | #------------------------------------------------------------------------- |
|
2370 | #------------------------------------------------------------------------- | |
2370 |
|
2371 | |||
2371 | def init_prefilter(self): |
|
2372 | def init_prefilter(self): | |
2372 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2373 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) | |
2373 | self.configurables.append(self.prefilter_manager) |
|
2374 | self.configurables.append(self.prefilter_manager) | |
2374 | # Ultimately this will be refactored in the new interpreter code, but |
|
2375 | # Ultimately this will be refactored in the new interpreter code, but | |
2375 | # for now, we should expose the main prefilter method (there's legacy |
|
2376 | # for now, we should expose the main prefilter method (there's legacy | |
2376 | # code out there that may rely on this). |
|
2377 | # code out there that may rely on this). | |
2377 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2378 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2378 |
|
2379 | |||
2379 | def auto_rewrite_input(self, cmd): |
|
2380 | def auto_rewrite_input(self, cmd): | |
2380 | """Print to the screen the rewritten form of the user's command. |
|
2381 | """Print to the screen the rewritten form of the user's command. | |
2381 |
|
2382 | |||
2382 | This shows visual feedback by rewriting input lines that cause |
|
2383 | This shows visual feedback by rewriting input lines that cause | |
2383 | automatic calling to kick in, like:: |
|
2384 | automatic calling to kick in, like:: | |
2384 |
|
2385 | |||
2385 | /f x |
|
2386 | /f x | |
2386 |
|
2387 | |||
2387 | into:: |
|
2388 | into:: | |
2388 |
|
2389 | |||
2389 | ------> f(x) |
|
2390 | ------> f(x) | |
2390 |
|
2391 | |||
2391 | after the user's input prompt. This helps the user understand that the |
|
2392 | after the user's input prompt. This helps the user understand that the | |
2392 | input line was transformed automatically by IPython. |
|
2393 | input line was transformed automatically by IPython. | |
2393 | """ |
|
2394 | """ | |
2394 | if not self.show_rewritten_input: |
|
2395 | if not self.show_rewritten_input: | |
2395 | return |
|
2396 | return | |
2396 |
|
2397 | |||
2397 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2398 | # This is overridden in TerminalInteractiveShell to use fancy prompts | |
2398 | print("------> " + cmd) |
|
2399 | print("------> " + cmd) | |
2399 |
|
2400 | |||
2400 | #------------------------------------------------------------------------- |
|
2401 | #------------------------------------------------------------------------- | |
2401 | # Things related to extracting values/expressions from kernel and user_ns |
|
2402 | # Things related to extracting values/expressions from kernel and user_ns | |
2402 | #------------------------------------------------------------------------- |
|
2403 | #------------------------------------------------------------------------- | |
2403 |
|
2404 | |||
2404 | def _user_obj_error(self): |
|
2405 | def _user_obj_error(self): | |
2405 | """return simple exception dict |
|
2406 | """return simple exception dict | |
2406 |
|
2407 | |||
2407 | for use in user_expressions |
|
2408 | for use in user_expressions | |
2408 | """ |
|
2409 | """ | |
2409 |
|
2410 | |||
2410 | etype, evalue, tb = self._get_exc_info() |
|
2411 | etype, evalue, tb = self._get_exc_info() | |
2411 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2412 | stb = self.InteractiveTB.get_exception_only(etype, evalue) | |
2412 |
|
2413 | |||
2413 | exc_info = { |
|
2414 | exc_info = { | |
2414 | u'status' : 'error', |
|
2415 | u'status' : 'error', | |
2415 | u'traceback' : stb, |
|
2416 | u'traceback' : stb, | |
2416 | u'ename' : etype.__name__, |
|
2417 | u'ename' : etype.__name__, | |
2417 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2418 | u'evalue' : py3compat.safe_unicode(evalue), | |
2418 | } |
|
2419 | } | |
2419 |
|
2420 | |||
2420 | return exc_info |
|
2421 | return exc_info | |
2421 |
|
2422 | |||
2422 | def _format_user_obj(self, obj): |
|
2423 | def _format_user_obj(self, obj): | |
2423 | """format a user object to display dict |
|
2424 | """format a user object to display dict | |
2424 |
|
2425 | |||
2425 | for use in user_expressions |
|
2426 | for use in user_expressions | |
2426 | """ |
|
2427 | """ | |
2427 |
|
2428 | |||
2428 | data, md = self.display_formatter.format(obj) |
|
2429 | data, md = self.display_formatter.format(obj) | |
2429 | value = { |
|
2430 | value = { | |
2430 | 'status' : 'ok', |
|
2431 | 'status' : 'ok', | |
2431 | 'data' : data, |
|
2432 | 'data' : data, | |
2432 | 'metadata' : md, |
|
2433 | 'metadata' : md, | |
2433 | } |
|
2434 | } | |
2434 | return value |
|
2435 | return value | |
2435 |
|
2436 | |||
2436 | def user_expressions(self, expressions): |
|
2437 | def user_expressions(self, expressions): | |
2437 | """Evaluate a dict of expressions in the user's namespace. |
|
2438 | """Evaluate a dict of expressions in the user's namespace. | |
2438 |
|
2439 | |||
2439 | Parameters |
|
2440 | Parameters | |
2440 | ---------- |
|
2441 | ---------- | |
2441 | expressions : dict |
|
2442 | expressions : dict | |
2442 | A dict with string keys and string values. The expression values |
|
2443 | A dict with string keys and string values. The expression values | |
2443 | should be valid Python expressions, each of which will be evaluated |
|
2444 | should be valid Python expressions, each of which will be evaluated | |
2444 | in the user namespace. |
|
2445 | in the user namespace. | |
2445 |
|
2446 | |||
2446 | Returns |
|
2447 | Returns | |
2447 | ------- |
|
2448 | ------- | |
2448 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2449 | A dict, keyed like the input expressions dict, with the rich mime-typed | |
2449 | display_data of each value. |
|
2450 | display_data of each value. | |
2450 | """ |
|
2451 | """ | |
2451 | out = {} |
|
2452 | out = {} | |
2452 | user_ns = self.user_ns |
|
2453 | user_ns = self.user_ns | |
2453 | global_ns = self.user_global_ns |
|
2454 | global_ns = self.user_global_ns | |
2454 |
|
2455 | |||
2455 | for key, expr in expressions.items(): |
|
2456 | for key, expr in expressions.items(): | |
2456 | try: |
|
2457 | try: | |
2457 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2458 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) | |
2458 | except: |
|
2459 | except: | |
2459 | value = self._user_obj_error() |
|
2460 | value = self._user_obj_error() | |
2460 | out[key] = value |
|
2461 | out[key] = value | |
2461 | return out |
|
2462 | return out | |
2462 |
|
2463 | |||
2463 | #------------------------------------------------------------------------- |
|
2464 | #------------------------------------------------------------------------- | |
2464 | # Things related to the running of code |
|
2465 | # Things related to the running of code | |
2465 | #------------------------------------------------------------------------- |
|
2466 | #------------------------------------------------------------------------- | |
2466 |
|
2467 | |||
2467 | def ex(self, cmd): |
|
2468 | def ex(self, cmd): | |
2468 | """Execute a normal python statement in user namespace.""" |
|
2469 | """Execute a normal python statement in user namespace.""" | |
2469 | with self.builtin_trap: |
|
2470 | with self.builtin_trap: | |
2470 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2471 | exec(cmd, self.user_global_ns, self.user_ns) | |
2471 |
|
2472 | |||
2472 | def ev(self, expr): |
|
2473 | def ev(self, expr): | |
2473 | """Evaluate python expression expr in user namespace. |
|
2474 | """Evaluate python expression expr in user namespace. | |
2474 |
|
2475 | |||
2475 | Returns the result of evaluation |
|
2476 | Returns the result of evaluation | |
2476 | """ |
|
2477 | """ | |
2477 | with self.builtin_trap: |
|
2478 | with self.builtin_trap: | |
2478 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2479 | return eval(expr, self.user_global_ns, self.user_ns) | |
2479 |
|
2480 | |||
2480 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2481 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): | |
2481 | """A safe version of the builtin execfile(). |
|
2482 | """A safe version of the builtin execfile(). | |
2482 |
|
2483 | |||
2483 | This version will never throw an exception, but instead print |
|
2484 | This version will never throw an exception, but instead print | |
2484 | helpful error messages to the screen. This only works on pure |
|
2485 | helpful error messages to the screen. This only works on pure | |
2485 | Python files with the .py extension. |
|
2486 | Python files with the .py extension. | |
2486 |
|
2487 | |||
2487 | Parameters |
|
2488 | Parameters | |
2488 | ---------- |
|
2489 | ---------- | |
2489 | fname : string |
|
2490 | fname : string | |
2490 | The name of the file to be executed. |
|
2491 | The name of the file to be executed. | |
2491 | where : tuple |
|
2492 | where : tuple | |
2492 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2493 | One or two namespaces, passed to execfile() as (globals,locals). | |
2493 | If only one is given, it is passed as both. |
|
2494 | If only one is given, it is passed as both. | |
2494 | exit_ignore : bool (False) |
|
2495 | exit_ignore : bool (False) | |
2495 | If True, then silence SystemExit for non-zero status (it is always |
|
2496 | If True, then silence SystemExit for non-zero status (it is always | |
2496 | silenced for zero status, as it is so common). |
|
2497 | silenced for zero status, as it is so common). | |
2497 | raise_exceptions : bool (False) |
|
2498 | raise_exceptions : bool (False) | |
2498 | If True raise exceptions everywhere. Meant for testing. |
|
2499 | If True raise exceptions everywhere. Meant for testing. | |
2499 | shell_futures : bool (False) |
|
2500 | shell_futures : bool (False) | |
2500 | If True, the code will share future statements with the interactive |
|
2501 | If True, the code will share future statements with the interactive | |
2501 | shell. It will both be affected by previous __future__ imports, and |
|
2502 | shell. It will both be affected by previous __future__ imports, and | |
2502 | any __future__ imports in the code will affect the shell. If False, |
|
2503 | any __future__ imports in the code will affect the shell. If False, | |
2503 | __future__ imports are not shared in either direction. |
|
2504 | __future__ imports are not shared in either direction. | |
2504 |
|
2505 | |||
2505 | """ |
|
2506 | """ | |
2506 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2507 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2507 |
|
2508 | |||
2508 | # Make sure we can open the file |
|
2509 | # Make sure we can open the file | |
2509 | try: |
|
2510 | try: | |
2510 | with open(fname): |
|
2511 | with open(fname): | |
2511 | pass |
|
2512 | pass | |
2512 | except: |
|
2513 | except: | |
2513 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2514 | warn('Could not open file <%s> for safe execution.' % fname) | |
2514 | return |
|
2515 | return | |
2515 |
|
2516 | |||
2516 | # Find things also in current directory. This is needed to mimic the |
|
2517 | # Find things also in current directory. This is needed to mimic the | |
2517 | # behavior of running a script from the system command line, where |
|
2518 | # behavior of running a script from the system command line, where | |
2518 | # Python inserts the script's directory into sys.path |
|
2519 | # Python inserts the script's directory into sys.path | |
2519 | dname = os.path.dirname(fname) |
|
2520 | dname = os.path.dirname(fname) | |
2520 |
|
2521 | |||
2521 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2522 | with prepended_to_syspath(dname), self.builtin_trap: | |
2522 | try: |
|
2523 | try: | |
2523 | glob, loc = (where + (None, ))[:2] |
|
2524 | glob, loc = (where + (None, ))[:2] | |
2524 | py3compat.execfile( |
|
2525 | py3compat.execfile( | |
2525 | fname, glob, loc, |
|
2526 | fname, glob, loc, | |
2526 | self.compile if shell_futures else None) |
|
2527 | self.compile if shell_futures else None) | |
2527 | except SystemExit as status: |
|
2528 | except SystemExit as status: | |
2528 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2529 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2529 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2530 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2530 | # these are considered normal by the OS: |
|
2531 | # these are considered normal by the OS: | |
2531 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2532 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2532 | # 0 |
|
2533 | # 0 | |
2533 | # > python -c'import sys;sys.exit()'; echo $? |
|
2534 | # > python -c'import sys;sys.exit()'; echo $? | |
2534 | # 0 |
|
2535 | # 0 | |
2535 | # For other exit status, we show the exception unless |
|
2536 | # For other exit status, we show the exception unless | |
2536 | # explicitly silenced, but only in short form. |
|
2537 | # explicitly silenced, but only in short form. | |
2537 | if status.code: |
|
2538 | if status.code: | |
2538 | if raise_exceptions: |
|
2539 | if raise_exceptions: | |
2539 | raise |
|
2540 | raise | |
2540 | if not exit_ignore: |
|
2541 | if not exit_ignore: | |
2541 | self.showtraceback(exception_only=True) |
|
2542 | self.showtraceback(exception_only=True) | |
2542 | except: |
|
2543 | except: | |
2543 | if raise_exceptions: |
|
2544 | if raise_exceptions: | |
2544 | raise |
|
2545 | raise | |
2545 | # tb offset is 2 because we wrap execfile |
|
2546 | # tb offset is 2 because we wrap execfile | |
2546 | self.showtraceback(tb_offset=2) |
|
2547 | self.showtraceback(tb_offset=2) | |
2547 |
|
2548 | |||
2548 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2549 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): | |
2549 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2550 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. | |
2550 |
|
2551 | |||
2551 | Parameters |
|
2552 | Parameters | |
2552 | ---------- |
|
2553 | ---------- | |
2553 | fname : str |
|
2554 | fname : str | |
2554 | The name of the file to execute. The filename must have a |
|
2555 | The name of the file to execute. The filename must have a | |
2555 | .ipy or .ipynb extension. |
|
2556 | .ipy or .ipynb extension. | |
2556 | shell_futures : bool (False) |
|
2557 | shell_futures : bool (False) | |
2557 | If True, the code will share future statements with the interactive |
|
2558 | If True, the code will share future statements with the interactive | |
2558 | shell. It will both be affected by previous __future__ imports, and |
|
2559 | shell. It will both be affected by previous __future__ imports, and | |
2559 | any __future__ imports in the code will affect the shell. If False, |
|
2560 | any __future__ imports in the code will affect the shell. If False, | |
2560 | __future__ imports are not shared in either direction. |
|
2561 | __future__ imports are not shared in either direction. | |
2561 | raise_exceptions : bool (False) |
|
2562 | raise_exceptions : bool (False) | |
2562 | If True raise exceptions everywhere. Meant for testing. |
|
2563 | If True raise exceptions everywhere. Meant for testing. | |
2563 | """ |
|
2564 | """ | |
2564 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2565 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2565 |
|
2566 | |||
2566 | # Make sure we can open the file |
|
2567 | # Make sure we can open the file | |
2567 | try: |
|
2568 | try: | |
2568 | with open(fname): |
|
2569 | with open(fname): | |
2569 | pass |
|
2570 | pass | |
2570 | except: |
|
2571 | except: | |
2571 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2572 | warn('Could not open file <%s> for safe execution.' % fname) | |
2572 | return |
|
2573 | return | |
2573 |
|
2574 | |||
2574 | # Find things also in current directory. This is needed to mimic the |
|
2575 | # Find things also in current directory. This is needed to mimic the | |
2575 | # behavior of running a script from the system command line, where |
|
2576 | # behavior of running a script from the system command line, where | |
2576 | # Python inserts the script's directory into sys.path |
|
2577 | # Python inserts the script's directory into sys.path | |
2577 | dname = os.path.dirname(fname) |
|
2578 | dname = os.path.dirname(fname) | |
2578 |
|
2579 | |||
2579 | def get_cells(): |
|
2580 | def get_cells(): | |
2580 | """generator for sequence of code blocks to run""" |
|
2581 | """generator for sequence of code blocks to run""" | |
2581 | if fname.endswith('.ipynb'): |
|
2582 | if fname.endswith('.ipynb'): | |
2582 | from nbformat import read |
|
2583 | from nbformat import read | |
2583 | nb = read(fname, as_version=4) |
|
2584 | nb = read(fname, as_version=4) | |
2584 | if not nb.cells: |
|
2585 | if not nb.cells: | |
2585 | return |
|
2586 | return | |
2586 | for cell in nb.cells: |
|
2587 | for cell in nb.cells: | |
2587 | if cell.cell_type == 'code': |
|
2588 | if cell.cell_type == 'code': | |
2588 | yield cell.source |
|
2589 | yield cell.source | |
2589 | else: |
|
2590 | else: | |
2590 | with open(fname) as f: |
|
2591 | with open(fname) as f: | |
2591 | yield f.read() |
|
2592 | yield f.read() | |
2592 |
|
2593 | |||
2593 | with prepended_to_syspath(dname): |
|
2594 | with prepended_to_syspath(dname): | |
2594 | try: |
|
2595 | try: | |
2595 | for cell in get_cells(): |
|
2596 | for cell in get_cells(): | |
2596 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2597 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) | |
2597 | if raise_exceptions: |
|
2598 | if raise_exceptions: | |
2598 | result.raise_error() |
|
2599 | result.raise_error() | |
2599 | elif not result.success: |
|
2600 | elif not result.success: | |
2600 | break |
|
2601 | break | |
2601 | except: |
|
2602 | except: | |
2602 | if raise_exceptions: |
|
2603 | if raise_exceptions: | |
2603 | raise |
|
2604 | raise | |
2604 | self.showtraceback() |
|
2605 | self.showtraceback() | |
2605 | warn('Unknown failure executing file: <%s>' % fname) |
|
2606 | warn('Unknown failure executing file: <%s>' % fname) | |
2606 |
|
2607 | |||
2607 | def safe_run_module(self, mod_name, where): |
|
2608 | def safe_run_module(self, mod_name, where): | |
2608 | """A safe version of runpy.run_module(). |
|
2609 | """A safe version of runpy.run_module(). | |
2609 |
|
2610 | |||
2610 | This version will never throw an exception, but instead print |
|
2611 | This version will never throw an exception, but instead print | |
2611 | helpful error messages to the screen. |
|
2612 | helpful error messages to the screen. | |
2612 |
|
2613 | |||
2613 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2614 | `SystemExit` exceptions with status code 0 or None are ignored. | |
2614 |
|
2615 | |||
2615 | Parameters |
|
2616 | Parameters | |
2616 | ---------- |
|
2617 | ---------- | |
2617 | mod_name : string |
|
2618 | mod_name : string | |
2618 | The name of the module to be executed. |
|
2619 | The name of the module to be executed. | |
2619 | where : dict |
|
2620 | where : dict | |
2620 | The globals namespace. |
|
2621 | The globals namespace. | |
2621 | """ |
|
2622 | """ | |
2622 | try: |
|
2623 | try: | |
2623 | try: |
|
2624 | try: | |
2624 | where.update( |
|
2625 | where.update( | |
2625 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2626 | runpy.run_module(str(mod_name), run_name="__main__", | |
2626 | alter_sys=True) |
|
2627 | alter_sys=True) | |
2627 | ) |
|
2628 | ) | |
2628 | except SystemExit as status: |
|
2629 | except SystemExit as status: | |
2629 | if status.code: |
|
2630 | if status.code: | |
2630 | raise |
|
2631 | raise | |
2631 | except: |
|
2632 | except: | |
2632 | self.showtraceback() |
|
2633 | self.showtraceback() | |
2633 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2634 | warn('Unknown failure executing module: <%s>' % mod_name) | |
2634 |
|
2635 | |||
2635 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2636 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): | |
2636 | """Run a complete IPython cell. |
|
2637 | """Run a complete IPython cell. | |
2637 |
|
2638 | |||
2638 | Parameters |
|
2639 | Parameters | |
2639 | ---------- |
|
2640 | ---------- | |
2640 | raw_cell : str |
|
2641 | raw_cell : str | |
2641 | The code (including IPython code such as %magic functions) to run. |
|
2642 | The code (including IPython code such as %magic functions) to run. | |
2642 | store_history : bool |
|
2643 | store_history : bool | |
2643 | If True, the raw and translated cell will be stored in IPython's |
|
2644 | If True, the raw and translated cell will be stored in IPython's | |
2644 | history. For user code calling back into IPython's machinery, this |
|
2645 | history. For user code calling back into IPython's machinery, this | |
2645 | should be set to False. |
|
2646 | should be set to False. | |
2646 | silent : bool |
|
2647 | silent : bool | |
2647 | If True, avoid side-effects, such as implicit displayhooks and |
|
2648 | If True, avoid side-effects, such as implicit displayhooks and | |
2648 | and logging. silent=True forces store_history=False. |
|
2649 | and logging. silent=True forces store_history=False. | |
2649 | shell_futures : bool |
|
2650 | shell_futures : bool | |
2650 | If True, the code will share future statements with the interactive |
|
2651 | If True, the code will share future statements with the interactive | |
2651 | shell. It will both be affected by previous __future__ imports, and |
|
2652 | shell. It will both be affected by previous __future__ imports, and | |
2652 | any __future__ imports in the code will affect the shell. If False, |
|
2653 | any __future__ imports in the code will affect the shell. If False, | |
2653 | __future__ imports are not shared in either direction. |
|
2654 | __future__ imports are not shared in either direction. | |
2654 |
|
2655 | |||
2655 | Returns |
|
2656 | Returns | |
2656 | ------- |
|
2657 | ------- | |
2657 | result : :class:`ExecutionResult` |
|
2658 | result : :class:`ExecutionResult` | |
2658 | """ |
|
2659 | """ | |
2659 | try: |
|
2660 | try: | |
2660 | result = self._run_cell( |
|
2661 | result = self._run_cell( | |
2661 | raw_cell, store_history, silent, shell_futures) |
|
2662 | raw_cell, store_history, silent, shell_futures) | |
2662 | finally: |
|
2663 | finally: | |
2663 | self.events.trigger('post_execute') |
|
2664 | self.events.trigger('post_execute') | |
2664 | if not silent: |
|
2665 | if not silent: | |
2665 | self.events.trigger('post_run_cell', result) |
|
2666 | self.events.trigger('post_run_cell', result) | |
2666 | return result |
|
2667 | return result | |
2667 |
|
2668 | |||
2668 | def _run_cell(self, raw_cell, store_history, silent, shell_futures): |
|
2669 | def _run_cell(self, raw_cell, store_history, silent, shell_futures): | |
2669 | """Internal method to run a complete IPython cell. |
|
2670 | """Internal method to run a complete IPython cell. | |
2670 |
|
2671 | |||
2671 | Parameters |
|
2672 | Parameters | |
2672 | ---------- |
|
2673 | ---------- | |
2673 | raw_cell : str |
|
2674 | raw_cell : str | |
2674 | store_history : bool |
|
2675 | store_history : bool | |
2675 | silent : bool |
|
2676 | silent : bool | |
2676 | shell_futures : bool |
|
2677 | shell_futures : bool | |
2677 |
|
2678 | |||
2678 | Returns |
|
2679 | Returns | |
2679 | ------- |
|
2680 | ------- | |
2680 | result : :class:`ExecutionResult` |
|
2681 | result : :class:`ExecutionResult` | |
2681 | """ |
|
2682 | """ | |
2682 | info = ExecutionInfo( |
|
2683 | info = ExecutionInfo( | |
2683 | raw_cell, store_history, silent, shell_futures) |
|
2684 | raw_cell, store_history, silent, shell_futures) | |
2684 | result = ExecutionResult(info) |
|
2685 | result = ExecutionResult(info) | |
2685 |
|
2686 | |||
2686 | if (not raw_cell) or raw_cell.isspace(): |
|
2687 | if (not raw_cell) or raw_cell.isspace(): | |
2687 | self.last_execution_succeeded = True |
|
2688 | self.last_execution_succeeded = True | |
2688 | self.last_execution_result = result |
|
2689 | self.last_execution_result = result | |
2689 | return result |
|
2690 | return result | |
2690 |
|
2691 | |||
2691 | if silent: |
|
2692 | if silent: | |
2692 | store_history = False |
|
2693 | store_history = False | |
2693 |
|
2694 | |||
2694 | if store_history: |
|
2695 | if store_history: | |
2695 | result.execution_count = self.execution_count |
|
2696 | result.execution_count = self.execution_count | |
2696 |
|
2697 | |||
2697 | def error_before_exec(value): |
|
2698 | def error_before_exec(value): | |
2698 | result.error_before_exec = value |
|
2699 | result.error_before_exec = value | |
2699 | self.last_execution_succeeded = False |
|
2700 | self.last_execution_succeeded = False | |
2700 | self.last_execution_result = result |
|
2701 | self.last_execution_result = result | |
2701 | return result |
|
2702 | return result | |
2702 |
|
2703 | |||
2703 | self.events.trigger('pre_execute') |
|
2704 | self.events.trigger('pre_execute') | |
2704 | if not silent: |
|
2705 | if not silent: | |
2705 | self.events.trigger('pre_run_cell', info) |
|
2706 | self.events.trigger('pre_run_cell', info) | |
2706 |
|
2707 | |||
2707 | # If any of our input transformation (input_transformer_manager or |
|
2708 | # If any of our input transformation (input_transformer_manager or | |
2708 | # prefilter_manager) raises an exception, we store it in this variable |
|
2709 | # prefilter_manager) raises an exception, we store it in this variable | |
2709 | # so that we can display the error after logging the input and storing |
|
2710 | # so that we can display the error after logging the input and storing | |
2710 | # it in the history. |
|
2711 | # it in the history. | |
2711 | preprocessing_exc_tuple = None |
|
2712 | preprocessing_exc_tuple = None | |
2712 | try: |
|
2713 | try: | |
2713 | # Static input transformations |
|
2714 | # Static input transformations | |
2714 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
2715 | cell = self.input_transformer_manager.transform_cell(raw_cell) | |
2715 | except SyntaxError: |
|
2716 | except SyntaxError: | |
2716 | preprocessing_exc_tuple = sys.exc_info() |
|
2717 | preprocessing_exc_tuple = sys.exc_info() | |
2717 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
2718 | cell = raw_cell # cell has to exist so it can be stored/logged | |
2718 | else: |
|
2719 | else: | |
2719 | if len(cell.splitlines()) == 1: |
|
2720 | if len(cell.splitlines()) == 1: | |
2720 | # Dynamic transformations - only applied for single line commands |
|
2721 | # Dynamic transformations - only applied for single line commands | |
2721 | with self.builtin_trap: |
|
2722 | with self.builtin_trap: | |
2722 | try: |
|
2723 | try: | |
2723 | # use prefilter_lines to handle trailing newlines |
|
2724 | # use prefilter_lines to handle trailing newlines | |
2724 | # restore trailing newline for ast.parse |
|
2725 | # restore trailing newline for ast.parse | |
2725 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2726 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
2726 | except Exception: |
|
2727 | except Exception: | |
2727 | # don't allow prefilter errors to crash IPython |
|
2728 | # don't allow prefilter errors to crash IPython | |
2728 | preprocessing_exc_tuple = sys.exc_info() |
|
2729 | preprocessing_exc_tuple = sys.exc_info() | |
2729 |
|
2730 | |||
2730 | # Store raw and processed history |
|
2731 | # Store raw and processed history | |
2731 | if store_history: |
|
2732 | if store_history: | |
2732 | self.history_manager.store_inputs(self.execution_count, |
|
2733 | self.history_manager.store_inputs(self.execution_count, | |
2733 | cell, raw_cell) |
|
2734 | cell, raw_cell) | |
2734 | if not silent: |
|
2735 | if not silent: | |
2735 | self.logger.log(cell, raw_cell) |
|
2736 | self.logger.log(cell, raw_cell) | |
2736 |
|
2737 | |||
2737 | # Display the exception if input processing failed. |
|
2738 | # Display the exception if input processing failed. | |
2738 | if preprocessing_exc_tuple is not None: |
|
2739 | if preprocessing_exc_tuple is not None: | |
2739 | self.showtraceback(preprocessing_exc_tuple) |
|
2740 | self.showtraceback(preprocessing_exc_tuple) | |
2740 | if store_history: |
|
2741 | if store_history: | |
2741 | self.execution_count += 1 |
|
2742 | self.execution_count += 1 | |
2742 | return error_before_exec(preprocessing_exc_tuple[2]) |
|
2743 | return error_before_exec(preprocessing_exc_tuple[2]) | |
2743 |
|
2744 | |||
2744 | # Our own compiler remembers the __future__ environment. If we want to |
|
2745 | # Our own compiler remembers the __future__ environment. If we want to | |
2745 | # run code with a separate __future__ environment, use the default |
|
2746 | # run code with a separate __future__ environment, use the default | |
2746 | # compiler |
|
2747 | # compiler | |
2747 | compiler = self.compile if shell_futures else CachingCompiler() |
|
2748 | compiler = self.compile if shell_futures else CachingCompiler() | |
2748 |
|
2749 | |||
2749 | with self.builtin_trap: |
|
2750 | with self.builtin_trap: | |
2750 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2751 | cell_name = self.compile.cache(cell, self.execution_count) | |
2751 |
|
2752 | |||
2752 | with self.display_trap: |
|
2753 | with self.display_trap: | |
2753 | # Compile to bytecode |
|
2754 | # Compile to bytecode | |
2754 | try: |
|
2755 | try: | |
2755 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
2756 | code_ast = compiler.ast_parse(cell, filename=cell_name) | |
2756 | except self.custom_exceptions as e: |
|
2757 | except self.custom_exceptions as e: | |
2757 | etype, value, tb = sys.exc_info() |
|
2758 | etype, value, tb = sys.exc_info() | |
2758 | self.CustomTB(etype, value, tb) |
|
2759 | self.CustomTB(etype, value, tb) | |
2759 | return error_before_exec(e) |
|
2760 | return error_before_exec(e) | |
2760 | except IndentationError as e: |
|
2761 | except IndentationError as e: | |
2761 | self.showindentationerror() |
|
2762 | self.showindentationerror() | |
2762 | if store_history: |
|
2763 | if store_history: | |
2763 | self.execution_count += 1 |
|
2764 | self.execution_count += 1 | |
2764 | return error_before_exec(e) |
|
2765 | return error_before_exec(e) | |
2765 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2766 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2766 | MemoryError) as e: |
|
2767 | MemoryError) as e: | |
2767 | self.showsyntaxerror() |
|
2768 | self.showsyntaxerror() | |
2768 | if store_history: |
|
2769 | if store_history: | |
2769 | self.execution_count += 1 |
|
2770 | self.execution_count += 1 | |
2770 | return error_before_exec(e) |
|
2771 | return error_before_exec(e) | |
2771 |
|
2772 | |||
2772 | # Apply AST transformations |
|
2773 | # Apply AST transformations | |
2773 | try: |
|
2774 | try: | |
2774 | code_ast = self.transform_ast(code_ast) |
|
2775 | code_ast = self.transform_ast(code_ast) | |
2775 | except InputRejected as e: |
|
2776 | except InputRejected as e: | |
2776 | self.showtraceback() |
|
2777 | self.showtraceback() | |
2777 | if store_history: |
|
2778 | if store_history: | |
2778 | self.execution_count += 1 |
|
2779 | self.execution_count += 1 | |
2779 | return error_before_exec(e) |
|
2780 | return error_before_exec(e) | |
2780 |
|
2781 | |||
2781 | # Give the displayhook a reference to our ExecutionResult so it |
|
2782 | # Give the displayhook a reference to our ExecutionResult so it | |
2782 | # can fill in the output value. |
|
2783 | # can fill in the output value. | |
2783 | self.displayhook.exec_result = result |
|
2784 | self.displayhook.exec_result = result | |
2784 |
|
2785 | |||
2785 | # Execute the user code |
|
2786 | # Execute the user code | |
2786 | interactivity = 'none' if silent else self.ast_node_interactivity |
|
2787 | interactivity = 'none' if silent else self.ast_node_interactivity | |
2787 | has_raised = self.run_ast_nodes(code_ast.body, cell_name, |
|
2788 | has_raised = self.run_ast_nodes(code_ast.body, cell_name, | |
2788 | interactivity=interactivity, compiler=compiler, result=result) |
|
2789 | interactivity=interactivity, compiler=compiler, result=result) | |
2789 |
|
2790 | |||
2790 | self.last_execution_succeeded = not has_raised |
|
2791 | self.last_execution_succeeded = not has_raised | |
2791 | self.last_execution_result = result |
|
2792 | self.last_execution_result = result | |
2792 |
|
2793 | |||
2793 | # Reset this so later displayed values do not modify the |
|
2794 | # Reset this so later displayed values do not modify the | |
2794 | # ExecutionResult |
|
2795 | # ExecutionResult | |
2795 | self.displayhook.exec_result = None |
|
2796 | self.displayhook.exec_result = None | |
2796 |
|
2797 | |||
2797 | if store_history: |
|
2798 | if store_history: | |
2798 | # Write output to the database. Does nothing unless |
|
2799 | # Write output to the database. Does nothing unless | |
2799 | # history output logging is enabled. |
|
2800 | # history output logging is enabled. | |
2800 | self.history_manager.store_output(self.execution_count) |
|
2801 | self.history_manager.store_output(self.execution_count) | |
2801 | # Each cell is a *single* input, regardless of how many lines it has |
|
2802 | # Each cell is a *single* input, regardless of how many lines it has | |
2802 | self.execution_count += 1 |
|
2803 | self.execution_count += 1 | |
2803 |
|
2804 | |||
2804 | return result |
|
2805 | return result | |
2805 |
|
2806 | |||
2806 | def transform_ast(self, node): |
|
2807 | def transform_ast(self, node): | |
2807 | """Apply the AST transformations from self.ast_transformers |
|
2808 | """Apply the AST transformations from self.ast_transformers | |
2808 |
|
2809 | |||
2809 | Parameters |
|
2810 | Parameters | |
2810 | ---------- |
|
2811 | ---------- | |
2811 | node : ast.Node |
|
2812 | node : ast.Node | |
2812 | The root node to be transformed. Typically called with the ast.Module |
|
2813 | The root node to be transformed. Typically called with the ast.Module | |
2813 | produced by parsing user input. |
|
2814 | produced by parsing user input. | |
2814 |
|
2815 | |||
2815 | Returns |
|
2816 | Returns | |
2816 | ------- |
|
2817 | ------- | |
2817 | An ast.Node corresponding to the node it was called with. Note that it |
|
2818 | An ast.Node corresponding to the node it was called with. Note that it | |
2818 | may also modify the passed object, so don't rely on references to the |
|
2819 | may also modify the passed object, so don't rely on references to the | |
2819 | original AST. |
|
2820 | original AST. | |
2820 | """ |
|
2821 | """ | |
2821 | for transformer in self.ast_transformers: |
|
2822 | for transformer in self.ast_transformers: | |
2822 | try: |
|
2823 | try: | |
2823 | node = transformer.visit(node) |
|
2824 | node = transformer.visit(node) | |
2824 | except InputRejected: |
|
2825 | except InputRejected: | |
2825 | # User-supplied AST transformers can reject an input by raising |
|
2826 | # User-supplied AST transformers can reject an input by raising | |
2826 | # an InputRejected. Short-circuit in this case so that we |
|
2827 | # an InputRejected. Short-circuit in this case so that we | |
2827 | # don't unregister the transform. |
|
2828 | # don't unregister the transform. | |
2828 | raise |
|
2829 | raise | |
2829 | except Exception: |
|
2830 | except Exception: | |
2830 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
2831 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) | |
2831 | self.ast_transformers.remove(transformer) |
|
2832 | self.ast_transformers.remove(transformer) | |
2832 |
|
2833 | |||
2833 | if self.ast_transformers: |
|
2834 | if self.ast_transformers: | |
2834 | ast.fix_missing_locations(node) |
|
2835 | ast.fix_missing_locations(node) | |
2835 | return node |
|
2836 | return node | |
2836 |
|
2837 | |||
2837 |
|
2838 | |||
2838 | def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
2839 | def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', | |
2839 | compiler=compile, result=None): |
|
2840 | compiler=compile, result=None): | |
2840 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2841 | """Run a sequence of AST nodes. The execution mode depends on the | |
2841 | interactivity parameter. |
|
2842 | interactivity parameter. | |
2842 |
|
2843 | |||
2843 | Parameters |
|
2844 | Parameters | |
2844 | ---------- |
|
2845 | ---------- | |
2845 | nodelist : list |
|
2846 | nodelist : list | |
2846 | A sequence of AST nodes to run. |
|
2847 | A sequence of AST nodes to run. | |
2847 | cell_name : str |
|
2848 | cell_name : str | |
2848 | Will be passed to the compiler as the filename of the cell. Typically |
|
2849 | Will be passed to the compiler as the filename of the cell. Typically | |
2849 | the value returned by ip.compile.cache(cell). |
|
2850 | the value returned by ip.compile.cache(cell). | |
2850 | interactivity : str |
|
2851 | interactivity : str | |
2851 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
2852 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', | |
2852 | specifying which nodes should be run interactively (displaying output |
|
2853 | specifying which nodes should be run interactively (displaying output | |
2853 | from expressions). 'last_expr' will run the last node interactively |
|
2854 | from expressions). 'last_expr' will run the last node interactively | |
2854 | only if it is an expression (i.e. expressions in loops or other blocks |
|
2855 | only if it is an expression (i.e. expressions in loops or other blocks | |
2855 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
2856 | are not displayed) 'last_expr_or_assign' will run the last expression | |
2856 | or the last assignment. Other values for this parameter will raise a |
|
2857 | or the last assignment. Other values for this parameter will raise a | |
2857 | ValueError. |
|
2858 | ValueError. | |
2858 | compiler : callable |
|
2859 | compiler : callable | |
2859 | A function with the same interface as the built-in compile(), to turn |
|
2860 | A function with the same interface as the built-in compile(), to turn | |
2860 | the AST nodes into code objects. Default is the built-in compile(). |
|
2861 | the AST nodes into code objects. Default is the built-in compile(). | |
2861 | result : ExecutionResult, optional |
|
2862 | result : ExecutionResult, optional | |
2862 | An object to store exceptions that occur during execution. |
|
2863 | An object to store exceptions that occur during execution. | |
2863 |
|
2864 | |||
2864 | Returns |
|
2865 | Returns | |
2865 | ------- |
|
2866 | ------- | |
2866 | True if an exception occurred while running code, False if it finished |
|
2867 | True if an exception occurred while running code, False if it finished | |
2867 | running. |
|
2868 | running. | |
2868 | """ |
|
2869 | """ | |
2869 | if not nodelist: |
|
2870 | if not nodelist: | |
2870 | return |
|
2871 | return | |
2871 |
|
2872 | |||
2872 | if interactivity == 'last_expr_or_assign': |
|
2873 | if interactivity == 'last_expr_or_assign': | |
2873 | if isinstance(nodelist[-1], _assign_nodes): |
|
2874 | if isinstance(nodelist[-1], _assign_nodes): | |
2874 | asg = nodelist[-1] |
|
2875 | asg = nodelist[-1] | |
2875 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
2876 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: | |
2876 | target = asg.targets[0] |
|
2877 | target = asg.targets[0] | |
2877 | elif isinstance(asg, _single_targets_nodes): |
|
2878 | elif isinstance(asg, _single_targets_nodes): | |
2878 | target = asg.target |
|
2879 | target = asg.target | |
2879 | else: |
|
2880 | else: | |
2880 | target = None |
|
2881 | target = None | |
2881 | if isinstance(target, ast.Name): |
|
2882 | if isinstance(target, ast.Name): | |
2882 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
2883 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) | |
2883 | ast.fix_missing_locations(nnode) |
|
2884 | ast.fix_missing_locations(nnode) | |
2884 | nodelist.append(nnode) |
|
2885 | nodelist.append(nnode) | |
2885 | interactivity = 'last_expr' |
|
2886 | interactivity = 'last_expr' | |
2886 |
|
2887 | |||
2887 | if interactivity == 'last_expr': |
|
2888 | if interactivity == 'last_expr': | |
2888 | if isinstance(nodelist[-1], ast.Expr): |
|
2889 | if isinstance(nodelist[-1], ast.Expr): | |
2889 | interactivity = "last" |
|
2890 | interactivity = "last" | |
2890 | else: |
|
2891 | else: | |
2891 | interactivity = "none" |
|
2892 | interactivity = "none" | |
2892 |
|
2893 | |||
2893 | if interactivity == 'none': |
|
2894 | if interactivity == 'none': | |
2894 | to_run_exec, to_run_interactive = nodelist, [] |
|
2895 | to_run_exec, to_run_interactive = nodelist, [] | |
2895 | elif interactivity == 'last': |
|
2896 | elif interactivity == 'last': | |
2896 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2897 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2897 | elif interactivity == 'all': |
|
2898 | elif interactivity == 'all': | |
2898 | to_run_exec, to_run_interactive = [], nodelist |
|
2899 | to_run_exec, to_run_interactive = [], nodelist | |
2899 | else: |
|
2900 | else: | |
2900 | raise ValueError("Interactivity was %r" % interactivity) |
|
2901 | raise ValueError("Interactivity was %r" % interactivity) | |
2901 |
|
2902 | |||
2902 | try: |
|
2903 | try: | |
2903 | for i, node in enumerate(to_run_exec): |
|
2904 | for i, node in enumerate(to_run_exec): | |
2904 | mod = ast.Module([node]) |
|
2905 | mod = ast.Module([node]) | |
2905 | code = compiler(mod, cell_name, "exec") |
|
2906 | code = compiler(mod, cell_name, "exec") | |
2906 | if self.run_code(code, result): |
|
2907 | if self.run_code(code, result): | |
2907 | return True |
|
2908 | return True | |
2908 |
|
2909 | |||
2909 | for i, node in enumerate(to_run_interactive): |
|
2910 | for i, node in enumerate(to_run_interactive): | |
2910 | mod = ast.Interactive([node]) |
|
2911 | mod = ast.Interactive([node]) | |
2911 | code = compiler(mod, cell_name, "single") |
|
2912 | code = compiler(mod, cell_name, "single") | |
2912 | if self.run_code(code, result): |
|
2913 | if self.run_code(code, result): | |
2913 | return True |
|
2914 | return True | |
2914 |
|
2915 | |||
2915 | # Flush softspace |
|
2916 | # Flush softspace | |
2916 | if softspace(sys.stdout, 0): |
|
2917 | if softspace(sys.stdout, 0): | |
2917 | print() |
|
2918 | print() | |
2918 |
|
2919 | |||
2919 | except: |
|
2920 | except: | |
2920 | # It's possible to have exceptions raised here, typically by |
|
2921 | # It's possible to have exceptions raised here, typically by | |
2921 | # compilation of odd code (such as a naked 'return' outside a |
|
2922 | # compilation of odd code (such as a naked 'return' outside a | |
2922 | # function) that did parse but isn't valid. Typically the exception |
|
2923 | # function) that did parse but isn't valid. Typically the exception | |
2923 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2924 | # is a SyntaxError, but it's safest just to catch anything and show | |
2924 | # the user a traceback. |
|
2925 | # the user a traceback. | |
2925 |
|
2926 | |||
2926 | # We do only one try/except outside the loop to minimize the impact |
|
2927 | # We do only one try/except outside the loop to minimize the impact | |
2927 | # on runtime, and also because if any node in the node list is |
|
2928 | # on runtime, and also because if any node in the node list is | |
2928 | # broken, we should stop execution completely. |
|
2929 | # broken, we should stop execution completely. | |
2929 | if result: |
|
2930 | if result: | |
2930 | result.error_before_exec = sys.exc_info()[1] |
|
2931 | result.error_before_exec = sys.exc_info()[1] | |
2931 | self.showtraceback() |
|
2932 | self.showtraceback() | |
2932 | return True |
|
2933 | return True | |
2933 |
|
2934 | |||
2934 | return False |
|
2935 | return False | |
2935 |
|
2936 | |||
2936 | def run_code(self, code_obj, result=None): |
|
2937 | def run_code(self, code_obj, result=None): | |
2937 | """Execute a code object. |
|
2938 | """Execute a code object. | |
2938 |
|
2939 | |||
2939 | When an exception occurs, self.showtraceback() is called to display a |
|
2940 | When an exception occurs, self.showtraceback() is called to display a | |
2940 | traceback. |
|
2941 | traceback. | |
2941 |
|
2942 | |||
2942 | Parameters |
|
2943 | Parameters | |
2943 | ---------- |
|
2944 | ---------- | |
2944 | code_obj : code object |
|
2945 | code_obj : code object | |
2945 | A compiled code object, to be executed |
|
2946 | A compiled code object, to be executed | |
2946 | result : ExecutionResult, optional |
|
2947 | result : ExecutionResult, optional | |
2947 | An object to store exceptions that occur during execution. |
|
2948 | An object to store exceptions that occur during execution. | |
2948 |
|
2949 | |||
2949 | Returns |
|
2950 | Returns | |
2950 | ------- |
|
2951 | ------- | |
2951 | False : successful execution. |
|
2952 | False : successful execution. | |
2952 | True : an error occurred. |
|
2953 | True : an error occurred. | |
2953 | """ |
|
2954 | """ | |
2954 | # Set our own excepthook in case the user code tries to call it |
|
2955 | # Set our own excepthook in case the user code tries to call it | |
2955 | # directly, so that the IPython crash handler doesn't get triggered |
|
2956 | # directly, so that the IPython crash handler doesn't get triggered | |
2956 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
2957 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook | |
2957 |
|
2958 | |||
2958 | # we save the original sys.excepthook in the instance, in case config |
|
2959 | # we save the original sys.excepthook in the instance, in case config | |
2959 | # code (such as magics) needs access to it. |
|
2960 | # code (such as magics) needs access to it. | |
2960 | self.sys_excepthook = old_excepthook |
|
2961 | self.sys_excepthook = old_excepthook | |
2961 | outflag = True # happens in more places, so it's easier as default |
|
2962 | outflag = True # happens in more places, so it's easier as default | |
2962 | try: |
|
2963 | try: | |
2963 | try: |
|
2964 | try: | |
2964 | self.hooks.pre_run_code_hook() |
|
2965 | self.hooks.pre_run_code_hook() | |
2965 | #rprint('Running code', repr(code_obj)) # dbg |
|
2966 | #rprint('Running code', repr(code_obj)) # dbg | |
2966 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
2967 | exec(code_obj, self.user_global_ns, self.user_ns) | |
2967 | finally: |
|
2968 | finally: | |
2968 | # Reset our crash handler in place |
|
2969 | # Reset our crash handler in place | |
2969 | sys.excepthook = old_excepthook |
|
2970 | sys.excepthook = old_excepthook | |
2970 | except SystemExit as e: |
|
2971 | except SystemExit as e: | |
2971 | if result is not None: |
|
2972 | if result is not None: | |
2972 | result.error_in_exec = e |
|
2973 | result.error_in_exec = e | |
2973 | self.showtraceback(exception_only=True) |
|
2974 | self.showtraceback(exception_only=True) | |
2974 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
2975 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) | |
2975 | except self.custom_exceptions: |
|
2976 | except self.custom_exceptions: | |
2976 | etype, value, tb = sys.exc_info() |
|
2977 | etype, value, tb = sys.exc_info() | |
2977 | if result is not None: |
|
2978 | if result is not None: | |
2978 | result.error_in_exec = value |
|
2979 | result.error_in_exec = value | |
2979 | self.CustomTB(etype, value, tb) |
|
2980 | self.CustomTB(etype, value, tb) | |
2980 | except: |
|
2981 | except: | |
2981 | if result is not None: |
|
2982 | if result is not None: | |
2982 | result.error_in_exec = sys.exc_info()[1] |
|
2983 | result.error_in_exec = sys.exc_info()[1] | |
2983 | self.showtraceback(running_compiled_code=True) |
|
2984 | self.showtraceback(running_compiled_code=True) | |
2984 | else: |
|
2985 | else: | |
2985 | outflag = False |
|
2986 | outflag = False | |
2986 | return outflag |
|
2987 | return outflag | |
2987 |
|
2988 | |||
2988 | # For backwards compatibility |
|
2989 | # For backwards compatibility | |
2989 | runcode = run_code |
|
2990 | runcode = run_code | |
2990 |
|
2991 | |||
2991 | #------------------------------------------------------------------------- |
|
2992 | #------------------------------------------------------------------------- | |
2992 | # Things related to GUI support and pylab |
|
2993 | # Things related to GUI support and pylab | |
2993 | #------------------------------------------------------------------------- |
|
2994 | #------------------------------------------------------------------------- | |
2994 |
|
2995 | |||
2995 | active_eventloop = None |
|
2996 | active_eventloop = None | |
2996 |
|
2997 | |||
2997 | def enable_gui(self, gui=None): |
|
2998 | def enable_gui(self, gui=None): | |
2998 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
2999 | raise NotImplementedError('Implement enable_gui in a subclass') | |
2999 |
|
3000 | |||
3000 | def enable_matplotlib(self, gui=None): |
|
3001 | def enable_matplotlib(self, gui=None): | |
3001 | """Enable interactive matplotlib and inline figure support. |
|
3002 | """Enable interactive matplotlib and inline figure support. | |
3002 |
|
3003 | |||
3003 | This takes the following steps: |
|
3004 | This takes the following steps: | |
3004 |
|
3005 | |||
3005 | 1. select the appropriate eventloop and matplotlib backend |
|
3006 | 1. select the appropriate eventloop and matplotlib backend | |
3006 | 2. set up matplotlib for interactive use with that backend |
|
3007 | 2. set up matplotlib for interactive use with that backend | |
3007 | 3. configure formatters for inline figure display |
|
3008 | 3. configure formatters for inline figure display | |
3008 | 4. enable the selected gui eventloop |
|
3009 | 4. enable the selected gui eventloop | |
3009 |
|
3010 | |||
3010 | Parameters |
|
3011 | Parameters | |
3011 | ---------- |
|
3012 | ---------- | |
3012 | gui : optional, string |
|
3013 | gui : optional, string | |
3013 | If given, dictates the choice of matplotlib GUI backend to use |
|
3014 | If given, dictates the choice of matplotlib GUI backend to use | |
3014 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3015 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
3015 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3016 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
3016 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3017 | matplotlib (as dictated by the matplotlib build-time options plus the | |
3017 | user's matplotlibrc configuration file). Note that not all backends |
|
3018 | user's matplotlibrc configuration file). Note that not all backends | |
3018 | make sense in all contexts, for example a terminal ipython can't |
|
3019 | make sense in all contexts, for example a terminal ipython can't | |
3019 | display figures inline. |
|
3020 | display figures inline. | |
3020 | """ |
|
3021 | """ | |
3021 | from IPython.core import pylabtools as pt |
|
3022 | from IPython.core import pylabtools as pt | |
3022 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3023 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) | |
3023 |
|
3024 | |||
3024 | if gui != 'inline': |
|
3025 | if gui != 'inline': | |
3025 | # If we have our first gui selection, store it |
|
3026 | # If we have our first gui selection, store it | |
3026 | if self.pylab_gui_select is None: |
|
3027 | if self.pylab_gui_select is None: | |
3027 | self.pylab_gui_select = gui |
|
3028 | self.pylab_gui_select = gui | |
3028 | # Otherwise if they are different |
|
3029 | # Otherwise if they are different | |
3029 | elif gui != self.pylab_gui_select: |
|
3030 | elif gui != self.pylab_gui_select: | |
3030 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3031 | print('Warning: Cannot change to a different GUI toolkit: %s.' | |
3031 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3032 | ' Using %s instead.' % (gui, self.pylab_gui_select)) | |
3032 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3033 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) | |
3033 |
|
3034 | |||
3034 | pt.activate_matplotlib(backend) |
|
3035 | pt.activate_matplotlib(backend) | |
3035 | pt.configure_inline_support(self, backend) |
|
3036 | pt.configure_inline_support(self, backend) | |
3036 |
|
3037 | |||
3037 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3038 | # Now we must activate the gui pylab wants to use, and fix %run to take | |
3038 | # plot updates into account |
|
3039 | # plot updates into account | |
3039 | self.enable_gui(gui) |
|
3040 | self.enable_gui(gui) | |
3040 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3041 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ | |
3041 | pt.mpl_runner(self.safe_execfile) |
|
3042 | pt.mpl_runner(self.safe_execfile) | |
3042 |
|
3043 | |||
3043 | return gui, backend |
|
3044 | return gui, backend | |
3044 |
|
3045 | |||
3045 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3046 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): | |
3046 | """Activate pylab support at runtime. |
|
3047 | """Activate pylab support at runtime. | |
3047 |
|
3048 | |||
3048 | This turns on support for matplotlib, preloads into the interactive |
|
3049 | This turns on support for matplotlib, preloads into the interactive | |
3049 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3050 | namespace all of numpy and pylab, and configures IPython to correctly | |
3050 | interact with the GUI event loop. The GUI backend to be used can be |
|
3051 | interact with the GUI event loop. The GUI backend to be used can be | |
3051 | optionally selected with the optional ``gui`` argument. |
|
3052 | optionally selected with the optional ``gui`` argument. | |
3052 |
|
3053 | |||
3053 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3054 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. | |
3054 |
|
3055 | |||
3055 | Parameters |
|
3056 | Parameters | |
3056 | ---------- |
|
3057 | ---------- | |
3057 | gui : optional, string |
|
3058 | gui : optional, string | |
3058 | If given, dictates the choice of matplotlib GUI backend to use |
|
3059 | If given, dictates the choice of matplotlib GUI backend to use | |
3059 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3060 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
3060 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3061 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
3061 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3062 | matplotlib (as dictated by the matplotlib build-time options plus the | |
3062 | user's matplotlibrc configuration file). Note that not all backends |
|
3063 | user's matplotlibrc configuration file). Note that not all backends | |
3063 | make sense in all contexts, for example a terminal ipython can't |
|
3064 | make sense in all contexts, for example a terminal ipython can't | |
3064 | display figures inline. |
|
3065 | display figures inline. | |
3065 | import_all : optional, bool, default: True |
|
3066 | import_all : optional, bool, default: True | |
3066 | Whether to do `from numpy import *` and `from pylab import *` |
|
3067 | Whether to do `from numpy import *` and `from pylab import *` | |
3067 | in addition to module imports. |
|
3068 | in addition to module imports. | |
3068 | welcome_message : deprecated |
|
3069 | welcome_message : deprecated | |
3069 | This argument is ignored, no welcome message will be displayed. |
|
3070 | This argument is ignored, no welcome message will be displayed. | |
3070 | """ |
|
3071 | """ | |
3071 | from IPython.core.pylabtools import import_pylab |
|
3072 | from IPython.core.pylabtools import import_pylab | |
3072 |
|
3073 | |||
3073 | gui, backend = self.enable_matplotlib(gui) |
|
3074 | gui, backend = self.enable_matplotlib(gui) | |
3074 |
|
3075 | |||
3075 | # We want to prevent the loading of pylab to pollute the user's |
|
3076 | # We want to prevent the loading of pylab to pollute the user's | |
3076 | # namespace as shown by the %who* magics, so we execute the activation |
|
3077 | # namespace as shown by the %who* magics, so we execute the activation | |
3077 | # code in an empty namespace, and we update *both* user_ns and |
|
3078 | # code in an empty namespace, and we update *both* user_ns and | |
3078 | # user_ns_hidden with this information. |
|
3079 | # user_ns_hidden with this information. | |
3079 | ns = {} |
|
3080 | ns = {} | |
3080 | import_pylab(ns, import_all) |
|
3081 | import_pylab(ns, import_all) | |
3081 | # warn about clobbered names |
|
3082 | # warn about clobbered names | |
3082 | ignored = {"__builtins__"} |
|
3083 | ignored = {"__builtins__"} | |
3083 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3084 | both = set(ns).intersection(self.user_ns).difference(ignored) | |
3084 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3085 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] | |
3085 | self.user_ns.update(ns) |
|
3086 | self.user_ns.update(ns) | |
3086 | self.user_ns_hidden.update(ns) |
|
3087 | self.user_ns_hidden.update(ns) | |
3087 | return gui, backend, clobbered |
|
3088 | return gui, backend, clobbered | |
3088 |
|
3089 | |||
3089 | #------------------------------------------------------------------------- |
|
3090 | #------------------------------------------------------------------------- | |
3090 | # Utilities |
|
3091 | # Utilities | |
3091 | #------------------------------------------------------------------------- |
|
3092 | #------------------------------------------------------------------------- | |
3092 |
|
3093 | |||
3093 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3094 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): | |
3094 | """Expand python variables in a string. |
|
3095 | """Expand python variables in a string. | |
3095 |
|
3096 | |||
3096 | The depth argument indicates how many frames above the caller should |
|
3097 | The depth argument indicates how many frames above the caller should | |
3097 | be walked to look for the local namespace where to expand variables. |
|
3098 | be walked to look for the local namespace where to expand variables. | |
3098 |
|
3099 | |||
3099 | The global namespace for expansion is always the user's interactive |
|
3100 | The global namespace for expansion is always the user's interactive | |
3100 | namespace. |
|
3101 | namespace. | |
3101 | """ |
|
3102 | """ | |
3102 | ns = self.user_ns.copy() |
|
3103 | ns = self.user_ns.copy() | |
3103 | try: |
|
3104 | try: | |
3104 | frame = sys._getframe(depth+1) |
|
3105 | frame = sys._getframe(depth+1) | |
3105 | except ValueError: |
|
3106 | except ValueError: | |
3106 | # This is thrown if there aren't that many frames on the stack, |
|
3107 | # This is thrown if there aren't that many frames on the stack, | |
3107 | # e.g. if a script called run_line_magic() directly. |
|
3108 | # e.g. if a script called run_line_magic() directly. | |
3108 | pass |
|
3109 | pass | |
3109 | else: |
|
3110 | else: | |
3110 | ns.update(frame.f_locals) |
|
3111 | ns.update(frame.f_locals) | |
3111 |
|
3112 | |||
3112 | try: |
|
3113 | try: | |
3113 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3114 | # We have to use .vformat() here, because 'self' is a valid and common | |
3114 | # name, and expanding **ns for .format() would make it collide with |
|
3115 | # name, and expanding **ns for .format() would make it collide with | |
3115 | # the 'self' argument of the method. |
|
3116 | # the 'self' argument of the method. | |
3116 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3117 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) | |
3117 | except Exception: |
|
3118 | except Exception: | |
3118 | # if formatter couldn't format, just let it go untransformed |
|
3119 | # if formatter couldn't format, just let it go untransformed | |
3119 | pass |
|
3120 | pass | |
3120 | return cmd |
|
3121 | return cmd | |
3121 |
|
3122 | |||
3122 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3123 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
3123 | """Make a new tempfile and return its filename. |
|
3124 | """Make a new tempfile and return its filename. | |
3124 |
|
3125 | |||
3125 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3126 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), | |
3126 | but it registers the created filename internally so ipython cleans it up |
|
3127 | but it registers the created filename internally so ipython cleans it up | |
3127 | at exit time. |
|
3128 | at exit time. | |
3128 |
|
3129 | |||
3129 | Optional inputs: |
|
3130 | Optional inputs: | |
3130 |
|
3131 | |||
3131 | - data(None): if data is given, it gets written out to the temp file |
|
3132 | - data(None): if data is given, it gets written out to the temp file | |
3132 | immediately, and the file is closed again.""" |
|
3133 | immediately, and the file is closed again.""" | |
3133 |
|
3134 | |||
3134 | dirname = tempfile.mkdtemp(prefix=prefix) |
|
3135 | dirname = tempfile.mkdtemp(prefix=prefix) | |
3135 | self.tempdirs.append(dirname) |
|
3136 | self.tempdirs.append(dirname) | |
3136 |
|
3137 | |||
3137 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) |
|
3138 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) | |
3138 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3139 | os.close(handle) # On Windows, there can only be one open handle on a file | |
3139 | self.tempfiles.append(filename) |
|
3140 | self.tempfiles.append(filename) | |
3140 |
|
3141 | |||
3141 | if data: |
|
3142 | if data: | |
3142 | tmp_file = open(filename,'w') |
|
3143 | tmp_file = open(filename,'w') | |
3143 | tmp_file.write(data) |
|
3144 | tmp_file.write(data) | |
3144 | tmp_file.close() |
|
3145 | tmp_file.close() | |
3145 | return filename |
|
3146 | return filename | |
3146 |
|
3147 | |||
3147 | @undoc |
|
3148 | @undoc | |
3148 | def write(self,data): |
|
3149 | def write(self,data): | |
3149 | """DEPRECATED: Write a string to the default output""" |
|
3150 | """DEPRECATED: Write a string to the default output""" | |
3150 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3151 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', | |
3151 | DeprecationWarning, stacklevel=2) |
|
3152 | DeprecationWarning, stacklevel=2) | |
3152 | sys.stdout.write(data) |
|
3153 | sys.stdout.write(data) | |
3153 |
|
3154 | |||
3154 | @undoc |
|
3155 | @undoc | |
3155 | def write_err(self,data): |
|
3156 | def write_err(self,data): | |
3156 | """DEPRECATED: Write a string to the default error output""" |
|
3157 | """DEPRECATED: Write a string to the default error output""" | |
3157 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3158 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', | |
3158 | DeprecationWarning, stacklevel=2) |
|
3159 | DeprecationWarning, stacklevel=2) | |
3159 | sys.stderr.write(data) |
|
3160 | sys.stderr.write(data) | |
3160 |
|
3161 | |||
3161 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3162 | def ask_yes_no(self, prompt, default=None, interrupt=None): | |
3162 | if self.quiet: |
|
3163 | if self.quiet: | |
3163 | return True |
|
3164 | return True | |
3164 | return ask_yes_no(prompt,default,interrupt) |
|
3165 | return ask_yes_no(prompt,default,interrupt) | |
3165 |
|
3166 | |||
3166 | def show_usage(self): |
|
3167 | def show_usage(self): | |
3167 | """Show a usage message""" |
|
3168 | """Show a usage message""" | |
3168 | page.page(IPython.core.usage.interactive_usage) |
|
3169 | page.page(IPython.core.usage.interactive_usage) | |
3169 |
|
3170 | |||
3170 | def extract_input_lines(self, range_str, raw=False): |
|
3171 | def extract_input_lines(self, range_str, raw=False): | |
3171 | """Return as a string a set of input history slices. |
|
3172 | """Return as a string a set of input history slices. | |
3172 |
|
3173 | |||
3173 | Parameters |
|
3174 | Parameters | |
3174 | ---------- |
|
3175 | ---------- | |
3175 | range_str : string |
|
3176 | range_str : string | |
3176 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3177 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", | |
3177 | since this function is for use by magic functions which get their |
|
3178 | since this function is for use by magic functions which get their | |
3178 | arguments as strings. The number before the / is the session |
|
3179 | arguments as strings. The number before the / is the session | |
3179 | number: ~n goes n back from the current session. |
|
3180 | number: ~n goes n back from the current session. | |
3180 |
|
3181 | |||
3181 | raw : bool, optional |
|
3182 | raw : bool, optional | |
3182 | By default, the processed input is used. If this is true, the raw |
|
3183 | By default, the processed input is used. If this is true, the raw | |
3183 | input history is used instead. |
|
3184 | input history is used instead. | |
3184 |
|
3185 | |||
3185 | Notes |
|
3186 | Notes | |
3186 | ----- |
|
3187 | ----- | |
3187 |
|
3188 | |||
3188 | Slices can be described with two notations: |
|
3189 | Slices can be described with two notations: | |
3189 |
|
3190 | |||
3190 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3191 | * ``N:M`` -> standard python form, means including items N...(M-1). | |
3191 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3192 | * ``N-M`` -> include items N..M (closed endpoint). | |
3192 | """ |
|
3193 | """ | |
3193 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3194 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) | |
3194 | return "\n".join(x for _, _, x in lines) |
|
3195 | return "\n".join(x for _, _, x in lines) | |
3195 |
|
3196 | |||
3196 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3197 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): | |
3197 | """Get a code string from history, file, url, or a string or macro. |
|
3198 | """Get a code string from history, file, url, or a string or macro. | |
3198 |
|
3199 | |||
3199 | This is mainly used by magic functions. |
|
3200 | This is mainly used by magic functions. | |
3200 |
|
3201 | |||
3201 | Parameters |
|
3202 | Parameters | |
3202 | ---------- |
|
3203 | ---------- | |
3203 |
|
3204 | |||
3204 | target : str |
|
3205 | target : str | |
3205 |
|
3206 | |||
3206 | A string specifying code to retrieve. This will be tried respectively |
|
3207 | A string specifying code to retrieve. This will be tried respectively | |
3207 | as: ranges of input history (see %history for syntax), url, |
|
3208 | as: ranges of input history (see %history for syntax), url, | |
3208 | corresponding .py file, filename, or an expression evaluating to a |
|
3209 | corresponding .py file, filename, or an expression evaluating to a | |
3209 | string or Macro in the user namespace. |
|
3210 | string or Macro in the user namespace. | |
3210 |
|
3211 | |||
3211 | raw : bool |
|
3212 | raw : bool | |
3212 | If true (default), retrieve raw history. Has no effect on the other |
|
3213 | If true (default), retrieve raw history. Has no effect on the other | |
3213 | retrieval mechanisms. |
|
3214 | retrieval mechanisms. | |
3214 |
|
3215 | |||
3215 | py_only : bool (default False) |
|
3216 | py_only : bool (default False) | |
3216 | Only try to fetch python code, do not try alternative methods to decode file |
|
3217 | Only try to fetch python code, do not try alternative methods to decode file | |
3217 | if unicode fails. |
|
3218 | if unicode fails. | |
3218 |
|
3219 | |||
3219 | Returns |
|
3220 | Returns | |
3220 | ------- |
|
3221 | ------- | |
3221 | A string of code. |
|
3222 | A string of code. | |
3222 |
|
3223 | |||
3223 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3224 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
3224 | to an object of another type. In each case, .args[0] is a printable |
|
3225 | to an object of another type. In each case, .args[0] is a printable | |
3225 | message. |
|
3226 | message. | |
3226 | """ |
|
3227 | """ | |
3227 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3228 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
3228 | if code: |
|
3229 | if code: | |
3229 | return code |
|
3230 | return code | |
3230 | try: |
|
3231 | try: | |
3231 | if target.startswith(('http://', 'https://')): |
|
3232 | if target.startswith(('http://', 'https://')): | |
3232 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3233 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) | |
3233 | except UnicodeDecodeError: |
|
3234 | except UnicodeDecodeError: | |
3234 | if not py_only : |
|
3235 | if not py_only : | |
3235 | # Deferred import |
|
3236 | # Deferred import | |
3236 | from urllib.request import urlopen |
|
3237 | from urllib.request import urlopen | |
3237 | response = urlopen(target) |
|
3238 | response = urlopen(target) | |
3238 | return response.read().decode('latin1') |
|
3239 | return response.read().decode('latin1') | |
3239 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3240 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
3240 |
|
3241 | |||
3241 | potential_target = [target] |
|
3242 | potential_target = [target] | |
3242 | try : |
|
3243 | try : | |
3243 | potential_target.insert(0,get_py_filename(target)) |
|
3244 | potential_target.insert(0,get_py_filename(target)) | |
3244 | except IOError: |
|
3245 | except IOError: | |
3245 | pass |
|
3246 | pass | |
3246 |
|
3247 | |||
3247 | for tgt in potential_target : |
|
3248 | for tgt in potential_target : | |
3248 | if os.path.isfile(tgt): # Read file |
|
3249 | if os.path.isfile(tgt): # Read file | |
3249 | try : |
|
3250 | try : | |
3250 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3251 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) | |
3251 | except UnicodeDecodeError : |
|
3252 | except UnicodeDecodeError : | |
3252 | if not py_only : |
|
3253 | if not py_only : | |
3253 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3254 | with io_open(tgt,'r', encoding='latin1') as f : | |
3254 | return f.read() |
|
3255 | return f.read() | |
3255 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3256 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
3256 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3257 | elif os.path.isdir(os.path.expanduser(tgt)): | |
3257 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3258 | raise ValueError("'%s' is a directory, not a regular file." % target) | |
3258 |
|
3259 | |||
3259 | if search_ns: |
|
3260 | if search_ns: | |
3260 | # Inspect namespace to load object source |
|
3261 | # Inspect namespace to load object source | |
3261 | object_info = self.object_inspect(target, detail_level=1) |
|
3262 | object_info = self.object_inspect(target, detail_level=1) | |
3262 | if object_info['found'] and object_info['source']: |
|
3263 | if object_info['found'] and object_info['source']: | |
3263 | return object_info['source'] |
|
3264 | return object_info['source'] | |
3264 |
|
3265 | |||
3265 | try: # User namespace |
|
3266 | try: # User namespace | |
3266 | codeobj = eval(target, self.user_ns) |
|
3267 | codeobj = eval(target, self.user_ns) | |
3267 | except Exception: |
|
3268 | except Exception: | |
3268 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3269 | raise ValueError(("'%s' was not found in history, as a file, url, " | |
3269 | "nor in the user namespace.") % target) |
|
3270 | "nor in the user namespace.") % target) | |
3270 |
|
3271 | |||
3271 | if isinstance(codeobj, str): |
|
3272 | if isinstance(codeobj, str): | |
3272 | return codeobj |
|
3273 | return codeobj | |
3273 | elif isinstance(codeobj, Macro): |
|
3274 | elif isinstance(codeobj, Macro): | |
3274 | return codeobj.value |
|
3275 | return codeobj.value | |
3275 |
|
3276 | |||
3276 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3277 | raise TypeError("%s is neither a string nor a macro." % target, | |
3277 | codeobj) |
|
3278 | codeobj) | |
3278 |
|
3279 | |||
3279 | #------------------------------------------------------------------------- |
|
3280 | #------------------------------------------------------------------------- | |
3280 | # Things related to IPython exiting |
|
3281 | # Things related to IPython exiting | |
3281 | #------------------------------------------------------------------------- |
|
3282 | #------------------------------------------------------------------------- | |
3282 | def atexit_operations(self): |
|
3283 | def atexit_operations(self): | |
3283 | """This will be executed at the time of exit. |
|
3284 | """This will be executed at the time of exit. | |
3284 |
|
3285 | |||
3285 | Cleanup operations and saving of persistent data that is done |
|
3286 | Cleanup operations and saving of persistent data that is done | |
3286 | unconditionally by IPython should be performed here. |
|
3287 | unconditionally by IPython should be performed here. | |
3287 |
|
3288 | |||
3288 | For things that may depend on startup flags or platform specifics (such |
|
3289 | For things that may depend on startup flags or platform specifics (such | |
3289 | as having readline or not), register a separate atexit function in the |
|
3290 | as having readline or not), register a separate atexit function in the | |
3290 | code that has the appropriate information, rather than trying to |
|
3291 | code that has the appropriate information, rather than trying to | |
3291 | clutter |
|
3292 | clutter | |
3292 | """ |
|
3293 | """ | |
3293 | # Close the history session (this stores the end time and line count) |
|
3294 | # Close the history session (this stores the end time and line count) | |
3294 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3295 | # this must be *before* the tempfile cleanup, in case of temporary | |
3295 | # history db |
|
3296 | # history db | |
3296 | self.history_manager.end_session() |
|
3297 | self.history_manager.end_session() | |
3297 |
|
3298 | |||
3298 | # Cleanup all tempfiles and folders left around |
|
3299 | # Cleanup all tempfiles and folders left around | |
3299 | for tfile in self.tempfiles: |
|
3300 | for tfile in self.tempfiles: | |
3300 | try: |
|
3301 | try: | |
3301 | os.unlink(tfile) |
|
3302 | os.unlink(tfile) | |
3302 | except OSError: |
|
3303 | except OSError: | |
3303 | pass |
|
3304 | pass | |
3304 |
|
3305 | |||
3305 | for tdir in self.tempdirs: |
|
3306 | for tdir in self.tempdirs: | |
3306 | try: |
|
3307 | try: | |
3307 | os.rmdir(tdir) |
|
3308 | os.rmdir(tdir) | |
3308 | except OSError: |
|
3309 | except OSError: | |
3309 | pass |
|
3310 | pass | |
3310 |
|
3311 | |||
3311 | # Clear all user namespaces to release all references cleanly. |
|
3312 | # Clear all user namespaces to release all references cleanly. | |
3312 | self.reset(new_session=False) |
|
3313 | self.reset(new_session=False) | |
3313 |
|
3314 | |||
3314 | # Run user hooks |
|
3315 | # Run user hooks | |
3315 | self.hooks.shutdown_hook() |
|
3316 | self.hooks.shutdown_hook() | |
3316 |
|
3317 | |||
3317 | def cleanup(self): |
|
3318 | def cleanup(self): | |
3318 | self.restore_sys_module_state() |
|
3319 | self.restore_sys_module_state() | |
3319 |
|
3320 | |||
3320 |
|
3321 | |||
3321 | # Overridden in terminal subclass to change prompts |
|
3322 | # Overridden in terminal subclass to change prompts | |
3322 | def switch_doctest_mode(self, mode): |
|
3323 | def switch_doctest_mode(self, mode): | |
3323 | pass |
|
3324 | pass | |
3324 |
|
3325 | |||
3325 |
|
3326 | |||
3326 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3327 | class InteractiveShellABC(metaclass=abc.ABCMeta): | |
3327 | """An abstract base class for InteractiveShell.""" |
|
3328 | """An abstract base class for InteractiveShell.""" | |
3328 |
|
3329 | |||
3329 | InteractiveShellABC.register(InteractiveShell) |
|
3330 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,1009 +1,1021 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """Tests for the IPython tab-completion machinery.""" |
|
2 | """Tests for the IPython tab-completion machinery.""" | |
3 |
|
3 | |||
4 | # Copyright (c) IPython Development Team. |
|
4 | # Copyright (c) IPython Development Team. | |
5 | # Distributed under the terms of the Modified BSD License. |
|
5 | # Distributed under the terms of the Modified BSD License. | |
6 |
|
6 | |||
7 | import os |
|
7 | import os | |
8 | import sys |
|
8 | import sys | |
9 | import textwrap |
|
9 | import textwrap | |
10 | import unittest |
|
10 | import unittest | |
11 |
|
11 | |||
12 | from contextlib import contextmanager |
|
12 | from contextlib import contextmanager | |
13 |
|
13 | |||
14 | import nose.tools as nt |
|
14 | import nose.tools as nt | |
15 |
|
15 | |||
16 | from traitlets.config.loader import Config |
|
16 | from traitlets.config.loader import Config | |
17 | from IPython import get_ipython |
|
17 | from IPython import get_ipython | |
18 | from IPython.core import completer |
|
18 | from IPython.core import completer | |
19 | from IPython.external.decorators import knownfailureif |
|
19 | from IPython.external.decorators import knownfailureif | |
20 | from IPython.utils.tempdir import TemporaryDirectory, TemporaryWorkingDirectory |
|
20 | from IPython.utils.tempdir import TemporaryDirectory, TemporaryWorkingDirectory | |
21 | from IPython.utils.generics import complete_object |
|
21 | from IPython.utils.generics import complete_object | |
22 | from IPython.testing import decorators as dec |
|
22 | from IPython.testing import decorators as dec | |
23 |
|
23 | |||
24 | from IPython.core.completer import ( |
|
24 | from IPython.core.completer import ( | |
25 | Completion, provisionalcompleter, match_dict_keys, _deduplicate_completions) |
|
25 | Completion, provisionalcompleter, match_dict_keys, _deduplicate_completions) | |
26 | from nose.tools import assert_in, assert_not_in |
|
26 | from nose.tools import assert_in, assert_not_in | |
27 |
|
27 | |||
28 | #----------------------------------------------------------------------------- |
|
28 | #----------------------------------------------------------------------------- | |
29 | # Test functions |
|
29 | # Test functions | |
30 | #----------------------------------------------------------------------------- |
|
30 | #----------------------------------------------------------------------------- | |
31 |
|
31 | |||
32 | @contextmanager |
|
32 | @contextmanager | |
33 | def greedy_completion(): |
|
33 | def greedy_completion(): | |
34 | ip = get_ipython() |
|
34 | ip = get_ipython() | |
35 | greedy_original = ip.Completer.greedy |
|
35 | greedy_original = ip.Completer.greedy | |
36 | try: |
|
36 | try: | |
37 | ip.Completer.greedy = True |
|
37 | ip.Completer.greedy = True | |
38 | yield |
|
38 | yield | |
39 | finally: |
|
39 | finally: | |
40 | ip.Completer.greedy = greedy_original |
|
40 | ip.Completer.greedy = greedy_original | |
41 |
|
41 | |||
42 | def test_protect_filename(): |
|
42 | def test_protect_filename(): | |
43 | if sys.platform == 'win32': |
|
43 | if sys.platform == 'win32': | |
44 | pairs = [('abc','abc'), |
|
44 | pairs = [('abc','abc'), | |
45 | (' abc','" abc"'), |
|
45 | (' abc','" abc"'), | |
46 | ('a bc','"a bc"'), |
|
46 | ('a bc','"a bc"'), | |
47 | ('a bc','"a bc"'), |
|
47 | ('a bc','"a bc"'), | |
48 | (' bc','" bc"'), |
|
48 | (' bc','" bc"'), | |
49 | ] |
|
49 | ] | |
50 | else: |
|
50 | else: | |
51 | pairs = [('abc','abc'), |
|
51 | pairs = [('abc','abc'), | |
52 | (' abc',r'\ abc'), |
|
52 | (' abc',r'\ abc'), | |
53 | ('a bc',r'a\ bc'), |
|
53 | ('a bc',r'a\ bc'), | |
54 | ('a bc',r'a\ \ bc'), |
|
54 | ('a bc',r'a\ \ bc'), | |
55 | (' bc',r'\ \ bc'), |
|
55 | (' bc',r'\ \ bc'), | |
56 | # On posix, we also protect parens and other special characters. |
|
56 | # On posix, we also protect parens and other special characters. | |
57 | ('a(bc',r'a\(bc'), |
|
57 | ('a(bc',r'a\(bc'), | |
58 | ('a)bc',r'a\)bc'), |
|
58 | ('a)bc',r'a\)bc'), | |
59 | ('a( )bc',r'a\(\ \)bc'), |
|
59 | ('a( )bc',r'a\(\ \)bc'), | |
60 | ('a[1]bc', r'a\[1\]bc'), |
|
60 | ('a[1]bc', r'a\[1\]bc'), | |
61 | ('a{1}bc', r'a\{1\}bc'), |
|
61 | ('a{1}bc', r'a\{1\}bc'), | |
62 | ('a#bc', r'a\#bc'), |
|
62 | ('a#bc', r'a\#bc'), | |
63 | ('a?bc', r'a\?bc'), |
|
63 | ('a?bc', r'a\?bc'), | |
64 | ('a=bc', r'a\=bc'), |
|
64 | ('a=bc', r'a\=bc'), | |
65 | ('a\\bc', r'a\\bc'), |
|
65 | ('a\\bc', r'a\\bc'), | |
66 | ('a|bc', r'a\|bc'), |
|
66 | ('a|bc', r'a\|bc'), | |
67 | ('a;bc', r'a\;bc'), |
|
67 | ('a;bc', r'a\;bc'), | |
68 | ('a:bc', r'a\:bc'), |
|
68 | ('a:bc', r'a\:bc'), | |
69 | ("a'bc", r"a\'bc"), |
|
69 | ("a'bc", r"a\'bc"), | |
70 | ('a*bc', r'a\*bc'), |
|
70 | ('a*bc', r'a\*bc'), | |
71 | ('a"bc', r'a\"bc'), |
|
71 | ('a"bc', r'a\"bc'), | |
72 | ('a^bc', r'a\^bc'), |
|
72 | ('a^bc', r'a\^bc'), | |
73 | ('a&bc', r'a\&bc'), |
|
73 | ('a&bc', r'a\&bc'), | |
74 | ] |
|
74 | ] | |
75 | # run the actual tests |
|
75 | # run the actual tests | |
76 | for s1, s2 in pairs: |
|
76 | for s1, s2 in pairs: | |
77 | s1p = completer.protect_filename(s1) |
|
77 | s1p = completer.protect_filename(s1) | |
78 | nt.assert_equal(s1p, s2) |
|
78 | nt.assert_equal(s1p, s2) | |
79 |
|
79 | |||
80 |
|
80 | |||
81 | def check_line_split(splitter, test_specs): |
|
81 | def check_line_split(splitter, test_specs): | |
82 | for part1, part2, split in test_specs: |
|
82 | for part1, part2, split in test_specs: | |
83 | cursor_pos = len(part1) |
|
83 | cursor_pos = len(part1) | |
84 | line = part1+part2 |
|
84 | line = part1+part2 | |
85 | out = splitter.split_line(line, cursor_pos) |
|
85 | out = splitter.split_line(line, cursor_pos) | |
86 | nt.assert_equal(out, split) |
|
86 | nt.assert_equal(out, split) | |
87 |
|
87 | |||
88 |
|
88 | |||
89 | def test_line_split(): |
|
89 | def test_line_split(): | |
90 | """Basic line splitter test with default specs.""" |
|
90 | """Basic line splitter test with default specs.""" | |
91 | sp = completer.CompletionSplitter() |
|
91 | sp = completer.CompletionSplitter() | |
92 | # The format of the test specs is: part1, part2, expected answer. Parts 1 |
|
92 | # The format of the test specs is: part1, part2, expected answer. Parts 1 | |
93 | # and 2 are joined into the 'line' sent to the splitter, as if the cursor |
|
93 | # and 2 are joined into the 'line' sent to the splitter, as if the cursor | |
94 | # was at the end of part1. So an empty part2 represents someone hitting |
|
94 | # was at the end of part1. So an empty part2 represents someone hitting | |
95 | # tab at the end of the line, the most common case. |
|
95 | # tab at the end of the line, the most common case. | |
96 | t = [('run some/scrip', '', 'some/scrip'), |
|
96 | t = [('run some/scrip', '', 'some/scrip'), | |
97 | ('run scripts/er', 'ror.py foo', 'scripts/er'), |
|
97 | ('run scripts/er', 'ror.py foo', 'scripts/er'), | |
98 | ('echo $HOM', '', 'HOM'), |
|
98 | ('echo $HOM', '', 'HOM'), | |
99 | ('print sys.pa', '', 'sys.pa'), |
|
99 | ('print sys.pa', '', 'sys.pa'), | |
100 | ('print(sys.pa', '', 'sys.pa'), |
|
100 | ('print(sys.pa', '', 'sys.pa'), | |
101 | ("execfile('scripts/er", '', 'scripts/er'), |
|
101 | ("execfile('scripts/er", '', 'scripts/er'), | |
102 | ('a[x.', '', 'x.'), |
|
102 | ('a[x.', '', 'x.'), | |
103 | ('a[x.', 'y', 'x.'), |
|
103 | ('a[x.', 'y', 'x.'), | |
104 | ('cd "some_file/', '', 'some_file/'), |
|
104 | ('cd "some_file/', '', 'some_file/'), | |
105 | ] |
|
105 | ] | |
106 | check_line_split(sp, t) |
|
106 | check_line_split(sp, t) | |
107 | # Ensure splitting works OK with unicode by re-running the tests with |
|
107 | # Ensure splitting works OK with unicode by re-running the tests with | |
108 | # all inputs turned into unicode |
|
108 | # all inputs turned into unicode | |
109 | check_line_split(sp, [ map(str, p) for p in t] ) |
|
109 | check_line_split(sp, [ map(str, p) for p in t] ) | |
110 |
|
110 | |||
111 |
|
111 | |||
112 | def test_custom_completion_error(): |
|
112 | def test_custom_completion_error(): | |
113 | """Test that errors from custom attribute completers are silenced.""" |
|
113 | """Test that errors from custom attribute completers are silenced.""" | |
114 | ip = get_ipython() |
|
114 | ip = get_ipython() | |
115 | class A(object): pass |
|
115 | class A(object): pass | |
116 | ip.user_ns['a'] = A() |
|
116 | ip.user_ns['a'] = A() | |
117 |
|
117 | |||
118 | @complete_object.when_type(A) |
|
118 | @complete_object.when_type(A) | |
119 | def complete_A(a, existing_completions): |
|
119 | def complete_A(a, existing_completions): | |
120 | raise TypeError("this should be silenced") |
|
120 | raise TypeError("this should be silenced") | |
121 |
|
121 | |||
122 | ip.complete("a.") |
|
122 | ip.complete("a.") | |
123 |
|
123 | |||
124 |
|
124 | |||
125 | def test_unicode_completions(): |
|
125 | def test_unicode_completions(): | |
126 | ip = get_ipython() |
|
126 | ip = get_ipython() | |
127 | # Some strings that trigger different types of completion. Check them both |
|
127 | # Some strings that trigger different types of completion. Check them both | |
128 | # in str and unicode forms |
|
128 | # in str and unicode forms | |
129 | s = ['ru', '%ru', 'cd /', 'floa', 'float(x)/'] |
|
129 | s = ['ru', '%ru', 'cd /', 'floa', 'float(x)/'] | |
130 | for t in s + list(map(str, s)): |
|
130 | for t in s + list(map(str, s)): | |
131 | # We don't need to check exact completion values (they may change |
|
131 | # We don't need to check exact completion values (they may change | |
132 | # depending on the state of the namespace, but at least no exceptions |
|
132 | # depending on the state of the namespace, but at least no exceptions | |
133 | # should be thrown and the return value should be a pair of text, list |
|
133 | # should be thrown and the return value should be a pair of text, list | |
134 | # values. |
|
134 | # values. | |
135 | text, matches = ip.complete(t) |
|
135 | text, matches = ip.complete(t) | |
136 | nt.assert_true(isinstance(text, str)) |
|
136 | nt.assert_true(isinstance(text, str)) | |
137 | nt.assert_true(isinstance(matches, list)) |
|
137 | nt.assert_true(isinstance(matches, list)) | |
138 |
|
138 | |||
139 | def test_latex_completions(): |
|
139 | def test_latex_completions(): | |
140 | from IPython.core.latex_symbols import latex_symbols |
|
140 | from IPython.core.latex_symbols import latex_symbols | |
141 | import random |
|
141 | import random | |
142 | ip = get_ipython() |
|
142 | ip = get_ipython() | |
143 | # Test some random unicode symbols |
|
143 | # Test some random unicode symbols | |
144 | keys = random.sample(latex_symbols.keys(), 10) |
|
144 | keys = random.sample(latex_symbols.keys(), 10) | |
145 | for k in keys: |
|
145 | for k in keys: | |
146 | text, matches = ip.complete(k) |
|
146 | text, matches = ip.complete(k) | |
147 | nt.assert_equal(len(matches),1) |
|
147 | nt.assert_equal(len(matches),1) | |
148 | nt.assert_equal(text, k) |
|
148 | nt.assert_equal(text, k) | |
149 | nt.assert_equal(matches[0], latex_symbols[k]) |
|
149 | nt.assert_equal(matches[0], latex_symbols[k]) | |
150 | # Test a more complex line |
|
150 | # Test a more complex line | |
151 | text, matches = ip.complete(u'print(\\alpha') |
|
151 | text, matches = ip.complete(u'print(\\alpha') | |
152 | nt.assert_equal(text, u'\\alpha') |
|
152 | nt.assert_equal(text, u'\\alpha') | |
153 | nt.assert_equal(matches[0], latex_symbols['\\alpha']) |
|
153 | nt.assert_equal(matches[0], latex_symbols['\\alpha']) | |
154 | # Test multiple matching latex symbols |
|
154 | # Test multiple matching latex symbols | |
155 | text, matches = ip.complete(u'\\al') |
|
155 | text, matches = ip.complete(u'\\al') | |
156 | nt.assert_in('\\alpha', matches) |
|
156 | nt.assert_in('\\alpha', matches) | |
157 | nt.assert_in('\\aleph', matches) |
|
157 | nt.assert_in('\\aleph', matches) | |
158 |
|
158 | |||
159 |
|
159 | |||
160 |
|
160 | |||
161 |
|
161 | |||
162 | def test_back_latex_completion(): |
|
162 | def test_back_latex_completion(): | |
163 | ip = get_ipython() |
|
163 | ip = get_ipython() | |
164 |
|
164 | |||
165 | # do not return more than 1 matches fro \beta, only the latex one. |
|
165 | # do not return more than 1 matches fro \beta, only the latex one. | |
166 | name, matches = ip.complete('\\Ξ²') |
|
166 | name, matches = ip.complete('\\Ξ²') | |
167 | nt.assert_equal(len(matches), 1) |
|
167 | nt.assert_equal(len(matches), 1) | |
168 | nt.assert_equal(matches[0], '\\beta') |
|
168 | nt.assert_equal(matches[0], '\\beta') | |
169 |
|
169 | |||
170 | def test_back_unicode_completion(): |
|
170 | def test_back_unicode_completion(): | |
171 | ip = get_ipython() |
|
171 | ip = get_ipython() | |
172 |
|
172 | |||
173 | name, matches = ip.complete('\\β €') |
|
173 | name, matches = ip.complete('\\β €') | |
174 | nt.assert_equal(len(matches), 1) |
|
174 | nt.assert_equal(len(matches), 1) | |
175 | nt.assert_equal(matches[0], '\\ROMAN NUMERAL FIVE') |
|
175 | nt.assert_equal(matches[0], '\\ROMAN NUMERAL FIVE') | |
176 |
|
176 | |||
177 |
|
177 | |||
178 | def test_forward_unicode_completion(): |
|
178 | def test_forward_unicode_completion(): | |
179 | ip = get_ipython() |
|
179 | ip = get_ipython() | |
180 |
|
180 | |||
181 | name, matches = ip.complete('\\ROMAN NUMERAL FIVE') |
|
181 | name, matches = ip.complete('\\ROMAN NUMERAL FIVE') | |
182 | nt.assert_equal(len(matches), 1) |
|
182 | nt.assert_equal(len(matches), 1) | |
183 | nt.assert_equal(matches[0], 'β €') |
|
183 | nt.assert_equal(matches[0], 'β €') | |
184 |
|
184 | |||
185 | @dec.knownfailureif(sys.platform == 'win32', 'Fails if there is a C:\\j... path') |
|
185 | @dec.knownfailureif(sys.platform == 'win32', 'Fails if there is a C:\\j... path') | |
186 | def test_no_ascii_back_completion(): |
|
186 | def test_no_ascii_back_completion(): | |
187 | ip = get_ipython() |
|
187 | ip = get_ipython() | |
188 | with TemporaryWorkingDirectory(): # Avoid any filename completions |
|
188 | with TemporaryWorkingDirectory(): # Avoid any filename completions | |
189 | # single ascii letter that don't have yet completions |
|
189 | # single ascii letter that don't have yet completions | |
190 | for letter in 'jJ' : |
|
190 | for letter in 'jJ' : | |
191 | name, matches = ip.complete('\\'+letter) |
|
191 | name, matches = ip.complete('\\'+letter) | |
192 | nt.assert_equal(matches, []) |
|
192 | nt.assert_equal(matches, []) | |
193 |
|
193 | |||
194 |
|
194 | |||
195 |
|
195 | |||
196 |
|
196 | |||
197 | class CompletionSplitterTestCase(unittest.TestCase): |
|
197 | class CompletionSplitterTestCase(unittest.TestCase): | |
198 | def setUp(self): |
|
198 | def setUp(self): | |
199 | self.sp = completer.CompletionSplitter() |
|
199 | self.sp = completer.CompletionSplitter() | |
200 |
|
200 | |||
201 | def test_delim_setting(self): |
|
201 | def test_delim_setting(self): | |
202 | self.sp.delims = ' ' |
|
202 | self.sp.delims = ' ' | |
203 | nt.assert_equal(self.sp.delims, ' ') |
|
203 | nt.assert_equal(self.sp.delims, ' ') | |
204 | nt.assert_equal(self.sp._delim_expr, '[\ ]') |
|
204 | nt.assert_equal(self.sp._delim_expr, '[\ ]') | |
205 |
|
205 | |||
206 | def test_spaces(self): |
|
206 | def test_spaces(self): | |
207 | """Test with only spaces as split chars.""" |
|
207 | """Test with only spaces as split chars.""" | |
208 | self.sp.delims = ' ' |
|
208 | self.sp.delims = ' ' | |
209 | t = [('foo', '', 'foo'), |
|
209 | t = [('foo', '', 'foo'), | |
210 | ('run foo', '', 'foo'), |
|
210 | ('run foo', '', 'foo'), | |
211 | ('run foo', 'bar', 'foo'), |
|
211 | ('run foo', 'bar', 'foo'), | |
212 | ] |
|
212 | ] | |
213 | check_line_split(self.sp, t) |
|
213 | check_line_split(self.sp, t) | |
214 |
|
214 | |||
215 |
|
215 | |||
216 | def test_has_open_quotes1(): |
|
216 | def test_has_open_quotes1(): | |
217 | for s in ["'", "'''", "'hi' '"]: |
|
217 | for s in ["'", "'''", "'hi' '"]: | |
218 | nt.assert_equal(completer.has_open_quotes(s), "'") |
|
218 | nt.assert_equal(completer.has_open_quotes(s), "'") | |
219 |
|
219 | |||
220 |
|
220 | |||
221 | def test_has_open_quotes2(): |
|
221 | def test_has_open_quotes2(): | |
222 | for s in ['"', '"""', '"hi" "']: |
|
222 | for s in ['"', '"""', '"hi" "']: | |
223 | nt.assert_equal(completer.has_open_quotes(s), '"') |
|
223 | nt.assert_equal(completer.has_open_quotes(s), '"') | |
224 |
|
224 | |||
225 |
|
225 | |||
226 | def test_has_open_quotes3(): |
|
226 | def test_has_open_quotes3(): | |
227 | for s in ["''", "''' '''", "'hi' 'ipython'"]: |
|
227 | for s in ["''", "''' '''", "'hi' 'ipython'"]: | |
228 | nt.assert_false(completer.has_open_quotes(s)) |
|
228 | nt.assert_false(completer.has_open_quotes(s)) | |
229 |
|
229 | |||
230 |
|
230 | |||
231 | def test_has_open_quotes4(): |
|
231 | def test_has_open_quotes4(): | |
232 | for s in ['""', '""" """', '"hi" "ipython"']: |
|
232 | for s in ['""', '""" """', '"hi" "ipython"']: | |
233 | nt.assert_false(completer.has_open_quotes(s)) |
|
233 | nt.assert_false(completer.has_open_quotes(s)) | |
234 |
|
234 | |||
235 |
|
235 | |||
236 | @knownfailureif(sys.platform == 'win32', "abspath completions fail on Windows") |
|
236 | @knownfailureif(sys.platform == 'win32', "abspath completions fail on Windows") | |
237 | def test_abspath_file_completions(): |
|
237 | def test_abspath_file_completions(): | |
238 | ip = get_ipython() |
|
238 | ip = get_ipython() | |
239 | with TemporaryDirectory() as tmpdir: |
|
239 | with TemporaryDirectory() as tmpdir: | |
240 | prefix = os.path.join(tmpdir, 'foo') |
|
240 | prefix = os.path.join(tmpdir, 'foo') | |
241 | suffixes = ['1', '2'] |
|
241 | suffixes = ['1', '2'] | |
242 | names = [prefix+s for s in suffixes] |
|
242 | names = [prefix+s for s in suffixes] | |
243 | for n in names: |
|
243 | for n in names: | |
244 | open(n, 'w').close() |
|
244 | open(n, 'w').close() | |
245 |
|
245 | |||
246 | # Check simple completion |
|
246 | # Check simple completion | |
247 | c = ip.complete(prefix)[1] |
|
247 | c = ip.complete(prefix)[1] | |
248 | nt.assert_equal(c, names) |
|
248 | nt.assert_equal(c, names) | |
249 |
|
249 | |||
250 | # Now check with a function call |
|
250 | # Now check with a function call | |
251 | cmd = 'a = f("%s' % prefix |
|
251 | cmd = 'a = f("%s' % prefix | |
252 | c = ip.complete(prefix, cmd)[1] |
|
252 | c = ip.complete(prefix, cmd)[1] | |
253 | comp = [prefix+s for s in suffixes] |
|
253 | comp = [prefix+s for s in suffixes] | |
254 | nt.assert_equal(c, comp) |
|
254 | nt.assert_equal(c, comp) | |
255 |
|
255 | |||
256 |
|
256 | |||
257 | def test_local_file_completions(): |
|
257 | def test_local_file_completions(): | |
258 | ip = get_ipython() |
|
258 | ip = get_ipython() | |
259 | with TemporaryWorkingDirectory(): |
|
259 | with TemporaryWorkingDirectory(): | |
260 | prefix = './foo' |
|
260 | prefix = './foo' | |
261 | suffixes = ['1', '2'] |
|
261 | suffixes = ['1', '2'] | |
262 | names = [prefix+s for s in suffixes] |
|
262 | names = [prefix+s for s in suffixes] | |
263 | for n in names: |
|
263 | for n in names: | |
264 | open(n, 'w').close() |
|
264 | open(n, 'w').close() | |
265 |
|
265 | |||
266 | # Check simple completion |
|
266 | # Check simple completion | |
267 | c = ip.complete(prefix)[1] |
|
267 | c = ip.complete(prefix)[1] | |
268 | nt.assert_equal(c, names) |
|
268 | nt.assert_equal(c, names) | |
269 |
|
269 | |||
270 | # Now check with a function call |
|
270 | # Now check with a function call | |
271 | cmd = 'a = f("%s' % prefix |
|
271 | cmd = 'a = f("%s' % prefix | |
272 | c = ip.complete(prefix, cmd)[1] |
|
272 | c = ip.complete(prefix, cmd)[1] | |
273 | comp = set(prefix+s for s in suffixes) |
|
273 | comp = set(prefix+s for s in suffixes) | |
274 | nt.assert_true(comp.issubset(set(c))) |
|
274 | nt.assert_true(comp.issubset(set(c))) | |
275 |
|
275 | |||
276 |
|
276 | |||
277 | def test_quoted_file_completions(): |
|
277 | def test_quoted_file_completions(): | |
278 | ip = get_ipython() |
|
278 | ip = get_ipython() | |
279 | with TemporaryWorkingDirectory(): |
|
279 | with TemporaryWorkingDirectory(): | |
280 | name = "foo'bar" |
|
280 | name = "foo'bar" | |
281 | open(name, 'w').close() |
|
281 | open(name, 'w').close() | |
282 |
|
282 | |||
283 | # Don't escape Windows |
|
283 | # Don't escape Windows | |
284 | escaped = name if sys.platform == "win32" else "foo\\'bar" |
|
284 | escaped = name if sys.platform == "win32" else "foo\\'bar" | |
285 |
|
285 | |||
286 | # Single quote matches embedded single quote |
|
286 | # Single quote matches embedded single quote | |
287 | text = "open('foo" |
|
287 | text = "open('foo" | |
288 | c = ip.Completer._complete(cursor_line=0, |
|
288 | c = ip.Completer._complete(cursor_line=0, | |
289 | cursor_pos=len(text), |
|
289 | cursor_pos=len(text), | |
290 | full_text=text)[1] |
|
290 | full_text=text)[1] | |
291 | nt.assert_equal(c, [escaped]) |
|
291 | nt.assert_equal(c, [escaped]) | |
292 |
|
292 | |||
293 | # Double quote requires no escape |
|
293 | # Double quote requires no escape | |
294 | text = 'open("foo' |
|
294 | text = 'open("foo' | |
295 | c = ip.Completer._complete(cursor_line=0, |
|
295 | c = ip.Completer._complete(cursor_line=0, | |
296 | cursor_pos=len(text), |
|
296 | cursor_pos=len(text), | |
297 | full_text=text)[1] |
|
297 | full_text=text)[1] | |
298 | nt.assert_equal(c, [name]) |
|
298 | nt.assert_equal(c, [name]) | |
299 |
|
299 | |||
300 | # No quote requires an escape |
|
300 | # No quote requires an escape | |
301 | text = '%ls foo' |
|
301 | text = '%ls foo' | |
302 | c = ip.Completer._complete(cursor_line=0, |
|
302 | c = ip.Completer._complete(cursor_line=0, | |
303 | cursor_pos=len(text), |
|
303 | cursor_pos=len(text), | |
304 | full_text=text)[1] |
|
304 | full_text=text)[1] | |
305 | nt.assert_equal(c, [escaped]) |
|
305 | nt.assert_equal(c, [escaped]) | |
306 |
|
306 | |||
307 |
|
307 | |||
308 | def test_jedi(): |
|
308 | def test_jedi(): | |
309 | """ |
|
309 | """ | |
310 | A couple of issue we had with Jedi |
|
310 | A couple of issue we had with Jedi | |
311 | """ |
|
311 | """ | |
312 | ip = get_ipython() |
|
312 | ip = get_ipython() | |
313 |
|
313 | |||
314 | def _test_complete(reason, s, comp, start=None, end=None): |
|
314 | def _test_complete(reason, s, comp, start=None, end=None): | |
315 | l = len(s) |
|
315 | l = len(s) | |
316 | start = start if start is not None else l |
|
316 | start = start if start is not None else l | |
317 | end = end if end is not None else l |
|
317 | end = end if end is not None else l | |
318 | with provisionalcompleter(): |
|
318 | with provisionalcompleter(): | |
319 | completions = set(ip.Completer.completions(s, l)) |
|
319 | completions = set(ip.Completer.completions(s, l)) | |
320 | assert_in(Completion(start, end, comp), completions, reason) |
|
320 | assert_in(Completion(start, end, comp), completions, reason) | |
321 |
|
321 | |||
322 | def _test_not_complete(reason, s, comp): |
|
322 | def _test_not_complete(reason, s, comp): | |
323 | l = len(s) |
|
323 | l = len(s) | |
324 | with provisionalcompleter(): |
|
324 | with provisionalcompleter(): | |
325 | completions = set(ip.Completer.completions(s, l)) |
|
325 | completions = set(ip.Completer.completions(s, l)) | |
326 | assert_not_in(Completion(l, l, comp), completions, reason) |
|
326 | assert_not_in(Completion(l, l, comp), completions, reason) | |
327 |
|
327 | |||
328 | import jedi |
|
328 | import jedi | |
329 | jedi_version = tuple(int(i) for i in jedi.__version__.split('.')[:3]) |
|
329 | jedi_version = tuple(int(i) for i in jedi.__version__.split('.')[:3]) | |
330 | if jedi_version > (0, 10): |
|
330 | if jedi_version > (0, 10): | |
331 | yield _test_complete, 'jedi >0.9 should complete and not crash', 'a=1;a.', 'real' |
|
331 | yield _test_complete, 'jedi >0.9 should complete and not crash', 'a=1;a.', 'real' | |
332 | yield _test_complete, 'can infer first argument', 'a=(1,"foo");a[0].', 'real' |
|
332 | yield _test_complete, 'can infer first argument', 'a=(1,"foo");a[0].', 'real' | |
333 | yield _test_complete, 'can infer second argument', 'a=(1,"foo");a[1].', 'capitalize' |
|
333 | yield _test_complete, 'can infer second argument', 'a=(1,"foo");a[1].', 'capitalize' | |
334 | yield _test_complete, 'cover duplicate completions', 'im', 'import', 0, 2 |
|
334 | yield _test_complete, 'cover duplicate completions', 'im', 'import', 0, 2 | |
335 |
|
335 | |||
336 | yield _test_not_complete, 'does not mix types', 'a=(1,"foo");a[0].', 'capitalize' |
|
336 | yield _test_not_complete, 'does not mix types', 'a=(1,"foo");a[0].', 'capitalize' | |
337 |
|
337 | |||
338 | def test_completion_have_signature(): |
|
338 | def test_completion_have_signature(): | |
339 | """ |
|
339 | """ | |
340 | Lets make sure jedi is capable of pulling out the signature of the function we are completing. |
|
340 | Lets make sure jedi is capable of pulling out the signature of the function we are completing. | |
341 | """ |
|
341 | """ | |
342 | ip = get_ipython() |
|
342 | ip = get_ipython() | |
343 | with provisionalcompleter(): |
|
343 | with provisionalcompleter(): | |
344 | completions = ip.Completer.completions('ope', 3) |
|
344 | completions = ip.Completer.completions('ope', 3) | |
345 | c = next(completions) # should be `open` |
|
345 | c = next(completions) # should be `open` | |
346 | assert 'file' in c.signature, "Signature of function was not found by completer" |
|
346 | assert 'file' in c.signature, "Signature of function was not found by completer" | |
347 | assert 'encoding' in c.signature, "Signature of function was not found by completer" |
|
347 | assert 'encoding' in c.signature, "Signature of function was not found by completer" | |
348 |
|
348 | |||
349 |
|
349 | |||
350 | def test_deduplicate_completions(): |
|
350 | def test_deduplicate_completions(): | |
351 | """ |
|
351 | """ | |
352 | Test that completions are correctly deduplicated (even if ranges are not the same) |
|
352 | Test that completions are correctly deduplicated (even if ranges are not the same) | |
353 | """ |
|
353 | """ | |
354 | ip = get_ipython() |
|
354 | ip = get_ipython() | |
355 | ip.ex(textwrap.dedent(''' |
|
355 | ip.ex(textwrap.dedent(''' | |
356 | class Z: |
|
356 | class Z: | |
357 | zoo = 1 |
|
357 | zoo = 1 | |
358 | ''')) |
|
358 | ''')) | |
359 | with provisionalcompleter(): |
|
359 | with provisionalcompleter(): | |
360 | l = list(_deduplicate_completions('Z.z', ip.Completer.completions('Z.z', 3))) |
|
360 | l = list(_deduplicate_completions('Z.z', ip.Completer.completions('Z.z', 3))) | |
361 |
|
361 | |||
362 | assert len(l) == 1, 'Completions (Z.z<tab>) correctly deduplicate: %s ' % l |
|
362 | assert len(l) == 1, 'Completions (Z.z<tab>) correctly deduplicate: %s ' % l | |
363 | assert l[0].text == 'zoo' # and not `it.accumulate` |
|
363 | assert l[0].text == 'zoo' # and not `it.accumulate` | |
364 |
|
364 | |||
365 |
|
365 | |||
366 | def test_greedy_completions(): |
|
366 | def test_greedy_completions(): | |
367 | """ |
|
367 | """ | |
368 | Test the capability of the Greedy completer. |
|
368 | Test the capability of the Greedy completer. | |
369 |
|
369 | |||
370 | Most of the test here do not really show off the greedy completer, for proof |
|
370 | Most of the test here do not really show off the greedy completer, for proof | |
371 | each of the text bellow now pass with Jedi. The greedy completer is capable of more. |
|
371 | each of the text bellow now pass with Jedi. The greedy completer is capable of more. | |
372 |
|
372 | |||
373 | See the :any:`test_dict_key_completion_contexts` |
|
373 | See the :any:`test_dict_key_completion_contexts` | |
374 |
|
374 | |||
375 | """ |
|
375 | """ | |
376 | ip = get_ipython() |
|
376 | ip = get_ipython() | |
377 | ip.ex('a=list(range(5))') |
|
377 | ip.ex('a=list(range(5))') | |
378 | _,c = ip.complete('.',line='a[0].') |
|
378 | _,c = ip.complete('.',line='a[0].') | |
379 | nt.assert_false('.real' in c, |
|
379 | nt.assert_false('.real' in c, | |
380 | "Shouldn't have completed on a[0]: %s"%c) |
|
380 | "Shouldn't have completed on a[0]: %s"%c) | |
381 | with greedy_completion(), provisionalcompleter(): |
|
381 | with greedy_completion(), provisionalcompleter(): | |
382 | def _(line, cursor_pos, expect, message, completion): |
|
382 | def _(line, cursor_pos, expect, message, completion): | |
|
383 | ip.Completer.use_jedi = False | |||
383 | _,c = ip.complete('.', line=line, cursor_pos=cursor_pos) |
|
384 | _,c = ip.complete('.', line=line, cursor_pos=cursor_pos) | |
|
385 | nt.assert_in(expect, c, message % c) | |||
|
386 | ||||
|
387 | ip.Completer.use_jedi = True | |||
384 | with provisionalcompleter(): |
|
388 | with provisionalcompleter(): | |
385 | completions = ip.Completer.completions(line, cursor_pos) |
|
389 | completions = ip.Completer.completions(line, cursor_pos) | |
386 | nt.assert_in(expect, c, message%c) |
|
|||
387 | nt.assert_in(completion, completions) |
|
390 | nt.assert_in(completion, completions) | |
388 |
|
391 | |||
389 | yield _, 'a[0].', 5, 'a[0].real', "Should have completed on a[0].: %s", Completion(5,5, 'real') |
|
392 | yield _, 'a[0].', 5, 'a[0].real', "Should have completed on a[0].: %s", Completion(5,5, 'real') | |
390 | yield _, 'a[0].r', 6, 'a[0].real', "Should have completed on a[0].r: %s", Completion(5,6, 'real') |
|
393 | yield _, 'a[0].r', 6, 'a[0].real', "Should have completed on a[0].r: %s", Completion(5,6, 'real') | |
391 |
|
394 | |||
392 | if sys.version_info > (3, 4): |
|
395 | if sys.version_info > (3, 4): | |
393 | yield _, 'a[0].from_', 10, 'a[0].from_bytes', "Should have completed on a[0].from_: %s", Completion(5, 10, 'from_bytes') |
|
396 | yield _, 'a[0].from_', 10, 'a[0].from_bytes', "Should have completed on a[0].from_: %s", Completion(5, 10, 'from_bytes') | |
394 |
|
397 | |||
395 |
|
398 | |||
396 | def test_omit__names(): |
|
399 | def test_omit__names(): | |
397 | # also happens to test IPCompleter as a configurable |
|
400 | # also happens to test IPCompleter as a configurable | |
398 | ip = get_ipython() |
|
401 | ip = get_ipython() | |
399 | ip._hidden_attr = 1 |
|
402 | ip._hidden_attr = 1 | |
400 | ip._x = {} |
|
403 | ip._x = {} | |
401 | c = ip.Completer |
|
404 | c = ip.Completer | |
402 | ip.ex('ip=get_ipython()') |
|
405 | ip.ex('ip=get_ipython()') | |
403 | cfg = Config() |
|
406 | cfg = Config() | |
404 | cfg.IPCompleter.omit__names = 0 |
|
407 | cfg.IPCompleter.omit__names = 0 | |
405 | c.update_config(cfg) |
|
408 | c.update_config(cfg) | |
406 | with provisionalcompleter(): |
|
409 | with provisionalcompleter(): | |
|
410 | c.use_jedi = False | |||
407 | s,matches = c.complete('ip.') |
|
411 | s,matches = c.complete('ip.') | |
408 | completions = set(c.completions('ip.', 3)) |
|
|||
409 |
|
||||
410 | nt.assert_in('ip.__str__', matches) |
|
412 | nt.assert_in('ip.__str__', matches) | |
411 | nt.assert_in(Completion(3, 3, '__str__'), completions) |
|
|||
412 |
|
||||
413 | nt.assert_in('ip._hidden_attr', matches) |
|
413 | nt.assert_in('ip._hidden_attr', matches) | |
|
414 | ||||
|
415 | c.use_jedi = True | |||
|
416 | completions = set(c.completions('ip.', 3)) | |||
|
417 | nt.assert_in(Completion(3, 3, '__str__'), completions) | |||
414 | nt.assert_in(Completion(3,3, "_hidden_attr"), completions) |
|
418 | nt.assert_in(Completion(3,3, "_hidden_attr"), completions) | |
415 |
|
419 | |||
416 |
|
420 | |||
417 | cfg = Config() |
|
421 | cfg = Config() | |
418 | cfg.IPCompleter.omit__names = 1 |
|
422 | cfg.IPCompleter.omit__names = 1 | |
419 | c.update_config(cfg) |
|
423 | c.update_config(cfg) | |
420 | with provisionalcompleter(): |
|
424 | with provisionalcompleter(): | |
|
425 | c.use_jedi = False | |||
421 | s,matches = c.complete('ip.') |
|
426 | s,matches = c.complete('ip.') | |
422 | completions = set(c.completions('ip.', 3)) |
|
|||
423 |
|
||||
424 | nt.assert_not_in('ip.__str__', matches) |
|
427 | nt.assert_not_in('ip.__str__', matches) | |
425 | nt.assert_not_in(Completion(3,3,'__str__'), completions) |
|
|||
426 |
|
||||
427 | # nt.assert_in('ip._hidden_attr', matches) |
|
428 | # nt.assert_in('ip._hidden_attr', matches) | |
|
429 | ||||
|
430 | c.use_jedi = True | |||
|
431 | completions = set(c.completions('ip.', 3)) | |||
|
432 | nt.assert_not_in(Completion(3,3,'__str__'), completions) | |||
428 | nt.assert_in(Completion(3,3, "_hidden_attr"), completions) |
|
433 | nt.assert_in(Completion(3,3, "_hidden_attr"), completions) | |
429 |
|
434 | |||
430 | cfg = Config() |
|
435 | cfg = Config() | |
431 | cfg.IPCompleter.omit__names = 2 |
|
436 | cfg.IPCompleter.omit__names = 2 | |
432 | c.update_config(cfg) |
|
437 | c.update_config(cfg) | |
433 | with provisionalcompleter(): |
|
438 | with provisionalcompleter(): | |
|
439 | c.use_jedi = False | |||
434 | s,matches = c.complete('ip.') |
|
440 | s,matches = c.complete('ip.') | |
435 | completions = set(c.completions('ip.', 3)) |
|
|||
436 |
|
||||
437 | nt.assert_not_in('ip.__str__', matches) |
|
441 | nt.assert_not_in('ip.__str__', matches) | |
438 | nt.assert_not_in(Completion(3,3,'__str__'), completions) |
|
|||
439 |
|
||||
440 | nt.assert_not_in('ip._hidden_attr', matches) |
|
442 | nt.assert_not_in('ip._hidden_attr', matches) | |
|
443 | ||||
|
444 | c.use_jedi = True | |||
|
445 | completions = set(c.completions('ip.', 3)) | |||
|
446 | nt.assert_not_in(Completion(3,3,'__str__'), completions) | |||
441 | nt.assert_not_in(Completion(3,3, "_hidden_attr"), completions) |
|
447 | nt.assert_not_in(Completion(3,3, "_hidden_attr"), completions) | |
442 |
|
448 | |||
443 | with provisionalcompleter(): |
|
449 | with provisionalcompleter(): | |
|
450 | c.use_jedi = False | |||
444 | s,matches = c.complete('ip._x.') |
|
451 | s,matches = c.complete('ip._x.') | |
445 | completions = set(c.completions('ip._x.', 6)) |
|
|||
446 |
|
||||
447 | nt.assert_in('ip._x.keys', matches) |
|
452 | nt.assert_in('ip._x.keys', matches) | |
|
453 | ||||
|
454 | c.use_jedi = True | |||
|
455 | completions = set(c.completions('ip._x.', 6)) | |||
448 | nt.assert_in(Completion(6,6, "keys"), completions) |
|
456 | nt.assert_in(Completion(6,6, "keys"), completions) | |
449 |
|
457 | |||
450 | del ip._hidden_attr |
|
458 | del ip._hidden_attr | |
451 | del ip._x |
|
459 | del ip._x | |
452 |
|
460 | |||
453 |
|
461 | |||
454 | def test_limit_to__all__False_ok(): |
|
462 | def test_limit_to__all__False_ok(): | |
455 | """ |
|
463 | """ | |
456 | Limit to all is deprecated, once we remove it this test can go away. |
|
464 | Limit to all is deprecated, once we remove it this test can go away. | |
457 | """ |
|
465 | """ | |
458 | ip = get_ipython() |
|
466 | ip = get_ipython() | |
459 | c = ip.Completer |
|
467 | c = ip.Completer | |
|
468 | c.use_jedi = False | |||
460 | ip.ex('class D: x=24') |
|
469 | ip.ex('class D: x=24') | |
461 | ip.ex('d=D()') |
|
470 | ip.ex('d=D()') | |
462 | cfg = Config() |
|
471 | cfg = Config() | |
463 | cfg.IPCompleter.limit_to__all__ = False |
|
472 | cfg.IPCompleter.limit_to__all__ = False | |
464 | c.update_config(cfg) |
|
473 | c.update_config(cfg) | |
465 | s, matches = c.complete('d.') |
|
474 | s, matches = c.complete('d.') | |
466 | nt.assert_in('d.x', matches) |
|
475 | nt.assert_in('d.x', matches) | |
467 |
|
476 | |||
468 |
|
477 | |||
469 | def test_get__all__entries_ok(): |
|
478 | def test_get__all__entries_ok(): | |
470 | class A(object): |
|
479 | class A(object): | |
471 | __all__ = ['x', 1] |
|
480 | __all__ = ['x', 1] | |
472 | words = completer.get__all__entries(A()) |
|
481 | words = completer.get__all__entries(A()) | |
473 | nt.assert_equal(words, ['x']) |
|
482 | nt.assert_equal(words, ['x']) | |
474 |
|
483 | |||
475 |
|
484 | |||
476 | def test_get__all__entries_no__all__ok(): |
|
485 | def test_get__all__entries_no__all__ok(): | |
477 | class A(object): |
|
486 | class A(object): | |
478 | pass |
|
487 | pass | |
479 | words = completer.get__all__entries(A()) |
|
488 | words = completer.get__all__entries(A()) | |
480 | nt.assert_equal(words, []) |
|
489 | nt.assert_equal(words, []) | |
481 |
|
490 | |||
482 |
|
491 | |||
483 | def test_func_kw_completions(): |
|
492 | def test_func_kw_completions(): | |
484 | ip = get_ipython() |
|
493 | ip = get_ipython() | |
485 | c = ip.Completer |
|
494 | c = ip.Completer | |
|
495 | c.use_jedi = False | |||
486 | ip.ex('def myfunc(a=1,b=2): return a+b') |
|
496 | ip.ex('def myfunc(a=1,b=2): return a+b') | |
487 | s, matches = c.complete(None, 'myfunc(1,b') |
|
497 | s, matches = c.complete(None, 'myfunc(1,b') | |
488 | nt.assert_in('b=', matches) |
|
498 | nt.assert_in('b=', matches) | |
489 | # Simulate completing with cursor right after b (pos==10): |
|
499 | # Simulate completing with cursor right after b (pos==10): | |
490 | s, matches = c.complete(None, 'myfunc(1,b)', 10) |
|
500 | s, matches = c.complete(None, 'myfunc(1,b)', 10) | |
491 | nt.assert_in('b=', matches) |
|
501 | nt.assert_in('b=', matches) | |
492 | s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b') |
|
502 | s, matches = c.complete(None, 'myfunc(a="escaped\\")string",b') | |
493 | nt.assert_in('b=', matches) |
|
503 | nt.assert_in('b=', matches) | |
494 | #builtin function |
|
504 | #builtin function | |
495 | s, matches = c.complete(None, 'min(k, k') |
|
505 | s, matches = c.complete(None, 'min(k, k') | |
496 | nt.assert_in('key=', matches) |
|
506 | nt.assert_in('key=', matches) | |
497 |
|
507 | |||
498 |
|
508 | |||
499 | def test_default_arguments_from_docstring(): |
|
509 | def test_default_arguments_from_docstring(): | |
500 | ip = get_ipython() |
|
510 | ip = get_ipython() | |
501 | c = ip.Completer |
|
511 | c = ip.Completer | |
502 | kwd = c._default_arguments_from_docstring( |
|
512 | kwd = c._default_arguments_from_docstring( | |
503 | 'min(iterable[, key=func]) -> value') |
|
513 | 'min(iterable[, key=func]) -> value') | |
504 | nt.assert_equal(kwd, ['key']) |
|
514 | nt.assert_equal(kwd, ['key']) | |
505 | #with cython type etc |
|
515 | #with cython type etc | |
506 | kwd = c._default_arguments_from_docstring( |
|
516 | kwd = c._default_arguments_from_docstring( | |
507 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n') |
|
517 | 'Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n') | |
508 | nt.assert_equal(kwd, ['ncall', 'resume', 'nsplit']) |
|
518 | nt.assert_equal(kwd, ['ncall', 'resume', 'nsplit']) | |
509 | #white spaces |
|
519 | #white spaces | |
510 | kwd = c._default_arguments_from_docstring( |
|
520 | kwd = c._default_arguments_from_docstring( | |
511 | '\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n') |
|
521 | '\n Minuit.migrad(self, int ncall=10000, resume=True, int nsplit=1)\n') | |
512 | nt.assert_equal(kwd, ['ncall', 'resume', 'nsplit']) |
|
522 | nt.assert_equal(kwd, ['ncall', 'resume', 'nsplit']) | |
513 |
|
523 | |||
514 | def test_line_magics(): |
|
524 | def test_line_magics(): | |
515 | ip = get_ipython() |
|
525 | ip = get_ipython() | |
516 | c = ip.Completer |
|
526 | c = ip.Completer | |
517 | s, matches = c.complete(None, 'lsmag') |
|
527 | s, matches = c.complete(None, 'lsmag') | |
518 | nt.assert_in('%lsmagic', matches) |
|
528 | nt.assert_in('%lsmagic', matches) | |
519 | s, matches = c.complete(None, '%lsmag') |
|
529 | s, matches = c.complete(None, '%lsmag') | |
520 | nt.assert_in('%lsmagic', matches) |
|
530 | nt.assert_in('%lsmagic', matches) | |
521 |
|
531 | |||
522 |
|
532 | |||
523 | def test_cell_magics(): |
|
533 | def test_cell_magics(): | |
524 | from IPython.core.magic import register_cell_magic |
|
534 | from IPython.core.magic import register_cell_magic | |
525 |
|
535 | |||
526 | @register_cell_magic |
|
536 | @register_cell_magic | |
527 | def _foo_cellm(line, cell): |
|
537 | def _foo_cellm(line, cell): | |
528 | pass |
|
538 | pass | |
529 |
|
539 | |||
530 | ip = get_ipython() |
|
540 | ip = get_ipython() | |
531 | c = ip.Completer |
|
541 | c = ip.Completer | |
532 |
|
542 | |||
533 | s, matches = c.complete(None, '_foo_ce') |
|
543 | s, matches = c.complete(None, '_foo_ce') | |
534 | nt.assert_in('%%_foo_cellm', matches) |
|
544 | nt.assert_in('%%_foo_cellm', matches) | |
535 | s, matches = c.complete(None, '%%_foo_ce') |
|
545 | s, matches = c.complete(None, '%%_foo_ce') | |
536 | nt.assert_in('%%_foo_cellm', matches) |
|
546 | nt.assert_in('%%_foo_cellm', matches) | |
537 |
|
547 | |||
538 |
|
548 | |||
539 | def test_line_cell_magics(): |
|
549 | def test_line_cell_magics(): | |
540 | from IPython.core.magic import register_line_cell_magic |
|
550 | from IPython.core.magic import register_line_cell_magic | |
541 |
|
551 | |||
542 | @register_line_cell_magic |
|
552 | @register_line_cell_magic | |
543 | def _bar_cellm(line, cell): |
|
553 | def _bar_cellm(line, cell): | |
544 | pass |
|
554 | pass | |
545 |
|
555 | |||
546 | ip = get_ipython() |
|
556 | ip = get_ipython() | |
547 | c = ip.Completer |
|
557 | c = ip.Completer | |
548 |
|
558 | |||
549 | # The policy here is trickier, see comments in completion code. The |
|
559 | # The policy here is trickier, see comments in completion code. The | |
550 | # returned values depend on whether the user passes %% or not explicitly, |
|
560 | # returned values depend on whether the user passes %% or not explicitly, | |
551 | # and this will show a difference if the same name is both a line and cell |
|
561 | # and this will show a difference if the same name is both a line and cell | |
552 | # magic. |
|
562 | # magic. | |
553 | s, matches = c.complete(None, '_bar_ce') |
|
563 | s, matches = c.complete(None, '_bar_ce') | |
554 | nt.assert_in('%_bar_cellm', matches) |
|
564 | nt.assert_in('%_bar_cellm', matches) | |
555 | nt.assert_in('%%_bar_cellm', matches) |
|
565 | nt.assert_in('%%_bar_cellm', matches) | |
556 | s, matches = c.complete(None, '%_bar_ce') |
|
566 | s, matches = c.complete(None, '%_bar_ce') | |
557 | nt.assert_in('%_bar_cellm', matches) |
|
567 | nt.assert_in('%_bar_cellm', matches) | |
558 | nt.assert_in('%%_bar_cellm', matches) |
|
568 | nt.assert_in('%%_bar_cellm', matches) | |
559 | s, matches = c.complete(None, '%%_bar_ce') |
|
569 | s, matches = c.complete(None, '%%_bar_ce') | |
560 | nt.assert_not_in('%_bar_cellm', matches) |
|
570 | nt.assert_not_in('%_bar_cellm', matches) | |
561 | nt.assert_in('%%_bar_cellm', matches) |
|
571 | nt.assert_in('%%_bar_cellm', matches) | |
562 |
|
572 | |||
563 |
|
573 | |||
564 | def test_magic_completion_order(): |
|
574 | def test_magic_completion_order(): | |
565 | ip = get_ipython() |
|
575 | ip = get_ipython() | |
566 | c = ip.Completer |
|
576 | c = ip.Completer | |
567 |
|
577 | |||
568 | # Test ordering of line and cell magics. |
|
578 | # Test ordering of line and cell magics. | |
569 | text, matches = c.complete("timeit") |
|
579 | text, matches = c.complete("timeit") | |
570 | nt.assert_equal(matches, ["%timeit", "%%timeit"]) |
|
580 | nt.assert_equal(matches, ["%timeit", "%%timeit"]) | |
571 |
|
581 | |||
572 |
|
582 | |||
573 | def test_magic_completion_shadowing(): |
|
583 | def test_magic_completion_shadowing(): | |
574 | ip = get_ipython() |
|
584 | ip = get_ipython() | |
575 | c = ip.Completer |
|
585 | c = ip.Completer | |
|
586 | c.use_jedi = False | |||
576 |
|
587 | |||
577 | # Before importing matplotlib, %matplotlib magic should be the only option. |
|
588 | # Before importing matplotlib, %matplotlib magic should be the only option. | |
578 | text, matches = c.complete("mat") |
|
589 | text, matches = c.complete("mat") | |
579 | nt.assert_equal(matches, ["%matplotlib"]) |
|
590 | nt.assert_equal(matches, ["%matplotlib"]) | |
580 |
|
591 | |||
581 | # The newly introduced name should shadow the magic. |
|
592 | # The newly introduced name should shadow the magic. | |
582 | ip.run_cell("matplotlib = 1") |
|
593 | ip.run_cell("matplotlib = 1") | |
583 | text, matches = c.complete("mat") |
|
594 | text, matches = c.complete("mat") | |
584 | nt.assert_equal(matches, ["matplotlib"]) |
|
595 | nt.assert_equal(matches, ["matplotlib"]) | |
585 |
|
596 | |||
586 | # After removing matplotlib from namespace, the magic should again be |
|
597 | # After removing matplotlib from namespace, the magic should again be | |
587 | # the only option. |
|
598 | # the only option. | |
588 | del ip.user_ns["matplotlib"] |
|
599 | del ip.user_ns["matplotlib"] | |
589 | text, matches = c.complete("mat") |
|
600 | text, matches = c.complete("mat") | |
590 | nt.assert_equal(matches, ["%matplotlib"]) |
|
601 | nt.assert_equal(matches, ["%matplotlib"]) | |
591 |
|
602 | |||
592 | def test_magic_completion_shadowing_explicit(): |
|
603 | def test_magic_completion_shadowing_explicit(): | |
593 | """ |
|
604 | """ | |
594 | If the user try to complete a shadowed magic, and explicit % start should |
|
605 | If the user try to complete a shadowed magic, and explicit % start should | |
595 | still return the completions. |
|
606 | still return the completions. | |
596 | """ |
|
607 | """ | |
597 | ip = get_ipython() |
|
608 | ip = get_ipython() | |
598 | c = ip.Completer |
|
609 | c = ip.Completer | |
599 |
|
610 | |||
600 | # Before importing matplotlib, %matplotlib magic should be the only option. |
|
611 | # Before importing matplotlib, %matplotlib magic should be the only option. | |
601 | text, matches = c.complete("%mat") |
|
612 | text, matches = c.complete("%mat") | |
602 | nt.assert_equal(matches, ["%matplotlib"]) |
|
613 | nt.assert_equal(matches, ["%matplotlib"]) | |
603 |
|
614 | |||
604 | ip.run_cell("matplotlib = 1") |
|
615 | ip.run_cell("matplotlib = 1") | |
605 |
|
616 | |||
606 | # After removing matplotlib from namespace, the magic should still be |
|
617 | # After removing matplotlib from namespace, the magic should still be | |
607 | # the only option. |
|
618 | # the only option. | |
608 | text, matches = c.complete("%mat") |
|
619 | text, matches = c.complete("%mat") | |
609 | nt.assert_equal(matches, ["%matplotlib"]) |
|
620 | nt.assert_equal(matches, ["%matplotlib"]) | |
610 |
|
621 | |||
611 | def test_magic_config(): |
|
622 | def test_magic_config(): | |
612 | ip = get_ipython() |
|
623 | ip = get_ipython() | |
613 | c = ip.Completer |
|
624 | c = ip.Completer | |
614 |
|
625 | |||
615 | s, matches = c.complete(None, 'conf') |
|
626 | s, matches = c.complete(None, 'conf') | |
616 | nt.assert_in('%config', matches) |
|
627 | nt.assert_in('%config', matches) | |
617 | s, matches = c.complete(None, 'conf') |
|
628 | s, matches = c.complete(None, 'conf') | |
618 | nt.assert_not_in('AliasManager', matches) |
|
629 | nt.assert_not_in('AliasManager', matches) | |
619 | s, matches = c.complete(None, 'config ') |
|
630 | s, matches = c.complete(None, 'config ') | |
620 | nt.assert_in('AliasManager', matches) |
|
631 | nt.assert_in('AliasManager', matches) | |
621 | s, matches = c.complete(None, '%config ') |
|
632 | s, matches = c.complete(None, '%config ') | |
622 | nt.assert_in('AliasManager', matches) |
|
633 | nt.assert_in('AliasManager', matches) | |
623 | s, matches = c.complete(None, 'config Ali') |
|
634 | s, matches = c.complete(None, 'config Ali') | |
624 | nt.assert_list_equal(['AliasManager'], matches) |
|
635 | nt.assert_list_equal(['AliasManager'], matches) | |
625 | s, matches = c.complete(None, '%config Ali') |
|
636 | s, matches = c.complete(None, '%config Ali') | |
626 | nt.assert_list_equal(['AliasManager'], matches) |
|
637 | nt.assert_list_equal(['AliasManager'], matches) | |
627 | s, matches = c.complete(None, 'config AliasManager') |
|
638 | s, matches = c.complete(None, 'config AliasManager') | |
628 | nt.assert_list_equal(['AliasManager'], matches) |
|
639 | nt.assert_list_equal(['AliasManager'], matches) | |
629 | s, matches = c.complete(None, '%config AliasManager') |
|
640 | s, matches = c.complete(None, '%config AliasManager') | |
630 | nt.assert_list_equal(['AliasManager'], matches) |
|
641 | nt.assert_list_equal(['AliasManager'], matches) | |
631 | s, matches = c.complete(None, 'config AliasManager.') |
|
642 | s, matches = c.complete(None, 'config AliasManager.') | |
632 | nt.assert_in('AliasManager.default_aliases', matches) |
|
643 | nt.assert_in('AliasManager.default_aliases', matches) | |
633 | s, matches = c.complete(None, '%config AliasManager.') |
|
644 | s, matches = c.complete(None, '%config AliasManager.') | |
634 | nt.assert_in('AliasManager.default_aliases', matches) |
|
645 | nt.assert_in('AliasManager.default_aliases', matches) | |
635 | s, matches = c.complete(None, 'config AliasManager.de') |
|
646 | s, matches = c.complete(None, 'config AliasManager.de') | |
636 | nt.assert_list_equal(['AliasManager.default_aliases'], matches) |
|
647 | nt.assert_list_equal(['AliasManager.default_aliases'], matches) | |
637 | s, matches = c.complete(None, 'config AliasManager.de') |
|
648 | s, matches = c.complete(None, 'config AliasManager.de') | |
638 | nt.assert_list_equal(['AliasManager.default_aliases'], matches) |
|
649 | nt.assert_list_equal(['AliasManager.default_aliases'], matches) | |
639 |
|
650 | |||
640 |
|
651 | |||
641 | def test_magic_color(): |
|
652 | def test_magic_color(): | |
642 | ip = get_ipython() |
|
653 | ip = get_ipython() | |
643 | c = ip.Completer |
|
654 | c = ip.Completer | |
644 |
|
655 | |||
645 | s, matches = c.complete(None, 'colo') |
|
656 | s, matches = c.complete(None, 'colo') | |
646 | nt.assert_in('%colors', matches) |
|
657 | nt.assert_in('%colors', matches) | |
647 | s, matches = c.complete(None, 'colo') |
|
658 | s, matches = c.complete(None, 'colo') | |
648 | nt.assert_not_in('NoColor', matches) |
|
659 | nt.assert_not_in('NoColor', matches) | |
649 | s, matches = c.complete(None, '%colors') # No trailing space |
|
660 | s, matches = c.complete(None, '%colors') # No trailing space | |
650 | nt.assert_not_in('NoColor', matches) |
|
661 | nt.assert_not_in('NoColor', matches) | |
651 | s, matches = c.complete(None, 'colors ') |
|
662 | s, matches = c.complete(None, 'colors ') | |
652 | nt.assert_in('NoColor', matches) |
|
663 | nt.assert_in('NoColor', matches) | |
653 | s, matches = c.complete(None, '%colors ') |
|
664 | s, matches = c.complete(None, '%colors ') | |
654 | nt.assert_in('NoColor', matches) |
|
665 | nt.assert_in('NoColor', matches) | |
655 | s, matches = c.complete(None, 'colors NoCo') |
|
666 | s, matches = c.complete(None, 'colors NoCo') | |
656 | nt.assert_list_equal(['NoColor'], matches) |
|
667 | nt.assert_list_equal(['NoColor'], matches) | |
657 | s, matches = c.complete(None, '%colors NoCo') |
|
668 | s, matches = c.complete(None, '%colors NoCo') | |
658 | nt.assert_list_equal(['NoColor'], matches) |
|
669 | nt.assert_list_equal(['NoColor'], matches) | |
659 |
|
670 | |||
660 |
|
671 | |||
661 | def test_match_dict_keys(): |
|
672 | def test_match_dict_keys(): | |
662 | """ |
|
673 | """ | |
663 | Test that match_dict_keys works on a couple of use case does return what |
|
674 | Test that match_dict_keys works on a couple of use case does return what | |
664 | expected, and does not crash |
|
675 | expected, and does not crash | |
665 | """ |
|
676 | """ | |
666 | delims = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' |
|
677 | delims = ' \t\n`!@#$^&*()=+[{]}\\|;:\'",<>?' | |
667 |
|
678 | |||
668 |
|
679 | |||
669 | keys = ['foo', b'far'] |
|
680 | keys = ['foo', b'far'] | |
670 | assert match_dict_keys(keys, "b'", delims=delims) == ("'", 2 ,['far']) |
|
681 | assert match_dict_keys(keys, "b'", delims=delims) == ("'", 2 ,['far']) | |
671 | assert match_dict_keys(keys, "b'f", delims=delims) == ("'", 2 ,['far']) |
|
682 | assert match_dict_keys(keys, "b'f", delims=delims) == ("'", 2 ,['far']) | |
672 | assert match_dict_keys(keys, 'b"', delims=delims) == ('"', 2 ,['far']) |
|
683 | assert match_dict_keys(keys, 'b"', delims=delims) == ('"', 2 ,['far']) | |
673 | assert match_dict_keys(keys, 'b"f', delims=delims) == ('"', 2 ,['far']) |
|
684 | assert match_dict_keys(keys, 'b"f', delims=delims) == ('"', 2 ,['far']) | |
674 |
|
685 | |||
675 | assert match_dict_keys(keys, "'", delims=delims) == ("'", 1 ,['foo']) |
|
686 | assert match_dict_keys(keys, "'", delims=delims) == ("'", 1 ,['foo']) | |
676 | assert match_dict_keys(keys, "'f", delims=delims) == ("'", 1 ,['foo']) |
|
687 | assert match_dict_keys(keys, "'f", delims=delims) == ("'", 1 ,['foo']) | |
677 | assert match_dict_keys(keys, '"', delims=delims) == ('"', 1 ,['foo']) |
|
688 | assert match_dict_keys(keys, '"', delims=delims) == ('"', 1 ,['foo']) | |
678 | assert match_dict_keys(keys, '"f', delims=delims) == ('"', 1 ,['foo']) |
|
689 | assert match_dict_keys(keys, '"f', delims=delims) == ('"', 1 ,['foo']) | |
679 |
|
690 | |||
680 | match_dict_keys |
|
691 | match_dict_keys | |
681 |
|
692 | |||
682 |
|
693 | |||
683 | def test_dict_key_completion_string(): |
|
694 | def test_dict_key_completion_string(): | |
684 | """Test dictionary key completion for string keys""" |
|
695 | """Test dictionary key completion for string keys""" | |
685 | ip = get_ipython() |
|
696 | ip = get_ipython() | |
686 | complete = ip.Completer.complete |
|
697 | complete = ip.Completer.complete | |
687 |
|
698 | |||
688 | ip.user_ns['d'] = {'abc': None} |
|
699 | ip.user_ns['d'] = {'abc': None} | |
689 |
|
700 | |||
690 | # check completion at different stages |
|
701 | # check completion at different stages | |
691 | _, matches = complete(line_buffer="d[") |
|
702 | _, matches = complete(line_buffer="d[") | |
692 | nt.assert_in("'abc'", matches) |
|
703 | nt.assert_in("'abc'", matches) | |
693 | nt.assert_not_in("'abc']", matches) |
|
704 | nt.assert_not_in("'abc']", matches) | |
694 |
|
705 | |||
695 | _, matches = complete(line_buffer="d['") |
|
706 | _, matches = complete(line_buffer="d['") | |
696 | nt.assert_in("abc", matches) |
|
707 | nt.assert_in("abc", matches) | |
697 | nt.assert_not_in("abc']", matches) |
|
708 | nt.assert_not_in("abc']", matches) | |
698 |
|
709 | |||
699 | _, matches = complete(line_buffer="d['a") |
|
710 | _, matches = complete(line_buffer="d['a") | |
700 | nt.assert_in("abc", matches) |
|
711 | nt.assert_in("abc", matches) | |
701 | nt.assert_not_in("abc']", matches) |
|
712 | nt.assert_not_in("abc']", matches) | |
702 |
|
713 | |||
703 | # check use of different quoting |
|
714 | # check use of different quoting | |
704 | _, matches = complete(line_buffer="d[\"") |
|
715 | _, matches = complete(line_buffer="d[\"") | |
705 | nt.assert_in("abc", matches) |
|
716 | nt.assert_in("abc", matches) | |
706 | nt.assert_not_in('abc\"]', matches) |
|
717 | nt.assert_not_in('abc\"]', matches) | |
707 |
|
718 | |||
708 | _, matches = complete(line_buffer="d[\"a") |
|
719 | _, matches = complete(line_buffer="d[\"a") | |
709 | nt.assert_in("abc", matches) |
|
720 | nt.assert_in("abc", matches) | |
710 | nt.assert_not_in('abc\"]', matches) |
|
721 | nt.assert_not_in('abc\"]', matches) | |
711 |
|
722 | |||
712 | # check sensitivity to following context |
|
723 | # check sensitivity to following context | |
713 | _, matches = complete(line_buffer="d[]", cursor_pos=2) |
|
724 | _, matches = complete(line_buffer="d[]", cursor_pos=2) | |
714 | nt.assert_in("'abc'", matches) |
|
725 | nt.assert_in("'abc'", matches) | |
715 |
|
726 | |||
716 | _, matches = complete(line_buffer="d['']", cursor_pos=3) |
|
727 | _, matches = complete(line_buffer="d['']", cursor_pos=3) | |
717 | nt.assert_in("abc", matches) |
|
728 | nt.assert_in("abc", matches) | |
718 | nt.assert_not_in("abc'", matches) |
|
729 | nt.assert_not_in("abc'", matches) | |
719 | nt.assert_not_in("abc']", matches) |
|
730 | nt.assert_not_in("abc']", matches) | |
720 |
|
731 | |||
721 | # check multiple solutions are correctly returned and that noise is not |
|
732 | # check multiple solutions are correctly returned and that noise is not | |
722 | ip.user_ns['d'] = {'abc': None, 'abd': None, 'bad': None, object(): None, |
|
733 | ip.user_ns['d'] = {'abc': None, 'abd': None, 'bad': None, object(): None, | |
723 | 5: None} |
|
734 | 5: None} | |
724 |
|
735 | |||
725 | _, matches = complete(line_buffer="d['a") |
|
736 | _, matches = complete(line_buffer="d['a") | |
726 | nt.assert_in("abc", matches) |
|
737 | nt.assert_in("abc", matches) | |
727 | nt.assert_in("abd", matches) |
|
738 | nt.assert_in("abd", matches) | |
728 | nt.assert_not_in("bad", matches) |
|
739 | nt.assert_not_in("bad", matches) | |
729 | assert not any(m.endswith((']', '"', "'")) for m in matches), matches |
|
740 | assert not any(m.endswith((']', '"', "'")) for m in matches), matches | |
730 |
|
741 | |||
731 | # check escaping and whitespace |
|
742 | # check escaping and whitespace | |
732 | ip.user_ns['d'] = {'a\nb': None, 'a\'b': None, 'a"b': None, 'a word': None} |
|
743 | ip.user_ns['d'] = {'a\nb': None, 'a\'b': None, 'a"b': None, 'a word': None} | |
733 | _, matches = complete(line_buffer="d['a") |
|
744 | _, matches = complete(line_buffer="d['a") | |
734 | nt.assert_in("a\\nb", matches) |
|
745 | nt.assert_in("a\\nb", matches) | |
735 | nt.assert_in("a\\'b", matches) |
|
746 | nt.assert_in("a\\'b", matches) | |
736 | nt.assert_in("a\"b", matches) |
|
747 | nt.assert_in("a\"b", matches) | |
737 | nt.assert_in("a word", matches) |
|
748 | nt.assert_in("a word", matches) | |
738 | assert not any(m.endswith((']', '"', "'")) for m in matches), matches |
|
749 | assert not any(m.endswith((']', '"', "'")) for m in matches), matches | |
739 |
|
750 | |||
740 | # - can complete on non-initial word of the string |
|
751 | # - can complete on non-initial word of the string | |
741 | _, matches = complete(line_buffer="d['a w") |
|
752 | _, matches = complete(line_buffer="d['a w") | |
742 | nt.assert_in("word", matches) |
|
753 | nt.assert_in("word", matches) | |
743 |
|
754 | |||
744 | # - understands quote escaping |
|
755 | # - understands quote escaping | |
745 | _, matches = complete(line_buffer="d['a\\'") |
|
756 | _, matches = complete(line_buffer="d['a\\'") | |
746 | nt.assert_in("b", matches) |
|
757 | nt.assert_in("b", matches) | |
747 |
|
758 | |||
748 | # - default quoting should work like repr |
|
759 | # - default quoting should work like repr | |
749 | _, matches = complete(line_buffer="d[") |
|
760 | _, matches = complete(line_buffer="d[") | |
750 | nt.assert_in("\"a'b\"", matches) |
|
761 | nt.assert_in("\"a'b\"", matches) | |
751 |
|
762 | |||
752 | # - when opening quote with ", possible to match with unescaped apostrophe |
|
763 | # - when opening quote with ", possible to match with unescaped apostrophe | |
753 | _, matches = complete(line_buffer="d[\"a'") |
|
764 | _, matches = complete(line_buffer="d[\"a'") | |
754 | nt.assert_in("b", matches) |
|
765 | nt.assert_in("b", matches) | |
755 |
|
766 | |||
756 | # need to not split at delims that readline won't split at |
|
767 | # need to not split at delims that readline won't split at | |
757 | if '-' not in ip.Completer.splitter.delims: |
|
768 | if '-' not in ip.Completer.splitter.delims: | |
758 | ip.user_ns['d'] = {'before-after': None} |
|
769 | ip.user_ns['d'] = {'before-after': None} | |
759 | _, matches = complete(line_buffer="d['before-af") |
|
770 | _, matches = complete(line_buffer="d['before-af") | |
760 | nt.assert_in('before-after', matches) |
|
771 | nt.assert_in('before-after', matches) | |
761 |
|
772 | |||
762 | def test_dict_key_completion_contexts(): |
|
773 | def test_dict_key_completion_contexts(): | |
763 | """Test expression contexts in which dict key completion occurs""" |
|
774 | """Test expression contexts in which dict key completion occurs""" | |
764 | ip = get_ipython() |
|
775 | ip = get_ipython() | |
765 | complete = ip.Completer.complete |
|
776 | complete = ip.Completer.complete | |
766 | d = {'abc': None} |
|
777 | d = {'abc': None} | |
767 | ip.user_ns['d'] = d |
|
778 | ip.user_ns['d'] = d | |
768 |
|
779 | |||
769 | class C: |
|
780 | class C: | |
770 | data = d |
|
781 | data = d | |
771 | ip.user_ns['C'] = C |
|
782 | ip.user_ns['C'] = C | |
772 | ip.user_ns['get'] = lambda: d |
|
783 | ip.user_ns['get'] = lambda: d | |
773 |
|
784 | |||
774 | def assert_no_completion(**kwargs): |
|
785 | def assert_no_completion(**kwargs): | |
775 | _, matches = complete(**kwargs) |
|
786 | _, matches = complete(**kwargs) | |
776 | nt.assert_not_in('abc', matches) |
|
787 | nt.assert_not_in('abc', matches) | |
777 | nt.assert_not_in('abc\'', matches) |
|
788 | nt.assert_not_in('abc\'', matches) | |
778 | nt.assert_not_in('abc\']', matches) |
|
789 | nt.assert_not_in('abc\']', matches) | |
779 | nt.assert_not_in('\'abc\'', matches) |
|
790 | nt.assert_not_in('\'abc\'', matches) | |
780 | nt.assert_not_in('\'abc\']', matches) |
|
791 | nt.assert_not_in('\'abc\']', matches) | |
781 |
|
792 | |||
782 | def assert_completion(**kwargs): |
|
793 | def assert_completion(**kwargs): | |
783 | _, matches = complete(**kwargs) |
|
794 | _, matches = complete(**kwargs) | |
784 | nt.assert_in("'abc'", matches) |
|
795 | nt.assert_in("'abc'", matches) | |
785 | nt.assert_not_in("'abc']", matches) |
|
796 | nt.assert_not_in("'abc']", matches) | |
786 |
|
797 | |||
787 | # no completion after string closed, even if reopened |
|
798 | # no completion after string closed, even if reopened | |
788 | assert_no_completion(line_buffer="d['a'") |
|
799 | assert_no_completion(line_buffer="d['a'") | |
789 | assert_no_completion(line_buffer="d[\"a\"") |
|
800 | assert_no_completion(line_buffer="d[\"a\"") | |
790 | assert_no_completion(line_buffer="d['a' + ") |
|
801 | assert_no_completion(line_buffer="d['a' + ") | |
791 | assert_no_completion(line_buffer="d['a' + '") |
|
802 | assert_no_completion(line_buffer="d['a' + '") | |
792 |
|
803 | |||
793 | # completion in non-trivial expressions |
|
804 | # completion in non-trivial expressions | |
794 | assert_completion(line_buffer="+ d[") |
|
805 | assert_completion(line_buffer="+ d[") | |
795 | assert_completion(line_buffer="(d[") |
|
806 | assert_completion(line_buffer="(d[") | |
796 | assert_completion(line_buffer="C.data[") |
|
807 | assert_completion(line_buffer="C.data[") | |
797 |
|
808 | |||
798 | # greedy flag |
|
809 | # greedy flag | |
799 | def assert_completion(**kwargs): |
|
810 | def assert_completion(**kwargs): | |
800 | _, matches = complete(**kwargs) |
|
811 | _, matches = complete(**kwargs) | |
801 | nt.assert_in("get()['abc']", matches) |
|
812 | nt.assert_in("get()['abc']", matches) | |
802 |
|
813 | |||
803 | assert_no_completion(line_buffer="get()[") |
|
814 | assert_no_completion(line_buffer="get()[") | |
804 | with greedy_completion(): |
|
815 | with greedy_completion(): | |
805 | assert_completion(line_buffer="get()[") |
|
816 | assert_completion(line_buffer="get()[") | |
806 | assert_completion(line_buffer="get()['") |
|
817 | assert_completion(line_buffer="get()['") | |
807 | assert_completion(line_buffer="get()['a") |
|
818 | assert_completion(line_buffer="get()['a") | |
808 | assert_completion(line_buffer="get()['ab") |
|
819 | assert_completion(line_buffer="get()['ab") | |
809 | assert_completion(line_buffer="get()['abc") |
|
820 | assert_completion(line_buffer="get()['abc") | |
810 |
|
821 | |||
811 |
|
822 | |||
812 |
|
823 | |||
813 | def test_dict_key_completion_bytes(): |
|
824 | def test_dict_key_completion_bytes(): | |
814 | """Test handling of bytes in dict key completion""" |
|
825 | """Test handling of bytes in dict key completion""" | |
815 | ip = get_ipython() |
|
826 | ip = get_ipython() | |
816 | complete = ip.Completer.complete |
|
827 | complete = ip.Completer.complete | |
817 |
|
828 | |||
818 | ip.user_ns['d'] = {'abc': None, b'abd': None} |
|
829 | ip.user_ns['d'] = {'abc': None, b'abd': None} | |
819 |
|
830 | |||
820 | _, matches = complete(line_buffer="d[") |
|
831 | _, matches = complete(line_buffer="d[") | |
821 | nt.assert_in("'abc'", matches) |
|
832 | nt.assert_in("'abc'", matches) | |
822 | nt.assert_in("b'abd'", matches) |
|
833 | nt.assert_in("b'abd'", matches) | |
823 |
|
834 | |||
824 | if False: # not currently implemented |
|
835 | if False: # not currently implemented | |
825 | _, matches = complete(line_buffer="d[b") |
|
836 | _, matches = complete(line_buffer="d[b") | |
826 | nt.assert_in("b'abd'", matches) |
|
837 | nt.assert_in("b'abd'", matches) | |
827 | nt.assert_not_in("b'abc'", matches) |
|
838 | nt.assert_not_in("b'abc'", matches) | |
828 |
|
839 | |||
829 | _, matches = complete(line_buffer="d[b'") |
|
840 | _, matches = complete(line_buffer="d[b'") | |
830 | nt.assert_in("abd", matches) |
|
841 | nt.assert_in("abd", matches) | |
831 | nt.assert_not_in("abc", matches) |
|
842 | nt.assert_not_in("abc", matches) | |
832 |
|
843 | |||
833 | _, matches = complete(line_buffer="d[B'") |
|
844 | _, matches = complete(line_buffer="d[B'") | |
834 | nt.assert_in("abd", matches) |
|
845 | nt.assert_in("abd", matches) | |
835 | nt.assert_not_in("abc", matches) |
|
846 | nt.assert_not_in("abc", matches) | |
836 |
|
847 | |||
837 | _, matches = complete(line_buffer="d['") |
|
848 | _, matches = complete(line_buffer="d['") | |
838 | nt.assert_in("abc", matches) |
|
849 | nt.assert_in("abc", matches) | |
839 | nt.assert_not_in("abd", matches) |
|
850 | nt.assert_not_in("abd", matches) | |
840 |
|
851 | |||
841 |
|
852 | |||
842 | def test_dict_key_completion_unicode_py3(): |
|
853 | def test_dict_key_completion_unicode_py3(): | |
843 | """Test handling of unicode in dict key completion""" |
|
854 | """Test handling of unicode in dict key completion""" | |
844 | ip = get_ipython() |
|
855 | ip = get_ipython() | |
845 | complete = ip.Completer.complete |
|
856 | complete = ip.Completer.complete | |
846 |
|
857 | |||
847 | ip.user_ns['d'] = {u'a\u05d0': None} |
|
858 | ip.user_ns['d'] = {u'a\u05d0': None} | |
848 |
|
859 | |||
849 | # query using escape |
|
860 | # query using escape | |
850 | if sys.platform != 'win32': |
|
861 | if sys.platform != 'win32': | |
851 | # Known failure on Windows |
|
862 | # Known failure on Windows | |
852 | _, matches = complete(line_buffer="d['a\\u05d0") |
|
863 | _, matches = complete(line_buffer="d['a\\u05d0") | |
853 | nt.assert_in("u05d0", matches) # tokenized after \\ |
|
864 | nt.assert_in("u05d0", matches) # tokenized after \\ | |
854 |
|
865 | |||
855 | # query using character |
|
866 | # query using character | |
856 | _, matches = complete(line_buffer="d['a\u05d0") |
|
867 | _, matches = complete(line_buffer="d['a\u05d0") | |
857 | nt.assert_in(u"a\u05d0", matches) |
|
868 | nt.assert_in(u"a\u05d0", matches) | |
858 |
|
869 | |||
859 | with greedy_completion(): |
|
870 | with greedy_completion(): | |
860 | # query using escape |
|
871 | # query using escape | |
861 | _, matches = complete(line_buffer="d['a\\u05d0") |
|
872 | _, matches = complete(line_buffer="d['a\\u05d0") | |
862 | nt.assert_in("d['a\\u05d0']", matches) # tokenized after \\ |
|
873 | nt.assert_in("d['a\\u05d0']", matches) # tokenized after \\ | |
863 |
|
874 | |||
864 | # query using character |
|
875 | # query using character | |
865 | _, matches = complete(line_buffer="d['a\u05d0") |
|
876 | _, matches = complete(line_buffer="d['a\u05d0") | |
866 | nt.assert_in(u"d['a\u05d0']", matches) |
|
877 | nt.assert_in(u"d['a\u05d0']", matches) | |
867 |
|
878 | |||
868 |
|
879 | |||
869 |
|
880 | |||
870 | @dec.skip_without('numpy') |
|
881 | @dec.skip_without('numpy') | |
871 | def test_struct_array_key_completion(): |
|
882 | def test_struct_array_key_completion(): | |
872 | """Test dict key completion applies to numpy struct arrays""" |
|
883 | """Test dict key completion applies to numpy struct arrays""" | |
873 | import numpy |
|
884 | import numpy | |
874 | ip = get_ipython() |
|
885 | ip = get_ipython() | |
875 | complete = ip.Completer.complete |
|
886 | complete = ip.Completer.complete | |
876 | ip.user_ns['d'] = numpy.array([], dtype=[('hello', 'f'), ('world', 'f')]) |
|
887 | ip.user_ns['d'] = numpy.array([], dtype=[('hello', 'f'), ('world', 'f')]) | |
877 | _, matches = complete(line_buffer="d['") |
|
888 | _, matches = complete(line_buffer="d['") | |
878 | nt.assert_in("hello", matches) |
|
889 | nt.assert_in("hello", matches) | |
879 | nt.assert_in("world", matches) |
|
890 | nt.assert_in("world", matches) | |
880 | # complete on the numpy struct itself |
|
891 | # complete on the numpy struct itself | |
881 | dt = numpy.dtype([('my_head', [('my_dt', '>u4'), ('my_df', '>u4')]), |
|
892 | dt = numpy.dtype([('my_head', [('my_dt', '>u4'), ('my_df', '>u4')]), | |
882 | ('my_data', '>f4', 5)]) |
|
893 | ('my_data', '>f4', 5)]) | |
883 | x = numpy.zeros(2, dtype=dt) |
|
894 | x = numpy.zeros(2, dtype=dt) | |
884 | ip.user_ns['d'] = x[1] |
|
895 | ip.user_ns['d'] = x[1] | |
885 | _, matches = complete(line_buffer="d['") |
|
896 | _, matches = complete(line_buffer="d['") | |
886 | nt.assert_in("my_head", matches) |
|
897 | nt.assert_in("my_head", matches) | |
887 | nt.assert_in("my_data", matches) |
|
898 | nt.assert_in("my_data", matches) | |
888 | # complete on a nested level |
|
899 | # complete on a nested level | |
889 | with greedy_completion(): |
|
900 | with greedy_completion(): | |
890 | ip.user_ns['d'] = numpy.zeros(2, dtype=dt) |
|
901 | ip.user_ns['d'] = numpy.zeros(2, dtype=dt) | |
891 | _, matches = complete(line_buffer="d[1]['my_head']['") |
|
902 | _, matches = complete(line_buffer="d[1]['my_head']['") | |
892 | nt.assert_true(any(["my_dt" in m for m in matches])) |
|
903 | nt.assert_true(any(["my_dt" in m for m in matches])) | |
893 | nt.assert_true(any(["my_df" in m for m in matches])) |
|
904 | nt.assert_true(any(["my_df" in m for m in matches])) | |
894 |
|
905 | |||
895 |
|
906 | |||
896 | @dec.skip_without('pandas') |
|
907 | @dec.skip_without('pandas') | |
897 | def test_dataframe_key_completion(): |
|
908 | def test_dataframe_key_completion(): | |
898 | """Test dict key completion applies to pandas DataFrames""" |
|
909 | """Test dict key completion applies to pandas DataFrames""" | |
899 | import pandas |
|
910 | import pandas | |
900 | ip = get_ipython() |
|
911 | ip = get_ipython() | |
901 | complete = ip.Completer.complete |
|
912 | complete = ip.Completer.complete | |
902 | ip.user_ns['d'] = pandas.DataFrame({'hello': [1], 'world': [2]}) |
|
913 | ip.user_ns['d'] = pandas.DataFrame({'hello': [1], 'world': [2]}) | |
903 | _, matches = complete(line_buffer="d['") |
|
914 | _, matches = complete(line_buffer="d['") | |
904 | nt.assert_in("hello", matches) |
|
915 | nt.assert_in("hello", matches) | |
905 | nt.assert_in("world", matches) |
|
916 | nt.assert_in("world", matches) | |
906 |
|
917 | |||
907 |
|
918 | |||
908 | def test_dict_key_completion_invalids(): |
|
919 | def test_dict_key_completion_invalids(): | |
909 | """Smoke test cases dict key completion can't handle""" |
|
920 | """Smoke test cases dict key completion can't handle""" | |
910 | ip = get_ipython() |
|
921 | ip = get_ipython() | |
911 | complete = ip.Completer.complete |
|
922 | complete = ip.Completer.complete | |
912 |
|
923 | |||
913 | ip.user_ns['no_getitem'] = None |
|
924 | ip.user_ns['no_getitem'] = None | |
914 | ip.user_ns['no_keys'] = [] |
|
925 | ip.user_ns['no_keys'] = [] | |
915 | ip.user_ns['cant_call_keys'] = dict |
|
926 | ip.user_ns['cant_call_keys'] = dict | |
916 | ip.user_ns['empty'] = {} |
|
927 | ip.user_ns['empty'] = {} | |
917 | ip.user_ns['d'] = {'abc': 5} |
|
928 | ip.user_ns['d'] = {'abc': 5} | |
918 |
|
929 | |||
919 | _, matches = complete(line_buffer="no_getitem['") |
|
930 | _, matches = complete(line_buffer="no_getitem['") | |
920 | _, matches = complete(line_buffer="no_keys['") |
|
931 | _, matches = complete(line_buffer="no_keys['") | |
921 | _, matches = complete(line_buffer="cant_call_keys['") |
|
932 | _, matches = complete(line_buffer="cant_call_keys['") | |
922 | _, matches = complete(line_buffer="empty['") |
|
933 | _, matches = complete(line_buffer="empty['") | |
923 | _, matches = complete(line_buffer="name_error['") |
|
934 | _, matches = complete(line_buffer="name_error['") | |
924 | _, matches = complete(line_buffer="d['\\") # incomplete escape |
|
935 | _, matches = complete(line_buffer="d['\\") # incomplete escape | |
925 |
|
936 | |||
926 | class KeyCompletable(object): |
|
937 | class KeyCompletable(object): | |
927 | def __init__(self, things=()): |
|
938 | def __init__(self, things=()): | |
928 | self.things = things |
|
939 | self.things = things | |
929 |
|
940 | |||
930 | def _ipython_key_completions_(self): |
|
941 | def _ipython_key_completions_(self): | |
931 | return list(self.things) |
|
942 | return list(self.things) | |
932 |
|
943 | |||
933 | def test_object_key_completion(): |
|
944 | def test_object_key_completion(): | |
934 | ip = get_ipython() |
|
945 | ip = get_ipython() | |
935 | ip.user_ns['key_completable'] = KeyCompletable(['qwerty', 'qwick']) |
|
946 | ip.user_ns['key_completable'] = KeyCompletable(['qwerty', 'qwick']) | |
936 |
|
947 | |||
937 | _, matches = ip.Completer.complete(line_buffer="key_completable['qw") |
|
948 | _, matches = ip.Completer.complete(line_buffer="key_completable['qw") | |
938 | nt.assert_in('qwerty', matches) |
|
949 | nt.assert_in('qwerty', matches) | |
939 | nt.assert_in('qwick', matches) |
|
950 | nt.assert_in('qwick', matches) | |
940 |
|
951 | |||
941 |
|
952 | |||
942 | class NamedInstanceMetaclass(type): |
|
953 | class NamedInstanceMetaclass(type): | |
943 | def __getitem__(cls, item): |
|
954 | def __getitem__(cls, item): | |
944 | return cls.get_instance(item) |
|
955 | return cls.get_instance(item) | |
945 |
|
956 | |||
946 | class NamedInstanceClass(object, metaclass=NamedInstanceMetaclass): |
|
957 | class NamedInstanceClass(object, metaclass=NamedInstanceMetaclass): | |
947 | def __init__(self, name): |
|
958 | def __init__(self, name): | |
948 | if not hasattr(self.__class__, 'instances'): |
|
959 | if not hasattr(self.__class__, 'instances'): | |
949 | self.__class__.instances = {} |
|
960 | self.__class__.instances = {} | |
950 | self.__class__.instances[name] = self |
|
961 | self.__class__.instances[name] = self | |
951 |
|
962 | |||
952 | @classmethod |
|
963 | @classmethod | |
953 | def _ipython_key_completions_(cls): |
|
964 | def _ipython_key_completions_(cls): | |
954 | return cls.instances.keys() |
|
965 | return cls.instances.keys() | |
955 |
|
966 | |||
956 | @classmethod |
|
967 | @classmethod | |
957 | def get_instance(cls, name): |
|
968 | def get_instance(cls, name): | |
958 | return cls.instances[name] |
|
969 | return cls.instances[name] | |
959 |
|
970 | |||
960 | def test_class_key_completion(): |
|
971 | def test_class_key_completion(): | |
961 | ip = get_ipython() |
|
972 | ip = get_ipython() | |
962 | NamedInstanceClass('qwerty') |
|
973 | NamedInstanceClass('qwerty') | |
963 | NamedInstanceClass('qwick') |
|
974 | NamedInstanceClass('qwick') | |
964 | ip.user_ns['named_instance_class'] = NamedInstanceClass |
|
975 | ip.user_ns['named_instance_class'] = NamedInstanceClass | |
965 |
|
976 | |||
966 | _, matches = ip.Completer.complete(line_buffer="named_instance_class['qw") |
|
977 | _, matches = ip.Completer.complete(line_buffer="named_instance_class['qw") | |
967 | nt.assert_in('qwerty', matches) |
|
978 | nt.assert_in('qwerty', matches) | |
968 | nt.assert_in('qwick', matches) |
|
979 | nt.assert_in('qwick', matches) | |
969 |
|
980 | |||
970 | def test_tryimport(): |
|
981 | def test_tryimport(): | |
971 | """ |
|
982 | """ | |
972 | Test that try-import don't crash on trailing dot, and import modules before |
|
983 | Test that try-import don't crash on trailing dot, and import modules before | |
973 | """ |
|
984 | """ | |
974 | from IPython.core.completerlib import try_import |
|
985 | from IPython.core.completerlib import try_import | |
975 | assert(try_import("IPython.")) |
|
986 | assert(try_import("IPython.")) | |
976 |
|
987 | |||
977 |
|
988 | |||
978 | def test_aimport_module_completer(): |
|
989 | def test_aimport_module_completer(): | |
979 | ip = get_ipython() |
|
990 | ip = get_ipython() | |
980 | _, matches = ip.complete('i', '%aimport i') |
|
991 | _, matches = ip.complete('i', '%aimport i') | |
981 | nt.assert_in('io', matches) |
|
992 | nt.assert_in('io', matches) | |
982 | nt.assert_not_in('int', matches) |
|
993 | nt.assert_not_in('int', matches) | |
983 |
|
994 | |||
984 | def test_nested_import_module_completer(): |
|
995 | def test_nested_import_module_completer(): | |
985 | ip = get_ipython() |
|
996 | ip = get_ipython() | |
986 | _, matches = ip.complete(None, 'import IPython.co', 17) |
|
997 | _, matches = ip.complete(None, 'import IPython.co', 17) | |
987 | nt.assert_in('IPython.core', matches) |
|
998 | nt.assert_in('IPython.core', matches) | |
988 | nt.assert_not_in('import IPython.core', matches) |
|
999 | nt.assert_not_in('import IPython.core', matches) | |
989 | nt.assert_not_in('IPython.display', matches) |
|
1000 | nt.assert_not_in('IPython.display', matches) | |
990 |
|
1001 | |||
991 | def test_import_module_completer(): |
|
1002 | def test_import_module_completer(): | |
992 | ip = get_ipython() |
|
1003 | ip = get_ipython() | |
993 | _, matches = ip.complete('i', 'import i') |
|
1004 | _, matches = ip.complete('i', 'import i') | |
994 | nt.assert_in('io', matches) |
|
1005 | nt.assert_in('io', matches) | |
995 | nt.assert_not_in('int', matches) |
|
1006 | nt.assert_not_in('int', matches) | |
996 |
|
1007 | |||
997 | def test_from_module_completer(): |
|
1008 | def test_from_module_completer(): | |
998 | ip = get_ipython() |
|
1009 | ip = get_ipython() | |
999 | _, matches = ip.complete('B', 'from io import B', 16) |
|
1010 | _, matches = ip.complete('B', 'from io import B', 16) | |
1000 | nt.assert_in('BytesIO', matches) |
|
1011 | nt.assert_in('BytesIO', matches) | |
1001 | nt.assert_not_in('BaseException', matches) |
|
1012 | nt.assert_not_in('BaseException', matches) | |
1002 |
|
1013 | |||
1003 | def test_snake_case_completion(): |
|
1014 | def test_snake_case_completion(): | |
1004 | ip = get_ipython() |
|
1015 | ip = get_ipython() | |
|
1016 | ip.Completer.use_jedi = False | |||
1005 | ip.user_ns['some_three'] = 3 |
|
1017 | ip.user_ns['some_three'] = 3 | |
1006 | ip.user_ns['some_four'] = 4 |
|
1018 | ip.user_ns['some_four'] = 4 | |
1007 | _, matches = ip.complete("s_", "print(s_f") |
|
1019 | _, matches = ip.complete("s_", "print(s_f") | |
1008 | nt.assert_in('some_three', matches) |
|
1020 | nt.assert_in('some_three', matches) | |
1009 | nt.assert_in('some_four', matches) |
|
1021 | nt.assert_in('some_four', matches) |
General Comments 0
You need to be logged in to leave comments.
Login now