##// END OF EJS Templates
Fix my own daft mistake in previous commit.
Thomas Kluyver -
Show More
@@ -1,3478 +1,3478 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-2009 The IPython Development Team
8 # Copyright (C) 2008-2009 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__
18 import __builtin__
19 import __future__
19 import __future__
20 import bdb
20 import bdb
21 import inspect
21 import inspect
22 import os
22 import os
23 import sys
23 import sys
24 import shutil
24 import shutil
25 import re
25 import re
26 import time
26 import time
27 import textwrap
27 import textwrap
28 from cStringIO import StringIO
28 from cStringIO import StringIO
29 from getopt import getopt,GetoptError
29 from getopt import getopt,GetoptError
30 from pprint import pformat
30 from pprint import pformat
31 from xmlrpclib import ServerProxy
31 from xmlrpclib import ServerProxy
32
32
33 # cProfile was added in Python2.5
33 # cProfile was added in Python2.5
34 try:
34 try:
35 import cProfile as profile
35 import cProfile as profile
36 import pstats
36 import pstats
37 except ImportError:
37 except ImportError:
38 # profile isn't bundled by default in Debian for license reasons
38 # profile isn't bundled by default in Debian for license reasons
39 try:
39 try:
40 import profile,pstats
40 import profile,pstats
41 except ImportError:
41 except ImportError:
42 profile = pstats = None
42 profile = pstats = None
43
43
44 import IPython
44 import IPython
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.fakemodule import FakeModule
48 from IPython.core.fakemodule import FakeModule
49 from IPython.core.macro import Macro
49 from IPython.core.macro import Macro
50 from IPython.core import page
50 from IPython.core import page
51 from IPython.core.prefilter import ESC_MAGIC
51 from IPython.core.prefilter import ESC_MAGIC
52 from IPython.lib.pylabtools import mpl_runner
52 from IPython.lib.pylabtools import mpl_runner
53 from IPython.external.Itpl import itpl, printpl
53 from IPython.external.Itpl import itpl, printpl
54 from IPython.testing import decorators as testdec
54 from IPython.testing import decorators as testdec
55 from IPython.utils.io import file_read, nlprint
55 from IPython.utils.io import file_read, nlprint
56 import IPython.utils.io
56 import IPython.utils.io
57 from IPython.utils.path import get_py_filename
57 from IPython.utils.path import get_py_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 LSString, SList, format_screen
60 from IPython.utils.text import LSString, SList, 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 import IPython.utils.generics
64 import IPython.utils.generics
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 # Main class implementing Magic functionality
95 # Main class implementing Magic functionality
96
96
97 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
97 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
98 # on construction of the main InteractiveShell object. Something odd is going
98 # on construction of the main InteractiveShell object. Something odd is going
99 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
99 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
100 # eventually this needs to be clarified.
100 # eventually this needs to be clarified.
101 # BG: This is because InteractiveShell inherits from this, but is itself a
101 # BG: This is because InteractiveShell inherits from this, but is itself a
102 # Configurable. This messes up the MRO in some way. The fix is that we need to
102 # Configurable. This messes up the MRO in some way. The fix is that we need to
103 # make Magic a configurable that InteractiveShell does not subclass.
103 # make Magic a configurable that InteractiveShell does not subclass.
104
104
105 class Magic:
105 class Magic:
106 """Magic functions for InteractiveShell.
106 """Magic functions for InteractiveShell.
107
107
108 Shell functions which can be reached as %function_name. All magic
108 Shell functions which can be reached as %function_name. All magic
109 functions should accept a string, which they can parse for their own
109 functions should accept a string, which they can parse for their own
110 needs. This can make some functions easier to type, eg `%cd ../`
110 needs. This can make some functions easier to type, eg `%cd ../`
111 vs. `%cd("../")`
111 vs. `%cd("../")`
112
112
113 ALL definitions MUST begin with the prefix magic_. The user won't need it
113 ALL definitions MUST begin with the prefix magic_. The user won't need it
114 at the command line, but it is is needed in the definition. """
114 at the command line, but it is is needed in the definition. """
115
115
116 # class globals
116 # class globals
117 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
117 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
118 'Automagic is ON, % prefix NOT needed for magic functions.']
118 'Automagic is ON, % prefix NOT needed for magic functions.']
119
119
120 #......................................................................
120 #......................................................................
121 # some utility functions
121 # some utility functions
122
122
123 def __init__(self,shell):
123 def __init__(self,shell):
124
124
125 self.options_table = {}
125 self.options_table = {}
126 if profile is None:
126 if profile is None:
127 self.magic_prun = self.profile_missing_notice
127 self.magic_prun = self.profile_missing_notice
128 self.shell = shell
128 self.shell = shell
129
129
130 # namespace for holding state we may need
130 # namespace for holding state we may need
131 self._magic_state = Bunch()
131 self._magic_state = Bunch()
132
132
133 def profile_missing_notice(self, *args, **kwargs):
133 def profile_missing_notice(self, *args, **kwargs):
134 error("""\
134 error("""\
135 The profile module could not be found. It has been removed from the standard
135 The profile module could not be found. It has been removed from the standard
136 python packages because of its non-free license. To use profiling, install the
136 python packages because of its non-free license. To use profiling, install the
137 python-profiler package from non-free.""")
137 python-profiler package from non-free.""")
138
138
139 def default_option(self,fn,optstr):
139 def default_option(self,fn,optstr):
140 """Make an entry in the options_table for fn, with value optstr"""
140 """Make an entry in the options_table for fn, with value optstr"""
141
141
142 if fn not in self.lsmagic():
142 if fn not in self.lsmagic():
143 error("%s is not a magic function" % fn)
143 error("%s is not a magic function" % fn)
144 self.options_table[fn] = optstr
144 self.options_table[fn] = optstr
145
145
146 def lsmagic(self):
146 def lsmagic(self):
147 """Return a list of currently available magic functions.
147 """Return a list of currently available magic functions.
148
148
149 Gives a list of the bare names after mangling (['ls','cd', ...], not
149 Gives a list of the bare names after mangling (['ls','cd', ...], not
150 ['magic_ls','magic_cd',...]"""
150 ['magic_ls','magic_cd',...]"""
151
151
152 # FIXME. This needs a cleanup, in the way the magics list is built.
152 # FIXME. This needs a cleanup, in the way the magics list is built.
153
153
154 # magics in class definition
154 # magics in class definition
155 class_magic = lambda fn: fn.startswith('magic_') and \
155 class_magic = lambda fn: fn.startswith('magic_') and \
156 callable(Magic.__dict__[fn])
156 callable(Magic.__dict__[fn])
157 # in instance namespace (run-time user additions)
157 # in instance namespace (run-time user additions)
158 inst_magic = lambda fn: fn.startswith('magic_') and \
158 inst_magic = lambda fn: fn.startswith('magic_') and \
159 callable(self.__dict__[fn])
159 callable(self.__dict__[fn])
160 # and bound magics by user (so they can access self):
160 # and bound magics by user (so they can access self):
161 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
161 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
162 callable(self.__class__.__dict__[fn])
162 callable(self.__class__.__dict__[fn])
163 magics = filter(class_magic,Magic.__dict__.keys()) + \
163 magics = filter(class_magic,Magic.__dict__.keys()) + \
164 filter(inst_magic,self.__dict__.keys()) + \
164 filter(inst_magic,self.__dict__.keys()) + \
165 filter(inst_bound_magic,self.__class__.__dict__.keys())
165 filter(inst_bound_magic,self.__class__.__dict__.keys())
166 out = []
166 out = []
167 for fn in set(magics):
167 for fn in set(magics):
168 out.append(fn.replace('magic_','',1))
168 out.append(fn.replace('magic_','',1))
169 out.sort()
169 out.sort()
170 return out
170 return out
171
171
172 def extract_input_lines(self, range_str, raw=False):
172 def extract_input_lines(self, range_str, raw=False):
173 """Return as a string a set of input history slices.
173 """Return as a string a set of input history slices.
174
174
175 Inputs:
175 Inputs:
176
176
177 - range_str: the set of slices is given as a string, like
177 - range_str: the set of slices is given as a string, like
178 "~5/6-~4/2 4:8 9", since this function is for use by magic functions
178 "~5/6-~4/2 4:8 9", since this function is for use by magic functions
179 which get their arguments as strings. The number before the / is the
179 which get their arguments as strings. The number before the / is the
180 session number: ~n goes n back from the current session.
180 session number: ~n goes n back from the current session.
181
181
182 Optional inputs:
182 Optional inputs:
183
183
184 - raw(False): by default, the processed input is used. If this is
184 - raw(False): by default, the processed input is used. If this is
185 true, the raw input history is used instead.
185 true, the raw input history is used instead.
186
186
187 Note that slices can be called with two notations:
187 Note that slices can be called with two notations:
188
188
189 N:M -> standard python form, means including items N...(M-1).
189 N:M -> standard python form, means including items N...(M-1).
190
190
191 N-M -> include items N..M (closed endpoint)."""
191 N-M -> include items N..M (closed endpoint)."""
192 lines = self.shell.history_manager.\
192 lines = self.shell.history_manager.\
193 get_range_by_str(range_str, raw=raw)
193 get_range_by_str(range_str, raw=raw)
194 return "\n".join(x for _, _, x in lines)
194 return "\n".join(x for _, _, x in lines)
195
195
196 def arg_err(self,func):
196 def arg_err(self,func):
197 """Print docstring if incorrect arguments were passed"""
197 """Print docstring if incorrect arguments were passed"""
198 print 'Error in arguments:'
198 print 'Error in arguments:'
199 print oinspect.getdoc(func)
199 print oinspect.getdoc(func)
200
200
201 def format_latex(self,strng):
201 def format_latex(self,strng):
202 """Format a string for latex inclusion."""
202 """Format a string for latex inclusion."""
203
203
204 # Characters that need to be escaped for latex:
204 # Characters that need to be escaped for latex:
205 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
205 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
206 # Magic command names as headers:
206 # Magic command names as headers:
207 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
207 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
208 re.MULTILINE)
208 re.MULTILINE)
209 # Magic commands
209 # Magic commands
210 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
210 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
211 re.MULTILINE)
211 re.MULTILINE)
212 # Paragraph continue
212 # Paragraph continue
213 par_re = re.compile(r'\\$',re.MULTILINE)
213 par_re = re.compile(r'\\$',re.MULTILINE)
214
214
215 # The "\n" symbol
215 # The "\n" symbol
216 newline_re = re.compile(r'\\n')
216 newline_re = re.compile(r'\\n')
217
217
218 # Now build the string for output:
218 # Now build the string for output:
219 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
219 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
220 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
220 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
221 strng)
221 strng)
222 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
222 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
223 strng = par_re.sub(r'\\\\',strng)
223 strng = par_re.sub(r'\\\\',strng)
224 strng = escape_re.sub(r'\\\1',strng)
224 strng = escape_re.sub(r'\\\1',strng)
225 strng = newline_re.sub(r'\\textbackslash{}n',strng)
225 strng = newline_re.sub(r'\\textbackslash{}n',strng)
226 return strng
226 return strng
227
227
228 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
228 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
229 """Parse options passed to an argument string.
229 """Parse options passed to an argument string.
230
230
231 The interface is similar to that of getopt(), but it returns back a
231 The interface is similar to that of getopt(), but it returns back a
232 Struct with the options as keys and the stripped argument string still
232 Struct with the options as keys and the stripped argument string still
233 as a string.
233 as a string.
234
234
235 arg_str is quoted as a true sys.argv vector by using shlex.split.
235 arg_str is quoted as a true sys.argv vector by using shlex.split.
236 This allows us to easily expand variables, glob files, quote
236 This allows us to easily expand variables, glob files, quote
237 arguments, etc.
237 arguments, etc.
238
238
239 Options:
239 Options:
240 -mode: default 'string'. If given as 'list', the argument string is
240 -mode: default 'string'. If given as 'list', the argument string is
241 returned as a list (split on whitespace) instead of a string.
241 returned as a list (split on whitespace) instead of a string.
242
242
243 -list_all: put all option values in lists. Normally only options
243 -list_all: put all option values in lists. Normally only options
244 appearing more than once are put in a list.
244 appearing more than once are put in a list.
245
245
246 -posix (True): whether to split the input line in POSIX mode or not,
246 -posix (True): whether to split the input line in POSIX mode or not,
247 as per the conventions outlined in the shlex module from the
247 as per the conventions outlined in the shlex module from the
248 standard library."""
248 standard library."""
249
249
250 # inject default options at the beginning of the input line
250 # inject default options at the beginning of the input line
251 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
251 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
252 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
252 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
253
253
254 mode = kw.get('mode','string')
254 mode = kw.get('mode','string')
255 if mode not in ['string','list']:
255 if mode not in ['string','list']:
256 raise ValueError,'incorrect mode given: %s' % mode
256 raise ValueError,'incorrect mode given: %s' % mode
257 # Get options
257 # Get options
258 list_all = kw.get('list_all',0)
258 list_all = kw.get('list_all',0)
259 posix = kw.get('posix', os.name == 'posix')
259 posix = kw.get('posix', os.name == 'posix')
260
260
261 # Check if we have more than one argument to warrant extra processing:
261 # Check if we have more than one argument to warrant extra processing:
262 odict = {} # Dictionary with options
262 odict = {} # Dictionary with options
263 args = arg_str.split()
263 args = arg_str.split()
264 if len(args) >= 1:
264 if len(args) >= 1:
265 # If the list of inputs only has 0 or 1 thing in it, there's no
265 # If the list of inputs only has 0 or 1 thing in it, there's no
266 # need to look for options
266 # need to look for options
267 argv = arg_split(arg_str,posix)
267 argv = arg_split(arg_str,posix)
268 # Do regular option processing
268 # Do regular option processing
269 try:
269 try:
270 opts,args = getopt(argv,opt_str,*long_opts)
270 opts,args = getopt(argv,opt_str,*long_opts)
271 except GetoptError,e:
271 except GetoptError,e:
272 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
272 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
273 " ".join(long_opts)))
273 " ".join(long_opts)))
274 for o,a in opts:
274 for o,a in opts:
275 if o.startswith('--'):
275 if o.startswith('--'):
276 o = o[2:]
276 o = o[2:]
277 else:
277 else:
278 o = o[1:]
278 o = o[1:]
279 try:
279 try:
280 odict[o].append(a)
280 odict[o].append(a)
281 except AttributeError:
281 except AttributeError:
282 odict[o] = [odict[o],a]
282 odict[o] = [odict[o],a]
283 except KeyError:
283 except KeyError:
284 if list_all:
284 if list_all:
285 odict[o] = [a]
285 odict[o] = [a]
286 else:
286 else:
287 odict[o] = a
287 odict[o] = a
288
288
289 # Prepare opts,args for return
289 # Prepare opts,args for return
290 opts = Struct(odict)
290 opts = Struct(odict)
291 if mode == 'string':
291 if mode == 'string':
292 args = ' '.join(args)
292 args = ' '.join(args)
293
293
294 return opts,args
294 return opts,args
295
295
296 #......................................................................
296 #......................................................................
297 # And now the actual magic functions
297 # And now the actual magic functions
298
298
299 # Functions for IPython shell work (vars,funcs, config, etc)
299 # Functions for IPython shell work (vars,funcs, config, etc)
300 def magic_lsmagic(self, parameter_s = ''):
300 def magic_lsmagic(self, parameter_s = ''):
301 """List currently available magic functions."""
301 """List currently available magic functions."""
302 mesc = ESC_MAGIC
302 mesc = ESC_MAGIC
303 print 'Available magic functions:\n'+mesc+\
303 print 'Available magic functions:\n'+mesc+\
304 (' '+mesc).join(self.lsmagic())
304 (' '+mesc).join(self.lsmagic())
305 print '\n' + Magic.auto_status[self.shell.automagic]
305 print '\n' + Magic.auto_status[self.shell.automagic]
306 return None
306 return None
307
307
308 def magic_magic(self, parameter_s = ''):
308 def magic_magic(self, parameter_s = ''):
309 """Print information about the magic function system.
309 """Print information about the magic function system.
310
310
311 Supported formats: -latex, -brief, -rest
311 Supported formats: -latex, -brief, -rest
312 """
312 """
313
313
314 mode = ''
314 mode = ''
315 try:
315 try:
316 if parameter_s.split()[0] == '-latex':
316 if parameter_s.split()[0] == '-latex':
317 mode = 'latex'
317 mode = 'latex'
318 if parameter_s.split()[0] == '-brief':
318 if parameter_s.split()[0] == '-brief':
319 mode = 'brief'
319 mode = 'brief'
320 if parameter_s.split()[0] == '-rest':
320 if parameter_s.split()[0] == '-rest':
321 mode = 'rest'
321 mode = 'rest'
322 rest_docs = []
322 rest_docs = []
323 except:
323 except:
324 pass
324 pass
325
325
326 magic_docs = []
326 magic_docs = []
327 for fname in self.lsmagic():
327 for fname in self.lsmagic():
328 mname = 'magic_' + fname
328 mname = 'magic_' + fname
329 for space in (Magic,self,self.__class__):
329 for space in (Magic,self,self.__class__):
330 try:
330 try:
331 fn = space.__dict__[mname]
331 fn = space.__dict__[mname]
332 except KeyError:
332 except KeyError:
333 pass
333 pass
334 else:
334 else:
335 break
335 break
336 if mode == 'brief':
336 if mode == 'brief':
337 # only first line
337 # only first line
338 if fn.__doc__:
338 if fn.__doc__:
339 fndoc = fn.__doc__.split('\n',1)[0]
339 fndoc = fn.__doc__.split('\n',1)[0]
340 else:
340 else:
341 fndoc = 'No documentation'
341 fndoc = 'No documentation'
342 else:
342 else:
343 if fn.__doc__:
343 if fn.__doc__:
344 fndoc = fn.__doc__.rstrip()
344 fndoc = fn.__doc__.rstrip()
345 else:
345 else:
346 fndoc = 'No documentation'
346 fndoc = 'No documentation'
347
347
348
348
349 if mode == 'rest':
349 if mode == 'rest':
350 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
350 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
351 fname,fndoc))
351 fname,fndoc))
352
352
353 else:
353 else:
354 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
354 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
355 fname,fndoc))
355 fname,fndoc))
356
356
357 magic_docs = ''.join(magic_docs)
357 magic_docs = ''.join(magic_docs)
358
358
359 if mode == 'rest':
359 if mode == 'rest':
360 return "".join(rest_docs)
360 return "".join(rest_docs)
361
361
362 if mode == 'latex':
362 if mode == 'latex':
363 print self.format_latex(magic_docs)
363 print self.format_latex(magic_docs)
364 return
364 return
365 else:
365 else:
366 magic_docs = format_screen(magic_docs)
366 magic_docs = format_screen(magic_docs)
367 if mode == 'brief':
367 if mode == 'brief':
368 return magic_docs
368 return magic_docs
369
369
370 outmsg = """
370 outmsg = """
371 IPython's 'magic' functions
371 IPython's 'magic' functions
372 ===========================
372 ===========================
373
373
374 The magic function system provides a series of functions which allow you to
374 The magic function system provides a series of functions which allow you to
375 control the behavior of IPython itself, plus a lot of system-type
375 control the behavior of IPython itself, plus a lot of system-type
376 features. All these functions are prefixed with a % character, but parameters
376 features. All these functions are prefixed with a % character, but parameters
377 are given without parentheses or quotes.
377 are given without parentheses or quotes.
378
378
379 NOTE: If you have 'automagic' enabled (via the command line option or with the
379 NOTE: If you have 'automagic' enabled (via the command line option or with the
380 %automagic function), you don't need to type in the % explicitly. By default,
380 %automagic function), you don't need to type in the % explicitly. By default,
381 IPython ships with automagic on, so you should only rarely need the % escape.
381 IPython ships with automagic on, so you should only rarely need the % escape.
382
382
383 Example: typing '%cd mydir' (without the quotes) changes you working directory
383 Example: typing '%cd mydir' (without the quotes) changes you working directory
384 to 'mydir', if it exists.
384 to 'mydir', if it exists.
385
385
386 You can define your own magic functions to extend the system. See the supplied
386 You can define your own magic functions to extend the system. See the supplied
387 ipythonrc and example-magic.py files for details (in your ipython
387 ipythonrc and example-magic.py files for details (in your ipython
388 configuration directory, typically $HOME/.config/ipython on Linux or $HOME/.ipython elsewhere).
388 configuration directory, typically $HOME/.config/ipython on Linux or $HOME/.ipython elsewhere).
389
389
390 You can also define your own aliased names for magic functions. In your
390 You can also define your own aliased names for magic functions. In your
391 ipythonrc file, placing a line like:
391 ipythonrc file, placing a line like:
392
392
393 execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile
393 execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile
394
394
395 will define %pf as a new name for %profile.
395 will define %pf as a new name for %profile.
396
396
397 You can also call magics in code using the magic() function, which IPython
397 You can also call magics in code using the magic() function, which IPython
398 automatically adds to the builtin namespace. Type 'magic?' for details.
398 automatically adds to the builtin namespace. Type 'magic?' for details.
399
399
400 For a list of the available magic functions, use %lsmagic. For a description
400 For a list of the available magic functions, use %lsmagic. For a description
401 of any of them, type %magic_name?, e.g. '%cd?'.
401 of any of them, type %magic_name?, e.g. '%cd?'.
402
402
403 Currently the magic system has the following functions:\n"""
403 Currently the magic system has the following functions:\n"""
404
404
405 mesc = ESC_MAGIC
405 mesc = ESC_MAGIC
406 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
406 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
407 "\n\n%s%s\n\n%s" % (outmsg,
407 "\n\n%s%s\n\n%s" % (outmsg,
408 magic_docs,mesc,mesc,
408 magic_docs,mesc,mesc,
409 (' '+mesc).join(self.lsmagic()),
409 (' '+mesc).join(self.lsmagic()),
410 Magic.auto_status[self.shell.automagic] ) )
410 Magic.auto_status[self.shell.automagic] ) )
411 page.page(outmsg)
411 page.page(outmsg)
412
412
413 def magic_automagic(self, parameter_s = ''):
413 def magic_automagic(self, parameter_s = ''):
414 """Make magic functions callable without having to type the initial %.
414 """Make magic functions callable without having to type the initial %.
415
415
416 Without argumentsl toggles on/off (when off, you must call it as
416 Without argumentsl toggles on/off (when off, you must call it as
417 %automagic, of course). With arguments it sets the value, and you can
417 %automagic, of course). With arguments it sets the value, and you can
418 use any of (case insensitive):
418 use any of (case insensitive):
419
419
420 - on,1,True: to activate
420 - on,1,True: to activate
421
421
422 - off,0,False: to deactivate.
422 - off,0,False: to deactivate.
423
423
424 Note that magic functions have lowest priority, so if there's a
424 Note that magic functions have lowest priority, so if there's a
425 variable whose name collides with that of a magic fn, automagic won't
425 variable whose name collides with that of a magic fn, automagic won't
426 work for that function (you get the variable instead). However, if you
426 work for that function (you get the variable instead). However, if you
427 delete the variable (del var), the previously shadowed magic function
427 delete the variable (del var), the previously shadowed magic function
428 becomes visible to automagic again."""
428 becomes visible to automagic again."""
429
429
430 arg = parameter_s.lower()
430 arg = parameter_s.lower()
431 if parameter_s in ('on','1','true'):
431 if parameter_s in ('on','1','true'):
432 self.shell.automagic = True
432 self.shell.automagic = True
433 elif parameter_s in ('off','0','false'):
433 elif parameter_s in ('off','0','false'):
434 self.shell.automagic = False
434 self.shell.automagic = False
435 else:
435 else:
436 self.shell.automagic = not self.shell.automagic
436 self.shell.automagic = not self.shell.automagic
437 print '\n' + Magic.auto_status[self.shell.automagic]
437 print '\n' + Magic.auto_status[self.shell.automagic]
438
438
439 @testdec.skip_doctest
439 @testdec.skip_doctest
440 def magic_autocall(self, parameter_s = ''):
440 def magic_autocall(self, parameter_s = ''):
441 """Make functions callable without having to type parentheses.
441 """Make functions callable without having to type parentheses.
442
442
443 Usage:
443 Usage:
444
444
445 %autocall [mode]
445 %autocall [mode]
446
446
447 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
447 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
448 value is toggled on and off (remembering the previous state).
448 value is toggled on and off (remembering the previous state).
449
449
450 In more detail, these values mean:
450 In more detail, these values mean:
451
451
452 0 -> fully disabled
452 0 -> fully disabled
453
453
454 1 -> active, but do not apply if there are no arguments on the line.
454 1 -> active, but do not apply if there are no arguments on the line.
455
455
456 In this mode, you get:
456 In this mode, you get:
457
457
458 In [1]: callable
458 In [1]: callable
459 Out[1]: <built-in function callable>
459 Out[1]: <built-in function callable>
460
460
461 In [2]: callable 'hello'
461 In [2]: callable 'hello'
462 ------> callable('hello')
462 ------> callable('hello')
463 Out[2]: False
463 Out[2]: False
464
464
465 2 -> Active always. Even if no arguments are present, the callable
465 2 -> Active always. Even if no arguments are present, the callable
466 object is called:
466 object is called:
467
467
468 In [2]: float
468 In [2]: float
469 ------> float()
469 ------> float()
470 Out[2]: 0.0
470 Out[2]: 0.0
471
471
472 Note that even with autocall off, you can still use '/' at the start of
472 Note that even with autocall off, you can still use '/' at the start of
473 a line to treat the first argument on the command line as a function
473 a line to treat the first argument on the command line as a function
474 and add parentheses to it:
474 and add parentheses to it:
475
475
476 In [8]: /str 43
476 In [8]: /str 43
477 ------> str(43)
477 ------> str(43)
478 Out[8]: '43'
478 Out[8]: '43'
479
479
480 # all-random (note for auto-testing)
480 # all-random (note for auto-testing)
481 """
481 """
482
482
483 if parameter_s:
483 if parameter_s:
484 arg = int(parameter_s)
484 arg = int(parameter_s)
485 else:
485 else:
486 arg = 'toggle'
486 arg = 'toggle'
487
487
488 if not arg in (0,1,2,'toggle'):
488 if not arg in (0,1,2,'toggle'):
489 error('Valid modes: (0->Off, 1->Smart, 2->Full')
489 error('Valid modes: (0->Off, 1->Smart, 2->Full')
490 return
490 return
491
491
492 if arg in (0,1,2):
492 if arg in (0,1,2):
493 self.shell.autocall = arg
493 self.shell.autocall = arg
494 else: # toggle
494 else: # toggle
495 if self.shell.autocall:
495 if self.shell.autocall:
496 self._magic_state.autocall_save = self.shell.autocall
496 self._magic_state.autocall_save = self.shell.autocall
497 self.shell.autocall = 0
497 self.shell.autocall = 0
498 else:
498 else:
499 try:
499 try:
500 self.shell.autocall = self._magic_state.autocall_save
500 self.shell.autocall = self._magic_state.autocall_save
501 except AttributeError:
501 except AttributeError:
502 self.shell.autocall = self._magic_state.autocall_save = 1
502 self.shell.autocall = self._magic_state.autocall_save = 1
503
503
504 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
504 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
505
505
506
506
507 def magic_page(self, parameter_s=''):
507 def magic_page(self, parameter_s=''):
508 """Pretty print the object and display it through a pager.
508 """Pretty print the object and display it through a pager.
509
509
510 %page [options] OBJECT
510 %page [options] OBJECT
511
511
512 If no object is given, use _ (last output).
512 If no object is given, use _ (last output).
513
513
514 Options:
514 Options:
515
515
516 -r: page str(object), don't pretty-print it."""
516 -r: page str(object), don't pretty-print it."""
517
517
518 # After a function contributed by Olivier Aubert, slightly modified.
518 # After a function contributed by Olivier Aubert, slightly modified.
519
519
520 # Process options/args
520 # Process options/args
521 opts,args = self.parse_options(parameter_s,'r')
521 opts,args = self.parse_options(parameter_s,'r')
522 raw = 'r' in opts
522 raw = 'r' in opts
523
523
524 oname = args and args or '_'
524 oname = args and args or '_'
525 info = self._ofind(oname)
525 info = self._ofind(oname)
526 if info['found']:
526 if info['found']:
527 txt = (raw and str or pformat)( info['obj'] )
527 txt = (raw and str or pformat)( info['obj'] )
528 page.page(txt)
528 page.page(txt)
529 else:
529 else:
530 print 'Object `%s` not found' % oname
530 print 'Object `%s` not found' % oname
531
531
532 def magic_profile(self, parameter_s=''):
532 def magic_profile(self, parameter_s=''):
533 """Print your currently active IPython profile."""
533 """Print your currently active IPython profile."""
534 if self.shell.profile:
534 if self.shell.profile:
535 printpl('Current IPython profile: $self.shell.profile.')
535 printpl('Current IPython profile: $self.shell.profile.')
536 else:
536 else:
537 print 'No profile active.'
537 print 'No profile active.'
538
538
539 def magic_pinfo(self, parameter_s='', namespaces=None):
539 def magic_pinfo(self, parameter_s='', namespaces=None):
540 """Provide detailed information about an object.
540 """Provide detailed information about an object.
541
541
542 '%pinfo object' is just a synonym for object? or ?object."""
542 '%pinfo object' is just a synonym for object? or ?object."""
543
543
544 #print 'pinfo par: <%s>' % parameter_s # dbg
544 #print 'pinfo par: <%s>' % parameter_s # dbg
545
545
546
546
547 # detail_level: 0 -> obj? , 1 -> obj??
547 # detail_level: 0 -> obj? , 1 -> obj??
548 detail_level = 0
548 detail_level = 0
549 # We need to detect if we got called as 'pinfo pinfo foo', which can
549 # We need to detect if we got called as 'pinfo pinfo foo', which can
550 # happen if the user types 'pinfo foo?' at the cmd line.
550 # happen if the user types 'pinfo foo?' at the cmd line.
551 pinfo,qmark1,oname,qmark2 = \
551 pinfo,qmark1,oname,qmark2 = \
552 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
552 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
553 if pinfo or qmark1 or qmark2:
553 if pinfo or qmark1 or qmark2:
554 detail_level = 1
554 detail_level = 1
555 if "*" in oname:
555 if "*" in oname:
556 self.magic_psearch(oname)
556 self.magic_psearch(oname)
557 else:
557 else:
558 self.shell._inspect('pinfo', oname, detail_level=detail_level,
558 self.shell._inspect('pinfo', oname, detail_level=detail_level,
559 namespaces=namespaces)
559 namespaces=namespaces)
560
560
561 def magic_pinfo2(self, parameter_s='', namespaces=None):
561 def magic_pinfo2(self, parameter_s='', namespaces=None):
562 """Provide extra detailed information about an object.
562 """Provide extra detailed information about an object.
563
563
564 '%pinfo2 object' is just a synonym for object?? or ??object."""
564 '%pinfo2 object' is just a synonym for object?? or ??object."""
565 self.shell._inspect('pinfo', parameter_s, detail_level=1,
565 self.shell._inspect('pinfo', parameter_s, detail_level=1,
566 namespaces=namespaces)
566 namespaces=namespaces)
567
567
568 @testdec.skip_doctest
568 @testdec.skip_doctest
569 def magic_pdef(self, parameter_s='', namespaces=None):
569 def magic_pdef(self, parameter_s='', namespaces=None):
570 """Print the definition header for any callable object.
570 """Print the definition header for any callable object.
571
571
572 If the object is a class, print the constructor information.
572 If the object is a class, print the constructor information.
573
573
574 Examples
574 Examples
575 --------
575 --------
576 ::
576 ::
577
577
578 In [3]: %pdef urllib.urlopen
578 In [3]: %pdef urllib.urlopen
579 urllib.urlopen(url, data=None, proxies=None)
579 urllib.urlopen(url, data=None, proxies=None)
580 """
580 """
581 self._inspect('pdef',parameter_s, namespaces)
581 self._inspect('pdef',parameter_s, namespaces)
582
582
583 def magic_pdoc(self, parameter_s='', namespaces=None):
583 def magic_pdoc(self, parameter_s='', namespaces=None):
584 """Print the docstring for an object.
584 """Print the docstring for an object.
585
585
586 If the given object is a class, it will print both the class and the
586 If the given object is a class, it will print both the class and the
587 constructor docstrings."""
587 constructor docstrings."""
588 self._inspect('pdoc',parameter_s, namespaces)
588 self._inspect('pdoc',parameter_s, namespaces)
589
589
590 def magic_psource(self, parameter_s='', namespaces=None):
590 def magic_psource(self, parameter_s='', namespaces=None):
591 """Print (or run through pager) the source code for an object."""
591 """Print (or run through pager) the source code for an object."""
592 self._inspect('psource',parameter_s, namespaces)
592 self._inspect('psource',parameter_s, namespaces)
593
593
594 def magic_pfile(self, parameter_s=''):
594 def magic_pfile(self, parameter_s=''):
595 """Print (or run through pager) the file where an object is defined.
595 """Print (or run through pager) the file where an object is defined.
596
596
597 The file opens at the line where the object definition begins. IPython
597 The file opens at the line where the object definition begins. IPython
598 will honor the environment variable PAGER if set, and otherwise will
598 will honor the environment variable PAGER if set, and otherwise will
599 do its best to print the file in a convenient form.
599 do its best to print the file in a convenient form.
600
600
601 If the given argument is not an object currently defined, IPython will
601 If the given argument is not an object currently defined, IPython will
602 try to interpret it as a filename (automatically adding a .py extension
602 try to interpret it as a filename (automatically adding a .py extension
603 if needed). You can thus use %pfile as a syntax highlighting code
603 if needed). You can thus use %pfile as a syntax highlighting code
604 viewer."""
604 viewer."""
605
605
606 # first interpret argument as an object name
606 # first interpret argument as an object name
607 out = self._inspect('pfile',parameter_s)
607 out = self._inspect('pfile',parameter_s)
608 # if not, try the input as a filename
608 # if not, try the input as a filename
609 if out == 'not found':
609 if out == 'not found':
610 try:
610 try:
611 filename = get_py_filename(parameter_s)
611 filename = get_py_filename(parameter_s)
612 except IOError,msg:
612 except IOError,msg:
613 print msg
613 print msg
614 return
614 return
615 page.page(self.shell.inspector.format(file(filename).read()))
615 page.page(self.shell.inspector.format(file(filename).read()))
616
616
617 def magic_psearch(self, parameter_s=''):
617 def magic_psearch(self, parameter_s=''):
618 """Search for object in namespaces by wildcard.
618 """Search for object in namespaces by wildcard.
619
619
620 %psearch [options] PATTERN [OBJECT TYPE]
620 %psearch [options] PATTERN [OBJECT TYPE]
621
621
622 Note: ? can be used as a synonym for %psearch, at the beginning or at
622 Note: ? can be used as a synonym for %psearch, at the beginning or at
623 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
623 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
624 rest of the command line must be unchanged (options come first), so
624 rest of the command line must be unchanged (options come first), so
625 for example the following forms are equivalent
625 for example the following forms are equivalent
626
626
627 %psearch -i a* function
627 %psearch -i a* function
628 -i a* function?
628 -i a* function?
629 ?-i a* function
629 ?-i a* function
630
630
631 Arguments:
631 Arguments:
632
632
633 PATTERN
633 PATTERN
634
634
635 where PATTERN is a string containing * as a wildcard similar to its
635 where PATTERN is a string containing * as a wildcard similar to its
636 use in a shell. The pattern is matched in all namespaces on the
636 use in a shell. The pattern is matched in all namespaces on the
637 search path. By default objects starting with a single _ are not
637 search path. By default objects starting with a single _ are not
638 matched, many IPython generated objects have a single
638 matched, many IPython generated objects have a single
639 underscore. The default is case insensitive matching. Matching is
639 underscore. The default is case insensitive matching. Matching is
640 also done on the attributes of objects and not only on the objects
640 also done on the attributes of objects and not only on the objects
641 in a module.
641 in a module.
642
642
643 [OBJECT TYPE]
643 [OBJECT TYPE]
644
644
645 Is the name of a python type from the types module. The name is
645 Is the name of a python type from the types module. The name is
646 given in lowercase without the ending type, ex. StringType is
646 given in lowercase without the ending type, ex. StringType is
647 written string. By adding a type here only objects matching the
647 written string. By adding a type here only objects matching the
648 given type are matched. Using all here makes the pattern match all
648 given type are matched. Using all here makes the pattern match all
649 types (this is the default).
649 types (this is the default).
650
650
651 Options:
651 Options:
652
652
653 -a: makes the pattern match even objects whose names start with a
653 -a: makes the pattern match even objects whose names start with a
654 single underscore. These names are normally ommitted from the
654 single underscore. These names are normally ommitted from the
655 search.
655 search.
656
656
657 -i/-c: make the pattern case insensitive/sensitive. If neither of
657 -i/-c: make the pattern case insensitive/sensitive. If neither of
658 these options is given, the default is read from your ipythonrc
658 these options is given, the default is read from your ipythonrc
659 file. The option name which sets this value is
659 file. The option name which sets this value is
660 'wildcards_case_sensitive'. If this option is not specified in your
660 'wildcards_case_sensitive'. If this option is not specified in your
661 ipythonrc file, IPython's internal default is to do a case sensitive
661 ipythonrc file, IPython's internal default is to do a case sensitive
662 search.
662 search.
663
663
664 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
664 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
665 specifiy can be searched in any of the following namespaces:
665 specifiy can be searched in any of the following namespaces:
666 'builtin', 'user', 'user_global','internal', 'alias', where
666 'builtin', 'user', 'user_global','internal', 'alias', where
667 'builtin' and 'user' are the search defaults. Note that you should
667 'builtin' and 'user' are the search defaults. Note that you should
668 not use quotes when specifying namespaces.
668 not use quotes when specifying namespaces.
669
669
670 'Builtin' contains the python module builtin, 'user' contains all
670 'Builtin' contains the python module builtin, 'user' contains all
671 user data, 'alias' only contain the shell aliases and no python
671 user data, 'alias' only contain the shell aliases and no python
672 objects, 'internal' contains objects used by IPython. The
672 objects, 'internal' contains objects used by IPython. The
673 'user_global' namespace is only used by embedded IPython instances,
673 'user_global' namespace is only used by embedded IPython instances,
674 and it contains module-level globals. You can add namespaces to the
674 and it contains module-level globals. You can add namespaces to the
675 search with -s or exclude them with -e (these options can be given
675 search with -s or exclude them with -e (these options can be given
676 more than once).
676 more than once).
677
677
678 Examples:
678 Examples:
679
679
680 %psearch a* -> objects beginning with an a
680 %psearch a* -> objects beginning with an a
681 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
681 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
682 %psearch a* function -> all functions beginning with an a
682 %psearch a* function -> all functions beginning with an a
683 %psearch re.e* -> objects beginning with an e in module re
683 %psearch re.e* -> objects beginning with an e in module re
684 %psearch r*.e* -> objects that start with e in modules starting in r
684 %psearch r*.e* -> objects that start with e in modules starting in r
685 %psearch r*.* string -> all strings in modules beginning with r
685 %psearch r*.* string -> all strings in modules beginning with r
686
686
687 Case sensitve search:
687 Case sensitve search:
688
688
689 %psearch -c a* list all object beginning with lower case a
689 %psearch -c a* list all object beginning with lower case a
690
690
691 Show objects beginning with a single _:
691 Show objects beginning with a single _:
692
692
693 %psearch -a _* list objects beginning with a single underscore"""
693 %psearch -a _* list objects beginning with a single underscore"""
694 try:
694 try:
695 parameter_s = parameter_s.encode('ascii')
695 parameter_s = parameter_s.encode('ascii')
696 except UnicodeEncodeError:
696 except UnicodeEncodeError:
697 print 'Python identifiers can only contain ascii characters.'
697 print 'Python identifiers can only contain ascii characters.'
698 return
698 return
699
699
700 # default namespaces to be searched
700 # default namespaces to be searched
701 def_search = ['user','builtin']
701 def_search = ['user','builtin']
702
702
703 # Process options/args
703 # Process options/args
704 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
704 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
705 opt = opts.get
705 opt = opts.get
706 shell = self.shell
706 shell = self.shell
707 psearch = shell.inspector.psearch
707 psearch = shell.inspector.psearch
708
708
709 # select case options
709 # select case options
710 if opts.has_key('i'):
710 if opts.has_key('i'):
711 ignore_case = True
711 ignore_case = True
712 elif opts.has_key('c'):
712 elif opts.has_key('c'):
713 ignore_case = False
713 ignore_case = False
714 else:
714 else:
715 ignore_case = not shell.wildcards_case_sensitive
715 ignore_case = not shell.wildcards_case_sensitive
716
716
717 # Build list of namespaces to search from user options
717 # Build list of namespaces to search from user options
718 def_search.extend(opt('s',[]))
718 def_search.extend(opt('s',[]))
719 ns_exclude = ns_exclude=opt('e',[])
719 ns_exclude = ns_exclude=opt('e',[])
720 ns_search = [nm for nm in def_search if nm not in ns_exclude]
720 ns_search = [nm for nm in def_search if nm not in ns_exclude]
721
721
722 # Call the actual search
722 # Call the actual search
723 try:
723 try:
724 psearch(args,shell.ns_table,ns_search,
724 psearch(args,shell.ns_table,ns_search,
725 show_all=opt('a'),ignore_case=ignore_case)
725 show_all=opt('a'),ignore_case=ignore_case)
726 except:
726 except:
727 shell.showtraceback()
727 shell.showtraceback()
728
728
729 @testdec.skip_doctest
729 @testdec.skip_doctest
730 def magic_who_ls(self, parameter_s=''):
730 def magic_who_ls(self, parameter_s=''):
731 """Return a sorted list of all interactive variables.
731 """Return a sorted list of all interactive variables.
732
732
733 If arguments are given, only variables of types matching these
733 If arguments are given, only variables of types matching these
734 arguments are returned.
734 arguments are returned.
735
735
736 Examples
736 Examples
737 --------
737 --------
738
738
739 Define two variables and list them with who_ls::
739 Define two variables and list them with who_ls::
740
740
741 In [1]: alpha = 123
741 In [1]: alpha = 123
742
742
743 In [2]: beta = 'test'
743 In [2]: beta = 'test'
744
744
745 In [3]: %who_ls
745 In [3]: %who_ls
746 Out[3]: ['alpha', 'beta']
746 Out[3]: ['alpha', 'beta']
747
747
748 In [4]: %who_ls int
748 In [4]: %who_ls int
749 Out[4]: ['alpha']
749 Out[4]: ['alpha']
750
750
751 In [5]: %who_ls str
751 In [5]: %who_ls str
752 Out[5]: ['beta']
752 Out[5]: ['beta']
753 """
753 """
754
754
755 user_ns = self.shell.user_ns
755 user_ns = self.shell.user_ns
756 internal_ns = self.shell.internal_ns
756 internal_ns = self.shell.internal_ns
757 user_ns_hidden = self.shell.user_ns_hidden
757 user_ns_hidden = self.shell.user_ns_hidden
758 out = [ i for i in user_ns
758 out = [ i for i in user_ns
759 if not i.startswith('_') \
759 if not i.startswith('_') \
760 and not (i in internal_ns or i in user_ns_hidden) ]
760 and not (i in internal_ns or i in user_ns_hidden) ]
761
761
762 typelist = parameter_s.split()
762 typelist = parameter_s.split()
763 if typelist:
763 if typelist:
764 typeset = set(typelist)
764 typeset = set(typelist)
765 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
765 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
766
766
767 out.sort()
767 out.sort()
768 return out
768 return out
769
769
770 @testdec.skip_doctest
770 @testdec.skip_doctest
771 def magic_who(self, parameter_s=''):
771 def magic_who(self, parameter_s=''):
772 """Print all interactive variables, with some minimal formatting.
772 """Print all interactive variables, with some minimal formatting.
773
773
774 If any arguments are given, only variables whose type matches one of
774 If any arguments are given, only variables whose type matches one of
775 these are printed. For example:
775 these are printed. For example:
776
776
777 %who function str
777 %who function str
778
778
779 will only list functions and strings, excluding all other types of
779 will only list functions and strings, excluding all other types of
780 variables. To find the proper type names, simply use type(var) at a
780 variables. To find the proper type names, simply use type(var) at a
781 command line to see how python prints type names. For example:
781 command line to see how python prints type names. For example:
782
782
783 In [1]: type('hello')\\
783 In [1]: type('hello')\\
784 Out[1]: <type 'str'>
784 Out[1]: <type 'str'>
785
785
786 indicates that the type name for strings is 'str'.
786 indicates that the type name for strings is 'str'.
787
787
788 %who always excludes executed names loaded through your configuration
788 %who always excludes executed names loaded through your configuration
789 file and things which are internal to IPython.
789 file and things which are internal to IPython.
790
790
791 This is deliberate, as typically you may load many modules and the
791 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.
792 purpose of %who is to show you only what you've manually defined.
793
793
794 Examples
794 Examples
795 --------
795 --------
796
796
797 Define two variables and list them with who::
797 Define two variables and list them with who::
798
798
799 In [1]: alpha = 123
799 In [1]: alpha = 123
800
800
801 In [2]: beta = 'test'
801 In [2]: beta = 'test'
802
802
803 In [3]: %who
803 In [3]: %who
804 alpha beta
804 alpha beta
805
805
806 In [4]: %who int
806 In [4]: %who int
807 alpha
807 alpha
808
808
809 In [5]: %who str
809 In [5]: %who str
810 beta
810 beta
811 """
811 """
812
812
813 varlist = self.magic_who_ls(parameter_s)
813 varlist = self.magic_who_ls(parameter_s)
814 if not varlist:
814 if not varlist:
815 if parameter_s:
815 if parameter_s:
816 print 'No variables match your requested type.'
816 print 'No variables match your requested type.'
817 else:
817 else:
818 print 'Interactive namespace is empty.'
818 print 'Interactive namespace is empty.'
819 return
819 return
820
820
821 # if we have variables, move on...
821 # if we have variables, move on...
822 count = 0
822 count = 0
823 for i in varlist:
823 for i in varlist:
824 print i+'\t',
824 print i+'\t',
825 count += 1
825 count += 1
826 if count > 8:
826 if count > 8:
827 count = 0
827 count = 0
828 print
828 print
829 print
829 print
830
830
831 @testdec.skip_doctest
831 @testdec.skip_doctest
832 def magic_whos(self, parameter_s=''):
832 def magic_whos(self, parameter_s=''):
833 """Like %who, but gives some extra information about each variable.
833 """Like %who, but gives some extra information about each variable.
834
834
835 The same type filtering of %who can be applied here.
835 The same type filtering of %who can be applied here.
836
836
837 For all variables, the type is printed. Additionally it prints:
837 For all variables, the type is printed. Additionally it prints:
838
838
839 - For {},[],(): their length.
839 - For {},[],(): their length.
840
840
841 - For numpy arrays, a summary with shape, number of
841 - For numpy arrays, a summary with shape, number of
842 elements, typecode and size in memory.
842 elements, typecode and size in memory.
843
843
844 - Everything else: a string representation, snipping their middle if
844 - Everything else: a string representation, snipping their middle if
845 too long.
845 too long.
846
846
847 Examples
847 Examples
848 --------
848 --------
849
849
850 Define two variables and list them with whos::
850 Define two variables and list them with whos::
851
851
852 In [1]: alpha = 123
852 In [1]: alpha = 123
853
853
854 In [2]: beta = 'test'
854 In [2]: beta = 'test'
855
855
856 In [3]: %whos
856 In [3]: %whos
857 Variable Type Data/Info
857 Variable Type Data/Info
858 --------------------------------
858 --------------------------------
859 alpha int 123
859 alpha int 123
860 beta str test
860 beta str test
861 """
861 """
862
862
863 varnames = self.magic_who_ls(parameter_s)
863 varnames = self.magic_who_ls(parameter_s)
864 if not varnames:
864 if not varnames:
865 if parameter_s:
865 if parameter_s:
866 print 'No variables match your requested type.'
866 print 'No variables match your requested type.'
867 else:
867 else:
868 print 'Interactive namespace is empty.'
868 print 'Interactive namespace is empty.'
869 return
869 return
870
870
871 # if we have variables, move on...
871 # if we have variables, move on...
872
872
873 # for these types, show len() instead of data:
873 # for these types, show len() instead of data:
874 seq_types = ['dict', 'list', 'tuple']
874 seq_types = ['dict', 'list', 'tuple']
875
875
876 # for numpy/Numeric arrays, display summary info
876 # for numpy/Numeric arrays, display summary info
877 try:
877 try:
878 import numpy
878 import numpy
879 except ImportError:
879 except ImportError:
880 ndarray_type = None
880 ndarray_type = None
881 else:
881 else:
882 ndarray_type = numpy.ndarray.__name__
882 ndarray_type = numpy.ndarray.__name__
883 try:
883 try:
884 import Numeric
884 import Numeric
885 except ImportError:
885 except ImportError:
886 array_type = None
886 array_type = None
887 else:
887 else:
888 array_type = Numeric.ArrayType.__name__
888 array_type = Numeric.ArrayType.__name__
889
889
890 # Find all variable names and types so we can figure out column sizes
890 # Find all variable names and types so we can figure out column sizes
891 def get_vars(i):
891 def get_vars(i):
892 return self.shell.user_ns[i]
892 return self.shell.user_ns[i]
893
893
894 # some types are well known and can be shorter
894 # some types are well known and can be shorter
895 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
895 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
896 def type_name(v):
896 def type_name(v):
897 tn = type(v).__name__
897 tn = type(v).__name__
898 return abbrevs.get(tn,tn)
898 return abbrevs.get(tn,tn)
899
899
900 varlist = map(get_vars,varnames)
900 varlist = map(get_vars,varnames)
901
901
902 typelist = []
902 typelist = []
903 for vv in varlist:
903 for vv in varlist:
904 tt = type_name(vv)
904 tt = type_name(vv)
905
905
906 if tt=='instance':
906 if tt=='instance':
907 typelist.append( abbrevs.get(str(vv.__class__),
907 typelist.append( abbrevs.get(str(vv.__class__),
908 str(vv.__class__)))
908 str(vv.__class__)))
909 else:
909 else:
910 typelist.append(tt)
910 typelist.append(tt)
911
911
912 # column labels and # of spaces as separator
912 # column labels and # of spaces as separator
913 varlabel = 'Variable'
913 varlabel = 'Variable'
914 typelabel = 'Type'
914 typelabel = 'Type'
915 datalabel = 'Data/Info'
915 datalabel = 'Data/Info'
916 colsep = 3
916 colsep = 3
917 # variable format strings
917 # variable format strings
918 vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)"
918 vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)"
919 vfmt_short = '$vstr[:25]<...>$vstr[-25:]'
919 vfmt_short = '$vstr[:25]<...>$vstr[-25:]'
920 aformat = "%s: %s elems, type `%s`, %s bytes"
920 aformat = "%s: %s elems, type `%s`, %s bytes"
921 # find the size of the columns to format the output nicely
921 # find the size of the columns to format the output nicely
922 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
922 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
923 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
923 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
924 # table header
924 # table header
925 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
925 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
926 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
926 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
927 # and the table itself
927 # and the table itself
928 kb = 1024
928 kb = 1024
929 Mb = 1048576 # kb**2
929 Mb = 1048576 # kb**2
930 for vname,var,vtype in zip(varnames,varlist,typelist):
930 for vname,var,vtype in zip(varnames,varlist,typelist):
931 print itpl(vformat),
931 print itpl(vformat),
932 if vtype in seq_types:
932 if vtype in seq_types:
933 print "n="+str(len(var))
933 print "n="+str(len(var))
934 elif vtype in [array_type,ndarray_type]:
934 elif vtype in [array_type,ndarray_type]:
935 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
935 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
936 if vtype==ndarray_type:
936 if vtype==ndarray_type:
937 # numpy
937 # numpy
938 vsize = var.size
938 vsize = var.size
939 vbytes = vsize*var.itemsize
939 vbytes = vsize*var.itemsize
940 vdtype = var.dtype
940 vdtype = var.dtype
941 else:
941 else:
942 # Numeric
942 # Numeric
943 vsize = Numeric.size(var)
943 vsize = Numeric.size(var)
944 vbytes = vsize*var.itemsize()
944 vbytes = vsize*var.itemsize()
945 vdtype = var.typecode()
945 vdtype = var.typecode()
946
946
947 if vbytes < 100000:
947 if vbytes < 100000:
948 print aformat % (vshape,vsize,vdtype,vbytes)
948 print aformat % (vshape,vsize,vdtype,vbytes)
949 else:
949 else:
950 print aformat % (vshape,vsize,vdtype,vbytes),
950 print aformat % (vshape,vsize,vdtype,vbytes),
951 if vbytes < Mb:
951 if vbytes < Mb:
952 print '(%s kb)' % (vbytes/kb,)
952 print '(%s kb)' % (vbytes/kb,)
953 else:
953 else:
954 print '(%s Mb)' % (vbytes/Mb,)
954 print '(%s Mb)' % (vbytes/Mb,)
955 else:
955 else:
956 try:
956 try:
957 vstr = str(var)
957 vstr = str(var)
958 except UnicodeEncodeError:
958 except UnicodeEncodeError:
959 vstr = unicode(var).encode(sys.getdefaultencoding(),
959 vstr = unicode(var).encode(sys.getdefaultencoding(),
960 'backslashreplace')
960 'backslashreplace')
961 vstr = vstr.replace('\n','\\n')
961 vstr = vstr.replace('\n','\\n')
962 if len(vstr) < 50:
962 if len(vstr) < 50:
963 print vstr
963 print vstr
964 else:
964 else:
965 printpl(vfmt_short)
965 printpl(vfmt_short)
966
966
967 def magic_reset(self, parameter_s=''):
967 def magic_reset(self, parameter_s=''):
968 """Resets the namespace by removing all names defined by the user.
968 """Resets the namespace by removing all names defined by the user.
969
969
970 Parameters
970 Parameters
971 ----------
971 ----------
972 -f : force reset without asking for confirmation.
972 -f : force reset without asking for confirmation.
973
973
974 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
974 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
975 References to objects may be kept. By default (without this option),
975 References to objects may be kept. By default (without this option),
976 we do a 'hard' reset, giving you a new session and removing all
976 we do a 'hard' reset, giving you a new session and removing all
977 references to objects from the current session.
977 references to objects from the current session.
978
978
979 Examples
979 Examples
980 --------
980 --------
981 In [6]: a = 1
981 In [6]: a = 1
982
982
983 In [7]: a
983 In [7]: a
984 Out[7]: 1
984 Out[7]: 1
985
985
986 In [8]: 'a' in _ip.user_ns
986 In [8]: 'a' in _ip.user_ns
987 Out[8]: True
987 Out[8]: True
988
988
989 In [9]: %reset -f
989 In [9]: %reset -f
990
990
991 In [1]: 'a' in _ip.user_ns
991 In [1]: 'a' in _ip.user_ns
992 Out[1]: False
992 Out[1]: False
993 """
993 """
994 opts, args = self.parse_options(parameter_s,'sh')
994 opts, args = self.parse_options(parameter_s,'sf')
995 if 'f' in opts:
995 if 'f' in opts:
996 ans = True
996 ans = True
997 else:
997 else:
998 ans = self.shell.ask_yes_no(
998 ans = self.shell.ask_yes_no(
999 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
999 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1000 if not ans:
1000 if not ans:
1001 print 'Nothing done.'
1001 print 'Nothing done.'
1002 return
1002 return
1003
1003
1004 if 's' in opts: # Soft reset
1004 if 's' in opts: # Soft reset
1005 user_ns = self.shell.user_ns
1005 user_ns = self.shell.user_ns
1006 for i in self.magic_who_ls():
1006 for i in self.magic_who_ls():
1007 del(user_ns[i])
1007 del(user_ns[i])
1008
1008
1009 else: # Hard reset
1009 else: # Hard reset
1010 self.shell.reset(new_session = True)
1010 self.shell.reset(new_session = True)
1011
1011
1012
1012
1013
1013
1014 def magic_reset_selective(self, parameter_s=''):
1014 def magic_reset_selective(self, parameter_s=''):
1015 """Resets the namespace by removing names defined by the user.
1015 """Resets the namespace by removing names defined by the user.
1016
1016
1017 Input/Output history are left around in case you need them.
1017 Input/Output history are left around in case you need them.
1018
1018
1019 %reset_selective [-f] regex
1019 %reset_selective [-f] regex
1020
1020
1021 No action is taken if regex is not included
1021 No action is taken if regex is not included
1022
1022
1023 Options
1023 Options
1024 -f : force reset without asking for confirmation.
1024 -f : force reset without asking for confirmation.
1025
1025
1026 Examples
1026 Examples
1027 --------
1027 --------
1028
1028
1029 We first fully reset the namespace so your output looks identical to
1029 We first fully reset the namespace so your output looks identical to
1030 this example for pedagogical reasons; in practice you do not need a
1030 this example for pedagogical reasons; in practice you do not need a
1031 full reset.
1031 full reset.
1032
1032
1033 In [1]: %reset -f
1033 In [1]: %reset -f
1034
1034
1035 Now, with a clean namespace we can make a few variables and use
1035 Now, with a clean namespace we can make a few variables and use
1036 %reset_selective to only delete names that match our regexp:
1036 %reset_selective to only delete names that match our regexp:
1037
1037
1038 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1038 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1039
1039
1040 In [3]: who_ls
1040 In [3]: who_ls
1041 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1041 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1042
1042
1043 In [4]: %reset_selective -f b[2-3]m
1043 In [4]: %reset_selective -f b[2-3]m
1044
1044
1045 In [5]: who_ls
1045 In [5]: who_ls
1046 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1046 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1047
1047
1048 In [6]: %reset_selective -f d
1048 In [6]: %reset_selective -f d
1049
1049
1050 In [7]: who_ls
1050 In [7]: who_ls
1051 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1051 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1052
1052
1053 In [8]: %reset_selective -f c
1053 In [8]: %reset_selective -f c
1054
1054
1055 In [9]: who_ls
1055 In [9]: who_ls
1056 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1056 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1057
1057
1058 In [10]: %reset_selective -f b
1058 In [10]: %reset_selective -f b
1059
1059
1060 In [11]: who_ls
1060 In [11]: who_ls
1061 Out[11]: ['a']
1061 Out[11]: ['a']
1062 """
1062 """
1063
1063
1064 opts, regex = self.parse_options(parameter_s,'f')
1064 opts, regex = self.parse_options(parameter_s,'f')
1065
1065
1066 if opts.has_key('f'):
1066 if opts.has_key('f'):
1067 ans = True
1067 ans = True
1068 else:
1068 else:
1069 ans = self.shell.ask_yes_no(
1069 ans = self.shell.ask_yes_no(
1070 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1070 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1071 if not ans:
1071 if not ans:
1072 print 'Nothing done.'
1072 print 'Nothing done.'
1073 return
1073 return
1074 user_ns = self.shell.user_ns
1074 user_ns = self.shell.user_ns
1075 if not regex:
1075 if not regex:
1076 print 'No regex pattern specified. Nothing done.'
1076 print 'No regex pattern specified. Nothing done.'
1077 return
1077 return
1078 else:
1078 else:
1079 try:
1079 try:
1080 m = re.compile(regex)
1080 m = re.compile(regex)
1081 except TypeError:
1081 except TypeError:
1082 raise TypeError('regex must be a string or compiled pattern')
1082 raise TypeError('regex must be a string or compiled pattern')
1083 for i in self.magic_who_ls():
1083 for i in self.magic_who_ls():
1084 if m.search(i):
1084 if m.search(i):
1085 del(user_ns[i])
1085 del(user_ns[i])
1086
1086
1087 def magic_logstart(self,parameter_s=''):
1087 def magic_logstart(self,parameter_s=''):
1088 """Start logging anywhere in a session.
1088 """Start logging anywhere in a session.
1089
1089
1090 %logstart [-o|-r|-t] [log_name [log_mode]]
1090 %logstart [-o|-r|-t] [log_name [log_mode]]
1091
1091
1092 If no name is given, it defaults to a file named 'ipython_log.py' in your
1092 If no name is given, it defaults to a file named 'ipython_log.py' in your
1093 current directory, in 'rotate' mode (see below).
1093 current directory, in 'rotate' mode (see below).
1094
1094
1095 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1095 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1096 history up to that point and then continues logging.
1096 history up to that point and then continues logging.
1097
1097
1098 %logstart takes a second optional parameter: logging mode. This can be one
1098 %logstart takes a second optional parameter: logging mode. This can be one
1099 of (note that the modes are given unquoted):\\
1099 of (note that the modes are given unquoted):\\
1100 append: well, that says it.\\
1100 append: well, that says it.\\
1101 backup: rename (if exists) to name~ and start name.\\
1101 backup: rename (if exists) to name~ and start name.\\
1102 global: single logfile in your home dir, appended to.\\
1102 global: single logfile in your home dir, appended to.\\
1103 over : overwrite existing log.\\
1103 over : overwrite existing log.\\
1104 rotate: create rotating logs name.1~, name.2~, etc.
1104 rotate: create rotating logs name.1~, name.2~, etc.
1105
1105
1106 Options:
1106 Options:
1107
1107
1108 -o: log also IPython's output. In this mode, all commands which
1108 -o: log also IPython's output. In this mode, all commands which
1109 generate an Out[NN] prompt are recorded to the logfile, right after
1109 generate an Out[NN] prompt are recorded to the logfile, right after
1110 their corresponding input line. The output lines are always
1110 their corresponding input line. The output lines are always
1111 prepended with a '#[Out]# ' marker, so that the log remains valid
1111 prepended with a '#[Out]# ' marker, so that the log remains valid
1112 Python code.
1112 Python code.
1113
1113
1114 Since this marker is always the same, filtering only the output from
1114 Since this marker is always the same, filtering only the output from
1115 a log is very easy, using for example a simple awk call:
1115 a log is very easy, using for example a simple awk call:
1116
1116
1117 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1117 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1118
1118
1119 -r: log 'raw' input. Normally, IPython's logs contain the processed
1119 -r: log 'raw' input. Normally, IPython's logs contain the processed
1120 input, so that user lines are logged in their final form, converted
1120 input, so that user lines are logged in their final form, converted
1121 into valid Python. For example, %Exit is logged as
1121 into valid Python. For example, %Exit is logged as
1122 '_ip.magic("Exit"). If the -r flag is given, all input is logged
1122 '_ip.magic("Exit"). If the -r flag is given, all input is logged
1123 exactly as typed, with no transformations applied.
1123 exactly as typed, with no transformations applied.
1124
1124
1125 -t: put timestamps before each input line logged (these are put in
1125 -t: put timestamps before each input line logged (these are put in
1126 comments)."""
1126 comments)."""
1127
1127
1128 opts,par = self.parse_options(parameter_s,'ort')
1128 opts,par = self.parse_options(parameter_s,'ort')
1129 log_output = 'o' in opts
1129 log_output = 'o' in opts
1130 log_raw_input = 'r' in opts
1130 log_raw_input = 'r' in opts
1131 timestamp = 't' in opts
1131 timestamp = 't' in opts
1132
1132
1133 logger = self.shell.logger
1133 logger = self.shell.logger
1134
1134
1135 # if no args are given, the defaults set in the logger constructor by
1135 # if no args are given, the defaults set in the logger constructor by
1136 # ipytohn remain valid
1136 # ipytohn remain valid
1137 if par:
1137 if par:
1138 try:
1138 try:
1139 logfname,logmode = par.split()
1139 logfname,logmode = par.split()
1140 except:
1140 except:
1141 logfname = par
1141 logfname = par
1142 logmode = 'backup'
1142 logmode = 'backup'
1143 else:
1143 else:
1144 logfname = logger.logfname
1144 logfname = logger.logfname
1145 logmode = logger.logmode
1145 logmode = logger.logmode
1146 # put logfname into rc struct as if it had been called on the command
1146 # put logfname into rc struct as if it had been called on the command
1147 # line, so it ends up saved in the log header Save it in case we need
1147 # line, so it ends up saved in the log header Save it in case we need
1148 # to restore it...
1148 # to restore it...
1149 old_logfile = self.shell.logfile
1149 old_logfile = self.shell.logfile
1150 if logfname:
1150 if logfname:
1151 logfname = os.path.expanduser(logfname)
1151 logfname = os.path.expanduser(logfname)
1152 self.shell.logfile = logfname
1152 self.shell.logfile = logfname
1153
1153
1154 loghead = '# IPython log file\n\n'
1154 loghead = '# IPython log file\n\n'
1155 try:
1155 try:
1156 started = logger.logstart(logfname,loghead,logmode,
1156 started = logger.logstart(logfname,loghead,logmode,
1157 log_output,timestamp,log_raw_input)
1157 log_output,timestamp,log_raw_input)
1158 except:
1158 except:
1159 self.shell.logfile = old_logfile
1159 self.shell.logfile = old_logfile
1160 warn("Couldn't start log: %s" % sys.exc_info()[1])
1160 warn("Couldn't start log: %s" % sys.exc_info()[1])
1161 else:
1161 else:
1162 # log input history up to this point, optionally interleaving
1162 # log input history up to this point, optionally interleaving
1163 # output if requested
1163 # output if requested
1164
1164
1165 if timestamp:
1165 if timestamp:
1166 # disable timestamping for the previous history, since we've
1166 # disable timestamping for the previous history, since we've
1167 # lost those already (no time machine here).
1167 # lost those already (no time machine here).
1168 logger.timestamp = False
1168 logger.timestamp = False
1169
1169
1170 if log_raw_input:
1170 if log_raw_input:
1171 input_hist = self.shell.history_manager.input_hist_raw
1171 input_hist = self.shell.history_manager.input_hist_raw
1172 else:
1172 else:
1173 input_hist = self.shell.history_manager.input_hist_parsed
1173 input_hist = self.shell.history_manager.input_hist_parsed
1174
1174
1175 if log_output:
1175 if log_output:
1176 log_write = logger.log_write
1176 log_write = logger.log_write
1177 output_hist = self.shell.history_manager.output_hist
1177 output_hist = self.shell.history_manager.output_hist
1178 for n in range(1,len(input_hist)-1):
1178 for n in range(1,len(input_hist)-1):
1179 log_write(input_hist[n].rstrip())
1179 log_write(input_hist[n].rstrip())
1180 if n in output_hist:
1180 if n in output_hist:
1181 log_write(repr(output_hist[n]),'output')
1181 log_write(repr(output_hist[n]),'output')
1182 else:
1182 else:
1183 logger.log_write(''.join(input_hist[1:]))
1183 logger.log_write(''.join(input_hist[1:]))
1184 if timestamp:
1184 if timestamp:
1185 # re-enable timestamping
1185 # re-enable timestamping
1186 logger.timestamp = True
1186 logger.timestamp = True
1187
1187
1188 print ('Activating auto-logging. '
1188 print ('Activating auto-logging. '
1189 'Current session state plus future input saved.')
1189 'Current session state plus future input saved.')
1190 logger.logstate()
1190 logger.logstate()
1191
1191
1192 def magic_logstop(self,parameter_s=''):
1192 def magic_logstop(self,parameter_s=''):
1193 """Fully stop logging and close log file.
1193 """Fully stop logging and close log file.
1194
1194
1195 In order to start logging again, a new %logstart call needs to be made,
1195 In order to start logging again, a new %logstart call needs to be made,
1196 possibly (though not necessarily) with a new filename, mode and other
1196 possibly (though not necessarily) with a new filename, mode and other
1197 options."""
1197 options."""
1198 self.logger.logstop()
1198 self.logger.logstop()
1199
1199
1200 def magic_logoff(self,parameter_s=''):
1200 def magic_logoff(self,parameter_s=''):
1201 """Temporarily stop logging.
1201 """Temporarily stop logging.
1202
1202
1203 You must have previously started logging."""
1203 You must have previously started logging."""
1204 self.shell.logger.switch_log(0)
1204 self.shell.logger.switch_log(0)
1205
1205
1206 def magic_logon(self,parameter_s=''):
1206 def magic_logon(self,parameter_s=''):
1207 """Restart logging.
1207 """Restart logging.
1208
1208
1209 This function is for restarting logging which you've temporarily
1209 This function is for restarting logging which you've temporarily
1210 stopped with %logoff. For starting logging for the first time, you
1210 stopped with %logoff. For starting logging for the first time, you
1211 must use the %logstart function, which allows you to specify an
1211 must use the %logstart function, which allows you to specify an
1212 optional log filename."""
1212 optional log filename."""
1213
1213
1214 self.shell.logger.switch_log(1)
1214 self.shell.logger.switch_log(1)
1215
1215
1216 def magic_logstate(self,parameter_s=''):
1216 def magic_logstate(self,parameter_s=''):
1217 """Print the status of the logging system."""
1217 """Print the status of the logging system."""
1218
1218
1219 self.shell.logger.logstate()
1219 self.shell.logger.logstate()
1220
1220
1221 def magic_pdb(self, parameter_s=''):
1221 def magic_pdb(self, parameter_s=''):
1222 """Control the automatic calling of the pdb interactive debugger.
1222 """Control the automatic calling of the pdb interactive debugger.
1223
1223
1224 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1224 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1225 argument it works as a toggle.
1225 argument it works as a toggle.
1226
1226
1227 When an exception is triggered, IPython can optionally call the
1227 When an exception is triggered, IPython can optionally call the
1228 interactive pdb debugger after the traceback printout. %pdb toggles
1228 interactive pdb debugger after the traceback printout. %pdb toggles
1229 this feature on and off.
1229 this feature on and off.
1230
1230
1231 The initial state of this feature is set in your ipythonrc
1231 The initial state of this feature is set in your ipythonrc
1232 configuration file (the variable is called 'pdb').
1232 configuration file (the variable is called 'pdb').
1233
1233
1234 If you want to just activate the debugger AFTER an exception has fired,
1234 If you want to just activate the debugger AFTER an exception has fired,
1235 without having to type '%pdb on' and rerunning your code, you can use
1235 without having to type '%pdb on' and rerunning your code, you can use
1236 the %debug magic."""
1236 the %debug magic."""
1237
1237
1238 par = parameter_s.strip().lower()
1238 par = parameter_s.strip().lower()
1239
1239
1240 if par:
1240 if par:
1241 try:
1241 try:
1242 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1242 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1243 except KeyError:
1243 except KeyError:
1244 print ('Incorrect argument. Use on/1, off/0, '
1244 print ('Incorrect argument. Use on/1, off/0, '
1245 'or nothing for a toggle.')
1245 'or nothing for a toggle.')
1246 return
1246 return
1247 else:
1247 else:
1248 # toggle
1248 # toggle
1249 new_pdb = not self.shell.call_pdb
1249 new_pdb = not self.shell.call_pdb
1250
1250
1251 # set on the shell
1251 # set on the shell
1252 self.shell.call_pdb = new_pdb
1252 self.shell.call_pdb = new_pdb
1253 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1253 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1254
1254
1255 def magic_debug(self, parameter_s=''):
1255 def magic_debug(self, parameter_s=''):
1256 """Activate the interactive debugger in post-mortem mode.
1256 """Activate the interactive debugger in post-mortem mode.
1257
1257
1258 If an exception has just occurred, this lets you inspect its stack
1258 If an exception has just occurred, this lets you inspect its stack
1259 frames interactively. Note that this will always work only on the last
1259 frames interactively. Note that this will always work only on the last
1260 traceback that occurred, so you must call this quickly after an
1260 traceback that occurred, so you must call this quickly after an
1261 exception that you wish to inspect has fired, because if another one
1261 exception that you wish to inspect has fired, because if another one
1262 occurs, it clobbers the previous one.
1262 occurs, it clobbers the previous one.
1263
1263
1264 If you want IPython to automatically do this on every exception, see
1264 If you want IPython to automatically do this on every exception, see
1265 the %pdb magic for more details.
1265 the %pdb magic for more details.
1266 """
1266 """
1267 self.shell.debugger(force=True)
1267 self.shell.debugger(force=True)
1268
1268
1269 @testdec.skip_doctest
1269 @testdec.skip_doctest
1270 def magic_prun(self, parameter_s ='',user_mode=1,
1270 def magic_prun(self, parameter_s ='',user_mode=1,
1271 opts=None,arg_lst=None,prog_ns=None):
1271 opts=None,arg_lst=None,prog_ns=None):
1272
1272
1273 """Run a statement through the python code profiler.
1273 """Run a statement through the python code profiler.
1274
1274
1275 Usage:
1275 Usage:
1276 %prun [options] statement
1276 %prun [options] statement
1277
1277
1278 The given statement (which doesn't require quote marks) is run via the
1278 The given statement (which doesn't require quote marks) is run via the
1279 python profiler in a manner similar to the profile.run() function.
1279 python profiler in a manner similar to the profile.run() function.
1280 Namespaces are internally managed to work correctly; profile.run
1280 Namespaces are internally managed to work correctly; profile.run
1281 cannot be used in IPython because it makes certain assumptions about
1281 cannot be used in IPython because it makes certain assumptions about
1282 namespaces which do not hold under IPython.
1282 namespaces which do not hold under IPython.
1283
1283
1284 Options:
1284 Options:
1285
1285
1286 -l <limit>: you can place restrictions on what or how much of the
1286 -l <limit>: you can place restrictions on what or how much of the
1287 profile gets printed. The limit value can be:
1287 profile gets printed. The limit value can be:
1288
1288
1289 * A string: only information for function names containing this string
1289 * A string: only information for function names containing this string
1290 is printed.
1290 is printed.
1291
1291
1292 * An integer: only these many lines are printed.
1292 * An integer: only these many lines are printed.
1293
1293
1294 * A float (between 0 and 1): this fraction of the report is printed
1294 * A float (between 0 and 1): this fraction of the report is printed
1295 (for example, use a limit of 0.4 to see the topmost 40% only).
1295 (for example, use a limit of 0.4 to see the topmost 40% only).
1296
1296
1297 You can combine several limits with repeated use of the option. For
1297 You can combine several limits with repeated use of the option. For
1298 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1298 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1299 information about class constructors.
1299 information about class constructors.
1300
1300
1301 -r: return the pstats.Stats object generated by the profiling. This
1301 -r: return the pstats.Stats object generated by the profiling. This
1302 object has all the information about the profile in it, and you can
1302 object has all the information about the profile in it, and you can
1303 later use it for further analysis or in other functions.
1303 later use it for further analysis or in other functions.
1304
1304
1305 -s <key>: sort profile by given key. You can provide more than one key
1305 -s <key>: sort profile by given key. You can provide more than one key
1306 by using the option several times: '-s key1 -s key2 -s key3...'. The
1306 by using the option several times: '-s key1 -s key2 -s key3...'. The
1307 default sorting key is 'time'.
1307 default sorting key is 'time'.
1308
1308
1309 The following is copied verbatim from the profile documentation
1309 The following is copied verbatim from the profile documentation
1310 referenced below:
1310 referenced below:
1311
1311
1312 When more than one key is provided, additional keys are used as
1312 When more than one key is provided, additional keys are used as
1313 secondary criteria when the there is equality in all keys selected
1313 secondary criteria when the there is equality in all keys selected
1314 before them.
1314 before them.
1315
1315
1316 Abbreviations can be used for any key names, as long as the
1316 Abbreviations can be used for any key names, as long as the
1317 abbreviation is unambiguous. The following are the keys currently
1317 abbreviation is unambiguous. The following are the keys currently
1318 defined:
1318 defined:
1319
1319
1320 Valid Arg Meaning
1320 Valid Arg Meaning
1321 "calls" call count
1321 "calls" call count
1322 "cumulative" cumulative time
1322 "cumulative" cumulative time
1323 "file" file name
1323 "file" file name
1324 "module" file name
1324 "module" file name
1325 "pcalls" primitive call count
1325 "pcalls" primitive call count
1326 "line" line number
1326 "line" line number
1327 "name" function name
1327 "name" function name
1328 "nfl" name/file/line
1328 "nfl" name/file/line
1329 "stdname" standard name
1329 "stdname" standard name
1330 "time" internal time
1330 "time" internal time
1331
1331
1332 Note that all sorts on statistics are in descending order (placing
1332 Note that all sorts on statistics are in descending order (placing
1333 most time consuming items first), where as name, file, and line number
1333 most time consuming items first), where as name, file, and line number
1334 searches are in ascending order (i.e., alphabetical). The subtle
1334 searches are in ascending order (i.e., alphabetical). The subtle
1335 distinction between "nfl" and "stdname" is that the standard name is a
1335 distinction between "nfl" and "stdname" is that the standard name is a
1336 sort of the name as printed, which means that the embedded line
1336 sort of the name as printed, which means that the embedded line
1337 numbers get compared in an odd way. For example, lines 3, 20, and 40
1337 numbers get compared in an odd way. For example, lines 3, 20, and 40
1338 would (if the file names were the same) appear in the string order
1338 would (if the file names were the same) appear in the string order
1339 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1339 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1340 line numbers. In fact, sort_stats("nfl") is the same as
1340 line numbers. In fact, sort_stats("nfl") is the same as
1341 sort_stats("name", "file", "line").
1341 sort_stats("name", "file", "line").
1342
1342
1343 -T <filename>: save profile results as shown on screen to a text
1343 -T <filename>: save profile results as shown on screen to a text
1344 file. The profile is still shown on screen.
1344 file. The profile is still shown on screen.
1345
1345
1346 -D <filename>: save (via dump_stats) profile statistics to given
1346 -D <filename>: save (via dump_stats) profile statistics to given
1347 filename. This data is in a format understod by the pstats module, and
1347 filename. This data is in a format understod by the pstats module, and
1348 is generated by a call to the dump_stats() method of profile
1348 is generated by a call to the dump_stats() method of profile
1349 objects. The profile is still shown on screen.
1349 objects. The profile is still shown on screen.
1350
1350
1351 If you want to run complete programs under the profiler's control, use
1351 If you want to run complete programs under the profiler's control, use
1352 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1352 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1353 contains profiler specific options as described here.
1353 contains profiler specific options as described here.
1354
1354
1355 You can read the complete documentation for the profile module with::
1355 You can read the complete documentation for the profile module with::
1356
1356
1357 In [1]: import profile; profile.help()
1357 In [1]: import profile; profile.help()
1358 """
1358 """
1359
1359
1360 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1360 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1361 # protect user quote marks
1361 # protect user quote marks
1362 parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
1362 parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
1363
1363
1364 if user_mode: # regular user call
1364 if user_mode: # regular user call
1365 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
1365 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
1366 list_all=1)
1366 list_all=1)
1367 namespace = self.shell.user_ns
1367 namespace = self.shell.user_ns
1368 else: # called to run a program by %run -p
1368 else: # called to run a program by %run -p
1369 try:
1369 try:
1370 filename = get_py_filename(arg_lst[0])
1370 filename = get_py_filename(arg_lst[0])
1371 except IOError,msg:
1371 except IOError,msg:
1372 error(msg)
1372 error(msg)
1373 return
1373 return
1374
1374
1375 arg_str = 'execfile(filename,prog_ns)'
1375 arg_str = 'execfile(filename,prog_ns)'
1376 namespace = locals()
1376 namespace = locals()
1377
1377
1378 opts.merge(opts_def)
1378 opts.merge(opts_def)
1379
1379
1380 prof = profile.Profile()
1380 prof = profile.Profile()
1381 try:
1381 try:
1382 prof = prof.runctx(arg_str,namespace,namespace)
1382 prof = prof.runctx(arg_str,namespace,namespace)
1383 sys_exit = ''
1383 sys_exit = ''
1384 except SystemExit:
1384 except SystemExit:
1385 sys_exit = """*** SystemExit exception caught in code being profiled."""
1385 sys_exit = """*** SystemExit exception caught in code being profiled."""
1386
1386
1387 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1387 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1388
1388
1389 lims = opts.l
1389 lims = opts.l
1390 if lims:
1390 if lims:
1391 lims = [] # rebuild lims with ints/floats/strings
1391 lims = [] # rebuild lims with ints/floats/strings
1392 for lim in opts.l:
1392 for lim in opts.l:
1393 try:
1393 try:
1394 lims.append(int(lim))
1394 lims.append(int(lim))
1395 except ValueError:
1395 except ValueError:
1396 try:
1396 try:
1397 lims.append(float(lim))
1397 lims.append(float(lim))
1398 except ValueError:
1398 except ValueError:
1399 lims.append(lim)
1399 lims.append(lim)
1400
1400
1401 # Trap output.
1401 # Trap output.
1402 stdout_trap = StringIO()
1402 stdout_trap = StringIO()
1403
1403
1404 if hasattr(stats,'stream'):
1404 if hasattr(stats,'stream'):
1405 # In newer versions of python, the stats object has a 'stream'
1405 # In newer versions of python, the stats object has a 'stream'
1406 # attribute to write into.
1406 # attribute to write into.
1407 stats.stream = stdout_trap
1407 stats.stream = stdout_trap
1408 stats.print_stats(*lims)
1408 stats.print_stats(*lims)
1409 else:
1409 else:
1410 # For older versions, we manually redirect stdout during printing
1410 # For older versions, we manually redirect stdout during printing
1411 sys_stdout = sys.stdout
1411 sys_stdout = sys.stdout
1412 try:
1412 try:
1413 sys.stdout = stdout_trap
1413 sys.stdout = stdout_trap
1414 stats.print_stats(*lims)
1414 stats.print_stats(*lims)
1415 finally:
1415 finally:
1416 sys.stdout = sys_stdout
1416 sys.stdout = sys_stdout
1417
1417
1418 output = stdout_trap.getvalue()
1418 output = stdout_trap.getvalue()
1419 output = output.rstrip()
1419 output = output.rstrip()
1420
1420
1421 page.page(output)
1421 page.page(output)
1422 print sys_exit,
1422 print sys_exit,
1423
1423
1424 dump_file = opts.D[0]
1424 dump_file = opts.D[0]
1425 text_file = opts.T[0]
1425 text_file = opts.T[0]
1426 if dump_file:
1426 if dump_file:
1427 prof.dump_stats(dump_file)
1427 prof.dump_stats(dump_file)
1428 print '\n*** Profile stats marshalled to file',\
1428 print '\n*** Profile stats marshalled to file',\
1429 `dump_file`+'.',sys_exit
1429 `dump_file`+'.',sys_exit
1430 if text_file:
1430 if text_file:
1431 pfile = file(text_file,'w')
1431 pfile = file(text_file,'w')
1432 pfile.write(output)
1432 pfile.write(output)
1433 pfile.close()
1433 pfile.close()
1434 print '\n*** Profile printout saved to text file',\
1434 print '\n*** Profile printout saved to text file',\
1435 `text_file`+'.',sys_exit
1435 `text_file`+'.',sys_exit
1436
1436
1437 if opts.has_key('r'):
1437 if opts.has_key('r'):
1438 return stats
1438 return stats
1439 else:
1439 else:
1440 return None
1440 return None
1441
1441
1442 @testdec.skip_doctest
1442 @testdec.skip_doctest
1443 def magic_run(self, parameter_s ='',runner=None,
1443 def magic_run(self, parameter_s ='',runner=None,
1444 file_finder=get_py_filename):
1444 file_finder=get_py_filename):
1445 """Run the named file inside IPython as a program.
1445 """Run the named file inside IPython as a program.
1446
1446
1447 Usage:\\
1447 Usage:\\
1448 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1448 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1449
1449
1450 Parameters after the filename are passed as command-line arguments to
1450 Parameters after the filename are passed as command-line arguments to
1451 the program (put in sys.argv). Then, control returns to IPython's
1451 the program (put in sys.argv). Then, control returns to IPython's
1452 prompt.
1452 prompt.
1453
1453
1454 This is similar to running at a system prompt:\\
1454 This is similar to running at a system prompt:\\
1455 $ python file args\\
1455 $ python file args\\
1456 but with the advantage of giving you IPython's tracebacks, and of
1456 but with the advantage of giving you IPython's tracebacks, and of
1457 loading all variables into your interactive namespace for further use
1457 loading all variables into your interactive namespace for further use
1458 (unless -p is used, see below).
1458 (unless -p is used, see below).
1459
1459
1460 The file is executed in a namespace initially consisting only of
1460 The file is executed in a namespace initially consisting only of
1461 __name__=='__main__' and sys.argv constructed as indicated. It thus
1461 __name__=='__main__' and sys.argv constructed as indicated. It thus
1462 sees its environment as if it were being run as a stand-alone program
1462 sees its environment as if it were being run as a stand-alone program
1463 (except for sharing global objects such as previously imported
1463 (except for sharing global objects such as previously imported
1464 modules). But after execution, the IPython interactive namespace gets
1464 modules). But after execution, the IPython interactive namespace gets
1465 updated with all variables defined in the program (except for __name__
1465 updated with all variables defined in the program (except for __name__
1466 and sys.argv). This allows for very convenient loading of code for
1466 and sys.argv). This allows for very convenient loading of code for
1467 interactive work, while giving each program a 'clean sheet' to run in.
1467 interactive work, while giving each program a 'clean sheet' to run in.
1468
1468
1469 Options:
1469 Options:
1470
1470
1471 -n: __name__ is NOT set to '__main__', but to the running file's name
1471 -n: __name__ is NOT set to '__main__', but to the running file's name
1472 without extension (as python does under import). This allows running
1472 without extension (as python does under import). This allows running
1473 scripts and reloading the definitions in them without calling code
1473 scripts and reloading the definitions in them without calling code
1474 protected by an ' if __name__ == "__main__" ' clause.
1474 protected by an ' if __name__ == "__main__" ' clause.
1475
1475
1476 -i: run the file in IPython's namespace instead of an empty one. This
1476 -i: run the file in IPython's namespace instead of an empty one. This
1477 is useful if you are experimenting with code written in a text editor
1477 is useful if you are experimenting with code written in a text editor
1478 which depends on variables defined interactively.
1478 which depends on variables defined interactively.
1479
1479
1480 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1480 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1481 being run. This is particularly useful if IPython is being used to
1481 being run. This is particularly useful if IPython is being used to
1482 run unittests, which always exit with a sys.exit() call. In such
1482 run unittests, which always exit with a sys.exit() call. In such
1483 cases you are interested in the output of the test results, not in
1483 cases you are interested in the output of the test results, not in
1484 seeing a traceback of the unittest module.
1484 seeing a traceback of the unittest module.
1485
1485
1486 -t: print timing information at the end of the run. IPython will give
1486 -t: print timing information at the end of the run. IPython will give
1487 you an estimated CPU time consumption for your script, which under
1487 you an estimated CPU time consumption for your script, which under
1488 Unix uses the resource module to avoid the wraparound problems of
1488 Unix uses the resource module to avoid the wraparound problems of
1489 time.clock(). Under Unix, an estimate of time spent on system tasks
1489 time.clock(). Under Unix, an estimate of time spent on system tasks
1490 is also given (for Windows platforms this is reported as 0.0).
1490 is also given (for Windows platforms this is reported as 0.0).
1491
1491
1492 If -t is given, an additional -N<N> option can be given, where <N>
1492 If -t is given, an additional -N<N> option can be given, where <N>
1493 must be an integer indicating how many times you want the script to
1493 must be an integer indicating how many times you want the script to
1494 run. The final timing report will include total and per run results.
1494 run. The final timing report will include total and per run results.
1495
1495
1496 For example (testing the script uniq_stable.py):
1496 For example (testing the script uniq_stable.py):
1497
1497
1498 In [1]: run -t uniq_stable
1498 In [1]: run -t uniq_stable
1499
1499
1500 IPython CPU timings (estimated):\\
1500 IPython CPU timings (estimated):\\
1501 User : 0.19597 s.\\
1501 User : 0.19597 s.\\
1502 System: 0.0 s.\\
1502 System: 0.0 s.\\
1503
1503
1504 In [2]: run -t -N5 uniq_stable
1504 In [2]: run -t -N5 uniq_stable
1505
1505
1506 IPython CPU timings (estimated):\\
1506 IPython CPU timings (estimated):\\
1507 Total runs performed: 5\\
1507 Total runs performed: 5\\
1508 Times : Total Per run\\
1508 Times : Total Per run\\
1509 User : 0.910862 s, 0.1821724 s.\\
1509 User : 0.910862 s, 0.1821724 s.\\
1510 System: 0.0 s, 0.0 s.
1510 System: 0.0 s, 0.0 s.
1511
1511
1512 -d: run your program under the control of pdb, the Python debugger.
1512 -d: run your program under the control of pdb, the Python debugger.
1513 This allows you to execute your program step by step, watch variables,
1513 This allows you to execute your program step by step, watch variables,
1514 etc. Internally, what IPython does is similar to calling:
1514 etc. Internally, what IPython does is similar to calling:
1515
1515
1516 pdb.run('execfile("YOURFILENAME")')
1516 pdb.run('execfile("YOURFILENAME")')
1517
1517
1518 with a breakpoint set on line 1 of your file. You can change the line
1518 with a breakpoint set on line 1 of your file. You can change the line
1519 number for this automatic breakpoint to be <N> by using the -bN option
1519 number for this automatic breakpoint to be <N> by using the -bN option
1520 (where N must be an integer). For example:
1520 (where N must be an integer). For example:
1521
1521
1522 %run -d -b40 myscript
1522 %run -d -b40 myscript
1523
1523
1524 will set the first breakpoint at line 40 in myscript.py. Note that
1524 will set the first breakpoint at line 40 in myscript.py. Note that
1525 the first breakpoint must be set on a line which actually does
1525 the first breakpoint must be set on a line which actually does
1526 something (not a comment or docstring) for it to stop execution.
1526 something (not a comment or docstring) for it to stop execution.
1527
1527
1528 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1528 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1529 first enter 'c' (without qoutes) to start execution up to the first
1529 first enter 'c' (without qoutes) to start execution up to the first
1530 breakpoint.
1530 breakpoint.
1531
1531
1532 Entering 'help' gives information about the use of the debugger. You
1532 Entering 'help' gives information about the use of the debugger. You
1533 can easily see pdb's full documentation with "import pdb;pdb.help()"
1533 can easily see pdb's full documentation with "import pdb;pdb.help()"
1534 at a prompt.
1534 at a prompt.
1535
1535
1536 -p: run program under the control of the Python profiler module (which
1536 -p: run program under the control of the Python profiler module (which
1537 prints a detailed report of execution times, function calls, etc).
1537 prints a detailed report of execution times, function calls, etc).
1538
1538
1539 You can pass other options after -p which affect the behavior of the
1539 You can pass other options after -p which affect the behavior of the
1540 profiler itself. See the docs for %prun for details.
1540 profiler itself. See the docs for %prun for details.
1541
1541
1542 In this mode, the program's variables do NOT propagate back to the
1542 In this mode, the program's variables do NOT propagate back to the
1543 IPython interactive namespace (because they remain in the namespace
1543 IPython interactive namespace (because they remain in the namespace
1544 where the profiler executes them).
1544 where the profiler executes them).
1545
1545
1546 Internally this triggers a call to %prun, see its documentation for
1546 Internally this triggers a call to %prun, see its documentation for
1547 details on the options available specifically for profiling.
1547 details on the options available specifically for profiling.
1548
1548
1549 There is one special usage for which the text above doesn't apply:
1549 There is one special usage for which the text above doesn't apply:
1550 if the filename ends with .ipy, the file is run as ipython script,
1550 if the filename ends with .ipy, the file is run as ipython script,
1551 just as if the commands were written on IPython prompt.
1551 just as if the commands were written on IPython prompt.
1552 """
1552 """
1553
1553
1554 # get arguments and set sys.argv for program to be run.
1554 # get arguments and set sys.argv for program to be run.
1555 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1555 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1556 mode='list',list_all=1)
1556 mode='list',list_all=1)
1557
1557
1558 try:
1558 try:
1559 filename = file_finder(arg_lst[0])
1559 filename = file_finder(arg_lst[0])
1560 except IndexError:
1560 except IndexError:
1561 warn('you must provide at least a filename.')
1561 warn('you must provide at least a filename.')
1562 print '\n%run:\n',oinspect.getdoc(self.magic_run)
1562 print '\n%run:\n',oinspect.getdoc(self.magic_run)
1563 return
1563 return
1564 except IOError,msg:
1564 except IOError,msg:
1565 error(msg)
1565 error(msg)
1566 return
1566 return
1567
1567
1568 if filename.lower().endswith('.ipy'):
1568 if filename.lower().endswith('.ipy'):
1569 self.shell.safe_execfile_ipy(filename)
1569 self.shell.safe_execfile_ipy(filename)
1570 return
1570 return
1571
1571
1572 # Control the response to exit() calls made by the script being run
1572 # Control the response to exit() calls made by the script being run
1573 exit_ignore = opts.has_key('e')
1573 exit_ignore = opts.has_key('e')
1574
1574
1575 # Make sure that the running script gets a proper sys.argv as if it
1575 # Make sure that the running script gets a proper sys.argv as if it
1576 # were run from a system shell.
1576 # were run from a system shell.
1577 save_argv = sys.argv # save it for later restoring
1577 save_argv = sys.argv # save it for later restoring
1578 sys.argv = [filename]+ arg_lst[1:] # put in the proper filename
1578 sys.argv = [filename]+ arg_lst[1:] # put in the proper filename
1579
1579
1580 if opts.has_key('i'):
1580 if opts.has_key('i'):
1581 # Run in user's interactive namespace
1581 # Run in user's interactive namespace
1582 prog_ns = self.shell.user_ns
1582 prog_ns = self.shell.user_ns
1583 __name__save = self.shell.user_ns['__name__']
1583 __name__save = self.shell.user_ns['__name__']
1584 prog_ns['__name__'] = '__main__'
1584 prog_ns['__name__'] = '__main__'
1585 main_mod = self.shell.new_main_mod(prog_ns)
1585 main_mod = self.shell.new_main_mod(prog_ns)
1586 else:
1586 else:
1587 # Run in a fresh, empty namespace
1587 # Run in a fresh, empty namespace
1588 if opts.has_key('n'):
1588 if opts.has_key('n'):
1589 name = os.path.splitext(os.path.basename(filename))[0]
1589 name = os.path.splitext(os.path.basename(filename))[0]
1590 else:
1590 else:
1591 name = '__main__'
1591 name = '__main__'
1592
1592
1593 main_mod = self.shell.new_main_mod()
1593 main_mod = self.shell.new_main_mod()
1594 prog_ns = main_mod.__dict__
1594 prog_ns = main_mod.__dict__
1595 prog_ns['__name__'] = name
1595 prog_ns['__name__'] = name
1596
1596
1597 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1597 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1598 # set the __file__ global in the script's namespace
1598 # set the __file__ global in the script's namespace
1599 prog_ns['__file__'] = filename
1599 prog_ns['__file__'] = filename
1600
1600
1601 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1601 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1602 # that, if we overwrite __main__, we replace it at the end
1602 # that, if we overwrite __main__, we replace it at the end
1603 main_mod_name = prog_ns['__name__']
1603 main_mod_name = prog_ns['__name__']
1604
1604
1605 if main_mod_name == '__main__':
1605 if main_mod_name == '__main__':
1606 restore_main = sys.modules['__main__']
1606 restore_main = sys.modules['__main__']
1607 else:
1607 else:
1608 restore_main = False
1608 restore_main = False
1609
1609
1610 # This needs to be undone at the end to prevent holding references to
1610 # This needs to be undone at the end to prevent holding references to
1611 # every single object ever created.
1611 # every single object ever created.
1612 sys.modules[main_mod_name] = main_mod
1612 sys.modules[main_mod_name] = main_mod
1613
1613
1614 try:
1614 try:
1615 stats = None
1615 stats = None
1616 with self.readline_no_record:
1616 with self.readline_no_record:
1617 if opts.has_key('p'):
1617 if opts.has_key('p'):
1618 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1618 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1619 else:
1619 else:
1620 if opts.has_key('d'):
1620 if opts.has_key('d'):
1621 deb = debugger.Pdb(self.shell.colors)
1621 deb = debugger.Pdb(self.shell.colors)
1622 # reset Breakpoint state, which is moronically kept
1622 # reset Breakpoint state, which is moronically kept
1623 # in a class
1623 # in a class
1624 bdb.Breakpoint.next = 1
1624 bdb.Breakpoint.next = 1
1625 bdb.Breakpoint.bplist = {}
1625 bdb.Breakpoint.bplist = {}
1626 bdb.Breakpoint.bpbynumber = [None]
1626 bdb.Breakpoint.bpbynumber = [None]
1627 # Set an initial breakpoint to stop execution
1627 # Set an initial breakpoint to stop execution
1628 maxtries = 10
1628 maxtries = 10
1629 bp = int(opts.get('b',[1])[0])
1629 bp = int(opts.get('b',[1])[0])
1630 checkline = deb.checkline(filename,bp)
1630 checkline = deb.checkline(filename,bp)
1631 if not checkline:
1631 if not checkline:
1632 for bp in range(bp+1,bp+maxtries+1):
1632 for bp in range(bp+1,bp+maxtries+1):
1633 if deb.checkline(filename,bp):
1633 if deb.checkline(filename,bp):
1634 break
1634 break
1635 else:
1635 else:
1636 msg = ("\nI failed to find a valid line to set "
1636 msg = ("\nI failed to find a valid line to set "
1637 "a breakpoint\n"
1637 "a breakpoint\n"
1638 "after trying up to line: %s.\n"
1638 "after trying up to line: %s.\n"
1639 "Please set a valid breakpoint manually "
1639 "Please set a valid breakpoint manually "
1640 "with the -b option." % bp)
1640 "with the -b option." % bp)
1641 error(msg)
1641 error(msg)
1642 return
1642 return
1643 # if we find a good linenumber, set the breakpoint
1643 # if we find a good linenumber, set the breakpoint
1644 deb.do_break('%s:%s' % (filename,bp))
1644 deb.do_break('%s:%s' % (filename,bp))
1645 # Start file run
1645 # Start file run
1646 print "NOTE: Enter 'c' at the",
1646 print "NOTE: Enter 'c' at the",
1647 print "%s prompt to start your script." % deb.prompt
1647 print "%s prompt to start your script." % deb.prompt
1648 try:
1648 try:
1649 deb.run('execfile("%s")' % filename,prog_ns)
1649 deb.run('execfile("%s")' % filename,prog_ns)
1650
1650
1651 except:
1651 except:
1652 etype, value, tb = sys.exc_info()
1652 etype, value, tb = sys.exc_info()
1653 # Skip three frames in the traceback: the %run one,
1653 # Skip three frames in the traceback: the %run one,
1654 # one inside bdb.py, and the command-line typed by the
1654 # one inside bdb.py, and the command-line typed by the
1655 # user (run by exec in pdb itself).
1655 # user (run by exec in pdb itself).
1656 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1656 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1657 else:
1657 else:
1658 if runner is None:
1658 if runner is None:
1659 runner = self.shell.safe_execfile
1659 runner = self.shell.safe_execfile
1660 if opts.has_key('t'):
1660 if opts.has_key('t'):
1661 # timed execution
1661 # timed execution
1662 try:
1662 try:
1663 nruns = int(opts['N'][0])
1663 nruns = int(opts['N'][0])
1664 if nruns < 1:
1664 if nruns < 1:
1665 error('Number of runs must be >=1')
1665 error('Number of runs must be >=1')
1666 return
1666 return
1667 except (KeyError):
1667 except (KeyError):
1668 nruns = 1
1668 nruns = 1
1669 if nruns == 1:
1669 if nruns == 1:
1670 t0 = clock2()
1670 t0 = clock2()
1671 runner(filename,prog_ns,prog_ns,
1671 runner(filename,prog_ns,prog_ns,
1672 exit_ignore=exit_ignore)
1672 exit_ignore=exit_ignore)
1673 t1 = clock2()
1673 t1 = clock2()
1674 t_usr = t1[0]-t0[0]
1674 t_usr = t1[0]-t0[0]
1675 t_sys = t1[1]-t0[1]
1675 t_sys = t1[1]-t0[1]
1676 print "\nIPython CPU timings (estimated):"
1676 print "\nIPython CPU timings (estimated):"
1677 print " User : %10s s." % t_usr
1677 print " User : %10s s." % t_usr
1678 print " System: %10s s." % t_sys
1678 print " System: %10s s." % t_sys
1679 else:
1679 else:
1680 runs = range(nruns)
1680 runs = range(nruns)
1681 t0 = clock2()
1681 t0 = clock2()
1682 for nr in runs:
1682 for nr in runs:
1683 runner(filename,prog_ns,prog_ns,
1683 runner(filename,prog_ns,prog_ns,
1684 exit_ignore=exit_ignore)
1684 exit_ignore=exit_ignore)
1685 t1 = clock2()
1685 t1 = clock2()
1686 t_usr = t1[0]-t0[0]
1686 t_usr = t1[0]-t0[0]
1687 t_sys = t1[1]-t0[1]
1687 t_sys = t1[1]-t0[1]
1688 print "\nIPython CPU timings (estimated):"
1688 print "\nIPython CPU timings (estimated):"
1689 print "Total runs performed:",nruns
1689 print "Total runs performed:",nruns
1690 print " Times : %10s %10s" % ('Total','Per run')
1690 print " Times : %10s %10s" % ('Total','Per run')
1691 print " User : %10s s, %10s s." % (t_usr,t_usr/nruns)
1691 print " User : %10s s, %10s s." % (t_usr,t_usr/nruns)
1692 print " System: %10s s, %10s s." % (t_sys,t_sys/nruns)
1692 print " System: %10s s, %10s s." % (t_sys,t_sys/nruns)
1693
1693
1694 else:
1694 else:
1695 # regular execution
1695 # regular execution
1696 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1696 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1697
1697
1698 if opts.has_key('i'):
1698 if opts.has_key('i'):
1699 self.shell.user_ns['__name__'] = __name__save
1699 self.shell.user_ns['__name__'] = __name__save
1700 else:
1700 else:
1701 # The shell MUST hold a reference to prog_ns so after %run
1701 # The shell MUST hold a reference to prog_ns so after %run
1702 # exits, the python deletion mechanism doesn't zero it out
1702 # exits, the python deletion mechanism doesn't zero it out
1703 # (leaving dangling references).
1703 # (leaving dangling references).
1704 self.shell.cache_main_mod(prog_ns,filename)
1704 self.shell.cache_main_mod(prog_ns,filename)
1705 # update IPython interactive namespace
1705 # update IPython interactive namespace
1706
1706
1707 # Some forms of read errors on the file may mean the
1707 # Some forms of read errors on the file may mean the
1708 # __name__ key was never set; using pop we don't have to
1708 # __name__ key was never set; using pop we don't have to
1709 # worry about a possible KeyError.
1709 # worry about a possible KeyError.
1710 prog_ns.pop('__name__', None)
1710 prog_ns.pop('__name__', None)
1711
1711
1712 self.shell.user_ns.update(prog_ns)
1712 self.shell.user_ns.update(prog_ns)
1713 finally:
1713 finally:
1714 # It's a bit of a mystery why, but __builtins__ can change from
1714 # It's a bit of a mystery why, but __builtins__ can change from
1715 # being a module to becoming a dict missing some key data after
1715 # being a module to becoming a dict missing some key data after
1716 # %run. As best I can see, this is NOT something IPython is doing
1716 # %run. As best I can see, this is NOT something IPython is doing
1717 # at all, and similar problems have been reported before:
1717 # at all, and similar problems have been reported before:
1718 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1718 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1719 # Since this seems to be done by the interpreter itself, the best
1719 # Since this seems to be done by the interpreter itself, the best
1720 # we can do is to at least restore __builtins__ for the user on
1720 # we can do is to at least restore __builtins__ for the user on
1721 # exit.
1721 # exit.
1722 self.shell.user_ns['__builtins__'] = __builtin__
1722 self.shell.user_ns['__builtins__'] = __builtin__
1723
1723
1724 # Ensure key global structures are restored
1724 # Ensure key global structures are restored
1725 sys.argv = save_argv
1725 sys.argv = save_argv
1726 if restore_main:
1726 if restore_main:
1727 sys.modules['__main__'] = restore_main
1727 sys.modules['__main__'] = restore_main
1728 else:
1728 else:
1729 # Remove from sys.modules the reference to main_mod we'd
1729 # Remove from sys.modules the reference to main_mod we'd
1730 # added. Otherwise it will trap references to objects
1730 # added. Otherwise it will trap references to objects
1731 # contained therein.
1731 # contained therein.
1732 del sys.modules[main_mod_name]
1732 del sys.modules[main_mod_name]
1733
1733
1734 return stats
1734 return stats
1735
1735
1736 @testdec.skip_doctest
1736 @testdec.skip_doctest
1737 def magic_timeit(self, parameter_s =''):
1737 def magic_timeit(self, parameter_s =''):
1738 """Time execution of a Python statement or expression
1738 """Time execution of a Python statement or expression
1739
1739
1740 Usage:\\
1740 Usage:\\
1741 %timeit [-n<N> -r<R> [-t|-c]] statement
1741 %timeit [-n<N> -r<R> [-t|-c]] statement
1742
1742
1743 Time execution of a Python statement or expression using the timeit
1743 Time execution of a Python statement or expression using the timeit
1744 module.
1744 module.
1745
1745
1746 Options:
1746 Options:
1747 -n<N>: execute the given statement <N> times in a loop. If this value
1747 -n<N>: execute the given statement <N> times in a loop. If this value
1748 is not given, a fitting value is chosen.
1748 is not given, a fitting value is chosen.
1749
1749
1750 -r<R>: repeat the loop iteration <R> times and take the best result.
1750 -r<R>: repeat the loop iteration <R> times and take the best result.
1751 Default: 3
1751 Default: 3
1752
1752
1753 -t: use time.time to measure the time, which is the default on Unix.
1753 -t: use time.time to measure the time, which is the default on Unix.
1754 This function measures wall time.
1754 This function measures wall time.
1755
1755
1756 -c: use time.clock to measure the time, which is the default on
1756 -c: use time.clock to measure the time, which is the default on
1757 Windows and measures wall time. On Unix, resource.getrusage is used
1757 Windows and measures wall time. On Unix, resource.getrusage is used
1758 instead and returns the CPU user time.
1758 instead and returns the CPU user time.
1759
1759
1760 -p<P>: use a precision of <P> digits to display the timing result.
1760 -p<P>: use a precision of <P> digits to display the timing result.
1761 Default: 3
1761 Default: 3
1762
1762
1763
1763
1764 Examples:
1764 Examples:
1765
1765
1766 In [1]: %timeit pass
1766 In [1]: %timeit pass
1767 10000000 loops, best of 3: 53.3 ns per loop
1767 10000000 loops, best of 3: 53.3 ns per loop
1768
1768
1769 In [2]: u = None
1769 In [2]: u = None
1770
1770
1771 In [3]: %timeit u is None
1771 In [3]: %timeit u is None
1772 10000000 loops, best of 3: 184 ns per loop
1772 10000000 loops, best of 3: 184 ns per loop
1773
1773
1774 In [4]: %timeit -r 4 u == None
1774 In [4]: %timeit -r 4 u == None
1775 1000000 loops, best of 4: 242 ns per loop
1775 1000000 loops, best of 4: 242 ns per loop
1776
1776
1777 In [5]: import time
1777 In [5]: import time
1778
1778
1779 In [6]: %timeit -n1 time.sleep(2)
1779 In [6]: %timeit -n1 time.sleep(2)
1780 1 loops, best of 3: 2 s per loop
1780 1 loops, best of 3: 2 s per loop
1781
1781
1782
1782
1783 The times reported by %timeit will be slightly higher than those
1783 The times reported by %timeit will be slightly higher than those
1784 reported by the timeit.py script when variables are accessed. This is
1784 reported by the timeit.py script when variables are accessed. This is
1785 due to the fact that %timeit executes the statement in the namespace
1785 due to the fact that %timeit executes the statement in the namespace
1786 of the shell, compared with timeit.py, which uses a single setup
1786 of the shell, compared with timeit.py, which uses a single setup
1787 statement to import function or create variables. Generally, the bias
1787 statement to import function or create variables. Generally, the bias
1788 does not matter as long as results from timeit.py are not mixed with
1788 does not matter as long as results from timeit.py are not mixed with
1789 those from %timeit."""
1789 those from %timeit."""
1790
1790
1791 import timeit
1791 import timeit
1792 import math
1792 import math
1793
1793
1794 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1794 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1795 # certain terminals. Until we figure out a robust way of
1795 # certain terminals. Until we figure out a robust way of
1796 # auto-detecting if the terminal can deal with it, use plain 'us' for
1796 # auto-detecting if the terminal can deal with it, use plain 'us' for
1797 # microseconds. I am really NOT happy about disabling the proper
1797 # microseconds. I am really NOT happy about disabling the proper
1798 # 'micro' prefix, but crashing is worse... If anyone knows what the
1798 # 'micro' prefix, but crashing is worse... If anyone knows what the
1799 # right solution for this is, I'm all ears...
1799 # right solution for this is, I'm all ears...
1800 #
1800 #
1801 # Note: using
1801 # Note: using
1802 #
1802 #
1803 # s = u'\xb5'
1803 # s = u'\xb5'
1804 # s.encode(sys.getdefaultencoding())
1804 # s.encode(sys.getdefaultencoding())
1805 #
1805 #
1806 # is not sufficient, as I've seen terminals where that fails but
1806 # is not sufficient, as I've seen terminals where that fails but
1807 # print s
1807 # print s
1808 #
1808 #
1809 # succeeds
1809 # succeeds
1810 #
1810 #
1811 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1811 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1812
1812
1813 #units = [u"s", u"ms",u'\xb5',"ns"]
1813 #units = [u"s", u"ms",u'\xb5',"ns"]
1814 units = [u"s", u"ms",u'us',"ns"]
1814 units = [u"s", u"ms",u'us',"ns"]
1815
1815
1816 scaling = [1, 1e3, 1e6, 1e9]
1816 scaling = [1, 1e3, 1e6, 1e9]
1817
1817
1818 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1818 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1819 posix=False)
1819 posix=False)
1820 if stmt == "":
1820 if stmt == "":
1821 return
1821 return
1822 timefunc = timeit.default_timer
1822 timefunc = timeit.default_timer
1823 number = int(getattr(opts, "n", 0))
1823 number = int(getattr(opts, "n", 0))
1824 repeat = int(getattr(opts, "r", timeit.default_repeat))
1824 repeat = int(getattr(opts, "r", timeit.default_repeat))
1825 precision = int(getattr(opts, "p", 3))
1825 precision = int(getattr(opts, "p", 3))
1826 if hasattr(opts, "t"):
1826 if hasattr(opts, "t"):
1827 timefunc = time.time
1827 timefunc = time.time
1828 if hasattr(opts, "c"):
1828 if hasattr(opts, "c"):
1829 timefunc = clock
1829 timefunc = clock
1830
1830
1831 timer = timeit.Timer(timer=timefunc)
1831 timer = timeit.Timer(timer=timefunc)
1832 # this code has tight coupling to the inner workings of timeit.Timer,
1832 # this code has tight coupling to the inner workings of timeit.Timer,
1833 # but is there a better way to achieve that the code stmt has access
1833 # but is there a better way to achieve that the code stmt has access
1834 # to the shell namespace?
1834 # to the shell namespace?
1835
1835
1836 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1836 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1837 'setup': "pass"}
1837 'setup': "pass"}
1838 # Track compilation time so it can be reported if too long
1838 # Track compilation time so it can be reported if too long
1839 # Minimum time above which compilation time will be reported
1839 # Minimum time above which compilation time will be reported
1840 tc_min = 0.1
1840 tc_min = 0.1
1841
1841
1842 t0 = clock()
1842 t0 = clock()
1843 code = compile(src, "<magic-timeit>", "exec")
1843 code = compile(src, "<magic-timeit>", "exec")
1844 tc = clock()-t0
1844 tc = clock()-t0
1845
1845
1846 ns = {}
1846 ns = {}
1847 exec code in self.shell.user_ns, ns
1847 exec code in self.shell.user_ns, ns
1848 timer.inner = ns["inner"]
1848 timer.inner = ns["inner"]
1849
1849
1850 if number == 0:
1850 if number == 0:
1851 # determine number so that 0.2 <= total time < 2.0
1851 # determine number so that 0.2 <= total time < 2.0
1852 number = 1
1852 number = 1
1853 for i in range(1, 10):
1853 for i in range(1, 10):
1854 if timer.timeit(number) >= 0.2:
1854 if timer.timeit(number) >= 0.2:
1855 break
1855 break
1856 number *= 10
1856 number *= 10
1857
1857
1858 best = min(timer.repeat(repeat, number)) / number
1858 best = min(timer.repeat(repeat, number)) / number
1859
1859
1860 if best > 0.0 and best < 1000.0:
1860 if best > 0.0 and best < 1000.0:
1861 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1861 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1862 elif best >= 1000.0:
1862 elif best >= 1000.0:
1863 order = 0
1863 order = 0
1864 else:
1864 else:
1865 order = 3
1865 order = 3
1866 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1866 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1867 precision,
1867 precision,
1868 best * scaling[order],
1868 best * scaling[order],
1869 units[order])
1869 units[order])
1870 if tc > tc_min:
1870 if tc > tc_min:
1871 print "Compiler time: %.2f s" % tc
1871 print "Compiler time: %.2f s" % tc
1872
1872
1873 @testdec.skip_doctest
1873 @testdec.skip_doctest
1874 @needs_local_scope
1874 @needs_local_scope
1875 def magic_time(self,parameter_s = ''):
1875 def magic_time(self,parameter_s = ''):
1876 """Time execution of a Python statement or expression.
1876 """Time execution of a Python statement or expression.
1877
1877
1878 The CPU and wall clock times are printed, and the value of the
1878 The CPU and wall clock times are printed, and the value of the
1879 expression (if any) is returned. Note that under Win32, system time
1879 expression (if any) is returned. Note that under Win32, system time
1880 is always reported as 0, since it can not be measured.
1880 is always reported as 0, since it can not be measured.
1881
1881
1882 This function provides very basic timing functionality. In Python
1882 This function provides very basic timing functionality. In Python
1883 2.3, the timeit module offers more control and sophistication, so this
1883 2.3, the timeit module offers more control and sophistication, so this
1884 could be rewritten to use it (patches welcome).
1884 could be rewritten to use it (patches welcome).
1885
1885
1886 Some examples:
1886 Some examples:
1887
1887
1888 In [1]: time 2**128
1888 In [1]: time 2**128
1889 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1889 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1890 Wall time: 0.00
1890 Wall time: 0.00
1891 Out[1]: 340282366920938463463374607431768211456L
1891 Out[1]: 340282366920938463463374607431768211456L
1892
1892
1893 In [2]: n = 1000000
1893 In [2]: n = 1000000
1894
1894
1895 In [3]: time sum(range(n))
1895 In [3]: time sum(range(n))
1896 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1896 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1897 Wall time: 1.37
1897 Wall time: 1.37
1898 Out[3]: 499999500000L
1898 Out[3]: 499999500000L
1899
1899
1900 In [4]: time print 'hello world'
1900 In [4]: time print 'hello world'
1901 hello world
1901 hello world
1902 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1902 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1903 Wall time: 0.00
1903 Wall time: 0.00
1904
1904
1905 Note that the time needed by Python to compile the given expression
1905 Note that the time needed by Python to compile the given expression
1906 will be reported if it is more than 0.1s. In this example, the
1906 will be reported if it is more than 0.1s. In this example, the
1907 actual exponentiation is done by Python at compilation time, so while
1907 actual exponentiation is done by Python at compilation time, so while
1908 the expression can take a noticeable amount of time to compute, that
1908 the expression can take a noticeable amount of time to compute, that
1909 time is purely due to the compilation:
1909 time is purely due to the compilation:
1910
1910
1911 In [5]: time 3**9999;
1911 In [5]: time 3**9999;
1912 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1912 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1913 Wall time: 0.00 s
1913 Wall time: 0.00 s
1914
1914
1915 In [6]: time 3**999999;
1915 In [6]: time 3**999999;
1916 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1916 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1917 Wall time: 0.00 s
1917 Wall time: 0.00 s
1918 Compiler : 0.78 s
1918 Compiler : 0.78 s
1919 """
1919 """
1920
1920
1921 # fail immediately if the given expression can't be compiled
1921 # fail immediately if the given expression can't be compiled
1922
1922
1923 expr = self.shell.prefilter(parameter_s,False)
1923 expr = self.shell.prefilter(parameter_s,False)
1924
1924
1925 # Minimum time above which compilation time will be reported
1925 # Minimum time above which compilation time will be reported
1926 tc_min = 0.1
1926 tc_min = 0.1
1927
1927
1928 try:
1928 try:
1929 mode = 'eval'
1929 mode = 'eval'
1930 t0 = clock()
1930 t0 = clock()
1931 code = compile(expr,'<timed eval>',mode)
1931 code = compile(expr,'<timed eval>',mode)
1932 tc = clock()-t0
1932 tc = clock()-t0
1933 except SyntaxError:
1933 except SyntaxError:
1934 mode = 'exec'
1934 mode = 'exec'
1935 t0 = clock()
1935 t0 = clock()
1936 code = compile(expr,'<timed exec>',mode)
1936 code = compile(expr,'<timed exec>',mode)
1937 tc = clock()-t0
1937 tc = clock()-t0
1938 # skew measurement as little as possible
1938 # skew measurement as little as possible
1939 glob = self.shell.user_ns
1939 glob = self.shell.user_ns
1940 locs = self._magic_locals
1940 locs = self._magic_locals
1941 clk = clock2
1941 clk = clock2
1942 wtime = time.time
1942 wtime = time.time
1943 # time execution
1943 # time execution
1944 wall_st = wtime()
1944 wall_st = wtime()
1945 if mode=='eval':
1945 if mode=='eval':
1946 st = clk()
1946 st = clk()
1947 out = eval(code, glob, locs)
1947 out = eval(code, glob, locs)
1948 end = clk()
1948 end = clk()
1949 else:
1949 else:
1950 st = clk()
1950 st = clk()
1951 exec code in glob, locs
1951 exec code in glob, locs
1952 end = clk()
1952 end = clk()
1953 out = None
1953 out = None
1954 wall_end = wtime()
1954 wall_end = wtime()
1955 # Compute actual times and report
1955 # Compute actual times and report
1956 wall_time = wall_end-wall_st
1956 wall_time = wall_end-wall_st
1957 cpu_user = end[0]-st[0]
1957 cpu_user = end[0]-st[0]
1958 cpu_sys = end[1]-st[1]
1958 cpu_sys = end[1]-st[1]
1959 cpu_tot = cpu_user+cpu_sys
1959 cpu_tot = cpu_user+cpu_sys
1960 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1960 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1961 (cpu_user,cpu_sys,cpu_tot)
1961 (cpu_user,cpu_sys,cpu_tot)
1962 print "Wall time: %.2f s" % wall_time
1962 print "Wall time: %.2f s" % wall_time
1963 if tc > tc_min:
1963 if tc > tc_min:
1964 print "Compiler : %.2f s" % tc
1964 print "Compiler : %.2f s" % tc
1965 return out
1965 return out
1966
1966
1967 @testdec.skip_doctest
1967 @testdec.skip_doctest
1968 def magic_macro(self,parameter_s = ''):
1968 def magic_macro(self,parameter_s = ''):
1969 """Define a macro for future re-execution. It accepts ranges of history,
1969 """Define a macro for future re-execution. It accepts ranges of history,
1970 filenames or string objects.
1970 filenames or string objects.
1971
1971
1972 Usage:\\
1972 Usage:\\
1973 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1973 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1974
1974
1975 Options:
1975 Options:
1976
1976
1977 -r: use 'raw' input. By default, the 'processed' history is used,
1977 -r: use 'raw' input. By default, the 'processed' history is used,
1978 so that magics are loaded in their transformed version to valid
1978 so that magics are loaded in their transformed version to valid
1979 Python. If this option is given, the raw input as typed as the
1979 Python. If this option is given, the raw input as typed as the
1980 command line is used instead.
1980 command line is used instead.
1981
1981
1982 This will define a global variable called `name` which is a string
1982 This will define a global variable called `name` which is a string
1983 made of joining the slices and lines you specify (n1,n2,... numbers
1983 made of joining the slices and lines you specify (n1,n2,... numbers
1984 above) from your input history into a single string. This variable
1984 above) from your input history into a single string. This variable
1985 acts like an automatic function which re-executes those lines as if
1985 acts like an automatic function which re-executes those lines as if
1986 you had typed them. You just type 'name' at the prompt and the code
1986 you had typed them. You just type 'name' at the prompt and the code
1987 executes.
1987 executes.
1988
1988
1989 The syntax for indicating input ranges is described in %history.
1989 The syntax for indicating input ranges is described in %history.
1990
1990
1991 Note: as a 'hidden' feature, you can also use traditional python slice
1991 Note: as a 'hidden' feature, you can also use traditional python slice
1992 notation, where N:M means numbers N through M-1.
1992 notation, where N:M means numbers N through M-1.
1993
1993
1994 For example, if your history contains (%hist prints it):
1994 For example, if your history contains (%hist prints it):
1995
1995
1996 44: x=1
1996 44: x=1
1997 45: y=3
1997 45: y=3
1998 46: z=x+y
1998 46: z=x+y
1999 47: print x
1999 47: print x
2000 48: a=5
2000 48: a=5
2001 49: print 'x',x,'y',y
2001 49: print 'x',x,'y',y
2002
2002
2003 you can create a macro with lines 44 through 47 (included) and line 49
2003 you can create a macro with lines 44 through 47 (included) and line 49
2004 called my_macro with:
2004 called my_macro with:
2005
2005
2006 In [55]: %macro my_macro 44-47 49
2006 In [55]: %macro my_macro 44-47 49
2007
2007
2008 Now, typing `my_macro` (without quotes) will re-execute all this code
2008 Now, typing `my_macro` (without quotes) will re-execute all this code
2009 in one pass.
2009 in one pass.
2010
2010
2011 You don't need to give the line-numbers in order, and any given line
2011 You don't need to give the line-numbers in order, and any given line
2012 number can appear multiple times. You can assemble macros with any
2012 number can appear multiple times. You can assemble macros with any
2013 lines from your input history in any order.
2013 lines from your input history in any order.
2014
2014
2015 The macro is a simple object which holds its value in an attribute,
2015 The macro is a simple object which holds its value in an attribute,
2016 but IPython's display system checks for macros and executes them as
2016 but IPython's display system checks for macros and executes them as
2017 code instead of printing them when you type their name.
2017 code instead of printing them when you type their name.
2018
2018
2019 You can view a macro's contents by explicitly printing it with:
2019 You can view a macro's contents by explicitly printing it with:
2020
2020
2021 'print macro_name'.
2021 'print macro_name'.
2022
2022
2023 """
2023 """
2024
2024
2025 opts,args = self.parse_options(parameter_s,'r',mode='list')
2025 opts,args = self.parse_options(parameter_s,'r',mode='list')
2026 if not args: # List existing macros
2026 if not args: # List existing macros
2027 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2027 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2028 isinstance(v, Macro))
2028 isinstance(v, Macro))
2029 if len(args) == 1:
2029 if len(args) == 1:
2030 raise UsageError(
2030 raise UsageError(
2031 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2031 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2032 name, codefrom = args[0], " ".join(args[1:])
2032 name, codefrom = args[0], " ".join(args[1:])
2033
2033
2034 #print 'rng',ranges # dbg
2034 #print 'rng',ranges # dbg
2035 try:
2035 try:
2036 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2036 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2037 except (ValueError, TypeError) as e:
2037 except (ValueError, TypeError) as e:
2038 print e.args[0]
2038 print e.args[0]
2039 return
2039 return
2040 macro = Macro(lines)
2040 macro = Macro(lines)
2041 self.shell.define_macro(name, macro)
2041 self.shell.define_macro(name, macro)
2042 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2042 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2043 print '=== Macro contents: ==='
2043 print '=== Macro contents: ==='
2044 print macro,
2044 print macro,
2045
2045
2046 def magic_save(self,parameter_s = ''):
2046 def magic_save(self,parameter_s = ''):
2047 """Save a set of lines or a macro to a given filename.
2047 """Save a set of lines or a macro to a given filename.
2048
2048
2049 Usage:\\
2049 Usage:\\
2050 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2050 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2051
2051
2052 Options:
2052 Options:
2053
2053
2054 -r: use 'raw' input. By default, the 'processed' history is used,
2054 -r: use 'raw' input. By default, the 'processed' history is used,
2055 so that magics are loaded in their transformed version to valid
2055 so that magics are loaded in their transformed version to valid
2056 Python. If this option is given, the raw input as typed as the
2056 Python. If this option is given, the raw input as typed as the
2057 command line is used instead.
2057 command line is used instead.
2058
2058
2059 This function uses the same syntax as %history for input ranges,
2059 This function uses the same syntax as %history for input ranges,
2060 then saves the lines to the filename you specify.
2060 then saves the lines to the filename you specify.
2061
2061
2062 It adds a '.py' extension to the file if you don't do so yourself, and
2062 It adds a '.py' extension to the file if you don't do so yourself, and
2063 it asks for confirmation before overwriting existing files."""
2063 it asks for confirmation before overwriting existing files."""
2064
2064
2065 opts,args = self.parse_options(parameter_s,'r',mode='list')
2065 opts,args = self.parse_options(parameter_s,'r',mode='list')
2066 fname, codefrom = args[0], " ".join(args[1:])
2066 fname, codefrom = args[0], " ".join(args[1:])
2067 if not fname.endswith('.py'):
2067 if not fname.endswith('.py'):
2068 fname += '.py'
2068 fname += '.py'
2069 if os.path.isfile(fname):
2069 if os.path.isfile(fname):
2070 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2070 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2071 if ans.lower() not in ['y','yes']:
2071 if ans.lower() not in ['y','yes']:
2072 print 'Operation cancelled.'
2072 print 'Operation cancelled.'
2073 return
2073 return
2074 try:
2074 try:
2075 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2075 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2076 except (TypeError, ValueError) as e:
2076 except (TypeError, ValueError) as e:
2077 print e.args[0]
2077 print e.args[0]
2078 return
2078 return
2079 if isinstance(cmds, unicode):
2079 if isinstance(cmds, unicode):
2080 cmds = cmds.encode("utf-8")
2080 cmds = cmds.encode("utf-8")
2081 with open(fname,'w') as f:
2081 with open(fname,'w') as f:
2082 f.write("# coding: utf-8\n")
2082 f.write("# coding: utf-8\n")
2083 f.write(cmds)
2083 f.write(cmds)
2084 print 'The following commands were written to file `%s`:' % fname
2084 print 'The following commands were written to file `%s`:' % fname
2085 print cmds
2085 print cmds
2086
2086
2087 def magic_pastebin(self, parameter_s = ''):
2087 def magic_pastebin(self, parameter_s = ''):
2088 """Upload code to the 'Lodge it' paste bin, returning the URL."""
2088 """Upload code to the 'Lodge it' paste bin, returning the URL."""
2089 try:
2089 try:
2090 code = self.shell.find_user_code(parameter_s)
2090 code = self.shell.find_user_code(parameter_s)
2091 except (ValueError, TypeError) as e:
2091 except (ValueError, TypeError) as e:
2092 print e.args[0]
2092 print e.args[0]
2093 return
2093 return
2094 pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/')
2094 pbserver = ServerProxy('http://paste.pocoo.org/xmlrpc/')
2095 id = pbserver.pastes.newPaste("python", code)
2095 id = pbserver.pastes.newPaste("python", code)
2096 return "http://paste.pocoo.org/show/" + id
2096 return "http://paste.pocoo.org/show/" + id
2097
2097
2098 def _edit_macro(self,mname,macro):
2098 def _edit_macro(self,mname,macro):
2099 """open an editor with the macro data in a file"""
2099 """open an editor with the macro data in a file"""
2100 filename = self.shell.mktempfile(macro.value)
2100 filename = self.shell.mktempfile(macro.value)
2101 self.shell.hooks.editor(filename)
2101 self.shell.hooks.editor(filename)
2102
2102
2103 # and make a new macro object, to replace the old one
2103 # and make a new macro object, to replace the old one
2104 mfile = open(filename)
2104 mfile = open(filename)
2105 mvalue = mfile.read()
2105 mvalue = mfile.read()
2106 mfile.close()
2106 mfile.close()
2107 self.shell.user_ns[mname] = Macro(mvalue)
2107 self.shell.user_ns[mname] = Macro(mvalue)
2108
2108
2109 def magic_ed(self,parameter_s=''):
2109 def magic_ed(self,parameter_s=''):
2110 """Alias to %edit."""
2110 """Alias to %edit."""
2111 return self.magic_edit(parameter_s)
2111 return self.magic_edit(parameter_s)
2112
2112
2113 @testdec.skip_doctest
2113 @testdec.skip_doctest
2114 def magic_edit(self,parameter_s='',last_call=['','']):
2114 def magic_edit(self,parameter_s='',last_call=['','']):
2115 """Bring up an editor and execute the resulting code.
2115 """Bring up an editor and execute the resulting code.
2116
2116
2117 Usage:
2117 Usage:
2118 %edit [options] [args]
2118 %edit [options] [args]
2119
2119
2120 %edit runs IPython's editor hook. The default version of this hook is
2120 %edit runs IPython's editor hook. The default version of this hook is
2121 set to call the __IPYTHON__.rc.editor command. This is read from your
2121 set to call the __IPYTHON__.rc.editor command. This is read from your
2122 environment variable $EDITOR. If this isn't found, it will default to
2122 environment variable $EDITOR. If this isn't found, it will default to
2123 vi under Linux/Unix and to notepad under Windows. See the end of this
2123 vi under Linux/Unix and to notepad under Windows. See the end of this
2124 docstring for how to change the editor hook.
2124 docstring for how to change the editor hook.
2125
2125
2126 You can also set the value of this editor via the command line option
2126 You can also set the value of this editor via the command line option
2127 '-editor' or in your ipythonrc file. This is useful if you wish to use
2127 '-editor' or in your ipythonrc file. This is useful if you wish to use
2128 specifically for IPython an editor different from your typical default
2128 specifically for IPython an editor different from your typical default
2129 (and for Windows users who typically don't set environment variables).
2129 (and for Windows users who typically don't set environment variables).
2130
2130
2131 This command allows you to conveniently edit multi-line code right in
2131 This command allows you to conveniently edit multi-line code right in
2132 your IPython session.
2132 your IPython session.
2133
2133
2134 If called without arguments, %edit opens up an empty editor with a
2134 If called without arguments, %edit opens up an empty editor with a
2135 temporary file and will execute the contents of this file when you
2135 temporary file and will execute the contents of this file when you
2136 close it (don't forget to save it!).
2136 close it (don't forget to save it!).
2137
2137
2138
2138
2139 Options:
2139 Options:
2140
2140
2141 -n <number>: open the editor at a specified line number. By default,
2141 -n <number>: open the editor at a specified line number. By default,
2142 the IPython editor hook uses the unix syntax 'editor +N filename', but
2142 the IPython editor hook uses the unix syntax 'editor +N filename', but
2143 you can configure this by providing your own modified hook if your
2143 you can configure this by providing your own modified hook if your
2144 favorite editor supports line-number specifications with a different
2144 favorite editor supports line-number specifications with a different
2145 syntax.
2145 syntax.
2146
2146
2147 -p: this will call the editor with the same data as the previous time
2147 -p: this will call the editor with the same data as the previous time
2148 it was used, regardless of how long ago (in your current session) it
2148 it was used, regardless of how long ago (in your current session) it
2149 was.
2149 was.
2150
2150
2151 -r: use 'raw' input. This option only applies to input taken from the
2151 -r: use 'raw' input. This option only applies to input taken from the
2152 user's history. By default, the 'processed' history is used, so that
2152 user's history. By default, the 'processed' history is used, so that
2153 magics are loaded in their transformed version to valid Python. If
2153 magics are loaded in their transformed version to valid Python. If
2154 this option is given, the raw input as typed as the command line is
2154 this option is given, the raw input as typed as the command line is
2155 used instead. When you exit the editor, it will be executed by
2155 used instead. When you exit the editor, it will be executed by
2156 IPython's own processor.
2156 IPython's own processor.
2157
2157
2158 -x: do not execute the edited code immediately upon exit. This is
2158 -x: do not execute the edited code immediately upon exit. This is
2159 mainly useful if you are editing programs which need to be called with
2159 mainly useful if you are editing programs which need to be called with
2160 command line arguments, which you can then do using %run.
2160 command line arguments, which you can then do using %run.
2161
2161
2162
2162
2163 Arguments:
2163 Arguments:
2164
2164
2165 If arguments are given, the following possibilites exist:
2165 If arguments are given, the following possibilites exist:
2166
2166
2167 - If the argument is a filename, IPython will load that into the
2167 - If the argument is a filename, IPython will load that into the
2168 editor. It will execute its contents with execfile() when you exit,
2168 editor. It will execute its contents with execfile() when you exit,
2169 loading any code in the file into your interactive namespace.
2169 loading any code in the file into your interactive namespace.
2170
2170
2171 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2171 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2172 The syntax is the same as in the %history magic.
2172 The syntax is the same as in the %history magic.
2173
2173
2174 - If the argument is a string variable, its contents are loaded
2174 - If the argument is a string variable, its contents are loaded
2175 into the editor. You can thus edit any string which contains
2175 into the editor. You can thus edit any string which contains
2176 python code (including the result of previous edits).
2176 python code (including the result of previous edits).
2177
2177
2178 - If the argument is the name of an object (other than a string),
2178 - If the argument is the name of an object (other than a string),
2179 IPython will try to locate the file where it was defined and open the
2179 IPython will try to locate the file where it was defined and open the
2180 editor at the point where it is defined. You can use `%edit function`
2180 editor at the point where it is defined. You can use `%edit function`
2181 to load an editor exactly at the point where 'function' is defined,
2181 to load an editor exactly at the point where 'function' is defined,
2182 edit it and have the file be executed automatically.
2182 edit it and have the file be executed automatically.
2183
2183
2184 If the object is a macro (see %macro for details), this opens up your
2184 If the object is a macro (see %macro for details), this opens up your
2185 specified editor with a temporary file containing the macro's data.
2185 specified editor with a temporary file containing the macro's data.
2186 Upon exit, the macro is reloaded with the contents of the file.
2186 Upon exit, the macro is reloaded with the contents of the file.
2187
2187
2188 Note: opening at an exact line is only supported under Unix, and some
2188 Note: opening at an exact line is only supported under Unix, and some
2189 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2189 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2190 '+NUMBER' parameter necessary for this feature. Good editors like
2190 '+NUMBER' parameter necessary for this feature. Good editors like
2191 (X)Emacs, vi, jed, pico and joe all do.
2191 (X)Emacs, vi, jed, pico and joe all do.
2192
2192
2193 After executing your code, %edit will return as output the code you
2193 After executing your code, %edit will return as output the code you
2194 typed in the editor (except when it was an existing file). This way
2194 typed in the editor (except when it was an existing file). This way
2195 you can reload the code in further invocations of %edit as a variable,
2195 you can reload the code in further invocations of %edit as a variable,
2196 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2196 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2197 the output.
2197 the output.
2198
2198
2199 Note that %edit is also available through the alias %ed.
2199 Note that %edit is also available through the alias %ed.
2200
2200
2201 This is an example of creating a simple function inside the editor and
2201 This is an example of creating a simple function inside the editor and
2202 then modifying it. First, start up the editor:
2202 then modifying it. First, start up the editor:
2203
2203
2204 In [1]: ed
2204 In [1]: ed
2205 Editing... done. Executing edited code...
2205 Editing... done. Executing edited code...
2206 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
2206 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
2207
2207
2208 We can then call the function foo():
2208 We can then call the function foo():
2209
2209
2210 In [2]: foo()
2210 In [2]: foo()
2211 foo() was defined in an editing session
2211 foo() was defined in an editing session
2212
2212
2213 Now we edit foo. IPython automatically loads the editor with the
2213 Now we edit foo. IPython automatically loads the editor with the
2214 (temporary) file where foo() was previously defined:
2214 (temporary) file where foo() was previously defined:
2215
2215
2216 In [3]: ed foo
2216 In [3]: ed foo
2217 Editing... done. Executing edited code...
2217 Editing... done. Executing edited code...
2218
2218
2219 And if we call foo() again we get the modified version:
2219 And if we call foo() again we get the modified version:
2220
2220
2221 In [4]: foo()
2221 In [4]: foo()
2222 foo() has now been changed!
2222 foo() has now been changed!
2223
2223
2224 Here is an example of how to edit a code snippet successive
2224 Here is an example of how to edit a code snippet successive
2225 times. First we call the editor:
2225 times. First we call the editor:
2226
2226
2227 In [5]: ed
2227 In [5]: ed
2228 Editing... done. Executing edited code...
2228 Editing... done. Executing edited code...
2229 hello
2229 hello
2230 Out[5]: "print 'hello'n"
2230 Out[5]: "print 'hello'n"
2231
2231
2232 Now we call it again with the previous output (stored in _):
2232 Now we call it again with the previous output (stored in _):
2233
2233
2234 In [6]: ed _
2234 In [6]: ed _
2235 Editing... done. Executing edited code...
2235 Editing... done. Executing edited code...
2236 hello world
2236 hello world
2237 Out[6]: "print 'hello world'n"
2237 Out[6]: "print 'hello world'n"
2238
2238
2239 Now we call it with the output #8 (stored in _8, also as Out[8]):
2239 Now we call it with the output #8 (stored in _8, also as Out[8]):
2240
2240
2241 In [7]: ed _8
2241 In [7]: ed _8
2242 Editing... done. Executing edited code...
2242 Editing... done. Executing edited code...
2243 hello again
2243 hello again
2244 Out[7]: "print 'hello again'n"
2244 Out[7]: "print 'hello again'n"
2245
2245
2246
2246
2247 Changing the default editor hook:
2247 Changing the default editor hook:
2248
2248
2249 If you wish to write your own editor hook, you can put it in a
2249 If you wish to write your own editor hook, you can put it in a
2250 configuration file which you load at startup time. The default hook
2250 configuration file which you load at startup time. The default hook
2251 is defined in the IPython.core.hooks module, and you can use that as a
2251 is defined in the IPython.core.hooks module, and you can use that as a
2252 starting example for further modifications. That file also has
2252 starting example for further modifications. That file also has
2253 general instructions on how to set a new hook for use once you've
2253 general instructions on how to set a new hook for use once you've
2254 defined it."""
2254 defined it."""
2255
2255
2256 # FIXME: This function has become a convoluted mess. It needs a
2256 # FIXME: This function has become a convoluted mess. It needs a
2257 # ground-up rewrite with clean, simple logic.
2257 # ground-up rewrite with clean, simple logic.
2258
2258
2259 def make_filename(arg):
2259 def make_filename(arg):
2260 "Make a filename from the given args"
2260 "Make a filename from the given args"
2261 try:
2261 try:
2262 filename = get_py_filename(arg)
2262 filename = get_py_filename(arg)
2263 except IOError:
2263 except IOError:
2264 if args.endswith('.py'):
2264 if args.endswith('.py'):
2265 filename = arg
2265 filename = arg
2266 else:
2266 else:
2267 filename = None
2267 filename = None
2268 return filename
2268 return filename
2269
2269
2270 # custom exceptions
2270 # custom exceptions
2271 class DataIsObject(Exception): pass
2271 class DataIsObject(Exception): pass
2272
2272
2273 opts,args = self.parse_options(parameter_s,'prxn:')
2273 opts,args = self.parse_options(parameter_s,'prxn:')
2274 # Set a few locals from the options for convenience:
2274 # Set a few locals from the options for convenience:
2275 opts_prev = 'p' in opts
2275 opts_prev = 'p' in opts
2276 opts_raw = 'r' in opts
2276 opts_raw = 'r' in opts
2277
2277
2278 # Default line number value
2278 # Default line number value
2279 lineno = opts.get('n',None)
2279 lineno = opts.get('n',None)
2280
2280
2281 if opts_prev:
2281 if opts_prev:
2282 args = '_%s' % last_call[0]
2282 args = '_%s' % last_call[0]
2283 if not self.shell.user_ns.has_key(args):
2283 if not self.shell.user_ns.has_key(args):
2284 args = last_call[1]
2284 args = last_call[1]
2285
2285
2286 # use last_call to remember the state of the previous call, but don't
2286 # use last_call to remember the state of the previous call, but don't
2287 # let it be clobbered by successive '-p' calls.
2287 # let it be clobbered by successive '-p' calls.
2288 try:
2288 try:
2289 last_call[0] = self.shell.displayhook.prompt_count
2289 last_call[0] = self.shell.displayhook.prompt_count
2290 if not opts_prev:
2290 if not opts_prev:
2291 last_call[1] = parameter_s
2291 last_call[1] = parameter_s
2292 except:
2292 except:
2293 pass
2293 pass
2294
2294
2295 # by default this is done with temp files, except when the given
2295 # by default this is done with temp files, except when the given
2296 # arg is a filename
2296 # arg is a filename
2297 use_temp = True
2297 use_temp = True
2298
2298
2299 data = ''
2299 data = ''
2300 if args.endswith('.py'):
2300 if args.endswith('.py'):
2301 filename = make_filename(args)
2301 filename = make_filename(args)
2302 use_temp = False
2302 use_temp = False
2303 elif args:
2303 elif args:
2304 # Mode where user specifies ranges of lines, like in %macro.
2304 # Mode where user specifies ranges of lines, like in %macro.
2305 data = self.extract_input_lines(args, opts_raw)
2305 data = self.extract_input_lines(args, opts_raw)
2306 if not data:
2306 if not data:
2307 try:
2307 try:
2308 # Load the parameter given as a variable. If not a string,
2308 # Load the parameter given as a variable. If not a string,
2309 # process it as an object instead (below)
2309 # process it as an object instead (below)
2310
2310
2311 #print '*** args',args,'type',type(args) # dbg
2311 #print '*** args',args,'type',type(args) # dbg
2312 data = eval(args, self.shell.user_ns)
2312 data = eval(args, self.shell.user_ns)
2313 if not isinstance(data, basestring):
2313 if not isinstance(data, basestring):
2314 raise DataIsObject
2314 raise DataIsObject
2315
2315
2316 except (NameError,SyntaxError):
2316 except (NameError,SyntaxError):
2317 # given argument is not a variable, try as a filename
2317 # given argument is not a variable, try as a filename
2318 filename = make_filename(args)
2318 filename = make_filename(args)
2319 if filename is None:
2319 if filename is None:
2320 warn("Argument given (%s) can't be found as a variable "
2320 warn("Argument given (%s) can't be found as a variable "
2321 "or as a filename." % args)
2321 "or as a filename." % args)
2322 return
2322 return
2323 use_temp = False
2323 use_temp = False
2324
2324
2325 except DataIsObject:
2325 except DataIsObject:
2326 # macros have a special edit function
2326 # macros have a special edit function
2327 if isinstance(data, Macro):
2327 if isinstance(data, Macro):
2328 self._edit_macro(args,data)
2328 self._edit_macro(args,data)
2329 return
2329 return
2330
2330
2331 # For objects, try to edit the file where they are defined
2331 # For objects, try to edit the file where they are defined
2332 try:
2332 try:
2333 filename = inspect.getabsfile(data)
2333 filename = inspect.getabsfile(data)
2334 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2334 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2335 # class created by %edit? Try to find source
2335 # class created by %edit? Try to find source
2336 # by looking for method definitions instead, the
2336 # by looking for method definitions instead, the
2337 # __module__ in those classes is FakeModule.
2337 # __module__ in those classes is FakeModule.
2338 attrs = [getattr(data, aname) for aname in dir(data)]
2338 attrs = [getattr(data, aname) for aname in dir(data)]
2339 for attr in attrs:
2339 for attr in attrs:
2340 if not inspect.ismethod(attr):
2340 if not inspect.ismethod(attr):
2341 continue
2341 continue
2342 filename = inspect.getabsfile(attr)
2342 filename = inspect.getabsfile(attr)
2343 if filename and 'fakemodule' not in filename.lower():
2343 if filename and 'fakemodule' not in filename.lower():
2344 # change the attribute to be the edit target instead
2344 # change the attribute to be the edit target instead
2345 data = attr
2345 data = attr
2346 break
2346 break
2347
2347
2348 datafile = 1
2348 datafile = 1
2349 except TypeError:
2349 except TypeError:
2350 filename = make_filename(args)
2350 filename = make_filename(args)
2351 datafile = 1
2351 datafile = 1
2352 warn('Could not find file where `%s` is defined.\n'
2352 warn('Could not find file where `%s` is defined.\n'
2353 'Opening a file named `%s`' % (args,filename))
2353 'Opening a file named `%s`' % (args,filename))
2354 # Now, make sure we can actually read the source (if it was in
2354 # Now, make sure we can actually read the source (if it was in
2355 # a temp file it's gone by now).
2355 # a temp file it's gone by now).
2356 if datafile:
2356 if datafile:
2357 try:
2357 try:
2358 if lineno is None:
2358 if lineno is None:
2359 lineno = inspect.getsourcelines(data)[1]
2359 lineno = inspect.getsourcelines(data)[1]
2360 except IOError:
2360 except IOError:
2361 filename = make_filename(args)
2361 filename = make_filename(args)
2362 if filename is None:
2362 if filename is None:
2363 warn('The file `%s` where `%s` was defined cannot '
2363 warn('The file `%s` where `%s` was defined cannot '
2364 'be read.' % (filename,data))
2364 'be read.' % (filename,data))
2365 return
2365 return
2366 use_temp = False
2366 use_temp = False
2367
2367
2368 if use_temp:
2368 if use_temp:
2369 filename = self.shell.mktempfile(data)
2369 filename = self.shell.mktempfile(data)
2370 print 'IPython will make a temporary file named:',filename
2370 print 'IPython will make a temporary file named:',filename
2371
2371
2372 # do actual editing here
2372 # do actual editing here
2373 print 'Editing...',
2373 print 'Editing...',
2374 sys.stdout.flush()
2374 sys.stdout.flush()
2375 try:
2375 try:
2376 # Quote filenames that may have spaces in them
2376 # Quote filenames that may have spaces in them
2377 if ' ' in filename:
2377 if ' ' in filename:
2378 filename = "%s" % filename
2378 filename = "%s" % filename
2379 self.shell.hooks.editor(filename,lineno)
2379 self.shell.hooks.editor(filename,lineno)
2380 except TryNext:
2380 except TryNext:
2381 warn('Could not open editor')
2381 warn('Could not open editor')
2382 return
2382 return
2383
2383
2384 # XXX TODO: should this be generalized for all string vars?
2384 # XXX TODO: should this be generalized for all string vars?
2385 # For now, this is special-cased to blocks created by cpaste
2385 # For now, this is special-cased to blocks created by cpaste
2386 if args.strip() == 'pasted_block':
2386 if args.strip() == 'pasted_block':
2387 self.shell.user_ns['pasted_block'] = file_read(filename)
2387 self.shell.user_ns['pasted_block'] = file_read(filename)
2388
2388
2389 if 'x' in opts: # -x prevents actual execution
2389 if 'x' in opts: # -x prevents actual execution
2390 print
2390 print
2391 else:
2391 else:
2392 print 'done. Executing edited code...'
2392 print 'done. Executing edited code...'
2393 if opts_raw:
2393 if opts_raw:
2394 self.shell.run_cell(file_read(filename),
2394 self.shell.run_cell(file_read(filename),
2395 store_history=False)
2395 store_history=False)
2396 else:
2396 else:
2397 self.shell.safe_execfile(filename,self.shell.user_ns,
2397 self.shell.safe_execfile(filename,self.shell.user_ns,
2398 self.shell.user_ns)
2398 self.shell.user_ns)
2399
2399
2400
2400
2401 if use_temp:
2401 if use_temp:
2402 try:
2402 try:
2403 return open(filename).read()
2403 return open(filename).read()
2404 except IOError,msg:
2404 except IOError,msg:
2405 if msg.filename == filename:
2405 if msg.filename == filename:
2406 warn('File not found. Did you forget to save?')
2406 warn('File not found. Did you forget to save?')
2407 return
2407 return
2408 else:
2408 else:
2409 self.shell.showtraceback()
2409 self.shell.showtraceback()
2410
2410
2411 def magic_xmode(self,parameter_s = ''):
2411 def magic_xmode(self,parameter_s = ''):
2412 """Switch modes for the exception handlers.
2412 """Switch modes for the exception handlers.
2413
2413
2414 Valid modes: Plain, Context and Verbose.
2414 Valid modes: Plain, Context and Verbose.
2415
2415
2416 If called without arguments, acts as a toggle."""
2416 If called without arguments, acts as a toggle."""
2417
2417
2418 def xmode_switch_err(name):
2418 def xmode_switch_err(name):
2419 warn('Error changing %s exception modes.\n%s' %
2419 warn('Error changing %s exception modes.\n%s' %
2420 (name,sys.exc_info()[1]))
2420 (name,sys.exc_info()[1]))
2421
2421
2422 shell = self.shell
2422 shell = self.shell
2423 new_mode = parameter_s.strip().capitalize()
2423 new_mode = parameter_s.strip().capitalize()
2424 try:
2424 try:
2425 shell.InteractiveTB.set_mode(mode=new_mode)
2425 shell.InteractiveTB.set_mode(mode=new_mode)
2426 print 'Exception reporting mode:',shell.InteractiveTB.mode
2426 print 'Exception reporting mode:',shell.InteractiveTB.mode
2427 except:
2427 except:
2428 xmode_switch_err('user')
2428 xmode_switch_err('user')
2429
2429
2430 def magic_colors(self,parameter_s = ''):
2430 def magic_colors(self,parameter_s = ''):
2431 """Switch color scheme for prompts, info system and exception handlers.
2431 """Switch color scheme for prompts, info system and exception handlers.
2432
2432
2433 Currently implemented schemes: NoColor, Linux, LightBG.
2433 Currently implemented schemes: NoColor, Linux, LightBG.
2434
2434
2435 Color scheme names are not case-sensitive.
2435 Color scheme names are not case-sensitive.
2436
2436
2437 Examples
2437 Examples
2438 --------
2438 --------
2439 To get a plain black and white terminal::
2439 To get a plain black and white terminal::
2440
2440
2441 %colors nocolor
2441 %colors nocolor
2442 """
2442 """
2443
2443
2444 def color_switch_err(name):
2444 def color_switch_err(name):
2445 warn('Error changing %s color schemes.\n%s' %
2445 warn('Error changing %s color schemes.\n%s' %
2446 (name,sys.exc_info()[1]))
2446 (name,sys.exc_info()[1]))
2447
2447
2448
2448
2449 new_scheme = parameter_s.strip()
2449 new_scheme = parameter_s.strip()
2450 if not new_scheme:
2450 if not new_scheme:
2451 raise UsageError(
2451 raise UsageError(
2452 "%colors: you must specify a color scheme. See '%colors?'")
2452 "%colors: you must specify a color scheme. See '%colors?'")
2453 return
2453 return
2454 # local shortcut
2454 # local shortcut
2455 shell = self.shell
2455 shell = self.shell
2456
2456
2457 import IPython.utils.rlineimpl as readline
2457 import IPython.utils.rlineimpl as readline
2458
2458
2459 if not readline.have_readline and sys.platform == "win32":
2459 if not readline.have_readline and sys.platform == "win32":
2460 msg = """\
2460 msg = """\
2461 Proper color support under MS Windows requires the pyreadline library.
2461 Proper color support under MS Windows requires the pyreadline library.
2462 You can find it at:
2462 You can find it at:
2463 http://ipython.scipy.org/moin/PyReadline/Intro
2463 http://ipython.scipy.org/moin/PyReadline/Intro
2464 Gary's readline needs the ctypes module, from:
2464 Gary's readline needs the ctypes module, from:
2465 http://starship.python.net/crew/theller/ctypes
2465 http://starship.python.net/crew/theller/ctypes
2466 (Note that ctypes is already part of Python versions 2.5 and newer).
2466 (Note that ctypes is already part of Python versions 2.5 and newer).
2467
2467
2468 Defaulting color scheme to 'NoColor'"""
2468 Defaulting color scheme to 'NoColor'"""
2469 new_scheme = 'NoColor'
2469 new_scheme = 'NoColor'
2470 warn(msg)
2470 warn(msg)
2471
2471
2472 # readline option is 0
2472 # readline option is 0
2473 if not shell.has_readline:
2473 if not shell.has_readline:
2474 new_scheme = 'NoColor'
2474 new_scheme = 'NoColor'
2475
2475
2476 # Set prompt colors
2476 # Set prompt colors
2477 try:
2477 try:
2478 shell.displayhook.set_colors(new_scheme)
2478 shell.displayhook.set_colors(new_scheme)
2479 except:
2479 except:
2480 color_switch_err('prompt')
2480 color_switch_err('prompt')
2481 else:
2481 else:
2482 shell.colors = \
2482 shell.colors = \
2483 shell.displayhook.color_table.active_scheme_name
2483 shell.displayhook.color_table.active_scheme_name
2484 # Set exception colors
2484 # Set exception colors
2485 try:
2485 try:
2486 shell.InteractiveTB.set_colors(scheme = new_scheme)
2486 shell.InteractiveTB.set_colors(scheme = new_scheme)
2487 shell.SyntaxTB.set_colors(scheme = new_scheme)
2487 shell.SyntaxTB.set_colors(scheme = new_scheme)
2488 except:
2488 except:
2489 color_switch_err('exception')
2489 color_switch_err('exception')
2490
2490
2491 # Set info (for 'object?') colors
2491 # Set info (for 'object?') colors
2492 if shell.color_info:
2492 if shell.color_info:
2493 try:
2493 try:
2494 shell.inspector.set_active_scheme(new_scheme)
2494 shell.inspector.set_active_scheme(new_scheme)
2495 except:
2495 except:
2496 color_switch_err('object inspector')
2496 color_switch_err('object inspector')
2497 else:
2497 else:
2498 shell.inspector.set_active_scheme('NoColor')
2498 shell.inspector.set_active_scheme('NoColor')
2499
2499
2500 def magic_pprint(self, parameter_s=''):
2500 def magic_pprint(self, parameter_s=''):
2501 """Toggle pretty printing on/off."""
2501 """Toggle pretty printing on/off."""
2502 ptformatter = self.shell.display_formatter.formatters['text/plain']
2502 ptformatter = self.shell.display_formatter.formatters['text/plain']
2503 ptformatter.pprint = bool(1 - ptformatter.pprint)
2503 ptformatter.pprint = bool(1 - ptformatter.pprint)
2504 print 'Pretty printing has been turned', \
2504 print 'Pretty printing has been turned', \
2505 ['OFF','ON'][ptformatter.pprint]
2505 ['OFF','ON'][ptformatter.pprint]
2506
2506
2507 def magic_Exit(self, parameter_s=''):
2507 def magic_Exit(self, parameter_s=''):
2508 """Exit IPython."""
2508 """Exit IPython."""
2509
2509
2510 self.shell.ask_exit()
2510 self.shell.ask_exit()
2511
2511
2512 # Add aliases as magics so all common forms work: exit, quit, Exit, Quit.
2512 # Add aliases as magics so all common forms work: exit, quit, Exit, Quit.
2513 magic_exit = magic_quit = magic_Quit = magic_Exit
2513 magic_exit = magic_quit = magic_Quit = magic_Exit
2514
2514
2515 #......................................................................
2515 #......................................................................
2516 # Functions to implement unix shell-type things
2516 # Functions to implement unix shell-type things
2517
2517
2518 @testdec.skip_doctest
2518 @testdec.skip_doctest
2519 def magic_alias(self, parameter_s = ''):
2519 def magic_alias(self, parameter_s = ''):
2520 """Define an alias for a system command.
2520 """Define an alias for a system command.
2521
2521
2522 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2522 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2523
2523
2524 Then, typing 'alias_name params' will execute the system command 'cmd
2524 Then, typing 'alias_name params' will execute the system command 'cmd
2525 params' (from your underlying operating system).
2525 params' (from your underlying operating system).
2526
2526
2527 Aliases have lower precedence than magic functions and Python normal
2527 Aliases have lower precedence than magic functions and Python normal
2528 variables, so if 'foo' is both a Python variable and an alias, the
2528 variables, so if 'foo' is both a Python variable and an alias, the
2529 alias can not be executed until 'del foo' removes the Python variable.
2529 alias can not be executed until 'del foo' removes the Python variable.
2530
2530
2531 You can use the %l specifier in an alias definition to represent the
2531 You can use the %l specifier in an alias definition to represent the
2532 whole line when the alias is called. For example:
2532 whole line when the alias is called. For example:
2533
2533
2534 In [2]: alias bracket echo "Input in brackets: <%l>"
2534 In [2]: alias bracket echo "Input in brackets: <%l>"
2535 In [3]: bracket hello world
2535 In [3]: bracket hello world
2536 Input in brackets: <hello world>
2536 Input in brackets: <hello world>
2537
2537
2538 You can also define aliases with parameters using %s specifiers (one
2538 You can also define aliases with parameters using %s specifiers (one
2539 per parameter):
2539 per parameter):
2540
2540
2541 In [1]: alias parts echo first %s second %s
2541 In [1]: alias parts echo first %s second %s
2542 In [2]: %parts A B
2542 In [2]: %parts A B
2543 first A second B
2543 first A second B
2544 In [3]: %parts A
2544 In [3]: %parts A
2545 Incorrect number of arguments: 2 expected.
2545 Incorrect number of arguments: 2 expected.
2546 parts is an alias to: 'echo first %s second %s'
2546 parts is an alias to: 'echo first %s second %s'
2547
2547
2548 Note that %l and %s are mutually exclusive. You can only use one or
2548 Note that %l and %s are mutually exclusive. You can only use one or
2549 the other in your aliases.
2549 the other in your aliases.
2550
2550
2551 Aliases expand Python variables just like system calls using ! or !!
2551 Aliases expand Python variables just like system calls using ! or !!
2552 do: all expressions prefixed with '$' get expanded. For details of
2552 do: all expressions prefixed with '$' get expanded. For details of
2553 the semantic rules, see PEP-215:
2553 the semantic rules, see PEP-215:
2554 http://www.python.org/peps/pep-0215.html. This is the library used by
2554 http://www.python.org/peps/pep-0215.html. This is the library used by
2555 IPython for variable expansion. If you want to access a true shell
2555 IPython for variable expansion. If you want to access a true shell
2556 variable, an extra $ is necessary to prevent its expansion by IPython:
2556 variable, an extra $ is necessary to prevent its expansion by IPython:
2557
2557
2558 In [6]: alias show echo
2558 In [6]: alias show echo
2559 In [7]: PATH='A Python string'
2559 In [7]: PATH='A Python string'
2560 In [8]: show $PATH
2560 In [8]: show $PATH
2561 A Python string
2561 A Python string
2562 In [9]: show $$PATH
2562 In [9]: show $$PATH
2563 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2563 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2564
2564
2565 You can use the alias facility to acess all of $PATH. See the %rehash
2565 You can use the alias facility to acess all of $PATH. See the %rehash
2566 and %rehashx functions, which automatically create aliases for the
2566 and %rehashx functions, which automatically create aliases for the
2567 contents of your $PATH.
2567 contents of your $PATH.
2568
2568
2569 If called with no parameters, %alias prints the current alias table."""
2569 If called with no parameters, %alias prints the current alias table."""
2570
2570
2571 par = parameter_s.strip()
2571 par = parameter_s.strip()
2572 if not par:
2572 if not par:
2573 stored = self.db.get('stored_aliases', {} )
2573 stored = self.db.get('stored_aliases', {} )
2574 aliases = sorted(self.shell.alias_manager.aliases)
2574 aliases = sorted(self.shell.alias_manager.aliases)
2575 # for k, v in stored:
2575 # for k, v in stored:
2576 # atab.append(k, v[0])
2576 # atab.append(k, v[0])
2577
2577
2578 print "Total number of aliases:", len(aliases)
2578 print "Total number of aliases:", len(aliases)
2579 sys.stdout.flush()
2579 sys.stdout.flush()
2580 return aliases
2580 return aliases
2581
2581
2582 # Now try to define a new one
2582 # Now try to define a new one
2583 try:
2583 try:
2584 alias,cmd = par.split(None, 1)
2584 alias,cmd = par.split(None, 1)
2585 except:
2585 except:
2586 print oinspect.getdoc(self.magic_alias)
2586 print oinspect.getdoc(self.magic_alias)
2587 else:
2587 else:
2588 self.shell.alias_manager.soft_define_alias(alias, cmd)
2588 self.shell.alias_manager.soft_define_alias(alias, cmd)
2589 # end magic_alias
2589 # end magic_alias
2590
2590
2591 def magic_unalias(self, parameter_s = ''):
2591 def magic_unalias(self, parameter_s = ''):
2592 """Remove an alias"""
2592 """Remove an alias"""
2593
2593
2594 aname = parameter_s.strip()
2594 aname = parameter_s.strip()
2595 self.shell.alias_manager.undefine_alias(aname)
2595 self.shell.alias_manager.undefine_alias(aname)
2596 stored = self.db.get('stored_aliases', {} )
2596 stored = self.db.get('stored_aliases', {} )
2597 if aname in stored:
2597 if aname in stored:
2598 print "Removing %stored alias",aname
2598 print "Removing %stored alias",aname
2599 del stored[aname]
2599 del stored[aname]
2600 self.db['stored_aliases'] = stored
2600 self.db['stored_aliases'] = stored
2601
2601
2602 def magic_rehashx(self, parameter_s = ''):
2602 def magic_rehashx(self, parameter_s = ''):
2603 """Update the alias table with all executable files in $PATH.
2603 """Update the alias table with all executable files in $PATH.
2604
2604
2605 This version explicitly checks that every entry in $PATH is a file
2605 This version explicitly checks that every entry in $PATH is a file
2606 with execute access (os.X_OK), so it is much slower than %rehash.
2606 with execute access (os.X_OK), so it is much slower than %rehash.
2607
2607
2608 Under Windows, it checks executability as a match agains a
2608 Under Windows, it checks executability as a match agains a
2609 '|'-separated string of extensions, stored in the IPython config
2609 '|'-separated string of extensions, stored in the IPython config
2610 variable win_exec_ext. This defaults to 'exe|com|bat'.
2610 variable win_exec_ext. This defaults to 'exe|com|bat'.
2611
2611
2612 This function also resets the root module cache of module completer,
2612 This function also resets the root module cache of module completer,
2613 used on slow filesystems.
2613 used on slow filesystems.
2614 """
2614 """
2615 from IPython.core.alias import InvalidAliasError
2615 from IPython.core.alias import InvalidAliasError
2616
2616
2617 # for the benefit of module completer in ipy_completers.py
2617 # for the benefit of module completer in ipy_completers.py
2618 del self.db['rootmodules']
2618 del self.db['rootmodules']
2619
2619
2620 path = [os.path.abspath(os.path.expanduser(p)) for p in
2620 path = [os.path.abspath(os.path.expanduser(p)) for p in
2621 os.environ.get('PATH','').split(os.pathsep)]
2621 os.environ.get('PATH','').split(os.pathsep)]
2622 path = filter(os.path.isdir,path)
2622 path = filter(os.path.isdir,path)
2623
2623
2624 syscmdlist = []
2624 syscmdlist = []
2625 # Now define isexec in a cross platform manner.
2625 # Now define isexec in a cross platform manner.
2626 if os.name == 'posix':
2626 if os.name == 'posix':
2627 isexec = lambda fname:os.path.isfile(fname) and \
2627 isexec = lambda fname:os.path.isfile(fname) and \
2628 os.access(fname,os.X_OK)
2628 os.access(fname,os.X_OK)
2629 else:
2629 else:
2630 try:
2630 try:
2631 winext = os.environ['pathext'].replace(';','|').replace('.','')
2631 winext = os.environ['pathext'].replace(';','|').replace('.','')
2632 except KeyError:
2632 except KeyError:
2633 winext = 'exe|com|bat|py'
2633 winext = 'exe|com|bat|py'
2634 if 'py' not in winext:
2634 if 'py' not in winext:
2635 winext += '|py'
2635 winext += '|py'
2636 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2636 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2637 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2637 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2638 savedir = os.getcwd()
2638 savedir = os.getcwd()
2639
2639
2640 # Now walk the paths looking for executables to alias.
2640 # Now walk the paths looking for executables to alias.
2641 try:
2641 try:
2642 # write the whole loop for posix/Windows so we don't have an if in
2642 # write the whole loop for posix/Windows so we don't have an if in
2643 # the innermost part
2643 # the innermost part
2644 if os.name == 'posix':
2644 if os.name == 'posix':
2645 for pdir in path:
2645 for pdir in path:
2646 os.chdir(pdir)
2646 os.chdir(pdir)
2647 for ff in os.listdir(pdir):
2647 for ff in os.listdir(pdir):
2648 if isexec(ff):
2648 if isexec(ff):
2649 try:
2649 try:
2650 # Removes dots from the name since ipython
2650 # Removes dots from the name since ipython
2651 # will assume names with dots to be python.
2651 # will assume names with dots to be python.
2652 self.shell.alias_manager.define_alias(
2652 self.shell.alias_manager.define_alias(
2653 ff.replace('.',''), ff)
2653 ff.replace('.',''), ff)
2654 except InvalidAliasError:
2654 except InvalidAliasError:
2655 pass
2655 pass
2656 else:
2656 else:
2657 syscmdlist.append(ff)
2657 syscmdlist.append(ff)
2658 else:
2658 else:
2659 no_alias = self.shell.alias_manager.no_alias
2659 no_alias = self.shell.alias_manager.no_alias
2660 for pdir in path:
2660 for pdir in path:
2661 os.chdir(pdir)
2661 os.chdir(pdir)
2662 for ff in os.listdir(pdir):
2662 for ff in os.listdir(pdir):
2663 base, ext = os.path.splitext(ff)
2663 base, ext = os.path.splitext(ff)
2664 if isexec(ff) and base.lower() not in no_alias:
2664 if isexec(ff) and base.lower() not in no_alias:
2665 if ext.lower() == '.exe':
2665 if ext.lower() == '.exe':
2666 ff = base
2666 ff = base
2667 try:
2667 try:
2668 # Removes dots from the name since ipython
2668 # Removes dots from the name since ipython
2669 # will assume names with dots to be python.
2669 # will assume names with dots to be python.
2670 self.shell.alias_manager.define_alias(
2670 self.shell.alias_manager.define_alias(
2671 base.lower().replace('.',''), ff)
2671 base.lower().replace('.',''), ff)
2672 except InvalidAliasError:
2672 except InvalidAliasError:
2673 pass
2673 pass
2674 syscmdlist.append(ff)
2674 syscmdlist.append(ff)
2675 db = self.db
2675 db = self.db
2676 db['syscmdlist'] = syscmdlist
2676 db['syscmdlist'] = syscmdlist
2677 finally:
2677 finally:
2678 os.chdir(savedir)
2678 os.chdir(savedir)
2679
2679
2680 @testdec.skip_doctest
2680 @testdec.skip_doctest
2681 def magic_pwd(self, parameter_s = ''):
2681 def magic_pwd(self, parameter_s = ''):
2682 """Return the current working directory path.
2682 """Return the current working directory path.
2683
2683
2684 Examples
2684 Examples
2685 --------
2685 --------
2686 ::
2686 ::
2687
2687
2688 In [9]: pwd
2688 In [9]: pwd
2689 Out[9]: '/home/tsuser/sprint/ipython'
2689 Out[9]: '/home/tsuser/sprint/ipython'
2690 """
2690 """
2691 return os.getcwd()
2691 return os.getcwd()
2692
2692
2693 @testdec.skip_doctest
2693 @testdec.skip_doctest
2694 def magic_cd(self, parameter_s=''):
2694 def magic_cd(self, parameter_s=''):
2695 """Change the current working directory.
2695 """Change the current working directory.
2696
2696
2697 This command automatically maintains an internal list of directories
2697 This command automatically maintains an internal list of directories
2698 you visit during your IPython session, in the variable _dh. The
2698 you visit during your IPython session, in the variable _dh. The
2699 command %dhist shows this history nicely formatted. You can also
2699 command %dhist shows this history nicely formatted. You can also
2700 do 'cd -<tab>' to see directory history conveniently.
2700 do 'cd -<tab>' to see directory history conveniently.
2701
2701
2702 Usage:
2702 Usage:
2703
2703
2704 cd 'dir': changes to directory 'dir'.
2704 cd 'dir': changes to directory 'dir'.
2705
2705
2706 cd -: changes to the last visited directory.
2706 cd -: changes to the last visited directory.
2707
2707
2708 cd -<n>: changes to the n-th directory in the directory history.
2708 cd -<n>: changes to the n-th directory in the directory history.
2709
2709
2710 cd --foo: change to directory that matches 'foo' in history
2710 cd --foo: change to directory that matches 'foo' in history
2711
2711
2712 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2712 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2713 (note: cd <bookmark_name> is enough if there is no
2713 (note: cd <bookmark_name> is enough if there is no
2714 directory <bookmark_name>, but a bookmark with the name exists.)
2714 directory <bookmark_name>, but a bookmark with the name exists.)
2715 'cd -b <tab>' allows you to tab-complete bookmark names.
2715 'cd -b <tab>' allows you to tab-complete bookmark names.
2716
2716
2717 Options:
2717 Options:
2718
2718
2719 -q: quiet. Do not print the working directory after the cd command is
2719 -q: quiet. Do not print the working directory after the cd command is
2720 executed. By default IPython's cd command does print this directory,
2720 executed. By default IPython's cd command does print this directory,
2721 since the default prompts do not display path information.
2721 since the default prompts do not display path information.
2722
2722
2723 Note that !cd doesn't work for this purpose because the shell where
2723 Note that !cd doesn't work for this purpose because the shell where
2724 !command runs is immediately discarded after executing 'command'.
2724 !command runs is immediately discarded after executing 'command'.
2725
2725
2726 Examples
2726 Examples
2727 --------
2727 --------
2728 ::
2728 ::
2729
2729
2730 In [10]: cd parent/child
2730 In [10]: cd parent/child
2731 /home/tsuser/parent/child
2731 /home/tsuser/parent/child
2732 """
2732 """
2733
2733
2734 parameter_s = parameter_s.strip()
2734 parameter_s = parameter_s.strip()
2735 #bkms = self.shell.persist.get("bookmarks",{})
2735 #bkms = self.shell.persist.get("bookmarks",{})
2736
2736
2737 oldcwd = os.getcwd()
2737 oldcwd = os.getcwd()
2738 numcd = re.match(r'(-)(\d+)$',parameter_s)
2738 numcd = re.match(r'(-)(\d+)$',parameter_s)
2739 # jump in directory history by number
2739 # jump in directory history by number
2740 if numcd:
2740 if numcd:
2741 nn = int(numcd.group(2))
2741 nn = int(numcd.group(2))
2742 try:
2742 try:
2743 ps = self.shell.user_ns['_dh'][nn]
2743 ps = self.shell.user_ns['_dh'][nn]
2744 except IndexError:
2744 except IndexError:
2745 print 'The requested directory does not exist in history.'
2745 print 'The requested directory does not exist in history.'
2746 return
2746 return
2747 else:
2747 else:
2748 opts = {}
2748 opts = {}
2749 elif parameter_s.startswith('--'):
2749 elif parameter_s.startswith('--'):
2750 ps = None
2750 ps = None
2751 fallback = None
2751 fallback = None
2752 pat = parameter_s[2:]
2752 pat = parameter_s[2:]
2753 dh = self.shell.user_ns['_dh']
2753 dh = self.shell.user_ns['_dh']
2754 # first search only by basename (last component)
2754 # first search only by basename (last component)
2755 for ent in reversed(dh):
2755 for ent in reversed(dh):
2756 if pat in os.path.basename(ent) and os.path.isdir(ent):
2756 if pat in os.path.basename(ent) and os.path.isdir(ent):
2757 ps = ent
2757 ps = ent
2758 break
2758 break
2759
2759
2760 if fallback is None and pat in ent and os.path.isdir(ent):
2760 if fallback is None and pat in ent and os.path.isdir(ent):
2761 fallback = ent
2761 fallback = ent
2762
2762
2763 # if we have no last part match, pick the first full path match
2763 # if we have no last part match, pick the first full path match
2764 if ps is None:
2764 if ps is None:
2765 ps = fallback
2765 ps = fallback
2766
2766
2767 if ps is None:
2767 if ps is None:
2768 print "No matching entry in directory history"
2768 print "No matching entry in directory history"
2769 return
2769 return
2770 else:
2770 else:
2771 opts = {}
2771 opts = {}
2772
2772
2773
2773
2774 else:
2774 else:
2775 #turn all non-space-escaping backslashes to slashes,
2775 #turn all non-space-escaping backslashes to slashes,
2776 # for c:\windows\directory\names\
2776 # for c:\windows\directory\names\
2777 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2777 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2778 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2778 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2779 # jump to previous
2779 # jump to previous
2780 if ps == '-':
2780 if ps == '-':
2781 try:
2781 try:
2782 ps = self.shell.user_ns['_dh'][-2]
2782 ps = self.shell.user_ns['_dh'][-2]
2783 except IndexError:
2783 except IndexError:
2784 raise UsageError('%cd -: No previous directory to change to.')
2784 raise UsageError('%cd -: No previous directory to change to.')
2785 # jump to bookmark if needed
2785 # jump to bookmark if needed
2786 else:
2786 else:
2787 if not os.path.isdir(ps) or opts.has_key('b'):
2787 if not os.path.isdir(ps) or opts.has_key('b'):
2788 bkms = self.db.get('bookmarks', {})
2788 bkms = self.db.get('bookmarks', {})
2789
2789
2790 if bkms.has_key(ps):
2790 if bkms.has_key(ps):
2791 target = bkms[ps]
2791 target = bkms[ps]
2792 print '(bookmark:%s) -> %s' % (ps,target)
2792 print '(bookmark:%s) -> %s' % (ps,target)
2793 ps = target
2793 ps = target
2794 else:
2794 else:
2795 if opts.has_key('b'):
2795 if opts.has_key('b'):
2796 raise UsageError("Bookmark '%s' not found. "
2796 raise UsageError("Bookmark '%s' not found. "
2797 "Use '%%bookmark -l' to see your bookmarks." % ps)
2797 "Use '%%bookmark -l' to see your bookmarks." % ps)
2798
2798
2799 # at this point ps should point to the target dir
2799 # at this point ps should point to the target dir
2800 if ps:
2800 if ps:
2801 try:
2801 try:
2802 os.chdir(os.path.expanduser(ps))
2802 os.chdir(os.path.expanduser(ps))
2803 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2803 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2804 set_term_title('IPython: ' + abbrev_cwd())
2804 set_term_title('IPython: ' + abbrev_cwd())
2805 except OSError:
2805 except OSError:
2806 print sys.exc_info()[1]
2806 print sys.exc_info()[1]
2807 else:
2807 else:
2808 cwd = os.getcwd()
2808 cwd = os.getcwd()
2809 dhist = self.shell.user_ns['_dh']
2809 dhist = self.shell.user_ns['_dh']
2810 if oldcwd != cwd:
2810 if oldcwd != cwd:
2811 dhist.append(cwd)
2811 dhist.append(cwd)
2812 self.db['dhist'] = compress_dhist(dhist)[-100:]
2812 self.db['dhist'] = compress_dhist(dhist)[-100:]
2813
2813
2814 else:
2814 else:
2815 os.chdir(self.shell.home_dir)
2815 os.chdir(self.shell.home_dir)
2816 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2816 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2817 set_term_title('IPython: ' + '~')
2817 set_term_title('IPython: ' + '~')
2818 cwd = os.getcwd()
2818 cwd = os.getcwd()
2819 dhist = self.shell.user_ns['_dh']
2819 dhist = self.shell.user_ns['_dh']
2820
2820
2821 if oldcwd != cwd:
2821 if oldcwd != cwd:
2822 dhist.append(cwd)
2822 dhist.append(cwd)
2823 self.db['dhist'] = compress_dhist(dhist)[-100:]
2823 self.db['dhist'] = compress_dhist(dhist)[-100:]
2824 if not 'q' in opts and self.shell.user_ns['_dh']:
2824 if not 'q' in opts and self.shell.user_ns['_dh']:
2825 print self.shell.user_ns['_dh'][-1]
2825 print self.shell.user_ns['_dh'][-1]
2826
2826
2827
2827
2828 def magic_env(self, parameter_s=''):
2828 def magic_env(self, parameter_s=''):
2829 """List environment variables."""
2829 """List environment variables."""
2830
2830
2831 return os.environ.data
2831 return os.environ.data
2832
2832
2833 def magic_pushd(self, parameter_s=''):
2833 def magic_pushd(self, parameter_s=''):
2834 """Place the current dir on stack and change directory.
2834 """Place the current dir on stack and change directory.
2835
2835
2836 Usage:\\
2836 Usage:\\
2837 %pushd ['dirname']
2837 %pushd ['dirname']
2838 """
2838 """
2839
2839
2840 dir_s = self.shell.dir_stack
2840 dir_s = self.shell.dir_stack
2841 tgt = os.path.expanduser(parameter_s)
2841 tgt = os.path.expanduser(parameter_s)
2842 cwd = os.getcwd().replace(self.home_dir,'~')
2842 cwd = os.getcwd().replace(self.home_dir,'~')
2843 if tgt:
2843 if tgt:
2844 self.magic_cd(parameter_s)
2844 self.magic_cd(parameter_s)
2845 dir_s.insert(0,cwd)
2845 dir_s.insert(0,cwd)
2846 return self.magic_dirs()
2846 return self.magic_dirs()
2847
2847
2848 def magic_popd(self, parameter_s=''):
2848 def magic_popd(self, parameter_s=''):
2849 """Change to directory popped off the top of the stack.
2849 """Change to directory popped off the top of the stack.
2850 """
2850 """
2851 if not self.shell.dir_stack:
2851 if not self.shell.dir_stack:
2852 raise UsageError("%popd on empty stack")
2852 raise UsageError("%popd on empty stack")
2853 top = self.shell.dir_stack.pop(0)
2853 top = self.shell.dir_stack.pop(0)
2854 self.magic_cd(top)
2854 self.magic_cd(top)
2855 print "popd ->",top
2855 print "popd ->",top
2856
2856
2857 def magic_dirs(self, parameter_s=''):
2857 def magic_dirs(self, parameter_s=''):
2858 """Return the current directory stack."""
2858 """Return the current directory stack."""
2859
2859
2860 return self.shell.dir_stack
2860 return self.shell.dir_stack
2861
2861
2862 def magic_dhist(self, parameter_s=''):
2862 def magic_dhist(self, parameter_s=''):
2863 """Print your history of visited directories.
2863 """Print your history of visited directories.
2864
2864
2865 %dhist -> print full history\\
2865 %dhist -> print full history\\
2866 %dhist n -> print last n entries only\\
2866 %dhist n -> print last n entries only\\
2867 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2867 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2868
2868
2869 This history is automatically maintained by the %cd command, and
2869 This history is automatically maintained by the %cd command, and
2870 always available as the global list variable _dh. You can use %cd -<n>
2870 always available as the global list variable _dh. You can use %cd -<n>
2871 to go to directory number <n>.
2871 to go to directory number <n>.
2872
2872
2873 Note that most of time, you should view directory history by entering
2873 Note that most of time, you should view directory history by entering
2874 cd -<TAB>.
2874 cd -<TAB>.
2875
2875
2876 """
2876 """
2877
2877
2878 dh = self.shell.user_ns['_dh']
2878 dh = self.shell.user_ns['_dh']
2879 if parameter_s:
2879 if parameter_s:
2880 try:
2880 try:
2881 args = map(int,parameter_s.split())
2881 args = map(int,parameter_s.split())
2882 except:
2882 except:
2883 self.arg_err(Magic.magic_dhist)
2883 self.arg_err(Magic.magic_dhist)
2884 return
2884 return
2885 if len(args) == 1:
2885 if len(args) == 1:
2886 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2886 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2887 elif len(args) == 2:
2887 elif len(args) == 2:
2888 ini,fin = args
2888 ini,fin = args
2889 else:
2889 else:
2890 self.arg_err(Magic.magic_dhist)
2890 self.arg_err(Magic.magic_dhist)
2891 return
2891 return
2892 else:
2892 else:
2893 ini,fin = 0,len(dh)
2893 ini,fin = 0,len(dh)
2894 nlprint(dh,
2894 nlprint(dh,
2895 header = 'Directory history (kept in _dh)',
2895 header = 'Directory history (kept in _dh)',
2896 start=ini,stop=fin)
2896 start=ini,stop=fin)
2897
2897
2898 @testdec.skip_doctest
2898 @testdec.skip_doctest
2899 def magic_sc(self, parameter_s=''):
2899 def magic_sc(self, parameter_s=''):
2900 """Shell capture - execute a shell command and capture its output.
2900 """Shell capture - execute a shell command and capture its output.
2901
2901
2902 DEPRECATED. Suboptimal, retained for backwards compatibility.
2902 DEPRECATED. Suboptimal, retained for backwards compatibility.
2903
2903
2904 You should use the form 'var = !command' instead. Example:
2904 You should use the form 'var = !command' instead. Example:
2905
2905
2906 "%sc -l myfiles = ls ~" should now be written as
2906 "%sc -l myfiles = ls ~" should now be written as
2907
2907
2908 "myfiles = !ls ~"
2908 "myfiles = !ls ~"
2909
2909
2910 myfiles.s, myfiles.l and myfiles.n still apply as documented
2910 myfiles.s, myfiles.l and myfiles.n still apply as documented
2911 below.
2911 below.
2912
2912
2913 --
2913 --
2914 %sc [options] varname=command
2914 %sc [options] varname=command
2915
2915
2916 IPython will run the given command using commands.getoutput(), and
2916 IPython will run the given command using commands.getoutput(), and
2917 will then update the user's interactive namespace with a variable
2917 will then update the user's interactive namespace with a variable
2918 called varname, containing the value of the call. Your command can
2918 called varname, containing the value of the call. Your command can
2919 contain shell wildcards, pipes, etc.
2919 contain shell wildcards, pipes, etc.
2920
2920
2921 The '=' sign in the syntax is mandatory, and the variable name you
2921 The '=' sign in the syntax is mandatory, and the variable name you
2922 supply must follow Python's standard conventions for valid names.
2922 supply must follow Python's standard conventions for valid names.
2923
2923
2924 (A special format without variable name exists for internal use)
2924 (A special format without variable name exists for internal use)
2925
2925
2926 Options:
2926 Options:
2927
2927
2928 -l: list output. Split the output on newlines into a list before
2928 -l: list output. Split the output on newlines into a list before
2929 assigning it to the given variable. By default the output is stored
2929 assigning it to the given variable. By default the output is stored
2930 as a single string.
2930 as a single string.
2931
2931
2932 -v: verbose. Print the contents of the variable.
2932 -v: verbose. Print the contents of the variable.
2933
2933
2934 In most cases you should not need to split as a list, because the
2934 In most cases you should not need to split as a list, because the
2935 returned value is a special type of string which can automatically
2935 returned value is a special type of string which can automatically
2936 provide its contents either as a list (split on newlines) or as a
2936 provide its contents either as a list (split on newlines) or as a
2937 space-separated string. These are convenient, respectively, either
2937 space-separated string. These are convenient, respectively, either
2938 for sequential processing or to be passed to a shell command.
2938 for sequential processing or to be passed to a shell command.
2939
2939
2940 For example:
2940 For example:
2941
2941
2942 # all-random
2942 # all-random
2943
2943
2944 # Capture into variable a
2944 # Capture into variable a
2945 In [1]: sc a=ls *py
2945 In [1]: sc a=ls *py
2946
2946
2947 # a is a string with embedded newlines
2947 # a is a string with embedded newlines
2948 In [2]: a
2948 In [2]: a
2949 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2949 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2950
2950
2951 # which can be seen as a list:
2951 # which can be seen as a list:
2952 In [3]: a.l
2952 In [3]: a.l
2953 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2953 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2954
2954
2955 # or as a whitespace-separated string:
2955 # or as a whitespace-separated string:
2956 In [4]: a.s
2956 In [4]: a.s
2957 Out[4]: 'setup.py win32_manual_post_install.py'
2957 Out[4]: 'setup.py win32_manual_post_install.py'
2958
2958
2959 # a.s is useful to pass as a single command line:
2959 # a.s is useful to pass as a single command line:
2960 In [5]: !wc -l $a.s
2960 In [5]: !wc -l $a.s
2961 146 setup.py
2961 146 setup.py
2962 130 win32_manual_post_install.py
2962 130 win32_manual_post_install.py
2963 276 total
2963 276 total
2964
2964
2965 # while the list form is useful to loop over:
2965 # while the list form is useful to loop over:
2966 In [6]: for f in a.l:
2966 In [6]: for f in a.l:
2967 ...: !wc -l $f
2967 ...: !wc -l $f
2968 ...:
2968 ...:
2969 146 setup.py
2969 146 setup.py
2970 130 win32_manual_post_install.py
2970 130 win32_manual_post_install.py
2971
2971
2972 Similiarly, the lists returned by the -l option are also special, in
2972 Similiarly, the lists returned by the -l option are also special, in
2973 the sense that you can equally invoke the .s attribute on them to
2973 the sense that you can equally invoke the .s attribute on them to
2974 automatically get a whitespace-separated string from their contents:
2974 automatically get a whitespace-separated string from their contents:
2975
2975
2976 In [7]: sc -l b=ls *py
2976 In [7]: sc -l b=ls *py
2977
2977
2978 In [8]: b
2978 In [8]: b
2979 Out[8]: ['setup.py', 'win32_manual_post_install.py']
2979 Out[8]: ['setup.py', 'win32_manual_post_install.py']
2980
2980
2981 In [9]: b.s
2981 In [9]: b.s
2982 Out[9]: 'setup.py win32_manual_post_install.py'
2982 Out[9]: 'setup.py win32_manual_post_install.py'
2983
2983
2984 In summary, both the lists and strings used for ouptut capture have
2984 In summary, both the lists and strings used for ouptut capture have
2985 the following special attributes:
2985 the following special attributes:
2986
2986
2987 .l (or .list) : value as list.
2987 .l (or .list) : value as list.
2988 .n (or .nlstr): value as newline-separated string.
2988 .n (or .nlstr): value as newline-separated string.
2989 .s (or .spstr): value as space-separated string.
2989 .s (or .spstr): value as space-separated string.
2990 """
2990 """
2991
2991
2992 opts,args = self.parse_options(parameter_s,'lv')
2992 opts,args = self.parse_options(parameter_s,'lv')
2993 # Try to get a variable name and command to run
2993 # Try to get a variable name and command to run
2994 try:
2994 try:
2995 # the variable name must be obtained from the parse_options
2995 # the variable name must be obtained from the parse_options
2996 # output, which uses shlex.split to strip options out.
2996 # output, which uses shlex.split to strip options out.
2997 var,_ = args.split('=',1)
2997 var,_ = args.split('=',1)
2998 var = var.strip()
2998 var = var.strip()
2999 # But the the command has to be extracted from the original input
2999 # But the the command has to be extracted from the original input
3000 # parameter_s, not on what parse_options returns, to avoid the
3000 # parameter_s, not on what parse_options returns, to avoid the
3001 # quote stripping which shlex.split performs on it.
3001 # quote stripping which shlex.split performs on it.
3002 _,cmd = parameter_s.split('=',1)
3002 _,cmd = parameter_s.split('=',1)
3003 except ValueError:
3003 except ValueError:
3004 var,cmd = '',''
3004 var,cmd = '',''
3005 # If all looks ok, proceed
3005 # If all looks ok, proceed
3006 split = 'l' in opts
3006 split = 'l' in opts
3007 out = self.shell.getoutput(cmd, split=split)
3007 out = self.shell.getoutput(cmd, split=split)
3008 if opts.has_key('v'):
3008 if opts.has_key('v'):
3009 print '%s ==\n%s' % (var,pformat(out))
3009 print '%s ==\n%s' % (var,pformat(out))
3010 if var:
3010 if var:
3011 self.shell.user_ns.update({var:out})
3011 self.shell.user_ns.update({var:out})
3012 else:
3012 else:
3013 return out
3013 return out
3014
3014
3015 def magic_sx(self, parameter_s=''):
3015 def magic_sx(self, parameter_s=''):
3016 """Shell execute - run a shell command and capture its output.
3016 """Shell execute - run a shell command and capture its output.
3017
3017
3018 %sx command
3018 %sx command
3019
3019
3020 IPython will run the given command using commands.getoutput(), and
3020 IPython will run the given command using commands.getoutput(), and
3021 return the result formatted as a list (split on '\\n'). Since the
3021 return the result formatted as a list (split on '\\n'). Since the
3022 output is _returned_, it will be stored in ipython's regular output
3022 output is _returned_, it will be stored in ipython's regular output
3023 cache Out[N] and in the '_N' automatic variables.
3023 cache Out[N] and in the '_N' automatic variables.
3024
3024
3025 Notes:
3025 Notes:
3026
3026
3027 1) If an input line begins with '!!', then %sx is automatically
3027 1) If an input line begins with '!!', then %sx is automatically
3028 invoked. That is, while:
3028 invoked. That is, while:
3029 !ls
3029 !ls
3030 causes ipython to simply issue system('ls'), typing
3030 causes ipython to simply issue system('ls'), typing
3031 !!ls
3031 !!ls
3032 is a shorthand equivalent to:
3032 is a shorthand equivalent to:
3033 %sx ls
3033 %sx ls
3034
3034
3035 2) %sx differs from %sc in that %sx automatically splits into a list,
3035 2) %sx differs from %sc in that %sx automatically splits into a list,
3036 like '%sc -l'. The reason for this is to make it as easy as possible
3036 like '%sc -l'. The reason for this is to make it as easy as possible
3037 to process line-oriented shell output via further python commands.
3037 to process line-oriented shell output via further python commands.
3038 %sc is meant to provide much finer control, but requires more
3038 %sc is meant to provide much finer control, but requires more
3039 typing.
3039 typing.
3040
3040
3041 3) Just like %sc -l, this is a list with special attributes:
3041 3) Just like %sc -l, this is a list with special attributes:
3042
3042
3043 .l (or .list) : value as list.
3043 .l (or .list) : value as list.
3044 .n (or .nlstr): value as newline-separated string.
3044 .n (or .nlstr): value as newline-separated string.
3045 .s (or .spstr): value as whitespace-separated string.
3045 .s (or .spstr): value as whitespace-separated string.
3046
3046
3047 This is very useful when trying to use such lists as arguments to
3047 This is very useful when trying to use such lists as arguments to
3048 system commands."""
3048 system commands."""
3049
3049
3050 if parameter_s:
3050 if parameter_s:
3051 return self.shell.getoutput(parameter_s)
3051 return self.shell.getoutput(parameter_s)
3052
3052
3053
3053
3054 def magic_bookmark(self, parameter_s=''):
3054 def magic_bookmark(self, parameter_s=''):
3055 """Manage IPython's bookmark system.
3055 """Manage IPython's bookmark system.
3056
3056
3057 %bookmark <name> - set bookmark to current dir
3057 %bookmark <name> - set bookmark to current dir
3058 %bookmark <name> <dir> - set bookmark to <dir>
3058 %bookmark <name> <dir> - set bookmark to <dir>
3059 %bookmark -l - list all bookmarks
3059 %bookmark -l - list all bookmarks
3060 %bookmark -d <name> - remove bookmark
3060 %bookmark -d <name> - remove bookmark
3061 %bookmark -r - remove all bookmarks
3061 %bookmark -r - remove all bookmarks
3062
3062
3063 You can later on access a bookmarked folder with:
3063 You can later on access a bookmarked folder with:
3064 %cd -b <name>
3064 %cd -b <name>
3065 or simply '%cd <name>' if there is no directory called <name> AND
3065 or simply '%cd <name>' if there is no directory called <name> AND
3066 there is such a bookmark defined.
3066 there is such a bookmark defined.
3067
3067
3068 Your bookmarks persist through IPython sessions, but they are
3068 Your bookmarks persist through IPython sessions, but they are
3069 associated with each profile."""
3069 associated with each profile."""
3070
3070
3071 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3071 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3072 if len(args) > 2:
3072 if len(args) > 2:
3073 raise UsageError("%bookmark: too many arguments")
3073 raise UsageError("%bookmark: too many arguments")
3074
3074
3075 bkms = self.db.get('bookmarks',{})
3075 bkms = self.db.get('bookmarks',{})
3076
3076
3077 if opts.has_key('d'):
3077 if opts.has_key('d'):
3078 try:
3078 try:
3079 todel = args[0]
3079 todel = args[0]
3080 except IndexError:
3080 except IndexError:
3081 raise UsageError(
3081 raise UsageError(
3082 "%bookmark -d: must provide a bookmark to delete")
3082 "%bookmark -d: must provide a bookmark to delete")
3083 else:
3083 else:
3084 try:
3084 try:
3085 del bkms[todel]
3085 del bkms[todel]
3086 except KeyError:
3086 except KeyError:
3087 raise UsageError(
3087 raise UsageError(
3088 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3088 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3089
3089
3090 elif opts.has_key('r'):
3090 elif opts.has_key('r'):
3091 bkms = {}
3091 bkms = {}
3092 elif opts.has_key('l'):
3092 elif opts.has_key('l'):
3093 bks = bkms.keys()
3093 bks = bkms.keys()
3094 bks.sort()
3094 bks.sort()
3095 if bks:
3095 if bks:
3096 size = max(map(len,bks))
3096 size = max(map(len,bks))
3097 else:
3097 else:
3098 size = 0
3098 size = 0
3099 fmt = '%-'+str(size)+'s -> %s'
3099 fmt = '%-'+str(size)+'s -> %s'
3100 print 'Current bookmarks:'
3100 print 'Current bookmarks:'
3101 for bk in bks:
3101 for bk in bks:
3102 print fmt % (bk,bkms[bk])
3102 print fmt % (bk,bkms[bk])
3103 else:
3103 else:
3104 if not args:
3104 if not args:
3105 raise UsageError("%bookmark: You must specify the bookmark name")
3105 raise UsageError("%bookmark: You must specify the bookmark name")
3106 elif len(args)==1:
3106 elif len(args)==1:
3107 bkms[args[0]] = os.getcwd()
3107 bkms[args[0]] = os.getcwd()
3108 elif len(args)==2:
3108 elif len(args)==2:
3109 bkms[args[0]] = args[1]
3109 bkms[args[0]] = args[1]
3110 self.db['bookmarks'] = bkms
3110 self.db['bookmarks'] = bkms
3111
3111
3112 def magic_pycat(self, parameter_s=''):
3112 def magic_pycat(self, parameter_s=''):
3113 """Show a syntax-highlighted file through a pager.
3113 """Show a syntax-highlighted file through a pager.
3114
3114
3115 This magic is similar to the cat utility, but it will assume the file
3115 This magic is similar to the cat utility, but it will assume the file
3116 to be Python source and will show it with syntax highlighting. """
3116 to be Python source and will show it with syntax highlighting. """
3117
3117
3118 try:
3118 try:
3119 filename = get_py_filename(parameter_s)
3119 filename = get_py_filename(parameter_s)
3120 cont = file_read(filename)
3120 cont = file_read(filename)
3121 except IOError:
3121 except IOError:
3122 try:
3122 try:
3123 cont = eval(parameter_s,self.user_ns)
3123 cont = eval(parameter_s,self.user_ns)
3124 except NameError:
3124 except NameError:
3125 cont = None
3125 cont = None
3126 if cont is None:
3126 if cont is None:
3127 print "Error: no such file or variable"
3127 print "Error: no such file or variable"
3128 return
3128 return
3129
3129
3130 page.page(self.shell.pycolorize(cont))
3130 page.page(self.shell.pycolorize(cont))
3131
3131
3132 def _rerun_pasted(self):
3132 def _rerun_pasted(self):
3133 """ Rerun a previously pasted command.
3133 """ Rerun a previously pasted command.
3134 """
3134 """
3135 b = self.user_ns.get('pasted_block', None)
3135 b = self.user_ns.get('pasted_block', None)
3136 if b is None:
3136 if b is None:
3137 raise UsageError('No previous pasted block available')
3137 raise UsageError('No previous pasted block available')
3138 print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
3138 print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
3139 exec b in self.user_ns
3139 exec b in self.user_ns
3140
3140
3141 def _get_pasted_lines(self, sentinel):
3141 def _get_pasted_lines(self, sentinel):
3142 """ Yield pasted lines until the user enters the given sentinel value.
3142 """ Yield pasted lines until the user enters the given sentinel value.
3143 """
3143 """
3144 from IPython.core import interactiveshell
3144 from IPython.core import interactiveshell
3145 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3145 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3146 while True:
3146 while True:
3147 l = interactiveshell.raw_input_original(':')
3147 l = interactiveshell.raw_input_original(':')
3148 if l == sentinel:
3148 if l == sentinel:
3149 return
3149 return
3150 else:
3150 else:
3151 yield l
3151 yield l
3152
3152
3153 def _strip_pasted_lines_for_code(self, raw_lines):
3153 def _strip_pasted_lines_for_code(self, raw_lines):
3154 """ Strip non-code parts of a sequence of lines to return a block of
3154 """ Strip non-code parts of a sequence of lines to return a block of
3155 code.
3155 code.
3156 """
3156 """
3157 # Regular expressions that declare text we strip from the input:
3157 # Regular expressions that declare text we strip from the input:
3158 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3158 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3159 r'^\s*(\s?>)+', # Python input prompt
3159 r'^\s*(\s?>)+', # Python input prompt
3160 r'^\s*\.{3,}', # Continuation prompts
3160 r'^\s*\.{3,}', # Continuation prompts
3161 r'^\++',
3161 r'^\++',
3162 ]
3162 ]
3163
3163
3164 strip_from_start = map(re.compile,strip_re)
3164 strip_from_start = map(re.compile,strip_re)
3165
3165
3166 lines = []
3166 lines = []
3167 for l in raw_lines:
3167 for l in raw_lines:
3168 for pat in strip_from_start:
3168 for pat in strip_from_start:
3169 l = pat.sub('',l)
3169 l = pat.sub('',l)
3170 lines.append(l)
3170 lines.append(l)
3171
3171
3172 block = "\n".join(lines) + '\n'
3172 block = "\n".join(lines) + '\n'
3173 #print "block:\n",block
3173 #print "block:\n",block
3174 return block
3174 return block
3175
3175
3176 def _execute_block(self, block, par):
3176 def _execute_block(self, block, par):
3177 """ Execute a block, or store it in a variable, per the user's request.
3177 """ Execute a block, or store it in a variable, per the user's request.
3178 """
3178 """
3179 if not par:
3179 if not par:
3180 b = textwrap.dedent(block)
3180 b = textwrap.dedent(block)
3181 self.user_ns['pasted_block'] = b
3181 self.user_ns['pasted_block'] = b
3182 exec b in self.user_ns
3182 exec b in self.user_ns
3183 else:
3183 else:
3184 self.user_ns[par] = SList(block.splitlines())
3184 self.user_ns[par] = SList(block.splitlines())
3185 print "Block assigned to '%s'" % par
3185 print "Block assigned to '%s'" % par
3186
3186
3187 def magic_quickref(self,arg):
3187 def magic_quickref(self,arg):
3188 """ Show a quick reference sheet """
3188 """ Show a quick reference sheet """
3189 import IPython.core.usage
3189 import IPython.core.usage
3190 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3190 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3191
3191
3192 page.page(qr)
3192 page.page(qr)
3193
3193
3194 def magic_doctest_mode(self,parameter_s=''):
3194 def magic_doctest_mode(self,parameter_s=''):
3195 """Toggle doctest mode on and off.
3195 """Toggle doctest mode on and off.
3196
3196
3197 This mode is intended to make IPython behave as much as possible like a
3197 This mode is intended to make IPython behave as much as possible like a
3198 plain Python shell, from the perspective of how its prompts, exceptions
3198 plain Python shell, from the perspective of how its prompts, exceptions
3199 and output look. This makes it easy to copy and paste parts of a
3199 and output look. This makes it easy to copy and paste parts of a
3200 session into doctests. It does so by:
3200 session into doctests. It does so by:
3201
3201
3202 - Changing the prompts to the classic ``>>>`` ones.
3202 - Changing the prompts to the classic ``>>>`` ones.
3203 - Changing the exception reporting mode to 'Plain'.
3203 - Changing the exception reporting mode to 'Plain'.
3204 - Disabling pretty-printing of output.
3204 - Disabling pretty-printing of output.
3205
3205
3206 Note that IPython also supports the pasting of code snippets that have
3206 Note that IPython also supports the pasting of code snippets that have
3207 leading '>>>' and '...' prompts in them. This means that you can paste
3207 leading '>>>' and '...' prompts in them. This means that you can paste
3208 doctests from files or docstrings (even if they have leading
3208 doctests from files or docstrings (even if they have leading
3209 whitespace), and the code will execute correctly. You can then use
3209 whitespace), and the code will execute correctly. You can then use
3210 '%history -t' to see the translated history; this will give you the
3210 '%history -t' to see the translated history; this will give you the
3211 input after removal of all the leading prompts and whitespace, which
3211 input after removal of all the leading prompts and whitespace, which
3212 can be pasted back into an editor.
3212 can be pasted back into an editor.
3213
3213
3214 With these features, you can switch into this mode easily whenever you
3214 With these features, you can switch into this mode easily whenever you
3215 need to do testing and changes to doctests, without having to leave
3215 need to do testing and changes to doctests, without having to leave
3216 your existing IPython session.
3216 your existing IPython session.
3217 """
3217 """
3218
3218
3219 from IPython.utils.ipstruct import Struct
3219 from IPython.utils.ipstruct import Struct
3220
3220
3221 # Shorthands
3221 # Shorthands
3222 shell = self.shell
3222 shell = self.shell
3223 oc = shell.displayhook
3223 oc = shell.displayhook
3224 meta = shell.meta
3224 meta = shell.meta
3225 disp_formatter = self.shell.display_formatter
3225 disp_formatter = self.shell.display_formatter
3226 ptformatter = disp_formatter.formatters['text/plain']
3226 ptformatter = disp_formatter.formatters['text/plain']
3227 # dstore is a data store kept in the instance metadata bag to track any
3227 # dstore is a data store kept in the instance metadata bag to track any
3228 # changes we make, so we can undo them later.
3228 # changes we make, so we can undo them later.
3229 dstore = meta.setdefault('doctest_mode',Struct())
3229 dstore = meta.setdefault('doctest_mode',Struct())
3230 save_dstore = dstore.setdefault
3230 save_dstore = dstore.setdefault
3231
3231
3232 # save a few values we'll need to recover later
3232 # save a few values we'll need to recover later
3233 mode = save_dstore('mode',False)
3233 mode = save_dstore('mode',False)
3234 save_dstore('rc_pprint',ptformatter.pprint)
3234 save_dstore('rc_pprint',ptformatter.pprint)
3235 save_dstore('xmode',shell.InteractiveTB.mode)
3235 save_dstore('xmode',shell.InteractiveTB.mode)
3236 save_dstore('rc_separate_out',shell.separate_out)
3236 save_dstore('rc_separate_out',shell.separate_out)
3237 save_dstore('rc_separate_out2',shell.separate_out2)
3237 save_dstore('rc_separate_out2',shell.separate_out2)
3238 save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
3238 save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
3239 save_dstore('rc_separate_in',shell.separate_in)
3239 save_dstore('rc_separate_in',shell.separate_in)
3240 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3240 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3241
3241
3242 if mode == False:
3242 if mode == False:
3243 # turn on
3243 # turn on
3244 oc.prompt1.p_template = '>>> '
3244 oc.prompt1.p_template = '>>> '
3245 oc.prompt2.p_template = '... '
3245 oc.prompt2.p_template = '... '
3246 oc.prompt_out.p_template = ''
3246 oc.prompt_out.p_template = ''
3247
3247
3248 # Prompt separators like plain python
3248 # Prompt separators like plain python
3249 oc.input_sep = oc.prompt1.sep = ''
3249 oc.input_sep = oc.prompt1.sep = ''
3250 oc.output_sep = ''
3250 oc.output_sep = ''
3251 oc.output_sep2 = ''
3251 oc.output_sep2 = ''
3252
3252
3253 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3253 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3254 oc.prompt_out.pad_left = False
3254 oc.prompt_out.pad_left = False
3255
3255
3256 ptformatter.pprint = False
3256 ptformatter.pprint = False
3257 disp_formatter.plain_text_only = True
3257 disp_formatter.plain_text_only = True
3258
3258
3259 shell.magic_xmode('Plain')
3259 shell.magic_xmode('Plain')
3260 else:
3260 else:
3261 # turn off
3261 # turn off
3262 oc.prompt1.p_template = shell.prompt_in1
3262 oc.prompt1.p_template = shell.prompt_in1
3263 oc.prompt2.p_template = shell.prompt_in2
3263 oc.prompt2.p_template = shell.prompt_in2
3264 oc.prompt_out.p_template = shell.prompt_out
3264 oc.prompt_out.p_template = shell.prompt_out
3265
3265
3266 oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
3266 oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
3267
3267
3268 oc.output_sep = dstore.rc_separate_out
3268 oc.output_sep = dstore.rc_separate_out
3269 oc.output_sep2 = dstore.rc_separate_out2
3269 oc.output_sep2 = dstore.rc_separate_out2
3270
3270
3271 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3271 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3272 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3272 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3273
3273
3274 ptformatter.pprint = dstore.rc_pprint
3274 ptformatter.pprint = dstore.rc_pprint
3275 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3275 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3276
3276
3277 shell.magic_xmode(dstore.xmode)
3277 shell.magic_xmode(dstore.xmode)
3278
3278
3279 # Store new mode and inform
3279 # Store new mode and inform
3280 dstore.mode = bool(1-int(mode))
3280 dstore.mode = bool(1-int(mode))
3281 mode_label = ['OFF','ON'][dstore.mode]
3281 mode_label = ['OFF','ON'][dstore.mode]
3282 print 'Doctest mode is:', mode_label
3282 print 'Doctest mode is:', mode_label
3283
3283
3284 def magic_gui(self, parameter_s=''):
3284 def magic_gui(self, parameter_s=''):
3285 """Enable or disable IPython GUI event loop integration.
3285 """Enable or disable IPython GUI event loop integration.
3286
3286
3287 %gui [GUINAME]
3287 %gui [GUINAME]
3288
3288
3289 This magic replaces IPython's threaded shells that were activated
3289 This magic replaces IPython's threaded shells that were activated
3290 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3290 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3291 can now be enabled, disabled and swtiched at runtime and keyboard
3291 can now be enabled, disabled and swtiched at runtime and keyboard
3292 interrupts should work without any problems. The following toolkits
3292 interrupts should work without any problems. The following toolkits
3293 are supported: wxPython, PyQt4, PyGTK, and Tk::
3293 are supported: wxPython, PyQt4, PyGTK, and Tk::
3294
3294
3295 %gui wx # enable wxPython event loop integration
3295 %gui wx # enable wxPython event loop integration
3296 %gui qt4|qt # enable PyQt4 event loop integration
3296 %gui qt4|qt # enable PyQt4 event loop integration
3297 %gui gtk # enable PyGTK event loop integration
3297 %gui gtk # enable PyGTK event loop integration
3298 %gui tk # enable Tk event loop integration
3298 %gui tk # enable Tk event loop integration
3299 %gui # disable all event loop integration
3299 %gui # disable all event loop integration
3300
3300
3301 WARNING: after any of these has been called you can simply create
3301 WARNING: after any of these has been called you can simply create
3302 an application object, but DO NOT start the event loop yourself, as
3302 an application object, but DO NOT start the event loop yourself, as
3303 we have already handled that.
3303 we have already handled that.
3304 """
3304 """
3305 from IPython.lib.inputhook import enable_gui
3305 from IPython.lib.inputhook import enable_gui
3306 opts, arg = self.parse_options(parameter_s, '')
3306 opts, arg = self.parse_options(parameter_s, '')
3307 if arg=='': arg = None
3307 if arg=='': arg = None
3308 return enable_gui(arg)
3308 return enable_gui(arg)
3309
3309
3310 def magic_load_ext(self, module_str):
3310 def magic_load_ext(self, module_str):
3311 """Load an IPython extension by its module name."""
3311 """Load an IPython extension by its module name."""
3312 return self.extension_manager.load_extension(module_str)
3312 return self.extension_manager.load_extension(module_str)
3313
3313
3314 def magic_unload_ext(self, module_str):
3314 def magic_unload_ext(self, module_str):
3315 """Unload an IPython extension by its module name."""
3315 """Unload an IPython extension by its module name."""
3316 self.extension_manager.unload_extension(module_str)
3316 self.extension_manager.unload_extension(module_str)
3317
3317
3318 def magic_reload_ext(self, module_str):
3318 def magic_reload_ext(self, module_str):
3319 """Reload an IPython extension by its module name."""
3319 """Reload an IPython extension by its module name."""
3320 self.extension_manager.reload_extension(module_str)
3320 self.extension_manager.reload_extension(module_str)
3321
3321
3322 @testdec.skip_doctest
3322 @testdec.skip_doctest
3323 def magic_install_profiles(self, s):
3323 def magic_install_profiles(self, s):
3324 """Install the default IPython profiles into the .ipython dir.
3324 """Install the default IPython profiles into the .ipython dir.
3325
3325
3326 If the default profiles have already been installed, they will not
3326 If the default profiles have already been installed, they will not
3327 be overwritten. You can force overwriting them by using the ``-o``
3327 be overwritten. You can force overwriting them by using the ``-o``
3328 option::
3328 option::
3329
3329
3330 In [1]: %install_profiles -o
3330 In [1]: %install_profiles -o
3331 """
3331 """
3332 if '-o' in s:
3332 if '-o' in s:
3333 overwrite = True
3333 overwrite = True
3334 else:
3334 else:
3335 overwrite = False
3335 overwrite = False
3336 from IPython.config import profile
3336 from IPython.config import profile
3337 profile_dir = os.path.split(profile.__file__)[0]
3337 profile_dir = os.path.split(profile.__file__)[0]
3338 ipython_dir = self.ipython_dir
3338 ipython_dir = self.ipython_dir
3339 files = os.listdir(profile_dir)
3339 files = os.listdir(profile_dir)
3340
3340
3341 to_install = []
3341 to_install = []
3342 for f in files:
3342 for f in files:
3343 if f.startswith('ipython_config'):
3343 if f.startswith('ipython_config'):
3344 src = os.path.join(profile_dir, f)
3344 src = os.path.join(profile_dir, f)
3345 dst = os.path.join(ipython_dir, f)
3345 dst = os.path.join(ipython_dir, f)
3346 if (not os.path.isfile(dst)) or overwrite:
3346 if (not os.path.isfile(dst)) or overwrite:
3347 to_install.append((f, src, dst))
3347 to_install.append((f, src, dst))
3348 if len(to_install)>0:
3348 if len(to_install)>0:
3349 print "Installing profiles to: ", ipython_dir
3349 print "Installing profiles to: ", ipython_dir
3350 for (f, src, dst) in to_install:
3350 for (f, src, dst) in to_install:
3351 shutil.copy(src, dst)
3351 shutil.copy(src, dst)
3352 print " %s" % f
3352 print " %s" % f
3353
3353
3354 def magic_install_default_config(self, s):
3354 def magic_install_default_config(self, s):
3355 """Install IPython's default config file into the .ipython dir.
3355 """Install IPython's default config file into the .ipython dir.
3356
3356
3357 If the default config file (:file:`ipython_config.py`) is already
3357 If the default config file (:file:`ipython_config.py`) is already
3358 installed, it will not be overwritten. You can force overwriting
3358 installed, it will not be overwritten. You can force overwriting
3359 by using the ``-o`` option::
3359 by using the ``-o`` option::
3360
3360
3361 In [1]: %install_default_config
3361 In [1]: %install_default_config
3362 """
3362 """
3363 if '-o' in s:
3363 if '-o' in s:
3364 overwrite = True
3364 overwrite = True
3365 else:
3365 else:
3366 overwrite = False
3366 overwrite = False
3367 from IPython.config import default
3367 from IPython.config import default
3368 config_dir = os.path.split(default.__file__)[0]
3368 config_dir = os.path.split(default.__file__)[0]
3369 ipython_dir = self.ipython_dir
3369 ipython_dir = self.ipython_dir
3370 default_config_file_name = 'ipython_config.py'
3370 default_config_file_name = 'ipython_config.py'
3371 src = os.path.join(config_dir, default_config_file_name)
3371 src = os.path.join(config_dir, default_config_file_name)
3372 dst = os.path.join(ipython_dir, default_config_file_name)
3372 dst = os.path.join(ipython_dir, default_config_file_name)
3373 if (not os.path.isfile(dst)) or overwrite:
3373 if (not os.path.isfile(dst)) or overwrite:
3374 shutil.copy(src, dst)
3374 shutil.copy(src, dst)
3375 print "Installing default config file: %s" % dst
3375 print "Installing default config file: %s" % dst
3376
3376
3377 # Pylab support: simple wrappers that activate pylab, load gui input
3377 # Pylab support: simple wrappers that activate pylab, load gui input
3378 # handling and modify slightly %run
3378 # handling and modify slightly %run
3379
3379
3380 @testdec.skip_doctest
3380 @testdec.skip_doctest
3381 def _pylab_magic_run(self, parameter_s=''):
3381 def _pylab_magic_run(self, parameter_s=''):
3382 Magic.magic_run(self, parameter_s,
3382 Magic.magic_run(self, parameter_s,
3383 runner=mpl_runner(self.shell.safe_execfile))
3383 runner=mpl_runner(self.shell.safe_execfile))
3384
3384
3385 _pylab_magic_run.__doc__ = magic_run.__doc__
3385 _pylab_magic_run.__doc__ = magic_run.__doc__
3386
3386
3387 @testdec.skip_doctest
3387 @testdec.skip_doctest
3388 def magic_pylab(self, s):
3388 def magic_pylab(self, s):
3389 """Load numpy and matplotlib to work interactively.
3389 """Load numpy and matplotlib to work interactively.
3390
3390
3391 %pylab [GUINAME]
3391 %pylab [GUINAME]
3392
3392
3393 This function lets you activate pylab (matplotlib, numpy and
3393 This function lets you activate pylab (matplotlib, numpy and
3394 interactive support) at any point during an IPython session.
3394 interactive support) at any point during an IPython session.
3395
3395
3396 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3396 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3397 pylab and mlab, as well as all names from numpy and pylab.
3397 pylab and mlab, as well as all names from numpy and pylab.
3398
3398
3399 Parameters
3399 Parameters
3400 ----------
3400 ----------
3401 guiname : optional
3401 guiname : optional
3402 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or
3402 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk', 'osx' or
3403 'tk'). If given, the corresponding Matplotlib backend is used,
3403 'tk'). If given, the corresponding Matplotlib backend is used,
3404 otherwise matplotlib's default (which you can override in your
3404 otherwise matplotlib's default (which you can override in your
3405 matplotlib config file) is used.
3405 matplotlib config file) is used.
3406
3406
3407 Examples
3407 Examples
3408 --------
3408 --------
3409 In this case, where the MPL default is TkAgg:
3409 In this case, where the MPL default is TkAgg:
3410 In [2]: %pylab
3410 In [2]: %pylab
3411
3411
3412 Welcome to pylab, a matplotlib-based Python environment.
3412 Welcome to pylab, a matplotlib-based Python environment.
3413 Backend in use: TkAgg
3413 Backend in use: TkAgg
3414 For more information, type 'help(pylab)'.
3414 For more information, type 'help(pylab)'.
3415
3415
3416 But you can explicitly request a different backend:
3416 But you can explicitly request a different backend:
3417 In [3]: %pylab qt
3417 In [3]: %pylab qt
3418
3418
3419 Welcome to pylab, a matplotlib-based Python environment.
3419 Welcome to pylab, a matplotlib-based Python environment.
3420 Backend in use: Qt4Agg
3420 Backend in use: Qt4Agg
3421 For more information, type 'help(pylab)'.
3421 For more information, type 'help(pylab)'.
3422 """
3422 """
3423 self.shell.enable_pylab(s)
3423 self.shell.enable_pylab(s)
3424
3424
3425 def magic_tb(self, s):
3425 def magic_tb(self, s):
3426 """Print the last traceback with the currently active exception mode.
3426 """Print the last traceback with the currently active exception mode.
3427
3427
3428 See %xmode for changing exception reporting modes."""
3428 See %xmode for changing exception reporting modes."""
3429 self.shell.showtraceback()
3429 self.shell.showtraceback()
3430
3430
3431 @testdec.skip_doctest
3431 @testdec.skip_doctest
3432 def magic_precision(self, s=''):
3432 def magic_precision(self, s=''):
3433 """Set floating point precision for pretty printing.
3433 """Set floating point precision for pretty printing.
3434
3434
3435 Can set either integer precision or a format string.
3435 Can set either integer precision or a format string.
3436
3436
3437 If numpy has been imported and precision is an int,
3437 If numpy has been imported and precision is an int,
3438 numpy display precision will also be set, via ``numpy.set_printoptions``.
3438 numpy display precision will also be set, via ``numpy.set_printoptions``.
3439
3439
3440 If no argument is given, defaults will be restored.
3440 If no argument is given, defaults will be restored.
3441
3441
3442 Examples
3442 Examples
3443 --------
3443 --------
3444 ::
3444 ::
3445
3445
3446 In [1]: from math import pi
3446 In [1]: from math import pi
3447
3447
3448 In [2]: %precision 3
3448 In [2]: %precision 3
3449 Out[2]: '%.3f'
3449 Out[2]: '%.3f'
3450
3450
3451 In [3]: pi
3451 In [3]: pi
3452 Out[3]: 3.142
3452 Out[3]: 3.142
3453
3453
3454 In [4]: %precision %i
3454 In [4]: %precision %i
3455 Out[4]: '%i'
3455 Out[4]: '%i'
3456
3456
3457 In [5]: pi
3457 In [5]: pi
3458 Out[5]: 3
3458 Out[5]: 3
3459
3459
3460 In [6]: %precision %e
3460 In [6]: %precision %e
3461 Out[6]: '%e'
3461 Out[6]: '%e'
3462
3462
3463 In [7]: pi**10
3463 In [7]: pi**10
3464 Out[7]: 9.364805e+04
3464 Out[7]: 9.364805e+04
3465
3465
3466 In [8]: %precision
3466 In [8]: %precision
3467 Out[8]: '%r'
3467 Out[8]: '%r'
3468
3468
3469 In [9]: pi**10
3469 In [9]: pi**10
3470 Out[9]: 93648.047476082982
3470 Out[9]: 93648.047476082982
3471
3471
3472 """
3472 """
3473
3473
3474 ptformatter = self.shell.display_formatter.formatters['text/plain']
3474 ptformatter = self.shell.display_formatter.formatters['text/plain']
3475 ptformatter.float_precision = s
3475 ptformatter.float_precision = s
3476 return ptformatter.float_format
3476 return ptformatter.float_format
3477
3477
3478 # end Magic
3478 # end Magic
General Comments 0
You need to be logged in to leave comments. Login now