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