##// END OF EJS Templates
Major restructuring of magics, breaking them up into separate classes....
Fernando Perez -
Show More
@@ -1,2893 +1,2894 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Main IPython class."""
2 """Main IPython class."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2008-2011 The IPython Development Team
8 #
8 #
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12
12
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16
16
17 from __future__ import with_statement
17 from __future__ import with_statement
18 from __future__ import absolute_import
18 from __future__ import absolute_import
19
19
20 import __builtin__ as builtin_mod
20 import __builtin__ as builtin_mod
21 import __future__
21 import __future__
22 import abc
22 import abc
23 import ast
23 import ast
24 import atexit
24 import atexit
25 import os
25 import os
26 import re
26 import re
27 import runpy
27 import runpy
28 import sys
28 import sys
29 import tempfile
29 import tempfile
30 import types
30 import types
31 import urllib
31 import urllib
32 from io import open as io_open
32 from io import open as io_open
33
33
34 from IPython.config.configurable import SingletonConfigurable
34 from IPython.config.configurable import SingletonConfigurable
35 from IPython.core import debugger, oinspect
35 from IPython.core import debugger, oinspect
36 from IPython.core import page
36 from IPython.core import page
37 from IPython.core import prefilter
37 from IPython.core import prefilter
38 from IPython.core import shadowns
38 from IPython.core import shadowns
39 from IPython.core import ultratb
39 from IPython.core import ultratb
40 from IPython.core.alias import AliasManager, AliasError
40 from IPython.core.alias import AliasManager, AliasError
41 from IPython.core.autocall import ExitAutocall
41 from IPython.core.autocall import ExitAutocall
42 from IPython.core.builtin_trap import BuiltinTrap
42 from IPython.core.builtin_trap import BuiltinTrap
43 from IPython.core.compilerop import CachingCompiler
43 from IPython.core.compilerop import CachingCompiler
44 from IPython.core.display_trap import DisplayTrap
44 from IPython.core.display_trap import DisplayTrap
45 from IPython.core.displayhook import DisplayHook
45 from IPython.core.displayhook import DisplayHook
46 from IPython.core.displaypub import DisplayPublisher
46 from IPython.core.displaypub import DisplayPublisher
47 from IPython.core.error import UsageError
47 from IPython.core.error import UsageError
48 from IPython.core.extensions import ExtensionManager
48 from IPython.core.extensions import ExtensionManager
49 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
49 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
50 from IPython.core.formatters import DisplayFormatter
50 from IPython.core.formatters import DisplayFormatter
51 from IPython.core.history import HistoryManager
51 from IPython.core.history import HistoryManager
52 from IPython.core.inputsplitter import IPythonInputSplitter
52 from IPython.core.inputsplitter import IPythonInputSplitter
53 from IPython.core.logger import Logger
53 from IPython.core.logger import Logger
54 from IPython.core.macro import Macro
54 from IPython.core.macro import Macro
55 from IPython.core.magic import Magic
55 from IPython.core.magic import Magic
56 from IPython.core.payload import PayloadManager
56 from IPython.core.payload import PayloadManager
57 from IPython.core.plugin import PluginManager
57 from IPython.core.plugin import PluginManager
58 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
58 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
59 from IPython.core.profiledir import ProfileDir
59 from IPython.core.profiledir import ProfileDir
60 from IPython.core.pylabtools import pylab_activate
60 from IPython.core.pylabtools import pylab_activate
61 from IPython.core.prompts import PromptManager
61 from IPython.core.prompts import PromptManager
62 from IPython.utils import PyColorize
62 from IPython.utils import PyColorize
63 from IPython.utils import io
63 from IPython.utils import io
64 from IPython.utils import py3compat
64 from IPython.utils import py3compat
65 from IPython.utils import openpy
65 from IPython.utils import openpy
66 from IPython.utils.doctestreload import doctest_reload
66 from IPython.utils.doctestreload import doctest_reload
67 from IPython.utils.io import ask_yes_no
67 from IPython.utils.io import ask_yes_no
68 from IPython.utils.ipstruct import Struct
68 from IPython.utils.ipstruct import Struct
69 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
69 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
70 from IPython.utils.pickleshare import PickleShareDB
70 from IPython.utils.pickleshare import PickleShareDB
71 from IPython.utils.process import system, getoutput
71 from IPython.utils.process import system, getoutput
72 from IPython.utils.strdispatch import StrDispatch
72 from IPython.utils.strdispatch import StrDispatch
73 from IPython.utils.syspathcontext import prepended_to_syspath
73 from IPython.utils.syspathcontext import prepended_to_syspath
74 from IPython.utils.text import (format_screen, LSString, SList,
74 from IPython.utils.text import (format_screen, LSString, SList,
75 DollarFormatter)
75 DollarFormatter)
76 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
76 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
77 List, Unicode, Instance, Type)
77 List, Unicode, Instance, Type)
78 from IPython.utils.warn import warn, error
78 from IPython.utils.warn import warn, error
79 import IPython.core.hooks
79 import IPython.core.hooks
80
80
81 #-----------------------------------------------------------------------------
81 #-----------------------------------------------------------------------------
82 # Globals
82 # Globals
83 #-----------------------------------------------------------------------------
83 #-----------------------------------------------------------------------------
84
84
85 # compiled regexps for autoindent management
85 # compiled regexps for autoindent management
86 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
86 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
87
87
88 #-----------------------------------------------------------------------------
88 #-----------------------------------------------------------------------------
89 # Utilities
89 # Utilities
90 #-----------------------------------------------------------------------------
90 #-----------------------------------------------------------------------------
91
91
92 def softspace(file, newvalue):
92 def softspace(file, newvalue):
93 """Copied from code.py, to remove the dependency"""
93 """Copied from code.py, to remove the dependency"""
94
94
95 oldvalue = 0
95 oldvalue = 0
96 try:
96 try:
97 oldvalue = file.softspace
97 oldvalue = file.softspace
98 except AttributeError:
98 except AttributeError:
99 pass
99 pass
100 try:
100 try:
101 file.softspace = newvalue
101 file.softspace = newvalue
102 except (AttributeError, TypeError):
102 except (AttributeError, TypeError):
103 # "attribute-less object" or "read-only attributes"
103 # "attribute-less object" or "read-only attributes"
104 pass
104 pass
105 return oldvalue
105 return oldvalue
106
106
107
107
108 def no_op(*a, **kw): pass
108 def no_op(*a, **kw): pass
109
109
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 class Bunch: pass
117 class Bunch: pass
118
118
119
119
120 def get_default_colors():
120 def get_default_colors():
121 if sys.platform=='darwin':
121 if sys.platform=='darwin':
122 return "LightBG"
122 return "LightBG"
123 elif os.name=='nt':
123 elif os.name=='nt':
124 return 'Linux'
124 return 'Linux'
125 else:
125 else:
126 return 'Linux'
126 return 'Linux'
127
127
128
128
129 class SeparateUnicode(Unicode):
129 class SeparateUnicode(Unicode):
130 """A Unicode subclass to validate separate_in, separate_out, etc.
130 """A Unicode subclass to validate separate_in, separate_out, etc.
131
131
132 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
132 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
133 """
133 """
134
134
135 def validate(self, obj, value):
135 def validate(self, obj, value):
136 if value == '0': value = ''
136 if value == '0': value = ''
137 value = value.replace('\\n','\n')
137 value = value.replace('\\n','\n')
138 return super(SeparateUnicode, self).validate(obj, value)
138 return super(SeparateUnicode, self).validate(obj, value)
139
139
140
140
141 class ReadlineNoRecord(object):
141 class ReadlineNoRecord(object):
142 """Context manager to execute some code, then reload readline history
142 """Context manager to execute some code, then reload readline history
143 so that interactive input to the code doesn't appear when pressing up."""
143 so that interactive input to the code doesn't appear when pressing up."""
144 def __init__(self, shell):
144 def __init__(self, shell):
145 self.shell = shell
145 self.shell = shell
146 self._nested_level = 0
146 self._nested_level = 0
147
147
148 def __enter__(self):
148 def __enter__(self):
149 if self._nested_level == 0:
149 if self._nested_level == 0:
150 try:
150 try:
151 self.orig_length = self.current_length()
151 self.orig_length = self.current_length()
152 self.readline_tail = self.get_readline_tail()
152 self.readline_tail = self.get_readline_tail()
153 except (AttributeError, IndexError): # Can fail with pyreadline
153 except (AttributeError, IndexError): # Can fail with pyreadline
154 self.orig_length, self.readline_tail = 999999, []
154 self.orig_length, self.readline_tail = 999999, []
155 self._nested_level += 1
155 self._nested_level += 1
156
156
157 def __exit__(self, type, value, traceback):
157 def __exit__(self, type, value, traceback):
158 self._nested_level -= 1
158 self._nested_level -= 1
159 if self._nested_level == 0:
159 if self._nested_level == 0:
160 # Try clipping the end if it's got longer
160 # Try clipping the end if it's got longer
161 try:
161 try:
162 e = self.current_length() - self.orig_length
162 e = self.current_length() - self.orig_length
163 if e > 0:
163 if e > 0:
164 for _ in range(e):
164 for _ in range(e):
165 self.shell.readline.remove_history_item(self.orig_length)
165 self.shell.readline.remove_history_item(self.orig_length)
166
166
167 # If it still doesn't match, just reload readline history.
167 # If it still doesn't match, just reload readline history.
168 if self.current_length() != self.orig_length \
168 if self.current_length() != self.orig_length \
169 or self.get_readline_tail() != self.readline_tail:
169 or self.get_readline_tail() != self.readline_tail:
170 self.shell.refill_readline_hist()
170 self.shell.refill_readline_hist()
171 except (AttributeError, IndexError):
171 except (AttributeError, IndexError):
172 pass
172 pass
173 # Returning False will cause exceptions to propagate
173 # Returning False will cause exceptions to propagate
174 return False
174 return False
175
175
176 def current_length(self):
176 def current_length(self):
177 return self.shell.readline.get_current_history_length()
177 return self.shell.readline.get_current_history_length()
178
178
179 def get_readline_tail(self, n=10):
179 def get_readline_tail(self, n=10):
180 """Get the last n items in readline history."""
180 """Get the last n items in readline history."""
181 end = self.shell.readline.get_current_history_length() + 1
181 end = self.shell.readline.get_current_history_length() + 1
182 start = max(end-n, 1)
182 start = max(end-n, 1)
183 ghi = self.shell.readline.get_history_item
183 ghi = self.shell.readline.get_history_item
184 return [ghi(x) for x in range(start, end)]
184 return [ghi(x) for x in range(start, end)]
185
185
186 #-----------------------------------------------------------------------------
186 #-----------------------------------------------------------------------------
187 # Main IPython class
187 # Main IPython class
188 #-----------------------------------------------------------------------------
188 #-----------------------------------------------------------------------------
189
189
190 class InteractiveShell(SingletonConfigurable):
190 class InteractiveShell(SingletonConfigurable):
191 """An enhanced, interactive shell for Python."""
191 """An enhanced, interactive shell for Python."""
192
192
193 _instance = None
193 _instance = None
194
194
195 autocall = Enum((0,1,2), default_value=0, config=True, help=
195 autocall = Enum((0,1,2), default_value=0, config=True, help=
196 """
196 """
197 Make IPython automatically call any callable object even if you didn't
197 Make IPython automatically call any callable object even if you didn't
198 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
198 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
199 automatically. The value can be '0' to disable the feature, '1' for
199 automatically. The value can be '0' to disable the feature, '1' for
200 'smart' autocall, where it is not applied if there are no more
200 'smart' autocall, where it is not applied if there are no more
201 arguments on the line, and '2' for 'full' autocall, where all callable
201 arguments on the line, and '2' for 'full' autocall, where all callable
202 objects are automatically called (even if no arguments are present).
202 objects are automatically called (even if no arguments are present).
203 """
203 """
204 )
204 )
205 # TODO: remove all autoindent logic and put into frontends.
205 # TODO: remove all autoindent logic and put into frontends.
206 # We can't do this yet because even runlines uses the autoindent.
206 # We can't do this yet because even runlines uses the autoindent.
207 autoindent = CBool(True, config=True, help=
207 autoindent = CBool(True, config=True, help=
208 """
208 """
209 Autoindent IPython code entered interactively.
209 Autoindent IPython code entered interactively.
210 """
210 """
211 )
211 )
212 automagic = CBool(True, config=True, help=
212 automagic = CBool(True, config=True, help=
213 """
213 """
214 Enable magic commands to be called without the leading %.
214 Enable magic commands to be called without the leading %.
215 """
215 """
216 )
216 )
217 cache_size = Integer(1000, config=True, help=
217 cache_size = Integer(1000, config=True, help=
218 """
218 """
219 Set the size of the output cache. The default is 1000, you can
219 Set the size of the output cache. The default is 1000, you can
220 change it permanently in your config file. Setting it to 0 completely
220 change it permanently in your config file. Setting it to 0 completely
221 disables the caching system, and the minimum value accepted is 20 (if
221 disables the caching system, and the minimum value accepted is 20 (if
222 you provide a value less than 20, it is reset to 0 and a warning is
222 you provide a value less than 20, it is reset to 0 and a warning is
223 issued). This limit is defined because otherwise you'll spend more
223 issued). This limit is defined because otherwise you'll spend more
224 time re-flushing a too small cache than working
224 time re-flushing a too small cache than working
225 """
225 """
226 )
226 )
227 color_info = CBool(True, config=True, help=
227 color_info = CBool(True, config=True, help=
228 """
228 """
229 Use colors for displaying information about objects. Because this
229 Use colors for displaying information about objects. Because this
230 information is passed through a pager (like 'less'), and some pagers
230 information is passed through a pager (like 'less'), and some pagers
231 get confused with color codes, this capability can be turned off.
231 get confused with color codes, this capability can be turned off.
232 """
232 """
233 )
233 )
234 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
234 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
235 default_value=get_default_colors(), config=True,
235 default_value=get_default_colors(), config=True,
236 help="Set the color scheme (NoColor, Linux, or LightBG)."
236 help="Set the color scheme (NoColor, Linux, or LightBG)."
237 )
237 )
238 colors_force = CBool(False, help=
238 colors_force = CBool(False, help=
239 """
239 """
240 Force use of ANSI color codes, regardless of OS and readline
240 Force use of ANSI color codes, regardless of OS and readline
241 availability.
241 availability.
242 """
242 """
243 # FIXME: This is essentially a hack to allow ZMQShell to show colors
243 # FIXME: This is essentially a hack to allow ZMQShell to show colors
244 # without readline on Win32. When the ZMQ formatting system is
244 # without readline on Win32. When the ZMQ formatting system is
245 # refactored, this should be removed.
245 # refactored, this should be removed.
246 )
246 )
247 debug = CBool(False, config=True)
247 debug = CBool(False, config=True)
248 deep_reload = CBool(False, config=True, help=
248 deep_reload = CBool(False, config=True, help=
249 """
249 """
250 Enable deep (recursive) reloading by default. IPython can use the
250 Enable deep (recursive) reloading by default. IPython can use the
251 deep_reload module which reloads changes in modules recursively (it
251 deep_reload module which reloads changes in modules recursively (it
252 replaces the reload() function, so you don't need to change anything to
252 replaces the reload() function, so you don't need to change anything to
253 use it). deep_reload() forces a full reload of modules whose code may
253 use it). deep_reload() forces a full reload of modules whose code may
254 have changed, which the default reload() function does not. When
254 have changed, which the default reload() function does not. When
255 deep_reload is off, IPython will use the normal reload(), but
255 deep_reload is off, IPython will use the normal reload(), but
256 deep_reload will still be available as dreload().
256 deep_reload will still be available as dreload().
257 """
257 """
258 )
258 )
259 disable_failing_post_execute = CBool(False, config=True,
259 disable_failing_post_execute = CBool(False, config=True,
260 help="Don't call post-execute functions that have failed in the past."""
260 help="Don't call post-execute functions that have failed in the past."""
261 )
261 )
262 display_formatter = Instance(DisplayFormatter)
262 display_formatter = Instance(DisplayFormatter)
263 displayhook_class = Type(DisplayHook)
263 displayhook_class = Type(DisplayHook)
264 display_pub_class = Type(DisplayPublisher)
264 display_pub_class = Type(DisplayPublisher)
265
265
266 exit_now = CBool(False)
266 exit_now = CBool(False)
267 exiter = Instance(ExitAutocall)
267 exiter = Instance(ExitAutocall)
268 def _exiter_default(self):
268 def _exiter_default(self):
269 return ExitAutocall(self)
269 return ExitAutocall(self)
270 # Monotonically increasing execution counter
270 # Monotonically increasing execution counter
271 execution_count = Integer(1)
271 execution_count = Integer(1)
272 filename = Unicode("<ipython console>")
272 filename = Unicode("<ipython console>")
273 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
273 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
274
274
275 # Input splitter, to split entire cells of input into either individual
275 # Input splitter, to split entire cells of input into either individual
276 # interactive statements or whole blocks.
276 # interactive statements or whole blocks.
277 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
277 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
278 (), {})
278 (), {})
279 logstart = CBool(False, config=True, help=
279 logstart = CBool(False, config=True, help=
280 """
280 """
281 Start logging to the default log file.
281 Start logging to the default log file.
282 """
282 """
283 )
283 )
284 logfile = Unicode('', config=True, help=
284 logfile = Unicode('', config=True, help=
285 """
285 """
286 The name of the logfile to use.
286 The name of the logfile to use.
287 """
287 """
288 )
288 )
289 logappend = Unicode('', config=True, help=
289 logappend = Unicode('', config=True, help=
290 """
290 """
291 Start logging to the given file in append mode.
291 Start logging to the given file in append mode.
292 """
292 """
293 )
293 )
294 object_info_string_level = Enum((0,1,2), default_value=0,
294 object_info_string_level = Enum((0,1,2), default_value=0,
295 config=True)
295 config=True)
296 pdb = CBool(False, config=True, help=
296 pdb = CBool(False, config=True, help=
297 """
297 """
298 Automatically call the pdb debugger after every exception.
298 Automatically call the pdb debugger after every exception.
299 """
299 """
300 )
300 )
301 multiline_history = CBool(sys.platform != 'win32', config=True,
301 multiline_history = CBool(sys.platform != 'win32', config=True,
302 help="Save multi-line entries as one entry in readline history"
302 help="Save multi-line entries as one entry in readline history"
303 )
303 )
304
304
305 # deprecated prompt traits:
305 # deprecated prompt traits:
306
306
307 prompt_in1 = Unicode('In [\\#]: ', config=True,
307 prompt_in1 = Unicode('In [\\#]: ', config=True,
308 help="Deprecated, use PromptManager.in_template")
308 help="Deprecated, use PromptManager.in_template")
309 prompt_in2 = Unicode(' .\\D.: ', config=True,
309 prompt_in2 = Unicode(' .\\D.: ', config=True,
310 help="Deprecated, use PromptManager.in2_template")
310 help="Deprecated, use PromptManager.in2_template")
311 prompt_out = Unicode('Out[\\#]: ', config=True,
311 prompt_out = Unicode('Out[\\#]: ', config=True,
312 help="Deprecated, use PromptManager.out_template")
312 help="Deprecated, use PromptManager.out_template")
313 prompts_pad_left = CBool(True, config=True,
313 prompts_pad_left = CBool(True, config=True,
314 help="Deprecated, use PromptManager.justify")
314 help="Deprecated, use PromptManager.justify")
315
315
316 def _prompt_trait_changed(self, name, old, new):
316 def _prompt_trait_changed(self, name, old, new):
317 table = {
317 table = {
318 'prompt_in1' : 'in_template',
318 'prompt_in1' : 'in_template',
319 'prompt_in2' : 'in2_template',
319 'prompt_in2' : 'in2_template',
320 'prompt_out' : 'out_template',
320 'prompt_out' : 'out_template',
321 'prompts_pad_left' : 'justify',
321 'prompts_pad_left' : 'justify',
322 }
322 }
323 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format(
323 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format(
324 name=name, newname=table[name])
324 name=name, newname=table[name])
325 )
325 )
326 # protect against weird cases where self.config may not exist:
326 # protect against weird cases where self.config may not exist:
327 if self.config is not None:
327 if self.config is not None:
328 # propagate to corresponding PromptManager trait
328 # propagate to corresponding PromptManager trait
329 setattr(self.config.PromptManager, table[name], new)
329 setattr(self.config.PromptManager, table[name], new)
330
330
331 _prompt_in1_changed = _prompt_trait_changed
331 _prompt_in1_changed = _prompt_trait_changed
332 _prompt_in2_changed = _prompt_trait_changed
332 _prompt_in2_changed = _prompt_trait_changed
333 _prompt_out_changed = _prompt_trait_changed
333 _prompt_out_changed = _prompt_trait_changed
334 _prompt_pad_left_changed = _prompt_trait_changed
334 _prompt_pad_left_changed = _prompt_trait_changed
335
335
336 show_rewritten_input = CBool(True, config=True,
336 show_rewritten_input = CBool(True, config=True,
337 help="Show rewritten input, e.g. for autocall."
337 help="Show rewritten input, e.g. for autocall."
338 )
338 )
339
339
340 quiet = CBool(False, config=True)
340 quiet = CBool(False, config=True)
341
341
342 history_length = Integer(10000, config=True)
342 history_length = Integer(10000, config=True)
343
343
344 # The readline stuff will eventually be moved to the terminal subclass
344 # The readline stuff will eventually be moved to the terminal subclass
345 # but for now, we can't do that as readline is welded in everywhere.
345 # but for now, we can't do that as readline is welded in everywhere.
346 readline_use = CBool(True, config=True)
346 readline_use = CBool(True, config=True)
347 readline_remove_delims = Unicode('-/~', config=True)
347 readline_remove_delims = Unicode('-/~', config=True)
348 # don't use \M- bindings by default, because they
348 # don't use \M- bindings by default, because they
349 # conflict with 8-bit encodings. See gh-58,gh-88
349 # conflict with 8-bit encodings. See gh-58,gh-88
350 readline_parse_and_bind = List([
350 readline_parse_and_bind = List([
351 'tab: complete',
351 'tab: complete',
352 '"\C-l": clear-screen',
352 '"\C-l": clear-screen',
353 'set show-all-if-ambiguous on',
353 'set show-all-if-ambiguous on',
354 '"\C-o": tab-insert',
354 '"\C-o": tab-insert',
355 '"\C-r": reverse-search-history',
355 '"\C-r": reverse-search-history',
356 '"\C-s": forward-search-history',
356 '"\C-s": forward-search-history',
357 '"\C-p": history-search-backward',
357 '"\C-p": history-search-backward',
358 '"\C-n": history-search-forward',
358 '"\C-n": history-search-forward',
359 '"\e[A": history-search-backward',
359 '"\e[A": history-search-backward',
360 '"\e[B": history-search-forward',
360 '"\e[B": history-search-forward',
361 '"\C-k": kill-line',
361 '"\C-k": kill-line',
362 '"\C-u": unix-line-discard',
362 '"\C-u": unix-line-discard',
363 ], allow_none=False, config=True)
363 ], allow_none=False, config=True)
364
364
365 # TODO: this part of prompt management should be moved to the frontends.
365 # TODO: this part of prompt management should be moved to the frontends.
366 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
366 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
367 separate_in = SeparateUnicode('\n', config=True)
367 separate_in = SeparateUnicode('\n', config=True)
368 separate_out = SeparateUnicode('', config=True)
368 separate_out = SeparateUnicode('', config=True)
369 separate_out2 = SeparateUnicode('', config=True)
369 separate_out2 = SeparateUnicode('', config=True)
370 wildcards_case_sensitive = CBool(True, config=True)
370 wildcards_case_sensitive = CBool(True, config=True)
371 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
371 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
372 default_value='Context', config=True)
372 default_value='Context', config=True)
373
373
374 # Subcomponents of InteractiveShell
374 # Subcomponents of InteractiveShell
375 alias_manager = Instance('IPython.core.alias.AliasManager')
375 alias_manager = Instance('IPython.core.alias.AliasManager')
376 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
376 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
377 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
377 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
378 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
378 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
379 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
379 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
380 plugin_manager = Instance('IPython.core.plugin.PluginManager')
380 plugin_manager = Instance('IPython.core.plugin.PluginManager')
381 payload_manager = Instance('IPython.core.payload.PayloadManager')
381 payload_manager = Instance('IPython.core.payload.PayloadManager')
382 history_manager = Instance('IPython.core.history.HistoryManager')
382 history_manager = Instance('IPython.core.history.HistoryManager')
383 magics_manager = Instance('IPython.core.magic.MagicsManager')
383
384
384 profile_dir = Instance('IPython.core.application.ProfileDir')
385 profile_dir = Instance('IPython.core.application.ProfileDir')
385 @property
386 @property
386 def profile(self):
387 def profile(self):
387 if self.profile_dir is not None:
388 if self.profile_dir is not None:
388 name = os.path.basename(self.profile_dir.location)
389 name = os.path.basename(self.profile_dir.location)
389 return name.replace('profile_','')
390 return name.replace('profile_','')
390
391
391
392
392 # Private interface
393 # Private interface
393 _post_execute = Instance(dict)
394 _post_execute = Instance(dict)
394
395
395 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
396 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
396 user_module=None, user_ns=None,
397 user_module=None, user_ns=None,
397 custom_exceptions=((), None)):
398 custom_exceptions=((), None)):
398
399
399 # This is where traits with a config_key argument are updated
400 # This is where traits with a config_key argument are updated
400 # from the values on config.
401 # from the values on config.
401 super(InteractiveShell, self).__init__(config=config)
402 super(InteractiveShell, self).__init__(config=config)
402 self.configurables = [self]
403 self.configurables = [self]
403
404
404 # These are relatively independent and stateless
405 # These are relatively independent and stateless
405 self.init_ipython_dir(ipython_dir)
406 self.init_ipython_dir(ipython_dir)
406 self.init_profile_dir(profile_dir)
407 self.init_profile_dir(profile_dir)
407 self.init_instance_attrs()
408 self.init_instance_attrs()
408 self.init_environment()
409 self.init_environment()
409
410
410 # Check if we're in a virtualenv, and set up sys.path.
411 # Check if we're in a virtualenv, and set up sys.path.
411 self.init_virtualenv()
412 self.init_virtualenv()
412
413
413 # Create namespaces (user_ns, user_global_ns, etc.)
414 # Create namespaces (user_ns, user_global_ns, etc.)
414 self.init_create_namespaces(user_module, user_ns)
415 self.init_create_namespaces(user_module, user_ns)
415 # This has to be done after init_create_namespaces because it uses
416 # This has to be done after init_create_namespaces because it uses
416 # something in self.user_ns, but before init_sys_modules, which
417 # something in self.user_ns, but before init_sys_modules, which
417 # is the first thing to modify sys.
418 # is the first thing to modify sys.
418 # TODO: When we override sys.stdout and sys.stderr before this class
419 # TODO: When we override sys.stdout and sys.stderr before this class
419 # is created, we are saving the overridden ones here. Not sure if this
420 # is created, we are saving the overridden ones here. Not sure if this
420 # is what we want to do.
421 # is what we want to do.
421 self.save_sys_module_state()
422 self.save_sys_module_state()
422 self.init_sys_modules()
423 self.init_sys_modules()
423
424
424 # While we're trying to have each part of the code directly access what
425 # While we're trying to have each part of the code directly access what
425 # it needs without keeping redundant references to objects, we have too
426 # it needs without keeping redundant references to objects, we have too
426 # much legacy code that expects ip.db to exist.
427 # much legacy code that expects ip.db to exist.
427 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
428 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
428
429
429 self.init_history()
430 self.init_history()
430 self.init_encoding()
431 self.init_encoding()
431 self.init_prefilter()
432 self.init_prefilter()
432
433
433 self._magic = Magic(self)
434 self._magic = Magic(self)
434
435
435 self.init_syntax_highlighting()
436 self.init_syntax_highlighting()
436 self.init_hooks()
437 self.init_hooks()
437 self.init_pushd_popd_magic()
438 self.init_pushd_popd_magic()
438 # self.init_traceback_handlers use to be here, but we moved it below
439 # self.init_traceback_handlers use to be here, but we moved it below
439 # because it and init_io have to come after init_readline.
440 # because it and init_io have to come after init_readline.
440 self.init_user_ns()
441 self.init_user_ns()
441 self.init_logger()
442 self.init_logger()
442 self.init_alias()
443 self.init_alias()
443 self.init_builtins()
444 self.init_builtins()
444
445
445 # pre_config_initialization
446 # pre_config_initialization
446
447
447 # The next section should contain everything that was in ipmaker.
448 # The next section should contain everything that was in ipmaker.
448 self.init_logstart()
449 self.init_logstart()
449
450
450 # The following was in post_config_initialization
451 # The following was in post_config_initialization
451 self.init_inspector()
452 self.init_inspector()
452 # init_readline() must come before init_io(), because init_io uses
453 # init_readline() must come before init_io(), because init_io uses
453 # readline related things.
454 # readline related things.
454 self.init_readline()
455 self.init_readline()
455 # We save this here in case user code replaces raw_input, but it needs
456 # We save this here in case user code replaces raw_input, but it needs
456 # to be after init_readline(), because PyPy's readline works by replacing
457 # to be after init_readline(), because PyPy's readline works by replacing
457 # raw_input.
458 # raw_input.
458 if py3compat.PY3:
459 if py3compat.PY3:
459 self.raw_input_original = input
460 self.raw_input_original = input
460 else:
461 else:
461 self.raw_input_original = raw_input
462 self.raw_input_original = raw_input
462 # init_completer must come after init_readline, because it needs to
463 # init_completer must come after init_readline, because it needs to
463 # know whether readline is present or not system-wide to configure the
464 # know whether readline is present or not system-wide to configure the
464 # completers, since the completion machinery can now operate
465 # completers, since the completion machinery can now operate
465 # independently of readline (e.g. over the network)
466 # independently of readline (e.g. over the network)
466 self.init_completer()
467 self.init_completer()
467 # TODO: init_io() needs to happen before init_traceback handlers
468 # TODO: init_io() needs to happen before init_traceback handlers
468 # because the traceback handlers hardcode the stdout/stderr streams.
469 # because the traceback handlers hardcode the stdout/stderr streams.
469 # This logic in in debugger.Pdb and should eventually be changed.
470 # This logic in in debugger.Pdb and should eventually be changed.
470 self.init_io()
471 self.init_io()
471 self.init_traceback_handlers(custom_exceptions)
472 self.init_traceback_handlers(custom_exceptions)
472 self.init_prompts()
473 self.init_prompts()
473 self.init_display_formatter()
474 self.init_display_formatter()
474 self.init_display_pub()
475 self.init_display_pub()
475 self.init_displayhook()
476 self.init_displayhook()
476 self.init_reload_doctest()
477 self.init_reload_doctest()
477 self.init_magics()
478 self.init_magics()
478 self.init_pdb()
479 self.init_pdb()
479 self.init_extension_manager()
480 self.init_extension_manager()
480 self.init_plugin_manager()
481 self.init_plugin_manager()
481 self.init_payload()
482 self.init_payload()
482 self.hooks.late_startup_hook()
483 self.hooks.late_startup_hook()
483 atexit.register(self.atexit_operations)
484 atexit.register(self.atexit_operations)
484
485
485 def get_ipython(self):
486 def get_ipython(self):
486 """Return the currently running IPython instance."""
487 """Return the currently running IPython instance."""
487 return self
488 return self
488
489
489 #-------------------------------------------------------------------------
490 #-------------------------------------------------------------------------
490 # Trait changed handlers
491 # Trait changed handlers
491 #-------------------------------------------------------------------------
492 #-------------------------------------------------------------------------
492
493
493 def _ipython_dir_changed(self, name, new):
494 def _ipython_dir_changed(self, name, new):
494 if not os.path.isdir(new):
495 if not os.path.isdir(new):
495 os.makedirs(new, mode = 0777)
496 os.makedirs(new, mode = 0777)
496
497
497 def set_autoindent(self,value=None):
498 def set_autoindent(self,value=None):
498 """Set the autoindent flag, checking for readline support.
499 """Set the autoindent flag, checking for readline support.
499
500
500 If called with no arguments, it acts as a toggle."""
501 If called with no arguments, it acts as a toggle."""
501
502
502 if value != 0 and not self.has_readline:
503 if value != 0 and not self.has_readline:
503 if os.name == 'posix':
504 if os.name == 'posix':
504 warn("The auto-indent feature requires the readline library")
505 warn("The auto-indent feature requires the readline library")
505 self.autoindent = 0
506 self.autoindent = 0
506 return
507 return
507 if value is None:
508 if value is None:
508 self.autoindent = not self.autoindent
509 self.autoindent = not self.autoindent
509 else:
510 else:
510 self.autoindent = value
511 self.autoindent = value
511
512
512 #-------------------------------------------------------------------------
513 #-------------------------------------------------------------------------
513 # init_* methods called by __init__
514 # init_* methods called by __init__
514 #-------------------------------------------------------------------------
515 #-------------------------------------------------------------------------
515
516
516 def init_ipython_dir(self, ipython_dir):
517 def init_ipython_dir(self, ipython_dir):
517 if ipython_dir is not None:
518 if ipython_dir is not None:
518 self.ipython_dir = ipython_dir
519 self.ipython_dir = ipython_dir
519 return
520 return
520
521
521 self.ipython_dir = get_ipython_dir()
522 self.ipython_dir = get_ipython_dir()
522
523
523 def init_profile_dir(self, profile_dir):
524 def init_profile_dir(self, profile_dir):
524 if profile_dir is not None:
525 if profile_dir is not None:
525 self.profile_dir = profile_dir
526 self.profile_dir = profile_dir
526 return
527 return
527 self.profile_dir =\
528 self.profile_dir =\
528 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
529 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
529
530
530 def init_instance_attrs(self):
531 def init_instance_attrs(self):
531 self.more = False
532 self.more = False
532
533
533 # command compiler
534 # command compiler
534 self.compile = CachingCompiler()
535 self.compile = CachingCompiler()
535
536
536 # Make an empty namespace, which extension writers can rely on both
537 # Make an empty namespace, which extension writers can rely on both
537 # existing and NEVER being used by ipython itself. This gives them a
538 # existing and NEVER being used by ipython itself. This gives them a
538 # convenient location for storing additional information and state
539 # convenient location for storing additional information and state
539 # their extensions may require, without fear of collisions with other
540 # their extensions may require, without fear of collisions with other
540 # ipython names that may develop later.
541 # ipython names that may develop later.
541 self.meta = Struct()
542 self.meta = Struct()
542
543
543 # Temporary files used for various purposes. Deleted at exit.
544 # Temporary files used for various purposes. Deleted at exit.
544 self.tempfiles = []
545 self.tempfiles = []
545
546
546 # Keep track of readline usage (later set by init_readline)
547 # Keep track of readline usage (later set by init_readline)
547 self.has_readline = False
548 self.has_readline = False
548
549
549 # keep track of where we started running (mainly for crash post-mortem)
550 # keep track of where we started running (mainly for crash post-mortem)
550 # This is not being used anywhere currently.
551 # This is not being used anywhere currently.
551 self.starting_dir = os.getcwdu()
552 self.starting_dir = os.getcwdu()
552
553
553 # Indentation management
554 # Indentation management
554 self.indent_current_nsp = 0
555 self.indent_current_nsp = 0
555
556
556 # Dict to track post-execution functions that have been registered
557 # Dict to track post-execution functions that have been registered
557 self._post_execute = {}
558 self._post_execute = {}
558
559
559 def init_environment(self):
560 def init_environment(self):
560 """Any changes we need to make to the user's environment."""
561 """Any changes we need to make to the user's environment."""
561 pass
562 pass
562
563
563 def init_encoding(self):
564 def init_encoding(self):
564 # Get system encoding at startup time. Certain terminals (like Emacs
565 # Get system encoding at startup time. Certain terminals (like Emacs
565 # under Win32 have it set to None, and we need to have a known valid
566 # under Win32 have it set to None, and we need to have a known valid
566 # encoding to use in the raw_input() method
567 # encoding to use in the raw_input() method
567 try:
568 try:
568 self.stdin_encoding = sys.stdin.encoding or 'ascii'
569 self.stdin_encoding = sys.stdin.encoding or 'ascii'
569 except AttributeError:
570 except AttributeError:
570 self.stdin_encoding = 'ascii'
571 self.stdin_encoding = 'ascii'
571
572
572 def init_syntax_highlighting(self):
573 def init_syntax_highlighting(self):
573 # Python source parser/formatter for syntax highlighting
574 # Python source parser/formatter for syntax highlighting
574 pyformat = PyColorize.Parser().format
575 pyformat = PyColorize.Parser().format
575 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
576 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
576
577
577 def init_pushd_popd_magic(self):
578 def init_pushd_popd_magic(self):
578 # for pushd/popd management
579 # for pushd/popd management
579 self.home_dir = get_home_dir()
580 self.home_dir = get_home_dir()
580
581
581 self.dir_stack = []
582 self.dir_stack = []
582
583
583 def init_logger(self):
584 def init_logger(self):
584 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
585 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
585 logmode='rotate')
586 logmode='rotate')
586
587
587 def init_logstart(self):
588 def init_logstart(self):
588 """Initialize logging in case it was requested at the command line.
589 """Initialize logging in case it was requested at the command line.
589 """
590 """
590 if self.logappend:
591 if self.logappend:
591 self.magic('logstart %s append' % self.logappend)
592 self.magic('logstart %s append' % self.logappend)
592 elif self.logfile:
593 elif self.logfile:
593 self.magic('logstart %' % self.logfile)
594 self.magic('logstart %' % self.logfile)
594 elif self.logstart:
595 elif self.logstart:
595 self.magic('logstart')
596 self.magic('logstart')
596
597
597 def init_builtins(self):
598 def init_builtins(self):
598 # A single, static flag that we set to True. Its presence indicates
599 # A single, static flag that we set to True. Its presence indicates
599 # that an IPython shell has been created, and we make no attempts at
600 # that an IPython shell has been created, and we make no attempts at
600 # removing on exit or representing the existence of more than one
601 # removing on exit or representing the existence of more than one
601 # IPython at a time.
602 # IPython at a time.
602 builtin_mod.__dict__['__IPYTHON__'] = True
603 builtin_mod.__dict__['__IPYTHON__'] = True
603
604
604 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
605 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
605 # manage on enter/exit, but with all our shells it's virtually
606 # manage on enter/exit, but with all our shells it's virtually
606 # impossible to get all the cases right. We're leaving the name in for
607 # impossible to get all the cases right. We're leaving the name in for
607 # those who adapted their codes to check for this flag, but will
608 # those who adapted their codes to check for this flag, but will
608 # eventually remove it after a few more releases.
609 # eventually remove it after a few more releases.
609 builtin_mod.__dict__['__IPYTHON__active'] = \
610 builtin_mod.__dict__['__IPYTHON__active'] = \
610 'Deprecated, check for __IPYTHON__'
611 'Deprecated, check for __IPYTHON__'
611
612
612 self.builtin_trap = BuiltinTrap(shell=self)
613 self.builtin_trap = BuiltinTrap(shell=self)
613
614
614 def init_inspector(self):
615 def init_inspector(self):
615 # Object inspector
616 # Object inspector
616 self.inspector = oinspect.Inspector(oinspect.InspectColors,
617 self.inspector = oinspect.Inspector(oinspect.InspectColors,
617 PyColorize.ANSICodeColors,
618 PyColorize.ANSICodeColors,
618 'NoColor',
619 'NoColor',
619 self.object_info_string_level)
620 self.object_info_string_level)
620
621
621 def init_io(self):
622 def init_io(self):
622 # This will just use sys.stdout and sys.stderr. If you want to
623 # This will just use sys.stdout and sys.stderr. If you want to
623 # override sys.stdout and sys.stderr themselves, you need to do that
624 # override sys.stdout and sys.stderr themselves, you need to do that
624 # *before* instantiating this class, because io holds onto
625 # *before* instantiating this class, because io holds onto
625 # references to the underlying streams.
626 # references to the underlying streams.
626 if sys.platform == 'win32' and self.has_readline:
627 if sys.platform == 'win32' and self.has_readline:
627 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
628 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
628 else:
629 else:
629 io.stdout = io.IOStream(sys.stdout)
630 io.stdout = io.IOStream(sys.stdout)
630 io.stderr = io.IOStream(sys.stderr)
631 io.stderr = io.IOStream(sys.stderr)
631
632
632 def init_prompts(self):
633 def init_prompts(self):
633 self.prompt_manager = PromptManager(shell=self, config=self.config)
634 self.prompt_manager = PromptManager(shell=self, config=self.config)
634 self.configurables.append(self.prompt_manager)
635 self.configurables.append(self.prompt_manager)
635 # Set system prompts, so that scripts can decide if they are running
636 # Set system prompts, so that scripts can decide if they are running
636 # interactively.
637 # interactively.
637 sys.ps1 = 'In : '
638 sys.ps1 = 'In : '
638 sys.ps2 = '...: '
639 sys.ps2 = '...: '
639 sys.ps3 = 'Out: '
640 sys.ps3 = 'Out: '
640
641
641 def init_display_formatter(self):
642 def init_display_formatter(self):
642 self.display_formatter = DisplayFormatter(config=self.config)
643 self.display_formatter = DisplayFormatter(config=self.config)
643 self.configurables.append(self.display_formatter)
644 self.configurables.append(self.display_formatter)
644
645
645 def init_display_pub(self):
646 def init_display_pub(self):
646 self.display_pub = self.display_pub_class(config=self.config)
647 self.display_pub = self.display_pub_class(config=self.config)
647 self.configurables.append(self.display_pub)
648 self.configurables.append(self.display_pub)
648
649
649 def init_displayhook(self):
650 def init_displayhook(self):
650 # Initialize displayhook, set in/out prompts and printing system
651 # Initialize displayhook, set in/out prompts and printing system
651 self.displayhook = self.displayhook_class(
652 self.displayhook = self.displayhook_class(
652 config=self.config,
653 config=self.config,
653 shell=self,
654 shell=self,
654 cache_size=self.cache_size,
655 cache_size=self.cache_size,
655 )
656 )
656 self.configurables.append(self.displayhook)
657 self.configurables.append(self.displayhook)
657 # This is a context manager that installs/revmoes the displayhook at
658 # This is a context manager that installs/revmoes the displayhook at
658 # the appropriate time.
659 # the appropriate time.
659 self.display_trap = DisplayTrap(hook=self.displayhook)
660 self.display_trap = DisplayTrap(hook=self.displayhook)
660
661
661 def init_reload_doctest(self):
662 def init_reload_doctest(self):
662 # Do a proper resetting of doctest, including the necessary displayhook
663 # Do a proper resetting of doctest, including the necessary displayhook
663 # monkeypatching
664 # monkeypatching
664 try:
665 try:
665 doctest_reload()
666 doctest_reload()
666 except ImportError:
667 except ImportError:
667 warn("doctest module does not exist.")
668 warn("doctest module does not exist.")
668
669
669 def init_virtualenv(self):
670 def init_virtualenv(self):
670 """Add a virtualenv to sys.path so the user can import modules from it.
671 """Add a virtualenv to sys.path so the user can import modules from it.
671 This isn't perfect: it doesn't use the Python interpreter with which the
672 This isn't perfect: it doesn't use the Python interpreter with which the
672 virtualenv was built, and it ignores the --no-site-packages option. A
673 virtualenv was built, and it ignores the --no-site-packages option. A
673 warning will appear suggesting the user installs IPython in the
674 warning will appear suggesting the user installs IPython in the
674 virtualenv, but for many cases, it probably works well enough.
675 virtualenv, but for many cases, it probably works well enough.
675
676
676 Adapted from code snippets online.
677 Adapted from code snippets online.
677
678
678 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
679 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
679 """
680 """
680 if 'VIRTUAL_ENV' not in os.environ:
681 if 'VIRTUAL_ENV' not in os.environ:
681 # Not in a virtualenv
682 # Not in a virtualenv
682 return
683 return
683
684
684 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
685 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
685 # Running properly in the virtualenv, don't need to do anything
686 # Running properly in the virtualenv, don't need to do anything
686 return
687 return
687
688
688 warn("Attempting to work in a virtualenv. If you encounter problems, please "
689 warn("Attempting to work in a virtualenv. If you encounter problems, please "
689 "install IPython inside the virtualenv.\n")
690 "install IPython inside the virtualenv.\n")
690 if sys.platform == "win32":
691 if sys.platform == "win32":
691 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
692 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
692 else:
693 else:
693 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
694 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
694 'python%d.%d' % sys.version_info[:2], 'site-packages')
695 'python%d.%d' % sys.version_info[:2], 'site-packages')
695
696
696 import site
697 import site
697 sys.path.insert(0, virtual_env)
698 sys.path.insert(0, virtual_env)
698 site.addsitedir(virtual_env)
699 site.addsitedir(virtual_env)
699
700
700 #-------------------------------------------------------------------------
701 #-------------------------------------------------------------------------
701 # Things related to injections into the sys module
702 # Things related to injections into the sys module
702 #-------------------------------------------------------------------------
703 #-------------------------------------------------------------------------
703
704
704 def save_sys_module_state(self):
705 def save_sys_module_state(self):
705 """Save the state of hooks in the sys module.
706 """Save the state of hooks in the sys module.
706
707
707 This has to be called after self.user_module is created.
708 This has to be called after self.user_module is created.
708 """
709 """
709 self._orig_sys_module_state = {}
710 self._orig_sys_module_state = {}
710 self._orig_sys_module_state['stdin'] = sys.stdin
711 self._orig_sys_module_state['stdin'] = sys.stdin
711 self._orig_sys_module_state['stdout'] = sys.stdout
712 self._orig_sys_module_state['stdout'] = sys.stdout
712 self._orig_sys_module_state['stderr'] = sys.stderr
713 self._orig_sys_module_state['stderr'] = sys.stderr
713 self._orig_sys_module_state['excepthook'] = sys.excepthook
714 self._orig_sys_module_state['excepthook'] = sys.excepthook
714 self._orig_sys_modules_main_name = self.user_module.__name__
715 self._orig_sys_modules_main_name = self.user_module.__name__
715 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
716 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
716
717
717 def restore_sys_module_state(self):
718 def restore_sys_module_state(self):
718 """Restore the state of the sys module."""
719 """Restore the state of the sys module."""
719 try:
720 try:
720 for k, v in self._orig_sys_module_state.iteritems():
721 for k, v in self._orig_sys_module_state.iteritems():
721 setattr(sys, k, v)
722 setattr(sys, k, v)
722 except AttributeError:
723 except AttributeError:
723 pass
724 pass
724 # Reset what what done in self.init_sys_modules
725 # Reset what what done in self.init_sys_modules
725 if self._orig_sys_modules_main_mod is not None:
726 if self._orig_sys_modules_main_mod is not None:
726 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
727 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
727
728
728 #-------------------------------------------------------------------------
729 #-------------------------------------------------------------------------
729 # Things related to hooks
730 # Things related to hooks
730 #-------------------------------------------------------------------------
731 #-------------------------------------------------------------------------
731
732
732 def init_hooks(self):
733 def init_hooks(self):
733 # hooks holds pointers used for user-side customizations
734 # hooks holds pointers used for user-side customizations
734 self.hooks = Struct()
735 self.hooks = Struct()
735
736
736 self.strdispatchers = {}
737 self.strdispatchers = {}
737
738
738 # Set all default hooks, defined in the IPython.hooks module.
739 # Set all default hooks, defined in the IPython.hooks module.
739 hooks = IPython.core.hooks
740 hooks = IPython.core.hooks
740 for hook_name in hooks.__all__:
741 for hook_name in hooks.__all__:
741 # default hooks have priority 100, i.e. low; user hooks should have
742 # default hooks have priority 100, i.e. low; user hooks should have
742 # 0-100 priority
743 # 0-100 priority
743 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
744 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
744
745
745 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
746 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
746 """set_hook(name,hook) -> sets an internal IPython hook.
747 """set_hook(name,hook) -> sets an internal IPython hook.
747
748
748 IPython exposes some of its internal API as user-modifiable hooks. By
749 IPython exposes some of its internal API as user-modifiable hooks. By
749 adding your function to one of these hooks, you can modify IPython's
750 adding your function to one of these hooks, you can modify IPython's
750 behavior to call at runtime your own routines."""
751 behavior to call at runtime your own routines."""
751
752
752 # At some point in the future, this should validate the hook before it
753 # At some point in the future, this should validate the hook before it
753 # accepts it. Probably at least check that the hook takes the number
754 # accepts it. Probably at least check that the hook takes the number
754 # of args it's supposed to.
755 # of args it's supposed to.
755
756
756 f = types.MethodType(hook,self)
757 f = types.MethodType(hook,self)
757
758
758 # check if the hook is for strdispatcher first
759 # check if the hook is for strdispatcher first
759 if str_key is not None:
760 if str_key is not None:
760 sdp = self.strdispatchers.get(name, StrDispatch())
761 sdp = self.strdispatchers.get(name, StrDispatch())
761 sdp.add_s(str_key, f, priority )
762 sdp.add_s(str_key, f, priority )
762 self.strdispatchers[name] = sdp
763 self.strdispatchers[name] = sdp
763 return
764 return
764 if re_key is not None:
765 if re_key is not None:
765 sdp = self.strdispatchers.get(name, StrDispatch())
766 sdp = self.strdispatchers.get(name, StrDispatch())
766 sdp.add_re(re.compile(re_key), f, priority )
767 sdp.add_re(re.compile(re_key), f, priority )
767 self.strdispatchers[name] = sdp
768 self.strdispatchers[name] = sdp
768 return
769 return
769
770
770 dp = getattr(self.hooks, name, None)
771 dp = getattr(self.hooks, name, None)
771 if name not in IPython.core.hooks.__all__:
772 if name not in IPython.core.hooks.__all__:
772 print "Warning! Hook '%s' is not one of %s" % \
773 print "Warning! Hook '%s' is not one of %s" % \
773 (name, IPython.core.hooks.__all__ )
774 (name, IPython.core.hooks.__all__ )
774 if not dp:
775 if not dp:
775 dp = IPython.core.hooks.CommandChainDispatcher()
776 dp = IPython.core.hooks.CommandChainDispatcher()
776
777
777 try:
778 try:
778 dp.add(f,priority)
779 dp.add(f,priority)
779 except AttributeError:
780 except AttributeError:
780 # it was not commandchain, plain old func - replace
781 # it was not commandchain, plain old func - replace
781 dp = f
782 dp = f
782
783
783 setattr(self.hooks,name, dp)
784 setattr(self.hooks,name, dp)
784
785
785 def register_post_execute(self, func):
786 def register_post_execute(self, func):
786 """Register a function for calling after code execution.
787 """Register a function for calling after code execution.
787 """
788 """
788 if not callable(func):
789 if not callable(func):
789 raise ValueError('argument %s must be callable' % func)
790 raise ValueError('argument %s must be callable' % func)
790 self._post_execute[func] = True
791 self._post_execute[func] = True
791
792
792 #-------------------------------------------------------------------------
793 #-------------------------------------------------------------------------
793 # Things related to the "main" module
794 # Things related to the "main" module
794 #-------------------------------------------------------------------------
795 #-------------------------------------------------------------------------
795
796
796 def new_main_mod(self,ns=None):
797 def new_main_mod(self,ns=None):
797 """Return a new 'main' module object for user code execution.
798 """Return a new 'main' module object for user code execution.
798 """
799 """
799 main_mod = self._user_main_module
800 main_mod = self._user_main_module
800 init_fakemod_dict(main_mod,ns)
801 init_fakemod_dict(main_mod,ns)
801 return main_mod
802 return main_mod
802
803
803 def cache_main_mod(self,ns,fname):
804 def cache_main_mod(self,ns,fname):
804 """Cache a main module's namespace.
805 """Cache a main module's namespace.
805
806
806 When scripts are executed via %run, we must keep a reference to the
807 When scripts are executed via %run, we must keep a reference to the
807 namespace of their __main__ module (a FakeModule instance) around so
808 namespace of their __main__ module (a FakeModule instance) around so
808 that Python doesn't clear it, rendering objects defined therein
809 that Python doesn't clear it, rendering objects defined therein
809 useless.
810 useless.
810
811
811 This method keeps said reference in a private dict, keyed by the
812 This method keeps said reference in a private dict, keyed by the
812 absolute path of the module object (which corresponds to the script
813 absolute path of the module object (which corresponds to the script
813 path). This way, for multiple executions of the same script we only
814 path). This way, for multiple executions of the same script we only
814 keep one copy of the namespace (the last one), thus preventing memory
815 keep one copy of the namespace (the last one), thus preventing memory
815 leaks from old references while allowing the objects from the last
816 leaks from old references while allowing the objects from the last
816 execution to be accessible.
817 execution to be accessible.
817
818
818 Note: we can not allow the actual FakeModule instances to be deleted,
819 Note: we can not allow the actual FakeModule instances to be deleted,
819 because of how Python tears down modules (it hard-sets all their
820 because of how Python tears down modules (it hard-sets all their
820 references to None without regard for reference counts). This method
821 references to None without regard for reference counts). This method
821 must therefore make a *copy* of the given namespace, to allow the
822 must therefore make a *copy* of the given namespace, to allow the
822 original module's __dict__ to be cleared and reused.
823 original module's __dict__ to be cleared and reused.
823
824
824
825
825 Parameters
826 Parameters
826 ----------
827 ----------
827 ns : a namespace (a dict, typically)
828 ns : a namespace (a dict, typically)
828
829
829 fname : str
830 fname : str
830 Filename associated with the namespace.
831 Filename associated with the namespace.
831
832
832 Examples
833 Examples
833 --------
834 --------
834
835
835 In [10]: import IPython
836 In [10]: import IPython
836
837
837 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
838 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
838
839
839 In [12]: IPython.__file__ in _ip._main_ns_cache
840 In [12]: IPython.__file__ in _ip._main_ns_cache
840 Out[12]: True
841 Out[12]: True
841 """
842 """
842 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
843 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
843
844
844 def clear_main_mod_cache(self):
845 def clear_main_mod_cache(self):
845 """Clear the cache of main modules.
846 """Clear the cache of main modules.
846
847
847 Mainly for use by utilities like %reset.
848 Mainly for use by utilities like %reset.
848
849
849 Examples
850 Examples
850 --------
851 --------
851
852
852 In [15]: import IPython
853 In [15]: import IPython
853
854
854 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
855 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
855
856
856 In [17]: len(_ip._main_ns_cache) > 0
857 In [17]: len(_ip._main_ns_cache) > 0
857 Out[17]: True
858 Out[17]: True
858
859
859 In [18]: _ip.clear_main_mod_cache()
860 In [18]: _ip.clear_main_mod_cache()
860
861
861 In [19]: len(_ip._main_ns_cache) == 0
862 In [19]: len(_ip._main_ns_cache) == 0
862 Out[19]: True
863 Out[19]: True
863 """
864 """
864 self._main_ns_cache.clear()
865 self._main_ns_cache.clear()
865
866
866 #-------------------------------------------------------------------------
867 #-------------------------------------------------------------------------
867 # Things related to debugging
868 # Things related to debugging
868 #-------------------------------------------------------------------------
869 #-------------------------------------------------------------------------
869
870
870 def init_pdb(self):
871 def init_pdb(self):
871 # Set calling of pdb on exceptions
872 # Set calling of pdb on exceptions
872 # self.call_pdb is a property
873 # self.call_pdb is a property
873 self.call_pdb = self.pdb
874 self.call_pdb = self.pdb
874
875
875 def _get_call_pdb(self):
876 def _get_call_pdb(self):
876 return self._call_pdb
877 return self._call_pdb
877
878
878 def _set_call_pdb(self,val):
879 def _set_call_pdb(self,val):
879
880
880 if val not in (0,1,False,True):
881 if val not in (0,1,False,True):
881 raise ValueError,'new call_pdb value must be boolean'
882 raise ValueError,'new call_pdb value must be boolean'
882
883
883 # store value in instance
884 # store value in instance
884 self._call_pdb = val
885 self._call_pdb = val
885
886
886 # notify the actual exception handlers
887 # notify the actual exception handlers
887 self.InteractiveTB.call_pdb = val
888 self.InteractiveTB.call_pdb = val
888
889
889 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
890 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
890 'Control auto-activation of pdb at exceptions')
891 'Control auto-activation of pdb at exceptions')
891
892
892 def debugger(self,force=False):
893 def debugger(self,force=False):
893 """Call the pydb/pdb debugger.
894 """Call the pydb/pdb debugger.
894
895
895 Keywords:
896 Keywords:
896
897
897 - force(False): by default, this routine checks the instance call_pdb
898 - force(False): by default, this routine checks the instance call_pdb
898 flag and does not actually invoke the debugger if the flag is false.
899 flag and does not actually invoke the debugger if the flag is false.
899 The 'force' option forces the debugger to activate even if the flag
900 The 'force' option forces the debugger to activate even if the flag
900 is false.
901 is false.
901 """
902 """
902
903
903 if not (force or self.call_pdb):
904 if not (force or self.call_pdb):
904 return
905 return
905
906
906 if not hasattr(sys,'last_traceback'):
907 if not hasattr(sys,'last_traceback'):
907 error('No traceback has been produced, nothing to debug.')
908 error('No traceback has been produced, nothing to debug.')
908 return
909 return
909
910
910 # use pydb if available
911 # use pydb if available
911 if debugger.has_pydb:
912 if debugger.has_pydb:
912 from pydb import pm
913 from pydb import pm
913 else:
914 else:
914 # fallback to our internal debugger
915 # fallback to our internal debugger
915 pm = lambda : self.InteractiveTB.debugger(force=True)
916 pm = lambda : self.InteractiveTB.debugger(force=True)
916
917
917 with self.readline_no_record:
918 with self.readline_no_record:
918 pm()
919 pm()
919
920
920 #-------------------------------------------------------------------------
921 #-------------------------------------------------------------------------
921 # Things related to IPython's various namespaces
922 # Things related to IPython's various namespaces
922 #-------------------------------------------------------------------------
923 #-------------------------------------------------------------------------
923 default_user_namespaces = True
924 default_user_namespaces = True
924
925
925 def init_create_namespaces(self, user_module=None, user_ns=None):
926 def init_create_namespaces(self, user_module=None, user_ns=None):
926 # Create the namespace where the user will operate. user_ns is
927 # Create the namespace where the user will operate. user_ns is
927 # normally the only one used, and it is passed to the exec calls as
928 # normally the only one used, and it is passed to the exec calls as
928 # the locals argument. But we do carry a user_global_ns namespace
929 # the locals argument. But we do carry a user_global_ns namespace
929 # given as the exec 'globals' argument, This is useful in embedding
930 # given as the exec 'globals' argument, This is useful in embedding
930 # situations where the ipython shell opens in a context where the
931 # situations where the ipython shell opens in a context where the
931 # distinction between locals and globals is meaningful. For
932 # distinction between locals and globals is meaningful. For
932 # non-embedded contexts, it is just the same object as the user_ns dict.
933 # non-embedded contexts, it is just the same object as the user_ns dict.
933
934
934 # FIXME. For some strange reason, __builtins__ is showing up at user
935 # FIXME. For some strange reason, __builtins__ is showing up at user
935 # level as a dict instead of a module. This is a manual fix, but I
936 # level as a dict instead of a module. This is a manual fix, but I
936 # should really track down where the problem is coming from. Alex
937 # should really track down where the problem is coming from. Alex
937 # Schmolck reported this problem first.
938 # Schmolck reported this problem first.
938
939
939 # A useful post by Alex Martelli on this topic:
940 # A useful post by Alex Martelli on this topic:
940 # Re: inconsistent value from __builtins__
941 # Re: inconsistent value from __builtins__
941 # Von: Alex Martelli <aleaxit@yahoo.com>
942 # Von: Alex Martelli <aleaxit@yahoo.com>
942 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
943 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
943 # Gruppen: comp.lang.python
944 # Gruppen: comp.lang.python
944
945
945 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
946 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
946 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
947 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
947 # > <type 'dict'>
948 # > <type 'dict'>
948 # > >>> print type(__builtins__)
949 # > >>> print type(__builtins__)
949 # > <type 'module'>
950 # > <type 'module'>
950 # > Is this difference in return value intentional?
951 # > Is this difference in return value intentional?
951
952
952 # Well, it's documented that '__builtins__' can be either a dictionary
953 # Well, it's documented that '__builtins__' can be either a dictionary
953 # or a module, and it's been that way for a long time. Whether it's
954 # or a module, and it's been that way for a long time. Whether it's
954 # intentional (or sensible), I don't know. In any case, the idea is
955 # intentional (or sensible), I don't know. In any case, the idea is
955 # that if you need to access the built-in namespace directly, you
956 # that if you need to access the built-in namespace directly, you
956 # should start with "import __builtin__" (note, no 's') which will
957 # should start with "import __builtin__" (note, no 's') which will
957 # definitely give you a module. Yeah, it's somewhat confusing:-(.
958 # definitely give you a module. Yeah, it's somewhat confusing:-(.
958
959
959 # These routines return a properly built module and dict as needed by
960 # These routines return a properly built module and dict as needed by
960 # the rest of the code, and can also be used by extension writers to
961 # the rest of the code, and can also be used by extension writers to
961 # generate properly initialized namespaces.
962 # generate properly initialized namespaces.
962 if (user_ns is not None) or (user_module is not None):
963 if (user_ns is not None) or (user_module is not None):
963 self.default_user_namespaces = False
964 self.default_user_namespaces = False
964 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
965 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
965
966
966 # A record of hidden variables we have added to the user namespace, so
967 # A record of hidden variables we have added to the user namespace, so
967 # we can list later only variables defined in actual interactive use.
968 # we can list later only variables defined in actual interactive use.
968 self.user_ns_hidden = set()
969 self.user_ns_hidden = set()
969
970
970 # Now that FakeModule produces a real module, we've run into a nasty
971 # Now that FakeModule produces a real module, we've run into a nasty
971 # problem: after script execution (via %run), the module where the user
972 # problem: after script execution (via %run), the module where the user
972 # code ran is deleted. Now that this object is a true module (needed
973 # code ran is deleted. Now that this object is a true module (needed
973 # so docetst and other tools work correctly), the Python module
974 # so docetst and other tools work correctly), the Python module
974 # teardown mechanism runs over it, and sets to None every variable
975 # teardown mechanism runs over it, and sets to None every variable
975 # present in that module. Top-level references to objects from the
976 # present in that module. Top-level references to objects from the
976 # script survive, because the user_ns is updated with them. However,
977 # script survive, because the user_ns is updated with them. However,
977 # calling functions defined in the script that use other things from
978 # calling functions defined in the script that use other things from
978 # the script will fail, because the function's closure had references
979 # the script will fail, because the function's closure had references
979 # to the original objects, which are now all None. So we must protect
980 # to the original objects, which are now all None. So we must protect
980 # these modules from deletion by keeping a cache.
981 # these modules from deletion by keeping a cache.
981 #
982 #
982 # To avoid keeping stale modules around (we only need the one from the
983 # To avoid keeping stale modules around (we only need the one from the
983 # last run), we use a dict keyed with the full path to the script, so
984 # last run), we use a dict keyed with the full path to the script, so
984 # only the last version of the module is held in the cache. Note,
985 # only the last version of the module is held in the cache. Note,
985 # however, that we must cache the module *namespace contents* (their
986 # however, that we must cache the module *namespace contents* (their
986 # __dict__). Because if we try to cache the actual modules, old ones
987 # __dict__). Because if we try to cache the actual modules, old ones
987 # (uncached) could be destroyed while still holding references (such as
988 # (uncached) could be destroyed while still holding references (such as
988 # those held by GUI objects that tend to be long-lived)>
989 # those held by GUI objects that tend to be long-lived)>
989 #
990 #
990 # The %reset command will flush this cache. See the cache_main_mod()
991 # The %reset command will flush this cache. See the cache_main_mod()
991 # and clear_main_mod_cache() methods for details on use.
992 # and clear_main_mod_cache() methods for details on use.
992
993
993 # This is the cache used for 'main' namespaces
994 # This is the cache used for 'main' namespaces
994 self._main_ns_cache = {}
995 self._main_ns_cache = {}
995 # And this is the single instance of FakeModule whose __dict__ we keep
996 # And this is the single instance of FakeModule whose __dict__ we keep
996 # copying and clearing for reuse on each %run
997 # copying and clearing for reuse on each %run
997 self._user_main_module = FakeModule()
998 self._user_main_module = FakeModule()
998
999
999 # A table holding all the namespaces IPython deals with, so that
1000 # A table holding all the namespaces IPython deals with, so that
1000 # introspection facilities can search easily.
1001 # introspection facilities can search easily.
1001 self.ns_table = {'user_global':self.user_module.__dict__,
1002 self.ns_table = {'user_global':self.user_module.__dict__,
1002 'user_local':self.user_ns,
1003 'user_local':self.user_ns,
1003 'builtin':builtin_mod.__dict__
1004 'builtin':builtin_mod.__dict__
1004 }
1005 }
1005
1006
1006 @property
1007 @property
1007 def user_global_ns(self):
1008 def user_global_ns(self):
1008 return self.user_module.__dict__
1009 return self.user_module.__dict__
1009
1010
1010 def prepare_user_module(self, user_module=None, user_ns=None):
1011 def prepare_user_module(self, user_module=None, user_ns=None):
1011 """Prepare the module and namespace in which user code will be run.
1012 """Prepare the module and namespace in which user code will be run.
1012
1013
1013 When IPython is started normally, both parameters are None: a new module
1014 When IPython is started normally, both parameters are None: a new module
1014 is created automatically, and its __dict__ used as the namespace.
1015 is created automatically, and its __dict__ used as the namespace.
1015
1016
1016 If only user_module is provided, its __dict__ is used as the namespace.
1017 If only user_module is provided, its __dict__ is used as the namespace.
1017 If only user_ns is provided, a dummy module is created, and user_ns
1018 If only user_ns is provided, a dummy module is created, and user_ns
1018 becomes the global namespace. If both are provided (as they may be
1019 becomes the global namespace. If both are provided (as they may be
1019 when embedding), user_ns is the local namespace, and user_module
1020 when embedding), user_ns is the local namespace, and user_module
1020 provides the global namespace.
1021 provides the global namespace.
1021
1022
1022 Parameters
1023 Parameters
1023 ----------
1024 ----------
1024 user_module : module, optional
1025 user_module : module, optional
1025 The current user module in which IPython is being run. If None,
1026 The current user module in which IPython is being run. If None,
1026 a clean module will be created.
1027 a clean module will be created.
1027 user_ns : dict, optional
1028 user_ns : dict, optional
1028 A namespace in which to run interactive commands.
1029 A namespace in which to run interactive commands.
1029
1030
1030 Returns
1031 Returns
1031 -------
1032 -------
1032 A tuple of user_module and user_ns, each properly initialised.
1033 A tuple of user_module and user_ns, each properly initialised.
1033 """
1034 """
1034 if user_module is None and user_ns is not None:
1035 if user_module is None and user_ns is not None:
1035 user_ns.setdefault("__name__", "__main__")
1036 user_ns.setdefault("__name__", "__main__")
1036 class DummyMod(object):
1037 class DummyMod(object):
1037 "A dummy module used for IPython's interactive namespace."
1038 "A dummy module used for IPython's interactive namespace."
1038 pass
1039 pass
1039 user_module = DummyMod()
1040 user_module = DummyMod()
1040 user_module.__dict__ = user_ns
1041 user_module.__dict__ = user_ns
1041
1042
1042 if user_module is None:
1043 if user_module is None:
1043 user_module = types.ModuleType("__main__",
1044 user_module = types.ModuleType("__main__",
1044 doc="Automatically created module for IPython interactive environment")
1045 doc="Automatically created module for IPython interactive environment")
1045
1046
1046 # We must ensure that __builtin__ (without the final 's') is always
1047 # We must ensure that __builtin__ (without the final 's') is always
1047 # available and pointing to the __builtin__ *module*. For more details:
1048 # available and pointing to the __builtin__ *module*. For more details:
1048 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1049 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1049 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1051 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1051
1052
1052 if user_ns is None:
1053 if user_ns is None:
1053 user_ns = user_module.__dict__
1054 user_ns = user_module.__dict__
1054
1055
1055 return user_module, user_ns
1056 return user_module, user_ns
1056
1057
1057 def init_sys_modules(self):
1058 def init_sys_modules(self):
1058 # We need to insert into sys.modules something that looks like a
1059 # We need to insert into sys.modules something that looks like a
1059 # module but which accesses the IPython namespace, for shelve and
1060 # module but which accesses the IPython namespace, for shelve and
1060 # pickle to work interactively. Normally they rely on getting
1061 # pickle to work interactively. Normally they rely on getting
1061 # everything out of __main__, but for embedding purposes each IPython
1062 # everything out of __main__, but for embedding purposes each IPython
1062 # instance has its own private namespace, so we can't go shoving
1063 # instance has its own private namespace, so we can't go shoving
1063 # everything into __main__.
1064 # everything into __main__.
1064
1065
1065 # note, however, that we should only do this for non-embedded
1066 # note, however, that we should only do this for non-embedded
1066 # ipythons, which really mimic the __main__.__dict__ with their own
1067 # ipythons, which really mimic the __main__.__dict__ with their own
1067 # namespace. Embedded instances, on the other hand, should not do
1068 # namespace. Embedded instances, on the other hand, should not do
1068 # this because they need to manage the user local/global namespaces
1069 # this because they need to manage the user local/global namespaces
1069 # only, but they live within a 'normal' __main__ (meaning, they
1070 # only, but they live within a 'normal' __main__ (meaning, they
1070 # shouldn't overtake the execution environment of the script they're
1071 # shouldn't overtake the execution environment of the script they're
1071 # embedded in).
1072 # embedded in).
1072
1073
1073 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1074 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1074 main_name = self.user_module.__name__
1075 main_name = self.user_module.__name__
1075 sys.modules[main_name] = self.user_module
1076 sys.modules[main_name] = self.user_module
1076
1077
1077 def init_user_ns(self):
1078 def init_user_ns(self):
1078 """Initialize all user-visible namespaces to their minimum defaults.
1079 """Initialize all user-visible namespaces to their minimum defaults.
1079
1080
1080 Certain history lists are also initialized here, as they effectively
1081 Certain history lists are also initialized here, as they effectively
1081 act as user namespaces.
1082 act as user namespaces.
1082
1083
1083 Notes
1084 Notes
1084 -----
1085 -----
1085 All data structures here are only filled in, they are NOT reset by this
1086 All data structures here are only filled in, they are NOT reset by this
1086 method. If they were not empty before, data will simply be added to
1087 method. If they were not empty before, data will simply be added to
1087 therm.
1088 therm.
1088 """
1089 """
1089 # This function works in two parts: first we put a few things in
1090 # This function works in two parts: first we put a few things in
1090 # user_ns, and we sync that contents into user_ns_hidden so that these
1091 # user_ns, and we sync that contents into user_ns_hidden so that these
1091 # initial variables aren't shown by %who. After the sync, we add the
1092 # initial variables aren't shown by %who. After the sync, we add the
1092 # rest of what we *do* want the user to see with %who even on a new
1093 # rest of what we *do* want the user to see with %who even on a new
1093 # session (probably nothing, so theye really only see their own stuff)
1094 # session (probably nothing, so theye really only see their own stuff)
1094
1095
1095 # The user dict must *always* have a __builtin__ reference to the
1096 # The user dict must *always* have a __builtin__ reference to the
1096 # Python standard __builtin__ namespace, which must be imported.
1097 # Python standard __builtin__ namespace, which must be imported.
1097 # This is so that certain operations in prompt evaluation can be
1098 # This is so that certain operations in prompt evaluation can be
1098 # reliably executed with builtins. Note that we can NOT use
1099 # reliably executed with builtins. Note that we can NOT use
1099 # __builtins__ (note the 's'), because that can either be a dict or a
1100 # __builtins__ (note the 's'), because that can either be a dict or a
1100 # module, and can even mutate at runtime, depending on the context
1101 # module, and can even mutate at runtime, depending on the context
1101 # (Python makes no guarantees on it). In contrast, __builtin__ is
1102 # (Python makes no guarantees on it). In contrast, __builtin__ is
1102 # always a module object, though it must be explicitly imported.
1103 # always a module object, though it must be explicitly imported.
1103
1104
1104 # For more details:
1105 # For more details:
1105 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1106 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1106 ns = dict()
1107 ns = dict()
1107
1108
1108 # Put 'help' in the user namespace
1109 # Put 'help' in the user namespace
1109 try:
1110 try:
1110 from site import _Helper
1111 from site import _Helper
1111 ns['help'] = _Helper()
1112 ns['help'] = _Helper()
1112 except ImportError:
1113 except ImportError:
1113 warn('help() not available - check site.py')
1114 warn('help() not available - check site.py')
1114
1115
1115 # make global variables for user access to the histories
1116 # make global variables for user access to the histories
1116 ns['_ih'] = self.history_manager.input_hist_parsed
1117 ns['_ih'] = self.history_manager.input_hist_parsed
1117 ns['_oh'] = self.history_manager.output_hist
1118 ns['_oh'] = self.history_manager.output_hist
1118 ns['_dh'] = self.history_manager.dir_hist
1119 ns['_dh'] = self.history_manager.dir_hist
1119
1120
1120 ns['_sh'] = shadowns
1121 ns['_sh'] = shadowns
1121
1122
1122 # user aliases to input and output histories. These shouldn't show up
1123 # user aliases to input and output histories. These shouldn't show up
1123 # in %who, as they can have very large reprs.
1124 # in %who, as they can have very large reprs.
1124 ns['In'] = self.history_manager.input_hist_parsed
1125 ns['In'] = self.history_manager.input_hist_parsed
1125 ns['Out'] = self.history_manager.output_hist
1126 ns['Out'] = self.history_manager.output_hist
1126
1127
1127 # Store myself as the public api!!!
1128 # Store myself as the public api!!!
1128 ns['get_ipython'] = self.get_ipython
1129 ns['get_ipython'] = self.get_ipython
1129
1130
1130 ns['exit'] = self.exiter
1131 ns['exit'] = self.exiter
1131 ns['quit'] = self.exiter
1132 ns['quit'] = self.exiter
1132
1133
1133 # Sync what we've added so far to user_ns_hidden so these aren't seen
1134 # Sync what we've added so far to user_ns_hidden so these aren't seen
1134 # by %who
1135 # by %who
1135 self.user_ns_hidden.update(ns)
1136 self.user_ns_hidden.update(ns)
1136
1137
1137 # Anything put into ns now would show up in %who. Think twice before
1138 # Anything put into ns now would show up in %who. Think twice before
1138 # putting anything here, as we really want %who to show the user their
1139 # putting anything here, as we really want %who to show the user their
1139 # stuff, not our variables.
1140 # stuff, not our variables.
1140
1141
1141 # Finally, update the real user's namespace
1142 # Finally, update the real user's namespace
1142 self.user_ns.update(ns)
1143 self.user_ns.update(ns)
1143
1144
1144 @property
1145 @property
1145 def all_ns_refs(self):
1146 def all_ns_refs(self):
1146 """Get a list of references to all the namespace dictionaries in which
1147 """Get a list of references to all the namespace dictionaries in which
1147 IPython might store a user-created object.
1148 IPython might store a user-created object.
1148
1149
1149 Note that this does not include the displayhook, which also caches
1150 Note that this does not include the displayhook, which also caches
1150 objects from the output."""
1151 objects from the output."""
1151 return [self.user_ns, self.user_global_ns,
1152 return [self.user_ns, self.user_global_ns,
1152 self._user_main_module.__dict__] + self._main_ns_cache.values()
1153 self._user_main_module.__dict__] + self._main_ns_cache.values()
1153
1154
1154 def reset(self, new_session=True):
1155 def reset(self, new_session=True):
1155 """Clear all internal namespaces, and attempt to release references to
1156 """Clear all internal namespaces, and attempt to release references to
1156 user objects.
1157 user objects.
1157
1158
1158 If new_session is True, a new history session will be opened.
1159 If new_session is True, a new history session will be opened.
1159 """
1160 """
1160 # Clear histories
1161 # Clear histories
1161 self.history_manager.reset(new_session)
1162 self.history_manager.reset(new_session)
1162 # Reset counter used to index all histories
1163 # Reset counter used to index all histories
1163 if new_session:
1164 if new_session:
1164 self.execution_count = 1
1165 self.execution_count = 1
1165
1166
1166 # Flush cached output items
1167 # Flush cached output items
1167 if self.displayhook.do_full_cache:
1168 if self.displayhook.do_full_cache:
1168 self.displayhook.flush()
1169 self.displayhook.flush()
1169
1170
1170 # The main execution namespaces must be cleared very carefully,
1171 # The main execution namespaces must be cleared very carefully,
1171 # skipping the deletion of the builtin-related keys, because doing so
1172 # skipping the deletion of the builtin-related keys, because doing so
1172 # would cause errors in many object's __del__ methods.
1173 # would cause errors in many object's __del__ methods.
1173 if self.user_ns is not self.user_global_ns:
1174 if self.user_ns is not self.user_global_ns:
1174 self.user_ns.clear()
1175 self.user_ns.clear()
1175 ns = self.user_global_ns
1176 ns = self.user_global_ns
1176 drop_keys = set(ns.keys())
1177 drop_keys = set(ns.keys())
1177 drop_keys.discard('__builtin__')
1178 drop_keys.discard('__builtin__')
1178 drop_keys.discard('__builtins__')
1179 drop_keys.discard('__builtins__')
1179 drop_keys.discard('__name__')
1180 drop_keys.discard('__name__')
1180 for k in drop_keys:
1181 for k in drop_keys:
1181 del ns[k]
1182 del ns[k]
1182
1183
1183 self.user_ns_hidden.clear()
1184 self.user_ns_hidden.clear()
1184
1185
1185 # Restore the user namespaces to minimal usability
1186 # Restore the user namespaces to minimal usability
1186 self.init_user_ns()
1187 self.init_user_ns()
1187
1188
1188 # Restore the default and user aliases
1189 # Restore the default and user aliases
1189 self.alias_manager.clear_aliases()
1190 self.alias_manager.clear_aliases()
1190 self.alias_manager.init_aliases()
1191 self.alias_manager.init_aliases()
1191
1192
1192 # Flush the private list of module references kept for script
1193 # Flush the private list of module references kept for script
1193 # execution protection
1194 # execution protection
1194 self.clear_main_mod_cache()
1195 self.clear_main_mod_cache()
1195
1196
1196 # Clear out the namespace from the last %run
1197 # Clear out the namespace from the last %run
1197 self.new_main_mod()
1198 self.new_main_mod()
1198
1199
1199 def del_var(self, varname, by_name=False):
1200 def del_var(self, varname, by_name=False):
1200 """Delete a variable from the various namespaces, so that, as
1201 """Delete a variable from the various namespaces, so that, as
1201 far as possible, we're not keeping any hidden references to it.
1202 far as possible, we're not keeping any hidden references to it.
1202
1203
1203 Parameters
1204 Parameters
1204 ----------
1205 ----------
1205 varname : str
1206 varname : str
1206 The name of the variable to delete.
1207 The name of the variable to delete.
1207 by_name : bool
1208 by_name : bool
1208 If True, delete variables with the given name in each
1209 If True, delete variables with the given name in each
1209 namespace. If False (default), find the variable in the user
1210 namespace. If False (default), find the variable in the user
1210 namespace, and delete references to it.
1211 namespace, and delete references to it.
1211 """
1212 """
1212 if varname in ('__builtin__', '__builtins__'):
1213 if varname in ('__builtin__', '__builtins__'):
1213 raise ValueError("Refusing to delete %s" % varname)
1214 raise ValueError("Refusing to delete %s" % varname)
1214
1215
1215 ns_refs = self.all_ns_refs
1216 ns_refs = self.all_ns_refs
1216
1217
1217 if by_name: # Delete by name
1218 if by_name: # Delete by name
1218 for ns in ns_refs:
1219 for ns in ns_refs:
1219 try:
1220 try:
1220 del ns[varname]
1221 del ns[varname]
1221 except KeyError:
1222 except KeyError:
1222 pass
1223 pass
1223 else: # Delete by object
1224 else: # Delete by object
1224 try:
1225 try:
1225 obj = self.user_ns[varname]
1226 obj = self.user_ns[varname]
1226 except KeyError:
1227 except KeyError:
1227 raise NameError("name '%s' is not defined" % varname)
1228 raise NameError("name '%s' is not defined" % varname)
1228 # Also check in output history
1229 # Also check in output history
1229 ns_refs.append(self.history_manager.output_hist)
1230 ns_refs.append(self.history_manager.output_hist)
1230 for ns in ns_refs:
1231 for ns in ns_refs:
1231 to_delete = [n for n, o in ns.iteritems() if o is obj]
1232 to_delete = [n for n, o in ns.iteritems() if o is obj]
1232 for name in to_delete:
1233 for name in to_delete:
1233 del ns[name]
1234 del ns[name]
1234
1235
1235 # displayhook keeps extra references, but not in a dictionary
1236 # displayhook keeps extra references, but not in a dictionary
1236 for name in ('_', '__', '___'):
1237 for name in ('_', '__', '___'):
1237 if getattr(self.displayhook, name) is obj:
1238 if getattr(self.displayhook, name) is obj:
1238 setattr(self.displayhook, name, None)
1239 setattr(self.displayhook, name, None)
1239
1240
1240 def reset_selective(self, regex=None):
1241 def reset_selective(self, regex=None):
1241 """Clear selective variables from internal namespaces based on a
1242 """Clear selective variables from internal namespaces based on a
1242 specified regular expression.
1243 specified regular expression.
1243
1244
1244 Parameters
1245 Parameters
1245 ----------
1246 ----------
1246 regex : string or compiled pattern, optional
1247 regex : string or compiled pattern, optional
1247 A regular expression pattern that will be used in searching
1248 A regular expression pattern that will be used in searching
1248 variable names in the users namespaces.
1249 variable names in the users namespaces.
1249 """
1250 """
1250 if regex is not None:
1251 if regex is not None:
1251 try:
1252 try:
1252 m = re.compile(regex)
1253 m = re.compile(regex)
1253 except TypeError:
1254 except TypeError:
1254 raise TypeError('regex must be a string or compiled pattern')
1255 raise TypeError('regex must be a string or compiled pattern')
1255 # Search for keys in each namespace that match the given regex
1256 # Search for keys in each namespace that match the given regex
1256 # If a match is found, delete the key/value pair.
1257 # If a match is found, delete the key/value pair.
1257 for ns in self.all_ns_refs:
1258 for ns in self.all_ns_refs:
1258 for var in ns:
1259 for var in ns:
1259 if m.search(var):
1260 if m.search(var):
1260 del ns[var]
1261 del ns[var]
1261
1262
1262 def push(self, variables, interactive=True):
1263 def push(self, variables, interactive=True):
1263 """Inject a group of variables into the IPython user namespace.
1264 """Inject a group of variables into the IPython user namespace.
1264
1265
1265 Parameters
1266 Parameters
1266 ----------
1267 ----------
1267 variables : dict, str or list/tuple of str
1268 variables : dict, str or list/tuple of str
1268 The variables to inject into the user's namespace. If a dict, a
1269 The variables to inject into the user's namespace. If a dict, a
1269 simple update is done. If a str, the string is assumed to have
1270 simple update is done. If a str, the string is assumed to have
1270 variable names separated by spaces. A list/tuple of str can also
1271 variable names separated by spaces. A list/tuple of str can also
1271 be used to give the variable names. If just the variable names are
1272 be used to give the variable names. If just the variable names are
1272 give (list/tuple/str) then the variable values looked up in the
1273 give (list/tuple/str) then the variable values looked up in the
1273 callers frame.
1274 callers frame.
1274 interactive : bool
1275 interactive : bool
1275 If True (default), the variables will be listed with the ``who``
1276 If True (default), the variables will be listed with the ``who``
1276 magic.
1277 magic.
1277 """
1278 """
1278 vdict = None
1279 vdict = None
1279
1280
1280 # We need a dict of name/value pairs to do namespace updates.
1281 # We need a dict of name/value pairs to do namespace updates.
1281 if isinstance(variables, dict):
1282 if isinstance(variables, dict):
1282 vdict = variables
1283 vdict = variables
1283 elif isinstance(variables, (basestring, list, tuple)):
1284 elif isinstance(variables, (basestring, list, tuple)):
1284 if isinstance(variables, basestring):
1285 if isinstance(variables, basestring):
1285 vlist = variables.split()
1286 vlist = variables.split()
1286 else:
1287 else:
1287 vlist = variables
1288 vlist = variables
1288 vdict = {}
1289 vdict = {}
1289 cf = sys._getframe(1)
1290 cf = sys._getframe(1)
1290 for name in vlist:
1291 for name in vlist:
1291 try:
1292 try:
1292 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1293 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1293 except:
1294 except:
1294 print ('Could not get variable %s from %s' %
1295 print ('Could not get variable %s from %s' %
1295 (name,cf.f_code.co_name))
1296 (name,cf.f_code.co_name))
1296 else:
1297 else:
1297 raise ValueError('variables must be a dict/str/list/tuple')
1298 raise ValueError('variables must be a dict/str/list/tuple')
1298
1299
1299 # Propagate variables to user namespace
1300 # Propagate variables to user namespace
1300 self.user_ns.update(vdict)
1301 self.user_ns.update(vdict)
1301
1302
1302 # And configure interactive visibility
1303 # And configure interactive visibility
1303 user_ns_hidden = self.user_ns_hidden
1304 user_ns_hidden = self.user_ns_hidden
1304 if interactive:
1305 if interactive:
1305 user_ns_hidden.difference_update(vdict)
1306 user_ns_hidden.difference_update(vdict)
1306 else:
1307 else:
1307 user_ns_hidden.update(vdict)
1308 user_ns_hidden.update(vdict)
1308
1309
1309 def drop_by_id(self, variables):
1310 def drop_by_id(self, variables):
1310 """Remove a dict of variables from the user namespace, if they are the
1311 """Remove a dict of variables from the user namespace, if they are the
1311 same as the values in the dictionary.
1312 same as the values in the dictionary.
1312
1313
1313 This is intended for use by extensions: variables that they've added can
1314 This is intended for use by extensions: variables that they've added can
1314 be taken back out if they are unloaded, without removing any that the
1315 be taken back out if they are unloaded, without removing any that the
1315 user has overwritten.
1316 user has overwritten.
1316
1317
1317 Parameters
1318 Parameters
1318 ----------
1319 ----------
1319 variables : dict
1320 variables : dict
1320 A dictionary mapping object names (as strings) to the objects.
1321 A dictionary mapping object names (as strings) to the objects.
1321 """
1322 """
1322 for name, obj in variables.iteritems():
1323 for name, obj in variables.iteritems():
1323 if name in self.user_ns and self.user_ns[name] is obj:
1324 if name in self.user_ns and self.user_ns[name] is obj:
1324 del self.user_ns[name]
1325 del self.user_ns[name]
1325 self.user_ns_hidden.discard(name)
1326 self.user_ns_hidden.discard(name)
1326
1327
1327 #-------------------------------------------------------------------------
1328 #-------------------------------------------------------------------------
1328 # Things related to object introspection
1329 # Things related to object introspection
1329 #-------------------------------------------------------------------------
1330 #-------------------------------------------------------------------------
1330
1331
1331 def _ofind(self, oname, namespaces=None):
1332 def _ofind(self, oname, namespaces=None):
1332 """Find an object in the available namespaces.
1333 """Find an object in the available namespaces.
1333
1334
1334 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1335 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1335
1336
1336 Has special code to detect magic functions.
1337 Has special code to detect magic functions.
1337 """
1338 """
1338 oname = oname.strip()
1339 oname = oname.strip()
1339 #print '1- oname: <%r>' % oname # dbg
1340 #print '1- oname: <%r>' % oname # dbg
1340 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1341 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1341 return dict(found=False)
1342 return dict(found=False)
1342
1343
1343 alias_ns = None
1344 alias_ns = None
1344 if namespaces is None:
1345 if namespaces is None:
1345 # Namespaces to search in:
1346 # Namespaces to search in:
1346 # Put them in a list. The order is important so that we
1347 # Put them in a list. The order is important so that we
1347 # find things in the same order that Python finds them.
1348 # find things in the same order that Python finds them.
1348 namespaces = [ ('Interactive', self.user_ns),
1349 namespaces = [ ('Interactive', self.user_ns),
1349 ('Interactive (global)', self.user_global_ns),
1350 ('Interactive (global)', self.user_global_ns),
1350 ('Python builtin', builtin_mod.__dict__),
1351 ('Python builtin', builtin_mod.__dict__),
1351 ('Alias', self.alias_manager.alias_table),
1352 ('Alias', self.alias_manager.alias_table),
1352 ]
1353 ]
1353 alias_ns = self.alias_manager.alias_table
1354 alias_ns = self.alias_manager.alias_table
1354
1355
1355 # initialize results to 'null'
1356 # initialize results to 'null'
1356 found = False; obj = None; ospace = None; ds = None;
1357 found = False; obj = None; ospace = None; ds = None;
1357 ismagic = False; isalias = False; parent = None
1358 ismagic = False; isalias = False; parent = None
1358
1359
1359 # We need to special-case 'print', which as of python2.6 registers as a
1360 # We need to special-case 'print', which as of python2.6 registers as a
1360 # function but should only be treated as one if print_function was
1361 # function but should only be treated as one if print_function was
1361 # loaded with a future import. In this case, just bail.
1362 # loaded with a future import. In this case, just bail.
1362 if (oname == 'print' and not py3compat.PY3 and not \
1363 if (oname == 'print' and not py3compat.PY3 and not \
1363 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1364 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1364 return {'found':found, 'obj':obj, 'namespace':ospace,
1365 return {'found':found, 'obj':obj, 'namespace':ospace,
1365 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1366 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1366
1367
1367 # Look for the given name by splitting it in parts. If the head is
1368 # Look for the given name by splitting it in parts. If the head is
1368 # found, then we look for all the remaining parts as members, and only
1369 # found, then we look for all the remaining parts as members, and only
1369 # declare success if we can find them all.
1370 # declare success if we can find them all.
1370 oname_parts = oname.split('.')
1371 oname_parts = oname.split('.')
1371 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1372 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1372 for nsname,ns in namespaces:
1373 for nsname,ns in namespaces:
1373 try:
1374 try:
1374 obj = ns[oname_head]
1375 obj = ns[oname_head]
1375 except KeyError:
1376 except KeyError:
1376 continue
1377 continue
1377 else:
1378 else:
1378 #print 'oname_rest:', oname_rest # dbg
1379 #print 'oname_rest:', oname_rest # dbg
1379 for part in oname_rest:
1380 for part in oname_rest:
1380 try:
1381 try:
1381 parent = obj
1382 parent = obj
1382 obj = getattr(obj,part)
1383 obj = getattr(obj,part)
1383 except:
1384 except:
1384 # Blanket except b/c some badly implemented objects
1385 # Blanket except b/c some badly implemented objects
1385 # allow __getattr__ to raise exceptions other than
1386 # allow __getattr__ to raise exceptions other than
1386 # AttributeError, which then crashes IPython.
1387 # AttributeError, which then crashes IPython.
1387 break
1388 break
1388 else:
1389 else:
1389 # If we finish the for loop (no break), we got all members
1390 # If we finish the for loop (no break), we got all members
1390 found = True
1391 found = True
1391 ospace = nsname
1392 ospace = nsname
1392 if ns == alias_ns:
1393 if ns == alias_ns:
1393 isalias = True
1394 isalias = True
1394 break # namespace loop
1395 break # namespace loop
1395
1396
1396 # Try to see if it's magic
1397 # Try to see if it's magic
1397 if not found:
1398 if not found:
1398 if oname.startswith(ESC_MAGIC):
1399 if oname.startswith(ESC_MAGIC):
1399 oname = oname[1:]
1400 oname = oname[1:]
1400 obj = self.find_magic(oname)
1401 obj = self.find_magic(oname)
1401 if obj is not None:
1402 if obj is not None:
1402 found = True
1403 found = True
1403 ospace = 'IPython internal'
1404 ospace = 'IPython internal'
1404 ismagic = True
1405 ismagic = True
1405
1406
1406 # Last try: special-case some literals like '', [], {}, etc:
1407 # Last try: special-case some literals like '', [], {}, etc:
1407 if not found and oname_head in ["''",'""','[]','{}','()']:
1408 if not found and oname_head in ["''",'""','[]','{}','()']:
1408 obj = eval(oname_head)
1409 obj = eval(oname_head)
1409 found = True
1410 found = True
1410 ospace = 'Interactive'
1411 ospace = 'Interactive'
1411
1412
1412 return {'found':found, 'obj':obj, 'namespace':ospace,
1413 return {'found':found, 'obj':obj, 'namespace':ospace,
1413 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1414 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1414
1415
1415 def _ofind_property(self, oname, info):
1416 def _ofind_property(self, oname, info):
1416 """Second part of object finding, to look for property details."""
1417 """Second part of object finding, to look for property details."""
1417 if info.found:
1418 if info.found:
1418 # Get the docstring of the class property if it exists.
1419 # Get the docstring of the class property if it exists.
1419 path = oname.split('.')
1420 path = oname.split('.')
1420 root = '.'.join(path[:-1])
1421 root = '.'.join(path[:-1])
1421 if info.parent is not None:
1422 if info.parent is not None:
1422 try:
1423 try:
1423 target = getattr(info.parent, '__class__')
1424 target = getattr(info.parent, '__class__')
1424 # The object belongs to a class instance.
1425 # The object belongs to a class instance.
1425 try:
1426 try:
1426 target = getattr(target, path[-1])
1427 target = getattr(target, path[-1])
1427 # The class defines the object.
1428 # The class defines the object.
1428 if isinstance(target, property):
1429 if isinstance(target, property):
1429 oname = root + '.__class__.' + path[-1]
1430 oname = root + '.__class__.' + path[-1]
1430 info = Struct(self._ofind(oname))
1431 info = Struct(self._ofind(oname))
1431 except AttributeError: pass
1432 except AttributeError: pass
1432 except AttributeError: pass
1433 except AttributeError: pass
1433
1434
1434 # We return either the new info or the unmodified input if the object
1435 # We return either the new info or the unmodified input if the object
1435 # hadn't been found
1436 # hadn't been found
1436 return info
1437 return info
1437
1438
1438 def _object_find(self, oname, namespaces=None):
1439 def _object_find(self, oname, namespaces=None):
1439 """Find an object and return a struct with info about it."""
1440 """Find an object and return a struct with info about it."""
1440 inf = Struct(self._ofind(oname, namespaces))
1441 inf = Struct(self._ofind(oname, namespaces))
1441 return Struct(self._ofind_property(oname, inf))
1442 return Struct(self._ofind_property(oname, inf))
1442
1443
1443 def _inspect(self, meth, oname, namespaces=None, **kw):
1444 def _inspect(self, meth, oname, namespaces=None, **kw):
1444 """Generic interface to the inspector system.
1445 """Generic interface to the inspector system.
1445
1446
1446 This function is meant to be called by pdef, pdoc & friends."""
1447 This function is meant to be called by pdef, pdoc & friends."""
1447 info = self._object_find(oname)
1448 info = self._object_find(oname)
1448 if info.found:
1449 if info.found:
1449 pmethod = getattr(self.inspector, meth)
1450 pmethod = getattr(self.inspector, meth)
1450 formatter = format_screen if info.ismagic else None
1451 formatter = format_screen if info.ismagic else None
1451 if meth == 'pdoc':
1452 if meth == 'pdoc':
1452 pmethod(info.obj, oname, formatter)
1453 pmethod(info.obj, oname, formatter)
1453 elif meth == 'pinfo':
1454 elif meth == 'pinfo':
1454 pmethod(info.obj, oname, formatter, info, **kw)
1455 pmethod(info.obj, oname, formatter, info, **kw)
1455 else:
1456 else:
1456 pmethod(info.obj, oname)
1457 pmethod(info.obj, oname)
1457 else:
1458 else:
1458 print 'Object `%s` not found.' % oname
1459 print 'Object `%s` not found.' % oname
1459 return 'not found' # so callers can take other action
1460 return 'not found' # so callers can take other action
1460
1461
1461 def object_inspect(self, oname, detail_level=0):
1462 def object_inspect(self, oname, detail_level=0):
1462 with self.builtin_trap:
1463 with self.builtin_trap:
1463 info = self._object_find(oname)
1464 info = self._object_find(oname)
1464 if info.found:
1465 if info.found:
1465 return self.inspector.info(info.obj, oname, info=info,
1466 return self.inspector.info(info.obj, oname, info=info,
1466 detail_level=detail_level
1467 detail_level=detail_level
1467 )
1468 )
1468 else:
1469 else:
1469 return oinspect.object_info(name=oname, found=False)
1470 return oinspect.object_info(name=oname, found=False)
1470
1471
1471 #-------------------------------------------------------------------------
1472 #-------------------------------------------------------------------------
1472 # Things related to history management
1473 # Things related to history management
1473 #-------------------------------------------------------------------------
1474 #-------------------------------------------------------------------------
1474
1475
1475 def init_history(self):
1476 def init_history(self):
1476 """Sets up the command history, and starts regular autosaves."""
1477 """Sets up the command history, and starts regular autosaves."""
1477 self.history_manager = HistoryManager(shell=self, config=self.config)
1478 self.history_manager = HistoryManager(shell=self, config=self.config)
1478 self.configurables.append(self.history_manager)
1479 self.configurables.append(self.history_manager)
1479
1480
1480 #-------------------------------------------------------------------------
1481 #-------------------------------------------------------------------------
1481 # Things related to exception handling and tracebacks (not debugging)
1482 # Things related to exception handling and tracebacks (not debugging)
1482 #-------------------------------------------------------------------------
1483 #-------------------------------------------------------------------------
1483
1484
1484 def init_traceback_handlers(self, custom_exceptions):
1485 def init_traceback_handlers(self, custom_exceptions):
1485 # Syntax error handler.
1486 # Syntax error handler.
1486 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1487 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1487
1488
1488 # The interactive one is initialized with an offset, meaning we always
1489 # The interactive one is initialized with an offset, meaning we always
1489 # want to remove the topmost item in the traceback, which is our own
1490 # want to remove the topmost item in the traceback, which is our own
1490 # internal code. Valid modes: ['Plain','Context','Verbose']
1491 # internal code. Valid modes: ['Plain','Context','Verbose']
1491 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1492 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1492 color_scheme='NoColor',
1493 color_scheme='NoColor',
1493 tb_offset = 1,
1494 tb_offset = 1,
1494 check_cache=self.compile.check_cache)
1495 check_cache=self.compile.check_cache)
1495
1496
1496 # The instance will store a pointer to the system-wide exception hook,
1497 # The instance will store a pointer to the system-wide exception hook,
1497 # so that runtime code (such as magics) can access it. This is because
1498 # so that runtime code (such as magics) can access it. This is because
1498 # during the read-eval loop, it may get temporarily overwritten.
1499 # during the read-eval loop, it may get temporarily overwritten.
1499 self.sys_excepthook = sys.excepthook
1500 self.sys_excepthook = sys.excepthook
1500
1501
1501 # and add any custom exception handlers the user may have specified
1502 # and add any custom exception handlers the user may have specified
1502 self.set_custom_exc(*custom_exceptions)
1503 self.set_custom_exc(*custom_exceptions)
1503
1504
1504 # Set the exception mode
1505 # Set the exception mode
1505 self.InteractiveTB.set_mode(mode=self.xmode)
1506 self.InteractiveTB.set_mode(mode=self.xmode)
1506
1507
1507 def set_custom_exc(self, exc_tuple, handler):
1508 def set_custom_exc(self, exc_tuple, handler):
1508 """set_custom_exc(exc_tuple,handler)
1509 """set_custom_exc(exc_tuple,handler)
1509
1510
1510 Set a custom exception handler, which will be called if any of the
1511 Set a custom exception handler, which will be called if any of the
1511 exceptions in exc_tuple occur in the mainloop (specifically, in the
1512 exceptions in exc_tuple occur in the mainloop (specifically, in the
1512 run_code() method).
1513 run_code() method).
1513
1514
1514 Parameters
1515 Parameters
1515 ----------
1516 ----------
1516
1517
1517 exc_tuple : tuple of exception classes
1518 exc_tuple : tuple of exception classes
1518 A *tuple* of exception classes, for which to call the defined
1519 A *tuple* of exception classes, for which to call the defined
1519 handler. It is very important that you use a tuple, and NOT A
1520 handler. It is very important that you use a tuple, and NOT A
1520 LIST here, because of the way Python's except statement works. If
1521 LIST here, because of the way Python's except statement works. If
1521 you only want to trap a single exception, use a singleton tuple::
1522 you only want to trap a single exception, use a singleton tuple::
1522
1523
1523 exc_tuple == (MyCustomException,)
1524 exc_tuple == (MyCustomException,)
1524
1525
1525 handler : callable
1526 handler : callable
1526 handler must have the following signature::
1527 handler must have the following signature::
1527
1528
1528 def my_handler(self, etype, value, tb, tb_offset=None):
1529 def my_handler(self, etype, value, tb, tb_offset=None):
1529 ...
1530 ...
1530 return structured_traceback
1531 return structured_traceback
1531
1532
1532 Your handler must return a structured traceback (a list of strings),
1533 Your handler must return a structured traceback (a list of strings),
1533 or None.
1534 or None.
1534
1535
1535 This will be made into an instance method (via types.MethodType)
1536 This will be made into an instance method (via types.MethodType)
1536 of IPython itself, and it will be called if any of the exceptions
1537 of IPython itself, and it will be called if any of the exceptions
1537 listed in the exc_tuple are caught. If the handler is None, an
1538 listed in the exc_tuple are caught. If the handler is None, an
1538 internal basic one is used, which just prints basic info.
1539 internal basic one is used, which just prints basic info.
1539
1540
1540 To protect IPython from crashes, if your handler ever raises an
1541 To protect IPython from crashes, if your handler ever raises an
1541 exception or returns an invalid result, it will be immediately
1542 exception or returns an invalid result, it will be immediately
1542 disabled.
1543 disabled.
1543
1544
1544 WARNING: by putting in your own exception handler into IPython's main
1545 WARNING: by putting in your own exception handler into IPython's main
1545 execution loop, you run a very good chance of nasty crashes. This
1546 execution loop, you run a very good chance of nasty crashes. This
1546 facility should only be used if you really know what you are doing."""
1547 facility should only be used if you really know what you are doing."""
1547
1548
1548 assert type(exc_tuple)==type(()) , \
1549 assert type(exc_tuple)==type(()) , \
1549 "The custom exceptions must be given AS A TUPLE."
1550 "The custom exceptions must be given AS A TUPLE."
1550
1551
1551 def dummy_handler(self,etype,value,tb,tb_offset=None):
1552 def dummy_handler(self,etype,value,tb,tb_offset=None):
1552 print '*** Simple custom exception handler ***'
1553 print '*** Simple custom exception handler ***'
1553 print 'Exception type :',etype
1554 print 'Exception type :',etype
1554 print 'Exception value:',value
1555 print 'Exception value:',value
1555 print 'Traceback :',tb
1556 print 'Traceback :',tb
1556 #print 'Source code :','\n'.join(self.buffer)
1557 #print 'Source code :','\n'.join(self.buffer)
1557
1558
1558 def validate_stb(stb):
1559 def validate_stb(stb):
1559 """validate structured traceback return type
1560 """validate structured traceback return type
1560
1561
1561 return type of CustomTB *should* be a list of strings, but allow
1562 return type of CustomTB *should* be a list of strings, but allow
1562 single strings or None, which are harmless.
1563 single strings or None, which are harmless.
1563
1564
1564 This function will *always* return a list of strings,
1565 This function will *always* return a list of strings,
1565 and will raise a TypeError if stb is inappropriate.
1566 and will raise a TypeError if stb is inappropriate.
1566 """
1567 """
1567 msg = "CustomTB must return list of strings, not %r" % stb
1568 msg = "CustomTB must return list of strings, not %r" % stb
1568 if stb is None:
1569 if stb is None:
1569 return []
1570 return []
1570 elif isinstance(stb, basestring):
1571 elif isinstance(stb, basestring):
1571 return [stb]
1572 return [stb]
1572 elif not isinstance(stb, list):
1573 elif not isinstance(stb, list):
1573 raise TypeError(msg)
1574 raise TypeError(msg)
1574 # it's a list
1575 # it's a list
1575 for line in stb:
1576 for line in stb:
1576 # check every element
1577 # check every element
1577 if not isinstance(line, basestring):
1578 if not isinstance(line, basestring):
1578 raise TypeError(msg)
1579 raise TypeError(msg)
1579 return stb
1580 return stb
1580
1581
1581 if handler is None:
1582 if handler is None:
1582 wrapped = dummy_handler
1583 wrapped = dummy_handler
1583 else:
1584 else:
1584 def wrapped(self,etype,value,tb,tb_offset=None):
1585 def wrapped(self,etype,value,tb,tb_offset=None):
1585 """wrap CustomTB handler, to protect IPython from user code
1586 """wrap CustomTB handler, to protect IPython from user code
1586
1587
1587 This makes it harder (but not impossible) for custom exception
1588 This makes it harder (but not impossible) for custom exception
1588 handlers to crash IPython.
1589 handlers to crash IPython.
1589 """
1590 """
1590 try:
1591 try:
1591 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1592 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1592 return validate_stb(stb)
1593 return validate_stb(stb)
1593 except:
1594 except:
1594 # clear custom handler immediately
1595 # clear custom handler immediately
1595 self.set_custom_exc((), None)
1596 self.set_custom_exc((), None)
1596 print >> io.stderr, "Custom TB Handler failed, unregistering"
1597 print >> io.stderr, "Custom TB Handler failed, unregistering"
1597 # show the exception in handler first
1598 # show the exception in handler first
1598 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1599 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1599 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1600 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1600 print >> io.stdout, "The original exception:"
1601 print >> io.stdout, "The original exception:"
1601 stb = self.InteractiveTB.structured_traceback(
1602 stb = self.InteractiveTB.structured_traceback(
1602 (etype,value,tb), tb_offset=tb_offset
1603 (etype,value,tb), tb_offset=tb_offset
1603 )
1604 )
1604 return stb
1605 return stb
1605
1606
1606 self.CustomTB = types.MethodType(wrapped,self)
1607 self.CustomTB = types.MethodType(wrapped,self)
1607 self.custom_exceptions = exc_tuple
1608 self.custom_exceptions = exc_tuple
1608
1609
1609 def excepthook(self, etype, value, tb):
1610 def excepthook(self, etype, value, tb):
1610 """One more defense for GUI apps that call sys.excepthook.
1611 """One more defense for GUI apps that call sys.excepthook.
1611
1612
1612 GUI frameworks like wxPython trap exceptions and call
1613 GUI frameworks like wxPython trap exceptions and call
1613 sys.excepthook themselves. I guess this is a feature that
1614 sys.excepthook themselves. I guess this is a feature that
1614 enables them to keep running after exceptions that would
1615 enables them to keep running after exceptions that would
1615 otherwise kill their mainloop. This is a bother for IPython
1616 otherwise kill their mainloop. This is a bother for IPython
1616 which excepts to catch all of the program exceptions with a try:
1617 which excepts to catch all of the program exceptions with a try:
1617 except: statement.
1618 except: statement.
1618
1619
1619 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1620 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1620 any app directly invokes sys.excepthook, it will look to the user like
1621 any app directly invokes sys.excepthook, it will look to the user like
1621 IPython crashed. In order to work around this, we can disable the
1622 IPython crashed. In order to work around this, we can disable the
1622 CrashHandler and replace it with this excepthook instead, which prints a
1623 CrashHandler and replace it with this excepthook instead, which prints a
1623 regular traceback using our InteractiveTB. In this fashion, apps which
1624 regular traceback using our InteractiveTB. In this fashion, apps which
1624 call sys.excepthook will generate a regular-looking exception from
1625 call sys.excepthook will generate a regular-looking exception from
1625 IPython, and the CrashHandler will only be triggered by real IPython
1626 IPython, and the CrashHandler will only be triggered by real IPython
1626 crashes.
1627 crashes.
1627
1628
1628 This hook should be used sparingly, only in places which are not likely
1629 This hook should be used sparingly, only in places which are not likely
1629 to be true IPython errors.
1630 to be true IPython errors.
1630 """
1631 """
1631 self.showtraceback((etype,value,tb),tb_offset=0)
1632 self.showtraceback((etype,value,tb),tb_offset=0)
1632
1633
1633 def _get_exc_info(self, exc_tuple=None):
1634 def _get_exc_info(self, exc_tuple=None):
1634 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1635 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1635
1636
1636 Ensures sys.last_type,value,traceback hold the exc_info we found,
1637 Ensures sys.last_type,value,traceback hold the exc_info we found,
1637 from whichever source.
1638 from whichever source.
1638
1639
1639 raises ValueError if none of these contain any information
1640 raises ValueError if none of these contain any information
1640 """
1641 """
1641 if exc_tuple is None:
1642 if exc_tuple is None:
1642 etype, value, tb = sys.exc_info()
1643 etype, value, tb = sys.exc_info()
1643 else:
1644 else:
1644 etype, value, tb = exc_tuple
1645 etype, value, tb = exc_tuple
1645
1646
1646 if etype is None:
1647 if etype is None:
1647 if hasattr(sys, 'last_type'):
1648 if hasattr(sys, 'last_type'):
1648 etype, value, tb = sys.last_type, sys.last_value, \
1649 etype, value, tb = sys.last_type, sys.last_value, \
1649 sys.last_traceback
1650 sys.last_traceback
1650
1651
1651 if etype is None:
1652 if etype is None:
1652 raise ValueError("No exception to find")
1653 raise ValueError("No exception to find")
1653
1654
1654 # Now store the exception info in sys.last_type etc.
1655 # Now store the exception info in sys.last_type etc.
1655 # WARNING: these variables are somewhat deprecated and not
1656 # WARNING: these variables are somewhat deprecated and not
1656 # necessarily safe to use in a threaded environment, but tools
1657 # necessarily safe to use in a threaded environment, but tools
1657 # like pdb depend on their existence, so let's set them. If we
1658 # like pdb depend on their existence, so let's set them. If we
1658 # find problems in the field, we'll need to revisit their use.
1659 # find problems in the field, we'll need to revisit their use.
1659 sys.last_type = etype
1660 sys.last_type = etype
1660 sys.last_value = value
1661 sys.last_value = value
1661 sys.last_traceback = tb
1662 sys.last_traceback = tb
1662
1663
1663 return etype, value, tb
1664 return etype, value, tb
1664
1665
1665
1666
1666 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1667 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1667 exception_only=False):
1668 exception_only=False):
1668 """Display the exception that just occurred.
1669 """Display the exception that just occurred.
1669
1670
1670 If nothing is known about the exception, this is the method which
1671 If nothing is known about the exception, this is the method which
1671 should be used throughout the code for presenting user tracebacks,
1672 should be used throughout the code for presenting user tracebacks,
1672 rather than directly invoking the InteractiveTB object.
1673 rather than directly invoking the InteractiveTB object.
1673
1674
1674 A specific showsyntaxerror() also exists, but this method can take
1675 A specific showsyntaxerror() also exists, but this method can take
1675 care of calling it if needed, so unless you are explicitly catching a
1676 care of calling it if needed, so unless you are explicitly catching a
1676 SyntaxError exception, don't try to analyze the stack manually and
1677 SyntaxError exception, don't try to analyze the stack manually and
1677 simply call this method."""
1678 simply call this method."""
1678
1679
1679 try:
1680 try:
1680 try:
1681 try:
1681 etype, value, tb = self._get_exc_info(exc_tuple)
1682 etype, value, tb = self._get_exc_info(exc_tuple)
1682 except ValueError:
1683 except ValueError:
1683 self.write_err('No traceback available to show.\n')
1684 self.write_err('No traceback available to show.\n')
1684 return
1685 return
1685
1686
1686 if etype is SyntaxError:
1687 if etype is SyntaxError:
1687 # Though this won't be called by syntax errors in the input
1688 # Though this won't be called by syntax errors in the input
1688 # line, there may be SyntaxError cases with imported code.
1689 # line, there may be SyntaxError cases with imported code.
1689 self.showsyntaxerror(filename)
1690 self.showsyntaxerror(filename)
1690 elif etype is UsageError:
1691 elif etype is UsageError:
1691 self.write_err("UsageError: %s" % value)
1692 self.write_err("UsageError: %s" % value)
1692 else:
1693 else:
1693 if etype in self.custom_exceptions:
1694 if etype in self.custom_exceptions:
1694 stb = self.CustomTB(etype, value, tb, tb_offset)
1695 stb = self.CustomTB(etype, value, tb, tb_offset)
1695 else:
1696 else:
1696 if exception_only:
1697 if exception_only:
1697 stb = ['An exception has occurred, use %tb to see '
1698 stb = ['An exception has occurred, use %tb to see '
1698 'the full traceback.\n']
1699 'the full traceback.\n']
1699 stb.extend(self.InteractiveTB.get_exception_only(etype,
1700 stb.extend(self.InteractiveTB.get_exception_only(etype,
1700 value))
1701 value))
1701 else:
1702 else:
1702 stb = self.InteractiveTB.structured_traceback(etype,
1703 stb = self.InteractiveTB.structured_traceback(etype,
1703 value, tb, tb_offset=tb_offset)
1704 value, tb, tb_offset=tb_offset)
1704
1705
1705 self._showtraceback(etype, value, stb)
1706 self._showtraceback(etype, value, stb)
1706 if self.call_pdb:
1707 if self.call_pdb:
1707 # drop into debugger
1708 # drop into debugger
1708 self.debugger(force=True)
1709 self.debugger(force=True)
1709 return
1710 return
1710
1711
1711 # Actually show the traceback
1712 # Actually show the traceback
1712 self._showtraceback(etype, value, stb)
1713 self._showtraceback(etype, value, stb)
1713
1714
1714 except KeyboardInterrupt:
1715 except KeyboardInterrupt:
1715 self.write_err("\nKeyboardInterrupt\n")
1716 self.write_err("\nKeyboardInterrupt\n")
1716
1717
1717 def _showtraceback(self, etype, evalue, stb):
1718 def _showtraceback(self, etype, evalue, stb):
1718 """Actually show a traceback.
1719 """Actually show a traceback.
1719
1720
1720 Subclasses may override this method to put the traceback on a different
1721 Subclasses may override this method to put the traceback on a different
1721 place, like a side channel.
1722 place, like a side channel.
1722 """
1723 """
1723 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1724 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1724
1725
1725 def showsyntaxerror(self, filename=None):
1726 def showsyntaxerror(self, filename=None):
1726 """Display the syntax error that just occurred.
1727 """Display the syntax error that just occurred.
1727
1728
1728 This doesn't display a stack trace because there isn't one.
1729 This doesn't display a stack trace because there isn't one.
1729
1730
1730 If a filename is given, it is stuffed in the exception instead
1731 If a filename is given, it is stuffed in the exception instead
1731 of what was there before (because Python's parser always uses
1732 of what was there before (because Python's parser always uses
1732 "<string>" when reading from a string).
1733 "<string>" when reading from a string).
1733 """
1734 """
1734 etype, value, last_traceback = self._get_exc_info()
1735 etype, value, last_traceback = self._get_exc_info()
1735
1736
1736 if filename and etype is SyntaxError:
1737 if filename and etype is SyntaxError:
1737 try:
1738 try:
1738 value.filename = filename
1739 value.filename = filename
1739 except:
1740 except:
1740 # Not the format we expect; leave it alone
1741 # Not the format we expect; leave it alone
1741 pass
1742 pass
1742
1743
1743 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1744 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1744 self._showtraceback(etype, value, stb)
1745 self._showtraceback(etype, value, stb)
1745
1746
1746 # This is overridden in TerminalInteractiveShell to show a message about
1747 # This is overridden in TerminalInteractiveShell to show a message about
1747 # the %paste magic.
1748 # the %paste magic.
1748 def showindentationerror(self):
1749 def showindentationerror(self):
1749 """Called by run_cell when there's an IndentationError in code entered
1750 """Called by run_cell when there's an IndentationError in code entered
1750 at the prompt.
1751 at the prompt.
1751
1752
1752 This is overridden in TerminalInteractiveShell to show a message about
1753 This is overridden in TerminalInteractiveShell to show a message about
1753 the %paste magic."""
1754 the %paste magic."""
1754 self.showsyntaxerror()
1755 self.showsyntaxerror()
1755
1756
1756 #-------------------------------------------------------------------------
1757 #-------------------------------------------------------------------------
1757 # Things related to readline
1758 # Things related to readline
1758 #-------------------------------------------------------------------------
1759 #-------------------------------------------------------------------------
1759
1760
1760 def init_readline(self):
1761 def init_readline(self):
1761 """Command history completion/saving/reloading."""
1762 """Command history completion/saving/reloading."""
1762
1763
1763 if self.readline_use:
1764 if self.readline_use:
1764 import IPython.utils.rlineimpl as readline
1765 import IPython.utils.rlineimpl as readline
1765
1766
1766 self.rl_next_input = None
1767 self.rl_next_input = None
1767 self.rl_do_indent = False
1768 self.rl_do_indent = False
1768
1769
1769 if not self.readline_use or not readline.have_readline:
1770 if not self.readline_use or not readline.have_readline:
1770 self.has_readline = False
1771 self.has_readline = False
1771 self.readline = None
1772 self.readline = None
1772 # Set a number of methods that depend on readline to be no-op
1773 # Set a number of methods that depend on readline to be no-op
1773 self.readline_no_record = no_op_context
1774 self.readline_no_record = no_op_context
1774 self.set_readline_completer = no_op
1775 self.set_readline_completer = no_op
1775 self.set_custom_completer = no_op
1776 self.set_custom_completer = no_op
1776 self.set_completer_frame = no_op
1777 self.set_completer_frame = no_op
1777 if self.readline_use:
1778 if self.readline_use:
1778 warn('Readline services not available or not loaded.')
1779 warn('Readline services not available or not loaded.')
1779 else:
1780 else:
1780 self.has_readline = True
1781 self.has_readline = True
1781 self.readline = readline
1782 self.readline = readline
1782 sys.modules['readline'] = readline
1783 sys.modules['readline'] = readline
1783
1784
1784 # Platform-specific configuration
1785 # Platform-specific configuration
1785 if os.name == 'nt':
1786 if os.name == 'nt':
1786 # FIXME - check with Frederick to see if we can harmonize
1787 # FIXME - check with Frederick to see if we can harmonize
1787 # naming conventions with pyreadline to avoid this
1788 # naming conventions with pyreadline to avoid this
1788 # platform-dependent check
1789 # platform-dependent check
1789 self.readline_startup_hook = readline.set_pre_input_hook
1790 self.readline_startup_hook = readline.set_pre_input_hook
1790 else:
1791 else:
1791 self.readline_startup_hook = readline.set_startup_hook
1792 self.readline_startup_hook = readline.set_startup_hook
1792
1793
1793 # Load user's initrc file (readline config)
1794 # Load user's initrc file (readline config)
1794 # Or if libedit is used, load editrc.
1795 # Or if libedit is used, load editrc.
1795 inputrc_name = os.environ.get('INPUTRC')
1796 inputrc_name = os.environ.get('INPUTRC')
1796 if inputrc_name is None:
1797 if inputrc_name is None:
1797 inputrc_name = '.inputrc'
1798 inputrc_name = '.inputrc'
1798 if readline.uses_libedit:
1799 if readline.uses_libedit:
1799 inputrc_name = '.editrc'
1800 inputrc_name = '.editrc'
1800 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1801 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1801 if os.path.isfile(inputrc_name):
1802 if os.path.isfile(inputrc_name):
1802 try:
1803 try:
1803 readline.read_init_file(inputrc_name)
1804 readline.read_init_file(inputrc_name)
1804 except:
1805 except:
1805 warn('Problems reading readline initialization file <%s>'
1806 warn('Problems reading readline initialization file <%s>'
1806 % inputrc_name)
1807 % inputrc_name)
1807
1808
1808 # Configure readline according to user's prefs
1809 # Configure readline according to user's prefs
1809 # This is only done if GNU readline is being used. If libedit
1810 # This is only done if GNU readline is being used. If libedit
1810 # is being used (as on Leopard) the readline config is
1811 # is being used (as on Leopard) the readline config is
1811 # not run as the syntax for libedit is different.
1812 # not run as the syntax for libedit is different.
1812 if not readline.uses_libedit:
1813 if not readline.uses_libedit:
1813 for rlcommand in self.readline_parse_and_bind:
1814 for rlcommand in self.readline_parse_and_bind:
1814 #print "loading rl:",rlcommand # dbg
1815 #print "loading rl:",rlcommand # dbg
1815 readline.parse_and_bind(rlcommand)
1816 readline.parse_and_bind(rlcommand)
1816
1817
1817 # Remove some chars from the delimiters list. If we encounter
1818 # Remove some chars from the delimiters list. If we encounter
1818 # unicode chars, discard them.
1819 # unicode chars, discard them.
1819 delims = readline.get_completer_delims()
1820 delims = readline.get_completer_delims()
1820 if not py3compat.PY3:
1821 if not py3compat.PY3:
1821 delims = delims.encode("ascii", "ignore")
1822 delims = delims.encode("ascii", "ignore")
1822 for d in self.readline_remove_delims:
1823 for d in self.readline_remove_delims:
1823 delims = delims.replace(d, "")
1824 delims = delims.replace(d, "")
1824 delims = delims.replace(ESC_MAGIC, '')
1825 delims = delims.replace(ESC_MAGIC, '')
1825 readline.set_completer_delims(delims)
1826 readline.set_completer_delims(delims)
1826 # otherwise we end up with a monster history after a while:
1827 # otherwise we end up with a monster history after a while:
1827 readline.set_history_length(self.history_length)
1828 readline.set_history_length(self.history_length)
1828
1829
1829 self.refill_readline_hist()
1830 self.refill_readline_hist()
1830 self.readline_no_record = ReadlineNoRecord(self)
1831 self.readline_no_record = ReadlineNoRecord(self)
1831
1832
1832 # Configure auto-indent for all platforms
1833 # Configure auto-indent for all platforms
1833 self.set_autoindent(self.autoindent)
1834 self.set_autoindent(self.autoindent)
1834
1835
1835 def refill_readline_hist(self):
1836 def refill_readline_hist(self):
1836 # Load the last 1000 lines from history
1837 # Load the last 1000 lines from history
1837 self.readline.clear_history()
1838 self.readline.clear_history()
1838 stdin_encoding = sys.stdin.encoding or "utf-8"
1839 stdin_encoding = sys.stdin.encoding or "utf-8"
1839 last_cell = u""
1840 last_cell = u""
1840 for _, _, cell in self.history_manager.get_tail(1000,
1841 for _, _, cell in self.history_manager.get_tail(1000,
1841 include_latest=True):
1842 include_latest=True):
1842 # Ignore blank lines and consecutive duplicates
1843 # Ignore blank lines and consecutive duplicates
1843 cell = cell.rstrip()
1844 cell = cell.rstrip()
1844 if cell and (cell != last_cell):
1845 if cell and (cell != last_cell):
1845 if self.multiline_history:
1846 if self.multiline_history:
1846 self.readline.add_history(py3compat.unicode_to_str(cell,
1847 self.readline.add_history(py3compat.unicode_to_str(cell,
1847 stdin_encoding))
1848 stdin_encoding))
1848 else:
1849 else:
1849 for line in cell.splitlines():
1850 for line in cell.splitlines():
1850 self.readline.add_history(py3compat.unicode_to_str(line,
1851 self.readline.add_history(py3compat.unicode_to_str(line,
1851 stdin_encoding))
1852 stdin_encoding))
1852 last_cell = cell
1853 last_cell = cell
1853
1854
1854 def set_next_input(self, s):
1855 def set_next_input(self, s):
1855 """ Sets the 'default' input string for the next command line.
1856 """ Sets the 'default' input string for the next command line.
1856
1857
1857 Requires readline.
1858 Requires readline.
1858
1859
1859 Example:
1860 Example:
1860
1861
1861 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1862 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1862 [D:\ipython]|2> Hello Word_ # cursor is here
1863 [D:\ipython]|2> Hello Word_ # cursor is here
1863 """
1864 """
1864 self.rl_next_input = py3compat.cast_bytes_py2(s)
1865 self.rl_next_input = py3compat.cast_bytes_py2(s)
1865
1866
1866 # Maybe move this to the terminal subclass?
1867 # Maybe move this to the terminal subclass?
1867 def pre_readline(self):
1868 def pre_readline(self):
1868 """readline hook to be used at the start of each line.
1869 """readline hook to be used at the start of each line.
1869
1870
1870 Currently it handles auto-indent only."""
1871 Currently it handles auto-indent only."""
1871
1872
1872 if self.rl_do_indent:
1873 if self.rl_do_indent:
1873 self.readline.insert_text(self._indent_current_str())
1874 self.readline.insert_text(self._indent_current_str())
1874 if self.rl_next_input is not None:
1875 if self.rl_next_input is not None:
1875 self.readline.insert_text(self.rl_next_input)
1876 self.readline.insert_text(self.rl_next_input)
1876 self.rl_next_input = None
1877 self.rl_next_input = None
1877
1878
1878 def _indent_current_str(self):
1879 def _indent_current_str(self):
1879 """return the current level of indentation as a string"""
1880 """return the current level of indentation as a string"""
1880 return self.input_splitter.indent_spaces * ' '
1881 return self.input_splitter.indent_spaces * ' '
1881
1882
1882 #-------------------------------------------------------------------------
1883 #-------------------------------------------------------------------------
1883 # Things related to text completion
1884 # Things related to text completion
1884 #-------------------------------------------------------------------------
1885 #-------------------------------------------------------------------------
1885
1886
1886 def init_completer(self):
1887 def init_completer(self):
1887 """Initialize the completion machinery.
1888 """Initialize the completion machinery.
1888
1889
1889 This creates completion machinery that can be used by client code,
1890 This creates completion machinery that can be used by client code,
1890 either interactively in-process (typically triggered by the readline
1891 either interactively in-process (typically triggered by the readline
1891 library), programatically (such as in test suites) or out-of-prcess
1892 library), programatically (such as in test suites) or out-of-prcess
1892 (typically over the network by remote frontends).
1893 (typically over the network by remote frontends).
1893 """
1894 """
1894 from IPython.core.completer import IPCompleter
1895 from IPython.core.completer import IPCompleter
1895 from IPython.core.completerlib import (module_completer,
1896 from IPython.core.completerlib import (module_completer,
1896 magic_run_completer, cd_completer, reset_completer)
1897 magic_run_completer, cd_completer, reset_completer)
1897
1898
1898 self.Completer = IPCompleter(shell=self,
1899 self.Completer = IPCompleter(shell=self,
1899 namespace=self.user_ns,
1900 namespace=self.user_ns,
1900 global_namespace=self.user_global_ns,
1901 global_namespace=self.user_global_ns,
1901 alias_table=self.alias_manager.alias_table,
1902 alias_table=self.alias_manager.alias_table,
1902 use_readline=self.has_readline,
1903 use_readline=self.has_readline,
1903 config=self.config,
1904 config=self.config,
1904 )
1905 )
1905 self.configurables.append(self.Completer)
1906 self.configurables.append(self.Completer)
1906
1907
1907 # Add custom completers to the basic ones built into IPCompleter
1908 # Add custom completers to the basic ones built into IPCompleter
1908 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1909 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1909 self.strdispatchers['complete_command'] = sdisp
1910 self.strdispatchers['complete_command'] = sdisp
1910 self.Completer.custom_completers = sdisp
1911 self.Completer.custom_completers = sdisp
1911
1912
1912 self.set_hook('complete_command', module_completer, str_key = 'import')
1913 self.set_hook('complete_command', module_completer, str_key = 'import')
1913 self.set_hook('complete_command', module_completer, str_key = 'from')
1914 self.set_hook('complete_command', module_completer, str_key = 'from')
1914 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1915 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1915 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1916 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1916 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1917 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1917
1918
1918 # Only configure readline if we truly are using readline. IPython can
1919 # Only configure readline if we truly are using readline. IPython can
1919 # do tab-completion over the network, in GUIs, etc, where readline
1920 # do tab-completion over the network, in GUIs, etc, where readline
1920 # itself may be absent
1921 # itself may be absent
1921 if self.has_readline:
1922 if self.has_readline:
1922 self.set_readline_completer()
1923 self.set_readline_completer()
1923
1924
1924 def complete(self, text, line=None, cursor_pos=None):
1925 def complete(self, text, line=None, cursor_pos=None):
1925 """Return the completed text and a list of completions.
1926 """Return the completed text and a list of completions.
1926
1927
1927 Parameters
1928 Parameters
1928 ----------
1929 ----------
1929
1930
1930 text : string
1931 text : string
1931 A string of text to be completed on. It can be given as empty and
1932 A string of text to be completed on. It can be given as empty and
1932 instead a line/position pair are given. In this case, the
1933 instead a line/position pair are given. In this case, the
1933 completer itself will split the line like readline does.
1934 completer itself will split the line like readline does.
1934
1935
1935 line : string, optional
1936 line : string, optional
1936 The complete line that text is part of.
1937 The complete line that text is part of.
1937
1938
1938 cursor_pos : int, optional
1939 cursor_pos : int, optional
1939 The position of the cursor on the input line.
1940 The position of the cursor on the input line.
1940
1941
1941 Returns
1942 Returns
1942 -------
1943 -------
1943 text : string
1944 text : string
1944 The actual text that was completed.
1945 The actual text that was completed.
1945
1946
1946 matches : list
1947 matches : list
1947 A sorted list with all possible completions.
1948 A sorted list with all possible completions.
1948
1949
1949 The optional arguments allow the completion to take more context into
1950 The optional arguments allow the completion to take more context into
1950 account, and are part of the low-level completion API.
1951 account, and are part of the low-level completion API.
1951
1952
1952 This is a wrapper around the completion mechanism, similar to what
1953 This is a wrapper around the completion mechanism, similar to what
1953 readline does at the command line when the TAB key is hit. By
1954 readline does at the command line when the TAB key is hit. By
1954 exposing it as a method, it can be used by other non-readline
1955 exposing it as a method, it can be used by other non-readline
1955 environments (such as GUIs) for text completion.
1956 environments (such as GUIs) for text completion.
1956
1957
1957 Simple usage example:
1958 Simple usage example:
1958
1959
1959 In [1]: x = 'hello'
1960 In [1]: x = 'hello'
1960
1961
1961 In [2]: _ip.complete('x.l')
1962 In [2]: _ip.complete('x.l')
1962 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1963 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1963 """
1964 """
1964
1965
1965 # Inject names into __builtin__ so we can complete on the added names.
1966 # Inject names into __builtin__ so we can complete on the added names.
1966 with self.builtin_trap:
1967 with self.builtin_trap:
1967 return self.Completer.complete(text, line, cursor_pos)
1968 return self.Completer.complete(text, line, cursor_pos)
1968
1969
1969 def set_custom_completer(self, completer, pos=0):
1970 def set_custom_completer(self, completer, pos=0):
1970 """Adds a new custom completer function.
1971 """Adds a new custom completer function.
1971
1972
1972 The position argument (defaults to 0) is the index in the completers
1973 The position argument (defaults to 0) is the index in the completers
1973 list where you want the completer to be inserted."""
1974 list where you want the completer to be inserted."""
1974
1975
1975 newcomp = types.MethodType(completer,self.Completer)
1976 newcomp = types.MethodType(completer,self.Completer)
1976 self.Completer.matchers.insert(pos,newcomp)
1977 self.Completer.matchers.insert(pos,newcomp)
1977
1978
1978 def set_readline_completer(self):
1979 def set_readline_completer(self):
1979 """Reset readline's completer to be our own."""
1980 """Reset readline's completer to be our own."""
1980 self.readline.set_completer(self.Completer.rlcomplete)
1981 self.readline.set_completer(self.Completer.rlcomplete)
1981
1982
1982 def set_completer_frame(self, frame=None):
1983 def set_completer_frame(self, frame=None):
1983 """Set the frame of the completer."""
1984 """Set the frame of the completer."""
1984 if frame:
1985 if frame:
1985 self.Completer.namespace = frame.f_locals
1986 self.Completer.namespace = frame.f_locals
1986 self.Completer.global_namespace = frame.f_globals
1987 self.Completer.global_namespace = frame.f_globals
1987 else:
1988 else:
1988 self.Completer.namespace = self.user_ns
1989 self.Completer.namespace = self.user_ns
1989 self.Completer.global_namespace = self.user_global_ns
1990 self.Completer.global_namespace = self.user_global_ns
1990
1991
1991 #-------------------------------------------------------------------------
1992 #-------------------------------------------------------------------------
1992 # Things related to magics
1993 # Things related to magics
1993 #-------------------------------------------------------------------------
1994 #-------------------------------------------------------------------------
1994
1995
1995 def init_magics(self):
1996 def init_magics(self):
1996 # FIXME: Move the color initialization to the DisplayHook, which
1997 # FIXME: Move the color initialization to the DisplayHook, which
1997 # should be split into a prompt manager and displayhook. We probably
1998 # should be split into a prompt manager and displayhook. We probably
1998 # even need a centralize colors management object.
1999 # even need a centralize colors management object.
1999 self.magic('colors %s' % self.colors)
2000 self.magic('colors %s' % self.colors)
2000 # History was moved to a separate module
2001 # History was moved to a separate module
2001 from IPython.core import history
2002 from IPython.core import history
2002 history.init_ipython(self)
2003 history.init_ipython(self)
2003
2004
2004 def magic(self, arg_s, next_input=None):
2005 def magic(self, arg_s, next_input=None):
2005 """Call a magic function by name.
2006 """Call a magic function by name.
2006
2007
2007 Input: a string containing the name of the magic function to call and
2008 Input: a string containing the name of the magic function to call and
2008 any additional arguments to be passed to the magic.
2009 any additional arguments to be passed to the magic.
2009
2010
2010 magic('name -opt foo bar') is equivalent to typing at the ipython
2011 magic('name -opt foo bar') is equivalent to typing at the ipython
2011 prompt:
2012 prompt:
2012
2013
2013 In[1]: %name -opt foo bar
2014 In[1]: %name -opt foo bar
2014
2015
2015 To call a magic without arguments, simply use magic('name').
2016 To call a magic without arguments, simply use magic('name').
2016
2017
2017 This provides a proper Python function to call IPython's magics in any
2018 This provides a proper Python function to call IPython's magics in any
2018 valid Python code you can type at the interpreter, including loops and
2019 valid Python code you can type at the interpreter, including loops and
2019 compound statements.
2020 compound statements.
2020 """
2021 """
2021 # Allow setting the next input - this is used if the user does `a=abs?`.
2022 # Allow setting the next input - this is used if the user does `a=abs?`.
2022 # We do this first so that magic functions can override it.
2023 # We do this first so that magic functions can override it.
2023 if next_input:
2024 if next_input:
2024 self.set_next_input(next_input)
2025 self.set_next_input(next_input)
2025
2026
2026 magic_name, _, magic_arg_s = arg_s.partition(' ')
2027 magic_name, _, magic_arg_s = arg_s.partition(' ')
2027 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2028 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2028
2029
2029 fn = self.find_magic(magic_name)
2030 fn = self.find_magic(magic_name)
2030 if fn is None:
2031 if fn is None:
2031 error("Magic function `%s` not found." % magic_name)
2032 error("Magic function `%s` not found." % magic_name)
2032 else:
2033 else:
2033 magic_arg_s = self.var_expand(magic_arg_s, 1)
2034 magic_arg_s = self.var_expand(magic_arg_s, 1)
2034 # Put magic args in a list so we can call with f(*a) syntax
2035 # Put magic args in a list so we can call with f(*a) syntax
2035 args = [magic_arg_s]
2036 args = [magic_arg_s]
2036 # Grab local namespace if we need it:
2037 # Grab local namespace if we need it:
2037 if getattr(fn, "needs_local_scope", False):
2038 if getattr(fn, "needs_local_scope", False):
2038 args.append(sys._getframe(1).f_locals)
2039 args.append(sys._getframe(1).f_locals)
2039 with self.builtin_trap:
2040 with self.builtin_trap:
2040 result = fn(*args)
2041 result = fn(*args)
2041 return result
2042 return result
2042
2043
2043 def define_magic(self, magic_name, func):
2044 def define_magic(self, magic_name, func):
2044 """Expose own function as magic function for ipython
2045 """Expose own function as magic function for ipython
2045
2046
2046 Example::
2047 Example::
2047
2048
2048 def foo_impl(self,parameter_s=''):
2049 def foo_impl(self,parameter_s=''):
2049 'My very own magic!. (Use docstrings, IPython reads them).'
2050 'My very own magic!. (Use docstrings, IPython reads them).'
2050 print 'Magic function. Passed parameter is between < >:'
2051 print 'Magic function. Passed parameter is between < >:'
2051 print '<%s>' % parameter_s
2052 print '<%s>' % parameter_s
2052 print 'The self object is:', self
2053 print 'The self object is:', self
2053
2054
2054 ip.define_magic('foo',foo_impl)
2055 ip.define_magic('foo',foo_impl)
2055 """
2056 """
2056 im = types.MethodType(func, self._magic)
2057 im = types.MethodType(func, self._magic)
2057 old = self.find_magic(magic_name)
2058 old = self.find_magic(magic_name)
2058 setattr(self._magic, 'magic_' + magic_name, im)
2059 setattr(self._magic, 'magic_' + magic_name, im)
2059 return old
2060 return old
2060
2061
2061 def find_magic(self, magic_name):
2062 def find_magic(self, magic_name):
2062 """Find and return a magic function by name.
2063 """Find and return a magic function by name.
2063 """
2064 """
2064 return getattr(self._magic, 'magic_' + magic_name, None)
2065 return getattr(self._magic, 'magic_' + magic_name, None)
2065
2066
2066 #-------------------------------------------------------------------------
2067 #-------------------------------------------------------------------------
2067 # Things related to macros
2068 # Things related to macros
2068 #-------------------------------------------------------------------------
2069 #-------------------------------------------------------------------------
2069
2070
2070 def define_macro(self, name, themacro):
2071 def define_macro(self, name, themacro):
2071 """Define a new macro
2072 """Define a new macro
2072
2073
2073 Parameters
2074 Parameters
2074 ----------
2075 ----------
2075 name : str
2076 name : str
2076 The name of the macro.
2077 The name of the macro.
2077 themacro : str or Macro
2078 themacro : str or Macro
2078 The action to do upon invoking the macro. If a string, a new
2079 The action to do upon invoking the macro. If a string, a new
2079 Macro object is created by passing the string to it.
2080 Macro object is created by passing the string to it.
2080 """
2081 """
2081
2082
2082 from IPython.core import macro
2083 from IPython.core import macro
2083
2084
2084 if isinstance(themacro, basestring):
2085 if isinstance(themacro, basestring):
2085 themacro = macro.Macro(themacro)
2086 themacro = macro.Macro(themacro)
2086 if not isinstance(themacro, macro.Macro):
2087 if not isinstance(themacro, macro.Macro):
2087 raise ValueError('A macro must be a string or a Macro instance.')
2088 raise ValueError('A macro must be a string or a Macro instance.')
2088 self.user_ns[name] = themacro
2089 self.user_ns[name] = themacro
2089
2090
2090 #-------------------------------------------------------------------------
2091 #-------------------------------------------------------------------------
2091 # Things related to the running of system commands
2092 # Things related to the running of system commands
2092 #-------------------------------------------------------------------------
2093 #-------------------------------------------------------------------------
2093
2094
2094 def system_piped(self, cmd):
2095 def system_piped(self, cmd):
2095 """Call the given cmd in a subprocess, piping stdout/err
2096 """Call the given cmd in a subprocess, piping stdout/err
2096
2097
2097 Parameters
2098 Parameters
2098 ----------
2099 ----------
2099 cmd : str
2100 cmd : str
2100 Command to execute (can not end in '&', as background processes are
2101 Command to execute (can not end in '&', as background processes are
2101 not supported. Should not be a command that expects input
2102 not supported. Should not be a command that expects input
2102 other than simple text.
2103 other than simple text.
2103 """
2104 """
2104 if cmd.rstrip().endswith('&'):
2105 if cmd.rstrip().endswith('&'):
2105 # this is *far* from a rigorous test
2106 # this is *far* from a rigorous test
2106 # We do not support backgrounding processes because we either use
2107 # We do not support backgrounding processes because we either use
2107 # pexpect or pipes to read from. Users can always just call
2108 # pexpect or pipes to read from. Users can always just call
2108 # os.system() or use ip.system=ip.system_raw
2109 # os.system() or use ip.system=ip.system_raw
2109 # if they really want a background process.
2110 # if they really want a background process.
2110 raise OSError("Background processes not supported.")
2111 raise OSError("Background processes not supported.")
2111
2112
2112 # we explicitly do NOT return the subprocess status code, because
2113 # we explicitly do NOT return the subprocess status code, because
2113 # a non-None value would trigger :func:`sys.displayhook` calls.
2114 # a non-None value would trigger :func:`sys.displayhook` calls.
2114 # Instead, we store the exit_code in user_ns.
2115 # Instead, we store the exit_code in user_ns.
2115 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2116 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2116
2117
2117 def system_raw(self, cmd):
2118 def system_raw(self, cmd):
2118 """Call the given cmd in a subprocess using os.system
2119 """Call the given cmd in a subprocess using os.system
2119
2120
2120 Parameters
2121 Parameters
2121 ----------
2122 ----------
2122 cmd : str
2123 cmd : str
2123 Command to execute.
2124 Command to execute.
2124 """
2125 """
2125 cmd = self.var_expand(cmd, depth=2)
2126 cmd = self.var_expand(cmd, depth=2)
2126 # protect os.system from UNC paths on Windows, which it can't handle:
2127 # protect os.system from UNC paths on Windows, which it can't handle:
2127 if sys.platform == 'win32':
2128 if sys.platform == 'win32':
2128 from IPython.utils._process_win32 import AvoidUNCPath
2129 from IPython.utils._process_win32 import AvoidUNCPath
2129 with AvoidUNCPath() as path:
2130 with AvoidUNCPath() as path:
2130 if path is not None:
2131 if path is not None:
2131 cmd = '"pushd %s &&"%s' % (path, cmd)
2132 cmd = '"pushd %s &&"%s' % (path, cmd)
2132 cmd = py3compat.unicode_to_str(cmd)
2133 cmd = py3compat.unicode_to_str(cmd)
2133 ec = os.system(cmd)
2134 ec = os.system(cmd)
2134 else:
2135 else:
2135 cmd = py3compat.unicode_to_str(cmd)
2136 cmd = py3compat.unicode_to_str(cmd)
2136 ec = os.system(cmd)
2137 ec = os.system(cmd)
2137
2138
2138 # We explicitly do NOT return the subprocess status code, because
2139 # We explicitly do NOT return the subprocess status code, because
2139 # a non-None value would trigger :func:`sys.displayhook` calls.
2140 # a non-None value would trigger :func:`sys.displayhook` calls.
2140 # Instead, we store the exit_code in user_ns.
2141 # Instead, we store the exit_code in user_ns.
2141 self.user_ns['_exit_code'] = ec
2142 self.user_ns['_exit_code'] = ec
2142
2143
2143 # use piped system by default, because it is better behaved
2144 # use piped system by default, because it is better behaved
2144 system = system_piped
2145 system = system_piped
2145
2146
2146 def getoutput(self, cmd, split=True):
2147 def getoutput(self, cmd, split=True):
2147 """Get output (possibly including stderr) from a subprocess.
2148 """Get output (possibly including stderr) from a subprocess.
2148
2149
2149 Parameters
2150 Parameters
2150 ----------
2151 ----------
2151 cmd : str
2152 cmd : str
2152 Command to execute (can not end in '&', as background processes are
2153 Command to execute (can not end in '&', as background processes are
2153 not supported.
2154 not supported.
2154 split : bool, optional
2155 split : bool, optional
2155
2156
2156 If True, split the output into an IPython SList. Otherwise, an
2157 If True, split the output into an IPython SList. Otherwise, an
2157 IPython LSString is returned. These are objects similar to normal
2158 IPython LSString is returned. These are objects similar to normal
2158 lists and strings, with a few convenience attributes for easier
2159 lists and strings, with a few convenience attributes for easier
2159 manipulation of line-based output. You can use '?' on them for
2160 manipulation of line-based output. You can use '?' on them for
2160 details.
2161 details.
2161 """
2162 """
2162 if cmd.rstrip().endswith('&'):
2163 if cmd.rstrip().endswith('&'):
2163 # this is *far* from a rigorous test
2164 # this is *far* from a rigorous test
2164 raise OSError("Background processes not supported.")
2165 raise OSError("Background processes not supported.")
2165 out = getoutput(self.var_expand(cmd, depth=2))
2166 out = getoutput(self.var_expand(cmd, depth=2))
2166 if split:
2167 if split:
2167 out = SList(out.splitlines())
2168 out = SList(out.splitlines())
2168 else:
2169 else:
2169 out = LSString(out)
2170 out = LSString(out)
2170 return out
2171 return out
2171
2172
2172 #-------------------------------------------------------------------------
2173 #-------------------------------------------------------------------------
2173 # Things related to aliases
2174 # Things related to aliases
2174 #-------------------------------------------------------------------------
2175 #-------------------------------------------------------------------------
2175
2176
2176 def init_alias(self):
2177 def init_alias(self):
2177 self.alias_manager = AliasManager(shell=self, config=self.config)
2178 self.alias_manager = AliasManager(shell=self, config=self.config)
2178 self.configurables.append(self.alias_manager)
2179 self.configurables.append(self.alias_manager)
2179 self.ns_table['alias'] = self.alias_manager.alias_table,
2180 self.ns_table['alias'] = self.alias_manager.alias_table,
2180
2181
2181 #-------------------------------------------------------------------------
2182 #-------------------------------------------------------------------------
2182 # Things related to extensions and plugins
2183 # Things related to extensions and plugins
2183 #-------------------------------------------------------------------------
2184 #-------------------------------------------------------------------------
2184
2185
2185 def init_extension_manager(self):
2186 def init_extension_manager(self):
2186 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2187 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2187 self.configurables.append(self.extension_manager)
2188 self.configurables.append(self.extension_manager)
2188
2189
2189 def init_plugin_manager(self):
2190 def init_plugin_manager(self):
2190 self.plugin_manager = PluginManager(config=self.config)
2191 self.plugin_manager = PluginManager(config=self.config)
2191 self.configurables.append(self.plugin_manager)
2192 self.configurables.append(self.plugin_manager)
2192
2193
2193
2194
2194 #-------------------------------------------------------------------------
2195 #-------------------------------------------------------------------------
2195 # Things related to payloads
2196 # Things related to payloads
2196 #-------------------------------------------------------------------------
2197 #-------------------------------------------------------------------------
2197
2198
2198 def init_payload(self):
2199 def init_payload(self):
2199 self.payload_manager = PayloadManager(config=self.config)
2200 self.payload_manager = PayloadManager(config=self.config)
2200 self.configurables.append(self.payload_manager)
2201 self.configurables.append(self.payload_manager)
2201
2202
2202 #-------------------------------------------------------------------------
2203 #-------------------------------------------------------------------------
2203 # Things related to the prefilter
2204 # Things related to the prefilter
2204 #-------------------------------------------------------------------------
2205 #-------------------------------------------------------------------------
2205
2206
2206 def init_prefilter(self):
2207 def init_prefilter(self):
2207 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2208 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2208 self.configurables.append(self.prefilter_manager)
2209 self.configurables.append(self.prefilter_manager)
2209 # Ultimately this will be refactored in the new interpreter code, but
2210 # Ultimately this will be refactored in the new interpreter code, but
2210 # for now, we should expose the main prefilter method (there's legacy
2211 # for now, we should expose the main prefilter method (there's legacy
2211 # code out there that may rely on this).
2212 # code out there that may rely on this).
2212 self.prefilter = self.prefilter_manager.prefilter_lines
2213 self.prefilter = self.prefilter_manager.prefilter_lines
2213
2214
2214 def auto_rewrite_input(self, cmd):
2215 def auto_rewrite_input(self, cmd):
2215 """Print to the screen the rewritten form of the user's command.
2216 """Print to the screen the rewritten form of the user's command.
2216
2217
2217 This shows visual feedback by rewriting input lines that cause
2218 This shows visual feedback by rewriting input lines that cause
2218 automatic calling to kick in, like::
2219 automatic calling to kick in, like::
2219
2220
2220 /f x
2221 /f x
2221
2222
2222 into::
2223 into::
2223
2224
2224 ------> f(x)
2225 ------> f(x)
2225
2226
2226 after the user's input prompt. This helps the user understand that the
2227 after the user's input prompt. This helps the user understand that the
2227 input line was transformed automatically by IPython.
2228 input line was transformed automatically by IPython.
2228 """
2229 """
2229 if not self.show_rewritten_input:
2230 if not self.show_rewritten_input:
2230 return
2231 return
2231
2232
2232 rw = self.prompt_manager.render('rewrite') + cmd
2233 rw = self.prompt_manager.render('rewrite') + cmd
2233
2234
2234 try:
2235 try:
2235 # plain ascii works better w/ pyreadline, on some machines, so
2236 # plain ascii works better w/ pyreadline, on some machines, so
2236 # we use it and only print uncolored rewrite if we have unicode
2237 # we use it and only print uncolored rewrite if we have unicode
2237 rw = str(rw)
2238 rw = str(rw)
2238 print >> io.stdout, rw
2239 print >> io.stdout, rw
2239 except UnicodeEncodeError:
2240 except UnicodeEncodeError:
2240 print "------> " + cmd
2241 print "------> " + cmd
2241
2242
2242 #-------------------------------------------------------------------------
2243 #-------------------------------------------------------------------------
2243 # Things related to extracting values/expressions from kernel and user_ns
2244 # Things related to extracting values/expressions from kernel and user_ns
2244 #-------------------------------------------------------------------------
2245 #-------------------------------------------------------------------------
2245
2246
2246 def _simple_error(self):
2247 def _simple_error(self):
2247 etype, value = sys.exc_info()[:2]
2248 etype, value = sys.exc_info()[:2]
2248 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2249 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2249
2250
2250 def user_variables(self, names):
2251 def user_variables(self, names):
2251 """Get a list of variable names from the user's namespace.
2252 """Get a list of variable names from the user's namespace.
2252
2253
2253 Parameters
2254 Parameters
2254 ----------
2255 ----------
2255 names : list of strings
2256 names : list of strings
2256 A list of names of variables to be read from the user namespace.
2257 A list of names of variables to be read from the user namespace.
2257
2258
2258 Returns
2259 Returns
2259 -------
2260 -------
2260 A dict, keyed by the input names and with the repr() of each value.
2261 A dict, keyed by the input names and with the repr() of each value.
2261 """
2262 """
2262 out = {}
2263 out = {}
2263 user_ns = self.user_ns
2264 user_ns = self.user_ns
2264 for varname in names:
2265 for varname in names:
2265 try:
2266 try:
2266 value = repr(user_ns[varname])
2267 value = repr(user_ns[varname])
2267 except:
2268 except:
2268 value = self._simple_error()
2269 value = self._simple_error()
2269 out[varname] = value
2270 out[varname] = value
2270 return out
2271 return out
2271
2272
2272 def user_expressions(self, expressions):
2273 def user_expressions(self, expressions):
2273 """Evaluate a dict of expressions in the user's namespace.
2274 """Evaluate a dict of expressions in the user's namespace.
2274
2275
2275 Parameters
2276 Parameters
2276 ----------
2277 ----------
2277 expressions : dict
2278 expressions : dict
2278 A dict with string keys and string values. The expression values
2279 A dict with string keys and string values. The expression values
2279 should be valid Python expressions, each of which will be evaluated
2280 should be valid Python expressions, each of which will be evaluated
2280 in the user namespace.
2281 in the user namespace.
2281
2282
2282 Returns
2283 Returns
2283 -------
2284 -------
2284 A dict, keyed like the input expressions dict, with the repr() of each
2285 A dict, keyed like the input expressions dict, with the repr() of each
2285 value.
2286 value.
2286 """
2287 """
2287 out = {}
2288 out = {}
2288 user_ns = self.user_ns
2289 user_ns = self.user_ns
2289 global_ns = self.user_global_ns
2290 global_ns = self.user_global_ns
2290 for key, expr in expressions.iteritems():
2291 for key, expr in expressions.iteritems():
2291 try:
2292 try:
2292 value = repr(eval(expr, global_ns, user_ns))
2293 value = repr(eval(expr, global_ns, user_ns))
2293 except:
2294 except:
2294 value = self._simple_error()
2295 value = self._simple_error()
2295 out[key] = value
2296 out[key] = value
2296 return out
2297 return out
2297
2298
2298 #-------------------------------------------------------------------------
2299 #-------------------------------------------------------------------------
2299 # Things related to the running of code
2300 # Things related to the running of code
2300 #-------------------------------------------------------------------------
2301 #-------------------------------------------------------------------------
2301
2302
2302 def ex(self, cmd):
2303 def ex(self, cmd):
2303 """Execute a normal python statement in user namespace."""
2304 """Execute a normal python statement in user namespace."""
2304 with self.builtin_trap:
2305 with self.builtin_trap:
2305 exec cmd in self.user_global_ns, self.user_ns
2306 exec cmd in self.user_global_ns, self.user_ns
2306
2307
2307 def ev(self, expr):
2308 def ev(self, expr):
2308 """Evaluate python expression expr in user namespace.
2309 """Evaluate python expression expr in user namespace.
2309
2310
2310 Returns the result of evaluation
2311 Returns the result of evaluation
2311 """
2312 """
2312 with self.builtin_trap:
2313 with self.builtin_trap:
2313 return eval(expr, self.user_global_ns, self.user_ns)
2314 return eval(expr, self.user_global_ns, self.user_ns)
2314
2315
2315 def safe_execfile(self, fname, *where, **kw):
2316 def safe_execfile(self, fname, *where, **kw):
2316 """A safe version of the builtin execfile().
2317 """A safe version of the builtin execfile().
2317
2318
2318 This version will never throw an exception, but instead print
2319 This version will never throw an exception, but instead print
2319 helpful error messages to the screen. This only works on pure
2320 helpful error messages to the screen. This only works on pure
2320 Python files with the .py extension.
2321 Python files with the .py extension.
2321
2322
2322 Parameters
2323 Parameters
2323 ----------
2324 ----------
2324 fname : string
2325 fname : string
2325 The name of the file to be executed.
2326 The name of the file to be executed.
2326 where : tuple
2327 where : tuple
2327 One or two namespaces, passed to execfile() as (globals,locals).
2328 One or two namespaces, passed to execfile() as (globals,locals).
2328 If only one is given, it is passed as both.
2329 If only one is given, it is passed as both.
2329 exit_ignore : bool (False)
2330 exit_ignore : bool (False)
2330 If True, then silence SystemExit for non-zero status (it is always
2331 If True, then silence SystemExit for non-zero status (it is always
2331 silenced for zero status, as it is so common).
2332 silenced for zero status, as it is so common).
2332 raise_exceptions : bool (False)
2333 raise_exceptions : bool (False)
2333 If True raise exceptions everywhere. Meant for testing.
2334 If True raise exceptions everywhere. Meant for testing.
2334
2335
2335 """
2336 """
2336 kw.setdefault('exit_ignore', False)
2337 kw.setdefault('exit_ignore', False)
2337 kw.setdefault('raise_exceptions', False)
2338 kw.setdefault('raise_exceptions', False)
2338
2339
2339 fname = os.path.abspath(os.path.expanduser(fname))
2340 fname = os.path.abspath(os.path.expanduser(fname))
2340
2341
2341 # Make sure we can open the file
2342 # Make sure we can open the file
2342 try:
2343 try:
2343 with open(fname) as thefile:
2344 with open(fname) as thefile:
2344 pass
2345 pass
2345 except:
2346 except:
2346 warn('Could not open file <%s> for safe execution.' % fname)
2347 warn('Could not open file <%s> for safe execution.' % fname)
2347 return
2348 return
2348
2349
2349 # Find things also in current directory. This is needed to mimic the
2350 # Find things also in current directory. This is needed to mimic the
2350 # behavior of running a script from the system command line, where
2351 # behavior of running a script from the system command line, where
2351 # Python inserts the script's directory into sys.path
2352 # Python inserts the script's directory into sys.path
2352 dname = os.path.dirname(fname)
2353 dname = os.path.dirname(fname)
2353
2354
2354 with prepended_to_syspath(dname):
2355 with prepended_to_syspath(dname):
2355 try:
2356 try:
2356 py3compat.execfile(fname,*where)
2357 py3compat.execfile(fname,*where)
2357 except SystemExit, status:
2358 except SystemExit, status:
2358 # If the call was made with 0 or None exit status (sys.exit(0)
2359 # If the call was made with 0 or None exit status (sys.exit(0)
2359 # or sys.exit() ), don't bother showing a traceback, as both of
2360 # or sys.exit() ), don't bother showing a traceback, as both of
2360 # these are considered normal by the OS:
2361 # these are considered normal by the OS:
2361 # > python -c'import sys;sys.exit(0)'; echo $?
2362 # > python -c'import sys;sys.exit(0)'; echo $?
2362 # 0
2363 # 0
2363 # > python -c'import sys;sys.exit()'; echo $?
2364 # > python -c'import sys;sys.exit()'; echo $?
2364 # 0
2365 # 0
2365 # For other exit status, we show the exception unless
2366 # For other exit status, we show the exception unless
2366 # explicitly silenced, but only in short form.
2367 # explicitly silenced, but only in short form.
2367 if kw['raise_exceptions']:
2368 if kw['raise_exceptions']:
2368 raise
2369 raise
2369 if status.code not in (0, None) and not kw['exit_ignore']:
2370 if status.code not in (0, None) and not kw['exit_ignore']:
2370 self.showtraceback(exception_only=True)
2371 self.showtraceback(exception_only=True)
2371 except:
2372 except:
2372 if kw['raise_exceptions']:
2373 if kw['raise_exceptions']:
2373 raise
2374 raise
2374 self.showtraceback()
2375 self.showtraceback()
2375
2376
2376 def safe_execfile_ipy(self, fname):
2377 def safe_execfile_ipy(self, fname):
2377 """Like safe_execfile, but for .ipy files with IPython syntax.
2378 """Like safe_execfile, but for .ipy files with IPython syntax.
2378
2379
2379 Parameters
2380 Parameters
2380 ----------
2381 ----------
2381 fname : str
2382 fname : str
2382 The name of the file to execute. The filename must have a
2383 The name of the file to execute. The filename must have a
2383 .ipy extension.
2384 .ipy extension.
2384 """
2385 """
2385 fname = os.path.abspath(os.path.expanduser(fname))
2386 fname = os.path.abspath(os.path.expanduser(fname))
2386
2387
2387 # Make sure we can open the file
2388 # Make sure we can open the file
2388 try:
2389 try:
2389 with open(fname) as thefile:
2390 with open(fname) as thefile:
2390 pass
2391 pass
2391 except:
2392 except:
2392 warn('Could not open file <%s> for safe execution.' % fname)
2393 warn('Could not open file <%s> for safe execution.' % fname)
2393 return
2394 return
2394
2395
2395 # Find things also in current directory. This is needed to mimic the
2396 # Find things also in current directory. This is needed to mimic the
2396 # behavior of running a script from the system command line, where
2397 # behavior of running a script from the system command line, where
2397 # Python inserts the script's directory into sys.path
2398 # Python inserts the script's directory into sys.path
2398 dname = os.path.dirname(fname)
2399 dname = os.path.dirname(fname)
2399
2400
2400 with prepended_to_syspath(dname):
2401 with prepended_to_syspath(dname):
2401 try:
2402 try:
2402 with open(fname) as thefile:
2403 with open(fname) as thefile:
2403 # self.run_cell currently captures all exceptions
2404 # self.run_cell currently captures all exceptions
2404 # raised in user code. It would be nice if there were
2405 # raised in user code. It would be nice if there were
2405 # versions of runlines, execfile that did raise, so
2406 # versions of runlines, execfile that did raise, so
2406 # we could catch the errors.
2407 # we could catch the errors.
2407 self.run_cell(thefile.read(), store_history=False)
2408 self.run_cell(thefile.read(), store_history=False)
2408 except:
2409 except:
2409 self.showtraceback()
2410 self.showtraceback()
2410 warn('Unknown failure executing file: <%s>' % fname)
2411 warn('Unknown failure executing file: <%s>' % fname)
2411
2412
2412 def safe_run_module(self, mod_name, where):
2413 def safe_run_module(self, mod_name, where):
2413 """A safe version of runpy.run_module().
2414 """A safe version of runpy.run_module().
2414
2415
2415 This version will never throw an exception, but instead print
2416 This version will never throw an exception, but instead print
2416 helpful error messages to the screen.
2417 helpful error messages to the screen.
2417
2418
2418 Parameters
2419 Parameters
2419 ----------
2420 ----------
2420 mod_name : string
2421 mod_name : string
2421 The name of the module to be executed.
2422 The name of the module to be executed.
2422 where : dict
2423 where : dict
2423 The globals namespace.
2424 The globals namespace.
2424 """
2425 """
2425 try:
2426 try:
2426 where.update(
2427 where.update(
2427 runpy.run_module(str(mod_name), run_name="__main__",
2428 runpy.run_module(str(mod_name), run_name="__main__",
2428 alter_sys=True)
2429 alter_sys=True)
2429 )
2430 )
2430 except:
2431 except:
2431 self.showtraceback()
2432 self.showtraceback()
2432 warn('Unknown failure executing module: <%s>' % mod_name)
2433 warn('Unknown failure executing module: <%s>' % mod_name)
2433
2434
2434 def run_cell(self, raw_cell, store_history=False, silent=False):
2435 def run_cell(self, raw_cell, store_history=False, silent=False):
2435 """Run a complete IPython cell.
2436 """Run a complete IPython cell.
2436
2437
2437 Parameters
2438 Parameters
2438 ----------
2439 ----------
2439 raw_cell : str
2440 raw_cell : str
2440 The code (including IPython code such as %magic functions) to run.
2441 The code (including IPython code such as %magic functions) to run.
2441 store_history : bool
2442 store_history : bool
2442 If True, the raw and translated cell will be stored in IPython's
2443 If True, the raw and translated cell will be stored in IPython's
2443 history. For user code calling back into IPython's machinery, this
2444 history. For user code calling back into IPython's machinery, this
2444 should be set to False.
2445 should be set to False.
2445 silent : bool
2446 silent : bool
2446 If True, avoid side-effets, such as implicit displayhooks, history,
2447 If True, avoid side-effets, such as implicit displayhooks, history,
2447 and logging. silent=True forces store_history=False.
2448 and logging. silent=True forces store_history=False.
2448 """
2449 """
2449 if (not raw_cell) or raw_cell.isspace():
2450 if (not raw_cell) or raw_cell.isspace():
2450 return
2451 return
2451
2452
2452 if silent:
2453 if silent:
2453 store_history = False
2454 store_history = False
2454
2455
2455 for line in raw_cell.splitlines():
2456 for line in raw_cell.splitlines():
2456 self.input_splitter.push(line)
2457 self.input_splitter.push(line)
2457 cell = self.input_splitter.source_reset()
2458 cell = self.input_splitter.source_reset()
2458
2459
2459 with self.builtin_trap:
2460 with self.builtin_trap:
2460 prefilter_failed = False
2461 prefilter_failed = False
2461 if len(cell.splitlines()) == 1:
2462 if len(cell.splitlines()) == 1:
2462 try:
2463 try:
2463 # use prefilter_lines to handle trailing newlines
2464 # use prefilter_lines to handle trailing newlines
2464 # restore trailing newline for ast.parse
2465 # restore trailing newline for ast.parse
2465 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2466 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2466 except AliasError as e:
2467 except AliasError as e:
2467 error(e)
2468 error(e)
2468 prefilter_failed = True
2469 prefilter_failed = True
2469 except Exception:
2470 except Exception:
2470 # don't allow prefilter errors to crash IPython
2471 # don't allow prefilter errors to crash IPython
2471 self.showtraceback()
2472 self.showtraceback()
2472 prefilter_failed = True
2473 prefilter_failed = True
2473
2474
2474 # Store raw and processed history
2475 # Store raw and processed history
2475 if store_history:
2476 if store_history:
2476 self.history_manager.store_inputs(self.execution_count,
2477 self.history_manager.store_inputs(self.execution_count,
2477 cell, raw_cell)
2478 cell, raw_cell)
2478 if not silent:
2479 if not silent:
2479 self.logger.log(cell, raw_cell)
2480 self.logger.log(cell, raw_cell)
2480
2481
2481 if not prefilter_failed:
2482 if not prefilter_failed:
2482 # don't run if prefilter failed
2483 # don't run if prefilter failed
2483 cell_name = self.compile.cache(cell, self.execution_count)
2484 cell_name = self.compile.cache(cell, self.execution_count)
2484
2485
2485 with self.display_trap:
2486 with self.display_trap:
2486 try:
2487 try:
2487 code_ast = self.compile.ast_parse(cell, filename=cell_name)
2488 code_ast = self.compile.ast_parse(cell, filename=cell_name)
2488 except IndentationError:
2489 except IndentationError:
2489 self.showindentationerror()
2490 self.showindentationerror()
2490 if store_history:
2491 if store_history:
2491 self.execution_count += 1
2492 self.execution_count += 1
2492 return None
2493 return None
2493 except (OverflowError, SyntaxError, ValueError, TypeError,
2494 except (OverflowError, SyntaxError, ValueError, TypeError,
2494 MemoryError):
2495 MemoryError):
2495 self.showsyntaxerror()
2496 self.showsyntaxerror()
2496 if store_history:
2497 if store_history:
2497 self.execution_count += 1
2498 self.execution_count += 1
2498 return None
2499 return None
2499
2500
2500 interactivity = "none" if silent else "last_expr"
2501 interactivity = "none" if silent else "last_expr"
2501 self.run_ast_nodes(code_ast.body, cell_name,
2502 self.run_ast_nodes(code_ast.body, cell_name,
2502 interactivity=interactivity)
2503 interactivity=interactivity)
2503
2504
2504 # Execute any registered post-execution functions.
2505 # Execute any registered post-execution functions.
2505 # unless we are silent
2506 # unless we are silent
2506 post_exec = [] if silent else self._post_execute.iteritems()
2507 post_exec = [] if silent else self._post_execute.iteritems()
2507
2508
2508 for func, status in post_exec:
2509 for func, status in post_exec:
2509 if self.disable_failing_post_execute and not status:
2510 if self.disable_failing_post_execute and not status:
2510 continue
2511 continue
2511 try:
2512 try:
2512 func()
2513 func()
2513 except KeyboardInterrupt:
2514 except KeyboardInterrupt:
2514 print >> io.stderr, "\nKeyboardInterrupt"
2515 print >> io.stderr, "\nKeyboardInterrupt"
2515 except Exception:
2516 except Exception:
2516 # register as failing:
2517 # register as failing:
2517 self._post_execute[func] = False
2518 self._post_execute[func] = False
2518 self.showtraceback()
2519 self.showtraceback()
2519 print >> io.stderr, '\n'.join([
2520 print >> io.stderr, '\n'.join([
2520 "post-execution function %r produced an error." % func,
2521 "post-execution function %r produced an error." % func,
2521 "If this problem persists, you can disable failing post-exec functions with:",
2522 "If this problem persists, you can disable failing post-exec functions with:",
2522 "",
2523 "",
2523 " get_ipython().disable_failing_post_execute = True"
2524 " get_ipython().disable_failing_post_execute = True"
2524 ])
2525 ])
2525
2526
2526 if store_history:
2527 if store_history:
2527 # Write output to the database. Does nothing unless
2528 # Write output to the database. Does nothing unless
2528 # history output logging is enabled.
2529 # history output logging is enabled.
2529 self.history_manager.store_output(self.execution_count)
2530 self.history_manager.store_output(self.execution_count)
2530 # Each cell is a *single* input, regardless of how many lines it has
2531 # Each cell is a *single* input, regardless of how many lines it has
2531 self.execution_count += 1
2532 self.execution_count += 1
2532
2533
2533 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2534 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2534 """Run a sequence of AST nodes. The execution mode depends on the
2535 """Run a sequence of AST nodes. The execution mode depends on the
2535 interactivity parameter.
2536 interactivity parameter.
2536
2537
2537 Parameters
2538 Parameters
2538 ----------
2539 ----------
2539 nodelist : list
2540 nodelist : list
2540 A sequence of AST nodes to run.
2541 A sequence of AST nodes to run.
2541 cell_name : str
2542 cell_name : str
2542 Will be passed to the compiler as the filename of the cell. Typically
2543 Will be passed to the compiler as the filename of the cell. Typically
2543 the value returned by ip.compile.cache(cell).
2544 the value returned by ip.compile.cache(cell).
2544 interactivity : str
2545 interactivity : str
2545 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2546 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2546 run interactively (displaying output from expressions). 'last_expr'
2547 run interactively (displaying output from expressions). 'last_expr'
2547 will run the last node interactively only if it is an expression (i.e.
2548 will run the last node interactively only if it is an expression (i.e.
2548 expressions in loops or other blocks are not displayed. Other values
2549 expressions in loops or other blocks are not displayed. Other values
2549 for this parameter will raise a ValueError.
2550 for this parameter will raise a ValueError.
2550 """
2551 """
2551 if not nodelist:
2552 if not nodelist:
2552 return
2553 return
2553
2554
2554 if interactivity == 'last_expr':
2555 if interactivity == 'last_expr':
2555 if isinstance(nodelist[-1], ast.Expr):
2556 if isinstance(nodelist[-1], ast.Expr):
2556 interactivity = "last"
2557 interactivity = "last"
2557 else:
2558 else:
2558 interactivity = "none"
2559 interactivity = "none"
2559
2560
2560 if interactivity == 'none':
2561 if interactivity == 'none':
2561 to_run_exec, to_run_interactive = nodelist, []
2562 to_run_exec, to_run_interactive = nodelist, []
2562 elif interactivity == 'last':
2563 elif interactivity == 'last':
2563 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2564 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2564 elif interactivity == 'all':
2565 elif interactivity == 'all':
2565 to_run_exec, to_run_interactive = [], nodelist
2566 to_run_exec, to_run_interactive = [], nodelist
2566 else:
2567 else:
2567 raise ValueError("Interactivity was %r" % interactivity)
2568 raise ValueError("Interactivity was %r" % interactivity)
2568
2569
2569 exec_count = self.execution_count
2570 exec_count = self.execution_count
2570
2571
2571 try:
2572 try:
2572 for i, node in enumerate(to_run_exec):
2573 for i, node in enumerate(to_run_exec):
2573 mod = ast.Module([node])
2574 mod = ast.Module([node])
2574 code = self.compile(mod, cell_name, "exec")
2575 code = self.compile(mod, cell_name, "exec")
2575 if self.run_code(code):
2576 if self.run_code(code):
2576 return True
2577 return True
2577
2578
2578 for i, node in enumerate(to_run_interactive):
2579 for i, node in enumerate(to_run_interactive):
2579 mod = ast.Interactive([node])
2580 mod = ast.Interactive([node])
2580 code = self.compile(mod, cell_name, "single")
2581 code = self.compile(mod, cell_name, "single")
2581 if self.run_code(code):
2582 if self.run_code(code):
2582 return True
2583 return True
2583
2584
2584 # Flush softspace
2585 # Flush softspace
2585 if softspace(sys.stdout, 0):
2586 if softspace(sys.stdout, 0):
2586 print
2587 print
2587
2588
2588 except:
2589 except:
2589 # It's possible to have exceptions raised here, typically by
2590 # It's possible to have exceptions raised here, typically by
2590 # compilation of odd code (such as a naked 'return' outside a
2591 # compilation of odd code (such as a naked 'return' outside a
2591 # function) that did parse but isn't valid. Typically the exception
2592 # function) that did parse but isn't valid. Typically the exception
2592 # is a SyntaxError, but it's safest just to catch anything and show
2593 # is a SyntaxError, but it's safest just to catch anything and show
2593 # the user a traceback.
2594 # the user a traceback.
2594
2595
2595 # We do only one try/except outside the loop to minimize the impact
2596 # We do only one try/except outside the loop to minimize the impact
2596 # on runtime, and also because if any node in the node list is
2597 # on runtime, and also because if any node in the node list is
2597 # broken, we should stop execution completely.
2598 # broken, we should stop execution completely.
2598 self.showtraceback()
2599 self.showtraceback()
2599
2600
2600 return False
2601 return False
2601
2602
2602 def run_code(self, code_obj):
2603 def run_code(self, code_obj):
2603 """Execute a code object.
2604 """Execute a code object.
2604
2605
2605 When an exception occurs, self.showtraceback() is called to display a
2606 When an exception occurs, self.showtraceback() is called to display a
2606 traceback.
2607 traceback.
2607
2608
2608 Parameters
2609 Parameters
2609 ----------
2610 ----------
2610 code_obj : code object
2611 code_obj : code object
2611 A compiled code object, to be executed
2612 A compiled code object, to be executed
2612
2613
2613 Returns
2614 Returns
2614 -------
2615 -------
2615 False : successful execution.
2616 False : successful execution.
2616 True : an error occurred.
2617 True : an error occurred.
2617 """
2618 """
2618
2619
2619 # Set our own excepthook in case the user code tries to call it
2620 # Set our own excepthook in case the user code tries to call it
2620 # directly, so that the IPython crash handler doesn't get triggered
2621 # directly, so that the IPython crash handler doesn't get triggered
2621 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2622 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2622
2623
2623 # we save the original sys.excepthook in the instance, in case config
2624 # we save the original sys.excepthook in the instance, in case config
2624 # code (such as magics) needs access to it.
2625 # code (such as magics) needs access to it.
2625 self.sys_excepthook = old_excepthook
2626 self.sys_excepthook = old_excepthook
2626 outflag = 1 # happens in more places, so it's easier as default
2627 outflag = 1 # happens in more places, so it's easier as default
2627 try:
2628 try:
2628 try:
2629 try:
2629 self.hooks.pre_run_code_hook()
2630 self.hooks.pre_run_code_hook()
2630 #rprint('Running code', repr(code_obj)) # dbg
2631 #rprint('Running code', repr(code_obj)) # dbg
2631 exec code_obj in self.user_global_ns, self.user_ns
2632 exec code_obj in self.user_global_ns, self.user_ns
2632 finally:
2633 finally:
2633 # Reset our crash handler in place
2634 # Reset our crash handler in place
2634 sys.excepthook = old_excepthook
2635 sys.excepthook = old_excepthook
2635 except SystemExit:
2636 except SystemExit:
2636 self.showtraceback(exception_only=True)
2637 self.showtraceback(exception_only=True)
2637 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2638 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2638 except self.custom_exceptions:
2639 except self.custom_exceptions:
2639 etype,value,tb = sys.exc_info()
2640 etype,value,tb = sys.exc_info()
2640 self.CustomTB(etype,value,tb)
2641 self.CustomTB(etype,value,tb)
2641 except:
2642 except:
2642 self.showtraceback()
2643 self.showtraceback()
2643 else:
2644 else:
2644 outflag = 0
2645 outflag = 0
2645 return outflag
2646 return outflag
2646
2647
2647 # For backwards compatibility
2648 # For backwards compatibility
2648 runcode = run_code
2649 runcode = run_code
2649
2650
2650 #-------------------------------------------------------------------------
2651 #-------------------------------------------------------------------------
2651 # Things related to GUI support and pylab
2652 # Things related to GUI support and pylab
2652 #-------------------------------------------------------------------------
2653 #-------------------------------------------------------------------------
2653
2654
2654 def enable_gui(self, gui=None):
2655 def enable_gui(self, gui=None):
2655 raise NotImplementedError('Implement enable_gui in a subclass')
2656 raise NotImplementedError('Implement enable_gui in a subclass')
2656
2657
2657 def enable_pylab(self, gui=None, import_all=True):
2658 def enable_pylab(self, gui=None, import_all=True):
2658 """Activate pylab support at runtime.
2659 """Activate pylab support at runtime.
2659
2660
2660 This turns on support for matplotlib, preloads into the interactive
2661 This turns on support for matplotlib, preloads into the interactive
2661 namespace all of numpy and pylab, and configures IPython to correctly
2662 namespace all of numpy and pylab, and configures IPython to correctly
2662 interact with the GUI event loop. The GUI backend to be used can be
2663 interact with the GUI event loop. The GUI backend to be used can be
2663 optionally selected with the optional :param:`gui` argument.
2664 optionally selected with the optional :param:`gui` argument.
2664
2665
2665 Parameters
2666 Parameters
2666 ----------
2667 ----------
2667 gui : optional, string
2668 gui : optional, string
2668
2669
2669 If given, dictates the choice of matplotlib GUI backend to use
2670 If given, dictates the choice of matplotlib GUI backend to use
2670 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2671 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2671 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2672 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2672 matplotlib (as dictated by the matplotlib build-time options plus the
2673 matplotlib (as dictated by the matplotlib build-time options plus the
2673 user's matplotlibrc configuration file). Note that not all backends
2674 user's matplotlibrc configuration file). Note that not all backends
2674 make sense in all contexts, for example a terminal ipython can't
2675 make sense in all contexts, for example a terminal ipython can't
2675 display figures inline.
2676 display figures inline.
2676 """
2677 """
2677 from IPython.core.pylabtools import mpl_runner
2678 from IPython.core.pylabtools import mpl_runner
2678 # We want to prevent the loading of pylab to pollute the user's
2679 # We want to prevent the loading of pylab to pollute the user's
2679 # namespace as shown by the %who* magics, so we execute the activation
2680 # namespace as shown by the %who* magics, so we execute the activation
2680 # code in an empty namespace, and we update *both* user_ns and
2681 # code in an empty namespace, and we update *both* user_ns and
2681 # user_ns_hidden with this information.
2682 # user_ns_hidden with this information.
2682 ns = {}
2683 ns = {}
2683 try:
2684 try:
2684 gui = pylab_activate(ns, gui, import_all, self)
2685 gui = pylab_activate(ns, gui, import_all, self)
2685 except KeyError:
2686 except KeyError:
2686 error("Backend %r not supported" % gui)
2687 error("Backend %r not supported" % gui)
2687 return
2688 return
2688 self.user_ns.update(ns)
2689 self.user_ns.update(ns)
2689 self.user_ns_hidden.update(ns)
2690 self.user_ns_hidden.update(ns)
2690 # Now we must activate the gui pylab wants to use, and fix %run to take
2691 # Now we must activate the gui pylab wants to use, and fix %run to take
2691 # plot updates into account
2692 # plot updates into account
2692 self.enable_gui(gui)
2693 self.enable_gui(gui)
2693 self._magic.default_runner = mpl_runner(self.safe_execfile)
2694 self._magic.default_runner = mpl_runner(self.safe_execfile)
2694
2695
2695 #-------------------------------------------------------------------------
2696 #-------------------------------------------------------------------------
2696 # Utilities
2697 # Utilities
2697 #-------------------------------------------------------------------------
2698 #-------------------------------------------------------------------------
2698
2699
2699 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2700 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2700 """Expand python variables in a string.
2701 """Expand python variables in a string.
2701
2702
2702 The depth argument indicates how many frames above the caller should
2703 The depth argument indicates how many frames above the caller should
2703 be walked to look for the local namespace where to expand variables.
2704 be walked to look for the local namespace where to expand variables.
2704
2705
2705 The global namespace for expansion is always the user's interactive
2706 The global namespace for expansion is always the user's interactive
2706 namespace.
2707 namespace.
2707 """
2708 """
2708 ns = self.user_ns.copy()
2709 ns = self.user_ns.copy()
2709 ns.update(sys._getframe(depth+1).f_locals)
2710 ns.update(sys._getframe(depth+1).f_locals)
2710 ns.pop('self', None)
2711 ns.pop('self', None)
2711 try:
2712 try:
2712 cmd = formatter.format(cmd, **ns)
2713 cmd = formatter.format(cmd, **ns)
2713 except Exception:
2714 except Exception:
2714 # if formatter couldn't format, just let it go untransformed
2715 # if formatter couldn't format, just let it go untransformed
2715 pass
2716 pass
2716 return cmd
2717 return cmd
2717
2718
2718 def mktempfile(self, data=None, prefix='ipython_edit_'):
2719 def mktempfile(self, data=None, prefix='ipython_edit_'):
2719 """Make a new tempfile and return its filename.
2720 """Make a new tempfile and return its filename.
2720
2721
2721 This makes a call to tempfile.mktemp, but it registers the created
2722 This makes a call to tempfile.mktemp, but it registers the created
2722 filename internally so ipython cleans it up at exit time.
2723 filename internally so ipython cleans it up at exit time.
2723
2724
2724 Optional inputs:
2725 Optional inputs:
2725
2726
2726 - data(None): if data is given, it gets written out to the temp file
2727 - data(None): if data is given, it gets written out to the temp file
2727 immediately, and the file is closed again."""
2728 immediately, and the file is closed again."""
2728
2729
2729 filename = tempfile.mktemp('.py', prefix)
2730 filename = tempfile.mktemp('.py', prefix)
2730 self.tempfiles.append(filename)
2731 self.tempfiles.append(filename)
2731
2732
2732 if data:
2733 if data:
2733 tmp_file = open(filename,'w')
2734 tmp_file = open(filename,'w')
2734 tmp_file.write(data)
2735 tmp_file.write(data)
2735 tmp_file.close()
2736 tmp_file.close()
2736 return filename
2737 return filename
2737
2738
2738 # TODO: This should be removed when Term is refactored.
2739 # TODO: This should be removed when Term is refactored.
2739 def write(self,data):
2740 def write(self,data):
2740 """Write a string to the default output"""
2741 """Write a string to the default output"""
2741 io.stdout.write(data)
2742 io.stdout.write(data)
2742
2743
2743 # TODO: This should be removed when Term is refactored.
2744 # TODO: This should be removed when Term is refactored.
2744 def write_err(self,data):
2745 def write_err(self,data):
2745 """Write a string to the default error output"""
2746 """Write a string to the default error output"""
2746 io.stderr.write(data)
2747 io.stderr.write(data)
2747
2748
2748 def ask_yes_no(self, prompt, default=None):
2749 def ask_yes_no(self, prompt, default=None):
2749 if self.quiet:
2750 if self.quiet:
2750 return True
2751 return True
2751 return ask_yes_no(prompt,default)
2752 return ask_yes_no(prompt,default)
2752
2753
2753 def show_usage(self):
2754 def show_usage(self):
2754 """Show a usage message"""
2755 """Show a usage message"""
2755 page.page(IPython.core.usage.interactive_usage)
2756 page.page(IPython.core.usage.interactive_usage)
2756
2757
2757 def extract_input_lines(self, range_str, raw=False):
2758 def extract_input_lines(self, range_str, raw=False):
2758 """Return as a string a set of input history slices.
2759 """Return as a string a set of input history slices.
2759
2760
2760 Parameters
2761 Parameters
2761 ----------
2762 ----------
2762 range_str : string
2763 range_str : string
2763 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
2764 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
2764 since this function is for use by magic functions which get their
2765 since this function is for use by magic functions which get their
2765 arguments as strings. The number before the / is the session
2766 arguments as strings. The number before the / is the session
2766 number: ~n goes n back from the current session.
2767 number: ~n goes n back from the current session.
2767
2768
2768 Optional Parameters:
2769 Optional Parameters:
2769 - raw(False): by default, the processed input is used. If this is
2770 - raw(False): by default, the processed input is used. If this is
2770 true, the raw input history is used instead.
2771 true, the raw input history is used instead.
2771
2772
2772 Note that slices can be called with two notations:
2773 Note that slices can be called with two notations:
2773
2774
2774 N:M -> standard python form, means including items N...(M-1).
2775 N:M -> standard python form, means including items N...(M-1).
2775
2776
2776 N-M -> include items N..M (closed endpoint)."""
2777 N-M -> include items N..M (closed endpoint)."""
2777 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
2778 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
2778 return "\n".join(x for _, _, x in lines)
2779 return "\n".join(x for _, _, x in lines)
2779
2780
2780 def find_user_code(self, target, raw=True, py_only=False):
2781 def find_user_code(self, target, raw=True, py_only=False):
2781 """Get a code string from history, file, url, or a string or macro.
2782 """Get a code string from history, file, url, or a string or macro.
2782
2783
2783 This is mainly used by magic functions.
2784 This is mainly used by magic functions.
2784
2785
2785 Parameters
2786 Parameters
2786 ----------
2787 ----------
2787
2788
2788 target : str
2789 target : str
2789
2790
2790 A string specifying code to retrieve. This will be tried respectively
2791 A string specifying code to retrieve. This will be tried respectively
2791 as: ranges of input history (see %history for syntax), url,
2792 as: ranges of input history (see %history for syntax), url,
2792 correspnding .py file, filename, or an expression evaluating to a
2793 correspnding .py file, filename, or an expression evaluating to a
2793 string or Macro in the user namespace.
2794 string or Macro in the user namespace.
2794
2795
2795 raw : bool
2796 raw : bool
2796 If true (default), retrieve raw history. Has no effect on the other
2797 If true (default), retrieve raw history. Has no effect on the other
2797 retrieval mechanisms.
2798 retrieval mechanisms.
2798
2799
2799 py_only : bool (default False)
2800 py_only : bool (default False)
2800 Only try to fetch python code, do not try alternative methods to decode file
2801 Only try to fetch python code, do not try alternative methods to decode file
2801 if unicode fails.
2802 if unicode fails.
2802
2803
2803 Returns
2804 Returns
2804 -------
2805 -------
2805 A string of code.
2806 A string of code.
2806
2807
2807 ValueError is raised if nothing is found, and TypeError if it evaluates
2808 ValueError is raised if nothing is found, and TypeError if it evaluates
2808 to an object of another type. In each case, .args[0] is a printable
2809 to an object of another type. In each case, .args[0] is a printable
2809 message.
2810 message.
2810 """
2811 """
2811 code = self.extract_input_lines(target, raw=raw) # Grab history
2812 code = self.extract_input_lines(target, raw=raw) # Grab history
2812 if code:
2813 if code:
2813 return code
2814 return code
2814 utarget = unquote_filename(target)
2815 utarget = unquote_filename(target)
2815 try:
2816 try:
2816 if utarget.startswith(('http://', 'https://')):
2817 if utarget.startswith(('http://', 'https://')):
2817 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2818 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2818 except UnicodeDecodeError:
2819 except UnicodeDecodeError:
2819 if not py_only :
2820 if not py_only :
2820 response = urllib.urlopen(target)
2821 response = urllib.urlopen(target)
2821 return response.read().decode('latin1')
2822 return response.read().decode('latin1')
2822 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2823 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2823
2824
2824 potential_target = [target]
2825 potential_target = [target]
2825 try :
2826 try :
2826 potential_target.insert(0,get_py_filename(target))
2827 potential_target.insert(0,get_py_filename(target))
2827 except IOError:
2828 except IOError:
2828 pass
2829 pass
2829
2830
2830 for tgt in potential_target :
2831 for tgt in potential_target :
2831 if os.path.isfile(tgt): # Read file
2832 if os.path.isfile(tgt): # Read file
2832 try :
2833 try :
2833 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2834 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2834 except UnicodeDecodeError :
2835 except UnicodeDecodeError :
2835 if not py_only :
2836 if not py_only :
2836 with io_open(tgt,'r', encoding='latin1') as f :
2837 with io_open(tgt,'r', encoding='latin1') as f :
2837 return f.read()
2838 return f.read()
2838 raise ValueError(("'%s' seem to be unreadable.") % target)
2839 raise ValueError(("'%s' seem to be unreadable.") % target)
2839
2840
2840 try: # User namespace
2841 try: # User namespace
2841 codeobj = eval(target, self.user_ns)
2842 codeobj = eval(target, self.user_ns)
2842 except Exception:
2843 except Exception:
2843 raise ValueError(("'%s' was not found in history, as a file, url, "
2844 raise ValueError(("'%s' was not found in history, as a file, url, "
2844 "nor in the user namespace.") % target)
2845 "nor in the user namespace.") % target)
2845 if isinstance(codeobj, basestring):
2846 if isinstance(codeobj, basestring):
2846 return codeobj
2847 return codeobj
2847 elif isinstance(codeobj, Macro):
2848 elif isinstance(codeobj, Macro):
2848 return codeobj.value
2849 return codeobj.value
2849
2850
2850 raise TypeError("%s is neither a string nor a macro." % target,
2851 raise TypeError("%s is neither a string nor a macro." % target,
2851 codeobj)
2852 codeobj)
2852
2853
2853 #-------------------------------------------------------------------------
2854 #-------------------------------------------------------------------------
2854 # Things related to IPython exiting
2855 # Things related to IPython exiting
2855 #-------------------------------------------------------------------------
2856 #-------------------------------------------------------------------------
2856 def atexit_operations(self):
2857 def atexit_operations(self):
2857 """This will be executed at the time of exit.
2858 """This will be executed at the time of exit.
2858
2859
2859 Cleanup operations and saving of persistent data that is done
2860 Cleanup operations and saving of persistent data that is done
2860 unconditionally by IPython should be performed here.
2861 unconditionally by IPython should be performed here.
2861
2862
2862 For things that may depend on startup flags or platform specifics (such
2863 For things that may depend on startup flags or platform specifics (such
2863 as having readline or not), register a separate atexit function in the
2864 as having readline or not), register a separate atexit function in the
2864 code that has the appropriate information, rather than trying to
2865 code that has the appropriate information, rather than trying to
2865 clutter
2866 clutter
2866 """
2867 """
2867 # Close the history session (this stores the end time and line count)
2868 # Close the history session (this stores the end time and line count)
2868 # this must be *before* the tempfile cleanup, in case of temporary
2869 # this must be *before* the tempfile cleanup, in case of temporary
2869 # history db
2870 # history db
2870 self.history_manager.end_session()
2871 self.history_manager.end_session()
2871
2872
2872 # Cleanup all tempfiles left around
2873 # Cleanup all tempfiles left around
2873 for tfile in self.tempfiles:
2874 for tfile in self.tempfiles:
2874 try:
2875 try:
2875 os.unlink(tfile)
2876 os.unlink(tfile)
2876 except OSError:
2877 except OSError:
2877 pass
2878 pass
2878
2879
2879 # Clear all user namespaces to release all references cleanly.
2880 # Clear all user namespaces to release all references cleanly.
2880 self.reset(new_session=False)
2881 self.reset(new_session=False)
2881
2882
2882 # Run user hooks
2883 # Run user hooks
2883 self.hooks.shutdown_hook()
2884 self.hooks.shutdown_hook()
2884
2885
2885 def cleanup(self):
2886 def cleanup(self):
2886 self.restore_sys_module_state()
2887 self.restore_sys_module_state()
2887
2888
2888
2889
2889 class InteractiveShellABC(object):
2890 class InteractiveShellABC(object):
2890 """An abstract base class for InteractiveShell."""
2891 """An abstract base class for InteractiveShell."""
2891 __metaclass__ = abc.ABCMeta
2892 __metaclass__ = abc.ABCMeta
2892
2893
2893 InteractiveShellABC.register(InteractiveShell)
2894 InteractiveShellABC.register(InteractiveShell)
This diff has been collapsed as it changes many lines, (4544 lines changed) Show them Hide them
@@ -1,3822 +1,3880 b''
1 # encoding: utf-8
1 # encoding: utf-8
2 """Magic functions for InteractiveShell.
2 """Magic functions for InteractiveShell.
3 """
3 """
4
4
5 #-----------------------------------------------------------------------------
5 #-----------------------------------------------------------------------------
6 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
6 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
7 # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu>
7 # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu>
8 # Copyright (C) 2008-2011 The IPython Development Team
8 # Copyright (C) 2008 The IPython Development Team
9
9
10 # Distributed under the terms of the BSD License. The full license is in
10 # Distributed under the terms of the BSD License. The full license is in
11 # the file COPYING, distributed as part of this software.
11 # the file COPYING, distributed as part of this software.
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13
13
14 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
15 # Imports
15 # Imports
16 #-----------------------------------------------------------------------------
16 #-----------------------------------------------------------------------------
17
17
18 import __builtin__ as builtin_mod
18 import __builtin__ as builtin_mod
19 import __future__
19 import __future__
20 import bdb
20 import bdb
21 import gc
22 import imp
21 import inspect
23 import inspect
22 import io
24 import io
23 import json
25 import json
24 import os
26 import os
25 import sys
26 import re
27 import re
28 import shutil
29 import sys
27 import time
30 import time
28 import gc
29 from StringIO import StringIO
31 from StringIO import StringIO
30 from getopt import getopt,GetoptError
32 from getopt import getopt,GetoptError
31 from pprint import pformat
33 from pprint import pformat
32 from urllib2 import urlopen
34 from urllib2 import urlopen
33
35
34 # cProfile was added in Python2.5
36 # cProfile was added in Python2.5
35 try:
37 try:
36 import cProfile as profile
38 import cProfile as profile
37 import pstats
39 import pstats
38 except ImportError:
40 except ImportError:
39 # profile isn't bundled by default in Debian for license reasons
41 # profile isn't bundled by default in Debian for license reasons
40 try:
42 try:
41 import profile,pstats
43 import profile,pstats
42 except ImportError:
44 except ImportError:
43 profile = pstats = None
45 profile = pstats = None
44
46
47 import IPython
48 from IPython.config.application import Application
49 from IPython.config.configurable import Configurable
45 from IPython.core import debugger, oinspect
50 from IPython.core import debugger, oinspect
51 from IPython.core import magic_arguments, page
52 from IPython.core.error import StdinNotImplementedError
46 from IPython.core.error import TryNext
53 from IPython.core.error import TryNext
47 from IPython.core.error import UsageError
54 from IPython.core.error import UsageError
48 from IPython.core.error import StdinNotImplementedError
55 from IPython.core.fakemodule import FakeModule
49 from IPython.core.macro import Macro
56 from IPython.core.macro import Macro
50 from IPython.core import magic_arguments, page
51 from IPython.core.prefilter import ESC_MAGIC
57 from IPython.core.prefilter import ESC_MAGIC
58 from IPython.core.profiledir import ProfileDir
52 from IPython.testing.skipdoctest import skip_doctest
59 from IPython.testing.skipdoctest import skip_doctest
60 from IPython.utils import openpy
53 from IPython.utils import py3compat
61 from IPython.utils import py3compat
54 from IPython.utils.encoding import DEFAULT_ENCODING
62 from IPython.utils.encoding import DEFAULT_ENCODING
55 from IPython.utils.io import file_read, nlprint
63 from IPython.utils.io import file_read, nlprint
64 from IPython.utils.ipstruct import Struct
56 from IPython.utils.module_paths import find_mod
65 from IPython.utils.module_paths import find_mod
57 from IPython.utils.path import get_py_filename, unquote_filename
66 from IPython.utils.path import get_py_filename, unquote_filename
58 from IPython.utils.process import arg_split, abbrev_cwd
67 from IPython.utils.process import arg_split, abbrev_cwd
59 from IPython.utils.terminal import set_term_title
68 from IPython.utils.terminal import set_term_title
60 from IPython.utils.text import format_screen
69 from IPython.utils.text import format_screen
61 from IPython.utils.timing import clock, clock2
70 from IPython.utils.timing import clock, clock2
71 from IPython.utils.traitlets import Bool, Dict, Instance, Integer, List, Unicode
62 from IPython.utils.warn import warn, error
72 from IPython.utils.warn import warn, error
63 from IPython.utils.ipstruct import Struct
64 from IPython.config.application import Application
65
73
66 #-----------------------------------------------------------------------------
74 #-----------------------------------------------------------------------------
67 # Utility functions
75 # Utility classes and functions
68 #-----------------------------------------------------------------------------
76 #-----------------------------------------------------------------------------
69
77
78 class Bunch: pass
79
80
81 # Used for exception handling in magic_edit
82 class MacroToEdit(ValueError): pass
83
84
70 def on_off(tag):
85 def on_off(tag):
71 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
86 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
72 return ['OFF','ON'][tag]
87 return ['OFF','ON'][tag]
73
88
74 class Bunch: pass
75
89
76 def compress_dhist(dh):
90 def compress_dhist(dh):
77 head, tail = dh[:-10], dh[-10:]
91 head, tail = dh[:-10], dh[-10:]
78
92
79 newhead = []
93 newhead = []
80 done = set()
94 done = set()
81 for h in head:
95 for h in head:
82 if h in done:
96 if h in done:
83 continue
97 continue
84 newhead.append(h)
98 newhead.append(h)
85 done.add(h)
99 done.add(h)
86
100
87 return newhead + tail
101 return newhead + tail
88
102
103
89 def needs_local_scope(func):
104 def needs_local_scope(func):
90 """Decorator to mark magic functions which need to local scope to run."""
105 """Decorator to mark magic functions which need to local scope to run."""
91 func.needs_local_scope = True
106 func.needs_local_scope = True
92 return func
107 return func
93
108
94
95 # Used for exception handling in magic_edit
96 class MacroToEdit(ValueError): pass
97
98 #***************************************************************************
109 #***************************************************************************
99 # Main class implementing Magic functionality
100
101 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
102 # on construction of the main InteractiveShell object. Something odd is going
103 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
104 # eventually this needs to be clarified.
105 # BG: This is because InteractiveShell inherits from this, but is itself a
106 # Configurable. This messes up the MRO in some way. The fix is that we need to
107 # make Magic a configurable that InteractiveShell does not subclass.
108
109 class Magic(object):
110 """Magic functions for InteractiveShell.
111
112 Shell functions which can be reached as %function_name. All magic
113 functions should accept a string, which they can parse for their own
114 needs. This can make some functions easier to type, eg `%cd ../`
115 vs. `%cd("../")`
116
117 ALL definitions MUST begin with the prefix magic_. The user won't need it
118 at the command line, but it is is needed in the definition. """
119
120 # class globals
121 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
122 'Automagic is ON, % prefix NOT needed for magic functions.']
123
124
125 configurables = None
126
127 default_runner = None
128 #......................................................................
129 # some utility functions
130
131 def __init__(self, shell):
132
110
133 self.options_table = {}
111 class MagicManager(Configurable):
134 if profile is None:
112 """Object that handles all magic-related functionality for IPython.
135 self.magic_prun = self.profile_missing_notice
113 """
136 self.shell = shell
114 # An instance of the IPython shell we are attached to
137 if self.configurables is None:
115 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
138 self.configurables = []
139
116
140 # namespace for holding state we may need
117 auto_status = Enum([
141 self._magic_state = Bunch()
118 'Automagic is OFF, % prefix IS needed for magic functions.',
119 'Automagic is ON, % prefix NOT needed for magic functions.'])
142
120
143 def profile_missing_notice(self, *args, **kwargs):
121 def __init__(self, shell=None, config=None, **traits):
144 error("""\
145 The profile module could not be found. It has been removed from the standard
146 python packages because of its non-free license. To use profiling, install the
147 python-profiler package from non-free.""")
148
122
149 def default_option(self,fn,optstr):
123 super(MagicManager, self).__init__(shell=shell, config=config, **traits)
150 """Make an entry in the options_table for fn, with value optstr"""
151
124
152 if fn not in self.lsmagic():
153 error("%s is not a magic function" % fn)
154 self.options_table[fn] = optstr
155
125
156 def lsmagic(self):
126 def lsmagic(self):
157 """Return a list of currently available magic functions.
127 """Return a list of currently available magic functions.
158
128
159 Gives a list of the bare names after mangling (['ls','cd', ...], not
129 Gives a list of the bare names after mangling (['ls','cd', ...], not
160 ['magic_ls','magic_cd',...]"""
130 ['magic_ls','magic_cd',...]"""
161
131
162 # FIXME. This needs a cleanup, in the way the magics list is built.
132 # FIXME. This needs a cleanup, in the way the magics list is built.
163
133
164 # magics in class definition
134 # magics in class definition
165 class_magic = lambda fn: fn.startswith('magic_') and \
135 class_magic = lambda fn: fn.startswith('magic_') and \
166 callable(Magic.__dict__[fn])
136 callable(Magic.__dict__[fn])
167 # in instance namespace (run-time user additions)
137 # in instance namespace (run-time user additions)
168 inst_magic = lambda fn: fn.startswith('magic_') and \
138 inst_magic = lambda fn: fn.startswith('magic_') and \
169 callable(self.__dict__[fn])
139 callable(self.__dict__[fn])
170 # and bound magics by user (so they can access self):
140 # and bound magics by user (so they can access self):
171 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
141 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
172 callable(self.__class__.__dict__[fn])
142 callable(self.__class__.__dict__[fn])
173 magics = filter(class_magic,Magic.__dict__.keys()) + \
143 magics = filter(class_magic, Magic.__dict__.keys()) + \
174 filter(inst_magic, self.__dict__.keys()) + \
144 filter(inst_magic, self.__dict__.keys()) + \
175 filter(inst_bound_magic, self.__class__.__dict__.keys())
145 filter(inst_bound_magic, self.__class__.__dict__.keys())
176 out = []
146 out = []
177 for fn in set(magics):
147 for fn in set(magics):
178 out.append(fn.replace('magic_','',1))
148 out.append(fn.replace('magic_', '', 1))
179 out.sort()
149 out.sort()
180 return out
150 return out
181
151
152
153 class MagicFunctions(object):
154 """Base class for implementing magic functions.
155
156 Shell functions which can be reached as %function_name. All magic
157 functions should accept a string, which they can parse for their own
158 needs. This can make some functions easier to type, eg `%cd ../`
159 vs. `%cd("../")`
160 """
161
162 options_table = Dict(config=True,
163 help = """Dict holding all command-line options for each magic.
164 """)
165
166 class __metaclass__(type):
167 def __new__(cls, name, bases, dct):
168 cls.registered = False
169 return type.__new__(cls, name, bases, dct)
170
171 def __init__(self, shell):
172 if not(self.__class__.registered):
173 raise ValueError('unregistered Magics')
174 self.shell = shell
175
182 def arg_err(self,func):
176 def arg_err(self,func):
183 """Print docstring if incorrect arguments were passed"""
177 """Print docstring if incorrect arguments were passed"""
184 print 'Error in arguments:'
178 print 'Error in arguments:'
185 print oinspect.getdoc(func)
179 print oinspect.getdoc(func)
186
180
187 def format_latex(self,strng):
181 def format_latex(self,strng):
188 """Format a string for latex inclusion."""
182 """Format a string for latex inclusion."""
189
183
190 # Characters that need to be escaped for latex:
184 # Characters that need to be escaped for latex:
191 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
185 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
192 # Magic command names as headers:
186 # Magic command names as headers:
193 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
187 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
194 re.MULTILINE)
188 re.MULTILINE)
195 # Magic commands
189 # Magic commands
196 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
190 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
197 re.MULTILINE)
191 re.MULTILINE)
198 # Paragraph continue
192 # Paragraph continue
199 par_re = re.compile(r'\\$',re.MULTILINE)
193 par_re = re.compile(r'\\$',re.MULTILINE)
200
194
201 # The "\n" symbol
195 # The "\n" symbol
202 newline_re = re.compile(r'\\n')
196 newline_re = re.compile(r'\\n')
203
197
204 # Now build the string for output:
198 # Now build the string for output:
205 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
199 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
206 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
200 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
207 strng)
201 strng)
208 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
202 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
209 strng = par_re.sub(r'\\\\',strng)
203 strng = par_re.sub(r'\\\\',strng)
210 strng = escape_re.sub(r'\\\1',strng)
204 strng = escape_re.sub(r'\\\1',strng)
211 strng = newline_re.sub(r'\\textbackslash{}n',strng)
205 strng = newline_re.sub(r'\\textbackslash{}n',strng)
212 return strng
206 return strng
213
207
214 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
208 def parse_options(self, arg_str, opt_str, *long_opts, **kw):
215 """Parse options passed to an argument string.
209 """Parse options passed to an argument string.
216
210
217 The interface is similar to that of getopt(), but it returns back a
211 The interface is similar to that of getopt(), but it returns back a
218 Struct with the options as keys and the stripped argument string still
212 Struct with the options as keys and the stripped argument string still
219 as a string.
213 as a string.
220
214
221 arg_str is quoted as a true sys.argv vector by using shlex.split.
215 arg_str is quoted as a true sys.argv vector by using shlex.split.
222 This allows us to easily expand variables, glob files, quote
216 This allows us to easily expand variables, glob files, quote
223 arguments, etc.
217 arguments, etc.
224
218
225 Options:
219 Options:
226 -mode: default 'string'. If given as 'list', the argument string is
220 -mode: default 'string'. If given as 'list', the argument string is
227 returned as a list (split on whitespace) instead of a string.
221 returned as a list (split on whitespace) instead of a string.
228
222
229 -list_all: put all option values in lists. Normally only options
223 -list_all: put all option values in lists. Normally only options
230 appearing more than once are put in a list.
224 appearing more than once are put in a list.
231
225
232 -posix (True): whether to split the input line in POSIX mode or not,
226 -posix (True): whether to split the input line in POSIX mode or not,
233 as per the conventions outlined in the shlex module from the
227 as per the conventions outlined in the shlex module from the
234 standard library."""
228 standard library."""
235
229
236 # inject default options at the beginning of the input line
230 # inject default options at the beginning of the input line
237 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
231 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
238 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
232 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
239
233
240 mode = kw.get('mode','string')
234 mode = kw.get('mode','string')
241 if mode not in ['string','list']:
235 if mode not in ['string','list']:
242 raise ValueError,'incorrect mode given: %s' % mode
236 raise ValueError,'incorrect mode given: %s' % mode
243 # Get options
237 # Get options
244 list_all = kw.get('list_all',0)
238 list_all = kw.get('list_all',0)
245 posix = kw.get('posix', os.name == 'posix')
239 posix = kw.get('posix', os.name == 'posix')
246 strict = kw.get('strict', True)
240 strict = kw.get('strict', True)
247
241
248 # Check if we have more than one argument to warrant extra processing:
242 # Check if we have more than one argument to warrant extra processing:
249 odict = {} # Dictionary with options
243 odict = {} # Dictionary with options
250 args = arg_str.split()
244 args = arg_str.split()
251 if len(args) >= 1:
245 if len(args) >= 1:
252 # If the list of inputs only has 0 or 1 thing in it, there's no
246 # If the list of inputs only has 0 or 1 thing in it, there's no
253 # need to look for options
247 # need to look for options
254 argv = arg_split(arg_str, posix, strict)
248 argv = arg_split(arg_str, posix, strict)
255 # Do regular option processing
249 # Do regular option processing
256 try:
250 try:
257 opts,args = getopt(argv,opt_str,*long_opts)
251 opts,args = getopt(argv,opt_str,*long_opts)
258 except GetoptError,e:
252 except GetoptError,e:
259 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
253 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
260 " ".join(long_opts)))
254 " ".join(long_opts)))
261 for o,a in opts:
255 for o,a in opts:
262 if o.startswith('--'):
256 if o.startswith('--'):
263 o = o[2:]
257 o = o[2:]
264 else:
258 else:
265 o = o[1:]
259 o = o[1:]
266 try:
260 try:
267 odict[o].append(a)
261 odict[o].append(a)
268 except AttributeError:
262 except AttributeError:
269 odict[o] = [odict[o],a]
263 odict[o] = [odict[o],a]
270 except KeyError:
264 except KeyError:
271 if list_all:
265 if list_all:
272 odict[o] = [a]
266 odict[o] = [a]
273 else:
267 else:
274 odict[o] = a
268 odict[o] = a
275
269
276 # Prepare opts,args for return
270 # Prepare opts,args for return
277 opts = Struct(odict)
271 opts = Struct(odict)
278 if mode == 'string':
272 if mode == 'string':
279 args = ' '.join(args)
273 args = ' '.join(args)
280
274
281 return opts,args
275 return opts,args
282
276
283 #......................................................................
277 def default_option(self,fn,optstr):
284 # And now the actual magic functions
278 """Make an entry in the options_table for fn, with value optstr"""
279
280 if fn not in self.lsmagic():
281 error("%s is not a magic function" % fn)
282 self.options_table[fn] = optstr
283
284
285 class BasicMagics(MagicFunctions):
286 """Magics that provide central IPython functionality.
287
288 These are various magics that don't fit into specific categories but that
289 are all part of the base 'IPython experience'."""
285
290
286 # Functions for IPython shell work (vars,funcs, config, etc)
287 def magic_lsmagic(self, parameter_s = ''):
291 def magic_lsmagic(self, parameter_s = ''):
288 """List currently available magic functions."""
292 """List currently available magic functions."""
289 mesc = ESC_MAGIC
293 mesc = ESC_MAGIC
290 print 'Available magic functions:\n'+mesc+\
294 print 'Available magic functions:\n'+mesc+\
291 (' '+mesc).join(self.lsmagic())
295 (' '+mesc).join(self.lsmagic())
292 print '\n' + Magic.auto_status[self.shell.automagic]
296 print '\n' + Magic.auto_status[self.shell.automagic]
293 return None
297 return None
294
298
295 def magic_magic(self, parameter_s = ''):
299 def magic_magic(self, parameter_s = ''):
296 """Print information about the magic function system.
300 """Print information about the magic function system.
297
301
298 Supported formats: -latex, -brief, -rest
302 Supported formats: -latex, -brief, -rest
299 """
303 """
300
304
301 mode = ''
305 mode = ''
302 try:
306 try:
303 if parameter_s.split()[0] == '-latex':
307 if parameter_s.split()[0] == '-latex':
304 mode = 'latex'
308 mode = 'latex'
305 if parameter_s.split()[0] == '-brief':
309 if parameter_s.split()[0] == '-brief':
306 mode = 'brief'
310 mode = 'brief'
307 if parameter_s.split()[0] == '-rest':
311 if parameter_s.split()[0] == '-rest':
308 mode = 'rest'
312 mode = 'rest'
309 rest_docs = []
313 rest_docs = []
310 except:
314 except:
311 pass
315 pass
312
316
313 magic_docs = []
317 magic_docs = []
314 for fname in self.lsmagic():
318 for fname in self.lsmagic():
315 mname = 'magic_' + fname
319 mname = 'magic_' + fname
316 for space in (Magic, self, self.__class__):
320 for space in (Magic, self, self.__class__):
317 try:
321 try:
318 fn = space.__dict__[mname]
322 fn = space.__dict__[mname]
319 except KeyError:
323 except KeyError:
320 pass
324 pass
321 else:
325 else:
322 break
326 break
323 if mode == 'brief':
327 if mode == 'brief':
324 # only first line
328 # only first line
325 if fn.__doc__:
329 if fn.__doc__:
326 fndoc = fn.__doc__.split('\n',1)[0]
330 fndoc = fn.__doc__.split('\n',1)[0]
327 else:
331 else:
328 fndoc = 'No documentation'
332 fndoc = 'No documentation'
329 else:
333 else:
330 if fn.__doc__:
334 if fn.__doc__:
331 fndoc = fn.__doc__.rstrip()
335 fndoc = fn.__doc__.rstrip()
332 else:
336 else:
333 fndoc = 'No documentation'
337 fndoc = 'No documentation'
334
338
335
339
336 if mode == 'rest':
340 if mode == 'rest':
337 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
341 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
338 fname,fndoc))
342 fname,fndoc))
339
343
340 else:
344 else:
341 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
345 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
342 fname,fndoc))
346 fname,fndoc))
343
347
344 magic_docs = ''.join(magic_docs)
348 magic_docs = ''.join(magic_docs)
345
349
346 if mode == 'rest':
350 if mode == 'rest':
347 return "".join(rest_docs)
351 return "".join(rest_docs)
348
352
349 if mode == 'latex':
353 if mode == 'latex':
350 print self.format_latex(magic_docs)
354 print self.format_latex(magic_docs)
351 return
355 return
352 else:
356 else:
353 magic_docs = format_screen(magic_docs)
357 magic_docs = format_screen(magic_docs)
354 if mode == 'brief':
358 if mode == 'brief':
355 return magic_docs
359 return magic_docs
356
360
357 outmsg = """
361 outmsg = """
358 IPython's 'magic' functions
362 IPython's 'magic' functions
359 ===========================
363 ===========================
360
364
361 The magic function system provides a series of functions which allow you to
365 The magic function system provides a series of functions which allow you to
362 control the behavior of IPython itself, plus a lot of system-type
366 control the behavior of IPython itself, plus a lot of system-type
363 features. All these functions are prefixed with a % character, but parameters
367 features. All these functions are prefixed with a % character, but parameters
364 are given without parentheses or quotes.
368 are given without parentheses or quotes.
365
369
366 NOTE: If you have 'automagic' enabled (via the command line option or with the
370 NOTE: If you have 'automagic' enabled (via the command line option or with the
367 %automagic function), you don't need to type in the % explicitly. By default,
371 %automagic function), you don't need to type in the % explicitly. By default,
368 IPython ships with automagic on, so you should only rarely need the % escape.
372 IPython ships with automagic on, so you should only rarely need the % escape.
369
373
370 Example: typing '%cd mydir' (without the quotes) changes you working directory
374 Example: typing '%cd mydir' (without the quotes) changes you working directory
371 to 'mydir', if it exists.
375 to 'mydir', if it exists.
372
376
373 For a list of the available magic functions, use %lsmagic. For a description
377 For a list of the available magic functions, use %lsmagic. For a description
374 of any of them, type %magic_name?, e.g. '%cd?'.
378 of any of them, type %magic_name?, e.g. '%cd?'.
375
379
376 Currently the magic system has the following functions:\n"""
380 Currently the magic system has the following functions:\n"""
377
381
378 mesc = ESC_MAGIC
382 mesc = ESC_MAGIC
379 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
383 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
380 "\n\n%s%s\n\n%s" % (outmsg,
384 "\n\n%s%s\n\n%s" % (outmsg,
381 magic_docs,mesc,mesc,
385 magic_docs,mesc,mesc,
382 (' '+mesc).join(self.lsmagic()),
386 (' '+mesc).join(self.lsmagic()),
383 Magic.auto_status[self.shell.automagic] ) )
387 Magic.auto_status[self.shell.automagic] ) )
384 page.page(outmsg)
388 page.page(outmsg)
385
389
386 def magic_automagic(self, parameter_s = ''):
387 """Make magic functions callable without having to type the initial %.
388
389 Without argumentsl toggles on/off (when off, you must call it as
390 %automagic, of course). With arguments it sets the value, and you can
391 use any of (case insensitive):
392
393 - on,1,True: to activate
394
395 - off,0,False: to deactivate.
396
397 Note that magic functions have lowest priority, so if there's a
398 variable whose name collides with that of a magic fn, automagic won't
399 work for that function (you get the variable instead). However, if you
400 delete the variable (del var), the previously shadowed magic function
401 becomes visible to automagic again."""
402
403 arg = parameter_s.lower()
404 if parameter_s in ('on','1','true'):
405 self.shell.automagic = True
406 elif parameter_s in ('off','0','false'):
407 self.shell.automagic = False
408 else:
409 self.shell.automagic = not self.shell.automagic
410 print '\n' + Magic.auto_status[self.shell.automagic]
411
412 @skip_doctest
413 def magic_autocall(self, parameter_s = ''):
414 """Make functions callable without having to type parentheses.
415
416 Usage:
417
418 %autocall [mode]
419
420 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
421 value is toggled on and off (remembering the previous state).
422
423 In more detail, these values mean:
424
425 0 -> fully disabled
426
427 1 -> active, but do not apply if there are no arguments on the line.
428
429 In this mode, you get::
430
431 In [1]: callable
432 Out[1]: <built-in function callable>
433
434 In [2]: callable 'hello'
435 ------> callable('hello')
436 Out[2]: False
437
438 2 -> Active always. Even if no arguments are present, the callable
439 object is called::
440
441 In [2]: float
442 ------> float()
443 Out[2]: 0.0
444
445 Note that even with autocall off, you can still use '/' at the start of
446 a line to treat the first argument on the command line as a function
447 and add parentheses to it::
448
449 In [8]: /str 43
450 ------> str(43)
451 Out[8]: '43'
452
453 # all-random (note for auto-testing)
454 """
455
456 if parameter_s:
457 arg = int(parameter_s)
458 else:
459 arg = 'toggle'
460
461 if not arg in (0,1,2,'toggle'):
462 error('Valid modes: (0->Off, 1->Smart, 2->Full')
463 return
464
465 if arg in (0,1,2):
466 self.shell.autocall = arg
467 else: # toggle
468 if self.shell.autocall:
469 self._magic_state.autocall_save = self.shell.autocall
470 self.shell.autocall = 0
471 else:
472 try:
473 self.shell.autocall = self._magic_state.autocall_save
474 except AttributeError:
475 self.shell.autocall = self._magic_state.autocall_save = 1
476
477 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
478
479
390
480 def magic_page(self, parameter_s=''):
391 def magic_page(self, parameter_s=''):
481 """Pretty print the object and display it through a pager.
392 """Pretty print the object and display it through a pager.
482
393
483 %page [options] OBJECT
394 %page [options] OBJECT
484
395
485 If no object is given, use _ (last output).
396 If no object is given, use _ (last output).
486
397
487 Options:
398 Options:
488
399
489 -r: page str(object), don't pretty-print it."""
400 -r: page str(object), don't pretty-print it."""
490
401
491 # After a function contributed by Olivier Aubert, slightly modified.
402 # After a function contributed by Olivier Aubert, slightly modified.
492
403
493 # Process options/args
404 # Process options/args
494 opts,args = self.parse_options(parameter_s,'r')
405 opts,args = self.parse_options(parameter_s,'r')
495 raw = 'r' in opts
406 raw = 'r' in opts
496
407
497 oname = args and args or '_'
408 oname = args and args or '_'
498 info = self._ofind(oname)
409 info = self._ofind(oname)
499 if info['found']:
410 if info['found']:
500 txt = (raw and str or pformat)( info['obj'] )
411 txt = (raw and str or pformat)( info['obj'] )
501 page.page(txt)
412 page.page(txt)
502 else:
413 else:
503 print 'Object `%s` not found' % oname
414 print 'Object `%s` not found' % oname
504
415
505 def magic_profile(self, parameter_s=''):
416 def magic_profile(self, parameter_s=''):
506 """Print your currently active IPython profile."""
417 """Print your currently active IPython profile."""
507 from IPython.core.application import BaseIPythonApplication
418 from IPython.core.application import BaseIPythonApplication
508 if BaseIPythonApplication.initialized():
419 if BaseIPythonApplication.initialized():
509 print BaseIPythonApplication.instance().profile
420 print BaseIPythonApplication.instance().profile
510 else:
421 else:
511 error("profile is an application-level value, but you don't appear to be in an IPython application")
422 error("profile is an application-level value, but you don't appear to be in an IPython application")
512
423
513 def magic_pinfo(self, parameter_s='', namespaces=None):
424 def magic_pprint(self, parameter_s=''):
514 """Provide detailed information about an object.
425 """Toggle pretty printing on/off."""
515
426 ptformatter = self.shell.display_formatter.formatters['text/plain']
516 '%pinfo object' is just a synonym for object? or ?object."""
427 ptformatter.pprint = bool(1 - ptformatter.pprint)
517
428 print 'Pretty printing has been turned', \
518 #print 'pinfo par: <%s>' % parameter_s # dbg
429 ['OFF','ON'][ptformatter.pprint]
519
520
521 # detail_level: 0 -> obj? , 1 -> obj??
522 detail_level = 0
523 # We need to detect if we got called as 'pinfo pinfo foo', which can
524 # happen if the user types 'pinfo foo?' at the cmd line.
525 pinfo,qmark1,oname,qmark2 = \
526 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
527 if pinfo or qmark1 or qmark2:
528 detail_level = 1
529 if "*" in oname:
530 self.magic_psearch(oname)
531 else:
532 self.shell._inspect('pinfo', oname, detail_level=detail_level,
533 namespaces=namespaces)
534
535 def magic_pinfo2(self, parameter_s='', namespaces=None):
536 """Provide extra detailed information about an object.
537
430
538 '%pinfo2 object' is just a synonym for object?? or ??object."""
431 def magic_colors(self,parameter_s = ''):
539 self.shell._inspect('pinfo', parameter_s, detail_level=1,
432 """Switch color scheme for prompts, info system and exception handlers.
540 namespaces=namespaces)
541
433
542 @skip_doctest
434 Currently implemented schemes: NoColor, Linux, LightBG.
543 def magic_pdef(self, parameter_s='', namespaces=None):
544 """Print the definition header for any callable object.
545
435
546 If the object is a class, print the constructor information.
436 Color scheme names are not case-sensitive.
547
437
548 Examples
438 Examples
549 --------
439 --------
550 ::
440 To get a plain black and white terminal::
551
441
552 In [3]: %pdef urllib.urlopen
442 %colors nocolor
553 urllib.urlopen(url, data=None, proxies=None)
554 """
443 """
555 self._inspect('pdef',parameter_s, namespaces)
556
444
557 def magic_pdoc(self, parameter_s='', namespaces=None):
445 def color_switch_err(name):
558 """Print the docstring for an object.
446 warn('Error changing %s color schemes.\n%s' %
447 (name,sys.exc_info()[1]))
559
448
560 If the given object is a class, it will print both the class and the
561 constructor docstrings."""
562 self._inspect('pdoc',parameter_s, namespaces)
563
449
564 def magic_psource(self, parameter_s='', namespaces=None):
450 new_scheme = parameter_s.strip()
565 """Print (or run through pager) the source code for an object."""
451 if not new_scheme:
566 self._inspect('psource',parameter_s, namespaces)
452 raise UsageError(
453 "%colors: you must specify a color scheme. See '%colors?'")
454 return
455 # local shortcut
456 shell = self.shell
567
457
568 def magic_pfile(self, parameter_s=''):
458 import IPython.utils.rlineimpl as readline
569 """Print (or run through pager) the file where an object is defined.
570
459
571 The file opens at the line where the object definition begins. IPython
460 if not shell.colors_force and \
572 will honor the environment variable PAGER if set, and otherwise will
461 not readline.have_readline and sys.platform == "win32":
573 do its best to print the file in a convenient form.
462 msg = """\
463 Proper color support under MS Windows requires the pyreadline library.
464 You can find it at:
465 http://ipython.org/pyreadline.html
466 Gary's readline needs the ctypes module, from:
467 http://starship.python.net/crew/theller/ctypes
468 (Note that ctypes is already part of Python versions 2.5 and newer).
574
469
575 If the given argument is not an object currently defined, IPython will
470 Defaulting color scheme to 'NoColor'"""
576 try to interpret it as a filename (automatically adding a .py extension
471 new_scheme = 'NoColor'
577 if needed). You can thus use %pfile as a syntax highlighting code
472 warn(msg)
578 viewer."""
579
580 # first interpret argument as an object name
581 out = self._inspect('pfile',parameter_s)
582 # if not, try the input as a filename
583 if out == 'not found':
584 try:
585 filename = get_py_filename(parameter_s)
586 except IOError,msg:
587 print msg
588 return
589 page.page(self.shell.inspector.format(open(filename).read()))
590
591 def magic_psearch(self, parameter_s=''):
592 """Search for object in namespaces by wildcard.
593
473
594 %psearch [options] PATTERN [OBJECT TYPE]
474 # readline option is 0
475 if not shell.colors_force and not shell.has_readline:
476 new_scheme = 'NoColor'
595
477
596 Note: ? can be used as a synonym for %psearch, at the beginning or at
478 # Set prompt colors
597 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
479 try:
598 rest of the command line must be unchanged (options come first), so
480 shell.prompt_manager.color_scheme = new_scheme
599 for example the following forms are equivalent
481 except:
482 color_switch_err('prompt')
483 else:
484 shell.colors = \
485 shell.prompt_manager.color_scheme_table.active_scheme_name
486 # Set exception colors
487 try:
488 shell.InteractiveTB.set_colors(scheme = new_scheme)
489 shell.SyntaxTB.set_colors(scheme = new_scheme)
490 except:
491 color_switch_err('exception')
600
492
601 %psearch -i a* function
493 # Set info (for 'object?') colors
602 -i a* function?
494 if shell.color_info:
603 ?-i a* function
495 try:
496 shell.inspector.set_active_scheme(new_scheme)
497 except:
498 color_switch_err('object inspector')
499 else:
500 shell.inspector.set_active_scheme('NoColor')
604
501
605 Arguments:
502 def magic_xmode(self,parameter_s = ''):
503 """Switch modes for the exception handlers.
606
504
607 PATTERN
505 Valid modes: Plain, Context and Verbose.
608
506
609 where PATTERN is a string containing * as a wildcard similar to its
507 If called without arguments, acts as a toggle."""
610 use in a shell. The pattern is matched in all namespaces on the
611 search path. By default objects starting with a single _ are not
612 matched, many IPython generated objects have a single
613 underscore. The default is case insensitive matching. Matching is
614 also done on the attributes of objects and not only on the objects
615 in a module.
616
508
617 [OBJECT TYPE]
509 def xmode_switch_err(name):
510 warn('Error changing %s exception modes.\n%s' %
511 (name,sys.exc_info()[1]))
618
512
619 Is the name of a python type from the types module. The name is
513 shell = self.shell
620 given in lowercase without the ending type, ex. StringType is
514 new_mode = parameter_s.strip().capitalize()
621 written string. By adding a type here only objects matching the
515 try:
622 given type are matched. Using all here makes the pattern match all
516 shell.InteractiveTB.set_mode(mode=new_mode)
623 types (this is the default).
517 print 'Exception reporting mode:',shell.InteractiveTB.mode
518 except:
519 xmode_switch_err('user')
624
520
625 Options:
521 def magic_quickref(self,arg):
522 """ Show a quick reference sheet """
523 import IPython.core.usage
524 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
525 page.page(qr)
626
526
627 -a: makes the pattern match even objects whose names start with a
527 def magic_doctest_mode(self,parameter_s=''):
628 single underscore. These names are normally omitted from the
528 """Toggle doctest mode on and off.
629 search.
630
529
631 -i/-c: make the pattern case insensitive/sensitive. If neither of
530 This mode is intended to make IPython behave as much as possible like a
632 these options are given, the default is read from your configuration
531 plain Python shell, from the perspective of how its prompts, exceptions
633 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
532 and output look. This makes it easy to copy and paste parts of a
634 If this option is not specified in your configuration file, IPython's
533 session into doctests. It does so by:
635 internal default is to do a case sensitive search.
636
534
637 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
535 - Changing the prompts to the classic ``>>>`` ones.
638 specify can be searched in any of the following namespaces:
536 - Changing the exception reporting mode to 'Plain'.
639 'builtin', 'user', 'user_global','internal', 'alias', where
537 - Disabling pretty-printing of output.
640 'builtin' and 'user' are the search defaults. Note that you should
641 not use quotes when specifying namespaces.
642
538
643 'Builtin' contains the python module builtin, 'user' contains all
539 Note that IPython also supports the pasting of code snippets that have
644 user data, 'alias' only contain the shell aliases and no python
540 leading '>>>' and '...' prompts in them. This means that you can paste
645 objects, 'internal' contains objects used by IPython. The
541 doctests from files or docstrings (even if they have leading
646 'user_global' namespace is only used by embedded IPython instances,
542 whitespace), and the code will execute correctly. You can then use
647 and it contains module-level globals. You can add namespaces to the
543 '%history -t' to see the translated history; this will give you the
648 search with -s or exclude them with -e (these options can be given
544 input after removal of all the leading prompts and whitespace, which
649 more than once).
545 can be pasted back into an editor.
650
546
651 Examples
547 With these features, you can switch into this mode easily whenever you
652 --------
548 need to do testing and changes to doctests, without having to leave
653 ::
549 your existing IPython session.
550 """
654
551
655 %psearch a* -> objects beginning with an a
552 from IPython.utils.ipstruct import Struct
656 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
657 %psearch a* function -> all functions beginning with an a
658 %psearch re.e* -> objects beginning with an e in module re
659 %psearch r*.e* -> objects that start with e in modules starting in r
660 %psearch r*.* string -> all strings in modules beginning with r
661
553
662 Case sensitive search::
554 # Shorthands
555 shell = self.shell
556 pm = shell.prompt_manager
557 meta = shell.meta
558 disp_formatter = self.shell.display_formatter
559 ptformatter = disp_formatter.formatters['text/plain']
560 # dstore is a data store kept in the instance metadata bag to track any
561 # changes we make, so we can undo them later.
562 dstore = meta.setdefault('doctest_mode',Struct())
563 save_dstore = dstore.setdefault
663
564
664 %psearch -c a* list all object beginning with lower case a
565 # save a few values we'll need to recover later
566 mode = save_dstore('mode',False)
567 save_dstore('rc_pprint',ptformatter.pprint)
568 save_dstore('xmode',shell.InteractiveTB.mode)
569 save_dstore('rc_separate_out',shell.separate_out)
570 save_dstore('rc_separate_out2',shell.separate_out2)
571 save_dstore('rc_prompts_pad_left',pm.justify)
572 save_dstore('rc_separate_in',shell.separate_in)
573 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
574 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
665
575
666 Show objects beginning with a single _::
576 if mode == False:
577 # turn on
578 pm.in_template = '>>> '
579 pm.in2_template = '... '
580 pm.out_template = ''
667
581
668 %psearch -a _* list objects beginning with a single underscore"""
582 # Prompt separators like plain python
669 try:
583 shell.separate_in = ''
670 parameter_s.encode('ascii')
584 shell.separate_out = ''
671 except UnicodeEncodeError:
585 shell.separate_out2 = ''
672 print 'Python identifiers can only contain ascii characters.'
673 return
674
586
675 # default namespaces to be searched
587 pm.justify = False
676 def_search = ['user_local', 'user_global', 'builtin']
677
588
678 # Process options/args
589 ptformatter.pprint = False
679 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
590 disp_formatter.plain_text_only = True
680 opt = opts.get
681 shell = self.shell
682 psearch = shell.inspector.psearch
683
591
684 # select case options
592 shell.magic('xmode Plain')
685 if opts.has_key('i'):
686 ignore_case = True
687 elif opts.has_key('c'):
688 ignore_case = False
689 else:
593 else:
690 ignore_case = not shell.wildcards_case_sensitive
594 # turn off
595 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
691
596
692 # Build list of namespaces to search from user options
597 shell.separate_in = dstore.rc_separate_in
693 def_search.extend(opt('s',[]))
694 ns_exclude = ns_exclude=opt('e',[])
695 ns_search = [nm for nm in def_search if nm not in ns_exclude]
696
598
697 # Call the actual search
599 shell.separate_out = dstore.rc_separate_out
698 try:
600 shell.separate_out2 = dstore.rc_separate_out2
699 psearch(args,shell.ns_table,ns_search,
700 show_all=opt('a'),ignore_case=ignore_case)
701 except:
702 shell.showtraceback()
703
601
704 @skip_doctest
602 pm.justify = dstore.rc_prompts_pad_left
705 def magic_who_ls(self, parameter_s=''):
706 """Return a sorted list of all interactive variables.
707
603
708 If arguments are given, only variables of types matching these
604 ptformatter.pprint = dstore.rc_pprint
709 arguments are returned.
605 disp_formatter.plain_text_only = dstore.rc_plain_text_only
710
606
711 Examples
607 shell.magic('xmode ' + dstore.xmode)
712 --------
713
608
714 Define two variables and list them with who_ls::
609 # Store new mode and inform
610 dstore.mode = bool(1-int(mode))
611 mode_label = ['OFF','ON'][dstore.mode]
612 print 'Doctest mode is:', mode_label
715
613
716 In [1]: alpha = 123
614 def magic_gui(self, parameter_s=''):
615 """Enable or disable IPython GUI event loop integration.
717
616
718 In [2]: beta = 'test'
617 %gui [GUINAME]
719
618
720 In [3]: %who_ls
619 This magic replaces IPython's threaded shells that were activated
721 Out[3]: ['alpha', 'beta']
620 using the (pylab/wthread/etc.) command line flags. GUI toolkits
621 can now be enabled at runtime and keyboard
622 interrupts should work without any problems. The following toolkits
623 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
722
624
723 In [4]: %who_ls int
625 %gui wx # enable wxPython event loop integration
724 Out[4]: ['alpha']
626 %gui qt4|qt # enable PyQt4 event loop integration
627 %gui gtk # enable PyGTK event loop integration
628 %gui gtk3 # enable Gtk3 event loop integration
629 %gui tk # enable Tk event loop integration
630 %gui OSX # enable Cocoa event loop integration
631 # (requires %matplotlib 1.1)
632 %gui # disable all event loop integration
725
633
726 In [5]: %who_ls str
634 WARNING: after any of these has been called you can simply create
727 Out[5]: ['beta']
635 an application object, but DO NOT start the event loop yourself, as
636 we have already handled that.
728 """
637 """
729
638 opts, arg = self.parse_options(parameter_s, '')
730 user_ns = self.shell.user_ns
639 if arg=='': arg = None
731 user_ns_hidden = self.shell.user_ns_hidden
640 try:
732 out = [ i for i in user_ns
641 return self.enable_gui(arg)
733 if not i.startswith('_') \
642 except Exception as e:
734 and not i in user_ns_hidden ]
643 # print simple error message, rather than traceback if we can't
735
644 # hook up the GUI
736 typelist = parameter_s.split()
645 error(str(e))
737 if typelist:
738 typeset = set(typelist)
739 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
740
741 out.sort()
742 return out
743
646
744 @skip_doctest
647 @skip_doctest
745 def magic_who(self, parameter_s=''):
648 def magic_precision(self, s=''):
746 """Print all interactive variables, with some minimal formatting.
649 """Set floating point precision for pretty printing.
747
650
748 If any arguments are given, only variables whose type matches one of
651 Can set either integer precision or a format string.
749 these are printed. For example::
750
652
751 %who function str
653 If numpy has been imported and precision is an int,
654 numpy display precision will also be set, via ``numpy.set_printoptions``.
752
655
753 will only list functions and strings, excluding all other types of
656 If no argument is given, defaults will be restored.
754 variables. To find the proper type names, simply use type(var) at a
755 command line to see how python prints type names. For example:
756
657
658 Examples
659 --------
757 ::
660 ::
758
661
759 In [1]: type('hello')\\
662 In [1]: from math import pi
760 Out[1]: <type 'str'>
761
663
762 indicates that the type name for strings is 'str'.
664 In [2]: %precision 3
665 Out[2]: u'%.3f'
763
666
764 ``%who`` always excludes executed names loaded through your configuration
667 In [3]: pi
765 file and things which are internal to IPython.
668 Out[3]: 3.142
766
669
767 This is deliberate, as typically you may load many modules and the
670 In [4]: %precision %i
768 purpose of %who is to show you only what you've manually defined.
671 Out[4]: u'%i'
769
672
770 Examples
673 In [5]: pi
771 --------
674 Out[5]: 3
772
675
773 Define two variables and list them with who::
676 In [6]: %precision %e
677 Out[6]: u'%e'
774
678
775 In [1]: alpha = 123
679 In [7]: pi**10
680 Out[7]: 9.364805e+04
776
681
777 In [2]: beta = 'test'
682 In [8]: %precision
683 Out[8]: u'%r'
778
684
779 In [3]: %who
685 In [9]: pi**10
780 alpha beta
686 Out[9]: 93648.047476082982
687 """
688 ptformatter = self.shell.display_formatter.formatters['text/plain']
689 ptformatter.float_precision = s
690 return ptformatter.float_format
781
691
782 In [4]: %who int
692 @magic_arguments.magic_arguments()
783 alpha
693 @magic_arguments.argument(
694 '-e', '--export', action='store_true', default=False,
695 help='Export IPython history as a notebook. The filename argument '
696 'is used to specify the notebook name and format. For example '
697 'a filename of notebook.ipynb will result in a notebook name '
698 'of "notebook" and a format of "xml". Likewise using a ".json" '
699 'or ".py" file extension will write the notebook in the json '
700 'or py formats.'
701 )
702 @magic_arguments.argument(
703 '-f', '--format',
704 help='Convert an existing IPython notebook to a new format. This option '
705 'specifies the new format and can have the values: xml, json, py. '
706 'The target filename is chosen automatically based on the new '
707 'format. The filename argument gives the name of the source file.'
708 )
709 @magic_arguments.argument(
710 'filename', type=unicode,
711 help='Notebook name or filename'
712 )
713 def magic_notebook(self, s):
714 """Export and convert IPython notebooks.
784
715
785 In [5]: %who str
716 This function can export the current IPython history to a notebook file
786 beta
717 or can convert an existing notebook file into a different format. For
718 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
719 To export the history to "foo.py" do "%notebook -e foo.py". To convert
720 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
721 formats include (json/ipynb, py).
787 """
722 """
723 args = magic_arguments.parse_argstring(self.magic_notebook, s)
788
724
789 varlist = self.magic_who_ls(parameter_s)
725 from IPython.nbformat import current
790 if not varlist:
726 args.filename = unquote_filename(args.filename)
791 if parameter_s:
727 if args.export:
792 print 'No variables match your requested type.'
728 fname, name, format = current.parse_filename(args.filename)
729 cells = []
730 hist = list(self.shell.history_manager.get_range())
731 for session, prompt_number, input in hist[:-1]:
732 cells.append(current.new_code_cell(prompt_number=prompt_number,
733 input=input))
734 worksheet = current.new_worksheet(cells=cells)
735 nb = current.new_notebook(name=name,worksheets=[worksheet])
736 with io.open(fname, 'w', encoding='utf-8') as f:
737 current.write(nb, f, format);
738 elif args.format is not None:
739 old_fname, old_name, old_format = current.parse_filename(args.filename)
740 new_format = args.format
741 if new_format == u'xml':
742 raise ValueError('Notebooks cannot be written as xml.')
743 elif new_format == u'ipynb' or new_format == u'json':
744 new_fname = old_name + u'.ipynb'
745 new_format = u'json'
746 elif new_format == u'py':
747 new_fname = old_name + u'.py'
793 else:
748 else:
794 print 'Interactive namespace is empty.'
749 raise ValueError('Invalid notebook format: %s' % new_format)
795 return
750 with io.open(old_fname, 'r', encoding='utf-8') as f:
751 nb = current.read(f, old_format)
752 with io.open(new_fname, 'w', encoding='utf-8') as f:
753 current.write(nb, f, new_format)
796
754
797 # if we have variables, move on...
798 count = 0
799 for i in varlist:
800 print i+'\t',
801 count += 1
802 if count > 8:
803 count = 0
804 print
805 print
806
755
807 @skip_doctest
756 class CodeMagics(MagicFunctions):
808 def magic_whos(self, parameter_s=''):
757 """Magics related to code management (loading, saving, editing, ...)."""
809 """Like %who, but gives some extra information about each variable.
810
758
811 The same type filtering of %who can be applied here.
759 def magic_save(self,parameter_s = ''):
760 """Save a set of lines or a macro to a given filename.
812
761
813 For all variables, the type is printed. Additionally it prints:
762 Usage:\\
763 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
814
764
815 - For {},[],(): their length.
765 Options:
816
766
817 - For numpy arrays, a summary with shape, number of
767 -r: use 'raw' input. By default, the 'processed' history is used,
818 elements, typecode and size in memory.
768 so that magics are loaded in their transformed version to valid
769 Python. If this option is given, the raw input as typed as the
770 command line is used instead.
819
771
820 - Everything else: a string representation, snipping their middle if
772 This function uses the same syntax as %history for input ranges,
821 too long.
773 then saves the lines to the filename you specify.
822
774
823 Examples
775 It adds a '.py' extension to the file if you don't do so yourself, and
824 --------
776 it asks for confirmation before overwriting existing files."""
825
777
826 Define two variables and list them with whos::
778 opts,args = self.parse_options(parameter_s,'r',mode='list')
779 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
780 if not fname.endswith('.py'):
781 fname += '.py'
782 if os.path.isfile(fname):
783 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
784 if ans.lower() not in ['y','yes']:
785 print 'Operation cancelled.'
786 return
787 try:
788 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
789 except (TypeError, ValueError) as e:
790 print e.args[0]
791 return
792 with io.open(fname,'w', encoding="utf-8") as f:
793 f.write(u"# coding: utf-8\n")
794 f.write(py3compat.cast_unicode(cmds))
795 print 'The following commands were written to file `%s`:' % fname
796 print cmds
827
797
828 In [1]: alpha = 123
798 def magic_pastebin(self, parameter_s = ''):
799 """Upload code to Github's Gist paste bin, returning the URL.
829
800
830 In [2]: beta = 'test'
801 Usage:\\
802 %pastebin [-d "Custom description"] 1-7
831
803
832 In [3]: %whos
804 The argument can be an input history range, a filename, or the name of a
833 Variable Type Data/Info
805 string or macro.
834 --------------------------------
806
835 alpha int 123
807 Options:
836 beta str test
808
809 -d: Pass a custom description for the gist. The default will say
810 "Pasted from IPython".
837 """
811 """
812 opts, args = self.parse_options(parameter_s, 'd:')
838
813
839 varnames = self.magic_who_ls(parameter_s)
814 try:
840 if not varnames:
815 code = self.shell.find_user_code(args)
841 if parameter_s:
816 except (ValueError, TypeError) as e:
842 print 'No variables match your requested type.'
817 print e.args[0]
843 else:
844 print 'Interactive namespace is empty.'
845 return
818 return
846
819
847 # if we have variables, move on...
820 post_data = json.dumps({
821 "description": opts.get('d', "Pasted from IPython"),
822 "public": True,
823 "files": {
824 "file1.py": {
825 "content": code
826 }
827 }
828 }).encode('utf-8')
848
829
849 # for these types, show len() instead of data:
830 response = urlopen("https://api.github.com/gists", post_data)
850 seq_types = ['dict', 'list', 'tuple']
831 response_data = json.loads(response.read().decode('utf-8'))
832 return response_data['html_url']
851
833
852 # for numpy arrays, display summary info
834 def magic_loadpy(self, arg_s):
853 ndarray_type = None
835 """Alias of `%load`
854 if 'numpy' in sys.modules:
855 try:
856 from numpy import ndarray
857 except ImportError:
858 pass
859 else:
860 ndarray_type = ndarray.__name__
861
836
862 # Find all variable names and types so we can figure out column sizes
837 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
863 def get_vars(i):
838 extension. So it has been renamed simply into %load. You can look at
864 return self.shell.user_ns[i]
839 `%load`'s docstring for more info.
840 """
841 self.magic_load(arg_s)
865
842
866 # some types are well known and can be shorter
843 def magic_load(self, arg_s):
867 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
844 """Load code into the current frontend.
868 def type_name(v):
869 tn = type(v).__name__
870 return abbrevs.get(tn,tn)
871
845
872 varlist = map(get_vars,varnames)
846 Usage:\\
847 %load [options] source
873
848
874 typelist = []
849 where source can be a filename, URL, input history range or macro
875 for vv in varlist:
876 tt = type_name(vv)
877
850
878 if tt=='instance':
851 Options:
879 typelist.append( abbrevs.get(str(vv.__class__),
852 --------
880 str(vv.__class__)))
853 -y : Don't ask confirmation for loading source above 200 000 characters.
881 else:
882 typelist.append(tt)
883
854
884 # column labels and # of spaces as separator
855 This magic command can either take a local filename, a URL, an history
885 varlabel = 'Variable'
856 range (see %history) or a macro as argument, it will prompt for
886 typelabel = 'Type'
857 confirmation before loading source with more than 200 000 characters, unless
887 datalabel = 'Data/Info'
858 -y flag is passed or if the frontend does not support raw_input::
888 colsep = 3
889 # variable format strings
890 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
891 aformat = "%s: %s elems, type `%s`, %s bytes"
892 # find the size of the columns to format the output nicely
893 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
894 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
895 # table header
896 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
897 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
898 # and the table itself
899 kb = 1024
900 Mb = 1048576 # kb**2
901 for vname,var,vtype in zip(varnames,varlist,typelist):
902 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
903 if vtype in seq_types:
904 print "n="+str(len(var))
905 elif vtype == ndarray_type:
906 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
907 if vtype==ndarray_type:
908 # numpy
909 vsize = var.size
910 vbytes = vsize*var.itemsize
911 vdtype = var.dtype
912
859
913 if vbytes < 100000:
860 %load myscript.py
914 print aformat % (vshape,vsize,vdtype,vbytes)
861 %load 7-27
915 else:
862 %load myMacro
916 print aformat % (vshape,vsize,vdtype,vbytes),
863 %load http://www.example.com/myscript.py
917 if vbytes < Mb:
864 """
918 print '(%s kb)' % (vbytes/kb,)
865 opts,args = self.parse_options(arg_s,'y')
919 else:
866
920 print '(%s Mb)' % (vbytes/Mb,)
867 contents = self.shell.find_user_code(args)
921 else:
868 l = len(contents)
869
870 # 200 000 is ~ 2500 full 80 caracter lines
871 # so in average, more than 5000 lines
872 if l > 200000 and 'y' not in opts:
922 try:
873 try:
923 vstr = str(var)
874 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
924 except UnicodeEncodeError:
875 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
925 vstr = unicode(var).encode(DEFAULT_ENCODING,
876 except StdinNotImplementedError:
926 'backslashreplace')
877 #asume yes if raw input not implemented
927 except:
878 ans = True
928 vstr = "<object with id %d (str() failed)>" % id(var)
929 vstr = vstr.replace('\n','\\n')
930 if len(vstr) < 50:
931 print vstr
932 else:
933 print vstr[:25] + "<...>" + vstr[-25:]
934
879
935 def magic_reset(self, parameter_s=''):
880 if ans is False :
936 """Resets the namespace by removing all names defined by the user, if
881 print 'Operation cancelled.'
937 called without arguments, or by removing some types of objects, such
882 return
938 as everything currently in IPython's In[] and Out[] containers (see
939 the parameters for details).
940
883
941 Parameters
884 self.set_next_input(contents)
942 ----------
943 -f : force reset without asking for confirmation.
944
885
945 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
886 def _find_edit_target(self, args, opts, last_call):
946 References to objects may be kept. By default (without this option),
887 """Utility method used by magic_edit to find what to edit."""
947 we do a 'hard' reset, giving you a new session and removing all
948 references to objects from the current session.
949
888
950 in : reset input history
889 def make_filename(arg):
890 "Make a filename from the given args"
891 arg = unquote_filename(arg)
892 try:
893 filename = get_py_filename(arg)
894 except IOError:
895 # If it ends with .py but doesn't already exist, assume we want
896 # a new file.
897 if arg.endswith('.py'):
898 filename = arg
899 else:
900 filename = None
901 return filename
951
902
952 out : reset output history
903 # Set a few locals from the options for convenience:
904 opts_prev = 'p' in opts
905 opts_raw = 'r' in opts
953
906
954 dhist : reset directory history
907 # custom exceptions
908 class DataIsObject(Exception): pass
955
909
956 array : reset only variables that are NumPy arrays
910 # Default line number value
911 lineno = opts.get('n',None)
957
912
958 See Also
913 if opts_prev:
959 --------
914 args = '_%s' % last_call[0]
960 magic_reset_selective : invoked as ``%reset_selective``
915 if not self.shell.user_ns.has_key(args):
916 args = last_call[1]
961
917
962 Examples
918 # use last_call to remember the state of the previous call, but don't
963 --------
919 # let it be clobbered by successive '-p' calls.
964 ::
920 try:
921 last_call[0] = self.shell.displayhook.prompt_count
922 if not opts_prev:
923 last_call[1] = args
924 except:
925 pass
965
926
966 In [6]: a = 1
927 # by default this is done with temp files, except when the given
928 # arg is a filename
929 use_temp = True
967
930
968 In [7]: a
931 data = ''
969 Out[7]: 1
970
932
971 In [8]: 'a' in _ip.user_ns
933 # First, see if the arguments should be a filename.
972 Out[8]: True
934 filename = make_filename(args)
935 if filename:
936 use_temp = False
937 elif args:
938 # Mode where user specifies ranges of lines, like in %macro.
939 data = self.shell.extract_input_lines(args, opts_raw)
940 if not data:
941 try:
942 # Load the parameter given as a variable. If not a string,
943 # process it as an object instead (below)
973
944
974 In [9]: %reset -f
945 #print '*** args',args,'type',type(args) # dbg
946 data = eval(args, self.shell.user_ns)
947 if not isinstance(data, basestring):
948 raise DataIsObject
975
949
976 In [1]: 'a' in _ip.user_ns
950 except (NameError,SyntaxError):
977 Out[1]: False
951 # given argument is not a variable, try as a filename
952 filename = make_filename(args)
953 if filename is None:
954 warn("Argument given (%s) can't be found as a variable "
955 "or as a filename." % args)
956 return
957 use_temp = False
978
958
979 In [2]: %reset -f in
959 except DataIsObject:
980 Flushing input history
960 # macros have a special edit function
961 if isinstance(data, Macro):
962 raise MacroToEdit(data)
981
963
982 In [3]: %reset -f dhist in
964 # For objects, try to edit the file where they are defined
983 Flushing directory history
965 try:
984 Flushing input history
966 filename = inspect.getabsfile(data)
967 if 'fakemodule' in filename.lower() and inspect.isclass(data):
968 # class created by %edit? Try to find source
969 # by looking for method definitions instead, the
970 # __module__ in those classes is FakeModule.
971 attrs = [getattr(data, aname) for aname in dir(data)]
972 for attr in attrs:
973 if not inspect.ismethod(attr):
974 continue
975 filename = inspect.getabsfile(attr)
976 if filename and 'fakemodule' not in filename.lower():
977 # change the attribute to be the edit target instead
978 data = attr
979 break
985
980
986 Notes
981 datafile = 1
987 -----
982 except TypeError:
988 Calling this magic from clients that do not implement standard input,
983 filename = make_filename(args)
989 such as the ipython notebook interface, will reset the namespace
984 datafile = 1
990 without confirmation.
985 warn('Could not find file where `%s` is defined.\n'
991 """
986 'Opening a file named `%s`' % (args,filename))
992 opts, args = self.parse_options(parameter_s,'sf', mode='list')
987 # Now, make sure we can actually read the source (if it was in
993 if 'f' in opts:
988 # a temp file it's gone by now).
994 ans = True
989 if datafile:
995 else:
996 try:
990 try:
997 ans = self.shell.ask_yes_no(
991 if lineno is None:
998 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
992 lineno = inspect.getsourcelines(data)[1]
999 except StdinNotImplementedError:
993 except IOError:
1000 ans = True
994 filename = make_filename(args)
1001 if not ans:
995 if filename is None:
1002 print 'Nothing done.'
996 warn('The file `%s` where `%s` was defined cannot '
997 'be read.' % (filename,data))
1003 return
998 return
999 use_temp = False
1004
1000
1005 if 's' in opts: # Soft reset
1001 if use_temp:
1006 user_ns = self.shell.user_ns
1002 filename = self.shell.mktempfile(data)
1007 for i in self.magic_who_ls():
1003 print 'IPython will make a temporary file named:',filename
1008 del(user_ns[i])
1009 elif len(args) == 0: # Hard reset
1010 self.shell.reset(new_session = False)
1011
1012 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1013 ip = self.shell
1014 user_ns = self.shell.user_ns # local lookup, heavily used
1015
1004
1016 for target in args:
1005 return filename, lineno, use_temp
1017 target = target.lower() # make matches case insensitive
1018 if target == 'out':
1019 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1020 self.shell.displayhook.flush()
1021
1006
1022 elif target == 'in':
1007 def _edit_macro(self,mname,macro):
1023 print "Flushing input history"
1008 """open an editor with the macro data in a file"""
1024 pc = self.shell.displayhook.prompt_count + 1
1009 filename = self.shell.mktempfile(macro.value)
1025 for n in range(1, pc):
1010 self.shell.hooks.editor(filename)
1026 key = '_i'+repr(n)
1027 user_ns.pop(key,None)
1028 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1029 hm = ip.history_manager
1030 # don't delete these, as %save and %macro depending on the length
1031 # of these lists to be preserved
1032 hm.input_hist_parsed[:] = [''] * pc
1033 hm.input_hist_raw[:] = [''] * pc
1034 # hm has internal machinery for _i,_ii,_iii, clear it out
1035 hm._i = hm._ii = hm._iii = hm._i00 = u''
1036
1011
1037 elif target == 'array':
1012 # and make a new macro object, to replace the old one
1038 # Support cleaning up numpy arrays
1013 mfile = open(filename)
1039 try:
1014 mvalue = mfile.read()
1040 from numpy import ndarray
1015 mfile.close()
1041 # This must be done with items and not iteritems because we're
1016 self.shell.user_ns[mname] = Macro(mvalue)
1042 # going to modify the dict in-place.
1043 for x,val in user_ns.items():
1044 if isinstance(val,ndarray):
1045 del user_ns[x]
1046 except ImportError:
1047 print "reset array only works if Numpy is available."
1048
1017
1049 elif target == 'dhist':
1018 def magic_ed(self,parameter_s=''):
1050 print "Flushing directory history"
1019 """Alias to %edit."""
1051 del user_ns['_dh'][:]
1020 return self.magic_edit(parameter_s)
1052
1021
1053 else:
1022 @skip_doctest
1054 print "Don't know how to reset ",
1023 def magic_edit(self,parameter_s='',last_call=['','']):
1055 print target + ", please run `%reset?` for details"
1024 """Bring up an editor and execute the resulting code.
1056
1025
1057 gc.collect()
1026 Usage:
1027 %edit [options] [args]
1058
1028
1059 def magic_reset_selective(self, parameter_s=''):
1029 %edit runs IPython's editor hook. The default version of this hook is
1060 """Resets the namespace by removing names defined by the user.
1030 set to call the editor specified by your $EDITOR environment variable.
1031 If this isn't found, it will default to vi under Linux/Unix and to
1032 notepad under Windows. See the end of this docstring for how to change
1033 the editor hook.
1061
1034
1062 Input/Output history are left around in case you need them.
1035 You can also set the value of this editor via the
1036 ``TerminalInteractiveShell.editor`` option in your configuration file.
1037 This is useful if you wish to use a different editor from your typical
1038 default with IPython (and for Windows users who typically don't set
1039 environment variables).
1063
1040
1064 %reset_selective [-f] regex
1041 This command allows you to conveniently edit multi-line code right in
1042 your IPython session.
1065
1043
1066 No action is taken if regex is not included
1044 If called without arguments, %edit opens up an empty editor with a
1045 temporary file and will execute the contents of this file when you
1046 close it (don't forget to save it!).
1067
1047
1068 Options
1069 -f : force reset without asking for confirmation.
1070
1048
1071 See Also
1049 Options:
1072 --------
1073 magic_reset : invoked as ``%reset``
1074
1050
1075 Examples
1051 -n <number>: open the editor at a specified line number. By default,
1076 --------
1052 the IPython editor hook uses the unix syntax 'editor +N filename', but
1053 you can configure this by providing your own modified hook if your
1054 favorite editor supports line-number specifications with a different
1055 syntax.
1077
1056
1078 We first fully reset the namespace so your output looks identical to
1057 -p: this will call the editor with the same data as the previous time
1079 this example for pedagogical reasons; in practice you do not need a
1058 it was used, regardless of how long ago (in your current session) it
1080 full reset::
1059 was.
1081
1060
1082 In [1]: %reset -f
1061 -r: use 'raw' input. This option only applies to input taken from the
1062 user's history. By default, the 'processed' history is used, so that
1063 magics are loaded in their transformed version to valid Python. If
1064 this option is given, the raw input as typed as the command line is
1065 used instead. When you exit the editor, it will be executed by
1066 IPython's own processor.
1083
1067
1084 Now, with a clean namespace we can make a few variables and use
1068 -x: do not execute the edited code immediately upon exit. This is
1085 ``%reset_selective`` to only delete names that match our regexp::
1069 mainly useful if you are editing programs which need to be called with
1070 command line arguments, which you can then do using %run.
1086
1071
1087 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1088
1072
1089 In [3]: who_ls
1073 Arguments:
1090 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1091
1074
1092 In [4]: %reset_selective -f b[2-3]m
1075 If arguments are given, the following possibilities exist:
1093
1076
1094 In [5]: who_ls
1077 - If the argument is a filename, IPython will load that into the
1095 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1078 editor. It will execute its contents with execfile() when you exit,
1079 loading any code in the file into your interactive namespace.
1096
1080
1097 In [6]: %reset_selective -f d
1081 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
1082 The syntax is the same as in the %history magic.
1098
1083
1099 In [7]: who_ls
1084 - If the argument is a string variable, its contents are loaded
1100 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1085 into the editor. You can thus edit any string which contains
1086 python code (including the result of previous edits).
1101
1087
1102 In [8]: %reset_selective -f c
1088 - If the argument is the name of an object (other than a string),
1089 IPython will try to locate the file where it was defined and open the
1090 editor at the point where it is defined. You can use `%edit function`
1091 to load an editor exactly at the point where 'function' is defined,
1092 edit it and have the file be executed automatically.
1103
1093
1104 In [9]: who_ls
1094 - If the object is a macro (see %macro for details), this opens up your
1105 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1095 specified editor with a temporary file containing the macro's data.
1096 Upon exit, the macro is reloaded with the contents of the file.
1106
1097
1107 In [10]: %reset_selective -f b
1098 Note: opening at an exact line is only supported under Unix, and some
1099 editors (like kedit and gedit up to Gnome 2.8) do not understand the
1100 '+NUMBER' parameter necessary for this feature. Good editors like
1101 (X)Emacs, vi, jed, pico and joe all do.
1108
1102
1109 In [11]: who_ls
1103 After executing your code, %edit will return as output the code you
1110 Out[11]: ['a']
1104 typed in the editor (except when it was an existing file). This way
1105 you can reload the code in further invocations of %edit as a variable,
1106 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
1107 the output.
1111
1108
1112 Notes
1109 Note that %edit is also available through the alias %ed.
1113 -----
1114 Calling this magic from clients that do not implement standard input,
1115 such as the ipython notebook interface, will reset the namespace
1116 without confirmation.
1117 """
1118
1110
1119 opts, regex = self.parse_options(parameter_s,'f')
1111 This is an example of creating a simple function inside the editor and
1112 then modifying it. First, start up the editor::
1120
1113
1121 if opts.has_key('f'):
1114 In [1]: ed
1122 ans = True
1115 Editing... done. Executing edited code...
1123 else:
1116 Out[1]: 'def foo():\\n print "foo() was defined in an editing
1124 try:
1117 session"\\n'
1125 ans = self.shell.ask_yes_no(
1126 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1127 default='n')
1128 except StdinNotImplementedError:
1129 ans = True
1130 if not ans:
1131 print 'Nothing done.'
1132 return
1133 user_ns = self.shell.user_ns
1134 if not regex:
1135 print 'No regex pattern specified. Nothing done.'
1136 return
1137 else:
1138 try:
1139 m = re.compile(regex)
1140 except TypeError:
1141 raise TypeError('regex must be a string or compiled pattern')
1142 for i in self.magic_who_ls():
1143 if m.search(i):
1144 del(user_ns[i])
1145
1118
1146 def magic_xdel(self, parameter_s=''):
1119 We can then call the function foo()::
1147 """Delete a variable, trying to clear it from anywhere that
1148 IPython's machinery has references to it. By default, this uses
1149 the identity of the named object in the user namespace to remove
1150 references held under other names. The object is also removed
1151 from the output history.
1152
1120
1153 Options
1121 In [2]: foo()
1154 -n : Delete the specified name from all namespaces, without
1122 foo() was defined in an editing session
1155 checking their identity.
1156 """
1157 opts, varname = self.parse_options(parameter_s,'n')
1158 try:
1159 self.shell.del_var(varname, ('n' in opts))
1160 except (NameError, ValueError) as e:
1161 print type(e).__name__ +": "+ str(e)
1162
1123
1163 def magic_logstart(self,parameter_s=''):
1124 Now we edit foo. IPython automatically loads the editor with the
1164 """Start logging anywhere in a session.
1125 (temporary) file where foo() was previously defined::
1165
1126
1166 %logstart [-o|-r|-t] [log_name [log_mode]]
1127 In [3]: ed foo
1128 Editing... done. Executing edited code...
1167
1129
1168 If no name is given, it defaults to a file named 'ipython_log.py' in your
1130 And if we call foo() again we get the modified version::
1169 current directory, in 'rotate' mode (see below).
1170
1131
1171 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1132 In [4]: foo()
1172 history up to that point and then continues logging.
1133 foo() has now been changed!
1173
1134
1174 %logstart takes a second optional parameter: logging mode. This can be one
1135 Here is an example of how to edit a code snippet successive
1175 of (note that the modes are given unquoted):\\
1136 times. First we call the editor::
1176 append: well, that says it.\\
1177 backup: rename (if exists) to name~ and start name.\\
1178 global: single logfile in your home dir, appended to.\\
1179 over : overwrite existing log.\\
1180 rotate: create rotating logs name.1~, name.2~, etc.
1181
1137
1182 Options:
1138 In [5]: ed
1139 Editing... done. Executing edited code...
1140 hello
1141 Out[5]: "print 'hello'\\n"
1183
1142
1184 -o: log also IPython's output. In this mode, all commands which
1143 Now we call it again with the previous output (stored in _)::
1185 generate an Out[NN] prompt are recorded to the logfile, right after
1186 their corresponding input line. The output lines are always
1187 prepended with a '#[Out]# ' marker, so that the log remains valid
1188 Python code.
1189
1144
1190 Since this marker is always the same, filtering only the output from
1145 In [6]: ed _
1191 a log is very easy, using for example a simple awk call::
1146 Editing... done. Executing edited code...
1147 hello world
1148 Out[6]: "print 'hello world'\\n"
1192
1149
1193 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1150 Now we call it with the output #8 (stored in _8, also as Out[8])::
1194
1151
1195 -r: log 'raw' input. Normally, IPython's logs contain the processed
1152 In [7]: ed _8
1196 input, so that user lines are logged in their final form, converted
1153 Editing... done. Executing edited code...
1197 into valid Python. For example, %Exit is logged as
1154 hello again
1198 _ip.magic("Exit"). If the -r flag is given, all input is logged
1155 Out[7]: "print 'hello again'\\n"
1199 exactly as typed, with no transformations applied.
1200
1156
1201 -t: put timestamps before each input line logged (these are put in
1202 comments)."""
1203
1157
1204 opts,par = self.parse_options(parameter_s,'ort')
1158 Changing the default editor hook:
1205 log_output = 'o' in opts
1206 log_raw_input = 'r' in opts
1207 timestamp = 't' in opts
1208
1159
1209 logger = self.shell.logger
1160 If you wish to write your own editor hook, you can put it in a
1161 configuration file which you load at startup time. The default hook
1162 is defined in the IPython.core.hooks module, and you can use that as a
1163 starting example for further modifications. That file also has
1164 general instructions on how to set a new hook for use once you've
1165 defined it."""
1166 opts,args = self.parse_options(parameter_s,'prxn:')
1210
1167
1211 # if no args are given, the defaults set in the logger constructor by
1212 # ipython remain valid
1213 if par:
1214 try:
1168 try:
1215 logfname,logmode = par.split()
1169 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
1216 except:
1170 except MacroToEdit as e:
1217 logfname = par
1171 self._edit_macro(args, e.args[0])
1218 logmode = 'backup'
1172 return
1219 else:
1220 logfname = logger.logfname
1221 logmode = logger.logmode
1222 # put logfname into rc struct as if it had been called on the command
1223 # line, so it ends up saved in the log header Save it in case we need
1224 # to restore it...
1225 old_logfile = self.shell.logfile
1226 if logfname:
1227 logfname = os.path.expanduser(logfname)
1228 self.shell.logfile = logfname
1229
1173
1230 loghead = '# IPython log file\n\n'
1174 # do actual editing here
1175 print 'Editing...',
1176 sys.stdout.flush()
1231 try:
1177 try:
1232 started = logger.logstart(logfname,loghead,logmode,
1178 # Quote filenames that may have spaces in them
1233 log_output,timestamp,log_raw_input)
1179 if ' ' in filename:
1234 except:
1180 filename = "'%s'" % filename
1235 self.shell.logfile = old_logfile
1181 self.shell.hooks.editor(filename,lineno)
1236 warn("Couldn't start log: %s" % sys.exc_info()[1])
1182 except TryNext:
1237 else:
1183 warn('Could not open editor')
1238 # log input history up to this point, optionally interleaving
1184 return
1239 # output if requested
1240
1185
1241 if timestamp:
1186 # XXX TODO: should this be generalized for all string vars?
1242 # disable timestamping for the previous history, since we've
1187 # For now, this is special-cased to blocks created by cpaste
1243 # lost those already (no time machine here).
1188 if args.strip() == 'pasted_block':
1244 logger.timestamp = False
1189 self.shell.user_ns['pasted_block'] = file_read(filename)
1245
1190
1246 if log_raw_input:
1191 if 'x' in opts: # -x prevents actual execution
1247 input_hist = self.shell.history_manager.input_hist_raw
1192 print
1248 else:
1193 else:
1249 input_hist = self.shell.history_manager.input_hist_parsed
1194 print 'done. Executing edited code...'
1250
1195 if 'r' in opts: # Untranslated IPython code
1251 if log_output:
1196 self.shell.run_cell(file_read(filename),
1252 log_write = logger.log_write
1197 store_history=False)
1253 output_hist = self.shell.history_manager.output_hist
1254 for n in range(1,len(input_hist)-1):
1255 log_write(input_hist[n].rstrip() + '\n')
1256 if n in output_hist:
1257 log_write(repr(output_hist[n]),'output')
1258 else:
1198 else:
1259 logger.log_write('\n'.join(input_hist[1:]))
1199 self.shell.safe_execfile(filename, self.shell.user_ns,
1260 logger.log_write('\n')
1200 self.shell.user_ns)
1261 if timestamp:
1262 # re-enable timestamping
1263 logger.timestamp = True
1264
1265 print ('Activating auto-logging. '
1266 'Current session state plus future input saved.')
1267 logger.logstate()
1268
1201
1269 def magic_logstop(self,parameter_s=''):
1202 if is_temp:
1270 """Fully stop logging and close log file.
1203 try:
1204 return open(filename).read()
1205 except IOError,msg:
1206 if msg.filename == filename:
1207 warn('File not found. Did you forget to save?')
1208 return
1209 else:
1210 self.shell.showtraceback()
1271
1211
1272 In order to start logging again, a new %logstart call needs to be made,
1273 possibly (though not necessarily) with a new filename, mode and other
1274 options."""
1275 self.logger.logstop()
1276
1212
1277 def magic_logoff(self,parameter_s=''):
1213 class ConfigMagics(MagicFunctions):
1278 """Temporarily stop logging.
1279
1214
1280 You must have previously started logging."""
1215 def __init__(self, shell):
1281 self.shell.logger.switch_log(0)
1216 super(ProfileMagics, self).__init__(shell)
1217 self.configurables = []
1282
1218
1283 def magic_logon(self,parameter_s=''):
1219 def magic_config(self, s):
1284 """Restart logging.
1220 """configure IPython
1285
1221
1286 This function is for restarting logging which you've temporarily
1222 %config Class[.trait=value]
1287 stopped with %logoff. For starting logging for the first time, you
1288 must use the %logstart function, which allows you to specify an
1289 optional log filename."""
1290
1223
1291 self.shell.logger.switch_log(1)
1224 This magic exposes most of the IPython config system. Any
1225 Configurable class should be able to be configured with the simple
1226 line::
1292
1227
1293 def magic_logstate(self,parameter_s=''):
1228 %config Class.trait=value
1294 """Print the status of the logging system."""
1295
1229
1296 self.shell.logger.logstate()
1230 Where `value` will be resolved in the user's namespace, if it is an
1231 expression or variable name.
1297
1232
1298 def magic_pdb(self, parameter_s=''):
1233 Examples
1299 """Control the automatic calling of the pdb interactive debugger.
1234 --------
1300
1235
1301 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1236 To see what classes are available for config, pass no arguments::
1302 argument it works as a toggle.
1303
1237
1304 When an exception is triggered, IPython can optionally call the
1238 In [1]: %config
1305 interactive pdb debugger after the traceback printout. %pdb toggles
1239 Available objects for config:
1306 this feature on and off.
1240 TerminalInteractiveShell
1241 HistoryManager
1242 PrefilterManager
1243 AliasManager
1244 IPCompleter
1245 PromptManager
1246 DisplayFormatter
1307
1247
1308 The initial state of this feature is set in your configuration
1248 To view what is configurable on a given class, just pass the class
1309 file (the option is ``InteractiveShell.pdb``).
1249 name::
1310
1250
1311 If you want to just activate the debugger AFTER an exception has fired,
1251 In [2]: %config IPCompleter
1312 without having to type '%pdb on' and rerunning your code, you can use
1252 IPCompleter options
1313 the %debug magic."""
1253 -----------------
1254 IPCompleter.omit__names=<Enum>
1255 Current: 2
1256 Choices: (0, 1, 2)
1257 Instruct the completer to omit private method names
1258 Specifically, when completing on ``object.<tab>``.
1259 When 2 [default]: all names that start with '_' will be excluded.
1260 When 1: all 'magic' names (``__foo__``) will be excluded.
1261 When 0: nothing will be excluded.
1262 IPCompleter.merge_completions=<CBool>
1263 Current: True
1264 Whether to merge completion results into a single list
1265 If False, only the completion results from the first non-empty completer
1266 will be returned.
1267 IPCompleter.limit_to__all__=<CBool>
1268 Current: False
1269 Instruct the completer to use __all__ for the completion
1270 Specifically, when completing on ``object.<tab>``.
1271 When True: only those names in obj.__all__ will be included.
1272 When False [default]: the __all__ attribute is ignored
1273 IPCompleter.greedy=<CBool>
1274 Current: False
1275 Activate greedy completion
1276 This will enable completion on elements of lists, results of function calls,
1277 etc., but can be unsafe because the code is actually evaluated on TAB.
1314
1278
1315 par = parameter_s.strip().lower()
1279 but the real use is in setting values::
1316
1280
1317 if par:
1281 In [3]: %config IPCompleter.greedy = True
1318 try:
1319 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1320 except KeyError:
1321 print ('Incorrect argument. Use on/1, off/0, '
1322 'or nothing for a toggle.')
1323 return
1324 else:
1325 # toggle
1326 new_pdb = not self.shell.call_pdb
1327
1282
1328 # set on the shell
1283 and these values are read from the user_ns if they are variables::
1329 self.shell.call_pdb = new_pdb
1330 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1331
1284
1332 def magic_debug(self, parameter_s=''):
1285 In [4]: feeling_greedy=False
1333 """Activate the interactive debugger in post-mortem mode.
1334
1286
1335 If an exception has just occurred, this lets you inspect its stack
1287 In [5]: %config IPCompleter.greedy = feeling_greedy
1336 frames interactively. Note that this will always work only on the last
1337 traceback that occurred, so you must call this quickly after an
1338 exception that you wish to inspect has fired, because if another one
1339 occurs, it clobbers the previous one.
1340
1288
1341 If you want IPython to automatically do this on every exception, see
1342 the %pdb magic for more details.
1343 """
1289 """
1344 self.shell.debugger(force=True)
1290 from IPython.config.loader import Config
1291 # some IPython objects are Configurable, but do not yet have
1292 # any configurable traits. Exclude them from the effects of
1293 # this magic, as their presence is just noise:
1294 configurables = [ c for c in self.shell.configurables
1295 if c.__class__.class_traits(config=True) ]
1296 classnames = [ c.__class__.__name__ for c in configurables ]
1345
1297
1346 @skip_doctest
1298 line = s.strip()
1347 def magic_prun(self, parameter_s ='',user_mode=1,
1299 if not line:
1348 opts=None,arg_lst=None,prog_ns=None):
1300 # print available configurable names
1301 print "Available objects for config:"
1302 for name in classnames:
1303 print " ", name
1304 return
1305 elif line in classnames:
1306 # `%config TerminalInteractiveShell` will print trait info for
1307 # TerminalInteractiveShell
1308 c = configurables[classnames.index(line)]
1309 cls = c.__class__
1310 help = cls.class_get_help(c)
1311 # strip leading '--' from cl-args:
1312 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1313 print help
1314 return
1315 elif '=' not in line:
1316 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
1349
1317
1350 """Run a statement through the python code profiler.
1351
1318
1352 Usage:
1319 # otherwise, assume we are setting configurables.
1353 %prun [options] statement
1320 # leave quotes on args when splitting, because we want
1321 # unquoted args to eval in user_ns
1322 cfg = Config()
1323 exec "cfg."+line in locals(), self.shell.user_ns
1354
1324
1355 The given statement (which doesn't require quote marks) is run via the
1325 for configurable in configurables:
1356 python profiler in a manner similar to the profile.run() function.
1326 try:
1357 Namespaces are internally managed to work correctly; profile.run
1327 configurable.update_config(cfg)
1358 cannot be used in IPython because it makes certain assumptions about
1328 except Exception as e:
1359 namespaces which do not hold under IPython.
1329 error(e)
1360
1330
1361 Options:
1362
1331
1363 -l <limit>: you can place restrictions on what or how much of the
1332 class NamespaceMagics(MagicFunctions):
1364 profile gets printed. The limit value can be:
1333 """Magics to manage various aspects of the user's namespace.
1365
1334
1366 * A string: only information for function names containing this string
1335 These include listing variables, introspecting into them, etc.
1367 is printed.
1336 """
1368
1337
1369 * An integer: only these many lines are printed.
1338 def magic_pinfo(self, parameter_s='', namespaces=None):
1339 """Provide detailed information about an object.
1370
1340
1371 * A float (between 0 and 1): this fraction of the report is printed
1341 '%pinfo object' is just a synonym for object? or ?object."""
1372 (for example, use a limit of 0.4 to see the topmost 40% only).
1373
1342
1374 You can combine several limits with repeated use of the option. For
1343 #print 'pinfo par: <%s>' % parameter_s # dbg
1375 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1376 information about class constructors.
1377
1344
1378 -r: return the pstats.Stats object generated by the profiling. This
1379 object has all the information about the profile in it, and you can
1380 later use it for further analysis or in other functions.
1381
1345
1382 -s <key>: sort profile by given key. You can provide more than one key
1346 # detail_level: 0 -> obj? , 1 -> obj??
1383 by using the option several times: '-s key1 -s key2 -s key3...'. The
1347 detail_level = 0
1384 default sorting key is 'time'.
1348 # We need to detect if we got called as 'pinfo pinfo foo', which can
1349 # happen if the user types 'pinfo foo?' at the cmd line.
1350 pinfo,qmark1,oname,qmark2 = \
1351 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
1352 if pinfo or qmark1 or qmark2:
1353 detail_level = 1
1354 if "*" in oname:
1355 self.magic_psearch(oname)
1356 else:
1357 self.shell._inspect('pinfo', oname, detail_level=detail_level,
1358 namespaces=namespaces)
1385
1359
1386 The following is copied verbatim from the profile documentation
1360 def magic_pinfo2(self, parameter_s='', namespaces=None):
1387 referenced below:
1361 """Provide extra detailed information about an object.
1388
1362
1389 When more than one key is provided, additional keys are used as
1363 '%pinfo2 object' is just a synonym for object?? or ??object."""
1390 secondary criteria when the there is equality in all keys selected
1364 self.shell._inspect('pinfo', parameter_s, detail_level=1,
1391 before them.
1365 namespaces=namespaces)
1392
1366
1393 Abbreviations can be used for any key names, as long as the
1367 @skip_doctest
1394 abbreviation is unambiguous. The following are the keys currently
1368 def magic_pdef(self, parameter_s='', namespaces=None):
1395 defined:
1369 """Print the definition header for any callable object.
1396
1370
1397 Valid Arg Meaning
1371 If the object is a class, print the constructor information.
1398 "calls" call count
1399 "cumulative" cumulative time
1400 "file" file name
1401 "module" file name
1402 "pcalls" primitive call count
1403 "line" line number
1404 "name" function name
1405 "nfl" name/file/line
1406 "stdname" standard name
1407 "time" internal time
1408
1372
1409 Note that all sorts on statistics are in descending order (placing
1373 Examples
1410 most time consuming items first), where as name, file, and line number
1374 --------
1411 searches are in ascending order (i.e., alphabetical). The subtle
1375 ::
1412 distinction between "nfl" and "stdname" is that the standard name is a
1413 sort of the name as printed, which means that the embedded line
1414 numbers get compared in an odd way. For example, lines 3, 20, and 40
1415 would (if the file names were the same) appear in the string order
1416 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1417 line numbers. In fact, sort_stats("nfl") is the same as
1418 sort_stats("name", "file", "line").
1419
1376
1420 -T <filename>: save profile results as shown on screen to a text
1377 In [3]: %pdef urllib.urlopen
1421 file. The profile is still shown on screen.
1378 urllib.urlopen(url, data=None, proxies=None)
1379 """
1380 self._inspect('pdef',parameter_s, namespaces)
1422
1381
1423 -D <filename>: save (via dump_stats) profile statistics to given
1382 def magic_pdoc(self, parameter_s='', namespaces=None):
1424 filename. This data is in a format understood by the pstats module, and
1383 """Print the docstring for an object.
1425 is generated by a call to the dump_stats() method of profile
1426 objects. The profile is still shown on screen.
1427
1384
1428 -q: suppress output to the pager. Best used with -T and/or -D above.
1385 If the given object is a class, it will print both the class and the
1386 constructor docstrings."""
1387 self._inspect('pdoc',parameter_s, namespaces)
1429
1388
1430 If you want to run complete programs under the profiler's control, use
1389 def magic_psource(self, parameter_s='', namespaces=None):
1431 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1390 """Print (or run through pager) the source code for an object."""
1432 contains profiler specific options as described here.
1391 self._inspect('psource',parameter_s, namespaces)
1433
1392
1434 You can read the complete documentation for the profile module with::
1393 def magic_pfile(self, parameter_s=''):
1394 """Print (or run through pager) the file where an object is defined.
1435
1395
1436 In [1]: import profile; profile.help()
1396 The file opens at the line where the object definition begins. IPython
1437 """
1397 will honor the environment variable PAGER if set, and otherwise will
1398 do its best to print the file in a convenient form.
1438
1399
1439 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1400 If the given argument is not an object currently defined, IPython will
1401 try to interpret it as a filename (automatically adding a .py extension
1402 if needed). You can thus use %pfile as a syntax highlighting code
1403 viewer."""
1440
1404
1441 if user_mode: # regular user call
1405 # first interpret argument as an object name
1442 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
1406 out = self._inspect('pfile',parameter_s)
1443 list_all=1, posix=False)
1407 # if not, try the input as a filename
1444 namespace = self.shell.user_ns
1408 if out == 'not found':
1445 else: # called to run a program by %run -p
1446 try:
1447 filename = get_py_filename(arg_lst[0])
1448 except IOError as e:
1449 try:
1409 try:
1450 msg = str(e)
1410 filename = get_py_filename(parameter_s)
1451 except UnicodeError:
1411 except IOError,msg:
1452 msg = e.message
1412 print msg
1453 error(msg)
1454 return
1413 return
1414 page.page(self.shell.inspector.format(open(filename).read()))
1455
1415
1456 arg_str = 'execfile(filename,prog_ns)'
1416 def magic_psearch(self, parameter_s=''):
1457 namespace = {
1417 """Search for object in namespaces by wildcard.
1458 'execfile': self.shell.safe_execfile,
1459 'prog_ns': prog_ns,
1460 'filename': filename
1461 }
1462
1418
1463 opts.merge(opts_def)
1419 %psearch [options] PATTERN [OBJECT TYPE]
1464
1420
1465 prof = profile.Profile()
1421 Note: ? can be used as a synonym for %psearch, at the beginning or at
1466 try:
1422 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
1467 prof = prof.runctx(arg_str,namespace,namespace)
1423 rest of the command line must be unchanged (options come first), so
1468 sys_exit = ''
1424 for example the following forms are equivalent
1469 except SystemExit:
1470 sys_exit = """*** SystemExit exception caught in code being profiled."""
1471
1425
1472 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1426 %psearch -i a* function
1427 -i a* function?
1428 ?-i a* function
1473
1429
1474 lims = opts.l
1430 Arguments:
1475 if lims:
1476 lims = [] # rebuild lims with ints/floats/strings
1477 for lim in opts.l:
1478 try:
1479 lims.append(int(lim))
1480 except ValueError:
1481 try:
1482 lims.append(float(lim))
1483 except ValueError:
1484 lims.append(lim)
1485
1431
1486 # Trap output.
1432 PATTERN
1487 stdout_trap = StringIO()
1488
1433
1489 if hasattr(stats,'stream'):
1434 where PATTERN is a string containing * as a wildcard similar to its
1490 # In newer versions of python, the stats object has a 'stream'
1435 use in a shell. The pattern is matched in all namespaces on the
1491 # attribute to write into.
1436 search path. By default objects starting with a single _ are not
1492 stats.stream = stdout_trap
1437 matched, many IPython generated objects have a single
1493 stats.print_stats(*lims)
1438 underscore. The default is case insensitive matching. Matching is
1494 else:
1439 also done on the attributes of objects and not only on the objects
1495 # For older versions, we manually redirect stdout during printing
1440 in a module.
1496 sys_stdout = sys.stdout
1497 try:
1498 sys.stdout = stdout_trap
1499 stats.print_stats(*lims)
1500 finally:
1501 sys.stdout = sys_stdout
1502
1441
1503 output = stdout_trap.getvalue()
1442 [OBJECT TYPE]
1504 output = output.rstrip()
1505
1443
1506 if 'q' not in opts:
1444 Is the name of a python type from the types module. The name is
1507 page.page(output)
1445 given in lowercase without the ending type, ex. StringType is
1508 print sys_exit,
1446 written string. By adding a type here only objects matching the
1447 given type are matched. Using all here makes the pattern match all
1448 types (this is the default).
1509
1449
1510 dump_file = opts.D[0]
1450 Options:
1511 text_file = opts.T[0]
1512 if dump_file:
1513 dump_file = unquote_filename(dump_file)
1514 prof.dump_stats(dump_file)
1515 print '\n*** Profile stats marshalled to file',\
1516 `dump_file`+'.',sys_exit
1517 if text_file:
1518 text_file = unquote_filename(text_file)
1519 pfile = open(text_file,'w')
1520 pfile.write(output)
1521 pfile.close()
1522 print '\n*** Profile printout saved to text file',\
1523 `text_file`+'.',sys_exit
1524
1451
1525 if opts.has_key('r'):
1452 -a: makes the pattern match even objects whose names start with a
1526 return stats
1453 single underscore. These names are normally omitted from the
1527 else:
1454 search.
1528 return None
1529
1455
1530 @skip_doctest
1456 -i/-c: make the pattern case insensitive/sensitive. If neither of
1531 def magic_run(self, parameter_s ='', runner=None,
1457 these options are given, the default is read from your configuration
1532 file_finder=get_py_filename):
1458 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
1533 """Run the named file inside IPython as a program.
1459 If this option is not specified in your configuration file, IPython's
1460 internal default is to do a case sensitive search.
1534
1461
1535 Usage:\\
1462 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
1536 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1463 specify can be searched in any of the following namespaces:
1464 'builtin', 'user', 'user_global','internal', 'alias', where
1465 'builtin' and 'user' are the search defaults. Note that you should
1466 not use quotes when specifying namespaces.
1537
1467
1538 Parameters after the filename are passed as command-line arguments to
1468 'Builtin' contains the python module builtin, 'user' contains all
1539 the program (put in sys.argv). Then, control returns to IPython's
1469 user data, 'alias' only contain the shell aliases and no python
1540 prompt.
1470 objects, 'internal' contains objects used by IPython. The
1471 'user_global' namespace is only used by embedded IPython instances,
1472 and it contains module-level globals. You can add namespaces to the
1473 search with -s or exclude them with -e (these options can be given
1474 more than once).
1541
1475
1542 This is similar to running at a system prompt:\\
1476 Examples
1543 $ python file args\\
1477 --------
1544 but with the advantage of giving you IPython's tracebacks, and of
1478 ::
1545 loading all variables into your interactive namespace for further use
1546 (unless -p is used, see below).
1547
1479
1548 The file is executed in a namespace initially consisting only of
1480 %psearch a* -> objects beginning with an a
1549 __name__=='__main__' and sys.argv constructed as indicated. It thus
1481 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
1550 sees its environment as if it were being run as a stand-alone program
1482 %psearch a* function -> all functions beginning with an a
1551 (except for sharing global objects such as previously imported
1483 %psearch re.e* -> objects beginning with an e in module re
1552 modules). But after execution, the IPython interactive namespace gets
1484 %psearch r*.e* -> objects that start with e in modules starting in r
1553 updated with all variables defined in the program (except for __name__
1485 %psearch r*.* string -> all strings in modules beginning with r
1554 and sys.argv). This allows for very convenient loading of code for
1555 interactive work, while giving each program a 'clean sheet' to run in.
1556
1486
1557 Options:
1487 Case sensitive search::
1558
1488
1559 -n: __name__ is NOT set to '__main__', but to the running file's name
1489 %psearch -c a* list all object beginning with lower case a
1560 without extension (as python does under import). This allows running
1561 scripts and reloading the definitions in them without calling code
1562 protected by an ' if __name__ == "__main__" ' clause.
1563
1490
1564 -i: run the file in IPython's namespace instead of an empty one. This
1491 Show objects beginning with a single _::
1565 is useful if you are experimenting with code written in a text editor
1566 which depends on variables defined interactively.
1567
1492
1568 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1493 %psearch -a _* list objects beginning with a single underscore"""
1569 being run. This is particularly useful if IPython is being used to
1494 try:
1570 run unittests, which always exit with a sys.exit() call. In such
1495 parameter_s.encode('ascii')
1571 cases you are interested in the output of the test results, not in
1496 except UnicodeEncodeError:
1572 seeing a traceback of the unittest module.
1497 print 'Python identifiers can only contain ascii characters.'
1498 return
1573
1499
1574 -t: print timing information at the end of the run. IPython will give
1500 # default namespaces to be searched
1575 you an estimated CPU time consumption for your script, which under
1501 def_search = ['user_local', 'user_global', 'builtin']
1576 Unix uses the resource module to avoid the wraparound problems of
1577 time.clock(). Under Unix, an estimate of time spent on system tasks
1578 is also given (for Windows platforms this is reported as 0.0).
1579
1502
1580 If -t is given, an additional -N<N> option can be given, where <N>
1503 # Process options/args
1581 must be an integer indicating how many times you want the script to
1504 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
1582 run. The final timing report will include total and per run results.
1505 opt = opts.get
1506 shell = self.shell
1507 psearch = shell.inspector.psearch
1583
1508
1584 For example (testing the script uniq_stable.py)::
1509 # select case options
1510 if opts.has_key('i'):
1511 ignore_case = True
1512 elif opts.has_key('c'):
1513 ignore_case = False
1514 else:
1515 ignore_case = not shell.wildcards_case_sensitive
1585
1516
1586 In [1]: run -t uniq_stable
1517 # Build list of namespaces to search from user options
1518 def_search.extend(opt('s',[]))
1519 ns_exclude = ns_exclude=opt('e',[])
1520 ns_search = [nm for nm in def_search if nm not in ns_exclude]
1587
1521
1588 IPython CPU timings (estimated):\\
1522 # Call the actual search
1589 User : 0.19597 s.\\
1523 try:
1590 System: 0.0 s.\\
1524 psearch(args,shell.ns_table,ns_search,
1525 show_all=opt('a'),ignore_case=ignore_case)
1526 except:
1527 shell.showtraceback()
1591
1528
1592 In [2]: run -t -N5 uniq_stable
1529 @skip_doctest
1530 def magic_who_ls(self, parameter_s=''):
1531 """Return a sorted list of all interactive variables.
1593
1532
1594 IPython CPU timings (estimated):\\
1533 If arguments are given, only variables of types matching these
1595 Total runs performed: 5\\
1534 arguments are returned.
1596 Times : Total Per run\\
1597 User : 0.910862 s, 0.1821724 s.\\
1598 System: 0.0 s, 0.0 s.
1599
1535
1600 -d: run your program under the control of pdb, the Python debugger.
1536 Examples
1601 This allows you to execute your program step by step, watch variables,
1537 --------
1602 etc. Internally, what IPython does is similar to calling:
1603
1538
1604 pdb.run('execfile("YOURFILENAME")')
1539 Define two variables and list them with who_ls::
1605
1540
1606 with a breakpoint set on line 1 of your file. You can change the line
1541 In [1]: alpha = 123
1607 number for this automatic breakpoint to be <N> by using the -bN option
1608 (where N must be an integer). For example::
1609
1542
1610 %run -d -b40 myscript
1543 In [2]: beta = 'test'
1611
1544
1612 will set the first breakpoint at line 40 in myscript.py. Note that
1545 In [3]: %who_ls
1613 the first breakpoint must be set on a line which actually does
1546 Out[3]: ['alpha', 'beta']
1614 something (not a comment or docstring) for it to stop execution.
1615
1547
1616 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1548 In [4]: %who_ls int
1617 first enter 'c' (without quotes) to start execution up to the first
1549 Out[4]: ['alpha']
1618 breakpoint.
1619
1550
1620 Entering 'help' gives information about the use of the debugger. You
1551 In [5]: %who_ls str
1621 can easily see pdb's full documentation with "import pdb;pdb.help()"
1552 Out[5]: ['beta']
1622 at a prompt.
1553 """
1623
1554
1624 -p: run program under the control of the Python profiler module (which
1555 user_ns = self.shell.user_ns
1625 prints a detailed report of execution times, function calls, etc).
1556 user_ns_hidden = self.shell.user_ns_hidden
1557 out = [ i for i in user_ns
1558 if not i.startswith('_') \
1559 and not i in user_ns_hidden ]
1626
1560
1627 You can pass other options after -p which affect the behavior of the
1561 typelist = parameter_s.split()
1628 profiler itself. See the docs for %prun for details.
1562 if typelist:
1563 typeset = set(typelist)
1564 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
1629
1565
1630 In this mode, the program's variables do NOT propagate back to the
1566 out.sort()
1631 IPython interactive namespace (because they remain in the namespace
1567 return out
1632 where the profiler executes them).
1633
1568
1634 Internally this triggers a call to %prun, see its documentation for
1569 @skip_doctest
1635 details on the options available specifically for profiling.
1570 def magic_who(self, parameter_s=''):
1571 """Print all interactive variables, with some minimal formatting.
1636
1572
1637 There is one special usage for which the text above doesn't apply:
1573 If any arguments are given, only variables whose type matches one of
1638 if the filename ends with .ipy, the file is run as ipython script,
1574 these are printed. For example::
1639 just as if the commands were written on IPython prompt.
1640
1575
1641 -m: specify module name to load instead of script path. Similar to
1576 %who function str
1642 the -m option for the python interpreter. Use this option last if you
1643 want to combine with other %run options. Unlike the python interpreter
1644 only source modules are allowed no .pyc or .pyo files.
1645 For example::
1646
1577
1647 %run -m example
1578 will only list functions and strings, excluding all other types of
1579 variables. To find the proper type names, simply use type(var) at a
1580 command line to see how python prints type names. For example:
1648
1581
1649 will run the example module.
1582 ::
1650
1583
1651 """
1584 In [1]: type('hello')\\
1585 Out[1]: <type 'str'>
1652
1586
1653 # get arguments and set sys.argv for program to be run.
1587 indicates that the type name for strings is 'str'.
1654 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1655 mode='list', list_all=1)
1656 if "m" in opts:
1657 modulename = opts["m"][0]
1658 modpath = find_mod(modulename)
1659 if modpath is None:
1660 warn('%r is not a valid modulename on sys.path'%modulename)
1661 return
1662 arg_lst = [modpath] + arg_lst
1663 try:
1664 filename = file_finder(arg_lst[0])
1665 except IndexError:
1666 warn('you must provide at least a filename.')
1667 print '\n%run:\n', oinspect.getdoc(self.magic_run)
1668 return
1669 except IOError as e:
1670 try:
1671 msg = str(e)
1672 except UnicodeError:
1673 msg = e.message
1674 error(msg)
1675 return
1676
1588
1677 if filename.lower().endswith('.ipy'):
1589 ``%who`` always excludes executed names loaded through your configuration
1678 self.shell.safe_execfile_ipy(filename)
1590 file and things which are internal to IPython.
1679 return
1680
1591
1681 # Control the response to exit() calls made by the script being run
1592 This is deliberate, as typically you may load many modules and the
1682 exit_ignore = 'e' in opts
1593 purpose of %who is to show you only what you've manually defined.
1683
1594
1684 # Make sure that the running script gets a proper sys.argv as if it
1595 Examples
1685 # were run from a system shell.
1596 --------
1686 save_argv = sys.argv # save it for later restoring
1687
1597
1688 # simulate shell expansion on arguments, at least tilde expansion
1598 Define two variables and list them with who::
1689 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1690
1599
1691 sys.argv = [filename] + args # put in the proper filename
1600 In [1]: alpha = 123
1692 # protect sys.argv from potential unicode strings on Python 2:
1693 if not py3compat.PY3:
1694 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1695
1601
1696 if 'i' in opts:
1602 In [2]: beta = 'test'
1697 # Run in user's interactive namespace
1698 prog_ns = self.shell.user_ns
1699 __name__save = self.shell.user_ns['__name__']
1700 prog_ns['__name__'] = '__main__'
1701 main_mod = self.shell.new_main_mod(prog_ns)
1702 else:
1703 # Run in a fresh, empty namespace
1704 if 'n' in opts:
1705 name = os.path.splitext(os.path.basename(filename))[0]
1706 else:
1707 name = '__main__'
1708
1603
1709 main_mod = self.shell.new_main_mod()
1604 In [3]: %who
1710 prog_ns = main_mod.__dict__
1605 alpha beta
1711 prog_ns['__name__'] = name
1712
1606
1713 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1607 In [4]: %who int
1714 # set the __file__ global in the script's namespace
1608 alpha
1715 prog_ns['__file__'] = filename
1716
1609
1717 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1610 In [5]: %who str
1718 # that, if we overwrite __main__, we replace it at the end
1611 beta
1719 main_mod_name = prog_ns['__name__']
1612 """
1720
1613
1721 if main_mod_name == '__main__':
1614 varlist = self.magic_who_ls(parameter_s)
1722 restore_main = sys.modules['__main__']
1615 if not varlist:
1616 if parameter_s:
1617 print 'No variables match your requested type.'
1723 else:
1618 else:
1724 restore_main = False
1619 print 'Interactive namespace is empty.'
1620 return
1725
1621
1726 # This needs to be undone at the end to prevent holding references to
1622 # if we have variables, move on...
1727 # every single object ever created.
1623 count = 0
1728 sys.modules[main_mod_name] = main_mod
1624 for i in varlist:
1625 print i+'\t',
1626 count += 1
1627 if count > 8:
1628 count = 0
1629 print
1630 print
1729
1631
1730 try:
1632 @skip_doctest
1731 stats = None
1633 def magic_whos(self, parameter_s=''):
1732 with self.shell.readline_no_record:
1634 """Like %who, but gives some extra information about each variable.
1733 if 'p' in opts:
1635
1734 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
1636 The same type filtering of %who can be applied here.
1735 else:
1637
1736 if 'd' in opts:
1638 For all variables, the type is printed. Additionally it prints:
1737 deb = debugger.Pdb(self.shell.colors)
1639
1738 # reset Breakpoint state, which is moronically kept
1640 - For {},[],(): their length.
1739 # in a class
1641
1740 bdb.Breakpoint.next = 1
1642 - For numpy arrays, a summary with shape, number of
1741 bdb.Breakpoint.bplist = {}
1643 elements, typecode and size in memory.
1742 bdb.Breakpoint.bpbynumber = [None]
1644
1743 # Set an initial breakpoint to stop execution
1645 - Everything else: a string representation, snipping their middle if
1744 maxtries = 10
1646 too long.
1745 bp = int(opts.get('b', [1])[0])
1647
1746 checkline = deb.checkline(filename, bp)
1648 Examples
1747 if not checkline:
1649 --------
1748 for bp in range(bp + 1, bp + maxtries + 1):
1650
1749 if deb.checkline(filename, bp):
1651 Define two variables and list them with whos::
1750 break
1652
1653 In [1]: alpha = 123
1654
1655 In [2]: beta = 'test'
1656
1657 In [3]: %whos
1658 Variable Type Data/Info
1659 --------------------------------
1660 alpha int 123
1661 beta str test
1662 """
1663
1664 varnames = self.magic_who_ls(parameter_s)
1665 if not varnames:
1666 if parameter_s:
1667 print 'No variables match your requested type.'
1751 else:
1668 else:
1752 msg = ("\nI failed to find a valid line to set "
1669 print 'Interactive namespace is empty.'
1753 "a breakpoint\n"
1754 "after trying up to line: %s.\n"
1755 "Please set a valid breakpoint manually "
1756 "with the -b option." % bp)
1757 error(msg)
1758 return
1670 return
1759 # if we find a good linenumber, set the breakpoint
1760 deb.do_break('%s:%s' % (filename, bp))
1761 # Start file run
1762 print "NOTE: Enter 'c' at the",
1763 print "%s prompt to start your script." % deb.prompt
1764 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1765 try:
1766 deb.run('execfile("%s", prog_ns)' % filename, ns)
1767
1671
1768 except:
1672 # if we have variables, move on...
1769 etype, value, tb = sys.exc_info()
1673
1770 # Skip three frames in the traceback: the %run one,
1674 # for these types, show len() instead of data:
1771 # one inside bdb.py, and the command-line typed by the
1675 seq_types = ['dict', 'list', 'tuple']
1772 # user (run by exec in pdb itself).
1676
1773 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1677 # for numpy arrays, display summary info
1774 else:
1678 ndarray_type = None
1775 if runner is None:
1679 if 'numpy' in sys.modules:
1776 runner = self.default_runner
1777 if runner is None:
1778 runner = self.shell.safe_execfile
1779 if 't' in opts:
1780 # timed execution
1781 try:
1680 try:
1782 nruns = int(opts['N'][0])
1681 from numpy import ndarray
1783 if nruns < 1:
1682 except ImportError:
1784 error('Number of runs must be >=1')
1683 pass
1785 return
1786 except (KeyError):
1787 nruns = 1
1788 twall0 = time.time()
1789 if nruns == 1:
1790 t0 = clock2()
1791 runner(filename, prog_ns, prog_ns,
1792 exit_ignore=exit_ignore)
1793 t1 = clock2()
1794 t_usr = t1[0] - t0[0]
1795 t_sys = t1[1] - t0[1]
1796 print "\nIPython CPU timings (estimated):"
1797 print " User : %10.2f s." % t_usr
1798 print " System : %10.2f s." % t_sys
1799 else:
1684 else:
1800 runs = range(nruns)
1685 ndarray_type = ndarray.__name__
1801 t0 = clock2()
1686
1802 for nr in runs:
1687 # Find all variable names and types so we can figure out column sizes
1803 runner(filename, prog_ns, prog_ns,
1688 def get_vars(i):
1804 exit_ignore=exit_ignore)
1689 return self.shell.user_ns[i]
1805 t1 = clock2()
1690
1806 t_usr = t1[0] - t0[0]
1691 # some types are well known and can be shorter
1807 t_sys = t1[1] - t0[1]
1692 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
1808 print "\nIPython CPU timings (estimated):"
1693 def type_name(v):
1809 print "Total runs performed:", nruns
1694 tn = type(v).__name__
1810 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1695 return abbrevs.get(tn,tn)
1811 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1696
1812 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1697 varlist = map(get_vars,varnames)
1813 twall1 = time.time()
1698
1814 print "Wall time: %10.2f s." % (twall1 - twall0)
1699 typelist = []
1700 for vv in varlist:
1701 tt = type_name(vv)
1815
1702
1703 if tt=='instance':
1704 typelist.append( abbrevs.get(str(vv.__class__),
1705 str(vv.__class__)))
1816 else:
1706 else:
1817 # regular execution
1707 typelist.append(tt)
1818 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1819
1708
1820 if 'i' in opts:
1709 # column labels and # of spaces as separator
1821 self.shell.user_ns['__name__'] = __name__save
1710 varlabel = 'Variable'
1711 typelabel = 'Type'
1712 datalabel = 'Data/Info'
1713 colsep = 3
1714 # variable format strings
1715 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
1716 aformat = "%s: %s elems, type `%s`, %s bytes"
1717 # find the size of the columns to format the output nicely
1718 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
1719 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
1720 # table header
1721 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
1722 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
1723 # and the table itself
1724 kb = 1024
1725 Mb = 1048576 # kb**2
1726 for vname,var,vtype in zip(varnames,varlist,typelist):
1727 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
1728 if vtype in seq_types:
1729 print "n="+str(len(var))
1730 elif vtype == ndarray_type:
1731 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
1732 if vtype==ndarray_type:
1733 # numpy
1734 vsize = var.size
1735 vbytes = vsize*var.itemsize
1736 vdtype = var.dtype
1737
1738 if vbytes < 100000:
1739 print aformat % (vshape,vsize,vdtype,vbytes)
1822 else:
1740 else:
1823 # The shell MUST hold a reference to prog_ns so after %run
1741 print aformat % (vshape,vsize,vdtype,vbytes),
1824 # exits, the python deletion mechanism doesn't zero it out
1742 if vbytes < Mb:
1825 # (leaving dangling references).
1743 print '(%s kb)' % (vbytes/kb,)
1826 self.shell.cache_main_mod(prog_ns, filename)
1744 else:
1827 # update IPython interactive namespace
1745 print '(%s Mb)' % (vbytes/Mb,)
1746 else:
1747 try:
1748 vstr = str(var)
1749 except UnicodeEncodeError:
1750 vstr = unicode(var).encode(DEFAULT_ENCODING,
1751 'backslashreplace')
1752 except:
1753 vstr = "<object with id %d (str() failed)>" % id(var)
1754 vstr = vstr.replace('\n','\\n')
1755 if len(vstr) < 50:
1756 print vstr
1757 else:
1758 print vstr[:25] + "<...>" + vstr[-25:]
1828
1759
1829 # Some forms of read errors on the file may mean the
1760 def magic_reset(self, parameter_s=''):
1830 # __name__ key was never set; using pop we don't have to
1761 """Resets the namespace by removing all names defined by the user, if
1831 # worry about a possible KeyError.
1762 called without arguments, or by removing some types of objects, such
1832 prog_ns.pop('__name__', None)
1763 as everything currently in IPython's In[] and Out[] containers (see
1764 the parameters for details).
1833
1765
1834 self.shell.user_ns.update(prog_ns)
1766 Parameters
1835 finally:
1767 ----------
1836 # It's a bit of a mystery why, but __builtins__ can change from
1768 -f : force reset without asking for confirmation.
1837 # being a module to becoming a dict missing some key data after
1838 # %run. As best I can see, this is NOT something IPython is doing
1839 # at all, and similar problems have been reported before:
1840 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1841 # Since this seems to be done by the interpreter itself, the best
1842 # we can do is to at least restore __builtins__ for the user on
1843 # exit.
1844 self.shell.user_ns['__builtins__'] = builtin_mod
1845
1769
1846 # Ensure key global structures are restored
1770 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
1847 sys.argv = save_argv
1771 References to objects may be kept. By default (without this option),
1848 if restore_main:
1772 we do a 'hard' reset, giving you a new session and removing all
1849 sys.modules['__main__'] = restore_main
1773 references to objects from the current session.
1850 else:
1851 # Remove from sys.modules the reference to main_mod we'd
1852 # added. Otherwise it will trap references to objects
1853 # contained therein.
1854 del sys.modules[main_mod_name]
1855
1774
1856 return stats
1775 in : reset input history
1857
1776
1858 @skip_doctest
1777 out : reset output history
1859 def magic_timeit(self, parameter_s =''):
1778
1860 """Time execution of a Python statement or expression
1779 dhist : reset directory history
1780
1781 array : reset only variables that are NumPy arrays
1782
1783 See Also
1784 --------
1785 magic_reset_selective : invoked as ``%reset_selective``
1786
1787 Examples
1788 --------
1789 ::
1790
1791 In [6]: a = 1
1792
1793 In [7]: a
1794 Out[7]: 1
1795
1796 In [8]: 'a' in _ip.user_ns
1797 Out[8]: True
1798
1799 In [9]: %reset -f
1800
1801 In [1]: 'a' in _ip.user_ns
1802 Out[1]: False
1803
1804 In [2]: %reset -f in
1805 Flushing input history
1806
1807 In [3]: %reset -f dhist in
1808 Flushing directory history
1809 Flushing input history
1810
1811 Notes
1812 -----
1813 Calling this magic from clients that do not implement standard input,
1814 such as the ipython notebook interface, will reset the namespace
1815 without confirmation.
1816 """
1817 opts, args = self.parse_options(parameter_s,'sf', mode='list')
1818 if 'f' in opts:
1819 ans = True
1820 else:
1821 try:
1822 ans = self.shell.ask_yes_no(
1823 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
1824 except StdinNotImplementedError:
1825 ans = True
1826 if not ans:
1827 print 'Nothing done.'
1828 return
1829
1830 if 's' in opts: # Soft reset
1831 user_ns = self.shell.user_ns
1832 for i in self.magic_who_ls():
1833 del(user_ns[i])
1834 elif len(args) == 0: # Hard reset
1835 self.shell.reset(new_session = False)
1836
1837 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1838 ip = self.shell
1839 user_ns = self.shell.user_ns # local lookup, heavily used
1840
1841 for target in args:
1842 target = target.lower() # make matches case insensitive
1843 if target == 'out':
1844 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1845 self.shell.displayhook.flush()
1846
1847 elif target == 'in':
1848 print "Flushing input history"
1849 pc = self.shell.displayhook.prompt_count + 1
1850 for n in range(1, pc):
1851 key = '_i'+repr(n)
1852 user_ns.pop(key,None)
1853 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1854 hm = ip.history_manager
1855 # don't delete these, as %save and %macro depending on the length
1856 # of these lists to be preserved
1857 hm.input_hist_parsed[:] = [''] * pc
1858 hm.input_hist_raw[:] = [''] * pc
1859 # hm has internal machinery for _i,_ii,_iii, clear it out
1860 hm._i = hm._ii = hm._iii = hm._i00 = u''
1861
1862 elif target == 'array':
1863 # Support cleaning up numpy arrays
1864 try:
1865 from numpy import ndarray
1866 # This must be done with items and not iteritems because we're
1867 # going to modify the dict in-place.
1868 for x,val in user_ns.items():
1869 if isinstance(val,ndarray):
1870 del user_ns[x]
1871 except ImportError:
1872 print "reset array only works if Numpy is available."
1873
1874 elif target == 'dhist':
1875 print "Flushing directory history"
1876 del user_ns['_dh'][:]
1877
1878 else:
1879 print "Don't know how to reset ",
1880 print target + ", please run `%reset?` for details"
1881
1882 gc.collect()
1883
1884 def magic_reset_selective(self, parameter_s=''):
1885 """Resets the namespace by removing names defined by the user.
1886
1887 Input/Output history are left around in case you need them.
1888
1889 %reset_selective [-f] regex
1890
1891 No action is taken if regex is not included
1892
1893 Options
1894 -f : force reset without asking for confirmation.
1895
1896 See Also
1897 --------
1898 magic_reset : invoked as ``%reset``
1899
1900 Examples
1901 --------
1902
1903 We first fully reset the namespace so your output looks identical to
1904 this example for pedagogical reasons; in practice you do not need a
1905 full reset::
1906
1907 In [1]: %reset -f
1908
1909 Now, with a clean namespace we can make a few variables and use
1910 ``%reset_selective`` to only delete names that match our regexp::
1911
1912 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1913
1914 In [3]: who_ls
1915 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1916
1917 In [4]: %reset_selective -f b[2-3]m
1918
1919 In [5]: who_ls
1920 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1921
1922 In [6]: %reset_selective -f d
1923
1924 In [7]: who_ls
1925 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1926
1927 In [8]: %reset_selective -f c
1928
1929 In [9]: who_ls
1930 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1931
1932 In [10]: %reset_selective -f b
1933
1934 In [11]: who_ls
1935 Out[11]: ['a']
1936
1937 Notes
1938 -----
1939 Calling this magic from clients that do not implement standard input,
1940 such as the ipython notebook interface, will reset the namespace
1941 without confirmation.
1942 """
1943
1944 opts, regex = self.parse_options(parameter_s,'f')
1945
1946 if opts.has_key('f'):
1947 ans = True
1948 else:
1949 try:
1950 ans = self.shell.ask_yes_no(
1951 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1952 default='n')
1953 except StdinNotImplementedError:
1954 ans = True
1955 if not ans:
1956 print 'Nothing done.'
1957 return
1958 user_ns = self.shell.user_ns
1959 if not regex:
1960 print 'No regex pattern specified. Nothing done.'
1961 return
1962 else:
1963 try:
1964 m = re.compile(regex)
1965 except TypeError:
1966 raise TypeError('regex must be a string or compiled pattern')
1967 for i in self.magic_who_ls():
1968 if m.search(i):
1969 del(user_ns[i])
1970
1971 def magic_xdel(self, parameter_s=''):
1972 """Delete a variable, trying to clear it from anywhere that
1973 IPython's machinery has references to it. By default, this uses
1974 the identity of the named object in the user namespace to remove
1975 references held under other names. The object is also removed
1976 from the output history.
1977
1978 Options
1979 -n : Delete the specified name from all namespaces, without
1980 checking their identity.
1981 """
1982 opts, varname = self.parse_options(parameter_s,'n')
1983 try:
1984 self.shell.del_var(varname, ('n' in opts))
1985 except (NameError, ValueError) as e:
1986 print type(e).__name__ +": "+ str(e)
1987
1988
1989 class ExecutionMagics(MagicFunctions):
1990 """Magics related to code execution, debugging, profiling, etc.
1991
1992 """
1993
1994 def __init__(self, shell):
1995 super(ProfileMagics, self).__init__(shell)
1996 if profile is None:
1997 self.magic_prun = self.profile_missing_notice
1998 # Default execution function used to actually run user code.
1999 self.default_runner = None
2000
2001 def profile_missing_notice(self, *args, **kwargs):
2002 error("""\
2003 The profile module could not be found. It has been removed from the standard
2004 python packages because of its non-free license. To use profiling, install the
2005 python-profiler package from non-free.""")
2006
2007 @skip_doctest
2008 def magic_prun(self, parameter_s ='',user_mode=1,
2009 opts=None,arg_lst=None,prog_ns=None):
2010
2011 """Run a statement through the python code profiler.
2012
2013 Usage:
2014 %prun [options] statement
2015
2016 The given statement (which doesn't require quote marks) is run via the
2017 python profiler in a manner similar to the profile.run() function.
2018 Namespaces are internally managed to work correctly; profile.run
2019 cannot be used in IPython because it makes certain assumptions about
2020 namespaces which do not hold under IPython.
2021
2022 Options:
2023
2024 -l <limit>: you can place restrictions on what or how much of the
2025 profile gets printed. The limit value can be:
2026
2027 * A string: only information for function names containing this string
2028 is printed.
2029
2030 * An integer: only these many lines are printed.
2031
2032 * A float (between 0 and 1): this fraction of the report is printed
2033 (for example, use a limit of 0.4 to see the topmost 40% only).
2034
2035 You can combine several limits with repeated use of the option. For
2036 example, '-l __init__ -l 5' will print only the topmost 5 lines of
2037 information about class constructors.
2038
2039 -r: return the pstats.Stats object generated by the profiling. This
2040 object has all the information about the profile in it, and you can
2041 later use it for further analysis or in other functions.
2042
2043 -s <key>: sort profile by given key. You can provide more than one key
2044 by using the option several times: '-s key1 -s key2 -s key3...'. The
2045 default sorting key is 'time'.
2046
2047 The following is copied verbatim from the profile documentation
2048 referenced below:
2049
2050 When more than one key is provided, additional keys are used as
2051 secondary criteria when the there is equality in all keys selected
2052 before them.
2053
2054 Abbreviations can be used for any key names, as long as the
2055 abbreviation is unambiguous. The following are the keys currently
2056 defined:
2057
2058 Valid Arg Meaning
2059 "calls" call count
2060 "cumulative" cumulative time
2061 "file" file name
2062 "module" file name
2063 "pcalls" primitive call count
2064 "line" line number
2065 "name" function name
2066 "nfl" name/file/line
2067 "stdname" standard name
2068 "time" internal time
2069
2070 Note that all sorts on statistics are in descending order (placing
2071 most time consuming items first), where as name, file, and line number
2072 searches are in ascending order (i.e., alphabetical). The subtle
2073 distinction between "nfl" and "stdname" is that the standard name is a
2074 sort of the name as printed, which means that the embedded line
2075 numbers get compared in an odd way. For example, lines 3, 20, and 40
2076 would (if the file names were the same) appear in the string order
2077 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
2078 line numbers. In fact, sort_stats("nfl") is the same as
2079 sort_stats("name", "file", "line").
2080
2081 -T <filename>: save profile results as shown on screen to a text
2082 file. The profile is still shown on screen.
2083
2084 -D <filename>: save (via dump_stats) profile statistics to given
2085 filename. This data is in a format understood by the pstats module, and
2086 is generated by a call to the dump_stats() method of profile
2087 objects. The profile is still shown on screen.
2088
2089 -q: suppress output to the pager. Best used with -T and/or -D above.
2090
2091 If you want to run complete programs under the profiler's control, use
2092 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
2093 contains profiler specific options as described here.
2094
2095 You can read the complete documentation for the profile module with::
2096
2097 In [1]: import profile; profile.help()
2098 """
2099
2100 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
2101
2102 if user_mode: # regular user call
2103 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
2104 list_all=1, posix=False)
2105 namespace = self.shell.user_ns
2106 else: # called to run a program by %run -p
2107 try:
2108 filename = get_py_filename(arg_lst[0])
2109 except IOError as e:
2110 try:
2111 msg = str(e)
2112 except UnicodeError:
2113 msg = e.message
2114 error(msg)
2115 return
2116
2117 arg_str = 'execfile(filename,prog_ns)'
2118 namespace = {
2119 'execfile': self.shell.safe_execfile,
2120 'prog_ns': prog_ns,
2121 'filename': filename
2122 }
2123
2124 opts.merge(opts_def)
2125
2126 prof = profile.Profile()
2127 try:
2128 prof = prof.runctx(arg_str,namespace,namespace)
2129 sys_exit = ''
2130 except SystemExit:
2131 sys_exit = """*** SystemExit exception caught in code being profiled."""
2132
2133 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
2134
2135 lims = opts.l
2136 if lims:
2137 lims = [] # rebuild lims with ints/floats/strings
2138 for lim in opts.l:
2139 try:
2140 lims.append(int(lim))
2141 except ValueError:
2142 try:
2143 lims.append(float(lim))
2144 except ValueError:
2145 lims.append(lim)
2146
2147 # Trap output.
2148 stdout_trap = StringIO()
2149
2150 if hasattr(stats,'stream'):
2151 # In newer versions of python, the stats object has a 'stream'
2152 # attribute to write into.
2153 stats.stream = stdout_trap
2154 stats.print_stats(*lims)
2155 else:
2156 # For older versions, we manually redirect stdout during printing
2157 sys_stdout = sys.stdout
2158 try:
2159 sys.stdout = stdout_trap
2160 stats.print_stats(*lims)
2161 finally:
2162 sys.stdout = sys_stdout
1861
2163
1862 Usage:\\
2164 output = stdout_trap.getvalue()
1863 %timeit [-n<N> -r<R> [-t|-c]] statement
2165 output = output.rstrip()
1864
2166
1865 Time execution of a Python statement or expression using the timeit
2167 if 'q' not in opts:
1866 module.
2168 page.page(output)
2169 print sys_exit,
1867
2170
1868 Options:
2171 dump_file = opts.D[0]
1869 -n<N>: execute the given statement <N> times in a loop. If this value
2172 text_file = opts.T[0]
1870 is not given, a fitting value is chosen.
2173 if dump_file:
2174 dump_file = unquote_filename(dump_file)
2175 prof.dump_stats(dump_file)
2176 print '\n*** Profile stats marshalled to file',\
2177 `dump_file`+'.',sys_exit
2178 if text_file:
2179 text_file = unquote_filename(text_file)
2180 pfile = open(text_file,'w')
2181 pfile.write(output)
2182 pfile.close()
2183 print '\n*** Profile printout saved to text file',\
2184 `text_file`+'.',sys_exit
1871
2185
1872 -r<R>: repeat the loop iteration <R> times and take the best result.
2186 if opts.has_key('r'):
1873 Default: 3
2187 return stats
2188 else:
2189 return None
1874
2190
1875 -t: use time.time to measure the time, which is the default on Unix.
2191 def magic_pdb(self, parameter_s=''):
1876 This function measures wall time.
2192 """Control the automatic calling of the pdb interactive debugger.
1877
2193
1878 -c: use time.clock to measure the time, which is the default on
2194 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1879 Windows and measures wall time. On Unix, resource.getrusage is used
2195 argument it works as a toggle.
1880 instead and returns the CPU user time.
1881
2196
1882 -p<P>: use a precision of <P> digits to display the timing result.
2197 When an exception is triggered, IPython can optionally call the
1883 Default: 3
2198 interactive pdb debugger after the traceback printout. %pdb toggles
2199 this feature on and off.
1884
2200
2201 The initial state of this feature is set in your configuration
2202 file (the option is ``InteractiveShell.pdb``).
1885
2203
1886 Examples
2204 If you want to just activate the debugger AFTER an exception has fired,
1887 --------
2205 without having to type '%pdb on' and rerunning your code, you can use
1888 ::
2206 the %debug magic."""
1889
2207
1890 In [1]: %timeit pass
2208 par = parameter_s.strip().lower()
1891 10000000 loops, best of 3: 53.3 ns per loop
1892
2209
1893 In [2]: u = None
2210 if par:
2211 try:
2212 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
2213 except KeyError:
2214 print ('Incorrect argument. Use on/1, off/0, '
2215 'or nothing for a toggle.')
2216 return
2217 else:
2218 # toggle
2219 new_pdb = not self.shell.call_pdb
1894
2220
1895 In [3]: %timeit u is None
2221 # set on the shell
1896 10000000 loops, best of 3: 184 ns per loop
2222 self.shell.call_pdb = new_pdb
2223 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1897
2224
1898 In [4]: %timeit -r 4 u == None
2225 def magic_debug(self, parameter_s=''):
1899 1000000 loops, best of 4: 242 ns per loop
2226 """Activate the interactive debugger in post-mortem mode.
1900
2227
1901 In [5]: import time
2228 If an exception has just occurred, this lets you inspect its stack
2229 frames interactively. Note that this will always work only on the last
2230 traceback that occurred, so you must call this quickly after an
2231 exception that you wish to inspect has fired, because if another one
2232 occurs, it clobbers the previous one.
1902
2233
1903 In [6]: %timeit -n1 time.sleep(2)
2234 If you want IPython to automatically do this on every exception, see
1904 1 loops, best of 3: 2 s per loop
2235 the %pdb magic for more details.
2236 """
2237 self.shell.debugger(force=True)
1905
2238
2239 def magic_tb(self, s):
2240 """Print the last traceback with the currently active exception mode.
1906
2241
1907 The times reported by %timeit will be slightly higher than those
2242 See %xmode for changing exception reporting modes."""
1908 reported by the timeit.py script when variables are accessed. This is
2243 self.shell.showtraceback()
1909 due to the fact that %timeit executes the statement in the namespace
1910 of the shell, compared with timeit.py, which uses a single setup
1911 statement to import function or create variables. Generally, the bias
1912 does not matter as long as results from timeit.py are not mixed with
1913 those from %timeit."""
1914
2244
1915 import timeit
2245 @skip_doctest
1916 import math
2246 def magic_run(self, parameter_s ='', runner=None,
2247 file_finder=get_py_filename):
2248 """Run the named file inside IPython as a program.
1917
2249
1918 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
2250 Usage:\\
1919 # certain terminals. Until we figure out a robust way of
2251 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1920 # auto-detecting if the terminal can deal with it, use plain 'us' for
1921 # microseconds. I am really NOT happy about disabling the proper
1922 # 'micro' prefix, but crashing is worse... If anyone knows what the
1923 # right solution for this is, I'm all ears...
1924 #
1925 # Note: using
1926 #
1927 # s = u'\xb5'
1928 # s.encode(sys.getdefaultencoding())
1929 #
1930 # is not sufficient, as I've seen terminals where that fails but
1931 # print s
1932 #
1933 # succeeds
1934 #
1935 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1936
2252
1937 #units = [u"s", u"ms",u'\xb5',"ns"]
2253 Parameters after the filename are passed as command-line arguments to
1938 units = [u"s", u"ms",u'us',"ns"]
2254 the program (put in sys.argv). Then, control returns to IPython's
2255 prompt.
1939
2256
1940 scaling = [1, 1e3, 1e6, 1e9]
2257 This is similar to running at a system prompt:\\
2258 $ python file args\\
2259 but with the advantage of giving you IPython's tracebacks, and of
2260 loading all variables into your interactive namespace for further use
2261 (unless -p is used, see below).
1941
2262
1942 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
2263 The file is executed in a namespace initially consisting only of
1943 posix=False, strict=False)
2264 __name__=='__main__' and sys.argv constructed as indicated. It thus
1944 if stmt == "":
2265 sees its environment as if it were being run as a stand-alone program
1945 return
2266 (except for sharing global objects such as previously imported
1946 timefunc = timeit.default_timer
2267 modules). But after execution, the IPython interactive namespace gets
1947 number = int(getattr(opts, "n", 0))
2268 updated with all variables defined in the program (except for __name__
1948 repeat = int(getattr(opts, "r", timeit.default_repeat))
2269 and sys.argv). This allows for very convenient loading of code for
1949 precision = int(getattr(opts, "p", 3))
2270 interactive work, while giving each program a 'clean sheet' to run in.
1950 if hasattr(opts, "t"):
1951 timefunc = time.time
1952 if hasattr(opts, "c"):
1953 timefunc = clock
1954
2271
1955 timer = timeit.Timer(timer=timefunc)
2272 Options:
1956 # this code has tight coupling to the inner workings of timeit.Timer,
1957 # but is there a better way to achieve that the code stmt has access
1958 # to the shell namespace?
1959
2273
1960 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
2274 -n: __name__ is NOT set to '__main__', but to the running file's name
1961 'setup': "pass"}
2275 without extension (as python does under import). This allows running
1962 # Track compilation time so it can be reported if too long
2276 scripts and reloading the definitions in them without calling code
1963 # Minimum time above which compilation time will be reported
2277 protected by an ' if __name__ == "__main__" ' clause.
1964 tc_min = 0.1
1965
2278
1966 t0 = clock()
2279 -i: run the file in IPython's namespace instead of an empty one. This
1967 code = compile(src, "<magic-timeit>", "exec")
2280 is useful if you are experimenting with code written in a text editor
1968 tc = clock()-t0
2281 which depends on variables defined interactively.
1969
2282
1970 ns = {}
2283 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1971 exec code in self.shell.user_ns, ns
2284 being run. This is particularly useful if IPython is being used to
1972 timer.inner = ns["inner"]
2285 run unittests, which always exit with a sys.exit() call. In such
2286 cases you are interested in the output of the test results, not in
2287 seeing a traceback of the unittest module.
1973
2288
1974 if number == 0:
2289 -t: print timing information at the end of the run. IPython will give
1975 # determine number so that 0.2 <= total time < 2.0
2290 you an estimated CPU time consumption for your script, which under
1976 number = 1
2291 Unix uses the resource module to avoid the wraparound problems of
1977 for i in range(1, 10):
2292 time.clock(). Under Unix, an estimate of time spent on system tasks
1978 if timer.timeit(number) >= 0.2:
2293 is also given (for Windows platforms this is reported as 0.0).
1979 break
1980 number *= 10
1981
2294
1982 best = min(timer.repeat(repeat, number)) / number
2295 If -t is given, an additional -N<N> option can be given, where <N>
2296 must be an integer indicating how many times you want the script to
2297 run. The final timing report will include total and per run results.
1983
2298
1984 if best > 0.0 and best < 1000.0:
2299 For example (testing the script uniq_stable.py)::
1985 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1986 elif best >= 1000.0:
1987 order = 0
1988 else:
1989 order = 3
1990 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1991 precision,
1992 best * scaling[order],
1993 units[order])
1994 if tc > tc_min:
1995 print "Compiler time: %.2f s" % tc
1996
2300
1997 @skip_doctest
2301 In [1]: run -t uniq_stable
1998 @needs_local_scope
1999 def magic_time(self,parameter_s, user_locals):
2000 """Time execution of a Python statement or expression.
2001
2302
2002 The CPU and wall clock times are printed, and the value of the
2303 IPython CPU timings (estimated):\\
2003 expression (if any) is returned. Note that under Win32, system time
2304 User : 0.19597 s.\\
2004 is always reported as 0, since it can not be measured.
2305 System: 0.0 s.\\
2005
2306
2006 This function provides very basic timing functionality. In Python
2307 In [2]: run -t -N5 uniq_stable
2007 2.3, the timeit module offers more control and sophistication, so this
2008 could be rewritten to use it (patches welcome).
2009
2308
2010 Examples
2309 IPython CPU timings (estimated):\\
2011 --------
2310 Total runs performed: 5\\
2012 ::
2311 Times : Total Per run\\
2312 User : 0.910862 s, 0.1821724 s.\\
2313 System: 0.0 s, 0.0 s.
2013
2314
2014 In [1]: time 2**128
2315 -d: run your program under the control of pdb, the Python debugger.
2015 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2316 This allows you to execute your program step by step, watch variables,
2016 Wall time: 0.00
2317 etc. Internally, what IPython does is similar to calling:
2017 Out[1]: 340282366920938463463374607431768211456L
2018
2318
2019 In [2]: n = 1000000
2319 pdb.run('execfile("YOURFILENAME")')
2020
2320
2021 In [3]: time sum(range(n))
2321 with a breakpoint set on line 1 of your file. You can change the line
2022 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2322 number for this automatic breakpoint to be <N> by using the -bN option
2023 Wall time: 1.37
2323 (where N must be an integer). For example::
2024 Out[3]: 499999500000L
2025
2324
2026 In [4]: time print 'hello world'
2325 %run -d -b40 myscript
2027 hello world
2028 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2029 Wall time: 0.00
2030
2326
2031 Note that the time needed by Python to compile the given expression
2327 will set the first breakpoint at line 40 in myscript.py. Note that
2032 will be reported if it is more than 0.1s. In this example, the
2328 the first breakpoint must be set on a line which actually does
2033 actual exponentiation is done by Python at compilation time, so while
2329 something (not a comment or docstring) for it to stop execution.
2034 the expression can take a noticeable amount of time to compute, that
2035 time is purely due to the compilation:
2036
2330
2037 In [5]: time 3**9999;
2331 When the pdb debugger starts, you will see a (Pdb) prompt. You must
2038 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2332 first enter 'c' (without quotes) to start execution up to the first
2039 Wall time: 0.00 s
2333 breakpoint.
2040
2334
2041 In [6]: time 3**999999;
2335 Entering 'help' gives information about the use of the debugger. You
2042 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2336 can easily see pdb's full documentation with "import pdb;pdb.help()"
2043 Wall time: 0.00 s
2337 at a prompt.
2044 Compiler : 0.78 s
2045 """
2046
2338
2047 # fail immediately if the given expression can't be compiled
2339 -p: run program under the control of the Python profiler module (which
2340 prints a detailed report of execution times, function calls, etc).
2048
2341
2049 expr = self.shell.prefilter(parameter_s,False)
2342 You can pass other options after -p which affect the behavior of the
2343 profiler itself. See the docs for %prun for details.
2050
2344
2051 # Minimum time above which compilation time will be reported
2345 In this mode, the program's variables do NOT propagate back to the
2052 tc_min = 0.1
2346 IPython interactive namespace (because they remain in the namespace
2347 where the profiler executes them).
2053
2348
2054 try:
2349 Internally this triggers a call to %prun, see its documentation for
2055 mode = 'eval'
2350 details on the options available specifically for profiling.
2056 t0 = clock()
2057 code = compile(expr,'<timed eval>',mode)
2058 tc = clock()-t0
2059 except SyntaxError:
2060 mode = 'exec'
2061 t0 = clock()
2062 code = compile(expr,'<timed exec>',mode)
2063 tc = clock()-t0
2064 # skew measurement as little as possible
2065 glob = self.shell.user_ns
2066 wtime = time.time
2067 # time execution
2068 wall_st = wtime()
2069 if mode=='eval':
2070 st = clock2()
2071 out = eval(code, glob, user_locals)
2072 end = clock2()
2073 else:
2074 st = clock2()
2075 exec code in glob, user_locals
2076 end = clock2()
2077 out = None
2078 wall_end = wtime()
2079 # Compute actual times and report
2080 wall_time = wall_end-wall_st
2081 cpu_user = end[0]-st[0]
2082 cpu_sys = end[1]-st[1]
2083 cpu_tot = cpu_user+cpu_sys
2084 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2085 (cpu_user,cpu_sys,cpu_tot)
2086 print "Wall time: %.2f s" % wall_time
2087 if tc > tc_min:
2088 print "Compiler : %.2f s" % tc
2089 return out
2090
2351
2091 @skip_doctest
2352 There is one special usage for which the text above doesn't apply:
2092 def magic_macro(self,parameter_s = ''):
2353 if the filename ends with .ipy, the file is run as ipython script,
2093 """Define a macro for future re-execution. It accepts ranges of history,
2354 just as if the commands were written on IPython prompt.
2094 filenames or string objects.
2095
2355
2096 Usage:\\
2356 -m: specify module name to load instead of script path. Similar to
2097 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2357 the -m option for the python interpreter. Use this option last if you
2358 want to combine with other %run options. Unlike the python interpreter
2359 only source modules are allowed no .pyc or .pyo files.
2360 For example::
2098
2361
2099 Options:
2362 %run -m example
2100
2363
2101 -r: use 'raw' input. By default, the 'processed' history is used,
2364 will run the example module.
2102 so that magics are loaded in their transformed version to valid
2103 Python. If this option is given, the raw input as typed as the
2104 command line is used instead.
2105
2365
2106 This will define a global variable called `name` which is a string
2366 """
2107 made of joining the slices and lines you specify (n1,n2,... numbers
2108 above) from your input history into a single string. This variable
2109 acts like an automatic function which re-executes those lines as if
2110 you had typed them. You just type 'name' at the prompt and the code
2111 executes.
2112
2367
2113 The syntax for indicating input ranges is described in %history.
2368 # get arguments and set sys.argv for program to be run.
2369 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
2370 mode='list', list_all=1)
2371 if "m" in opts:
2372 modulename = opts["m"][0]
2373 modpath = find_mod(modulename)
2374 if modpath is None:
2375 warn('%r is not a valid modulename on sys.path'%modulename)
2376 return
2377 arg_lst = [modpath] + arg_lst
2378 try:
2379 filename = file_finder(arg_lst[0])
2380 except IndexError:
2381 warn('you must provide at least a filename.')
2382 print '\n%run:\n', oinspect.getdoc(self.magic_run)
2383 return
2384 except IOError as e:
2385 try:
2386 msg = str(e)
2387 except UnicodeError:
2388 msg = e.message
2389 error(msg)
2390 return
2114
2391
2115 Note: as a 'hidden' feature, you can also use traditional python slice
2392 if filename.lower().endswith('.ipy'):
2116 notation, where N:M means numbers N through M-1.
2393 self.shell.safe_execfile_ipy(filename)
2394 return
2117
2395
2118 For example, if your history contains (%hist prints it)::
2396 # Control the response to exit() calls made by the script being run
2397 exit_ignore = 'e' in opts
2119
2398
2120 44: x=1
2399 # Make sure that the running script gets a proper sys.argv as if it
2121 45: y=3
2400 # were run from a system shell.
2122 46: z=x+y
2401 save_argv = sys.argv # save it for later restoring
2123 47: print x
2124 48: a=5
2125 49: print 'x',x,'y',y
2126
2402
2127 you can create a macro with lines 44 through 47 (included) and line 49
2403 # simulate shell expansion on arguments, at least tilde expansion
2128 called my_macro with::
2404 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
2129
2405
2130 In [55]: %macro my_macro 44-47 49
2406 sys.argv = [filename] + args # put in the proper filename
2407 # protect sys.argv from potential unicode strings on Python 2:
2408 if not py3compat.PY3:
2409 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
2131
2410
2132 Now, typing `my_macro` (without quotes) will re-execute all this code
2411 if 'i' in opts:
2133 in one pass.
2412 # Run in user's interactive namespace
2413 prog_ns = self.shell.user_ns
2414 __name__save = self.shell.user_ns['__name__']
2415 prog_ns['__name__'] = '__main__'
2416 main_mod = self.shell.new_main_mod(prog_ns)
2417 else:
2418 # Run in a fresh, empty namespace
2419 if 'n' in opts:
2420 name = os.path.splitext(os.path.basename(filename))[0]
2421 else:
2422 name = '__main__'
2134
2423
2135 You don't need to give the line-numbers in order, and any given line
2424 main_mod = self.shell.new_main_mod()
2136 number can appear multiple times. You can assemble macros with any
2425 prog_ns = main_mod.__dict__
2137 lines from your input history in any order.
2426 prog_ns['__name__'] = name
2138
2427
2139 The macro is a simple object which holds its value in an attribute,
2428 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
2140 but IPython's display system checks for macros and executes them as
2429 # set the __file__ global in the script's namespace
2141 code instead of printing them when you type their name.
2430 prog_ns['__file__'] = filename
2142
2431
2143 You can view a macro's contents by explicitly printing it with::
2432 # pickle fix. See interactiveshell for an explanation. But we need to make sure
2433 # that, if we overwrite __main__, we replace it at the end
2434 main_mod_name = prog_ns['__name__']
2144
2435
2145 print macro_name
2436 if main_mod_name == '__main__':
2437 restore_main = sys.modules['__main__']
2438 else:
2439 restore_main = False
2146
2440
2147 """
2441 # This needs to be undone at the end to prevent holding references to
2148 opts,args = self.parse_options(parameter_s,'r',mode='list')
2442 # every single object ever created.
2149 if not args: # List existing macros
2443 sys.modules[main_mod_name] = main_mod
2150 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2151 isinstance(v, Macro))
2152 if len(args) == 1:
2153 raise UsageError(
2154 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2155 name, codefrom = args[0], " ".join(args[1:])
2156
2444
2157 #print 'rng',ranges # dbg
2158 try:
2445 try:
2159 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2446 stats = None
2160 except (ValueError, TypeError) as e:
2447 with self.shell.readline_no_record:
2161 print e.args[0]
2448 if 'p' in opts:
2449 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
2450 else:
2451 if 'd' in opts:
2452 deb = debugger.Pdb(self.shell.colors)
2453 # reset Breakpoint state, which is moronically kept
2454 # in a class
2455 bdb.Breakpoint.next = 1
2456 bdb.Breakpoint.bplist = {}
2457 bdb.Breakpoint.bpbynumber = [None]
2458 # Set an initial breakpoint to stop execution
2459 maxtries = 10
2460 bp = int(opts.get('b', [1])[0])
2461 checkline = deb.checkline(filename, bp)
2462 if not checkline:
2463 for bp in range(bp + 1, bp + maxtries + 1):
2464 if deb.checkline(filename, bp):
2465 break
2466 else:
2467 msg = ("\nI failed to find a valid line to set "
2468 "a breakpoint\n"
2469 "after trying up to line: %s.\n"
2470 "Please set a valid breakpoint manually "
2471 "with the -b option." % bp)
2472 error(msg)
2473 return
2474 # if we find a good linenumber, set the breakpoint
2475 deb.do_break('%s:%s' % (filename, bp))
2476 # Start file run
2477 print "NOTE: Enter 'c' at the",
2478 print "%s prompt to start your script." % deb.prompt
2479 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
2480 try:
2481 deb.run('execfile("%s", prog_ns)' % filename, ns)
2482
2483 except:
2484 etype, value, tb = sys.exc_info()
2485 # Skip three frames in the traceback: the %run one,
2486 # one inside bdb.py, and the command-line typed by the
2487 # user (run by exec in pdb itself).
2488 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
2489 else:
2490 if runner is None:
2491 runner = self.default_runner
2492 if runner is None:
2493 runner = self.shell.safe_execfile
2494 if 't' in opts:
2495 # timed execution
2496 try:
2497 nruns = int(opts['N'][0])
2498 if nruns < 1:
2499 error('Number of runs must be >=1')
2162 return
2500 return
2163 macro = Macro(lines)
2501 except (KeyError):
2164 self.shell.define_macro(name, macro)
2502 nruns = 1
2165 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2503 twall0 = time.time()
2166 print '=== Macro contents: ==='
2504 if nruns == 1:
2167 print macro,
2505 t0 = clock2()
2168
2506 runner(filename, prog_ns, prog_ns,
2169 def magic_save(self,parameter_s = ''):
2507 exit_ignore=exit_ignore)
2170 """Save a set of lines or a macro to a given filename.
2508 t1 = clock2()
2509 t_usr = t1[0] - t0[0]
2510 t_sys = t1[1] - t0[1]
2511 print "\nIPython CPU timings (estimated):"
2512 print " User : %10.2f s." % t_usr
2513 print " System : %10.2f s." % t_sys
2514 else:
2515 runs = range(nruns)
2516 t0 = clock2()
2517 for nr in runs:
2518 runner(filename, prog_ns, prog_ns,
2519 exit_ignore=exit_ignore)
2520 t1 = clock2()
2521 t_usr = t1[0] - t0[0]
2522 t_sys = t1[1] - t0[1]
2523 print "\nIPython CPU timings (estimated):"
2524 print "Total runs performed:", nruns
2525 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
2526 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
2527 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
2528 twall1 = time.time()
2529 print "Wall time: %10.2f s." % (twall1 - twall0)
2171
2530
2172 Usage:\\
2531 else:
2173 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2532 # regular execution
2533 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
2174
2534
2175 Options:
2535 if 'i' in opts:
2536 self.shell.user_ns['__name__'] = __name__save
2537 else:
2538 # The shell MUST hold a reference to prog_ns so after %run
2539 # exits, the python deletion mechanism doesn't zero it out
2540 # (leaving dangling references).
2541 self.shell.cache_main_mod(prog_ns, filename)
2542 # update IPython interactive namespace
2176
2543
2177 -r: use 'raw' input. By default, the 'processed' history is used,
2544 # Some forms of read errors on the file may mean the
2178 so that magics are loaded in their transformed version to valid
2545 # __name__ key was never set; using pop we don't have to
2179 Python. If this option is given, the raw input as typed as the
2546 # worry about a possible KeyError.
2180 command line is used instead.
2547 prog_ns.pop('__name__', None)
2181
2548
2182 This function uses the same syntax as %history for input ranges,
2549 self.shell.user_ns.update(prog_ns)
2183 then saves the lines to the filename you specify.
2550 finally:
2551 # It's a bit of a mystery why, but __builtins__ can change from
2552 # being a module to becoming a dict missing some key data after
2553 # %run. As best I can see, this is NOT something IPython is doing
2554 # at all, and similar problems have been reported before:
2555 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
2556 # Since this seems to be done by the interpreter itself, the best
2557 # we can do is to at least restore __builtins__ for the user on
2558 # exit.
2559 self.shell.user_ns['__builtins__'] = builtin_mod
2184
2560
2185 It adds a '.py' extension to the file if you don't do so yourself, and
2561 # Ensure key global structures are restored
2186 it asks for confirmation before overwriting existing files."""
2562 sys.argv = save_argv
2563 if restore_main:
2564 sys.modules['__main__'] = restore_main
2565 else:
2566 # Remove from sys.modules the reference to main_mod we'd
2567 # added. Otherwise it will trap references to objects
2568 # contained therein.
2569 del sys.modules[main_mod_name]
2187
2570
2188 opts,args = self.parse_options(parameter_s,'r',mode='list')
2571 return stats
2189 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
2190 if not fname.endswith('.py'):
2191 fname += '.py'
2192 if os.path.isfile(fname):
2193 overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n')
2194 if not overwrite :
2195 print 'Operation cancelled.'
2196 return
2197 try:
2198 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2199 except (TypeError, ValueError) as e:
2200 print e.args[0]
2201 return
2202 with io.open(fname,'w', encoding="utf-8") as f:
2203 f.write(u"# coding: utf-8\n")
2204 f.write(py3compat.cast_unicode(cmds))
2205 print 'The following commands were written to file `%s`:' % fname
2206 print cmds
2207
2572
2208 def magic_pastebin(self, parameter_s = ''):
2573 @skip_doctest
2209 """Upload code to Github's Gist paste bin, returning the URL.
2574 def magic_timeit(self, parameter_s =''):
2575 """Time execution of a Python statement or expression
2210
2576
2211 Usage:\\
2577 Usage:\\
2212 %pastebin [-d "Custom description"] 1-7
2578 %timeit [-n<N> -r<R> [-t|-c]] statement
2213
2579
2214 The argument can be an input history range, a filename, or the name of a
2580 Time execution of a Python statement or expression using the timeit
2215 string or macro.
2581 module.
2216
2582
2217 Options:
2583 Options:
2584 -n<N>: execute the given statement <N> times in a loop. If this value
2585 is not given, a fitting value is chosen.
2218
2586
2219 -d: Pass a custom description for the gist. The default will say
2587 -r<R>: repeat the loop iteration <R> times and take the best result.
2220 "Pasted from IPython".
2588 Default: 3
2221 """
2222 opts, args = self.parse_options(parameter_s, 'd:')
2223
2224 try:
2225 code = self.shell.find_user_code(args)
2226 except (ValueError, TypeError) as e:
2227 print e.args[0]
2228 return
2229
2230 post_data = json.dumps({
2231 "description": opts.get('d', "Pasted from IPython"),
2232 "public": True,
2233 "files": {
2234 "file1.py": {
2235 "content": code
2236 }
2237 }
2238 }).encode('utf-8')
2239
2240 response = urlopen("https://api.github.com/gists", post_data)
2241 response_data = json.loads(response.read().decode('utf-8'))
2242 return response_data['html_url']
2243
2244 def magic_loadpy(self, arg_s):
2245 """Alias of `%load`
2246
2589
2247 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
2590 -t: use time.time to measure the time, which is the default on Unix.
2248 extension. So it has been renamed simply into %load. You can look at
2591 This function measures wall time.
2249 `%load`'s docstring for more info.
2250 """
2251 self.magic_load(arg_s)
2252
2592
2253 def magic_load(self, arg_s):
2593 -c: use time.clock to measure the time, which is the default on
2254 """Load code into the current frontend.
2594 Windows and measures wall time. On Unix, resource.getrusage is used
2595 instead and returns the CPU user time.
2255
2596
2256 Usage:\\
2597 -p<P>: use a precision of <P> digits to display the timing result.
2257 %load [options] source
2598 Default: 3
2258
2599
2259 where source can be a filename, URL, input history range or macro
2260
2600
2261 Options:
2601 Examples
2262 --------
2602 --------
2263 -y : Don't ask confirmation for loading source above 200 000 characters.
2603 ::
2264
2265 This magic command can either take a local filename, a URL, an history
2266 range (see %history) or a macro as argument, it will prompt for
2267 confirmation before loading source with more than 200 000 characters, unless
2268 -y flag is passed or if the frontend does not support raw_input::
2269
2270 %load myscript.py
2271 %load 7-27
2272 %load myMacro
2273 %load http://www.example.com/myscript.py
2274 """
2275 opts,args = self.parse_options(arg_s,'y')
2276
2277 contents = self.shell.find_user_code(args)
2278 l = len(contents)
2279
2280 # 200 000 is ~ 2500 full 80 caracter lines
2281 # so in average, more than 5000 lines
2282 if l > 200000 and 'y' not in opts:
2283 try:
2284 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
2285 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
2286 except StdinNotImplementedError:
2287 #asume yes if raw input not implemented
2288 ans = True
2289
2290 if ans is False :
2291 print 'Operation cancelled.'
2292 return
2293
2604
2294 self.set_next_input(contents)
2605 In [1]: %timeit pass
2606 10000000 loops, best of 3: 53.3 ns per loop
2295
2607
2296 def _find_edit_target(self, args, opts, last_call):
2608 In [2]: u = None
2297 """Utility method used by magic_edit to find what to edit."""
2298
2609
2299 def make_filename(arg):
2610 In [3]: %timeit u is None
2300 "Make a filename from the given args"
2611 10000000 loops, best of 3: 184 ns per loop
2301 arg = unquote_filename(arg)
2302 try:
2303 filename = get_py_filename(arg)
2304 except IOError:
2305 # If it ends with .py but doesn't already exist, assume we want
2306 # a new file.
2307 if arg.endswith('.py'):
2308 filename = arg
2309 else:
2310 filename = None
2311 return filename
2312
2612
2313 # Set a few locals from the options for convenience:
2613 In [4]: %timeit -r 4 u == None
2314 opts_prev = 'p' in opts
2614 1000000 loops, best of 4: 242 ns per loop
2315 opts_raw = 'r' in opts
2316
2615
2317 # custom exceptions
2616 In [5]: import time
2318 class DataIsObject(Exception): pass
2319
2617
2320 # Default line number value
2618 In [6]: %timeit -n1 time.sleep(2)
2321 lineno = opts.get('n',None)
2619 1 loops, best of 3: 2 s per loop
2322
2620
2323 if opts_prev:
2324 args = '_%s' % last_call[0]
2325 if not self.shell.user_ns.has_key(args):
2326 args = last_call[1]
2327
2621
2328 # use last_call to remember the state of the previous call, but don't
2622 The times reported by %timeit will be slightly higher than those
2329 # let it be clobbered by successive '-p' calls.
2623 reported by the timeit.py script when variables are accessed. This is
2330 try:
2624 due to the fact that %timeit executes the statement in the namespace
2331 last_call[0] = self.shell.displayhook.prompt_count
2625 of the shell, compared with timeit.py, which uses a single setup
2332 if not opts_prev:
2626 statement to import function or create variables. Generally, the bias
2333 last_call[1] = args
2627 does not matter as long as results from timeit.py are not mixed with
2334 except:
2628 those from %timeit."""
2335 pass
2336
2629
2337 # by default this is done with temp files, except when the given
2630 import timeit
2338 # arg is a filename
2631 import math
2339 use_temp = True
2340
2632
2341 data = ''
2633 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
2634 # certain terminals. Until we figure out a robust way of
2635 # auto-detecting if the terminal can deal with it, use plain 'us' for
2636 # microseconds. I am really NOT happy about disabling the proper
2637 # 'micro' prefix, but crashing is worse... If anyone knows what the
2638 # right solution for this is, I'm all ears...
2639 #
2640 # Note: using
2641 #
2642 # s = u'\xb5'
2643 # s.encode(sys.getdefaultencoding())
2644 #
2645 # is not sufficient, as I've seen terminals where that fails but
2646 # print s
2647 #
2648 # succeeds
2649 #
2650 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
2342
2651
2343 # First, see if the arguments should be a filename.
2652 #units = [u"s", u"ms",u'\xb5',"ns"]
2344 filename = make_filename(args)
2653 units = [u"s", u"ms",u'us',"ns"]
2345 if filename:
2346 use_temp = False
2347 elif args:
2348 # Mode where user specifies ranges of lines, like in %macro.
2349 data = self.shell.extract_input_lines(args, opts_raw)
2350 if not data:
2351 try:
2352 # Load the parameter given as a variable. If not a string,
2353 # process it as an object instead (below)
2354
2654
2355 #print '*** args',args,'type',type(args) # dbg
2655 scaling = [1, 1e3, 1e6, 1e9]
2356 data = eval(args, self.shell.user_ns)
2357 if not isinstance(data, basestring):
2358 raise DataIsObject
2359
2656
2360 except (NameError,SyntaxError):
2657 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
2361 # given argument is not a variable, try as a filename
2658 posix=False, strict=False)
2362 filename = make_filename(args)
2659 if stmt == "":
2363 if filename is None:
2364 warn("Argument given (%s) can't be found as a variable "
2365 "or as a filename." % args)
2366 return
2660 return
2367 use_temp = False
2661 timefunc = timeit.default_timer
2368
2662 number = int(getattr(opts, "n", 0))
2369 except DataIsObject:
2663 repeat = int(getattr(opts, "r", timeit.default_repeat))
2370 # macros have a special edit function
2664 precision = int(getattr(opts, "p", 3))
2371 if isinstance(data, Macro):
2665 if hasattr(opts, "t"):
2372 raise MacroToEdit(data)
2666 timefunc = time.time
2667 if hasattr(opts, "c"):
2668 timefunc = clock
2373
2669
2374 # For objects, try to edit the file where they are defined
2670 timer = timeit.Timer(timer=timefunc)
2375 try:
2671 # this code has tight coupling to the inner workings of timeit.Timer,
2376 filename = inspect.getabsfile(data)
2672 # but is there a better way to achieve that the code stmt has access
2377 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2673 # to the shell namespace?
2378 # class created by %edit? Try to find source
2379 # by looking for method definitions instead, the
2380 # __module__ in those classes is FakeModule.
2381 attrs = [getattr(data, aname) for aname in dir(data)]
2382 for attr in attrs:
2383 if not inspect.ismethod(attr):
2384 continue
2385 filename = inspect.getabsfile(attr)
2386 if filename and 'fakemodule' not in filename.lower():
2387 # change the attribute to be the edit target instead
2388 data = attr
2389 break
2390
2674
2391 datafile = 1
2675 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
2392 except TypeError:
2676 'setup': "pass"}
2393 filename = make_filename(args)
2677 # Track compilation time so it can be reported if too long
2394 datafile = 1
2678 # Minimum time above which compilation time will be reported
2395 warn('Could not find file where `%s` is defined.\n'
2679 tc_min = 0.1
2396 'Opening a file named `%s`' % (args,filename))
2397 # Now, make sure we can actually read the source (if it was in
2398 # a temp file it's gone by now).
2399 if datafile:
2400 try:
2401 if lineno is None:
2402 lineno = inspect.getsourcelines(data)[1]
2403 except IOError:
2404 filename = make_filename(args)
2405 if filename is None:
2406 warn('The file `%s` where `%s` was defined cannot '
2407 'be read.' % (filename,data))
2408 return
2409 use_temp = False
2410
2680
2411 if use_temp:
2681 t0 = clock()
2412 filename = self.shell.mktempfile(data)
2682 code = compile(src, "<magic-timeit>", "exec")
2413 print 'IPython will make a temporary file named:',filename
2683 tc = clock()-t0
2414
2684
2415 return filename, lineno, use_temp
2685 ns = {}
2686 exec code in self.shell.user_ns, ns
2687 timer.inner = ns["inner"]
2416
2688
2417 def _edit_macro(self,mname,macro):
2689 if number == 0:
2418 """open an editor with the macro data in a file"""
2690 # determine number so that 0.2 <= total time < 2.0
2419 filename = self.shell.mktempfile(macro.value)
2691 number = 1
2420 self.shell.hooks.editor(filename)
2692 for i in range(1, 10):
2693 if timer.timeit(number) >= 0.2:
2694 break
2695 number *= 10
2421
2696
2422 # and make a new macro object, to replace the old one
2697 best = min(timer.repeat(repeat, number)) / number
2423 mfile = open(filename)
2424 mvalue = mfile.read()
2425 mfile.close()
2426 self.shell.user_ns[mname] = Macro(mvalue)
2427
2698
2428 def magic_ed(self,parameter_s=''):
2699 if best > 0.0 and best < 1000.0:
2429 """Alias to %edit."""
2700 order = min(-int(math.floor(math.log10(best)) // 3), 3)
2430 return self.magic_edit(parameter_s)
2701 elif best >= 1000.0:
2702 order = 0
2703 else:
2704 order = 3
2705 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
2706 precision,
2707 best * scaling[order],
2708 units[order])
2709 if tc > tc_min:
2710 print "Compiler time: %.2f s" % tc
2431
2711
2432 @skip_doctest
2712 @skip_doctest
2433 def magic_edit(self,parameter_s='',last_call=['','']):
2713 @needs_local_scope
2434 """Bring up an editor and execute the resulting code.
2714 def magic_time(self,parameter_s, user_locals):
2435
2715 """Time execution of a Python statement or expression.
2436 Usage:
2437 %edit [options] [args]
2438
2439 %edit runs IPython's editor hook. The default version of this hook is
2440 set to call the editor specified by your $EDITOR environment variable.
2441 If this isn't found, it will default to vi under Linux/Unix and to
2442 notepad under Windows. See the end of this docstring for how to change
2443 the editor hook.
2444
2445 You can also set the value of this editor via the
2446 ``TerminalInteractiveShell.editor`` option in your configuration file.
2447 This is useful if you wish to use a different editor from your typical
2448 default with IPython (and for Windows users who typically don't set
2449 environment variables).
2450
2716
2451 This command allows you to conveniently edit multi-line code right in
2717 The CPU and wall clock times are printed, and the value of the
2452 your IPython session.
2718 expression (if any) is returned. Note that under Win32, system time
2719 is always reported as 0, since it can not be measured.
2453
2720
2454 If called without arguments, %edit opens up an empty editor with a
2721 This function provides very basic timing functionality. In Python
2455 temporary file and will execute the contents of this file when you
2722 2.3, the timeit module offers more control and sophistication, so this
2456 close it (don't forget to save it!).
2723 could be rewritten to use it (patches welcome).
2457
2724
2725 Examples
2726 --------
2727 ::
2458
2728
2459 Options:
2729 In [1]: time 2**128
2730 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2731 Wall time: 0.00
2732 Out[1]: 340282366920938463463374607431768211456L
2460
2733
2461 -n <number>: open the editor at a specified line number. By default,
2734 In [2]: n = 1000000
2462 the IPython editor hook uses the unix syntax 'editor +N filename', but
2463 you can configure this by providing your own modified hook if your
2464 favorite editor supports line-number specifications with a different
2465 syntax.
2466
2735
2467 -p: this will call the editor with the same data as the previous time
2736 In [3]: time sum(range(n))
2468 it was used, regardless of how long ago (in your current session) it
2737 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2469 was.
2738 Wall time: 1.37
2739 Out[3]: 499999500000L
2470
2740
2471 -r: use 'raw' input. This option only applies to input taken from the
2741 In [4]: time print 'hello world'
2472 user's history. By default, the 'processed' history is used, so that
2742 hello world
2473 magics are loaded in their transformed version to valid Python. If
2743 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2474 this option is given, the raw input as typed as the command line is
2744 Wall time: 0.00
2475 used instead. When you exit the editor, it will be executed by
2476 IPython's own processor.
2477
2745
2478 -x: do not execute the edited code immediately upon exit. This is
2746 Note that the time needed by Python to compile the given expression
2479 mainly useful if you are editing programs which need to be called with
2747 will be reported if it is more than 0.1s. In this example, the
2480 command line arguments, which you can then do using %run.
2748 actual exponentiation is done by Python at compilation time, so while
2749 the expression can take a noticeable amount of time to compute, that
2750 time is purely due to the compilation:
2481
2751
2752 In [5]: time 3**9999;
2753 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2754 Wall time: 0.00 s
2482
2755
2483 Arguments:
2756 In [6]: time 3**999999;
2757 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2758 Wall time: 0.00 s
2759 Compiler : 0.78 s
2760 """
2484
2761
2485 If arguments are given, the following possibilities exist:
2762 # fail immediately if the given expression can't be compiled
2486
2763
2487 - If the argument is a filename, IPython will load that into the
2764 expr = self.shell.prefilter(parameter_s,False)
2488 editor. It will execute its contents with execfile() when you exit,
2489 loading any code in the file into your interactive namespace.
2490
2765
2491 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2766 # Minimum time above which compilation time will be reported
2492 The syntax is the same as in the %history magic.
2767 tc_min = 0.1
2493
2768
2494 - If the argument is a string variable, its contents are loaded
2769 try:
2495 into the editor. You can thus edit any string which contains
2770 mode = 'eval'
2496 python code (including the result of previous edits).
2771 t0 = clock()
2772 code = compile(expr,'<timed eval>',mode)
2773 tc = clock()-t0
2774 except SyntaxError:
2775 mode = 'exec'
2776 t0 = clock()
2777 code = compile(expr,'<timed exec>',mode)
2778 tc = clock()-t0
2779 # skew measurement as little as possible
2780 glob = self.shell.user_ns
2781 wtime = time.time
2782 # time execution
2783 wall_st = wtime()
2784 if mode=='eval':
2785 st = clock2()
2786 out = eval(code, glob, user_locals)
2787 end = clock2()
2788 else:
2789 st = clock2()
2790 exec code in glob, user_locals
2791 end = clock2()
2792 out = None
2793 wall_end = wtime()
2794 # Compute actual times and report
2795 wall_time = wall_end-wall_st
2796 cpu_user = end[0]-st[0]
2797 cpu_sys = end[1]-st[1]
2798 cpu_tot = cpu_user+cpu_sys
2799 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2800 (cpu_user,cpu_sys,cpu_tot)
2801 print "Wall time: %.2f s" % wall_time
2802 if tc > tc_min:
2803 print "Compiler : %.2f s" % tc
2804 return out
2497
2805
2498 - If the argument is the name of an object (other than a string),
2806 @skip_doctest
2499 IPython will try to locate the file where it was defined and open the
2807 def magic_macro(self,parameter_s = ''):
2500 editor at the point where it is defined. You can use `%edit function`
2808 """Define a macro for future re-execution. It accepts ranges of history,
2501 to load an editor exactly at the point where 'function' is defined,
2809 filenames or string objects.
2502 edit it and have the file be executed automatically.
2503
2810
2504 - If the object is a macro (see %macro for details), this opens up your
2811 Usage:\\
2505 specified editor with a temporary file containing the macro's data.
2812 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2506 Upon exit, the macro is reloaded with the contents of the file.
2507
2813
2508 Note: opening at an exact line is only supported under Unix, and some
2814 Options:
2509 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2510 '+NUMBER' parameter necessary for this feature. Good editors like
2511 (X)Emacs, vi, jed, pico and joe all do.
2512
2815
2513 After executing your code, %edit will return as output the code you
2816 -r: use 'raw' input. By default, the 'processed' history is used,
2514 typed in the editor (except when it was an existing file). This way
2817 so that magics are loaded in their transformed version to valid
2515 you can reload the code in further invocations of %edit as a variable,
2818 Python. If this option is given, the raw input as typed as the
2516 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2819 command line is used instead.
2517 the output.
2518
2820
2519 Note that %edit is also available through the alias %ed.
2821 This will define a global variable called `name` which is a string
2822 made of joining the slices and lines you specify (n1,n2,... numbers
2823 above) from your input history into a single string. This variable
2824 acts like an automatic function which re-executes those lines as if
2825 you had typed them. You just type 'name' at the prompt and the code
2826 executes.
2520
2827
2521 This is an example of creating a simple function inside the editor and
2828 The syntax for indicating input ranges is described in %history.
2522 then modifying it. First, start up the editor::
2523
2829
2524 In [1]: ed
2830 Note: as a 'hidden' feature, you can also use traditional python slice
2525 Editing... done. Executing edited code...
2831 notation, where N:M means numbers N through M-1.
2526 Out[1]: 'def foo():\\n print "foo() was defined in an editing
2527 session"\\n'
2528
2832
2529 We can then call the function foo()::
2833 For example, if your history contains (%hist prints it)::
2530
2834
2531 In [2]: foo()
2835 44: x=1
2532 foo() was defined in an editing session
2836 45: y=3
2837 46: z=x+y
2838 47: print x
2839 48: a=5
2840 49: print 'x',x,'y',y
2533
2841
2534 Now we edit foo. IPython automatically loads the editor with the
2842 you can create a macro with lines 44 through 47 (included) and line 49
2535 (temporary) file where foo() was previously defined::
2843 called my_macro with::
2536
2844
2537 In [3]: ed foo
2845 In [55]: %macro my_macro 44-47 49
2538 Editing... done. Executing edited code...
2539
2846
2540 And if we call foo() again we get the modified version::
2847 Now, typing `my_macro` (without quotes) will re-execute all this code
2848 in one pass.
2541
2849
2542 In [4]: foo()
2850 You don't need to give the line-numbers in order, and any given line
2543 foo() has now been changed!
2851 number can appear multiple times. You can assemble macros with any
2852 lines from your input history in any order.
2544
2853
2545 Here is an example of how to edit a code snippet successive
2854 The macro is a simple object which holds its value in an attribute,
2546 times. First we call the editor::
2855 but IPython's display system checks for macros and executes them as
2856 code instead of printing them when you type their name.
2547
2857
2548 In [5]: ed
2858 You can view a macro's contents by explicitly printing it with::
2549 Editing... done. Executing edited code...
2550 hello
2551 Out[5]: "print 'hello'\\n"
2552
2859
2553 Now we call it again with the previous output (stored in _)::
2860 print macro_name
2554
2861
2555 In [6]: ed _
2862 """
2556 Editing... done. Executing edited code...
2863 opts,args = self.parse_options(parameter_s,'r',mode='list')
2557 hello world
2864 if not args: # List existing macros
2558 Out[6]: "print 'hello world'\\n"
2865 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2866 isinstance(v, Macro))
2867 if len(args) == 1:
2868 raise UsageError(
2869 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2870 name, codefrom = args[0], " ".join(args[1:])
2559
2871
2560 Now we call it with the output #8 (stored in _8, also as Out[8])::
2872 #print 'rng',ranges # dbg
2873 try:
2874 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2875 except (ValueError, TypeError) as e:
2876 print e.args[0]
2877 return
2878 macro = Macro(lines)
2879 self.shell.define_macro(name, macro)
2880 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2881 print '=== Macro contents: ==='
2882 print macro,
2561
2883
2562 In [7]: ed _8
2563 Editing... done. Executing edited code...
2564 hello again
2565 Out[7]: "print 'hello again'\\n"
2566
2884
2885 class AutoMagics(MagicFunctions):
2886 """Magics that control various autoX behaviors."""
2567
2887
2568 Changing the default editor hook:
2888 def __init__(self, shell):
2889 super(ProfileMagics, self).__init__(shell)
2890 # namespace for holding state we may need
2891 self._magic_state = Bunch()
2569
2892
2570 If you wish to write your own editor hook, you can put it in a
2893 def magic_automagic(self, parameter_s = ''):
2571 configuration file which you load at startup time. The default hook
2894 """Make magic functions callable without having to type the initial %.
2572 is defined in the IPython.core.hooks module, and you can use that as a
2573 starting example for further modifications. That file also has
2574 general instructions on how to set a new hook for use once you've
2575 defined it."""
2576 opts,args = self.parse_options(parameter_s,'prxn:')
2577
2895
2578 try:
2896 Without argumentsl toggles on/off (when off, you must call it as
2579 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2897 %automagic, of course). With arguments it sets the value, and you can
2580 except MacroToEdit as e:
2898 use any of (case insensitive):
2581 self._edit_macro(args, e.args[0])
2582 return
2583
2899
2584 # do actual editing here
2900 - on,1,True: to activate
2585 print 'Editing...',
2586 sys.stdout.flush()
2587 try:
2588 # Quote filenames that may have spaces in them
2589 if ' ' in filename:
2590 filename = "'%s'" % filename
2591 self.shell.hooks.editor(filename,lineno)
2592 except TryNext:
2593 warn('Could not open editor')
2594 return
2595
2901
2596 # XXX TODO: should this be generalized for all string vars?
2902 - off,0,False: to deactivate.
2597 # For now, this is special-cased to blocks created by cpaste
2598 if args.strip() == 'pasted_block':
2599 self.shell.user_ns['pasted_block'] = file_read(filename)
2600
2903
2601 if 'x' in opts: # -x prevents actual execution
2904 Note that magic functions have lowest priority, so if there's a
2602 print
2905 variable whose name collides with that of a magic fn, automagic won't
2603 else:
2906 work for that function (you get the variable instead). However, if you
2604 print 'done. Executing edited code...'
2907 delete the variable (del var), the previously shadowed magic function
2605 if 'r' in opts: # Untranslated IPython code
2908 becomes visible to automagic again."""
2606 self.shell.run_cell(file_read(filename),
2607 store_history=False)
2608 else:
2609 self.shell.safe_execfile(filename, self.shell.user_ns,
2610 self.shell.user_ns)
2611
2909
2612 if is_temp:
2910 arg = parameter_s.lower()
2613 try:
2911 if parameter_s in ('on','1','true'):
2614 return open(filename).read()
2912 self.shell.automagic = True
2615 except IOError,msg:
2913 elif parameter_s in ('off','0','false'):
2616 if msg.filename == filename:
2914 self.shell.automagic = False
2617 warn('File not found. Did you forget to save?')
2618 return
2619 else:
2915 else:
2620 self.shell.showtraceback()
2916 self.shell.automagic = not self.shell.automagic
2621
2917 print '\n' + Magic.auto_status[self.shell.automagic]
2622 def magic_xmode(self,parameter_s = ''):
2623 """Switch modes for the exception handlers.
2624
2918
2625 Valid modes: Plain, Context and Verbose.
2919 @skip_doctest
2920 def magic_autocall(self, parameter_s = ''):
2921 """Make functions callable without having to type parentheses.
2626
2922
2627 If called without arguments, acts as a toggle."""
2923 Usage:
2628
2924
2629 def xmode_switch_err(name):
2925 %autocall [mode]
2630 warn('Error changing %s exception modes.\n%s' %
2631 (name,sys.exc_info()[1]))
2632
2926
2633 shell = self.shell
2927 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
2634 new_mode = parameter_s.strip().capitalize()
2928 value is toggled on and off (remembering the previous state).
2635 try:
2636 shell.InteractiveTB.set_mode(mode=new_mode)
2637 print 'Exception reporting mode:',shell.InteractiveTB.mode
2638 except:
2639 xmode_switch_err('user')
2640
2929
2641 def magic_colors(self,parameter_s = ''):
2930 In more detail, these values mean:
2642 """Switch color scheme for prompts, info system and exception handlers.
2643
2931
2644 Currently implemented schemes: NoColor, Linux, LightBG.
2932 0 -> fully disabled
2645
2933
2646 Color scheme names are not case-sensitive.
2934 1 -> active, but do not apply if there are no arguments on the line.
2647
2935
2648 Examples
2936 In this mode, you get::
2649 --------
2650 To get a plain black and white terminal::
2651
2937
2652 %colors nocolor
2938 In [1]: callable
2653 """
2939 Out[1]: <built-in function callable>
2654
2940
2655 def color_switch_err(name):
2941 In [2]: callable 'hello'
2656 warn('Error changing %s color schemes.\n%s' %
2942 ------> callable('hello')
2657 (name,sys.exc_info()[1]))
2943 Out[2]: False
2658
2944
2945 2 -> Active always. Even if no arguments are present, the callable
2946 object is called::
2659
2947
2660 new_scheme = parameter_s.strip()
2948 In [2]: float
2661 if not new_scheme:
2949 ------> float()
2662 raise UsageError(
2950 Out[2]: 0.0
2663 "%colors: you must specify a color scheme. See '%colors?'")
2664 return
2665 # local shortcut
2666 shell = self.shell
2667
2951
2668 import IPython.utils.rlineimpl as readline
2952 Note that even with autocall off, you can still use '/' at the start of
2953 a line to treat the first argument on the command line as a function
2954 and add parentheses to it::
2669
2955
2670 if not shell.colors_force and \
2956 In [8]: /str 43
2671 not readline.have_readline and sys.platform == "win32":
2957 ------> str(43)
2672 msg = """\
2958 Out[8]: '43'
2673 Proper color support under MS Windows requires the pyreadline library.
2674 You can find it at:
2675 http://ipython.org/pyreadline.html
2676 Gary's readline needs the ctypes module, from:
2677 http://starship.python.net/crew/theller/ctypes
2678 (Note that ctypes is already part of Python versions 2.5 and newer).
2679
2959
2680 Defaulting color scheme to 'NoColor'"""
2960 # all-random (note for auto-testing)
2681 new_scheme = 'NoColor'
2961 """
2682 warn(msg)
2683
2962
2684 # readline option is 0
2963 if parameter_s:
2685 if not shell.colors_force and not shell.has_readline:
2964 arg = int(parameter_s)
2686 new_scheme = 'NoColor'
2965 else:
2966 arg = 'toggle'
2687
2967
2688 # Set prompt colors
2968 if not arg in (0,1,2,'toggle'):
2689 try:
2969 error('Valid modes: (0->Off, 1->Smart, 2->Full')
2690 shell.prompt_manager.color_scheme = new_scheme
2970 return
2691 except:
2971
2692 color_switch_err('prompt')
2972 if arg in (0,1,2):
2973 self.shell.autocall = arg
2974 else: # toggle
2975 if self.shell.autocall:
2976 self._magic_state.autocall_save = self.shell.autocall
2977 self.shell.autocall = 0
2693 else:
2978 else:
2694 shell.colors = \
2695 shell.prompt_manager.color_scheme_table.active_scheme_name
2696 # Set exception colors
2697 try:
2979 try:
2698 shell.InteractiveTB.set_colors(scheme = new_scheme)
2980 self.shell.autocall = self._magic_state.autocall_save
2699 shell.SyntaxTB.set_colors(scheme = new_scheme)
2981 except AttributeError:
2700 except:
2982 self.shell.autocall = self._magic_state.autocall_save = 1
2701 color_switch_err('exception')
2702
2983
2703 # Set info (for 'object?') colors
2984 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
2704 if shell.color_info:
2705 try:
2706 shell.inspector.set_active_scheme(new_scheme)
2707 except:
2708 color_switch_err('object inspector')
2709 else:
2710 shell.inspector.set_active_scheme('NoColor')
2711
2985
2712 def magic_pprint(self, parameter_s=''):
2713 """Toggle pretty printing on/off."""
2714 ptformatter = self.shell.display_formatter.formatters['text/plain']
2715 ptformatter.pprint = bool(1 - ptformatter.pprint)
2716 print 'Pretty printing has been turned', \
2717 ['OFF','ON'][ptformatter.pprint]
2718
2986
2719 #......................................................................
2987 class OSMagics(MagicFunctions):
2720 # Functions to implement unix shell-type things
2988 """Magics to interact with the underlying OS (shell-type functionality).
2989 """
2721
2990
2722 @skip_doctest
2991 @skip_doctest
2723 def magic_alias(self, parameter_s = ''):
2992 def magic_alias(self, parameter_s = ''):
2724 """Define an alias for a system command.
2993 """Define an alias for a system command.
2725
2994
2726 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2995 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2727
2996
2728 Then, typing 'alias_name params' will execute the system command 'cmd
2997 Then, typing 'alias_name params' will execute the system command 'cmd
2729 params' (from your underlying operating system).
2998 params' (from your underlying operating system).
2730
2999
2731 Aliases have lower precedence than magic functions and Python normal
3000 Aliases have lower precedence than magic functions and Python normal
2732 variables, so if 'foo' is both a Python variable and an alias, the
3001 variables, so if 'foo' is both a Python variable and an alias, the
2733 alias can not be executed until 'del foo' removes the Python variable.
3002 alias can not be executed until 'del foo' removes the Python variable.
2734
3003
2735 You can use the %l specifier in an alias definition to represent the
3004 You can use the %l specifier in an alias definition to represent the
2736 whole line when the alias is called. For example::
3005 whole line when the alias is called. For example::
2737
3006
2738 In [2]: alias bracket echo "Input in brackets: <%l>"
3007 In [2]: alias bracket echo "Input in brackets: <%l>"
2739 In [3]: bracket hello world
3008 In [3]: bracket hello world
2740 Input in brackets: <hello world>
3009 Input in brackets: <hello world>
2741
3010
2742 You can also define aliases with parameters using %s specifiers (one
3011 You can also define aliases with parameters using %s specifiers (one
2743 per parameter)::
3012 per parameter)::
2744
3013
2745 In [1]: alias parts echo first %s second %s
3014 In [1]: alias parts echo first %s second %s
2746 In [2]: %parts A B
3015 In [2]: %parts A B
2747 first A second B
3016 first A second B
2748 In [3]: %parts A
3017 In [3]: %parts A
2749 Incorrect number of arguments: 2 expected.
3018 Incorrect number of arguments: 2 expected.
2750 parts is an alias to: 'echo first %s second %s'
3019 parts is an alias to: 'echo first %s second %s'
2751
3020
2752 Note that %l and %s are mutually exclusive. You can only use one or
3021 Note that %l and %s are mutually exclusive. You can only use one or
2753 the other in your aliases.
3022 the other in your aliases.
2754
3023
2755 Aliases expand Python variables just like system calls using ! or !!
3024 Aliases expand Python variables just like system calls using ! or !!
2756 do: all expressions prefixed with '$' get expanded. For details of
3025 do: all expressions prefixed with '$' get expanded. For details of
2757 the semantic rules, see PEP-215:
3026 the semantic rules, see PEP-215:
2758 http://www.python.org/peps/pep-0215.html. This is the library used by
3027 http://www.python.org/peps/pep-0215.html. This is the library used by
2759 IPython for variable expansion. If you want to access a true shell
3028 IPython for variable expansion. If you want to access a true shell
2760 variable, an extra $ is necessary to prevent its expansion by
3029 variable, an extra $ is necessary to prevent its expansion by
2761 IPython::
3030 IPython::
2762
3031
2763 In [6]: alias show echo
3032 In [6]: alias show echo
2764 In [7]: PATH='A Python string'
3033 In [7]: PATH='A Python string'
2765 In [8]: show $PATH
3034 In [8]: show $PATH
2766 A Python string
3035 A Python string
2767 In [9]: show $$PATH
3036 In [9]: show $$PATH
2768 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
3037 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2769
3038
2770 You can use the alias facility to acess all of $PATH. See the %rehash
3039 You can use the alias facility to acess all of $PATH. See the %rehash
2771 and %rehashx functions, which automatically create aliases for the
3040 and %rehashx functions, which automatically create aliases for the
2772 contents of your $PATH.
3041 contents of your $PATH.
2773
3042
2774 If called with no parameters, %alias prints the current alias table."""
3043 If called with no parameters, %alias prints the current alias table."""
2775
3044
2776 par = parameter_s.strip()
3045 par = parameter_s.strip()
2777 if not par:
3046 if not par:
2778 stored = self.shell.db.get('stored_aliases', {} )
3047 stored = self.shell.db.get('stored_aliases', {} )
2779 aliases = sorted(self.shell.alias_manager.aliases)
3048 aliases = sorted(self.shell.alias_manager.aliases)
2780 # for k, v in stored:
3049 # for k, v in stored:
2781 # atab.append(k, v[0])
3050 # atab.append(k, v[0])
2782
3051
2783 print "Total number of aliases:", len(aliases)
3052 print "Total number of aliases:", len(aliases)
2784 sys.stdout.flush()
3053 sys.stdout.flush()
2785 return aliases
3054 return aliases
2786
3055
2787 # Now try to define a new one
3056 # Now try to define a new one
2788 try:
3057 try:
2789 alias,cmd = par.split(None, 1)
3058 alias,cmd = par.split(None, 1)
2790 except:
3059 except:
2791 print oinspect.getdoc(self.magic_alias)
3060 print oinspect.getdoc(self.magic_alias)
2792 else:
3061 else:
2793 self.shell.alias_manager.soft_define_alias(alias, cmd)
3062 self.shell.alias_manager.soft_define_alias(alias, cmd)
2794 # end magic_alias
3063 # end magic_alias
2795
3064
2796 def magic_unalias(self, parameter_s = ''):
3065 def magic_unalias(self, parameter_s = ''):
2797 """Remove an alias"""
3066 """Remove an alias"""
2798
3067
2799 aname = parameter_s.strip()
3068 aname = parameter_s.strip()
2800 self.shell.alias_manager.undefine_alias(aname)
3069 self.shell.alias_manager.undefine_alias(aname)
2801 stored = self.shell.db.get('stored_aliases', {} )
3070 stored = self.shell.db.get('stored_aliases', {} )
2802 if aname in stored:
3071 if aname in stored:
2803 print "Removing %stored alias",aname
3072 print "Removing %stored alias",aname
2804 del stored[aname]
3073 del stored[aname]
2805 self.shell.db['stored_aliases'] = stored
3074 self.shell.db['stored_aliases'] = stored
2806
3075
2807 def magic_rehashx(self, parameter_s = ''):
3076 def magic_rehashx(self, parameter_s = ''):
2808 """Update the alias table with all executable files in $PATH.
3077 """Update the alias table with all executable files in $PATH.
2809
3078
2810 This version explicitly checks that every entry in $PATH is a file
3079 This version explicitly checks that every entry in $PATH is a file
2811 with execute access (os.X_OK), so it is much slower than %rehash.
3080 with execute access (os.X_OK), so it is much slower than %rehash.
2812
3081
2813 Under Windows, it checks executability as a match against a
3082 Under Windows, it checks executability as a match against a
2814 '|'-separated string of extensions, stored in the IPython config
3083 '|'-separated string of extensions, stored in the IPython config
2815 variable win_exec_ext. This defaults to 'exe|com|bat'.
3084 variable win_exec_ext. This defaults to 'exe|com|bat'.
2816
3085
2817 This function also resets the root module cache of module completer,
3086 This function also resets the root module cache of module completer,
2818 used on slow filesystems.
3087 used on slow filesystems.
2819 """
3088 """
2820 from IPython.core.alias import InvalidAliasError
3089 from IPython.core.alias import InvalidAliasError
2821
3090
2822 # for the benefit of module completer in ipy_completers.py
3091 # for the benefit of module completer in ipy_completers.py
2823 del self.shell.db['rootmodules']
3092 del self.shell.db['rootmodules']
2824
3093
2825 path = [os.path.abspath(os.path.expanduser(p)) for p in
3094 path = [os.path.abspath(os.path.expanduser(p)) for p in
2826 os.environ.get('PATH','').split(os.pathsep)]
3095 os.environ.get('PATH','').split(os.pathsep)]
2827 path = filter(os.path.isdir,path)
3096 path = filter(os.path.isdir,path)
2828
3097
2829 syscmdlist = []
3098 syscmdlist = []
2830 # Now define isexec in a cross platform manner.
3099 # Now define isexec in a cross platform manner.
2831 if os.name == 'posix':
3100 if os.name == 'posix':
2832 isexec = lambda fname:os.path.isfile(fname) and \
3101 isexec = lambda fname:os.path.isfile(fname) and \
2833 os.access(fname,os.X_OK)
3102 os.access(fname,os.X_OK)
2834 else:
3103 else:
2835 try:
3104 try:
2836 winext = os.environ['pathext'].replace(';','|').replace('.','')
3105 winext = os.environ['pathext'].replace(';','|').replace('.','')
2837 except KeyError:
3106 except KeyError:
2838 winext = 'exe|com|bat|py'
3107 winext = 'exe|com|bat|py'
2839 if 'py' not in winext:
3108 if 'py' not in winext:
2840 winext += '|py'
3109 winext += '|py'
2841 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
3110 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2842 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
3111 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2843 savedir = os.getcwdu()
3112 savedir = os.getcwdu()
2844
3113
2845 # Now walk the paths looking for executables to alias.
3114 # Now walk the paths looking for executables to alias.
2846 try:
3115 try:
2847 # write the whole loop for posix/Windows so we don't have an if in
3116 # write the whole loop for posix/Windows so we don't have an if in
2848 # the innermost part
3117 # the innermost part
2849 if os.name == 'posix':
3118 if os.name == 'posix':
2850 for pdir in path:
3119 for pdir in path:
2851 os.chdir(pdir)
3120 os.chdir(pdir)
2852 for ff in os.listdir(pdir):
3121 for ff in os.listdir(pdir):
2853 if isexec(ff):
3122 if isexec(ff):
2854 try:
3123 try:
2855 # Removes dots from the name since ipython
3124 # Removes dots from the name since ipython
2856 # will assume names with dots to be python.
3125 # will assume names with dots to be python.
2857 self.shell.alias_manager.define_alias(
3126 self.shell.alias_manager.define_alias(
2858 ff.replace('.',''), ff)
3127 ff.replace('.',''), ff)
2859 except InvalidAliasError:
3128 except InvalidAliasError:
2860 pass
3129 pass
2861 else:
3130 else:
2862 syscmdlist.append(ff)
3131 syscmdlist.append(ff)
2863 else:
3132 else:
2864 no_alias = self.shell.alias_manager.no_alias
3133 no_alias = self.shell.alias_manager.no_alias
2865 for pdir in path:
3134 for pdir in path:
2866 os.chdir(pdir)
3135 os.chdir(pdir)
2867 for ff in os.listdir(pdir):
3136 for ff in os.listdir(pdir):
2868 base, ext = os.path.splitext(ff)
3137 base, ext = os.path.splitext(ff)
2869 if isexec(ff) and base.lower() not in no_alias:
3138 if isexec(ff) and base.lower() not in no_alias:
2870 if ext.lower() == '.exe':
3139 if ext.lower() == '.exe':
2871 ff = base
3140 ff = base
2872 try:
3141 try:
2873 # Removes dots from the name since ipython
3142 # Removes dots from the name since ipython
2874 # will assume names with dots to be python.
3143 # will assume names with dots to be python.
2875 self.shell.alias_manager.define_alias(
3144 self.shell.alias_manager.define_alias(
2876 base.lower().replace('.',''), ff)
3145 base.lower().replace('.',''), ff)
2877 except InvalidAliasError:
3146 except InvalidAliasError:
2878 pass
3147 pass
2879 syscmdlist.append(ff)
3148 syscmdlist.append(ff)
2880 self.shell.db['syscmdlist'] = syscmdlist
3149 self.shell.db['syscmdlist'] = syscmdlist
2881 finally:
3150 finally:
2882 os.chdir(savedir)
3151 os.chdir(savedir)
2883
3152
2884 @skip_doctest
3153 @skip_doctest
2885 def magic_pwd(self, parameter_s = ''):
3154 def magic_pwd(self, parameter_s = ''):
2886 """Return the current working directory path.
3155 """Return the current working directory path.
2887
3156
2888 Examples
3157 Examples
2889 --------
3158 --------
2890 ::
3159 ::
2891
3160
2892 In [9]: pwd
3161 In [9]: pwd
2893 Out[9]: '/home/tsuser/sprint/ipython'
3162 Out[9]: '/home/tsuser/sprint/ipython'
2894 """
3163 """
2895 return os.getcwdu()
3164 return os.getcwdu()
2896
3165
2897 @skip_doctest
3166 @skip_doctest
2898 def magic_cd(self, parameter_s=''):
3167 def magic_cd(self, parameter_s=''):
2899 """Change the current working directory.
3168 """Change the current working directory.
2900
3169
2901 This command automatically maintains an internal list of directories
3170 This command automatically maintains an internal list of directories
2902 you visit during your IPython session, in the variable _dh. The
3171 you visit during your IPython session, in the variable _dh. The
2903 command %dhist shows this history nicely formatted. You can also
3172 command %dhist shows this history nicely formatted. You can also
2904 do 'cd -<tab>' to see directory history conveniently.
3173 do 'cd -<tab>' to see directory history conveniently.
2905
3174
2906 Usage:
3175 Usage:
2907
3176
2908 cd 'dir': changes to directory 'dir'.
3177 cd 'dir': changes to directory 'dir'.
2909
3178
2910 cd -: changes to the last visited directory.
3179 cd -: changes to the last visited directory.
2911
3180
2912 cd -<n>: changes to the n-th directory in the directory history.
3181 cd -<n>: changes to the n-th directory in the directory history.
2913
3182
2914 cd --foo: change to directory that matches 'foo' in history
3183 cd --foo: change to directory that matches 'foo' in history
2915
3184
2916 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
3185 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2917 (note: cd <bookmark_name> is enough if there is no
3186 (note: cd <bookmark_name> is enough if there is no
2918 directory <bookmark_name>, but a bookmark with the name exists.)
3187 directory <bookmark_name>, but a bookmark with the name exists.)
2919 'cd -b <tab>' allows you to tab-complete bookmark names.
3188 'cd -b <tab>' allows you to tab-complete bookmark names.
2920
3189
2921 Options:
3190 Options:
2922
3191
2923 -q: quiet. Do not print the working directory after the cd command is
3192 -q: quiet. Do not print the working directory after the cd command is
2924 executed. By default IPython's cd command does print this directory,
3193 executed. By default IPython's cd command does print this directory,
2925 since the default prompts do not display path information.
3194 since the default prompts do not display path information.
2926
3195
2927 Note that !cd doesn't work for this purpose because the shell where
3196 Note that !cd doesn't work for this purpose because the shell where
2928 !command runs is immediately discarded after executing 'command'.
3197 !command runs is immediately discarded after executing 'command'.
2929
3198
2930 Examples
3199 Examples
2931 --------
3200 --------
2932 ::
3201 ::
2933
3202
2934 In [10]: cd parent/child
3203 In [10]: cd parent/child
2935 /home/tsuser/parent/child
3204 /home/tsuser/parent/child
2936 """
3205 """
2937
3206
2938 parameter_s = parameter_s.strip()
3207 parameter_s = parameter_s.strip()
2939 #bkms = self.shell.persist.get("bookmarks",{})
3208 #bkms = self.shell.persist.get("bookmarks",{})
2940
3209
2941 oldcwd = os.getcwdu()
3210 oldcwd = os.getcwdu()
2942 numcd = re.match(r'(-)(\d+)$',parameter_s)
3211 numcd = re.match(r'(-)(\d+)$',parameter_s)
2943 # jump in directory history by number
3212 # jump in directory history by number
2944 if numcd:
3213 if numcd:
2945 nn = int(numcd.group(2))
3214 nn = int(numcd.group(2))
2946 try:
3215 try:
2947 ps = self.shell.user_ns['_dh'][nn]
3216 ps = self.shell.user_ns['_dh'][nn]
2948 except IndexError:
3217 except IndexError:
2949 print 'The requested directory does not exist in history.'
3218 print 'The requested directory does not exist in history.'
2950 return
3219 return
2951 else:
3220 else:
2952 opts = {}
3221 opts = {}
2953 elif parameter_s.startswith('--'):
3222 elif parameter_s.startswith('--'):
2954 ps = None
3223 ps = None
2955 fallback = None
3224 fallback = None
2956 pat = parameter_s[2:]
3225 pat = parameter_s[2:]
2957 dh = self.shell.user_ns['_dh']
3226 dh = self.shell.user_ns['_dh']
2958 # first search only by basename (last component)
3227 # first search only by basename (last component)
2959 for ent in reversed(dh):
3228 for ent in reversed(dh):
2960 if pat in os.path.basename(ent) and os.path.isdir(ent):
3229 if pat in os.path.basename(ent) and os.path.isdir(ent):
2961 ps = ent
3230 ps = ent
2962 break
3231 break
2963
3232
2964 if fallback is None and pat in ent and os.path.isdir(ent):
3233 if fallback is None and pat in ent and os.path.isdir(ent):
2965 fallback = ent
3234 fallback = ent
2966
3235
2967 # if we have no last part match, pick the first full path match
3236 # if we have no last part match, pick the first full path match
2968 if ps is None:
3237 if ps is None:
2969 ps = fallback
3238 ps = fallback
2970
3239
2971 if ps is None:
3240 if ps is None:
2972 print "No matching entry in directory history"
3241 print "No matching entry in directory history"
2973 return
3242 return
2974 else:
3243 else:
2975 opts = {}
3244 opts = {}
2976
3245
2977
3246
2978 else:
3247 else:
2979 #turn all non-space-escaping backslashes to slashes,
3248 #turn all non-space-escaping backslashes to slashes,
2980 # for c:\windows\directory\names\
3249 # for c:\windows\directory\names\
2981 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
3250 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2982 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
3251 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2983 # jump to previous
3252 # jump to previous
2984 if ps == '-':
3253 if ps == '-':
2985 try:
3254 try:
2986 ps = self.shell.user_ns['_dh'][-2]
3255 ps = self.shell.user_ns['_dh'][-2]
2987 except IndexError:
3256 except IndexError:
2988 raise UsageError('%cd -: No previous directory to change to.')
3257 raise UsageError('%cd -: No previous directory to change to.')
2989 # jump to bookmark if needed
3258 # jump to bookmark if needed
2990 else:
3259 else:
2991 if not os.path.isdir(ps) or opts.has_key('b'):
3260 if not os.path.isdir(ps) or opts.has_key('b'):
2992 bkms = self.shell.db.get('bookmarks', {})
3261 bkms = self.shell.db.get('bookmarks', {})
2993
3262
2994 if bkms.has_key(ps):
3263 if bkms.has_key(ps):
2995 target = bkms[ps]
3264 target = bkms[ps]
2996 print '(bookmark:%s) -> %s' % (ps,target)
3265 print '(bookmark:%s) -> %s' % (ps,target)
2997 ps = target
3266 ps = target
2998 else:
3267 else:
2999 if opts.has_key('b'):
3268 if opts.has_key('b'):
3000 raise UsageError("Bookmark '%s' not found. "
3269 raise UsageError("Bookmark '%s' not found. "
3001 "Use '%%bookmark -l' to see your bookmarks." % ps)
3270 "Use '%%bookmark -l' to see your bookmarks." % ps)
3002
3271
3003 # strip extra quotes on Windows, because os.chdir doesn't like them
3272 # strip extra quotes on Windows, because os.chdir doesn't like them
3004 ps = unquote_filename(ps)
3273 ps = unquote_filename(ps)
3005 # at this point ps should point to the target dir
3274 # at this point ps should point to the target dir
3006 if ps:
3275 if ps:
3007 try:
3276 try:
3008 os.chdir(os.path.expanduser(ps))
3277 os.chdir(os.path.expanduser(ps))
3009 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3278 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3010 set_term_title('IPython: ' + abbrev_cwd())
3279 set_term_title('IPython: ' + abbrev_cwd())
3011 except OSError:
3280 except OSError:
3012 print sys.exc_info()[1]
3281 print sys.exc_info()[1]
3013 else:
3282 else:
3014 cwd = os.getcwdu()
3283 cwd = os.getcwdu()
3015 dhist = self.shell.user_ns['_dh']
3284 dhist = self.shell.user_ns['_dh']
3016 if oldcwd != cwd:
3285 if oldcwd != cwd:
3017 dhist.append(cwd)
3286 dhist.append(cwd)
3018 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3287 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3019
3288
3020 else:
3289 else:
3021 os.chdir(self.shell.home_dir)
3290 os.chdir(self.shell.home_dir)
3022 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3291 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3023 set_term_title('IPython: ' + '~')
3292 set_term_title('IPython: ' + '~')
3024 cwd = os.getcwdu()
3293 cwd = os.getcwdu()
3025 dhist = self.shell.user_ns['_dh']
3294 dhist = self.shell.user_ns['_dh']
3026
3295
3027 if oldcwd != cwd:
3296 if oldcwd != cwd:
3028 dhist.append(cwd)
3297 dhist.append(cwd)
3029 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3298 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3030 if not 'q' in opts and self.shell.user_ns['_dh']:
3299 if not 'q' in opts and self.shell.user_ns['_dh']:
3031 print self.shell.user_ns['_dh'][-1]
3300 print self.shell.user_ns['_dh'][-1]
3032
3301
3033
3302
3034 def magic_env(self, parameter_s=''):
3303 def magic_env(self, parameter_s=''):
3035 """List environment variables."""
3304 """List environment variables."""
3036
3305
3037 return dict(os.environ)
3306 return dict(os.environ)
3038
3307
3039 def magic_pushd(self, parameter_s=''):
3308 def magic_pushd(self, parameter_s=''):
3040 """Place the current dir on stack and change directory.
3309 """Place the current dir on stack and change directory.
3041
3310
3042 Usage:\\
3311 Usage:\\
3043 %pushd ['dirname']
3312 %pushd ['dirname']
3044 """
3313 """
3045
3314
3046 dir_s = self.shell.dir_stack
3315 dir_s = self.shell.dir_stack
3047 tgt = os.path.expanduser(unquote_filename(parameter_s))
3316 tgt = os.path.expanduser(unquote_filename(parameter_s))
3048 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
3317 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
3049 if tgt:
3318 if tgt:
3050 self.magic_cd(parameter_s)
3319 self.magic_cd(parameter_s)
3051 dir_s.insert(0,cwd)
3320 dir_s.insert(0,cwd)
3052 return self.shell.magic('dirs')
3321 return self.shell.magic('dirs')
3053
3322
3054 def magic_popd(self, parameter_s=''):
3323 def magic_popd(self, parameter_s=''):
3055 """Change to directory popped off the top of the stack.
3324 """Change to directory popped off the top of the stack.
3056 """
3325 """
3057 if not self.shell.dir_stack:
3326 if not self.shell.dir_stack:
3058 raise UsageError("%popd on empty stack")
3327 raise UsageError("%popd on empty stack")
3059 top = self.shell.dir_stack.pop(0)
3328 top = self.shell.dir_stack.pop(0)
3060 self.magic_cd(top)
3329 self.magic_cd(top)
3061 print "popd ->",top
3330 print "popd ->",top
3062
3331
3063 def magic_dirs(self, parameter_s=''):
3332 def magic_dirs(self, parameter_s=''):
3064 """Return the current directory stack."""
3333 """Return the current directory stack."""
3065
3334
3066 return self.shell.dir_stack
3335 return self.shell.dir_stack
3067
3336
3068 def magic_dhist(self, parameter_s=''):
3337 def magic_dhist(self, parameter_s=''):
3069 """Print your history of visited directories.
3338 """Print your history of visited directories.
3070
3339
3071 %dhist -> print full history\\
3340 %dhist -> print full history\\
3072 %dhist n -> print last n entries only\\
3341 %dhist n -> print last n entries only\\
3073 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
3342 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
3074
3343
3075 This history is automatically maintained by the %cd command, and
3344 This history is automatically maintained by the %cd command, and
3076 always available as the global list variable _dh. You can use %cd -<n>
3345 always available as the global list variable _dh. You can use %cd -<n>
3077 to go to directory number <n>.
3346 to go to directory number <n>.
3078
3347
3079 Note that most of time, you should view directory history by entering
3348 Note that most of time, you should view directory history by entering
3080 cd -<TAB>.
3349 cd -<TAB>.
3081
3350
3082 """
3351 """
3083
3352
3084 dh = self.shell.user_ns['_dh']
3353 dh = self.shell.user_ns['_dh']
3085 if parameter_s:
3354 if parameter_s:
3086 try:
3355 try:
3087 args = map(int,parameter_s.split())
3356 args = map(int,parameter_s.split())
3088 except:
3357 except:
3089 self.arg_err(Magic.magic_dhist)
3358 self.arg_err(Magic.magic_dhist)
3090 return
3359 return
3091 if len(args) == 1:
3360 if len(args) == 1:
3092 ini,fin = max(len(dh)-(args[0]),0),len(dh)
3361 ini,fin = max(len(dh)-(args[0]),0),len(dh)
3093 elif len(args) == 2:
3362 elif len(args) == 2:
3094 ini,fin = args
3363 ini,fin = args
3095 else:
3364 else:
3096 self.arg_err(Magic.magic_dhist)
3365 self.arg_err(Magic.magic_dhist)
3097 return
3366 return
3098 else:
3367 else:
3099 ini,fin = 0,len(dh)
3368 ini,fin = 0,len(dh)
3100 nlprint(dh,
3369 nlprint(dh,
3101 header = 'Directory history (kept in _dh)',
3370 header = 'Directory history (kept in _dh)',
3102 start=ini,stop=fin)
3371 start=ini,stop=fin)
3103
3372
3104 @skip_doctest
3373 @skip_doctest
3105 def magic_sc(self, parameter_s=''):
3374 def magic_sc(self, parameter_s=''):
3106 """Shell capture - execute a shell command and capture its output.
3375 """Shell capture - execute a shell command and capture its output.
3107
3376
3108 DEPRECATED. Suboptimal, retained for backwards compatibility.
3377 DEPRECATED. Suboptimal, retained for backwards compatibility.
3109
3378
3110 You should use the form 'var = !command' instead. Example:
3379 You should use the form 'var = !command' instead. Example:
3111
3380
3112 "%sc -l myfiles = ls ~" should now be written as
3381 "%sc -l myfiles = ls ~" should now be written as
3113
3382
3114 "myfiles = !ls ~"
3383 "myfiles = !ls ~"
3115
3384
3116 myfiles.s, myfiles.l and myfiles.n still apply as documented
3385 myfiles.s, myfiles.l and myfiles.n still apply as documented
3117 below.
3386 below.
3118
3387
3119 --
3388 --
3120 %sc [options] varname=command
3389 %sc [options] varname=command
3121
3390
3122 IPython will run the given command using commands.getoutput(), and
3391 IPython will run the given command using commands.getoutput(), and
3123 will then update the user's interactive namespace with a variable
3392 will then update the user's interactive namespace with a variable
3124 called varname, containing the value of the call. Your command can
3393 called varname, containing the value of the call. Your command can
3125 contain shell wildcards, pipes, etc.
3394 contain shell wildcards, pipes, etc.
3126
3395
3127 The '=' sign in the syntax is mandatory, and the variable name you
3396 The '=' sign in the syntax is mandatory, and the variable name you
3128 supply must follow Python's standard conventions for valid names.
3397 supply must follow Python's standard conventions for valid names.
3129
3398
3130 (A special format without variable name exists for internal use)
3399 (A special format without variable name exists for internal use)
3131
3400
3132 Options:
3401 Options:
3133
3402
3134 -l: list output. Split the output on newlines into a list before
3403 -l: list output. Split the output on newlines into a list before
3135 assigning it to the given variable. By default the output is stored
3404 assigning it to the given variable. By default the output is stored
3136 as a single string.
3405 as a single string.
3137
3406
3138 -v: verbose. Print the contents of the variable.
3407 -v: verbose. Print the contents of the variable.
3139
3408
3140 In most cases you should not need to split as a list, because the
3409 In most cases you should not need to split as a list, because the
3141 returned value is a special type of string which can automatically
3410 returned value is a special type of string which can automatically
3142 provide its contents either as a list (split on newlines) or as a
3411 provide its contents either as a list (split on newlines) or as a
3143 space-separated string. These are convenient, respectively, either
3412 space-separated string. These are convenient, respectively, either
3144 for sequential processing or to be passed to a shell command.
3413 for sequential processing or to be passed to a shell command.
3145
3414
3146 For example::
3415 For example::
3147
3416
3148 # Capture into variable a
3417 # Capture into variable a
3149 In [1]: sc a=ls *py
3418 In [1]: sc a=ls *py
3150
3419
3151 # a is a string with embedded newlines
3420 # a is a string with embedded newlines
3152 In [2]: a
3421 In [2]: a
3153 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
3422 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
3154
3423
3155 # which can be seen as a list:
3424 # which can be seen as a list:
3156 In [3]: a.l
3425 In [3]: a.l
3157 Out[3]: ['setup.py', 'win32_manual_post_install.py']
3426 Out[3]: ['setup.py', 'win32_manual_post_install.py']
3158
3427
3159 # or as a whitespace-separated string:
3428 # or as a whitespace-separated string:
3160 In [4]: a.s
3429 In [4]: a.s
3161 Out[4]: 'setup.py win32_manual_post_install.py'
3430 Out[4]: 'setup.py win32_manual_post_install.py'
3162
3431
3163 # a.s is useful to pass as a single command line:
3432 # a.s is useful to pass as a single command line:
3164 In [5]: !wc -l $a.s
3433 In [5]: !wc -l $a.s
3165 146 setup.py
3434 146 setup.py
3166 130 win32_manual_post_install.py
3435 130 win32_manual_post_install.py
3167 276 total
3436 276 total
3168
3437
3169 # while the list form is useful to loop over:
3438 # while the list form is useful to loop over:
3170 In [6]: for f in a.l:
3439 In [6]: for f in a.l:
3171 ...: !wc -l $f
3440 ...: !wc -l $f
3172 ...:
3441 ...:
3173 146 setup.py
3442 146 setup.py
3174 130 win32_manual_post_install.py
3443 130 win32_manual_post_install.py
3175
3444
3176 Similarly, the lists returned by the -l option are also special, in
3445 Similarly, the lists returned by the -l option are also special, in
3177 the sense that you can equally invoke the .s attribute on them to
3446 the sense that you can equally invoke the .s attribute on them to
3178 automatically get a whitespace-separated string from their contents::
3447 automatically get a whitespace-separated string from their contents::
3179
3448
3180 In [7]: sc -l b=ls *py
3449 In [7]: sc -l b=ls *py
3181
3450
3182 In [8]: b
3451 In [8]: b
3183 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3452 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3184
3453
3185 In [9]: b.s
3454 In [9]: b.s
3186 Out[9]: 'setup.py win32_manual_post_install.py'
3455 Out[9]: 'setup.py win32_manual_post_install.py'
3187
3456
3188 In summary, both the lists and strings used for output capture have
3457 In summary, both the lists and strings used for output capture have
3189 the following special attributes::
3458 the following special attributes::
3190
3459
3191 .l (or .list) : value as list.
3460 .l (or .list) : value as list.
3192 .n (or .nlstr): value as newline-separated string.
3461 .n (or .nlstr): value as newline-separated string.
3193 .s (or .spstr): value as space-separated string.
3462 .s (or .spstr): value as space-separated string.
3194 """
3463 """
3195
3464
3196 opts,args = self.parse_options(parameter_s,'lv')
3465 opts,args = self.parse_options(parameter_s,'lv')
3197 # Try to get a variable name and command to run
3466 # Try to get a variable name and command to run
3198 try:
3467 try:
3199 # the variable name must be obtained from the parse_options
3468 # the variable name must be obtained from the parse_options
3200 # output, which uses shlex.split to strip options out.
3469 # output, which uses shlex.split to strip options out.
3201 var,_ = args.split('=',1)
3470 var,_ = args.split('=',1)
3202 var = var.strip()
3471 var = var.strip()
3203 # But the command has to be extracted from the original input
3472 # But the command has to be extracted from the original input
3204 # parameter_s, not on what parse_options returns, to avoid the
3473 # parameter_s, not on what parse_options returns, to avoid the
3205 # quote stripping which shlex.split performs on it.
3474 # quote stripping which shlex.split performs on it.
3206 _,cmd = parameter_s.split('=',1)
3475 _,cmd = parameter_s.split('=',1)
3207 except ValueError:
3476 except ValueError:
3208 var,cmd = '',''
3477 var,cmd = '',''
3209 # If all looks ok, proceed
3478 # If all looks ok, proceed
3210 split = 'l' in opts
3479 split = 'l' in opts
3211 out = self.shell.getoutput(cmd, split=split)
3480 out = self.shell.getoutput(cmd, split=split)
3212 if opts.has_key('v'):
3481 if opts.has_key('v'):
3213 print '%s ==\n%s' % (var,pformat(out))
3482 print '%s ==\n%s' % (var,pformat(out))
3214 if var:
3483 if var:
3215 self.shell.user_ns.update({var:out})
3484 self.shell.user_ns.update({var:out})
3216 else:
3485 else:
3217 return out
3486 return out
3218
3487
3219 def magic_sx(self, parameter_s=''):
3488 def magic_sx(self, parameter_s=''):
3220 """Shell execute - run a shell command and capture its output.
3489 """Shell execute - run a shell command and capture its output.
3221
3490
3222 %sx command
3491 %sx command
3223
3492
3224 IPython will run the given command using commands.getoutput(), and
3493 IPython will run the given command using commands.getoutput(), and
3225 return the result formatted as a list (split on '\\n'). Since the
3494 return the result formatted as a list (split on '\\n'). Since the
3226 output is _returned_, it will be stored in ipython's regular output
3495 output is _returned_, it will be stored in ipython's regular output
3227 cache Out[N] and in the '_N' automatic variables.
3496 cache Out[N] and in the '_N' automatic variables.
3228
3497
3229 Notes:
3498 Notes:
3230
3499
3231 1) If an input line begins with '!!', then %sx is automatically
3500 1) If an input line begins with '!!', then %sx is automatically
3232 invoked. That is, while::
3501 invoked. That is, while::
3233
3502
3234 !ls
3503 !ls
3235
3504
3236 causes ipython to simply issue system('ls'), typing::
3505 causes ipython to simply issue system('ls'), typing::
3237
3506
3238 !!ls
3507 !!ls
3239
3508
3240 is a shorthand equivalent to::
3509 is a shorthand equivalent to::
3241
3510
3242 %sx ls
3511 %sx ls
3243
3512
3244 2) %sx differs from %sc in that %sx automatically splits into a list,
3513 2) %sx differs from %sc in that %sx automatically splits into a list,
3245 like '%sc -l'. The reason for this is to make it as easy as possible
3514 like '%sc -l'. The reason for this is to make it as easy as possible
3246 to process line-oriented shell output via further python commands.
3515 to process line-oriented shell output via further python commands.
3247 %sc is meant to provide much finer control, but requires more
3516 %sc is meant to provide much finer control, but requires more
3248 typing.
3517 typing.
3249
3518
3250 3) Just like %sc -l, this is a list with special attributes:
3519 3) Just like %sc -l, this is a list with special attributes:
3251 ::
3520 ::
3252
3521
3253 .l (or .list) : value as list.
3522 .l (or .list) : value as list.
3254 .n (or .nlstr): value as newline-separated string.
3523 .n (or .nlstr): value as newline-separated string.
3255 .s (or .spstr): value as whitespace-separated string.
3524 .s (or .spstr): value as whitespace-separated string.
3256
3525
3257 This is very useful when trying to use such lists as arguments to
3526 This is very useful when trying to use such lists as arguments to
3258 system commands."""
3527 system commands."""
3259
3528
3260 if parameter_s:
3529 if parameter_s:
3261 return self.shell.getoutput(parameter_s)
3530 return self.shell.getoutput(parameter_s)
3262
3531
3263
3532
3264 def magic_bookmark(self, parameter_s=''):
3533 def magic_bookmark(self, parameter_s=''):
3265 """Manage IPython's bookmark system.
3534 """Manage IPython's bookmark system.
3266
3535
3267 %bookmark <name> - set bookmark to current dir
3536 %bookmark <name> - set bookmark to current dir
3268 %bookmark <name> <dir> - set bookmark to <dir>
3537 %bookmark <name> <dir> - set bookmark to <dir>
3269 %bookmark -l - list all bookmarks
3538 %bookmark -l - list all bookmarks
3270 %bookmark -d <name> - remove bookmark
3539 %bookmark -d <name> - remove bookmark
3271 %bookmark -r - remove all bookmarks
3540 %bookmark -r - remove all bookmarks
3272
3541
3273 You can later on access a bookmarked folder with::
3542 You can later on access a bookmarked folder with::
3274
3543
3275 %cd -b <name>
3544 %cd -b <name>
3276
3545
3277 or simply '%cd <name>' if there is no directory called <name> AND
3546 or simply '%cd <name>' if there is no directory called <name> AND
3278 there is such a bookmark defined.
3547 there is such a bookmark defined.
3279
3548
3280 Your bookmarks persist through IPython sessions, but they are
3549 Your bookmarks persist through IPython sessions, but they are
3281 associated with each profile."""
3550 associated with each profile."""
3282
3551
3283 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3552 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3284 if len(args) > 2:
3553 if len(args) > 2:
3285 raise UsageError("%bookmark: too many arguments")
3554 raise UsageError("%bookmark: too many arguments")
3286
3555
3287 bkms = self.shell.db.get('bookmarks',{})
3556 bkms = self.shell.db.get('bookmarks',{})
3288
3557
3289 if opts.has_key('d'):
3558 if opts.has_key('d'):
3290 try:
3559 try:
3291 todel = args[0]
3560 todel = args[0]
3292 except IndexError:
3561 except IndexError:
3293 raise UsageError(
3562 raise UsageError(
3294 "%bookmark -d: must provide a bookmark to delete")
3563 "%bookmark -d: must provide a bookmark to delete")
3295 else:
3564 else:
3296 try:
3565 try:
3297 del bkms[todel]
3566 del bkms[todel]
3298 except KeyError:
3567 except KeyError:
3299 raise UsageError(
3568 raise UsageError(
3300 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3569 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3301
3570
3302 elif opts.has_key('r'):
3571 elif opts.has_key('r'):
3303 bkms = {}
3572 bkms = {}
3304 elif opts.has_key('l'):
3573 elif opts.has_key('l'):
3305 bks = bkms.keys()
3574 bks = bkms.keys()
3306 bks.sort()
3575 bks.sort()
3307 if bks:
3576 if bks:
3308 size = max(map(len,bks))
3577 size = max(map(len,bks))
3309 else:
3578 else:
3310 size = 0
3579 size = 0
3311 fmt = '%-'+str(size)+'s -> %s'
3580 fmt = '%-'+str(size)+'s -> %s'
3312 print 'Current bookmarks:'
3581 print 'Current bookmarks:'
3313 for bk in bks:
3582 for bk in bks:
3314 print fmt % (bk,bkms[bk])
3583 print fmt % (bk,bkms[bk])
3315 else:
3584 else:
3316 if not args:
3585 if not args:
3317 raise UsageError("%bookmark: You must specify the bookmark name")
3586 raise UsageError("%bookmark: You must specify the bookmark name")
3318 elif len(args)==1:
3587 elif len(args)==1:
3319 bkms[args[0]] = os.getcwdu()
3588 bkms[args[0]] = os.getcwdu()
3320 elif len(args)==2:
3589 elif len(args)==2:
3321 bkms[args[0]] = args[1]
3590 bkms[args[0]] = args[1]
3322 self.shell.db['bookmarks'] = bkms
3591 self.shell.db['bookmarks'] = bkms
3323
3592
3324
3593
3325 def magic_pycat(self, parameter_s=''):
3594 def magic_pycat(self, parameter_s=''):
3326 """Show a syntax-highlighted file through a pager.
3595 """Show a syntax-highlighted file through a pager.
3327
3596
3328 This magic is similar to the cat utility, but it will assume the file
3597 This magic is similar to the cat utility, but it will assume the file
3329 to be Python source and will show it with syntax highlighting.
3598 to be Python source and will show it with syntax highlighting.
3330
3599
3331 This magic command can either take a local filename, an url,
3600 This magic command can either take a local filename, an url,
3332 an history range (see %history) or a macro as argument ::
3601 an history range (see %history) or a macro as argument ::
3333
3602
3334 %pycat myscript.py
3603 %pycat myscript.py
3335 %pycat 7-27
3604 %pycat 7-27
3336 %pycat myMacro
3605 %pycat myMacro
3337 %pycat http://www.example.com/myscript.py
3606 %pycat http://www.example.com/myscript.py
3338 """
3607 """
3339
3608
3340 try :
3609 try :
3341 cont = self.shell.find_user_code(parameter_s)
3610 cont = self.shell.find_user_code(parameter_s)
3342 except ValueError, IOError:
3611 except ValueError, IOError:
3343 print "Error: no such file, variable, URL, history range or macro"
3612 print "Error: no such file, variable, URL, history range or macro"
3344 return
3613 return
3345
3614
3346 page.page(self.shell.pycolorize(cont))
3615 page.page(self.shell.pycolorize(cont))
3347
3616
3348 def magic_quickref(self,arg):
3349 """ Show a quick reference sheet """
3350 import IPython.core.usage
3351 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3352
3617
3353 page.page(qr)
3618 class LoggingMagics(MagicFunctions):
3619 """Magics related to all logging machinery."""
3620 def magic_logstart(self,parameter_s=''):
3621 """Start logging anywhere in a session.
3354
3622
3355 def magic_doctest_mode(self,parameter_s=''):
3623 %logstart [-o|-r|-t] [log_name [log_mode]]
3356 """Toggle doctest mode on and off.
3357
3624
3358 This mode is intended to make IPython behave as much as possible like a
3625 If no name is given, it defaults to a file named 'ipython_log.py' in your
3359 plain Python shell, from the perspective of how its prompts, exceptions
3626 current directory, in 'rotate' mode (see below).
3360 and output look. This makes it easy to copy and paste parts of a
3361 session into doctests. It does so by:
3362
3627
3363 - Changing the prompts to the classic ``>>>`` ones.
3628 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
3364 - Changing the exception reporting mode to 'Plain'.
3629 history up to that point and then continues logging.
3365 - Disabling pretty-printing of output.
3366
3630
3367 Note that IPython also supports the pasting of code snippets that have
3631 %logstart takes a second optional parameter: logging mode. This can be one
3368 leading '>>>' and '...' prompts in them. This means that you can paste
3632 of (note that the modes are given unquoted):\\
3369 doctests from files or docstrings (even if they have leading
3633 append: well, that says it.\\
3370 whitespace), and the code will execute correctly. You can then use
3634 backup: rename (if exists) to name~ and start name.\\
3371 '%history -t' to see the translated history; this will give you the
3635 global: single logfile in your home dir, appended to.\\
3372 input after removal of all the leading prompts and whitespace, which
3636 over : overwrite existing log.\\
3373 can be pasted back into an editor.
3637 rotate: create rotating logs name.1~, name.2~, etc.
3374
3638
3375 With these features, you can switch into this mode easily whenever you
3639 Options:
3376 need to do testing and changes to doctests, without having to leave
3377 your existing IPython session.
3378 """
3379
3640
3380 from IPython.utils.ipstruct import Struct
3641 -o: log also IPython's output. In this mode, all commands which
3642 generate an Out[NN] prompt are recorded to the logfile, right after
3643 their corresponding input line. The output lines are always
3644 prepended with a '#[Out]# ' marker, so that the log remains valid
3645 Python code.
3381
3646
3382 # Shorthands
3647 Since this marker is always the same, filtering only the output from
3383 shell = self.shell
3648 a log is very easy, using for example a simple awk call::
3384 pm = shell.prompt_manager
3385 meta = shell.meta
3386 disp_formatter = self.shell.display_formatter
3387 ptformatter = disp_formatter.formatters['text/plain']
3388 # dstore is a data store kept in the instance metadata bag to track any
3389 # changes we make, so we can undo them later.
3390 dstore = meta.setdefault('doctest_mode',Struct())
3391 save_dstore = dstore.setdefault
3392
3649
3393 # save a few values we'll need to recover later
3650 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
3394 mode = save_dstore('mode',False)
3395 save_dstore('rc_pprint',ptformatter.pprint)
3396 save_dstore('xmode',shell.InteractiveTB.mode)
3397 save_dstore('rc_separate_out',shell.separate_out)
3398 save_dstore('rc_separate_out2',shell.separate_out2)
3399 save_dstore('rc_prompts_pad_left',pm.justify)
3400 save_dstore('rc_separate_in',shell.separate_in)
3401 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3402 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
3403
3651
3404 if mode == False:
3652 -r: log 'raw' input. Normally, IPython's logs contain the processed
3405 # turn on
3653 input, so that user lines are logged in their final form, converted
3406 pm.in_template = '>>> '
3654 into valid Python. For example, %Exit is logged as
3407 pm.in2_template = '... '
3655 _ip.magic("Exit"). If the -r flag is given, all input is logged
3408 pm.out_template = ''
3656 exactly as typed, with no transformations applied.
3409
3657
3410 # Prompt separators like plain python
3658 -t: put timestamps before each input line logged (these are put in
3411 shell.separate_in = ''
3659 comments)."""
3412 shell.separate_out = ''
3413 shell.separate_out2 = ''
3414
3660
3415 pm.justify = False
3661 opts,par = self.parse_options(parameter_s,'ort')
3662 log_output = 'o' in opts
3663 log_raw_input = 'r' in opts
3664 timestamp = 't' in opts
3416
3665
3417 ptformatter.pprint = False
3666 logger = self.shell.logger
3418 disp_formatter.plain_text_only = True
3419
3667
3420 shell.magic('xmode Plain')
3668 # if no args are given, the defaults set in the logger constructor by
3669 # ipython remain valid
3670 if par:
3671 try:
3672 logfname,logmode = par.split()
3673 except:
3674 logfname = par
3675 logmode = 'backup'
3421 else:
3676 else:
3422 # turn off
3677 logfname = logger.logfname
3423 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
3678 logmode = logger.logmode
3679 # put logfname into rc struct as if it had been called on the command
3680 # line, so it ends up saved in the log header Save it in case we need
3681 # to restore it...
3682 old_logfile = self.shell.logfile
3683 if logfname:
3684 logfname = os.path.expanduser(logfname)
3685 self.shell.logfile = logfname
3424
3686
3425 shell.separate_in = dstore.rc_separate_in
3687 loghead = '# IPython log file\n\n'
3688 try:
3689 started = logger.logstart(logfname,loghead,logmode,
3690 log_output,timestamp,log_raw_input)
3691 except:
3692 self.shell.logfile = old_logfile
3693 warn("Couldn't start log: %s" % sys.exc_info()[1])
3694 else:
3695 # log input history up to this point, optionally interleaving
3696 # output if requested
3426
3697
3427 shell.separate_out = dstore.rc_separate_out
3698 if timestamp:
3428 shell.separate_out2 = dstore.rc_separate_out2
3699 # disable timestamping for the previous history, since we've
3700 # lost those already (no time machine here).
3701 logger.timestamp = False
3429
3702
3430 pm.justify = dstore.rc_prompts_pad_left
3703 if log_raw_input:
3704 input_hist = self.shell.history_manager.input_hist_raw
3705 else:
3706 input_hist = self.shell.history_manager.input_hist_parsed
3431
3707
3432 ptformatter.pprint = dstore.rc_pprint
3708 if log_output:
3433 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3709 log_write = logger.log_write
3710 output_hist = self.shell.history_manager.output_hist
3711 for n in range(1,len(input_hist)-1):
3712 log_write(input_hist[n].rstrip() + '\n')
3713 if n in output_hist:
3714 log_write(repr(output_hist[n]),'output')
3715 else:
3716 logger.log_write('\n'.join(input_hist[1:]))
3717 logger.log_write('\n')
3718 if timestamp:
3719 # re-enable timestamping
3720 logger.timestamp = True
3434
3721
3435 shell.magic('xmode ' + dstore.xmode)
3722 print ('Activating auto-logging. '
3723 'Current session state plus future input saved.')
3724 logger.logstate()
3436
3725
3437 # Store new mode and inform
3726 def magic_logstop(self,parameter_s=''):
3438 dstore.mode = bool(1-int(mode))
3727 """Fully stop logging and close log file.
3439 mode_label = ['OFF','ON'][dstore.mode]
3440 print 'Doctest mode is:', mode_label
3441
3728
3442 def magic_gui(self, parameter_s=''):
3729 In order to start logging again, a new %logstart call needs to be made,
3443 """Enable or disable IPython GUI event loop integration.
3730 possibly (though not necessarily) with a new filename, mode and other
3731 options."""
3732 self.logger.logstop()
3444
3733
3445 %gui [GUINAME]
3734 def magic_logoff(self,parameter_s=''):
3735 """Temporarily stop logging.
3446
3736
3447 This magic replaces IPython's threaded shells that were activated
3737 You must have previously started logging."""
3448 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3738 self.shell.logger.switch_log(0)
3449 can now be enabled at runtime and keyboard
3739
3450 interrupts should work without any problems. The following toolkits
3740 def magic_logon(self,parameter_s=''):
3451 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
3741 """Restart logging.
3742
3743 This function is for restarting logging which you've temporarily
3744 stopped with %logoff. For starting logging for the first time, you
3745 must use the %logstart function, which allows you to specify an
3746 optional log filename."""
3747
3748 self.shell.logger.switch_log(1)
3452
3749
3453 %gui wx # enable wxPython event loop integration
3750 def magic_logstate(self,parameter_s=''):
3454 %gui qt4|qt # enable PyQt4 event loop integration
3751 """Print the status of the logging system."""
3455 %gui gtk # enable PyGTK event loop integration
3456 %gui gtk3 # enable Gtk3 event loop integration
3457 %gui tk # enable Tk event loop integration
3458 %gui OSX # enable Cocoa event loop integration
3459 # (requires %matplotlib 1.1)
3460 %gui # disable all event loop integration
3461
3752
3462 WARNING: after any of these has been called you can simply create
3753 self.shell.logger.logstate()
3463 an application object, but DO NOT start the event loop yourself, as
3464 we have already handled that.
3465 """
3466 opts, arg = self.parse_options(parameter_s, '')
3467 if arg=='': arg = None
3468 try:
3469 return self.enable_gui(arg)
3470 except Exception as e:
3471 # print simple error message, rather than traceback if we can't
3472 # hook up the GUI
3473 error(str(e))
3474
3754
3755 class ExtensionsMagics(MagicFunctions):
3756 """Magics to manage the IPython extensions system."""
3475 def magic_install_ext(self, parameter_s):
3757 def magic_install_ext(self, parameter_s):
3476 """Download and install an extension from a URL, e.g.::
3758 """Download and install an extension from a URL, e.g.::
3477
3759
3478 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
3760 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
3479
3761
3480 The URL should point to an importable Python module - either a .py file
3762 The URL should point to an importable Python module - either a .py file
3481 or a .zip file.
3763 or a .zip file.
3482
3764
3483 Parameters:
3765 Parameters:
3484
3766
3485 -n filename : Specify a name for the file, rather than taking it from
3767 -n filename : Specify a name for the file, rather than taking it from
3486 the URL.
3768 the URL.
3487 """
3769 """
3488 opts, args = self.parse_options(parameter_s, 'n:')
3770 opts, args = self.parse_options(parameter_s, 'n:')
3489 try:
3771 try:
3490 filename = self.shell.extension_manager.install_extension(args,
3772 filename = self.shell.extension_manager.install_extension(args,
3491 opts.get('n'))
3773 opts.get('n'))
3492 except ValueError as e:
3774 except ValueError as e:
3493 print e
3775 print e
3494 return
3776 return
3495
3777
3496 filename = os.path.basename(filename)
3778 filename = os.path.basename(filename)
3497 print "Installed %s. To use it, type:" % filename
3779 print "Installed %s. To use it, type:" % filename
3498 print " %%load_ext %s" % os.path.splitext(filename)[0]
3780 print " %%load_ext %s" % os.path.splitext(filename)[0]
3499
3781
3500
3782
3501 def magic_load_ext(self, module_str):
3783 def magic_load_ext(self, module_str):
3502 """Load an IPython extension by its module name."""
3784 """Load an IPython extension by its module name."""
3503 return self.shell.extension_manager.load_extension(module_str)
3785 return self.shell.extension_manager.load_extension(module_str)
3504
3786
3505 def magic_unload_ext(self, module_str):
3787 def magic_unload_ext(self, module_str):
3506 """Unload an IPython extension by its module name."""
3788 """Unload an IPython extension by its module name."""
3507 self.shell.extension_manager.unload_extension(module_str)
3789 self.shell.extension_manager.unload_extension(module_str)
3508
3790
3509 def magic_reload_ext(self, module_str):
3791 def magic_reload_ext(self, module_str):
3510 """Reload an IPython extension by its module name."""
3792 """Reload an IPython extension by its module name."""
3511 self.shell.extension_manager.reload_extension(module_str)
3793 self.shell.extension_manager.reload_extension(module_str)
3512
3794
3795
3796 class DeprecatedMagics(MagicFunctions):
3797 """Magics slated for later removal."""
3513 def magic_install_profiles(self, s):
3798 def magic_install_profiles(self, s):
3514 """%install_profiles has been deprecated."""
3799 """%install_profiles has been deprecated."""
3515 print '\n'.join([
3800 print '\n'.join([
3516 "%install_profiles has been deprecated.",
3801 "%install_profiles has been deprecated.",
3517 "Use `ipython profile list` to view available profiles.",
3802 "Use `ipython profile list` to view available profiles.",
3518 "Requesting a profile with `ipython profile create <name>`",
3803 "Requesting a profile with `ipython profile create <name>`",
3519 "or `ipython --profile=<name>` will start with the bundled",
3804 "or `ipython --profile=<name>` will start with the bundled",
3520 "profile of that name if it exists."
3805 "profile of that name if it exists."
3521 ])
3806 ])
3522
3807
3523 def magic_install_default_config(self, s):
3808 def magic_install_default_config(self, s):
3524 """%install_default_config has been deprecated."""
3809 """%install_default_config has been deprecated."""
3525 print '\n'.join([
3810 print '\n'.join([
3526 "%install_default_config has been deprecated.",
3811 "%install_default_config has been deprecated.",
3527 "Use `ipython profile create <name>` to initialize a profile",
3812 "Use `ipython profile create <name>` to initialize a profile",
3528 "with the default config files.",
3813 "with the default config files.",
3529 "Add `--reset` to overwrite already existing config files with defaults."
3814 "Add `--reset` to overwrite already existing config files with defaults."
3530 ])
3815 ])
3531
3816
3817
3818 class PylabMagics(MagicFunctions):
3819 """Magics related to matplotlib's pylab support"""
3820
3532 @skip_doctest
3821 @skip_doctest
3533 def magic_pylab(self, s):
3822 def magic_pylab(self, s):
3534 """Load numpy and matplotlib to work interactively.
3823 """Load numpy and matplotlib to work interactively.
3535
3824
3536 %pylab [GUINAME]
3825 %pylab [GUINAME]
3537
3826
3538 This function lets you activate pylab (matplotlib, numpy and
3827 This function lets you activate pylab (matplotlib, numpy and
3539 interactive support) at any point during an IPython session.
3828 interactive support) at any point during an IPython session.
3540
3829
3541 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3830 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3542 pylab and mlab, as well as all names from numpy and pylab.
3831 pylab and mlab, as well as all names from numpy and pylab.
3543
3832
3544 If you are using the inline matplotlib backend for embedded figures,
3833 If you are using the inline matplotlib backend for embedded figures,
3545 you can adjust its behavior via the %config magic::
3834 you can adjust its behavior via the %config magic::
3546
3835
3547 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
3836 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
3548 In [1]: %config InlineBackend.figure_format = 'svg'
3837 In [1]: %config InlineBackend.figure_format = 'svg'
3549
3838
3550 # change the behavior of closing all figures at the end of each
3839 # change the behavior of closing all figures at the end of each
3551 # execution (cell), or allowing reuse of active figures across
3840 # execution (cell), or allowing reuse of active figures across
3552 # cells:
3841 # cells:
3553 In [2]: %config InlineBackend.close_figures = False
3842 In [2]: %config InlineBackend.close_figures = False
3554
3843
3555 Parameters
3844 Parameters
3556 ----------
3845 ----------
3557 guiname : optional
3846 guiname : optional
3558 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
3847 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
3559 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
3848 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
3560 used, otherwise matplotlib's default (which you can override in your
3849 used, otherwise matplotlib's default (which you can override in your
3561 matplotlib config file) is used.
3850 matplotlib config file) is used.
3562
3851
3563 Examples
3852 Examples
3564 --------
3853 --------
3565 In this case, where the MPL default is TkAgg::
3854 In this case, where the MPL default is TkAgg::
3566
3855
3567 In [2]: %pylab
3856 In [2]: %pylab
3568
3857
3569 Welcome to pylab, a matplotlib-based Python environment.
3858 Welcome to pylab, a matplotlib-based Python environment.
3570 Backend in use: TkAgg
3859 Backend in use: TkAgg
3571 For more information, type 'help(pylab)'.
3860 For more information, type 'help(pylab)'.
3572
3861
3573 But you can explicitly request a different backend::
3862 But you can explicitly request a different backend::
3574
3863
3575 In [3]: %pylab qt
3864 In [3]: %pylab qt
3576
3865
3577 Welcome to pylab, a matplotlib-based Python environment.
3866 Welcome to pylab, a matplotlib-based Python environment.
3578 Backend in use: Qt4Agg
3867 Backend in use: Qt4Agg
3579 For more information, type 'help(pylab)'.
3868 For more information, type 'help(pylab)'.
3580 """
3869 """
3581
3870
3582 if Application.initialized():
3871 if Application.initialized():
3583 app = Application.instance()
3872 app = Application.instance()
3584 try:
3873 try:
3585 import_all_status = app.pylab_import_all
3874 import_all_status = app.pylab_import_all
3586 except AttributeError:
3875 except AttributeError:
3587 import_all_status = True
3876 import_all_status = True
3588 else:
3877 else:
3589 import_all_status = True
3878 import_all_status = True
3590
3879
3591 self.shell.enable_pylab(s, import_all=import_all_status)
3880 self.shell.enable_pylab(s, import_all=import_all_status)
3592
3593 def magic_tb(self, s):
3594 """Print the last traceback with the currently active exception mode.
3595
3596 See %xmode for changing exception reporting modes."""
3597 self.shell.showtraceback()
3598
3599 @skip_doctest
3600 def magic_precision(self, s=''):
3601 """Set floating point precision for pretty printing.
3602
3603 Can set either integer precision or a format string.
3604
3605 If numpy has been imported and precision is an int,
3606 numpy display precision will also be set, via ``numpy.set_printoptions``.
3607
3608 If no argument is given, defaults will be restored.
3609
3610 Examples
3611 --------
3612 ::
3613
3614 In [1]: from math import pi
3615
3616 In [2]: %precision 3
3617 Out[2]: u'%.3f'
3618
3619 In [3]: pi
3620 Out[3]: 3.142
3621
3622 In [4]: %precision %i
3623 Out[4]: u'%i'
3624
3625 In [5]: pi
3626 Out[5]: 3
3627
3628 In [6]: %precision %e
3629 Out[6]: u'%e'
3630
3631 In [7]: pi**10
3632 Out[7]: 9.364805e+04
3633
3634 In [8]: %precision
3635 Out[8]: u'%r'
3636
3637 In [9]: pi**10
3638 Out[9]: 93648.047476082982
3639
3640 """
3641
3642 ptformatter = self.shell.display_formatter.formatters['text/plain']
3643 ptformatter.float_precision = s
3644 return ptformatter.float_format
3645
3646
3647 @magic_arguments.magic_arguments()
3648 @magic_arguments.argument(
3649 '-e', '--export', action='store_true', default=False,
3650 help='Export IPython history as a notebook. The filename argument '
3651 'is used to specify the notebook name and format. For example '
3652 'a filename of notebook.ipynb will result in a notebook name '
3653 'of "notebook" and a format of "xml". Likewise using a ".json" '
3654 'or ".py" file extension will write the notebook in the json '
3655 'or py formats.'
3656 )
3657 @magic_arguments.argument(
3658 '-f', '--format',
3659 help='Convert an existing IPython notebook to a new format. This option '
3660 'specifies the new format and can have the values: xml, json, py. '
3661 'The target filename is chosen automatically based on the new '
3662 'format. The filename argument gives the name of the source file.'
3663 )
3664 @magic_arguments.argument(
3665 'filename', type=unicode,
3666 help='Notebook name or filename'
3667 )
3668 def magic_notebook(self, s):
3669 """Export and convert IPython notebooks.
3670
3671 This function can export the current IPython history to a notebook file
3672 or can convert an existing notebook file into a different format. For
3673 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3674 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3675 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3676 formats include (json/ipynb, py).
3677 """
3678 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3679
3680 from IPython.nbformat import current
3681 args.filename = unquote_filename(args.filename)
3682 if args.export:
3683 fname, name, format = current.parse_filename(args.filename)
3684 cells = []
3685 hist = list(self.shell.history_manager.get_range())
3686 for session, prompt_number, input in hist[:-1]:
3687 cells.append(current.new_code_cell(prompt_number=prompt_number,
3688 input=input))
3689 worksheet = current.new_worksheet(cells=cells)
3690 nb = current.new_notebook(name=name,worksheets=[worksheet])
3691 with io.open(fname, 'w', encoding='utf-8') as f:
3692 current.write(nb, f, format);
3693 elif args.format is not None:
3694 old_fname, old_name, old_format = current.parse_filename(args.filename)
3695 new_format = args.format
3696 if new_format == u'xml':
3697 raise ValueError('Notebooks cannot be written as xml.')
3698 elif new_format == u'ipynb' or new_format == u'json':
3699 new_fname = old_name + u'.ipynb'
3700 new_format = u'json'
3701 elif new_format == u'py':
3702 new_fname = old_name + u'.py'
3703 else:
3704 raise ValueError('Invalid notebook format: %s' % new_format)
3705 with io.open(old_fname, 'r', encoding='utf-8') as f:
3706 nb = current.read(f, old_format)
3707 with io.open(new_fname, 'w', encoding='utf-8') as f:
3708 current.write(nb, f, new_format)
3709
3710 def magic_config(self, s):
3711 """configure IPython
3712
3713 %config Class[.trait=value]
3714
3715 This magic exposes most of the IPython config system. Any
3716 Configurable class should be able to be configured with the simple
3717 line::
3718
3719 %config Class.trait=value
3720
3721 Where `value` will be resolved in the user's namespace, if it is an
3722 expression or variable name.
3723
3724 Examples
3725 --------
3726
3727 To see what classes are available for config, pass no arguments::
3728
3729 In [1]: %config
3730 Available objects for config:
3731 TerminalInteractiveShell
3732 HistoryManager
3733 PrefilterManager
3734 AliasManager
3735 IPCompleter
3736 PromptManager
3737 DisplayFormatter
3738
3739 To view what is configurable on a given class, just pass the class
3740 name::
3741
3742 In [2]: %config IPCompleter
3743 IPCompleter options
3744 -----------------
3745 IPCompleter.omit__names=<Enum>
3746 Current: 2
3747 Choices: (0, 1, 2)
3748 Instruct the completer to omit private method names
3749 Specifically, when completing on ``object.<tab>``.
3750 When 2 [default]: all names that start with '_' will be excluded.
3751 When 1: all 'magic' names (``__foo__``) will be excluded.
3752 When 0: nothing will be excluded.
3753 IPCompleter.merge_completions=<CBool>
3754 Current: True
3755 Whether to merge completion results into a single list
3756 If False, only the completion results from the first non-empty completer
3757 will be returned.
3758 IPCompleter.limit_to__all__=<CBool>
3759 Current: False
3760 Instruct the completer to use __all__ for the completion
3761 Specifically, when completing on ``object.<tab>``.
3762 When True: only those names in obj.__all__ will be included.
3763 When False [default]: the __all__ attribute is ignored
3764 IPCompleter.greedy=<CBool>
3765 Current: False
3766 Activate greedy completion
3767 This will enable completion on elements of lists, results of function calls,
3768 etc., but can be unsafe because the code is actually evaluated on TAB.
3769
3770 but the real use is in setting values::
3771
3772 In [3]: %config IPCompleter.greedy = True
3773
3774 and these values are read from the user_ns if they are variables::
3775
3776 In [4]: feeling_greedy=False
3777
3778 In [5]: %config IPCompleter.greedy = feeling_greedy
3779
3780 """
3781 from IPython.config.loader import Config
3782 # some IPython objects are Configurable, but do not yet have
3783 # any configurable traits. Exclude them from the effects of
3784 # this magic, as their presence is just noise:
3785 configurables = [ c for c in self.shell.configurables
3786 if c.__class__.class_traits(config=True) ]
3787 classnames = [ c.__class__.__name__ for c in configurables ]
3788
3789 line = s.strip()
3790 if not line:
3791 # print available configurable names
3792 print "Available objects for config:"
3793 for name in classnames:
3794 print " ", name
3795 return
3796 elif line in classnames:
3797 # `%config TerminalInteractiveShell` will print trait info for
3798 # TerminalInteractiveShell
3799 c = configurables[classnames.index(line)]
3800 cls = c.__class__
3801 help = cls.class_get_help(c)
3802 # strip leading '--' from cl-args:
3803 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
3804 print help
3805 return
3806 elif '=' not in line:
3807 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
3808
3809
3810 # otherwise, assume we are setting configurables.
3811 # leave quotes on args when splitting, because we want
3812 # unquoted args to eval in user_ns
3813 cfg = Config()
3814 exec "cfg."+line in locals(), self.shell.user_ns
3815
3816 for configurable in configurables:
3817 try:
3818 configurable.update_config(cfg)
3819 except Exception as e:
3820 error(e)
3821
3822 # end Magic
General Comments 0
You need to be logged in to leave comments. Login now