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