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