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