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