Show More
@@ -1,3288 +1,3288 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 | from __future__ import absolute_import, print_function |
|
13 | from __future__ import absolute_import, print_function | |
14 |
|
14 | |||
15 | import __future__ |
|
15 | import __future__ | |
16 | import abc |
|
16 | import abc | |
17 | import ast |
|
17 | import ast | |
18 | import atexit |
|
18 | import atexit | |
19 | import functools |
|
19 | import functools | |
20 | import os |
|
20 | import os | |
21 | import re |
|
21 | import re | |
22 | import runpy |
|
22 | import runpy | |
23 | import sys |
|
23 | import sys | |
24 | import tempfile |
|
24 | import tempfile | |
25 | import types |
|
25 | import types | |
26 | import subprocess |
|
26 | import subprocess | |
27 | from io import open as io_open |
|
27 | from io import open as io_open | |
28 |
|
28 | |||
29 | from IPython.config.configurable import SingletonConfigurable |
|
29 | from IPython.config.configurable import SingletonConfigurable | |
30 | from IPython.core import debugger, oinspect |
|
30 | from IPython.core import debugger, oinspect | |
31 | from IPython.core import magic |
|
31 | from IPython.core import magic | |
32 | from IPython.core import page |
|
32 | from IPython.core import page | |
33 | from IPython.core import prefilter |
|
33 | from IPython.core import prefilter | |
34 | from IPython.core import shadowns |
|
34 | from IPython.core import shadowns | |
35 | from IPython.core import ultratb |
|
35 | from IPython.core import ultratb | |
36 | from IPython.core.alias import AliasManager, AliasError |
|
36 | from IPython.core.alias import AliasManager, AliasError | |
37 | from IPython.core.autocall import ExitAutocall |
|
37 | from IPython.core.autocall import ExitAutocall | |
38 | from IPython.core.builtin_trap import BuiltinTrap |
|
38 | from IPython.core.builtin_trap import BuiltinTrap | |
39 | from IPython.core.events import EventManager, available_events |
|
39 | from IPython.core.events import EventManager, available_events | |
40 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
40 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython | |
41 | from IPython.core.display_trap import DisplayTrap |
|
41 | from IPython.core.display_trap import DisplayTrap | |
42 | from IPython.core.displayhook import DisplayHook |
|
42 | from IPython.core.displayhook import DisplayHook | |
43 | from IPython.core.displaypub import DisplayPublisher |
|
43 | from IPython.core.displaypub import DisplayPublisher | |
44 | from IPython.core.error import InputRejected, UsageError |
|
44 | from IPython.core.error import InputRejected, UsageError | |
45 | from IPython.core.extensions import ExtensionManager |
|
45 | from IPython.core.extensions import ExtensionManager | |
46 | from IPython.core.formatters import DisplayFormatter |
|
46 | from IPython.core.formatters import DisplayFormatter | |
47 | from IPython.core.history import HistoryManager |
|
47 | from IPython.core.history import HistoryManager | |
48 | from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2 |
|
48 | from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2 | |
49 | from IPython.core.logger import Logger |
|
49 | from IPython.core.logger import Logger | |
50 | from IPython.core.macro import Macro |
|
50 | from IPython.core.macro import Macro | |
51 | from IPython.core.payload import PayloadManager |
|
51 | from IPython.core.payload import PayloadManager | |
52 | from IPython.core.prefilter import PrefilterManager |
|
52 | from IPython.core.prefilter import PrefilterManager | |
53 | from IPython.core.profiledir import ProfileDir |
|
53 | from IPython.core.profiledir import ProfileDir | |
54 | from IPython.core.prompts import PromptManager |
|
54 | from IPython.core.prompts import PromptManager | |
55 | from IPython.core.usage import default_banner |
|
55 | from IPython.core.usage import default_banner | |
56 | from IPython.lib.latextools import LaTeXTool |
|
56 | from IPython.lib.latextools import LaTeXTool | |
57 | from IPython.testing.skipdoctest import skip_doctest |
|
57 | from IPython.testing.skipdoctest import skip_doctest | |
58 | from IPython.utils import PyColorize |
|
58 | from IPython.utils import PyColorize | |
59 | from IPython.utils import io |
|
59 | from IPython.utils import io | |
60 | from IPython.utils import py3compat |
|
60 | from IPython.utils import py3compat | |
61 | from IPython.utils import openpy |
|
61 | from IPython.utils import openpy | |
62 | from IPython.utils.decorators import undoc |
|
62 | from IPython.utils.decorators import undoc | |
63 | from IPython.utils.io import ask_yes_no |
|
63 | from IPython.utils.io import ask_yes_no | |
64 | from IPython.utils.ipstruct import Struct |
|
64 | from IPython.utils.ipstruct import Struct | |
65 | from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename, ensure_dir_exists |
|
65 | from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename, ensure_dir_exists | |
66 | from IPython.utils.pickleshare import PickleShareDB |
|
66 | from IPython.utils.pickleshare import PickleShareDB | |
67 | from IPython.utils.process import system, getoutput |
|
67 | from IPython.utils.process import system, getoutput | |
68 | from IPython.utils.py3compat import (builtin_mod, unicode_type, string_types, |
|
68 | from IPython.utils.py3compat import (builtin_mod, unicode_type, string_types, | |
69 | with_metaclass, iteritems) |
|
69 | with_metaclass, iteritems) | |
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, |
|
72 | from IPython.utils.text import (format_screen, LSString, SList, | |
73 | DollarFormatter) |
|
73 | DollarFormatter) | |
74 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, |
|
74 | from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum, | |
75 | List, Unicode, Instance, Type) |
|
75 | List, Unicode, Instance, Type) | |
76 | from IPython.utils.warn import warn, error |
|
76 | from IPython.utils.warn import warn, error | |
77 | import IPython.core.hooks |
|
77 | import IPython.core.hooks | |
78 |
|
78 | |||
79 | #----------------------------------------------------------------------------- |
|
79 | #----------------------------------------------------------------------------- | |
80 | # Globals |
|
80 | # Globals | |
81 | #----------------------------------------------------------------------------- |
|
81 | #----------------------------------------------------------------------------- | |
82 |
|
82 | |||
83 | # compiled regexps for autoindent management |
|
83 | # compiled regexps for autoindent management | |
84 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
84 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') | |
85 |
|
85 | |||
86 | #----------------------------------------------------------------------------- |
|
86 | #----------------------------------------------------------------------------- | |
87 | # Utilities |
|
87 | # Utilities | |
88 | #----------------------------------------------------------------------------- |
|
88 | #----------------------------------------------------------------------------- | |
89 |
|
89 | |||
90 | @undoc |
|
90 | @undoc | |
91 | def softspace(file, newvalue): |
|
91 | def softspace(file, newvalue): | |
92 | """Copied from code.py, to remove the dependency""" |
|
92 | """Copied from code.py, to remove the dependency""" | |
93 |
|
93 | |||
94 | oldvalue = 0 |
|
94 | oldvalue = 0 | |
95 | try: |
|
95 | try: | |
96 | oldvalue = file.softspace |
|
96 | oldvalue = file.softspace | |
97 | except AttributeError: |
|
97 | except AttributeError: | |
98 | pass |
|
98 | pass | |
99 | try: |
|
99 | try: | |
100 | file.softspace = newvalue |
|
100 | file.softspace = newvalue | |
101 | except (AttributeError, TypeError): |
|
101 | except (AttributeError, TypeError): | |
102 | # "attribute-less object" or "read-only attributes" |
|
102 | # "attribute-less object" or "read-only attributes" | |
103 | pass |
|
103 | pass | |
104 | return oldvalue |
|
104 | return oldvalue | |
105 |
|
105 | |||
106 | @undoc |
|
106 | @undoc | |
107 | def no_op(*a, **kw): pass |
|
107 | def no_op(*a, **kw): pass | |
108 |
|
108 | |||
109 | @undoc |
|
109 | @undoc | |
110 | class NoOpContext(object): |
|
110 | class NoOpContext(object): | |
111 | def __enter__(self): pass |
|
111 | def __enter__(self): pass | |
112 | def __exit__(self, type, value, traceback): pass |
|
112 | def __exit__(self, type, value, traceback): pass | |
113 | no_op_context = NoOpContext() |
|
113 | no_op_context = NoOpContext() | |
114 |
|
114 | |||
115 | class SpaceInInput(Exception): pass |
|
115 | class SpaceInInput(Exception): pass | |
116 |
|
116 | |||
117 | @undoc |
|
117 | @undoc | |
118 | class Bunch: pass |
|
118 | class Bunch: pass | |
119 |
|
119 | |||
120 |
|
120 | |||
121 | def get_default_colors(): |
|
121 | def get_default_colors(): | |
122 | if sys.platform=='darwin': |
|
122 | if sys.platform=='darwin': | |
123 | return "LightBG" |
|
123 | return "LightBG" | |
124 | elif os.name=='nt': |
|
124 | elif os.name=='nt': | |
125 | return 'Linux' |
|
125 | return 'Linux' | |
126 | else: |
|
126 | else: | |
127 | return 'Linux' |
|
127 | return 'Linux' | |
128 |
|
128 | |||
129 |
|
129 | |||
130 | class SeparateUnicode(Unicode): |
|
130 | class SeparateUnicode(Unicode): | |
131 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
131 | r"""A Unicode subclass to validate separate_in, separate_out, etc. | |
132 |
|
132 | |||
133 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
133 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. | |
134 | """ |
|
134 | """ | |
135 |
|
135 | |||
136 | def validate(self, obj, value): |
|
136 | def validate(self, obj, value): | |
137 | if value == '0': value = '' |
|
137 | if value == '0': value = '' | |
138 | value = value.replace('\\n','\n') |
|
138 | value = value.replace('\\n','\n') | |
139 | return super(SeparateUnicode, self).validate(obj, value) |
|
139 | return super(SeparateUnicode, self).validate(obj, value) | |
140 |
|
140 | |||
141 |
|
141 | |||
142 | class ReadlineNoRecord(object): |
|
142 | class ReadlineNoRecord(object): | |
143 | """Context manager to execute some code, then reload readline history |
|
143 | """Context manager to execute some code, then reload readline history | |
144 | so that interactive input to the code doesn't appear when pressing up.""" |
|
144 | so that interactive input to the code doesn't appear when pressing up.""" | |
145 | def __init__(self, shell): |
|
145 | def __init__(self, shell): | |
146 | self.shell = shell |
|
146 | self.shell = shell | |
147 | self._nested_level = 0 |
|
147 | self._nested_level = 0 | |
148 |
|
148 | |||
149 | def __enter__(self): |
|
149 | def __enter__(self): | |
150 | if self._nested_level == 0: |
|
150 | if self._nested_level == 0: | |
151 | try: |
|
151 | try: | |
152 | self.orig_length = self.current_length() |
|
152 | self.orig_length = self.current_length() | |
153 | self.readline_tail = self.get_readline_tail() |
|
153 | self.readline_tail = self.get_readline_tail() | |
154 | except (AttributeError, IndexError): # Can fail with pyreadline |
|
154 | except (AttributeError, IndexError): # Can fail with pyreadline | |
155 | self.orig_length, self.readline_tail = 999999, [] |
|
155 | self.orig_length, self.readline_tail = 999999, [] | |
156 | self._nested_level += 1 |
|
156 | self._nested_level += 1 | |
157 |
|
157 | |||
158 | def __exit__(self, type, value, traceback): |
|
158 | def __exit__(self, type, value, traceback): | |
159 | self._nested_level -= 1 |
|
159 | self._nested_level -= 1 | |
160 | if self._nested_level == 0: |
|
160 | if self._nested_level == 0: | |
161 | # Try clipping the end if it's got longer |
|
161 | # Try clipping the end if it's got longer | |
162 | try: |
|
162 | try: | |
163 | e = self.current_length() - self.orig_length |
|
163 | e = self.current_length() - self.orig_length | |
164 | if e > 0: |
|
164 | if e > 0: | |
165 | for _ in range(e): |
|
165 | for _ in range(e): | |
166 | self.shell.readline.remove_history_item(self.orig_length) |
|
166 | self.shell.readline.remove_history_item(self.orig_length) | |
167 |
|
167 | |||
168 | # If it still doesn't match, just reload readline history. |
|
168 | # If it still doesn't match, just reload readline history. | |
169 | if self.current_length() != self.orig_length \ |
|
169 | if self.current_length() != self.orig_length \ | |
170 | or self.get_readline_tail() != self.readline_tail: |
|
170 | or self.get_readline_tail() != self.readline_tail: | |
171 | self.shell.refill_readline_hist() |
|
171 | self.shell.refill_readline_hist() | |
172 | except (AttributeError, IndexError): |
|
172 | except (AttributeError, IndexError): | |
173 | pass |
|
173 | pass | |
174 | # Returning False will cause exceptions to propagate |
|
174 | # Returning False will cause exceptions to propagate | |
175 | return False |
|
175 | return False | |
176 |
|
176 | |||
177 | def current_length(self): |
|
177 | def current_length(self): | |
178 | return self.shell.readline.get_current_history_length() |
|
178 | return self.shell.readline.get_current_history_length() | |
179 |
|
179 | |||
180 | def get_readline_tail(self, n=10): |
|
180 | def get_readline_tail(self, n=10): | |
181 | """Get the last n items in readline history.""" |
|
181 | """Get the last n items in readline history.""" | |
182 | end = self.shell.readline.get_current_history_length() + 1 |
|
182 | end = self.shell.readline.get_current_history_length() + 1 | |
183 | start = max(end-n, 1) |
|
183 | start = max(end-n, 1) | |
184 | ghi = self.shell.readline.get_history_item |
|
184 | ghi = self.shell.readline.get_history_item | |
185 | return [ghi(x) for x in range(start, end)] |
|
185 | return [ghi(x) for x in range(start, end)] | |
186 |
|
186 | |||
187 |
|
187 | |||
188 | @undoc |
|
188 | @undoc | |
189 | class DummyMod(object): |
|
189 | class DummyMod(object): | |
190 | """A dummy module used for IPython's interactive module when |
|
190 | """A dummy module used for IPython's interactive module when | |
191 | a namespace must be assigned to the module's __dict__.""" |
|
191 | a namespace must be assigned to the module's __dict__.""" | |
192 | pass |
|
192 | pass | |
193 |
|
193 | |||
194 | #----------------------------------------------------------------------------- |
|
194 | #----------------------------------------------------------------------------- | |
195 | # Main IPython class |
|
195 | # Main IPython class | |
196 | #----------------------------------------------------------------------------- |
|
196 | #----------------------------------------------------------------------------- | |
197 |
|
197 | |||
198 | class InteractiveShell(SingletonConfigurable): |
|
198 | class InteractiveShell(SingletonConfigurable): | |
199 | """An enhanced, interactive shell for Python.""" |
|
199 | """An enhanced, interactive shell for Python.""" | |
200 |
|
200 | |||
201 | _instance = None |
|
201 | _instance = None | |
202 |
|
202 | |||
203 | ast_transformers = List([], config=True, help= |
|
203 | ast_transformers = List([], config=True, help= | |
204 | """ |
|
204 | """ | |
205 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
205 | A list of ast.NodeTransformer subclass instances, which will be applied | |
206 | to user input before code is run. |
|
206 | to user input before code is run. | |
207 | """ |
|
207 | """ | |
208 | ) |
|
208 | ) | |
209 |
|
209 | |||
210 | autocall = Enum((0,1,2), default_value=0, config=True, help= |
|
210 | autocall = Enum((0,1,2), default_value=0, config=True, help= | |
211 | """ |
|
211 | """ | |
212 | Make IPython automatically call any callable object even if you didn't |
|
212 | Make IPython automatically call any callable object even if you didn't | |
213 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
213 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' | |
214 | automatically. The value can be '0' to disable the feature, '1' for |
|
214 | automatically. The value can be '0' to disable the feature, '1' for | |
215 | 'smart' autocall, where it is not applied if there are no more |
|
215 | 'smart' autocall, where it is not applied if there are no more | |
216 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
216 | arguments on the line, and '2' for 'full' autocall, where all callable | |
217 | objects are automatically called (even if no arguments are present). |
|
217 | objects are automatically called (even if no arguments are present). | |
218 | """ |
|
218 | """ | |
219 | ) |
|
219 | ) | |
220 | # TODO: remove all autoindent logic and put into frontends. |
|
220 | # TODO: remove all autoindent logic and put into frontends. | |
221 | # We can't do this yet because even runlines uses the autoindent. |
|
221 | # We can't do this yet because even runlines uses the autoindent. | |
222 | autoindent = CBool(True, config=True, help= |
|
222 | autoindent = CBool(True, config=True, help= | |
223 | """ |
|
223 | """ | |
224 | Autoindent IPython code entered interactively. |
|
224 | Autoindent IPython code entered interactively. | |
225 | """ |
|
225 | """ | |
226 | ) |
|
226 | ) | |
227 | automagic = CBool(True, config=True, help= |
|
227 | automagic = CBool(True, config=True, help= | |
228 | """ |
|
228 | """ | |
229 | Enable magic commands to be called without the leading %. |
|
229 | Enable magic commands to be called without the leading %. | |
230 | """ |
|
230 | """ | |
231 | ) |
|
231 | ) | |
232 |
|
232 | |||
233 | banner = Unicode('') |
|
233 | banner = Unicode('') | |
234 |
|
234 | |||
235 | banner1 = Unicode(default_banner, config=True, |
|
235 | banner1 = Unicode(default_banner, config=True, | |
236 | help="""The part of the banner to be printed before the profile""" |
|
236 | help="""The part of the banner to be printed before the profile""" | |
237 | ) |
|
237 | ) | |
238 | banner2 = Unicode('', config=True, |
|
238 | banner2 = Unicode('', config=True, | |
239 | help="""The part of the banner to be printed after the profile""" |
|
239 | help="""The part of the banner to be printed after the profile""" | |
240 | ) |
|
240 | ) | |
241 |
|
241 | |||
242 | cache_size = Integer(1000, config=True, help= |
|
242 | cache_size = Integer(1000, config=True, help= | |
243 | """ |
|
243 | """ | |
244 | Set the size of the output cache. The default is 1000, you can |
|
244 | Set the size of the output cache. The default is 1000, you can | |
245 | change it permanently in your config file. Setting it to 0 completely |
|
245 | change it permanently in your config file. Setting it to 0 completely | |
246 | disables the caching system, and the minimum value accepted is 20 (if |
|
246 | disables the caching system, and the minimum value accepted is 20 (if | |
247 | you provide a value less than 20, it is reset to 0 and a warning is |
|
247 | you provide a value less than 20, it is reset to 0 and a warning is | |
248 | issued). This limit is defined because otherwise you'll spend more |
|
248 | issued). This limit is defined because otherwise you'll spend more | |
249 | time re-flushing a too small cache than working |
|
249 | time re-flushing a too small cache than working | |
250 | """ |
|
250 | """ | |
251 | ) |
|
251 | ) | |
252 | color_info = CBool(True, config=True, help= |
|
252 | color_info = CBool(True, config=True, help= | |
253 | """ |
|
253 | """ | |
254 | Use colors for displaying information about objects. Because this |
|
254 | Use colors for displaying information about objects. Because this | |
255 | information is passed through a pager (like 'less'), and some pagers |
|
255 | information is passed through a pager (like 'less'), and some pagers | |
256 | get confused with color codes, this capability can be turned off. |
|
256 | get confused with color codes, this capability can be turned off. | |
257 | """ |
|
257 | """ | |
258 | ) |
|
258 | ) | |
259 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), |
|
259 | colors = CaselessStrEnum(('NoColor','LightBG','Linux'), | |
260 | default_value=get_default_colors(), config=True, |
|
260 | default_value=get_default_colors(), config=True, | |
261 | help="Set the color scheme (NoColor, Linux, or LightBG)." |
|
261 | help="Set the color scheme (NoColor, Linux, or LightBG)." | |
262 | ) |
|
262 | ) | |
263 | colors_force = CBool(False, help= |
|
263 | colors_force = CBool(False, help= | |
264 | """ |
|
264 | """ | |
265 | Force use of ANSI color codes, regardless of OS and readline |
|
265 | Force use of ANSI color codes, regardless of OS and readline | |
266 | availability. |
|
266 | availability. | |
267 | """ |
|
267 | """ | |
268 | # FIXME: This is essentially a hack to allow ZMQShell to show colors |
|
268 | # FIXME: This is essentially a hack to allow ZMQShell to show colors | |
269 | # without readline on Win32. When the ZMQ formatting system is |
|
269 | # without readline on Win32. When the ZMQ formatting system is | |
270 | # refactored, this should be removed. |
|
270 | # refactored, this should be removed. | |
271 | ) |
|
271 | ) | |
272 | debug = CBool(False, config=True) |
|
272 | debug = CBool(False, config=True) | |
273 | deep_reload = CBool(False, config=True, help= |
|
273 | deep_reload = CBool(False, config=True, help= | |
274 | """ |
|
274 | """ | |
275 | Enable deep (recursive) reloading by default. IPython can use the |
|
275 | Enable deep (recursive) reloading by default. IPython can use the | |
276 | deep_reload module which reloads changes in modules recursively (it |
|
276 | deep_reload module which reloads changes in modules recursively (it | |
277 | replaces the reload() function, so you don't need to change anything to |
|
277 | replaces the reload() function, so you don't need to change anything to | |
278 | use it). deep_reload() forces a full reload of modules whose code may |
|
278 | use it). deep_reload() forces a full reload of modules whose code may | |
279 | have changed, which the default reload() function does not. When |
|
279 | have changed, which the default reload() function does not. When | |
280 | deep_reload is off, IPython will use the normal reload(), but |
|
280 | deep_reload is off, IPython will use the normal reload(), but | |
281 | deep_reload will still be available as dreload(). |
|
281 | deep_reload will still be available as dreload(). | |
282 | """ |
|
282 | """ | |
283 | ) |
|
283 | ) | |
284 | disable_failing_post_execute = CBool(False, config=True, |
|
284 | disable_failing_post_execute = CBool(False, config=True, | |
285 | help="Don't call post-execute functions that have failed in the past." |
|
285 | help="Don't call post-execute functions that have failed in the past." | |
286 | ) |
|
286 | ) | |
287 | display_formatter = Instance(DisplayFormatter) |
|
287 | display_formatter = Instance(DisplayFormatter) | |
288 | displayhook_class = Type(DisplayHook) |
|
288 | displayhook_class = Type(DisplayHook) | |
289 | display_pub_class = Type(DisplayPublisher) |
|
289 | display_pub_class = Type(DisplayPublisher) | |
290 | data_pub_class = None |
|
290 | data_pub_class = None | |
291 |
|
291 | |||
292 | exit_now = CBool(False) |
|
292 | exit_now = CBool(False) | |
293 | exiter = Instance(ExitAutocall) |
|
293 | exiter = Instance(ExitAutocall) | |
294 | def _exiter_default(self): |
|
294 | def _exiter_default(self): | |
295 | return ExitAutocall(self) |
|
295 | return ExitAutocall(self) | |
296 | # Monotonically increasing execution counter |
|
296 | # Monotonically increasing execution counter | |
297 | execution_count = Integer(1) |
|
297 | execution_count = Integer(1) | |
298 | filename = Unicode("<ipython console>") |
|
298 | filename = Unicode("<ipython console>") | |
299 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ |
|
299 | ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__ | |
300 |
|
300 | |||
301 | # Input splitter, to transform input line by line and detect when a block |
|
301 | # Input splitter, to transform input line by line and detect when a block | |
302 | # is ready to be executed. |
|
302 | # is ready to be executed. | |
303 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
303 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
304 | (), {'line_input_checker': True}) |
|
304 | (), {'line_input_checker': True}) | |
305 |
|
305 | |||
306 | # This InputSplitter instance is used to transform completed cells before |
|
306 | # This InputSplitter instance is used to transform completed cells before | |
307 | # running them. It allows cell magics to contain blank lines. |
|
307 | # running them. It allows cell magics to contain blank lines. | |
308 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
308 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', | |
309 | (), {'line_input_checker': False}) |
|
309 | (), {'line_input_checker': False}) | |
310 |
|
310 | |||
311 | logstart = CBool(False, config=True, help= |
|
311 | logstart = CBool(False, config=True, help= | |
312 | """ |
|
312 | """ | |
313 | Start logging to the default log file. |
|
313 | Start logging to the default log file. | |
314 | """ |
|
314 | """ | |
315 | ) |
|
315 | ) | |
316 | logfile = Unicode('', config=True, help= |
|
316 | logfile = Unicode('', config=True, help= | |
317 | """ |
|
317 | """ | |
318 | The name of the logfile to use. |
|
318 | The name of the logfile to use. | |
319 | """ |
|
319 | """ | |
320 | ) |
|
320 | ) | |
321 | logappend = Unicode('', config=True, help= |
|
321 | logappend = Unicode('', config=True, help= | |
322 | """ |
|
322 | """ | |
323 | Start logging to the given file in append mode. |
|
323 | Start logging to the given file in append mode. | |
324 | """ |
|
324 | """ | |
325 | ) |
|
325 | ) | |
326 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
326 | object_info_string_level = Enum((0,1,2), default_value=0, | |
327 | config=True) |
|
327 | config=True) | |
328 | pdb = CBool(False, config=True, help= |
|
328 | pdb = CBool(False, config=True, help= | |
329 | """ |
|
329 | """ | |
330 | Automatically call the pdb debugger after every exception. |
|
330 | Automatically call the pdb debugger after every exception. | |
331 | """ |
|
331 | """ | |
332 | ) |
|
332 | ) | |
333 | multiline_history = CBool(sys.platform != 'win32', config=True, |
|
333 | multiline_history = CBool(sys.platform != 'win32', config=True, | |
334 | help="Save multi-line entries as one entry in readline history" |
|
334 | help="Save multi-line entries as one entry in readline history" | |
335 | ) |
|
335 | ) | |
336 |
|
336 | |||
337 | # deprecated prompt traits: |
|
337 | # deprecated prompt traits: | |
338 |
|
338 | |||
339 | prompt_in1 = Unicode('In [\\#]: ', config=True, |
|
339 | prompt_in1 = Unicode('In [\\#]: ', config=True, | |
340 | help="Deprecated, use PromptManager.in_template") |
|
340 | help="Deprecated, use PromptManager.in_template") | |
341 | prompt_in2 = Unicode(' .\\D.: ', config=True, |
|
341 | prompt_in2 = Unicode(' .\\D.: ', config=True, | |
342 | help="Deprecated, use PromptManager.in2_template") |
|
342 | help="Deprecated, use PromptManager.in2_template") | |
343 | prompt_out = Unicode('Out[\\#]: ', config=True, |
|
343 | prompt_out = Unicode('Out[\\#]: ', config=True, | |
344 | help="Deprecated, use PromptManager.out_template") |
|
344 | help="Deprecated, use PromptManager.out_template") | |
345 | prompts_pad_left = CBool(True, config=True, |
|
345 | prompts_pad_left = CBool(True, config=True, | |
346 | help="Deprecated, use PromptManager.justify") |
|
346 | help="Deprecated, use PromptManager.justify") | |
347 |
|
347 | |||
348 | def _prompt_trait_changed(self, name, old, new): |
|
348 | def _prompt_trait_changed(self, name, old, new): | |
349 | table = { |
|
349 | table = { | |
350 | 'prompt_in1' : 'in_template', |
|
350 | 'prompt_in1' : 'in_template', | |
351 | 'prompt_in2' : 'in2_template', |
|
351 | 'prompt_in2' : 'in2_template', | |
352 | 'prompt_out' : 'out_template', |
|
352 | 'prompt_out' : 'out_template', | |
353 | 'prompts_pad_left' : 'justify', |
|
353 | 'prompts_pad_left' : 'justify', | |
354 | } |
|
354 | } | |
355 | warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format( |
|
355 | warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format( | |
356 | name=name, newname=table[name]) |
|
356 | name=name, newname=table[name]) | |
357 | ) |
|
357 | ) | |
358 | # protect against weird cases where self.config may not exist: |
|
358 | # protect against weird cases where self.config may not exist: | |
359 | if self.config is not None: |
|
359 | if self.config is not None: | |
360 | # propagate to corresponding PromptManager trait |
|
360 | # propagate to corresponding PromptManager trait | |
361 | setattr(self.config.PromptManager, table[name], new) |
|
361 | setattr(self.config.PromptManager, table[name], new) | |
362 |
|
362 | |||
363 | _prompt_in1_changed = _prompt_trait_changed |
|
363 | _prompt_in1_changed = _prompt_trait_changed | |
364 | _prompt_in2_changed = _prompt_trait_changed |
|
364 | _prompt_in2_changed = _prompt_trait_changed | |
365 | _prompt_out_changed = _prompt_trait_changed |
|
365 | _prompt_out_changed = _prompt_trait_changed | |
366 | _prompt_pad_left_changed = _prompt_trait_changed |
|
366 | _prompt_pad_left_changed = _prompt_trait_changed | |
367 |
|
367 | |||
368 | show_rewritten_input = CBool(True, config=True, |
|
368 | show_rewritten_input = CBool(True, config=True, | |
369 | help="Show rewritten input, e.g. for autocall." |
|
369 | help="Show rewritten input, e.g. for autocall." | |
370 | ) |
|
370 | ) | |
371 |
|
371 | |||
372 | quiet = CBool(False, config=True) |
|
372 | quiet = CBool(False, config=True) | |
373 |
|
373 | |||
374 | history_length = Integer(10000, config=True) |
|
374 | history_length = Integer(10000, config=True) | |
375 |
|
375 | |||
376 | # The readline stuff will eventually be moved to the terminal subclass |
|
376 | # The readline stuff will eventually be moved to the terminal subclass | |
377 | # but for now, we can't do that as readline is welded in everywhere. |
|
377 | # but for now, we can't do that as readline is welded in everywhere. | |
378 | readline_use = CBool(True, config=True) |
|
378 | readline_use = CBool(True, config=True) | |
379 | readline_remove_delims = Unicode('-/~', config=True) |
|
379 | readline_remove_delims = Unicode('-/~', config=True) | |
380 | readline_delims = Unicode() # set by init_readline() |
|
380 | readline_delims = Unicode() # set by init_readline() | |
381 | # don't use \M- bindings by default, because they |
|
381 | # don't use \M- bindings by default, because they | |
382 | # conflict with 8-bit encodings. See gh-58,gh-88 |
|
382 | # conflict with 8-bit encodings. See gh-58,gh-88 | |
383 | readline_parse_and_bind = List([ |
|
383 | readline_parse_and_bind = List([ | |
384 | 'tab: complete', |
|
384 | 'tab: complete', | |
385 | '"\C-l": clear-screen', |
|
385 | '"\C-l": clear-screen', | |
386 | 'set show-all-if-ambiguous on', |
|
386 | 'set show-all-if-ambiguous on', | |
387 | '"\C-o": tab-insert', |
|
387 | '"\C-o": tab-insert', | |
388 | '"\C-r": reverse-search-history', |
|
388 | '"\C-r": reverse-search-history', | |
389 | '"\C-s": forward-search-history', |
|
389 | '"\C-s": forward-search-history', | |
390 | '"\C-p": history-search-backward', |
|
390 | '"\C-p": history-search-backward', | |
391 | '"\C-n": history-search-forward', |
|
391 | '"\C-n": history-search-forward', | |
392 | '"\e[A": history-search-backward', |
|
392 | '"\e[A": history-search-backward', | |
393 | '"\e[B": history-search-forward', |
|
393 | '"\e[B": history-search-forward', | |
394 | '"\C-k": kill-line', |
|
394 | '"\C-k": kill-line', | |
395 | '"\C-u": unix-line-discard', |
|
395 | '"\C-u": unix-line-discard', | |
396 | ], config=True) |
|
396 | ], config=True) | |
397 |
|
397 | |||
398 | _custom_readline_config = False |
|
398 | _custom_readline_config = False | |
399 |
|
399 | |||
400 | def _readline_parse_and_bind_changed(self, name, old, new): |
|
400 | def _readline_parse_and_bind_changed(self, name, old, new): | |
401 | # notice that readline config is customized |
|
401 | # notice that readline config is customized | |
402 | # indicates that it should have higher priority than inputrc |
|
402 | # indicates that it should have higher priority than inputrc | |
403 | self._custom_readline_config = True |
|
403 | self._custom_readline_config = True | |
404 |
|
404 | |||
405 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'], |
|
405 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'], | |
406 | default_value='last_expr', config=True, |
|
406 | default_value='last_expr', config=True, | |
407 | help=""" |
|
407 | help=""" | |
408 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
408 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be | |
409 | run interactively (displaying output from expressions).""") |
|
409 | run interactively (displaying output from expressions).""") | |
410 |
|
410 | |||
411 | # TODO: this part of prompt management should be moved to the frontends. |
|
411 | # TODO: this part of prompt management should be moved to the frontends. | |
412 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
412 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' | |
413 | separate_in = SeparateUnicode('\n', config=True) |
|
413 | separate_in = SeparateUnicode('\n', config=True) | |
414 | separate_out = SeparateUnicode('', config=True) |
|
414 | separate_out = SeparateUnicode('', config=True) | |
415 | separate_out2 = SeparateUnicode('', config=True) |
|
415 | separate_out2 = SeparateUnicode('', config=True) | |
416 | wildcards_case_sensitive = CBool(True, config=True) |
|
416 | wildcards_case_sensitive = CBool(True, config=True) | |
417 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
417 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), | |
418 | default_value='Context', config=True) |
|
418 | default_value='Context', config=True) | |
419 |
|
419 | |||
420 | # Subcomponents of InteractiveShell |
|
420 | # Subcomponents of InteractiveShell | |
421 | alias_manager = Instance('IPython.core.alias.AliasManager') |
|
421 | alias_manager = Instance('IPython.core.alias.AliasManager') | |
422 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') |
|
422 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager') | |
423 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') |
|
423 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap') | |
424 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') |
|
424 | display_trap = Instance('IPython.core.display_trap.DisplayTrap') | |
425 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') |
|
425 | extension_manager = Instance('IPython.core.extensions.ExtensionManager') | |
426 | payload_manager = Instance('IPython.core.payload.PayloadManager') |
|
426 | payload_manager = Instance('IPython.core.payload.PayloadManager') | |
427 | history_manager = Instance('IPython.core.history.HistoryManager') |
|
427 | history_manager = Instance('IPython.core.history.HistoryManager') | |
428 | magics_manager = Instance('IPython.core.magic.MagicsManager') |
|
428 | magics_manager = Instance('IPython.core.magic.MagicsManager') | |
429 |
|
429 | |||
430 | profile_dir = Instance('IPython.core.application.ProfileDir') |
|
430 | profile_dir = Instance('IPython.core.application.ProfileDir') | |
431 | @property |
|
431 | @property | |
432 | def profile(self): |
|
432 | def profile(self): | |
433 | if self.profile_dir is not None: |
|
433 | if self.profile_dir is not None: | |
434 | name = os.path.basename(self.profile_dir.location) |
|
434 | name = os.path.basename(self.profile_dir.location) | |
435 | return name.replace('profile_','') |
|
435 | return name.replace('profile_','') | |
436 |
|
436 | |||
437 |
|
437 | |||
438 | # Private interface |
|
438 | # Private interface | |
439 | _post_execute = Instance(dict) |
|
439 | _post_execute = Instance(dict) | |
440 |
|
440 | |||
441 | # Tracks any GUI loop loaded for pylab |
|
441 | # Tracks any GUI loop loaded for pylab | |
442 | pylab_gui_select = None |
|
442 | pylab_gui_select = None | |
443 |
|
443 | |||
444 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
444 | def __init__(self, ipython_dir=None, profile_dir=None, | |
445 | user_module=None, user_ns=None, |
|
445 | user_module=None, user_ns=None, | |
446 | custom_exceptions=((), None), **kwargs): |
|
446 | custom_exceptions=((), None), **kwargs): | |
447 |
|
447 | |||
448 | # This is where traits with a config_key argument are updated |
|
448 | # This is where traits with a config_key argument are updated | |
449 | # from the values on config. |
|
449 | # from the values on config. | |
450 | super(InteractiveShell, self).__init__(**kwargs) |
|
450 | super(InteractiveShell, self).__init__(**kwargs) | |
451 | self.configurables = [self] |
|
451 | self.configurables = [self] | |
452 |
|
452 | |||
453 | # These are relatively independent and stateless |
|
453 | # These are relatively independent and stateless | |
454 | self.init_ipython_dir(ipython_dir) |
|
454 | self.init_ipython_dir(ipython_dir) | |
455 | self.init_profile_dir(profile_dir) |
|
455 | self.init_profile_dir(profile_dir) | |
456 | self.init_instance_attrs() |
|
456 | self.init_instance_attrs() | |
457 | self.init_environment() |
|
457 | self.init_environment() | |
458 |
|
458 | |||
459 | # Check if we're in a virtualenv, and set up sys.path. |
|
459 | # Check if we're in a virtualenv, and set up sys.path. | |
460 | self.init_virtualenv() |
|
460 | self.init_virtualenv() | |
461 |
|
461 | |||
462 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
462 | # Create namespaces (user_ns, user_global_ns, etc.) | |
463 | self.init_create_namespaces(user_module, user_ns) |
|
463 | self.init_create_namespaces(user_module, user_ns) | |
464 | # This has to be done after init_create_namespaces because it uses |
|
464 | # This has to be done after init_create_namespaces because it uses | |
465 | # something in self.user_ns, but before init_sys_modules, which |
|
465 | # something in self.user_ns, but before init_sys_modules, which | |
466 | # is the first thing to modify sys. |
|
466 | # is the first thing to modify sys. | |
467 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
467 | # TODO: When we override sys.stdout and sys.stderr before this class | |
468 | # is created, we are saving the overridden ones here. Not sure if this |
|
468 | # is created, we are saving the overridden ones here. Not sure if this | |
469 | # is what we want to do. |
|
469 | # is what we want to do. | |
470 | self.save_sys_module_state() |
|
470 | self.save_sys_module_state() | |
471 | self.init_sys_modules() |
|
471 | self.init_sys_modules() | |
472 |
|
472 | |||
473 | # While we're trying to have each part of the code directly access what |
|
473 | # While we're trying to have each part of the code directly access what | |
474 | # it needs without keeping redundant references to objects, we have too |
|
474 | # it needs without keeping redundant references to objects, we have too | |
475 | # much legacy code that expects ip.db to exist. |
|
475 | # much legacy code that expects ip.db to exist. | |
476 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
476 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) | |
477 |
|
477 | |||
478 | self.init_history() |
|
478 | self.init_history() | |
479 | self.init_encoding() |
|
479 | self.init_encoding() | |
480 | self.init_prefilter() |
|
480 | self.init_prefilter() | |
481 |
|
481 | |||
482 | self.init_syntax_highlighting() |
|
482 | self.init_syntax_highlighting() | |
483 | self.init_hooks() |
|
483 | self.init_hooks() | |
484 | self.init_events() |
|
484 | self.init_events() | |
485 | self.init_pushd_popd_magic() |
|
485 | self.init_pushd_popd_magic() | |
486 | # self.init_traceback_handlers use to be here, but we moved it below |
|
486 | # self.init_traceback_handlers use to be here, but we moved it below | |
487 | # because it and init_io have to come after init_readline. |
|
487 | # because it and init_io have to come after init_readline. | |
488 | self.init_user_ns() |
|
488 | self.init_user_ns() | |
489 | self.init_logger() |
|
489 | self.init_logger() | |
490 | self.init_builtins() |
|
490 | self.init_builtins() | |
491 |
|
491 | |||
492 | # The following was in post_config_initialization |
|
492 | # The following was in post_config_initialization | |
493 | self.init_inspector() |
|
493 | self.init_inspector() | |
494 | # init_readline() must come before init_io(), because init_io uses |
|
494 | # init_readline() must come before init_io(), because init_io uses | |
495 | # readline related things. |
|
495 | # readline related things. | |
496 | self.init_readline() |
|
496 | self.init_readline() | |
497 | # We save this here in case user code replaces raw_input, but it needs |
|
497 | # We save this here in case user code replaces raw_input, but it needs | |
498 | # to be after init_readline(), because PyPy's readline works by replacing |
|
498 | # to be after init_readline(), because PyPy's readline works by replacing | |
499 | # raw_input. |
|
499 | # raw_input. | |
500 | if py3compat.PY3: |
|
500 | if py3compat.PY3: | |
501 | self.raw_input_original = input |
|
501 | self.raw_input_original = input | |
502 | else: |
|
502 | else: | |
503 | self.raw_input_original = raw_input |
|
503 | self.raw_input_original = raw_input | |
504 | # init_completer must come after init_readline, because it needs to |
|
504 | # init_completer must come after init_readline, because it needs to | |
505 | # know whether readline is present or not system-wide to configure the |
|
505 | # know whether readline is present or not system-wide to configure the | |
506 | # completers, since the completion machinery can now operate |
|
506 | # completers, since the completion machinery can now operate | |
507 | # independently of readline (e.g. over the network) |
|
507 | # independently of readline (e.g. over the network) | |
508 | self.init_completer() |
|
508 | self.init_completer() | |
509 | # TODO: init_io() needs to happen before init_traceback handlers |
|
509 | # TODO: init_io() needs to happen before init_traceback handlers | |
510 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
510 | # because the traceback handlers hardcode the stdout/stderr streams. | |
511 | # This logic in in debugger.Pdb and should eventually be changed. |
|
511 | # This logic in in debugger.Pdb and should eventually be changed. | |
512 | self.init_io() |
|
512 | self.init_io() | |
513 | self.init_traceback_handlers(custom_exceptions) |
|
513 | self.init_traceback_handlers(custom_exceptions) | |
514 | self.init_prompts() |
|
514 | self.init_prompts() | |
515 | self.init_display_formatter() |
|
515 | self.init_display_formatter() | |
516 | self.init_display_pub() |
|
516 | self.init_display_pub() | |
517 | self.init_data_pub() |
|
517 | self.init_data_pub() | |
518 | self.init_displayhook() |
|
518 | self.init_displayhook() | |
519 | self.init_latextool() |
|
519 | self.init_latextool() | |
520 | self.init_magics() |
|
520 | self.init_magics() | |
521 | self.init_alias() |
|
521 | self.init_alias() | |
522 | self.init_logstart() |
|
522 | self.init_logstart() | |
523 | self.init_pdb() |
|
523 | self.init_pdb() | |
524 | self.init_extension_manager() |
|
524 | self.init_extension_manager() | |
525 | self.init_payload() |
|
525 | self.init_payload() | |
526 | self.init_comms() |
|
526 | self.init_comms() | |
527 | self.hooks.late_startup_hook() |
|
527 | self.hooks.late_startup_hook() | |
528 | self.events.trigger('shell_initialized', self) |
|
528 | self.events.trigger('shell_initialized', self) | |
529 | atexit.register(self.atexit_operations) |
|
529 | atexit.register(self.atexit_operations) | |
530 |
|
530 | |||
531 | def get_ipython(self): |
|
531 | def get_ipython(self): | |
532 | """Return the currently running IPython instance.""" |
|
532 | """Return the currently running IPython instance.""" | |
533 | return self |
|
533 | return self | |
534 |
|
534 | |||
535 | #------------------------------------------------------------------------- |
|
535 | #------------------------------------------------------------------------- | |
536 | # Trait changed handlers |
|
536 | # Trait changed handlers | |
537 | #------------------------------------------------------------------------- |
|
537 | #------------------------------------------------------------------------- | |
538 |
|
538 | |||
539 | def _ipython_dir_changed(self, name, new): |
|
539 | def _ipython_dir_changed(self, name, new): | |
540 | ensure_dir_exists(new) |
|
540 | ensure_dir_exists(new) | |
541 |
|
541 | |||
542 | def set_autoindent(self,value=None): |
|
542 | def set_autoindent(self,value=None): | |
543 | """Set the autoindent flag, checking for readline support. |
|
543 | """Set the autoindent flag, checking for readline support. | |
544 |
|
544 | |||
545 | If called with no arguments, it acts as a toggle.""" |
|
545 | If called with no arguments, it acts as a toggle.""" | |
546 |
|
546 | |||
547 | if value != 0 and not self.has_readline: |
|
547 | if value != 0 and not self.has_readline: | |
548 | if os.name == 'posix': |
|
548 | if os.name == 'posix': | |
549 | warn("The auto-indent feature requires the readline library") |
|
549 | warn("The auto-indent feature requires the readline library") | |
550 | self.autoindent = 0 |
|
550 | self.autoindent = 0 | |
551 | return |
|
551 | return | |
552 | if value is None: |
|
552 | if value is None: | |
553 | self.autoindent = not self.autoindent |
|
553 | self.autoindent = not self.autoindent | |
554 | else: |
|
554 | else: | |
555 | self.autoindent = value |
|
555 | self.autoindent = value | |
556 |
|
556 | |||
557 | #------------------------------------------------------------------------- |
|
557 | #------------------------------------------------------------------------- | |
558 | # init_* methods called by __init__ |
|
558 | # init_* methods called by __init__ | |
559 | #------------------------------------------------------------------------- |
|
559 | #------------------------------------------------------------------------- | |
560 |
|
560 | |||
561 | def init_ipython_dir(self, ipython_dir): |
|
561 | def init_ipython_dir(self, ipython_dir): | |
562 | if ipython_dir is not None: |
|
562 | if ipython_dir is not None: | |
563 | self.ipython_dir = ipython_dir |
|
563 | self.ipython_dir = ipython_dir | |
564 | return |
|
564 | return | |
565 |
|
565 | |||
566 | self.ipython_dir = get_ipython_dir() |
|
566 | self.ipython_dir = get_ipython_dir() | |
567 |
|
567 | |||
568 | def init_profile_dir(self, profile_dir): |
|
568 | def init_profile_dir(self, profile_dir): | |
569 | if profile_dir is not None: |
|
569 | if profile_dir is not None: | |
570 | self.profile_dir = profile_dir |
|
570 | self.profile_dir = profile_dir | |
571 | return |
|
571 | return | |
572 | self.profile_dir =\ |
|
572 | self.profile_dir =\ | |
573 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
573 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') | |
574 |
|
574 | |||
575 | def init_instance_attrs(self): |
|
575 | def init_instance_attrs(self): | |
576 | self.more = False |
|
576 | self.more = False | |
577 |
|
577 | |||
578 | # command compiler |
|
578 | # command compiler | |
579 | self.compile = CachingCompiler() |
|
579 | self.compile = CachingCompiler() | |
580 |
|
580 | |||
581 | # Make an empty namespace, which extension writers can rely on both |
|
581 | # Make an empty namespace, which extension writers can rely on both | |
582 | # existing and NEVER being used by ipython itself. This gives them a |
|
582 | # existing and NEVER being used by ipython itself. This gives them a | |
583 | # convenient location for storing additional information and state |
|
583 | # convenient location for storing additional information and state | |
584 | # their extensions may require, without fear of collisions with other |
|
584 | # their extensions may require, without fear of collisions with other | |
585 | # ipython names that may develop later. |
|
585 | # ipython names that may develop later. | |
586 | self.meta = Struct() |
|
586 | self.meta = Struct() | |
587 |
|
587 | |||
588 | # Temporary files used for various purposes. Deleted at exit. |
|
588 | # Temporary files used for various purposes. Deleted at exit. | |
589 | self.tempfiles = [] |
|
589 | self.tempfiles = [] | |
590 | self.tempdirs = [] |
|
590 | self.tempdirs = [] | |
591 |
|
591 | |||
592 | # Keep track of readline usage (later set by init_readline) |
|
592 | # Keep track of readline usage (later set by init_readline) | |
593 | self.has_readline = False |
|
593 | self.has_readline = False | |
594 |
|
594 | |||
595 | # keep track of where we started running (mainly for crash post-mortem) |
|
595 | # keep track of where we started running (mainly for crash post-mortem) | |
596 | # This is not being used anywhere currently. |
|
596 | # This is not being used anywhere currently. | |
597 | self.starting_dir = py3compat.getcwd() |
|
597 | self.starting_dir = py3compat.getcwd() | |
598 |
|
598 | |||
599 | # Indentation management |
|
599 | # Indentation management | |
600 | self.indent_current_nsp = 0 |
|
600 | self.indent_current_nsp = 0 | |
601 |
|
601 | |||
602 | # Dict to track post-execution functions that have been registered |
|
602 | # Dict to track post-execution functions that have been registered | |
603 | self._post_execute = {} |
|
603 | self._post_execute = {} | |
604 |
|
604 | |||
605 | def init_environment(self): |
|
605 | def init_environment(self): | |
606 | """Any changes we need to make to the user's environment.""" |
|
606 | """Any changes we need to make to the user's environment.""" | |
607 | pass |
|
607 | pass | |
608 |
|
608 | |||
609 | def init_encoding(self): |
|
609 | def init_encoding(self): | |
610 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
610 | # Get system encoding at startup time. Certain terminals (like Emacs | |
611 | # under Win32 have it set to None, and we need to have a known valid |
|
611 | # under Win32 have it set to None, and we need to have a known valid | |
612 | # encoding to use in the raw_input() method |
|
612 | # encoding to use in the raw_input() method | |
613 | try: |
|
613 | try: | |
614 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
614 | self.stdin_encoding = sys.stdin.encoding or 'ascii' | |
615 | except AttributeError: |
|
615 | except AttributeError: | |
616 | self.stdin_encoding = 'ascii' |
|
616 | self.stdin_encoding = 'ascii' | |
617 |
|
617 | |||
618 | def init_syntax_highlighting(self): |
|
618 | def init_syntax_highlighting(self): | |
619 | # Python source parser/formatter for syntax highlighting |
|
619 | # Python source parser/formatter for syntax highlighting | |
620 | pyformat = PyColorize.Parser().format |
|
620 | pyformat = PyColorize.Parser().format | |
621 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) |
|
621 | self.pycolorize = lambda src: pyformat(src,'str',self.colors) | |
622 |
|
622 | |||
623 | def init_pushd_popd_magic(self): |
|
623 | def init_pushd_popd_magic(self): | |
624 | # for pushd/popd management |
|
624 | # for pushd/popd management | |
625 | self.home_dir = get_home_dir() |
|
625 | self.home_dir = get_home_dir() | |
626 |
|
626 | |||
627 | self.dir_stack = [] |
|
627 | self.dir_stack = [] | |
628 |
|
628 | |||
629 | def init_logger(self): |
|
629 | def init_logger(self): | |
630 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
630 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', | |
631 | logmode='rotate') |
|
631 | logmode='rotate') | |
632 |
|
632 | |||
633 | def init_logstart(self): |
|
633 | def init_logstart(self): | |
634 | """Initialize logging in case it was requested at the command line. |
|
634 | """Initialize logging in case it was requested at the command line. | |
635 | """ |
|
635 | """ | |
636 | if self.logappend: |
|
636 | if self.logappend: | |
637 | self.magic('logstart %s append' % self.logappend) |
|
637 | self.magic('logstart %s append' % self.logappend) | |
638 | elif self.logfile: |
|
638 | elif self.logfile: | |
639 | self.magic('logstart %s' % self.logfile) |
|
639 | self.magic('logstart %s' % self.logfile) | |
640 | elif self.logstart: |
|
640 | elif self.logstart: | |
641 | self.magic('logstart') |
|
641 | self.magic('logstart') | |
642 |
|
642 | |||
643 | def init_builtins(self): |
|
643 | def init_builtins(self): | |
644 | # A single, static flag that we set to True. Its presence indicates |
|
644 | # A single, static flag that we set to True. Its presence indicates | |
645 | # that an IPython shell has been created, and we make no attempts at |
|
645 | # that an IPython shell has been created, and we make no attempts at | |
646 | # removing on exit or representing the existence of more than one |
|
646 | # removing on exit or representing the existence of more than one | |
647 | # IPython at a time. |
|
647 | # IPython at a time. | |
648 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
648 | builtin_mod.__dict__['__IPYTHON__'] = True | |
649 |
|
649 | |||
650 | # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to |
|
650 | # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to | |
651 | # manage on enter/exit, but with all our shells it's virtually |
|
651 | # manage on enter/exit, but with all our shells it's virtually | |
652 | # impossible to get all the cases right. We're leaving the name in for |
|
652 | # impossible to get all the cases right. We're leaving the name in for | |
653 | # those who adapted their codes to check for this flag, but will |
|
653 | # those who adapted their codes to check for this flag, but will | |
654 | # eventually remove it after a few more releases. |
|
654 | # eventually remove it after a few more releases. | |
655 | builtin_mod.__dict__['__IPYTHON__active'] = \ |
|
655 | builtin_mod.__dict__['__IPYTHON__active'] = \ | |
656 | 'Deprecated, check for __IPYTHON__' |
|
656 | 'Deprecated, check for __IPYTHON__' | |
657 |
|
657 | |||
658 | self.builtin_trap = BuiltinTrap(shell=self) |
|
658 | self.builtin_trap = BuiltinTrap(shell=self) | |
659 |
|
659 | |||
660 | def init_inspector(self): |
|
660 | def init_inspector(self): | |
661 | # Object inspector |
|
661 | # Object inspector | |
662 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
662 | self.inspector = oinspect.Inspector(oinspect.InspectColors, | |
663 | PyColorize.ANSICodeColors, |
|
663 | PyColorize.ANSICodeColors, | |
664 | 'NoColor', |
|
664 | 'NoColor', | |
665 | self.object_info_string_level) |
|
665 | self.object_info_string_level) | |
666 |
|
666 | |||
667 | def init_io(self): |
|
667 | def init_io(self): | |
668 | # This will just use sys.stdout and sys.stderr. If you want to |
|
668 | # This will just use sys.stdout and sys.stderr. If you want to | |
669 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
669 | # override sys.stdout and sys.stderr themselves, you need to do that | |
670 | # *before* instantiating this class, because io holds onto |
|
670 | # *before* instantiating this class, because io holds onto | |
671 | # references to the underlying streams. |
|
671 | # references to the underlying streams. | |
672 | if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline: |
|
672 | if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline: | |
673 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) |
|
673 | io.stdout = io.stderr = io.IOStream(self.readline._outputfile) | |
674 | else: |
|
674 | else: | |
675 | io.stdout = io.IOStream(sys.stdout) |
|
675 | io.stdout = io.IOStream(sys.stdout) | |
676 | io.stderr = io.IOStream(sys.stderr) |
|
676 | io.stderr = io.IOStream(sys.stderr) | |
677 |
|
677 | |||
678 | def init_prompts(self): |
|
678 | def init_prompts(self): | |
679 | self.prompt_manager = PromptManager(shell=self, parent=self) |
|
679 | self.prompt_manager = PromptManager(shell=self, parent=self) | |
680 | self.configurables.append(self.prompt_manager) |
|
680 | self.configurables.append(self.prompt_manager) | |
681 | # Set system prompts, so that scripts can decide if they are running |
|
681 | # Set system prompts, so that scripts can decide if they are running | |
682 | # interactively. |
|
682 | # interactively. | |
683 | sys.ps1 = 'In : ' |
|
683 | sys.ps1 = 'In : ' | |
684 | sys.ps2 = '...: ' |
|
684 | sys.ps2 = '...: ' | |
685 | sys.ps3 = 'Out: ' |
|
685 | sys.ps3 = 'Out: ' | |
686 |
|
686 | |||
687 | def init_display_formatter(self): |
|
687 | def init_display_formatter(self): | |
688 | self.display_formatter = DisplayFormatter(parent=self) |
|
688 | self.display_formatter = DisplayFormatter(parent=self) | |
689 | self.configurables.append(self.display_formatter) |
|
689 | self.configurables.append(self.display_formatter) | |
690 |
|
690 | |||
691 | def init_display_pub(self): |
|
691 | def init_display_pub(self): | |
692 | self.display_pub = self.display_pub_class(parent=self) |
|
692 | self.display_pub = self.display_pub_class(parent=self) | |
693 | self.configurables.append(self.display_pub) |
|
693 | self.configurables.append(self.display_pub) | |
694 |
|
694 | |||
695 | def init_data_pub(self): |
|
695 | def init_data_pub(self): | |
696 | if not self.data_pub_class: |
|
696 | if not self.data_pub_class: | |
697 | self.data_pub = None |
|
697 | self.data_pub = None | |
698 | return |
|
698 | return | |
699 | self.data_pub = self.data_pub_class(parent=self) |
|
699 | self.data_pub = self.data_pub_class(parent=self) | |
700 | self.configurables.append(self.data_pub) |
|
700 | self.configurables.append(self.data_pub) | |
701 |
|
701 | |||
702 | def init_displayhook(self): |
|
702 | def init_displayhook(self): | |
703 | # Initialize displayhook, set in/out prompts and printing system |
|
703 | # Initialize displayhook, set in/out prompts and printing system | |
704 | self.displayhook = self.displayhook_class( |
|
704 | self.displayhook = self.displayhook_class( | |
705 | parent=self, |
|
705 | parent=self, | |
706 | shell=self, |
|
706 | shell=self, | |
707 | cache_size=self.cache_size, |
|
707 | cache_size=self.cache_size, | |
708 | ) |
|
708 | ) | |
709 | self.configurables.append(self.displayhook) |
|
709 | self.configurables.append(self.displayhook) | |
710 | # This is a context manager that installs/revmoes the displayhook at |
|
710 | # This is a context manager that installs/revmoes the displayhook at | |
711 | # the appropriate time. |
|
711 | # the appropriate time. | |
712 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
712 | self.display_trap = DisplayTrap(hook=self.displayhook) | |
713 |
|
713 | |||
714 | def init_latextool(self): |
|
714 | def init_latextool(self): | |
715 | """Configure LaTeXTool.""" |
|
715 | """Configure LaTeXTool.""" | |
716 | cfg = LaTeXTool.instance(parent=self) |
|
716 | cfg = LaTeXTool.instance(parent=self) | |
717 | if cfg not in self.configurables: |
|
717 | if cfg not in self.configurables: | |
718 | self.configurables.append(cfg) |
|
718 | self.configurables.append(cfg) | |
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 | # venv detection: |
|
735 | # venv detection: | |
736 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
736 | # stdlib venv may symlink sys.executable, so we can't use realpath. | |
737 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
737 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. | |
738 | # So we just check every item in the symlink tree (generally <= 3) |
|
738 | # So we just check every item in the symlink tree (generally <= 3) | |
739 | p = os.path.normcase(sys.executable) |
|
739 | p = os.path.normcase(sys.executable) | |
740 | paths = [p] |
|
740 | paths = [p] | |
741 | while os.path.islink(p): |
|
741 | while os.path.islink(p): | |
742 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) |
|
742 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) | |
743 | paths.append(p) |
|
743 | paths.append(p) | |
744 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) |
|
744 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) | |
745 | if any(p.startswith(p_venv) for p in paths): |
|
745 | if any(p.startswith(p_venv) for p in paths): | |
746 | # Running properly in the virtualenv, don't need to do anything |
|
746 | # Running properly in the virtualenv, don't need to do anything | |
747 | return |
|
747 | return | |
748 |
|
748 | |||
749 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
749 | warn("Attempting to work in a virtualenv. If you encounter problems, please " | |
750 | "install IPython inside the virtualenv.") |
|
750 | "install IPython inside the virtualenv.") | |
751 | if sys.platform == "win32": |
|
751 | if sys.platform == "win32": | |
752 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
752 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') | |
753 | else: |
|
753 | else: | |
754 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
754 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', | |
755 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
755 | 'python%d.%d' % sys.version_info[:2], 'site-packages') | |
756 |
|
756 | |||
757 | import site |
|
757 | import site | |
758 | sys.path.insert(0, virtual_env) |
|
758 | sys.path.insert(0, virtual_env) | |
759 | site.addsitedir(virtual_env) |
|
759 | site.addsitedir(virtual_env) | |
760 |
|
760 | |||
761 | #------------------------------------------------------------------------- |
|
761 | #------------------------------------------------------------------------- | |
762 | # Things related to injections into the sys module |
|
762 | # Things related to injections into the sys module | |
763 | #------------------------------------------------------------------------- |
|
763 | #------------------------------------------------------------------------- | |
764 |
|
764 | |||
765 | def save_sys_module_state(self): |
|
765 | def save_sys_module_state(self): | |
766 | """Save the state of hooks in the sys module. |
|
766 | """Save the state of hooks in the sys module. | |
767 |
|
767 | |||
768 | This has to be called after self.user_module is created. |
|
768 | This has to be called after self.user_module is created. | |
769 | """ |
|
769 | """ | |
770 | self._orig_sys_module_state = {} |
|
770 | self._orig_sys_module_state = {} | |
771 | self._orig_sys_module_state['stdin'] = sys.stdin |
|
771 | self._orig_sys_module_state['stdin'] = sys.stdin | |
772 | self._orig_sys_module_state['stdout'] = sys.stdout |
|
772 | self._orig_sys_module_state['stdout'] = sys.stdout | |
773 | self._orig_sys_module_state['stderr'] = sys.stderr |
|
773 | self._orig_sys_module_state['stderr'] = sys.stderr | |
774 | self._orig_sys_module_state['excepthook'] = sys.excepthook |
|
774 | self._orig_sys_module_state['excepthook'] = sys.excepthook | |
775 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
775 | self._orig_sys_modules_main_name = self.user_module.__name__ | |
776 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
776 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) | |
777 |
|
777 | |||
778 | def restore_sys_module_state(self): |
|
778 | def restore_sys_module_state(self): | |
779 | """Restore the state of the sys module.""" |
|
779 | """Restore the state of the sys module.""" | |
780 | try: |
|
780 | try: | |
781 | for k, v in iteritems(self._orig_sys_module_state): |
|
781 | for k, v in iteritems(self._orig_sys_module_state): | |
782 | setattr(sys, k, v) |
|
782 | setattr(sys, k, v) | |
783 | except AttributeError: |
|
783 | except AttributeError: | |
784 | pass |
|
784 | pass | |
785 | # Reset what what done in self.init_sys_modules |
|
785 | # Reset what what done in self.init_sys_modules | |
786 | if self._orig_sys_modules_main_mod is not None: |
|
786 | if self._orig_sys_modules_main_mod is not None: | |
787 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
787 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod | |
788 |
|
788 | |||
789 | #------------------------------------------------------------------------- |
|
789 | #------------------------------------------------------------------------- | |
790 | # Things related to the banner |
|
790 | # Things related to the banner | |
791 | #------------------------------------------------------------------------- |
|
791 | #------------------------------------------------------------------------- | |
792 |
|
792 | |||
793 | @property |
|
793 | @property | |
794 | def banner(self): |
|
794 | def banner(self): | |
795 | banner = self.banner1 |
|
795 | banner = self.banner1 | |
796 | if self.profile and self.profile != 'default': |
|
796 | if self.profile and self.profile != 'default': | |
797 | banner += '\nIPython profile: %s\n' % self.profile |
|
797 | banner += '\nIPython profile: %s\n' % self.profile | |
798 | if self.banner2: |
|
798 | if self.banner2: | |
799 | banner += '\n' + self.banner2 |
|
799 | banner += '\n' + self.banner2 | |
800 | return banner |
|
800 | return banner | |
801 |
|
801 | |||
802 | def show_banner(self, banner=None): |
|
802 | def show_banner(self, banner=None): | |
803 | if banner is None: |
|
803 | if banner is None: | |
804 | banner = self.banner |
|
804 | banner = self.banner | |
805 | self.write(banner) |
|
805 | self.write(banner) | |
806 |
|
806 | |||
807 | #------------------------------------------------------------------------- |
|
807 | #------------------------------------------------------------------------- | |
808 | # Things related to hooks |
|
808 | # Things related to hooks | |
809 | #------------------------------------------------------------------------- |
|
809 | #------------------------------------------------------------------------- | |
810 |
|
810 | |||
811 | def init_hooks(self): |
|
811 | def init_hooks(self): | |
812 | # hooks holds pointers used for user-side customizations |
|
812 | # hooks holds pointers used for user-side customizations | |
813 | self.hooks = Struct() |
|
813 | self.hooks = Struct() | |
814 |
|
814 | |||
815 | self.strdispatchers = {} |
|
815 | self.strdispatchers = {} | |
816 |
|
816 | |||
817 | # Set all default hooks, defined in the IPython.hooks module. |
|
817 | # Set all default hooks, defined in the IPython.hooks module. | |
818 | hooks = IPython.core.hooks |
|
818 | hooks = IPython.core.hooks | |
819 | for hook_name in hooks.__all__: |
|
819 | for hook_name in hooks.__all__: | |
820 | # default hooks have priority 100, i.e. low; user hooks should have |
|
820 | # default hooks have priority 100, i.e. low; user hooks should have | |
821 | # 0-100 priority |
|
821 | # 0-100 priority | |
822 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
822 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) | |
823 |
|
823 | |||
824 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
824 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, | |
825 | _warn_deprecated=True): |
|
825 | _warn_deprecated=True): | |
826 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
826 | """set_hook(name,hook) -> sets an internal IPython hook. | |
827 |
|
827 | |||
828 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
828 | IPython exposes some of its internal API as user-modifiable hooks. By | |
829 | adding your function to one of these hooks, you can modify IPython's |
|
829 | adding your function to one of these hooks, you can modify IPython's | |
830 | behavior to call at runtime your own routines.""" |
|
830 | behavior to call at runtime your own routines.""" | |
831 |
|
831 | |||
832 | # At some point in the future, this should validate the hook before it |
|
832 | # At some point in the future, this should validate the hook before it | |
833 | # accepts it. Probably at least check that the hook takes the number |
|
833 | # accepts it. Probably at least check that the hook takes the number | |
834 | # of args it's supposed to. |
|
834 | # of args it's supposed to. | |
835 |
|
835 | |||
836 | f = types.MethodType(hook,self) |
|
836 | f = types.MethodType(hook,self) | |
837 |
|
837 | |||
838 | # check if the hook is for strdispatcher first |
|
838 | # check if the hook is for strdispatcher first | |
839 | if str_key is not None: |
|
839 | if str_key is not None: | |
840 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
840 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
841 | sdp.add_s(str_key, f, priority ) |
|
841 | sdp.add_s(str_key, f, priority ) | |
842 | self.strdispatchers[name] = sdp |
|
842 | self.strdispatchers[name] = sdp | |
843 | return |
|
843 | return | |
844 | if re_key is not None: |
|
844 | if re_key is not None: | |
845 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
845 | sdp = self.strdispatchers.get(name, StrDispatch()) | |
846 | sdp.add_re(re.compile(re_key), f, priority ) |
|
846 | sdp.add_re(re.compile(re_key), f, priority ) | |
847 | self.strdispatchers[name] = sdp |
|
847 | self.strdispatchers[name] = sdp | |
848 | return |
|
848 | return | |
849 |
|
849 | |||
850 | dp = getattr(self.hooks, name, None) |
|
850 | dp = getattr(self.hooks, name, None) | |
851 | if name not in IPython.core.hooks.__all__: |
|
851 | if name not in IPython.core.hooks.__all__: | |
852 | print("Warning! Hook '%s' is not one of %s" % \ |
|
852 | print("Warning! Hook '%s' is not one of %s" % \ | |
853 | (name, IPython.core.hooks.__all__ )) |
|
853 | (name, IPython.core.hooks.__all__ )) | |
854 |
|
854 | |||
855 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
855 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): | |
856 | alternative = IPython.core.hooks.deprecated[name] |
|
856 | alternative = IPython.core.hooks.deprecated[name] | |
857 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative)) |
|
857 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative)) | |
858 |
|
858 | |||
859 | if not dp: |
|
859 | if not dp: | |
860 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
860 | dp = IPython.core.hooks.CommandChainDispatcher() | |
861 |
|
861 | |||
862 | try: |
|
862 | try: | |
863 | dp.add(f,priority) |
|
863 | dp.add(f,priority) | |
864 | except AttributeError: |
|
864 | except AttributeError: | |
865 | # it was not commandchain, plain old func - replace |
|
865 | # it was not commandchain, plain old func - replace | |
866 | dp = f |
|
866 | dp = f | |
867 |
|
867 | |||
868 | setattr(self.hooks,name, dp) |
|
868 | setattr(self.hooks,name, dp) | |
869 |
|
869 | |||
870 | #------------------------------------------------------------------------- |
|
870 | #------------------------------------------------------------------------- | |
871 | # Things related to events |
|
871 | # Things related to events | |
872 | #------------------------------------------------------------------------- |
|
872 | #------------------------------------------------------------------------- | |
873 |
|
873 | |||
874 | def init_events(self): |
|
874 | def init_events(self): | |
875 | self.events = EventManager(self, available_events) |
|
875 | self.events = EventManager(self, available_events) | |
876 |
|
876 | |||
877 | def register_post_execute(self, func): |
|
877 | def register_post_execute(self, func): | |
878 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
878 | """DEPRECATED: Use ip.events.register('post_run_cell', func) | |
879 |
|
879 | |||
880 | Register a function for calling after code execution. |
|
880 | Register a function for calling after code execution. | |
881 | """ |
|
881 | """ | |
882 | warn("ip.register_post_execute is deprecated, use " |
|
882 | warn("ip.register_post_execute is deprecated, use " | |
883 | "ip.events.register('post_run_cell', func) instead.") |
|
883 | "ip.events.register('post_run_cell', func) instead.") | |
884 | self.events.register('post_run_cell', func) |
|
884 | self.events.register('post_run_cell', func) | |
885 |
|
885 | |||
886 | #------------------------------------------------------------------------- |
|
886 | #------------------------------------------------------------------------- | |
887 | # Things related to the "main" module |
|
887 | # Things related to the "main" module | |
888 | #------------------------------------------------------------------------- |
|
888 | #------------------------------------------------------------------------- | |
889 |
|
889 | |||
890 | def new_main_mod(self, filename, modname): |
|
890 | def new_main_mod(self, filename, modname): | |
891 | """Return a new 'main' module object for user code execution. |
|
891 | """Return a new 'main' module object for user code execution. | |
892 |
|
892 | |||
893 | ``filename`` should be the path of the script which will be run in the |
|
893 | ``filename`` should be the path of the script which will be run in the | |
894 | module. Requests with the same filename will get the same module, with |
|
894 | module. Requests with the same filename will get the same module, with | |
895 | its namespace cleared. |
|
895 | its namespace cleared. | |
896 |
|
896 | |||
897 | ``modname`` should be the module name - normally either '__main__' or |
|
897 | ``modname`` should be the module name - normally either '__main__' or | |
898 | the basename of the file without the extension. |
|
898 | the basename of the file without the extension. | |
899 |
|
899 | |||
900 | When scripts are executed via %run, we must keep a reference to their |
|
900 | When scripts are executed via %run, we must keep a reference to their | |
901 | __main__ module around so that Python doesn't |
|
901 | __main__ module around so that Python doesn't | |
902 | clear it, rendering references to module globals useless. |
|
902 | clear it, rendering references to module globals useless. | |
903 |
|
903 | |||
904 | This method keeps said reference in a private dict, keyed by the |
|
904 | This method keeps said reference in a private dict, keyed by the | |
905 | absolute path of the script. This way, for multiple executions of the |
|
905 | absolute path of the script. This way, for multiple executions of the | |
906 | same script we only keep one copy of the namespace (the last one), |
|
906 | same script we only keep one copy of the namespace (the last one), | |
907 | thus preventing memory leaks from old references while allowing the |
|
907 | thus preventing memory leaks from old references while allowing the | |
908 | objects from the last execution to be accessible. |
|
908 | objects from the last execution to be accessible. | |
909 | """ |
|
909 | """ | |
910 | filename = os.path.abspath(filename) |
|
910 | filename = os.path.abspath(filename) | |
911 | try: |
|
911 | try: | |
912 | main_mod = self._main_mod_cache[filename] |
|
912 | main_mod = self._main_mod_cache[filename] | |
913 | except KeyError: |
|
913 | except KeyError: | |
914 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
914 | main_mod = self._main_mod_cache[filename] = types.ModuleType( | |
915 | py3compat.cast_bytes_py2(modname), |
|
915 | py3compat.cast_bytes_py2(modname), | |
916 | doc="Module created for script run in IPython") |
|
916 | doc="Module created for script run in IPython") | |
917 | else: |
|
917 | else: | |
918 | main_mod.__dict__.clear() |
|
918 | main_mod.__dict__.clear() | |
919 | main_mod.__name__ = modname |
|
919 | main_mod.__name__ = modname | |
920 |
|
920 | |||
921 | main_mod.__file__ = filename |
|
921 | main_mod.__file__ = filename | |
922 | # It seems pydoc (and perhaps others) needs any module instance to |
|
922 | # It seems pydoc (and perhaps others) needs any module instance to | |
923 | # implement a __nonzero__ method |
|
923 | # implement a __nonzero__ method | |
924 | main_mod.__nonzero__ = lambda : True |
|
924 | main_mod.__nonzero__ = lambda : True | |
925 |
|
925 | |||
926 | return main_mod |
|
926 | return main_mod | |
927 |
|
927 | |||
928 | def clear_main_mod_cache(self): |
|
928 | def clear_main_mod_cache(self): | |
929 | """Clear the cache of main modules. |
|
929 | """Clear the cache of main modules. | |
930 |
|
930 | |||
931 | Mainly for use by utilities like %reset. |
|
931 | Mainly for use by utilities like %reset. | |
932 |
|
932 | |||
933 | Examples |
|
933 | Examples | |
934 | -------- |
|
934 | -------- | |
935 |
|
935 | |||
936 | In [15]: import IPython |
|
936 | In [15]: import IPython | |
937 |
|
937 | |||
938 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
938 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') | |
939 |
|
939 | |||
940 | In [17]: len(_ip._main_mod_cache) > 0 |
|
940 | In [17]: len(_ip._main_mod_cache) > 0 | |
941 | Out[17]: True |
|
941 | Out[17]: True | |
942 |
|
942 | |||
943 | In [18]: _ip.clear_main_mod_cache() |
|
943 | In [18]: _ip.clear_main_mod_cache() | |
944 |
|
944 | |||
945 | In [19]: len(_ip._main_mod_cache) == 0 |
|
945 | In [19]: len(_ip._main_mod_cache) == 0 | |
946 | Out[19]: True |
|
946 | Out[19]: True | |
947 | """ |
|
947 | """ | |
948 | self._main_mod_cache.clear() |
|
948 | self._main_mod_cache.clear() | |
949 |
|
949 | |||
950 | #------------------------------------------------------------------------- |
|
950 | #------------------------------------------------------------------------- | |
951 | # Things related to debugging |
|
951 | # Things related to debugging | |
952 | #------------------------------------------------------------------------- |
|
952 | #------------------------------------------------------------------------- | |
953 |
|
953 | |||
954 | def init_pdb(self): |
|
954 | def init_pdb(self): | |
955 | # Set calling of pdb on exceptions |
|
955 | # Set calling of pdb on exceptions | |
956 | # self.call_pdb is a property |
|
956 | # self.call_pdb is a property | |
957 | self.call_pdb = self.pdb |
|
957 | self.call_pdb = self.pdb | |
958 |
|
958 | |||
959 | def _get_call_pdb(self): |
|
959 | def _get_call_pdb(self): | |
960 | return self._call_pdb |
|
960 | return self._call_pdb | |
961 |
|
961 | |||
962 | def _set_call_pdb(self,val): |
|
962 | def _set_call_pdb(self,val): | |
963 |
|
963 | |||
964 | if val not in (0,1,False,True): |
|
964 | if val not in (0,1,False,True): | |
965 | raise ValueError('new call_pdb value must be boolean') |
|
965 | raise ValueError('new call_pdb value must be boolean') | |
966 |
|
966 | |||
967 | # store value in instance |
|
967 | # store value in instance | |
968 | self._call_pdb = val |
|
968 | self._call_pdb = val | |
969 |
|
969 | |||
970 | # notify the actual exception handlers |
|
970 | # notify the actual exception handlers | |
971 | self.InteractiveTB.call_pdb = val |
|
971 | self.InteractiveTB.call_pdb = val | |
972 |
|
972 | |||
973 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
973 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, | |
974 | 'Control auto-activation of pdb at exceptions') |
|
974 | 'Control auto-activation of pdb at exceptions') | |
975 |
|
975 | |||
976 | def debugger(self,force=False): |
|
976 | def debugger(self,force=False): | |
977 | """Call the pydb/pdb debugger. |
|
977 | """Call the pydb/pdb debugger. | |
978 |
|
978 | |||
979 | Keywords: |
|
979 | Keywords: | |
980 |
|
980 | |||
981 | - force(False): by default, this routine checks the instance call_pdb |
|
981 | - force(False): by default, this routine checks the instance call_pdb | |
982 | flag and does not actually invoke the debugger if the flag is false. |
|
982 | flag and does not actually invoke the debugger if the flag is false. | |
983 | The 'force' option forces the debugger to activate even if the flag |
|
983 | The 'force' option forces the debugger to activate even if the flag | |
984 | is false. |
|
984 | is false. | |
985 | """ |
|
985 | """ | |
986 |
|
986 | |||
987 | if not (force or self.call_pdb): |
|
987 | if not (force or self.call_pdb): | |
988 | return |
|
988 | return | |
989 |
|
989 | |||
990 | if not hasattr(sys,'last_traceback'): |
|
990 | if not hasattr(sys,'last_traceback'): | |
991 | error('No traceback has been produced, nothing to debug.') |
|
991 | error('No traceback has been produced, nothing to debug.') | |
992 | return |
|
992 | return | |
993 |
|
993 | |||
994 | # use pydb if available |
|
994 | # use pydb if available | |
995 | if debugger.has_pydb: |
|
995 | if debugger.has_pydb: | |
996 | from pydb import pm |
|
996 | from pydb import pm | |
997 | else: |
|
997 | else: | |
998 | # fallback to our internal debugger |
|
998 | # fallback to our internal debugger | |
999 | pm = lambda : self.InteractiveTB.debugger(force=True) |
|
999 | pm = lambda : self.InteractiveTB.debugger(force=True) | |
1000 |
|
1000 | |||
1001 | with self.readline_no_record: |
|
1001 | with self.readline_no_record: | |
1002 | pm() |
|
1002 | pm() | |
1003 |
|
1003 | |||
1004 | #------------------------------------------------------------------------- |
|
1004 | #------------------------------------------------------------------------- | |
1005 | # Things related to IPython's various namespaces |
|
1005 | # Things related to IPython's various namespaces | |
1006 | #------------------------------------------------------------------------- |
|
1006 | #------------------------------------------------------------------------- | |
1007 | default_user_namespaces = True |
|
1007 | default_user_namespaces = True | |
1008 |
|
1008 | |||
1009 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1009 | def init_create_namespaces(self, user_module=None, user_ns=None): | |
1010 | # Create the namespace where the user will operate. user_ns is |
|
1010 | # Create the namespace where the user will operate. user_ns is | |
1011 | # normally the only one used, and it is passed to the exec calls as |
|
1011 | # normally the only one used, and it is passed to the exec calls as | |
1012 | # the locals argument. But we do carry a user_global_ns namespace |
|
1012 | # the locals argument. But we do carry a user_global_ns namespace | |
1013 | # given as the exec 'globals' argument, This is useful in embedding |
|
1013 | # given as the exec 'globals' argument, This is useful in embedding | |
1014 | # situations where the ipython shell opens in a context where the |
|
1014 | # situations where the ipython shell opens in a context where the | |
1015 | # distinction between locals and globals is meaningful. For |
|
1015 | # distinction between locals and globals is meaningful. For | |
1016 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1016 | # non-embedded contexts, it is just the same object as the user_ns dict. | |
1017 |
|
1017 | |||
1018 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1018 | # FIXME. For some strange reason, __builtins__ is showing up at user | |
1019 | # level as a dict instead of a module. This is a manual fix, but I |
|
1019 | # level as a dict instead of a module. This is a manual fix, but I | |
1020 | # should really track down where the problem is coming from. Alex |
|
1020 | # should really track down where the problem is coming from. Alex | |
1021 | # Schmolck reported this problem first. |
|
1021 | # Schmolck reported this problem first. | |
1022 |
|
1022 | |||
1023 | # A useful post by Alex Martelli on this topic: |
|
1023 | # A useful post by Alex Martelli on this topic: | |
1024 | # Re: inconsistent value from __builtins__ |
|
1024 | # Re: inconsistent value from __builtins__ | |
1025 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1025 | # Von: Alex Martelli <aleaxit@yahoo.com> | |
1026 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1026 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends | |
1027 | # Gruppen: comp.lang.python |
|
1027 | # Gruppen: comp.lang.python | |
1028 |
|
1028 | |||
1029 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1029 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: | |
1030 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1030 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) | |
1031 | # > <type 'dict'> |
|
1031 | # > <type 'dict'> | |
1032 | # > >>> print type(__builtins__) |
|
1032 | # > >>> print type(__builtins__) | |
1033 | # > <type 'module'> |
|
1033 | # > <type 'module'> | |
1034 | # > Is this difference in return value intentional? |
|
1034 | # > Is this difference in return value intentional? | |
1035 |
|
1035 | |||
1036 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1036 | # Well, it's documented that '__builtins__' can be either a dictionary | |
1037 | # or a module, and it's been that way for a long time. Whether it's |
|
1037 | # or a module, and it's been that way for a long time. Whether it's | |
1038 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1038 | # intentional (or sensible), I don't know. In any case, the idea is | |
1039 | # that if you need to access the built-in namespace directly, you |
|
1039 | # that if you need to access the built-in namespace directly, you | |
1040 | # should start with "import __builtin__" (note, no 's') which will |
|
1040 | # should start with "import __builtin__" (note, no 's') which will | |
1041 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1041 | # definitely give you a module. Yeah, it's somewhat confusing:-(. | |
1042 |
|
1042 | |||
1043 | # These routines return a properly built module and dict as needed by |
|
1043 | # These routines return a properly built module and dict as needed by | |
1044 | # the rest of the code, and can also be used by extension writers to |
|
1044 | # the rest of the code, and can also be used by extension writers to | |
1045 | # generate properly initialized namespaces. |
|
1045 | # generate properly initialized namespaces. | |
1046 | if (user_ns is not None) or (user_module is not None): |
|
1046 | if (user_ns is not None) or (user_module is not None): | |
1047 | self.default_user_namespaces = False |
|
1047 | self.default_user_namespaces = False | |
1048 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1048 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) | |
1049 |
|
1049 | |||
1050 | # A record of hidden variables we have added to the user namespace, so |
|
1050 | # A record of hidden variables we have added to the user namespace, so | |
1051 | # we can list later only variables defined in actual interactive use. |
|
1051 | # we can list later only variables defined in actual interactive use. | |
1052 | self.user_ns_hidden = {} |
|
1052 | self.user_ns_hidden = {} | |
1053 |
|
1053 | |||
1054 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1054 | # Now that FakeModule produces a real module, we've run into a nasty | |
1055 | # problem: after script execution (via %run), the module where the user |
|
1055 | # problem: after script execution (via %run), the module where the user | |
1056 | # code ran is deleted. Now that this object is a true module (needed |
|
1056 | # code ran is deleted. Now that this object is a true module (needed | |
1057 |
# so doc |
|
1057 | # so doctest and other tools work correctly), the Python module | |
1058 | # teardown mechanism runs over it, and sets to None every variable |
|
1058 | # teardown mechanism runs over it, and sets to None every variable | |
1059 | # present in that module. Top-level references to objects from the |
|
1059 | # present in that module. Top-level references to objects from the | |
1060 | # script survive, because the user_ns is updated with them. However, |
|
1060 | # script survive, because the user_ns is updated with them. However, | |
1061 | # calling functions defined in the script that use other things from |
|
1061 | # calling functions defined in the script that use other things from | |
1062 | # the script will fail, because the function's closure had references |
|
1062 | # the script will fail, because the function's closure had references | |
1063 | # to the original objects, which are now all None. So we must protect |
|
1063 | # to the original objects, which are now all None. So we must protect | |
1064 | # these modules from deletion by keeping a cache. |
|
1064 | # these modules from deletion by keeping a cache. | |
1065 | # |
|
1065 | # | |
1066 | # To avoid keeping stale modules around (we only need the one from the |
|
1066 | # To avoid keeping stale modules around (we only need the one from the | |
1067 | # last run), we use a dict keyed with the full path to the script, so |
|
1067 | # last run), we use a dict keyed with the full path to the script, so | |
1068 | # only the last version of the module is held in the cache. Note, |
|
1068 | # only the last version of the module is held in the cache. Note, | |
1069 | # however, that we must cache the module *namespace contents* (their |
|
1069 | # however, that we must cache the module *namespace contents* (their | |
1070 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1070 | # __dict__). Because if we try to cache the actual modules, old ones | |
1071 | # (uncached) could be destroyed while still holding references (such as |
|
1071 | # (uncached) could be destroyed while still holding references (such as | |
1072 | # those held by GUI objects that tend to be long-lived)> |
|
1072 | # those held by GUI objects that tend to be long-lived)> | |
1073 | # |
|
1073 | # | |
1074 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1074 | # The %reset command will flush this cache. See the cache_main_mod() | |
1075 | # and clear_main_mod_cache() methods for details on use. |
|
1075 | # and clear_main_mod_cache() methods for details on use. | |
1076 |
|
1076 | |||
1077 | # This is the cache used for 'main' namespaces |
|
1077 | # This is the cache used for 'main' namespaces | |
1078 | self._main_mod_cache = {} |
|
1078 | self._main_mod_cache = {} | |
1079 |
|
1079 | |||
1080 | # A table holding all the namespaces IPython deals with, so that |
|
1080 | # A table holding all the namespaces IPython deals with, so that | |
1081 | # introspection facilities can search easily. |
|
1081 | # introspection facilities can search easily. | |
1082 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1082 | self.ns_table = {'user_global':self.user_module.__dict__, | |
1083 | 'user_local':self.user_ns, |
|
1083 | 'user_local':self.user_ns, | |
1084 | 'builtin':builtin_mod.__dict__ |
|
1084 | 'builtin':builtin_mod.__dict__ | |
1085 | } |
|
1085 | } | |
1086 |
|
1086 | |||
1087 | @property |
|
1087 | @property | |
1088 | def user_global_ns(self): |
|
1088 | def user_global_ns(self): | |
1089 | return self.user_module.__dict__ |
|
1089 | return self.user_module.__dict__ | |
1090 |
|
1090 | |||
1091 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1091 | def prepare_user_module(self, user_module=None, user_ns=None): | |
1092 | """Prepare the module and namespace in which user code will be run. |
|
1092 | """Prepare the module and namespace in which user code will be run. | |
1093 |
|
1093 | |||
1094 | When IPython is started normally, both parameters are None: a new module |
|
1094 | When IPython is started normally, both parameters are None: a new module | |
1095 | is created automatically, and its __dict__ used as the namespace. |
|
1095 | is created automatically, and its __dict__ used as the namespace. | |
1096 |
|
1096 | |||
1097 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1097 | If only user_module is provided, its __dict__ is used as the namespace. | |
1098 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1098 | If only user_ns is provided, a dummy module is created, and user_ns | |
1099 | becomes the global namespace. If both are provided (as they may be |
|
1099 | becomes the global namespace. If both are provided (as they may be | |
1100 | when embedding), user_ns is the local namespace, and user_module |
|
1100 | when embedding), user_ns is the local namespace, and user_module | |
1101 | provides the global namespace. |
|
1101 | provides the global namespace. | |
1102 |
|
1102 | |||
1103 | Parameters |
|
1103 | Parameters | |
1104 | ---------- |
|
1104 | ---------- | |
1105 | user_module : module, optional |
|
1105 | user_module : module, optional | |
1106 | The current user module in which IPython is being run. If None, |
|
1106 | The current user module in which IPython is being run. If None, | |
1107 | a clean module will be created. |
|
1107 | a clean module will be created. | |
1108 | user_ns : dict, optional |
|
1108 | user_ns : dict, optional | |
1109 | A namespace in which to run interactive commands. |
|
1109 | A namespace in which to run interactive commands. | |
1110 |
|
1110 | |||
1111 | Returns |
|
1111 | Returns | |
1112 | ------- |
|
1112 | ------- | |
1113 | A tuple of user_module and user_ns, each properly initialised. |
|
1113 | A tuple of user_module and user_ns, each properly initialised. | |
1114 | """ |
|
1114 | """ | |
1115 | if user_module is None and user_ns is not None: |
|
1115 | if user_module is None and user_ns is not None: | |
1116 | user_ns.setdefault("__name__", "__main__") |
|
1116 | user_ns.setdefault("__name__", "__main__") | |
1117 | user_module = DummyMod() |
|
1117 | user_module = DummyMod() | |
1118 | user_module.__dict__ = user_ns |
|
1118 | user_module.__dict__ = user_ns | |
1119 |
|
1119 | |||
1120 | if user_module is None: |
|
1120 | if user_module is None: | |
1121 | user_module = types.ModuleType("__main__", |
|
1121 | user_module = types.ModuleType("__main__", | |
1122 | doc="Automatically created module for IPython interactive environment") |
|
1122 | doc="Automatically created module for IPython interactive environment") | |
1123 |
|
1123 | |||
1124 | # We must ensure that __builtin__ (without the final 's') is always |
|
1124 | # We must ensure that __builtin__ (without the final 's') is always | |
1125 | # available and pointing to the __builtin__ *module*. For more details: |
|
1125 | # available and pointing to the __builtin__ *module*. For more details: | |
1126 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1126 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1127 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1127 | user_module.__dict__.setdefault('__builtin__', builtin_mod) | |
1128 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1128 | user_module.__dict__.setdefault('__builtins__', builtin_mod) | |
1129 |
|
1129 | |||
1130 | if user_ns is None: |
|
1130 | if user_ns is None: | |
1131 | user_ns = user_module.__dict__ |
|
1131 | user_ns = user_module.__dict__ | |
1132 |
|
1132 | |||
1133 | return user_module, user_ns |
|
1133 | return user_module, user_ns | |
1134 |
|
1134 | |||
1135 | def init_sys_modules(self): |
|
1135 | def init_sys_modules(self): | |
1136 | # We need to insert into sys.modules something that looks like a |
|
1136 | # We need to insert into sys.modules something that looks like a | |
1137 | # module but which accesses the IPython namespace, for shelve and |
|
1137 | # module but which accesses the IPython namespace, for shelve and | |
1138 | # pickle to work interactively. Normally they rely on getting |
|
1138 | # pickle to work interactively. Normally they rely on getting | |
1139 | # everything out of __main__, but for embedding purposes each IPython |
|
1139 | # everything out of __main__, but for embedding purposes each IPython | |
1140 | # instance has its own private namespace, so we can't go shoving |
|
1140 | # instance has its own private namespace, so we can't go shoving | |
1141 | # everything into __main__. |
|
1141 | # everything into __main__. | |
1142 |
|
1142 | |||
1143 | # note, however, that we should only do this for non-embedded |
|
1143 | # note, however, that we should only do this for non-embedded | |
1144 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1144 | # ipythons, which really mimic the __main__.__dict__ with their own | |
1145 | # namespace. Embedded instances, on the other hand, should not do |
|
1145 | # namespace. Embedded instances, on the other hand, should not do | |
1146 | # this because they need to manage the user local/global namespaces |
|
1146 | # this because they need to manage the user local/global namespaces | |
1147 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1147 | # only, but they live within a 'normal' __main__ (meaning, they | |
1148 | # shouldn't overtake the execution environment of the script they're |
|
1148 | # shouldn't overtake the execution environment of the script they're | |
1149 | # embedded in). |
|
1149 | # embedded in). | |
1150 |
|
1150 | |||
1151 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1151 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. | |
1152 | main_name = self.user_module.__name__ |
|
1152 | main_name = self.user_module.__name__ | |
1153 | sys.modules[main_name] = self.user_module |
|
1153 | sys.modules[main_name] = self.user_module | |
1154 |
|
1154 | |||
1155 | def init_user_ns(self): |
|
1155 | def init_user_ns(self): | |
1156 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1156 | """Initialize all user-visible namespaces to their minimum defaults. | |
1157 |
|
1157 | |||
1158 | Certain history lists are also initialized here, as they effectively |
|
1158 | Certain history lists are also initialized here, as they effectively | |
1159 | act as user namespaces. |
|
1159 | act as user namespaces. | |
1160 |
|
1160 | |||
1161 | Notes |
|
1161 | Notes | |
1162 | ----- |
|
1162 | ----- | |
1163 | All data structures here are only filled in, they are NOT reset by this |
|
1163 | All data structures here are only filled in, they are NOT reset by this | |
1164 | method. If they were not empty before, data will simply be added to |
|
1164 | method. If they were not empty before, data will simply be added to | |
1165 | therm. |
|
1165 | therm. | |
1166 | """ |
|
1166 | """ | |
1167 | # This function works in two parts: first we put a few things in |
|
1167 | # This function works in two parts: first we put a few things in | |
1168 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1168 | # user_ns, and we sync that contents into user_ns_hidden so that these | |
1169 | # initial variables aren't shown by %who. After the sync, we add the |
|
1169 | # initial variables aren't shown by %who. After the sync, we add the | |
1170 | # rest of what we *do* want the user to see with %who even on a new |
|
1170 | # rest of what we *do* want the user to see with %who even on a new | |
1171 |
# session (probably nothing, so they |
|
1171 | # session (probably nothing, so they really only see their own stuff) | |
1172 |
|
1172 | |||
1173 | # The user dict must *always* have a __builtin__ reference to the |
|
1173 | # The user dict must *always* have a __builtin__ reference to the | |
1174 | # Python standard __builtin__ namespace, which must be imported. |
|
1174 | # Python standard __builtin__ namespace, which must be imported. | |
1175 | # This is so that certain operations in prompt evaluation can be |
|
1175 | # This is so that certain operations in prompt evaluation can be | |
1176 | # reliably executed with builtins. Note that we can NOT use |
|
1176 | # reliably executed with builtins. Note that we can NOT use | |
1177 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1177 | # __builtins__ (note the 's'), because that can either be a dict or a | |
1178 | # module, and can even mutate at runtime, depending on the context |
|
1178 | # module, and can even mutate at runtime, depending on the context | |
1179 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1179 | # (Python makes no guarantees on it). In contrast, __builtin__ is | |
1180 | # always a module object, though it must be explicitly imported. |
|
1180 | # always a module object, though it must be explicitly imported. | |
1181 |
|
1181 | |||
1182 | # For more details: |
|
1182 | # For more details: | |
1183 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1183 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html | |
1184 | ns = dict() |
|
1184 | ns = dict() | |
1185 |
|
1185 | |||
1186 | # make global variables for user access to the histories |
|
1186 | # make global variables for user access to the histories | |
1187 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1187 | ns['_ih'] = self.history_manager.input_hist_parsed | |
1188 | ns['_oh'] = self.history_manager.output_hist |
|
1188 | ns['_oh'] = self.history_manager.output_hist | |
1189 | ns['_dh'] = self.history_manager.dir_hist |
|
1189 | ns['_dh'] = self.history_manager.dir_hist | |
1190 |
|
1190 | |||
1191 | ns['_sh'] = shadowns |
|
1191 | ns['_sh'] = shadowns | |
1192 |
|
1192 | |||
1193 | # user aliases to input and output histories. These shouldn't show up |
|
1193 | # user aliases to input and output histories. These shouldn't show up | |
1194 | # in %who, as they can have very large reprs. |
|
1194 | # in %who, as they can have very large reprs. | |
1195 | ns['In'] = self.history_manager.input_hist_parsed |
|
1195 | ns['In'] = self.history_manager.input_hist_parsed | |
1196 | ns['Out'] = self.history_manager.output_hist |
|
1196 | ns['Out'] = self.history_manager.output_hist | |
1197 |
|
1197 | |||
1198 | # Store myself as the public api!!! |
|
1198 | # Store myself as the public api!!! | |
1199 | ns['get_ipython'] = self.get_ipython |
|
1199 | ns['get_ipython'] = self.get_ipython | |
1200 |
|
1200 | |||
1201 | ns['exit'] = self.exiter |
|
1201 | ns['exit'] = self.exiter | |
1202 | ns['quit'] = self.exiter |
|
1202 | ns['quit'] = self.exiter | |
1203 |
|
1203 | |||
1204 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1204 | # Sync what we've added so far to user_ns_hidden so these aren't seen | |
1205 | # by %who |
|
1205 | # by %who | |
1206 | self.user_ns_hidden.update(ns) |
|
1206 | self.user_ns_hidden.update(ns) | |
1207 |
|
1207 | |||
1208 | # Anything put into ns now would show up in %who. Think twice before |
|
1208 | # Anything put into ns now would show up in %who. Think twice before | |
1209 | # putting anything here, as we really want %who to show the user their |
|
1209 | # putting anything here, as we really want %who to show the user their | |
1210 | # stuff, not our variables. |
|
1210 | # stuff, not our variables. | |
1211 |
|
1211 | |||
1212 | # Finally, update the real user's namespace |
|
1212 | # Finally, update the real user's namespace | |
1213 | self.user_ns.update(ns) |
|
1213 | self.user_ns.update(ns) | |
1214 |
|
1214 | |||
1215 | @property |
|
1215 | @property | |
1216 | def all_ns_refs(self): |
|
1216 | def all_ns_refs(self): | |
1217 | """Get a list of references to all the namespace dictionaries in which |
|
1217 | """Get a list of references to all the namespace dictionaries in which | |
1218 | IPython might store a user-created object. |
|
1218 | IPython might store a user-created object. | |
1219 |
|
1219 | |||
1220 | Note that this does not include the displayhook, which also caches |
|
1220 | Note that this does not include the displayhook, which also caches | |
1221 | objects from the output.""" |
|
1221 | objects from the output.""" | |
1222 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1222 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ | |
1223 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1223 | [m.__dict__ for m in self._main_mod_cache.values()] | |
1224 |
|
1224 | |||
1225 | def reset(self, new_session=True): |
|
1225 | def reset(self, new_session=True): | |
1226 | """Clear all internal namespaces, and attempt to release references to |
|
1226 | """Clear all internal namespaces, and attempt to release references to | |
1227 | user objects. |
|
1227 | user objects. | |
1228 |
|
1228 | |||
1229 | If new_session is True, a new history session will be opened. |
|
1229 | If new_session is True, a new history session will be opened. | |
1230 | """ |
|
1230 | """ | |
1231 | # Clear histories |
|
1231 | # Clear histories | |
1232 | self.history_manager.reset(new_session) |
|
1232 | self.history_manager.reset(new_session) | |
1233 | # Reset counter used to index all histories |
|
1233 | # Reset counter used to index all histories | |
1234 | if new_session: |
|
1234 | if new_session: | |
1235 | self.execution_count = 1 |
|
1235 | self.execution_count = 1 | |
1236 |
|
1236 | |||
1237 | # Flush cached output items |
|
1237 | # Flush cached output items | |
1238 | if self.displayhook.do_full_cache: |
|
1238 | if self.displayhook.do_full_cache: | |
1239 | self.displayhook.flush() |
|
1239 | self.displayhook.flush() | |
1240 |
|
1240 | |||
1241 | # The main execution namespaces must be cleared very carefully, |
|
1241 | # The main execution namespaces must be cleared very carefully, | |
1242 | # skipping the deletion of the builtin-related keys, because doing so |
|
1242 | # skipping the deletion of the builtin-related keys, because doing so | |
1243 | # would cause errors in many object's __del__ methods. |
|
1243 | # would cause errors in many object's __del__ methods. | |
1244 | if self.user_ns is not self.user_global_ns: |
|
1244 | if self.user_ns is not self.user_global_ns: | |
1245 | self.user_ns.clear() |
|
1245 | self.user_ns.clear() | |
1246 | ns = self.user_global_ns |
|
1246 | ns = self.user_global_ns | |
1247 | drop_keys = set(ns.keys()) |
|
1247 | drop_keys = set(ns.keys()) | |
1248 | drop_keys.discard('__builtin__') |
|
1248 | drop_keys.discard('__builtin__') | |
1249 | drop_keys.discard('__builtins__') |
|
1249 | drop_keys.discard('__builtins__') | |
1250 | drop_keys.discard('__name__') |
|
1250 | drop_keys.discard('__name__') | |
1251 | for k in drop_keys: |
|
1251 | for k in drop_keys: | |
1252 | del ns[k] |
|
1252 | del ns[k] | |
1253 |
|
1253 | |||
1254 | self.user_ns_hidden.clear() |
|
1254 | self.user_ns_hidden.clear() | |
1255 |
|
1255 | |||
1256 | # Restore the user namespaces to minimal usability |
|
1256 | # Restore the user namespaces to minimal usability | |
1257 | self.init_user_ns() |
|
1257 | self.init_user_ns() | |
1258 |
|
1258 | |||
1259 | # Restore the default and user aliases |
|
1259 | # Restore the default and user aliases | |
1260 | self.alias_manager.clear_aliases() |
|
1260 | self.alias_manager.clear_aliases() | |
1261 | self.alias_manager.init_aliases() |
|
1261 | self.alias_manager.init_aliases() | |
1262 |
|
1262 | |||
1263 | # Flush the private list of module references kept for script |
|
1263 | # Flush the private list of module references kept for script | |
1264 | # execution protection |
|
1264 | # execution protection | |
1265 | self.clear_main_mod_cache() |
|
1265 | self.clear_main_mod_cache() | |
1266 |
|
1266 | |||
1267 | def del_var(self, varname, by_name=False): |
|
1267 | def del_var(self, varname, by_name=False): | |
1268 | """Delete a variable from the various namespaces, so that, as |
|
1268 | """Delete a variable from the various namespaces, so that, as | |
1269 | far as possible, we're not keeping any hidden references to it. |
|
1269 | far as possible, we're not keeping any hidden references to it. | |
1270 |
|
1270 | |||
1271 | Parameters |
|
1271 | Parameters | |
1272 | ---------- |
|
1272 | ---------- | |
1273 | varname : str |
|
1273 | varname : str | |
1274 | The name of the variable to delete. |
|
1274 | The name of the variable to delete. | |
1275 | by_name : bool |
|
1275 | by_name : bool | |
1276 | If True, delete variables with the given name in each |
|
1276 | If True, delete variables with the given name in each | |
1277 | namespace. If False (default), find the variable in the user |
|
1277 | namespace. If False (default), find the variable in the user | |
1278 | namespace, and delete references to it. |
|
1278 | namespace, and delete references to it. | |
1279 | """ |
|
1279 | """ | |
1280 | if varname in ('__builtin__', '__builtins__'): |
|
1280 | if varname in ('__builtin__', '__builtins__'): | |
1281 | raise ValueError("Refusing to delete %s" % varname) |
|
1281 | raise ValueError("Refusing to delete %s" % varname) | |
1282 |
|
1282 | |||
1283 | ns_refs = self.all_ns_refs |
|
1283 | ns_refs = self.all_ns_refs | |
1284 |
|
1284 | |||
1285 | if by_name: # Delete by name |
|
1285 | if by_name: # Delete by name | |
1286 | for ns in ns_refs: |
|
1286 | for ns in ns_refs: | |
1287 | try: |
|
1287 | try: | |
1288 | del ns[varname] |
|
1288 | del ns[varname] | |
1289 | except KeyError: |
|
1289 | except KeyError: | |
1290 | pass |
|
1290 | pass | |
1291 | else: # Delete by object |
|
1291 | else: # Delete by object | |
1292 | try: |
|
1292 | try: | |
1293 | obj = self.user_ns[varname] |
|
1293 | obj = self.user_ns[varname] | |
1294 | except KeyError: |
|
1294 | except KeyError: | |
1295 | raise NameError("name '%s' is not defined" % varname) |
|
1295 | raise NameError("name '%s' is not defined" % varname) | |
1296 | # Also check in output history |
|
1296 | # Also check in output history | |
1297 | ns_refs.append(self.history_manager.output_hist) |
|
1297 | ns_refs.append(self.history_manager.output_hist) | |
1298 | for ns in ns_refs: |
|
1298 | for ns in ns_refs: | |
1299 | to_delete = [n for n, o in iteritems(ns) if o is obj] |
|
1299 | to_delete = [n for n, o in iteritems(ns) if o is obj] | |
1300 | for name in to_delete: |
|
1300 | for name in to_delete: | |
1301 | del ns[name] |
|
1301 | del ns[name] | |
1302 |
|
1302 | |||
1303 | # displayhook keeps extra references, but not in a dictionary |
|
1303 | # displayhook keeps extra references, but not in a dictionary | |
1304 | for name in ('_', '__', '___'): |
|
1304 | for name in ('_', '__', '___'): | |
1305 | if getattr(self.displayhook, name) is obj: |
|
1305 | if getattr(self.displayhook, name) is obj: | |
1306 | setattr(self.displayhook, name, None) |
|
1306 | setattr(self.displayhook, name, None) | |
1307 |
|
1307 | |||
1308 | def reset_selective(self, regex=None): |
|
1308 | def reset_selective(self, regex=None): | |
1309 | """Clear selective variables from internal namespaces based on a |
|
1309 | """Clear selective variables from internal namespaces based on a | |
1310 | specified regular expression. |
|
1310 | specified regular expression. | |
1311 |
|
1311 | |||
1312 | Parameters |
|
1312 | Parameters | |
1313 | ---------- |
|
1313 | ---------- | |
1314 | regex : string or compiled pattern, optional |
|
1314 | regex : string or compiled pattern, optional | |
1315 | A regular expression pattern that will be used in searching |
|
1315 | A regular expression pattern that will be used in searching | |
1316 | variable names in the users namespaces. |
|
1316 | variable names in the users namespaces. | |
1317 | """ |
|
1317 | """ | |
1318 | if regex is not None: |
|
1318 | if regex is not None: | |
1319 | try: |
|
1319 | try: | |
1320 | m = re.compile(regex) |
|
1320 | m = re.compile(regex) | |
1321 | except TypeError: |
|
1321 | except TypeError: | |
1322 | raise TypeError('regex must be a string or compiled pattern') |
|
1322 | raise TypeError('regex must be a string or compiled pattern') | |
1323 | # Search for keys in each namespace that match the given regex |
|
1323 | # Search for keys in each namespace that match the given regex | |
1324 | # If a match is found, delete the key/value pair. |
|
1324 | # If a match is found, delete the key/value pair. | |
1325 | for ns in self.all_ns_refs: |
|
1325 | for ns in self.all_ns_refs: | |
1326 | for var in ns: |
|
1326 | for var in ns: | |
1327 | if m.search(var): |
|
1327 | if m.search(var): | |
1328 | del ns[var] |
|
1328 | del ns[var] | |
1329 |
|
1329 | |||
1330 | def push(self, variables, interactive=True): |
|
1330 | def push(self, variables, interactive=True): | |
1331 | """Inject a group of variables into the IPython user namespace. |
|
1331 | """Inject a group of variables into the IPython user namespace. | |
1332 |
|
1332 | |||
1333 | Parameters |
|
1333 | Parameters | |
1334 | ---------- |
|
1334 | ---------- | |
1335 | variables : dict, str or list/tuple of str |
|
1335 | variables : dict, str or list/tuple of str | |
1336 | The variables to inject into the user's namespace. If a dict, a |
|
1336 | The variables to inject into the user's namespace. If a dict, a | |
1337 | simple update is done. If a str, the string is assumed to have |
|
1337 | simple update is done. If a str, the string is assumed to have | |
1338 | variable names separated by spaces. A list/tuple of str can also |
|
1338 | variable names separated by spaces. A list/tuple of str can also | |
1339 | be used to give the variable names. If just the variable names are |
|
1339 | be used to give the variable names. If just the variable names are | |
1340 | give (list/tuple/str) then the variable values looked up in the |
|
1340 | give (list/tuple/str) then the variable values looked up in the | |
1341 | callers frame. |
|
1341 | callers frame. | |
1342 | interactive : bool |
|
1342 | interactive : bool | |
1343 | If True (default), the variables will be listed with the ``who`` |
|
1343 | If True (default), the variables will be listed with the ``who`` | |
1344 | magic. |
|
1344 | magic. | |
1345 | """ |
|
1345 | """ | |
1346 | vdict = None |
|
1346 | vdict = None | |
1347 |
|
1347 | |||
1348 | # We need a dict of name/value pairs to do namespace updates. |
|
1348 | # We need a dict of name/value pairs to do namespace updates. | |
1349 | if isinstance(variables, dict): |
|
1349 | if isinstance(variables, dict): | |
1350 | vdict = variables |
|
1350 | vdict = variables | |
1351 | elif isinstance(variables, string_types+(list, tuple)): |
|
1351 | elif isinstance(variables, string_types+(list, tuple)): | |
1352 | if isinstance(variables, string_types): |
|
1352 | if isinstance(variables, string_types): | |
1353 | vlist = variables.split() |
|
1353 | vlist = variables.split() | |
1354 | else: |
|
1354 | else: | |
1355 | vlist = variables |
|
1355 | vlist = variables | |
1356 | vdict = {} |
|
1356 | vdict = {} | |
1357 | cf = sys._getframe(1) |
|
1357 | cf = sys._getframe(1) | |
1358 | for name in vlist: |
|
1358 | for name in vlist: | |
1359 | try: |
|
1359 | try: | |
1360 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1360 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) | |
1361 | except: |
|
1361 | except: | |
1362 | print('Could not get variable %s from %s' % |
|
1362 | print('Could not get variable %s from %s' % | |
1363 | (name,cf.f_code.co_name)) |
|
1363 | (name,cf.f_code.co_name)) | |
1364 | else: |
|
1364 | else: | |
1365 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1365 | raise ValueError('variables must be a dict/str/list/tuple') | |
1366 |
|
1366 | |||
1367 | # Propagate variables to user namespace |
|
1367 | # Propagate variables to user namespace | |
1368 | self.user_ns.update(vdict) |
|
1368 | self.user_ns.update(vdict) | |
1369 |
|
1369 | |||
1370 | # And configure interactive visibility |
|
1370 | # And configure interactive visibility | |
1371 | user_ns_hidden = self.user_ns_hidden |
|
1371 | user_ns_hidden = self.user_ns_hidden | |
1372 | if interactive: |
|
1372 | if interactive: | |
1373 | for name in vdict: |
|
1373 | for name in vdict: | |
1374 | user_ns_hidden.pop(name, None) |
|
1374 | user_ns_hidden.pop(name, None) | |
1375 | else: |
|
1375 | else: | |
1376 | user_ns_hidden.update(vdict) |
|
1376 | user_ns_hidden.update(vdict) | |
1377 |
|
1377 | |||
1378 | def drop_by_id(self, variables): |
|
1378 | def drop_by_id(self, variables): | |
1379 | """Remove a dict of variables from the user namespace, if they are the |
|
1379 | """Remove a dict of variables from the user namespace, if they are the | |
1380 | same as the values in the dictionary. |
|
1380 | same as the values in the dictionary. | |
1381 |
|
1381 | |||
1382 | This is intended for use by extensions: variables that they've added can |
|
1382 | This is intended for use by extensions: variables that they've added can | |
1383 | be taken back out if they are unloaded, without removing any that the |
|
1383 | be taken back out if they are unloaded, without removing any that the | |
1384 | user has overwritten. |
|
1384 | user has overwritten. | |
1385 |
|
1385 | |||
1386 | Parameters |
|
1386 | Parameters | |
1387 | ---------- |
|
1387 | ---------- | |
1388 | variables : dict |
|
1388 | variables : dict | |
1389 | A dictionary mapping object names (as strings) to the objects. |
|
1389 | A dictionary mapping object names (as strings) to the objects. | |
1390 | """ |
|
1390 | """ | |
1391 | for name, obj in iteritems(variables): |
|
1391 | for name, obj in iteritems(variables): | |
1392 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1392 | if name in self.user_ns and self.user_ns[name] is obj: | |
1393 | del self.user_ns[name] |
|
1393 | del self.user_ns[name] | |
1394 | self.user_ns_hidden.pop(name, None) |
|
1394 | self.user_ns_hidden.pop(name, None) | |
1395 |
|
1395 | |||
1396 | #------------------------------------------------------------------------- |
|
1396 | #------------------------------------------------------------------------- | |
1397 | # Things related to object introspection |
|
1397 | # Things related to object introspection | |
1398 | #------------------------------------------------------------------------- |
|
1398 | #------------------------------------------------------------------------- | |
1399 |
|
1399 | |||
1400 | def _ofind(self, oname, namespaces=None): |
|
1400 | def _ofind(self, oname, namespaces=None): | |
1401 | """Find an object in the available namespaces. |
|
1401 | """Find an object in the available namespaces. | |
1402 |
|
1402 | |||
1403 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1403 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic | |
1404 |
|
1404 | |||
1405 | Has special code to detect magic functions. |
|
1405 | Has special code to detect magic functions. | |
1406 | """ |
|
1406 | """ | |
1407 | oname = oname.strip() |
|
1407 | oname = oname.strip() | |
1408 | #print '1- oname: <%r>' % oname # dbg |
|
1408 | #print '1- oname: <%r>' % oname # dbg | |
1409 | if not oname.startswith(ESC_MAGIC) and \ |
|
1409 | if not oname.startswith(ESC_MAGIC) and \ | |
1410 | not oname.startswith(ESC_MAGIC2) and \ |
|
1410 | not oname.startswith(ESC_MAGIC2) and \ | |
1411 | not py3compat.isidentifier(oname, dotted=True): |
|
1411 | not py3compat.isidentifier(oname, dotted=True): | |
1412 | return dict(found=False) |
|
1412 | return dict(found=False) | |
1413 |
|
1413 | |||
1414 | alias_ns = None |
|
1414 | alias_ns = None | |
1415 | if namespaces is None: |
|
1415 | if namespaces is None: | |
1416 | # Namespaces to search in: |
|
1416 | # Namespaces to search in: | |
1417 | # Put them in a list. The order is important so that we |
|
1417 | # Put them in a list. The order is important so that we | |
1418 | # find things in the same order that Python finds them. |
|
1418 | # find things in the same order that Python finds them. | |
1419 | namespaces = [ ('Interactive', self.user_ns), |
|
1419 | namespaces = [ ('Interactive', self.user_ns), | |
1420 | ('Interactive (global)', self.user_global_ns), |
|
1420 | ('Interactive (global)', self.user_global_ns), | |
1421 | ('Python builtin', builtin_mod.__dict__), |
|
1421 | ('Python builtin', builtin_mod.__dict__), | |
1422 | ] |
|
1422 | ] | |
1423 |
|
1423 | |||
1424 | # initialize results to 'null' |
|
1424 | # initialize results to 'null' | |
1425 | found = False; obj = None; ospace = None; ds = None; |
|
1425 | found = False; obj = None; ospace = None; ds = None; | |
1426 | ismagic = False; isalias = False; parent = None |
|
1426 | ismagic = False; isalias = False; parent = None | |
1427 |
|
1427 | |||
1428 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1428 | # We need to special-case 'print', which as of python2.6 registers as a | |
1429 | # function but should only be treated as one if print_function was |
|
1429 | # function but should only be treated as one if print_function was | |
1430 | # loaded with a future import. In this case, just bail. |
|
1430 | # loaded with a future import. In this case, just bail. | |
1431 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1431 | if (oname == 'print' and not py3compat.PY3 and not \ | |
1432 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1432 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): | |
1433 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1433 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1434 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1434 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1435 |
|
1435 | |||
1436 | # Look for the given name by splitting it in parts. If the head is |
|
1436 | # Look for the given name by splitting it in parts. If the head is | |
1437 | # found, then we look for all the remaining parts as members, and only |
|
1437 | # found, then we look for all the remaining parts as members, and only | |
1438 | # declare success if we can find them all. |
|
1438 | # declare success if we can find them all. | |
1439 | oname_parts = oname.split('.') |
|
1439 | oname_parts = oname.split('.') | |
1440 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1440 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] | |
1441 | for nsname,ns in namespaces: |
|
1441 | for nsname,ns in namespaces: | |
1442 | try: |
|
1442 | try: | |
1443 | obj = ns[oname_head] |
|
1443 | obj = ns[oname_head] | |
1444 | except KeyError: |
|
1444 | except KeyError: | |
1445 | continue |
|
1445 | continue | |
1446 | else: |
|
1446 | else: | |
1447 | #print 'oname_rest:', oname_rest # dbg |
|
1447 | #print 'oname_rest:', oname_rest # dbg | |
1448 | for idx, part in enumerate(oname_rest): |
|
1448 | for idx, part in enumerate(oname_rest): | |
1449 | try: |
|
1449 | try: | |
1450 | parent = obj |
|
1450 | parent = obj | |
1451 | # The last part is looked up in a special way to avoid |
|
1451 | # The last part is looked up in a special way to avoid | |
1452 | # descriptor invocation as it may raise or have side |
|
1452 | # descriptor invocation as it may raise or have side | |
1453 | # effects. |
|
1453 | # effects. | |
1454 | if idx == len(oname_rest) - 1: |
|
1454 | if idx == len(oname_rest) - 1: | |
1455 | obj = self._getattr_property(obj, part) |
|
1455 | obj = self._getattr_property(obj, part) | |
1456 | else: |
|
1456 | else: | |
1457 | obj = getattr(obj, part) |
|
1457 | obj = getattr(obj, part) | |
1458 | except: |
|
1458 | except: | |
1459 | # Blanket except b/c some badly implemented objects |
|
1459 | # Blanket except b/c some badly implemented objects | |
1460 | # allow __getattr__ to raise exceptions other than |
|
1460 | # allow __getattr__ to raise exceptions other than | |
1461 | # AttributeError, which then crashes IPython. |
|
1461 | # AttributeError, which then crashes IPython. | |
1462 | break |
|
1462 | break | |
1463 | else: |
|
1463 | else: | |
1464 | # If we finish the for loop (no break), we got all members |
|
1464 | # If we finish the for loop (no break), we got all members | |
1465 | found = True |
|
1465 | found = True | |
1466 | ospace = nsname |
|
1466 | ospace = nsname | |
1467 | break # namespace loop |
|
1467 | break # namespace loop | |
1468 |
|
1468 | |||
1469 | # Try to see if it's magic |
|
1469 | # Try to see if it's magic | |
1470 | if not found: |
|
1470 | if not found: | |
1471 | obj = None |
|
1471 | obj = None | |
1472 | if oname.startswith(ESC_MAGIC2): |
|
1472 | if oname.startswith(ESC_MAGIC2): | |
1473 | oname = oname.lstrip(ESC_MAGIC2) |
|
1473 | oname = oname.lstrip(ESC_MAGIC2) | |
1474 | obj = self.find_cell_magic(oname) |
|
1474 | obj = self.find_cell_magic(oname) | |
1475 | elif oname.startswith(ESC_MAGIC): |
|
1475 | elif oname.startswith(ESC_MAGIC): | |
1476 | oname = oname.lstrip(ESC_MAGIC) |
|
1476 | oname = oname.lstrip(ESC_MAGIC) | |
1477 | obj = self.find_line_magic(oname) |
|
1477 | obj = self.find_line_magic(oname) | |
1478 | else: |
|
1478 | else: | |
1479 | # search without prefix, so run? will find %run? |
|
1479 | # search without prefix, so run? will find %run? | |
1480 | obj = self.find_line_magic(oname) |
|
1480 | obj = self.find_line_magic(oname) | |
1481 | if obj is None: |
|
1481 | if obj is None: | |
1482 | obj = self.find_cell_magic(oname) |
|
1482 | obj = self.find_cell_magic(oname) | |
1483 | if obj is not None: |
|
1483 | if obj is not None: | |
1484 | found = True |
|
1484 | found = True | |
1485 | ospace = 'IPython internal' |
|
1485 | ospace = 'IPython internal' | |
1486 | ismagic = True |
|
1486 | ismagic = True | |
1487 |
|
1487 | |||
1488 | # Last try: special-case some literals like '', [], {}, etc: |
|
1488 | # Last try: special-case some literals like '', [], {}, etc: | |
1489 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1489 | if not found and oname_head in ["''",'""','[]','{}','()']: | |
1490 | obj = eval(oname_head) |
|
1490 | obj = eval(oname_head) | |
1491 | found = True |
|
1491 | found = True | |
1492 | ospace = 'Interactive' |
|
1492 | ospace = 'Interactive' | |
1493 |
|
1493 | |||
1494 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1494 | return {'found':found, 'obj':obj, 'namespace':ospace, | |
1495 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1495 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} | |
1496 |
|
1496 | |||
1497 | @staticmethod |
|
1497 | @staticmethod | |
1498 | def _getattr_property(obj, attrname): |
|
1498 | def _getattr_property(obj, attrname): | |
1499 | """Property-aware getattr to use in object finding. |
|
1499 | """Property-aware getattr to use in object finding. | |
1500 |
|
1500 | |||
1501 | If attrname represents a property, return it unevaluated (in case it has |
|
1501 | If attrname represents a property, return it unevaluated (in case it has | |
1502 | side effects or raises an error. |
|
1502 | side effects or raises an error. | |
1503 |
|
1503 | |||
1504 | """ |
|
1504 | """ | |
1505 | if not isinstance(obj, type): |
|
1505 | if not isinstance(obj, type): | |
1506 | try: |
|
1506 | try: | |
1507 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1507 | # `getattr(type(obj), attrname)` is not guaranteed to return | |
1508 | # `obj`, but does so for property: |
|
1508 | # `obj`, but does so for property: | |
1509 | # |
|
1509 | # | |
1510 | # property.__get__(self, None, cls) -> self |
|
1510 | # property.__get__(self, None, cls) -> self | |
1511 | # |
|
1511 | # | |
1512 | # The universal alternative is to traverse the mro manually |
|
1512 | # The universal alternative is to traverse the mro manually | |
1513 | # searching for attrname in class dicts. |
|
1513 | # searching for attrname in class dicts. | |
1514 | attr = getattr(type(obj), attrname) |
|
1514 | attr = getattr(type(obj), attrname) | |
1515 | except AttributeError: |
|
1515 | except AttributeError: | |
1516 | pass |
|
1516 | pass | |
1517 | else: |
|
1517 | else: | |
1518 | # This relies on the fact that data descriptors (with both |
|
1518 | # This relies on the fact that data descriptors (with both | |
1519 | # __get__ & __set__ magic methods) take precedence over |
|
1519 | # __get__ & __set__ magic methods) take precedence over | |
1520 | # instance-level attributes: |
|
1520 | # instance-level attributes: | |
1521 | # |
|
1521 | # | |
1522 | # class A(object): |
|
1522 | # class A(object): | |
1523 | # @property |
|
1523 | # @property | |
1524 | # def foobar(self): return 123 |
|
1524 | # def foobar(self): return 123 | |
1525 | # a = A() |
|
1525 | # a = A() | |
1526 | # a.__dict__['foobar'] = 345 |
|
1526 | # a.__dict__['foobar'] = 345 | |
1527 | # a.foobar # == 123 |
|
1527 | # a.foobar # == 123 | |
1528 | # |
|
1528 | # | |
1529 | # So, a property may be returned right away. |
|
1529 | # So, a property may be returned right away. | |
1530 | if isinstance(attr, property): |
|
1530 | if isinstance(attr, property): | |
1531 | return attr |
|
1531 | return attr | |
1532 |
|
1532 | |||
1533 | # Nothing helped, fall back. |
|
1533 | # Nothing helped, fall back. | |
1534 | return getattr(obj, attrname) |
|
1534 | return getattr(obj, attrname) | |
1535 |
|
1535 | |||
1536 | def _object_find(self, oname, namespaces=None): |
|
1536 | def _object_find(self, oname, namespaces=None): | |
1537 | """Find an object and return a struct with info about it.""" |
|
1537 | """Find an object and return a struct with info about it.""" | |
1538 | return Struct(self._ofind(oname, namespaces)) |
|
1538 | return Struct(self._ofind(oname, namespaces)) | |
1539 |
|
1539 | |||
1540 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1540 | def _inspect(self, meth, oname, namespaces=None, **kw): | |
1541 | """Generic interface to the inspector system. |
|
1541 | """Generic interface to the inspector system. | |
1542 |
|
1542 | |||
1543 | This function is meant to be called by pdef, pdoc & friends.""" |
|
1543 | This function is meant to be called by pdef, pdoc & friends.""" | |
1544 | info = self._object_find(oname, namespaces) |
|
1544 | info = self._object_find(oname, namespaces) | |
1545 | if info.found: |
|
1545 | if info.found: | |
1546 | pmethod = getattr(self.inspector, meth) |
|
1546 | pmethod = getattr(self.inspector, meth) | |
1547 | formatter = format_screen if info.ismagic else None |
|
1547 | formatter = format_screen if info.ismagic else None | |
1548 | if meth == 'pdoc': |
|
1548 | if meth == 'pdoc': | |
1549 | pmethod(info.obj, oname, formatter) |
|
1549 | pmethod(info.obj, oname, formatter) | |
1550 | elif meth == 'pinfo': |
|
1550 | elif meth == 'pinfo': | |
1551 | pmethod(info.obj, oname, formatter, info, **kw) |
|
1551 | pmethod(info.obj, oname, formatter, info, **kw) | |
1552 | else: |
|
1552 | else: | |
1553 | pmethod(info.obj, oname) |
|
1553 | pmethod(info.obj, oname) | |
1554 | else: |
|
1554 | else: | |
1555 | print('Object `%s` not found.' % oname) |
|
1555 | print('Object `%s` not found.' % oname) | |
1556 | return 'not found' # so callers can take other action |
|
1556 | return 'not found' # so callers can take other action | |
1557 |
|
1557 | |||
1558 | def object_inspect(self, oname, detail_level=0): |
|
1558 | def object_inspect(self, oname, detail_level=0): | |
1559 | """Get object info about oname""" |
|
1559 | """Get object info about oname""" | |
1560 | with self.builtin_trap: |
|
1560 | with self.builtin_trap: | |
1561 | info = self._object_find(oname) |
|
1561 | info = self._object_find(oname) | |
1562 | if info.found: |
|
1562 | if info.found: | |
1563 | return self.inspector.info(info.obj, oname, info=info, |
|
1563 | return self.inspector.info(info.obj, oname, info=info, | |
1564 | detail_level=detail_level |
|
1564 | detail_level=detail_level | |
1565 | ) |
|
1565 | ) | |
1566 | else: |
|
1566 | else: | |
1567 | return oinspect.object_info(name=oname, found=False) |
|
1567 | return oinspect.object_info(name=oname, found=False) | |
1568 |
|
1568 | |||
1569 | def object_inspect_text(self, oname, detail_level=0): |
|
1569 | def object_inspect_text(self, oname, detail_level=0): | |
1570 | """Get object info as formatted text""" |
|
1570 | """Get object info as formatted text""" | |
1571 | with self.builtin_trap: |
|
1571 | with self.builtin_trap: | |
1572 | info = self._object_find(oname) |
|
1572 | info = self._object_find(oname) | |
1573 | if info.found: |
|
1573 | if info.found: | |
1574 | return self.inspector._format_info(info.obj, oname, info=info, |
|
1574 | return self.inspector._format_info(info.obj, oname, info=info, | |
1575 | detail_level=detail_level |
|
1575 | detail_level=detail_level | |
1576 | ) |
|
1576 | ) | |
1577 | else: |
|
1577 | else: | |
1578 | raise KeyError(oname) |
|
1578 | raise KeyError(oname) | |
1579 |
|
1579 | |||
1580 | #------------------------------------------------------------------------- |
|
1580 | #------------------------------------------------------------------------- | |
1581 | # Things related to history management |
|
1581 | # Things related to history management | |
1582 | #------------------------------------------------------------------------- |
|
1582 | #------------------------------------------------------------------------- | |
1583 |
|
1583 | |||
1584 | def init_history(self): |
|
1584 | def init_history(self): | |
1585 | """Sets up the command history, and starts regular autosaves.""" |
|
1585 | """Sets up the command history, and starts regular autosaves.""" | |
1586 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1586 | self.history_manager = HistoryManager(shell=self, parent=self) | |
1587 | self.configurables.append(self.history_manager) |
|
1587 | self.configurables.append(self.history_manager) | |
1588 |
|
1588 | |||
1589 | #------------------------------------------------------------------------- |
|
1589 | #------------------------------------------------------------------------- | |
1590 | # Things related to exception handling and tracebacks (not debugging) |
|
1590 | # Things related to exception handling and tracebacks (not debugging) | |
1591 | #------------------------------------------------------------------------- |
|
1591 | #------------------------------------------------------------------------- | |
1592 |
|
1592 | |||
1593 | def init_traceback_handlers(self, custom_exceptions): |
|
1593 | def init_traceback_handlers(self, custom_exceptions): | |
1594 | # Syntax error handler. |
|
1594 | # Syntax error handler. | |
1595 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') |
|
1595 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor') | |
1596 |
|
1596 | |||
1597 | # The interactive one is initialized with an offset, meaning we always |
|
1597 | # The interactive one is initialized with an offset, meaning we always | |
1598 | # want to remove the topmost item in the traceback, which is our own |
|
1598 | # want to remove the topmost item in the traceback, which is our own | |
1599 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1599 | # internal code. Valid modes: ['Plain','Context','Verbose'] | |
1600 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1600 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', | |
1601 | color_scheme='NoColor', |
|
1601 | color_scheme='NoColor', | |
1602 | tb_offset = 1, |
|
1602 | tb_offset = 1, | |
1603 | check_cache=check_linecache_ipython) |
|
1603 | check_cache=check_linecache_ipython) | |
1604 |
|
1604 | |||
1605 | # The instance will store a pointer to the system-wide exception hook, |
|
1605 | # The instance will store a pointer to the system-wide exception hook, | |
1606 | # so that runtime code (such as magics) can access it. This is because |
|
1606 | # so that runtime code (such as magics) can access it. This is because | |
1607 | # during the read-eval loop, it may get temporarily overwritten. |
|
1607 | # during the read-eval loop, it may get temporarily overwritten. | |
1608 | self.sys_excepthook = sys.excepthook |
|
1608 | self.sys_excepthook = sys.excepthook | |
1609 |
|
1609 | |||
1610 | # and add any custom exception handlers the user may have specified |
|
1610 | # and add any custom exception handlers the user may have specified | |
1611 | self.set_custom_exc(*custom_exceptions) |
|
1611 | self.set_custom_exc(*custom_exceptions) | |
1612 |
|
1612 | |||
1613 | # Set the exception mode |
|
1613 | # Set the exception mode | |
1614 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1614 | self.InteractiveTB.set_mode(mode=self.xmode) | |
1615 |
|
1615 | |||
1616 | def set_custom_exc(self, exc_tuple, handler): |
|
1616 | def set_custom_exc(self, exc_tuple, handler): | |
1617 | """set_custom_exc(exc_tuple,handler) |
|
1617 | """set_custom_exc(exc_tuple,handler) | |
1618 |
|
1618 | |||
1619 | Set a custom exception handler, which will be called if any of the |
|
1619 | Set a custom exception handler, which will be called if any of the | |
1620 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1620 | exceptions in exc_tuple occur in the mainloop (specifically, in the | |
1621 | run_code() method). |
|
1621 | run_code() method). | |
1622 |
|
1622 | |||
1623 | Parameters |
|
1623 | Parameters | |
1624 | ---------- |
|
1624 | ---------- | |
1625 |
|
1625 | |||
1626 | exc_tuple : tuple of exception classes |
|
1626 | exc_tuple : tuple of exception classes | |
1627 | A *tuple* of exception classes, for which to call the defined |
|
1627 | A *tuple* of exception classes, for which to call the defined | |
1628 | handler. It is very important that you use a tuple, and NOT A |
|
1628 | handler. It is very important that you use a tuple, and NOT A | |
1629 | LIST here, because of the way Python's except statement works. If |
|
1629 | LIST here, because of the way Python's except statement works. If | |
1630 | you only want to trap a single exception, use a singleton tuple:: |
|
1630 | you only want to trap a single exception, use a singleton tuple:: | |
1631 |
|
1631 | |||
1632 | exc_tuple == (MyCustomException,) |
|
1632 | exc_tuple == (MyCustomException,) | |
1633 |
|
1633 | |||
1634 | handler : callable |
|
1634 | handler : callable | |
1635 | handler must have the following signature:: |
|
1635 | handler must have the following signature:: | |
1636 |
|
1636 | |||
1637 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1637 | def my_handler(self, etype, value, tb, tb_offset=None): | |
1638 | ... |
|
1638 | ... | |
1639 | return structured_traceback |
|
1639 | return structured_traceback | |
1640 |
|
1640 | |||
1641 | Your handler must return a structured traceback (a list of strings), |
|
1641 | Your handler must return a structured traceback (a list of strings), | |
1642 | or None. |
|
1642 | or None. | |
1643 |
|
1643 | |||
1644 | This will be made into an instance method (via types.MethodType) |
|
1644 | This will be made into an instance method (via types.MethodType) | |
1645 | of IPython itself, and it will be called if any of the exceptions |
|
1645 | of IPython itself, and it will be called if any of the exceptions | |
1646 | listed in the exc_tuple are caught. If the handler is None, an |
|
1646 | listed in the exc_tuple are caught. If the handler is None, an | |
1647 | internal basic one is used, which just prints basic info. |
|
1647 | internal basic one is used, which just prints basic info. | |
1648 |
|
1648 | |||
1649 | To protect IPython from crashes, if your handler ever raises an |
|
1649 | To protect IPython from crashes, if your handler ever raises an | |
1650 | exception or returns an invalid result, it will be immediately |
|
1650 | exception or returns an invalid result, it will be immediately | |
1651 | disabled. |
|
1651 | disabled. | |
1652 |
|
1652 | |||
1653 | WARNING: by putting in your own exception handler into IPython's main |
|
1653 | WARNING: by putting in your own exception handler into IPython's main | |
1654 | execution loop, you run a very good chance of nasty crashes. This |
|
1654 | execution loop, you run a very good chance of nasty crashes. This | |
1655 | facility should only be used if you really know what you are doing.""" |
|
1655 | facility should only be used if you really know what you are doing.""" | |
1656 |
|
1656 | |||
1657 | assert type(exc_tuple)==type(()) , \ |
|
1657 | assert type(exc_tuple)==type(()) , \ | |
1658 | "The custom exceptions must be given AS A TUPLE." |
|
1658 | "The custom exceptions must be given AS A TUPLE." | |
1659 |
|
1659 | |||
1660 | def dummy_handler(self,etype,value,tb,tb_offset=None): |
|
1660 | def dummy_handler(self,etype,value,tb,tb_offset=None): | |
1661 | print('*** Simple custom exception handler ***') |
|
1661 | print('*** Simple custom exception handler ***') | |
1662 | print('Exception type :',etype) |
|
1662 | print('Exception type :',etype) | |
1663 | print('Exception value:',value) |
|
1663 | print('Exception value:',value) | |
1664 | print('Traceback :',tb) |
|
1664 | print('Traceback :',tb) | |
1665 | #print 'Source code :','\n'.join(self.buffer) |
|
1665 | #print 'Source code :','\n'.join(self.buffer) | |
1666 |
|
1666 | |||
1667 | def validate_stb(stb): |
|
1667 | def validate_stb(stb): | |
1668 | """validate structured traceback return type |
|
1668 | """validate structured traceback return type | |
1669 |
|
1669 | |||
1670 | return type of CustomTB *should* be a list of strings, but allow |
|
1670 | return type of CustomTB *should* be a list of strings, but allow | |
1671 | single strings or None, which are harmless. |
|
1671 | single strings or None, which are harmless. | |
1672 |
|
1672 | |||
1673 | This function will *always* return a list of strings, |
|
1673 | This function will *always* return a list of strings, | |
1674 | and will raise a TypeError if stb is inappropriate. |
|
1674 | and will raise a TypeError if stb is inappropriate. | |
1675 | """ |
|
1675 | """ | |
1676 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1676 | msg = "CustomTB must return list of strings, not %r" % stb | |
1677 | if stb is None: |
|
1677 | if stb is None: | |
1678 | return [] |
|
1678 | return [] | |
1679 | elif isinstance(stb, string_types): |
|
1679 | elif isinstance(stb, string_types): | |
1680 | return [stb] |
|
1680 | return [stb] | |
1681 | elif not isinstance(stb, list): |
|
1681 | elif not isinstance(stb, list): | |
1682 | raise TypeError(msg) |
|
1682 | raise TypeError(msg) | |
1683 | # it's a list |
|
1683 | # it's a list | |
1684 | for line in stb: |
|
1684 | for line in stb: | |
1685 | # check every element |
|
1685 | # check every element | |
1686 | if not isinstance(line, string_types): |
|
1686 | if not isinstance(line, string_types): | |
1687 | raise TypeError(msg) |
|
1687 | raise TypeError(msg) | |
1688 | return stb |
|
1688 | return stb | |
1689 |
|
1689 | |||
1690 | if handler is None: |
|
1690 | if handler is None: | |
1691 | wrapped = dummy_handler |
|
1691 | wrapped = dummy_handler | |
1692 | else: |
|
1692 | else: | |
1693 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1693 | def wrapped(self,etype,value,tb,tb_offset=None): | |
1694 | """wrap CustomTB handler, to protect IPython from user code |
|
1694 | """wrap CustomTB handler, to protect IPython from user code | |
1695 |
|
1695 | |||
1696 | This makes it harder (but not impossible) for custom exception |
|
1696 | This makes it harder (but not impossible) for custom exception | |
1697 | handlers to crash IPython. |
|
1697 | handlers to crash IPython. | |
1698 | """ |
|
1698 | """ | |
1699 | try: |
|
1699 | try: | |
1700 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1700 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) | |
1701 | return validate_stb(stb) |
|
1701 | return validate_stb(stb) | |
1702 | except: |
|
1702 | except: | |
1703 | # clear custom handler immediately |
|
1703 | # clear custom handler immediately | |
1704 | self.set_custom_exc((), None) |
|
1704 | self.set_custom_exc((), None) | |
1705 | print("Custom TB Handler failed, unregistering", file=io.stderr) |
|
1705 | print("Custom TB Handler failed, unregistering", file=io.stderr) | |
1706 | # show the exception in handler first |
|
1706 | # show the exception in handler first | |
1707 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1707 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) | |
1708 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) |
|
1708 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) | |
1709 | print("The original exception:", file=io.stdout) |
|
1709 | print("The original exception:", file=io.stdout) | |
1710 | stb = self.InteractiveTB.structured_traceback( |
|
1710 | stb = self.InteractiveTB.structured_traceback( | |
1711 | (etype,value,tb), tb_offset=tb_offset |
|
1711 | (etype,value,tb), tb_offset=tb_offset | |
1712 | ) |
|
1712 | ) | |
1713 | return stb |
|
1713 | return stb | |
1714 |
|
1714 | |||
1715 | self.CustomTB = types.MethodType(wrapped,self) |
|
1715 | self.CustomTB = types.MethodType(wrapped,self) | |
1716 | self.custom_exceptions = exc_tuple |
|
1716 | self.custom_exceptions = exc_tuple | |
1717 |
|
1717 | |||
1718 | def excepthook(self, etype, value, tb): |
|
1718 | def excepthook(self, etype, value, tb): | |
1719 | """One more defense for GUI apps that call sys.excepthook. |
|
1719 | """One more defense for GUI apps that call sys.excepthook. | |
1720 |
|
1720 | |||
1721 | GUI frameworks like wxPython trap exceptions and call |
|
1721 | GUI frameworks like wxPython trap exceptions and call | |
1722 | sys.excepthook themselves. I guess this is a feature that |
|
1722 | sys.excepthook themselves. I guess this is a feature that | |
1723 | enables them to keep running after exceptions that would |
|
1723 | enables them to keep running after exceptions that would | |
1724 | otherwise kill their mainloop. This is a bother for IPython |
|
1724 | otherwise kill their mainloop. This is a bother for IPython | |
1725 | which excepts to catch all of the program exceptions with a try: |
|
1725 | which excepts to catch all of the program exceptions with a try: | |
1726 | except: statement. |
|
1726 | except: statement. | |
1727 |
|
1727 | |||
1728 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1728 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if | |
1729 | any app directly invokes sys.excepthook, it will look to the user like |
|
1729 | any app directly invokes sys.excepthook, it will look to the user like | |
1730 | IPython crashed. In order to work around this, we can disable the |
|
1730 | IPython crashed. In order to work around this, we can disable the | |
1731 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1731 | CrashHandler and replace it with this excepthook instead, which prints a | |
1732 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1732 | regular traceback using our InteractiveTB. In this fashion, apps which | |
1733 | call sys.excepthook will generate a regular-looking exception from |
|
1733 | call sys.excepthook will generate a regular-looking exception from | |
1734 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1734 | IPython, and the CrashHandler will only be triggered by real IPython | |
1735 | crashes. |
|
1735 | crashes. | |
1736 |
|
1736 | |||
1737 | This hook should be used sparingly, only in places which are not likely |
|
1737 | This hook should be used sparingly, only in places which are not likely | |
1738 | to be true IPython errors. |
|
1738 | to be true IPython errors. | |
1739 | """ |
|
1739 | """ | |
1740 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1740 | self.showtraceback((etype, value, tb), tb_offset=0) | |
1741 |
|
1741 | |||
1742 | def _get_exc_info(self, exc_tuple=None): |
|
1742 | def _get_exc_info(self, exc_tuple=None): | |
1743 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1743 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. | |
1744 |
|
1744 | |||
1745 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1745 | Ensures sys.last_type,value,traceback hold the exc_info we found, | |
1746 | from whichever source. |
|
1746 | from whichever source. | |
1747 |
|
1747 | |||
1748 | raises ValueError if none of these contain any information |
|
1748 | raises ValueError if none of these contain any information | |
1749 | """ |
|
1749 | """ | |
1750 | if exc_tuple is None: |
|
1750 | if exc_tuple is None: | |
1751 | etype, value, tb = sys.exc_info() |
|
1751 | etype, value, tb = sys.exc_info() | |
1752 | else: |
|
1752 | else: | |
1753 | etype, value, tb = exc_tuple |
|
1753 | etype, value, tb = exc_tuple | |
1754 |
|
1754 | |||
1755 | if etype is None: |
|
1755 | if etype is None: | |
1756 | if hasattr(sys, 'last_type'): |
|
1756 | if hasattr(sys, 'last_type'): | |
1757 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1757 | etype, value, tb = sys.last_type, sys.last_value, \ | |
1758 | sys.last_traceback |
|
1758 | sys.last_traceback | |
1759 |
|
1759 | |||
1760 | if etype is None: |
|
1760 | if etype is None: | |
1761 | raise ValueError("No exception to find") |
|
1761 | raise ValueError("No exception to find") | |
1762 |
|
1762 | |||
1763 | # Now store the exception info in sys.last_type etc. |
|
1763 | # Now store the exception info in sys.last_type etc. | |
1764 | # WARNING: these variables are somewhat deprecated and not |
|
1764 | # WARNING: these variables are somewhat deprecated and not | |
1765 | # necessarily safe to use in a threaded environment, but tools |
|
1765 | # necessarily safe to use in a threaded environment, but tools | |
1766 | # like pdb depend on their existence, so let's set them. If we |
|
1766 | # like pdb depend on their existence, so let's set them. If we | |
1767 | # find problems in the field, we'll need to revisit their use. |
|
1767 | # find problems in the field, we'll need to revisit their use. | |
1768 | sys.last_type = etype |
|
1768 | sys.last_type = etype | |
1769 | sys.last_value = value |
|
1769 | sys.last_value = value | |
1770 | sys.last_traceback = tb |
|
1770 | sys.last_traceback = tb | |
1771 |
|
1771 | |||
1772 | return etype, value, tb |
|
1772 | return etype, value, tb | |
1773 |
|
1773 | |||
1774 | def show_usage_error(self, exc): |
|
1774 | def show_usage_error(self, exc): | |
1775 | """Show a short message for UsageErrors |
|
1775 | """Show a short message for UsageErrors | |
1776 |
|
1776 | |||
1777 | These are special exceptions that shouldn't show a traceback. |
|
1777 | These are special exceptions that shouldn't show a traceback. | |
1778 | """ |
|
1778 | """ | |
1779 | self.write_err("UsageError: %s" % exc) |
|
1779 | self.write_err("UsageError: %s" % exc) | |
1780 |
|
1780 | |||
1781 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
1781 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, | |
1782 | exception_only=False): |
|
1782 | exception_only=False): | |
1783 | """Display the exception that just occurred. |
|
1783 | """Display the exception that just occurred. | |
1784 |
|
1784 | |||
1785 | If nothing is known about the exception, this is the method which |
|
1785 | If nothing is known about the exception, this is the method which | |
1786 | should be used throughout the code for presenting user tracebacks, |
|
1786 | should be used throughout the code for presenting user tracebacks, | |
1787 | rather than directly invoking the InteractiveTB object. |
|
1787 | rather than directly invoking the InteractiveTB object. | |
1788 |
|
1788 | |||
1789 | A specific showsyntaxerror() also exists, but this method can take |
|
1789 | A specific showsyntaxerror() also exists, but this method can take | |
1790 | care of calling it if needed, so unless you are explicitly catching a |
|
1790 | care of calling it if needed, so unless you are explicitly catching a | |
1791 | SyntaxError exception, don't try to analyze the stack manually and |
|
1791 | SyntaxError exception, don't try to analyze the stack manually and | |
1792 | simply call this method.""" |
|
1792 | simply call this method.""" | |
1793 |
|
1793 | |||
1794 | try: |
|
1794 | try: | |
1795 | try: |
|
1795 | try: | |
1796 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1796 | etype, value, tb = self._get_exc_info(exc_tuple) | |
1797 | except ValueError: |
|
1797 | except ValueError: | |
1798 | self.write_err('No traceback available to show.\n') |
|
1798 | self.write_err('No traceback available to show.\n') | |
1799 | return |
|
1799 | return | |
1800 |
|
1800 | |||
1801 | if issubclass(etype, SyntaxError): |
|
1801 | if issubclass(etype, SyntaxError): | |
1802 | # Though this won't be called by syntax errors in the input |
|
1802 | # Though this won't be called by syntax errors in the input | |
1803 | # line, there may be SyntaxError cases with imported code. |
|
1803 | # line, there may be SyntaxError cases with imported code. | |
1804 | self.showsyntaxerror(filename) |
|
1804 | self.showsyntaxerror(filename) | |
1805 | elif etype is UsageError: |
|
1805 | elif etype is UsageError: | |
1806 | self.show_usage_error(value) |
|
1806 | self.show_usage_error(value) | |
1807 | else: |
|
1807 | else: | |
1808 | if exception_only: |
|
1808 | if exception_only: | |
1809 | stb = ['An exception has occurred, use %tb to see ' |
|
1809 | stb = ['An exception has occurred, use %tb to see ' | |
1810 | 'the full traceback.\n'] |
|
1810 | 'the full traceback.\n'] | |
1811 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1811 | stb.extend(self.InteractiveTB.get_exception_only(etype, | |
1812 | value)) |
|
1812 | value)) | |
1813 | else: |
|
1813 | else: | |
1814 | try: |
|
1814 | try: | |
1815 | # Exception classes can customise their traceback - we |
|
1815 | # Exception classes can customise their traceback - we | |
1816 | # use this in IPython.parallel for exceptions occurring |
|
1816 | # use this in IPython.parallel for exceptions occurring | |
1817 | # in the engines. This should return a list of strings. |
|
1817 | # in the engines. This should return a list of strings. | |
1818 | stb = value._render_traceback_() |
|
1818 | stb = value._render_traceback_() | |
1819 | except Exception: |
|
1819 | except Exception: | |
1820 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1820 | stb = self.InteractiveTB.structured_traceback(etype, | |
1821 | value, tb, tb_offset=tb_offset) |
|
1821 | value, tb, tb_offset=tb_offset) | |
1822 |
|
1822 | |||
1823 | self._showtraceback(etype, value, stb) |
|
1823 | self._showtraceback(etype, value, stb) | |
1824 | if self.call_pdb: |
|
1824 | if self.call_pdb: | |
1825 | # drop into debugger |
|
1825 | # drop into debugger | |
1826 | self.debugger(force=True) |
|
1826 | self.debugger(force=True) | |
1827 | return |
|
1827 | return | |
1828 |
|
1828 | |||
1829 | # Actually show the traceback |
|
1829 | # Actually show the traceback | |
1830 | self._showtraceback(etype, value, stb) |
|
1830 | self._showtraceback(etype, value, stb) | |
1831 |
|
1831 | |||
1832 | except KeyboardInterrupt: |
|
1832 | except KeyboardInterrupt: | |
1833 | self.write_err("\nKeyboardInterrupt\n") |
|
1833 | self.write_err("\nKeyboardInterrupt\n") | |
1834 |
|
1834 | |||
1835 | def _showtraceback(self, etype, evalue, stb): |
|
1835 | def _showtraceback(self, etype, evalue, stb): | |
1836 | """Actually show a traceback. |
|
1836 | """Actually show a traceback. | |
1837 |
|
1837 | |||
1838 | Subclasses may override this method to put the traceback on a different |
|
1838 | Subclasses may override this method to put the traceback on a different | |
1839 | place, like a side channel. |
|
1839 | place, like a side channel. | |
1840 | """ |
|
1840 | """ | |
1841 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) |
|
1841 | print(self.InteractiveTB.stb2text(stb), file=io.stdout) | |
1842 |
|
1842 | |||
1843 | def showsyntaxerror(self, filename=None): |
|
1843 | def showsyntaxerror(self, filename=None): | |
1844 | """Display the syntax error that just occurred. |
|
1844 | """Display the syntax error that just occurred. | |
1845 |
|
1845 | |||
1846 | This doesn't display a stack trace because there isn't one. |
|
1846 | This doesn't display a stack trace because there isn't one. | |
1847 |
|
1847 | |||
1848 | If a filename is given, it is stuffed in the exception instead |
|
1848 | If a filename is given, it is stuffed in the exception instead | |
1849 | of what was there before (because Python's parser always uses |
|
1849 | of what was there before (because Python's parser always uses | |
1850 | "<string>" when reading from a string). |
|
1850 | "<string>" when reading from a string). | |
1851 | """ |
|
1851 | """ | |
1852 | etype, value, last_traceback = self._get_exc_info() |
|
1852 | etype, value, last_traceback = self._get_exc_info() | |
1853 |
|
1853 | |||
1854 | if filename and issubclass(etype, SyntaxError): |
|
1854 | if filename and issubclass(etype, SyntaxError): | |
1855 | try: |
|
1855 | try: | |
1856 | value.filename = filename |
|
1856 | value.filename = filename | |
1857 | except: |
|
1857 | except: | |
1858 | # Not the format we expect; leave it alone |
|
1858 | # Not the format we expect; leave it alone | |
1859 | pass |
|
1859 | pass | |
1860 |
|
1860 | |||
1861 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1861 | stb = self.SyntaxTB.structured_traceback(etype, value, []) | |
1862 | self._showtraceback(etype, value, stb) |
|
1862 | self._showtraceback(etype, value, stb) | |
1863 |
|
1863 | |||
1864 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1864 | # This is overridden in TerminalInteractiveShell to show a message about | |
1865 | # the %paste magic. |
|
1865 | # the %paste magic. | |
1866 | def showindentationerror(self): |
|
1866 | def showindentationerror(self): | |
1867 | """Called by run_cell when there's an IndentationError in code entered |
|
1867 | """Called by run_cell when there's an IndentationError in code entered | |
1868 | at the prompt. |
|
1868 | at the prompt. | |
1869 |
|
1869 | |||
1870 | This is overridden in TerminalInteractiveShell to show a message about |
|
1870 | This is overridden in TerminalInteractiveShell to show a message about | |
1871 | the %paste magic.""" |
|
1871 | the %paste magic.""" | |
1872 | self.showsyntaxerror() |
|
1872 | self.showsyntaxerror() | |
1873 |
|
1873 | |||
1874 | #------------------------------------------------------------------------- |
|
1874 | #------------------------------------------------------------------------- | |
1875 | # Things related to readline |
|
1875 | # Things related to readline | |
1876 | #------------------------------------------------------------------------- |
|
1876 | #------------------------------------------------------------------------- | |
1877 |
|
1877 | |||
1878 | def init_readline(self): |
|
1878 | def init_readline(self): | |
1879 | """Command history completion/saving/reloading.""" |
|
1879 | """Command history completion/saving/reloading.""" | |
1880 |
|
1880 | |||
1881 | if self.readline_use: |
|
1881 | if self.readline_use: | |
1882 | import IPython.utils.rlineimpl as readline |
|
1882 | import IPython.utils.rlineimpl as readline | |
1883 |
|
1883 | |||
1884 | self.rl_next_input = None |
|
1884 | self.rl_next_input = None | |
1885 | self.rl_do_indent = False |
|
1885 | self.rl_do_indent = False | |
1886 |
|
1886 | |||
1887 | if not self.readline_use or not readline.have_readline: |
|
1887 | if not self.readline_use or not readline.have_readline: | |
1888 | self.has_readline = False |
|
1888 | self.has_readline = False | |
1889 | self.readline = None |
|
1889 | self.readline = None | |
1890 | # Set a number of methods that depend on readline to be no-op |
|
1890 | # Set a number of methods that depend on readline to be no-op | |
1891 | self.readline_no_record = no_op_context |
|
1891 | self.readline_no_record = no_op_context | |
1892 | self.set_readline_completer = no_op |
|
1892 | self.set_readline_completer = no_op | |
1893 | self.set_custom_completer = no_op |
|
1893 | self.set_custom_completer = no_op | |
1894 | if self.readline_use: |
|
1894 | if self.readline_use: | |
1895 | warn('Readline services not available or not loaded.') |
|
1895 | warn('Readline services not available or not loaded.') | |
1896 | else: |
|
1896 | else: | |
1897 | self.has_readline = True |
|
1897 | self.has_readline = True | |
1898 | self.readline = readline |
|
1898 | self.readline = readline | |
1899 | sys.modules['readline'] = readline |
|
1899 | sys.modules['readline'] = readline | |
1900 |
|
1900 | |||
1901 | # Platform-specific configuration |
|
1901 | # Platform-specific configuration | |
1902 | if os.name == 'nt': |
|
1902 | if os.name == 'nt': | |
1903 | # FIXME - check with Frederick to see if we can harmonize |
|
1903 | # FIXME - check with Frederick to see if we can harmonize | |
1904 | # naming conventions with pyreadline to avoid this |
|
1904 | # naming conventions with pyreadline to avoid this | |
1905 | # platform-dependent check |
|
1905 | # platform-dependent check | |
1906 | self.readline_startup_hook = readline.set_pre_input_hook |
|
1906 | self.readline_startup_hook = readline.set_pre_input_hook | |
1907 | else: |
|
1907 | else: | |
1908 | self.readline_startup_hook = readline.set_startup_hook |
|
1908 | self.readline_startup_hook = readline.set_startup_hook | |
1909 |
|
1909 | |||
1910 | # Readline config order: |
|
1910 | # Readline config order: | |
1911 | # - IPython config (default value) |
|
1911 | # - IPython config (default value) | |
1912 | # - custom inputrc |
|
1912 | # - custom inputrc | |
1913 | # - IPython config (user customized) |
|
1913 | # - IPython config (user customized) | |
1914 |
|
1914 | |||
1915 | # load IPython config before inputrc if default |
|
1915 | # load IPython config before inputrc if default | |
1916 | # skip if libedit because parse_and_bind syntax is different |
|
1916 | # skip if libedit because parse_and_bind syntax is different | |
1917 | if not self._custom_readline_config and not readline.uses_libedit: |
|
1917 | if not self._custom_readline_config and not readline.uses_libedit: | |
1918 | for rlcommand in self.readline_parse_and_bind: |
|
1918 | for rlcommand in self.readline_parse_and_bind: | |
1919 | readline.parse_and_bind(rlcommand) |
|
1919 | readline.parse_and_bind(rlcommand) | |
1920 |
|
1920 | |||
1921 | # Load user's initrc file (readline config) |
|
1921 | # Load user's initrc file (readline config) | |
1922 | # Or if libedit is used, load editrc. |
|
1922 | # Or if libedit is used, load editrc. | |
1923 | inputrc_name = os.environ.get('INPUTRC') |
|
1923 | inputrc_name = os.environ.get('INPUTRC') | |
1924 | if inputrc_name is None: |
|
1924 | if inputrc_name is None: | |
1925 | inputrc_name = '.inputrc' |
|
1925 | inputrc_name = '.inputrc' | |
1926 | if readline.uses_libedit: |
|
1926 | if readline.uses_libedit: | |
1927 | inputrc_name = '.editrc' |
|
1927 | inputrc_name = '.editrc' | |
1928 | inputrc_name = os.path.join(self.home_dir, inputrc_name) |
|
1928 | inputrc_name = os.path.join(self.home_dir, inputrc_name) | |
1929 | if os.path.isfile(inputrc_name): |
|
1929 | if os.path.isfile(inputrc_name): | |
1930 | try: |
|
1930 | try: | |
1931 | readline.read_init_file(inputrc_name) |
|
1931 | readline.read_init_file(inputrc_name) | |
1932 | except: |
|
1932 | except: | |
1933 | warn('Problems reading readline initialization file <%s>' |
|
1933 | warn('Problems reading readline initialization file <%s>' | |
1934 | % inputrc_name) |
|
1934 | % inputrc_name) | |
1935 |
|
1935 | |||
1936 | # load IPython config after inputrc if user has customized |
|
1936 | # load IPython config after inputrc if user has customized | |
1937 | if self._custom_readline_config: |
|
1937 | if self._custom_readline_config: | |
1938 | for rlcommand in self.readline_parse_and_bind: |
|
1938 | for rlcommand in self.readline_parse_and_bind: | |
1939 | readline.parse_and_bind(rlcommand) |
|
1939 | readline.parse_and_bind(rlcommand) | |
1940 |
|
1940 | |||
1941 | # Remove some chars from the delimiters list. If we encounter |
|
1941 | # Remove some chars from the delimiters list. If we encounter | |
1942 | # unicode chars, discard them. |
|
1942 | # unicode chars, discard them. | |
1943 | delims = readline.get_completer_delims() |
|
1943 | delims = readline.get_completer_delims() | |
1944 | if not py3compat.PY3: |
|
1944 | if not py3compat.PY3: | |
1945 | delims = delims.encode("ascii", "ignore") |
|
1945 | delims = delims.encode("ascii", "ignore") | |
1946 | for d in self.readline_remove_delims: |
|
1946 | for d in self.readline_remove_delims: | |
1947 | delims = delims.replace(d, "") |
|
1947 | delims = delims.replace(d, "") | |
1948 | delims = delims.replace(ESC_MAGIC, '') |
|
1948 | delims = delims.replace(ESC_MAGIC, '') | |
1949 | readline.set_completer_delims(delims) |
|
1949 | readline.set_completer_delims(delims) | |
1950 | # Store these so we can restore them if something like rpy2 modifies |
|
1950 | # Store these so we can restore them if something like rpy2 modifies | |
1951 | # them. |
|
1951 | # them. | |
1952 | self.readline_delims = delims |
|
1952 | self.readline_delims = delims | |
1953 | # otherwise we end up with a monster history after a while: |
|
1953 | # otherwise we end up with a monster history after a while: | |
1954 | readline.set_history_length(self.history_length) |
|
1954 | readline.set_history_length(self.history_length) | |
1955 |
|
1955 | |||
1956 | self.refill_readline_hist() |
|
1956 | self.refill_readline_hist() | |
1957 | self.readline_no_record = ReadlineNoRecord(self) |
|
1957 | self.readline_no_record = ReadlineNoRecord(self) | |
1958 |
|
1958 | |||
1959 | # Configure auto-indent for all platforms |
|
1959 | # Configure auto-indent for all platforms | |
1960 | self.set_autoindent(self.autoindent) |
|
1960 | self.set_autoindent(self.autoindent) | |
1961 |
|
1961 | |||
1962 | def refill_readline_hist(self): |
|
1962 | def refill_readline_hist(self): | |
1963 | # Load the last 1000 lines from history |
|
1963 | # Load the last 1000 lines from history | |
1964 | self.readline.clear_history() |
|
1964 | self.readline.clear_history() | |
1965 | stdin_encoding = sys.stdin.encoding or "utf-8" |
|
1965 | stdin_encoding = sys.stdin.encoding or "utf-8" | |
1966 | last_cell = u"" |
|
1966 | last_cell = u"" | |
1967 | for _, _, cell in self.history_manager.get_tail(1000, |
|
1967 | for _, _, cell in self.history_manager.get_tail(1000, | |
1968 | include_latest=True): |
|
1968 | include_latest=True): | |
1969 | # Ignore blank lines and consecutive duplicates |
|
1969 | # Ignore blank lines and consecutive duplicates | |
1970 | cell = cell.rstrip() |
|
1970 | cell = cell.rstrip() | |
1971 | if cell and (cell != last_cell): |
|
1971 | if cell and (cell != last_cell): | |
1972 | try: |
|
1972 | try: | |
1973 | if self.multiline_history: |
|
1973 | if self.multiline_history: | |
1974 | self.readline.add_history(py3compat.unicode_to_str(cell, |
|
1974 | self.readline.add_history(py3compat.unicode_to_str(cell, | |
1975 | stdin_encoding)) |
|
1975 | stdin_encoding)) | |
1976 | else: |
|
1976 | else: | |
1977 | for line in cell.splitlines(): |
|
1977 | for line in cell.splitlines(): | |
1978 | self.readline.add_history(py3compat.unicode_to_str(line, |
|
1978 | self.readline.add_history(py3compat.unicode_to_str(line, | |
1979 | stdin_encoding)) |
|
1979 | stdin_encoding)) | |
1980 | last_cell = cell |
|
1980 | last_cell = cell | |
1981 |
|
1981 | |||
1982 | except TypeError: |
|
1982 | except TypeError: | |
1983 | # The history DB can get corrupted so it returns strings |
|
1983 | # The history DB can get corrupted so it returns strings | |
1984 | # containing null bytes, which readline objects to. |
|
1984 | # containing null bytes, which readline objects to. | |
1985 | continue |
|
1985 | continue | |
1986 |
|
1986 | |||
1987 | @skip_doctest |
|
1987 | @skip_doctest | |
1988 | def set_next_input(self, s): |
|
1988 | def set_next_input(self, s): | |
1989 | """ Sets the 'default' input string for the next command line. |
|
1989 | """ Sets the 'default' input string for the next command line. | |
1990 |
|
1990 | |||
1991 | Requires readline. |
|
1991 | Requires readline. | |
1992 |
|
1992 | |||
1993 | Example:: |
|
1993 | Example:: | |
1994 |
|
1994 | |||
1995 | In [1]: _ip.set_next_input("Hello Word") |
|
1995 | In [1]: _ip.set_next_input("Hello Word") | |
1996 | In [2]: Hello Word_ # cursor is here |
|
1996 | In [2]: Hello Word_ # cursor is here | |
1997 | """ |
|
1997 | """ | |
1998 | self.rl_next_input = py3compat.cast_bytes_py2(s) |
|
1998 | self.rl_next_input = py3compat.cast_bytes_py2(s) | |
1999 |
|
1999 | |||
2000 | # Maybe move this to the terminal subclass? |
|
2000 | # Maybe move this to the terminal subclass? | |
2001 | def pre_readline(self): |
|
2001 | def pre_readline(self): | |
2002 | """readline hook to be used at the start of each line. |
|
2002 | """readline hook to be used at the start of each line. | |
2003 |
|
2003 | |||
2004 | Currently it handles auto-indent only.""" |
|
2004 | Currently it handles auto-indent only.""" | |
2005 |
|
2005 | |||
2006 | if self.rl_do_indent: |
|
2006 | if self.rl_do_indent: | |
2007 | self.readline.insert_text(self._indent_current_str()) |
|
2007 | self.readline.insert_text(self._indent_current_str()) | |
2008 | if self.rl_next_input is not None: |
|
2008 | if self.rl_next_input is not None: | |
2009 | self.readline.insert_text(self.rl_next_input) |
|
2009 | self.readline.insert_text(self.rl_next_input) | |
2010 | self.rl_next_input = None |
|
2010 | self.rl_next_input = None | |
2011 |
|
2011 | |||
2012 | def _indent_current_str(self): |
|
2012 | def _indent_current_str(self): | |
2013 | """return the current level of indentation as a string""" |
|
2013 | """return the current level of indentation as a string""" | |
2014 | return self.input_splitter.indent_spaces * ' ' |
|
2014 | return self.input_splitter.indent_spaces * ' ' | |
2015 |
|
2015 | |||
2016 | #------------------------------------------------------------------------- |
|
2016 | #------------------------------------------------------------------------- | |
2017 | # Things related to text completion |
|
2017 | # Things related to text completion | |
2018 | #------------------------------------------------------------------------- |
|
2018 | #------------------------------------------------------------------------- | |
2019 |
|
2019 | |||
2020 | def init_completer(self): |
|
2020 | def init_completer(self): | |
2021 | """Initialize the completion machinery. |
|
2021 | """Initialize the completion machinery. | |
2022 |
|
2022 | |||
2023 | This creates completion machinery that can be used by client code, |
|
2023 | This creates completion machinery that can be used by client code, | |
2024 | either interactively in-process (typically triggered by the readline |
|
2024 | either interactively in-process (typically triggered by the readline | |
2025 | library), programatically (such as in test suites) or out-of-prcess |
|
2025 | library), programatically (such as in test suites) or out-of-prcess | |
2026 | (typically over the network by remote frontends). |
|
2026 | (typically over the network by remote frontends). | |
2027 | """ |
|
2027 | """ | |
2028 | from IPython.core.completer import IPCompleter |
|
2028 | from IPython.core.completer import IPCompleter | |
2029 | from IPython.core.completerlib import (module_completer, |
|
2029 | from IPython.core.completerlib import (module_completer, | |
2030 | magic_run_completer, cd_completer, reset_completer) |
|
2030 | magic_run_completer, cd_completer, reset_completer) | |
2031 |
|
2031 | |||
2032 | self.Completer = IPCompleter(shell=self, |
|
2032 | self.Completer = IPCompleter(shell=self, | |
2033 | namespace=self.user_ns, |
|
2033 | namespace=self.user_ns, | |
2034 | global_namespace=self.user_global_ns, |
|
2034 | global_namespace=self.user_global_ns, | |
2035 | use_readline=self.has_readline, |
|
2035 | use_readline=self.has_readline, | |
2036 | parent=self, |
|
2036 | parent=self, | |
2037 | ) |
|
2037 | ) | |
2038 | self.configurables.append(self.Completer) |
|
2038 | self.configurables.append(self.Completer) | |
2039 |
|
2039 | |||
2040 | # Add custom completers to the basic ones built into IPCompleter |
|
2040 | # Add custom completers to the basic ones built into IPCompleter | |
2041 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2041 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) | |
2042 | self.strdispatchers['complete_command'] = sdisp |
|
2042 | self.strdispatchers['complete_command'] = sdisp | |
2043 | self.Completer.custom_completers = sdisp |
|
2043 | self.Completer.custom_completers = sdisp | |
2044 |
|
2044 | |||
2045 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2045 | self.set_hook('complete_command', module_completer, str_key = 'import') | |
2046 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2046 | self.set_hook('complete_command', module_completer, str_key = 'from') | |
2047 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2047 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') | |
2048 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2048 | self.set_hook('complete_command', cd_completer, str_key = '%cd') | |
2049 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2049 | self.set_hook('complete_command', reset_completer, str_key = '%reset') | |
2050 |
|
2050 | |||
2051 | # Only configure readline if we truly are using readline. IPython can |
|
2051 | # Only configure readline if we truly are using readline. IPython can | |
2052 | # do tab-completion over the network, in GUIs, etc, where readline |
|
2052 | # do tab-completion over the network, in GUIs, etc, where readline | |
2053 | # itself may be absent |
|
2053 | # itself may be absent | |
2054 | if self.has_readline: |
|
2054 | if self.has_readline: | |
2055 | self.set_readline_completer() |
|
2055 | self.set_readline_completer() | |
2056 |
|
2056 | |||
2057 | def complete(self, text, line=None, cursor_pos=None): |
|
2057 | def complete(self, text, line=None, cursor_pos=None): | |
2058 | """Return the completed text and a list of completions. |
|
2058 | """Return the completed text and a list of completions. | |
2059 |
|
2059 | |||
2060 | Parameters |
|
2060 | Parameters | |
2061 | ---------- |
|
2061 | ---------- | |
2062 |
|
2062 | |||
2063 | text : string |
|
2063 | text : string | |
2064 | A string of text to be completed on. It can be given as empty and |
|
2064 | A string of text to be completed on. It can be given as empty and | |
2065 | instead a line/position pair are given. In this case, the |
|
2065 | instead a line/position pair are given. In this case, the | |
2066 | completer itself will split the line like readline does. |
|
2066 | completer itself will split the line like readline does. | |
2067 |
|
2067 | |||
2068 | line : string, optional |
|
2068 | line : string, optional | |
2069 | The complete line that text is part of. |
|
2069 | The complete line that text is part of. | |
2070 |
|
2070 | |||
2071 | cursor_pos : int, optional |
|
2071 | cursor_pos : int, optional | |
2072 | The position of the cursor on the input line. |
|
2072 | The position of the cursor on the input line. | |
2073 |
|
2073 | |||
2074 | Returns |
|
2074 | Returns | |
2075 | ------- |
|
2075 | ------- | |
2076 | text : string |
|
2076 | text : string | |
2077 | The actual text that was completed. |
|
2077 | The actual text that was completed. | |
2078 |
|
2078 | |||
2079 | matches : list |
|
2079 | matches : list | |
2080 | A sorted list with all possible completions. |
|
2080 | A sorted list with all possible completions. | |
2081 |
|
2081 | |||
2082 | The optional arguments allow the completion to take more context into |
|
2082 | The optional arguments allow the completion to take more context into | |
2083 | account, and are part of the low-level completion API. |
|
2083 | account, and are part of the low-level completion API. | |
2084 |
|
2084 | |||
2085 | This is a wrapper around the completion mechanism, similar to what |
|
2085 | This is a wrapper around the completion mechanism, similar to what | |
2086 | readline does at the command line when the TAB key is hit. By |
|
2086 | readline does at the command line when the TAB key is hit. By | |
2087 | exposing it as a method, it can be used by other non-readline |
|
2087 | exposing it as a method, it can be used by other non-readline | |
2088 | environments (such as GUIs) for text completion. |
|
2088 | environments (such as GUIs) for text completion. | |
2089 |
|
2089 | |||
2090 | Simple usage example: |
|
2090 | Simple usage example: | |
2091 |
|
2091 | |||
2092 | In [1]: x = 'hello' |
|
2092 | In [1]: x = 'hello' | |
2093 |
|
2093 | |||
2094 | In [2]: _ip.complete('x.l') |
|
2094 | In [2]: _ip.complete('x.l') | |
2095 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2095 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) | |
2096 | """ |
|
2096 | """ | |
2097 |
|
2097 | |||
2098 | # Inject names into __builtin__ so we can complete on the added names. |
|
2098 | # Inject names into __builtin__ so we can complete on the added names. | |
2099 | with self.builtin_trap: |
|
2099 | with self.builtin_trap: | |
2100 | return self.Completer.complete(text, line, cursor_pos) |
|
2100 | return self.Completer.complete(text, line, cursor_pos) | |
2101 |
|
2101 | |||
2102 | def set_custom_completer(self, completer, pos=0): |
|
2102 | def set_custom_completer(self, completer, pos=0): | |
2103 | """Adds a new custom completer function. |
|
2103 | """Adds a new custom completer function. | |
2104 |
|
2104 | |||
2105 | The position argument (defaults to 0) is the index in the completers |
|
2105 | The position argument (defaults to 0) is the index in the completers | |
2106 | list where you want the completer to be inserted.""" |
|
2106 | list where you want the completer to be inserted.""" | |
2107 |
|
2107 | |||
2108 | newcomp = types.MethodType(completer,self.Completer) |
|
2108 | newcomp = types.MethodType(completer,self.Completer) | |
2109 | self.Completer.matchers.insert(pos,newcomp) |
|
2109 | self.Completer.matchers.insert(pos,newcomp) | |
2110 |
|
2110 | |||
2111 | def set_readline_completer(self): |
|
2111 | def set_readline_completer(self): | |
2112 | """Reset readline's completer to be our own.""" |
|
2112 | """Reset readline's completer to be our own.""" | |
2113 | self.readline.set_completer(self.Completer.rlcomplete) |
|
2113 | self.readline.set_completer(self.Completer.rlcomplete) | |
2114 |
|
2114 | |||
2115 | def set_completer_frame(self, frame=None): |
|
2115 | def set_completer_frame(self, frame=None): | |
2116 | """Set the frame of the completer.""" |
|
2116 | """Set the frame of the completer.""" | |
2117 | if frame: |
|
2117 | if frame: | |
2118 | self.Completer.namespace = frame.f_locals |
|
2118 | self.Completer.namespace = frame.f_locals | |
2119 | self.Completer.global_namespace = frame.f_globals |
|
2119 | self.Completer.global_namespace = frame.f_globals | |
2120 | else: |
|
2120 | else: | |
2121 | self.Completer.namespace = self.user_ns |
|
2121 | self.Completer.namespace = self.user_ns | |
2122 | self.Completer.global_namespace = self.user_global_ns |
|
2122 | self.Completer.global_namespace = self.user_global_ns | |
2123 |
|
2123 | |||
2124 | #------------------------------------------------------------------------- |
|
2124 | #------------------------------------------------------------------------- | |
2125 | # Things related to magics |
|
2125 | # Things related to magics | |
2126 | #------------------------------------------------------------------------- |
|
2126 | #------------------------------------------------------------------------- | |
2127 |
|
2127 | |||
2128 | def init_magics(self): |
|
2128 | def init_magics(self): | |
2129 | from IPython.core import magics as m |
|
2129 | from IPython.core import magics as m | |
2130 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2130 | self.magics_manager = magic.MagicsManager(shell=self, | |
2131 | parent=self, |
|
2131 | parent=self, | |
2132 | user_magics=m.UserMagics(self)) |
|
2132 | user_magics=m.UserMagics(self)) | |
2133 | self.configurables.append(self.magics_manager) |
|
2133 | self.configurables.append(self.magics_manager) | |
2134 |
|
2134 | |||
2135 | # Expose as public API from the magics manager |
|
2135 | # Expose as public API from the magics manager | |
2136 | self.register_magics = self.magics_manager.register |
|
2136 | self.register_magics = self.magics_manager.register | |
2137 | self.define_magic = self.magics_manager.define_magic |
|
2137 | self.define_magic = self.magics_manager.define_magic | |
2138 |
|
2138 | |||
2139 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2139 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, | |
2140 | m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2140 | m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics, | |
2141 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2141 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, | |
2142 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, |
|
2142 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, | |
2143 | ) |
|
2143 | ) | |
2144 |
|
2144 | |||
2145 | # Register Magic Aliases |
|
2145 | # Register Magic Aliases | |
2146 | mman = self.magics_manager |
|
2146 | mman = self.magics_manager | |
2147 | # FIXME: magic aliases should be defined by the Magics classes |
|
2147 | # FIXME: magic aliases should be defined by the Magics classes | |
2148 | # or in MagicsManager, not here |
|
2148 | # or in MagicsManager, not here | |
2149 | mman.register_alias('ed', 'edit') |
|
2149 | mman.register_alias('ed', 'edit') | |
2150 | mman.register_alias('hist', 'history') |
|
2150 | mman.register_alias('hist', 'history') | |
2151 | mman.register_alias('rep', 'recall') |
|
2151 | mman.register_alias('rep', 'recall') | |
2152 | mman.register_alias('SVG', 'svg', 'cell') |
|
2152 | mman.register_alias('SVG', 'svg', 'cell') | |
2153 | mman.register_alias('HTML', 'html', 'cell') |
|
2153 | mman.register_alias('HTML', 'html', 'cell') | |
2154 | mman.register_alias('file', 'writefile', 'cell') |
|
2154 | mman.register_alias('file', 'writefile', 'cell') | |
2155 |
|
2155 | |||
2156 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2156 | # FIXME: Move the color initialization to the DisplayHook, which | |
2157 | # should be split into a prompt manager and displayhook. We probably |
|
2157 | # should be split into a prompt manager and displayhook. We probably | |
2158 | # even need a centralize colors management object. |
|
2158 | # even need a centralize colors management object. | |
2159 | self.magic('colors %s' % self.colors) |
|
2159 | self.magic('colors %s' % self.colors) | |
2160 |
|
2160 | |||
2161 | # Defined here so that it's included in the documentation |
|
2161 | # Defined here so that it's included in the documentation | |
2162 | @functools.wraps(magic.MagicsManager.register_function) |
|
2162 | @functools.wraps(magic.MagicsManager.register_function) | |
2163 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2163 | def register_magic_function(self, func, magic_kind='line', magic_name=None): | |
2164 | self.magics_manager.register_function(func, |
|
2164 | self.magics_manager.register_function(func, | |
2165 | magic_kind=magic_kind, magic_name=magic_name) |
|
2165 | magic_kind=magic_kind, magic_name=magic_name) | |
2166 |
|
2166 | |||
2167 | def run_line_magic(self, magic_name, line): |
|
2167 | def run_line_magic(self, magic_name, line): | |
2168 | """Execute the given line magic. |
|
2168 | """Execute the given line magic. | |
2169 |
|
2169 | |||
2170 | Parameters |
|
2170 | Parameters | |
2171 | ---------- |
|
2171 | ---------- | |
2172 | magic_name : str |
|
2172 | magic_name : str | |
2173 | Name of the desired magic function, without '%' prefix. |
|
2173 | Name of the desired magic function, without '%' prefix. | |
2174 |
|
2174 | |||
2175 | line : str |
|
2175 | line : str | |
2176 | The rest of the input line as a single string. |
|
2176 | The rest of the input line as a single string. | |
2177 | """ |
|
2177 | """ | |
2178 | fn = self.find_line_magic(magic_name) |
|
2178 | fn = self.find_line_magic(magic_name) | |
2179 | if fn is None: |
|
2179 | if fn is None: | |
2180 | cm = self.find_cell_magic(magic_name) |
|
2180 | cm = self.find_cell_magic(magic_name) | |
2181 | etpl = "Line magic function `%%%s` not found%s." |
|
2181 | etpl = "Line magic function `%%%s` not found%s." | |
2182 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2182 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' | |
2183 | 'did you mean that instead?)' % magic_name ) |
|
2183 | 'did you mean that instead?)' % magic_name ) | |
2184 | error(etpl % (magic_name, extra)) |
|
2184 | error(etpl % (magic_name, extra)) | |
2185 | else: |
|
2185 | else: | |
2186 | # Note: this is the distance in the stack to the user's frame. |
|
2186 | # Note: this is the distance in the stack to the user's frame. | |
2187 | # This will need to be updated if the internal calling logic gets |
|
2187 | # This will need to be updated if the internal calling logic gets | |
2188 | # refactored, or else we'll be expanding the wrong variables. |
|
2188 | # refactored, or else we'll be expanding the wrong variables. | |
2189 | stack_depth = 2 |
|
2189 | stack_depth = 2 | |
2190 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2190 | magic_arg_s = self.var_expand(line, stack_depth) | |
2191 | # Put magic args in a list so we can call with f(*a) syntax |
|
2191 | # Put magic args in a list so we can call with f(*a) syntax | |
2192 | args = [magic_arg_s] |
|
2192 | args = [magic_arg_s] | |
2193 | kwargs = {} |
|
2193 | kwargs = {} | |
2194 | # Grab local namespace if we need it: |
|
2194 | # Grab local namespace if we need it: | |
2195 | if getattr(fn, "needs_local_scope", False): |
|
2195 | if getattr(fn, "needs_local_scope", False): | |
2196 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2196 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals | |
2197 | with self.builtin_trap: |
|
2197 | with self.builtin_trap: | |
2198 | result = fn(*args,**kwargs) |
|
2198 | result = fn(*args,**kwargs) | |
2199 | return result |
|
2199 | return result | |
2200 |
|
2200 | |||
2201 | def run_cell_magic(self, magic_name, line, cell): |
|
2201 | def run_cell_magic(self, magic_name, line, cell): | |
2202 | """Execute the given cell magic. |
|
2202 | """Execute the given cell magic. | |
2203 |
|
2203 | |||
2204 | Parameters |
|
2204 | Parameters | |
2205 | ---------- |
|
2205 | ---------- | |
2206 | magic_name : str |
|
2206 | magic_name : str | |
2207 | Name of the desired magic function, without '%' prefix. |
|
2207 | Name of the desired magic function, without '%' prefix. | |
2208 |
|
2208 | |||
2209 | line : str |
|
2209 | line : str | |
2210 | The rest of the first input line as a single string. |
|
2210 | The rest of the first input line as a single string. | |
2211 |
|
2211 | |||
2212 | cell : str |
|
2212 | cell : str | |
2213 | The body of the cell as a (possibly multiline) string. |
|
2213 | The body of the cell as a (possibly multiline) string. | |
2214 | """ |
|
2214 | """ | |
2215 | fn = self.find_cell_magic(magic_name) |
|
2215 | fn = self.find_cell_magic(magic_name) | |
2216 | if fn is None: |
|
2216 | if fn is None: | |
2217 | lm = self.find_line_magic(magic_name) |
|
2217 | lm = self.find_line_magic(magic_name) | |
2218 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2218 | etpl = "Cell magic `%%{0}` not found{1}." | |
2219 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2219 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' | |
2220 | 'did you mean that instead?)'.format(magic_name)) |
|
2220 | 'did you mean that instead?)'.format(magic_name)) | |
2221 | error(etpl.format(magic_name, extra)) |
|
2221 | error(etpl.format(magic_name, extra)) | |
2222 | elif cell == '': |
|
2222 | elif cell == '': | |
2223 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2223 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) | |
2224 | if self.find_line_magic(magic_name) is not None: |
|
2224 | if self.find_line_magic(magic_name) is not None: | |
2225 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2225 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) | |
2226 | raise UsageError(message) |
|
2226 | raise UsageError(message) | |
2227 | else: |
|
2227 | else: | |
2228 | # Note: this is the distance in the stack to the user's frame. |
|
2228 | # Note: this is the distance in the stack to the user's frame. | |
2229 | # This will need to be updated if the internal calling logic gets |
|
2229 | # This will need to be updated if the internal calling logic gets | |
2230 | # refactored, or else we'll be expanding the wrong variables. |
|
2230 | # refactored, or else we'll be expanding the wrong variables. | |
2231 | stack_depth = 2 |
|
2231 | stack_depth = 2 | |
2232 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2232 | magic_arg_s = self.var_expand(line, stack_depth) | |
2233 | with self.builtin_trap: |
|
2233 | with self.builtin_trap: | |
2234 | result = fn(magic_arg_s, cell) |
|
2234 | result = fn(magic_arg_s, cell) | |
2235 | return result |
|
2235 | return result | |
2236 |
|
2236 | |||
2237 | def find_line_magic(self, magic_name): |
|
2237 | def find_line_magic(self, magic_name): | |
2238 | """Find and return a line magic by name. |
|
2238 | """Find and return a line magic by name. | |
2239 |
|
2239 | |||
2240 | Returns None if the magic isn't found.""" |
|
2240 | Returns None if the magic isn't found.""" | |
2241 | return self.magics_manager.magics['line'].get(magic_name) |
|
2241 | return self.magics_manager.magics['line'].get(magic_name) | |
2242 |
|
2242 | |||
2243 | def find_cell_magic(self, magic_name): |
|
2243 | def find_cell_magic(self, magic_name): | |
2244 | """Find and return a cell magic by name. |
|
2244 | """Find and return a cell magic by name. | |
2245 |
|
2245 | |||
2246 | Returns None if the magic isn't found.""" |
|
2246 | Returns None if the magic isn't found.""" | |
2247 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2247 | return self.magics_manager.magics['cell'].get(magic_name) | |
2248 |
|
2248 | |||
2249 | def find_magic(self, magic_name, magic_kind='line'): |
|
2249 | def find_magic(self, magic_name, magic_kind='line'): | |
2250 | """Find and return a magic of the given type by name. |
|
2250 | """Find and return a magic of the given type by name. | |
2251 |
|
2251 | |||
2252 | Returns None if the magic isn't found.""" |
|
2252 | Returns None if the magic isn't found.""" | |
2253 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2253 | return self.magics_manager.magics[magic_kind].get(magic_name) | |
2254 |
|
2254 | |||
2255 | def magic(self, arg_s): |
|
2255 | def magic(self, arg_s): | |
2256 | """DEPRECATED. Use run_line_magic() instead. |
|
2256 | """DEPRECATED. Use run_line_magic() instead. | |
2257 |
|
2257 | |||
2258 | Call a magic function by name. |
|
2258 | Call a magic function by name. | |
2259 |
|
2259 | |||
2260 | Input: a string containing the name of the magic function to call and |
|
2260 | Input: a string containing the name of the magic function to call and | |
2261 | any additional arguments to be passed to the magic. |
|
2261 | any additional arguments to be passed to the magic. | |
2262 |
|
2262 | |||
2263 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2263 | magic('name -opt foo bar') is equivalent to typing at the ipython | |
2264 | prompt: |
|
2264 | prompt: | |
2265 |
|
2265 | |||
2266 | In[1]: %name -opt foo bar |
|
2266 | In[1]: %name -opt foo bar | |
2267 |
|
2267 | |||
2268 | To call a magic without arguments, simply use magic('name'). |
|
2268 | To call a magic without arguments, simply use magic('name'). | |
2269 |
|
2269 | |||
2270 | This provides a proper Python function to call IPython's magics in any |
|
2270 | This provides a proper Python function to call IPython's magics in any | |
2271 | valid Python code you can type at the interpreter, including loops and |
|
2271 | valid Python code you can type at the interpreter, including loops and | |
2272 | compound statements. |
|
2272 | compound statements. | |
2273 | """ |
|
2273 | """ | |
2274 | # TODO: should we issue a loud deprecation warning here? |
|
2274 | # TODO: should we issue a loud deprecation warning here? | |
2275 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2275 | magic_name, _, magic_arg_s = arg_s.partition(' ') | |
2276 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2276 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) | |
2277 | return self.run_line_magic(magic_name, magic_arg_s) |
|
2277 | return self.run_line_magic(magic_name, magic_arg_s) | |
2278 |
|
2278 | |||
2279 | #------------------------------------------------------------------------- |
|
2279 | #------------------------------------------------------------------------- | |
2280 | # Things related to macros |
|
2280 | # Things related to macros | |
2281 | #------------------------------------------------------------------------- |
|
2281 | #------------------------------------------------------------------------- | |
2282 |
|
2282 | |||
2283 | def define_macro(self, name, themacro): |
|
2283 | def define_macro(self, name, themacro): | |
2284 | """Define a new macro |
|
2284 | """Define a new macro | |
2285 |
|
2285 | |||
2286 | Parameters |
|
2286 | Parameters | |
2287 | ---------- |
|
2287 | ---------- | |
2288 | name : str |
|
2288 | name : str | |
2289 | The name of the macro. |
|
2289 | The name of the macro. | |
2290 | themacro : str or Macro |
|
2290 | themacro : str or Macro | |
2291 | The action to do upon invoking the macro. If a string, a new |
|
2291 | The action to do upon invoking the macro. If a string, a new | |
2292 | Macro object is created by passing the string to it. |
|
2292 | Macro object is created by passing the string to it. | |
2293 | """ |
|
2293 | """ | |
2294 |
|
2294 | |||
2295 | from IPython.core import macro |
|
2295 | from IPython.core import macro | |
2296 |
|
2296 | |||
2297 | if isinstance(themacro, string_types): |
|
2297 | if isinstance(themacro, string_types): | |
2298 | themacro = macro.Macro(themacro) |
|
2298 | themacro = macro.Macro(themacro) | |
2299 | if not isinstance(themacro, macro.Macro): |
|
2299 | if not isinstance(themacro, macro.Macro): | |
2300 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2300 | raise ValueError('A macro must be a string or a Macro instance.') | |
2301 | self.user_ns[name] = themacro |
|
2301 | self.user_ns[name] = themacro | |
2302 |
|
2302 | |||
2303 | #------------------------------------------------------------------------- |
|
2303 | #------------------------------------------------------------------------- | |
2304 | # Things related to the running of system commands |
|
2304 | # Things related to the running of system commands | |
2305 | #------------------------------------------------------------------------- |
|
2305 | #------------------------------------------------------------------------- | |
2306 |
|
2306 | |||
2307 | def system_piped(self, cmd): |
|
2307 | def system_piped(self, cmd): | |
2308 | """Call the given cmd in a subprocess, piping stdout/err |
|
2308 | """Call the given cmd in a subprocess, piping stdout/err | |
2309 |
|
2309 | |||
2310 | Parameters |
|
2310 | Parameters | |
2311 | ---------- |
|
2311 | ---------- | |
2312 | cmd : str |
|
2312 | cmd : str | |
2313 | Command to execute (can not end in '&', as background processes are |
|
2313 | Command to execute (can not end in '&', as background processes are | |
2314 | not supported. Should not be a command that expects input |
|
2314 | not supported. Should not be a command that expects input | |
2315 | other than simple text. |
|
2315 | other than simple text. | |
2316 | """ |
|
2316 | """ | |
2317 | if cmd.rstrip().endswith('&'): |
|
2317 | if cmd.rstrip().endswith('&'): | |
2318 | # this is *far* from a rigorous test |
|
2318 | # this is *far* from a rigorous test | |
2319 | # We do not support backgrounding processes because we either use |
|
2319 | # We do not support backgrounding processes because we either use | |
2320 | # pexpect or pipes to read from. Users can always just call |
|
2320 | # pexpect or pipes to read from. Users can always just call | |
2321 | # os.system() or use ip.system=ip.system_raw |
|
2321 | # os.system() or use ip.system=ip.system_raw | |
2322 | # if they really want a background process. |
|
2322 | # if they really want a background process. | |
2323 | raise OSError("Background processes not supported.") |
|
2323 | raise OSError("Background processes not supported.") | |
2324 |
|
2324 | |||
2325 | # we explicitly do NOT return the subprocess status code, because |
|
2325 | # we explicitly do NOT return the subprocess status code, because | |
2326 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2326 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2327 | # Instead, we store the exit_code in user_ns. |
|
2327 | # Instead, we store the exit_code in user_ns. | |
2328 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2328 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) | |
2329 |
|
2329 | |||
2330 | def system_raw(self, cmd): |
|
2330 | def system_raw(self, cmd): | |
2331 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2331 | """Call the given cmd in a subprocess using os.system on Windows or | |
2332 | subprocess.call using the system shell on other platforms. |
|
2332 | subprocess.call using the system shell on other platforms. | |
2333 |
|
2333 | |||
2334 | Parameters |
|
2334 | Parameters | |
2335 | ---------- |
|
2335 | ---------- | |
2336 | cmd : str |
|
2336 | cmd : str | |
2337 | Command to execute. |
|
2337 | Command to execute. | |
2338 | """ |
|
2338 | """ | |
2339 | cmd = self.var_expand(cmd, depth=1) |
|
2339 | cmd = self.var_expand(cmd, depth=1) | |
2340 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2340 | # protect os.system from UNC paths on Windows, which it can't handle: | |
2341 | if sys.platform == 'win32': |
|
2341 | if sys.platform == 'win32': | |
2342 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2342 | from IPython.utils._process_win32 import AvoidUNCPath | |
2343 | with AvoidUNCPath() as path: |
|
2343 | with AvoidUNCPath() as path: | |
2344 | if path is not None: |
|
2344 | if path is not None: | |
2345 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2345 | cmd = '"pushd %s &&"%s' % (path, cmd) | |
2346 | cmd = py3compat.unicode_to_str(cmd) |
|
2346 | cmd = py3compat.unicode_to_str(cmd) | |
2347 | ec = os.system(cmd) |
|
2347 | ec = os.system(cmd) | |
2348 | else: |
|
2348 | else: | |
2349 | cmd = py3compat.unicode_to_str(cmd) |
|
2349 | cmd = py3compat.unicode_to_str(cmd) | |
2350 | # Call the cmd using the OS shell, instead of the default /bin/sh, if set. |
|
2350 | # Call the cmd using the OS shell, instead of the default /bin/sh, if set. | |
2351 | ec = subprocess.call(cmd, shell=True, executable=os.environ.get('SHELL', None)) |
|
2351 | ec = subprocess.call(cmd, shell=True, executable=os.environ.get('SHELL', None)) | |
2352 | # exit code is positive for program failure, or negative for |
|
2352 | # exit code is positive for program failure, or negative for | |
2353 | # terminating signal number. |
|
2353 | # terminating signal number. | |
2354 |
|
2354 | |||
2355 | # Interpret ec > 128 as signal |
|
2355 | # Interpret ec > 128 as signal | |
2356 | # Some shells (csh, fish) don't follow sh/bash conventions for exit codes |
|
2356 | # Some shells (csh, fish) don't follow sh/bash conventions for exit codes | |
2357 | if ec > 128: |
|
2357 | if ec > 128: | |
2358 | ec = -(ec - 128) |
|
2358 | ec = -(ec - 128) | |
2359 |
|
2359 | |||
2360 | # We explicitly do NOT return the subprocess status code, because |
|
2360 | # We explicitly do NOT return the subprocess status code, because | |
2361 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2361 | # a non-None value would trigger :func:`sys.displayhook` calls. | |
2362 | # Instead, we store the exit_code in user_ns. |
|
2362 | # Instead, we store the exit_code in user_ns. | |
2363 | self.user_ns['_exit_code'] = ec |
|
2363 | self.user_ns['_exit_code'] = ec | |
2364 |
|
2364 | |||
2365 | # use piped system by default, because it is better behaved |
|
2365 | # use piped system by default, because it is better behaved | |
2366 | system = system_piped |
|
2366 | system = system_piped | |
2367 |
|
2367 | |||
2368 | def getoutput(self, cmd, split=True, depth=0): |
|
2368 | def getoutput(self, cmd, split=True, depth=0): | |
2369 | """Get output (possibly including stderr) from a subprocess. |
|
2369 | """Get output (possibly including stderr) from a subprocess. | |
2370 |
|
2370 | |||
2371 | Parameters |
|
2371 | Parameters | |
2372 | ---------- |
|
2372 | ---------- | |
2373 | cmd : str |
|
2373 | cmd : str | |
2374 | Command to execute (can not end in '&', as background processes are |
|
2374 | Command to execute (can not end in '&', as background processes are | |
2375 | not supported. |
|
2375 | not supported. | |
2376 | split : bool, optional |
|
2376 | split : bool, optional | |
2377 | If True, split the output into an IPython SList. Otherwise, an |
|
2377 | If True, split the output into an IPython SList. Otherwise, an | |
2378 | IPython LSString is returned. These are objects similar to normal |
|
2378 | IPython LSString is returned. These are objects similar to normal | |
2379 | lists and strings, with a few convenience attributes for easier |
|
2379 | lists and strings, with a few convenience attributes for easier | |
2380 | manipulation of line-based output. You can use '?' on them for |
|
2380 | manipulation of line-based output. You can use '?' on them for | |
2381 | details. |
|
2381 | details. | |
2382 | depth : int, optional |
|
2382 | depth : int, optional | |
2383 | How many frames above the caller are the local variables which should |
|
2383 | How many frames above the caller are the local variables which should | |
2384 | be expanded in the command string? The default (0) assumes that the |
|
2384 | be expanded in the command string? The default (0) assumes that the | |
2385 | expansion variables are in the stack frame calling this function. |
|
2385 | expansion variables are in the stack frame calling this function. | |
2386 | """ |
|
2386 | """ | |
2387 | if cmd.rstrip().endswith('&'): |
|
2387 | if cmd.rstrip().endswith('&'): | |
2388 | # this is *far* from a rigorous test |
|
2388 | # this is *far* from a rigorous test | |
2389 | raise OSError("Background processes not supported.") |
|
2389 | raise OSError("Background processes not supported.") | |
2390 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2390 | out = getoutput(self.var_expand(cmd, depth=depth+1)) | |
2391 | if split: |
|
2391 | if split: | |
2392 | out = SList(out.splitlines()) |
|
2392 | out = SList(out.splitlines()) | |
2393 | else: |
|
2393 | else: | |
2394 | out = LSString(out) |
|
2394 | out = LSString(out) | |
2395 | return out |
|
2395 | return out | |
2396 |
|
2396 | |||
2397 | #------------------------------------------------------------------------- |
|
2397 | #------------------------------------------------------------------------- | |
2398 | # Things related to aliases |
|
2398 | # Things related to aliases | |
2399 | #------------------------------------------------------------------------- |
|
2399 | #------------------------------------------------------------------------- | |
2400 |
|
2400 | |||
2401 | def init_alias(self): |
|
2401 | def init_alias(self): | |
2402 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2402 | self.alias_manager = AliasManager(shell=self, parent=self) | |
2403 | self.configurables.append(self.alias_manager) |
|
2403 | self.configurables.append(self.alias_manager) | |
2404 |
|
2404 | |||
2405 | #------------------------------------------------------------------------- |
|
2405 | #------------------------------------------------------------------------- | |
2406 | # Things related to extensions |
|
2406 | # Things related to extensions | |
2407 | #------------------------------------------------------------------------- |
|
2407 | #------------------------------------------------------------------------- | |
2408 |
|
2408 | |||
2409 | def init_extension_manager(self): |
|
2409 | def init_extension_manager(self): | |
2410 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2410 | self.extension_manager = ExtensionManager(shell=self, parent=self) | |
2411 | self.configurables.append(self.extension_manager) |
|
2411 | self.configurables.append(self.extension_manager) | |
2412 |
|
2412 | |||
2413 | #------------------------------------------------------------------------- |
|
2413 | #------------------------------------------------------------------------- | |
2414 | # Things related to payloads |
|
2414 | # Things related to payloads | |
2415 | #------------------------------------------------------------------------- |
|
2415 | #------------------------------------------------------------------------- | |
2416 |
|
2416 | |||
2417 | def init_payload(self): |
|
2417 | def init_payload(self): | |
2418 | self.payload_manager = PayloadManager(parent=self) |
|
2418 | self.payload_manager = PayloadManager(parent=self) | |
2419 | self.configurables.append(self.payload_manager) |
|
2419 | self.configurables.append(self.payload_manager) | |
2420 |
|
2420 | |||
2421 | #------------------------------------------------------------------------- |
|
2421 | #------------------------------------------------------------------------- | |
2422 | # Things related to widgets |
|
2422 | # Things related to widgets | |
2423 | #------------------------------------------------------------------------- |
|
2423 | #------------------------------------------------------------------------- | |
2424 |
|
2424 | |||
2425 | def init_comms(self): |
|
2425 | def init_comms(self): | |
2426 | # not implemented in the base class |
|
2426 | # not implemented in the base class | |
2427 | pass |
|
2427 | pass | |
2428 |
|
2428 | |||
2429 | #------------------------------------------------------------------------- |
|
2429 | #------------------------------------------------------------------------- | |
2430 | # Things related to the prefilter |
|
2430 | # Things related to the prefilter | |
2431 | #------------------------------------------------------------------------- |
|
2431 | #------------------------------------------------------------------------- | |
2432 |
|
2432 | |||
2433 | def init_prefilter(self): |
|
2433 | def init_prefilter(self): | |
2434 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2434 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) | |
2435 | self.configurables.append(self.prefilter_manager) |
|
2435 | self.configurables.append(self.prefilter_manager) | |
2436 | # Ultimately this will be refactored in the new interpreter code, but |
|
2436 | # Ultimately this will be refactored in the new interpreter code, but | |
2437 | # for now, we should expose the main prefilter method (there's legacy |
|
2437 | # for now, we should expose the main prefilter method (there's legacy | |
2438 | # code out there that may rely on this). |
|
2438 | # code out there that may rely on this). | |
2439 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2439 | self.prefilter = self.prefilter_manager.prefilter_lines | |
2440 |
|
2440 | |||
2441 | def auto_rewrite_input(self, cmd): |
|
2441 | def auto_rewrite_input(self, cmd): | |
2442 | """Print to the screen the rewritten form of the user's command. |
|
2442 | """Print to the screen the rewritten form of the user's command. | |
2443 |
|
2443 | |||
2444 | This shows visual feedback by rewriting input lines that cause |
|
2444 | This shows visual feedback by rewriting input lines that cause | |
2445 | automatic calling to kick in, like:: |
|
2445 | automatic calling to kick in, like:: | |
2446 |
|
2446 | |||
2447 | /f x |
|
2447 | /f x | |
2448 |
|
2448 | |||
2449 | into:: |
|
2449 | into:: | |
2450 |
|
2450 | |||
2451 | ------> f(x) |
|
2451 | ------> f(x) | |
2452 |
|
2452 | |||
2453 | after the user's input prompt. This helps the user understand that the |
|
2453 | after the user's input prompt. This helps the user understand that the | |
2454 | input line was transformed automatically by IPython. |
|
2454 | input line was transformed automatically by IPython. | |
2455 | """ |
|
2455 | """ | |
2456 | if not self.show_rewritten_input: |
|
2456 | if not self.show_rewritten_input: | |
2457 | return |
|
2457 | return | |
2458 |
|
2458 | |||
2459 | rw = self.prompt_manager.render('rewrite') + cmd |
|
2459 | rw = self.prompt_manager.render('rewrite') + cmd | |
2460 |
|
2460 | |||
2461 | try: |
|
2461 | try: | |
2462 | # plain ascii works better w/ pyreadline, on some machines, so |
|
2462 | # plain ascii works better w/ pyreadline, on some machines, so | |
2463 | # we use it and only print uncolored rewrite if we have unicode |
|
2463 | # we use it and only print uncolored rewrite if we have unicode | |
2464 | rw = str(rw) |
|
2464 | rw = str(rw) | |
2465 | print(rw, file=io.stdout) |
|
2465 | print(rw, file=io.stdout) | |
2466 | except UnicodeEncodeError: |
|
2466 | except UnicodeEncodeError: | |
2467 | print("------> " + cmd) |
|
2467 | print("------> " + cmd) | |
2468 |
|
2468 | |||
2469 | #------------------------------------------------------------------------- |
|
2469 | #------------------------------------------------------------------------- | |
2470 | # Things related to extracting values/expressions from kernel and user_ns |
|
2470 | # Things related to extracting values/expressions from kernel and user_ns | |
2471 | #------------------------------------------------------------------------- |
|
2471 | #------------------------------------------------------------------------- | |
2472 |
|
2472 | |||
2473 | def _user_obj_error(self): |
|
2473 | def _user_obj_error(self): | |
2474 | """return simple exception dict |
|
2474 | """return simple exception dict | |
2475 |
|
2475 | |||
2476 | for use in user_expressions |
|
2476 | for use in user_expressions | |
2477 | """ |
|
2477 | """ | |
2478 |
|
2478 | |||
2479 | etype, evalue, tb = self._get_exc_info() |
|
2479 | etype, evalue, tb = self._get_exc_info() | |
2480 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2480 | stb = self.InteractiveTB.get_exception_only(etype, evalue) | |
2481 |
|
2481 | |||
2482 | exc_info = { |
|
2482 | exc_info = { | |
2483 | u'status' : 'error', |
|
2483 | u'status' : 'error', | |
2484 | u'traceback' : stb, |
|
2484 | u'traceback' : stb, | |
2485 | u'ename' : unicode_type(etype.__name__), |
|
2485 | u'ename' : unicode_type(etype.__name__), | |
2486 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2486 | u'evalue' : py3compat.safe_unicode(evalue), | |
2487 | } |
|
2487 | } | |
2488 |
|
2488 | |||
2489 | return exc_info |
|
2489 | return exc_info | |
2490 |
|
2490 | |||
2491 | def _format_user_obj(self, obj): |
|
2491 | def _format_user_obj(self, obj): | |
2492 | """format a user object to display dict |
|
2492 | """format a user object to display dict | |
2493 |
|
2493 | |||
2494 | for use in user_expressions |
|
2494 | for use in user_expressions | |
2495 | """ |
|
2495 | """ | |
2496 |
|
2496 | |||
2497 | data, md = self.display_formatter.format(obj) |
|
2497 | data, md = self.display_formatter.format(obj) | |
2498 | value = { |
|
2498 | value = { | |
2499 | 'status' : 'ok', |
|
2499 | 'status' : 'ok', | |
2500 | 'data' : data, |
|
2500 | 'data' : data, | |
2501 | 'metadata' : md, |
|
2501 | 'metadata' : md, | |
2502 | } |
|
2502 | } | |
2503 | return value |
|
2503 | return value | |
2504 |
|
2504 | |||
2505 | def user_expressions(self, expressions): |
|
2505 | def user_expressions(self, expressions): | |
2506 | """Evaluate a dict of expressions in the user's namespace. |
|
2506 | """Evaluate a dict of expressions in the user's namespace. | |
2507 |
|
2507 | |||
2508 | Parameters |
|
2508 | Parameters | |
2509 | ---------- |
|
2509 | ---------- | |
2510 | expressions : dict |
|
2510 | expressions : dict | |
2511 | A dict with string keys and string values. The expression values |
|
2511 | A dict with string keys and string values. The expression values | |
2512 | should be valid Python expressions, each of which will be evaluated |
|
2512 | should be valid Python expressions, each of which will be evaluated | |
2513 | in the user namespace. |
|
2513 | in the user namespace. | |
2514 |
|
2514 | |||
2515 | Returns |
|
2515 | Returns | |
2516 | ------- |
|
2516 | ------- | |
2517 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2517 | A dict, keyed like the input expressions dict, with the rich mime-typed | |
2518 | display_data of each value. |
|
2518 | display_data of each value. | |
2519 | """ |
|
2519 | """ | |
2520 | out = {} |
|
2520 | out = {} | |
2521 | user_ns = self.user_ns |
|
2521 | user_ns = self.user_ns | |
2522 | global_ns = self.user_global_ns |
|
2522 | global_ns = self.user_global_ns | |
2523 |
|
2523 | |||
2524 | for key, expr in iteritems(expressions): |
|
2524 | for key, expr in iteritems(expressions): | |
2525 | try: |
|
2525 | try: | |
2526 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2526 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) | |
2527 | except: |
|
2527 | except: | |
2528 | value = self._user_obj_error() |
|
2528 | value = self._user_obj_error() | |
2529 | out[key] = value |
|
2529 | out[key] = value | |
2530 | return out |
|
2530 | return out | |
2531 |
|
2531 | |||
2532 | #------------------------------------------------------------------------- |
|
2532 | #------------------------------------------------------------------------- | |
2533 | # Things related to the running of code |
|
2533 | # Things related to the running of code | |
2534 | #------------------------------------------------------------------------- |
|
2534 | #------------------------------------------------------------------------- | |
2535 |
|
2535 | |||
2536 | def ex(self, cmd): |
|
2536 | def ex(self, cmd): | |
2537 | """Execute a normal python statement in user namespace.""" |
|
2537 | """Execute a normal python statement in user namespace.""" | |
2538 | with self.builtin_trap: |
|
2538 | with self.builtin_trap: | |
2539 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2539 | exec(cmd, self.user_global_ns, self.user_ns) | |
2540 |
|
2540 | |||
2541 | def ev(self, expr): |
|
2541 | def ev(self, expr): | |
2542 | """Evaluate python expression expr in user namespace. |
|
2542 | """Evaluate python expression expr in user namespace. | |
2543 |
|
2543 | |||
2544 | Returns the result of evaluation |
|
2544 | Returns the result of evaluation | |
2545 | """ |
|
2545 | """ | |
2546 | with self.builtin_trap: |
|
2546 | with self.builtin_trap: | |
2547 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2547 | return eval(expr, self.user_global_ns, self.user_ns) | |
2548 |
|
2548 | |||
2549 | def safe_execfile(self, fname, *where, **kw): |
|
2549 | def safe_execfile(self, fname, *where, **kw): | |
2550 | """A safe version of the builtin execfile(). |
|
2550 | """A safe version of the builtin execfile(). | |
2551 |
|
2551 | |||
2552 | This version will never throw an exception, but instead print |
|
2552 | This version will never throw an exception, but instead print | |
2553 | helpful error messages to the screen. This only works on pure |
|
2553 | helpful error messages to the screen. This only works on pure | |
2554 | Python files with the .py extension. |
|
2554 | Python files with the .py extension. | |
2555 |
|
2555 | |||
2556 | Parameters |
|
2556 | Parameters | |
2557 | ---------- |
|
2557 | ---------- | |
2558 | fname : string |
|
2558 | fname : string | |
2559 | The name of the file to be executed. |
|
2559 | The name of the file to be executed. | |
2560 | where : tuple |
|
2560 | where : tuple | |
2561 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2561 | One or two namespaces, passed to execfile() as (globals,locals). | |
2562 | If only one is given, it is passed as both. |
|
2562 | If only one is given, it is passed as both. | |
2563 | exit_ignore : bool (False) |
|
2563 | exit_ignore : bool (False) | |
2564 | If True, then silence SystemExit for non-zero status (it is always |
|
2564 | If True, then silence SystemExit for non-zero status (it is always | |
2565 | silenced for zero status, as it is so common). |
|
2565 | silenced for zero status, as it is so common). | |
2566 | raise_exceptions : bool (False) |
|
2566 | raise_exceptions : bool (False) | |
2567 | If True raise exceptions everywhere. Meant for testing. |
|
2567 | If True raise exceptions everywhere. Meant for testing. | |
2568 |
|
2568 | |||
2569 | """ |
|
2569 | """ | |
2570 | kw.setdefault('exit_ignore', False) |
|
2570 | kw.setdefault('exit_ignore', False) | |
2571 | kw.setdefault('raise_exceptions', False) |
|
2571 | kw.setdefault('raise_exceptions', False) | |
2572 |
|
2572 | |||
2573 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2573 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2574 |
|
2574 | |||
2575 | # Make sure we can open the file |
|
2575 | # Make sure we can open the file | |
2576 | try: |
|
2576 | try: | |
2577 | with open(fname) as thefile: |
|
2577 | with open(fname) as thefile: | |
2578 | pass |
|
2578 | pass | |
2579 | except: |
|
2579 | except: | |
2580 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2580 | warn('Could not open file <%s> for safe execution.' % fname) | |
2581 | return |
|
2581 | return | |
2582 |
|
2582 | |||
2583 | # Find things also in current directory. This is needed to mimic the |
|
2583 | # Find things also in current directory. This is needed to mimic the | |
2584 | # behavior of running a script from the system command line, where |
|
2584 | # behavior of running a script from the system command line, where | |
2585 | # Python inserts the script's directory into sys.path |
|
2585 | # Python inserts the script's directory into sys.path | |
2586 | dname = os.path.dirname(fname) |
|
2586 | dname = os.path.dirname(fname) | |
2587 |
|
2587 | |||
2588 | with prepended_to_syspath(dname): |
|
2588 | with prepended_to_syspath(dname): | |
2589 | try: |
|
2589 | try: | |
2590 | py3compat.execfile(fname,*where) |
|
2590 | py3compat.execfile(fname,*where) | |
2591 | except SystemExit as status: |
|
2591 | except SystemExit as status: | |
2592 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2592 | # If the call was made with 0 or None exit status (sys.exit(0) | |
2593 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2593 | # or sys.exit() ), don't bother showing a traceback, as both of | |
2594 | # these are considered normal by the OS: |
|
2594 | # these are considered normal by the OS: | |
2595 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2595 | # > python -c'import sys;sys.exit(0)'; echo $? | |
2596 | # 0 |
|
2596 | # 0 | |
2597 | # > python -c'import sys;sys.exit()'; echo $? |
|
2597 | # > python -c'import sys;sys.exit()'; echo $? | |
2598 | # 0 |
|
2598 | # 0 | |
2599 | # For other exit status, we show the exception unless |
|
2599 | # For other exit status, we show the exception unless | |
2600 | # explicitly silenced, but only in short form. |
|
2600 | # explicitly silenced, but only in short form. | |
2601 | if kw['raise_exceptions']: |
|
2601 | if kw['raise_exceptions']: | |
2602 | raise |
|
2602 | raise | |
2603 | if status.code and not kw['exit_ignore']: |
|
2603 | if status.code and not kw['exit_ignore']: | |
2604 | self.showtraceback(exception_only=True) |
|
2604 | self.showtraceback(exception_only=True) | |
2605 | except: |
|
2605 | except: | |
2606 | if kw['raise_exceptions']: |
|
2606 | if kw['raise_exceptions']: | |
2607 | raise |
|
2607 | raise | |
2608 | # tb offset is 2 because we wrap execfile |
|
2608 | # tb offset is 2 because we wrap execfile | |
2609 | self.showtraceback(tb_offset=2) |
|
2609 | self.showtraceback(tb_offset=2) | |
2610 |
|
2610 | |||
2611 | def safe_execfile_ipy(self, fname): |
|
2611 | def safe_execfile_ipy(self, fname): | |
2612 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2612 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. | |
2613 |
|
2613 | |||
2614 | Parameters |
|
2614 | Parameters | |
2615 | ---------- |
|
2615 | ---------- | |
2616 | fname : str |
|
2616 | fname : str | |
2617 | The name of the file to execute. The filename must have a |
|
2617 | The name of the file to execute. The filename must have a | |
2618 | .ipy or .ipynb extension. |
|
2618 | .ipy or .ipynb extension. | |
2619 | """ |
|
2619 | """ | |
2620 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2620 | fname = os.path.abspath(os.path.expanduser(fname)) | |
2621 |
|
2621 | |||
2622 | # Make sure we can open the file |
|
2622 | # Make sure we can open the file | |
2623 | try: |
|
2623 | try: | |
2624 | with open(fname) as thefile: |
|
2624 | with open(fname) as thefile: | |
2625 | pass |
|
2625 | pass | |
2626 | except: |
|
2626 | except: | |
2627 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2627 | warn('Could not open file <%s> for safe execution.' % fname) | |
2628 | return |
|
2628 | return | |
2629 |
|
2629 | |||
2630 | # Find things also in current directory. This is needed to mimic the |
|
2630 | # Find things also in current directory. This is needed to mimic the | |
2631 | # behavior of running a script from the system command line, where |
|
2631 | # behavior of running a script from the system command line, where | |
2632 | # Python inserts the script's directory into sys.path |
|
2632 | # Python inserts the script's directory into sys.path | |
2633 | dname = os.path.dirname(fname) |
|
2633 | dname = os.path.dirname(fname) | |
2634 |
|
2634 | |||
2635 | def get_cells(): |
|
2635 | def get_cells(): | |
2636 | """generator for sequence of code blocks to run""" |
|
2636 | """generator for sequence of code blocks to run""" | |
2637 | if fname.endswith('.ipynb'): |
|
2637 | if fname.endswith('.ipynb'): | |
2638 | from IPython.nbformat import current |
|
2638 | from IPython.nbformat import current | |
2639 | with open(fname) as f: |
|
2639 | with open(fname) as f: | |
2640 | nb = current.read(f, 'json') |
|
2640 | nb = current.read(f, 'json') | |
2641 | if not nb.worksheets: |
|
2641 | if not nb.worksheets: | |
2642 | return |
|
2642 | return | |
2643 | for cell in nb.worksheets[0].cells: |
|
2643 | for cell in nb.worksheets[0].cells: | |
2644 | if cell.cell_type == 'code': |
|
2644 | if cell.cell_type == 'code': | |
2645 | yield cell.input |
|
2645 | yield cell.input | |
2646 | else: |
|
2646 | else: | |
2647 | with open(fname) as f: |
|
2647 | with open(fname) as f: | |
2648 | yield f.read() |
|
2648 | yield f.read() | |
2649 |
|
2649 | |||
2650 | with prepended_to_syspath(dname): |
|
2650 | with prepended_to_syspath(dname): | |
2651 | try: |
|
2651 | try: | |
2652 | for cell in get_cells(): |
|
2652 | for cell in get_cells(): | |
2653 | # self.run_cell currently captures all exceptions |
|
2653 | # self.run_cell currently captures all exceptions | |
2654 | # raised in user code. It would be nice if there were |
|
2654 | # raised in user code. It would be nice if there were | |
2655 | # versions of run_cell that did raise, so |
|
2655 | # versions of run_cell that did raise, so | |
2656 | # we could catch the errors. |
|
2656 | # we could catch the errors. | |
2657 | self.run_cell(cell, silent=True, shell_futures=False) |
|
2657 | self.run_cell(cell, silent=True, shell_futures=False) | |
2658 | except: |
|
2658 | except: | |
2659 | self.showtraceback() |
|
2659 | self.showtraceback() | |
2660 | warn('Unknown failure executing file: <%s>' % fname) |
|
2660 | warn('Unknown failure executing file: <%s>' % fname) | |
2661 |
|
2661 | |||
2662 | def safe_run_module(self, mod_name, where): |
|
2662 | def safe_run_module(self, mod_name, where): | |
2663 | """A safe version of runpy.run_module(). |
|
2663 | """A safe version of runpy.run_module(). | |
2664 |
|
2664 | |||
2665 | This version will never throw an exception, but instead print |
|
2665 | This version will never throw an exception, but instead print | |
2666 | helpful error messages to the screen. |
|
2666 | helpful error messages to the screen. | |
2667 |
|
2667 | |||
2668 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2668 | `SystemExit` exceptions with status code 0 or None are ignored. | |
2669 |
|
2669 | |||
2670 | Parameters |
|
2670 | Parameters | |
2671 | ---------- |
|
2671 | ---------- | |
2672 | mod_name : string |
|
2672 | mod_name : string | |
2673 | The name of the module to be executed. |
|
2673 | The name of the module to be executed. | |
2674 | where : dict |
|
2674 | where : dict | |
2675 | The globals namespace. |
|
2675 | The globals namespace. | |
2676 | """ |
|
2676 | """ | |
2677 | try: |
|
2677 | try: | |
2678 | try: |
|
2678 | try: | |
2679 | where.update( |
|
2679 | where.update( | |
2680 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2680 | runpy.run_module(str(mod_name), run_name="__main__", | |
2681 | alter_sys=True) |
|
2681 | alter_sys=True) | |
2682 | ) |
|
2682 | ) | |
2683 | except SystemExit as status: |
|
2683 | except SystemExit as status: | |
2684 | if status.code: |
|
2684 | if status.code: | |
2685 | raise |
|
2685 | raise | |
2686 | except: |
|
2686 | except: | |
2687 | self.showtraceback() |
|
2687 | self.showtraceback() | |
2688 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2688 | warn('Unknown failure executing module: <%s>' % mod_name) | |
2689 |
|
2689 | |||
2690 | def _run_cached_cell_magic(self, magic_name, line): |
|
2690 | def _run_cached_cell_magic(self, magic_name, line): | |
2691 | """Special method to call a cell magic with the data stored in self. |
|
2691 | """Special method to call a cell magic with the data stored in self. | |
2692 | """ |
|
2692 | """ | |
2693 | cell = self._current_cell_magic_body |
|
2693 | cell = self._current_cell_magic_body | |
2694 | self._current_cell_magic_body = None |
|
2694 | self._current_cell_magic_body = None | |
2695 | return self.run_cell_magic(magic_name, line, cell) |
|
2695 | return self.run_cell_magic(magic_name, line, cell) | |
2696 |
|
2696 | |||
2697 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2697 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): | |
2698 | """Run a complete IPython cell. |
|
2698 | """Run a complete IPython cell. | |
2699 |
|
2699 | |||
2700 | Parameters |
|
2700 | Parameters | |
2701 | ---------- |
|
2701 | ---------- | |
2702 | raw_cell : str |
|
2702 | raw_cell : str | |
2703 | The code (including IPython code such as %magic functions) to run. |
|
2703 | The code (including IPython code such as %magic functions) to run. | |
2704 | store_history : bool |
|
2704 | store_history : bool | |
2705 | If True, the raw and translated cell will be stored in IPython's |
|
2705 | If True, the raw and translated cell will be stored in IPython's | |
2706 | history. For user code calling back into IPython's machinery, this |
|
2706 | history. For user code calling back into IPython's machinery, this | |
2707 | should be set to False. |
|
2707 | should be set to False. | |
2708 | silent : bool |
|
2708 | silent : bool | |
2709 | If True, avoid side-effects, such as implicit displayhooks and |
|
2709 | If True, avoid side-effects, such as implicit displayhooks and | |
2710 | and logging. silent=True forces store_history=False. |
|
2710 | and logging. silent=True forces store_history=False. | |
2711 | shell_futures : bool |
|
2711 | shell_futures : bool | |
2712 | If True, the code will share future statements with the interactive |
|
2712 | If True, the code will share future statements with the interactive | |
2713 | shell. It will both be affected by previous __future__ imports, and |
|
2713 | shell. It will both be affected by previous __future__ imports, and | |
2714 | any __future__ imports in the code will affect the shell. If False, |
|
2714 | any __future__ imports in the code will affect the shell. If False, | |
2715 | __future__ imports are not shared in either direction. |
|
2715 | __future__ imports are not shared in either direction. | |
2716 | """ |
|
2716 | """ | |
2717 | if (not raw_cell) or raw_cell.isspace(): |
|
2717 | if (not raw_cell) or raw_cell.isspace(): | |
2718 | return |
|
2718 | return | |
2719 |
|
2719 | |||
2720 | if silent: |
|
2720 | if silent: | |
2721 | store_history = False |
|
2721 | store_history = False | |
2722 |
|
2722 | |||
2723 | self.events.trigger('pre_execute') |
|
2723 | self.events.trigger('pre_execute') | |
2724 | if not silent: |
|
2724 | if not silent: | |
2725 | self.events.trigger('pre_run_cell') |
|
2725 | self.events.trigger('pre_run_cell') | |
2726 |
|
2726 | |||
2727 | # If any of our input transformation (input_transformer_manager or |
|
2727 | # If any of our input transformation (input_transformer_manager or | |
2728 | # prefilter_manager) raises an exception, we store it in this variable |
|
2728 | # prefilter_manager) raises an exception, we store it in this variable | |
2729 | # so that we can display the error after logging the input and storing |
|
2729 | # so that we can display the error after logging the input and storing | |
2730 | # it in the history. |
|
2730 | # it in the history. | |
2731 | preprocessing_exc_tuple = None |
|
2731 | preprocessing_exc_tuple = None | |
2732 | try: |
|
2732 | try: | |
2733 | # Static input transformations |
|
2733 | # Static input transformations | |
2734 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
2734 | cell = self.input_transformer_manager.transform_cell(raw_cell) | |
2735 | except SyntaxError: |
|
2735 | except SyntaxError: | |
2736 | preprocessing_exc_tuple = sys.exc_info() |
|
2736 | preprocessing_exc_tuple = sys.exc_info() | |
2737 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
2737 | cell = raw_cell # cell has to exist so it can be stored/logged | |
2738 | else: |
|
2738 | else: | |
2739 | if len(cell.splitlines()) == 1: |
|
2739 | if len(cell.splitlines()) == 1: | |
2740 | # Dynamic transformations - only applied for single line commands |
|
2740 | # Dynamic transformations - only applied for single line commands | |
2741 | with self.builtin_trap: |
|
2741 | with self.builtin_trap: | |
2742 | try: |
|
2742 | try: | |
2743 | # use prefilter_lines to handle trailing newlines |
|
2743 | # use prefilter_lines to handle trailing newlines | |
2744 | # restore trailing newline for ast.parse |
|
2744 | # restore trailing newline for ast.parse | |
2745 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2745 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' | |
2746 | except Exception: |
|
2746 | except Exception: | |
2747 | # don't allow prefilter errors to crash IPython |
|
2747 | # don't allow prefilter errors to crash IPython | |
2748 | preprocessing_exc_tuple = sys.exc_info() |
|
2748 | preprocessing_exc_tuple = sys.exc_info() | |
2749 |
|
2749 | |||
2750 | # Store raw and processed history |
|
2750 | # Store raw and processed history | |
2751 | if store_history: |
|
2751 | if store_history: | |
2752 | self.history_manager.store_inputs(self.execution_count, |
|
2752 | self.history_manager.store_inputs(self.execution_count, | |
2753 | cell, raw_cell) |
|
2753 | cell, raw_cell) | |
2754 | if not silent: |
|
2754 | if not silent: | |
2755 | self.logger.log(cell, raw_cell) |
|
2755 | self.logger.log(cell, raw_cell) | |
2756 |
|
2756 | |||
2757 | # Display the exception if input processing failed. |
|
2757 | # Display the exception if input processing failed. | |
2758 | if preprocessing_exc_tuple is not None: |
|
2758 | if preprocessing_exc_tuple is not None: | |
2759 | self.showtraceback(preprocessing_exc_tuple) |
|
2759 | self.showtraceback(preprocessing_exc_tuple) | |
2760 | if store_history: |
|
2760 | if store_history: | |
2761 | self.execution_count += 1 |
|
2761 | self.execution_count += 1 | |
2762 | return |
|
2762 | return | |
2763 |
|
2763 | |||
2764 | # Our own compiler remembers the __future__ environment. If we want to |
|
2764 | # Our own compiler remembers the __future__ environment. If we want to | |
2765 | # run code with a separate __future__ environment, use the default |
|
2765 | # run code with a separate __future__ environment, use the default | |
2766 | # compiler |
|
2766 | # compiler | |
2767 | compiler = self.compile if shell_futures else CachingCompiler() |
|
2767 | compiler = self.compile if shell_futures else CachingCompiler() | |
2768 |
|
2768 | |||
2769 | with self.builtin_trap: |
|
2769 | with self.builtin_trap: | |
2770 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2770 | cell_name = self.compile.cache(cell, self.execution_count) | |
2771 |
|
2771 | |||
2772 | with self.display_trap: |
|
2772 | with self.display_trap: | |
2773 | # Compile to bytecode |
|
2773 | # Compile to bytecode | |
2774 | try: |
|
2774 | try: | |
2775 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
2775 | code_ast = compiler.ast_parse(cell, filename=cell_name) | |
2776 | except IndentationError: |
|
2776 | except IndentationError: | |
2777 | self.showindentationerror() |
|
2777 | self.showindentationerror() | |
2778 | if store_history: |
|
2778 | if store_history: | |
2779 | self.execution_count += 1 |
|
2779 | self.execution_count += 1 | |
2780 | return None |
|
2780 | return None | |
2781 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2781 | except (OverflowError, SyntaxError, ValueError, TypeError, | |
2782 | MemoryError): |
|
2782 | MemoryError): | |
2783 | self.showsyntaxerror() |
|
2783 | self.showsyntaxerror() | |
2784 | if store_history: |
|
2784 | if store_history: | |
2785 | self.execution_count += 1 |
|
2785 | self.execution_count += 1 | |
2786 | return None |
|
2786 | return None | |
2787 |
|
2787 | |||
2788 | # Apply AST transformations |
|
2788 | # Apply AST transformations | |
2789 | try: |
|
2789 | try: | |
2790 | code_ast = self.transform_ast(code_ast) |
|
2790 | code_ast = self.transform_ast(code_ast) | |
2791 | except InputRejected: |
|
2791 | except InputRejected: | |
2792 | self.showtraceback() |
|
2792 | self.showtraceback() | |
2793 | if store_history: |
|
2793 | if store_history: | |
2794 | self.execution_count += 1 |
|
2794 | self.execution_count += 1 | |
2795 | return None |
|
2795 | return None | |
2796 |
|
2796 | |||
2797 | # Execute the user code |
|
2797 | # Execute the user code | |
2798 | interactivity = "none" if silent else self.ast_node_interactivity |
|
2798 | interactivity = "none" if silent else self.ast_node_interactivity | |
2799 | self.run_ast_nodes(code_ast.body, cell_name, |
|
2799 | self.run_ast_nodes(code_ast.body, cell_name, | |
2800 | interactivity=interactivity, compiler=compiler) |
|
2800 | interactivity=interactivity, compiler=compiler) | |
2801 |
|
2801 | |||
2802 | self.events.trigger('post_execute') |
|
2802 | self.events.trigger('post_execute') | |
2803 | if not silent: |
|
2803 | if not silent: | |
2804 | self.events.trigger('post_run_cell') |
|
2804 | self.events.trigger('post_run_cell') | |
2805 |
|
2805 | |||
2806 | if store_history: |
|
2806 | if store_history: | |
2807 | # Write output to the database. Does nothing unless |
|
2807 | # Write output to the database. Does nothing unless | |
2808 | # history output logging is enabled. |
|
2808 | # history output logging is enabled. | |
2809 | self.history_manager.store_output(self.execution_count) |
|
2809 | self.history_manager.store_output(self.execution_count) | |
2810 | # Each cell is a *single* input, regardless of how many lines it has |
|
2810 | # Each cell is a *single* input, regardless of how many lines it has | |
2811 | self.execution_count += 1 |
|
2811 | self.execution_count += 1 | |
2812 |
|
2812 | |||
2813 | def transform_ast(self, node): |
|
2813 | def transform_ast(self, node): | |
2814 | """Apply the AST transformations from self.ast_transformers |
|
2814 | """Apply the AST transformations from self.ast_transformers | |
2815 |
|
2815 | |||
2816 | Parameters |
|
2816 | Parameters | |
2817 | ---------- |
|
2817 | ---------- | |
2818 | node : ast.Node |
|
2818 | node : ast.Node | |
2819 | The root node to be transformed. Typically called with the ast.Module |
|
2819 | The root node to be transformed. Typically called with the ast.Module | |
2820 | produced by parsing user input. |
|
2820 | produced by parsing user input. | |
2821 |
|
2821 | |||
2822 | Returns |
|
2822 | Returns | |
2823 | ------- |
|
2823 | ------- | |
2824 | An ast.Node corresponding to the node it was called with. Note that it |
|
2824 | An ast.Node corresponding to the node it was called with. Note that it | |
2825 | may also modify the passed object, so don't rely on references to the |
|
2825 | may also modify the passed object, so don't rely on references to the | |
2826 | original AST. |
|
2826 | original AST. | |
2827 | """ |
|
2827 | """ | |
2828 | for transformer in self.ast_transformers: |
|
2828 | for transformer in self.ast_transformers: | |
2829 | try: |
|
2829 | try: | |
2830 | node = transformer.visit(node) |
|
2830 | node = transformer.visit(node) | |
2831 | except InputRejected: |
|
2831 | except InputRejected: | |
2832 | # User-supplied AST transformers can reject an input by raising |
|
2832 | # User-supplied AST transformers can reject an input by raising | |
2833 | # an InputRejected. Short-circuit in this case so that we |
|
2833 | # an InputRejected. Short-circuit in this case so that we | |
2834 | # don't unregister the transform. |
|
2834 | # don't unregister the transform. | |
2835 | raise |
|
2835 | raise | |
2836 | except Exception: |
|
2836 | except Exception: | |
2837 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
2837 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) | |
2838 | self.ast_transformers.remove(transformer) |
|
2838 | self.ast_transformers.remove(transformer) | |
2839 |
|
2839 | |||
2840 | if self.ast_transformers: |
|
2840 | if self.ast_transformers: | |
2841 | ast.fix_missing_locations(node) |
|
2841 | ast.fix_missing_locations(node) | |
2842 | return node |
|
2842 | return node | |
2843 |
|
2843 | |||
2844 |
|
2844 | |||
2845 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr', |
|
2845 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr', | |
2846 | compiler=compile): |
|
2846 | compiler=compile): | |
2847 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2847 | """Run a sequence of AST nodes. The execution mode depends on the | |
2848 | interactivity parameter. |
|
2848 | interactivity parameter. | |
2849 |
|
2849 | |||
2850 | Parameters |
|
2850 | Parameters | |
2851 | ---------- |
|
2851 | ---------- | |
2852 | nodelist : list |
|
2852 | nodelist : list | |
2853 | A sequence of AST nodes to run. |
|
2853 | A sequence of AST nodes to run. | |
2854 | cell_name : str |
|
2854 | cell_name : str | |
2855 | Will be passed to the compiler as the filename of the cell. Typically |
|
2855 | Will be passed to the compiler as the filename of the cell. Typically | |
2856 | the value returned by ip.compile.cache(cell). |
|
2856 | the value returned by ip.compile.cache(cell). | |
2857 | interactivity : str |
|
2857 | interactivity : str | |
2858 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2858 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be | |
2859 | run interactively (displaying output from expressions). 'last_expr' |
|
2859 | run interactively (displaying output from expressions). 'last_expr' | |
2860 | will run the last node interactively only if it is an expression (i.e. |
|
2860 | will run the last node interactively only if it is an expression (i.e. | |
2861 | expressions in loops or other blocks are not displayed. Other values |
|
2861 | expressions in loops or other blocks are not displayed. Other values | |
2862 | for this parameter will raise a ValueError. |
|
2862 | for this parameter will raise a ValueError. | |
2863 | compiler : callable |
|
2863 | compiler : callable | |
2864 | A function with the same interface as the built-in compile(), to turn |
|
2864 | A function with the same interface as the built-in compile(), to turn | |
2865 | the AST nodes into code objects. Default is the built-in compile(). |
|
2865 | the AST nodes into code objects. Default is the built-in compile(). | |
2866 | """ |
|
2866 | """ | |
2867 | if not nodelist: |
|
2867 | if not nodelist: | |
2868 | return |
|
2868 | return | |
2869 |
|
2869 | |||
2870 | if interactivity == 'last_expr': |
|
2870 | if interactivity == 'last_expr': | |
2871 | if isinstance(nodelist[-1], ast.Expr): |
|
2871 | if isinstance(nodelist[-1], ast.Expr): | |
2872 | interactivity = "last" |
|
2872 | interactivity = "last" | |
2873 | else: |
|
2873 | else: | |
2874 | interactivity = "none" |
|
2874 | interactivity = "none" | |
2875 |
|
2875 | |||
2876 | if interactivity == 'none': |
|
2876 | if interactivity == 'none': | |
2877 | to_run_exec, to_run_interactive = nodelist, [] |
|
2877 | to_run_exec, to_run_interactive = nodelist, [] | |
2878 | elif interactivity == 'last': |
|
2878 | elif interactivity == 'last': | |
2879 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2879 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] | |
2880 | elif interactivity == 'all': |
|
2880 | elif interactivity == 'all': | |
2881 | to_run_exec, to_run_interactive = [], nodelist |
|
2881 | to_run_exec, to_run_interactive = [], nodelist | |
2882 | else: |
|
2882 | else: | |
2883 | raise ValueError("Interactivity was %r" % interactivity) |
|
2883 | raise ValueError("Interactivity was %r" % interactivity) | |
2884 |
|
2884 | |||
2885 | exec_count = self.execution_count |
|
2885 | exec_count = self.execution_count | |
2886 |
|
2886 | |||
2887 | try: |
|
2887 | try: | |
2888 | for i, node in enumerate(to_run_exec): |
|
2888 | for i, node in enumerate(to_run_exec): | |
2889 | mod = ast.Module([node]) |
|
2889 | mod = ast.Module([node]) | |
2890 | code = compiler(mod, cell_name, "exec") |
|
2890 | code = compiler(mod, cell_name, "exec") | |
2891 | if self.run_code(code): |
|
2891 | if self.run_code(code): | |
2892 | return True |
|
2892 | return True | |
2893 |
|
2893 | |||
2894 | for i, node in enumerate(to_run_interactive): |
|
2894 | for i, node in enumerate(to_run_interactive): | |
2895 | mod = ast.Interactive([node]) |
|
2895 | mod = ast.Interactive([node]) | |
2896 | code = compiler(mod, cell_name, "single") |
|
2896 | code = compiler(mod, cell_name, "single") | |
2897 | if self.run_code(code): |
|
2897 | if self.run_code(code): | |
2898 | return True |
|
2898 | return True | |
2899 |
|
2899 | |||
2900 | # Flush softspace |
|
2900 | # Flush softspace | |
2901 | if softspace(sys.stdout, 0): |
|
2901 | if softspace(sys.stdout, 0): | |
2902 | print() |
|
2902 | print() | |
2903 |
|
2903 | |||
2904 | except: |
|
2904 | except: | |
2905 | # It's possible to have exceptions raised here, typically by |
|
2905 | # It's possible to have exceptions raised here, typically by | |
2906 | # compilation of odd code (such as a naked 'return' outside a |
|
2906 | # compilation of odd code (such as a naked 'return' outside a | |
2907 | # function) that did parse but isn't valid. Typically the exception |
|
2907 | # function) that did parse but isn't valid. Typically the exception | |
2908 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2908 | # is a SyntaxError, but it's safest just to catch anything and show | |
2909 | # the user a traceback. |
|
2909 | # the user a traceback. | |
2910 |
|
2910 | |||
2911 | # We do only one try/except outside the loop to minimize the impact |
|
2911 | # We do only one try/except outside the loop to minimize the impact | |
2912 | # on runtime, and also because if any node in the node list is |
|
2912 | # on runtime, and also because if any node in the node list is | |
2913 | # broken, we should stop execution completely. |
|
2913 | # broken, we should stop execution completely. | |
2914 | self.showtraceback() |
|
2914 | self.showtraceback() | |
2915 |
|
2915 | |||
2916 | return False |
|
2916 | return False | |
2917 |
|
2917 | |||
2918 | def run_code(self, code_obj): |
|
2918 | def run_code(self, code_obj): | |
2919 | """Execute a code object. |
|
2919 | """Execute a code object. | |
2920 |
|
2920 | |||
2921 | When an exception occurs, self.showtraceback() is called to display a |
|
2921 | When an exception occurs, self.showtraceback() is called to display a | |
2922 | traceback. |
|
2922 | traceback. | |
2923 |
|
2923 | |||
2924 | Parameters |
|
2924 | Parameters | |
2925 | ---------- |
|
2925 | ---------- | |
2926 | code_obj : code object |
|
2926 | code_obj : code object | |
2927 | A compiled code object, to be executed |
|
2927 | A compiled code object, to be executed | |
2928 |
|
2928 | |||
2929 | Returns |
|
2929 | Returns | |
2930 | ------- |
|
2930 | ------- | |
2931 | False : successful execution. |
|
2931 | False : successful execution. | |
2932 | True : an error occurred. |
|
2932 | True : an error occurred. | |
2933 | """ |
|
2933 | """ | |
2934 | # Set our own excepthook in case the user code tries to call it |
|
2934 | # Set our own excepthook in case the user code tries to call it | |
2935 | # directly, so that the IPython crash handler doesn't get triggered |
|
2935 | # directly, so that the IPython crash handler doesn't get triggered | |
2936 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
2936 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook | |
2937 |
|
2937 | |||
2938 | # we save the original sys.excepthook in the instance, in case config |
|
2938 | # we save the original sys.excepthook in the instance, in case config | |
2939 | # code (such as magics) needs access to it. |
|
2939 | # code (such as magics) needs access to it. | |
2940 | self.sys_excepthook = old_excepthook |
|
2940 | self.sys_excepthook = old_excepthook | |
2941 | outflag = 1 # happens in more places, so it's easier as default |
|
2941 | outflag = 1 # happens in more places, so it's easier as default | |
2942 | try: |
|
2942 | try: | |
2943 | try: |
|
2943 | try: | |
2944 | self.hooks.pre_run_code_hook() |
|
2944 | self.hooks.pre_run_code_hook() | |
2945 | #rprint('Running code', repr(code_obj)) # dbg |
|
2945 | #rprint('Running code', repr(code_obj)) # dbg | |
2946 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
2946 | exec(code_obj, self.user_global_ns, self.user_ns) | |
2947 | finally: |
|
2947 | finally: | |
2948 | # Reset our crash handler in place |
|
2948 | # Reset our crash handler in place | |
2949 | sys.excepthook = old_excepthook |
|
2949 | sys.excepthook = old_excepthook | |
2950 | except SystemExit: |
|
2950 | except SystemExit: | |
2951 | self.showtraceback(exception_only=True) |
|
2951 | self.showtraceback(exception_only=True) | |
2952 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) |
|
2952 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1) | |
2953 | except self.custom_exceptions: |
|
2953 | except self.custom_exceptions: | |
2954 | etype, value, tb = sys.exc_info() |
|
2954 | etype, value, tb = sys.exc_info() | |
2955 | self.CustomTB(etype, value, tb) |
|
2955 | self.CustomTB(etype, value, tb) | |
2956 | except: |
|
2956 | except: | |
2957 | self.showtraceback() |
|
2957 | self.showtraceback() | |
2958 | else: |
|
2958 | else: | |
2959 | outflag = 0 |
|
2959 | outflag = 0 | |
2960 | return outflag |
|
2960 | return outflag | |
2961 |
|
2961 | |||
2962 | # For backwards compatibility |
|
2962 | # For backwards compatibility | |
2963 | runcode = run_code |
|
2963 | runcode = run_code | |
2964 |
|
2964 | |||
2965 | #------------------------------------------------------------------------- |
|
2965 | #------------------------------------------------------------------------- | |
2966 | # Things related to GUI support and pylab |
|
2966 | # Things related to GUI support and pylab | |
2967 | #------------------------------------------------------------------------- |
|
2967 | #------------------------------------------------------------------------- | |
2968 |
|
2968 | |||
2969 | def enable_gui(self, gui=None): |
|
2969 | def enable_gui(self, gui=None): | |
2970 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
2970 | raise NotImplementedError('Implement enable_gui in a subclass') | |
2971 |
|
2971 | |||
2972 | def enable_matplotlib(self, gui=None): |
|
2972 | def enable_matplotlib(self, gui=None): | |
2973 | """Enable interactive matplotlib and inline figure support. |
|
2973 | """Enable interactive matplotlib and inline figure support. | |
2974 |
|
2974 | |||
2975 | This takes the following steps: |
|
2975 | This takes the following steps: | |
2976 |
|
2976 | |||
2977 | 1. select the appropriate eventloop and matplotlib backend |
|
2977 | 1. select the appropriate eventloop and matplotlib backend | |
2978 | 2. set up matplotlib for interactive use with that backend |
|
2978 | 2. set up matplotlib for interactive use with that backend | |
2979 | 3. configure formatters for inline figure display |
|
2979 | 3. configure formatters for inline figure display | |
2980 | 4. enable the selected gui eventloop |
|
2980 | 4. enable the selected gui eventloop | |
2981 |
|
2981 | |||
2982 | Parameters |
|
2982 | Parameters | |
2983 | ---------- |
|
2983 | ---------- | |
2984 | gui : optional, string |
|
2984 | gui : optional, string | |
2985 | If given, dictates the choice of matplotlib GUI backend to use |
|
2985 | If given, dictates the choice of matplotlib GUI backend to use | |
2986 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2986 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
2987 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2987 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
2988 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2988 | matplotlib (as dictated by the matplotlib build-time options plus the | |
2989 | user's matplotlibrc configuration file). Note that not all backends |
|
2989 | user's matplotlibrc configuration file). Note that not all backends | |
2990 | make sense in all contexts, for example a terminal ipython can't |
|
2990 | make sense in all contexts, for example a terminal ipython can't | |
2991 | display figures inline. |
|
2991 | display figures inline. | |
2992 | """ |
|
2992 | """ | |
2993 | from IPython.core import pylabtools as pt |
|
2993 | from IPython.core import pylabtools as pt | |
2994 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
2994 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) | |
2995 |
|
2995 | |||
2996 | if gui != 'inline': |
|
2996 | if gui != 'inline': | |
2997 | # If we have our first gui selection, store it |
|
2997 | # If we have our first gui selection, store it | |
2998 | if self.pylab_gui_select is None: |
|
2998 | if self.pylab_gui_select is None: | |
2999 | self.pylab_gui_select = gui |
|
2999 | self.pylab_gui_select = gui | |
3000 | # Otherwise if they are different |
|
3000 | # Otherwise if they are different | |
3001 | elif gui != self.pylab_gui_select: |
|
3001 | elif gui != self.pylab_gui_select: | |
3002 | print ('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3002 | print ('Warning: Cannot change to a different GUI toolkit: %s.' | |
3003 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3003 | ' Using %s instead.' % (gui, self.pylab_gui_select)) | |
3004 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3004 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) | |
3005 |
|
3005 | |||
3006 | pt.activate_matplotlib(backend) |
|
3006 | pt.activate_matplotlib(backend) | |
3007 | pt.configure_inline_support(self, backend) |
|
3007 | pt.configure_inline_support(self, backend) | |
3008 |
|
3008 | |||
3009 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3009 | # Now we must activate the gui pylab wants to use, and fix %run to take | |
3010 | # plot updates into account |
|
3010 | # plot updates into account | |
3011 | self.enable_gui(gui) |
|
3011 | self.enable_gui(gui) | |
3012 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3012 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ | |
3013 | pt.mpl_runner(self.safe_execfile) |
|
3013 | pt.mpl_runner(self.safe_execfile) | |
3014 |
|
3014 | |||
3015 | return gui, backend |
|
3015 | return gui, backend | |
3016 |
|
3016 | |||
3017 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3017 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): | |
3018 | """Activate pylab support at runtime. |
|
3018 | """Activate pylab support at runtime. | |
3019 |
|
3019 | |||
3020 | This turns on support for matplotlib, preloads into the interactive |
|
3020 | This turns on support for matplotlib, preloads into the interactive | |
3021 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3021 | namespace all of numpy and pylab, and configures IPython to correctly | |
3022 | interact with the GUI event loop. The GUI backend to be used can be |
|
3022 | interact with the GUI event loop. The GUI backend to be used can be | |
3023 | optionally selected with the optional ``gui`` argument. |
|
3023 | optionally selected with the optional ``gui`` argument. | |
3024 |
|
3024 | |||
3025 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3025 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. | |
3026 |
|
3026 | |||
3027 | Parameters |
|
3027 | Parameters | |
3028 | ---------- |
|
3028 | ---------- | |
3029 | gui : optional, string |
|
3029 | gui : optional, string | |
3030 | If given, dictates the choice of matplotlib GUI backend to use |
|
3030 | If given, dictates the choice of matplotlib GUI backend to use | |
3031 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3031 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', | |
3032 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3032 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by | |
3033 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3033 | matplotlib (as dictated by the matplotlib build-time options plus the | |
3034 | user's matplotlibrc configuration file). Note that not all backends |
|
3034 | user's matplotlibrc configuration file). Note that not all backends | |
3035 | make sense in all contexts, for example a terminal ipython can't |
|
3035 | make sense in all contexts, for example a terminal ipython can't | |
3036 | display figures inline. |
|
3036 | display figures inline. | |
3037 | import_all : optional, bool, default: True |
|
3037 | import_all : optional, bool, default: True | |
3038 | Whether to do `from numpy import *` and `from pylab import *` |
|
3038 | Whether to do `from numpy import *` and `from pylab import *` | |
3039 | in addition to module imports. |
|
3039 | in addition to module imports. | |
3040 | welcome_message : deprecated |
|
3040 | welcome_message : deprecated | |
3041 | This argument is ignored, no welcome message will be displayed. |
|
3041 | This argument is ignored, no welcome message will be displayed. | |
3042 | """ |
|
3042 | """ | |
3043 | from IPython.core.pylabtools import import_pylab |
|
3043 | from IPython.core.pylabtools import import_pylab | |
3044 |
|
3044 | |||
3045 | gui, backend = self.enable_matplotlib(gui) |
|
3045 | gui, backend = self.enable_matplotlib(gui) | |
3046 |
|
3046 | |||
3047 | # We want to prevent the loading of pylab to pollute the user's |
|
3047 | # We want to prevent the loading of pylab to pollute the user's | |
3048 | # namespace as shown by the %who* magics, so we execute the activation |
|
3048 | # namespace as shown by the %who* magics, so we execute the activation | |
3049 | # code in an empty namespace, and we update *both* user_ns and |
|
3049 | # code in an empty namespace, and we update *both* user_ns and | |
3050 | # user_ns_hidden with this information. |
|
3050 | # user_ns_hidden with this information. | |
3051 | ns = {} |
|
3051 | ns = {} | |
3052 | import_pylab(ns, import_all) |
|
3052 | import_pylab(ns, import_all) | |
3053 | # warn about clobbered names |
|
3053 | # warn about clobbered names | |
3054 | ignored = set(["__builtins__"]) |
|
3054 | ignored = set(["__builtins__"]) | |
3055 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3055 | both = set(ns).intersection(self.user_ns).difference(ignored) | |
3056 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3056 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] | |
3057 | self.user_ns.update(ns) |
|
3057 | self.user_ns.update(ns) | |
3058 | self.user_ns_hidden.update(ns) |
|
3058 | self.user_ns_hidden.update(ns) | |
3059 | return gui, backend, clobbered |
|
3059 | return gui, backend, clobbered | |
3060 |
|
3060 | |||
3061 | #------------------------------------------------------------------------- |
|
3061 | #------------------------------------------------------------------------- | |
3062 | # Utilities |
|
3062 | # Utilities | |
3063 | #------------------------------------------------------------------------- |
|
3063 | #------------------------------------------------------------------------- | |
3064 |
|
3064 | |||
3065 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3065 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): | |
3066 | """Expand python variables in a string. |
|
3066 | """Expand python variables in a string. | |
3067 |
|
3067 | |||
3068 | The depth argument indicates how many frames above the caller should |
|
3068 | The depth argument indicates how many frames above the caller should | |
3069 | be walked to look for the local namespace where to expand variables. |
|
3069 | be walked to look for the local namespace where to expand variables. | |
3070 |
|
3070 | |||
3071 | The global namespace for expansion is always the user's interactive |
|
3071 | The global namespace for expansion is always the user's interactive | |
3072 | namespace. |
|
3072 | namespace. | |
3073 | """ |
|
3073 | """ | |
3074 | ns = self.user_ns.copy() |
|
3074 | ns = self.user_ns.copy() | |
3075 | ns.update(sys._getframe(depth+1).f_locals) |
|
3075 | ns.update(sys._getframe(depth+1).f_locals) | |
3076 | try: |
|
3076 | try: | |
3077 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3077 | # We have to use .vformat() here, because 'self' is a valid and common | |
3078 | # name, and expanding **ns for .format() would make it collide with |
|
3078 | # name, and expanding **ns for .format() would make it collide with | |
3079 | # the 'self' argument of the method. |
|
3079 | # the 'self' argument of the method. | |
3080 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3080 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) | |
3081 | except Exception: |
|
3081 | except Exception: | |
3082 | # if formatter couldn't format, just let it go untransformed |
|
3082 | # if formatter couldn't format, just let it go untransformed | |
3083 | pass |
|
3083 | pass | |
3084 | return cmd |
|
3084 | return cmd | |
3085 |
|
3085 | |||
3086 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3086 | def mktempfile(self, data=None, prefix='ipython_edit_'): | |
3087 | """Make a new tempfile and return its filename. |
|
3087 | """Make a new tempfile and return its filename. | |
3088 |
|
3088 | |||
3089 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3089 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), | |
3090 | but it registers the created filename internally so ipython cleans it up |
|
3090 | but it registers the created filename internally so ipython cleans it up | |
3091 | at exit time. |
|
3091 | at exit time. | |
3092 |
|
3092 | |||
3093 | Optional inputs: |
|
3093 | Optional inputs: | |
3094 |
|
3094 | |||
3095 | - data(None): if data is given, it gets written out to the temp file |
|
3095 | - data(None): if data is given, it gets written out to the temp file | |
3096 | immediately, and the file is closed again.""" |
|
3096 | immediately, and the file is closed again.""" | |
3097 |
|
3097 | |||
3098 | dirname = tempfile.mkdtemp(prefix=prefix) |
|
3098 | dirname = tempfile.mkdtemp(prefix=prefix) | |
3099 | self.tempdirs.append(dirname) |
|
3099 | self.tempdirs.append(dirname) | |
3100 |
|
3100 | |||
3101 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) |
|
3101 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) | |
3102 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3102 | os.close(handle) # On Windows, there can only be one open handle on a file | |
3103 | self.tempfiles.append(filename) |
|
3103 | self.tempfiles.append(filename) | |
3104 |
|
3104 | |||
3105 | if data: |
|
3105 | if data: | |
3106 | tmp_file = open(filename,'w') |
|
3106 | tmp_file = open(filename,'w') | |
3107 | tmp_file.write(data) |
|
3107 | tmp_file.write(data) | |
3108 | tmp_file.close() |
|
3108 | tmp_file.close() | |
3109 | return filename |
|
3109 | return filename | |
3110 |
|
3110 | |||
3111 | # TODO: This should be removed when Term is refactored. |
|
3111 | # TODO: This should be removed when Term is refactored. | |
3112 | def write(self,data): |
|
3112 | def write(self,data): | |
3113 | """Write a string to the default output""" |
|
3113 | """Write a string to the default output""" | |
3114 | io.stdout.write(data) |
|
3114 | io.stdout.write(data) | |
3115 |
|
3115 | |||
3116 | # TODO: This should be removed when Term is refactored. |
|
3116 | # TODO: This should be removed when Term is refactored. | |
3117 | def write_err(self,data): |
|
3117 | def write_err(self,data): | |
3118 | """Write a string to the default error output""" |
|
3118 | """Write a string to the default error output""" | |
3119 | io.stderr.write(data) |
|
3119 | io.stderr.write(data) | |
3120 |
|
3120 | |||
3121 | def ask_yes_no(self, prompt, default=None): |
|
3121 | def ask_yes_no(self, prompt, default=None): | |
3122 | if self.quiet: |
|
3122 | if self.quiet: | |
3123 | return True |
|
3123 | return True | |
3124 | return ask_yes_no(prompt,default) |
|
3124 | return ask_yes_no(prompt,default) | |
3125 |
|
3125 | |||
3126 | def show_usage(self): |
|
3126 | def show_usage(self): | |
3127 | """Show a usage message""" |
|
3127 | """Show a usage message""" | |
3128 | page.page(IPython.core.usage.interactive_usage) |
|
3128 | page.page(IPython.core.usage.interactive_usage) | |
3129 |
|
3129 | |||
3130 | def extract_input_lines(self, range_str, raw=False): |
|
3130 | def extract_input_lines(self, range_str, raw=False): | |
3131 | """Return as a string a set of input history slices. |
|
3131 | """Return as a string a set of input history slices. | |
3132 |
|
3132 | |||
3133 | Parameters |
|
3133 | Parameters | |
3134 | ---------- |
|
3134 | ---------- | |
3135 | range_str : string |
|
3135 | range_str : string | |
3136 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3136 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", | |
3137 | since this function is for use by magic functions which get their |
|
3137 | since this function is for use by magic functions which get their | |
3138 | arguments as strings. The number before the / is the session |
|
3138 | arguments as strings. The number before the / is the session | |
3139 | number: ~n goes n back from the current session. |
|
3139 | number: ~n goes n back from the current session. | |
3140 |
|
3140 | |||
3141 | raw : bool, optional |
|
3141 | raw : bool, optional | |
3142 | By default, the processed input is used. If this is true, the raw |
|
3142 | By default, the processed input is used. If this is true, the raw | |
3143 | input history is used instead. |
|
3143 | input history is used instead. | |
3144 |
|
3144 | |||
3145 | Notes |
|
3145 | Notes | |
3146 | ----- |
|
3146 | ----- | |
3147 |
|
3147 | |||
3148 | Slices can be described with two notations: |
|
3148 | Slices can be described with two notations: | |
3149 |
|
3149 | |||
3150 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3150 | * ``N:M`` -> standard python form, means including items N...(M-1). | |
3151 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3151 | * ``N-M`` -> include items N..M (closed endpoint). | |
3152 | """ |
|
3152 | """ | |
3153 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3153 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) | |
3154 | return "\n".join(x for _, _, x in lines) |
|
3154 | return "\n".join(x for _, _, x in lines) | |
3155 |
|
3155 | |||
3156 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3156 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): | |
3157 | """Get a code string from history, file, url, or a string or macro. |
|
3157 | """Get a code string from history, file, url, or a string or macro. | |
3158 |
|
3158 | |||
3159 | This is mainly used by magic functions. |
|
3159 | This is mainly used by magic functions. | |
3160 |
|
3160 | |||
3161 | Parameters |
|
3161 | Parameters | |
3162 | ---------- |
|
3162 | ---------- | |
3163 |
|
3163 | |||
3164 | target : str |
|
3164 | target : str | |
3165 |
|
3165 | |||
3166 | A string specifying code to retrieve. This will be tried respectively |
|
3166 | A string specifying code to retrieve. This will be tried respectively | |
3167 | as: ranges of input history (see %history for syntax), url, |
|
3167 | as: ranges of input history (see %history for syntax), url, | |
3168 | correspnding .py file, filename, or an expression evaluating to a |
|
3168 | correspnding .py file, filename, or an expression evaluating to a | |
3169 | string or Macro in the user namespace. |
|
3169 | string or Macro in the user namespace. | |
3170 |
|
3170 | |||
3171 | raw : bool |
|
3171 | raw : bool | |
3172 | If true (default), retrieve raw history. Has no effect on the other |
|
3172 | If true (default), retrieve raw history. Has no effect on the other | |
3173 | retrieval mechanisms. |
|
3173 | retrieval mechanisms. | |
3174 |
|
3174 | |||
3175 | py_only : bool (default False) |
|
3175 | py_only : bool (default False) | |
3176 | Only try to fetch python code, do not try alternative methods to decode file |
|
3176 | Only try to fetch python code, do not try alternative methods to decode file | |
3177 | if unicode fails. |
|
3177 | if unicode fails. | |
3178 |
|
3178 | |||
3179 | Returns |
|
3179 | Returns | |
3180 | ------- |
|
3180 | ------- | |
3181 | A string of code. |
|
3181 | A string of code. | |
3182 |
|
3182 | |||
3183 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3183 | ValueError is raised if nothing is found, and TypeError if it evaluates | |
3184 | to an object of another type. In each case, .args[0] is a printable |
|
3184 | to an object of another type. In each case, .args[0] is a printable | |
3185 | message. |
|
3185 | message. | |
3186 | """ |
|
3186 | """ | |
3187 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3187 | code = self.extract_input_lines(target, raw=raw) # Grab history | |
3188 | if code: |
|
3188 | if code: | |
3189 | return code |
|
3189 | return code | |
3190 | utarget = unquote_filename(target) |
|
3190 | utarget = unquote_filename(target) | |
3191 | try: |
|
3191 | try: | |
3192 | if utarget.startswith(('http://', 'https://')): |
|
3192 | if utarget.startswith(('http://', 'https://')): | |
3193 | return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie) |
|
3193 | return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie) | |
3194 | except UnicodeDecodeError: |
|
3194 | except UnicodeDecodeError: | |
3195 | if not py_only : |
|
3195 | if not py_only : | |
3196 | # Deferred import |
|
3196 | # Deferred import | |
3197 | try: |
|
3197 | try: | |
3198 | from urllib.request import urlopen # Py3 |
|
3198 | from urllib.request import urlopen # Py3 | |
3199 | except ImportError: |
|
3199 | except ImportError: | |
3200 | from urllib import urlopen |
|
3200 | from urllib import urlopen | |
3201 | response = urlopen(target) |
|
3201 | response = urlopen(target) | |
3202 | return response.read().decode('latin1') |
|
3202 | return response.read().decode('latin1') | |
3203 | raise ValueError(("'%s' seem to be unreadable.") % utarget) |
|
3203 | raise ValueError(("'%s' seem to be unreadable.") % utarget) | |
3204 |
|
3204 | |||
3205 | potential_target = [target] |
|
3205 | potential_target = [target] | |
3206 | try : |
|
3206 | try : | |
3207 | potential_target.insert(0,get_py_filename(target)) |
|
3207 | potential_target.insert(0,get_py_filename(target)) | |
3208 | except IOError: |
|
3208 | except IOError: | |
3209 | pass |
|
3209 | pass | |
3210 |
|
3210 | |||
3211 | for tgt in potential_target : |
|
3211 | for tgt in potential_target : | |
3212 | if os.path.isfile(tgt): # Read file |
|
3212 | if os.path.isfile(tgt): # Read file | |
3213 | try : |
|
3213 | try : | |
3214 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3214 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) | |
3215 | except UnicodeDecodeError : |
|
3215 | except UnicodeDecodeError : | |
3216 | if not py_only : |
|
3216 | if not py_only : | |
3217 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3217 | with io_open(tgt,'r', encoding='latin1') as f : | |
3218 | return f.read() |
|
3218 | return f.read() | |
3219 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3219 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
3220 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3220 | elif os.path.isdir(os.path.expanduser(tgt)): | |
3221 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3221 | raise ValueError("'%s' is a directory, not a regular file." % target) | |
3222 |
|
3222 | |||
3223 | if search_ns: |
|
3223 | if search_ns: | |
3224 | # Inspect namespace to load object source |
|
3224 | # Inspect namespace to load object source | |
3225 | object_info = self.object_inspect(target, detail_level=1) |
|
3225 | object_info = self.object_inspect(target, detail_level=1) | |
3226 | if object_info['found'] and object_info['source']: |
|
3226 | if object_info['found'] and object_info['source']: | |
3227 | return object_info['source'] |
|
3227 | return object_info['source'] | |
3228 |
|
3228 | |||
3229 | try: # User namespace |
|
3229 | try: # User namespace | |
3230 | codeobj = eval(target, self.user_ns) |
|
3230 | codeobj = eval(target, self.user_ns) | |
3231 | except Exception: |
|
3231 | except Exception: | |
3232 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3232 | raise ValueError(("'%s' was not found in history, as a file, url, " | |
3233 | "nor in the user namespace.") % target) |
|
3233 | "nor in the user namespace.") % target) | |
3234 |
|
3234 | |||
3235 | if isinstance(codeobj, string_types): |
|
3235 | if isinstance(codeobj, string_types): | |
3236 | return codeobj |
|
3236 | return codeobj | |
3237 | elif isinstance(codeobj, Macro): |
|
3237 | elif isinstance(codeobj, Macro): | |
3238 | return codeobj.value |
|
3238 | return codeobj.value | |
3239 |
|
3239 | |||
3240 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3240 | raise TypeError("%s is neither a string nor a macro." % target, | |
3241 | codeobj) |
|
3241 | codeobj) | |
3242 |
|
3242 | |||
3243 | #------------------------------------------------------------------------- |
|
3243 | #------------------------------------------------------------------------- | |
3244 | # Things related to IPython exiting |
|
3244 | # Things related to IPython exiting | |
3245 | #------------------------------------------------------------------------- |
|
3245 | #------------------------------------------------------------------------- | |
3246 | def atexit_operations(self): |
|
3246 | def atexit_operations(self): | |
3247 | """This will be executed at the time of exit. |
|
3247 | """This will be executed at the time of exit. | |
3248 |
|
3248 | |||
3249 | Cleanup operations and saving of persistent data that is done |
|
3249 | Cleanup operations and saving of persistent data that is done | |
3250 | unconditionally by IPython should be performed here. |
|
3250 | unconditionally by IPython should be performed here. | |
3251 |
|
3251 | |||
3252 | For things that may depend on startup flags or platform specifics (such |
|
3252 | For things that may depend on startup flags or platform specifics (such | |
3253 | as having readline or not), register a separate atexit function in the |
|
3253 | as having readline or not), register a separate atexit function in the | |
3254 | code that has the appropriate information, rather than trying to |
|
3254 | code that has the appropriate information, rather than trying to | |
3255 | clutter |
|
3255 | clutter | |
3256 | """ |
|
3256 | """ | |
3257 | # Close the history session (this stores the end time and line count) |
|
3257 | # Close the history session (this stores the end time and line count) | |
3258 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3258 | # this must be *before* the tempfile cleanup, in case of temporary | |
3259 | # history db |
|
3259 | # history db | |
3260 | self.history_manager.end_session() |
|
3260 | self.history_manager.end_session() | |
3261 |
|
3261 | |||
3262 | # Cleanup all tempfiles and folders left around |
|
3262 | # Cleanup all tempfiles and folders left around | |
3263 | for tfile in self.tempfiles: |
|
3263 | for tfile in self.tempfiles: | |
3264 | try: |
|
3264 | try: | |
3265 | os.unlink(tfile) |
|
3265 | os.unlink(tfile) | |
3266 | except OSError: |
|
3266 | except OSError: | |
3267 | pass |
|
3267 | pass | |
3268 |
|
3268 | |||
3269 | for tdir in self.tempdirs: |
|
3269 | for tdir in self.tempdirs: | |
3270 | try: |
|
3270 | try: | |
3271 | os.rmdir(tdir) |
|
3271 | os.rmdir(tdir) | |
3272 | except OSError: |
|
3272 | except OSError: | |
3273 | pass |
|
3273 | pass | |
3274 |
|
3274 | |||
3275 | # Clear all user namespaces to release all references cleanly. |
|
3275 | # Clear all user namespaces to release all references cleanly. | |
3276 | self.reset(new_session=False) |
|
3276 | self.reset(new_session=False) | |
3277 |
|
3277 | |||
3278 | # Run user hooks |
|
3278 | # Run user hooks | |
3279 | self.hooks.shutdown_hook() |
|
3279 | self.hooks.shutdown_hook() | |
3280 |
|
3280 | |||
3281 | def cleanup(self): |
|
3281 | def cleanup(self): | |
3282 | self.restore_sys_module_state() |
|
3282 | self.restore_sys_module_state() | |
3283 |
|
3283 | |||
3284 |
|
3284 | |||
3285 | class InteractiveShellABC(with_metaclass(abc.ABCMeta, object)): |
|
3285 | class InteractiveShellABC(with_metaclass(abc.ABCMeta, object)): | |
3286 | """An abstract base class for InteractiveShell.""" |
|
3286 | """An abstract base class for InteractiveShell.""" | |
3287 |
|
3287 | |||
3288 | InteractiveShellABC.register(InteractiveShell) |
|
3288 | InteractiveShellABC.register(InteractiveShell) |
General Comments 0
You need to be logged in to leave comments.
Login now