##// END OF EJS Templates
Move extract_input_lines to main shell object, where it belongs.
Fernando Perez -
Show More
@@ -1,2870 +1,2893 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
383
384 profile_dir = Instance('IPython.core.application.ProfileDir')
384 profile_dir = Instance('IPython.core.application.ProfileDir')
385 @property
385 @property
386 def profile(self):
386 def profile(self):
387 if self.profile_dir is not None:
387 if self.profile_dir is not None:
388 name = os.path.basename(self.profile_dir.location)
388 name = os.path.basename(self.profile_dir.location)
389 return name.replace('profile_','')
389 return name.replace('profile_','')
390
390
391
391
392 # Private interface
392 # Private interface
393 _post_execute = Instance(dict)
393 _post_execute = Instance(dict)
394
394
395 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
395 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
396 user_module=None, user_ns=None,
396 user_module=None, user_ns=None,
397 custom_exceptions=((), None)):
397 custom_exceptions=((), None)):
398
398
399 # This is where traits with a config_key argument are updated
399 # This is where traits with a config_key argument are updated
400 # from the values on config.
400 # from the values on config.
401 super(InteractiveShell, self).__init__(config=config)
401 super(InteractiveShell, self).__init__(config=config)
402 self.configurables = [self]
402 self.configurables = [self]
403
403
404 # These are relatively independent and stateless
404 # These are relatively independent and stateless
405 self.init_ipython_dir(ipython_dir)
405 self.init_ipython_dir(ipython_dir)
406 self.init_profile_dir(profile_dir)
406 self.init_profile_dir(profile_dir)
407 self.init_instance_attrs()
407 self.init_instance_attrs()
408 self.init_environment()
408 self.init_environment()
409
409
410 # Check if we're in a virtualenv, and set up sys.path.
410 # Check if we're in a virtualenv, and set up sys.path.
411 self.init_virtualenv()
411 self.init_virtualenv()
412
412
413 # Create namespaces (user_ns, user_global_ns, etc.)
413 # Create namespaces (user_ns, user_global_ns, etc.)
414 self.init_create_namespaces(user_module, user_ns)
414 self.init_create_namespaces(user_module, user_ns)
415 # This has to be done after init_create_namespaces because it uses
415 # This has to be done after init_create_namespaces because it uses
416 # something in self.user_ns, but before init_sys_modules, which
416 # something in self.user_ns, but before init_sys_modules, which
417 # is the first thing to modify sys.
417 # is the first thing to modify sys.
418 # TODO: When we override sys.stdout and sys.stderr before this class
418 # 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
419 # is created, we are saving the overridden ones here. Not sure if this
420 # is what we want to do.
420 # is what we want to do.
421 self.save_sys_module_state()
421 self.save_sys_module_state()
422 self.init_sys_modules()
422 self.init_sys_modules()
423
423
424 # While we're trying to have each part of the code directly access what
424 # 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
425 # it needs without keeping redundant references to objects, we have too
426 # much legacy code that expects ip.db to exist.
426 # much legacy code that expects ip.db to exist.
427 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
427 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
428
428
429 self.init_history()
429 self.init_history()
430 self.init_encoding()
430 self.init_encoding()
431 self.init_prefilter()
431 self.init_prefilter()
432
432
433 self._magic = Magic(self)
433 self._magic = Magic(self)
434
434
435 self.init_syntax_highlighting()
435 self.init_syntax_highlighting()
436 self.init_hooks()
436 self.init_hooks()
437 self.init_pushd_popd_magic()
437 self.init_pushd_popd_magic()
438 # self.init_traceback_handlers use to be here, but we moved it below
438 # 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.
439 # because it and init_io have to come after init_readline.
440 self.init_user_ns()
440 self.init_user_ns()
441 self.init_logger()
441 self.init_logger()
442 self.init_alias()
442 self.init_alias()
443 self.init_builtins()
443 self.init_builtins()
444
444
445 # pre_config_initialization
445 # pre_config_initialization
446
446
447 # The next section should contain everything that was in ipmaker.
447 # The next section should contain everything that was in ipmaker.
448 self.init_logstart()
448 self.init_logstart()
449
449
450 # The following was in post_config_initialization
450 # The following was in post_config_initialization
451 self.init_inspector()
451 self.init_inspector()
452 # init_readline() must come before init_io(), because init_io uses
452 # init_readline() must come before init_io(), because init_io uses
453 # readline related things.
453 # readline related things.
454 self.init_readline()
454 self.init_readline()
455 # We save this here in case user code replaces raw_input, but it needs
455 # 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
456 # to be after init_readline(), because PyPy's readline works by replacing
457 # raw_input.
457 # raw_input.
458 if py3compat.PY3:
458 if py3compat.PY3:
459 self.raw_input_original = input
459 self.raw_input_original = input
460 else:
460 else:
461 self.raw_input_original = raw_input
461 self.raw_input_original = raw_input
462 # init_completer must come after init_readline, because it needs to
462 # init_completer must come after init_readline, because it needs to
463 # know whether readline is present or not system-wide to configure the
463 # know whether readline is present or not system-wide to configure the
464 # completers, since the completion machinery can now operate
464 # completers, since the completion machinery can now operate
465 # independently of readline (e.g. over the network)
465 # independently of readline (e.g. over the network)
466 self.init_completer()
466 self.init_completer()
467 # TODO: init_io() needs to happen before init_traceback handlers
467 # TODO: init_io() needs to happen before init_traceback handlers
468 # because the traceback handlers hardcode the stdout/stderr streams.
468 # because the traceback handlers hardcode the stdout/stderr streams.
469 # This logic in in debugger.Pdb and should eventually be changed.
469 # This logic in in debugger.Pdb and should eventually be changed.
470 self.init_io()
470 self.init_io()
471 self.init_traceback_handlers(custom_exceptions)
471 self.init_traceback_handlers(custom_exceptions)
472 self.init_prompts()
472 self.init_prompts()
473 self.init_display_formatter()
473 self.init_display_formatter()
474 self.init_display_pub()
474 self.init_display_pub()
475 self.init_displayhook()
475 self.init_displayhook()
476 self.init_reload_doctest()
476 self.init_reload_doctest()
477 self.init_magics()
477 self.init_magics()
478 self.init_pdb()
478 self.init_pdb()
479 self.init_extension_manager()
479 self.init_extension_manager()
480 self.init_plugin_manager()
480 self.init_plugin_manager()
481 self.init_payload()
481 self.init_payload()
482 self.hooks.late_startup_hook()
482 self.hooks.late_startup_hook()
483 atexit.register(self.atexit_operations)
483 atexit.register(self.atexit_operations)
484
484
485 def get_ipython(self):
485 def get_ipython(self):
486 """Return the currently running IPython instance."""
486 """Return the currently running IPython instance."""
487 return self
487 return self
488
488
489 #-------------------------------------------------------------------------
489 #-------------------------------------------------------------------------
490 # Trait changed handlers
490 # Trait changed handlers
491 #-------------------------------------------------------------------------
491 #-------------------------------------------------------------------------
492
492
493 def _ipython_dir_changed(self, name, new):
493 def _ipython_dir_changed(self, name, new):
494 if not os.path.isdir(new):
494 if not os.path.isdir(new):
495 os.makedirs(new, mode = 0777)
495 os.makedirs(new, mode = 0777)
496
496
497 def set_autoindent(self,value=None):
497 def set_autoindent(self,value=None):
498 """Set the autoindent flag, checking for readline support.
498 """Set the autoindent flag, checking for readline support.
499
499
500 If called with no arguments, it acts as a toggle."""
500 If called with no arguments, it acts as a toggle."""
501
501
502 if value != 0 and not self.has_readline:
502 if value != 0 and not self.has_readline:
503 if os.name == 'posix':
503 if os.name == 'posix':
504 warn("The auto-indent feature requires the readline library")
504 warn("The auto-indent feature requires the readline library")
505 self.autoindent = 0
505 self.autoindent = 0
506 return
506 return
507 if value is None:
507 if value is None:
508 self.autoindent = not self.autoindent
508 self.autoindent = not self.autoindent
509 else:
509 else:
510 self.autoindent = value
510 self.autoindent = value
511
511
512 #-------------------------------------------------------------------------
512 #-------------------------------------------------------------------------
513 # init_* methods called by __init__
513 # init_* methods called by __init__
514 #-------------------------------------------------------------------------
514 #-------------------------------------------------------------------------
515
515
516 def init_ipython_dir(self, ipython_dir):
516 def init_ipython_dir(self, ipython_dir):
517 if ipython_dir is not None:
517 if ipython_dir is not None:
518 self.ipython_dir = ipython_dir
518 self.ipython_dir = ipython_dir
519 return
519 return
520
520
521 self.ipython_dir = get_ipython_dir()
521 self.ipython_dir = get_ipython_dir()
522
522
523 def init_profile_dir(self, profile_dir):
523 def init_profile_dir(self, profile_dir):
524 if profile_dir is not None:
524 if profile_dir is not None:
525 self.profile_dir = profile_dir
525 self.profile_dir = profile_dir
526 return
526 return
527 self.profile_dir =\
527 self.profile_dir =\
528 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
528 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
529
529
530 def init_instance_attrs(self):
530 def init_instance_attrs(self):
531 self.more = False
531 self.more = False
532
532
533 # command compiler
533 # command compiler
534 self.compile = CachingCompiler()
534 self.compile = CachingCompiler()
535
535
536 # Make an empty namespace, which extension writers can rely on both
536 # Make an empty namespace, which extension writers can rely on both
537 # existing and NEVER being used by ipython itself. This gives them a
537 # existing and NEVER being used by ipython itself. This gives them a
538 # convenient location for storing additional information and state
538 # convenient location for storing additional information and state
539 # their extensions may require, without fear of collisions with other
539 # their extensions may require, without fear of collisions with other
540 # ipython names that may develop later.
540 # ipython names that may develop later.
541 self.meta = Struct()
541 self.meta = Struct()
542
542
543 # Temporary files used for various purposes. Deleted at exit.
543 # Temporary files used for various purposes. Deleted at exit.
544 self.tempfiles = []
544 self.tempfiles = []
545
545
546 # Keep track of readline usage (later set by init_readline)
546 # Keep track of readline usage (later set by init_readline)
547 self.has_readline = False
547 self.has_readline = False
548
548
549 # keep track of where we started running (mainly for crash post-mortem)
549 # keep track of where we started running (mainly for crash post-mortem)
550 # This is not being used anywhere currently.
550 # This is not being used anywhere currently.
551 self.starting_dir = os.getcwdu()
551 self.starting_dir = os.getcwdu()
552
552
553 # Indentation management
553 # Indentation management
554 self.indent_current_nsp = 0
554 self.indent_current_nsp = 0
555
555
556 # Dict to track post-execution functions that have been registered
556 # Dict to track post-execution functions that have been registered
557 self._post_execute = {}
557 self._post_execute = {}
558
558
559 def init_environment(self):
559 def init_environment(self):
560 """Any changes we need to make to the user's environment."""
560 """Any changes we need to make to the user's environment."""
561 pass
561 pass
562
562
563 def init_encoding(self):
563 def init_encoding(self):
564 # Get system encoding at startup time. Certain terminals (like Emacs
564 # 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
565 # under Win32 have it set to None, and we need to have a known valid
566 # encoding to use in the raw_input() method
566 # encoding to use in the raw_input() method
567 try:
567 try:
568 self.stdin_encoding = sys.stdin.encoding or 'ascii'
568 self.stdin_encoding = sys.stdin.encoding or 'ascii'
569 except AttributeError:
569 except AttributeError:
570 self.stdin_encoding = 'ascii'
570 self.stdin_encoding = 'ascii'
571
571
572 def init_syntax_highlighting(self):
572 def init_syntax_highlighting(self):
573 # Python source parser/formatter for syntax highlighting
573 # Python source parser/formatter for syntax highlighting
574 pyformat = PyColorize.Parser().format
574 pyformat = PyColorize.Parser().format
575 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
575 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
576
576
577 def init_pushd_popd_magic(self):
577 def init_pushd_popd_magic(self):
578 # for pushd/popd management
578 # for pushd/popd management
579 self.home_dir = get_home_dir()
579 self.home_dir = get_home_dir()
580
580
581 self.dir_stack = []
581 self.dir_stack = []
582
582
583 def init_logger(self):
583 def init_logger(self):
584 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
584 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
585 logmode='rotate')
585 logmode='rotate')
586
586
587 def init_logstart(self):
587 def init_logstart(self):
588 """Initialize logging in case it was requested at the command line.
588 """Initialize logging in case it was requested at the command line.
589 """
589 """
590 if self.logappend:
590 if self.logappend:
591 self.magic('logstart %s append' % self.logappend)
591 self.magic('logstart %s append' % self.logappend)
592 elif self.logfile:
592 elif self.logfile:
593 self.magic('logstart %' % self.logfile)
593 self.magic('logstart %' % self.logfile)
594 elif self.logstart:
594 elif self.logstart:
595 self.magic('logstart')
595 self.magic('logstart')
596
596
597 def init_builtins(self):
597 def init_builtins(self):
598 # A single, static flag that we set to True. Its presence indicates
598 # 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
599 # 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
600 # removing on exit or representing the existence of more than one
601 # IPython at a time.
601 # IPython at a time.
602 builtin_mod.__dict__['__IPYTHON__'] = True
602 builtin_mod.__dict__['__IPYTHON__'] = True
603
603
604 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
604 # 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
605 # 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
606 # 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
607 # those who adapted their codes to check for this flag, but will
608 # eventually remove it after a few more releases.
608 # eventually remove it after a few more releases.
609 builtin_mod.__dict__['__IPYTHON__active'] = \
609 builtin_mod.__dict__['__IPYTHON__active'] = \
610 'Deprecated, check for __IPYTHON__'
610 'Deprecated, check for __IPYTHON__'
611
611
612 self.builtin_trap = BuiltinTrap(shell=self)
612 self.builtin_trap = BuiltinTrap(shell=self)
613
613
614 def init_inspector(self):
614 def init_inspector(self):
615 # Object inspector
615 # Object inspector
616 self.inspector = oinspect.Inspector(oinspect.InspectColors,
616 self.inspector = oinspect.Inspector(oinspect.InspectColors,
617 PyColorize.ANSICodeColors,
617 PyColorize.ANSICodeColors,
618 'NoColor',
618 'NoColor',
619 self.object_info_string_level)
619 self.object_info_string_level)
620
620
621 def init_io(self):
621 def init_io(self):
622 # This will just use sys.stdout and sys.stderr. If you want to
622 # 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
623 # override sys.stdout and sys.stderr themselves, you need to do that
624 # *before* instantiating this class, because io holds onto
624 # *before* instantiating this class, because io holds onto
625 # references to the underlying streams.
625 # references to the underlying streams.
626 if sys.platform == 'win32' and self.has_readline:
626 if sys.platform == 'win32' and self.has_readline:
627 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
627 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
628 else:
628 else:
629 io.stdout = io.IOStream(sys.stdout)
629 io.stdout = io.IOStream(sys.stdout)
630 io.stderr = io.IOStream(sys.stderr)
630 io.stderr = io.IOStream(sys.stderr)
631
631
632 def init_prompts(self):
632 def init_prompts(self):
633 self.prompt_manager = PromptManager(shell=self, config=self.config)
633 self.prompt_manager = PromptManager(shell=self, config=self.config)
634 self.configurables.append(self.prompt_manager)
634 self.configurables.append(self.prompt_manager)
635 # Set system prompts, so that scripts can decide if they are running
635 # Set system prompts, so that scripts can decide if they are running
636 # interactively.
636 # interactively.
637 sys.ps1 = 'In : '
637 sys.ps1 = 'In : '
638 sys.ps2 = '...: '
638 sys.ps2 = '...: '
639 sys.ps3 = 'Out: '
639 sys.ps3 = 'Out: '
640
640
641 def init_display_formatter(self):
641 def init_display_formatter(self):
642 self.display_formatter = DisplayFormatter(config=self.config)
642 self.display_formatter = DisplayFormatter(config=self.config)
643 self.configurables.append(self.display_formatter)
643 self.configurables.append(self.display_formatter)
644
644
645 def init_display_pub(self):
645 def init_display_pub(self):
646 self.display_pub = self.display_pub_class(config=self.config)
646 self.display_pub = self.display_pub_class(config=self.config)
647 self.configurables.append(self.display_pub)
647 self.configurables.append(self.display_pub)
648
648
649 def init_displayhook(self):
649 def init_displayhook(self):
650 # Initialize displayhook, set in/out prompts and printing system
650 # Initialize displayhook, set in/out prompts and printing system
651 self.displayhook = self.displayhook_class(
651 self.displayhook = self.displayhook_class(
652 config=self.config,
652 config=self.config,
653 shell=self,
653 shell=self,
654 cache_size=self.cache_size,
654 cache_size=self.cache_size,
655 )
655 )
656 self.configurables.append(self.displayhook)
656 self.configurables.append(self.displayhook)
657 # This is a context manager that installs/revmoes the displayhook at
657 # This is a context manager that installs/revmoes the displayhook at
658 # the appropriate time.
658 # the appropriate time.
659 self.display_trap = DisplayTrap(hook=self.displayhook)
659 self.display_trap = DisplayTrap(hook=self.displayhook)
660
660
661 def init_reload_doctest(self):
661 def init_reload_doctest(self):
662 # Do a proper resetting of doctest, including the necessary displayhook
662 # Do a proper resetting of doctest, including the necessary displayhook
663 # monkeypatching
663 # monkeypatching
664 try:
664 try:
665 doctest_reload()
665 doctest_reload()
666 except ImportError:
666 except ImportError:
667 warn("doctest module does not exist.")
667 warn("doctest module does not exist.")
668
668
669 def init_virtualenv(self):
669 def init_virtualenv(self):
670 """Add a virtualenv to sys.path so the user can import modules from it.
670 """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
671 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
672 virtualenv was built, and it ignores the --no-site-packages option. A
673 warning will appear suggesting the user installs IPython in the
673 warning will appear suggesting the user installs IPython in the
674 virtualenv, but for many cases, it probably works well enough.
674 virtualenv, but for many cases, it probably works well enough.
675
675
676 Adapted from code snippets online.
676 Adapted from code snippets online.
677
677
678 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
678 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
679 """
679 """
680 if 'VIRTUAL_ENV' not in os.environ:
680 if 'VIRTUAL_ENV' not in os.environ:
681 # Not in a virtualenv
681 # Not in a virtualenv
682 return
682 return
683
683
684 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
684 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
685 # Running properly in the virtualenv, don't need to do anything
685 # Running properly in the virtualenv, don't need to do anything
686 return
686 return
687
687
688 warn("Attempting to work in a virtualenv. If you encounter problems, please "
688 warn("Attempting to work in a virtualenv. If you encounter problems, please "
689 "install IPython inside the virtualenv.\n")
689 "install IPython inside the virtualenv.\n")
690 if sys.platform == "win32":
690 if sys.platform == "win32":
691 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
691 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
692 else:
692 else:
693 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
693 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
694 'python%d.%d' % sys.version_info[:2], 'site-packages')
694 'python%d.%d' % sys.version_info[:2], 'site-packages')
695
695
696 import site
696 import site
697 sys.path.insert(0, virtual_env)
697 sys.path.insert(0, virtual_env)
698 site.addsitedir(virtual_env)
698 site.addsitedir(virtual_env)
699
699
700 #-------------------------------------------------------------------------
700 #-------------------------------------------------------------------------
701 # Things related to injections into the sys module
701 # Things related to injections into the sys module
702 #-------------------------------------------------------------------------
702 #-------------------------------------------------------------------------
703
703
704 def save_sys_module_state(self):
704 def save_sys_module_state(self):
705 """Save the state of hooks in the sys module.
705 """Save the state of hooks in the sys module.
706
706
707 This has to be called after self.user_module is created.
707 This has to be called after self.user_module is created.
708 """
708 """
709 self._orig_sys_module_state = {}
709 self._orig_sys_module_state = {}
710 self._orig_sys_module_state['stdin'] = sys.stdin
710 self._orig_sys_module_state['stdin'] = sys.stdin
711 self._orig_sys_module_state['stdout'] = sys.stdout
711 self._orig_sys_module_state['stdout'] = sys.stdout
712 self._orig_sys_module_state['stderr'] = sys.stderr
712 self._orig_sys_module_state['stderr'] = sys.stderr
713 self._orig_sys_module_state['excepthook'] = sys.excepthook
713 self._orig_sys_module_state['excepthook'] = sys.excepthook
714 self._orig_sys_modules_main_name = self.user_module.__name__
714 self._orig_sys_modules_main_name = self.user_module.__name__
715 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
715 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
716
716
717 def restore_sys_module_state(self):
717 def restore_sys_module_state(self):
718 """Restore the state of the sys module."""
718 """Restore the state of the sys module."""
719 try:
719 try:
720 for k, v in self._orig_sys_module_state.iteritems():
720 for k, v in self._orig_sys_module_state.iteritems():
721 setattr(sys, k, v)
721 setattr(sys, k, v)
722 except AttributeError:
722 except AttributeError:
723 pass
723 pass
724 # Reset what what done in self.init_sys_modules
724 # Reset what what done in self.init_sys_modules
725 if self._orig_sys_modules_main_mod is not None:
725 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
726 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
727
727
728 #-------------------------------------------------------------------------
728 #-------------------------------------------------------------------------
729 # Things related to hooks
729 # Things related to hooks
730 #-------------------------------------------------------------------------
730 #-------------------------------------------------------------------------
731
731
732 def init_hooks(self):
732 def init_hooks(self):
733 # hooks holds pointers used for user-side customizations
733 # hooks holds pointers used for user-side customizations
734 self.hooks = Struct()
734 self.hooks = Struct()
735
735
736 self.strdispatchers = {}
736 self.strdispatchers = {}
737
737
738 # Set all default hooks, defined in the IPython.hooks module.
738 # Set all default hooks, defined in the IPython.hooks module.
739 hooks = IPython.core.hooks
739 hooks = IPython.core.hooks
740 for hook_name in hooks.__all__:
740 for hook_name in hooks.__all__:
741 # default hooks have priority 100, i.e. low; user hooks should have
741 # default hooks have priority 100, i.e. low; user hooks should have
742 # 0-100 priority
742 # 0-100 priority
743 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
743 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
744
744
745 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
745 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
746 """set_hook(name,hook) -> sets an internal IPython hook.
746 """set_hook(name,hook) -> sets an internal IPython hook.
747
747
748 IPython exposes some of its internal API as user-modifiable hooks. By
748 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
749 adding your function to one of these hooks, you can modify IPython's
750 behavior to call at runtime your own routines."""
750 behavior to call at runtime your own routines."""
751
751
752 # At some point in the future, this should validate the hook before it
752 # 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
753 # accepts it. Probably at least check that the hook takes the number
754 # of args it's supposed to.
754 # of args it's supposed to.
755
755
756 f = types.MethodType(hook,self)
756 f = types.MethodType(hook,self)
757
757
758 # check if the hook is for strdispatcher first
758 # check if the hook is for strdispatcher first
759 if str_key is not None:
759 if str_key is not None:
760 sdp = self.strdispatchers.get(name, StrDispatch())
760 sdp = self.strdispatchers.get(name, StrDispatch())
761 sdp.add_s(str_key, f, priority )
761 sdp.add_s(str_key, f, priority )
762 self.strdispatchers[name] = sdp
762 self.strdispatchers[name] = sdp
763 return
763 return
764 if re_key is not None:
764 if re_key is not None:
765 sdp = self.strdispatchers.get(name, StrDispatch())
765 sdp = self.strdispatchers.get(name, StrDispatch())
766 sdp.add_re(re.compile(re_key), f, priority )
766 sdp.add_re(re.compile(re_key), f, priority )
767 self.strdispatchers[name] = sdp
767 self.strdispatchers[name] = sdp
768 return
768 return
769
769
770 dp = getattr(self.hooks, name, None)
770 dp = getattr(self.hooks, name, None)
771 if name not in IPython.core.hooks.__all__:
771 if name not in IPython.core.hooks.__all__:
772 print "Warning! Hook '%s' is not one of %s" % \
772 print "Warning! Hook '%s' is not one of %s" % \
773 (name, IPython.core.hooks.__all__ )
773 (name, IPython.core.hooks.__all__ )
774 if not dp:
774 if not dp:
775 dp = IPython.core.hooks.CommandChainDispatcher()
775 dp = IPython.core.hooks.CommandChainDispatcher()
776
776
777 try:
777 try:
778 dp.add(f,priority)
778 dp.add(f,priority)
779 except AttributeError:
779 except AttributeError:
780 # it was not commandchain, plain old func - replace
780 # it was not commandchain, plain old func - replace
781 dp = f
781 dp = f
782
782
783 setattr(self.hooks,name, dp)
783 setattr(self.hooks,name, dp)
784
784
785 def register_post_execute(self, func):
785 def register_post_execute(self, func):
786 """Register a function for calling after code execution.
786 """Register a function for calling after code execution.
787 """
787 """
788 if not callable(func):
788 if not callable(func):
789 raise ValueError('argument %s must be callable' % func)
789 raise ValueError('argument %s must be callable' % func)
790 self._post_execute[func] = True
790 self._post_execute[func] = True
791
791
792 #-------------------------------------------------------------------------
792 #-------------------------------------------------------------------------
793 # Things related to the "main" module
793 # Things related to the "main" module
794 #-------------------------------------------------------------------------
794 #-------------------------------------------------------------------------
795
795
796 def new_main_mod(self,ns=None):
796 def new_main_mod(self,ns=None):
797 """Return a new 'main' module object for user code execution.
797 """Return a new 'main' module object for user code execution.
798 """
798 """
799 main_mod = self._user_main_module
799 main_mod = self._user_main_module
800 init_fakemod_dict(main_mod,ns)
800 init_fakemod_dict(main_mod,ns)
801 return main_mod
801 return main_mod
802
802
803 def cache_main_mod(self,ns,fname):
803 def cache_main_mod(self,ns,fname):
804 """Cache a main module's namespace.
804 """Cache a main module's namespace.
805
805
806 When scripts are executed via %run, we must keep a reference to the
806 When scripts are executed via %run, we must keep a reference to the
807 namespace of their __main__ module (a FakeModule instance) around so
807 namespace of their __main__ module (a FakeModule instance) around so
808 that Python doesn't clear it, rendering objects defined therein
808 that Python doesn't clear it, rendering objects defined therein
809 useless.
809 useless.
810
810
811 This method keeps said reference in a private dict, keyed by the
811 This method keeps said reference in a private dict, keyed by the
812 absolute path of the module object (which corresponds to the script
812 absolute path of the module object (which corresponds to the script
813 path). This way, for multiple executions of the same script we only
813 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
814 keep one copy of the namespace (the last one), thus preventing memory
815 leaks from old references while allowing the objects from the last
815 leaks from old references while allowing the objects from the last
816 execution to be accessible.
816 execution to be accessible.
817
817
818 Note: we can not allow the actual FakeModule instances to be deleted,
818 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
819 because of how Python tears down modules (it hard-sets all their
820 references to None without regard for reference counts). This method
820 references to None without regard for reference counts). This method
821 must therefore make a *copy* of the given namespace, to allow the
821 must therefore make a *copy* of the given namespace, to allow the
822 original module's __dict__ to be cleared and reused.
822 original module's __dict__ to be cleared and reused.
823
823
824
824
825 Parameters
825 Parameters
826 ----------
826 ----------
827 ns : a namespace (a dict, typically)
827 ns : a namespace (a dict, typically)
828
828
829 fname : str
829 fname : str
830 Filename associated with the namespace.
830 Filename associated with the namespace.
831
831
832 Examples
832 Examples
833 --------
833 --------
834
834
835 In [10]: import IPython
835 In [10]: import IPython
836
836
837 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
837 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
838
838
839 In [12]: IPython.__file__ in _ip._main_ns_cache
839 In [12]: IPython.__file__ in _ip._main_ns_cache
840 Out[12]: True
840 Out[12]: True
841 """
841 """
842 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
842 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
843
843
844 def clear_main_mod_cache(self):
844 def clear_main_mod_cache(self):
845 """Clear the cache of main modules.
845 """Clear the cache of main modules.
846
846
847 Mainly for use by utilities like %reset.
847 Mainly for use by utilities like %reset.
848
848
849 Examples
849 Examples
850 --------
850 --------
851
851
852 In [15]: import IPython
852 In [15]: import IPython
853
853
854 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
854 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
855
855
856 In [17]: len(_ip._main_ns_cache) > 0
856 In [17]: len(_ip._main_ns_cache) > 0
857 Out[17]: True
857 Out[17]: True
858
858
859 In [18]: _ip.clear_main_mod_cache()
859 In [18]: _ip.clear_main_mod_cache()
860
860
861 In [19]: len(_ip._main_ns_cache) == 0
861 In [19]: len(_ip._main_ns_cache) == 0
862 Out[19]: True
862 Out[19]: True
863 """
863 """
864 self._main_ns_cache.clear()
864 self._main_ns_cache.clear()
865
865
866 #-------------------------------------------------------------------------
866 #-------------------------------------------------------------------------
867 # Things related to debugging
867 # Things related to debugging
868 #-------------------------------------------------------------------------
868 #-------------------------------------------------------------------------
869
869
870 def init_pdb(self):
870 def init_pdb(self):
871 # Set calling of pdb on exceptions
871 # Set calling of pdb on exceptions
872 # self.call_pdb is a property
872 # self.call_pdb is a property
873 self.call_pdb = self.pdb
873 self.call_pdb = self.pdb
874
874
875 def _get_call_pdb(self):
875 def _get_call_pdb(self):
876 return self._call_pdb
876 return self._call_pdb
877
877
878 def _set_call_pdb(self,val):
878 def _set_call_pdb(self,val):
879
879
880 if val not in (0,1,False,True):
880 if val not in (0,1,False,True):
881 raise ValueError,'new call_pdb value must be boolean'
881 raise ValueError,'new call_pdb value must be boolean'
882
882
883 # store value in instance
883 # store value in instance
884 self._call_pdb = val
884 self._call_pdb = val
885
885
886 # notify the actual exception handlers
886 # notify the actual exception handlers
887 self.InteractiveTB.call_pdb = val
887 self.InteractiveTB.call_pdb = val
888
888
889 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
889 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
890 'Control auto-activation of pdb at exceptions')
890 'Control auto-activation of pdb at exceptions')
891
891
892 def debugger(self,force=False):
892 def debugger(self,force=False):
893 """Call the pydb/pdb debugger.
893 """Call the pydb/pdb debugger.
894
894
895 Keywords:
895 Keywords:
896
896
897 - force(False): by default, this routine checks the instance call_pdb
897 - 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.
898 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
899 The 'force' option forces the debugger to activate even if the flag
900 is false.
900 is false.
901 """
901 """
902
902
903 if not (force or self.call_pdb):
903 if not (force or self.call_pdb):
904 return
904 return
905
905
906 if not hasattr(sys,'last_traceback'):
906 if not hasattr(sys,'last_traceback'):
907 error('No traceback has been produced, nothing to debug.')
907 error('No traceback has been produced, nothing to debug.')
908 return
908 return
909
909
910 # use pydb if available
910 # use pydb if available
911 if debugger.has_pydb:
911 if debugger.has_pydb:
912 from pydb import pm
912 from pydb import pm
913 else:
913 else:
914 # fallback to our internal debugger
914 # fallback to our internal debugger
915 pm = lambda : self.InteractiveTB.debugger(force=True)
915 pm = lambda : self.InteractiveTB.debugger(force=True)
916
916
917 with self.readline_no_record:
917 with self.readline_no_record:
918 pm()
918 pm()
919
919
920 #-------------------------------------------------------------------------
920 #-------------------------------------------------------------------------
921 # Things related to IPython's various namespaces
921 # Things related to IPython's various namespaces
922 #-------------------------------------------------------------------------
922 #-------------------------------------------------------------------------
923 default_user_namespaces = True
923 default_user_namespaces = True
924
924
925 def init_create_namespaces(self, user_module=None, user_ns=None):
925 def init_create_namespaces(self, user_module=None, user_ns=None):
926 # Create the namespace where the user will operate. user_ns is
926 # 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
927 # 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
928 # the locals argument. But we do carry a user_global_ns namespace
929 # given as the exec 'globals' argument, This is useful in embedding
929 # given as the exec 'globals' argument, This is useful in embedding
930 # situations where the ipython shell opens in a context where the
930 # situations where the ipython shell opens in a context where the
931 # distinction between locals and globals is meaningful. For
931 # distinction between locals and globals is meaningful. For
932 # non-embedded contexts, it is just the same object as the user_ns dict.
932 # non-embedded contexts, it is just the same object as the user_ns dict.
933
933
934 # FIXME. For some strange reason, __builtins__ is showing up at user
934 # 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
935 # 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
936 # should really track down where the problem is coming from. Alex
937 # Schmolck reported this problem first.
937 # Schmolck reported this problem first.
938
938
939 # A useful post by Alex Martelli on this topic:
939 # A useful post by Alex Martelli on this topic:
940 # Re: inconsistent value from __builtins__
940 # Re: inconsistent value from __builtins__
941 # Von: Alex Martelli <aleaxit@yahoo.com>
941 # Von: Alex Martelli <aleaxit@yahoo.com>
942 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
942 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
943 # Gruppen: comp.lang.python
943 # Gruppen: comp.lang.python
944
944
945 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
945 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
946 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
946 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
947 # > <type 'dict'>
947 # > <type 'dict'>
948 # > >>> print type(__builtins__)
948 # > >>> print type(__builtins__)
949 # > <type 'module'>
949 # > <type 'module'>
950 # > Is this difference in return value intentional?
950 # > Is this difference in return value intentional?
951
951
952 # Well, it's documented that '__builtins__' can be either a dictionary
952 # 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
953 # 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
954 # 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
955 # that if you need to access the built-in namespace directly, you
956 # should start with "import __builtin__" (note, no 's') which will
956 # should start with "import __builtin__" (note, no 's') which will
957 # definitely give you a module. Yeah, it's somewhat confusing:-(.
957 # definitely give you a module. Yeah, it's somewhat confusing:-(.
958
958
959 # These routines return a properly built module and dict as needed by
959 # 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
960 # the rest of the code, and can also be used by extension writers to
961 # generate properly initialized namespaces.
961 # generate properly initialized namespaces.
962 if (user_ns is not None) or (user_module is not None):
962 if (user_ns is not None) or (user_module is not None):
963 self.default_user_namespaces = False
963 self.default_user_namespaces = False
964 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
964 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
965
965
966 # A record of hidden variables we have added to the user namespace, so
966 # 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.
967 # we can list later only variables defined in actual interactive use.
968 self.user_ns_hidden = set()
968 self.user_ns_hidden = set()
969
969
970 # Now that FakeModule produces a real module, we've run into a nasty
970 # 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
971 # 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
972 # code ran is deleted. Now that this object is a true module (needed
973 # so docetst and other tools work correctly), the Python module
973 # so docetst and other tools work correctly), the Python module
974 # teardown mechanism runs over it, and sets to None every variable
974 # teardown mechanism runs over it, and sets to None every variable
975 # present in that module. Top-level references to objects from the
975 # present in that module. Top-level references to objects from the
976 # script survive, because the user_ns is updated with them. However,
976 # script survive, because the user_ns is updated with them. However,
977 # calling functions defined in the script that use other things from
977 # calling functions defined in the script that use other things from
978 # the script will fail, because the function's closure had references
978 # 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
979 # to the original objects, which are now all None. So we must protect
980 # these modules from deletion by keeping a cache.
980 # these modules from deletion by keeping a cache.
981 #
981 #
982 # To avoid keeping stale modules around (we only need the one from the
982 # 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
983 # 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,
984 # only the last version of the module is held in the cache. Note,
985 # however, that we must cache the module *namespace contents* (their
985 # however, that we must cache the module *namespace contents* (their
986 # __dict__). Because if we try to cache the actual modules, old ones
986 # __dict__). Because if we try to cache the actual modules, old ones
987 # (uncached) could be destroyed while still holding references (such as
987 # (uncached) could be destroyed while still holding references (such as
988 # those held by GUI objects that tend to be long-lived)>
988 # those held by GUI objects that tend to be long-lived)>
989 #
989 #
990 # The %reset command will flush this cache. See the cache_main_mod()
990 # The %reset command will flush this cache. See the cache_main_mod()
991 # and clear_main_mod_cache() methods for details on use.
991 # and clear_main_mod_cache() methods for details on use.
992
992
993 # This is the cache used for 'main' namespaces
993 # This is the cache used for 'main' namespaces
994 self._main_ns_cache = {}
994 self._main_ns_cache = {}
995 # And this is the single instance of FakeModule whose __dict__ we keep
995 # And this is the single instance of FakeModule whose __dict__ we keep
996 # copying and clearing for reuse on each %run
996 # copying and clearing for reuse on each %run
997 self._user_main_module = FakeModule()
997 self._user_main_module = FakeModule()
998
998
999 # A table holding all the namespaces IPython deals with, so that
999 # A table holding all the namespaces IPython deals with, so that
1000 # introspection facilities can search easily.
1000 # introspection facilities can search easily.
1001 self.ns_table = {'user_global':self.user_module.__dict__,
1001 self.ns_table = {'user_global':self.user_module.__dict__,
1002 'user_local':self.user_ns,
1002 'user_local':self.user_ns,
1003 'builtin':builtin_mod.__dict__
1003 'builtin':builtin_mod.__dict__
1004 }
1004 }
1005
1005
1006 @property
1006 @property
1007 def user_global_ns(self):
1007 def user_global_ns(self):
1008 return self.user_module.__dict__
1008 return self.user_module.__dict__
1009
1009
1010 def prepare_user_module(self, user_module=None, user_ns=None):
1010 def prepare_user_module(self, user_module=None, user_ns=None):
1011 """Prepare the module and namespace in which user code will be run.
1011 """Prepare the module and namespace in which user code will be run.
1012
1012
1013 When IPython is started normally, both parameters are None: a new module
1013 When IPython is started normally, both parameters are None: a new module
1014 is created automatically, and its __dict__ used as the namespace.
1014 is created automatically, and its __dict__ used as the namespace.
1015
1015
1016 If only user_module is provided, its __dict__ is used as the namespace.
1016 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
1017 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
1018 becomes the global namespace. If both are provided (as they may be
1019 when embedding), user_ns is the local namespace, and user_module
1019 when embedding), user_ns is the local namespace, and user_module
1020 provides the global namespace.
1020 provides the global namespace.
1021
1021
1022 Parameters
1022 Parameters
1023 ----------
1023 ----------
1024 user_module : module, optional
1024 user_module : module, optional
1025 The current user module in which IPython is being run. If None,
1025 The current user module in which IPython is being run. If None,
1026 a clean module will be created.
1026 a clean module will be created.
1027 user_ns : dict, optional
1027 user_ns : dict, optional
1028 A namespace in which to run interactive commands.
1028 A namespace in which to run interactive commands.
1029
1029
1030 Returns
1030 Returns
1031 -------
1031 -------
1032 A tuple of user_module and user_ns, each properly initialised.
1032 A tuple of user_module and user_ns, each properly initialised.
1033 """
1033 """
1034 if user_module is None and user_ns is not None:
1034 if user_module is None and user_ns is not None:
1035 user_ns.setdefault("__name__", "__main__")
1035 user_ns.setdefault("__name__", "__main__")
1036 class DummyMod(object):
1036 class DummyMod(object):
1037 "A dummy module used for IPython's interactive namespace."
1037 "A dummy module used for IPython's interactive namespace."
1038 pass
1038 pass
1039 user_module = DummyMod()
1039 user_module = DummyMod()
1040 user_module.__dict__ = user_ns
1040 user_module.__dict__ = user_ns
1041
1041
1042 if user_module is None:
1042 if user_module is None:
1043 user_module = types.ModuleType("__main__",
1043 user_module = types.ModuleType("__main__",
1044 doc="Automatically created module for IPython interactive environment")
1044 doc="Automatically created module for IPython interactive environment")
1045
1045
1046 # We must ensure that __builtin__ (without the final 's') is always
1046 # We must ensure that __builtin__ (without the final 's') is always
1047 # available and pointing to the __builtin__ *module*. For more details:
1047 # available and pointing to the __builtin__ *module*. For more details:
1048 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1048 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1049 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1049 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1051
1051
1052 if user_ns is None:
1052 if user_ns is None:
1053 user_ns = user_module.__dict__
1053 user_ns = user_module.__dict__
1054
1054
1055 return user_module, user_ns
1055 return user_module, user_ns
1056
1056
1057 def init_sys_modules(self):
1057 def init_sys_modules(self):
1058 # We need to insert into sys.modules something that looks like a
1058 # We need to insert into sys.modules something that looks like a
1059 # module but which accesses the IPython namespace, for shelve and
1059 # module but which accesses the IPython namespace, for shelve and
1060 # pickle to work interactively. Normally they rely on getting
1060 # pickle to work interactively. Normally they rely on getting
1061 # everything out of __main__, but for embedding purposes each IPython
1061 # everything out of __main__, but for embedding purposes each IPython
1062 # instance has its own private namespace, so we can't go shoving
1062 # instance has its own private namespace, so we can't go shoving
1063 # everything into __main__.
1063 # everything into __main__.
1064
1064
1065 # note, however, that we should only do this for non-embedded
1065 # note, however, that we should only do this for non-embedded
1066 # ipythons, which really mimic the __main__.__dict__ with their own
1066 # ipythons, which really mimic the __main__.__dict__ with their own
1067 # namespace. Embedded instances, on the other hand, should not do
1067 # namespace. Embedded instances, on the other hand, should not do
1068 # this because they need to manage the user local/global namespaces
1068 # this because they need to manage the user local/global namespaces
1069 # only, but they live within a 'normal' __main__ (meaning, they
1069 # only, but they live within a 'normal' __main__ (meaning, they
1070 # shouldn't overtake the execution environment of the script they're
1070 # shouldn't overtake the execution environment of the script they're
1071 # embedded in).
1071 # embedded in).
1072
1072
1073 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1073 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1074 main_name = self.user_module.__name__
1074 main_name = self.user_module.__name__
1075 sys.modules[main_name] = self.user_module
1075 sys.modules[main_name] = self.user_module
1076
1076
1077 def init_user_ns(self):
1077 def init_user_ns(self):
1078 """Initialize all user-visible namespaces to their minimum defaults.
1078 """Initialize all user-visible namespaces to their minimum defaults.
1079
1079
1080 Certain history lists are also initialized here, as they effectively
1080 Certain history lists are also initialized here, as they effectively
1081 act as user namespaces.
1081 act as user namespaces.
1082
1082
1083 Notes
1083 Notes
1084 -----
1084 -----
1085 All data structures here are only filled in, they are NOT reset by this
1085 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
1086 method. If they were not empty before, data will simply be added to
1087 therm.
1087 therm.
1088 """
1088 """
1089 # This function works in two parts: first we put a few things in
1089 # 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
1090 # 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
1091 # 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
1092 # 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)
1093 # session (probably nothing, so theye really only see their own stuff)
1094
1094
1095 # The user dict must *always* have a __builtin__ reference to the
1095 # The user dict must *always* have a __builtin__ reference to the
1096 # Python standard __builtin__ namespace, which must be imported.
1096 # Python standard __builtin__ namespace, which must be imported.
1097 # This is so that certain operations in prompt evaluation can be
1097 # This is so that certain operations in prompt evaluation can be
1098 # reliably executed with builtins. Note that we can NOT use
1098 # reliably executed with builtins. Note that we can NOT use
1099 # __builtins__ (note the 's'), because that can either be a dict or a
1099 # __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
1100 # module, and can even mutate at runtime, depending on the context
1101 # (Python makes no guarantees on it). In contrast, __builtin__ is
1101 # (Python makes no guarantees on it). In contrast, __builtin__ is
1102 # always a module object, though it must be explicitly imported.
1102 # always a module object, though it must be explicitly imported.
1103
1103
1104 # For more details:
1104 # For more details:
1105 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1105 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1106 ns = dict()
1106 ns = dict()
1107
1107
1108 # Put 'help' in the user namespace
1108 # Put 'help' in the user namespace
1109 try:
1109 try:
1110 from site import _Helper
1110 from site import _Helper
1111 ns['help'] = _Helper()
1111 ns['help'] = _Helper()
1112 except ImportError:
1112 except ImportError:
1113 warn('help() not available - check site.py')
1113 warn('help() not available - check site.py')
1114
1114
1115 # make global variables for user access to the histories
1115 # make global variables for user access to the histories
1116 ns['_ih'] = self.history_manager.input_hist_parsed
1116 ns['_ih'] = self.history_manager.input_hist_parsed
1117 ns['_oh'] = self.history_manager.output_hist
1117 ns['_oh'] = self.history_manager.output_hist
1118 ns['_dh'] = self.history_manager.dir_hist
1118 ns['_dh'] = self.history_manager.dir_hist
1119
1119
1120 ns['_sh'] = shadowns
1120 ns['_sh'] = shadowns
1121
1121
1122 # user aliases to input and output histories. These shouldn't show up
1122 # user aliases to input and output histories. These shouldn't show up
1123 # in %who, as they can have very large reprs.
1123 # in %who, as they can have very large reprs.
1124 ns['In'] = self.history_manager.input_hist_parsed
1124 ns['In'] = self.history_manager.input_hist_parsed
1125 ns['Out'] = self.history_manager.output_hist
1125 ns['Out'] = self.history_manager.output_hist
1126
1126
1127 # Store myself as the public api!!!
1127 # Store myself as the public api!!!
1128 ns['get_ipython'] = self.get_ipython
1128 ns['get_ipython'] = self.get_ipython
1129
1129
1130 ns['exit'] = self.exiter
1130 ns['exit'] = self.exiter
1131 ns['quit'] = self.exiter
1131 ns['quit'] = self.exiter
1132
1132
1133 # Sync what we've added so far to user_ns_hidden so these aren't seen
1133 # Sync what we've added so far to user_ns_hidden so these aren't seen
1134 # by %who
1134 # by %who
1135 self.user_ns_hidden.update(ns)
1135 self.user_ns_hidden.update(ns)
1136
1136
1137 # Anything put into ns now would show up in %who. Think twice before
1137 # 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
1138 # putting anything here, as we really want %who to show the user their
1139 # stuff, not our variables.
1139 # stuff, not our variables.
1140
1140
1141 # Finally, update the real user's namespace
1141 # Finally, update the real user's namespace
1142 self.user_ns.update(ns)
1142 self.user_ns.update(ns)
1143
1143
1144 @property
1144 @property
1145 def all_ns_refs(self):
1145 def all_ns_refs(self):
1146 """Get a list of references to all the namespace dictionaries in which
1146 """Get a list of references to all the namespace dictionaries in which
1147 IPython might store a user-created object.
1147 IPython might store a user-created object.
1148
1148
1149 Note that this does not include the displayhook, which also caches
1149 Note that this does not include the displayhook, which also caches
1150 objects from the output."""
1150 objects from the output."""
1151 return [self.user_ns, self.user_global_ns,
1151 return [self.user_ns, self.user_global_ns,
1152 self._user_main_module.__dict__] + self._main_ns_cache.values()
1152 self._user_main_module.__dict__] + self._main_ns_cache.values()
1153
1153
1154 def reset(self, new_session=True):
1154 def reset(self, new_session=True):
1155 """Clear all internal namespaces, and attempt to release references to
1155 """Clear all internal namespaces, and attempt to release references to
1156 user objects.
1156 user objects.
1157
1157
1158 If new_session is True, a new history session will be opened.
1158 If new_session is True, a new history session will be opened.
1159 """
1159 """
1160 # Clear histories
1160 # Clear histories
1161 self.history_manager.reset(new_session)
1161 self.history_manager.reset(new_session)
1162 # Reset counter used to index all histories
1162 # Reset counter used to index all histories
1163 if new_session:
1163 if new_session:
1164 self.execution_count = 1
1164 self.execution_count = 1
1165
1165
1166 # Flush cached output items
1166 # Flush cached output items
1167 if self.displayhook.do_full_cache:
1167 if self.displayhook.do_full_cache:
1168 self.displayhook.flush()
1168 self.displayhook.flush()
1169
1169
1170 # The main execution namespaces must be cleared very carefully,
1170 # The main execution namespaces must be cleared very carefully,
1171 # skipping the deletion of the builtin-related keys, because doing so
1171 # skipping the deletion of the builtin-related keys, because doing so
1172 # would cause errors in many object's __del__ methods.
1172 # would cause errors in many object's __del__ methods.
1173 if self.user_ns is not self.user_global_ns:
1173 if self.user_ns is not self.user_global_ns:
1174 self.user_ns.clear()
1174 self.user_ns.clear()
1175 ns = self.user_global_ns
1175 ns = self.user_global_ns
1176 drop_keys = set(ns.keys())
1176 drop_keys = set(ns.keys())
1177 drop_keys.discard('__builtin__')
1177 drop_keys.discard('__builtin__')
1178 drop_keys.discard('__builtins__')
1178 drop_keys.discard('__builtins__')
1179 drop_keys.discard('__name__')
1179 drop_keys.discard('__name__')
1180 for k in drop_keys:
1180 for k in drop_keys:
1181 del ns[k]
1181 del ns[k]
1182
1182
1183 self.user_ns_hidden.clear()
1183 self.user_ns_hidden.clear()
1184
1184
1185 # Restore the user namespaces to minimal usability
1185 # Restore the user namespaces to minimal usability
1186 self.init_user_ns()
1186 self.init_user_ns()
1187
1187
1188 # Restore the default and user aliases
1188 # Restore the default and user aliases
1189 self.alias_manager.clear_aliases()
1189 self.alias_manager.clear_aliases()
1190 self.alias_manager.init_aliases()
1190 self.alias_manager.init_aliases()
1191
1191
1192 # Flush the private list of module references kept for script
1192 # Flush the private list of module references kept for script
1193 # execution protection
1193 # execution protection
1194 self.clear_main_mod_cache()
1194 self.clear_main_mod_cache()
1195
1195
1196 # Clear out the namespace from the last %run
1196 # Clear out the namespace from the last %run
1197 self.new_main_mod()
1197 self.new_main_mod()
1198
1198
1199 def del_var(self, varname, by_name=False):
1199 def del_var(self, varname, by_name=False):
1200 """Delete a variable from the various namespaces, so that, as
1200 """Delete a variable from the various namespaces, so that, as
1201 far as possible, we're not keeping any hidden references to it.
1201 far as possible, we're not keeping any hidden references to it.
1202
1202
1203 Parameters
1203 Parameters
1204 ----------
1204 ----------
1205 varname : str
1205 varname : str
1206 The name of the variable to delete.
1206 The name of the variable to delete.
1207 by_name : bool
1207 by_name : bool
1208 If True, delete variables with the given name in each
1208 If True, delete variables with the given name in each
1209 namespace. If False (default), find the variable in the user
1209 namespace. If False (default), find the variable in the user
1210 namespace, and delete references to it.
1210 namespace, and delete references to it.
1211 """
1211 """
1212 if varname in ('__builtin__', '__builtins__'):
1212 if varname in ('__builtin__', '__builtins__'):
1213 raise ValueError("Refusing to delete %s" % varname)
1213 raise ValueError("Refusing to delete %s" % varname)
1214
1214
1215 ns_refs = self.all_ns_refs
1215 ns_refs = self.all_ns_refs
1216
1216
1217 if by_name: # Delete by name
1217 if by_name: # Delete by name
1218 for ns in ns_refs:
1218 for ns in ns_refs:
1219 try:
1219 try:
1220 del ns[varname]
1220 del ns[varname]
1221 except KeyError:
1221 except KeyError:
1222 pass
1222 pass
1223 else: # Delete by object
1223 else: # Delete by object
1224 try:
1224 try:
1225 obj = self.user_ns[varname]
1225 obj = self.user_ns[varname]
1226 except KeyError:
1226 except KeyError:
1227 raise NameError("name '%s' is not defined" % varname)
1227 raise NameError("name '%s' is not defined" % varname)
1228 # Also check in output history
1228 # Also check in output history
1229 ns_refs.append(self.history_manager.output_hist)
1229 ns_refs.append(self.history_manager.output_hist)
1230 for ns in ns_refs:
1230 for ns in ns_refs:
1231 to_delete = [n for n, o in ns.iteritems() if o is obj]
1231 to_delete = [n for n, o in ns.iteritems() if o is obj]
1232 for name in to_delete:
1232 for name in to_delete:
1233 del ns[name]
1233 del ns[name]
1234
1234
1235 # displayhook keeps extra references, but not in a dictionary
1235 # displayhook keeps extra references, but not in a dictionary
1236 for name in ('_', '__', '___'):
1236 for name in ('_', '__', '___'):
1237 if getattr(self.displayhook, name) is obj:
1237 if getattr(self.displayhook, name) is obj:
1238 setattr(self.displayhook, name, None)
1238 setattr(self.displayhook, name, None)
1239
1239
1240 def reset_selective(self, regex=None):
1240 def reset_selective(self, regex=None):
1241 """Clear selective variables from internal namespaces based on a
1241 """Clear selective variables from internal namespaces based on a
1242 specified regular expression.
1242 specified regular expression.
1243
1243
1244 Parameters
1244 Parameters
1245 ----------
1245 ----------
1246 regex : string or compiled pattern, optional
1246 regex : string or compiled pattern, optional
1247 A regular expression pattern that will be used in searching
1247 A regular expression pattern that will be used in searching
1248 variable names in the users namespaces.
1248 variable names in the users namespaces.
1249 """
1249 """
1250 if regex is not None:
1250 if regex is not None:
1251 try:
1251 try:
1252 m = re.compile(regex)
1252 m = re.compile(regex)
1253 except TypeError:
1253 except TypeError:
1254 raise TypeError('regex must be a string or compiled pattern')
1254 raise TypeError('regex must be a string or compiled pattern')
1255 # Search for keys in each namespace that match the given regex
1255 # Search for keys in each namespace that match the given regex
1256 # If a match is found, delete the key/value pair.
1256 # If a match is found, delete the key/value pair.
1257 for ns in self.all_ns_refs:
1257 for ns in self.all_ns_refs:
1258 for var in ns:
1258 for var in ns:
1259 if m.search(var):
1259 if m.search(var):
1260 del ns[var]
1260 del ns[var]
1261
1261
1262 def push(self, variables, interactive=True):
1262 def push(self, variables, interactive=True):
1263 """Inject a group of variables into the IPython user namespace.
1263 """Inject a group of variables into the IPython user namespace.
1264
1264
1265 Parameters
1265 Parameters
1266 ----------
1266 ----------
1267 variables : dict, str or list/tuple of str
1267 variables : dict, str or list/tuple of str
1268 The variables to inject into the user's namespace. If a dict, a
1268 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
1269 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
1270 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
1271 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
1272 give (list/tuple/str) then the variable values looked up in the
1273 callers frame.
1273 callers frame.
1274 interactive : bool
1274 interactive : bool
1275 If True (default), the variables will be listed with the ``who``
1275 If True (default), the variables will be listed with the ``who``
1276 magic.
1276 magic.
1277 """
1277 """
1278 vdict = None
1278 vdict = None
1279
1279
1280 # We need a dict of name/value pairs to do namespace updates.
1280 # We need a dict of name/value pairs to do namespace updates.
1281 if isinstance(variables, dict):
1281 if isinstance(variables, dict):
1282 vdict = variables
1282 vdict = variables
1283 elif isinstance(variables, (basestring, list, tuple)):
1283 elif isinstance(variables, (basestring, list, tuple)):
1284 if isinstance(variables, basestring):
1284 if isinstance(variables, basestring):
1285 vlist = variables.split()
1285 vlist = variables.split()
1286 else:
1286 else:
1287 vlist = variables
1287 vlist = variables
1288 vdict = {}
1288 vdict = {}
1289 cf = sys._getframe(1)
1289 cf = sys._getframe(1)
1290 for name in vlist:
1290 for name in vlist:
1291 try:
1291 try:
1292 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1292 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1293 except:
1293 except:
1294 print ('Could not get variable %s from %s' %
1294 print ('Could not get variable %s from %s' %
1295 (name,cf.f_code.co_name))
1295 (name,cf.f_code.co_name))
1296 else:
1296 else:
1297 raise ValueError('variables must be a dict/str/list/tuple')
1297 raise ValueError('variables must be a dict/str/list/tuple')
1298
1298
1299 # Propagate variables to user namespace
1299 # Propagate variables to user namespace
1300 self.user_ns.update(vdict)
1300 self.user_ns.update(vdict)
1301
1301
1302 # And configure interactive visibility
1302 # And configure interactive visibility
1303 user_ns_hidden = self.user_ns_hidden
1303 user_ns_hidden = self.user_ns_hidden
1304 if interactive:
1304 if interactive:
1305 user_ns_hidden.difference_update(vdict)
1305 user_ns_hidden.difference_update(vdict)
1306 else:
1306 else:
1307 user_ns_hidden.update(vdict)
1307 user_ns_hidden.update(vdict)
1308
1308
1309 def drop_by_id(self, variables):
1309 def drop_by_id(self, variables):
1310 """Remove a dict of variables from the user namespace, if they are the
1310 """Remove a dict of variables from the user namespace, if they are the
1311 same as the values in the dictionary.
1311 same as the values in the dictionary.
1312
1312
1313 This is intended for use by extensions: variables that they've added can
1313 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
1314 be taken back out if they are unloaded, without removing any that the
1315 user has overwritten.
1315 user has overwritten.
1316
1316
1317 Parameters
1317 Parameters
1318 ----------
1318 ----------
1319 variables : dict
1319 variables : dict
1320 A dictionary mapping object names (as strings) to the objects.
1320 A dictionary mapping object names (as strings) to the objects.
1321 """
1321 """
1322 for name, obj in variables.iteritems():
1322 for name, obj in variables.iteritems():
1323 if name in self.user_ns and self.user_ns[name] is obj:
1323 if name in self.user_ns and self.user_ns[name] is obj:
1324 del self.user_ns[name]
1324 del self.user_ns[name]
1325 self.user_ns_hidden.discard(name)
1325 self.user_ns_hidden.discard(name)
1326
1326
1327 #-------------------------------------------------------------------------
1327 #-------------------------------------------------------------------------
1328 # Things related to object introspection
1328 # Things related to object introspection
1329 #-------------------------------------------------------------------------
1329 #-------------------------------------------------------------------------
1330
1330
1331 def _ofind(self, oname, namespaces=None):
1331 def _ofind(self, oname, namespaces=None):
1332 """Find an object in the available namespaces.
1332 """Find an object in the available namespaces.
1333
1333
1334 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1334 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1335
1335
1336 Has special code to detect magic functions.
1336 Has special code to detect magic functions.
1337 """
1337 """
1338 oname = oname.strip()
1338 oname = oname.strip()
1339 #print '1- oname: <%r>' % oname # dbg
1339 #print '1- oname: <%r>' % oname # dbg
1340 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1340 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1341 return dict(found=False)
1341 return dict(found=False)
1342
1342
1343 alias_ns = None
1343 alias_ns = None
1344 if namespaces is None:
1344 if namespaces is None:
1345 # Namespaces to search in:
1345 # Namespaces to search in:
1346 # Put them in a list. The order is important so that we
1346 # Put them in a list. The order is important so that we
1347 # find things in the same order that Python finds them.
1347 # find things in the same order that Python finds them.
1348 namespaces = [ ('Interactive', self.user_ns),
1348 namespaces = [ ('Interactive', self.user_ns),
1349 ('Interactive (global)', self.user_global_ns),
1349 ('Interactive (global)', self.user_global_ns),
1350 ('Python builtin', builtin_mod.__dict__),
1350 ('Python builtin', builtin_mod.__dict__),
1351 ('Alias', self.alias_manager.alias_table),
1351 ('Alias', self.alias_manager.alias_table),
1352 ]
1352 ]
1353 alias_ns = self.alias_manager.alias_table
1353 alias_ns = self.alias_manager.alias_table
1354
1354
1355 # initialize results to 'null'
1355 # initialize results to 'null'
1356 found = False; obj = None; ospace = None; ds = None;
1356 found = False; obj = None; ospace = None; ds = None;
1357 ismagic = False; isalias = False; parent = None
1357 ismagic = False; isalias = False; parent = None
1358
1358
1359 # We need to special-case 'print', which as of python2.6 registers as a
1359 # 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
1360 # function but should only be treated as one if print_function was
1361 # loaded with a future import. In this case, just bail.
1361 # loaded with a future import. In this case, just bail.
1362 if (oname == 'print' and not py3compat.PY3 and not \
1362 if (oname == 'print' and not py3compat.PY3 and not \
1363 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1363 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1364 return {'found':found, 'obj':obj, 'namespace':ospace,
1364 return {'found':found, 'obj':obj, 'namespace':ospace,
1365 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1365 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1366
1366
1367 # Look for the given name by splitting it in parts. If the head is
1367 # 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
1368 # found, then we look for all the remaining parts as members, and only
1369 # declare success if we can find them all.
1369 # declare success if we can find them all.
1370 oname_parts = oname.split('.')
1370 oname_parts = oname.split('.')
1371 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1371 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1372 for nsname,ns in namespaces:
1372 for nsname,ns in namespaces:
1373 try:
1373 try:
1374 obj = ns[oname_head]
1374 obj = ns[oname_head]
1375 except KeyError:
1375 except KeyError:
1376 continue
1376 continue
1377 else:
1377 else:
1378 #print 'oname_rest:', oname_rest # dbg
1378 #print 'oname_rest:', oname_rest # dbg
1379 for part in oname_rest:
1379 for part in oname_rest:
1380 try:
1380 try:
1381 parent = obj
1381 parent = obj
1382 obj = getattr(obj,part)
1382 obj = getattr(obj,part)
1383 except:
1383 except:
1384 # Blanket except b/c some badly implemented objects
1384 # Blanket except b/c some badly implemented objects
1385 # allow __getattr__ to raise exceptions other than
1385 # allow __getattr__ to raise exceptions other than
1386 # AttributeError, which then crashes IPython.
1386 # AttributeError, which then crashes IPython.
1387 break
1387 break
1388 else:
1388 else:
1389 # If we finish the for loop (no break), we got all members
1389 # If we finish the for loop (no break), we got all members
1390 found = True
1390 found = True
1391 ospace = nsname
1391 ospace = nsname
1392 if ns == alias_ns:
1392 if ns == alias_ns:
1393 isalias = True
1393 isalias = True
1394 break # namespace loop
1394 break # namespace loop
1395
1395
1396 # Try to see if it's magic
1396 # Try to see if it's magic
1397 if not found:
1397 if not found:
1398 if oname.startswith(ESC_MAGIC):
1398 if oname.startswith(ESC_MAGIC):
1399 oname = oname[1:]
1399 oname = oname[1:]
1400 obj = self.find_magic(oname)
1400 obj = self.find_magic(oname)
1401 if obj is not None:
1401 if obj is not None:
1402 found = True
1402 found = True
1403 ospace = 'IPython internal'
1403 ospace = 'IPython internal'
1404 ismagic = True
1404 ismagic = True
1405
1405
1406 # Last try: special-case some literals like '', [], {}, etc:
1406 # Last try: special-case some literals like '', [], {}, etc:
1407 if not found and oname_head in ["''",'""','[]','{}','()']:
1407 if not found and oname_head in ["''",'""','[]','{}','()']:
1408 obj = eval(oname_head)
1408 obj = eval(oname_head)
1409 found = True
1409 found = True
1410 ospace = 'Interactive'
1410 ospace = 'Interactive'
1411
1411
1412 return {'found':found, 'obj':obj, 'namespace':ospace,
1412 return {'found':found, 'obj':obj, 'namespace':ospace,
1413 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1413 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1414
1414
1415 def _ofind_property(self, oname, info):
1415 def _ofind_property(self, oname, info):
1416 """Second part of object finding, to look for property details."""
1416 """Second part of object finding, to look for property details."""
1417 if info.found:
1417 if info.found:
1418 # Get the docstring of the class property if it exists.
1418 # Get the docstring of the class property if it exists.
1419 path = oname.split('.')
1419 path = oname.split('.')
1420 root = '.'.join(path[:-1])
1420 root = '.'.join(path[:-1])
1421 if info.parent is not None:
1421 if info.parent is not None:
1422 try:
1422 try:
1423 target = getattr(info.parent, '__class__')
1423 target = getattr(info.parent, '__class__')
1424 # The object belongs to a class instance.
1424 # The object belongs to a class instance.
1425 try:
1425 try:
1426 target = getattr(target, path[-1])
1426 target = getattr(target, path[-1])
1427 # The class defines the object.
1427 # The class defines the object.
1428 if isinstance(target, property):
1428 if isinstance(target, property):
1429 oname = root + '.__class__.' + path[-1]
1429 oname = root + '.__class__.' + path[-1]
1430 info = Struct(self._ofind(oname))
1430 info = Struct(self._ofind(oname))
1431 except AttributeError: pass
1431 except AttributeError: pass
1432 except AttributeError: pass
1432 except AttributeError: pass
1433
1433
1434 # We return either the new info or the unmodified input if the object
1434 # We return either the new info or the unmodified input if the object
1435 # hadn't been found
1435 # hadn't been found
1436 return info
1436 return info
1437
1437
1438 def _object_find(self, oname, namespaces=None):
1438 def _object_find(self, oname, namespaces=None):
1439 """Find an object and return a struct with info about it."""
1439 """Find an object and return a struct with info about it."""
1440 inf = Struct(self._ofind(oname, namespaces))
1440 inf = Struct(self._ofind(oname, namespaces))
1441 return Struct(self._ofind_property(oname, inf))
1441 return Struct(self._ofind_property(oname, inf))
1442
1442
1443 def _inspect(self, meth, oname, namespaces=None, **kw):
1443 def _inspect(self, meth, oname, namespaces=None, **kw):
1444 """Generic interface to the inspector system.
1444 """Generic interface to the inspector system.
1445
1445
1446 This function is meant to be called by pdef, pdoc & friends."""
1446 This function is meant to be called by pdef, pdoc & friends."""
1447 info = self._object_find(oname)
1447 info = self._object_find(oname)
1448 if info.found:
1448 if info.found:
1449 pmethod = getattr(self.inspector, meth)
1449 pmethod = getattr(self.inspector, meth)
1450 formatter = format_screen if info.ismagic else None
1450 formatter = format_screen if info.ismagic else None
1451 if meth == 'pdoc':
1451 if meth == 'pdoc':
1452 pmethod(info.obj, oname, formatter)
1452 pmethod(info.obj, oname, formatter)
1453 elif meth == 'pinfo':
1453 elif meth == 'pinfo':
1454 pmethod(info.obj, oname, formatter, info, **kw)
1454 pmethod(info.obj, oname, formatter, info, **kw)
1455 else:
1455 else:
1456 pmethod(info.obj, oname)
1456 pmethod(info.obj, oname)
1457 else:
1457 else:
1458 print 'Object `%s` not found.' % oname
1458 print 'Object `%s` not found.' % oname
1459 return 'not found' # so callers can take other action
1459 return 'not found' # so callers can take other action
1460
1460
1461 def object_inspect(self, oname, detail_level=0):
1461 def object_inspect(self, oname, detail_level=0):
1462 with self.builtin_trap:
1462 with self.builtin_trap:
1463 info = self._object_find(oname)
1463 info = self._object_find(oname)
1464 if info.found:
1464 if info.found:
1465 return self.inspector.info(info.obj, oname, info=info,
1465 return self.inspector.info(info.obj, oname, info=info,
1466 detail_level=detail_level
1466 detail_level=detail_level
1467 )
1467 )
1468 else:
1468 else:
1469 return oinspect.object_info(name=oname, found=False)
1469 return oinspect.object_info(name=oname, found=False)
1470
1470
1471 #-------------------------------------------------------------------------
1471 #-------------------------------------------------------------------------
1472 # Things related to history management
1472 # Things related to history management
1473 #-------------------------------------------------------------------------
1473 #-------------------------------------------------------------------------
1474
1474
1475 def init_history(self):
1475 def init_history(self):
1476 """Sets up the command history, and starts regular autosaves."""
1476 """Sets up the command history, and starts regular autosaves."""
1477 self.history_manager = HistoryManager(shell=self, config=self.config)
1477 self.history_manager = HistoryManager(shell=self, config=self.config)
1478 self.configurables.append(self.history_manager)
1478 self.configurables.append(self.history_manager)
1479
1479
1480 #-------------------------------------------------------------------------
1480 #-------------------------------------------------------------------------
1481 # Things related to exception handling and tracebacks (not debugging)
1481 # Things related to exception handling and tracebacks (not debugging)
1482 #-------------------------------------------------------------------------
1482 #-------------------------------------------------------------------------
1483
1483
1484 def init_traceback_handlers(self, custom_exceptions):
1484 def init_traceback_handlers(self, custom_exceptions):
1485 # Syntax error handler.
1485 # Syntax error handler.
1486 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1486 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1487
1487
1488 # The interactive one is initialized with an offset, meaning we always
1488 # 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
1489 # want to remove the topmost item in the traceback, which is our own
1490 # internal code. Valid modes: ['Plain','Context','Verbose']
1490 # internal code. Valid modes: ['Plain','Context','Verbose']
1491 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1491 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1492 color_scheme='NoColor',
1492 color_scheme='NoColor',
1493 tb_offset = 1,
1493 tb_offset = 1,
1494 check_cache=self.compile.check_cache)
1494 check_cache=self.compile.check_cache)
1495
1495
1496 # The instance will store a pointer to the system-wide exception hook,
1496 # 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
1497 # so that runtime code (such as magics) can access it. This is because
1498 # during the read-eval loop, it may get temporarily overwritten.
1498 # during the read-eval loop, it may get temporarily overwritten.
1499 self.sys_excepthook = sys.excepthook
1499 self.sys_excepthook = sys.excepthook
1500
1500
1501 # and add any custom exception handlers the user may have specified
1501 # and add any custom exception handlers the user may have specified
1502 self.set_custom_exc(*custom_exceptions)
1502 self.set_custom_exc(*custom_exceptions)
1503
1503
1504 # Set the exception mode
1504 # Set the exception mode
1505 self.InteractiveTB.set_mode(mode=self.xmode)
1505 self.InteractiveTB.set_mode(mode=self.xmode)
1506
1506
1507 def set_custom_exc(self, exc_tuple, handler):
1507 def set_custom_exc(self, exc_tuple, handler):
1508 """set_custom_exc(exc_tuple,handler)
1508 """set_custom_exc(exc_tuple,handler)
1509
1509
1510 Set a custom exception handler, which will be called if any of the
1510 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
1511 exceptions in exc_tuple occur in the mainloop (specifically, in the
1512 run_code() method).
1512 run_code() method).
1513
1513
1514 Parameters
1514 Parameters
1515 ----------
1515 ----------
1516
1516
1517 exc_tuple : tuple of exception classes
1517 exc_tuple : tuple of exception classes
1518 A *tuple* of exception classes, for which to call the defined
1518 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
1519 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
1520 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::
1521 you only want to trap a single exception, use a singleton tuple::
1522
1522
1523 exc_tuple == (MyCustomException,)
1523 exc_tuple == (MyCustomException,)
1524
1524
1525 handler : callable
1525 handler : callable
1526 handler must have the following signature::
1526 handler must have the following signature::
1527
1527
1528 def my_handler(self, etype, value, tb, tb_offset=None):
1528 def my_handler(self, etype, value, tb, tb_offset=None):
1529 ...
1529 ...
1530 return structured_traceback
1530 return structured_traceback
1531
1531
1532 Your handler must return a structured traceback (a list of strings),
1532 Your handler must return a structured traceback (a list of strings),
1533 or None.
1533 or None.
1534
1534
1535 This will be made into an instance method (via types.MethodType)
1535 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
1536 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
1537 listed in the exc_tuple are caught. If the handler is None, an
1538 internal basic one is used, which just prints basic info.
1538 internal basic one is used, which just prints basic info.
1539
1539
1540 To protect IPython from crashes, if your handler ever raises an
1540 To protect IPython from crashes, if your handler ever raises an
1541 exception or returns an invalid result, it will be immediately
1541 exception or returns an invalid result, it will be immediately
1542 disabled.
1542 disabled.
1543
1543
1544 WARNING: by putting in your own exception handler into IPython's main
1544 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
1545 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."""
1546 facility should only be used if you really know what you are doing."""
1547
1547
1548 assert type(exc_tuple)==type(()) , \
1548 assert type(exc_tuple)==type(()) , \
1549 "The custom exceptions must be given AS A TUPLE."
1549 "The custom exceptions must be given AS A TUPLE."
1550
1550
1551 def dummy_handler(self,etype,value,tb,tb_offset=None):
1551 def dummy_handler(self,etype,value,tb,tb_offset=None):
1552 print '*** Simple custom exception handler ***'
1552 print '*** Simple custom exception handler ***'
1553 print 'Exception type :',etype
1553 print 'Exception type :',etype
1554 print 'Exception value:',value
1554 print 'Exception value:',value
1555 print 'Traceback :',tb
1555 print 'Traceback :',tb
1556 #print 'Source code :','\n'.join(self.buffer)
1556 #print 'Source code :','\n'.join(self.buffer)
1557
1557
1558 def validate_stb(stb):
1558 def validate_stb(stb):
1559 """validate structured traceback return type
1559 """validate structured traceback return type
1560
1560
1561 return type of CustomTB *should* be a list of strings, but allow
1561 return type of CustomTB *should* be a list of strings, but allow
1562 single strings or None, which are harmless.
1562 single strings or None, which are harmless.
1563
1563
1564 This function will *always* return a list of strings,
1564 This function will *always* return a list of strings,
1565 and will raise a TypeError if stb is inappropriate.
1565 and will raise a TypeError if stb is inappropriate.
1566 """
1566 """
1567 msg = "CustomTB must return list of strings, not %r" % stb
1567 msg = "CustomTB must return list of strings, not %r" % stb
1568 if stb is None:
1568 if stb is None:
1569 return []
1569 return []
1570 elif isinstance(stb, basestring):
1570 elif isinstance(stb, basestring):
1571 return [stb]
1571 return [stb]
1572 elif not isinstance(stb, list):
1572 elif not isinstance(stb, list):
1573 raise TypeError(msg)
1573 raise TypeError(msg)
1574 # it's a list
1574 # it's a list
1575 for line in stb:
1575 for line in stb:
1576 # check every element
1576 # check every element
1577 if not isinstance(line, basestring):
1577 if not isinstance(line, basestring):
1578 raise TypeError(msg)
1578 raise TypeError(msg)
1579 return stb
1579 return stb
1580
1580
1581 if handler is None:
1581 if handler is None:
1582 wrapped = dummy_handler
1582 wrapped = dummy_handler
1583 else:
1583 else:
1584 def wrapped(self,etype,value,tb,tb_offset=None):
1584 def wrapped(self,etype,value,tb,tb_offset=None):
1585 """wrap CustomTB handler, to protect IPython from user code
1585 """wrap CustomTB handler, to protect IPython from user code
1586
1586
1587 This makes it harder (but not impossible) for custom exception
1587 This makes it harder (but not impossible) for custom exception
1588 handlers to crash IPython.
1588 handlers to crash IPython.
1589 """
1589 """
1590 try:
1590 try:
1591 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1591 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1592 return validate_stb(stb)
1592 return validate_stb(stb)
1593 except:
1593 except:
1594 # clear custom handler immediately
1594 # clear custom handler immediately
1595 self.set_custom_exc((), None)
1595 self.set_custom_exc((), None)
1596 print >> io.stderr, "Custom TB Handler failed, unregistering"
1596 print >> io.stderr, "Custom TB Handler failed, unregistering"
1597 # show the exception in handler first
1597 # show the exception in handler first
1598 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1598 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1599 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1599 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1600 print >> io.stdout, "The original exception:"
1600 print >> io.stdout, "The original exception:"
1601 stb = self.InteractiveTB.structured_traceback(
1601 stb = self.InteractiveTB.structured_traceback(
1602 (etype,value,tb), tb_offset=tb_offset
1602 (etype,value,tb), tb_offset=tb_offset
1603 )
1603 )
1604 return stb
1604 return stb
1605
1605
1606 self.CustomTB = types.MethodType(wrapped,self)
1606 self.CustomTB = types.MethodType(wrapped,self)
1607 self.custom_exceptions = exc_tuple
1607 self.custom_exceptions = exc_tuple
1608
1608
1609 def excepthook(self, etype, value, tb):
1609 def excepthook(self, etype, value, tb):
1610 """One more defense for GUI apps that call sys.excepthook.
1610 """One more defense for GUI apps that call sys.excepthook.
1611
1611
1612 GUI frameworks like wxPython trap exceptions and call
1612 GUI frameworks like wxPython trap exceptions and call
1613 sys.excepthook themselves. I guess this is a feature that
1613 sys.excepthook themselves. I guess this is a feature that
1614 enables them to keep running after exceptions that would
1614 enables them to keep running after exceptions that would
1615 otherwise kill their mainloop. This is a bother for IPython
1615 otherwise kill their mainloop. This is a bother for IPython
1616 which excepts to catch all of the program exceptions with a try:
1616 which excepts to catch all of the program exceptions with a try:
1617 except: statement.
1617 except: statement.
1618
1618
1619 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1619 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
1620 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
1621 IPython crashed. In order to work around this, we can disable the
1622 CrashHandler and replace it with this excepthook instead, which prints a
1622 CrashHandler and replace it with this excepthook instead, which prints a
1623 regular traceback using our InteractiveTB. In this fashion, apps which
1623 regular traceback using our InteractiveTB. In this fashion, apps which
1624 call sys.excepthook will generate a regular-looking exception from
1624 call sys.excepthook will generate a regular-looking exception from
1625 IPython, and the CrashHandler will only be triggered by real IPython
1625 IPython, and the CrashHandler will only be triggered by real IPython
1626 crashes.
1626 crashes.
1627
1627
1628 This hook should be used sparingly, only in places which are not likely
1628 This hook should be used sparingly, only in places which are not likely
1629 to be true IPython errors.
1629 to be true IPython errors.
1630 """
1630 """
1631 self.showtraceback((etype,value,tb),tb_offset=0)
1631 self.showtraceback((etype,value,tb),tb_offset=0)
1632
1632
1633 def _get_exc_info(self, exc_tuple=None):
1633 def _get_exc_info(self, exc_tuple=None):
1634 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1634 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1635
1635
1636 Ensures sys.last_type,value,traceback hold the exc_info we found,
1636 Ensures sys.last_type,value,traceback hold the exc_info we found,
1637 from whichever source.
1637 from whichever source.
1638
1638
1639 raises ValueError if none of these contain any information
1639 raises ValueError if none of these contain any information
1640 """
1640 """
1641 if exc_tuple is None:
1641 if exc_tuple is None:
1642 etype, value, tb = sys.exc_info()
1642 etype, value, tb = sys.exc_info()
1643 else:
1643 else:
1644 etype, value, tb = exc_tuple
1644 etype, value, tb = exc_tuple
1645
1645
1646 if etype is None:
1646 if etype is None:
1647 if hasattr(sys, 'last_type'):
1647 if hasattr(sys, 'last_type'):
1648 etype, value, tb = sys.last_type, sys.last_value, \
1648 etype, value, tb = sys.last_type, sys.last_value, \
1649 sys.last_traceback
1649 sys.last_traceback
1650
1650
1651 if etype is None:
1651 if etype is None:
1652 raise ValueError("No exception to find")
1652 raise ValueError("No exception to find")
1653
1653
1654 # Now store the exception info in sys.last_type etc.
1654 # Now store the exception info in sys.last_type etc.
1655 # WARNING: these variables are somewhat deprecated and not
1655 # WARNING: these variables are somewhat deprecated and not
1656 # necessarily safe to use in a threaded environment, but tools
1656 # necessarily safe to use in a threaded environment, but tools
1657 # like pdb depend on their existence, so let's set them. If we
1657 # 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.
1658 # find problems in the field, we'll need to revisit their use.
1659 sys.last_type = etype
1659 sys.last_type = etype
1660 sys.last_value = value
1660 sys.last_value = value
1661 sys.last_traceback = tb
1661 sys.last_traceback = tb
1662
1662
1663 return etype, value, tb
1663 return etype, value, tb
1664
1664
1665
1665
1666 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1666 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1667 exception_only=False):
1667 exception_only=False):
1668 """Display the exception that just occurred.
1668 """Display the exception that just occurred.
1669
1669
1670 If nothing is known about the exception, this is the method which
1670 If nothing is known about the exception, this is the method which
1671 should be used throughout the code for presenting user tracebacks,
1671 should be used throughout the code for presenting user tracebacks,
1672 rather than directly invoking the InteractiveTB object.
1672 rather than directly invoking the InteractiveTB object.
1673
1673
1674 A specific showsyntaxerror() also exists, but this method can take
1674 A specific showsyntaxerror() also exists, but this method can take
1675 care of calling it if needed, so unless you are explicitly catching a
1675 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
1676 SyntaxError exception, don't try to analyze the stack manually and
1677 simply call this method."""
1677 simply call this method."""
1678
1678
1679 try:
1679 try:
1680 try:
1680 try:
1681 etype, value, tb = self._get_exc_info(exc_tuple)
1681 etype, value, tb = self._get_exc_info(exc_tuple)
1682 except ValueError:
1682 except ValueError:
1683 self.write_err('No traceback available to show.\n')
1683 self.write_err('No traceback available to show.\n')
1684 return
1684 return
1685
1685
1686 if etype is SyntaxError:
1686 if etype is SyntaxError:
1687 # Though this won't be called by syntax errors in the input
1687 # Though this won't be called by syntax errors in the input
1688 # line, there may be SyntaxError cases with imported code.
1688 # line, there may be SyntaxError cases with imported code.
1689 self.showsyntaxerror(filename)
1689 self.showsyntaxerror(filename)
1690 elif etype is UsageError:
1690 elif etype is UsageError:
1691 self.write_err("UsageError: %s" % value)
1691 self.write_err("UsageError: %s" % value)
1692 else:
1692 else:
1693 if etype in self.custom_exceptions:
1693 if etype in self.custom_exceptions:
1694 stb = self.CustomTB(etype, value, tb, tb_offset)
1694 stb = self.CustomTB(etype, value, tb, tb_offset)
1695 else:
1695 else:
1696 if exception_only:
1696 if exception_only:
1697 stb = ['An exception has occurred, use %tb to see '
1697 stb = ['An exception has occurred, use %tb to see '
1698 'the full traceback.\n']
1698 'the full traceback.\n']
1699 stb.extend(self.InteractiveTB.get_exception_only(etype,
1699 stb.extend(self.InteractiveTB.get_exception_only(etype,
1700 value))
1700 value))
1701 else:
1701 else:
1702 stb = self.InteractiveTB.structured_traceback(etype,
1702 stb = self.InteractiveTB.structured_traceback(etype,
1703 value, tb, tb_offset=tb_offset)
1703 value, tb, tb_offset=tb_offset)
1704
1704
1705 self._showtraceback(etype, value, stb)
1705 self._showtraceback(etype, value, stb)
1706 if self.call_pdb:
1706 if self.call_pdb:
1707 # drop into debugger
1707 # drop into debugger
1708 self.debugger(force=True)
1708 self.debugger(force=True)
1709 return
1709 return
1710
1710
1711 # Actually show the traceback
1711 # Actually show the traceback
1712 self._showtraceback(etype, value, stb)
1712 self._showtraceback(etype, value, stb)
1713
1713
1714 except KeyboardInterrupt:
1714 except KeyboardInterrupt:
1715 self.write_err("\nKeyboardInterrupt\n")
1715 self.write_err("\nKeyboardInterrupt\n")
1716
1716
1717 def _showtraceback(self, etype, evalue, stb):
1717 def _showtraceback(self, etype, evalue, stb):
1718 """Actually show a traceback.
1718 """Actually show a traceback.
1719
1719
1720 Subclasses may override this method to put the traceback on a different
1720 Subclasses may override this method to put the traceback on a different
1721 place, like a side channel.
1721 place, like a side channel.
1722 """
1722 """
1723 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1723 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1724
1724
1725 def showsyntaxerror(self, filename=None):
1725 def showsyntaxerror(self, filename=None):
1726 """Display the syntax error that just occurred.
1726 """Display the syntax error that just occurred.
1727
1727
1728 This doesn't display a stack trace because there isn't one.
1728 This doesn't display a stack trace because there isn't one.
1729
1729
1730 If a filename is given, it is stuffed in the exception instead
1730 If a filename is given, it is stuffed in the exception instead
1731 of what was there before (because Python's parser always uses
1731 of what was there before (because Python's parser always uses
1732 "<string>" when reading from a string).
1732 "<string>" when reading from a string).
1733 """
1733 """
1734 etype, value, last_traceback = self._get_exc_info()
1734 etype, value, last_traceback = self._get_exc_info()
1735
1735
1736 if filename and etype is SyntaxError:
1736 if filename and etype is SyntaxError:
1737 try:
1737 try:
1738 value.filename = filename
1738 value.filename = filename
1739 except:
1739 except:
1740 # Not the format we expect; leave it alone
1740 # Not the format we expect; leave it alone
1741 pass
1741 pass
1742
1742
1743 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1743 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1744 self._showtraceback(etype, value, stb)
1744 self._showtraceback(etype, value, stb)
1745
1745
1746 # This is overridden in TerminalInteractiveShell to show a message about
1746 # This is overridden in TerminalInteractiveShell to show a message about
1747 # the %paste magic.
1747 # the %paste magic.
1748 def showindentationerror(self):
1748 def showindentationerror(self):
1749 """Called by run_cell when there's an IndentationError in code entered
1749 """Called by run_cell when there's an IndentationError in code entered
1750 at the prompt.
1750 at the prompt.
1751
1751
1752 This is overridden in TerminalInteractiveShell to show a message about
1752 This is overridden in TerminalInteractiveShell to show a message about
1753 the %paste magic."""
1753 the %paste magic."""
1754 self.showsyntaxerror()
1754 self.showsyntaxerror()
1755
1755
1756 #-------------------------------------------------------------------------
1756 #-------------------------------------------------------------------------
1757 # Things related to readline
1757 # Things related to readline
1758 #-------------------------------------------------------------------------
1758 #-------------------------------------------------------------------------
1759
1759
1760 def init_readline(self):
1760 def init_readline(self):
1761 """Command history completion/saving/reloading."""
1761 """Command history completion/saving/reloading."""
1762
1762
1763 if self.readline_use:
1763 if self.readline_use:
1764 import IPython.utils.rlineimpl as readline
1764 import IPython.utils.rlineimpl as readline
1765
1765
1766 self.rl_next_input = None
1766 self.rl_next_input = None
1767 self.rl_do_indent = False
1767 self.rl_do_indent = False
1768
1768
1769 if not self.readline_use or not readline.have_readline:
1769 if not self.readline_use or not readline.have_readline:
1770 self.has_readline = False
1770 self.has_readline = False
1771 self.readline = None
1771 self.readline = None
1772 # Set a number of methods that depend on readline to be no-op
1772 # Set a number of methods that depend on readline to be no-op
1773 self.readline_no_record = no_op_context
1773 self.readline_no_record = no_op_context
1774 self.set_readline_completer = no_op
1774 self.set_readline_completer = no_op
1775 self.set_custom_completer = no_op
1775 self.set_custom_completer = no_op
1776 self.set_completer_frame = no_op
1776 self.set_completer_frame = no_op
1777 if self.readline_use:
1777 if self.readline_use:
1778 warn('Readline services not available or not loaded.')
1778 warn('Readline services not available or not loaded.')
1779 else:
1779 else:
1780 self.has_readline = True
1780 self.has_readline = True
1781 self.readline = readline
1781 self.readline = readline
1782 sys.modules['readline'] = readline
1782 sys.modules['readline'] = readline
1783
1783
1784 # Platform-specific configuration
1784 # Platform-specific configuration
1785 if os.name == 'nt':
1785 if os.name == 'nt':
1786 # FIXME - check with Frederick to see if we can harmonize
1786 # FIXME - check with Frederick to see if we can harmonize
1787 # naming conventions with pyreadline to avoid this
1787 # naming conventions with pyreadline to avoid this
1788 # platform-dependent check
1788 # platform-dependent check
1789 self.readline_startup_hook = readline.set_pre_input_hook
1789 self.readline_startup_hook = readline.set_pre_input_hook
1790 else:
1790 else:
1791 self.readline_startup_hook = readline.set_startup_hook
1791 self.readline_startup_hook = readline.set_startup_hook
1792
1792
1793 # Load user's initrc file (readline config)
1793 # Load user's initrc file (readline config)
1794 # Or if libedit is used, load editrc.
1794 # Or if libedit is used, load editrc.
1795 inputrc_name = os.environ.get('INPUTRC')
1795 inputrc_name = os.environ.get('INPUTRC')
1796 if inputrc_name is None:
1796 if inputrc_name is None:
1797 inputrc_name = '.inputrc'
1797 inputrc_name = '.inputrc'
1798 if readline.uses_libedit:
1798 if readline.uses_libedit:
1799 inputrc_name = '.editrc'
1799 inputrc_name = '.editrc'
1800 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1800 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1801 if os.path.isfile(inputrc_name):
1801 if os.path.isfile(inputrc_name):
1802 try:
1802 try:
1803 readline.read_init_file(inputrc_name)
1803 readline.read_init_file(inputrc_name)
1804 except:
1804 except:
1805 warn('Problems reading readline initialization file <%s>'
1805 warn('Problems reading readline initialization file <%s>'
1806 % inputrc_name)
1806 % inputrc_name)
1807
1807
1808 # Configure readline according to user's prefs
1808 # Configure readline according to user's prefs
1809 # This is only done if GNU readline is being used. If libedit
1809 # This is only done if GNU readline is being used. If libedit
1810 # is being used (as on Leopard) the readline config is
1810 # is being used (as on Leopard) the readline config is
1811 # not run as the syntax for libedit is different.
1811 # not run as the syntax for libedit is different.
1812 if not readline.uses_libedit:
1812 if not readline.uses_libedit:
1813 for rlcommand in self.readline_parse_and_bind:
1813 for rlcommand in self.readline_parse_and_bind:
1814 #print "loading rl:",rlcommand # dbg
1814 #print "loading rl:",rlcommand # dbg
1815 readline.parse_and_bind(rlcommand)
1815 readline.parse_and_bind(rlcommand)
1816
1816
1817 # Remove some chars from the delimiters list. If we encounter
1817 # Remove some chars from the delimiters list. If we encounter
1818 # unicode chars, discard them.
1818 # unicode chars, discard them.
1819 delims = readline.get_completer_delims()
1819 delims = readline.get_completer_delims()
1820 if not py3compat.PY3:
1820 if not py3compat.PY3:
1821 delims = delims.encode("ascii", "ignore")
1821 delims = delims.encode("ascii", "ignore")
1822 for d in self.readline_remove_delims:
1822 for d in self.readline_remove_delims:
1823 delims = delims.replace(d, "")
1823 delims = delims.replace(d, "")
1824 delims = delims.replace(ESC_MAGIC, '')
1824 delims = delims.replace(ESC_MAGIC, '')
1825 readline.set_completer_delims(delims)
1825 readline.set_completer_delims(delims)
1826 # otherwise we end up with a monster history after a while:
1826 # otherwise we end up with a monster history after a while:
1827 readline.set_history_length(self.history_length)
1827 readline.set_history_length(self.history_length)
1828
1828
1829 self.refill_readline_hist()
1829 self.refill_readline_hist()
1830 self.readline_no_record = ReadlineNoRecord(self)
1830 self.readline_no_record = ReadlineNoRecord(self)
1831
1831
1832 # Configure auto-indent for all platforms
1832 # Configure auto-indent for all platforms
1833 self.set_autoindent(self.autoindent)
1833 self.set_autoindent(self.autoindent)
1834
1834
1835 def refill_readline_hist(self):
1835 def refill_readline_hist(self):
1836 # Load the last 1000 lines from history
1836 # Load the last 1000 lines from history
1837 self.readline.clear_history()
1837 self.readline.clear_history()
1838 stdin_encoding = sys.stdin.encoding or "utf-8"
1838 stdin_encoding = sys.stdin.encoding or "utf-8"
1839 last_cell = u""
1839 last_cell = u""
1840 for _, _, cell in self.history_manager.get_tail(1000,
1840 for _, _, cell in self.history_manager.get_tail(1000,
1841 include_latest=True):
1841 include_latest=True):
1842 # Ignore blank lines and consecutive duplicates
1842 # Ignore blank lines and consecutive duplicates
1843 cell = cell.rstrip()
1843 cell = cell.rstrip()
1844 if cell and (cell != last_cell):
1844 if cell and (cell != last_cell):
1845 if self.multiline_history:
1845 if self.multiline_history:
1846 self.readline.add_history(py3compat.unicode_to_str(cell,
1846 self.readline.add_history(py3compat.unicode_to_str(cell,
1847 stdin_encoding))
1847 stdin_encoding))
1848 else:
1848 else:
1849 for line in cell.splitlines():
1849 for line in cell.splitlines():
1850 self.readline.add_history(py3compat.unicode_to_str(line,
1850 self.readline.add_history(py3compat.unicode_to_str(line,
1851 stdin_encoding))
1851 stdin_encoding))
1852 last_cell = cell
1852 last_cell = cell
1853
1853
1854 def set_next_input(self, s):
1854 def set_next_input(self, s):
1855 """ Sets the 'default' input string for the next command line.
1855 """ Sets the 'default' input string for the next command line.
1856
1856
1857 Requires readline.
1857 Requires readline.
1858
1858
1859 Example:
1859 Example:
1860
1860
1861 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1861 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1862 [D:\ipython]|2> Hello Word_ # cursor is here
1862 [D:\ipython]|2> Hello Word_ # cursor is here
1863 """
1863 """
1864 self.rl_next_input = py3compat.cast_bytes_py2(s)
1864 self.rl_next_input = py3compat.cast_bytes_py2(s)
1865
1865
1866 # Maybe move this to the terminal subclass?
1866 # Maybe move this to the terminal subclass?
1867 def pre_readline(self):
1867 def pre_readline(self):
1868 """readline hook to be used at the start of each line.
1868 """readline hook to be used at the start of each line.
1869
1869
1870 Currently it handles auto-indent only."""
1870 Currently it handles auto-indent only."""
1871
1871
1872 if self.rl_do_indent:
1872 if self.rl_do_indent:
1873 self.readline.insert_text(self._indent_current_str())
1873 self.readline.insert_text(self._indent_current_str())
1874 if self.rl_next_input is not None:
1874 if self.rl_next_input is not None:
1875 self.readline.insert_text(self.rl_next_input)
1875 self.readline.insert_text(self.rl_next_input)
1876 self.rl_next_input = None
1876 self.rl_next_input = None
1877
1877
1878 def _indent_current_str(self):
1878 def _indent_current_str(self):
1879 """return the current level of indentation as a string"""
1879 """return the current level of indentation as a string"""
1880 return self.input_splitter.indent_spaces * ' '
1880 return self.input_splitter.indent_spaces * ' '
1881
1881
1882 #-------------------------------------------------------------------------
1882 #-------------------------------------------------------------------------
1883 # Things related to text completion
1883 # Things related to text completion
1884 #-------------------------------------------------------------------------
1884 #-------------------------------------------------------------------------
1885
1885
1886 def init_completer(self):
1886 def init_completer(self):
1887 """Initialize the completion machinery.
1887 """Initialize the completion machinery.
1888
1888
1889 This creates completion machinery that can be used by client code,
1889 This creates completion machinery that can be used by client code,
1890 either interactively in-process (typically triggered by the readline
1890 either interactively in-process (typically triggered by the readline
1891 library), programatically (such as in test suites) or out-of-prcess
1891 library), programatically (such as in test suites) or out-of-prcess
1892 (typically over the network by remote frontends).
1892 (typically over the network by remote frontends).
1893 """
1893 """
1894 from IPython.core.completer import IPCompleter
1894 from IPython.core.completer import IPCompleter
1895 from IPython.core.completerlib import (module_completer,
1895 from IPython.core.completerlib import (module_completer,
1896 magic_run_completer, cd_completer, reset_completer)
1896 magic_run_completer, cd_completer, reset_completer)
1897
1897
1898 self.Completer = IPCompleter(shell=self,
1898 self.Completer = IPCompleter(shell=self,
1899 namespace=self.user_ns,
1899 namespace=self.user_ns,
1900 global_namespace=self.user_global_ns,
1900 global_namespace=self.user_global_ns,
1901 alias_table=self.alias_manager.alias_table,
1901 alias_table=self.alias_manager.alias_table,
1902 use_readline=self.has_readline,
1902 use_readline=self.has_readline,
1903 config=self.config,
1903 config=self.config,
1904 )
1904 )
1905 self.configurables.append(self.Completer)
1905 self.configurables.append(self.Completer)
1906
1906
1907 # Add custom completers to the basic ones built into IPCompleter
1907 # Add custom completers to the basic ones built into IPCompleter
1908 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1908 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1909 self.strdispatchers['complete_command'] = sdisp
1909 self.strdispatchers['complete_command'] = sdisp
1910 self.Completer.custom_completers = sdisp
1910 self.Completer.custom_completers = sdisp
1911
1911
1912 self.set_hook('complete_command', module_completer, str_key = 'import')
1912 self.set_hook('complete_command', module_completer, str_key = 'import')
1913 self.set_hook('complete_command', module_completer, str_key = 'from')
1913 self.set_hook('complete_command', module_completer, str_key = 'from')
1914 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1914 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1915 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1915 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1916 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1916 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1917
1917
1918 # Only configure readline if we truly are using readline. IPython can
1918 # Only configure readline if we truly are using readline. IPython can
1919 # do tab-completion over the network, in GUIs, etc, where readline
1919 # do tab-completion over the network, in GUIs, etc, where readline
1920 # itself may be absent
1920 # itself may be absent
1921 if self.has_readline:
1921 if self.has_readline:
1922 self.set_readline_completer()
1922 self.set_readline_completer()
1923
1923
1924 def complete(self, text, line=None, cursor_pos=None):
1924 def complete(self, text, line=None, cursor_pos=None):
1925 """Return the completed text and a list of completions.
1925 """Return the completed text and a list of completions.
1926
1926
1927 Parameters
1927 Parameters
1928 ----------
1928 ----------
1929
1929
1930 text : string
1930 text : string
1931 A string of text to be completed on. It can be given as empty and
1931 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
1932 instead a line/position pair are given. In this case, the
1933 completer itself will split the line like readline does.
1933 completer itself will split the line like readline does.
1934
1934
1935 line : string, optional
1935 line : string, optional
1936 The complete line that text is part of.
1936 The complete line that text is part of.
1937
1937
1938 cursor_pos : int, optional
1938 cursor_pos : int, optional
1939 The position of the cursor on the input line.
1939 The position of the cursor on the input line.
1940
1940
1941 Returns
1941 Returns
1942 -------
1942 -------
1943 text : string
1943 text : string
1944 The actual text that was completed.
1944 The actual text that was completed.
1945
1945
1946 matches : list
1946 matches : list
1947 A sorted list with all possible completions.
1947 A sorted list with all possible completions.
1948
1948
1949 The optional arguments allow the completion to take more context into
1949 The optional arguments allow the completion to take more context into
1950 account, and are part of the low-level completion API.
1950 account, and are part of the low-level completion API.
1951
1951
1952 This is a wrapper around the completion mechanism, similar to what
1952 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
1953 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
1954 exposing it as a method, it can be used by other non-readline
1955 environments (such as GUIs) for text completion.
1955 environments (such as GUIs) for text completion.
1956
1956
1957 Simple usage example:
1957 Simple usage example:
1958
1958
1959 In [1]: x = 'hello'
1959 In [1]: x = 'hello'
1960
1960
1961 In [2]: _ip.complete('x.l')
1961 In [2]: _ip.complete('x.l')
1962 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1962 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1963 """
1963 """
1964
1964
1965 # Inject names into __builtin__ so we can complete on the added names.
1965 # Inject names into __builtin__ so we can complete on the added names.
1966 with self.builtin_trap:
1966 with self.builtin_trap:
1967 return self.Completer.complete(text, line, cursor_pos)
1967 return self.Completer.complete(text, line, cursor_pos)
1968
1968
1969 def set_custom_completer(self, completer, pos=0):
1969 def set_custom_completer(self, completer, pos=0):
1970 """Adds a new custom completer function.
1970 """Adds a new custom completer function.
1971
1971
1972 The position argument (defaults to 0) is the index in the completers
1972 The position argument (defaults to 0) is the index in the completers
1973 list where you want the completer to be inserted."""
1973 list where you want the completer to be inserted."""
1974
1974
1975 newcomp = types.MethodType(completer,self.Completer)
1975 newcomp = types.MethodType(completer,self.Completer)
1976 self.Completer.matchers.insert(pos,newcomp)
1976 self.Completer.matchers.insert(pos,newcomp)
1977
1977
1978 def set_readline_completer(self):
1978 def set_readline_completer(self):
1979 """Reset readline's completer to be our own."""
1979 """Reset readline's completer to be our own."""
1980 self.readline.set_completer(self.Completer.rlcomplete)
1980 self.readline.set_completer(self.Completer.rlcomplete)
1981
1981
1982 def set_completer_frame(self, frame=None):
1982 def set_completer_frame(self, frame=None):
1983 """Set the frame of the completer."""
1983 """Set the frame of the completer."""
1984 if frame:
1984 if frame:
1985 self.Completer.namespace = frame.f_locals
1985 self.Completer.namespace = frame.f_locals
1986 self.Completer.global_namespace = frame.f_globals
1986 self.Completer.global_namespace = frame.f_globals
1987 else:
1987 else:
1988 self.Completer.namespace = self.user_ns
1988 self.Completer.namespace = self.user_ns
1989 self.Completer.global_namespace = self.user_global_ns
1989 self.Completer.global_namespace = self.user_global_ns
1990
1990
1991 #-------------------------------------------------------------------------
1991 #-------------------------------------------------------------------------
1992 # Things related to magics
1992 # Things related to magics
1993 #-------------------------------------------------------------------------
1993 #-------------------------------------------------------------------------
1994
1994
1995 def init_magics(self):
1995 def init_magics(self):
1996 # FIXME: Move the color initialization to the DisplayHook, which
1996 # FIXME: Move the color initialization to the DisplayHook, which
1997 # should be split into a prompt manager and displayhook. We probably
1997 # should be split into a prompt manager and displayhook. We probably
1998 # even need a centralize colors management object.
1998 # even need a centralize colors management object.
1999 self.magic('colors %s' % self.colors)
1999 self.magic('colors %s' % self.colors)
2000 # History was moved to a separate module
2000 # History was moved to a separate module
2001 from IPython.core import history
2001 from IPython.core import history
2002 history.init_ipython(self)
2002 history.init_ipython(self)
2003
2003
2004 def magic(self, arg_s, next_input=None):
2004 def magic(self, arg_s, next_input=None):
2005 """Call a magic function by name.
2005 """Call a magic function by name.
2006
2006
2007 Input: a string containing the name of the magic function to call and
2007 Input: a string containing the name of the magic function to call and
2008 any additional arguments to be passed to the magic.
2008 any additional arguments to be passed to the magic.
2009
2009
2010 magic('name -opt foo bar') is equivalent to typing at the ipython
2010 magic('name -opt foo bar') is equivalent to typing at the ipython
2011 prompt:
2011 prompt:
2012
2012
2013 In[1]: %name -opt foo bar
2013 In[1]: %name -opt foo bar
2014
2014
2015 To call a magic without arguments, simply use magic('name').
2015 To call a magic without arguments, simply use magic('name').
2016
2016
2017 This provides a proper Python function to call IPython's magics in any
2017 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
2018 valid Python code you can type at the interpreter, including loops and
2019 compound statements.
2019 compound statements.
2020 """
2020 """
2021 # Allow setting the next input - this is used if the user does `a=abs?`.
2021 # 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.
2022 # We do this first so that magic functions can override it.
2023 if next_input:
2023 if next_input:
2024 self.set_next_input(next_input)
2024 self.set_next_input(next_input)
2025
2025
2026 magic_name, _, magic_arg_s = arg_s.partition(' ')
2026 magic_name, _, magic_arg_s = arg_s.partition(' ')
2027 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2027 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2028
2028
2029 fn = self.find_magic(magic_name)
2029 fn = self.find_magic(magic_name)
2030 if fn is None:
2030 if fn is None:
2031 error("Magic function `%s` not found." % magic_name)
2031 error("Magic function `%s` not found." % magic_name)
2032 else:
2032 else:
2033 magic_arg_s = self.var_expand(magic_arg_s, 1)
2033 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
2034 # Put magic args in a list so we can call with f(*a) syntax
2035 args = [magic_arg_s]
2035 args = [magic_arg_s]
2036 # Grab local namespace if we need it:
2036 # Grab local namespace if we need it:
2037 if getattr(fn, "needs_local_scope", False):
2037 if getattr(fn, "needs_local_scope", False):
2038 args.append(sys._getframe(1).f_locals)
2038 args.append(sys._getframe(1).f_locals)
2039 with self.builtin_trap:
2039 with self.builtin_trap:
2040 result = fn(*args)
2040 result = fn(*args)
2041 return result
2041 return result
2042
2042
2043 def define_magic(self, magic_name, func):
2043 def define_magic(self, magic_name, func):
2044 """Expose own function as magic function for ipython
2044 """Expose own function as magic function for ipython
2045
2045
2046 Example::
2046 Example::
2047
2047
2048 def foo_impl(self,parameter_s=''):
2048 def foo_impl(self,parameter_s=''):
2049 'My very own magic!. (Use docstrings, IPython reads them).'
2049 'My very own magic!. (Use docstrings, IPython reads them).'
2050 print 'Magic function. Passed parameter is between < >:'
2050 print 'Magic function. Passed parameter is between < >:'
2051 print '<%s>' % parameter_s
2051 print '<%s>' % parameter_s
2052 print 'The self object is:', self
2052 print 'The self object is:', self
2053
2053
2054 ip.define_magic('foo',foo_impl)
2054 ip.define_magic('foo',foo_impl)
2055 """
2055 """
2056 im = types.MethodType(func, self._magic)
2056 im = types.MethodType(func, self._magic)
2057 old = self.find_magic(magic_name)
2057 old = self.find_magic(magic_name)
2058 setattr(self._magic, 'magic_' + magic_name, im)
2058 setattr(self._magic, 'magic_' + magic_name, im)
2059 return old
2059 return old
2060
2060
2061 def find_magic(self, magic_name):
2061 def find_magic(self, magic_name):
2062 """Find and return a magic function by name.
2062 """Find and return a magic function by name.
2063 """
2063 """
2064 return getattr(self._magic, 'magic_' + magic_name, None)
2064 return getattr(self._magic, 'magic_' + magic_name, None)
2065
2065
2066 #-------------------------------------------------------------------------
2066 #-------------------------------------------------------------------------
2067 # Things related to macros
2067 # Things related to macros
2068 #-------------------------------------------------------------------------
2068 #-------------------------------------------------------------------------
2069
2069
2070 def define_macro(self, name, themacro):
2070 def define_macro(self, name, themacro):
2071 """Define a new macro
2071 """Define a new macro
2072
2072
2073 Parameters
2073 Parameters
2074 ----------
2074 ----------
2075 name : str
2075 name : str
2076 The name of the macro.
2076 The name of the macro.
2077 themacro : str or Macro
2077 themacro : str or Macro
2078 The action to do upon invoking the macro. If a string, a new
2078 The action to do upon invoking the macro. If a string, a new
2079 Macro object is created by passing the string to it.
2079 Macro object is created by passing the string to it.
2080 """
2080 """
2081
2081
2082 from IPython.core import macro
2082 from IPython.core import macro
2083
2083
2084 if isinstance(themacro, basestring):
2084 if isinstance(themacro, basestring):
2085 themacro = macro.Macro(themacro)
2085 themacro = macro.Macro(themacro)
2086 if not isinstance(themacro, macro.Macro):
2086 if not isinstance(themacro, macro.Macro):
2087 raise ValueError('A macro must be a string or a Macro instance.')
2087 raise ValueError('A macro must be a string or a Macro instance.')
2088 self.user_ns[name] = themacro
2088 self.user_ns[name] = themacro
2089
2089
2090 #-------------------------------------------------------------------------
2090 #-------------------------------------------------------------------------
2091 # Things related to the running of system commands
2091 # Things related to the running of system commands
2092 #-------------------------------------------------------------------------
2092 #-------------------------------------------------------------------------
2093
2093
2094 def system_piped(self, cmd):
2094 def system_piped(self, cmd):
2095 """Call the given cmd in a subprocess, piping stdout/err
2095 """Call the given cmd in a subprocess, piping stdout/err
2096
2096
2097 Parameters
2097 Parameters
2098 ----------
2098 ----------
2099 cmd : str
2099 cmd : str
2100 Command to execute (can not end in '&', as background processes are
2100 Command to execute (can not end in '&', as background processes are
2101 not supported. Should not be a command that expects input
2101 not supported. Should not be a command that expects input
2102 other than simple text.
2102 other than simple text.
2103 """
2103 """
2104 if cmd.rstrip().endswith('&'):
2104 if cmd.rstrip().endswith('&'):
2105 # this is *far* from a rigorous test
2105 # this is *far* from a rigorous test
2106 # We do not support backgrounding processes because we either use
2106 # We do not support backgrounding processes because we either use
2107 # pexpect or pipes to read from. Users can always just call
2107 # pexpect or pipes to read from. Users can always just call
2108 # os.system() or use ip.system=ip.system_raw
2108 # os.system() or use ip.system=ip.system_raw
2109 # if they really want a background process.
2109 # if they really want a background process.
2110 raise OSError("Background processes not supported.")
2110 raise OSError("Background processes not supported.")
2111
2111
2112 # we explicitly do NOT return the subprocess status code, because
2112 # we explicitly do NOT return the subprocess status code, because
2113 # a non-None value would trigger :func:`sys.displayhook` calls.
2113 # a non-None value would trigger :func:`sys.displayhook` calls.
2114 # Instead, we store the exit_code in user_ns.
2114 # Instead, we store the exit_code in user_ns.
2115 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2115 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2116
2116
2117 def system_raw(self, cmd):
2117 def system_raw(self, cmd):
2118 """Call the given cmd in a subprocess using os.system
2118 """Call the given cmd in a subprocess using os.system
2119
2119
2120 Parameters
2120 Parameters
2121 ----------
2121 ----------
2122 cmd : str
2122 cmd : str
2123 Command to execute.
2123 Command to execute.
2124 """
2124 """
2125 cmd = self.var_expand(cmd, depth=2)
2125 cmd = self.var_expand(cmd, depth=2)
2126 # protect os.system from UNC paths on Windows, which it can't handle:
2126 # protect os.system from UNC paths on Windows, which it can't handle:
2127 if sys.platform == 'win32':
2127 if sys.platform == 'win32':
2128 from IPython.utils._process_win32 import AvoidUNCPath
2128 from IPython.utils._process_win32 import AvoidUNCPath
2129 with AvoidUNCPath() as path:
2129 with AvoidUNCPath() as path:
2130 if path is not None:
2130 if path is not None:
2131 cmd = '"pushd %s &&"%s' % (path, cmd)
2131 cmd = '"pushd %s &&"%s' % (path, cmd)
2132 cmd = py3compat.unicode_to_str(cmd)
2132 cmd = py3compat.unicode_to_str(cmd)
2133 ec = os.system(cmd)
2133 ec = os.system(cmd)
2134 else:
2134 else:
2135 cmd = py3compat.unicode_to_str(cmd)
2135 cmd = py3compat.unicode_to_str(cmd)
2136 ec = os.system(cmd)
2136 ec = os.system(cmd)
2137
2137
2138 # We explicitly do NOT return the subprocess status code, because
2138 # We explicitly do NOT return the subprocess status code, because
2139 # a non-None value would trigger :func:`sys.displayhook` calls.
2139 # a non-None value would trigger :func:`sys.displayhook` calls.
2140 # Instead, we store the exit_code in user_ns.
2140 # Instead, we store the exit_code in user_ns.
2141 self.user_ns['_exit_code'] = ec
2141 self.user_ns['_exit_code'] = ec
2142
2142
2143 # use piped system by default, because it is better behaved
2143 # use piped system by default, because it is better behaved
2144 system = system_piped
2144 system = system_piped
2145
2145
2146 def getoutput(self, cmd, split=True):
2146 def getoutput(self, cmd, split=True):
2147 """Get output (possibly including stderr) from a subprocess.
2147 """Get output (possibly including stderr) from a subprocess.
2148
2148
2149 Parameters
2149 Parameters
2150 ----------
2150 ----------
2151 cmd : str
2151 cmd : str
2152 Command to execute (can not end in '&', as background processes are
2152 Command to execute (can not end in '&', as background processes are
2153 not supported.
2153 not supported.
2154 split : bool, optional
2154 split : bool, optional
2155
2155
2156 If True, split the output into an IPython SList. Otherwise, an
2156 If True, split the output into an IPython SList. Otherwise, an
2157 IPython LSString is returned. These are objects similar to normal
2157 IPython LSString is returned. These are objects similar to normal
2158 lists and strings, with a few convenience attributes for easier
2158 lists and strings, with a few convenience attributes for easier
2159 manipulation of line-based output. You can use '?' on them for
2159 manipulation of line-based output. You can use '?' on them for
2160 details.
2160 details.
2161 """
2161 """
2162 if cmd.rstrip().endswith('&'):
2162 if cmd.rstrip().endswith('&'):
2163 # this is *far* from a rigorous test
2163 # this is *far* from a rigorous test
2164 raise OSError("Background processes not supported.")
2164 raise OSError("Background processes not supported.")
2165 out = getoutput(self.var_expand(cmd, depth=2))
2165 out = getoutput(self.var_expand(cmd, depth=2))
2166 if split:
2166 if split:
2167 out = SList(out.splitlines())
2167 out = SList(out.splitlines())
2168 else:
2168 else:
2169 out = LSString(out)
2169 out = LSString(out)
2170 return out
2170 return out
2171
2171
2172 #-------------------------------------------------------------------------
2172 #-------------------------------------------------------------------------
2173 # Things related to aliases
2173 # Things related to aliases
2174 #-------------------------------------------------------------------------
2174 #-------------------------------------------------------------------------
2175
2175
2176 def init_alias(self):
2176 def init_alias(self):
2177 self.alias_manager = AliasManager(shell=self, config=self.config)
2177 self.alias_manager = AliasManager(shell=self, config=self.config)
2178 self.configurables.append(self.alias_manager)
2178 self.configurables.append(self.alias_manager)
2179 self.ns_table['alias'] = self.alias_manager.alias_table,
2179 self.ns_table['alias'] = self.alias_manager.alias_table,
2180
2180
2181 #-------------------------------------------------------------------------
2181 #-------------------------------------------------------------------------
2182 # Things related to extensions and plugins
2182 # Things related to extensions and plugins
2183 #-------------------------------------------------------------------------
2183 #-------------------------------------------------------------------------
2184
2184
2185 def init_extension_manager(self):
2185 def init_extension_manager(self):
2186 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2186 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2187 self.configurables.append(self.extension_manager)
2187 self.configurables.append(self.extension_manager)
2188
2188
2189 def init_plugin_manager(self):
2189 def init_plugin_manager(self):
2190 self.plugin_manager = PluginManager(config=self.config)
2190 self.plugin_manager = PluginManager(config=self.config)
2191 self.configurables.append(self.plugin_manager)
2191 self.configurables.append(self.plugin_manager)
2192
2192
2193
2193
2194 #-------------------------------------------------------------------------
2194 #-------------------------------------------------------------------------
2195 # Things related to payloads
2195 # Things related to payloads
2196 #-------------------------------------------------------------------------
2196 #-------------------------------------------------------------------------
2197
2197
2198 def init_payload(self):
2198 def init_payload(self):
2199 self.payload_manager = PayloadManager(config=self.config)
2199 self.payload_manager = PayloadManager(config=self.config)
2200 self.configurables.append(self.payload_manager)
2200 self.configurables.append(self.payload_manager)
2201
2201
2202 #-------------------------------------------------------------------------
2202 #-------------------------------------------------------------------------
2203 # Things related to the prefilter
2203 # Things related to the prefilter
2204 #-------------------------------------------------------------------------
2204 #-------------------------------------------------------------------------
2205
2205
2206 def init_prefilter(self):
2206 def init_prefilter(self):
2207 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2207 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2208 self.configurables.append(self.prefilter_manager)
2208 self.configurables.append(self.prefilter_manager)
2209 # Ultimately this will be refactored in the new interpreter code, but
2209 # Ultimately this will be refactored in the new interpreter code, but
2210 # for now, we should expose the main prefilter method (there's legacy
2210 # for now, we should expose the main prefilter method (there's legacy
2211 # code out there that may rely on this).
2211 # code out there that may rely on this).
2212 self.prefilter = self.prefilter_manager.prefilter_lines
2212 self.prefilter = self.prefilter_manager.prefilter_lines
2213
2213
2214 def auto_rewrite_input(self, cmd):
2214 def auto_rewrite_input(self, cmd):
2215 """Print to the screen the rewritten form of the user's command.
2215 """Print to the screen the rewritten form of the user's command.
2216
2216
2217 This shows visual feedback by rewriting input lines that cause
2217 This shows visual feedback by rewriting input lines that cause
2218 automatic calling to kick in, like::
2218 automatic calling to kick in, like::
2219
2219
2220 /f x
2220 /f x
2221
2221
2222 into::
2222 into::
2223
2223
2224 ------> f(x)
2224 ------> f(x)
2225
2225
2226 after the user's input prompt. This helps the user understand that the
2226 after the user's input prompt. This helps the user understand that the
2227 input line was transformed automatically by IPython.
2227 input line was transformed automatically by IPython.
2228 """
2228 """
2229 if not self.show_rewritten_input:
2229 if not self.show_rewritten_input:
2230 return
2230 return
2231
2231
2232 rw = self.prompt_manager.render('rewrite') + cmd
2232 rw = self.prompt_manager.render('rewrite') + cmd
2233
2233
2234 try:
2234 try:
2235 # plain ascii works better w/ pyreadline, on some machines, so
2235 # plain ascii works better w/ pyreadline, on some machines, so
2236 # we use it and only print uncolored rewrite if we have unicode
2236 # we use it and only print uncolored rewrite if we have unicode
2237 rw = str(rw)
2237 rw = str(rw)
2238 print >> io.stdout, rw
2238 print >> io.stdout, rw
2239 except UnicodeEncodeError:
2239 except UnicodeEncodeError:
2240 print "------> " + cmd
2240 print "------> " + cmd
2241
2241
2242 #-------------------------------------------------------------------------
2242 #-------------------------------------------------------------------------
2243 # Things related to extracting values/expressions from kernel and user_ns
2243 # Things related to extracting values/expressions from kernel and user_ns
2244 #-------------------------------------------------------------------------
2244 #-------------------------------------------------------------------------
2245
2245
2246 def _simple_error(self):
2246 def _simple_error(self):
2247 etype, value = sys.exc_info()[:2]
2247 etype, value = sys.exc_info()[:2]
2248 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2248 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2249
2249
2250 def user_variables(self, names):
2250 def user_variables(self, names):
2251 """Get a list of variable names from the user's namespace.
2251 """Get a list of variable names from the user's namespace.
2252
2252
2253 Parameters
2253 Parameters
2254 ----------
2254 ----------
2255 names : list of strings
2255 names : list of strings
2256 A list of names of variables to be read from the user namespace.
2256 A list of names of variables to be read from the user namespace.
2257
2257
2258 Returns
2258 Returns
2259 -------
2259 -------
2260 A dict, keyed by the input names and with the repr() of each value.
2260 A dict, keyed by the input names and with the repr() of each value.
2261 """
2261 """
2262 out = {}
2262 out = {}
2263 user_ns = self.user_ns
2263 user_ns = self.user_ns
2264 for varname in names:
2264 for varname in names:
2265 try:
2265 try:
2266 value = repr(user_ns[varname])
2266 value = repr(user_ns[varname])
2267 except:
2267 except:
2268 value = self._simple_error()
2268 value = self._simple_error()
2269 out[varname] = value
2269 out[varname] = value
2270 return out
2270 return out
2271
2271
2272 def user_expressions(self, expressions):
2272 def user_expressions(self, expressions):
2273 """Evaluate a dict of expressions in the user's namespace.
2273 """Evaluate a dict of expressions in the user's namespace.
2274
2274
2275 Parameters
2275 Parameters
2276 ----------
2276 ----------
2277 expressions : dict
2277 expressions : dict
2278 A dict with string keys and string values. The expression values
2278 A dict with string keys and string values. The expression values
2279 should be valid Python expressions, each of which will be evaluated
2279 should be valid Python expressions, each of which will be evaluated
2280 in the user namespace.
2280 in the user namespace.
2281
2281
2282 Returns
2282 Returns
2283 -------
2283 -------
2284 A dict, keyed like the input expressions dict, with the repr() of each
2284 A dict, keyed like the input expressions dict, with the repr() of each
2285 value.
2285 value.
2286 """
2286 """
2287 out = {}
2287 out = {}
2288 user_ns = self.user_ns
2288 user_ns = self.user_ns
2289 global_ns = self.user_global_ns
2289 global_ns = self.user_global_ns
2290 for key, expr in expressions.iteritems():
2290 for key, expr in expressions.iteritems():
2291 try:
2291 try:
2292 value = repr(eval(expr, global_ns, user_ns))
2292 value = repr(eval(expr, global_ns, user_ns))
2293 except:
2293 except:
2294 value = self._simple_error()
2294 value = self._simple_error()
2295 out[key] = value
2295 out[key] = value
2296 return out
2296 return out
2297
2297
2298 #-------------------------------------------------------------------------
2298 #-------------------------------------------------------------------------
2299 # Things related to the running of code
2299 # Things related to the running of code
2300 #-------------------------------------------------------------------------
2300 #-------------------------------------------------------------------------
2301
2301
2302 def ex(self, cmd):
2302 def ex(self, cmd):
2303 """Execute a normal python statement in user namespace."""
2303 """Execute a normal python statement in user namespace."""
2304 with self.builtin_trap:
2304 with self.builtin_trap:
2305 exec cmd in self.user_global_ns, self.user_ns
2305 exec cmd in self.user_global_ns, self.user_ns
2306
2306
2307 def ev(self, expr):
2307 def ev(self, expr):
2308 """Evaluate python expression expr in user namespace.
2308 """Evaluate python expression expr in user namespace.
2309
2309
2310 Returns the result of evaluation
2310 Returns the result of evaluation
2311 """
2311 """
2312 with self.builtin_trap:
2312 with self.builtin_trap:
2313 return eval(expr, self.user_global_ns, self.user_ns)
2313 return eval(expr, self.user_global_ns, self.user_ns)
2314
2314
2315 def safe_execfile(self, fname, *where, **kw):
2315 def safe_execfile(self, fname, *where, **kw):
2316 """A safe version of the builtin execfile().
2316 """A safe version of the builtin execfile().
2317
2317
2318 This version will never throw an exception, but instead print
2318 This version will never throw an exception, but instead print
2319 helpful error messages to the screen. This only works on pure
2319 helpful error messages to the screen. This only works on pure
2320 Python files with the .py extension.
2320 Python files with the .py extension.
2321
2321
2322 Parameters
2322 Parameters
2323 ----------
2323 ----------
2324 fname : string
2324 fname : string
2325 The name of the file to be executed.
2325 The name of the file to be executed.
2326 where : tuple
2326 where : tuple
2327 One or two namespaces, passed to execfile() as (globals,locals).
2327 One or two namespaces, passed to execfile() as (globals,locals).
2328 If only one is given, it is passed as both.
2328 If only one is given, it is passed as both.
2329 exit_ignore : bool (False)
2329 exit_ignore : bool (False)
2330 If True, then silence SystemExit for non-zero status (it is always
2330 If True, then silence SystemExit for non-zero status (it is always
2331 silenced for zero status, as it is so common).
2331 silenced for zero status, as it is so common).
2332 raise_exceptions : bool (False)
2332 raise_exceptions : bool (False)
2333 If True raise exceptions everywhere. Meant for testing.
2333 If True raise exceptions everywhere. Meant for testing.
2334
2334
2335 """
2335 """
2336 kw.setdefault('exit_ignore', False)
2336 kw.setdefault('exit_ignore', False)
2337 kw.setdefault('raise_exceptions', False)
2337 kw.setdefault('raise_exceptions', False)
2338
2338
2339 fname = os.path.abspath(os.path.expanduser(fname))
2339 fname = os.path.abspath(os.path.expanduser(fname))
2340
2340
2341 # Make sure we can open the file
2341 # Make sure we can open the file
2342 try:
2342 try:
2343 with open(fname) as thefile:
2343 with open(fname) as thefile:
2344 pass
2344 pass
2345 except:
2345 except:
2346 warn('Could not open file <%s> for safe execution.' % fname)
2346 warn('Could not open file <%s> for safe execution.' % fname)
2347 return
2347 return
2348
2348
2349 # Find things also in current directory. This is needed to mimic the
2349 # Find things also in current directory. This is needed to mimic the
2350 # behavior of running a script from the system command line, where
2350 # behavior of running a script from the system command line, where
2351 # Python inserts the script's directory into sys.path
2351 # Python inserts the script's directory into sys.path
2352 dname = os.path.dirname(fname)
2352 dname = os.path.dirname(fname)
2353
2353
2354 with prepended_to_syspath(dname):
2354 with prepended_to_syspath(dname):
2355 try:
2355 try:
2356 py3compat.execfile(fname,*where)
2356 py3compat.execfile(fname,*where)
2357 except SystemExit, status:
2357 except SystemExit, status:
2358 # If the call was made with 0 or None exit status (sys.exit(0)
2358 # 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
2359 # or sys.exit() ), don't bother showing a traceback, as both of
2360 # these are considered normal by the OS:
2360 # these are considered normal by the OS:
2361 # > python -c'import sys;sys.exit(0)'; echo $?
2361 # > python -c'import sys;sys.exit(0)'; echo $?
2362 # 0
2362 # 0
2363 # > python -c'import sys;sys.exit()'; echo $?
2363 # > python -c'import sys;sys.exit()'; echo $?
2364 # 0
2364 # 0
2365 # For other exit status, we show the exception unless
2365 # For other exit status, we show the exception unless
2366 # explicitly silenced, but only in short form.
2366 # explicitly silenced, but only in short form.
2367 if kw['raise_exceptions']:
2367 if kw['raise_exceptions']:
2368 raise
2368 raise
2369 if status.code not in (0, None) and not kw['exit_ignore']:
2369 if status.code not in (0, None) and not kw['exit_ignore']:
2370 self.showtraceback(exception_only=True)
2370 self.showtraceback(exception_only=True)
2371 except:
2371 except:
2372 if kw['raise_exceptions']:
2372 if kw['raise_exceptions']:
2373 raise
2373 raise
2374 self.showtraceback()
2374 self.showtraceback()
2375
2375
2376 def safe_execfile_ipy(self, fname):
2376 def safe_execfile_ipy(self, fname):
2377 """Like safe_execfile, but for .ipy files with IPython syntax.
2377 """Like safe_execfile, but for .ipy files with IPython syntax.
2378
2378
2379 Parameters
2379 Parameters
2380 ----------
2380 ----------
2381 fname : str
2381 fname : str
2382 The name of the file to execute. The filename must have a
2382 The name of the file to execute. The filename must have a
2383 .ipy extension.
2383 .ipy extension.
2384 """
2384 """
2385 fname = os.path.abspath(os.path.expanduser(fname))
2385 fname = os.path.abspath(os.path.expanduser(fname))
2386
2386
2387 # Make sure we can open the file
2387 # Make sure we can open the file
2388 try:
2388 try:
2389 with open(fname) as thefile:
2389 with open(fname) as thefile:
2390 pass
2390 pass
2391 except:
2391 except:
2392 warn('Could not open file <%s> for safe execution.' % fname)
2392 warn('Could not open file <%s> for safe execution.' % fname)
2393 return
2393 return
2394
2394
2395 # Find things also in current directory. This is needed to mimic the
2395 # Find things also in current directory. This is needed to mimic the
2396 # behavior of running a script from the system command line, where
2396 # behavior of running a script from the system command line, where
2397 # Python inserts the script's directory into sys.path
2397 # Python inserts the script's directory into sys.path
2398 dname = os.path.dirname(fname)
2398 dname = os.path.dirname(fname)
2399
2399
2400 with prepended_to_syspath(dname):
2400 with prepended_to_syspath(dname):
2401 try:
2401 try:
2402 with open(fname) as thefile:
2402 with open(fname) as thefile:
2403 # self.run_cell currently captures all exceptions
2403 # self.run_cell currently captures all exceptions
2404 # raised in user code. It would be nice if there were
2404 # raised in user code. It would be nice if there were
2405 # versions of runlines, execfile that did raise, so
2405 # versions of runlines, execfile that did raise, so
2406 # we could catch the errors.
2406 # we could catch the errors.
2407 self.run_cell(thefile.read(), store_history=False)
2407 self.run_cell(thefile.read(), store_history=False)
2408 except:
2408 except:
2409 self.showtraceback()
2409 self.showtraceback()
2410 warn('Unknown failure executing file: <%s>' % fname)
2410 warn('Unknown failure executing file: <%s>' % fname)
2411
2411
2412 def safe_run_module(self, mod_name, where):
2412 def safe_run_module(self, mod_name, where):
2413 """A safe version of runpy.run_module().
2413 """A safe version of runpy.run_module().
2414
2414
2415 This version will never throw an exception, but instead print
2415 This version will never throw an exception, but instead print
2416 helpful error messages to the screen.
2416 helpful error messages to the screen.
2417
2417
2418 Parameters
2418 Parameters
2419 ----------
2419 ----------
2420 mod_name : string
2420 mod_name : string
2421 The name of the module to be executed.
2421 The name of the module to be executed.
2422 where : dict
2422 where : dict
2423 The globals namespace.
2423 The globals namespace.
2424 """
2424 """
2425 try:
2425 try:
2426 where.update(
2426 where.update(
2427 runpy.run_module(str(mod_name), run_name="__main__",
2427 runpy.run_module(str(mod_name), run_name="__main__",
2428 alter_sys=True)
2428 alter_sys=True)
2429 )
2429 )
2430 except:
2430 except:
2431 self.showtraceback()
2431 self.showtraceback()
2432 warn('Unknown failure executing module: <%s>' % mod_name)
2432 warn('Unknown failure executing module: <%s>' % mod_name)
2433
2433
2434 def run_cell(self, raw_cell, store_history=False, silent=False):
2434 def run_cell(self, raw_cell, store_history=False, silent=False):
2435 """Run a complete IPython cell.
2435 """Run a complete IPython cell.
2436
2436
2437 Parameters
2437 Parameters
2438 ----------
2438 ----------
2439 raw_cell : str
2439 raw_cell : str
2440 The code (including IPython code such as %magic functions) to run.
2440 The code (including IPython code such as %magic functions) to run.
2441 store_history : bool
2441 store_history : bool
2442 If True, the raw and translated cell will be stored in IPython's
2442 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
2443 history. For user code calling back into IPython's machinery, this
2444 should be set to False.
2444 should be set to False.
2445 silent : bool
2445 silent : bool
2446 If True, avoid side-effets, such as implicit displayhooks, history,
2446 If True, avoid side-effets, such as implicit displayhooks, history,
2447 and logging. silent=True forces store_history=False.
2447 and logging. silent=True forces store_history=False.
2448 """
2448 """
2449 if (not raw_cell) or raw_cell.isspace():
2449 if (not raw_cell) or raw_cell.isspace():
2450 return
2450 return
2451
2451
2452 if silent:
2452 if silent:
2453 store_history = False
2453 store_history = False
2454
2454
2455 for line in raw_cell.splitlines():
2455 for line in raw_cell.splitlines():
2456 self.input_splitter.push(line)
2456 self.input_splitter.push(line)
2457 cell = self.input_splitter.source_reset()
2457 cell = self.input_splitter.source_reset()
2458
2458
2459 with self.builtin_trap:
2459 with self.builtin_trap:
2460 prefilter_failed = False
2460 prefilter_failed = False
2461 if len(cell.splitlines()) == 1:
2461 if len(cell.splitlines()) == 1:
2462 try:
2462 try:
2463 # use prefilter_lines to handle trailing newlines
2463 # use prefilter_lines to handle trailing newlines
2464 # restore trailing newline for ast.parse
2464 # restore trailing newline for ast.parse
2465 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2465 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2466 except AliasError as e:
2466 except AliasError as e:
2467 error(e)
2467 error(e)
2468 prefilter_failed = True
2468 prefilter_failed = True
2469 except Exception:
2469 except Exception:
2470 # don't allow prefilter errors to crash IPython
2470 # don't allow prefilter errors to crash IPython
2471 self.showtraceback()
2471 self.showtraceback()
2472 prefilter_failed = True
2472 prefilter_failed = True
2473
2473
2474 # Store raw and processed history
2474 # Store raw and processed history
2475 if store_history:
2475 if store_history:
2476 self.history_manager.store_inputs(self.execution_count,
2476 self.history_manager.store_inputs(self.execution_count,
2477 cell, raw_cell)
2477 cell, raw_cell)
2478 if not silent:
2478 if not silent:
2479 self.logger.log(cell, raw_cell)
2479 self.logger.log(cell, raw_cell)
2480
2480
2481 if not prefilter_failed:
2481 if not prefilter_failed:
2482 # don't run if prefilter failed
2482 # don't run if prefilter failed
2483 cell_name = self.compile.cache(cell, self.execution_count)
2483 cell_name = self.compile.cache(cell, self.execution_count)
2484
2484
2485 with self.display_trap:
2485 with self.display_trap:
2486 try:
2486 try:
2487 code_ast = self.compile.ast_parse(cell, filename=cell_name)
2487 code_ast = self.compile.ast_parse(cell, filename=cell_name)
2488 except IndentationError:
2488 except IndentationError:
2489 self.showindentationerror()
2489 self.showindentationerror()
2490 if store_history:
2490 if store_history:
2491 self.execution_count += 1
2491 self.execution_count += 1
2492 return None
2492 return None
2493 except (OverflowError, SyntaxError, ValueError, TypeError,
2493 except (OverflowError, SyntaxError, ValueError, TypeError,
2494 MemoryError):
2494 MemoryError):
2495 self.showsyntaxerror()
2495 self.showsyntaxerror()
2496 if store_history:
2496 if store_history:
2497 self.execution_count += 1
2497 self.execution_count += 1
2498 return None
2498 return None
2499
2499
2500 interactivity = "none" if silent else "last_expr"
2500 interactivity = "none" if silent else "last_expr"
2501 self.run_ast_nodes(code_ast.body, cell_name,
2501 self.run_ast_nodes(code_ast.body, cell_name,
2502 interactivity=interactivity)
2502 interactivity=interactivity)
2503
2503
2504 # Execute any registered post-execution functions.
2504 # Execute any registered post-execution functions.
2505 # unless we are silent
2505 # unless we are silent
2506 post_exec = [] if silent else self._post_execute.iteritems()
2506 post_exec = [] if silent else self._post_execute.iteritems()
2507
2507
2508 for func, status in post_exec:
2508 for func, status in post_exec:
2509 if self.disable_failing_post_execute and not status:
2509 if self.disable_failing_post_execute and not status:
2510 continue
2510 continue
2511 try:
2511 try:
2512 func()
2512 func()
2513 except KeyboardInterrupt:
2513 except KeyboardInterrupt:
2514 print >> io.stderr, "\nKeyboardInterrupt"
2514 print >> io.stderr, "\nKeyboardInterrupt"
2515 except Exception:
2515 except Exception:
2516 # register as failing:
2516 # register as failing:
2517 self._post_execute[func] = False
2517 self._post_execute[func] = False
2518 self.showtraceback()
2518 self.showtraceback()
2519 print >> io.stderr, '\n'.join([
2519 print >> io.stderr, '\n'.join([
2520 "post-execution function %r produced an error." % func,
2520 "post-execution function %r produced an error." % func,
2521 "If this problem persists, you can disable failing post-exec functions with:",
2521 "If this problem persists, you can disable failing post-exec functions with:",
2522 "",
2522 "",
2523 " get_ipython().disable_failing_post_execute = True"
2523 " get_ipython().disable_failing_post_execute = True"
2524 ])
2524 ])
2525
2525
2526 if store_history:
2526 if store_history:
2527 # Write output to the database. Does nothing unless
2527 # Write output to the database. Does nothing unless
2528 # history output logging is enabled.
2528 # history output logging is enabled.
2529 self.history_manager.store_output(self.execution_count)
2529 self.history_manager.store_output(self.execution_count)
2530 # Each cell is a *single* input, regardless of how many lines it has
2530 # Each cell is a *single* input, regardless of how many lines it has
2531 self.execution_count += 1
2531 self.execution_count += 1
2532
2532
2533 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2533 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2534 """Run a sequence of AST nodes. The execution mode depends on the
2534 """Run a sequence of AST nodes. The execution mode depends on the
2535 interactivity parameter.
2535 interactivity parameter.
2536
2536
2537 Parameters
2537 Parameters
2538 ----------
2538 ----------
2539 nodelist : list
2539 nodelist : list
2540 A sequence of AST nodes to run.
2540 A sequence of AST nodes to run.
2541 cell_name : str
2541 cell_name : str
2542 Will be passed to the compiler as the filename of the cell. Typically
2542 Will be passed to the compiler as the filename of the cell. Typically
2543 the value returned by ip.compile.cache(cell).
2543 the value returned by ip.compile.cache(cell).
2544 interactivity : str
2544 interactivity : str
2545 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2545 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2546 run interactively (displaying output from expressions). 'last_expr'
2546 run interactively (displaying output from expressions). 'last_expr'
2547 will run the last node interactively only if it is an expression (i.e.
2547 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
2548 expressions in loops or other blocks are not displayed. Other values
2549 for this parameter will raise a ValueError.
2549 for this parameter will raise a ValueError.
2550 """
2550 """
2551 if not nodelist:
2551 if not nodelist:
2552 return
2552 return
2553
2553
2554 if interactivity == 'last_expr':
2554 if interactivity == 'last_expr':
2555 if isinstance(nodelist[-1], ast.Expr):
2555 if isinstance(nodelist[-1], ast.Expr):
2556 interactivity = "last"
2556 interactivity = "last"
2557 else:
2557 else:
2558 interactivity = "none"
2558 interactivity = "none"
2559
2559
2560 if interactivity == 'none':
2560 if interactivity == 'none':
2561 to_run_exec, to_run_interactive = nodelist, []
2561 to_run_exec, to_run_interactive = nodelist, []
2562 elif interactivity == 'last':
2562 elif interactivity == 'last':
2563 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2563 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2564 elif interactivity == 'all':
2564 elif interactivity == 'all':
2565 to_run_exec, to_run_interactive = [], nodelist
2565 to_run_exec, to_run_interactive = [], nodelist
2566 else:
2566 else:
2567 raise ValueError("Interactivity was %r" % interactivity)
2567 raise ValueError("Interactivity was %r" % interactivity)
2568
2568
2569 exec_count = self.execution_count
2569 exec_count = self.execution_count
2570
2570
2571 try:
2571 try:
2572 for i, node in enumerate(to_run_exec):
2572 for i, node in enumerate(to_run_exec):
2573 mod = ast.Module([node])
2573 mod = ast.Module([node])
2574 code = self.compile(mod, cell_name, "exec")
2574 code = self.compile(mod, cell_name, "exec")
2575 if self.run_code(code):
2575 if self.run_code(code):
2576 return True
2576 return True
2577
2577
2578 for i, node in enumerate(to_run_interactive):
2578 for i, node in enumerate(to_run_interactive):
2579 mod = ast.Interactive([node])
2579 mod = ast.Interactive([node])
2580 code = self.compile(mod, cell_name, "single")
2580 code = self.compile(mod, cell_name, "single")
2581 if self.run_code(code):
2581 if self.run_code(code):
2582 return True
2582 return True
2583
2583
2584 # Flush softspace
2584 # Flush softspace
2585 if softspace(sys.stdout, 0):
2585 if softspace(sys.stdout, 0):
2586 print
2586 print
2587
2587
2588 except:
2588 except:
2589 # It's possible to have exceptions raised here, typically by
2589 # It's possible to have exceptions raised here, typically by
2590 # compilation of odd code (such as a naked 'return' outside a
2590 # compilation of odd code (such as a naked 'return' outside a
2591 # function) that did parse but isn't valid. Typically the exception
2591 # 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
2592 # is a SyntaxError, but it's safest just to catch anything and show
2593 # the user a traceback.
2593 # the user a traceback.
2594
2594
2595 # We do only one try/except outside the loop to minimize the impact
2595 # 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
2596 # on runtime, and also because if any node in the node list is
2597 # broken, we should stop execution completely.
2597 # broken, we should stop execution completely.
2598 self.showtraceback()
2598 self.showtraceback()
2599
2599
2600 return False
2600 return False
2601
2601
2602 def run_code(self, code_obj):
2602 def run_code(self, code_obj):
2603 """Execute a code object.
2603 """Execute a code object.
2604
2604
2605 When an exception occurs, self.showtraceback() is called to display a
2605 When an exception occurs, self.showtraceback() is called to display a
2606 traceback.
2606 traceback.
2607
2607
2608 Parameters
2608 Parameters
2609 ----------
2609 ----------
2610 code_obj : code object
2610 code_obj : code object
2611 A compiled code object, to be executed
2611 A compiled code object, to be executed
2612
2612
2613 Returns
2613 Returns
2614 -------
2614 -------
2615 False : successful execution.
2615 False : successful execution.
2616 True : an error occurred.
2616 True : an error occurred.
2617 """
2617 """
2618
2618
2619 # Set our own excepthook in case the user code tries to call it
2619 # 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
2620 # directly, so that the IPython crash handler doesn't get triggered
2621 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2621 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2622
2622
2623 # we save the original sys.excepthook in the instance, in case config
2623 # we save the original sys.excepthook in the instance, in case config
2624 # code (such as magics) needs access to it.
2624 # code (such as magics) needs access to it.
2625 self.sys_excepthook = old_excepthook
2625 self.sys_excepthook = old_excepthook
2626 outflag = 1 # happens in more places, so it's easier as default
2626 outflag = 1 # happens in more places, so it's easier as default
2627 try:
2627 try:
2628 try:
2628 try:
2629 self.hooks.pre_run_code_hook()
2629 self.hooks.pre_run_code_hook()
2630 #rprint('Running code', repr(code_obj)) # dbg
2630 #rprint('Running code', repr(code_obj)) # dbg
2631 exec code_obj in self.user_global_ns, self.user_ns
2631 exec code_obj in self.user_global_ns, self.user_ns
2632 finally:
2632 finally:
2633 # Reset our crash handler in place
2633 # Reset our crash handler in place
2634 sys.excepthook = old_excepthook
2634 sys.excepthook = old_excepthook
2635 except SystemExit:
2635 except SystemExit:
2636 self.showtraceback(exception_only=True)
2636 self.showtraceback(exception_only=True)
2637 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2637 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2638 except self.custom_exceptions:
2638 except self.custom_exceptions:
2639 etype,value,tb = sys.exc_info()
2639 etype,value,tb = sys.exc_info()
2640 self.CustomTB(etype,value,tb)
2640 self.CustomTB(etype,value,tb)
2641 except:
2641 except:
2642 self.showtraceback()
2642 self.showtraceback()
2643 else:
2643 else:
2644 outflag = 0
2644 outflag = 0
2645 return outflag
2645 return outflag
2646
2646
2647 # For backwards compatibility
2647 # For backwards compatibility
2648 runcode = run_code
2648 runcode = run_code
2649
2649
2650 #-------------------------------------------------------------------------
2650 #-------------------------------------------------------------------------
2651 # Things related to GUI support and pylab
2651 # Things related to GUI support and pylab
2652 #-------------------------------------------------------------------------
2652 #-------------------------------------------------------------------------
2653
2653
2654 def enable_gui(self, gui=None):
2654 def enable_gui(self, gui=None):
2655 raise NotImplementedError('Implement enable_gui in a subclass')
2655 raise NotImplementedError('Implement enable_gui in a subclass')
2656
2656
2657 def enable_pylab(self, gui=None, import_all=True):
2657 def enable_pylab(self, gui=None, import_all=True):
2658 """Activate pylab support at runtime.
2658 """Activate pylab support at runtime.
2659
2659
2660 This turns on support for matplotlib, preloads into the interactive
2660 This turns on support for matplotlib, preloads into the interactive
2661 namespace all of numpy and pylab, and configures IPython to correctly
2661 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
2662 interact with the GUI event loop. The GUI backend to be used can be
2663 optionally selected with the optional :param:`gui` argument.
2663 optionally selected with the optional :param:`gui` argument.
2664
2664
2665 Parameters
2665 Parameters
2666 ----------
2666 ----------
2667 gui : optional, string
2667 gui : optional, string
2668
2668
2669 If given, dictates the choice of matplotlib GUI backend to use
2669 If given, dictates the choice of matplotlib GUI backend to use
2670 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2670 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2671 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2671 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2672 matplotlib (as dictated by the matplotlib build-time options plus the
2672 matplotlib (as dictated by the matplotlib build-time options plus the
2673 user's matplotlibrc configuration file). Note that not all backends
2673 user's matplotlibrc configuration file). Note that not all backends
2674 make sense in all contexts, for example a terminal ipython can't
2674 make sense in all contexts, for example a terminal ipython can't
2675 display figures inline.
2675 display figures inline.
2676 """
2676 """
2677 from IPython.core.pylabtools import mpl_runner
2677 from IPython.core.pylabtools import mpl_runner
2678 # We want to prevent the loading of pylab to pollute the user's
2678 # 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
2679 # 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
2680 # code in an empty namespace, and we update *both* user_ns and
2681 # user_ns_hidden with this information.
2681 # user_ns_hidden with this information.
2682 ns = {}
2682 ns = {}
2683 try:
2683 try:
2684 gui = pylab_activate(ns, gui, import_all, self)
2684 gui = pylab_activate(ns, gui, import_all, self)
2685 except KeyError:
2685 except KeyError:
2686 error("Backend %r not supported" % gui)
2686 error("Backend %r not supported" % gui)
2687 return
2687 return
2688 self.user_ns.update(ns)
2688 self.user_ns.update(ns)
2689 self.user_ns_hidden.update(ns)
2689 self.user_ns_hidden.update(ns)
2690 # Now we must activate the gui pylab wants to use, and fix %run to take
2690 # Now we must activate the gui pylab wants to use, and fix %run to take
2691 # plot updates into account
2691 # plot updates into account
2692 self.enable_gui(gui)
2692 self.enable_gui(gui)
2693 self._magic.default_runner = mpl_runner(self.safe_execfile)
2693 self._magic.default_runner = mpl_runner(self.safe_execfile)
2694
2694
2695 #-------------------------------------------------------------------------
2695 #-------------------------------------------------------------------------
2696 # Utilities
2696 # Utilities
2697 #-------------------------------------------------------------------------
2697 #-------------------------------------------------------------------------
2698
2698
2699 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2699 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2700 """Expand python variables in a string.
2700 """Expand python variables in a string.
2701
2701
2702 The depth argument indicates how many frames above the caller should
2702 The depth argument indicates how many frames above the caller should
2703 be walked to look for the local namespace where to expand variables.
2703 be walked to look for the local namespace where to expand variables.
2704
2704
2705 The global namespace for expansion is always the user's interactive
2705 The global namespace for expansion is always the user's interactive
2706 namespace.
2706 namespace.
2707 """
2707 """
2708 ns = self.user_ns.copy()
2708 ns = self.user_ns.copy()
2709 ns.update(sys._getframe(depth+1).f_locals)
2709 ns.update(sys._getframe(depth+1).f_locals)
2710 ns.pop('self', None)
2710 ns.pop('self', None)
2711 try:
2711 try:
2712 cmd = formatter.format(cmd, **ns)
2712 cmd = formatter.format(cmd, **ns)
2713 except Exception:
2713 except Exception:
2714 # if formatter couldn't format, just let it go untransformed
2714 # if formatter couldn't format, just let it go untransformed
2715 pass
2715 pass
2716 return cmd
2716 return cmd
2717
2717
2718 def mktempfile(self, data=None, prefix='ipython_edit_'):
2718 def mktempfile(self, data=None, prefix='ipython_edit_'):
2719 """Make a new tempfile and return its filename.
2719 """Make a new tempfile and return its filename.
2720
2720
2721 This makes a call to tempfile.mktemp, but it registers the created
2721 This makes a call to tempfile.mktemp, but it registers the created
2722 filename internally so ipython cleans it up at exit time.
2722 filename internally so ipython cleans it up at exit time.
2723
2723
2724 Optional inputs:
2724 Optional inputs:
2725
2725
2726 - data(None): if data is given, it gets written out to the temp file
2726 - data(None): if data is given, it gets written out to the temp file
2727 immediately, and the file is closed again."""
2727 immediately, and the file is closed again."""
2728
2728
2729 filename = tempfile.mktemp('.py', prefix)
2729 filename = tempfile.mktemp('.py', prefix)
2730 self.tempfiles.append(filename)
2730 self.tempfiles.append(filename)
2731
2731
2732 if data:
2732 if data:
2733 tmp_file = open(filename,'w')
2733 tmp_file = open(filename,'w')
2734 tmp_file.write(data)
2734 tmp_file.write(data)
2735 tmp_file.close()
2735 tmp_file.close()
2736 return filename
2736 return filename
2737
2737
2738 # TODO: This should be removed when Term is refactored.
2738 # TODO: This should be removed when Term is refactored.
2739 def write(self,data):
2739 def write(self,data):
2740 """Write a string to the default output"""
2740 """Write a string to the default output"""
2741 io.stdout.write(data)
2741 io.stdout.write(data)
2742
2742
2743 # TODO: This should be removed when Term is refactored.
2743 # TODO: This should be removed when Term is refactored.
2744 def write_err(self,data):
2744 def write_err(self,data):
2745 """Write a string to the default error output"""
2745 """Write a string to the default error output"""
2746 io.stderr.write(data)
2746 io.stderr.write(data)
2747
2747
2748 def ask_yes_no(self, prompt, default=None):
2748 def ask_yes_no(self, prompt, default=None):
2749 if self.quiet:
2749 if self.quiet:
2750 return True
2750 return True
2751 return ask_yes_no(prompt,default)
2751 return ask_yes_no(prompt,default)
2752
2752
2753 def show_usage(self):
2753 def show_usage(self):
2754 """Show a usage message"""
2754 """Show a usage message"""
2755 page.page(IPython.core.usage.interactive_usage)
2755 page.page(IPython.core.usage.interactive_usage)
2756
2756
2757 def extract_input_lines(self, range_str, raw=False):
2758 """Return as a string a set of input history slices.
2759
2760 Parameters
2761 ----------
2762 range_str : string
2763 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 arguments as strings. The number before the / is the session
2766 number: ~n goes n back from the current session.
2767
2768 Optional Parameters:
2769 - raw(False): by default, the processed input is used. If this is
2770 true, the raw input history is used instead.
2771
2772 Note that slices can be called with two notations:
2773
2774 N:M -> standard python form, means including items N...(M-1).
2775
2776 N-M -> include items N..M (closed endpoint)."""
2777 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
2778 return "\n".join(x for _, _, x in lines)
2779
2757 def find_user_code(self, target, raw=True, py_only=False):
2780 def find_user_code(self, target, raw=True, py_only=False):
2758 """Get a code string from history, file, url, or a string or macro.
2781 """Get a code string from history, file, url, or a string or macro.
2759
2782
2760 This is mainly used by magic functions.
2783 This is mainly used by magic functions.
2761
2784
2762 Parameters
2785 Parameters
2763 ----------
2786 ----------
2764
2787
2765 target : str
2788 target : str
2766
2789
2767 A string specifying code to retrieve. This will be tried respectively
2790 A string specifying code to retrieve. This will be tried respectively
2768 as: ranges of input history (see %history for syntax), url,
2791 as: ranges of input history (see %history for syntax), url,
2769 correspnding .py file, filename, or an expression evaluating to a
2792 correspnding .py file, filename, or an expression evaluating to a
2770 string or Macro in the user namespace.
2793 string or Macro in the user namespace.
2771
2794
2772 raw : bool
2795 raw : bool
2773 If true (default), retrieve raw history. Has no effect on the other
2796 If true (default), retrieve raw history. Has no effect on the other
2774 retrieval mechanisms.
2797 retrieval mechanisms.
2775
2798
2776 py_only : bool (default False)
2799 py_only : bool (default False)
2777 Only try to fetch python code, do not try alternative methods to decode file
2800 Only try to fetch python code, do not try alternative methods to decode file
2778 if unicode fails.
2801 if unicode fails.
2779
2802
2780 Returns
2803 Returns
2781 -------
2804 -------
2782 A string of code.
2805 A string of code.
2783
2806
2784 ValueError is raised if nothing is found, and TypeError if it evaluates
2807 ValueError is raised if nothing is found, and TypeError if it evaluates
2785 to an object of another type. In each case, .args[0] is a printable
2808 to an object of another type. In each case, .args[0] is a printable
2786 message.
2809 message.
2787 """
2810 """
2788 code = self.extract_input_lines(target, raw=raw) # Grab history
2811 code = self.extract_input_lines(target, raw=raw) # Grab history
2789 if code:
2812 if code:
2790 return code
2813 return code
2791 utarget = unquote_filename(target)
2814 utarget = unquote_filename(target)
2792 try:
2815 try:
2793 if utarget.startswith(('http://', 'https://')):
2816 if utarget.startswith(('http://', 'https://')):
2794 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2817 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2795 except UnicodeDecodeError:
2818 except UnicodeDecodeError:
2796 if not py_only :
2819 if not py_only :
2797 response = urllib.urlopen(target)
2820 response = urllib.urlopen(target)
2798 return response.read().decode('latin1')
2821 return response.read().decode('latin1')
2799 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2822 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2800
2823
2801 potential_target = [target]
2824 potential_target = [target]
2802 try :
2825 try :
2803 potential_target.insert(0,get_py_filename(target))
2826 potential_target.insert(0,get_py_filename(target))
2804 except IOError:
2827 except IOError:
2805 pass
2828 pass
2806
2829
2807 for tgt in potential_target :
2830 for tgt in potential_target :
2808 if os.path.isfile(tgt): # Read file
2831 if os.path.isfile(tgt): # Read file
2809 try :
2832 try :
2810 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2833 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2811 except UnicodeDecodeError :
2834 except UnicodeDecodeError :
2812 if not py_only :
2835 if not py_only :
2813 with io_open(tgt,'r', encoding='latin1') as f :
2836 with io_open(tgt,'r', encoding='latin1') as f :
2814 return f.read()
2837 return f.read()
2815 raise ValueError(("'%s' seem to be unreadable.") % target)
2838 raise ValueError(("'%s' seem to be unreadable.") % target)
2816
2839
2817 try: # User namespace
2840 try: # User namespace
2818 codeobj = eval(target, self.user_ns)
2841 codeobj = eval(target, self.user_ns)
2819 except Exception:
2842 except Exception:
2820 raise ValueError(("'%s' was not found in history, as a file, url, "
2843 raise ValueError(("'%s' was not found in history, as a file, url, "
2821 "nor in the user namespace.") % target)
2844 "nor in the user namespace.") % target)
2822 if isinstance(codeobj, basestring):
2845 if isinstance(codeobj, basestring):
2823 return codeobj
2846 return codeobj
2824 elif isinstance(codeobj, Macro):
2847 elif isinstance(codeobj, Macro):
2825 return codeobj.value
2848 return codeobj.value
2826
2849
2827 raise TypeError("%s is neither a string nor a macro." % target,
2850 raise TypeError("%s is neither a string nor a macro." % target,
2828 codeobj)
2851 codeobj)
2829
2852
2830 #-------------------------------------------------------------------------
2853 #-------------------------------------------------------------------------
2831 # Things related to IPython exiting
2854 # Things related to IPython exiting
2832 #-------------------------------------------------------------------------
2855 #-------------------------------------------------------------------------
2833 def atexit_operations(self):
2856 def atexit_operations(self):
2834 """This will be executed at the time of exit.
2857 """This will be executed at the time of exit.
2835
2858
2836 Cleanup operations and saving of persistent data that is done
2859 Cleanup operations and saving of persistent data that is done
2837 unconditionally by IPython should be performed here.
2860 unconditionally by IPython should be performed here.
2838
2861
2839 For things that may depend on startup flags or platform specifics (such
2862 For things that may depend on startup flags or platform specifics (such
2840 as having readline or not), register a separate atexit function in the
2863 as having readline or not), register a separate atexit function in the
2841 code that has the appropriate information, rather than trying to
2864 code that has the appropriate information, rather than trying to
2842 clutter
2865 clutter
2843 """
2866 """
2844 # Close the history session (this stores the end time and line count)
2867 # Close the history session (this stores the end time and line count)
2845 # this must be *before* the tempfile cleanup, in case of temporary
2868 # this must be *before* the tempfile cleanup, in case of temporary
2846 # history db
2869 # history db
2847 self.history_manager.end_session()
2870 self.history_manager.end_session()
2848
2871
2849 # Cleanup all tempfiles left around
2872 # Cleanup all tempfiles left around
2850 for tfile in self.tempfiles:
2873 for tfile in self.tempfiles:
2851 try:
2874 try:
2852 os.unlink(tfile)
2875 os.unlink(tfile)
2853 except OSError:
2876 except OSError:
2854 pass
2877 pass
2855
2878
2856 # Clear all user namespaces to release all references cleanly.
2879 # Clear all user namespaces to release all references cleanly.
2857 self.reset(new_session=False)
2880 self.reset(new_session=False)
2858
2881
2859 # Run user hooks
2882 # Run user hooks
2860 self.hooks.shutdown_hook()
2883 self.hooks.shutdown_hook()
2861
2884
2862 def cleanup(self):
2885 def cleanup(self):
2863 self.restore_sys_module_state()
2886 self.restore_sys_module_state()
2864
2887
2865
2888
2866 class InteractiveShellABC(object):
2889 class InteractiveShellABC(object):
2867 """An abstract base class for InteractiveShell."""
2890 """An abstract base class for InteractiveShell."""
2868 __metaclass__ = abc.ABCMeta
2891 __metaclass__ = abc.ABCMeta
2869
2892
2870 InteractiveShellABC.register(InteractiveShell)
2893 InteractiveShellABC.register(InteractiveShell)
@@ -1,3844 +1,3820 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-2007 Fernando Perez <fperez@colorado.edu>
8 # Copyright (C) 2008-2011 The IPython Development Team
8 # Copyright (C) 2008-2011 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 inspect
21 import inspect
22 import io
22 import io
23 import json
23 import json
24 import os
24 import os
25 import sys
25 import sys
26 import re
26 import re
27 import time
27 import time
28 import gc
28 import gc
29 from StringIO import StringIO
29 from StringIO import StringIO
30 from getopt import getopt,GetoptError
30 from getopt import getopt,GetoptError
31 from pprint import pformat
31 from pprint import pformat
32 from urllib2 import urlopen
32 from urllib2 import urlopen
33
33
34 # cProfile was added in Python2.5
34 # cProfile was added in Python2.5
35 try:
35 try:
36 import cProfile as profile
36 import cProfile as profile
37 import pstats
37 import pstats
38 except ImportError:
38 except ImportError:
39 # profile isn't bundled by default in Debian for license reasons
39 # profile isn't bundled by default in Debian for license reasons
40 try:
40 try:
41 import profile,pstats
41 import profile,pstats
42 except ImportError:
42 except ImportError:
43 profile = pstats = None
43 profile = pstats = None
44
44
45 from IPython.core import debugger, oinspect
45 from IPython.core import debugger, oinspect
46 from IPython.core.error import TryNext
46 from IPython.core.error import TryNext
47 from IPython.core.error import UsageError
47 from IPython.core.error import UsageError
48 from IPython.core.error import StdinNotImplementedError
48 from IPython.core.error import StdinNotImplementedError
49 from IPython.core.macro import Macro
49 from IPython.core.macro import Macro
50 from IPython.core import magic_arguments, page
50 from IPython.core import magic_arguments, page
51 from IPython.core.prefilter import ESC_MAGIC
51 from IPython.core.prefilter import ESC_MAGIC
52 from IPython.testing.skipdoctest import skip_doctest
52 from IPython.testing.skipdoctest import skip_doctest
53 from IPython.utils import py3compat
53 from IPython.utils import py3compat
54 from IPython.utils.encoding import DEFAULT_ENCODING
54 from IPython.utils.encoding import DEFAULT_ENCODING
55 from IPython.utils.io import file_read, nlprint
55 from IPython.utils.io import file_read, nlprint
56 from IPython.utils.module_paths import find_mod
56 from IPython.utils.module_paths import find_mod
57 from IPython.utils.path import get_py_filename, unquote_filename
57 from IPython.utils.path import get_py_filename, unquote_filename
58 from IPython.utils.process import arg_split, abbrev_cwd
58 from IPython.utils.process import arg_split, abbrev_cwd
59 from IPython.utils.terminal import set_term_title
59 from IPython.utils.terminal import set_term_title
60 from IPython.utils.text import format_screen
60 from IPython.utils.text import format_screen
61 from IPython.utils.timing import clock, clock2
61 from IPython.utils.timing import clock, clock2
62 from IPython.utils.warn import warn, error
62 from IPython.utils.warn import warn, error
63 from IPython.utils.ipstruct import Struct
63 from IPython.utils.ipstruct import Struct
64 from IPython.config.application import Application
64 from IPython.config.application import Application
65
65
66 #-----------------------------------------------------------------------------
66 #-----------------------------------------------------------------------------
67 # Utility functions
67 # Utility functions
68 #-----------------------------------------------------------------------------
68 #-----------------------------------------------------------------------------
69
69
70 def on_off(tag):
70 def on_off(tag):
71 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
71 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
72 return ['OFF','ON'][tag]
72 return ['OFF','ON'][tag]
73
73
74 class Bunch: pass
74 class Bunch: pass
75
75
76 def compress_dhist(dh):
76 def compress_dhist(dh):
77 head, tail = dh[:-10], dh[-10:]
77 head, tail = dh[:-10], dh[-10:]
78
78
79 newhead = []
79 newhead = []
80 done = set()
80 done = set()
81 for h in head:
81 for h in head:
82 if h in done:
82 if h in done:
83 continue
83 continue
84 newhead.append(h)
84 newhead.append(h)
85 done.add(h)
85 done.add(h)
86
86
87 return newhead + tail
87 return newhead + tail
88
88
89 def needs_local_scope(func):
89 def needs_local_scope(func):
90 """Decorator to mark magic functions which need to local scope to run."""
90 """Decorator to mark magic functions which need to local scope to run."""
91 func.needs_local_scope = True
91 func.needs_local_scope = True
92 return func
92 return func
93
93
94
94
95 # Used for exception handling in magic_edit
95 # Used for exception handling in magic_edit
96 class MacroToEdit(ValueError): pass
96 class MacroToEdit(ValueError): pass
97
97
98 #***************************************************************************
98 #***************************************************************************
99 # Main class implementing Magic functionality
99 # Main class implementing Magic functionality
100
100
101 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
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
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
103 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
104 # eventually this needs to be clarified.
104 # eventually this needs to be clarified.
105 # BG: This is because InteractiveShell inherits from this, but is itself a
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
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.
107 # make Magic a configurable that InteractiveShell does not subclass.
108
108
109 class Magic(object):
109 class Magic(object):
110 """Magic functions for InteractiveShell.
110 """Magic functions for InteractiveShell.
111
111
112 Shell functions which can be reached as %function_name. All magic
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
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 ../`
114 needs. This can make some functions easier to type, eg `%cd ../`
115 vs. `%cd("../")`
115 vs. `%cd("../")`
116
116
117 ALL definitions MUST begin with the prefix magic_. The user won't need it
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. """
118 at the command line, but it is is needed in the definition. """
119
119
120 # class globals
120 # class globals
121 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
121 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
122 'Automagic is ON, % prefix NOT needed for magic functions.']
122 'Automagic is ON, % prefix NOT needed for magic functions.']
123
123
124
124
125 configurables = None
125 configurables = None
126
126
127 default_runner = None
127 default_runner = None
128 #......................................................................
128 #......................................................................
129 # some utility functions
129 # some utility functions
130
130
131 def __init__(self, shell):
131 def __init__(self, shell):
132
132
133 self.options_table = {}
133 self.options_table = {}
134 if profile is None:
134 if profile is None:
135 self.magic_prun = self.profile_missing_notice
135 self.magic_prun = self.profile_missing_notice
136 self.shell = shell
136 self.shell = shell
137 if self.configurables is None:
137 if self.configurables is None:
138 self.configurables = []
138 self.configurables = []
139
139
140 # namespace for holding state we may need
140 # namespace for holding state we may need
141 self._magic_state = Bunch()
141 self._magic_state = Bunch()
142
142
143 def profile_missing_notice(self, *args, **kwargs):
143 def profile_missing_notice(self, *args, **kwargs):
144 error("""\
144 error("""\
145 The profile module could not be found. It has been removed from the standard
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
146 python packages because of its non-free license. To use profiling, install the
147 python-profiler package from non-free.""")
147 python-profiler package from non-free.""")
148
148
149 def default_option(self,fn,optstr):
149 def default_option(self,fn,optstr):
150 """Make an entry in the options_table for fn, with value optstr"""
150 """Make an entry in the options_table for fn, with value optstr"""
151
151
152 if fn not in self.lsmagic():
152 if fn not in self.lsmagic():
153 error("%s is not a magic function" % fn)
153 error("%s is not a magic function" % fn)
154 self.options_table[fn] = optstr
154 self.options_table[fn] = optstr
155
155
156 def lsmagic(self):
156 def lsmagic(self):
157 """Return a list of currently available magic functions.
157 """Return a list of currently available magic functions.
158
158
159 Gives a list of the bare names after mangling (['ls','cd', ...], not
159 Gives a list of the bare names after mangling (['ls','cd', ...], not
160 ['magic_ls','magic_cd',...]"""
160 ['magic_ls','magic_cd',...]"""
161
161
162 # FIXME. This needs a cleanup, in the way the magics list is built.
162 # FIXME. This needs a cleanup, in the way the magics list is built.
163
163
164 # magics in class definition
164 # magics in class definition
165 class_magic = lambda fn: fn.startswith('magic_') and \
165 class_magic = lambda fn: fn.startswith('magic_') and \
166 callable(Magic.__dict__[fn])
166 callable(Magic.__dict__[fn])
167 # in instance namespace (run-time user additions)
167 # in instance namespace (run-time user additions)
168 inst_magic = lambda fn: fn.startswith('magic_') and \
168 inst_magic = lambda fn: fn.startswith('magic_') and \
169 callable(self.__dict__[fn])
169 callable(self.__dict__[fn])
170 # and bound magics by user (so they can access self):
170 # and bound magics by user (so they can access self):
171 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
171 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
172 callable(self.__class__.__dict__[fn])
172 callable(self.__class__.__dict__[fn])
173 magics = filter(class_magic,Magic.__dict__.keys()) + \
173 magics = filter(class_magic,Magic.__dict__.keys()) + \
174 filter(inst_magic, self.__dict__.keys()) + \
174 filter(inst_magic, self.__dict__.keys()) + \
175 filter(inst_bound_magic, self.__class__.__dict__.keys())
175 filter(inst_bound_magic, self.__class__.__dict__.keys())
176 out = []
176 out = []
177 for fn in set(magics):
177 for fn in set(magics):
178 out.append(fn.replace('magic_','',1))
178 out.append(fn.replace('magic_','',1))
179 out.sort()
179 out.sort()
180 return out
180 return out
181
181
182 def extract_input_lines(self, range_str, raw=False):
183 """Return as a string a set of input history slices.
184
185 Parameters
186 ----------
187 range_str : string
188 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
189 since this function is for use by magic functions which get their
190 arguments as strings. The number before the / is the session
191 number: ~n goes n back from the current session.
192
193 Optional Parameters:
194 - raw(False): by default, the processed input is used. If this is
195 true, the raw input history is used instead.
196
197 Note that slices can be called with two notations:
198
199 N:M -> standard python form, means including items N...(M-1).
200
201 N-M -> include items N..M (closed endpoint)."""
202 lines = self.shell.history_manager.\
203 get_range_by_str(range_str, raw=raw)
204 return "\n".join(x for _, _, x in lines)
205
206 def arg_err(self,func):
182 def arg_err(self,func):
207 """Print docstring if incorrect arguments were passed"""
183 """Print docstring if incorrect arguments were passed"""
208 print 'Error in arguments:'
184 print 'Error in arguments:'
209 print oinspect.getdoc(func)
185 print oinspect.getdoc(func)
210
186
211 def format_latex(self,strng):
187 def format_latex(self,strng):
212 """Format a string for latex inclusion."""
188 """Format a string for latex inclusion."""
213
189
214 # Characters that need to be escaped for latex:
190 # Characters that need to be escaped for latex:
215 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
191 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
216 # Magic command names as headers:
192 # Magic command names as headers:
217 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
193 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
218 re.MULTILINE)
194 re.MULTILINE)
219 # Magic commands
195 # Magic commands
220 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
196 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
221 re.MULTILINE)
197 re.MULTILINE)
222 # Paragraph continue
198 # Paragraph continue
223 par_re = re.compile(r'\\$',re.MULTILINE)
199 par_re = re.compile(r'\\$',re.MULTILINE)
224
200
225 # The "\n" symbol
201 # The "\n" symbol
226 newline_re = re.compile(r'\\n')
202 newline_re = re.compile(r'\\n')
227
203
228 # Now build the string for output:
204 # Now build the string for output:
229 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
205 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
230 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
206 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
231 strng)
207 strng)
232 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
208 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
233 strng = par_re.sub(r'\\\\',strng)
209 strng = par_re.sub(r'\\\\',strng)
234 strng = escape_re.sub(r'\\\1',strng)
210 strng = escape_re.sub(r'\\\1',strng)
235 strng = newline_re.sub(r'\\textbackslash{}n',strng)
211 strng = newline_re.sub(r'\\textbackslash{}n',strng)
236 return strng
212 return strng
237
213
238 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
214 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
239 """Parse options passed to an argument string.
215 """Parse options passed to an argument string.
240
216
241 The interface is similar to that of getopt(), but it returns back a
217 The interface is similar to that of getopt(), but it returns back a
242 Struct with the options as keys and the stripped argument string still
218 Struct with the options as keys and the stripped argument string still
243 as a string.
219 as a string.
244
220
245 arg_str is quoted as a true sys.argv vector by using shlex.split.
221 arg_str is quoted as a true sys.argv vector by using shlex.split.
246 This allows us to easily expand variables, glob files, quote
222 This allows us to easily expand variables, glob files, quote
247 arguments, etc.
223 arguments, etc.
248
224
249 Options:
225 Options:
250 -mode: default 'string'. If given as 'list', the argument string is
226 -mode: default 'string'. If given as 'list', the argument string is
251 returned as a list (split on whitespace) instead of a string.
227 returned as a list (split on whitespace) instead of a string.
252
228
253 -list_all: put all option values in lists. Normally only options
229 -list_all: put all option values in lists. Normally only options
254 appearing more than once are put in a list.
230 appearing more than once are put in a list.
255
231
256 -posix (True): whether to split the input line in POSIX mode or not,
232 -posix (True): whether to split the input line in POSIX mode or not,
257 as per the conventions outlined in the shlex module from the
233 as per the conventions outlined in the shlex module from the
258 standard library."""
234 standard library."""
259
235
260 # inject default options at the beginning of the input line
236 # inject default options at the beginning of the input line
261 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
237 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
262 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
238 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
263
239
264 mode = kw.get('mode','string')
240 mode = kw.get('mode','string')
265 if mode not in ['string','list']:
241 if mode not in ['string','list']:
266 raise ValueError,'incorrect mode given: %s' % mode
242 raise ValueError,'incorrect mode given: %s' % mode
267 # Get options
243 # Get options
268 list_all = kw.get('list_all',0)
244 list_all = kw.get('list_all',0)
269 posix = kw.get('posix', os.name == 'posix')
245 posix = kw.get('posix', os.name == 'posix')
270 strict = kw.get('strict', True)
246 strict = kw.get('strict', True)
271
247
272 # Check if we have more than one argument to warrant extra processing:
248 # Check if we have more than one argument to warrant extra processing:
273 odict = {} # Dictionary with options
249 odict = {} # Dictionary with options
274 args = arg_str.split()
250 args = arg_str.split()
275 if len(args) >= 1:
251 if len(args) >= 1:
276 # If the list of inputs only has 0 or 1 thing in it, there's no
252 # If the list of inputs only has 0 or 1 thing in it, there's no
277 # need to look for options
253 # need to look for options
278 argv = arg_split(arg_str, posix, strict)
254 argv = arg_split(arg_str, posix, strict)
279 # Do regular option processing
255 # Do regular option processing
280 try:
256 try:
281 opts,args = getopt(argv,opt_str,*long_opts)
257 opts,args = getopt(argv,opt_str,*long_opts)
282 except GetoptError,e:
258 except GetoptError,e:
283 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
259 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
284 " ".join(long_opts)))
260 " ".join(long_opts)))
285 for o,a in opts:
261 for o,a in opts:
286 if o.startswith('--'):
262 if o.startswith('--'):
287 o = o[2:]
263 o = o[2:]
288 else:
264 else:
289 o = o[1:]
265 o = o[1:]
290 try:
266 try:
291 odict[o].append(a)
267 odict[o].append(a)
292 except AttributeError:
268 except AttributeError:
293 odict[o] = [odict[o],a]
269 odict[o] = [odict[o],a]
294 except KeyError:
270 except KeyError:
295 if list_all:
271 if list_all:
296 odict[o] = [a]
272 odict[o] = [a]
297 else:
273 else:
298 odict[o] = a
274 odict[o] = a
299
275
300 # Prepare opts,args for return
276 # Prepare opts,args for return
301 opts = Struct(odict)
277 opts = Struct(odict)
302 if mode == 'string':
278 if mode == 'string':
303 args = ' '.join(args)
279 args = ' '.join(args)
304
280
305 return opts,args
281 return opts,args
306
282
307 #......................................................................
283 #......................................................................
308 # And now the actual magic functions
284 # And now the actual magic functions
309
285
310 # Functions for IPython shell work (vars,funcs, config, etc)
286 # Functions for IPython shell work (vars,funcs, config, etc)
311 def magic_lsmagic(self, parameter_s = ''):
287 def magic_lsmagic(self, parameter_s = ''):
312 """List currently available magic functions."""
288 """List currently available magic functions."""
313 mesc = ESC_MAGIC
289 mesc = ESC_MAGIC
314 print 'Available magic functions:\n'+mesc+\
290 print 'Available magic functions:\n'+mesc+\
315 (' '+mesc).join(self.lsmagic())
291 (' '+mesc).join(self.lsmagic())
316 print '\n' + Magic.auto_status[self.shell.automagic]
292 print '\n' + Magic.auto_status[self.shell.automagic]
317 return None
293 return None
318
294
319 def magic_magic(self, parameter_s = ''):
295 def magic_magic(self, parameter_s = ''):
320 """Print information about the magic function system.
296 """Print information about the magic function system.
321
297
322 Supported formats: -latex, -brief, -rest
298 Supported formats: -latex, -brief, -rest
323 """
299 """
324
300
325 mode = ''
301 mode = ''
326 try:
302 try:
327 if parameter_s.split()[0] == '-latex':
303 if parameter_s.split()[0] == '-latex':
328 mode = 'latex'
304 mode = 'latex'
329 if parameter_s.split()[0] == '-brief':
305 if parameter_s.split()[0] == '-brief':
330 mode = 'brief'
306 mode = 'brief'
331 if parameter_s.split()[0] == '-rest':
307 if parameter_s.split()[0] == '-rest':
332 mode = 'rest'
308 mode = 'rest'
333 rest_docs = []
309 rest_docs = []
334 except:
310 except:
335 pass
311 pass
336
312
337 magic_docs = []
313 magic_docs = []
338 for fname in self.lsmagic():
314 for fname in self.lsmagic():
339 mname = 'magic_' + fname
315 mname = 'magic_' + fname
340 for space in (Magic, self, self.__class__):
316 for space in (Magic, self, self.__class__):
341 try:
317 try:
342 fn = space.__dict__[mname]
318 fn = space.__dict__[mname]
343 except KeyError:
319 except KeyError:
344 pass
320 pass
345 else:
321 else:
346 break
322 break
347 if mode == 'brief':
323 if mode == 'brief':
348 # only first line
324 # only first line
349 if fn.__doc__:
325 if fn.__doc__:
350 fndoc = fn.__doc__.split('\n',1)[0]
326 fndoc = fn.__doc__.split('\n',1)[0]
351 else:
327 else:
352 fndoc = 'No documentation'
328 fndoc = 'No documentation'
353 else:
329 else:
354 if fn.__doc__:
330 if fn.__doc__:
355 fndoc = fn.__doc__.rstrip()
331 fndoc = fn.__doc__.rstrip()
356 else:
332 else:
357 fndoc = 'No documentation'
333 fndoc = 'No documentation'
358
334
359
335
360 if mode == 'rest':
336 if mode == 'rest':
361 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
337 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
362 fname,fndoc))
338 fname,fndoc))
363
339
364 else:
340 else:
365 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
341 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
366 fname,fndoc))
342 fname,fndoc))
367
343
368 magic_docs = ''.join(magic_docs)
344 magic_docs = ''.join(magic_docs)
369
345
370 if mode == 'rest':
346 if mode == 'rest':
371 return "".join(rest_docs)
347 return "".join(rest_docs)
372
348
373 if mode == 'latex':
349 if mode == 'latex':
374 print self.format_latex(magic_docs)
350 print self.format_latex(magic_docs)
375 return
351 return
376 else:
352 else:
377 magic_docs = format_screen(magic_docs)
353 magic_docs = format_screen(magic_docs)
378 if mode == 'brief':
354 if mode == 'brief':
379 return magic_docs
355 return magic_docs
380
356
381 outmsg = """
357 outmsg = """
382 IPython's 'magic' functions
358 IPython's 'magic' functions
383 ===========================
359 ===========================
384
360
385 The magic function system provides a series of functions which allow you to
361 The magic function system provides a series of functions which allow you to
386 control the behavior of IPython itself, plus a lot of system-type
362 control the behavior of IPython itself, plus a lot of system-type
387 features. All these functions are prefixed with a % character, but parameters
363 features. All these functions are prefixed with a % character, but parameters
388 are given without parentheses or quotes.
364 are given without parentheses or quotes.
389
365
390 NOTE: If you have 'automagic' enabled (via the command line option or with the
366 NOTE: If you have 'automagic' enabled (via the command line option or with the
391 %automagic function), you don't need to type in the % explicitly. By default,
367 %automagic function), you don't need to type in the % explicitly. By default,
392 IPython ships with automagic on, so you should only rarely need the % escape.
368 IPython ships with automagic on, so you should only rarely need the % escape.
393
369
394 Example: typing '%cd mydir' (without the quotes) changes you working directory
370 Example: typing '%cd mydir' (without the quotes) changes you working directory
395 to 'mydir', if it exists.
371 to 'mydir', if it exists.
396
372
397 For a list of the available magic functions, use %lsmagic. For a description
373 For a list of the available magic functions, use %lsmagic. For a description
398 of any of them, type %magic_name?, e.g. '%cd?'.
374 of any of them, type %magic_name?, e.g. '%cd?'.
399
375
400 Currently the magic system has the following functions:\n"""
376 Currently the magic system has the following functions:\n"""
401
377
402 mesc = ESC_MAGIC
378 mesc = ESC_MAGIC
403 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
379 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
404 "\n\n%s%s\n\n%s" % (outmsg,
380 "\n\n%s%s\n\n%s" % (outmsg,
405 magic_docs,mesc,mesc,
381 magic_docs,mesc,mesc,
406 (' '+mesc).join(self.lsmagic()),
382 (' '+mesc).join(self.lsmagic()),
407 Magic.auto_status[self.shell.automagic] ) )
383 Magic.auto_status[self.shell.automagic] ) )
408 page.page(outmsg)
384 page.page(outmsg)
409
385
410 def magic_automagic(self, parameter_s = ''):
386 def magic_automagic(self, parameter_s = ''):
411 """Make magic functions callable without having to type the initial %.
387 """Make magic functions callable without having to type the initial %.
412
388
413 Without argumentsl toggles on/off (when off, you must call it as
389 Without argumentsl toggles on/off (when off, you must call it as
414 %automagic, of course). With arguments it sets the value, and you can
390 %automagic, of course). With arguments it sets the value, and you can
415 use any of (case insensitive):
391 use any of (case insensitive):
416
392
417 - on,1,True: to activate
393 - on,1,True: to activate
418
394
419 - off,0,False: to deactivate.
395 - off,0,False: to deactivate.
420
396
421 Note that magic functions have lowest priority, so if there's a
397 Note that magic functions have lowest priority, so if there's a
422 variable whose name collides with that of a magic fn, automagic won't
398 variable whose name collides with that of a magic fn, automagic won't
423 work for that function (you get the variable instead). However, if you
399 work for that function (you get the variable instead). However, if you
424 delete the variable (del var), the previously shadowed magic function
400 delete the variable (del var), the previously shadowed magic function
425 becomes visible to automagic again."""
401 becomes visible to automagic again."""
426
402
427 arg = parameter_s.lower()
403 arg = parameter_s.lower()
428 if parameter_s in ('on','1','true'):
404 if parameter_s in ('on','1','true'):
429 self.shell.automagic = True
405 self.shell.automagic = True
430 elif parameter_s in ('off','0','false'):
406 elif parameter_s in ('off','0','false'):
431 self.shell.automagic = False
407 self.shell.automagic = False
432 else:
408 else:
433 self.shell.automagic = not self.shell.automagic
409 self.shell.automagic = not self.shell.automagic
434 print '\n' + Magic.auto_status[self.shell.automagic]
410 print '\n' + Magic.auto_status[self.shell.automagic]
435
411
436 @skip_doctest
412 @skip_doctest
437 def magic_autocall(self, parameter_s = ''):
413 def magic_autocall(self, parameter_s = ''):
438 """Make functions callable without having to type parentheses.
414 """Make functions callable without having to type parentheses.
439
415
440 Usage:
416 Usage:
441
417
442 %autocall [mode]
418 %autocall [mode]
443
419
444 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
420 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
445 value is toggled on and off (remembering the previous state).
421 value is toggled on and off (remembering the previous state).
446
422
447 In more detail, these values mean:
423 In more detail, these values mean:
448
424
449 0 -> fully disabled
425 0 -> fully disabled
450
426
451 1 -> active, but do not apply if there are no arguments on the line.
427 1 -> active, but do not apply if there are no arguments on the line.
452
428
453 In this mode, you get::
429 In this mode, you get::
454
430
455 In [1]: callable
431 In [1]: callable
456 Out[1]: <built-in function callable>
432 Out[1]: <built-in function callable>
457
433
458 In [2]: callable 'hello'
434 In [2]: callable 'hello'
459 ------> callable('hello')
435 ------> callable('hello')
460 Out[2]: False
436 Out[2]: False
461
437
462 2 -> Active always. Even if no arguments are present, the callable
438 2 -> Active always. Even if no arguments are present, the callable
463 object is called::
439 object is called::
464
440
465 In [2]: float
441 In [2]: float
466 ------> float()
442 ------> float()
467 Out[2]: 0.0
443 Out[2]: 0.0
468
444
469 Note that even with autocall off, you can still use '/' at the start of
445 Note that even with autocall off, you can still use '/' at the start of
470 a line to treat the first argument on the command line as a function
446 a line to treat the first argument on the command line as a function
471 and add parentheses to it::
447 and add parentheses to it::
472
448
473 In [8]: /str 43
449 In [8]: /str 43
474 ------> str(43)
450 ------> str(43)
475 Out[8]: '43'
451 Out[8]: '43'
476
452
477 # all-random (note for auto-testing)
453 # all-random (note for auto-testing)
478 """
454 """
479
455
480 if parameter_s:
456 if parameter_s:
481 arg = int(parameter_s)
457 arg = int(parameter_s)
482 else:
458 else:
483 arg = 'toggle'
459 arg = 'toggle'
484
460
485 if not arg in (0,1,2,'toggle'):
461 if not arg in (0,1,2,'toggle'):
486 error('Valid modes: (0->Off, 1->Smart, 2->Full')
462 error('Valid modes: (0->Off, 1->Smart, 2->Full')
487 return
463 return
488
464
489 if arg in (0,1,2):
465 if arg in (0,1,2):
490 self.shell.autocall = arg
466 self.shell.autocall = arg
491 else: # toggle
467 else: # toggle
492 if self.shell.autocall:
468 if self.shell.autocall:
493 self._magic_state.autocall_save = self.shell.autocall
469 self._magic_state.autocall_save = self.shell.autocall
494 self.shell.autocall = 0
470 self.shell.autocall = 0
495 else:
471 else:
496 try:
472 try:
497 self.shell.autocall = self._magic_state.autocall_save
473 self.shell.autocall = self._magic_state.autocall_save
498 except AttributeError:
474 except AttributeError:
499 self.shell.autocall = self._magic_state.autocall_save = 1
475 self.shell.autocall = self._magic_state.autocall_save = 1
500
476
501 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
477 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
502
478
503
479
504 def magic_page(self, parameter_s=''):
480 def magic_page(self, parameter_s=''):
505 """Pretty print the object and display it through a pager.
481 """Pretty print the object and display it through a pager.
506
482
507 %page [options] OBJECT
483 %page [options] OBJECT
508
484
509 If no object is given, use _ (last output).
485 If no object is given, use _ (last output).
510
486
511 Options:
487 Options:
512
488
513 -r: page str(object), don't pretty-print it."""
489 -r: page str(object), don't pretty-print it."""
514
490
515 # After a function contributed by Olivier Aubert, slightly modified.
491 # After a function contributed by Olivier Aubert, slightly modified.
516
492
517 # Process options/args
493 # Process options/args
518 opts,args = self.parse_options(parameter_s,'r')
494 opts,args = self.parse_options(parameter_s,'r')
519 raw = 'r' in opts
495 raw = 'r' in opts
520
496
521 oname = args and args or '_'
497 oname = args and args or '_'
522 info = self._ofind(oname)
498 info = self._ofind(oname)
523 if info['found']:
499 if info['found']:
524 txt = (raw and str or pformat)( info['obj'] )
500 txt = (raw and str or pformat)( info['obj'] )
525 page.page(txt)
501 page.page(txt)
526 else:
502 else:
527 print 'Object `%s` not found' % oname
503 print 'Object `%s` not found' % oname
528
504
529 def magic_profile(self, parameter_s=''):
505 def magic_profile(self, parameter_s=''):
530 """Print your currently active IPython profile."""
506 """Print your currently active IPython profile."""
531 from IPython.core.application import BaseIPythonApplication
507 from IPython.core.application import BaseIPythonApplication
532 if BaseIPythonApplication.initialized():
508 if BaseIPythonApplication.initialized():
533 print BaseIPythonApplication.instance().profile
509 print BaseIPythonApplication.instance().profile
534 else:
510 else:
535 error("profile is an application-level value, but you don't appear to be in an IPython application")
511 error("profile is an application-level value, but you don't appear to be in an IPython application")
536
512
537 def magic_pinfo(self, parameter_s='', namespaces=None):
513 def magic_pinfo(self, parameter_s='', namespaces=None):
538 """Provide detailed information about an object.
514 """Provide detailed information about an object.
539
515
540 '%pinfo object' is just a synonym for object? or ?object."""
516 '%pinfo object' is just a synonym for object? or ?object."""
541
517
542 #print 'pinfo par: <%s>' % parameter_s # dbg
518 #print 'pinfo par: <%s>' % parameter_s # dbg
543
519
544
520
545 # detail_level: 0 -> obj? , 1 -> obj??
521 # detail_level: 0 -> obj? , 1 -> obj??
546 detail_level = 0
522 detail_level = 0
547 # We need to detect if we got called as 'pinfo pinfo foo', which can
523 # We need to detect if we got called as 'pinfo pinfo foo', which can
548 # happen if the user types 'pinfo foo?' at the cmd line.
524 # happen if the user types 'pinfo foo?' at the cmd line.
549 pinfo,qmark1,oname,qmark2 = \
525 pinfo,qmark1,oname,qmark2 = \
550 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
526 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
551 if pinfo or qmark1 or qmark2:
527 if pinfo or qmark1 or qmark2:
552 detail_level = 1
528 detail_level = 1
553 if "*" in oname:
529 if "*" in oname:
554 self.magic_psearch(oname)
530 self.magic_psearch(oname)
555 else:
531 else:
556 self.shell._inspect('pinfo', oname, detail_level=detail_level,
532 self.shell._inspect('pinfo', oname, detail_level=detail_level,
557 namespaces=namespaces)
533 namespaces=namespaces)
558
534
559 def magic_pinfo2(self, parameter_s='', namespaces=None):
535 def magic_pinfo2(self, parameter_s='', namespaces=None):
560 """Provide extra detailed information about an object.
536 """Provide extra detailed information about an object.
561
537
562 '%pinfo2 object' is just a synonym for object?? or ??object."""
538 '%pinfo2 object' is just a synonym for object?? or ??object."""
563 self.shell._inspect('pinfo', parameter_s, detail_level=1,
539 self.shell._inspect('pinfo', parameter_s, detail_level=1,
564 namespaces=namespaces)
540 namespaces=namespaces)
565
541
566 @skip_doctest
542 @skip_doctest
567 def magic_pdef(self, parameter_s='', namespaces=None):
543 def magic_pdef(self, parameter_s='', namespaces=None):
568 """Print the definition header for any callable object.
544 """Print the definition header for any callable object.
569
545
570 If the object is a class, print the constructor information.
546 If the object is a class, print the constructor information.
571
547
572 Examples
548 Examples
573 --------
549 --------
574 ::
550 ::
575
551
576 In [3]: %pdef urllib.urlopen
552 In [3]: %pdef urllib.urlopen
577 urllib.urlopen(url, data=None, proxies=None)
553 urllib.urlopen(url, data=None, proxies=None)
578 """
554 """
579 self._inspect('pdef',parameter_s, namespaces)
555 self._inspect('pdef',parameter_s, namespaces)
580
556
581 def magic_pdoc(self, parameter_s='', namespaces=None):
557 def magic_pdoc(self, parameter_s='', namespaces=None):
582 """Print the docstring for an object.
558 """Print the docstring for an object.
583
559
584 If the given object is a class, it will print both the class and the
560 If the given object is a class, it will print both the class and the
585 constructor docstrings."""
561 constructor docstrings."""
586 self._inspect('pdoc',parameter_s, namespaces)
562 self._inspect('pdoc',parameter_s, namespaces)
587
563
588 def magic_psource(self, parameter_s='', namespaces=None):
564 def magic_psource(self, parameter_s='', namespaces=None):
589 """Print (or run through pager) the source code for an object."""
565 """Print (or run through pager) the source code for an object."""
590 self._inspect('psource',parameter_s, namespaces)
566 self._inspect('psource',parameter_s, namespaces)
591
567
592 def magic_pfile(self, parameter_s=''):
568 def magic_pfile(self, parameter_s=''):
593 """Print (or run through pager) the file where an object is defined.
569 """Print (or run through pager) the file where an object is defined.
594
570
595 The file opens at the line where the object definition begins. IPython
571 The file opens at the line where the object definition begins. IPython
596 will honor the environment variable PAGER if set, and otherwise will
572 will honor the environment variable PAGER if set, and otherwise will
597 do its best to print the file in a convenient form.
573 do its best to print the file in a convenient form.
598
574
599 If the given argument is not an object currently defined, IPython will
575 If the given argument is not an object currently defined, IPython will
600 try to interpret it as a filename (automatically adding a .py extension
576 try to interpret it as a filename (automatically adding a .py extension
601 if needed). You can thus use %pfile as a syntax highlighting code
577 if needed). You can thus use %pfile as a syntax highlighting code
602 viewer."""
578 viewer."""
603
579
604 # first interpret argument as an object name
580 # first interpret argument as an object name
605 out = self._inspect('pfile',parameter_s)
581 out = self._inspect('pfile',parameter_s)
606 # if not, try the input as a filename
582 # if not, try the input as a filename
607 if out == 'not found':
583 if out == 'not found':
608 try:
584 try:
609 filename = get_py_filename(parameter_s)
585 filename = get_py_filename(parameter_s)
610 except IOError,msg:
586 except IOError,msg:
611 print msg
587 print msg
612 return
588 return
613 page.page(self.shell.inspector.format(open(filename).read()))
589 page.page(self.shell.inspector.format(open(filename).read()))
614
590
615 def magic_psearch(self, parameter_s=''):
591 def magic_psearch(self, parameter_s=''):
616 """Search for object in namespaces by wildcard.
592 """Search for object in namespaces by wildcard.
617
593
618 %psearch [options] PATTERN [OBJECT TYPE]
594 %psearch [options] PATTERN [OBJECT TYPE]
619
595
620 Note: ? can be used as a synonym for %psearch, at the beginning or at
596 Note: ? can be used as a synonym for %psearch, at the beginning or at
621 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
597 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
622 rest of the command line must be unchanged (options come first), so
598 rest of the command line must be unchanged (options come first), so
623 for example the following forms are equivalent
599 for example the following forms are equivalent
624
600
625 %psearch -i a* function
601 %psearch -i a* function
626 -i a* function?
602 -i a* function?
627 ?-i a* function
603 ?-i a* function
628
604
629 Arguments:
605 Arguments:
630
606
631 PATTERN
607 PATTERN
632
608
633 where PATTERN is a string containing * as a wildcard similar to its
609 where PATTERN is a string containing * as a wildcard similar to its
634 use in a shell. The pattern is matched in all namespaces on the
610 use in a shell. The pattern is matched in all namespaces on the
635 search path. By default objects starting with a single _ are not
611 search path. By default objects starting with a single _ are not
636 matched, many IPython generated objects have a single
612 matched, many IPython generated objects have a single
637 underscore. The default is case insensitive matching. Matching is
613 underscore. The default is case insensitive matching. Matching is
638 also done on the attributes of objects and not only on the objects
614 also done on the attributes of objects and not only on the objects
639 in a module.
615 in a module.
640
616
641 [OBJECT TYPE]
617 [OBJECT TYPE]
642
618
643 Is the name of a python type from the types module. The name is
619 Is the name of a python type from the types module. The name is
644 given in lowercase without the ending type, ex. StringType is
620 given in lowercase without the ending type, ex. StringType is
645 written string. By adding a type here only objects matching the
621 written string. By adding a type here only objects matching the
646 given type are matched. Using all here makes the pattern match all
622 given type are matched. Using all here makes the pattern match all
647 types (this is the default).
623 types (this is the default).
648
624
649 Options:
625 Options:
650
626
651 -a: makes the pattern match even objects whose names start with a
627 -a: makes the pattern match even objects whose names start with a
652 single underscore. These names are normally omitted from the
628 single underscore. These names are normally omitted from the
653 search.
629 search.
654
630
655 -i/-c: make the pattern case insensitive/sensitive. If neither of
631 -i/-c: make the pattern case insensitive/sensitive. If neither of
656 these options are given, the default is read from your configuration
632 these options are given, the default is read from your configuration
657 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
633 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
658 If this option is not specified in your configuration file, IPython's
634 If this option is not specified in your configuration file, IPython's
659 internal default is to do a case sensitive search.
635 internal default is to do a case sensitive search.
660
636
661 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
637 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
662 specify can be searched in any of the following namespaces:
638 specify can be searched in any of the following namespaces:
663 'builtin', 'user', 'user_global','internal', 'alias', where
639 'builtin', 'user', 'user_global','internal', 'alias', where
664 'builtin' and 'user' are the search defaults. Note that you should
640 'builtin' and 'user' are the search defaults. Note that you should
665 not use quotes when specifying namespaces.
641 not use quotes when specifying namespaces.
666
642
667 'Builtin' contains the python module builtin, 'user' contains all
643 'Builtin' contains the python module builtin, 'user' contains all
668 user data, 'alias' only contain the shell aliases and no python
644 user data, 'alias' only contain the shell aliases and no python
669 objects, 'internal' contains objects used by IPython. The
645 objects, 'internal' contains objects used by IPython. The
670 'user_global' namespace is only used by embedded IPython instances,
646 'user_global' namespace is only used by embedded IPython instances,
671 and it contains module-level globals. You can add namespaces to the
647 and it contains module-level globals. You can add namespaces to the
672 search with -s or exclude them with -e (these options can be given
648 search with -s or exclude them with -e (these options can be given
673 more than once).
649 more than once).
674
650
675 Examples
651 Examples
676 --------
652 --------
677 ::
653 ::
678
654
679 %psearch a* -> objects beginning with an a
655 %psearch a* -> objects beginning with an a
680 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
656 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
681 %psearch a* function -> all functions beginning with an a
657 %psearch a* function -> all functions beginning with an a
682 %psearch re.e* -> objects beginning with an e in module re
658 %psearch re.e* -> objects beginning with an e in module re
683 %psearch r*.e* -> objects that start with e in modules starting in r
659 %psearch r*.e* -> objects that start with e in modules starting in r
684 %psearch r*.* string -> all strings in modules beginning with r
660 %psearch r*.* string -> all strings in modules beginning with r
685
661
686 Case sensitive search::
662 Case sensitive search::
687
663
688 %psearch -c a* list all object beginning with lower case a
664 %psearch -c a* list all object beginning with lower case a
689
665
690 Show objects beginning with a single _::
666 Show objects beginning with a single _::
691
667
692 %psearch -a _* list objects beginning with a single underscore"""
668 %psearch -a _* list objects beginning with a single underscore"""
693 try:
669 try:
694 parameter_s.encode('ascii')
670 parameter_s.encode('ascii')
695 except UnicodeEncodeError:
671 except UnicodeEncodeError:
696 print 'Python identifiers can only contain ascii characters.'
672 print 'Python identifiers can only contain ascii characters.'
697 return
673 return
698
674
699 # default namespaces to be searched
675 # default namespaces to be searched
700 def_search = ['user_local', 'user_global', 'builtin']
676 def_search = ['user_local', 'user_global', 'builtin']
701
677
702 # Process options/args
678 # Process options/args
703 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
679 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
704 opt = opts.get
680 opt = opts.get
705 shell = self.shell
681 shell = self.shell
706 psearch = shell.inspector.psearch
682 psearch = shell.inspector.psearch
707
683
708 # select case options
684 # select case options
709 if opts.has_key('i'):
685 if opts.has_key('i'):
710 ignore_case = True
686 ignore_case = True
711 elif opts.has_key('c'):
687 elif opts.has_key('c'):
712 ignore_case = False
688 ignore_case = False
713 else:
689 else:
714 ignore_case = not shell.wildcards_case_sensitive
690 ignore_case = not shell.wildcards_case_sensitive
715
691
716 # Build list of namespaces to search from user options
692 # Build list of namespaces to search from user options
717 def_search.extend(opt('s',[]))
693 def_search.extend(opt('s',[]))
718 ns_exclude = ns_exclude=opt('e',[])
694 ns_exclude = ns_exclude=opt('e',[])
719 ns_search = [nm for nm in def_search if nm not in ns_exclude]
695 ns_search = [nm for nm in def_search if nm not in ns_exclude]
720
696
721 # Call the actual search
697 # Call the actual search
722 try:
698 try:
723 psearch(args,shell.ns_table,ns_search,
699 psearch(args,shell.ns_table,ns_search,
724 show_all=opt('a'),ignore_case=ignore_case)
700 show_all=opt('a'),ignore_case=ignore_case)
725 except:
701 except:
726 shell.showtraceback()
702 shell.showtraceback()
727
703
728 @skip_doctest
704 @skip_doctest
729 def magic_who_ls(self, parameter_s=''):
705 def magic_who_ls(self, parameter_s=''):
730 """Return a sorted list of all interactive variables.
706 """Return a sorted list of all interactive variables.
731
707
732 If arguments are given, only variables of types matching these
708 If arguments are given, only variables of types matching these
733 arguments are returned.
709 arguments are returned.
734
710
735 Examples
711 Examples
736 --------
712 --------
737
713
738 Define two variables and list them with who_ls::
714 Define two variables and list them with who_ls::
739
715
740 In [1]: alpha = 123
716 In [1]: alpha = 123
741
717
742 In [2]: beta = 'test'
718 In [2]: beta = 'test'
743
719
744 In [3]: %who_ls
720 In [3]: %who_ls
745 Out[3]: ['alpha', 'beta']
721 Out[3]: ['alpha', 'beta']
746
722
747 In [4]: %who_ls int
723 In [4]: %who_ls int
748 Out[4]: ['alpha']
724 Out[4]: ['alpha']
749
725
750 In [5]: %who_ls str
726 In [5]: %who_ls str
751 Out[5]: ['beta']
727 Out[5]: ['beta']
752 """
728 """
753
729
754 user_ns = self.shell.user_ns
730 user_ns = self.shell.user_ns
755 user_ns_hidden = self.shell.user_ns_hidden
731 user_ns_hidden = self.shell.user_ns_hidden
756 out = [ i for i in user_ns
732 out = [ i for i in user_ns
757 if not i.startswith('_') \
733 if not i.startswith('_') \
758 and not i in user_ns_hidden ]
734 and not i in user_ns_hidden ]
759
735
760 typelist = parameter_s.split()
736 typelist = parameter_s.split()
761 if typelist:
737 if typelist:
762 typeset = set(typelist)
738 typeset = set(typelist)
763 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
739 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
764
740
765 out.sort()
741 out.sort()
766 return out
742 return out
767
743
768 @skip_doctest
744 @skip_doctest
769 def magic_who(self, parameter_s=''):
745 def magic_who(self, parameter_s=''):
770 """Print all interactive variables, with some minimal formatting.
746 """Print all interactive variables, with some minimal formatting.
771
747
772 If any arguments are given, only variables whose type matches one of
748 If any arguments are given, only variables whose type matches one of
773 these are printed. For example::
749 these are printed. For example::
774
750
775 %who function str
751 %who function str
776
752
777 will only list functions and strings, excluding all other types of
753 will only list functions and strings, excluding all other types of
778 variables. To find the proper type names, simply use type(var) at a
754 variables. To find the proper type names, simply use type(var) at a
779 command line to see how python prints type names. For example:
755 command line to see how python prints type names. For example:
780
756
781 ::
757 ::
782
758
783 In [1]: type('hello')\\
759 In [1]: type('hello')\\
784 Out[1]: <type 'str'>
760 Out[1]: <type 'str'>
785
761
786 indicates that the type name for strings is 'str'.
762 indicates that the type name for strings is 'str'.
787
763
788 ``%who`` always excludes executed names loaded through your configuration
764 ``%who`` always excludes executed names loaded through your configuration
789 file and things which are internal to IPython.
765 file and things which are internal to IPython.
790
766
791 This is deliberate, as typically you may load many modules and the
767 This is deliberate, as typically you may load many modules and the
792 purpose of %who is to show you only what you've manually defined.
768 purpose of %who is to show you only what you've manually defined.
793
769
794 Examples
770 Examples
795 --------
771 --------
796
772
797 Define two variables and list them with who::
773 Define two variables and list them with who::
798
774
799 In [1]: alpha = 123
775 In [1]: alpha = 123
800
776
801 In [2]: beta = 'test'
777 In [2]: beta = 'test'
802
778
803 In [3]: %who
779 In [3]: %who
804 alpha beta
780 alpha beta
805
781
806 In [4]: %who int
782 In [4]: %who int
807 alpha
783 alpha
808
784
809 In [5]: %who str
785 In [5]: %who str
810 beta
786 beta
811 """
787 """
812
788
813 varlist = self.magic_who_ls(parameter_s)
789 varlist = self.magic_who_ls(parameter_s)
814 if not varlist:
790 if not varlist:
815 if parameter_s:
791 if parameter_s:
816 print 'No variables match your requested type.'
792 print 'No variables match your requested type.'
817 else:
793 else:
818 print 'Interactive namespace is empty.'
794 print 'Interactive namespace is empty.'
819 return
795 return
820
796
821 # if we have variables, move on...
797 # if we have variables, move on...
822 count = 0
798 count = 0
823 for i in varlist:
799 for i in varlist:
824 print i+'\t',
800 print i+'\t',
825 count += 1
801 count += 1
826 if count > 8:
802 if count > 8:
827 count = 0
803 count = 0
828 print
804 print
829 print
805 print
830
806
831 @skip_doctest
807 @skip_doctest
832 def magic_whos(self, parameter_s=''):
808 def magic_whos(self, parameter_s=''):
833 """Like %who, but gives some extra information about each variable.
809 """Like %who, but gives some extra information about each variable.
834
810
835 The same type filtering of %who can be applied here.
811 The same type filtering of %who can be applied here.
836
812
837 For all variables, the type is printed. Additionally it prints:
813 For all variables, the type is printed. Additionally it prints:
838
814
839 - For {},[],(): their length.
815 - For {},[],(): their length.
840
816
841 - For numpy arrays, a summary with shape, number of
817 - For numpy arrays, a summary with shape, number of
842 elements, typecode and size in memory.
818 elements, typecode and size in memory.
843
819
844 - Everything else: a string representation, snipping their middle if
820 - Everything else: a string representation, snipping their middle if
845 too long.
821 too long.
846
822
847 Examples
823 Examples
848 --------
824 --------
849
825
850 Define two variables and list them with whos::
826 Define two variables and list them with whos::
851
827
852 In [1]: alpha = 123
828 In [1]: alpha = 123
853
829
854 In [2]: beta = 'test'
830 In [2]: beta = 'test'
855
831
856 In [3]: %whos
832 In [3]: %whos
857 Variable Type Data/Info
833 Variable Type Data/Info
858 --------------------------------
834 --------------------------------
859 alpha int 123
835 alpha int 123
860 beta str test
836 beta str test
861 """
837 """
862
838
863 varnames = self.magic_who_ls(parameter_s)
839 varnames = self.magic_who_ls(parameter_s)
864 if not varnames:
840 if not varnames:
865 if parameter_s:
841 if parameter_s:
866 print 'No variables match your requested type.'
842 print 'No variables match your requested type.'
867 else:
843 else:
868 print 'Interactive namespace is empty.'
844 print 'Interactive namespace is empty.'
869 return
845 return
870
846
871 # if we have variables, move on...
847 # if we have variables, move on...
872
848
873 # for these types, show len() instead of data:
849 # for these types, show len() instead of data:
874 seq_types = ['dict', 'list', 'tuple']
850 seq_types = ['dict', 'list', 'tuple']
875
851
876 # for numpy arrays, display summary info
852 # for numpy arrays, display summary info
877 ndarray_type = None
853 ndarray_type = None
878 if 'numpy' in sys.modules:
854 if 'numpy' in sys.modules:
879 try:
855 try:
880 from numpy import ndarray
856 from numpy import ndarray
881 except ImportError:
857 except ImportError:
882 pass
858 pass
883 else:
859 else:
884 ndarray_type = ndarray.__name__
860 ndarray_type = ndarray.__name__
885
861
886 # Find all variable names and types so we can figure out column sizes
862 # Find all variable names and types so we can figure out column sizes
887 def get_vars(i):
863 def get_vars(i):
888 return self.shell.user_ns[i]
864 return self.shell.user_ns[i]
889
865
890 # some types are well known and can be shorter
866 # some types are well known and can be shorter
891 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
867 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
892 def type_name(v):
868 def type_name(v):
893 tn = type(v).__name__
869 tn = type(v).__name__
894 return abbrevs.get(tn,tn)
870 return abbrevs.get(tn,tn)
895
871
896 varlist = map(get_vars,varnames)
872 varlist = map(get_vars,varnames)
897
873
898 typelist = []
874 typelist = []
899 for vv in varlist:
875 for vv in varlist:
900 tt = type_name(vv)
876 tt = type_name(vv)
901
877
902 if tt=='instance':
878 if tt=='instance':
903 typelist.append( abbrevs.get(str(vv.__class__),
879 typelist.append( abbrevs.get(str(vv.__class__),
904 str(vv.__class__)))
880 str(vv.__class__)))
905 else:
881 else:
906 typelist.append(tt)
882 typelist.append(tt)
907
883
908 # column labels and # of spaces as separator
884 # column labels and # of spaces as separator
909 varlabel = 'Variable'
885 varlabel = 'Variable'
910 typelabel = 'Type'
886 typelabel = 'Type'
911 datalabel = 'Data/Info'
887 datalabel = 'Data/Info'
912 colsep = 3
888 colsep = 3
913 # variable format strings
889 # variable format strings
914 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
890 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
915 aformat = "%s: %s elems, type `%s`, %s bytes"
891 aformat = "%s: %s elems, type `%s`, %s bytes"
916 # find the size of the columns to format the output nicely
892 # find the size of the columns to format the output nicely
917 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
893 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
918 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
894 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
919 # table header
895 # table header
920 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
896 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
921 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
897 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
922 # and the table itself
898 # and the table itself
923 kb = 1024
899 kb = 1024
924 Mb = 1048576 # kb**2
900 Mb = 1048576 # kb**2
925 for vname,var,vtype in zip(varnames,varlist,typelist):
901 for vname,var,vtype in zip(varnames,varlist,typelist):
926 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
902 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
927 if vtype in seq_types:
903 if vtype in seq_types:
928 print "n="+str(len(var))
904 print "n="+str(len(var))
929 elif vtype == ndarray_type:
905 elif vtype == ndarray_type:
930 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
906 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
931 if vtype==ndarray_type:
907 if vtype==ndarray_type:
932 # numpy
908 # numpy
933 vsize = var.size
909 vsize = var.size
934 vbytes = vsize*var.itemsize
910 vbytes = vsize*var.itemsize
935 vdtype = var.dtype
911 vdtype = var.dtype
936
912
937 if vbytes < 100000:
913 if vbytes < 100000:
938 print aformat % (vshape,vsize,vdtype,vbytes)
914 print aformat % (vshape,vsize,vdtype,vbytes)
939 else:
915 else:
940 print aformat % (vshape,vsize,vdtype,vbytes),
916 print aformat % (vshape,vsize,vdtype,vbytes),
941 if vbytes < Mb:
917 if vbytes < Mb:
942 print '(%s kb)' % (vbytes/kb,)
918 print '(%s kb)' % (vbytes/kb,)
943 else:
919 else:
944 print '(%s Mb)' % (vbytes/Mb,)
920 print '(%s Mb)' % (vbytes/Mb,)
945 else:
921 else:
946 try:
922 try:
947 vstr = str(var)
923 vstr = str(var)
948 except UnicodeEncodeError:
924 except UnicodeEncodeError:
949 vstr = unicode(var).encode(DEFAULT_ENCODING,
925 vstr = unicode(var).encode(DEFAULT_ENCODING,
950 'backslashreplace')
926 'backslashreplace')
951 except:
927 except:
952 vstr = "<object with id %d (str() failed)>" % id(var)
928 vstr = "<object with id %d (str() failed)>" % id(var)
953 vstr = vstr.replace('\n','\\n')
929 vstr = vstr.replace('\n','\\n')
954 if len(vstr) < 50:
930 if len(vstr) < 50:
955 print vstr
931 print vstr
956 else:
932 else:
957 print vstr[:25] + "<...>" + vstr[-25:]
933 print vstr[:25] + "<...>" + vstr[-25:]
958
934
959 def magic_reset(self, parameter_s=''):
935 def magic_reset(self, parameter_s=''):
960 """Resets the namespace by removing all names defined by the user, if
936 """Resets the namespace by removing all names defined by the user, if
961 called without arguments, or by removing some types of objects, such
937 called without arguments, or by removing some types of objects, such
962 as everything currently in IPython's In[] and Out[] containers (see
938 as everything currently in IPython's In[] and Out[] containers (see
963 the parameters for details).
939 the parameters for details).
964
940
965 Parameters
941 Parameters
966 ----------
942 ----------
967 -f : force reset without asking for confirmation.
943 -f : force reset without asking for confirmation.
968
944
969 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
945 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
970 References to objects may be kept. By default (without this option),
946 References to objects may be kept. By default (without this option),
971 we do a 'hard' reset, giving you a new session and removing all
947 we do a 'hard' reset, giving you a new session and removing all
972 references to objects from the current session.
948 references to objects from the current session.
973
949
974 in : reset input history
950 in : reset input history
975
951
976 out : reset output history
952 out : reset output history
977
953
978 dhist : reset directory history
954 dhist : reset directory history
979
955
980 array : reset only variables that are NumPy arrays
956 array : reset only variables that are NumPy arrays
981
957
982 See Also
958 See Also
983 --------
959 --------
984 magic_reset_selective : invoked as ``%reset_selective``
960 magic_reset_selective : invoked as ``%reset_selective``
985
961
986 Examples
962 Examples
987 --------
963 --------
988 ::
964 ::
989
965
990 In [6]: a = 1
966 In [6]: a = 1
991
967
992 In [7]: a
968 In [7]: a
993 Out[7]: 1
969 Out[7]: 1
994
970
995 In [8]: 'a' in _ip.user_ns
971 In [8]: 'a' in _ip.user_ns
996 Out[8]: True
972 Out[8]: True
997
973
998 In [9]: %reset -f
974 In [9]: %reset -f
999
975
1000 In [1]: 'a' in _ip.user_ns
976 In [1]: 'a' in _ip.user_ns
1001 Out[1]: False
977 Out[1]: False
1002
978
1003 In [2]: %reset -f in
979 In [2]: %reset -f in
1004 Flushing input history
980 Flushing input history
1005
981
1006 In [3]: %reset -f dhist in
982 In [3]: %reset -f dhist in
1007 Flushing directory history
983 Flushing directory history
1008 Flushing input history
984 Flushing input history
1009
985
1010 Notes
986 Notes
1011 -----
987 -----
1012 Calling this magic from clients that do not implement standard input,
988 Calling this magic from clients that do not implement standard input,
1013 such as the ipython notebook interface, will reset the namespace
989 such as the ipython notebook interface, will reset the namespace
1014 without confirmation.
990 without confirmation.
1015 """
991 """
1016 opts, args = self.parse_options(parameter_s,'sf', mode='list')
992 opts, args = self.parse_options(parameter_s,'sf', mode='list')
1017 if 'f' in opts:
993 if 'f' in opts:
1018 ans = True
994 ans = True
1019 else:
995 else:
1020 try:
996 try:
1021 ans = self.shell.ask_yes_no(
997 ans = self.shell.ask_yes_no(
1022 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
998 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
1023 except StdinNotImplementedError:
999 except StdinNotImplementedError:
1024 ans = True
1000 ans = True
1025 if not ans:
1001 if not ans:
1026 print 'Nothing done.'
1002 print 'Nothing done.'
1027 return
1003 return
1028
1004
1029 if 's' in opts: # Soft reset
1005 if 's' in opts: # Soft reset
1030 user_ns = self.shell.user_ns
1006 user_ns = self.shell.user_ns
1031 for i in self.magic_who_ls():
1007 for i in self.magic_who_ls():
1032 del(user_ns[i])
1008 del(user_ns[i])
1033 elif len(args) == 0: # Hard reset
1009 elif len(args) == 0: # Hard reset
1034 self.shell.reset(new_session = False)
1010 self.shell.reset(new_session = False)
1035
1011
1036 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1012 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1037 ip = self.shell
1013 ip = self.shell
1038 user_ns = self.shell.user_ns # local lookup, heavily used
1014 user_ns = self.shell.user_ns # local lookup, heavily used
1039
1015
1040 for target in args:
1016 for target in args:
1041 target = target.lower() # make matches case insensitive
1017 target = target.lower() # make matches case insensitive
1042 if target == 'out':
1018 if target == 'out':
1043 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1019 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1044 self.shell.displayhook.flush()
1020 self.shell.displayhook.flush()
1045
1021
1046 elif target == 'in':
1022 elif target == 'in':
1047 print "Flushing input history"
1023 print "Flushing input history"
1048 pc = self.shell.displayhook.prompt_count + 1
1024 pc = self.shell.displayhook.prompt_count + 1
1049 for n in range(1, pc):
1025 for n in range(1, pc):
1050 key = '_i'+repr(n)
1026 key = '_i'+repr(n)
1051 user_ns.pop(key,None)
1027 user_ns.pop(key,None)
1052 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1028 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1053 hm = ip.history_manager
1029 hm = ip.history_manager
1054 # don't delete these, as %save and %macro depending on the length
1030 # don't delete these, as %save and %macro depending on the length
1055 # of these lists to be preserved
1031 # of these lists to be preserved
1056 hm.input_hist_parsed[:] = [''] * pc
1032 hm.input_hist_parsed[:] = [''] * pc
1057 hm.input_hist_raw[:] = [''] * pc
1033 hm.input_hist_raw[:] = [''] * pc
1058 # hm has internal machinery for _i,_ii,_iii, clear it out
1034 # hm has internal machinery for _i,_ii,_iii, clear it out
1059 hm._i = hm._ii = hm._iii = hm._i00 = u''
1035 hm._i = hm._ii = hm._iii = hm._i00 = u''
1060
1036
1061 elif target == 'array':
1037 elif target == 'array':
1062 # Support cleaning up numpy arrays
1038 # Support cleaning up numpy arrays
1063 try:
1039 try:
1064 from numpy import ndarray
1040 from numpy import ndarray
1065 # This must be done with items and not iteritems because we're
1041 # This must be done with items and not iteritems because we're
1066 # going to modify the dict in-place.
1042 # going to modify the dict in-place.
1067 for x,val in user_ns.items():
1043 for x,val in user_ns.items():
1068 if isinstance(val,ndarray):
1044 if isinstance(val,ndarray):
1069 del user_ns[x]
1045 del user_ns[x]
1070 except ImportError:
1046 except ImportError:
1071 print "reset array only works if Numpy is available."
1047 print "reset array only works if Numpy is available."
1072
1048
1073 elif target == 'dhist':
1049 elif target == 'dhist':
1074 print "Flushing directory history"
1050 print "Flushing directory history"
1075 del user_ns['_dh'][:]
1051 del user_ns['_dh'][:]
1076
1052
1077 else:
1053 else:
1078 print "Don't know how to reset ",
1054 print "Don't know how to reset ",
1079 print target + ", please run `%reset?` for details"
1055 print target + ", please run `%reset?` for details"
1080
1056
1081 gc.collect()
1057 gc.collect()
1082
1058
1083 def magic_reset_selective(self, parameter_s=''):
1059 def magic_reset_selective(self, parameter_s=''):
1084 """Resets the namespace by removing names defined by the user.
1060 """Resets the namespace by removing names defined by the user.
1085
1061
1086 Input/Output history are left around in case you need them.
1062 Input/Output history are left around in case you need them.
1087
1063
1088 %reset_selective [-f] regex
1064 %reset_selective [-f] regex
1089
1065
1090 No action is taken if regex is not included
1066 No action is taken if regex is not included
1091
1067
1092 Options
1068 Options
1093 -f : force reset without asking for confirmation.
1069 -f : force reset without asking for confirmation.
1094
1070
1095 See Also
1071 See Also
1096 --------
1072 --------
1097 magic_reset : invoked as ``%reset``
1073 magic_reset : invoked as ``%reset``
1098
1074
1099 Examples
1075 Examples
1100 --------
1076 --------
1101
1077
1102 We first fully reset the namespace so your output looks identical to
1078 We first fully reset the namespace so your output looks identical to
1103 this example for pedagogical reasons; in practice you do not need a
1079 this example for pedagogical reasons; in practice you do not need a
1104 full reset::
1080 full reset::
1105
1081
1106 In [1]: %reset -f
1082 In [1]: %reset -f
1107
1083
1108 Now, with a clean namespace we can make a few variables and use
1084 Now, with a clean namespace we can make a few variables and use
1109 ``%reset_selective`` to only delete names that match our regexp::
1085 ``%reset_selective`` to only delete names that match our regexp::
1110
1086
1111 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1087 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1112
1088
1113 In [3]: who_ls
1089 In [3]: who_ls
1114 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1090 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1115
1091
1116 In [4]: %reset_selective -f b[2-3]m
1092 In [4]: %reset_selective -f b[2-3]m
1117
1093
1118 In [5]: who_ls
1094 In [5]: who_ls
1119 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1095 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1120
1096
1121 In [6]: %reset_selective -f d
1097 In [6]: %reset_selective -f d
1122
1098
1123 In [7]: who_ls
1099 In [7]: who_ls
1124 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1100 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1125
1101
1126 In [8]: %reset_selective -f c
1102 In [8]: %reset_selective -f c
1127
1103
1128 In [9]: who_ls
1104 In [9]: who_ls
1129 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1105 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1130
1106
1131 In [10]: %reset_selective -f b
1107 In [10]: %reset_selective -f b
1132
1108
1133 In [11]: who_ls
1109 In [11]: who_ls
1134 Out[11]: ['a']
1110 Out[11]: ['a']
1135
1111
1136 Notes
1112 Notes
1137 -----
1113 -----
1138 Calling this magic from clients that do not implement standard input,
1114 Calling this magic from clients that do not implement standard input,
1139 such as the ipython notebook interface, will reset the namespace
1115 such as the ipython notebook interface, will reset the namespace
1140 without confirmation.
1116 without confirmation.
1141 """
1117 """
1142
1118
1143 opts, regex = self.parse_options(parameter_s,'f')
1119 opts, regex = self.parse_options(parameter_s,'f')
1144
1120
1145 if opts.has_key('f'):
1121 if opts.has_key('f'):
1146 ans = True
1122 ans = True
1147 else:
1123 else:
1148 try:
1124 try:
1149 ans = self.shell.ask_yes_no(
1125 ans = self.shell.ask_yes_no(
1150 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1126 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1151 default='n')
1127 default='n')
1152 except StdinNotImplementedError:
1128 except StdinNotImplementedError:
1153 ans = True
1129 ans = True
1154 if not ans:
1130 if not ans:
1155 print 'Nothing done.'
1131 print 'Nothing done.'
1156 return
1132 return
1157 user_ns = self.shell.user_ns
1133 user_ns = self.shell.user_ns
1158 if not regex:
1134 if not regex:
1159 print 'No regex pattern specified. Nothing done.'
1135 print 'No regex pattern specified. Nothing done.'
1160 return
1136 return
1161 else:
1137 else:
1162 try:
1138 try:
1163 m = re.compile(regex)
1139 m = re.compile(regex)
1164 except TypeError:
1140 except TypeError:
1165 raise TypeError('regex must be a string or compiled pattern')
1141 raise TypeError('regex must be a string or compiled pattern')
1166 for i in self.magic_who_ls():
1142 for i in self.magic_who_ls():
1167 if m.search(i):
1143 if m.search(i):
1168 del(user_ns[i])
1144 del(user_ns[i])
1169
1145
1170 def magic_xdel(self, parameter_s=''):
1146 def magic_xdel(self, parameter_s=''):
1171 """Delete a variable, trying to clear it from anywhere that
1147 """Delete a variable, trying to clear it from anywhere that
1172 IPython's machinery has references to it. By default, this uses
1148 IPython's machinery has references to it. By default, this uses
1173 the identity of the named object in the user namespace to remove
1149 the identity of the named object in the user namespace to remove
1174 references held under other names. The object is also removed
1150 references held under other names. The object is also removed
1175 from the output history.
1151 from the output history.
1176
1152
1177 Options
1153 Options
1178 -n : Delete the specified name from all namespaces, without
1154 -n : Delete the specified name from all namespaces, without
1179 checking their identity.
1155 checking their identity.
1180 """
1156 """
1181 opts, varname = self.parse_options(parameter_s,'n')
1157 opts, varname = self.parse_options(parameter_s,'n')
1182 try:
1158 try:
1183 self.shell.del_var(varname, ('n' in opts))
1159 self.shell.del_var(varname, ('n' in opts))
1184 except (NameError, ValueError) as e:
1160 except (NameError, ValueError) as e:
1185 print type(e).__name__ +": "+ str(e)
1161 print type(e).__name__ +": "+ str(e)
1186
1162
1187 def magic_logstart(self,parameter_s=''):
1163 def magic_logstart(self,parameter_s=''):
1188 """Start logging anywhere in a session.
1164 """Start logging anywhere in a session.
1189
1165
1190 %logstart [-o|-r|-t] [log_name [log_mode]]
1166 %logstart [-o|-r|-t] [log_name [log_mode]]
1191
1167
1192 If no name is given, it defaults to a file named 'ipython_log.py' in your
1168 If no name is given, it defaults to a file named 'ipython_log.py' in your
1193 current directory, in 'rotate' mode (see below).
1169 current directory, in 'rotate' mode (see below).
1194
1170
1195 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1171 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1196 history up to that point and then continues logging.
1172 history up to that point and then continues logging.
1197
1173
1198 %logstart takes a second optional parameter: logging mode. This can be one
1174 %logstart takes a second optional parameter: logging mode. This can be one
1199 of (note that the modes are given unquoted):\\
1175 of (note that the modes are given unquoted):\\
1200 append: well, that says it.\\
1176 append: well, that says it.\\
1201 backup: rename (if exists) to name~ and start name.\\
1177 backup: rename (if exists) to name~ and start name.\\
1202 global: single logfile in your home dir, appended to.\\
1178 global: single logfile in your home dir, appended to.\\
1203 over : overwrite existing log.\\
1179 over : overwrite existing log.\\
1204 rotate: create rotating logs name.1~, name.2~, etc.
1180 rotate: create rotating logs name.1~, name.2~, etc.
1205
1181
1206 Options:
1182 Options:
1207
1183
1208 -o: log also IPython's output. In this mode, all commands which
1184 -o: log also IPython's output. In this mode, all commands which
1209 generate an Out[NN] prompt are recorded to the logfile, right after
1185 generate an Out[NN] prompt are recorded to the logfile, right after
1210 their corresponding input line. The output lines are always
1186 their corresponding input line. The output lines are always
1211 prepended with a '#[Out]# ' marker, so that the log remains valid
1187 prepended with a '#[Out]# ' marker, so that the log remains valid
1212 Python code.
1188 Python code.
1213
1189
1214 Since this marker is always the same, filtering only the output from
1190 Since this marker is always the same, filtering only the output from
1215 a log is very easy, using for example a simple awk call::
1191 a log is very easy, using for example a simple awk call::
1216
1192
1217 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1193 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1218
1194
1219 -r: log 'raw' input. Normally, IPython's logs contain the processed
1195 -r: log 'raw' input. Normally, IPython's logs contain the processed
1220 input, so that user lines are logged in their final form, converted
1196 input, so that user lines are logged in their final form, converted
1221 into valid Python. For example, %Exit is logged as
1197 into valid Python. For example, %Exit is logged as
1222 _ip.magic("Exit"). If the -r flag is given, all input is logged
1198 _ip.magic("Exit"). If the -r flag is given, all input is logged
1223 exactly as typed, with no transformations applied.
1199 exactly as typed, with no transformations applied.
1224
1200
1225 -t: put timestamps before each input line logged (these are put in
1201 -t: put timestamps before each input line logged (these are put in
1226 comments)."""
1202 comments)."""
1227
1203
1228 opts,par = self.parse_options(parameter_s,'ort')
1204 opts,par = self.parse_options(parameter_s,'ort')
1229 log_output = 'o' in opts
1205 log_output = 'o' in opts
1230 log_raw_input = 'r' in opts
1206 log_raw_input = 'r' in opts
1231 timestamp = 't' in opts
1207 timestamp = 't' in opts
1232
1208
1233 logger = self.shell.logger
1209 logger = self.shell.logger
1234
1210
1235 # if no args are given, the defaults set in the logger constructor by
1211 # if no args are given, the defaults set in the logger constructor by
1236 # ipython remain valid
1212 # ipython remain valid
1237 if par:
1213 if par:
1238 try:
1214 try:
1239 logfname,logmode = par.split()
1215 logfname,logmode = par.split()
1240 except:
1216 except:
1241 logfname = par
1217 logfname = par
1242 logmode = 'backup'
1218 logmode = 'backup'
1243 else:
1219 else:
1244 logfname = logger.logfname
1220 logfname = logger.logfname
1245 logmode = logger.logmode
1221 logmode = logger.logmode
1246 # put logfname into rc struct as if it had been called on the command
1222 # put logfname into rc struct as if it had been called on the command
1247 # line, so it ends up saved in the log header Save it in case we need
1223 # line, so it ends up saved in the log header Save it in case we need
1248 # to restore it...
1224 # to restore it...
1249 old_logfile = self.shell.logfile
1225 old_logfile = self.shell.logfile
1250 if logfname:
1226 if logfname:
1251 logfname = os.path.expanduser(logfname)
1227 logfname = os.path.expanduser(logfname)
1252 self.shell.logfile = logfname
1228 self.shell.logfile = logfname
1253
1229
1254 loghead = '# IPython log file\n\n'
1230 loghead = '# IPython log file\n\n'
1255 try:
1231 try:
1256 started = logger.logstart(logfname,loghead,logmode,
1232 started = logger.logstart(logfname,loghead,logmode,
1257 log_output,timestamp,log_raw_input)
1233 log_output,timestamp,log_raw_input)
1258 except:
1234 except:
1259 self.shell.logfile = old_logfile
1235 self.shell.logfile = old_logfile
1260 warn("Couldn't start log: %s" % sys.exc_info()[1])
1236 warn("Couldn't start log: %s" % sys.exc_info()[1])
1261 else:
1237 else:
1262 # log input history up to this point, optionally interleaving
1238 # log input history up to this point, optionally interleaving
1263 # output if requested
1239 # output if requested
1264
1240
1265 if timestamp:
1241 if timestamp:
1266 # disable timestamping for the previous history, since we've
1242 # disable timestamping for the previous history, since we've
1267 # lost those already (no time machine here).
1243 # lost those already (no time machine here).
1268 logger.timestamp = False
1244 logger.timestamp = False
1269
1245
1270 if log_raw_input:
1246 if log_raw_input:
1271 input_hist = self.shell.history_manager.input_hist_raw
1247 input_hist = self.shell.history_manager.input_hist_raw
1272 else:
1248 else:
1273 input_hist = self.shell.history_manager.input_hist_parsed
1249 input_hist = self.shell.history_manager.input_hist_parsed
1274
1250
1275 if log_output:
1251 if log_output:
1276 log_write = logger.log_write
1252 log_write = logger.log_write
1277 output_hist = self.shell.history_manager.output_hist
1253 output_hist = self.shell.history_manager.output_hist
1278 for n in range(1,len(input_hist)-1):
1254 for n in range(1,len(input_hist)-1):
1279 log_write(input_hist[n].rstrip() + '\n')
1255 log_write(input_hist[n].rstrip() + '\n')
1280 if n in output_hist:
1256 if n in output_hist:
1281 log_write(repr(output_hist[n]),'output')
1257 log_write(repr(output_hist[n]),'output')
1282 else:
1258 else:
1283 logger.log_write('\n'.join(input_hist[1:]))
1259 logger.log_write('\n'.join(input_hist[1:]))
1284 logger.log_write('\n')
1260 logger.log_write('\n')
1285 if timestamp:
1261 if timestamp:
1286 # re-enable timestamping
1262 # re-enable timestamping
1287 logger.timestamp = True
1263 logger.timestamp = True
1288
1264
1289 print ('Activating auto-logging. '
1265 print ('Activating auto-logging. '
1290 'Current session state plus future input saved.')
1266 'Current session state plus future input saved.')
1291 logger.logstate()
1267 logger.logstate()
1292
1268
1293 def magic_logstop(self,parameter_s=''):
1269 def magic_logstop(self,parameter_s=''):
1294 """Fully stop logging and close log file.
1270 """Fully stop logging and close log file.
1295
1271
1296 In order to start logging again, a new %logstart call needs to be made,
1272 In order to start logging again, a new %logstart call needs to be made,
1297 possibly (though not necessarily) with a new filename, mode and other
1273 possibly (though not necessarily) with a new filename, mode and other
1298 options."""
1274 options."""
1299 self.logger.logstop()
1275 self.logger.logstop()
1300
1276
1301 def magic_logoff(self,parameter_s=''):
1277 def magic_logoff(self,parameter_s=''):
1302 """Temporarily stop logging.
1278 """Temporarily stop logging.
1303
1279
1304 You must have previously started logging."""
1280 You must have previously started logging."""
1305 self.shell.logger.switch_log(0)
1281 self.shell.logger.switch_log(0)
1306
1282
1307 def magic_logon(self,parameter_s=''):
1283 def magic_logon(self,parameter_s=''):
1308 """Restart logging.
1284 """Restart logging.
1309
1285
1310 This function is for restarting logging which you've temporarily
1286 This function is for restarting logging which you've temporarily
1311 stopped with %logoff. For starting logging for the first time, you
1287 stopped with %logoff. For starting logging for the first time, you
1312 must use the %logstart function, which allows you to specify an
1288 must use the %logstart function, which allows you to specify an
1313 optional log filename."""
1289 optional log filename."""
1314
1290
1315 self.shell.logger.switch_log(1)
1291 self.shell.logger.switch_log(1)
1316
1292
1317 def magic_logstate(self,parameter_s=''):
1293 def magic_logstate(self,parameter_s=''):
1318 """Print the status of the logging system."""
1294 """Print the status of the logging system."""
1319
1295
1320 self.shell.logger.logstate()
1296 self.shell.logger.logstate()
1321
1297
1322 def magic_pdb(self, parameter_s=''):
1298 def magic_pdb(self, parameter_s=''):
1323 """Control the automatic calling of the pdb interactive debugger.
1299 """Control the automatic calling of the pdb interactive debugger.
1324
1300
1325 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1301 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1326 argument it works as a toggle.
1302 argument it works as a toggle.
1327
1303
1328 When an exception is triggered, IPython can optionally call the
1304 When an exception is triggered, IPython can optionally call the
1329 interactive pdb debugger after the traceback printout. %pdb toggles
1305 interactive pdb debugger after the traceback printout. %pdb toggles
1330 this feature on and off.
1306 this feature on and off.
1331
1307
1332 The initial state of this feature is set in your configuration
1308 The initial state of this feature is set in your configuration
1333 file (the option is ``InteractiveShell.pdb``).
1309 file (the option is ``InteractiveShell.pdb``).
1334
1310
1335 If you want to just activate the debugger AFTER an exception has fired,
1311 If you want to just activate the debugger AFTER an exception has fired,
1336 without having to type '%pdb on' and rerunning your code, you can use
1312 without having to type '%pdb on' and rerunning your code, you can use
1337 the %debug magic."""
1313 the %debug magic."""
1338
1314
1339 par = parameter_s.strip().lower()
1315 par = parameter_s.strip().lower()
1340
1316
1341 if par:
1317 if par:
1342 try:
1318 try:
1343 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1319 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1344 except KeyError:
1320 except KeyError:
1345 print ('Incorrect argument. Use on/1, off/0, '
1321 print ('Incorrect argument. Use on/1, off/0, '
1346 'or nothing for a toggle.')
1322 'or nothing for a toggle.')
1347 return
1323 return
1348 else:
1324 else:
1349 # toggle
1325 # toggle
1350 new_pdb = not self.shell.call_pdb
1326 new_pdb = not self.shell.call_pdb
1351
1327
1352 # set on the shell
1328 # set on the shell
1353 self.shell.call_pdb = new_pdb
1329 self.shell.call_pdb = new_pdb
1354 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1330 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1355
1331
1356 def magic_debug(self, parameter_s=''):
1332 def magic_debug(self, parameter_s=''):
1357 """Activate the interactive debugger in post-mortem mode.
1333 """Activate the interactive debugger in post-mortem mode.
1358
1334
1359 If an exception has just occurred, this lets you inspect its stack
1335 If an exception has just occurred, this lets you inspect its stack
1360 frames interactively. Note that this will always work only on the last
1336 frames interactively. Note that this will always work only on the last
1361 traceback that occurred, so you must call this quickly after an
1337 traceback that occurred, so you must call this quickly after an
1362 exception that you wish to inspect has fired, because if another one
1338 exception that you wish to inspect has fired, because if another one
1363 occurs, it clobbers the previous one.
1339 occurs, it clobbers the previous one.
1364
1340
1365 If you want IPython to automatically do this on every exception, see
1341 If you want IPython to automatically do this on every exception, see
1366 the %pdb magic for more details.
1342 the %pdb magic for more details.
1367 """
1343 """
1368 self.shell.debugger(force=True)
1344 self.shell.debugger(force=True)
1369
1345
1370 @skip_doctest
1346 @skip_doctest
1371 def magic_prun(self, parameter_s ='',user_mode=1,
1347 def magic_prun(self, parameter_s ='',user_mode=1,
1372 opts=None,arg_lst=None,prog_ns=None):
1348 opts=None,arg_lst=None,prog_ns=None):
1373
1349
1374 """Run a statement through the python code profiler.
1350 """Run a statement through the python code profiler.
1375
1351
1376 Usage:
1352 Usage:
1377 %prun [options] statement
1353 %prun [options] statement
1378
1354
1379 The given statement (which doesn't require quote marks) is run via the
1355 The given statement (which doesn't require quote marks) is run via the
1380 python profiler in a manner similar to the profile.run() function.
1356 python profiler in a manner similar to the profile.run() function.
1381 Namespaces are internally managed to work correctly; profile.run
1357 Namespaces are internally managed to work correctly; profile.run
1382 cannot be used in IPython because it makes certain assumptions about
1358 cannot be used in IPython because it makes certain assumptions about
1383 namespaces which do not hold under IPython.
1359 namespaces which do not hold under IPython.
1384
1360
1385 Options:
1361 Options:
1386
1362
1387 -l <limit>: you can place restrictions on what or how much of the
1363 -l <limit>: you can place restrictions on what or how much of the
1388 profile gets printed. The limit value can be:
1364 profile gets printed. The limit value can be:
1389
1365
1390 * A string: only information for function names containing this string
1366 * A string: only information for function names containing this string
1391 is printed.
1367 is printed.
1392
1368
1393 * An integer: only these many lines are printed.
1369 * An integer: only these many lines are printed.
1394
1370
1395 * A float (between 0 and 1): this fraction of the report is printed
1371 * A float (between 0 and 1): this fraction of the report is printed
1396 (for example, use a limit of 0.4 to see the topmost 40% only).
1372 (for example, use a limit of 0.4 to see the topmost 40% only).
1397
1373
1398 You can combine several limits with repeated use of the option. For
1374 You can combine several limits with repeated use of the option. For
1399 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1375 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1400 information about class constructors.
1376 information about class constructors.
1401
1377
1402 -r: return the pstats.Stats object generated by the profiling. This
1378 -r: return the pstats.Stats object generated by the profiling. This
1403 object has all the information about the profile in it, and you can
1379 object has all the information about the profile in it, and you can
1404 later use it for further analysis or in other functions.
1380 later use it for further analysis or in other functions.
1405
1381
1406 -s <key>: sort profile by given key. You can provide more than one key
1382 -s <key>: sort profile by given key. You can provide more than one key
1407 by using the option several times: '-s key1 -s key2 -s key3...'. The
1383 by using the option several times: '-s key1 -s key2 -s key3...'. The
1408 default sorting key is 'time'.
1384 default sorting key is 'time'.
1409
1385
1410 The following is copied verbatim from the profile documentation
1386 The following is copied verbatim from the profile documentation
1411 referenced below:
1387 referenced below:
1412
1388
1413 When more than one key is provided, additional keys are used as
1389 When more than one key is provided, additional keys are used as
1414 secondary criteria when the there is equality in all keys selected
1390 secondary criteria when the there is equality in all keys selected
1415 before them.
1391 before them.
1416
1392
1417 Abbreviations can be used for any key names, as long as the
1393 Abbreviations can be used for any key names, as long as the
1418 abbreviation is unambiguous. The following are the keys currently
1394 abbreviation is unambiguous. The following are the keys currently
1419 defined:
1395 defined:
1420
1396
1421 Valid Arg Meaning
1397 Valid Arg Meaning
1422 "calls" call count
1398 "calls" call count
1423 "cumulative" cumulative time
1399 "cumulative" cumulative time
1424 "file" file name
1400 "file" file name
1425 "module" file name
1401 "module" file name
1426 "pcalls" primitive call count
1402 "pcalls" primitive call count
1427 "line" line number
1403 "line" line number
1428 "name" function name
1404 "name" function name
1429 "nfl" name/file/line
1405 "nfl" name/file/line
1430 "stdname" standard name
1406 "stdname" standard name
1431 "time" internal time
1407 "time" internal time
1432
1408
1433 Note that all sorts on statistics are in descending order (placing
1409 Note that all sorts on statistics are in descending order (placing
1434 most time consuming items first), where as name, file, and line number
1410 most time consuming items first), where as name, file, and line number
1435 searches are in ascending order (i.e., alphabetical). The subtle
1411 searches are in ascending order (i.e., alphabetical). The subtle
1436 distinction between "nfl" and "stdname" is that the standard name is a
1412 distinction between "nfl" and "stdname" is that the standard name is a
1437 sort of the name as printed, which means that the embedded line
1413 sort of the name as printed, which means that the embedded line
1438 numbers get compared in an odd way. For example, lines 3, 20, and 40
1414 numbers get compared in an odd way. For example, lines 3, 20, and 40
1439 would (if the file names were the same) appear in the string order
1415 would (if the file names were the same) appear in the string order
1440 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1416 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1441 line numbers. In fact, sort_stats("nfl") is the same as
1417 line numbers. In fact, sort_stats("nfl") is the same as
1442 sort_stats("name", "file", "line").
1418 sort_stats("name", "file", "line").
1443
1419
1444 -T <filename>: save profile results as shown on screen to a text
1420 -T <filename>: save profile results as shown on screen to a text
1445 file. The profile is still shown on screen.
1421 file. The profile is still shown on screen.
1446
1422
1447 -D <filename>: save (via dump_stats) profile statistics to given
1423 -D <filename>: save (via dump_stats) profile statistics to given
1448 filename. This data is in a format understood by the pstats module, and
1424 filename. This data is in a format understood by the pstats module, and
1449 is generated by a call to the dump_stats() method of profile
1425 is generated by a call to the dump_stats() method of profile
1450 objects. The profile is still shown on screen.
1426 objects. The profile is still shown on screen.
1451
1427
1452 -q: suppress output to the pager. Best used with -T and/or -D above.
1428 -q: suppress output to the pager. Best used with -T and/or -D above.
1453
1429
1454 If you want to run complete programs under the profiler's control, use
1430 If you want to run complete programs under the profiler's control, use
1455 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1431 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1456 contains profiler specific options as described here.
1432 contains profiler specific options as described here.
1457
1433
1458 You can read the complete documentation for the profile module with::
1434 You can read the complete documentation for the profile module with::
1459
1435
1460 In [1]: import profile; profile.help()
1436 In [1]: import profile; profile.help()
1461 """
1437 """
1462
1438
1463 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1439 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1464
1440
1465 if user_mode: # regular user call
1441 if user_mode: # regular user call
1466 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
1442 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
1467 list_all=1, posix=False)
1443 list_all=1, posix=False)
1468 namespace = self.shell.user_ns
1444 namespace = self.shell.user_ns
1469 else: # called to run a program by %run -p
1445 else: # called to run a program by %run -p
1470 try:
1446 try:
1471 filename = get_py_filename(arg_lst[0])
1447 filename = get_py_filename(arg_lst[0])
1472 except IOError as e:
1448 except IOError as e:
1473 try:
1449 try:
1474 msg = str(e)
1450 msg = str(e)
1475 except UnicodeError:
1451 except UnicodeError:
1476 msg = e.message
1452 msg = e.message
1477 error(msg)
1453 error(msg)
1478 return
1454 return
1479
1455
1480 arg_str = 'execfile(filename,prog_ns)'
1456 arg_str = 'execfile(filename,prog_ns)'
1481 namespace = {
1457 namespace = {
1482 'execfile': self.shell.safe_execfile,
1458 'execfile': self.shell.safe_execfile,
1483 'prog_ns': prog_ns,
1459 'prog_ns': prog_ns,
1484 'filename': filename
1460 'filename': filename
1485 }
1461 }
1486
1462
1487 opts.merge(opts_def)
1463 opts.merge(opts_def)
1488
1464
1489 prof = profile.Profile()
1465 prof = profile.Profile()
1490 try:
1466 try:
1491 prof = prof.runctx(arg_str,namespace,namespace)
1467 prof = prof.runctx(arg_str,namespace,namespace)
1492 sys_exit = ''
1468 sys_exit = ''
1493 except SystemExit:
1469 except SystemExit:
1494 sys_exit = """*** SystemExit exception caught in code being profiled."""
1470 sys_exit = """*** SystemExit exception caught in code being profiled."""
1495
1471
1496 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1472 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1497
1473
1498 lims = opts.l
1474 lims = opts.l
1499 if lims:
1475 if lims:
1500 lims = [] # rebuild lims with ints/floats/strings
1476 lims = [] # rebuild lims with ints/floats/strings
1501 for lim in opts.l:
1477 for lim in opts.l:
1502 try:
1478 try:
1503 lims.append(int(lim))
1479 lims.append(int(lim))
1504 except ValueError:
1480 except ValueError:
1505 try:
1481 try:
1506 lims.append(float(lim))
1482 lims.append(float(lim))
1507 except ValueError:
1483 except ValueError:
1508 lims.append(lim)
1484 lims.append(lim)
1509
1485
1510 # Trap output.
1486 # Trap output.
1511 stdout_trap = StringIO()
1487 stdout_trap = StringIO()
1512
1488
1513 if hasattr(stats,'stream'):
1489 if hasattr(stats,'stream'):
1514 # In newer versions of python, the stats object has a 'stream'
1490 # In newer versions of python, the stats object has a 'stream'
1515 # attribute to write into.
1491 # attribute to write into.
1516 stats.stream = stdout_trap
1492 stats.stream = stdout_trap
1517 stats.print_stats(*lims)
1493 stats.print_stats(*lims)
1518 else:
1494 else:
1519 # For older versions, we manually redirect stdout during printing
1495 # For older versions, we manually redirect stdout during printing
1520 sys_stdout = sys.stdout
1496 sys_stdout = sys.stdout
1521 try:
1497 try:
1522 sys.stdout = stdout_trap
1498 sys.stdout = stdout_trap
1523 stats.print_stats(*lims)
1499 stats.print_stats(*lims)
1524 finally:
1500 finally:
1525 sys.stdout = sys_stdout
1501 sys.stdout = sys_stdout
1526
1502
1527 output = stdout_trap.getvalue()
1503 output = stdout_trap.getvalue()
1528 output = output.rstrip()
1504 output = output.rstrip()
1529
1505
1530 if 'q' not in opts:
1506 if 'q' not in opts:
1531 page.page(output)
1507 page.page(output)
1532 print sys_exit,
1508 print sys_exit,
1533
1509
1534 dump_file = opts.D[0]
1510 dump_file = opts.D[0]
1535 text_file = opts.T[0]
1511 text_file = opts.T[0]
1536 if dump_file:
1512 if dump_file:
1537 dump_file = unquote_filename(dump_file)
1513 dump_file = unquote_filename(dump_file)
1538 prof.dump_stats(dump_file)
1514 prof.dump_stats(dump_file)
1539 print '\n*** Profile stats marshalled to file',\
1515 print '\n*** Profile stats marshalled to file',\
1540 `dump_file`+'.',sys_exit
1516 `dump_file`+'.',sys_exit
1541 if text_file:
1517 if text_file:
1542 text_file = unquote_filename(text_file)
1518 text_file = unquote_filename(text_file)
1543 pfile = open(text_file,'w')
1519 pfile = open(text_file,'w')
1544 pfile.write(output)
1520 pfile.write(output)
1545 pfile.close()
1521 pfile.close()
1546 print '\n*** Profile printout saved to text file',\
1522 print '\n*** Profile printout saved to text file',\
1547 `text_file`+'.',sys_exit
1523 `text_file`+'.',sys_exit
1548
1524
1549 if opts.has_key('r'):
1525 if opts.has_key('r'):
1550 return stats
1526 return stats
1551 else:
1527 else:
1552 return None
1528 return None
1553
1529
1554 @skip_doctest
1530 @skip_doctest
1555 def magic_run(self, parameter_s ='', runner=None,
1531 def magic_run(self, parameter_s ='', runner=None,
1556 file_finder=get_py_filename):
1532 file_finder=get_py_filename):
1557 """Run the named file inside IPython as a program.
1533 """Run the named file inside IPython as a program.
1558
1534
1559 Usage:\\
1535 Usage:\\
1560 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1536 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1561
1537
1562 Parameters after the filename are passed as command-line arguments to
1538 Parameters after the filename are passed as command-line arguments to
1563 the program (put in sys.argv). Then, control returns to IPython's
1539 the program (put in sys.argv). Then, control returns to IPython's
1564 prompt.
1540 prompt.
1565
1541
1566 This is similar to running at a system prompt:\\
1542 This is similar to running at a system prompt:\\
1567 $ python file args\\
1543 $ python file args\\
1568 but with the advantage of giving you IPython's tracebacks, and of
1544 but with the advantage of giving you IPython's tracebacks, and of
1569 loading all variables into your interactive namespace for further use
1545 loading all variables into your interactive namespace for further use
1570 (unless -p is used, see below).
1546 (unless -p is used, see below).
1571
1547
1572 The file is executed in a namespace initially consisting only of
1548 The file is executed in a namespace initially consisting only of
1573 __name__=='__main__' and sys.argv constructed as indicated. It thus
1549 __name__=='__main__' and sys.argv constructed as indicated. It thus
1574 sees its environment as if it were being run as a stand-alone program
1550 sees its environment as if it were being run as a stand-alone program
1575 (except for sharing global objects such as previously imported
1551 (except for sharing global objects such as previously imported
1576 modules). But after execution, the IPython interactive namespace gets
1552 modules). But after execution, the IPython interactive namespace gets
1577 updated with all variables defined in the program (except for __name__
1553 updated with all variables defined in the program (except for __name__
1578 and sys.argv). This allows for very convenient loading of code for
1554 and sys.argv). This allows for very convenient loading of code for
1579 interactive work, while giving each program a 'clean sheet' to run in.
1555 interactive work, while giving each program a 'clean sheet' to run in.
1580
1556
1581 Options:
1557 Options:
1582
1558
1583 -n: __name__ is NOT set to '__main__', but to the running file's name
1559 -n: __name__ is NOT set to '__main__', but to the running file's name
1584 without extension (as python does under import). This allows running
1560 without extension (as python does under import). This allows running
1585 scripts and reloading the definitions in them without calling code
1561 scripts and reloading the definitions in them without calling code
1586 protected by an ' if __name__ == "__main__" ' clause.
1562 protected by an ' if __name__ == "__main__" ' clause.
1587
1563
1588 -i: run the file in IPython's namespace instead of an empty one. This
1564 -i: run the file in IPython's namespace instead of an empty one. This
1589 is useful if you are experimenting with code written in a text editor
1565 is useful if you are experimenting with code written in a text editor
1590 which depends on variables defined interactively.
1566 which depends on variables defined interactively.
1591
1567
1592 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1568 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1593 being run. This is particularly useful if IPython is being used to
1569 being run. This is particularly useful if IPython is being used to
1594 run unittests, which always exit with a sys.exit() call. In such
1570 run unittests, which always exit with a sys.exit() call. In such
1595 cases you are interested in the output of the test results, not in
1571 cases you are interested in the output of the test results, not in
1596 seeing a traceback of the unittest module.
1572 seeing a traceback of the unittest module.
1597
1573
1598 -t: print timing information at the end of the run. IPython will give
1574 -t: print timing information at the end of the run. IPython will give
1599 you an estimated CPU time consumption for your script, which under
1575 you an estimated CPU time consumption for your script, which under
1600 Unix uses the resource module to avoid the wraparound problems of
1576 Unix uses the resource module to avoid the wraparound problems of
1601 time.clock(). Under Unix, an estimate of time spent on system tasks
1577 time.clock(). Under Unix, an estimate of time spent on system tasks
1602 is also given (for Windows platforms this is reported as 0.0).
1578 is also given (for Windows platforms this is reported as 0.0).
1603
1579
1604 If -t is given, an additional -N<N> option can be given, where <N>
1580 If -t is given, an additional -N<N> option can be given, where <N>
1605 must be an integer indicating how many times you want the script to
1581 must be an integer indicating how many times you want the script to
1606 run. The final timing report will include total and per run results.
1582 run. The final timing report will include total and per run results.
1607
1583
1608 For example (testing the script uniq_stable.py)::
1584 For example (testing the script uniq_stable.py)::
1609
1585
1610 In [1]: run -t uniq_stable
1586 In [1]: run -t uniq_stable
1611
1587
1612 IPython CPU timings (estimated):\\
1588 IPython CPU timings (estimated):\\
1613 User : 0.19597 s.\\
1589 User : 0.19597 s.\\
1614 System: 0.0 s.\\
1590 System: 0.0 s.\\
1615
1591
1616 In [2]: run -t -N5 uniq_stable
1592 In [2]: run -t -N5 uniq_stable
1617
1593
1618 IPython CPU timings (estimated):\\
1594 IPython CPU timings (estimated):\\
1619 Total runs performed: 5\\
1595 Total runs performed: 5\\
1620 Times : Total Per run\\
1596 Times : Total Per run\\
1621 User : 0.910862 s, 0.1821724 s.\\
1597 User : 0.910862 s, 0.1821724 s.\\
1622 System: 0.0 s, 0.0 s.
1598 System: 0.0 s, 0.0 s.
1623
1599
1624 -d: run your program under the control of pdb, the Python debugger.
1600 -d: run your program under the control of pdb, the Python debugger.
1625 This allows you to execute your program step by step, watch variables,
1601 This allows you to execute your program step by step, watch variables,
1626 etc. Internally, what IPython does is similar to calling:
1602 etc. Internally, what IPython does is similar to calling:
1627
1603
1628 pdb.run('execfile("YOURFILENAME")')
1604 pdb.run('execfile("YOURFILENAME")')
1629
1605
1630 with a breakpoint set on line 1 of your file. You can change the line
1606 with a breakpoint set on line 1 of your file. You can change the line
1631 number for this automatic breakpoint to be <N> by using the -bN option
1607 number for this automatic breakpoint to be <N> by using the -bN option
1632 (where N must be an integer). For example::
1608 (where N must be an integer). For example::
1633
1609
1634 %run -d -b40 myscript
1610 %run -d -b40 myscript
1635
1611
1636 will set the first breakpoint at line 40 in myscript.py. Note that
1612 will set the first breakpoint at line 40 in myscript.py. Note that
1637 the first breakpoint must be set on a line which actually does
1613 the first breakpoint must be set on a line which actually does
1638 something (not a comment or docstring) for it to stop execution.
1614 something (not a comment or docstring) for it to stop execution.
1639
1615
1640 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1616 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1641 first enter 'c' (without quotes) to start execution up to the first
1617 first enter 'c' (without quotes) to start execution up to the first
1642 breakpoint.
1618 breakpoint.
1643
1619
1644 Entering 'help' gives information about the use of the debugger. You
1620 Entering 'help' gives information about the use of the debugger. You
1645 can easily see pdb's full documentation with "import pdb;pdb.help()"
1621 can easily see pdb's full documentation with "import pdb;pdb.help()"
1646 at a prompt.
1622 at a prompt.
1647
1623
1648 -p: run program under the control of the Python profiler module (which
1624 -p: run program under the control of the Python profiler module (which
1649 prints a detailed report of execution times, function calls, etc).
1625 prints a detailed report of execution times, function calls, etc).
1650
1626
1651 You can pass other options after -p which affect the behavior of the
1627 You can pass other options after -p which affect the behavior of the
1652 profiler itself. See the docs for %prun for details.
1628 profiler itself. See the docs for %prun for details.
1653
1629
1654 In this mode, the program's variables do NOT propagate back to the
1630 In this mode, the program's variables do NOT propagate back to the
1655 IPython interactive namespace (because they remain in the namespace
1631 IPython interactive namespace (because they remain in the namespace
1656 where the profiler executes them).
1632 where the profiler executes them).
1657
1633
1658 Internally this triggers a call to %prun, see its documentation for
1634 Internally this triggers a call to %prun, see its documentation for
1659 details on the options available specifically for profiling.
1635 details on the options available specifically for profiling.
1660
1636
1661 There is one special usage for which the text above doesn't apply:
1637 There is one special usage for which the text above doesn't apply:
1662 if the filename ends with .ipy, the file is run as ipython script,
1638 if the filename ends with .ipy, the file is run as ipython script,
1663 just as if the commands were written on IPython prompt.
1639 just as if the commands were written on IPython prompt.
1664
1640
1665 -m: specify module name to load instead of script path. Similar to
1641 -m: specify module name to load instead of script path. Similar to
1666 the -m option for the python interpreter. Use this option last if you
1642 the -m option for the python interpreter. Use this option last if you
1667 want to combine with other %run options. Unlike the python interpreter
1643 want to combine with other %run options. Unlike the python interpreter
1668 only source modules are allowed no .pyc or .pyo files.
1644 only source modules are allowed no .pyc or .pyo files.
1669 For example::
1645 For example::
1670
1646
1671 %run -m example
1647 %run -m example
1672
1648
1673 will run the example module.
1649 will run the example module.
1674
1650
1675 """
1651 """
1676
1652
1677 # get arguments and set sys.argv for program to be run.
1653 # get arguments and set sys.argv for program to be run.
1678 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1654 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1679 mode='list', list_all=1)
1655 mode='list', list_all=1)
1680 if "m" in opts:
1656 if "m" in opts:
1681 modulename = opts["m"][0]
1657 modulename = opts["m"][0]
1682 modpath = find_mod(modulename)
1658 modpath = find_mod(modulename)
1683 if modpath is None:
1659 if modpath is None:
1684 warn('%r is not a valid modulename on sys.path'%modulename)
1660 warn('%r is not a valid modulename on sys.path'%modulename)
1685 return
1661 return
1686 arg_lst = [modpath] + arg_lst
1662 arg_lst = [modpath] + arg_lst
1687 try:
1663 try:
1688 filename = file_finder(arg_lst[0])
1664 filename = file_finder(arg_lst[0])
1689 except IndexError:
1665 except IndexError:
1690 warn('you must provide at least a filename.')
1666 warn('you must provide at least a filename.')
1691 print '\n%run:\n', oinspect.getdoc(self.magic_run)
1667 print '\n%run:\n', oinspect.getdoc(self.magic_run)
1692 return
1668 return
1693 except IOError as e:
1669 except IOError as e:
1694 try:
1670 try:
1695 msg = str(e)
1671 msg = str(e)
1696 except UnicodeError:
1672 except UnicodeError:
1697 msg = e.message
1673 msg = e.message
1698 error(msg)
1674 error(msg)
1699 return
1675 return
1700
1676
1701 if filename.lower().endswith('.ipy'):
1677 if filename.lower().endswith('.ipy'):
1702 self.shell.safe_execfile_ipy(filename)
1678 self.shell.safe_execfile_ipy(filename)
1703 return
1679 return
1704
1680
1705 # Control the response to exit() calls made by the script being run
1681 # Control the response to exit() calls made by the script being run
1706 exit_ignore = 'e' in opts
1682 exit_ignore = 'e' in opts
1707
1683
1708 # Make sure that the running script gets a proper sys.argv as if it
1684 # Make sure that the running script gets a proper sys.argv as if it
1709 # were run from a system shell.
1685 # were run from a system shell.
1710 save_argv = sys.argv # save it for later restoring
1686 save_argv = sys.argv # save it for later restoring
1711
1687
1712 # simulate shell expansion on arguments, at least tilde expansion
1688 # simulate shell expansion on arguments, at least tilde expansion
1713 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1689 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1714
1690
1715 sys.argv = [filename] + args # put in the proper filename
1691 sys.argv = [filename] + args # put in the proper filename
1716 # protect sys.argv from potential unicode strings on Python 2:
1692 # protect sys.argv from potential unicode strings on Python 2:
1717 if not py3compat.PY3:
1693 if not py3compat.PY3:
1718 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1694 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1719
1695
1720 if 'i' in opts:
1696 if 'i' in opts:
1721 # Run in user's interactive namespace
1697 # Run in user's interactive namespace
1722 prog_ns = self.shell.user_ns
1698 prog_ns = self.shell.user_ns
1723 __name__save = self.shell.user_ns['__name__']
1699 __name__save = self.shell.user_ns['__name__']
1724 prog_ns['__name__'] = '__main__'
1700 prog_ns['__name__'] = '__main__'
1725 main_mod = self.shell.new_main_mod(prog_ns)
1701 main_mod = self.shell.new_main_mod(prog_ns)
1726 else:
1702 else:
1727 # Run in a fresh, empty namespace
1703 # Run in a fresh, empty namespace
1728 if 'n' in opts:
1704 if 'n' in opts:
1729 name = os.path.splitext(os.path.basename(filename))[0]
1705 name = os.path.splitext(os.path.basename(filename))[0]
1730 else:
1706 else:
1731 name = '__main__'
1707 name = '__main__'
1732
1708
1733 main_mod = self.shell.new_main_mod()
1709 main_mod = self.shell.new_main_mod()
1734 prog_ns = main_mod.__dict__
1710 prog_ns = main_mod.__dict__
1735 prog_ns['__name__'] = name
1711 prog_ns['__name__'] = name
1736
1712
1737 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1713 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1738 # set the __file__ global in the script's namespace
1714 # set the __file__ global in the script's namespace
1739 prog_ns['__file__'] = filename
1715 prog_ns['__file__'] = filename
1740
1716
1741 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1717 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1742 # that, if we overwrite __main__, we replace it at the end
1718 # that, if we overwrite __main__, we replace it at the end
1743 main_mod_name = prog_ns['__name__']
1719 main_mod_name = prog_ns['__name__']
1744
1720
1745 if main_mod_name == '__main__':
1721 if main_mod_name == '__main__':
1746 restore_main = sys.modules['__main__']
1722 restore_main = sys.modules['__main__']
1747 else:
1723 else:
1748 restore_main = False
1724 restore_main = False
1749
1725
1750 # This needs to be undone at the end to prevent holding references to
1726 # This needs to be undone at the end to prevent holding references to
1751 # every single object ever created.
1727 # every single object ever created.
1752 sys.modules[main_mod_name] = main_mod
1728 sys.modules[main_mod_name] = main_mod
1753
1729
1754 try:
1730 try:
1755 stats = None
1731 stats = None
1756 with self.shell.readline_no_record:
1732 with self.shell.readline_no_record:
1757 if 'p' in opts:
1733 if 'p' in opts:
1758 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
1734 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
1759 else:
1735 else:
1760 if 'd' in opts:
1736 if 'd' in opts:
1761 deb = debugger.Pdb(self.shell.colors)
1737 deb = debugger.Pdb(self.shell.colors)
1762 # reset Breakpoint state, which is moronically kept
1738 # reset Breakpoint state, which is moronically kept
1763 # in a class
1739 # in a class
1764 bdb.Breakpoint.next = 1
1740 bdb.Breakpoint.next = 1
1765 bdb.Breakpoint.bplist = {}
1741 bdb.Breakpoint.bplist = {}
1766 bdb.Breakpoint.bpbynumber = [None]
1742 bdb.Breakpoint.bpbynumber = [None]
1767 # Set an initial breakpoint to stop execution
1743 # Set an initial breakpoint to stop execution
1768 maxtries = 10
1744 maxtries = 10
1769 bp = int(opts.get('b', [1])[0])
1745 bp = int(opts.get('b', [1])[0])
1770 checkline = deb.checkline(filename, bp)
1746 checkline = deb.checkline(filename, bp)
1771 if not checkline:
1747 if not checkline:
1772 for bp in range(bp + 1, bp + maxtries + 1):
1748 for bp in range(bp + 1, bp + maxtries + 1):
1773 if deb.checkline(filename, bp):
1749 if deb.checkline(filename, bp):
1774 break
1750 break
1775 else:
1751 else:
1776 msg = ("\nI failed to find a valid line to set "
1752 msg = ("\nI failed to find a valid line to set "
1777 "a breakpoint\n"
1753 "a breakpoint\n"
1778 "after trying up to line: %s.\n"
1754 "after trying up to line: %s.\n"
1779 "Please set a valid breakpoint manually "
1755 "Please set a valid breakpoint manually "
1780 "with the -b option." % bp)
1756 "with the -b option." % bp)
1781 error(msg)
1757 error(msg)
1782 return
1758 return
1783 # if we find a good linenumber, set the breakpoint
1759 # if we find a good linenumber, set the breakpoint
1784 deb.do_break('%s:%s' % (filename, bp))
1760 deb.do_break('%s:%s' % (filename, bp))
1785 # Start file run
1761 # Start file run
1786 print "NOTE: Enter 'c' at the",
1762 print "NOTE: Enter 'c' at the",
1787 print "%s prompt to start your script." % deb.prompt
1763 print "%s prompt to start your script." % deb.prompt
1788 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1764 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1789 try:
1765 try:
1790 deb.run('execfile("%s", prog_ns)' % filename, ns)
1766 deb.run('execfile("%s", prog_ns)' % filename, ns)
1791
1767
1792 except:
1768 except:
1793 etype, value, tb = sys.exc_info()
1769 etype, value, tb = sys.exc_info()
1794 # Skip three frames in the traceback: the %run one,
1770 # Skip three frames in the traceback: the %run one,
1795 # one inside bdb.py, and the command-line typed by the
1771 # one inside bdb.py, and the command-line typed by the
1796 # user (run by exec in pdb itself).
1772 # user (run by exec in pdb itself).
1797 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1773 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1798 else:
1774 else:
1799 if runner is None:
1775 if runner is None:
1800 runner = self.default_runner
1776 runner = self.default_runner
1801 if runner is None:
1777 if runner is None:
1802 runner = self.shell.safe_execfile
1778 runner = self.shell.safe_execfile
1803 if 't' in opts:
1779 if 't' in opts:
1804 # timed execution
1780 # timed execution
1805 try:
1781 try:
1806 nruns = int(opts['N'][0])
1782 nruns = int(opts['N'][0])
1807 if nruns < 1:
1783 if nruns < 1:
1808 error('Number of runs must be >=1')
1784 error('Number of runs must be >=1')
1809 return
1785 return
1810 except (KeyError):
1786 except (KeyError):
1811 nruns = 1
1787 nruns = 1
1812 twall0 = time.time()
1788 twall0 = time.time()
1813 if nruns == 1:
1789 if nruns == 1:
1814 t0 = clock2()
1790 t0 = clock2()
1815 runner(filename, prog_ns, prog_ns,
1791 runner(filename, prog_ns, prog_ns,
1816 exit_ignore=exit_ignore)
1792 exit_ignore=exit_ignore)
1817 t1 = clock2()
1793 t1 = clock2()
1818 t_usr = t1[0] - t0[0]
1794 t_usr = t1[0] - t0[0]
1819 t_sys = t1[1] - t0[1]
1795 t_sys = t1[1] - t0[1]
1820 print "\nIPython CPU timings (estimated):"
1796 print "\nIPython CPU timings (estimated):"
1821 print " User : %10.2f s." % t_usr
1797 print " User : %10.2f s." % t_usr
1822 print " System : %10.2f s." % t_sys
1798 print " System : %10.2f s." % t_sys
1823 else:
1799 else:
1824 runs = range(nruns)
1800 runs = range(nruns)
1825 t0 = clock2()
1801 t0 = clock2()
1826 for nr in runs:
1802 for nr in runs:
1827 runner(filename, prog_ns, prog_ns,
1803 runner(filename, prog_ns, prog_ns,
1828 exit_ignore=exit_ignore)
1804 exit_ignore=exit_ignore)
1829 t1 = clock2()
1805 t1 = clock2()
1830 t_usr = t1[0] - t0[0]
1806 t_usr = t1[0] - t0[0]
1831 t_sys = t1[1] - t0[1]
1807 t_sys = t1[1] - t0[1]
1832 print "\nIPython CPU timings (estimated):"
1808 print "\nIPython CPU timings (estimated):"
1833 print "Total runs performed:", nruns
1809 print "Total runs performed:", nruns
1834 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1810 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1835 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1811 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1836 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1812 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1837 twall1 = time.time()
1813 twall1 = time.time()
1838 print "Wall time: %10.2f s." % (twall1 - twall0)
1814 print "Wall time: %10.2f s." % (twall1 - twall0)
1839
1815
1840 else:
1816 else:
1841 # regular execution
1817 # regular execution
1842 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1818 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1843
1819
1844 if 'i' in opts:
1820 if 'i' in opts:
1845 self.shell.user_ns['__name__'] = __name__save
1821 self.shell.user_ns['__name__'] = __name__save
1846 else:
1822 else:
1847 # The shell MUST hold a reference to prog_ns so after %run
1823 # The shell MUST hold a reference to prog_ns so after %run
1848 # exits, the python deletion mechanism doesn't zero it out
1824 # exits, the python deletion mechanism doesn't zero it out
1849 # (leaving dangling references).
1825 # (leaving dangling references).
1850 self.shell.cache_main_mod(prog_ns, filename)
1826 self.shell.cache_main_mod(prog_ns, filename)
1851 # update IPython interactive namespace
1827 # update IPython interactive namespace
1852
1828
1853 # Some forms of read errors on the file may mean the
1829 # Some forms of read errors on the file may mean the
1854 # __name__ key was never set; using pop we don't have to
1830 # __name__ key was never set; using pop we don't have to
1855 # worry about a possible KeyError.
1831 # worry about a possible KeyError.
1856 prog_ns.pop('__name__', None)
1832 prog_ns.pop('__name__', None)
1857
1833
1858 self.shell.user_ns.update(prog_ns)
1834 self.shell.user_ns.update(prog_ns)
1859 finally:
1835 finally:
1860 # It's a bit of a mystery why, but __builtins__ can change from
1836 # It's a bit of a mystery why, but __builtins__ can change from
1861 # being a module to becoming a dict missing some key data after
1837 # being a module to becoming a dict missing some key data after
1862 # %run. As best I can see, this is NOT something IPython is doing
1838 # %run. As best I can see, this is NOT something IPython is doing
1863 # at all, and similar problems have been reported before:
1839 # at all, and similar problems have been reported before:
1864 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1840 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1865 # Since this seems to be done by the interpreter itself, the best
1841 # Since this seems to be done by the interpreter itself, the best
1866 # we can do is to at least restore __builtins__ for the user on
1842 # we can do is to at least restore __builtins__ for the user on
1867 # exit.
1843 # exit.
1868 self.shell.user_ns['__builtins__'] = builtin_mod
1844 self.shell.user_ns['__builtins__'] = builtin_mod
1869
1845
1870 # Ensure key global structures are restored
1846 # Ensure key global structures are restored
1871 sys.argv = save_argv
1847 sys.argv = save_argv
1872 if restore_main:
1848 if restore_main:
1873 sys.modules['__main__'] = restore_main
1849 sys.modules['__main__'] = restore_main
1874 else:
1850 else:
1875 # Remove from sys.modules the reference to main_mod we'd
1851 # Remove from sys.modules the reference to main_mod we'd
1876 # added. Otherwise it will trap references to objects
1852 # added. Otherwise it will trap references to objects
1877 # contained therein.
1853 # contained therein.
1878 del sys.modules[main_mod_name]
1854 del sys.modules[main_mod_name]
1879
1855
1880 return stats
1856 return stats
1881
1857
1882 @skip_doctest
1858 @skip_doctest
1883 def magic_timeit(self, parameter_s =''):
1859 def magic_timeit(self, parameter_s =''):
1884 """Time execution of a Python statement or expression
1860 """Time execution of a Python statement or expression
1885
1861
1886 Usage:\\
1862 Usage:\\
1887 %timeit [-n<N> -r<R> [-t|-c]] statement
1863 %timeit [-n<N> -r<R> [-t|-c]] statement
1888
1864
1889 Time execution of a Python statement or expression using the timeit
1865 Time execution of a Python statement or expression using the timeit
1890 module.
1866 module.
1891
1867
1892 Options:
1868 Options:
1893 -n<N>: execute the given statement <N> times in a loop. If this value
1869 -n<N>: execute the given statement <N> times in a loop. If this value
1894 is not given, a fitting value is chosen.
1870 is not given, a fitting value is chosen.
1895
1871
1896 -r<R>: repeat the loop iteration <R> times and take the best result.
1872 -r<R>: repeat the loop iteration <R> times and take the best result.
1897 Default: 3
1873 Default: 3
1898
1874
1899 -t: use time.time to measure the time, which is the default on Unix.
1875 -t: use time.time to measure the time, which is the default on Unix.
1900 This function measures wall time.
1876 This function measures wall time.
1901
1877
1902 -c: use time.clock to measure the time, which is the default on
1878 -c: use time.clock to measure the time, which is the default on
1903 Windows and measures wall time. On Unix, resource.getrusage is used
1879 Windows and measures wall time. On Unix, resource.getrusage is used
1904 instead and returns the CPU user time.
1880 instead and returns the CPU user time.
1905
1881
1906 -p<P>: use a precision of <P> digits to display the timing result.
1882 -p<P>: use a precision of <P> digits to display the timing result.
1907 Default: 3
1883 Default: 3
1908
1884
1909
1885
1910 Examples
1886 Examples
1911 --------
1887 --------
1912 ::
1888 ::
1913
1889
1914 In [1]: %timeit pass
1890 In [1]: %timeit pass
1915 10000000 loops, best of 3: 53.3 ns per loop
1891 10000000 loops, best of 3: 53.3 ns per loop
1916
1892
1917 In [2]: u = None
1893 In [2]: u = None
1918
1894
1919 In [3]: %timeit u is None
1895 In [3]: %timeit u is None
1920 10000000 loops, best of 3: 184 ns per loop
1896 10000000 loops, best of 3: 184 ns per loop
1921
1897
1922 In [4]: %timeit -r 4 u == None
1898 In [4]: %timeit -r 4 u == None
1923 1000000 loops, best of 4: 242 ns per loop
1899 1000000 loops, best of 4: 242 ns per loop
1924
1900
1925 In [5]: import time
1901 In [5]: import time
1926
1902
1927 In [6]: %timeit -n1 time.sleep(2)
1903 In [6]: %timeit -n1 time.sleep(2)
1928 1 loops, best of 3: 2 s per loop
1904 1 loops, best of 3: 2 s per loop
1929
1905
1930
1906
1931 The times reported by %timeit will be slightly higher than those
1907 The times reported by %timeit will be slightly higher than those
1932 reported by the timeit.py script when variables are accessed. This is
1908 reported by the timeit.py script when variables are accessed. This is
1933 due to the fact that %timeit executes the statement in the namespace
1909 due to the fact that %timeit executes the statement in the namespace
1934 of the shell, compared with timeit.py, which uses a single setup
1910 of the shell, compared with timeit.py, which uses a single setup
1935 statement to import function or create variables. Generally, the bias
1911 statement to import function or create variables. Generally, the bias
1936 does not matter as long as results from timeit.py are not mixed with
1912 does not matter as long as results from timeit.py are not mixed with
1937 those from %timeit."""
1913 those from %timeit."""
1938
1914
1939 import timeit
1915 import timeit
1940 import math
1916 import math
1941
1917
1942 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1918 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1943 # certain terminals. Until we figure out a robust way of
1919 # certain terminals. Until we figure out a robust way of
1944 # auto-detecting if the terminal can deal with it, use plain 'us' for
1920 # auto-detecting if the terminal can deal with it, use plain 'us' for
1945 # microseconds. I am really NOT happy about disabling the proper
1921 # microseconds. I am really NOT happy about disabling the proper
1946 # 'micro' prefix, but crashing is worse... If anyone knows what the
1922 # 'micro' prefix, but crashing is worse... If anyone knows what the
1947 # right solution for this is, I'm all ears...
1923 # right solution for this is, I'm all ears...
1948 #
1924 #
1949 # Note: using
1925 # Note: using
1950 #
1926 #
1951 # s = u'\xb5'
1927 # s = u'\xb5'
1952 # s.encode(sys.getdefaultencoding())
1928 # s.encode(sys.getdefaultencoding())
1953 #
1929 #
1954 # is not sufficient, as I've seen terminals where that fails but
1930 # is not sufficient, as I've seen terminals where that fails but
1955 # print s
1931 # print s
1956 #
1932 #
1957 # succeeds
1933 # succeeds
1958 #
1934 #
1959 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1935 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1960
1936
1961 #units = [u"s", u"ms",u'\xb5',"ns"]
1937 #units = [u"s", u"ms",u'\xb5',"ns"]
1962 units = [u"s", u"ms",u'us',"ns"]
1938 units = [u"s", u"ms",u'us',"ns"]
1963
1939
1964 scaling = [1, 1e3, 1e6, 1e9]
1940 scaling = [1, 1e3, 1e6, 1e9]
1965
1941
1966 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1942 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1967 posix=False, strict=False)
1943 posix=False, strict=False)
1968 if stmt == "":
1944 if stmt == "":
1969 return
1945 return
1970 timefunc = timeit.default_timer
1946 timefunc = timeit.default_timer
1971 number = int(getattr(opts, "n", 0))
1947 number = int(getattr(opts, "n", 0))
1972 repeat = int(getattr(opts, "r", timeit.default_repeat))
1948 repeat = int(getattr(opts, "r", timeit.default_repeat))
1973 precision = int(getattr(opts, "p", 3))
1949 precision = int(getattr(opts, "p", 3))
1974 if hasattr(opts, "t"):
1950 if hasattr(opts, "t"):
1975 timefunc = time.time
1951 timefunc = time.time
1976 if hasattr(opts, "c"):
1952 if hasattr(opts, "c"):
1977 timefunc = clock
1953 timefunc = clock
1978
1954
1979 timer = timeit.Timer(timer=timefunc)
1955 timer = timeit.Timer(timer=timefunc)
1980 # this code has tight coupling to the inner workings of timeit.Timer,
1956 # this code has tight coupling to the inner workings of timeit.Timer,
1981 # but is there a better way to achieve that the code stmt has access
1957 # but is there a better way to achieve that the code stmt has access
1982 # to the shell namespace?
1958 # to the shell namespace?
1983
1959
1984 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1960 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1985 'setup': "pass"}
1961 'setup': "pass"}
1986 # Track compilation time so it can be reported if too long
1962 # Track compilation time so it can be reported if too long
1987 # Minimum time above which compilation time will be reported
1963 # Minimum time above which compilation time will be reported
1988 tc_min = 0.1
1964 tc_min = 0.1
1989
1965
1990 t0 = clock()
1966 t0 = clock()
1991 code = compile(src, "<magic-timeit>", "exec")
1967 code = compile(src, "<magic-timeit>", "exec")
1992 tc = clock()-t0
1968 tc = clock()-t0
1993
1969
1994 ns = {}
1970 ns = {}
1995 exec code in self.shell.user_ns, ns
1971 exec code in self.shell.user_ns, ns
1996 timer.inner = ns["inner"]
1972 timer.inner = ns["inner"]
1997
1973
1998 if number == 0:
1974 if number == 0:
1999 # determine number so that 0.2 <= total time < 2.0
1975 # determine number so that 0.2 <= total time < 2.0
2000 number = 1
1976 number = 1
2001 for i in range(1, 10):
1977 for i in range(1, 10):
2002 if timer.timeit(number) >= 0.2:
1978 if timer.timeit(number) >= 0.2:
2003 break
1979 break
2004 number *= 10
1980 number *= 10
2005
1981
2006 best = min(timer.repeat(repeat, number)) / number
1982 best = min(timer.repeat(repeat, number)) / number
2007
1983
2008 if best > 0.0 and best < 1000.0:
1984 if best > 0.0 and best < 1000.0:
2009 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1985 order = min(-int(math.floor(math.log10(best)) // 3), 3)
2010 elif best >= 1000.0:
1986 elif best >= 1000.0:
2011 order = 0
1987 order = 0
2012 else:
1988 else:
2013 order = 3
1989 order = 3
2014 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1990 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
2015 precision,
1991 precision,
2016 best * scaling[order],
1992 best * scaling[order],
2017 units[order])
1993 units[order])
2018 if tc > tc_min:
1994 if tc > tc_min:
2019 print "Compiler time: %.2f s" % tc
1995 print "Compiler time: %.2f s" % tc
2020
1996
2021 @skip_doctest
1997 @skip_doctest
2022 @needs_local_scope
1998 @needs_local_scope
2023 def magic_time(self,parameter_s, user_locals):
1999 def magic_time(self,parameter_s, user_locals):
2024 """Time execution of a Python statement or expression.
2000 """Time execution of a Python statement or expression.
2025
2001
2026 The CPU and wall clock times are printed, and the value of the
2002 The CPU and wall clock times are printed, and the value of the
2027 expression (if any) is returned. Note that under Win32, system time
2003 expression (if any) is returned. Note that under Win32, system time
2028 is always reported as 0, since it can not be measured.
2004 is always reported as 0, since it can not be measured.
2029
2005
2030 This function provides very basic timing functionality. In Python
2006 This function provides very basic timing functionality. In Python
2031 2.3, the timeit module offers more control and sophistication, so this
2007 2.3, the timeit module offers more control and sophistication, so this
2032 could be rewritten to use it (patches welcome).
2008 could be rewritten to use it (patches welcome).
2033
2009
2034 Examples
2010 Examples
2035 --------
2011 --------
2036 ::
2012 ::
2037
2013
2038 In [1]: time 2**128
2014 In [1]: time 2**128
2039 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2015 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2040 Wall time: 0.00
2016 Wall time: 0.00
2041 Out[1]: 340282366920938463463374607431768211456L
2017 Out[1]: 340282366920938463463374607431768211456L
2042
2018
2043 In [2]: n = 1000000
2019 In [2]: n = 1000000
2044
2020
2045 In [3]: time sum(range(n))
2021 In [3]: time sum(range(n))
2046 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2022 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2047 Wall time: 1.37
2023 Wall time: 1.37
2048 Out[3]: 499999500000L
2024 Out[3]: 499999500000L
2049
2025
2050 In [4]: time print 'hello world'
2026 In [4]: time print 'hello world'
2051 hello world
2027 hello world
2052 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2028 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2053 Wall time: 0.00
2029 Wall time: 0.00
2054
2030
2055 Note that the time needed by Python to compile the given expression
2031 Note that the time needed by Python to compile the given expression
2056 will be reported if it is more than 0.1s. In this example, the
2032 will be reported if it is more than 0.1s. In this example, the
2057 actual exponentiation is done by Python at compilation time, so while
2033 actual exponentiation is done by Python at compilation time, so while
2058 the expression can take a noticeable amount of time to compute, that
2034 the expression can take a noticeable amount of time to compute, that
2059 time is purely due to the compilation:
2035 time is purely due to the compilation:
2060
2036
2061 In [5]: time 3**9999;
2037 In [5]: time 3**9999;
2062 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2038 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2063 Wall time: 0.00 s
2039 Wall time: 0.00 s
2064
2040
2065 In [6]: time 3**999999;
2041 In [6]: time 3**999999;
2066 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2042 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2067 Wall time: 0.00 s
2043 Wall time: 0.00 s
2068 Compiler : 0.78 s
2044 Compiler : 0.78 s
2069 """
2045 """
2070
2046
2071 # fail immediately if the given expression can't be compiled
2047 # fail immediately if the given expression can't be compiled
2072
2048
2073 expr = self.shell.prefilter(parameter_s,False)
2049 expr = self.shell.prefilter(parameter_s,False)
2074
2050
2075 # Minimum time above which compilation time will be reported
2051 # Minimum time above which compilation time will be reported
2076 tc_min = 0.1
2052 tc_min = 0.1
2077
2053
2078 try:
2054 try:
2079 mode = 'eval'
2055 mode = 'eval'
2080 t0 = clock()
2056 t0 = clock()
2081 code = compile(expr,'<timed eval>',mode)
2057 code = compile(expr,'<timed eval>',mode)
2082 tc = clock()-t0
2058 tc = clock()-t0
2083 except SyntaxError:
2059 except SyntaxError:
2084 mode = 'exec'
2060 mode = 'exec'
2085 t0 = clock()
2061 t0 = clock()
2086 code = compile(expr,'<timed exec>',mode)
2062 code = compile(expr,'<timed exec>',mode)
2087 tc = clock()-t0
2063 tc = clock()-t0
2088 # skew measurement as little as possible
2064 # skew measurement as little as possible
2089 glob = self.shell.user_ns
2065 glob = self.shell.user_ns
2090 wtime = time.time
2066 wtime = time.time
2091 # time execution
2067 # time execution
2092 wall_st = wtime()
2068 wall_st = wtime()
2093 if mode=='eval':
2069 if mode=='eval':
2094 st = clock2()
2070 st = clock2()
2095 out = eval(code, glob, user_locals)
2071 out = eval(code, glob, user_locals)
2096 end = clock2()
2072 end = clock2()
2097 else:
2073 else:
2098 st = clock2()
2074 st = clock2()
2099 exec code in glob, user_locals
2075 exec code in glob, user_locals
2100 end = clock2()
2076 end = clock2()
2101 out = None
2077 out = None
2102 wall_end = wtime()
2078 wall_end = wtime()
2103 # Compute actual times and report
2079 # Compute actual times and report
2104 wall_time = wall_end-wall_st
2080 wall_time = wall_end-wall_st
2105 cpu_user = end[0]-st[0]
2081 cpu_user = end[0]-st[0]
2106 cpu_sys = end[1]-st[1]
2082 cpu_sys = end[1]-st[1]
2107 cpu_tot = cpu_user+cpu_sys
2083 cpu_tot = cpu_user+cpu_sys
2108 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2084 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2109 (cpu_user,cpu_sys,cpu_tot)
2085 (cpu_user,cpu_sys,cpu_tot)
2110 print "Wall time: %.2f s" % wall_time
2086 print "Wall time: %.2f s" % wall_time
2111 if tc > tc_min:
2087 if tc > tc_min:
2112 print "Compiler : %.2f s" % tc
2088 print "Compiler : %.2f s" % tc
2113 return out
2089 return out
2114
2090
2115 @skip_doctest
2091 @skip_doctest
2116 def magic_macro(self,parameter_s = ''):
2092 def magic_macro(self,parameter_s = ''):
2117 """Define a macro for future re-execution. It accepts ranges of history,
2093 """Define a macro for future re-execution. It accepts ranges of history,
2118 filenames or string objects.
2094 filenames or string objects.
2119
2095
2120 Usage:\\
2096 Usage:\\
2121 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2097 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2122
2098
2123 Options:
2099 Options:
2124
2100
2125 -r: use 'raw' input. By default, the 'processed' history is used,
2101 -r: use 'raw' input. By default, the 'processed' history is used,
2126 so that magics are loaded in their transformed version to valid
2102 so that magics are loaded in their transformed version to valid
2127 Python. If this option is given, the raw input as typed as the
2103 Python. If this option is given, the raw input as typed as the
2128 command line is used instead.
2104 command line is used instead.
2129
2105
2130 This will define a global variable called `name` which is a string
2106 This will define a global variable called `name` which is a string
2131 made of joining the slices and lines you specify (n1,n2,... numbers
2107 made of joining the slices and lines you specify (n1,n2,... numbers
2132 above) from your input history into a single string. This variable
2108 above) from your input history into a single string. This variable
2133 acts like an automatic function which re-executes those lines as if
2109 acts like an automatic function which re-executes those lines as if
2134 you had typed them. You just type 'name' at the prompt and the code
2110 you had typed them. You just type 'name' at the prompt and the code
2135 executes.
2111 executes.
2136
2112
2137 The syntax for indicating input ranges is described in %history.
2113 The syntax for indicating input ranges is described in %history.
2138
2114
2139 Note: as a 'hidden' feature, you can also use traditional python slice
2115 Note: as a 'hidden' feature, you can also use traditional python slice
2140 notation, where N:M means numbers N through M-1.
2116 notation, where N:M means numbers N through M-1.
2141
2117
2142 For example, if your history contains (%hist prints it)::
2118 For example, if your history contains (%hist prints it)::
2143
2119
2144 44: x=1
2120 44: x=1
2145 45: y=3
2121 45: y=3
2146 46: z=x+y
2122 46: z=x+y
2147 47: print x
2123 47: print x
2148 48: a=5
2124 48: a=5
2149 49: print 'x',x,'y',y
2125 49: print 'x',x,'y',y
2150
2126
2151 you can create a macro with lines 44 through 47 (included) and line 49
2127 you can create a macro with lines 44 through 47 (included) and line 49
2152 called my_macro with::
2128 called my_macro with::
2153
2129
2154 In [55]: %macro my_macro 44-47 49
2130 In [55]: %macro my_macro 44-47 49
2155
2131
2156 Now, typing `my_macro` (without quotes) will re-execute all this code
2132 Now, typing `my_macro` (without quotes) will re-execute all this code
2157 in one pass.
2133 in one pass.
2158
2134
2159 You don't need to give the line-numbers in order, and any given line
2135 You don't need to give the line-numbers in order, and any given line
2160 number can appear multiple times. You can assemble macros with any
2136 number can appear multiple times. You can assemble macros with any
2161 lines from your input history in any order.
2137 lines from your input history in any order.
2162
2138
2163 The macro is a simple object which holds its value in an attribute,
2139 The macro is a simple object which holds its value in an attribute,
2164 but IPython's display system checks for macros and executes them as
2140 but IPython's display system checks for macros and executes them as
2165 code instead of printing them when you type their name.
2141 code instead of printing them when you type their name.
2166
2142
2167 You can view a macro's contents by explicitly printing it with::
2143 You can view a macro's contents by explicitly printing it with::
2168
2144
2169 print macro_name
2145 print macro_name
2170
2146
2171 """
2147 """
2172 opts,args = self.parse_options(parameter_s,'r',mode='list')
2148 opts,args = self.parse_options(parameter_s,'r',mode='list')
2173 if not args: # List existing macros
2149 if not args: # List existing macros
2174 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2150 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2175 isinstance(v, Macro))
2151 isinstance(v, Macro))
2176 if len(args) == 1:
2152 if len(args) == 1:
2177 raise UsageError(
2153 raise UsageError(
2178 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2154 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2179 name, codefrom = args[0], " ".join(args[1:])
2155 name, codefrom = args[0], " ".join(args[1:])
2180
2156
2181 #print 'rng',ranges # dbg
2157 #print 'rng',ranges # dbg
2182 try:
2158 try:
2183 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2159 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2184 except (ValueError, TypeError) as e:
2160 except (ValueError, TypeError) as e:
2185 print e.args[0]
2161 print e.args[0]
2186 return
2162 return
2187 macro = Macro(lines)
2163 macro = Macro(lines)
2188 self.shell.define_macro(name, macro)
2164 self.shell.define_macro(name, macro)
2189 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2165 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2190 print '=== Macro contents: ==='
2166 print '=== Macro contents: ==='
2191 print macro,
2167 print macro,
2192
2168
2193 def magic_save(self,parameter_s = ''):
2169 def magic_save(self,parameter_s = ''):
2194 """Save a set of lines or a macro to a given filename.
2170 """Save a set of lines or a macro to a given filename.
2195
2171
2196 Usage:\\
2172 Usage:\\
2197 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2173 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2198
2174
2199 Options:
2175 Options:
2200
2176
2201 -r: use 'raw' input. By default, the 'processed' history is used,
2177 -r: use 'raw' input. By default, the 'processed' history is used,
2202 so that magics are loaded in their transformed version to valid
2178 so that magics are loaded in their transformed version to valid
2203 Python. If this option is given, the raw input as typed as the
2179 Python. If this option is given, the raw input as typed as the
2204 command line is used instead.
2180 command line is used instead.
2205
2181
2206 This function uses the same syntax as %history for input ranges,
2182 This function uses the same syntax as %history for input ranges,
2207 then saves the lines to the filename you specify.
2183 then saves the lines to the filename you specify.
2208
2184
2209 It adds a '.py' extension to the file if you don't do so yourself, and
2185 It adds a '.py' extension to the file if you don't do so yourself, and
2210 it asks for confirmation before overwriting existing files."""
2186 it asks for confirmation before overwriting existing files."""
2211
2187
2212 opts,args = self.parse_options(parameter_s,'r',mode='list')
2188 opts,args = self.parse_options(parameter_s,'r',mode='list')
2213 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
2189 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
2214 if not fname.endswith('.py'):
2190 if not fname.endswith('.py'):
2215 fname += '.py'
2191 fname += '.py'
2216 if os.path.isfile(fname):
2192 if os.path.isfile(fname):
2217 overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n')
2193 overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n')
2218 if not overwrite :
2194 if not overwrite :
2219 print 'Operation cancelled.'
2195 print 'Operation cancelled.'
2220 return
2196 return
2221 try:
2197 try:
2222 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2198 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2223 except (TypeError, ValueError) as e:
2199 except (TypeError, ValueError) as e:
2224 print e.args[0]
2200 print e.args[0]
2225 return
2201 return
2226 with io.open(fname,'w', encoding="utf-8") as f:
2202 with io.open(fname,'w', encoding="utf-8") as f:
2227 f.write(u"# coding: utf-8\n")
2203 f.write(u"# coding: utf-8\n")
2228 f.write(py3compat.cast_unicode(cmds))
2204 f.write(py3compat.cast_unicode(cmds))
2229 print 'The following commands were written to file `%s`:' % fname
2205 print 'The following commands were written to file `%s`:' % fname
2230 print cmds
2206 print cmds
2231
2207
2232 def magic_pastebin(self, parameter_s = ''):
2208 def magic_pastebin(self, parameter_s = ''):
2233 """Upload code to Github's Gist paste bin, returning the URL.
2209 """Upload code to Github's Gist paste bin, returning the URL.
2234
2210
2235 Usage:\\
2211 Usage:\\
2236 %pastebin [-d "Custom description"] 1-7
2212 %pastebin [-d "Custom description"] 1-7
2237
2213
2238 The argument can be an input history range, a filename, or the name of a
2214 The argument can be an input history range, a filename, or the name of a
2239 string or macro.
2215 string or macro.
2240
2216
2241 Options:
2217 Options:
2242
2218
2243 -d: Pass a custom description for the gist. The default will say
2219 -d: Pass a custom description for the gist. The default will say
2244 "Pasted from IPython".
2220 "Pasted from IPython".
2245 """
2221 """
2246 opts, args = self.parse_options(parameter_s, 'd:')
2222 opts, args = self.parse_options(parameter_s, 'd:')
2247
2223
2248 try:
2224 try:
2249 code = self.shell.find_user_code(args)
2225 code = self.shell.find_user_code(args)
2250 except (ValueError, TypeError) as e:
2226 except (ValueError, TypeError) as e:
2251 print e.args[0]
2227 print e.args[0]
2252 return
2228 return
2253
2229
2254 post_data = json.dumps({
2230 post_data = json.dumps({
2255 "description": opts.get('d', "Pasted from IPython"),
2231 "description": opts.get('d', "Pasted from IPython"),
2256 "public": True,
2232 "public": True,
2257 "files": {
2233 "files": {
2258 "file1.py": {
2234 "file1.py": {
2259 "content": code
2235 "content": code
2260 }
2236 }
2261 }
2237 }
2262 }).encode('utf-8')
2238 }).encode('utf-8')
2263
2239
2264 response = urlopen("https://api.github.com/gists", post_data)
2240 response = urlopen("https://api.github.com/gists", post_data)
2265 response_data = json.loads(response.read().decode('utf-8'))
2241 response_data = json.loads(response.read().decode('utf-8'))
2266 return response_data['html_url']
2242 return response_data['html_url']
2267
2243
2268 def magic_loadpy(self, arg_s):
2244 def magic_loadpy(self, arg_s):
2269 """Alias of `%load`
2245 """Alias of `%load`
2270
2246
2271 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
2247 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
2272 extension. So it has been renamed simply into %load. You can look at
2248 extension. So it has been renamed simply into %load. You can look at
2273 `%load`'s docstring for more info.
2249 `%load`'s docstring for more info.
2274 """
2250 """
2275 self.magic_load(arg_s)
2251 self.magic_load(arg_s)
2276
2252
2277 def magic_load(self, arg_s):
2253 def magic_load(self, arg_s):
2278 """Load code into the current frontend.
2254 """Load code into the current frontend.
2279
2255
2280 Usage:\\
2256 Usage:\\
2281 %load [options] source
2257 %load [options] source
2282
2258
2283 where source can be a filename, URL, input history range or macro
2259 where source can be a filename, URL, input history range or macro
2284
2260
2285 Options:
2261 Options:
2286 --------
2262 --------
2287 -y : Don't ask confirmation for loading source above 200 000 characters.
2263 -y : Don't ask confirmation for loading source above 200 000 characters.
2288
2264
2289 This magic command can either take a local filename, a URL, an history
2265 This magic command can either take a local filename, a URL, an history
2290 range (see %history) or a macro as argument, it will prompt for
2266 range (see %history) or a macro as argument, it will prompt for
2291 confirmation before loading source with more than 200 000 characters, unless
2267 confirmation before loading source with more than 200 000 characters, unless
2292 -y flag is passed or if the frontend does not support raw_input::
2268 -y flag is passed or if the frontend does not support raw_input::
2293
2269
2294 %load myscript.py
2270 %load myscript.py
2295 %load 7-27
2271 %load 7-27
2296 %load myMacro
2272 %load myMacro
2297 %load http://www.example.com/myscript.py
2273 %load http://www.example.com/myscript.py
2298 """
2274 """
2299 opts,args = self.parse_options(arg_s,'y')
2275 opts,args = self.parse_options(arg_s,'y')
2300
2276
2301 contents = self.shell.find_user_code(args)
2277 contents = self.shell.find_user_code(args)
2302 l = len(contents)
2278 l = len(contents)
2303
2279
2304 # 200 000 is ~ 2500 full 80 caracter lines
2280 # 200 000 is ~ 2500 full 80 caracter lines
2305 # so in average, more than 5000 lines
2281 # so in average, more than 5000 lines
2306 if l > 200000 and 'y' not in opts:
2282 if l > 200000 and 'y' not in opts:
2307 try:
2283 try:
2308 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
2284 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
2309 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
2285 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
2310 except StdinNotImplementedError:
2286 except StdinNotImplementedError:
2311 #asume yes if raw input not implemented
2287 #asume yes if raw input not implemented
2312 ans = True
2288 ans = True
2313
2289
2314 if ans is False :
2290 if ans is False :
2315 print 'Operation cancelled.'
2291 print 'Operation cancelled.'
2316 return
2292 return
2317
2293
2318 self.set_next_input(contents)
2294 self.set_next_input(contents)
2319
2295
2320 def _find_edit_target(self, args, opts, last_call):
2296 def _find_edit_target(self, args, opts, last_call):
2321 """Utility method used by magic_edit to find what to edit."""
2297 """Utility method used by magic_edit to find what to edit."""
2322
2298
2323 def make_filename(arg):
2299 def make_filename(arg):
2324 "Make a filename from the given args"
2300 "Make a filename from the given args"
2325 arg = unquote_filename(arg)
2301 arg = unquote_filename(arg)
2326 try:
2302 try:
2327 filename = get_py_filename(arg)
2303 filename = get_py_filename(arg)
2328 except IOError:
2304 except IOError:
2329 # If it ends with .py but doesn't already exist, assume we want
2305 # If it ends with .py but doesn't already exist, assume we want
2330 # a new file.
2306 # a new file.
2331 if arg.endswith('.py'):
2307 if arg.endswith('.py'):
2332 filename = arg
2308 filename = arg
2333 else:
2309 else:
2334 filename = None
2310 filename = None
2335 return filename
2311 return filename
2336
2312
2337 # Set a few locals from the options for convenience:
2313 # Set a few locals from the options for convenience:
2338 opts_prev = 'p' in opts
2314 opts_prev = 'p' in opts
2339 opts_raw = 'r' in opts
2315 opts_raw = 'r' in opts
2340
2316
2341 # custom exceptions
2317 # custom exceptions
2342 class DataIsObject(Exception): pass
2318 class DataIsObject(Exception): pass
2343
2319
2344 # Default line number value
2320 # Default line number value
2345 lineno = opts.get('n',None)
2321 lineno = opts.get('n',None)
2346
2322
2347 if opts_prev:
2323 if opts_prev:
2348 args = '_%s' % last_call[0]
2324 args = '_%s' % last_call[0]
2349 if not self.shell.user_ns.has_key(args):
2325 if not self.shell.user_ns.has_key(args):
2350 args = last_call[1]
2326 args = last_call[1]
2351
2327
2352 # use last_call to remember the state of the previous call, but don't
2328 # use last_call to remember the state of the previous call, but don't
2353 # let it be clobbered by successive '-p' calls.
2329 # let it be clobbered by successive '-p' calls.
2354 try:
2330 try:
2355 last_call[0] = self.shell.displayhook.prompt_count
2331 last_call[0] = self.shell.displayhook.prompt_count
2356 if not opts_prev:
2332 if not opts_prev:
2357 last_call[1] = args
2333 last_call[1] = args
2358 except:
2334 except:
2359 pass
2335 pass
2360
2336
2361 # by default this is done with temp files, except when the given
2337 # by default this is done with temp files, except when the given
2362 # arg is a filename
2338 # arg is a filename
2363 use_temp = True
2339 use_temp = True
2364
2340
2365 data = ''
2341 data = ''
2366
2342
2367 # First, see if the arguments should be a filename.
2343 # First, see if the arguments should be a filename.
2368 filename = make_filename(args)
2344 filename = make_filename(args)
2369 if filename:
2345 if filename:
2370 use_temp = False
2346 use_temp = False
2371 elif args:
2347 elif args:
2372 # Mode where user specifies ranges of lines, like in %macro.
2348 # Mode where user specifies ranges of lines, like in %macro.
2373 data = self.extract_input_lines(args, opts_raw)
2349 data = self.shell.extract_input_lines(args, opts_raw)
2374 if not data:
2350 if not data:
2375 try:
2351 try:
2376 # Load the parameter given as a variable. If not a string,
2352 # Load the parameter given as a variable. If not a string,
2377 # process it as an object instead (below)
2353 # process it as an object instead (below)
2378
2354
2379 #print '*** args',args,'type',type(args) # dbg
2355 #print '*** args',args,'type',type(args) # dbg
2380 data = eval(args, self.shell.user_ns)
2356 data = eval(args, self.shell.user_ns)
2381 if not isinstance(data, basestring):
2357 if not isinstance(data, basestring):
2382 raise DataIsObject
2358 raise DataIsObject
2383
2359
2384 except (NameError,SyntaxError):
2360 except (NameError,SyntaxError):
2385 # given argument is not a variable, try as a filename
2361 # given argument is not a variable, try as a filename
2386 filename = make_filename(args)
2362 filename = make_filename(args)
2387 if filename is None:
2363 if filename is None:
2388 warn("Argument given (%s) can't be found as a variable "
2364 warn("Argument given (%s) can't be found as a variable "
2389 "or as a filename." % args)
2365 "or as a filename." % args)
2390 return
2366 return
2391 use_temp = False
2367 use_temp = False
2392
2368
2393 except DataIsObject:
2369 except DataIsObject:
2394 # macros have a special edit function
2370 # macros have a special edit function
2395 if isinstance(data, Macro):
2371 if isinstance(data, Macro):
2396 raise MacroToEdit(data)
2372 raise MacroToEdit(data)
2397
2373
2398 # For objects, try to edit the file where they are defined
2374 # For objects, try to edit the file where they are defined
2399 try:
2375 try:
2400 filename = inspect.getabsfile(data)
2376 filename = inspect.getabsfile(data)
2401 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2377 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2402 # class created by %edit? Try to find source
2378 # class created by %edit? Try to find source
2403 # by looking for method definitions instead, the
2379 # by looking for method definitions instead, the
2404 # __module__ in those classes is FakeModule.
2380 # __module__ in those classes is FakeModule.
2405 attrs = [getattr(data, aname) for aname in dir(data)]
2381 attrs = [getattr(data, aname) for aname in dir(data)]
2406 for attr in attrs:
2382 for attr in attrs:
2407 if not inspect.ismethod(attr):
2383 if not inspect.ismethod(attr):
2408 continue
2384 continue
2409 filename = inspect.getabsfile(attr)
2385 filename = inspect.getabsfile(attr)
2410 if filename and 'fakemodule' not in filename.lower():
2386 if filename and 'fakemodule' not in filename.lower():
2411 # change the attribute to be the edit target instead
2387 # change the attribute to be the edit target instead
2412 data = attr
2388 data = attr
2413 break
2389 break
2414
2390
2415 datafile = 1
2391 datafile = 1
2416 except TypeError:
2392 except TypeError:
2417 filename = make_filename(args)
2393 filename = make_filename(args)
2418 datafile = 1
2394 datafile = 1
2419 warn('Could not find file where `%s` is defined.\n'
2395 warn('Could not find file where `%s` is defined.\n'
2420 'Opening a file named `%s`' % (args,filename))
2396 'Opening a file named `%s`' % (args,filename))
2421 # Now, make sure we can actually read the source (if it was in
2397 # Now, make sure we can actually read the source (if it was in
2422 # a temp file it's gone by now).
2398 # a temp file it's gone by now).
2423 if datafile:
2399 if datafile:
2424 try:
2400 try:
2425 if lineno is None:
2401 if lineno is None:
2426 lineno = inspect.getsourcelines(data)[1]
2402 lineno = inspect.getsourcelines(data)[1]
2427 except IOError:
2403 except IOError:
2428 filename = make_filename(args)
2404 filename = make_filename(args)
2429 if filename is None:
2405 if filename is None:
2430 warn('The file `%s` where `%s` was defined cannot '
2406 warn('The file `%s` where `%s` was defined cannot '
2431 'be read.' % (filename,data))
2407 'be read.' % (filename,data))
2432 return
2408 return
2433 use_temp = False
2409 use_temp = False
2434
2410
2435 if use_temp:
2411 if use_temp:
2436 filename = self.shell.mktempfile(data)
2412 filename = self.shell.mktempfile(data)
2437 print 'IPython will make a temporary file named:',filename
2413 print 'IPython will make a temporary file named:',filename
2438
2414
2439 return filename, lineno, use_temp
2415 return filename, lineno, use_temp
2440
2416
2441 def _edit_macro(self,mname,macro):
2417 def _edit_macro(self,mname,macro):
2442 """open an editor with the macro data in a file"""
2418 """open an editor with the macro data in a file"""
2443 filename = self.shell.mktempfile(macro.value)
2419 filename = self.shell.mktempfile(macro.value)
2444 self.shell.hooks.editor(filename)
2420 self.shell.hooks.editor(filename)
2445
2421
2446 # and make a new macro object, to replace the old one
2422 # and make a new macro object, to replace the old one
2447 mfile = open(filename)
2423 mfile = open(filename)
2448 mvalue = mfile.read()
2424 mvalue = mfile.read()
2449 mfile.close()
2425 mfile.close()
2450 self.shell.user_ns[mname] = Macro(mvalue)
2426 self.shell.user_ns[mname] = Macro(mvalue)
2451
2427
2452 def magic_ed(self,parameter_s=''):
2428 def magic_ed(self,parameter_s=''):
2453 """Alias to %edit."""
2429 """Alias to %edit."""
2454 return self.magic_edit(parameter_s)
2430 return self.magic_edit(parameter_s)
2455
2431
2456 @skip_doctest
2432 @skip_doctest
2457 def magic_edit(self,parameter_s='',last_call=['','']):
2433 def magic_edit(self,parameter_s='',last_call=['','']):
2458 """Bring up an editor and execute the resulting code.
2434 """Bring up an editor and execute the resulting code.
2459
2435
2460 Usage:
2436 Usage:
2461 %edit [options] [args]
2437 %edit [options] [args]
2462
2438
2463 %edit runs IPython's editor hook. The default version of this hook is
2439 %edit runs IPython's editor hook. The default version of this hook is
2464 set to call the editor specified by your $EDITOR environment variable.
2440 set to call the editor specified by your $EDITOR environment variable.
2465 If this isn't found, it will default to vi under Linux/Unix and to
2441 If this isn't found, it will default to vi under Linux/Unix and to
2466 notepad under Windows. See the end of this docstring for how to change
2442 notepad under Windows. See the end of this docstring for how to change
2467 the editor hook.
2443 the editor hook.
2468
2444
2469 You can also set the value of this editor via the
2445 You can also set the value of this editor via the
2470 ``TerminalInteractiveShell.editor`` option in your configuration file.
2446 ``TerminalInteractiveShell.editor`` option in your configuration file.
2471 This is useful if you wish to use a different editor from your typical
2447 This is useful if you wish to use a different editor from your typical
2472 default with IPython (and for Windows users who typically don't set
2448 default with IPython (and for Windows users who typically don't set
2473 environment variables).
2449 environment variables).
2474
2450
2475 This command allows you to conveniently edit multi-line code right in
2451 This command allows you to conveniently edit multi-line code right in
2476 your IPython session.
2452 your IPython session.
2477
2453
2478 If called without arguments, %edit opens up an empty editor with a
2454 If called without arguments, %edit opens up an empty editor with a
2479 temporary file and will execute the contents of this file when you
2455 temporary file and will execute the contents of this file when you
2480 close it (don't forget to save it!).
2456 close it (don't forget to save it!).
2481
2457
2482
2458
2483 Options:
2459 Options:
2484
2460
2485 -n <number>: open the editor at a specified line number. By default,
2461 -n <number>: open the editor at a specified line number. By default,
2486 the IPython editor hook uses the unix syntax 'editor +N filename', but
2462 the IPython editor hook uses the unix syntax 'editor +N filename', but
2487 you can configure this by providing your own modified hook if your
2463 you can configure this by providing your own modified hook if your
2488 favorite editor supports line-number specifications with a different
2464 favorite editor supports line-number specifications with a different
2489 syntax.
2465 syntax.
2490
2466
2491 -p: this will call the editor with the same data as the previous time
2467 -p: this will call the editor with the same data as the previous time
2492 it was used, regardless of how long ago (in your current session) it
2468 it was used, regardless of how long ago (in your current session) it
2493 was.
2469 was.
2494
2470
2495 -r: use 'raw' input. This option only applies to input taken from the
2471 -r: use 'raw' input. This option only applies to input taken from the
2496 user's history. By default, the 'processed' history is used, so that
2472 user's history. By default, the 'processed' history is used, so that
2497 magics are loaded in their transformed version to valid Python. If
2473 magics are loaded in their transformed version to valid Python. If
2498 this option is given, the raw input as typed as the command line is
2474 this option is given, the raw input as typed as the command line is
2499 used instead. When you exit the editor, it will be executed by
2475 used instead. When you exit the editor, it will be executed by
2500 IPython's own processor.
2476 IPython's own processor.
2501
2477
2502 -x: do not execute the edited code immediately upon exit. This is
2478 -x: do not execute the edited code immediately upon exit. This is
2503 mainly useful if you are editing programs which need to be called with
2479 mainly useful if you are editing programs which need to be called with
2504 command line arguments, which you can then do using %run.
2480 command line arguments, which you can then do using %run.
2505
2481
2506
2482
2507 Arguments:
2483 Arguments:
2508
2484
2509 If arguments are given, the following possibilities exist:
2485 If arguments are given, the following possibilities exist:
2510
2486
2511 - If the argument is a filename, IPython will load that into the
2487 - If the argument is a filename, IPython will load that into the
2512 editor. It will execute its contents with execfile() when you exit,
2488 editor. It will execute its contents with execfile() when you exit,
2513 loading any code in the file into your interactive namespace.
2489 loading any code in the file into your interactive namespace.
2514
2490
2515 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2491 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2516 The syntax is the same as in the %history magic.
2492 The syntax is the same as in the %history magic.
2517
2493
2518 - If the argument is a string variable, its contents are loaded
2494 - If the argument is a string variable, its contents are loaded
2519 into the editor. You can thus edit any string which contains
2495 into the editor. You can thus edit any string which contains
2520 python code (including the result of previous edits).
2496 python code (including the result of previous edits).
2521
2497
2522 - If the argument is the name of an object (other than a string),
2498 - If the argument is the name of an object (other than a string),
2523 IPython will try to locate the file where it was defined and open the
2499 IPython will try to locate the file where it was defined and open the
2524 editor at the point where it is defined. You can use `%edit function`
2500 editor at the point where it is defined. You can use `%edit function`
2525 to load an editor exactly at the point where 'function' is defined,
2501 to load an editor exactly at the point where 'function' is defined,
2526 edit it and have the file be executed automatically.
2502 edit it and have the file be executed automatically.
2527
2503
2528 - If the object is a macro (see %macro for details), this opens up your
2504 - If the object is a macro (see %macro for details), this opens up your
2529 specified editor with a temporary file containing the macro's data.
2505 specified editor with a temporary file containing the macro's data.
2530 Upon exit, the macro is reloaded with the contents of the file.
2506 Upon exit, the macro is reloaded with the contents of the file.
2531
2507
2532 Note: opening at an exact line is only supported under Unix, and some
2508 Note: opening at an exact line is only supported under Unix, and some
2533 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2509 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2534 '+NUMBER' parameter necessary for this feature. Good editors like
2510 '+NUMBER' parameter necessary for this feature. Good editors like
2535 (X)Emacs, vi, jed, pico and joe all do.
2511 (X)Emacs, vi, jed, pico and joe all do.
2536
2512
2537 After executing your code, %edit will return as output the code you
2513 After executing your code, %edit will return as output the code you
2538 typed in the editor (except when it was an existing file). This way
2514 typed in the editor (except when it was an existing file). This way
2539 you can reload the code in further invocations of %edit as a variable,
2515 you can reload the code in further invocations of %edit as a variable,
2540 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2516 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2541 the output.
2517 the output.
2542
2518
2543 Note that %edit is also available through the alias %ed.
2519 Note that %edit is also available through the alias %ed.
2544
2520
2545 This is an example of creating a simple function inside the editor and
2521 This is an example of creating a simple function inside the editor and
2546 then modifying it. First, start up the editor::
2522 then modifying it. First, start up the editor::
2547
2523
2548 In [1]: ed
2524 In [1]: ed
2549 Editing... done. Executing edited code...
2525 Editing... done. Executing edited code...
2550 Out[1]: 'def foo():\\n print "foo() was defined in an editing
2526 Out[1]: 'def foo():\\n print "foo() was defined in an editing
2551 session"\\n'
2527 session"\\n'
2552
2528
2553 We can then call the function foo()::
2529 We can then call the function foo()::
2554
2530
2555 In [2]: foo()
2531 In [2]: foo()
2556 foo() was defined in an editing session
2532 foo() was defined in an editing session
2557
2533
2558 Now we edit foo. IPython automatically loads the editor with the
2534 Now we edit foo. IPython automatically loads the editor with the
2559 (temporary) file where foo() was previously defined::
2535 (temporary) file where foo() was previously defined::
2560
2536
2561 In [3]: ed foo
2537 In [3]: ed foo
2562 Editing... done. Executing edited code...
2538 Editing... done. Executing edited code...
2563
2539
2564 And if we call foo() again we get the modified version::
2540 And if we call foo() again we get the modified version::
2565
2541
2566 In [4]: foo()
2542 In [4]: foo()
2567 foo() has now been changed!
2543 foo() has now been changed!
2568
2544
2569 Here is an example of how to edit a code snippet successive
2545 Here is an example of how to edit a code snippet successive
2570 times. First we call the editor::
2546 times. First we call the editor::
2571
2547
2572 In [5]: ed
2548 In [5]: ed
2573 Editing... done. Executing edited code...
2549 Editing... done. Executing edited code...
2574 hello
2550 hello
2575 Out[5]: "print 'hello'\\n"
2551 Out[5]: "print 'hello'\\n"
2576
2552
2577 Now we call it again with the previous output (stored in _)::
2553 Now we call it again with the previous output (stored in _)::
2578
2554
2579 In [6]: ed _
2555 In [6]: ed _
2580 Editing... done. Executing edited code...
2556 Editing... done. Executing edited code...
2581 hello world
2557 hello world
2582 Out[6]: "print 'hello world'\\n"
2558 Out[6]: "print 'hello world'\\n"
2583
2559
2584 Now we call it with the output #8 (stored in _8, also as Out[8])::
2560 Now we call it with the output #8 (stored in _8, also as Out[8])::
2585
2561
2586 In [7]: ed _8
2562 In [7]: ed _8
2587 Editing... done. Executing edited code...
2563 Editing... done. Executing edited code...
2588 hello again
2564 hello again
2589 Out[7]: "print 'hello again'\\n"
2565 Out[7]: "print 'hello again'\\n"
2590
2566
2591
2567
2592 Changing the default editor hook:
2568 Changing the default editor hook:
2593
2569
2594 If you wish to write your own editor hook, you can put it in a
2570 If you wish to write your own editor hook, you can put it in a
2595 configuration file which you load at startup time. The default hook
2571 configuration file which you load at startup time. The default hook
2596 is defined in the IPython.core.hooks module, and you can use that as a
2572 is defined in the IPython.core.hooks module, and you can use that as a
2597 starting example for further modifications. That file also has
2573 starting example for further modifications. That file also has
2598 general instructions on how to set a new hook for use once you've
2574 general instructions on how to set a new hook for use once you've
2599 defined it."""
2575 defined it."""
2600 opts,args = self.parse_options(parameter_s,'prxn:')
2576 opts,args = self.parse_options(parameter_s,'prxn:')
2601
2577
2602 try:
2578 try:
2603 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2579 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2604 except MacroToEdit as e:
2580 except MacroToEdit as e:
2605 self._edit_macro(args, e.args[0])
2581 self._edit_macro(args, e.args[0])
2606 return
2582 return
2607
2583
2608 # do actual editing here
2584 # do actual editing here
2609 print 'Editing...',
2585 print 'Editing...',
2610 sys.stdout.flush()
2586 sys.stdout.flush()
2611 try:
2587 try:
2612 # Quote filenames that may have spaces in them
2588 # Quote filenames that may have spaces in them
2613 if ' ' in filename:
2589 if ' ' in filename:
2614 filename = "'%s'" % filename
2590 filename = "'%s'" % filename
2615 self.shell.hooks.editor(filename,lineno)
2591 self.shell.hooks.editor(filename,lineno)
2616 except TryNext:
2592 except TryNext:
2617 warn('Could not open editor')
2593 warn('Could not open editor')
2618 return
2594 return
2619
2595
2620 # XXX TODO: should this be generalized for all string vars?
2596 # XXX TODO: should this be generalized for all string vars?
2621 # For now, this is special-cased to blocks created by cpaste
2597 # For now, this is special-cased to blocks created by cpaste
2622 if args.strip() == 'pasted_block':
2598 if args.strip() == 'pasted_block':
2623 self.shell.user_ns['pasted_block'] = file_read(filename)
2599 self.shell.user_ns['pasted_block'] = file_read(filename)
2624
2600
2625 if 'x' in opts: # -x prevents actual execution
2601 if 'x' in opts: # -x prevents actual execution
2626 print
2602 print
2627 else:
2603 else:
2628 print 'done. Executing edited code...'
2604 print 'done. Executing edited code...'
2629 if 'r' in opts: # Untranslated IPython code
2605 if 'r' in opts: # Untranslated IPython code
2630 self.shell.run_cell(file_read(filename),
2606 self.shell.run_cell(file_read(filename),
2631 store_history=False)
2607 store_history=False)
2632 else:
2608 else:
2633 self.shell.safe_execfile(filename, self.shell.user_ns,
2609 self.shell.safe_execfile(filename, self.shell.user_ns,
2634 self.shell.user_ns)
2610 self.shell.user_ns)
2635
2611
2636 if is_temp:
2612 if is_temp:
2637 try:
2613 try:
2638 return open(filename).read()
2614 return open(filename).read()
2639 except IOError,msg:
2615 except IOError,msg:
2640 if msg.filename == filename:
2616 if msg.filename == filename:
2641 warn('File not found. Did you forget to save?')
2617 warn('File not found. Did you forget to save?')
2642 return
2618 return
2643 else:
2619 else:
2644 self.shell.showtraceback()
2620 self.shell.showtraceback()
2645
2621
2646 def magic_xmode(self,parameter_s = ''):
2622 def magic_xmode(self,parameter_s = ''):
2647 """Switch modes for the exception handlers.
2623 """Switch modes for the exception handlers.
2648
2624
2649 Valid modes: Plain, Context and Verbose.
2625 Valid modes: Plain, Context and Verbose.
2650
2626
2651 If called without arguments, acts as a toggle."""
2627 If called without arguments, acts as a toggle."""
2652
2628
2653 def xmode_switch_err(name):
2629 def xmode_switch_err(name):
2654 warn('Error changing %s exception modes.\n%s' %
2630 warn('Error changing %s exception modes.\n%s' %
2655 (name,sys.exc_info()[1]))
2631 (name,sys.exc_info()[1]))
2656
2632
2657 shell = self.shell
2633 shell = self.shell
2658 new_mode = parameter_s.strip().capitalize()
2634 new_mode = parameter_s.strip().capitalize()
2659 try:
2635 try:
2660 shell.InteractiveTB.set_mode(mode=new_mode)
2636 shell.InteractiveTB.set_mode(mode=new_mode)
2661 print 'Exception reporting mode:',shell.InteractiveTB.mode
2637 print 'Exception reporting mode:',shell.InteractiveTB.mode
2662 except:
2638 except:
2663 xmode_switch_err('user')
2639 xmode_switch_err('user')
2664
2640
2665 def magic_colors(self,parameter_s = ''):
2641 def magic_colors(self,parameter_s = ''):
2666 """Switch color scheme for prompts, info system and exception handlers.
2642 """Switch color scheme for prompts, info system and exception handlers.
2667
2643
2668 Currently implemented schemes: NoColor, Linux, LightBG.
2644 Currently implemented schemes: NoColor, Linux, LightBG.
2669
2645
2670 Color scheme names are not case-sensitive.
2646 Color scheme names are not case-sensitive.
2671
2647
2672 Examples
2648 Examples
2673 --------
2649 --------
2674 To get a plain black and white terminal::
2650 To get a plain black and white terminal::
2675
2651
2676 %colors nocolor
2652 %colors nocolor
2677 """
2653 """
2678
2654
2679 def color_switch_err(name):
2655 def color_switch_err(name):
2680 warn('Error changing %s color schemes.\n%s' %
2656 warn('Error changing %s color schemes.\n%s' %
2681 (name,sys.exc_info()[1]))
2657 (name,sys.exc_info()[1]))
2682
2658
2683
2659
2684 new_scheme = parameter_s.strip()
2660 new_scheme = parameter_s.strip()
2685 if not new_scheme:
2661 if not new_scheme:
2686 raise UsageError(
2662 raise UsageError(
2687 "%colors: you must specify a color scheme. See '%colors?'")
2663 "%colors: you must specify a color scheme. See '%colors?'")
2688 return
2664 return
2689 # local shortcut
2665 # local shortcut
2690 shell = self.shell
2666 shell = self.shell
2691
2667
2692 import IPython.utils.rlineimpl as readline
2668 import IPython.utils.rlineimpl as readline
2693
2669
2694 if not shell.colors_force and \
2670 if not shell.colors_force and \
2695 not readline.have_readline and sys.platform == "win32":
2671 not readline.have_readline and sys.platform == "win32":
2696 msg = """\
2672 msg = """\
2697 Proper color support under MS Windows requires the pyreadline library.
2673 Proper color support under MS Windows requires the pyreadline library.
2698 You can find it at:
2674 You can find it at:
2699 http://ipython.org/pyreadline.html
2675 http://ipython.org/pyreadline.html
2700 Gary's readline needs the ctypes module, from:
2676 Gary's readline needs the ctypes module, from:
2701 http://starship.python.net/crew/theller/ctypes
2677 http://starship.python.net/crew/theller/ctypes
2702 (Note that ctypes is already part of Python versions 2.5 and newer).
2678 (Note that ctypes is already part of Python versions 2.5 and newer).
2703
2679
2704 Defaulting color scheme to 'NoColor'"""
2680 Defaulting color scheme to 'NoColor'"""
2705 new_scheme = 'NoColor'
2681 new_scheme = 'NoColor'
2706 warn(msg)
2682 warn(msg)
2707
2683
2708 # readline option is 0
2684 # readline option is 0
2709 if not shell.colors_force and not shell.has_readline:
2685 if not shell.colors_force and not shell.has_readline:
2710 new_scheme = 'NoColor'
2686 new_scheme = 'NoColor'
2711
2687
2712 # Set prompt colors
2688 # Set prompt colors
2713 try:
2689 try:
2714 shell.prompt_manager.color_scheme = new_scheme
2690 shell.prompt_manager.color_scheme = new_scheme
2715 except:
2691 except:
2716 color_switch_err('prompt')
2692 color_switch_err('prompt')
2717 else:
2693 else:
2718 shell.colors = \
2694 shell.colors = \
2719 shell.prompt_manager.color_scheme_table.active_scheme_name
2695 shell.prompt_manager.color_scheme_table.active_scheme_name
2720 # Set exception colors
2696 # Set exception colors
2721 try:
2697 try:
2722 shell.InteractiveTB.set_colors(scheme = new_scheme)
2698 shell.InteractiveTB.set_colors(scheme = new_scheme)
2723 shell.SyntaxTB.set_colors(scheme = new_scheme)
2699 shell.SyntaxTB.set_colors(scheme = new_scheme)
2724 except:
2700 except:
2725 color_switch_err('exception')
2701 color_switch_err('exception')
2726
2702
2727 # Set info (for 'object?') colors
2703 # Set info (for 'object?') colors
2728 if shell.color_info:
2704 if shell.color_info:
2729 try:
2705 try:
2730 shell.inspector.set_active_scheme(new_scheme)
2706 shell.inspector.set_active_scheme(new_scheme)
2731 except:
2707 except:
2732 color_switch_err('object inspector')
2708 color_switch_err('object inspector')
2733 else:
2709 else:
2734 shell.inspector.set_active_scheme('NoColor')
2710 shell.inspector.set_active_scheme('NoColor')
2735
2711
2736 def magic_pprint(self, parameter_s=''):
2712 def magic_pprint(self, parameter_s=''):
2737 """Toggle pretty printing on/off."""
2713 """Toggle pretty printing on/off."""
2738 ptformatter = self.shell.display_formatter.formatters['text/plain']
2714 ptformatter = self.shell.display_formatter.formatters['text/plain']
2739 ptformatter.pprint = bool(1 - ptformatter.pprint)
2715 ptformatter.pprint = bool(1 - ptformatter.pprint)
2740 print 'Pretty printing has been turned', \
2716 print 'Pretty printing has been turned', \
2741 ['OFF','ON'][ptformatter.pprint]
2717 ['OFF','ON'][ptformatter.pprint]
2742
2718
2743 #......................................................................
2719 #......................................................................
2744 # Functions to implement unix shell-type things
2720 # Functions to implement unix shell-type things
2745
2721
2746 @skip_doctest
2722 @skip_doctest
2747 def magic_alias(self, parameter_s = ''):
2723 def magic_alias(self, parameter_s = ''):
2748 """Define an alias for a system command.
2724 """Define an alias for a system command.
2749
2725
2750 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2726 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2751
2727
2752 Then, typing 'alias_name params' will execute the system command 'cmd
2728 Then, typing 'alias_name params' will execute the system command 'cmd
2753 params' (from your underlying operating system).
2729 params' (from your underlying operating system).
2754
2730
2755 Aliases have lower precedence than magic functions and Python normal
2731 Aliases have lower precedence than magic functions and Python normal
2756 variables, so if 'foo' is both a Python variable and an alias, the
2732 variables, so if 'foo' is both a Python variable and an alias, the
2757 alias can not be executed until 'del foo' removes the Python variable.
2733 alias can not be executed until 'del foo' removes the Python variable.
2758
2734
2759 You can use the %l specifier in an alias definition to represent the
2735 You can use the %l specifier in an alias definition to represent the
2760 whole line when the alias is called. For example::
2736 whole line when the alias is called. For example::
2761
2737
2762 In [2]: alias bracket echo "Input in brackets: <%l>"
2738 In [2]: alias bracket echo "Input in brackets: <%l>"
2763 In [3]: bracket hello world
2739 In [3]: bracket hello world
2764 Input in brackets: <hello world>
2740 Input in brackets: <hello world>
2765
2741
2766 You can also define aliases with parameters using %s specifiers (one
2742 You can also define aliases with parameters using %s specifiers (one
2767 per parameter)::
2743 per parameter)::
2768
2744
2769 In [1]: alias parts echo first %s second %s
2745 In [1]: alias parts echo first %s second %s
2770 In [2]: %parts A B
2746 In [2]: %parts A B
2771 first A second B
2747 first A second B
2772 In [3]: %parts A
2748 In [3]: %parts A
2773 Incorrect number of arguments: 2 expected.
2749 Incorrect number of arguments: 2 expected.
2774 parts is an alias to: 'echo first %s second %s'
2750 parts is an alias to: 'echo first %s second %s'
2775
2751
2776 Note that %l and %s are mutually exclusive. You can only use one or
2752 Note that %l and %s are mutually exclusive. You can only use one or
2777 the other in your aliases.
2753 the other in your aliases.
2778
2754
2779 Aliases expand Python variables just like system calls using ! or !!
2755 Aliases expand Python variables just like system calls using ! or !!
2780 do: all expressions prefixed with '$' get expanded. For details of
2756 do: all expressions prefixed with '$' get expanded. For details of
2781 the semantic rules, see PEP-215:
2757 the semantic rules, see PEP-215:
2782 http://www.python.org/peps/pep-0215.html. This is the library used by
2758 http://www.python.org/peps/pep-0215.html. This is the library used by
2783 IPython for variable expansion. If you want to access a true shell
2759 IPython for variable expansion. If you want to access a true shell
2784 variable, an extra $ is necessary to prevent its expansion by
2760 variable, an extra $ is necessary to prevent its expansion by
2785 IPython::
2761 IPython::
2786
2762
2787 In [6]: alias show echo
2763 In [6]: alias show echo
2788 In [7]: PATH='A Python string'
2764 In [7]: PATH='A Python string'
2789 In [8]: show $PATH
2765 In [8]: show $PATH
2790 A Python string
2766 A Python string
2791 In [9]: show $$PATH
2767 In [9]: show $$PATH
2792 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2768 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2793
2769
2794 You can use the alias facility to acess all of $PATH. See the %rehash
2770 You can use the alias facility to acess all of $PATH. See the %rehash
2795 and %rehashx functions, which automatically create aliases for the
2771 and %rehashx functions, which automatically create aliases for the
2796 contents of your $PATH.
2772 contents of your $PATH.
2797
2773
2798 If called with no parameters, %alias prints the current alias table."""
2774 If called with no parameters, %alias prints the current alias table."""
2799
2775
2800 par = parameter_s.strip()
2776 par = parameter_s.strip()
2801 if not par:
2777 if not par:
2802 stored = self.shell.db.get('stored_aliases', {} )
2778 stored = self.shell.db.get('stored_aliases', {} )
2803 aliases = sorted(self.shell.alias_manager.aliases)
2779 aliases = sorted(self.shell.alias_manager.aliases)
2804 # for k, v in stored:
2780 # for k, v in stored:
2805 # atab.append(k, v[0])
2781 # atab.append(k, v[0])
2806
2782
2807 print "Total number of aliases:", len(aliases)
2783 print "Total number of aliases:", len(aliases)
2808 sys.stdout.flush()
2784 sys.stdout.flush()
2809 return aliases
2785 return aliases
2810
2786
2811 # Now try to define a new one
2787 # Now try to define a new one
2812 try:
2788 try:
2813 alias,cmd = par.split(None, 1)
2789 alias,cmd = par.split(None, 1)
2814 except:
2790 except:
2815 print oinspect.getdoc(self.magic_alias)
2791 print oinspect.getdoc(self.magic_alias)
2816 else:
2792 else:
2817 self.shell.alias_manager.soft_define_alias(alias, cmd)
2793 self.shell.alias_manager.soft_define_alias(alias, cmd)
2818 # end magic_alias
2794 # end magic_alias
2819
2795
2820 def magic_unalias(self, parameter_s = ''):
2796 def magic_unalias(self, parameter_s = ''):
2821 """Remove an alias"""
2797 """Remove an alias"""
2822
2798
2823 aname = parameter_s.strip()
2799 aname = parameter_s.strip()
2824 self.shell.alias_manager.undefine_alias(aname)
2800 self.shell.alias_manager.undefine_alias(aname)
2825 stored = self.shell.db.get('stored_aliases', {} )
2801 stored = self.shell.db.get('stored_aliases', {} )
2826 if aname in stored:
2802 if aname in stored:
2827 print "Removing %stored alias",aname
2803 print "Removing %stored alias",aname
2828 del stored[aname]
2804 del stored[aname]
2829 self.shell.db['stored_aliases'] = stored
2805 self.shell.db['stored_aliases'] = stored
2830
2806
2831 def magic_rehashx(self, parameter_s = ''):
2807 def magic_rehashx(self, parameter_s = ''):
2832 """Update the alias table with all executable files in $PATH.
2808 """Update the alias table with all executable files in $PATH.
2833
2809
2834 This version explicitly checks that every entry in $PATH is a file
2810 This version explicitly checks that every entry in $PATH is a file
2835 with execute access (os.X_OK), so it is much slower than %rehash.
2811 with execute access (os.X_OK), so it is much slower than %rehash.
2836
2812
2837 Under Windows, it checks executability as a match against a
2813 Under Windows, it checks executability as a match against a
2838 '|'-separated string of extensions, stored in the IPython config
2814 '|'-separated string of extensions, stored in the IPython config
2839 variable win_exec_ext. This defaults to 'exe|com|bat'.
2815 variable win_exec_ext. This defaults to 'exe|com|bat'.
2840
2816
2841 This function also resets the root module cache of module completer,
2817 This function also resets the root module cache of module completer,
2842 used on slow filesystems.
2818 used on slow filesystems.
2843 """
2819 """
2844 from IPython.core.alias import InvalidAliasError
2820 from IPython.core.alias import InvalidAliasError
2845
2821
2846 # for the benefit of module completer in ipy_completers.py
2822 # for the benefit of module completer in ipy_completers.py
2847 del self.shell.db['rootmodules']
2823 del self.shell.db['rootmodules']
2848
2824
2849 path = [os.path.abspath(os.path.expanduser(p)) for p in
2825 path = [os.path.abspath(os.path.expanduser(p)) for p in
2850 os.environ.get('PATH','').split(os.pathsep)]
2826 os.environ.get('PATH','').split(os.pathsep)]
2851 path = filter(os.path.isdir,path)
2827 path = filter(os.path.isdir,path)
2852
2828
2853 syscmdlist = []
2829 syscmdlist = []
2854 # Now define isexec in a cross platform manner.
2830 # Now define isexec in a cross platform manner.
2855 if os.name == 'posix':
2831 if os.name == 'posix':
2856 isexec = lambda fname:os.path.isfile(fname) and \
2832 isexec = lambda fname:os.path.isfile(fname) and \
2857 os.access(fname,os.X_OK)
2833 os.access(fname,os.X_OK)
2858 else:
2834 else:
2859 try:
2835 try:
2860 winext = os.environ['pathext'].replace(';','|').replace('.','')
2836 winext = os.environ['pathext'].replace(';','|').replace('.','')
2861 except KeyError:
2837 except KeyError:
2862 winext = 'exe|com|bat|py'
2838 winext = 'exe|com|bat|py'
2863 if 'py' not in winext:
2839 if 'py' not in winext:
2864 winext += '|py'
2840 winext += '|py'
2865 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2841 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2866 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2842 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2867 savedir = os.getcwdu()
2843 savedir = os.getcwdu()
2868
2844
2869 # Now walk the paths looking for executables to alias.
2845 # Now walk the paths looking for executables to alias.
2870 try:
2846 try:
2871 # write the whole loop for posix/Windows so we don't have an if in
2847 # write the whole loop for posix/Windows so we don't have an if in
2872 # the innermost part
2848 # the innermost part
2873 if os.name == 'posix':
2849 if os.name == 'posix':
2874 for pdir in path:
2850 for pdir in path:
2875 os.chdir(pdir)
2851 os.chdir(pdir)
2876 for ff in os.listdir(pdir):
2852 for ff in os.listdir(pdir):
2877 if isexec(ff):
2853 if isexec(ff):
2878 try:
2854 try:
2879 # Removes dots from the name since ipython
2855 # Removes dots from the name since ipython
2880 # will assume names with dots to be python.
2856 # will assume names with dots to be python.
2881 self.shell.alias_manager.define_alias(
2857 self.shell.alias_manager.define_alias(
2882 ff.replace('.',''), ff)
2858 ff.replace('.',''), ff)
2883 except InvalidAliasError:
2859 except InvalidAliasError:
2884 pass
2860 pass
2885 else:
2861 else:
2886 syscmdlist.append(ff)
2862 syscmdlist.append(ff)
2887 else:
2863 else:
2888 no_alias = self.shell.alias_manager.no_alias
2864 no_alias = self.shell.alias_manager.no_alias
2889 for pdir in path:
2865 for pdir in path:
2890 os.chdir(pdir)
2866 os.chdir(pdir)
2891 for ff in os.listdir(pdir):
2867 for ff in os.listdir(pdir):
2892 base, ext = os.path.splitext(ff)
2868 base, ext = os.path.splitext(ff)
2893 if isexec(ff) and base.lower() not in no_alias:
2869 if isexec(ff) and base.lower() not in no_alias:
2894 if ext.lower() == '.exe':
2870 if ext.lower() == '.exe':
2895 ff = base
2871 ff = base
2896 try:
2872 try:
2897 # Removes dots from the name since ipython
2873 # Removes dots from the name since ipython
2898 # will assume names with dots to be python.
2874 # will assume names with dots to be python.
2899 self.shell.alias_manager.define_alias(
2875 self.shell.alias_manager.define_alias(
2900 base.lower().replace('.',''), ff)
2876 base.lower().replace('.',''), ff)
2901 except InvalidAliasError:
2877 except InvalidAliasError:
2902 pass
2878 pass
2903 syscmdlist.append(ff)
2879 syscmdlist.append(ff)
2904 self.shell.db['syscmdlist'] = syscmdlist
2880 self.shell.db['syscmdlist'] = syscmdlist
2905 finally:
2881 finally:
2906 os.chdir(savedir)
2882 os.chdir(savedir)
2907
2883
2908 @skip_doctest
2884 @skip_doctest
2909 def magic_pwd(self, parameter_s = ''):
2885 def magic_pwd(self, parameter_s = ''):
2910 """Return the current working directory path.
2886 """Return the current working directory path.
2911
2887
2912 Examples
2888 Examples
2913 --------
2889 --------
2914 ::
2890 ::
2915
2891
2916 In [9]: pwd
2892 In [9]: pwd
2917 Out[9]: '/home/tsuser/sprint/ipython'
2893 Out[9]: '/home/tsuser/sprint/ipython'
2918 """
2894 """
2919 return os.getcwdu()
2895 return os.getcwdu()
2920
2896
2921 @skip_doctest
2897 @skip_doctest
2922 def magic_cd(self, parameter_s=''):
2898 def magic_cd(self, parameter_s=''):
2923 """Change the current working directory.
2899 """Change the current working directory.
2924
2900
2925 This command automatically maintains an internal list of directories
2901 This command automatically maintains an internal list of directories
2926 you visit during your IPython session, in the variable _dh. The
2902 you visit during your IPython session, in the variable _dh. The
2927 command %dhist shows this history nicely formatted. You can also
2903 command %dhist shows this history nicely formatted. You can also
2928 do 'cd -<tab>' to see directory history conveniently.
2904 do 'cd -<tab>' to see directory history conveniently.
2929
2905
2930 Usage:
2906 Usage:
2931
2907
2932 cd 'dir': changes to directory 'dir'.
2908 cd 'dir': changes to directory 'dir'.
2933
2909
2934 cd -: changes to the last visited directory.
2910 cd -: changes to the last visited directory.
2935
2911
2936 cd -<n>: changes to the n-th directory in the directory history.
2912 cd -<n>: changes to the n-th directory in the directory history.
2937
2913
2938 cd --foo: change to directory that matches 'foo' in history
2914 cd --foo: change to directory that matches 'foo' in history
2939
2915
2940 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2916 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2941 (note: cd <bookmark_name> is enough if there is no
2917 (note: cd <bookmark_name> is enough if there is no
2942 directory <bookmark_name>, but a bookmark with the name exists.)
2918 directory <bookmark_name>, but a bookmark with the name exists.)
2943 'cd -b <tab>' allows you to tab-complete bookmark names.
2919 'cd -b <tab>' allows you to tab-complete bookmark names.
2944
2920
2945 Options:
2921 Options:
2946
2922
2947 -q: quiet. Do not print the working directory after the cd command is
2923 -q: quiet. Do not print the working directory after the cd command is
2948 executed. By default IPython's cd command does print this directory,
2924 executed. By default IPython's cd command does print this directory,
2949 since the default prompts do not display path information.
2925 since the default prompts do not display path information.
2950
2926
2951 Note that !cd doesn't work for this purpose because the shell where
2927 Note that !cd doesn't work for this purpose because the shell where
2952 !command runs is immediately discarded after executing 'command'.
2928 !command runs is immediately discarded after executing 'command'.
2953
2929
2954 Examples
2930 Examples
2955 --------
2931 --------
2956 ::
2932 ::
2957
2933
2958 In [10]: cd parent/child
2934 In [10]: cd parent/child
2959 /home/tsuser/parent/child
2935 /home/tsuser/parent/child
2960 """
2936 """
2961
2937
2962 parameter_s = parameter_s.strip()
2938 parameter_s = parameter_s.strip()
2963 #bkms = self.shell.persist.get("bookmarks",{})
2939 #bkms = self.shell.persist.get("bookmarks",{})
2964
2940
2965 oldcwd = os.getcwdu()
2941 oldcwd = os.getcwdu()
2966 numcd = re.match(r'(-)(\d+)$',parameter_s)
2942 numcd = re.match(r'(-)(\d+)$',parameter_s)
2967 # jump in directory history by number
2943 # jump in directory history by number
2968 if numcd:
2944 if numcd:
2969 nn = int(numcd.group(2))
2945 nn = int(numcd.group(2))
2970 try:
2946 try:
2971 ps = self.shell.user_ns['_dh'][nn]
2947 ps = self.shell.user_ns['_dh'][nn]
2972 except IndexError:
2948 except IndexError:
2973 print 'The requested directory does not exist in history.'
2949 print 'The requested directory does not exist in history.'
2974 return
2950 return
2975 else:
2951 else:
2976 opts = {}
2952 opts = {}
2977 elif parameter_s.startswith('--'):
2953 elif parameter_s.startswith('--'):
2978 ps = None
2954 ps = None
2979 fallback = None
2955 fallback = None
2980 pat = parameter_s[2:]
2956 pat = parameter_s[2:]
2981 dh = self.shell.user_ns['_dh']
2957 dh = self.shell.user_ns['_dh']
2982 # first search only by basename (last component)
2958 # first search only by basename (last component)
2983 for ent in reversed(dh):
2959 for ent in reversed(dh):
2984 if pat in os.path.basename(ent) and os.path.isdir(ent):
2960 if pat in os.path.basename(ent) and os.path.isdir(ent):
2985 ps = ent
2961 ps = ent
2986 break
2962 break
2987
2963
2988 if fallback is None and pat in ent and os.path.isdir(ent):
2964 if fallback is None and pat in ent and os.path.isdir(ent):
2989 fallback = ent
2965 fallback = ent
2990
2966
2991 # if we have no last part match, pick the first full path match
2967 # if we have no last part match, pick the first full path match
2992 if ps is None:
2968 if ps is None:
2993 ps = fallback
2969 ps = fallback
2994
2970
2995 if ps is None:
2971 if ps is None:
2996 print "No matching entry in directory history"
2972 print "No matching entry in directory history"
2997 return
2973 return
2998 else:
2974 else:
2999 opts = {}
2975 opts = {}
3000
2976
3001
2977
3002 else:
2978 else:
3003 #turn all non-space-escaping backslashes to slashes,
2979 #turn all non-space-escaping backslashes to slashes,
3004 # for c:\windows\directory\names\
2980 # for c:\windows\directory\names\
3005 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2981 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
3006 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2982 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
3007 # jump to previous
2983 # jump to previous
3008 if ps == '-':
2984 if ps == '-':
3009 try:
2985 try:
3010 ps = self.shell.user_ns['_dh'][-2]
2986 ps = self.shell.user_ns['_dh'][-2]
3011 except IndexError:
2987 except IndexError:
3012 raise UsageError('%cd -: No previous directory to change to.')
2988 raise UsageError('%cd -: No previous directory to change to.')
3013 # jump to bookmark if needed
2989 # jump to bookmark if needed
3014 else:
2990 else:
3015 if not os.path.isdir(ps) or opts.has_key('b'):
2991 if not os.path.isdir(ps) or opts.has_key('b'):
3016 bkms = self.shell.db.get('bookmarks', {})
2992 bkms = self.shell.db.get('bookmarks', {})
3017
2993
3018 if bkms.has_key(ps):
2994 if bkms.has_key(ps):
3019 target = bkms[ps]
2995 target = bkms[ps]
3020 print '(bookmark:%s) -> %s' % (ps,target)
2996 print '(bookmark:%s) -> %s' % (ps,target)
3021 ps = target
2997 ps = target
3022 else:
2998 else:
3023 if opts.has_key('b'):
2999 if opts.has_key('b'):
3024 raise UsageError("Bookmark '%s' not found. "
3000 raise UsageError("Bookmark '%s' not found. "
3025 "Use '%%bookmark -l' to see your bookmarks." % ps)
3001 "Use '%%bookmark -l' to see your bookmarks." % ps)
3026
3002
3027 # strip extra quotes on Windows, because os.chdir doesn't like them
3003 # strip extra quotes on Windows, because os.chdir doesn't like them
3028 ps = unquote_filename(ps)
3004 ps = unquote_filename(ps)
3029 # at this point ps should point to the target dir
3005 # at this point ps should point to the target dir
3030 if ps:
3006 if ps:
3031 try:
3007 try:
3032 os.chdir(os.path.expanduser(ps))
3008 os.chdir(os.path.expanduser(ps))
3033 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3009 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3034 set_term_title('IPython: ' + abbrev_cwd())
3010 set_term_title('IPython: ' + abbrev_cwd())
3035 except OSError:
3011 except OSError:
3036 print sys.exc_info()[1]
3012 print sys.exc_info()[1]
3037 else:
3013 else:
3038 cwd = os.getcwdu()
3014 cwd = os.getcwdu()
3039 dhist = self.shell.user_ns['_dh']
3015 dhist = self.shell.user_ns['_dh']
3040 if oldcwd != cwd:
3016 if oldcwd != cwd:
3041 dhist.append(cwd)
3017 dhist.append(cwd)
3042 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3018 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3043
3019
3044 else:
3020 else:
3045 os.chdir(self.shell.home_dir)
3021 os.chdir(self.shell.home_dir)
3046 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3022 if hasattr(self.shell, 'term_title') and self.shell.term_title:
3047 set_term_title('IPython: ' + '~')
3023 set_term_title('IPython: ' + '~')
3048 cwd = os.getcwdu()
3024 cwd = os.getcwdu()
3049 dhist = self.shell.user_ns['_dh']
3025 dhist = self.shell.user_ns['_dh']
3050
3026
3051 if oldcwd != cwd:
3027 if oldcwd != cwd:
3052 dhist.append(cwd)
3028 dhist.append(cwd)
3053 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3029 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
3054 if not 'q' in opts and self.shell.user_ns['_dh']:
3030 if not 'q' in opts and self.shell.user_ns['_dh']:
3055 print self.shell.user_ns['_dh'][-1]
3031 print self.shell.user_ns['_dh'][-1]
3056
3032
3057
3033
3058 def magic_env(self, parameter_s=''):
3034 def magic_env(self, parameter_s=''):
3059 """List environment variables."""
3035 """List environment variables."""
3060
3036
3061 return dict(os.environ)
3037 return dict(os.environ)
3062
3038
3063 def magic_pushd(self, parameter_s=''):
3039 def magic_pushd(self, parameter_s=''):
3064 """Place the current dir on stack and change directory.
3040 """Place the current dir on stack and change directory.
3065
3041
3066 Usage:\\
3042 Usage:\\
3067 %pushd ['dirname']
3043 %pushd ['dirname']
3068 """
3044 """
3069
3045
3070 dir_s = self.shell.dir_stack
3046 dir_s = self.shell.dir_stack
3071 tgt = os.path.expanduser(unquote_filename(parameter_s))
3047 tgt = os.path.expanduser(unquote_filename(parameter_s))
3072 cwd = os.getcwdu().replace(self.home_dir,'~')
3048 cwd = os.getcwdu().replace(self.home_dir,'~')
3073 if tgt:
3049 if tgt:
3074 self.magic_cd(parameter_s)
3050 self.magic_cd(parameter_s)
3075 dir_s.insert(0,cwd)
3051 dir_s.insert(0,cwd)
3076 return self.magic_dirs()
3052 return self.magic_dirs()
3077
3053
3078 def magic_popd(self, parameter_s=''):
3054 def magic_popd(self, parameter_s=''):
3079 """Change to directory popped off the top of the stack.
3055 """Change to directory popped off the top of the stack.
3080 """
3056 """
3081 if not self.shell.dir_stack:
3057 if not self.shell.dir_stack:
3082 raise UsageError("%popd on empty stack")
3058 raise UsageError("%popd on empty stack")
3083 top = self.shell.dir_stack.pop(0)
3059 top = self.shell.dir_stack.pop(0)
3084 self.magic_cd(top)
3060 self.magic_cd(top)
3085 print "popd ->",top
3061 print "popd ->",top
3086
3062
3087 def magic_dirs(self, parameter_s=''):
3063 def magic_dirs(self, parameter_s=''):
3088 """Return the current directory stack."""
3064 """Return the current directory stack."""
3089
3065
3090 return self.shell.dir_stack
3066 return self.shell.dir_stack
3091
3067
3092 def magic_dhist(self, parameter_s=''):
3068 def magic_dhist(self, parameter_s=''):
3093 """Print your history of visited directories.
3069 """Print your history of visited directories.
3094
3070
3095 %dhist -> print full history\\
3071 %dhist -> print full history\\
3096 %dhist n -> print last n entries only\\
3072 %dhist n -> print last n entries only\\
3097 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
3073 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
3098
3074
3099 This history is automatically maintained by the %cd command, and
3075 This history is automatically maintained by the %cd command, and
3100 always available as the global list variable _dh. You can use %cd -<n>
3076 always available as the global list variable _dh. You can use %cd -<n>
3101 to go to directory number <n>.
3077 to go to directory number <n>.
3102
3078
3103 Note that most of time, you should view directory history by entering
3079 Note that most of time, you should view directory history by entering
3104 cd -<TAB>.
3080 cd -<TAB>.
3105
3081
3106 """
3082 """
3107
3083
3108 dh = self.shell.user_ns['_dh']
3084 dh = self.shell.user_ns['_dh']
3109 if parameter_s:
3085 if parameter_s:
3110 try:
3086 try:
3111 args = map(int,parameter_s.split())
3087 args = map(int,parameter_s.split())
3112 except:
3088 except:
3113 self.arg_err(Magic.magic_dhist)
3089 self.arg_err(Magic.magic_dhist)
3114 return
3090 return
3115 if len(args) == 1:
3091 if len(args) == 1:
3116 ini,fin = max(len(dh)-(args[0]),0),len(dh)
3092 ini,fin = max(len(dh)-(args[0]),0),len(dh)
3117 elif len(args) == 2:
3093 elif len(args) == 2:
3118 ini,fin = args
3094 ini,fin = args
3119 else:
3095 else:
3120 self.arg_err(Magic.magic_dhist)
3096 self.arg_err(Magic.magic_dhist)
3121 return
3097 return
3122 else:
3098 else:
3123 ini,fin = 0,len(dh)
3099 ini,fin = 0,len(dh)
3124 nlprint(dh,
3100 nlprint(dh,
3125 header = 'Directory history (kept in _dh)',
3101 header = 'Directory history (kept in _dh)',
3126 start=ini,stop=fin)
3102 start=ini,stop=fin)
3127
3103
3128 @skip_doctest
3104 @skip_doctest
3129 def magic_sc(self, parameter_s=''):
3105 def magic_sc(self, parameter_s=''):
3130 """Shell capture - execute a shell command and capture its output.
3106 """Shell capture - execute a shell command and capture its output.
3131
3107
3132 DEPRECATED. Suboptimal, retained for backwards compatibility.
3108 DEPRECATED. Suboptimal, retained for backwards compatibility.
3133
3109
3134 You should use the form 'var = !command' instead. Example:
3110 You should use the form 'var = !command' instead. Example:
3135
3111
3136 "%sc -l myfiles = ls ~" should now be written as
3112 "%sc -l myfiles = ls ~" should now be written as
3137
3113
3138 "myfiles = !ls ~"
3114 "myfiles = !ls ~"
3139
3115
3140 myfiles.s, myfiles.l and myfiles.n still apply as documented
3116 myfiles.s, myfiles.l and myfiles.n still apply as documented
3141 below.
3117 below.
3142
3118
3143 --
3119 --
3144 %sc [options] varname=command
3120 %sc [options] varname=command
3145
3121
3146 IPython will run the given command using commands.getoutput(), and
3122 IPython will run the given command using commands.getoutput(), and
3147 will then update the user's interactive namespace with a variable
3123 will then update the user's interactive namespace with a variable
3148 called varname, containing the value of the call. Your command can
3124 called varname, containing the value of the call. Your command can
3149 contain shell wildcards, pipes, etc.
3125 contain shell wildcards, pipes, etc.
3150
3126
3151 The '=' sign in the syntax is mandatory, and the variable name you
3127 The '=' sign in the syntax is mandatory, and the variable name you
3152 supply must follow Python's standard conventions for valid names.
3128 supply must follow Python's standard conventions for valid names.
3153
3129
3154 (A special format without variable name exists for internal use)
3130 (A special format without variable name exists for internal use)
3155
3131
3156 Options:
3132 Options:
3157
3133
3158 -l: list output. Split the output on newlines into a list before
3134 -l: list output. Split the output on newlines into a list before
3159 assigning it to the given variable. By default the output is stored
3135 assigning it to the given variable. By default the output is stored
3160 as a single string.
3136 as a single string.
3161
3137
3162 -v: verbose. Print the contents of the variable.
3138 -v: verbose. Print the contents of the variable.
3163
3139
3164 In most cases you should not need to split as a list, because the
3140 In most cases you should not need to split as a list, because the
3165 returned value is a special type of string which can automatically
3141 returned value is a special type of string which can automatically
3166 provide its contents either as a list (split on newlines) or as a
3142 provide its contents either as a list (split on newlines) or as a
3167 space-separated string. These are convenient, respectively, either
3143 space-separated string. These are convenient, respectively, either
3168 for sequential processing or to be passed to a shell command.
3144 for sequential processing or to be passed to a shell command.
3169
3145
3170 For example::
3146 For example::
3171
3147
3172 # Capture into variable a
3148 # Capture into variable a
3173 In [1]: sc a=ls *py
3149 In [1]: sc a=ls *py
3174
3150
3175 # a is a string with embedded newlines
3151 # a is a string with embedded newlines
3176 In [2]: a
3152 In [2]: a
3177 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
3153 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
3178
3154
3179 # which can be seen as a list:
3155 # which can be seen as a list:
3180 In [3]: a.l
3156 In [3]: a.l
3181 Out[3]: ['setup.py', 'win32_manual_post_install.py']
3157 Out[3]: ['setup.py', 'win32_manual_post_install.py']
3182
3158
3183 # or as a whitespace-separated string:
3159 # or as a whitespace-separated string:
3184 In [4]: a.s
3160 In [4]: a.s
3185 Out[4]: 'setup.py win32_manual_post_install.py'
3161 Out[4]: 'setup.py win32_manual_post_install.py'
3186
3162
3187 # a.s is useful to pass as a single command line:
3163 # a.s is useful to pass as a single command line:
3188 In [5]: !wc -l $a.s
3164 In [5]: !wc -l $a.s
3189 146 setup.py
3165 146 setup.py
3190 130 win32_manual_post_install.py
3166 130 win32_manual_post_install.py
3191 276 total
3167 276 total
3192
3168
3193 # while the list form is useful to loop over:
3169 # while the list form is useful to loop over:
3194 In [6]: for f in a.l:
3170 In [6]: for f in a.l:
3195 ...: !wc -l $f
3171 ...: !wc -l $f
3196 ...:
3172 ...:
3197 146 setup.py
3173 146 setup.py
3198 130 win32_manual_post_install.py
3174 130 win32_manual_post_install.py
3199
3175
3200 Similarly, the lists returned by the -l option are also special, in
3176 Similarly, the lists returned by the -l option are also special, in
3201 the sense that you can equally invoke the .s attribute on them to
3177 the sense that you can equally invoke the .s attribute on them to
3202 automatically get a whitespace-separated string from their contents::
3178 automatically get a whitespace-separated string from their contents::
3203
3179
3204 In [7]: sc -l b=ls *py
3180 In [7]: sc -l b=ls *py
3205
3181
3206 In [8]: b
3182 In [8]: b
3207 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3183 Out[8]: ['setup.py', 'win32_manual_post_install.py']
3208
3184
3209 In [9]: b.s
3185 In [9]: b.s
3210 Out[9]: 'setup.py win32_manual_post_install.py'
3186 Out[9]: 'setup.py win32_manual_post_install.py'
3211
3187
3212 In summary, both the lists and strings used for output capture have
3188 In summary, both the lists and strings used for output capture have
3213 the following special attributes::
3189 the following special attributes::
3214
3190
3215 .l (or .list) : value as list.
3191 .l (or .list) : value as list.
3216 .n (or .nlstr): value as newline-separated string.
3192 .n (or .nlstr): value as newline-separated string.
3217 .s (or .spstr): value as space-separated string.
3193 .s (or .spstr): value as space-separated string.
3218 """
3194 """
3219
3195
3220 opts,args = self.parse_options(parameter_s,'lv')
3196 opts,args = self.parse_options(parameter_s,'lv')
3221 # Try to get a variable name and command to run
3197 # Try to get a variable name and command to run
3222 try:
3198 try:
3223 # the variable name must be obtained from the parse_options
3199 # the variable name must be obtained from the parse_options
3224 # output, which uses shlex.split to strip options out.
3200 # output, which uses shlex.split to strip options out.
3225 var,_ = args.split('=',1)
3201 var,_ = args.split('=',1)
3226 var = var.strip()
3202 var = var.strip()
3227 # But the command has to be extracted from the original input
3203 # But the command has to be extracted from the original input
3228 # parameter_s, not on what parse_options returns, to avoid the
3204 # parameter_s, not on what parse_options returns, to avoid the
3229 # quote stripping which shlex.split performs on it.
3205 # quote stripping which shlex.split performs on it.
3230 _,cmd = parameter_s.split('=',1)
3206 _,cmd = parameter_s.split('=',1)
3231 except ValueError:
3207 except ValueError:
3232 var,cmd = '',''
3208 var,cmd = '',''
3233 # If all looks ok, proceed
3209 # If all looks ok, proceed
3234 split = 'l' in opts
3210 split = 'l' in opts
3235 out = self.shell.getoutput(cmd, split=split)
3211 out = self.shell.getoutput(cmd, split=split)
3236 if opts.has_key('v'):
3212 if opts.has_key('v'):
3237 print '%s ==\n%s' % (var,pformat(out))
3213 print '%s ==\n%s' % (var,pformat(out))
3238 if var:
3214 if var:
3239 self.shell.user_ns.update({var:out})
3215 self.shell.user_ns.update({var:out})
3240 else:
3216 else:
3241 return out
3217 return out
3242
3218
3243 def magic_sx(self, parameter_s=''):
3219 def magic_sx(self, parameter_s=''):
3244 """Shell execute - run a shell command and capture its output.
3220 """Shell execute - run a shell command and capture its output.
3245
3221
3246 %sx command
3222 %sx command
3247
3223
3248 IPython will run the given command using commands.getoutput(), and
3224 IPython will run the given command using commands.getoutput(), and
3249 return the result formatted as a list (split on '\\n'). Since the
3225 return the result formatted as a list (split on '\\n'). Since the
3250 output is _returned_, it will be stored in ipython's regular output
3226 output is _returned_, it will be stored in ipython's regular output
3251 cache Out[N] and in the '_N' automatic variables.
3227 cache Out[N] and in the '_N' automatic variables.
3252
3228
3253 Notes:
3229 Notes:
3254
3230
3255 1) If an input line begins with '!!', then %sx is automatically
3231 1) If an input line begins with '!!', then %sx is automatically
3256 invoked. That is, while::
3232 invoked. That is, while::
3257
3233
3258 !ls
3234 !ls
3259
3235
3260 causes ipython to simply issue system('ls'), typing::
3236 causes ipython to simply issue system('ls'), typing::
3261
3237
3262 !!ls
3238 !!ls
3263
3239
3264 is a shorthand equivalent to::
3240 is a shorthand equivalent to::
3265
3241
3266 %sx ls
3242 %sx ls
3267
3243
3268 2) %sx differs from %sc in that %sx automatically splits into a list,
3244 2) %sx differs from %sc in that %sx automatically splits into a list,
3269 like '%sc -l'. The reason for this is to make it as easy as possible
3245 like '%sc -l'. The reason for this is to make it as easy as possible
3270 to process line-oriented shell output via further python commands.
3246 to process line-oriented shell output via further python commands.
3271 %sc is meant to provide much finer control, but requires more
3247 %sc is meant to provide much finer control, but requires more
3272 typing.
3248 typing.
3273
3249
3274 3) Just like %sc -l, this is a list with special attributes:
3250 3) Just like %sc -l, this is a list with special attributes:
3275 ::
3251 ::
3276
3252
3277 .l (or .list) : value as list.
3253 .l (or .list) : value as list.
3278 .n (or .nlstr): value as newline-separated string.
3254 .n (or .nlstr): value as newline-separated string.
3279 .s (or .spstr): value as whitespace-separated string.
3255 .s (or .spstr): value as whitespace-separated string.
3280
3256
3281 This is very useful when trying to use such lists as arguments to
3257 This is very useful when trying to use such lists as arguments to
3282 system commands."""
3258 system commands."""
3283
3259
3284 if parameter_s:
3260 if parameter_s:
3285 return self.shell.getoutput(parameter_s)
3261 return self.shell.getoutput(parameter_s)
3286
3262
3287
3263
3288 def magic_bookmark(self, parameter_s=''):
3264 def magic_bookmark(self, parameter_s=''):
3289 """Manage IPython's bookmark system.
3265 """Manage IPython's bookmark system.
3290
3266
3291 %bookmark <name> - set bookmark to current dir
3267 %bookmark <name> - set bookmark to current dir
3292 %bookmark <name> <dir> - set bookmark to <dir>
3268 %bookmark <name> <dir> - set bookmark to <dir>
3293 %bookmark -l - list all bookmarks
3269 %bookmark -l - list all bookmarks
3294 %bookmark -d <name> - remove bookmark
3270 %bookmark -d <name> - remove bookmark
3295 %bookmark -r - remove all bookmarks
3271 %bookmark -r - remove all bookmarks
3296
3272
3297 You can later on access a bookmarked folder with::
3273 You can later on access a bookmarked folder with::
3298
3274
3299 %cd -b <name>
3275 %cd -b <name>
3300
3276
3301 or simply '%cd <name>' if there is no directory called <name> AND
3277 or simply '%cd <name>' if there is no directory called <name> AND
3302 there is such a bookmark defined.
3278 there is such a bookmark defined.
3303
3279
3304 Your bookmarks persist through IPython sessions, but they are
3280 Your bookmarks persist through IPython sessions, but they are
3305 associated with each profile."""
3281 associated with each profile."""
3306
3282
3307 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3283 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3308 if len(args) > 2:
3284 if len(args) > 2:
3309 raise UsageError("%bookmark: too many arguments")
3285 raise UsageError("%bookmark: too many arguments")
3310
3286
3311 bkms = self.shell.db.get('bookmarks',{})
3287 bkms = self.shell.db.get('bookmarks',{})
3312
3288
3313 if opts.has_key('d'):
3289 if opts.has_key('d'):
3314 try:
3290 try:
3315 todel = args[0]
3291 todel = args[0]
3316 except IndexError:
3292 except IndexError:
3317 raise UsageError(
3293 raise UsageError(
3318 "%bookmark -d: must provide a bookmark to delete")
3294 "%bookmark -d: must provide a bookmark to delete")
3319 else:
3295 else:
3320 try:
3296 try:
3321 del bkms[todel]
3297 del bkms[todel]
3322 except KeyError:
3298 except KeyError:
3323 raise UsageError(
3299 raise UsageError(
3324 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3300 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3325
3301
3326 elif opts.has_key('r'):
3302 elif opts.has_key('r'):
3327 bkms = {}
3303 bkms = {}
3328 elif opts.has_key('l'):
3304 elif opts.has_key('l'):
3329 bks = bkms.keys()
3305 bks = bkms.keys()
3330 bks.sort()
3306 bks.sort()
3331 if bks:
3307 if bks:
3332 size = max(map(len,bks))
3308 size = max(map(len,bks))
3333 else:
3309 else:
3334 size = 0
3310 size = 0
3335 fmt = '%-'+str(size)+'s -> %s'
3311 fmt = '%-'+str(size)+'s -> %s'
3336 print 'Current bookmarks:'
3312 print 'Current bookmarks:'
3337 for bk in bks:
3313 for bk in bks:
3338 print fmt % (bk,bkms[bk])
3314 print fmt % (bk,bkms[bk])
3339 else:
3315 else:
3340 if not args:
3316 if not args:
3341 raise UsageError("%bookmark: You must specify the bookmark name")
3317 raise UsageError("%bookmark: You must specify the bookmark name")
3342 elif len(args)==1:
3318 elif len(args)==1:
3343 bkms[args[0]] = os.getcwdu()
3319 bkms[args[0]] = os.getcwdu()
3344 elif len(args)==2:
3320 elif len(args)==2:
3345 bkms[args[0]] = args[1]
3321 bkms[args[0]] = args[1]
3346 self.shell.db['bookmarks'] = bkms
3322 self.shell.db['bookmarks'] = bkms
3347
3323
3348
3324
3349 def magic_pycat(self, parameter_s=''):
3325 def magic_pycat(self, parameter_s=''):
3350 """Show a syntax-highlighted file through a pager.
3326 """Show a syntax-highlighted file through a pager.
3351
3327
3352 This magic is similar to the cat utility, but it will assume the file
3328 This magic is similar to the cat utility, but it will assume the file
3353 to be Python source and will show it with syntax highlighting.
3329 to be Python source and will show it with syntax highlighting.
3354
3330
3355 This magic command can either take a local filename, an url,
3331 This magic command can either take a local filename, an url,
3356 an history range (see %history) or a macro as argument ::
3332 an history range (see %history) or a macro as argument ::
3357
3333
3358 %pycat myscript.py
3334 %pycat myscript.py
3359 %pycat 7-27
3335 %pycat 7-27
3360 %pycat myMacro
3336 %pycat myMacro
3361 %pycat http://www.example.com/myscript.py
3337 %pycat http://www.example.com/myscript.py
3362 """
3338 """
3363
3339
3364 try :
3340 try :
3365 cont = self.shell.find_user_code(parameter_s)
3341 cont = self.shell.find_user_code(parameter_s)
3366 except ValueError, IOError:
3342 except ValueError, IOError:
3367 print "Error: no such file, variable, URL, history range or macro"
3343 print "Error: no such file, variable, URL, history range or macro"
3368 return
3344 return
3369
3345
3370 page.page(self.shell.pycolorize(cont))
3346 page.page(self.shell.pycolorize(cont))
3371
3347
3372 def magic_quickref(self,arg):
3348 def magic_quickref(self,arg):
3373 """ Show a quick reference sheet """
3349 """ Show a quick reference sheet """
3374 import IPython.core.usage
3350 import IPython.core.usage
3375 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3351 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3376
3352
3377 page.page(qr)
3353 page.page(qr)
3378
3354
3379 def magic_doctest_mode(self,parameter_s=''):
3355 def magic_doctest_mode(self,parameter_s=''):
3380 """Toggle doctest mode on and off.
3356 """Toggle doctest mode on and off.
3381
3357
3382 This mode is intended to make IPython behave as much as possible like a
3358 This mode is intended to make IPython behave as much as possible like a
3383 plain Python shell, from the perspective of how its prompts, exceptions
3359 plain Python shell, from the perspective of how its prompts, exceptions
3384 and output look. This makes it easy to copy and paste parts of a
3360 and output look. This makes it easy to copy and paste parts of a
3385 session into doctests. It does so by:
3361 session into doctests. It does so by:
3386
3362
3387 - Changing the prompts to the classic ``>>>`` ones.
3363 - Changing the prompts to the classic ``>>>`` ones.
3388 - Changing the exception reporting mode to 'Plain'.
3364 - Changing the exception reporting mode to 'Plain'.
3389 - Disabling pretty-printing of output.
3365 - Disabling pretty-printing of output.
3390
3366
3391 Note that IPython also supports the pasting of code snippets that have
3367 Note that IPython also supports the pasting of code snippets that have
3392 leading '>>>' and '...' prompts in them. This means that you can paste
3368 leading '>>>' and '...' prompts in them. This means that you can paste
3393 doctests from files or docstrings (even if they have leading
3369 doctests from files or docstrings (even if they have leading
3394 whitespace), and the code will execute correctly. You can then use
3370 whitespace), and the code will execute correctly. You can then use
3395 '%history -t' to see the translated history; this will give you the
3371 '%history -t' to see the translated history; this will give you the
3396 input after removal of all the leading prompts and whitespace, which
3372 input after removal of all the leading prompts and whitespace, which
3397 can be pasted back into an editor.
3373 can be pasted back into an editor.
3398
3374
3399 With these features, you can switch into this mode easily whenever you
3375 With these features, you can switch into this mode easily whenever you
3400 need to do testing and changes to doctests, without having to leave
3376 need to do testing and changes to doctests, without having to leave
3401 your existing IPython session.
3377 your existing IPython session.
3402 """
3378 """
3403
3379
3404 from IPython.utils.ipstruct import Struct
3380 from IPython.utils.ipstruct import Struct
3405
3381
3406 # Shorthands
3382 # Shorthands
3407 shell = self.shell
3383 shell = self.shell
3408 pm = shell.prompt_manager
3384 pm = shell.prompt_manager
3409 meta = shell.meta
3385 meta = shell.meta
3410 disp_formatter = self.shell.display_formatter
3386 disp_formatter = self.shell.display_formatter
3411 ptformatter = disp_formatter.formatters['text/plain']
3387 ptformatter = disp_formatter.formatters['text/plain']
3412 # dstore is a data store kept in the instance metadata bag to track any
3388 # dstore is a data store kept in the instance metadata bag to track any
3413 # changes we make, so we can undo them later.
3389 # changes we make, so we can undo them later.
3414 dstore = meta.setdefault('doctest_mode',Struct())
3390 dstore = meta.setdefault('doctest_mode',Struct())
3415 save_dstore = dstore.setdefault
3391 save_dstore = dstore.setdefault
3416
3392
3417 # save a few values we'll need to recover later
3393 # save a few values we'll need to recover later
3418 mode = save_dstore('mode',False)
3394 mode = save_dstore('mode',False)
3419 save_dstore('rc_pprint',ptformatter.pprint)
3395 save_dstore('rc_pprint',ptformatter.pprint)
3420 save_dstore('xmode',shell.InteractiveTB.mode)
3396 save_dstore('xmode',shell.InteractiveTB.mode)
3421 save_dstore('rc_separate_out',shell.separate_out)
3397 save_dstore('rc_separate_out',shell.separate_out)
3422 save_dstore('rc_separate_out2',shell.separate_out2)
3398 save_dstore('rc_separate_out2',shell.separate_out2)
3423 save_dstore('rc_prompts_pad_left',pm.justify)
3399 save_dstore('rc_prompts_pad_left',pm.justify)
3424 save_dstore('rc_separate_in',shell.separate_in)
3400 save_dstore('rc_separate_in',shell.separate_in)
3425 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3401 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3426 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
3402 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
3427
3403
3428 if mode == False:
3404 if mode == False:
3429 # turn on
3405 # turn on
3430 pm.in_template = '>>> '
3406 pm.in_template = '>>> '
3431 pm.in2_template = '... '
3407 pm.in2_template = '... '
3432 pm.out_template = ''
3408 pm.out_template = ''
3433
3409
3434 # Prompt separators like plain python
3410 # Prompt separators like plain python
3435 shell.separate_in = ''
3411 shell.separate_in = ''
3436 shell.separate_out = ''
3412 shell.separate_out = ''
3437 shell.separate_out2 = ''
3413 shell.separate_out2 = ''
3438
3414
3439 pm.justify = False
3415 pm.justify = False
3440
3416
3441 ptformatter.pprint = False
3417 ptformatter.pprint = False
3442 disp_formatter.plain_text_only = True
3418 disp_formatter.plain_text_only = True
3443
3419
3444 shell.magic_xmode('Plain')
3420 shell.magic_xmode('Plain')
3445 else:
3421 else:
3446 # turn off
3422 # turn off
3447 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
3423 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
3448
3424
3449 shell.separate_in = dstore.rc_separate_in
3425 shell.separate_in = dstore.rc_separate_in
3450
3426
3451 shell.separate_out = dstore.rc_separate_out
3427 shell.separate_out = dstore.rc_separate_out
3452 shell.separate_out2 = dstore.rc_separate_out2
3428 shell.separate_out2 = dstore.rc_separate_out2
3453
3429
3454 pm.justify = dstore.rc_prompts_pad_left
3430 pm.justify = dstore.rc_prompts_pad_left
3455
3431
3456 ptformatter.pprint = dstore.rc_pprint
3432 ptformatter.pprint = dstore.rc_pprint
3457 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3433 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3458
3434
3459 shell.magic_xmode(dstore.xmode)
3435 shell.magic_xmode(dstore.xmode)
3460
3436
3461 # Store new mode and inform
3437 # Store new mode and inform
3462 dstore.mode = bool(1-int(mode))
3438 dstore.mode = bool(1-int(mode))
3463 mode_label = ['OFF','ON'][dstore.mode]
3439 mode_label = ['OFF','ON'][dstore.mode]
3464 print 'Doctest mode is:', mode_label
3440 print 'Doctest mode is:', mode_label
3465
3441
3466 def magic_gui(self, parameter_s=''):
3442 def magic_gui(self, parameter_s=''):
3467 """Enable or disable IPython GUI event loop integration.
3443 """Enable or disable IPython GUI event loop integration.
3468
3444
3469 %gui [GUINAME]
3445 %gui [GUINAME]
3470
3446
3471 This magic replaces IPython's threaded shells that were activated
3447 This magic replaces IPython's threaded shells that were activated
3472 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3448 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3473 can now be enabled at runtime and keyboard
3449 can now be enabled at runtime and keyboard
3474 interrupts should work without any problems. The following toolkits
3450 interrupts should work without any problems. The following toolkits
3475 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
3451 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
3476
3452
3477 %gui wx # enable wxPython event loop integration
3453 %gui wx # enable wxPython event loop integration
3478 %gui qt4|qt # enable PyQt4 event loop integration
3454 %gui qt4|qt # enable PyQt4 event loop integration
3479 %gui gtk # enable PyGTK event loop integration
3455 %gui gtk # enable PyGTK event loop integration
3480 %gui gtk3 # enable Gtk3 event loop integration
3456 %gui gtk3 # enable Gtk3 event loop integration
3481 %gui tk # enable Tk event loop integration
3457 %gui tk # enable Tk event loop integration
3482 %gui OSX # enable Cocoa event loop integration
3458 %gui OSX # enable Cocoa event loop integration
3483 # (requires %matplotlib 1.1)
3459 # (requires %matplotlib 1.1)
3484 %gui # disable all event loop integration
3460 %gui # disable all event loop integration
3485
3461
3486 WARNING: after any of these has been called you can simply create
3462 WARNING: after any of these has been called you can simply create
3487 an application object, but DO NOT start the event loop yourself, as
3463 an application object, but DO NOT start the event loop yourself, as
3488 we have already handled that.
3464 we have already handled that.
3489 """
3465 """
3490 opts, arg = self.parse_options(parameter_s, '')
3466 opts, arg = self.parse_options(parameter_s, '')
3491 if arg=='': arg = None
3467 if arg=='': arg = None
3492 try:
3468 try:
3493 return self.enable_gui(arg)
3469 return self.enable_gui(arg)
3494 except Exception as e:
3470 except Exception as e:
3495 # print simple error message, rather than traceback if we can't
3471 # print simple error message, rather than traceback if we can't
3496 # hook up the GUI
3472 # hook up the GUI
3497 error(str(e))
3473 error(str(e))
3498
3474
3499 def magic_install_ext(self, parameter_s):
3475 def magic_install_ext(self, parameter_s):
3500 """Download and install an extension from a URL, e.g.::
3476 """Download and install an extension from a URL, e.g.::
3501
3477
3502 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
3478 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
3503
3479
3504 The URL should point to an importable Python module - either a .py file
3480 The URL should point to an importable Python module - either a .py file
3505 or a .zip file.
3481 or a .zip file.
3506
3482
3507 Parameters:
3483 Parameters:
3508
3484
3509 -n filename : Specify a name for the file, rather than taking it from
3485 -n filename : Specify a name for the file, rather than taking it from
3510 the URL.
3486 the URL.
3511 """
3487 """
3512 opts, args = self.parse_options(parameter_s, 'n:')
3488 opts, args = self.parse_options(parameter_s, 'n:')
3513 try:
3489 try:
3514 filename = self.extension_manager.install_extension(args, opts.get('n'))
3490 filename = self.extension_manager.install_extension(args, opts.get('n'))
3515 except ValueError as e:
3491 except ValueError as e:
3516 print e
3492 print e
3517 return
3493 return
3518
3494
3519 filename = os.path.basename(filename)
3495 filename = os.path.basename(filename)
3520 print "Installed %s. To use it, type:" % filename
3496 print "Installed %s. To use it, type:" % filename
3521 print " %%load_ext %s" % os.path.splitext(filename)[0]
3497 print " %%load_ext %s" % os.path.splitext(filename)[0]
3522
3498
3523
3499
3524 def magic_load_ext(self, module_str):
3500 def magic_load_ext(self, module_str):
3525 """Load an IPython extension by its module name."""
3501 """Load an IPython extension by its module name."""
3526 return self.extension_manager.load_extension(module_str)
3502 return self.extension_manager.load_extension(module_str)
3527
3503
3528 def magic_unload_ext(self, module_str):
3504 def magic_unload_ext(self, module_str):
3529 """Unload an IPython extension by its module name."""
3505 """Unload an IPython extension by its module name."""
3530 self.extension_manager.unload_extension(module_str)
3506 self.extension_manager.unload_extension(module_str)
3531
3507
3532 def magic_reload_ext(self, module_str):
3508 def magic_reload_ext(self, module_str):
3533 """Reload an IPython extension by its module name."""
3509 """Reload an IPython extension by its module name."""
3534 self.extension_manager.reload_extension(module_str)
3510 self.extension_manager.reload_extension(module_str)
3535
3511
3536 def magic_install_profiles(self, s):
3512 def magic_install_profiles(self, s):
3537 """%install_profiles has been deprecated."""
3513 """%install_profiles has been deprecated."""
3538 print '\n'.join([
3514 print '\n'.join([
3539 "%install_profiles has been deprecated.",
3515 "%install_profiles has been deprecated.",
3540 "Use `ipython profile list` to view available profiles.",
3516 "Use `ipython profile list` to view available profiles.",
3541 "Requesting a profile with `ipython profile create <name>`",
3517 "Requesting a profile with `ipython profile create <name>`",
3542 "or `ipython --profile=<name>` will start with the bundled",
3518 "or `ipython --profile=<name>` will start with the bundled",
3543 "profile of that name if it exists."
3519 "profile of that name if it exists."
3544 ])
3520 ])
3545
3521
3546 def magic_install_default_config(self, s):
3522 def magic_install_default_config(self, s):
3547 """%install_default_config has been deprecated."""
3523 """%install_default_config has been deprecated."""
3548 print '\n'.join([
3524 print '\n'.join([
3549 "%install_default_config has been deprecated.",
3525 "%install_default_config has been deprecated.",
3550 "Use `ipython profile create <name>` to initialize a profile",
3526 "Use `ipython profile create <name>` to initialize a profile",
3551 "with the default config files.",
3527 "with the default config files.",
3552 "Add `--reset` to overwrite already existing config files with defaults."
3528 "Add `--reset` to overwrite already existing config files with defaults."
3553 ])
3529 ])
3554
3530
3555 @skip_doctest
3531 @skip_doctest
3556 def magic_pylab(self, s):
3532 def magic_pylab(self, s):
3557 """Load numpy and matplotlib to work interactively.
3533 """Load numpy and matplotlib to work interactively.
3558
3534
3559 %pylab [GUINAME]
3535 %pylab [GUINAME]
3560
3536
3561 This function lets you activate pylab (matplotlib, numpy and
3537 This function lets you activate pylab (matplotlib, numpy and
3562 interactive support) at any point during an IPython session.
3538 interactive support) at any point during an IPython session.
3563
3539
3564 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3540 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3565 pylab and mlab, as well as all names from numpy and pylab.
3541 pylab and mlab, as well as all names from numpy and pylab.
3566
3542
3567 If you are using the inline matplotlib backend for embedded figures,
3543 If you are using the inline matplotlib backend for embedded figures,
3568 you can adjust its behavior via the %config magic::
3544 you can adjust its behavior via the %config magic::
3569
3545
3570 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
3546 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
3571 In [1]: %config InlineBackend.figure_format = 'svg'
3547 In [1]: %config InlineBackend.figure_format = 'svg'
3572
3548
3573 # change the behavior of closing all figures at the end of each
3549 # change the behavior of closing all figures at the end of each
3574 # execution (cell), or allowing reuse of active figures across
3550 # execution (cell), or allowing reuse of active figures across
3575 # cells:
3551 # cells:
3576 In [2]: %config InlineBackend.close_figures = False
3552 In [2]: %config InlineBackend.close_figures = False
3577
3553
3578 Parameters
3554 Parameters
3579 ----------
3555 ----------
3580 guiname : optional
3556 guiname : optional
3581 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
3557 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
3582 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
3558 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
3583 used, otherwise matplotlib's default (which you can override in your
3559 used, otherwise matplotlib's default (which you can override in your
3584 matplotlib config file) is used.
3560 matplotlib config file) is used.
3585
3561
3586 Examples
3562 Examples
3587 --------
3563 --------
3588 In this case, where the MPL default is TkAgg::
3564 In this case, where the MPL default is TkAgg::
3589
3565
3590 In [2]: %pylab
3566 In [2]: %pylab
3591
3567
3592 Welcome to pylab, a matplotlib-based Python environment.
3568 Welcome to pylab, a matplotlib-based Python environment.
3593 Backend in use: TkAgg
3569 Backend in use: TkAgg
3594 For more information, type 'help(pylab)'.
3570 For more information, type 'help(pylab)'.
3595
3571
3596 But you can explicitly request a different backend::
3572 But you can explicitly request a different backend::
3597
3573
3598 In [3]: %pylab qt
3574 In [3]: %pylab qt
3599
3575
3600 Welcome to pylab, a matplotlib-based Python environment.
3576 Welcome to pylab, a matplotlib-based Python environment.
3601 Backend in use: Qt4Agg
3577 Backend in use: Qt4Agg
3602 For more information, type 'help(pylab)'.
3578 For more information, type 'help(pylab)'.
3603 """
3579 """
3604
3580
3605 if Application.initialized():
3581 if Application.initialized():
3606 app = Application.instance()
3582 app = Application.instance()
3607 try:
3583 try:
3608 import_all_status = app.pylab_import_all
3584 import_all_status = app.pylab_import_all
3609 except AttributeError:
3585 except AttributeError:
3610 import_all_status = True
3586 import_all_status = True
3611 else:
3587 else:
3612 import_all_status = True
3588 import_all_status = True
3613
3589
3614 self.shell.enable_pylab(s, import_all=import_all_status)
3590 self.shell.enable_pylab(s, import_all=import_all_status)
3615
3591
3616 def magic_tb(self, s):
3592 def magic_tb(self, s):
3617 """Print the last traceback with the currently active exception mode.
3593 """Print the last traceback with the currently active exception mode.
3618
3594
3619 See %xmode for changing exception reporting modes."""
3595 See %xmode for changing exception reporting modes."""
3620 self.shell.showtraceback()
3596 self.shell.showtraceback()
3621
3597
3622 @skip_doctest
3598 @skip_doctest
3623 def magic_precision(self, s=''):
3599 def magic_precision(self, s=''):
3624 """Set floating point precision for pretty printing.
3600 """Set floating point precision for pretty printing.
3625
3601
3626 Can set either integer precision or a format string.
3602 Can set either integer precision or a format string.
3627
3603
3628 If numpy has been imported and precision is an int,
3604 If numpy has been imported and precision is an int,
3629 numpy display precision will also be set, via ``numpy.set_printoptions``.
3605 numpy display precision will also be set, via ``numpy.set_printoptions``.
3630
3606
3631 If no argument is given, defaults will be restored.
3607 If no argument is given, defaults will be restored.
3632
3608
3633 Examples
3609 Examples
3634 --------
3610 --------
3635 ::
3611 ::
3636
3612
3637 In [1]: from math import pi
3613 In [1]: from math import pi
3638
3614
3639 In [2]: %precision 3
3615 In [2]: %precision 3
3640 Out[2]: u'%.3f'
3616 Out[2]: u'%.3f'
3641
3617
3642 In [3]: pi
3618 In [3]: pi
3643 Out[3]: 3.142
3619 Out[3]: 3.142
3644
3620
3645 In [4]: %precision %i
3621 In [4]: %precision %i
3646 Out[4]: u'%i'
3622 Out[4]: u'%i'
3647
3623
3648 In [5]: pi
3624 In [5]: pi
3649 Out[5]: 3
3625 Out[5]: 3
3650
3626
3651 In [6]: %precision %e
3627 In [6]: %precision %e
3652 Out[6]: u'%e'
3628 Out[6]: u'%e'
3653
3629
3654 In [7]: pi**10
3630 In [7]: pi**10
3655 Out[7]: 9.364805e+04
3631 Out[7]: 9.364805e+04
3656
3632
3657 In [8]: %precision
3633 In [8]: %precision
3658 Out[8]: u'%r'
3634 Out[8]: u'%r'
3659
3635
3660 In [9]: pi**10
3636 In [9]: pi**10
3661 Out[9]: 93648.047476082982
3637 Out[9]: 93648.047476082982
3662
3638
3663 """
3639 """
3664
3640
3665 ptformatter = self.shell.display_formatter.formatters['text/plain']
3641 ptformatter = self.shell.display_formatter.formatters['text/plain']
3666 ptformatter.float_precision = s
3642 ptformatter.float_precision = s
3667 return ptformatter.float_format
3643 return ptformatter.float_format
3668
3644
3669
3645
3670 @magic_arguments.magic_arguments()
3646 @magic_arguments.magic_arguments()
3671 @magic_arguments.argument(
3647 @magic_arguments.argument(
3672 '-e', '--export', action='store_true', default=False,
3648 '-e', '--export', action='store_true', default=False,
3673 help='Export IPython history as a notebook. The filename argument '
3649 help='Export IPython history as a notebook. The filename argument '
3674 'is used to specify the notebook name and format. For example '
3650 'is used to specify the notebook name and format. For example '
3675 'a filename of notebook.ipynb will result in a notebook name '
3651 'a filename of notebook.ipynb will result in a notebook name '
3676 'of "notebook" and a format of "xml". Likewise using a ".json" '
3652 'of "notebook" and a format of "xml". Likewise using a ".json" '
3677 'or ".py" file extension will write the notebook in the json '
3653 'or ".py" file extension will write the notebook in the json '
3678 'or py formats.'
3654 'or py formats.'
3679 )
3655 )
3680 @magic_arguments.argument(
3656 @magic_arguments.argument(
3681 '-f', '--format',
3657 '-f', '--format',
3682 help='Convert an existing IPython notebook to a new format. This option '
3658 help='Convert an existing IPython notebook to a new format. This option '
3683 'specifies the new format and can have the values: xml, json, py. '
3659 'specifies the new format and can have the values: xml, json, py. '
3684 'The target filename is chosen automatically based on the new '
3660 'The target filename is chosen automatically based on the new '
3685 'format. The filename argument gives the name of the source file.'
3661 'format. The filename argument gives the name of the source file.'
3686 )
3662 )
3687 @magic_arguments.argument(
3663 @magic_arguments.argument(
3688 'filename', type=unicode,
3664 'filename', type=unicode,
3689 help='Notebook name or filename'
3665 help='Notebook name or filename'
3690 )
3666 )
3691 def magic_notebook(self, s):
3667 def magic_notebook(self, s):
3692 """Export and convert IPython notebooks.
3668 """Export and convert IPython notebooks.
3693
3669
3694 This function can export the current IPython history to a notebook file
3670 This function can export the current IPython history to a notebook file
3695 or can convert an existing notebook file into a different format. For
3671 or can convert an existing notebook file into a different format. For
3696 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3672 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3697 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3673 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3698 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3674 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3699 formats include (json/ipynb, py).
3675 formats include (json/ipynb, py).
3700 """
3676 """
3701 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3677 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3702
3678
3703 from IPython.nbformat import current
3679 from IPython.nbformat import current
3704 args.filename = unquote_filename(args.filename)
3680 args.filename = unquote_filename(args.filename)
3705 if args.export:
3681 if args.export:
3706 fname, name, format = current.parse_filename(args.filename)
3682 fname, name, format = current.parse_filename(args.filename)
3707 cells = []
3683 cells = []
3708 hist = list(self.history_manager.get_range())
3684 hist = list(self.history_manager.get_range())
3709 for session, prompt_number, input in hist[:-1]:
3685 for session, prompt_number, input in hist[:-1]:
3710 cells.append(current.new_code_cell(prompt_number=prompt_number, input=input))
3686 cells.append(current.new_code_cell(prompt_number=prompt_number, input=input))
3711 worksheet = current.new_worksheet(cells=cells)
3687 worksheet = current.new_worksheet(cells=cells)
3712 nb = current.new_notebook(name=name,worksheets=[worksheet])
3688 nb = current.new_notebook(name=name,worksheets=[worksheet])
3713 with io.open(fname, 'w', encoding='utf-8') as f:
3689 with io.open(fname, 'w', encoding='utf-8') as f:
3714 current.write(nb, f, format);
3690 current.write(nb, f, format);
3715 elif args.format is not None:
3691 elif args.format is not None:
3716 old_fname, old_name, old_format = current.parse_filename(args.filename)
3692 old_fname, old_name, old_format = current.parse_filename(args.filename)
3717 new_format = args.format
3693 new_format = args.format
3718 if new_format == u'xml':
3694 if new_format == u'xml':
3719 raise ValueError('Notebooks cannot be written as xml.')
3695 raise ValueError('Notebooks cannot be written as xml.')
3720 elif new_format == u'ipynb' or new_format == u'json':
3696 elif new_format == u'ipynb' or new_format == u'json':
3721 new_fname = old_name + u'.ipynb'
3697 new_fname = old_name + u'.ipynb'
3722 new_format = u'json'
3698 new_format = u'json'
3723 elif new_format == u'py':
3699 elif new_format == u'py':
3724 new_fname = old_name + u'.py'
3700 new_fname = old_name + u'.py'
3725 else:
3701 else:
3726 raise ValueError('Invalid notebook format: %s' % new_format)
3702 raise ValueError('Invalid notebook format: %s' % new_format)
3727 with io.open(old_fname, 'r', encoding='utf-8') as f:
3703 with io.open(old_fname, 'r', encoding='utf-8') as f:
3728 nb = current.read(f, old_format)
3704 nb = current.read(f, old_format)
3729 with io.open(new_fname, 'w', encoding='utf-8') as f:
3705 with io.open(new_fname, 'w', encoding='utf-8') as f:
3730 current.write(nb, f, new_format)
3706 current.write(nb, f, new_format)
3731
3707
3732 def magic_config(self, s):
3708 def magic_config(self, s):
3733 """configure IPython
3709 """configure IPython
3734
3710
3735 %config Class[.trait=value]
3711 %config Class[.trait=value]
3736
3712
3737 This magic exposes most of the IPython config system. Any
3713 This magic exposes most of the IPython config system. Any
3738 Configurable class should be able to be configured with the simple
3714 Configurable class should be able to be configured with the simple
3739 line::
3715 line::
3740
3716
3741 %config Class.trait=value
3717 %config Class.trait=value
3742
3718
3743 Where `value` will be resolved in the user's namespace, if it is an
3719 Where `value` will be resolved in the user's namespace, if it is an
3744 expression or variable name.
3720 expression or variable name.
3745
3721
3746 Examples
3722 Examples
3747 --------
3723 --------
3748
3724
3749 To see what classes are available for config, pass no arguments::
3725 To see what classes are available for config, pass no arguments::
3750
3726
3751 In [1]: %config
3727 In [1]: %config
3752 Available objects for config:
3728 Available objects for config:
3753 TerminalInteractiveShell
3729 TerminalInteractiveShell
3754 HistoryManager
3730 HistoryManager
3755 PrefilterManager
3731 PrefilterManager
3756 AliasManager
3732 AliasManager
3757 IPCompleter
3733 IPCompleter
3758 PromptManager
3734 PromptManager
3759 DisplayFormatter
3735 DisplayFormatter
3760
3736
3761 To view what is configurable on a given class, just pass the class
3737 To view what is configurable on a given class, just pass the class
3762 name::
3738 name::
3763
3739
3764 In [2]: %config IPCompleter
3740 In [2]: %config IPCompleter
3765 IPCompleter options
3741 IPCompleter options
3766 -----------------
3742 -----------------
3767 IPCompleter.omit__names=<Enum>
3743 IPCompleter.omit__names=<Enum>
3768 Current: 2
3744 Current: 2
3769 Choices: (0, 1, 2)
3745 Choices: (0, 1, 2)
3770 Instruct the completer to omit private method names
3746 Instruct the completer to omit private method names
3771 Specifically, when completing on ``object.<tab>``.
3747 Specifically, when completing on ``object.<tab>``.
3772 When 2 [default]: all names that start with '_' will be excluded.
3748 When 2 [default]: all names that start with '_' will be excluded.
3773 When 1: all 'magic' names (``__foo__``) will be excluded.
3749 When 1: all 'magic' names (``__foo__``) will be excluded.
3774 When 0: nothing will be excluded.
3750 When 0: nothing will be excluded.
3775 IPCompleter.merge_completions=<CBool>
3751 IPCompleter.merge_completions=<CBool>
3776 Current: True
3752 Current: True
3777 Whether to merge completion results into a single list
3753 Whether to merge completion results into a single list
3778 If False, only the completion results from the first non-empty completer
3754 If False, only the completion results from the first non-empty completer
3779 will be returned.
3755 will be returned.
3780 IPCompleter.limit_to__all__=<CBool>
3756 IPCompleter.limit_to__all__=<CBool>
3781 Current: False
3757 Current: False
3782 Instruct the completer to use __all__ for the completion
3758 Instruct the completer to use __all__ for the completion
3783 Specifically, when completing on ``object.<tab>``.
3759 Specifically, when completing on ``object.<tab>``.
3784 When True: only those names in obj.__all__ will be included.
3760 When True: only those names in obj.__all__ will be included.
3785 When False [default]: the __all__ attribute is ignored
3761 When False [default]: the __all__ attribute is ignored
3786 IPCompleter.greedy=<CBool>
3762 IPCompleter.greedy=<CBool>
3787 Current: False
3763 Current: False
3788 Activate greedy completion
3764 Activate greedy completion
3789 This will enable completion on elements of lists, results of function calls,
3765 This will enable completion on elements of lists, results of function calls,
3790 etc., but can be unsafe because the code is actually evaluated on TAB.
3766 etc., but can be unsafe because the code is actually evaluated on TAB.
3791
3767
3792 but the real use is in setting values::
3768 but the real use is in setting values::
3793
3769
3794 In [3]: %config IPCompleter.greedy = True
3770 In [3]: %config IPCompleter.greedy = True
3795
3771
3796 and these values are read from the user_ns if they are variables::
3772 and these values are read from the user_ns if they are variables::
3797
3773
3798 In [4]: feeling_greedy=False
3774 In [4]: feeling_greedy=False
3799
3775
3800 In [5]: %config IPCompleter.greedy = feeling_greedy
3776 In [5]: %config IPCompleter.greedy = feeling_greedy
3801
3777
3802 """
3778 """
3803 from IPython.config.loader import Config
3779 from IPython.config.loader import Config
3804 # some IPython objects are Configurable, but do not yet have
3780 # some IPython objects are Configurable, but do not yet have
3805 # any configurable traits. Exclude them from the effects of
3781 # any configurable traits. Exclude them from the effects of
3806 # this magic, as their presence is just noise:
3782 # this magic, as their presence is just noise:
3807 configurables = [ c for c in self.shell.configurables
3783 configurables = [ c for c in self.shell.configurables
3808 if c.__class__.class_traits(config=True) ]
3784 if c.__class__.class_traits(config=True) ]
3809 classnames = [ c.__class__.__name__ for c in configurables ]
3785 classnames = [ c.__class__.__name__ for c in configurables ]
3810
3786
3811 line = s.strip()
3787 line = s.strip()
3812 if not line:
3788 if not line:
3813 # print available configurable names
3789 # print available configurable names
3814 print "Available objects for config:"
3790 print "Available objects for config:"
3815 for name in classnames:
3791 for name in classnames:
3816 print " ", name
3792 print " ", name
3817 return
3793 return
3818 elif line in classnames:
3794 elif line in classnames:
3819 # `%config TerminalInteractiveShell` will print trait info for
3795 # `%config TerminalInteractiveShell` will print trait info for
3820 # TerminalInteractiveShell
3796 # TerminalInteractiveShell
3821 c = configurables[classnames.index(line)]
3797 c = configurables[classnames.index(line)]
3822 cls = c.__class__
3798 cls = c.__class__
3823 help = cls.class_get_help(c)
3799 help = cls.class_get_help(c)
3824 # strip leading '--' from cl-args:
3800 # strip leading '--' from cl-args:
3825 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
3801 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
3826 print help
3802 print help
3827 return
3803 return
3828 elif '=' not in line:
3804 elif '=' not in line:
3829 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
3805 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
3830
3806
3831
3807
3832 # otherwise, assume we are setting configurables.
3808 # otherwise, assume we are setting configurables.
3833 # leave quotes on args when splitting, because we want
3809 # leave quotes on args when splitting, because we want
3834 # unquoted args to eval in user_ns
3810 # unquoted args to eval in user_ns
3835 cfg = Config()
3811 cfg = Config()
3836 exec "cfg."+line in locals(), self.shell.user_ns
3812 exec "cfg."+line in locals(), self.shell.user_ns
3837
3813
3838 for configurable in configurables:
3814 for configurable in configurables:
3839 try:
3815 try:
3840 configurable.update_config(cfg)
3816 configurable.update_config(cfg)
3841 except Exception as e:
3817 except Exception as e:
3842 error(e)
3818 error(e)
3843
3819
3844 # end Magic
3820 # end Magic
General Comments 0
You need to be logged in to leave comments. Login now