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