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