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