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