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