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