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