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