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