##// END OF EJS Templates
Create core.magics.code according to new API.
Fernando Perez -
Show More
@@ -0,0 +1,478 b''
1 """Implementation of basic magic functions.
2 """
3 #-----------------------------------------------------------------------------
4 # Copyright (c) 2012 The IPython Development Team.
5 #
6 # Distributed under the terms of the Modified BSD License.
7 #
8 # The full license is in the file COPYING.txt, distributed with this software.
9 #-----------------------------------------------------------------------------
10
11 #-----------------------------------------------------------------------------
12 # Imports
13 #-----------------------------------------------------------------------------
14
15 # Stdlib
16 import inspect
17 import io
18 import json
19 import os
20 import sys
21 from urllib2 import urlopen
22
23 # Our own packages
24 from IPython.core.error import TryNext
25 from IPython.core.macro import Macro
26 from IPython.core.magic import Magics, register_magics, line_magic
27 from IPython.testing.skipdoctest import skip_doctest
28 from IPython.utils import openpy
29 from IPython.utils import py3compat
30 from IPython.utils.io import file_read
31 from IPython.utils.path import get_py_filename, unquote_filename
32 from IPython.utils.warn import warn
33
34 #-----------------------------------------------------------------------------
35 # Magic implementation classes
36 #-----------------------------------------------------------------------------
37
38 # Used for exception handling in magic_edit
39 class MacroToEdit(ValueError): pass
40
41
42 @register_magics
43 class CodeMagics(Magics):
44 """Magics related to code management (loading, saving, editing, ...)."""
45
46 @line_magic
47 def save(self, parameter_s=''):
48 """Save a set of lines or a macro to a given filename.
49
50 Usage:\\
51 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
52
53 Options:
54
55 -r: use 'raw' input. By default, the 'processed' history is used,
56 so that magics are loaded in their transformed version to valid
57 Python. If this option is given, the raw input as typed as the
58 command line is used instead.
59
60 This function uses the same syntax as %history for input ranges,
61 then saves the lines to the filename you specify.
62
63 It adds a '.py' extension to the file if you don't do so yourself, and
64 it asks for confirmation before overwriting existing files."""
65
66 opts,args = self.parse_options(parameter_s,'r',mode='list')
67 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
68 if not fname.endswith('.py'):
69 fname += '.py'
70 if os.path.isfile(fname):
71 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
72 if ans.lower() not in ['y','yes']:
73 print 'Operation cancelled.'
74 return
75 try:
76 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
77 except (TypeError, ValueError) as e:
78 print e.args[0]
79 return
80 with io.open(fname,'w', encoding="utf-8") as f:
81 f.write(u"# coding: utf-8\n")
82 f.write(py3compat.cast_unicode(cmds))
83 print 'The following commands were written to file `%s`:' % fname
84 print cmds
85
86 @line_magic
87 def pastebin(self, parameter_s=''):
88 """Upload code to Github's Gist paste bin, returning the URL.
89
90 Usage:\\
91 %pastebin [-d "Custom description"] 1-7
92
93 The argument can be an input history range, a filename, or the name of a
94 string or macro.
95
96 Options:
97
98 -d: Pass a custom description for the gist. The default will say
99 "Pasted from IPython".
100 """
101 opts, args = self.parse_options(parameter_s, 'd:')
102
103 try:
104 code = self.shell.find_user_code(args)
105 except (ValueError, TypeError) as e:
106 print e.args[0]
107 return
108
109 post_data = json.dumps({
110 "description": opts.get('d', "Pasted from IPython"),
111 "public": True,
112 "files": {
113 "file1.py": {
114 "content": code
115 }
116 }
117 }).encode('utf-8')
118
119 response = urlopen("https://api.github.com/gists", post_data)
120 response_data = json.loads(response.read().decode('utf-8'))
121 return response_data['html_url']
122
123 @line_magic
124 def loadpy(self, arg_s):
125 """Load a .py python script into the GUI console.
126
127 This magic command can either take a local filename or a url::
128
129 %loadpy myscript.py
130 %loadpy http://www.example.com/myscript.py
131 """
132 arg_s = unquote_filename(arg_s)
133 remote_url = arg_s.startswith(('http://', 'https://'))
134 local_url = not remote_url
135 if local_url and not arg_s.endswith('.py'):
136 # Local files must be .py; for remote URLs it's possible that the
137 # fetch URL doesn't have a .py in it (many servers have an opaque
138 # URL, such as scipy-central.org).
139 raise ValueError('%%loadpy only works with .py files: %s' % arg_s)
140
141 # openpy takes care of finding the source encoding (per PEP 263)
142 if remote_url:
143 contents = openpy.read_py_url(arg_s, skip_encoding_cookie=True)
144 else:
145 contents = openpy.read_py_file(arg_s, skip_encoding_cookie=True)
146
147 self.shell.set_next_input(contents)
148
149 def _find_edit_target(self, args, opts, last_call):
150 """Utility method used by magic_edit to find what to edit."""
151
152 def make_filename(arg):
153 "Make a filename from the given args"
154 arg = unquote_filename(arg)
155 try:
156 filename = get_py_filename(arg)
157 except IOError:
158 # If it ends with .py but doesn't already exist, assume we want
159 # a new file.
160 if arg.endswith('.py'):
161 filename = arg
162 else:
163 filename = None
164 return filename
165
166 # Set a few locals from the options for convenience:
167 opts_prev = 'p' in opts
168 opts_raw = 'r' in opts
169
170 # custom exceptions
171 class DataIsObject(Exception): pass
172
173 # Default line number value
174 lineno = opts.get('n',None)
175
176 if opts_prev:
177 args = '_%s' % last_call[0]
178 if not self.shell.user_ns.has_key(args):
179 args = last_call[1]
180
181 # use last_call to remember the state of the previous call, but don't
182 # let it be clobbered by successive '-p' calls.
183 try:
184 last_call[0] = self.shell.displayhook.prompt_count
185 if not opts_prev:
186 last_call[1] = args
187 except:
188 pass
189
190 # by default this is done with temp files, except when the given
191 # arg is a filename
192 use_temp = True
193
194 data = ''
195
196 # First, see if the arguments should be a filename.
197 filename = make_filename(args)
198 if filename:
199 use_temp = False
200 elif args:
201 # Mode where user specifies ranges of lines, like in %macro.
202 data = self.shell.extract_input_lines(args, opts_raw)
203 if not data:
204 try:
205 # Load the parameter given as a variable. If not a string,
206 # process it as an object instead (below)
207
208 #print '*** args',args,'type',type(args) # dbg
209 data = eval(args, self.shell.user_ns)
210 if not isinstance(data, basestring):
211 raise DataIsObject
212
213 except (NameError,SyntaxError):
214 # given argument is not a variable, try as a filename
215 filename = make_filename(args)
216 if filename is None:
217 warn("Argument given (%s) can't be found as a variable "
218 "or as a filename." % args)
219 return
220 use_temp = False
221
222 except DataIsObject:
223 # macros have a special edit function
224 if isinstance(data, Macro):
225 raise MacroToEdit(data)
226
227 # For objects, try to edit the file where they are defined
228 try:
229 filename = inspect.getabsfile(data)
230 if 'fakemodule' in filename.lower() and \
231 inspect.isclass(data):
232 # class created by %edit? Try to find source
233 # by looking for method definitions instead, the
234 # __module__ in those classes is FakeModule.
235 attrs = [getattr(data, aname) for aname in dir(data)]
236 for attr in attrs:
237 if not inspect.ismethod(attr):
238 continue
239 filename = inspect.getabsfile(attr)
240 if filename and \
241 'fakemodule' not in filename.lower():
242 # change the attribute to be the edit
243 # target instead
244 data = attr
245 break
246
247 datafile = 1
248 except TypeError:
249 filename = make_filename(args)
250 datafile = 1
251 warn('Could not find file where `%s` is defined.\n'
252 'Opening a file named `%s`' % (args,filename))
253 # Now, make sure we can actually read the source (if it was
254 # in a temp file it's gone by now).
255 if datafile:
256 try:
257 if lineno is None:
258 lineno = inspect.getsourcelines(data)[1]
259 except IOError:
260 filename = make_filename(args)
261 if filename is None:
262 warn('The file `%s` where `%s` was defined cannot '
263 'be read.' % (filename,data))
264 return
265 use_temp = False
266
267 if use_temp:
268 filename = self.shell.mktempfile(data)
269 print 'IPython will make a temporary file named:',filename
270
271 return filename, lineno, use_temp
272
273 def _edit_macro(self,mname,macro):
274 """open an editor with the macro data in a file"""
275 filename = self.shell.mktempfile(macro.value)
276 self.shell.hooks.editor(filename)
277
278 # and make a new macro object, to replace the old one
279 mfile = open(filename)
280 mvalue = mfile.read()
281 mfile.close()
282 self.shell.user_ns[mname] = Macro(mvalue)
283
284 @line_magic
285 def ed(self, parameter_s=''):
286 """Alias to %edit."""
287 return self.edit(parameter_s)
288
289 @skip_doctest
290 @line_magic
291 def edit(self, parameter_s='',last_call=['','']):
292 """Bring up an editor and execute the resulting code.
293
294 Usage:
295 %edit [options] [args]
296
297 %edit runs IPython's editor hook. The default version of this hook is
298 set to call the editor specified by your $EDITOR environment variable.
299 If this isn't found, it will default to vi under Linux/Unix and to
300 notepad under Windows. See the end of this docstring for how to change
301 the editor hook.
302
303 You can also set the value of this editor via the
304 ``TerminalInteractiveShell.editor`` option in your configuration file.
305 This is useful if you wish to use a different editor from your typical
306 default with IPython (and for Windows users who typically don't set
307 environment variables).
308
309 This command allows you to conveniently edit multi-line code right in
310 your IPython session.
311
312 If called without arguments, %edit opens up an empty editor with a
313 temporary file and will execute the contents of this file when you
314 close it (don't forget to save it!).
315
316
317 Options:
318
319 -n <number>: open the editor at a specified line number. By default,
320 the IPython editor hook uses the unix syntax 'editor +N filename', but
321 you can configure this by providing your own modified hook if your
322 favorite editor supports line-number specifications with a different
323 syntax.
324
325 -p: this will call the editor with the same data as the previous time
326 it was used, regardless of how long ago (in your current session) it
327 was.
328
329 -r: use 'raw' input. This option only applies to input taken from the
330 user's history. By default, the 'processed' history is used, so that
331 magics are loaded in their transformed version to valid Python. If
332 this option is given, the raw input as typed as the command line is
333 used instead. When you exit the editor, it will be executed by
334 IPython's own processor.
335
336 -x: do not execute the edited code immediately upon exit. This is
337 mainly useful if you are editing programs which need to be called with
338 command line arguments, which you can then do using %run.
339
340
341 Arguments:
342
343 If arguments are given, the following possibilities exist:
344
345 - If the argument is a filename, IPython will load that into the
346 editor. It will execute its contents with execfile() when you exit,
347 loading any code in the file into your interactive namespace.
348
349 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
350 The syntax is the same as in the %history magic.
351
352 - If the argument is a string variable, its contents are loaded
353 into the editor. You can thus edit any string which contains
354 python code (including the result of previous edits).
355
356 - If the argument is the name of an object (other than a string),
357 IPython will try to locate the file where it was defined and open the
358 editor at the point where it is defined. You can use `%edit function`
359 to load an editor exactly at the point where 'function' is defined,
360 edit it and have the file be executed automatically.
361
362 - If the object is a macro (see %macro for details), this opens up your
363 specified editor with a temporary file containing the macro's data.
364 Upon exit, the macro is reloaded with the contents of the file.
365
366 Note: opening at an exact line is only supported under Unix, and some
367 editors (like kedit and gedit up to Gnome 2.8) do not understand the
368 '+NUMBER' parameter necessary for this feature. Good editors like
369 (X)Emacs, vi, jed, pico and joe all do.
370
371 After executing your code, %edit will return as output the code you
372 typed in the editor (except when it was an existing file). This way
373 you can reload the code in further invocations of %edit as a variable,
374 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
375 the output.
376
377 Note that %edit is also available through the alias %ed.
378
379 This is an example of creating a simple function inside the editor and
380 then modifying it. First, start up the editor::
381
382 In [1]: ed
383 Editing... done. Executing edited code...
384 Out[1]: 'def foo():\\n print "foo() was defined in an editing
385 session"\\n'
386
387 We can then call the function foo()::
388
389 In [2]: foo()
390 foo() was defined in an editing session
391
392 Now we edit foo. IPython automatically loads the editor with the
393 (temporary) file where foo() was previously defined::
394
395 In [3]: ed foo
396 Editing... done. Executing edited code...
397
398 And if we call foo() again we get the modified version::
399
400 In [4]: foo()
401 foo() has now been changed!
402
403 Here is an example of how to edit a code snippet successive
404 times. First we call the editor::
405
406 In [5]: ed
407 Editing... done. Executing edited code...
408 hello
409 Out[5]: "print 'hello'\\n"
410
411 Now we call it again with the previous output (stored in _)::
412
413 In [6]: ed _
414 Editing... done. Executing edited code...
415 hello world
416 Out[6]: "print 'hello world'\\n"
417
418 Now we call it with the output #8 (stored in _8, also as Out[8])::
419
420 In [7]: ed _8
421 Editing... done. Executing edited code...
422 hello again
423 Out[7]: "print 'hello again'\\n"
424
425
426 Changing the default editor hook:
427
428 If you wish to write your own editor hook, you can put it in a
429 configuration file which you load at startup time. The default hook
430 is defined in the IPython.core.hooks module, and you can use that as a
431 starting example for further modifications. That file also has
432 general instructions on how to set a new hook for use once you've
433 defined it."""
434 opts,args = self.parse_options(parameter_s,'prxn:')
435
436 try:
437 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
438 except MacroToEdit as e:
439 self._edit_macro(args, e.args[0])
440 return
441
442 # do actual editing here
443 print 'Editing...',
444 sys.stdout.flush()
445 try:
446 # Quote filenames that may have spaces in them
447 if ' ' in filename:
448 filename = "'%s'" % filename
449 self.shell.hooks.editor(filename,lineno)
450 except TryNext:
451 warn('Could not open editor')
452 return
453
454 # XXX TODO: should this be generalized for all string vars?
455 # For now, this is special-cased to blocks created by cpaste
456 if args.strip() == 'pasted_block':
457 self.shell.user_ns['pasted_block'] = file_read(filename)
458
459 if 'x' in opts: # -x prevents actual execution
460 print
461 else:
462 print 'done. Executing edited code...'
463 if 'r' in opts: # Untranslated IPython code
464 self.shell.run_cell(file_read(filename),
465 store_history=False)
466 else:
467 self.shell.safe_execfile(filename, self.shell.user_ns,
468 self.shell.user_ns)
469
470 if is_temp:
471 try:
472 return open(filename).read()
473 except IOError,msg:
474 if msg.filename == filename:
475 warn('File not found. Did you forget to save?')
476 return
477 else:
478 self.shell.showtraceback()
@@ -1,2951 +1,2951 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Main IPython class."""
2 """Main IPython class."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2008-2011 The IPython Development Team
8 #
8 #
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12
12
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16
16
17 from __future__ import with_statement
17 from __future__ import with_statement
18 from __future__ import absolute_import
18 from __future__ import absolute_import
19
19
20 import __builtin__ as builtin_mod
20 import __builtin__ as builtin_mod
21 import __future__
21 import __future__
22 import abc
22 import abc
23 import ast
23 import ast
24 import atexit
24 import atexit
25 import os
25 import os
26 import re
26 import re
27 import runpy
27 import runpy
28 import sys
28 import sys
29 import tempfile
29 import tempfile
30 import types
30 import types
31 import urllib
31 import urllib
32 from io import open as io_open
32 from io import open as io_open
33
33
34 from IPython.config.configurable import SingletonConfigurable
34 from IPython.config.configurable import SingletonConfigurable
35 from IPython.core import debugger, oinspect
35 from IPython.core import debugger, oinspect
36 from IPython.core import history as ipcorehist
36 from IPython.core import history as ipcorehist
37 from IPython.core import magic
37 from IPython.core import magic
38 from IPython.core import page
38 from IPython.core import page
39 from IPython.core import prefilter
39 from IPython.core import prefilter
40 from IPython.core import shadowns
40 from IPython.core import shadowns
41 from IPython.core import ultratb
41 from IPython.core import ultratb
42 from IPython.core.alias import AliasManager, AliasError
42 from IPython.core.alias import AliasManager, AliasError
43 from IPython.core.autocall import ExitAutocall
43 from IPython.core.autocall import ExitAutocall
44 from IPython.core.builtin_trap import BuiltinTrap
44 from IPython.core.builtin_trap import BuiltinTrap
45 from IPython.core.compilerop import CachingCompiler
45 from IPython.core.compilerop import CachingCompiler
46 from IPython.core.display_trap import DisplayTrap
46 from IPython.core.display_trap import DisplayTrap
47 from IPython.core.displayhook import DisplayHook
47 from IPython.core.displayhook import DisplayHook
48 from IPython.core.displaypub import DisplayPublisher
48 from IPython.core.displaypub import DisplayPublisher
49 from IPython.core.error import UsageError
49 from IPython.core.error import UsageError
50 from IPython.core.extensions import ExtensionManager
50 from IPython.core.extensions import ExtensionManager
51 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
51 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
52 from IPython.core.formatters import DisplayFormatter
52 from IPython.core.formatters import DisplayFormatter
53 from IPython.core.history import HistoryManager
53 from IPython.core.history import HistoryManager
54 from IPython.core.inputsplitter import IPythonInputSplitter
54 from IPython.core.inputsplitter import IPythonInputSplitter
55 from IPython.core.logger import Logger
55 from IPython.core.logger import Logger
56 from IPython.core.macro import Macro
56 from IPython.core.macro import Macro
57 from IPython.core.payload import PayloadManager
57 from IPython.core.payload import PayloadManager
58 from IPython.core.plugin import PluginManager
58 from IPython.core.plugin import PluginManager
59 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
59 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
60 from IPython.core.profiledir import ProfileDir
60 from IPython.core.profiledir import ProfileDir
61 from IPython.core.pylabtools import pylab_activate
61 from IPython.core.pylabtools import pylab_activate
62 from IPython.core.prompts import PromptManager
62 from IPython.core.prompts import PromptManager
63 from IPython.utils import PyColorize
63 from IPython.utils import PyColorize
64 from IPython.utils import io
64 from IPython.utils import io
65 from IPython.utils import py3compat
65 from IPython.utils import py3compat
66 from IPython.utils import openpy
66 from IPython.utils import openpy
67 from IPython.utils.doctestreload import doctest_reload
67 from IPython.utils.doctestreload import doctest_reload
68 from IPython.utils.io import ask_yes_no
68 from IPython.utils.io import ask_yes_no
69 from IPython.utils.ipstruct import Struct
69 from IPython.utils.ipstruct import Struct
70 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
70 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
71 from IPython.utils.pickleshare import PickleShareDB
71 from IPython.utils.pickleshare import PickleShareDB
72 from IPython.utils.process import system, getoutput
72 from IPython.utils.process import system, getoutput
73 from IPython.utils.strdispatch import StrDispatch
73 from IPython.utils.strdispatch import StrDispatch
74 from IPython.utils.syspathcontext import prepended_to_syspath
74 from IPython.utils.syspathcontext import prepended_to_syspath
75 from IPython.utils.text import (format_screen, LSString, SList,
75 from IPython.utils.text import (format_screen, LSString, SList,
76 DollarFormatter)
76 DollarFormatter)
77 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
77 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
78 List, Unicode, Instance, Type)
78 List, Unicode, Instance, Type)
79 from IPython.utils.warn import warn, error
79 from IPython.utils.warn import warn, error
80 import IPython.core.hooks
80 import IPython.core.hooks
81
81
82 #-----------------------------------------------------------------------------
82 #-----------------------------------------------------------------------------
83 # Globals
83 # Globals
84 #-----------------------------------------------------------------------------
84 #-----------------------------------------------------------------------------
85
85
86 # compiled regexps for autoindent management
86 # compiled regexps for autoindent management
87 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
87 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
88
88
89 #-----------------------------------------------------------------------------
89 #-----------------------------------------------------------------------------
90 # Utilities
90 # Utilities
91 #-----------------------------------------------------------------------------
91 #-----------------------------------------------------------------------------
92
92
93 def softspace(file, newvalue):
93 def softspace(file, newvalue):
94 """Copied from code.py, to remove the dependency"""
94 """Copied from code.py, to remove the dependency"""
95
95
96 oldvalue = 0
96 oldvalue = 0
97 try:
97 try:
98 oldvalue = file.softspace
98 oldvalue = file.softspace
99 except AttributeError:
99 except AttributeError:
100 pass
100 pass
101 try:
101 try:
102 file.softspace = newvalue
102 file.softspace = newvalue
103 except (AttributeError, TypeError):
103 except (AttributeError, TypeError):
104 # "attribute-less object" or "read-only attributes"
104 # "attribute-less object" or "read-only attributes"
105 pass
105 pass
106 return oldvalue
106 return oldvalue
107
107
108
108
109 def no_op(*a, **kw): pass
109 def no_op(*a, **kw): pass
110
110
111 class NoOpContext(object):
111 class NoOpContext(object):
112 def __enter__(self): pass
112 def __enter__(self): pass
113 def __exit__(self, type, value, traceback): pass
113 def __exit__(self, type, value, traceback): pass
114 no_op_context = NoOpContext()
114 no_op_context = NoOpContext()
115
115
116 class SpaceInInput(Exception): pass
116 class SpaceInInput(Exception): pass
117
117
118 class Bunch: pass
118 class Bunch: pass
119
119
120
120
121 def get_default_colors():
121 def get_default_colors():
122 if sys.platform=='darwin':
122 if sys.platform=='darwin':
123 return "LightBG"
123 return "LightBG"
124 elif os.name=='nt':
124 elif os.name=='nt':
125 return 'Linux'
125 return 'Linux'
126 else:
126 else:
127 return 'Linux'
127 return 'Linux'
128
128
129
129
130 class SeparateUnicode(Unicode):
130 class SeparateUnicode(Unicode):
131 """A Unicode subclass to validate separate_in, separate_out, etc.
131 """A Unicode subclass to validate separate_in, separate_out, etc.
132
132
133 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
133 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
134 """
134 """
135
135
136 def validate(self, obj, value):
136 def validate(self, obj, value):
137 if value == '0': value = ''
137 if value == '0': value = ''
138 value = value.replace('\\n','\n')
138 value = value.replace('\\n','\n')
139 return super(SeparateUnicode, self).validate(obj, value)
139 return super(SeparateUnicode, self).validate(obj, value)
140
140
141
141
142 class ReadlineNoRecord(object):
142 class ReadlineNoRecord(object):
143 """Context manager to execute some code, then reload readline history
143 """Context manager to execute some code, then reload readline history
144 so that interactive input to the code doesn't appear when pressing up."""
144 so that interactive input to the code doesn't appear when pressing up."""
145 def __init__(self, shell):
145 def __init__(self, shell):
146 self.shell = shell
146 self.shell = shell
147 self._nested_level = 0
147 self._nested_level = 0
148
148
149 def __enter__(self):
149 def __enter__(self):
150 if self._nested_level == 0:
150 if self._nested_level == 0:
151 try:
151 try:
152 self.orig_length = self.current_length()
152 self.orig_length = self.current_length()
153 self.readline_tail = self.get_readline_tail()
153 self.readline_tail = self.get_readline_tail()
154 except (AttributeError, IndexError): # Can fail with pyreadline
154 except (AttributeError, IndexError): # Can fail with pyreadline
155 self.orig_length, self.readline_tail = 999999, []
155 self.orig_length, self.readline_tail = 999999, []
156 self._nested_level += 1
156 self._nested_level += 1
157
157
158 def __exit__(self, type, value, traceback):
158 def __exit__(self, type, value, traceback):
159 self._nested_level -= 1
159 self._nested_level -= 1
160 if self._nested_level == 0:
160 if self._nested_level == 0:
161 # Try clipping the end if it's got longer
161 # Try clipping the end if it's got longer
162 try:
162 try:
163 e = self.current_length() - self.orig_length
163 e = self.current_length() - self.orig_length
164 if e > 0:
164 if e > 0:
165 for _ in range(e):
165 for _ in range(e):
166 self.shell.readline.remove_history_item(self.orig_length)
166 self.shell.readline.remove_history_item(self.orig_length)
167
167
168 # If it still doesn't match, just reload readline history.
168 # If it still doesn't match, just reload readline history.
169 if self.current_length() != self.orig_length \
169 if self.current_length() != self.orig_length \
170 or self.get_readline_tail() != self.readline_tail:
170 or self.get_readline_tail() != self.readline_tail:
171 self.shell.refill_readline_hist()
171 self.shell.refill_readline_hist()
172 except (AttributeError, IndexError):
172 except (AttributeError, IndexError):
173 pass
173 pass
174 # Returning False will cause exceptions to propagate
174 # Returning False will cause exceptions to propagate
175 return False
175 return False
176
176
177 def current_length(self):
177 def current_length(self):
178 return self.shell.readline.get_current_history_length()
178 return self.shell.readline.get_current_history_length()
179
179
180 def get_readline_tail(self, n=10):
180 def get_readline_tail(self, n=10):
181 """Get the last n items in readline history."""
181 """Get the last n items in readline history."""
182 end = self.shell.readline.get_current_history_length() + 1
182 end = self.shell.readline.get_current_history_length() + 1
183 start = max(end-n, 1)
183 start = max(end-n, 1)
184 ghi = self.shell.readline.get_history_item
184 ghi = self.shell.readline.get_history_item
185 return [ghi(x) for x in range(start, end)]
185 return [ghi(x) for x in range(start, end)]
186
186
187 #-----------------------------------------------------------------------------
187 #-----------------------------------------------------------------------------
188 # Main IPython class
188 # Main IPython class
189 #-----------------------------------------------------------------------------
189 #-----------------------------------------------------------------------------
190
190
191 class InteractiveShell(SingletonConfigurable):
191 class InteractiveShell(SingletonConfigurable):
192 """An enhanced, interactive shell for Python."""
192 """An enhanced, interactive shell for Python."""
193
193
194 _instance = None
194 _instance = None
195
195
196 autocall = Enum((0,1,2), default_value=0, config=True, help=
196 autocall = Enum((0,1,2), default_value=0, config=True, help=
197 """
197 """
198 Make IPython automatically call any callable object even if you didn't
198 Make IPython automatically call any callable object even if you didn't
199 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
199 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
200 automatically. The value can be '0' to disable the feature, '1' for
200 automatically. The value can be '0' to disable the feature, '1' for
201 'smart' autocall, where it is not applied if there are no more
201 'smart' autocall, where it is not applied if there are no more
202 arguments on the line, and '2' for 'full' autocall, where all callable
202 arguments on the line, and '2' for 'full' autocall, where all callable
203 objects are automatically called (even if no arguments are present).
203 objects are automatically called (even if no arguments are present).
204 """
204 """
205 )
205 )
206 # TODO: remove all autoindent logic and put into frontends.
206 # TODO: remove all autoindent logic and put into frontends.
207 # We can't do this yet because even runlines uses the autoindent.
207 # We can't do this yet because even runlines uses the autoindent.
208 autoindent = CBool(True, config=True, help=
208 autoindent = CBool(True, config=True, help=
209 """
209 """
210 Autoindent IPython code entered interactively.
210 Autoindent IPython code entered interactively.
211 """
211 """
212 )
212 )
213 automagic = CBool(True, config=True, help=
213 automagic = CBool(True, config=True, help=
214 """
214 """
215 Enable magic commands to be called without the leading %.
215 Enable magic commands to be called without the leading %.
216 """
216 """
217 )
217 )
218 cache_size = Integer(1000, config=True, help=
218 cache_size = Integer(1000, config=True, help=
219 """
219 """
220 Set the size of the output cache. The default is 1000, you can
220 Set the size of the output cache. The default is 1000, you can
221 change it permanently in your config file. Setting it to 0 completely
221 change it permanently in your config file. Setting it to 0 completely
222 disables the caching system, and the minimum value accepted is 20 (if
222 disables the caching system, and the minimum value accepted is 20 (if
223 you provide a value less than 20, it is reset to 0 and a warning is
223 you provide a value less than 20, it is reset to 0 and a warning is
224 issued). This limit is defined because otherwise you'll spend more
224 issued). This limit is defined because otherwise you'll spend more
225 time re-flushing a too small cache than working
225 time re-flushing a too small cache than working
226 """
226 """
227 )
227 )
228 color_info = CBool(True, config=True, help=
228 color_info = CBool(True, config=True, help=
229 """
229 """
230 Use colors for displaying information about objects. Because this
230 Use colors for displaying information about objects. Because this
231 information is passed through a pager (like 'less'), and some pagers
231 information is passed through a pager (like 'less'), and some pagers
232 get confused with color codes, this capability can be turned off.
232 get confused with color codes, this capability can be turned off.
233 """
233 """
234 )
234 )
235 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
235 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
236 default_value=get_default_colors(), config=True,
236 default_value=get_default_colors(), config=True,
237 help="Set the color scheme (NoColor, Linux, or LightBG)."
237 help="Set the color scheme (NoColor, Linux, or LightBG)."
238 )
238 )
239 colors_force = CBool(False, help=
239 colors_force = CBool(False, help=
240 """
240 """
241 Force use of ANSI color codes, regardless of OS and readline
241 Force use of ANSI color codes, regardless of OS and readline
242 availability.
242 availability.
243 """
243 """
244 # FIXME: This is essentially a hack to allow ZMQShell to show colors
244 # FIXME: This is essentially a hack to allow ZMQShell to show colors
245 # without readline on Win32. When the ZMQ formatting system is
245 # without readline on Win32. When the ZMQ formatting system is
246 # refactored, this should be removed.
246 # refactored, this should be removed.
247 )
247 )
248 debug = CBool(False, config=True)
248 debug = CBool(False, config=True)
249 deep_reload = CBool(False, config=True, help=
249 deep_reload = CBool(False, config=True, help=
250 """
250 """
251 Enable deep (recursive) reloading by default. IPython can use the
251 Enable deep (recursive) reloading by default. IPython can use the
252 deep_reload module which reloads changes in modules recursively (it
252 deep_reload module which reloads changes in modules recursively (it
253 replaces the reload() function, so you don't need to change anything to
253 replaces the reload() function, so you don't need to change anything to
254 use it). deep_reload() forces a full reload of modules whose code may
254 use it). deep_reload() forces a full reload of modules whose code may
255 have changed, which the default reload() function does not. When
255 have changed, which the default reload() function does not. When
256 deep_reload is off, IPython will use the normal reload(), but
256 deep_reload is off, IPython will use the normal reload(), but
257 deep_reload will still be available as dreload().
257 deep_reload will still be available as dreload().
258 """
258 """
259 )
259 )
260 disable_failing_post_execute = CBool(False, config=True,
260 disable_failing_post_execute = CBool(False, config=True,
261 help="Don't call post-execute functions that have failed in the past."""
261 help="Don't call post-execute functions that have failed in the past."""
262 )
262 )
263 display_formatter = Instance(DisplayFormatter)
263 display_formatter = Instance(DisplayFormatter)
264 displayhook_class = Type(DisplayHook)
264 displayhook_class = Type(DisplayHook)
265 display_pub_class = Type(DisplayPublisher)
265 display_pub_class = Type(DisplayPublisher)
266
266
267 exit_now = CBool(False)
267 exit_now = CBool(False)
268 exiter = Instance(ExitAutocall)
268 exiter = Instance(ExitAutocall)
269 def _exiter_default(self):
269 def _exiter_default(self):
270 return ExitAutocall(self)
270 return ExitAutocall(self)
271 # Monotonically increasing execution counter
271 # Monotonically increasing execution counter
272 execution_count = Integer(1)
272 execution_count = Integer(1)
273 filename = Unicode("<ipython console>")
273 filename = Unicode("<ipython console>")
274 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
274 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
275
275
276 # Input splitter, to split entire cells of input into either individual
276 # Input splitter, to split entire cells of input into either individual
277 # interactive statements or whole blocks.
277 # interactive statements or whole blocks.
278 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
278 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
279 (), {})
279 (), {})
280 logstart = CBool(False, config=True, help=
280 logstart = CBool(False, config=True, help=
281 """
281 """
282 Start logging to the default log file.
282 Start logging to the default log file.
283 """
283 """
284 )
284 )
285 logfile = Unicode('', config=True, help=
285 logfile = Unicode('', config=True, help=
286 """
286 """
287 The name of the logfile to use.
287 The name of the logfile to use.
288 """
288 """
289 )
289 )
290 logappend = Unicode('', config=True, help=
290 logappend = Unicode('', config=True, help=
291 """
291 """
292 Start logging to the given file in append mode.
292 Start logging to the given file in append mode.
293 """
293 """
294 )
294 )
295 object_info_string_level = Enum((0,1,2), default_value=0,
295 object_info_string_level = Enum((0,1,2), default_value=0,
296 config=True)
296 config=True)
297 pdb = CBool(False, config=True, help=
297 pdb = CBool(False, config=True, help=
298 """
298 """
299 Automatically call the pdb debugger after every exception.
299 Automatically call the pdb debugger after every exception.
300 """
300 """
301 )
301 )
302 multiline_history = CBool(sys.platform != 'win32', config=True,
302 multiline_history = CBool(sys.platform != 'win32', config=True,
303 help="Save multi-line entries as one entry in readline history"
303 help="Save multi-line entries as one entry in readline history"
304 )
304 )
305
305
306 # deprecated prompt traits:
306 # deprecated prompt traits:
307
307
308 prompt_in1 = Unicode('In [\\#]: ', config=True,
308 prompt_in1 = Unicode('In [\\#]: ', config=True,
309 help="Deprecated, use PromptManager.in_template")
309 help="Deprecated, use PromptManager.in_template")
310 prompt_in2 = Unicode(' .\\D.: ', config=True,
310 prompt_in2 = Unicode(' .\\D.: ', config=True,
311 help="Deprecated, use PromptManager.in2_template")
311 help="Deprecated, use PromptManager.in2_template")
312 prompt_out = Unicode('Out[\\#]: ', config=True,
312 prompt_out = Unicode('Out[\\#]: ', config=True,
313 help="Deprecated, use PromptManager.out_template")
313 help="Deprecated, use PromptManager.out_template")
314 prompts_pad_left = CBool(True, config=True,
314 prompts_pad_left = CBool(True, config=True,
315 help="Deprecated, use PromptManager.justify")
315 help="Deprecated, use PromptManager.justify")
316
316
317 def _prompt_trait_changed(self, name, old, new):
317 def _prompt_trait_changed(self, name, old, new):
318 table = {
318 table = {
319 'prompt_in1' : 'in_template',
319 'prompt_in1' : 'in_template',
320 'prompt_in2' : 'in2_template',
320 'prompt_in2' : 'in2_template',
321 'prompt_out' : 'out_template',
321 'prompt_out' : 'out_template',
322 'prompts_pad_left' : 'justify',
322 'prompts_pad_left' : 'justify',
323 }
323 }
324 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format(
324 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format(
325 name=name, newname=table[name])
325 name=name, newname=table[name])
326 )
326 )
327 # protect against weird cases where self.config may not exist:
327 # protect against weird cases where self.config may not exist:
328 if self.config is not None:
328 if self.config is not None:
329 # propagate to corresponding PromptManager trait
329 # propagate to corresponding PromptManager trait
330 setattr(self.config.PromptManager, table[name], new)
330 setattr(self.config.PromptManager, table[name], new)
331
331
332 _prompt_in1_changed = _prompt_trait_changed
332 _prompt_in1_changed = _prompt_trait_changed
333 _prompt_in2_changed = _prompt_trait_changed
333 _prompt_in2_changed = _prompt_trait_changed
334 _prompt_out_changed = _prompt_trait_changed
334 _prompt_out_changed = _prompt_trait_changed
335 _prompt_pad_left_changed = _prompt_trait_changed
335 _prompt_pad_left_changed = _prompt_trait_changed
336
336
337 show_rewritten_input = CBool(True, config=True,
337 show_rewritten_input = CBool(True, config=True,
338 help="Show rewritten input, e.g. for autocall."
338 help="Show rewritten input, e.g. for autocall."
339 )
339 )
340
340
341 quiet = CBool(False, config=True)
341 quiet = CBool(False, config=True)
342
342
343 history_length = Integer(10000, config=True)
343 history_length = Integer(10000, config=True)
344
344
345 # The readline stuff will eventually be moved to the terminal subclass
345 # The readline stuff will eventually be moved to the terminal subclass
346 # but for now, we can't do that as readline is welded in everywhere.
346 # but for now, we can't do that as readline is welded in everywhere.
347 readline_use = CBool(True, config=True)
347 readline_use = CBool(True, config=True)
348 readline_remove_delims = Unicode('-/~', config=True)
348 readline_remove_delims = Unicode('-/~', config=True)
349 # don't use \M- bindings by default, because they
349 # don't use \M- bindings by default, because they
350 # conflict with 8-bit encodings. See gh-58,gh-88
350 # conflict with 8-bit encodings. See gh-58,gh-88
351 readline_parse_and_bind = List([
351 readline_parse_and_bind = List([
352 'tab: complete',
352 'tab: complete',
353 '"\C-l": clear-screen',
353 '"\C-l": clear-screen',
354 'set show-all-if-ambiguous on',
354 'set show-all-if-ambiguous on',
355 '"\C-o": tab-insert',
355 '"\C-o": tab-insert',
356 '"\C-r": reverse-search-history',
356 '"\C-r": reverse-search-history',
357 '"\C-s": forward-search-history',
357 '"\C-s": forward-search-history',
358 '"\C-p": history-search-backward',
358 '"\C-p": history-search-backward',
359 '"\C-n": history-search-forward',
359 '"\C-n": history-search-forward',
360 '"\e[A": history-search-backward',
360 '"\e[A": history-search-backward',
361 '"\e[B": history-search-forward',
361 '"\e[B": history-search-forward',
362 '"\C-k": kill-line',
362 '"\C-k": kill-line',
363 '"\C-u": unix-line-discard',
363 '"\C-u": unix-line-discard',
364 ], allow_none=False, config=True)
364 ], allow_none=False, config=True)
365
365
366 # TODO: this part of prompt management should be moved to the frontends.
366 # TODO: this part of prompt management should be moved to the frontends.
367 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
367 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
368 separate_in = SeparateUnicode('\n', config=True)
368 separate_in = SeparateUnicode('\n', config=True)
369 separate_out = SeparateUnicode('', config=True)
369 separate_out = SeparateUnicode('', config=True)
370 separate_out2 = SeparateUnicode('', config=True)
370 separate_out2 = SeparateUnicode('', config=True)
371 wildcards_case_sensitive = CBool(True, config=True)
371 wildcards_case_sensitive = CBool(True, config=True)
372 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
372 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
373 default_value='Context', config=True)
373 default_value='Context', config=True)
374
374
375 # Subcomponents of InteractiveShell
375 # Subcomponents of InteractiveShell
376 alias_manager = Instance('IPython.core.alias.AliasManager')
376 alias_manager = Instance('IPython.core.alias.AliasManager')
377 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
377 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
378 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
378 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
379 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
379 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
380 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
380 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
381 plugin_manager = Instance('IPython.core.plugin.PluginManager')
381 plugin_manager = Instance('IPython.core.plugin.PluginManager')
382 payload_manager = Instance('IPython.core.payload.PayloadManager')
382 payload_manager = Instance('IPython.core.payload.PayloadManager')
383 history_manager = Instance('IPython.core.history.HistoryManager')
383 history_manager = Instance('IPython.core.history.HistoryManager')
384 magics_manager = Instance('IPython.core.magic.MagicsManager')
384 magics_manager = Instance('IPython.core.magic.MagicsManager')
385
385
386 profile_dir = Instance('IPython.core.application.ProfileDir')
386 profile_dir = Instance('IPython.core.application.ProfileDir')
387 @property
387 @property
388 def profile(self):
388 def profile(self):
389 if self.profile_dir is not None:
389 if self.profile_dir is not None:
390 name = os.path.basename(self.profile_dir.location)
390 name = os.path.basename(self.profile_dir.location)
391 return name.replace('profile_','')
391 return name.replace('profile_','')
392
392
393
393
394 # Private interface
394 # Private interface
395 _post_execute = Instance(dict)
395 _post_execute = Instance(dict)
396
396
397 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
397 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
398 user_module=None, user_ns=None,
398 user_module=None, user_ns=None,
399 custom_exceptions=((), None)):
399 custom_exceptions=((), None)):
400
400
401 # This is where traits with a config_key argument are updated
401 # This is where traits with a config_key argument are updated
402 # from the values on config.
402 # from the values on config.
403 super(InteractiveShell, self).__init__(config=config)
403 super(InteractiveShell, self).__init__(config=config)
404 self.configurables = [self]
404 self.configurables = [self]
405
405
406 # These are relatively independent and stateless
406 # These are relatively independent and stateless
407 self.init_ipython_dir(ipython_dir)
407 self.init_ipython_dir(ipython_dir)
408 self.init_profile_dir(profile_dir)
408 self.init_profile_dir(profile_dir)
409 self.init_instance_attrs()
409 self.init_instance_attrs()
410 self.init_environment()
410 self.init_environment()
411
411
412 # Check if we're in a virtualenv, and set up sys.path.
412 # Check if we're in a virtualenv, and set up sys.path.
413 self.init_virtualenv()
413 self.init_virtualenv()
414
414
415 # Create namespaces (user_ns, user_global_ns, etc.)
415 # Create namespaces (user_ns, user_global_ns, etc.)
416 self.init_create_namespaces(user_module, user_ns)
416 self.init_create_namespaces(user_module, user_ns)
417 # This has to be done after init_create_namespaces because it uses
417 # This has to be done after init_create_namespaces because it uses
418 # something in self.user_ns, but before init_sys_modules, which
418 # something in self.user_ns, but before init_sys_modules, which
419 # is the first thing to modify sys.
419 # is the first thing to modify sys.
420 # TODO: When we override sys.stdout and sys.stderr before this class
420 # TODO: When we override sys.stdout and sys.stderr before this class
421 # is created, we are saving the overridden ones here. Not sure if this
421 # is created, we are saving the overridden ones here. Not sure if this
422 # is what we want to do.
422 # is what we want to do.
423 self.save_sys_module_state()
423 self.save_sys_module_state()
424 self.init_sys_modules()
424 self.init_sys_modules()
425
425
426 # While we're trying to have each part of the code directly access what
426 # While we're trying to have each part of the code directly access what
427 # it needs without keeping redundant references to objects, we have too
427 # it needs without keeping redundant references to objects, we have too
428 # much legacy code that expects ip.db to exist.
428 # much legacy code that expects ip.db to exist.
429 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
429 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
430
430
431 self.init_history()
431 self.init_history()
432 self.init_encoding()
432 self.init_encoding()
433 self.init_prefilter()
433 self.init_prefilter()
434
434
435 self.init_syntax_highlighting()
435 self.init_syntax_highlighting()
436 self.init_hooks()
436 self.init_hooks()
437 self.init_pushd_popd_magic()
437 self.init_pushd_popd_magic()
438 # self.init_traceback_handlers use to be here, but we moved it below
438 # self.init_traceback_handlers use to be here, but we moved it below
439 # because it and init_io have to come after init_readline.
439 # because it and init_io have to come after init_readline.
440 self.init_user_ns()
440 self.init_user_ns()
441 self.init_logger()
441 self.init_logger()
442 self.init_alias()
442 self.init_alias()
443 self.init_builtins()
443 self.init_builtins()
444
444
445 # pre_config_initialization
445 # pre_config_initialization
446
446
447 # The next section should contain everything that was in ipmaker.
447 # The next section should contain everything that was in ipmaker.
448 self.init_logstart()
448 self.init_logstart()
449
449
450 # The following was in post_config_initialization
450 # The following was in post_config_initialization
451 self.init_inspector()
451 self.init_inspector()
452 # init_readline() must come before init_io(), because init_io uses
452 # init_readline() must come before init_io(), because init_io uses
453 # readline related things.
453 # readline related things.
454 self.init_readline()
454 self.init_readline()
455 # We save this here in case user code replaces raw_input, but it needs
455 # We save this here in case user code replaces raw_input, but it needs
456 # to be after init_readline(), because PyPy's readline works by replacing
456 # to be after init_readline(), because PyPy's readline works by replacing
457 # raw_input.
457 # raw_input.
458 if py3compat.PY3:
458 if py3compat.PY3:
459 self.raw_input_original = input
459 self.raw_input_original = input
460 else:
460 else:
461 self.raw_input_original = raw_input
461 self.raw_input_original = raw_input
462 # init_completer must come after init_readline, because it needs to
462 # init_completer must come after init_readline, because it needs to
463 # know whether readline is present or not system-wide to configure the
463 # know whether readline is present or not system-wide to configure the
464 # completers, since the completion machinery can now operate
464 # completers, since the completion machinery can now operate
465 # independently of readline (e.g. over the network)
465 # independently of readline (e.g. over the network)
466 self.init_completer()
466 self.init_completer()
467 # TODO: init_io() needs to happen before init_traceback handlers
467 # TODO: init_io() needs to happen before init_traceback handlers
468 # because the traceback handlers hardcode the stdout/stderr streams.
468 # because the traceback handlers hardcode the stdout/stderr streams.
469 # This logic in in debugger.Pdb and should eventually be changed.
469 # This logic in in debugger.Pdb and should eventually be changed.
470 self.init_io()
470 self.init_io()
471 self.init_traceback_handlers(custom_exceptions)
471 self.init_traceback_handlers(custom_exceptions)
472 self.init_prompts()
472 self.init_prompts()
473 self.init_display_formatter()
473 self.init_display_formatter()
474 self.init_display_pub()
474 self.init_display_pub()
475 self.init_displayhook()
475 self.init_displayhook()
476 self.init_reload_doctest()
476 self.init_reload_doctest()
477 self.init_magics()
477 self.init_magics()
478 self.init_pdb()
478 self.init_pdb()
479 self.init_extension_manager()
479 self.init_extension_manager()
480 self.init_plugin_manager()
480 self.init_plugin_manager()
481 self.init_payload()
481 self.init_payload()
482 self.hooks.late_startup_hook()
482 self.hooks.late_startup_hook()
483 atexit.register(self.atexit_operations)
483 atexit.register(self.atexit_operations)
484
484
485 def get_ipython(self):
485 def get_ipython(self):
486 """Return the currently running IPython instance."""
486 """Return the currently running IPython instance."""
487 return self
487 return self
488
488
489 #-------------------------------------------------------------------------
489 #-------------------------------------------------------------------------
490 # Trait changed handlers
490 # Trait changed handlers
491 #-------------------------------------------------------------------------
491 #-------------------------------------------------------------------------
492
492
493 def _ipython_dir_changed(self, name, new):
493 def _ipython_dir_changed(self, name, new):
494 if not os.path.isdir(new):
494 if not os.path.isdir(new):
495 os.makedirs(new, mode = 0777)
495 os.makedirs(new, mode = 0777)
496
496
497 def set_autoindent(self,value=None):
497 def set_autoindent(self,value=None):
498 """Set the autoindent flag, checking for readline support.
498 """Set the autoindent flag, checking for readline support.
499
499
500 If called with no arguments, it acts as a toggle."""
500 If called with no arguments, it acts as a toggle."""
501
501
502 if value != 0 and not self.has_readline:
502 if value != 0 and not self.has_readline:
503 if os.name == 'posix':
503 if os.name == 'posix':
504 warn("The auto-indent feature requires the readline library")
504 warn("The auto-indent feature requires the readline library")
505 self.autoindent = 0
505 self.autoindent = 0
506 return
506 return
507 if value is None:
507 if value is None:
508 self.autoindent = not self.autoindent
508 self.autoindent = not self.autoindent
509 else:
509 else:
510 self.autoindent = value
510 self.autoindent = value
511
511
512 #-------------------------------------------------------------------------
512 #-------------------------------------------------------------------------
513 # init_* methods called by __init__
513 # init_* methods called by __init__
514 #-------------------------------------------------------------------------
514 #-------------------------------------------------------------------------
515
515
516 def init_ipython_dir(self, ipython_dir):
516 def init_ipython_dir(self, ipython_dir):
517 if ipython_dir is not None:
517 if ipython_dir is not None:
518 self.ipython_dir = ipython_dir
518 self.ipython_dir = ipython_dir
519 return
519 return
520
520
521 self.ipython_dir = get_ipython_dir()
521 self.ipython_dir = get_ipython_dir()
522
522
523 def init_profile_dir(self, profile_dir):
523 def init_profile_dir(self, profile_dir):
524 if profile_dir is not None:
524 if profile_dir is not None:
525 self.profile_dir = profile_dir
525 self.profile_dir = profile_dir
526 return
526 return
527 self.profile_dir =\
527 self.profile_dir =\
528 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
528 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
529
529
530 def init_instance_attrs(self):
530 def init_instance_attrs(self):
531 self.more = False
531 self.more = False
532
532
533 # command compiler
533 # command compiler
534 self.compile = CachingCompiler()
534 self.compile = CachingCompiler()
535
535
536 # Make an empty namespace, which extension writers can rely on both
536 # Make an empty namespace, which extension writers can rely on both
537 # existing and NEVER being used by ipython itself. This gives them a
537 # existing and NEVER being used by ipython itself. This gives them a
538 # convenient location for storing additional information and state
538 # convenient location for storing additional information and state
539 # their extensions may require, without fear of collisions with other
539 # their extensions may require, without fear of collisions with other
540 # ipython names that may develop later.
540 # ipython names that may develop later.
541 self.meta = Struct()
541 self.meta = Struct()
542
542
543 # Temporary files used for various purposes. Deleted at exit.
543 # Temporary files used for various purposes. Deleted at exit.
544 self.tempfiles = []
544 self.tempfiles = []
545
545
546 # Keep track of readline usage (later set by init_readline)
546 # Keep track of readline usage (later set by init_readline)
547 self.has_readline = False
547 self.has_readline = False
548
548
549 # keep track of where we started running (mainly for crash post-mortem)
549 # keep track of where we started running (mainly for crash post-mortem)
550 # This is not being used anywhere currently.
550 # This is not being used anywhere currently.
551 self.starting_dir = os.getcwdu()
551 self.starting_dir = os.getcwdu()
552
552
553 # Indentation management
553 # Indentation management
554 self.indent_current_nsp = 0
554 self.indent_current_nsp = 0
555
555
556 # Dict to track post-execution functions that have been registered
556 # Dict to track post-execution functions that have been registered
557 self._post_execute = {}
557 self._post_execute = {}
558
558
559 def init_environment(self):
559 def init_environment(self):
560 """Any changes we need to make to the user's environment."""
560 """Any changes we need to make to the user's environment."""
561 pass
561 pass
562
562
563 def init_encoding(self):
563 def init_encoding(self):
564 # Get system encoding at startup time. Certain terminals (like Emacs
564 # Get system encoding at startup time. Certain terminals (like Emacs
565 # under Win32 have it set to None, and we need to have a known valid
565 # under Win32 have it set to None, and we need to have a known valid
566 # encoding to use in the raw_input() method
566 # encoding to use in the raw_input() method
567 try:
567 try:
568 self.stdin_encoding = sys.stdin.encoding or 'ascii'
568 self.stdin_encoding = sys.stdin.encoding or 'ascii'
569 except AttributeError:
569 except AttributeError:
570 self.stdin_encoding = 'ascii'
570 self.stdin_encoding = 'ascii'
571
571
572 def init_syntax_highlighting(self):
572 def init_syntax_highlighting(self):
573 # Python source parser/formatter for syntax highlighting
573 # Python source parser/formatter for syntax highlighting
574 pyformat = PyColorize.Parser().format
574 pyformat = PyColorize.Parser().format
575 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
575 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
576
576
577 def init_pushd_popd_magic(self):
577 def init_pushd_popd_magic(self):
578 # for pushd/popd management
578 # for pushd/popd management
579 self.home_dir = get_home_dir()
579 self.home_dir = get_home_dir()
580
580
581 self.dir_stack = []
581 self.dir_stack = []
582
582
583 def init_logger(self):
583 def init_logger(self):
584 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
584 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
585 logmode='rotate')
585 logmode='rotate')
586
586
587 def init_logstart(self):
587 def init_logstart(self):
588 """Initialize logging in case it was requested at the command line.
588 """Initialize logging in case it was requested at the command line.
589 """
589 """
590 if self.logappend:
590 if self.logappend:
591 self.magic('logstart %s append' % self.logappend)
591 self.magic('logstart %s append' % self.logappend)
592 elif self.logfile:
592 elif self.logfile:
593 self.magic('logstart %' % self.logfile)
593 self.magic('logstart %' % self.logfile)
594 elif self.logstart:
594 elif self.logstart:
595 self.magic('logstart')
595 self.magic('logstart')
596
596
597 def init_builtins(self):
597 def init_builtins(self):
598 # A single, static flag that we set to True. Its presence indicates
598 # A single, static flag that we set to True. Its presence indicates
599 # that an IPython shell has been created, and we make no attempts at
599 # that an IPython shell has been created, and we make no attempts at
600 # removing on exit or representing the existence of more than one
600 # removing on exit or representing the existence of more than one
601 # IPython at a time.
601 # IPython at a time.
602 builtin_mod.__dict__['__IPYTHON__'] = True
602 builtin_mod.__dict__['__IPYTHON__'] = True
603
603
604 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
604 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
605 # manage on enter/exit, but with all our shells it's virtually
605 # manage on enter/exit, but with all our shells it's virtually
606 # impossible to get all the cases right. We're leaving the name in for
606 # impossible to get all the cases right. We're leaving the name in for
607 # those who adapted their codes to check for this flag, but will
607 # those who adapted their codes to check for this flag, but will
608 # eventually remove it after a few more releases.
608 # eventually remove it after a few more releases.
609 builtin_mod.__dict__['__IPYTHON__active'] = \
609 builtin_mod.__dict__['__IPYTHON__active'] = \
610 'Deprecated, check for __IPYTHON__'
610 'Deprecated, check for __IPYTHON__'
611
611
612 self.builtin_trap = BuiltinTrap(shell=self)
612 self.builtin_trap = BuiltinTrap(shell=self)
613
613
614 def init_inspector(self):
614 def init_inspector(self):
615 # Object inspector
615 # Object inspector
616 self.inspector = oinspect.Inspector(oinspect.InspectColors,
616 self.inspector = oinspect.Inspector(oinspect.InspectColors,
617 PyColorize.ANSICodeColors,
617 PyColorize.ANSICodeColors,
618 'NoColor',
618 'NoColor',
619 self.object_info_string_level)
619 self.object_info_string_level)
620
620
621 def init_io(self):
621 def init_io(self):
622 # This will just use sys.stdout and sys.stderr. If you want to
622 # This will just use sys.stdout and sys.stderr. If you want to
623 # override sys.stdout and sys.stderr themselves, you need to do that
623 # override sys.stdout and sys.stderr themselves, you need to do that
624 # *before* instantiating this class, because io holds onto
624 # *before* instantiating this class, because io holds onto
625 # references to the underlying streams.
625 # references to the underlying streams.
626 if sys.platform == 'win32' and self.has_readline:
626 if sys.platform == 'win32' and self.has_readline:
627 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
627 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
628 else:
628 else:
629 io.stdout = io.IOStream(sys.stdout)
629 io.stdout = io.IOStream(sys.stdout)
630 io.stderr = io.IOStream(sys.stderr)
630 io.stderr = io.IOStream(sys.stderr)
631
631
632 def init_prompts(self):
632 def init_prompts(self):
633 self.prompt_manager = PromptManager(shell=self, config=self.config)
633 self.prompt_manager = PromptManager(shell=self, config=self.config)
634 self.configurables.append(self.prompt_manager)
634 self.configurables.append(self.prompt_manager)
635 # Set system prompts, so that scripts can decide if they are running
635 # Set system prompts, so that scripts can decide if they are running
636 # interactively.
636 # interactively.
637 sys.ps1 = 'In : '
637 sys.ps1 = 'In : '
638 sys.ps2 = '...: '
638 sys.ps2 = '...: '
639 sys.ps3 = 'Out: '
639 sys.ps3 = 'Out: '
640
640
641 def init_display_formatter(self):
641 def init_display_formatter(self):
642 self.display_formatter = DisplayFormatter(config=self.config)
642 self.display_formatter = DisplayFormatter(config=self.config)
643 self.configurables.append(self.display_formatter)
643 self.configurables.append(self.display_formatter)
644
644
645 def init_display_pub(self):
645 def init_display_pub(self):
646 self.display_pub = self.display_pub_class(config=self.config)
646 self.display_pub = self.display_pub_class(config=self.config)
647 self.configurables.append(self.display_pub)
647 self.configurables.append(self.display_pub)
648
648
649 def init_displayhook(self):
649 def init_displayhook(self):
650 # Initialize displayhook, set in/out prompts and printing system
650 # Initialize displayhook, set in/out prompts and printing system
651 self.displayhook = self.displayhook_class(
651 self.displayhook = self.displayhook_class(
652 config=self.config,
652 config=self.config,
653 shell=self,
653 shell=self,
654 cache_size=self.cache_size,
654 cache_size=self.cache_size,
655 )
655 )
656 self.configurables.append(self.displayhook)
656 self.configurables.append(self.displayhook)
657 # This is a context manager that installs/revmoes the displayhook at
657 # This is a context manager that installs/revmoes the displayhook at
658 # the appropriate time.
658 # the appropriate time.
659 self.display_trap = DisplayTrap(hook=self.displayhook)
659 self.display_trap = DisplayTrap(hook=self.displayhook)
660
660
661 def init_reload_doctest(self):
661 def init_reload_doctest(self):
662 # Do a proper resetting of doctest, including the necessary displayhook
662 # Do a proper resetting of doctest, including the necessary displayhook
663 # monkeypatching
663 # monkeypatching
664 try:
664 try:
665 doctest_reload()
665 doctest_reload()
666 except ImportError:
666 except ImportError:
667 warn("doctest module does not exist.")
667 warn("doctest module does not exist.")
668
668
669 def init_virtualenv(self):
669 def init_virtualenv(self):
670 """Add a virtualenv to sys.path so the user can import modules from it.
670 """Add a virtualenv to sys.path so the user can import modules from it.
671 This isn't perfect: it doesn't use the Python interpreter with which the
671 This isn't perfect: it doesn't use the Python interpreter with which the
672 virtualenv was built, and it ignores the --no-site-packages option. A
672 virtualenv was built, and it ignores the --no-site-packages option. A
673 warning will appear suggesting the user installs IPython in the
673 warning will appear suggesting the user installs IPython in the
674 virtualenv, but for many cases, it probably works well enough.
674 virtualenv, but for many cases, it probably works well enough.
675
675
676 Adapted from code snippets online.
676 Adapted from code snippets online.
677
677
678 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
678 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
679 """
679 """
680 if 'VIRTUAL_ENV' not in os.environ:
680 if 'VIRTUAL_ENV' not in os.environ:
681 # Not in a virtualenv
681 # Not in a virtualenv
682 return
682 return
683
683
684 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
684 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
685 # Running properly in the virtualenv, don't need to do anything
685 # Running properly in the virtualenv, don't need to do anything
686 return
686 return
687
687
688 warn("Attempting to work in a virtualenv. If you encounter problems, please "
688 warn("Attempting to work in a virtualenv. If you encounter problems, please "
689 "install IPython inside the virtualenv.\n")
689 "install IPython inside the virtualenv.\n")
690 if sys.platform == "win32":
690 if sys.platform == "win32":
691 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
691 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
692 else:
692 else:
693 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
693 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
694 'python%d.%d' % sys.version_info[:2], 'site-packages')
694 'python%d.%d' % sys.version_info[:2], 'site-packages')
695
695
696 import site
696 import site
697 sys.path.insert(0, virtual_env)
697 sys.path.insert(0, virtual_env)
698 site.addsitedir(virtual_env)
698 site.addsitedir(virtual_env)
699
699
700 #-------------------------------------------------------------------------
700 #-------------------------------------------------------------------------
701 # Things related to injections into the sys module
701 # Things related to injections into the sys module
702 #-------------------------------------------------------------------------
702 #-------------------------------------------------------------------------
703
703
704 def save_sys_module_state(self):
704 def save_sys_module_state(self):
705 """Save the state of hooks in the sys module.
705 """Save the state of hooks in the sys module.
706
706
707 This has to be called after self.user_module is created.
707 This has to be called after self.user_module is created.
708 """
708 """
709 self._orig_sys_module_state = {}
709 self._orig_sys_module_state = {}
710 self._orig_sys_module_state['stdin'] = sys.stdin
710 self._orig_sys_module_state['stdin'] = sys.stdin
711 self._orig_sys_module_state['stdout'] = sys.stdout
711 self._orig_sys_module_state['stdout'] = sys.stdout
712 self._orig_sys_module_state['stderr'] = sys.stderr
712 self._orig_sys_module_state['stderr'] = sys.stderr
713 self._orig_sys_module_state['excepthook'] = sys.excepthook
713 self._orig_sys_module_state['excepthook'] = sys.excepthook
714 self._orig_sys_modules_main_name = self.user_module.__name__
714 self._orig_sys_modules_main_name = self.user_module.__name__
715 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
715 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
716
716
717 def restore_sys_module_state(self):
717 def restore_sys_module_state(self):
718 """Restore the state of the sys module."""
718 """Restore the state of the sys module."""
719 try:
719 try:
720 for k, v in self._orig_sys_module_state.iteritems():
720 for k, v in self._orig_sys_module_state.iteritems():
721 setattr(sys, k, v)
721 setattr(sys, k, v)
722 except AttributeError:
722 except AttributeError:
723 pass
723 pass
724 # Reset what what done in self.init_sys_modules
724 # Reset what what done in self.init_sys_modules
725 if self._orig_sys_modules_main_mod is not None:
725 if self._orig_sys_modules_main_mod is not None:
726 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
726 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
727
727
728 #-------------------------------------------------------------------------
728 #-------------------------------------------------------------------------
729 # Things related to hooks
729 # Things related to hooks
730 #-------------------------------------------------------------------------
730 #-------------------------------------------------------------------------
731
731
732 def init_hooks(self):
732 def init_hooks(self):
733 # hooks holds pointers used for user-side customizations
733 # hooks holds pointers used for user-side customizations
734 self.hooks = Struct()
734 self.hooks = Struct()
735
735
736 self.strdispatchers = {}
736 self.strdispatchers = {}
737
737
738 # Set all default hooks, defined in the IPython.hooks module.
738 # Set all default hooks, defined in the IPython.hooks module.
739 hooks = IPython.core.hooks
739 hooks = IPython.core.hooks
740 for hook_name in hooks.__all__:
740 for hook_name in hooks.__all__:
741 # default hooks have priority 100, i.e. low; user hooks should have
741 # default hooks have priority 100, i.e. low; user hooks should have
742 # 0-100 priority
742 # 0-100 priority
743 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
743 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
744
744
745 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
745 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
746 """set_hook(name,hook) -> sets an internal IPython hook.
746 """set_hook(name,hook) -> sets an internal IPython hook.
747
747
748 IPython exposes some of its internal API as user-modifiable hooks. By
748 IPython exposes some of its internal API as user-modifiable hooks. By
749 adding your function to one of these hooks, you can modify IPython's
749 adding your function to one of these hooks, you can modify IPython's
750 behavior to call at runtime your own routines."""
750 behavior to call at runtime your own routines."""
751
751
752 # At some point in the future, this should validate the hook before it
752 # At some point in the future, this should validate the hook before it
753 # accepts it. Probably at least check that the hook takes the number
753 # accepts it. Probably at least check that the hook takes the number
754 # of args it's supposed to.
754 # of args it's supposed to.
755
755
756 f = types.MethodType(hook,self)
756 f = types.MethodType(hook,self)
757
757
758 # check if the hook is for strdispatcher first
758 # check if the hook is for strdispatcher first
759 if str_key is not None:
759 if str_key is not None:
760 sdp = self.strdispatchers.get(name, StrDispatch())
760 sdp = self.strdispatchers.get(name, StrDispatch())
761 sdp.add_s(str_key, f, priority )
761 sdp.add_s(str_key, f, priority )
762 self.strdispatchers[name] = sdp
762 self.strdispatchers[name] = sdp
763 return
763 return
764 if re_key is not None:
764 if re_key is not None:
765 sdp = self.strdispatchers.get(name, StrDispatch())
765 sdp = self.strdispatchers.get(name, StrDispatch())
766 sdp.add_re(re.compile(re_key), f, priority )
766 sdp.add_re(re.compile(re_key), f, priority )
767 self.strdispatchers[name] = sdp
767 self.strdispatchers[name] = sdp
768 return
768 return
769
769
770 dp = getattr(self.hooks, name, None)
770 dp = getattr(self.hooks, name, None)
771 if name not in IPython.core.hooks.__all__:
771 if name not in IPython.core.hooks.__all__:
772 print "Warning! Hook '%s' is not one of %s" % \
772 print "Warning! Hook '%s' is not one of %s" % \
773 (name, IPython.core.hooks.__all__ )
773 (name, IPython.core.hooks.__all__ )
774 if not dp:
774 if not dp:
775 dp = IPython.core.hooks.CommandChainDispatcher()
775 dp = IPython.core.hooks.CommandChainDispatcher()
776
776
777 try:
777 try:
778 dp.add(f,priority)
778 dp.add(f,priority)
779 except AttributeError:
779 except AttributeError:
780 # it was not commandchain, plain old func - replace
780 # it was not commandchain, plain old func - replace
781 dp = f
781 dp = f
782
782
783 setattr(self.hooks,name, dp)
783 setattr(self.hooks,name, dp)
784
784
785 def register_post_execute(self, func):
785 def register_post_execute(self, func):
786 """Register a function for calling after code execution.
786 """Register a function for calling after code execution.
787 """
787 """
788 if not callable(func):
788 if not callable(func):
789 raise ValueError('argument %s must be callable' % func)
789 raise ValueError('argument %s must be callable' % func)
790 self._post_execute[func] = True
790 self._post_execute[func] = True
791
791
792 #-------------------------------------------------------------------------
792 #-------------------------------------------------------------------------
793 # Things related to the "main" module
793 # Things related to the "main" module
794 #-------------------------------------------------------------------------
794 #-------------------------------------------------------------------------
795
795
796 def new_main_mod(self,ns=None):
796 def new_main_mod(self,ns=None):
797 """Return a new 'main' module object for user code execution.
797 """Return a new 'main' module object for user code execution.
798 """
798 """
799 main_mod = self._user_main_module
799 main_mod = self._user_main_module
800 init_fakemod_dict(main_mod,ns)
800 init_fakemod_dict(main_mod,ns)
801 return main_mod
801 return main_mod
802
802
803 def cache_main_mod(self,ns,fname):
803 def cache_main_mod(self,ns,fname):
804 """Cache a main module's namespace.
804 """Cache a main module's namespace.
805
805
806 When scripts are executed via %run, we must keep a reference to the
806 When scripts are executed via %run, we must keep a reference to the
807 namespace of their __main__ module (a FakeModule instance) around so
807 namespace of their __main__ module (a FakeModule instance) around so
808 that Python doesn't clear it, rendering objects defined therein
808 that Python doesn't clear it, rendering objects defined therein
809 useless.
809 useless.
810
810
811 This method keeps said reference in a private dict, keyed by the
811 This method keeps said reference in a private dict, keyed by the
812 absolute path of the module object (which corresponds to the script
812 absolute path of the module object (which corresponds to the script
813 path). This way, for multiple executions of the same script we only
813 path). This way, for multiple executions of the same script we only
814 keep one copy of the namespace (the last one), thus preventing memory
814 keep one copy of the namespace (the last one), thus preventing memory
815 leaks from old references while allowing the objects from the last
815 leaks from old references while allowing the objects from the last
816 execution to be accessible.
816 execution to be accessible.
817
817
818 Note: we can not allow the actual FakeModule instances to be deleted,
818 Note: we can not allow the actual FakeModule instances to be deleted,
819 because of how Python tears down modules (it hard-sets all their
819 because of how Python tears down modules (it hard-sets all their
820 references to None without regard for reference counts). This method
820 references to None without regard for reference counts). This method
821 must therefore make a *copy* of the given namespace, to allow the
821 must therefore make a *copy* of the given namespace, to allow the
822 original module's __dict__ to be cleared and reused.
822 original module's __dict__ to be cleared and reused.
823
823
824
824
825 Parameters
825 Parameters
826 ----------
826 ----------
827 ns : a namespace (a dict, typically)
827 ns : a namespace (a dict, typically)
828
828
829 fname : str
829 fname : str
830 Filename associated with the namespace.
830 Filename associated with the namespace.
831
831
832 Examples
832 Examples
833 --------
833 --------
834
834
835 In [10]: import IPython
835 In [10]: import IPython
836
836
837 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
837 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
838
838
839 In [12]: IPython.__file__ in _ip._main_ns_cache
839 In [12]: IPython.__file__ in _ip._main_ns_cache
840 Out[12]: True
840 Out[12]: True
841 """
841 """
842 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
842 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
843
843
844 def clear_main_mod_cache(self):
844 def clear_main_mod_cache(self):
845 """Clear the cache of main modules.
845 """Clear the cache of main modules.
846
846
847 Mainly for use by utilities like %reset.
847 Mainly for use by utilities like %reset.
848
848
849 Examples
849 Examples
850 --------
850 --------
851
851
852 In [15]: import IPython
852 In [15]: import IPython
853
853
854 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
854 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
855
855
856 In [17]: len(_ip._main_ns_cache) > 0
856 In [17]: len(_ip._main_ns_cache) > 0
857 Out[17]: True
857 Out[17]: True
858
858
859 In [18]: _ip.clear_main_mod_cache()
859 In [18]: _ip.clear_main_mod_cache()
860
860
861 In [19]: len(_ip._main_ns_cache) == 0
861 In [19]: len(_ip._main_ns_cache) == 0
862 Out[19]: True
862 Out[19]: True
863 """
863 """
864 self._main_ns_cache.clear()
864 self._main_ns_cache.clear()
865
865
866 #-------------------------------------------------------------------------
866 #-------------------------------------------------------------------------
867 # Things related to debugging
867 # Things related to debugging
868 #-------------------------------------------------------------------------
868 #-------------------------------------------------------------------------
869
869
870 def init_pdb(self):
870 def init_pdb(self):
871 # Set calling of pdb on exceptions
871 # Set calling of pdb on exceptions
872 # self.call_pdb is a property
872 # self.call_pdb is a property
873 self.call_pdb = self.pdb
873 self.call_pdb = self.pdb
874
874
875 def _get_call_pdb(self):
875 def _get_call_pdb(self):
876 return self._call_pdb
876 return self._call_pdb
877
877
878 def _set_call_pdb(self,val):
878 def _set_call_pdb(self,val):
879
879
880 if val not in (0,1,False,True):
880 if val not in (0,1,False,True):
881 raise ValueError,'new call_pdb value must be boolean'
881 raise ValueError,'new call_pdb value must be boolean'
882
882
883 # store value in instance
883 # store value in instance
884 self._call_pdb = val
884 self._call_pdb = val
885
885
886 # notify the actual exception handlers
886 # notify the actual exception handlers
887 self.InteractiveTB.call_pdb = val
887 self.InteractiveTB.call_pdb = val
888
888
889 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
889 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
890 'Control auto-activation of pdb at exceptions')
890 'Control auto-activation of pdb at exceptions')
891
891
892 def debugger(self,force=False):
892 def debugger(self,force=False):
893 """Call the pydb/pdb debugger.
893 """Call the pydb/pdb debugger.
894
894
895 Keywords:
895 Keywords:
896
896
897 - force(False): by default, this routine checks the instance call_pdb
897 - force(False): by default, this routine checks the instance call_pdb
898 flag and does not actually invoke the debugger if the flag is false.
898 flag and does not actually invoke the debugger if the flag is false.
899 The 'force' option forces the debugger to activate even if the flag
899 The 'force' option forces the debugger to activate even if the flag
900 is false.
900 is false.
901 """
901 """
902
902
903 if not (force or self.call_pdb):
903 if not (force or self.call_pdb):
904 return
904 return
905
905
906 if not hasattr(sys,'last_traceback'):
906 if not hasattr(sys,'last_traceback'):
907 error('No traceback has been produced, nothing to debug.')
907 error('No traceback has been produced, nothing to debug.')
908 return
908 return
909
909
910 # use pydb if available
910 # use pydb if available
911 if debugger.has_pydb:
911 if debugger.has_pydb:
912 from pydb import pm
912 from pydb import pm
913 else:
913 else:
914 # fallback to our internal debugger
914 # fallback to our internal debugger
915 pm = lambda : self.InteractiveTB.debugger(force=True)
915 pm = lambda : self.InteractiveTB.debugger(force=True)
916
916
917 with self.readline_no_record:
917 with self.readline_no_record:
918 pm()
918 pm()
919
919
920 #-------------------------------------------------------------------------
920 #-------------------------------------------------------------------------
921 # Things related to IPython's various namespaces
921 # Things related to IPython's various namespaces
922 #-------------------------------------------------------------------------
922 #-------------------------------------------------------------------------
923 default_user_namespaces = True
923 default_user_namespaces = True
924
924
925 def init_create_namespaces(self, user_module=None, user_ns=None):
925 def init_create_namespaces(self, user_module=None, user_ns=None):
926 # Create the namespace where the user will operate. user_ns is
926 # Create the namespace where the user will operate. user_ns is
927 # normally the only one used, and it is passed to the exec calls as
927 # normally the only one used, and it is passed to the exec calls as
928 # the locals argument. But we do carry a user_global_ns namespace
928 # the locals argument. But we do carry a user_global_ns namespace
929 # given as the exec 'globals' argument, This is useful in embedding
929 # given as the exec 'globals' argument, This is useful in embedding
930 # situations where the ipython shell opens in a context where the
930 # situations where the ipython shell opens in a context where the
931 # distinction between locals and globals is meaningful. For
931 # distinction between locals and globals is meaningful. For
932 # non-embedded contexts, it is just the same object as the user_ns dict.
932 # non-embedded contexts, it is just the same object as the user_ns dict.
933
933
934 # FIXME. For some strange reason, __builtins__ is showing up at user
934 # FIXME. For some strange reason, __builtins__ is showing up at user
935 # level as a dict instead of a module. This is a manual fix, but I
935 # level as a dict instead of a module. This is a manual fix, but I
936 # should really track down where the problem is coming from. Alex
936 # should really track down where the problem is coming from. Alex
937 # Schmolck reported this problem first.
937 # Schmolck reported this problem first.
938
938
939 # A useful post by Alex Martelli on this topic:
939 # A useful post by Alex Martelli on this topic:
940 # Re: inconsistent value from __builtins__
940 # Re: inconsistent value from __builtins__
941 # Von: Alex Martelli <aleaxit@yahoo.com>
941 # Von: Alex Martelli <aleaxit@yahoo.com>
942 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
942 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
943 # Gruppen: comp.lang.python
943 # Gruppen: comp.lang.python
944
944
945 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
945 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
946 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
946 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
947 # > <type 'dict'>
947 # > <type 'dict'>
948 # > >>> print type(__builtins__)
948 # > >>> print type(__builtins__)
949 # > <type 'module'>
949 # > <type 'module'>
950 # > Is this difference in return value intentional?
950 # > Is this difference in return value intentional?
951
951
952 # Well, it's documented that '__builtins__' can be either a dictionary
952 # Well, it's documented that '__builtins__' can be either a dictionary
953 # or a module, and it's been that way for a long time. Whether it's
953 # or a module, and it's been that way for a long time. Whether it's
954 # intentional (or sensible), I don't know. In any case, the idea is
954 # intentional (or sensible), I don't know. In any case, the idea is
955 # that if you need to access the built-in namespace directly, you
955 # that if you need to access the built-in namespace directly, you
956 # should start with "import __builtin__" (note, no 's') which will
956 # should start with "import __builtin__" (note, no 's') which will
957 # definitely give you a module. Yeah, it's somewhat confusing:-(.
957 # definitely give you a module. Yeah, it's somewhat confusing:-(.
958
958
959 # These routines return a properly built module and dict as needed by
959 # These routines return a properly built module and dict as needed by
960 # the rest of the code, and can also be used by extension writers to
960 # the rest of the code, and can also be used by extension writers to
961 # generate properly initialized namespaces.
961 # generate properly initialized namespaces.
962 if (user_ns is not None) or (user_module is not None):
962 if (user_ns is not None) or (user_module is not None):
963 self.default_user_namespaces = False
963 self.default_user_namespaces = False
964 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
964 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
965
965
966 # A record of hidden variables we have added to the user namespace, so
966 # A record of hidden variables we have added to the user namespace, so
967 # we can list later only variables defined in actual interactive use.
967 # we can list later only variables defined in actual interactive use.
968 self.user_ns_hidden = set()
968 self.user_ns_hidden = set()
969
969
970 # Now that FakeModule produces a real module, we've run into a nasty
970 # Now that FakeModule produces a real module, we've run into a nasty
971 # problem: after script execution (via %run), the module where the user
971 # problem: after script execution (via %run), the module where the user
972 # code ran is deleted. Now that this object is a true module (needed
972 # code ran is deleted. Now that this object is a true module (needed
973 # so docetst and other tools work correctly), the Python module
973 # so docetst and other tools work correctly), the Python module
974 # teardown mechanism runs over it, and sets to None every variable
974 # teardown mechanism runs over it, and sets to None every variable
975 # present in that module. Top-level references to objects from the
975 # present in that module. Top-level references to objects from the
976 # script survive, because the user_ns is updated with them. However,
976 # script survive, because the user_ns is updated with them. However,
977 # calling functions defined in the script that use other things from
977 # calling functions defined in the script that use other things from
978 # the script will fail, because the function's closure had references
978 # the script will fail, because the function's closure had references
979 # to the original objects, which are now all None. So we must protect
979 # to the original objects, which are now all None. So we must protect
980 # these modules from deletion by keeping a cache.
980 # these modules from deletion by keeping a cache.
981 #
981 #
982 # To avoid keeping stale modules around (we only need the one from the
982 # To avoid keeping stale modules around (we only need the one from the
983 # last run), we use a dict keyed with the full path to the script, so
983 # last run), we use a dict keyed with the full path to the script, so
984 # only the last version of the module is held in the cache. Note,
984 # only the last version of the module is held in the cache. Note,
985 # however, that we must cache the module *namespace contents* (their
985 # however, that we must cache the module *namespace contents* (their
986 # __dict__). Because if we try to cache the actual modules, old ones
986 # __dict__). Because if we try to cache the actual modules, old ones
987 # (uncached) could be destroyed while still holding references (such as
987 # (uncached) could be destroyed while still holding references (such as
988 # those held by GUI objects that tend to be long-lived)>
988 # those held by GUI objects that tend to be long-lived)>
989 #
989 #
990 # The %reset command will flush this cache. See the cache_main_mod()
990 # The %reset command will flush this cache. See the cache_main_mod()
991 # and clear_main_mod_cache() methods for details on use.
991 # and clear_main_mod_cache() methods for details on use.
992
992
993 # This is the cache used for 'main' namespaces
993 # This is the cache used for 'main' namespaces
994 self._main_ns_cache = {}
994 self._main_ns_cache = {}
995 # And this is the single instance of FakeModule whose __dict__ we keep
995 # And this is the single instance of FakeModule whose __dict__ we keep
996 # copying and clearing for reuse on each %run
996 # copying and clearing for reuse on each %run
997 self._user_main_module = FakeModule()
997 self._user_main_module = FakeModule()
998
998
999 # A table holding all the namespaces IPython deals with, so that
999 # A table holding all the namespaces IPython deals with, so that
1000 # introspection facilities can search easily.
1000 # introspection facilities can search easily.
1001 self.ns_table = {'user_global':self.user_module.__dict__,
1001 self.ns_table = {'user_global':self.user_module.__dict__,
1002 'user_local':self.user_ns,
1002 'user_local':self.user_ns,
1003 'builtin':builtin_mod.__dict__
1003 'builtin':builtin_mod.__dict__
1004 }
1004 }
1005
1005
1006 @property
1006 @property
1007 def user_global_ns(self):
1007 def user_global_ns(self):
1008 return self.user_module.__dict__
1008 return self.user_module.__dict__
1009
1009
1010 def prepare_user_module(self, user_module=None, user_ns=None):
1010 def prepare_user_module(self, user_module=None, user_ns=None):
1011 """Prepare the module and namespace in which user code will be run.
1011 """Prepare the module and namespace in which user code will be run.
1012
1012
1013 When IPython is started normally, both parameters are None: a new module
1013 When IPython is started normally, both parameters are None: a new module
1014 is created automatically, and its __dict__ used as the namespace.
1014 is created automatically, and its __dict__ used as the namespace.
1015
1015
1016 If only user_module is provided, its __dict__ is used as the namespace.
1016 If only user_module is provided, its __dict__ is used as the namespace.
1017 If only user_ns is provided, a dummy module is created, and user_ns
1017 If only user_ns is provided, a dummy module is created, and user_ns
1018 becomes the global namespace. If both are provided (as they may be
1018 becomes the global namespace. If both are provided (as they may be
1019 when embedding), user_ns is the local namespace, and user_module
1019 when embedding), user_ns is the local namespace, and user_module
1020 provides the global namespace.
1020 provides the global namespace.
1021
1021
1022 Parameters
1022 Parameters
1023 ----------
1023 ----------
1024 user_module : module, optional
1024 user_module : module, optional
1025 The current user module in which IPython is being run. If None,
1025 The current user module in which IPython is being run. If None,
1026 a clean module will be created.
1026 a clean module will be created.
1027 user_ns : dict, optional
1027 user_ns : dict, optional
1028 A namespace in which to run interactive commands.
1028 A namespace in which to run interactive commands.
1029
1029
1030 Returns
1030 Returns
1031 -------
1031 -------
1032 A tuple of user_module and user_ns, each properly initialised.
1032 A tuple of user_module and user_ns, each properly initialised.
1033 """
1033 """
1034 if user_module is None and user_ns is not None:
1034 if user_module is None and user_ns is not None:
1035 user_ns.setdefault("__name__", "__main__")
1035 user_ns.setdefault("__name__", "__main__")
1036 class DummyMod(object):
1036 class DummyMod(object):
1037 "A dummy module used for IPython's interactive namespace."
1037 "A dummy module used for IPython's interactive namespace."
1038 pass
1038 pass
1039 user_module = DummyMod()
1039 user_module = DummyMod()
1040 user_module.__dict__ = user_ns
1040 user_module.__dict__ = user_ns
1041
1041
1042 if user_module is None:
1042 if user_module is None:
1043 user_module = types.ModuleType("__main__",
1043 user_module = types.ModuleType("__main__",
1044 doc="Automatically created module for IPython interactive environment")
1044 doc="Automatically created module for IPython interactive environment")
1045
1045
1046 # We must ensure that __builtin__ (without the final 's') is always
1046 # We must ensure that __builtin__ (without the final 's') is always
1047 # available and pointing to the __builtin__ *module*. For more details:
1047 # available and pointing to the __builtin__ *module*. For more details:
1048 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1048 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1049 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1049 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1050 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1051
1051
1052 if user_ns is None:
1052 if user_ns is None:
1053 user_ns = user_module.__dict__
1053 user_ns = user_module.__dict__
1054
1054
1055 return user_module, user_ns
1055 return user_module, user_ns
1056
1056
1057 def init_sys_modules(self):
1057 def init_sys_modules(self):
1058 # We need to insert into sys.modules something that looks like a
1058 # We need to insert into sys.modules something that looks like a
1059 # module but which accesses the IPython namespace, for shelve and
1059 # module but which accesses the IPython namespace, for shelve and
1060 # pickle to work interactively. Normally they rely on getting
1060 # pickle to work interactively. Normally they rely on getting
1061 # everything out of __main__, but for embedding purposes each IPython
1061 # everything out of __main__, but for embedding purposes each IPython
1062 # instance has its own private namespace, so we can't go shoving
1062 # instance has its own private namespace, so we can't go shoving
1063 # everything into __main__.
1063 # everything into __main__.
1064
1064
1065 # note, however, that we should only do this for non-embedded
1065 # note, however, that we should only do this for non-embedded
1066 # ipythons, which really mimic the __main__.__dict__ with their own
1066 # ipythons, which really mimic the __main__.__dict__ with their own
1067 # namespace. Embedded instances, on the other hand, should not do
1067 # namespace. Embedded instances, on the other hand, should not do
1068 # this because they need to manage the user local/global namespaces
1068 # this because they need to manage the user local/global namespaces
1069 # only, but they live within a 'normal' __main__ (meaning, they
1069 # only, but they live within a 'normal' __main__ (meaning, they
1070 # shouldn't overtake the execution environment of the script they're
1070 # shouldn't overtake the execution environment of the script they're
1071 # embedded in).
1071 # embedded in).
1072
1072
1073 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1073 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1074 main_name = self.user_module.__name__
1074 main_name = self.user_module.__name__
1075 sys.modules[main_name] = self.user_module
1075 sys.modules[main_name] = self.user_module
1076
1076
1077 def init_user_ns(self):
1077 def init_user_ns(self):
1078 """Initialize all user-visible namespaces to their minimum defaults.
1078 """Initialize all user-visible namespaces to their minimum defaults.
1079
1079
1080 Certain history lists are also initialized here, as they effectively
1080 Certain history lists are also initialized here, as they effectively
1081 act as user namespaces.
1081 act as user namespaces.
1082
1082
1083 Notes
1083 Notes
1084 -----
1084 -----
1085 All data structures here are only filled in, they are NOT reset by this
1085 All data structures here are only filled in, they are NOT reset by this
1086 method. If they were not empty before, data will simply be added to
1086 method. If they were not empty before, data will simply be added to
1087 therm.
1087 therm.
1088 """
1088 """
1089 # This function works in two parts: first we put a few things in
1089 # This function works in two parts: first we put a few things in
1090 # user_ns, and we sync that contents into user_ns_hidden so that these
1090 # user_ns, and we sync that contents into user_ns_hidden so that these
1091 # initial variables aren't shown by %who. After the sync, we add the
1091 # initial variables aren't shown by %who. After the sync, we add the
1092 # rest of what we *do* want the user to see with %who even on a new
1092 # rest of what we *do* want the user to see with %who even on a new
1093 # session (probably nothing, so theye really only see their own stuff)
1093 # session (probably nothing, so theye really only see their own stuff)
1094
1094
1095 # The user dict must *always* have a __builtin__ reference to the
1095 # The user dict must *always* have a __builtin__ reference to the
1096 # Python standard __builtin__ namespace, which must be imported.
1096 # Python standard __builtin__ namespace, which must be imported.
1097 # This is so that certain operations in prompt evaluation can be
1097 # This is so that certain operations in prompt evaluation can be
1098 # reliably executed with builtins. Note that we can NOT use
1098 # reliably executed with builtins. Note that we can NOT use
1099 # __builtins__ (note the 's'), because that can either be a dict or a
1099 # __builtins__ (note the 's'), because that can either be a dict or a
1100 # module, and can even mutate at runtime, depending on the context
1100 # module, and can even mutate at runtime, depending on the context
1101 # (Python makes no guarantees on it). In contrast, __builtin__ is
1101 # (Python makes no guarantees on it). In contrast, __builtin__ is
1102 # always a module object, though it must be explicitly imported.
1102 # always a module object, though it must be explicitly imported.
1103
1103
1104 # For more details:
1104 # For more details:
1105 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1105 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1106 ns = dict()
1106 ns = dict()
1107
1107
1108 # Put 'help' in the user namespace
1108 # Put 'help' in the user namespace
1109 try:
1109 try:
1110 from site import _Helper
1110 from site import _Helper
1111 ns['help'] = _Helper()
1111 ns['help'] = _Helper()
1112 except ImportError:
1112 except ImportError:
1113 warn('help() not available - check site.py')
1113 warn('help() not available - check site.py')
1114
1114
1115 # make global variables for user access to the histories
1115 # make global variables for user access to the histories
1116 ns['_ih'] = self.history_manager.input_hist_parsed
1116 ns['_ih'] = self.history_manager.input_hist_parsed
1117 ns['_oh'] = self.history_manager.output_hist
1117 ns['_oh'] = self.history_manager.output_hist
1118 ns['_dh'] = self.history_manager.dir_hist
1118 ns['_dh'] = self.history_manager.dir_hist
1119
1119
1120 ns['_sh'] = shadowns
1120 ns['_sh'] = shadowns
1121
1121
1122 # user aliases to input and output histories. These shouldn't show up
1122 # user aliases to input and output histories. These shouldn't show up
1123 # in %who, as they can have very large reprs.
1123 # in %who, as they can have very large reprs.
1124 ns['In'] = self.history_manager.input_hist_parsed
1124 ns['In'] = self.history_manager.input_hist_parsed
1125 ns['Out'] = self.history_manager.output_hist
1125 ns['Out'] = self.history_manager.output_hist
1126
1126
1127 # Store myself as the public api!!!
1127 # Store myself as the public api!!!
1128 ns['get_ipython'] = self.get_ipython
1128 ns['get_ipython'] = self.get_ipython
1129
1129
1130 ns['exit'] = self.exiter
1130 ns['exit'] = self.exiter
1131 ns['quit'] = self.exiter
1131 ns['quit'] = self.exiter
1132
1132
1133 # Sync what we've added so far to user_ns_hidden so these aren't seen
1133 # Sync what we've added so far to user_ns_hidden so these aren't seen
1134 # by %who
1134 # by %who
1135 self.user_ns_hidden.update(ns)
1135 self.user_ns_hidden.update(ns)
1136
1136
1137 # Anything put into ns now would show up in %who. Think twice before
1137 # Anything put into ns now would show up in %who. Think twice before
1138 # putting anything here, as we really want %who to show the user their
1138 # putting anything here, as we really want %who to show the user their
1139 # stuff, not our variables.
1139 # stuff, not our variables.
1140
1140
1141 # Finally, update the real user's namespace
1141 # Finally, update the real user's namespace
1142 self.user_ns.update(ns)
1142 self.user_ns.update(ns)
1143
1143
1144 @property
1144 @property
1145 def all_ns_refs(self):
1145 def all_ns_refs(self):
1146 """Get a list of references to all the namespace dictionaries in which
1146 """Get a list of references to all the namespace dictionaries in which
1147 IPython might store a user-created object.
1147 IPython might store a user-created object.
1148
1148
1149 Note that this does not include the displayhook, which also caches
1149 Note that this does not include the displayhook, which also caches
1150 objects from the output."""
1150 objects from the output."""
1151 return [self.user_ns, self.user_global_ns,
1151 return [self.user_ns, self.user_global_ns,
1152 self._user_main_module.__dict__] + self._main_ns_cache.values()
1152 self._user_main_module.__dict__] + self._main_ns_cache.values()
1153
1153
1154 def reset(self, new_session=True):
1154 def reset(self, new_session=True):
1155 """Clear all internal namespaces, and attempt to release references to
1155 """Clear all internal namespaces, and attempt to release references to
1156 user objects.
1156 user objects.
1157
1157
1158 If new_session is True, a new history session will be opened.
1158 If new_session is True, a new history session will be opened.
1159 """
1159 """
1160 # Clear histories
1160 # Clear histories
1161 self.history_manager.reset(new_session)
1161 self.history_manager.reset(new_session)
1162 # Reset counter used to index all histories
1162 # Reset counter used to index all histories
1163 if new_session:
1163 if new_session:
1164 self.execution_count = 1
1164 self.execution_count = 1
1165
1165
1166 # Flush cached output items
1166 # Flush cached output items
1167 if self.displayhook.do_full_cache:
1167 if self.displayhook.do_full_cache:
1168 self.displayhook.flush()
1168 self.displayhook.flush()
1169
1169
1170 # The main execution namespaces must be cleared very carefully,
1170 # The main execution namespaces must be cleared very carefully,
1171 # skipping the deletion of the builtin-related keys, because doing so
1171 # skipping the deletion of the builtin-related keys, because doing so
1172 # would cause errors in many object's __del__ methods.
1172 # would cause errors in many object's __del__ methods.
1173 if self.user_ns is not self.user_global_ns:
1173 if self.user_ns is not self.user_global_ns:
1174 self.user_ns.clear()
1174 self.user_ns.clear()
1175 ns = self.user_global_ns
1175 ns = self.user_global_ns
1176 drop_keys = set(ns.keys())
1176 drop_keys = set(ns.keys())
1177 drop_keys.discard('__builtin__')
1177 drop_keys.discard('__builtin__')
1178 drop_keys.discard('__builtins__')
1178 drop_keys.discard('__builtins__')
1179 drop_keys.discard('__name__')
1179 drop_keys.discard('__name__')
1180 for k in drop_keys:
1180 for k in drop_keys:
1181 del ns[k]
1181 del ns[k]
1182
1182
1183 self.user_ns_hidden.clear()
1183 self.user_ns_hidden.clear()
1184
1184
1185 # Restore the user namespaces to minimal usability
1185 # Restore the user namespaces to minimal usability
1186 self.init_user_ns()
1186 self.init_user_ns()
1187
1187
1188 # Restore the default and user aliases
1188 # Restore the default and user aliases
1189 self.alias_manager.clear_aliases()
1189 self.alias_manager.clear_aliases()
1190 self.alias_manager.init_aliases()
1190 self.alias_manager.init_aliases()
1191
1191
1192 # Flush the private list of module references kept for script
1192 # Flush the private list of module references kept for script
1193 # execution protection
1193 # execution protection
1194 self.clear_main_mod_cache()
1194 self.clear_main_mod_cache()
1195
1195
1196 # Clear out the namespace from the last %run
1196 # Clear out the namespace from the last %run
1197 self.new_main_mod()
1197 self.new_main_mod()
1198
1198
1199 def del_var(self, varname, by_name=False):
1199 def del_var(self, varname, by_name=False):
1200 """Delete a variable from the various namespaces, so that, as
1200 """Delete a variable from the various namespaces, so that, as
1201 far as possible, we're not keeping any hidden references to it.
1201 far as possible, we're not keeping any hidden references to it.
1202
1202
1203 Parameters
1203 Parameters
1204 ----------
1204 ----------
1205 varname : str
1205 varname : str
1206 The name of the variable to delete.
1206 The name of the variable to delete.
1207 by_name : bool
1207 by_name : bool
1208 If True, delete variables with the given name in each
1208 If True, delete variables with the given name in each
1209 namespace. If False (default), find the variable in the user
1209 namespace. If False (default), find the variable in the user
1210 namespace, and delete references to it.
1210 namespace, and delete references to it.
1211 """
1211 """
1212 if varname in ('__builtin__', '__builtins__'):
1212 if varname in ('__builtin__', '__builtins__'):
1213 raise ValueError("Refusing to delete %s" % varname)
1213 raise ValueError("Refusing to delete %s" % varname)
1214
1214
1215 ns_refs = self.all_ns_refs
1215 ns_refs = self.all_ns_refs
1216
1216
1217 if by_name: # Delete by name
1217 if by_name: # Delete by name
1218 for ns in ns_refs:
1218 for ns in ns_refs:
1219 try:
1219 try:
1220 del ns[varname]
1220 del ns[varname]
1221 except KeyError:
1221 except KeyError:
1222 pass
1222 pass
1223 else: # Delete by object
1223 else: # Delete by object
1224 try:
1224 try:
1225 obj = self.user_ns[varname]
1225 obj = self.user_ns[varname]
1226 except KeyError:
1226 except KeyError:
1227 raise NameError("name '%s' is not defined" % varname)
1227 raise NameError("name '%s' is not defined" % varname)
1228 # Also check in output history
1228 # Also check in output history
1229 ns_refs.append(self.history_manager.output_hist)
1229 ns_refs.append(self.history_manager.output_hist)
1230 for ns in ns_refs:
1230 for ns in ns_refs:
1231 to_delete = [n for n, o in ns.iteritems() if o is obj]
1231 to_delete = [n for n, o in ns.iteritems() if o is obj]
1232 for name in to_delete:
1232 for name in to_delete:
1233 del ns[name]
1233 del ns[name]
1234
1234
1235 # displayhook keeps extra references, but not in a dictionary
1235 # displayhook keeps extra references, but not in a dictionary
1236 for name in ('_', '__', '___'):
1236 for name in ('_', '__', '___'):
1237 if getattr(self.displayhook, name) is obj:
1237 if getattr(self.displayhook, name) is obj:
1238 setattr(self.displayhook, name, None)
1238 setattr(self.displayhook, name, None)
1239
1239
1240 def reset_selective(self, regex=None):
1240 def reset_selective(self, regex=None):
1241 """Clear selective variables from internal namespaces based on a
1241 """Clear selective variables from internal namespaces based on a
1242 specified regular expression.
1242 specified regular expression.
1243
1243
1244 Parameters
1244 Parameters
1245 ----------
1245 ----------
1246 regex : string or compiled pattern, optional
1246 regex : string or compiled pattern, optional
1247 A regular expression pattern that will be used in searching
1247 A regular expression pattern that will be used in searching
1248 variable names in the users namespaces.
1248 variable names in the users namespaces.
1249 """
1249 """
1250 if regex is not None:
1250 if regex is not None:
1251 try:
1251 try:
1252 m = re.compile(regex)
1252 m = re.compile(regex)
1253 except TypeError:
1253 except TypeError:
1254 raise TypeError('regex must be a string or compiled pattern')
1254 raise TypeError('regex must be a string or compiled pattern')
1255 # Search for keys in each namespace that match the given regex
1255 # Search for keys in each namespace that match the given regex
1256 # If a match is found, delete the key/value pair.
1256 # If a match is found, delete the key/value pair.
1257 for ns in self.all_ns_refs:
1257 for ns in self.all_ns_refs:
1258 for var in ns:
1258 for var in ns:
1259 if m.search(var):
1259 if m.search(var):
1260 del ns[var]
1260 del ns[var]
1261
1261
1262 def push(self, variables, interactive=True):
1262 def push(self, variables, interactive=True):
1263 """Inject a group of variables into the IPython user namespace.
1263 """Inject a group of variables into the IPython user namespace.
1264
1264
1265 Parameters
1265 Parameters
1266 ----------
1266 ----------
1267 variables : dict, str or list/tuple of str
1267 variables : dict, str or list/tuple of str
1268 The variables to inject into the user's namespace. If a dict, a
1268 The variables to inject into the user's namespace. If a dict, a
1269 simple update is done. If a str, the string is assumed to have
1269 simple update is done. If a str, the string is assumed to have
1270 variable names separated by spaces. A list/tuple of str can also
1270 variable names separated by spaces. A list/tuple of str can also
1271 be used to give the variable names. If just the variable names are
1271 be used to give the variable names. If just the variable names are
1272 give (list/tuple/str) then the variable values looked up in the
1272 give (list/tuple/str) then the variable values looked up in the
1273 callers frame.
1273 callers frame.
1274 interactive : bool
1274 interactive : bool
1275 If True (default), the variables will be listed with the ``who``
1275 If True (default), the variables will be listed with the ``who``
1276 magic.
1276 magic.
1277 """
1277 """
1278 vdict = None
1278 vdict = None
1279
1279
1280 # We need a dict of name/value pairs to do namespace updates.
1280 # We need a dict of name/value pairs to do namespace updates.
1281 if isinstance(variables, dict):
1281 if isinstance(variables, dict):
1282 vdict = variables
1282 vdict = variables
1283 elif isinstance(variables, (basestring, list, tuple)):
1283 elif isinstance(variables, (basestring, list, tuple)):
1284 if isinstance(variables, basestring):
1284 if isinstance(variables, basestring):
1285 vlist = variables.split()
1285 vlist = variables.split()
1286 else:
1286 else:
1287 vlist = variables
1287 vlist = variables
1288 vdict = {}
1288 vdict = {}
1289 cf = sys._getframe(1)
1289 cf = sys._getframe(1)
1290 for name in vlist:
1290 for name in vlist:
1291 try:
1291 try:
1292 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1292 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1293 except:
1293 except:
1294 print ('Could not get variable %s from %s' %
1294 print ('Could not get variable %s from %s' %
1295 (name,cf.f_code.co_name))
1295 (name,cf.f_code.co_name))
1296 else:
1296 else:
1297 raise ValueError('variables must be a dict/str/list/tuple')
1297 raise ValueError('variables must be a dict/str/list/tuple')
1298
1298
1299 # Propagate variables to user namespace
1299 # Propagate variables to user namespace
1300 self.user_ns.update(vdict)
1300 self.user_ns.update(vdict)
1301
1301
1302 # And configure interactive visibility
1302 # And configure interactive visibility
1303 user_ns_hidden = self.user_ns_hidden
1303 user_ns_hidden = self.user_ns_hidden
1304 if interactive:
1304 if interactive:
1305 user_ns_hidden.difference_update(vdict)
1305 user_ns_hidden.difference_update(vdict)
1306 else:
1306 else:
1307 user_ns_hidden.update(vdict)
1307 user_ns_hidden.update(vdict)
1308
1308
1309 def drop_by_id(self, variables):
1309 def drop_by_id(self, variables):
1310 """Remove a dict of variables from the user namespace, if they are the
1310 """Remove a dict of variables from the user namespace, if they are the
1311 same as the values in the dictionary.
1311 same as the values in the dictionary.
1312
1312
1313 This is intended for use by extensions: variables that they've added can
1313 This is intended for use by extensions: variables that they've added can
1314 be taken back out if they are unloaded, without removing any that the
1314 be taken back out if they are unloaded, without removing any that the
1315 user has overwritten.
1315 user has overwritten.
1316
1316
1317 Parameters
1317 Parameters
1318 ----------
1318 ----------
1319 variables : dict
1319 variables : dict
1320 A dictionary mapping object names (as strings) to the objects.
1320 A dictionary mapping object names (as strings) to the objects.
1321 """
1321 """
1322 for name, obj in variables.iteritems():
1322 for name, obj in variables.iteritems():
1323 if name in self.user_ns and self.user_ns[name] is obj:
1323 if name in self.user_ns and self.user_ns[name] is obj:
1324 del self.user_ns[name]
1324 del self.user_ns[name]
1325 self.user_ns_hidden.discard(name)
1325 self.user_ns_hidden.discard(name)
1326
1326
1327 #-------------------------------------------------------------------------
1327 #-------------------------------------------------------------------------
1328 # Things related to object introspection
1328 # Things related to object introspection
1329 #-------------------------------------------------------------------------
1329 #-------------------------------------------------------------------------
1330
1330
1331 def _ofind(self, oname, namespaces=None):
1331 def _ofind(self, oname, namespaces=None):
1332 """Find an object in the available namespaces.
1332 """Find an object in the available namespaces.
1333
1333
1334 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1334 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1335
1335
1336 Has special code to detect magic functions.
1336 Has special code to detect magic functions.
1337 """
1337 """
1338 oname = oname.strip()
1338 oname = oname.strip()
1339 #print '1- oname: <%r>' % oname # dbg
1339 #print '1- oname: <%r>' % oname # dbg
1340 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1340 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1341 return dict(found=False)
1341 return dict(found=False)
1342
1342
1343 alias_ns = None
1343 alias_ns = None
1344 if namespaces is None:
1344 if namespaces is None:
1345 # Namespaces to search in:
1345 # Namespaces to search in:
1346 # Put them in a list. The order is important so that we
1346 # Put them in a list. The order is important so that we
1347 # find things in the same order that Python finds them.
1347 # find things in the same order that Python finds them.
1348 namespaces = [ ('Interactive', self.user_ns),
1348 namespaces = [ ('Interactive', self.user_ns),
1349 ('Interactive (global)', self.user_global_ns),
1349 ('Interactive (global)', self.user_global_ns),
1350 ('Python builtin', builtin_mod.__dict__),
1350 ('Python builtin', builtin_mod.__dict__),
1351 ('Alias', self.alias_manager.alias_table),
1351 ('Alias', self.alias_manager.alias_table),
1352 ]
1352 ]
1353 alias_ns = self.alias_manager.alias_table
1353 alias_ns = self.alias_manager.alias_table
1354
1354
1355 # initialize results to 'null'
1355 # initialize results to 'null'
1356 found = False; obj = None; ospace = None; ds = None;
1356 found = False; obj = None; ospace = None; ds = None;
1357 ismagic = False; isalias = False; parent = None
1357 ismagic = False; isalias = False; parent = None
1358
1358
1359 # We need to special-case 'print', which as of python2.6 registers as a
1359 # We need to special-case 'print', which as of python2.6 registers as a
1360 # function but should only be treated as one if print_function was
1360 # function but should only be treated as one if print_function was
1361 # loaded with a future import. In this case, just bail.
1361 # loaded with a future import. In this case, just bail.
1362 if (oname == 'print' and not py3compat.PY3 and not \
1362 if (oname == 'print' and not py3compat.PY3 and not \
1363 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1363 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1364 return {'found':found, 'obj':obj, 'namespace':ospace,
1364 return {'found':found, 'obj':obj, 'namespace':ospace,
1365 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1365 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1366
1366
1367 # Look for the given name by splitting it in parts. If the head is
1367 # Look for the given name by splitting it in parts. If the head is
1368 # found, then we look for all the remaining parts as members, and only
1368 # found, then we look for all the remaining parts as members, and only
1369 # declare success if we can find them all.
1369 # declare success if we can find them all.
1370 oname_parts = oname.split('.')
1370 oname_parts = oname.split('.')
1371 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1371 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1372 for nsname,ns in namespaces:
1372 for nsname,ns in namespaces:
1373 try:
1373 try:
1374 obj = ns[oname_head]
1374 obj = ns[oname_head]
1375 except KeyError:
1375 except KeyError:
1376 continue
1376 continue
1377 else:
1377 else:
1378 #print 'oname_rest:', oname_rest # dbg
1378 #print 'oname_rest:', oname_rest # dbg
1379 for part in oname_rest:
1379 for part in oname_rest:
1380 try:
1380 try:
1381 parent = obj
1381 parent = obj
1382 obj = getattr(obj,part)
1382 obj = getattr(obj,part)
1383 except:
1383 except:
1384 # Blanket except b/c some badly implemented objects
1384 # Blanket except b/c some badly implemented objects
1385 # allow __getattr__ to raise exceptions other than
1385 # allow __getattr__ to raise exceptions other than
1386 # AttributeError, which then crashes IPython.
1386 # AttributeError, which then crashes IPython.
1387 break
1387 break
1388 else:
1388 else:
1389 # If we finish the for loop (no break), we got all members
1389 # If we finish the for loop (no break), we got all members
1390 found = True
1390 found = True
1391 ospace = nsname
1391 ospace = nsname
1392 if ns == alias_ns:
1392 if ns == alias_ns:
1393 isalias = True
1393 isalias = True
1394 break # namespace loop
1394 break # namespace loop
1395
1395
1396 # Try to see if it's magic
1396 # Try to see if it's magic
1397 if not found:
1397 if not found:
1398 if oname.startswith(ESC_MAGIC):
1398 if oname.startswith(ESC_MAGIC):
1399 oname = oname[1:]
1399 oname = oname[1:]
1400 obj = self.find_magic(oname)
1400 obj = self.find_magic(oname)
1401 if obj is not None:
1401 if obj is not None:
1402 found = True
1402 found = True
1403 ospace = 'IPython internal'
1403 ospace = 'IPython internal'
1404 ismagic = True
1404 ismagic = True
1405
1405
1406 # Last try: special-case some literals like '', [], {}, etc:
1406 # Last try: special-case some literals like '', [], {}, etc:
1407 if not found and oname_head in ["''",'""','[]','{}','()']:
1407 if not found and oname_head in ["''",'""','[]','{}','()']:
1408 obj = eval(oname_head)
1408 obj = eval(oname_head)
1409 found = True
1409 found = True
1410 ospace = 'Interactive'
1410 ospace = 'Interactive'
1411
1411
1412 return {'found':found, 'obj':obj, 'namespace':ospace,
1412 return {'found':found, 'obj':obj, 'namespace':ospace,
1413 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1413 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1414
1414
1415 def _ofind_property(self, oname, info):
1415 def _ofind_property(self, oname, info):
1416 """Second part of object finding, to look for property details."""
1416 """Second part of object finding, to look for property details."""
1417 if info.found:
1417 if info.found:
1418 # Get the docstring of the class property if it exists.
1418 # Get the docstring of the class property if it exists.
1419 path = oname.split('.')
1419 path = oname.split('.')
1420 root = '.'.join(path[:-1])
1420 root = '.'.join(path[:-1])
1421 if info.parent is not None:
1421 if info.parent is not None:
1422 try:
1422 try:
1423 target = getattr(info.parent, '__class__')
1423 target = getattr(info.parent, '__class__')
1424 # The object belongs to a class instance.
1424 # The object belongs to a class instance.
1425 try:
1425 try:
1426 target = getattr(target, path[-1])
1426 target = getattr(target, path[-1])
1427 # The class defines the object.
1427 # The class defines the object.
1428 if isinstance(target, property):
1428 if isinstance(target, property):
1429 oname = root + '.__class__.' + path[-1]
1429 oname = root + '.__class__.' + path[-1]
1430 info = Struct(self._ofind(oname))
1430 info = Struct(self._ofind(oname))
1431 except AttributeError: pass
1431 except AttributeError: pass
1432 except AttributeError: pass
1432 except AttributeError: pass
1433
1433
1434 # We return either the new info or the unmodified input if the object
1434 # We return either the new info or the unmodified input if the object
1435 # hadn't been found
1435 # hadn't been found
1436 return info
1436 return info
1437
1437
1438 def _object_find(self, oname, namespaces=None):
1438 def _object_find(self, oname, namespaces=None):
1439 """Find an object and return a struct with info about it."""
1439 """Find an object and return a struct with info about it."""
1440 inf = Struct(self._ofind(oname, namespaces))
1440 inf = Struct(self._ofind(oname, namespaces))
1441 return Struct(self._ofind_property(oname, inf))
1441 return Struct(self._ofind_property(oname, inf))
1442
1442
1443 def _inspect(self, meth, oname, namespaces=None, **kw):
1443 def _inspect(self, meth, oname, namespaces=None, **kw):
1444 """Generic interface to the inspector system.
1444 """Generic interface to the inspector system.
1445
1445
1446 This function is meant to be called by pdef, pdoc & friends."""
1446 This function is meant to be called by pdef, pdoc & friends."""
1447 info = self._object_find(oname)
1447 info = self._object_find(oname)
1448 if info.found:
1448 if info.found:
1449 pmethod = getattr(self.inspector, meth)
1449 pmethod = getattr(self.inspector, meth)
1450 formatter = format_screen if info.ismagic else None
1450 formatter = format_screen if info.ismagic else None
1451 if meth == 'pdoc':
1451 if meth == 'pdoc':
1452 pmethod(info.obj, oname, formatter)
1452 pmethod(info.obj, oname, formatter)
1453 elif meth == 'pinfo':
1453 elif meth == 'pinfo':
1454 pmethod(info.obj, oname, formatter, info, **kw)
1454 pmethod(info.obj, oname, formatter, info, **kw)
1455 else:
1455 else:
1456 pmethod(info.obj, oname)
1456 pmethod(info.obj, oname)
1457 else:
1457 else:
1458 print 'Object `%s` not found.' % oname
1458 print 'Object `%s` not found.' % oname
1459 return 'not found' # so callers can take other action
1459 return 'not found' # so callers can take other action
1460
1460
1461 def object_inspect(self, oname, detail_level=0):
1461 def object_inspect(self, oname, detail_level=0):
1462 with self.builtin_trap:
1462 with self.builtin_trap:
1463 info = self._object_find(oname)
1463 info = self._object_find(oname)
1464 if info.found:
1464 if info.found:
1465 return self.inspector.info(info.obj, oname, info=info,
1465 return self.inspector.info(info.obj, oname, info=info,
1466 detail_level=detail_level
1466 detail_level=detail_level
1467 )
1467 )
1468 else:
1468 else:
1469 return oinspect.object_info(name=oname, found=False)
1469 return oinspect.object_info(name=oname, found=False)
1470
1470
1471 #-------------------------------------------------------------------------
1471 #-------------------------------------------------------------------------
1472 # Things related to history management
1472 # Things related to history management
1473 #-------------------------------------------------------------------------
1473 #-------------------------------------------------------------------------
1474
1474
1475 def init_history(self):
1475 def init_history(self):
1476 """Sets up the command history, and starts regular autosaves."""
1476 """Sets up the command history, and starts regular autosaves."""
1477 self.history_manager = HistoryManager(shell=self, config=self.config)
1477 self.history_manager = HistoryManager(shell=self, config=self.config)
1478 self.configurables.append(self.history_manager)
1478 self.configurables.append(self.history_manager)
1479
1479
1480 #-------------------------------------------------------------------------
1480 #-------------------------------------------------------------------------
1481 # Things related to exception handling and tracebacks (not debugging)
1481 # Things related to exception handling and tracebacks (not debugging)
1482 #-------------------------------------------------------------------------
1482 #-------------------------------------------------------------------------
1483
1483
1484 def init_traceback_handlers(self, custom_exceptions):
1484 def init_traceback_handlers(self, custom_exceptions):
1485 # Syntax error handler.
1485 # Syntax error handler.
1486 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1486 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1487
1487
1488 # The interactive one is initialized with an offset, meaning we always
1488 # The interactive one is initialized with an offset, meaning we always
1489 # want to remove the topmost item in the traceback, which is our own
1489 # want to remove the topmost item in the traceback, which is our own
1490 # internal code. Valid modes: ['Plain','Context','Verbose']
1490 # internal code. Valid modes: ['Plain','Context','Verbose']
1491 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1491 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1492 color_scheme='NoColor',
1492 color_scheme='NoColor',
1493 tb_offset = 1,
1493 tb_offset = 1,
1494 check_cache=self.compile.check_cache)
1494 check_cache=self.compile.check_cache)
1495
1495
1496 # The instance will store a pointer to the system-wide exception hook,
1496 # The instance will store a pointer to the system-wide exception hook,
1497 # so that runtime code (such as magics) can access it. This is because
1497 # so that runtime code (such as magics) can access it. This is because
1498 # during the read-eval loop, it may get temporarily overwritten.
1498 # during the read-eval loop, it may get temporarily overwritten.
1499 self.sys_excepthook = sys.excepthook
1499 self.sys_excepthook = sys.excepthook
1500
1500
1501 # and add any custom exception handlers the user may have specified
1501 # and add any custom exception handlers the user may have specified
1502 self.set_custom_exc(*custom_exceptions)
1502 self.set_custom_exc(*custom_exceptions)
1503
1503
1504 # Set the exception mode
1504 # Set the exception mode
1505 self.InteractiveTB.set_mode(mode=self.xmode)
1505 self.InteractiveTB.set_mode(mode=self.xmode)
1506
1506
1507 def set_custom_exc(self, exc_tuple, handler):
1507 def set_custom_exc(self, exc_tuple, handler):
1508 """set_custom_exc(exc_tuple,handler)
1508 """set_custom_exc(exc_tuple,handler)
1509
1509
1510 Set a custom exception handler, which will be called if any of the
1510 Set a custom exception handler, which will be called if any of the
1511 exceptions in exc_tuple occur in the mainloop (specifically, in the
1511 exceptions in exc_tuple occur in the mainloop (specifically, in the
1512 run_code() method).
1512 run_code() method).
1513
1513
1514 Parameters
1514 Parameters
1515 ----------
1515 ----------
1516
1516
1517 exc_tuple : tuple of exception classes
1517 exc_tuple : tuple of exception classes
1518 A *tuple* of exception classes, for which to call the defined
1518 A *tuple* of exception classes, for which to call the defined
1519 handler. It is very important that you use a tuple, and NOT A
1519 handler. It is very important that you use a tuple, and NOT A
1520 LIST here, because of the way Python's except statement works. If
1520 LIST here, because of the way Python's except statement works. If
1521 you only want to trap a single exception, use a singleton tuple::
1521 you only want to trap a single exception, use a singleton tuple::
1522
1522
1523 exc_tuple == (MyCustomException,)
1523 exc_tuple == (MyCustomException,)
1524
1524
1525 handler : callable
1525 handler : callable
1526 handler must have the following signature::
1526 handler must have the following signature::
1527
1527
1528 def my_handler(self, etype, value, tb, tb_offset=None):
1528 def my_handler(self, etype, value, tb, tb_offset=None):
1529 ...
1529 ...
1530 return structured_traceback
1530 return structured_traceback
1531
1531
1532 Your handler must return a structured traceback (a list of strings),
1532 Your handler must return a structured traceback (a list of strings),
1533 or None.
1533 or None.
1534
1534
1535 This will be made into an instance method (via types.MethodType)
1535 This will be made into an instance method (via types.MethodType)
1536 of IPython itself, and it will be called if any of the exceptions
1536 of IPython itself, and it will be called if any of the exceptions
1537 listed in the exc_tuple are caught. If the handler is None, an
1537 listed in the exc_tuple are caught. If the handler is None, an
1538 internal basic one is used, which just prints basic info.
1538 internal basic one is used, which just prints basic info.
1539
1539
1540 To protect IPython from crashes, if your handler ever raises an
1540 To protect IPython from crashes, if your handler ever raises an
1541 exception or returns an invalid result, it will be immediately
1541 exception or returns an invalid result, it will be immediately
1542 disabled.
1542 disabled.
1543
1543
1544 WARNING: by putting in your own exception handler into IPython's main
1544 WARNING: by putting in your own exception handler into IPython's main
1545 execution loop, you run a very good chance of nasty crashes. This
1545 execution loop, you run a very good chance of nasty crashes. This
1546 facility should only be used if you really know what you are doing."""
1546 facility should only be used if you really know what you are doing."""
1547
1547
1548 assert type(exc_tuple)==type(()) , \
1548 assert type(exc_tuple)==type(()) , \
1549 "The custom exceptions must be given AS A TUPLE."
1549 "The custom exceptions must be given AS A TUPLE."
1550
1550
1551 def dummy_handler(self,etype,value,tb,tb_offset=None):
1551 def dummy_handler(self,etype,value,tb,tb_offset=None):
1552 print '*** Simple custom exception handler ***'
1552 print '*** Simple custom exception handler ***'
1553 print 'Exception type :',etype
1553 print 'Exception type :',etype
1554 print 'Exception value:',value
1554 print 'Exception value:',value
1555 print 'Traceback :',tb
1555 print 'Traceback :',tb
1556 #print 'Source code :','\n'.join(self.buffer)
1556 #print 'Source code :','\n'.join(self.buffer)
1557
1557
1558 def validate_stb(stb):
1558 def validate_stb(stb):
1559 """validate structured traceback return type
1559 """validate structured traceback return type
1560
1560
1561 return type of CustomTB *should* be a list of strings, but allow
1561 return type of CustomTB *should* be a list of strings, but allow
1562 single strings or None, which are harmless.
1562 single strings or None, which are harmless.
1563
1563
1564 This function will *always* return a list of strings,
1564 This function will *always* return a list of strings,
1565 and will raise a TypeError if stb is inappropriate.
1565 and will raise a TypeError if stb is inappropriate.
1566 """
1566 """
1567 msg = "CustomTB must return list of strings, not %r" % stb
1567 msg = "CustomTB must return list of strings, not %r" % stb
1568 if stb is None:
1568 if stb is None:
1569 return []
1569 return []
1570 elif isinstance(stb, basestring):
1570 elif isinstance(stb, basestring):
1571 return [stb]
1571 return [stb]
1572 elif not isinstance(stb, list):
1572 elif not isinstance(stb, list):
1573 raise TypeError(msg)
1573 raise TypeError(msg)
1574 # it's a list
1574 # it's a list
1575 for line in stb:
1575 for line in stb:
1576 # check every element
1576 # check every element
1577 if not isinstance(line, basestring):
1577 if not isinstance(line, basestring):
1578 raise TypeError(msg)
1578 raise TypeError(msg)
1579 return stb
1579 return stb
1580
1580
1581 if handler is None:
1581 if handler is None:
1582 wrapped = dummy_handler
1582 wrapped = dummy_handler
1583 else:
1583 else:
1584 def wrapped(self,etype,value,tb,tb_offset=None):
1584 def wrapped(self,etype,value,tb,tb_offset=None):
1585 """wrap CustomTB handler, to protect IPython from user code
1585 """wrap CustomTB handler, to protect IPython from user code
1586
1586
1587 This makes it harder (but not impossible) for custom exception
1587 This makes it harder (but not impossible) for custom exception
1588 handlers to crash IPython.
1588 handlers to crash IPython.
1589 """
1589 """
1590 try:
1590 try:
1591 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1591 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1592 return validate_stb(stb)
1592 return validate_stb(stb)
1593 except:
1593 except:
1594 # clear custom handler immediately
1594 # clear custom handler immediately
1595 self.set_custom_exc((), None)
1595 self.set_custom_exc((), None)
1596 print >> io.stderr, "Custom TB Handler failed, unregistering"
1596 print >> io.stderr, "Custom TB Handler failed, unregistering"
1597 # show the exception in handler first
1597 # show the exception in handler first
1598 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1598 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1599 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1599 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1600 print >> io.stdout, "The original exception:"
1600 print >> io.stdout, "The original exception:"
1601 stb = self.InteractiveTB.structured_traceback(
1601 stb = self.InteractiveTB.structured_traceback(
1602 (etype,value,tb), tb_offset=tb_offset
1602 (etype,value,tb), tb_offset=tb_offset
1603 )
1603 )
1604 return stb
1604 return stb
1605
1605
1606 self.CustomTB = types.MethodType(wrapped,self)
1606 self.CustomTB = types.MethodType(wrapped,self)
1607 self.custom_exceptions = exc_tuple
1607 self.custom_exceptions = exc_tuple
1608
1608
1609 def excepthook(self, etype, value, tb):
1609 def excepthook(self, etype, value, tb):
1610 """One more defense for GUI apps that call sys.excepthook.
1610 """One more defense for GUI apps that call sys.excepthook.
1611
1611
1612 GUI frameworks like wxPython trap exceptions and call
1612 GUI frameworks like wxPython trap exceptions and call
1613 sys.excepthook themselves. I guess this is a feature that
1613 sys.excepthook themselves. I guess this is a feature that
1614 enables them to keep running after exceptions that would
1614 enables them to keep running after exceptions that would
1615 otherwise kill their mainloop. This is a bother for IPython
1615 otherwise kill their mainloop. This is a bother for IPython
1616 which excepts to catch all of the program exceptions with a try:
1616 which excepts to catch all of the program exceptions with a try:
1617 except: statement.
1617 except: statement.
1618
1618
1619 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1619 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1620 any app directly invokes sys.excepthook, it will look to the user like
1620 any app directly invokes sys.excepthook, it will look to the user like
1621 IPython crashed. In order to work around this, we can disable the
1621 IPython crashed. In order to work around this, we can disable the
1622 CrashHandler and replace it with this excepthook instead, which prints a
1622 CrashHandler and replace it with this excepthook instead, which prints a
1623 regular traceback using our InteractiveTB. In this fashion, apps which
1623 regular traceback using our InteractiveTB. In this fashion, apps which
1624 call sys.excepthook will generate a regular-looking exception from
1624 call sys.excepthook will generate a regular-looking exception from
1625 IPython, and the CrashHandler will only be triggered by real IPython
1625 IPython, and the CrashHandler will only be triggered by real IPython
1626 crashes.
1626 crashes.
1627
1627
1628 This hook should be used sparingly, only in places which are not likely
1628 This hook should be used sparingly, only in places which are not likely
1629 to be true IPython errors.
1629 to be true IPython errors.
1630 """
1630 """
1631 self.showtraceback((etype,value,tb),tb_offset=0)
1631 self.showtraceback((etype,value,tb),tb_offset=0)
1632
1632
1633 def _get_exc_info(self, exc_tuple=None):
1633 def _get_exc_info(self, exc_tuple=None):
1634 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1634 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1635
1635
1636 Ensures sys.last_type,value,traceback hold the exc_info we found,
1636 Ensures sys.last_type,value,traceback hold the exc_info we found,
1637 from whichever source.
1637 from whichever source.
1638
1638
1639 raises ValueError if none of these contain any information
1639 raises ValueError if none of these contain any information
1640 """
1640 """
1641 if exc_tuple is None:
1641 if exc_tuple is None:
1642 etype, value, tb = sys.exc_info()
1642 etype, value, tb = sys.exc_info()
1643 else:
1643 else:
1644 etype, value, tb = exc_tuple
1644 etype, value, tb = exc_tuple
1645
1645
1646 if etype is None:
1646 if etype is None:
1647 if hasattr(sys, 'last_type'):
1647 if hasattr(sys, 'last_type'):
1648 etype, value, tb = sys.last_type, sys.last_value, \
1648 etype, value, tb = sys.last_type, sys.last_value, \
1649 sys.last_traceback
1649 sys.last_traceback
1650
1650
1651 if etype is None:
1651 if etype is None:
1652 raise ValueError("No exception to find")
1652 raise ValueError("No exception to find")
1653
1653
1654 # Now store the exception info in sys.last_type etc.
1654 # Now store the exception info in sys.last_type etc.
1655 # WARNING: these variables are somewhat deprecated and not
1655 # WARNING: these variables are somewhat deprecated and not
1656 # necessarily safe to use in a threaded environment, but tools
1656 # necessarily safe to use in a threaded environment, but tools
1657 # like pdb depend on their existence, so let's set them. If we
1657 # like pdb depend on their existence, so let's set them. If we
1658 # find problems in the field, we'll need to revisit their use.
1658 # find problems in the field, we'll need to revisit their use.
1659 sys.last_type = etype
1659 sys.last_type = etype
1660 sys.last_value = value
1660 sys.last_value = value
1661 sys.last_traceback = tb
1661 sys.last_traceback = tb
1662
1662
1663 return etype, value, tb
1663 return etype, value, tb
1664
1664
1665
1665
1666 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1666 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1667 exception_only=False):
1667 exception_only=False):
1668 """Display the exception that just occurred.
1668 """Display the exception that just occurred.
1669
1669
1670 If nothing is known about the exception, this is the method which
1670 If nothing is known about the exception, this is the method which
1671 should be used throughout the code for presenting user tracebacks,
1671 should be used throughout the code for presenting user tracebacks,
1672 rather than directly invoking the InteractiveTB object.
1672 rather than directly invoking the InteractiveTB object.
1673
1673
1674 A specific showsyntaxerror() also exists, but this method can take
1674 A specific showsyntaxerror() also exists, but this method can take
1675 care of calling it if needed, so unless you are explicitly catching a
1675 care of calling it if needed, so unless you are explicitly catching a
1676 SyntaxError exception, don't try to analyze the stack manually and
1676 SyntaxError exception, don't try to analyze the stack manually and
1677 simply call this method."""
1677 simply call this method."""
1678
1678
1679 try:
1679 try:
1680 try:
1680 try:
1681 etype, value, tb = self._get_exc_info(exc_tuple)
1681 etype, value, tb = self._get_exc_info(exc_tuple)
1682 except ValueError:
1682 except ValueError:
1683 self.write_err('No traceback available to show.\n')
1683 self.write_err('No traceback available to show.\n')
1684 return
1684 return
1685
1685
1686 if etype is SyntaxError:
1686 if etype is SyntaxError:
1687 # Though this won't be called by syntax errors in the input
1687 # Though this won't be called by syntax errors in the input
1688 # line, there may be SyntaxError cases with imported code.
1688 # line, there may be SyntaxError cases with imported code.
1689 self.showsyntaxerror(filename)
1689 self.showsyntaxerror(filename)
1690 elif etype is UsageError:
1690 elif etype is UsageError:
1691 self.write_err("UsageError: %s" % value)
1691 self.write_err("UsageError: %s" % value)
1692 else:
1692 else:
1693 if etype in self.custom_exceptions:
1693 if etype in self.custom_exceptions:
1694 stb = self.CustomTB(etype, value, tb, tb_offset)
1694 stb = self.CustomTB(etype, value, tb, tb_offset)
1695 else:
1695 else:
1696 if exception_only:
1696 if exception_only:
1697 stb = ['An exception has occurred, use %tb to see '
1697 stb = ['An exception has occurred, use %tb to see '
1698 'the full traceback.\n']
1698 'the full traceback.\n']
1699 stb.extend(self.InteractiveTB.get_exception_only(etype,
1699 stb.extend(self.InteractiveTB.get_exception_only(etype,
1700 value))
1700 value))
1701 else:
1701 else:
1702 stb = self.InteractiveTB.structured_traceback(etype,
1702 stb = self.InteractiveTB.structured_traceback(etype,
1703 value, tb, tb_offset=tb_offset)
1703 value, tb, tb_offset=tb_offset)
1704
1704
1705 self._showtraceback(etype, value, stb)
1705 self._showtraceback(etype, value, stb)
1706 if self.call_pdb:
1706 if self.call_pdb:
1707 # drop into debugger
1707 # drop into debugger
1708 self.debugger(force=True)
1708 self.debugger(force=True)
1709 return
1709 return
1710
1710
1711 # Actually show the traceback
1711 # Actually show the traceback
1712 self._showtraceback(etype, value, stb)
1712 self._showtraceback(etype, value, stb)
1713
1713
1714 except KeyboardInterrupt:
1714 except KeyboardInterrupt:
1715 self.write_err("\nKeyboardInterrupt\n")
1715 self.write_err("\nKeyboardInterrupt\n")
1716
1716
1717 def _showtraceback(self, etype, evalue, stb):
1717 def _showtraceback(self, etype, evalue, stb):
1718 """Actually show a traceback.
1718 """Actually show a traceback.
1719
1719
1720 Subclasses may override this method to put the traceback on a different
1720 Subclasses may override this method to put the traceback on a different
1721 place, like a side channel.
1721 place, like a side channel.
1722 """
1722 """
1723 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1723 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1724
1724
1725 def showsyntaxerror(self, filename=None):
1725 def showsyntaxerror(self, filename=None):
1726 """Display the syntax error that just occurred.
1726 """Display the syntax error that just occurred.
1727
1727
1728 This doesn't display a stack trace because there isn't one.
1728 This doesn't display a stack trace because there isn't one.
1729
1729
1730 If a filename is given, it is stuffed in the exception instead
1730 If a filename is given, it is stuffed in the exception instead
1731 of what was there before (because Python's parser always uses
1731 of what was there before (because Python's parser always uses
1732 "<string>" when reading from a string).
1732 "<string>" when reading from a string).
1733 """
1733 """
1734 etype, value, last_traceback = self._get_exc_info()
1734 etype, value, last_traceback = self._get_exc_info()
1735
1735
1736 if filename and etype is SyntaxError:
1736 if filename and etype is SyntaxError:
1737 try:
1737 try:
1738 value.filename = filename
1738 value.filename = filename
1739 except:
1739 except:
1740 # Not the format we expect; leave it alone
1740 # Not the format we expect; leave it alone
1741 pass
1741 pass
1742
1742
1743 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1743 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1744 self._showtraceback(etype, value, stb)
1744 self._showtraceback(etype, value, stb)
1745
1745
1746 # This is overridden in TerminalInteractiveShell to show a message about
1746 # This is overridden in TerminalInteractiveShell to show a message about
1747 # the %paste magic.
1747 # the %paste magic.
1748 def showindentationerror(self):
1748 def showindentationerror(self):
1749 """Called by run_cell when there's an IndentationError in code entered
1749 """Called by run_cell when there's an IndentationError in code entered
1750 at the prompt.
1750 at the prompt.
1751
1751
1752 This is overridden in TerminalInteractiveShell to show a message about
1752 This is overridden in TerminalInteractiveShell to show a message about
1753 the %paste magic."""
1753 the %paste magic."""
1754 self.showsyntaxerror()
1754 self.showsyntaxerror()
1755
1755
1756 #-------------------------------------------------------------------------
1756 #-------------------------------------------------------------------------
1757 # Things related to readline
1757 # Things related to readline
1758 #-------------------------------------------------------------------------
1758 #-------------------------------------------------------------------------
1759
1759
1760 def init_readline(self):
1760 def init_readline(self):
1761 """Command history completion/saving/reloading."""
1761 """Command history completion/saving/reloading."""
1762
1762
1763 if self.readline_use:
1763 if self.readline_use:
1764 import IPython.utils.rlineimpl as readline
1764 import IPython.utils.rlineimpl as readline
1765
1765
1766 self.rl_next_input = None
1766 self.rl_next_input = None
1767 self.rl_do_indent = False
1767 self.rl_do_indent = False
1768
1768
1769 if not self.readline_use or not readline.have_readline:
1769 if not self.readline_use or not readline.have_readline:
1770 self.has_readline = False
1770 self.has_readline = False
1771 self.readline = None
1771 self.readline = None
1772 # Set a number of methods that depend on readline to be no-op
1772 # Set a number of methods that depend on readline to be no-op
1773 self.readline_no_record = no_op_context
1773 self.readline_no_record = no_op_context
1774 self.set_readline_completer = no_op
1774 self.set_readline_completer = no_op
1775 self.set_custom_completer = no_op
1775 self.set_custom_completer = no_op
1776 self.set_completer_frame = no_op
1776 self.set_completer_frame = no_op
1777 if self.readline_use:
1777 if self.readline_use:
1778 warn('Readline services not available or not loaded.')
1778 warn('Readline services not available or not loaded.')
1779 else:
1779 else:
1780 self.has_readline = True
1780 self.has_readline = True
1781 self.readline = readline
1781 self.readline = readline
1782 sys.modules['readline'] = readline
1782 sys.modules['readline'] = readline
1783
1783
1784 # Platform-specific configuration
1784 # Platform-specific configuration
1785 if os.name == 'nt':
1785 if os.name == 'nt':
1786 # FIXME - check with Frederick to see if we can harmonize
1786 # FIXME - check with Frederick to see if we can harmonize
1787 # naming conventions with pyreadline to avoid this
1787 # naming conventions with pyreadline to avoid this
1788 # platform-dependent check
1788 # platform-dependent check
1789 self.readline_startup_hook = readline.set_pre_input_hook
1789 self.readline_startup_hook = readline.set_pre_input_hook
1790 else:
1790 else:
1791 self.readline_startup_hook = readline.set_startup_hook
1791 self.readline_startup_hook = readline.set_startup_hook
1792
1792
1793 # Load user's initrc file (readline config)
1793 # Load user's initrc file (readline config)
1794 # Or if libedit is used, load editrc.
1794 # Or if libedit is used, load editrc.
1795 inputrc_name = os.environ.get('INPUTRC')
1795 inputrc_name = os.environ.get('INPUTRC')
1796 if inputrc_name is None:
1796 if inputrc_name is None:
1797 inputrc_name = '.inputrc'
1797 inputrc_name = '.inputrc'
1798 if readline.uses_libedit:
1798 if readline.uses_libedit:
1799 inputrc_name = '.editrc'
1799 inputrc_name = '.editrc'
1800 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1800 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1801 if os.path.isfile(inputrc_name):
1801 if os.path.isfile(inputrc_name):
1802 try:
1802 try:
1803 readline.read_init_file(inputrc_name)
1803 readline.read_init_file(inputrc_name)
1804 except:
1804 except:
1805 warn('Problems reading readline initialization file <%s>'
1805 warn('Problems reading readline initialization file <%s>'
1806 % inputrc_name)
1806 % inputrc_name)
1807
1807
1808 # Configure readline according to user's prefs
1808 # Configure readline according to user's prefs
1809 # This is only done if GNU readline is being used. If libedit
1809 # This is only done if GNU readline is being used. If libedit
1810 # is being used (as on Leopard) the readline config is
1810 # is being used (as on Leopard) the readline config is
1811 # not run as the syntax for libedit is different.
1811 # not run as the syntax for libedit is different.
1812 if not readline.uses_libedit:
1812 if not readline.uses_libedit:
1813 for rlcommand in self.readline_parse_and_bind:
1813 for rlcommand in self.readline_parse_and_bind:
1814 #print "loading rl:",rlcommand # dbg
1814 #print "loading rl:",rlcommand # dbg
1815 readline.parse_and_bind(rlcommand)
1815 readline.parse_and_bind(rlcommand)
1816
1816
1817 # Remove some chars from the delimiters list. If we encounter
1817 # Remove some chars from the delimiters list. If we encounter
1818 # unicode chars, discard them.
1818 # unicode chars, discard them.
1819 delims = readline.get_completer_delims()
1819 delims = readline.get_completer_delims()
1820 if not py3compat.PY3:
1820 if not py3compat.PY3:
1821 delims = delims.encode("ascii", "ignore")
1821 delims = delims.encode("ascii", "ignore")
1822 for d in self.readline_remove_delims:
1822 for d in self.readline_remove_delims:
1823 delims = delims.replace(d, "")
1823 delims = delims.replace(d, "")
1824 delims = delims.replace(ESC_MAGIC, '')
1824 delims = delims.replace(ESC_MAGIC, '')
1825 readline.set_completer_delims(delims)
1825 readline.set_completer_delims(delims)
1826 # otherwise we end up with a monster history after a while:
1826 # otherwise we end up with a monster history after a while:
1827 readline.set_history_length(self.history_length)
1827 readline.set_history_length(self.history_length)
1828
1828
1829 self.refill_readline_hist()
1829 self.refill_readline_hist()
1830 self.readline_no_record = ReadlineNoRecord(self)
1830 self.readline_no_record = ReadlineNoRecord(self)
1831
1831
1832 # Configure auto-indent for all platforms
1832 # Configure auto-indent for all platforms
1833 self.set_autoindent(self.autoindent)
1833 self.set_autoindent(self.autoindent)
1834
1834
1835 def refill_readline_hist(self):
1835 def refill_readline_hist(self):
1836 # Load the last 1000 lines from history
1836 # Load the last 1000 lines from history
1837 self.readline.clear_history()
1837 self.readline.clear_history()
1838 stdin_encoding = sys.stdin.encoding or "utf-8"
1838 stdin_encoding = sys.stdin.encoding or "utf-8"
1839 last_cell = u""
1839 last_cell = u""
1840 for _, _, cell in self.history_manager.get_tail(1000,
1840 for _, _, cell in self.history_manager.get_tail(1000,
1841 include_latest=True):
1841 include_latest=True):
1842 # Ignore blank lines and consecutive duplicates
1842 # Ignore blank lines and consecutive duplicates
1843 cell = cell.rstrip()
1843 cell = cell.rstrip()
1844 if cell and (cell != last_cell):
1844 if cell and (cell != last_cell):
1845 if self.multiline_history:
1845 if self.multiline_history:
1846 self.readline.add_history(py3compat.unicode_to_str(cell,
1846 self.readline.add_history(py3compat.unicode_to_str(cell,
1847 stdin_encoding))
1847 stdin_encoding))
1848 else:
1848 else:
1849 for line in cell.splitlines():
1849 for line in cell.splitlines():
1850 self.readline.add_history(py3compat.unicode_to_str(line,
1850 self.readline.add_history(py3compat.unicode_to_str(line,
1851 stdin_encoding))
1851 stdin_encoding))
1852 last_cell = cell
1852 last_cell = cell
1853
1853
1854 def set_next_input(self, s):
1854 def set_next_input(self, s):
1855 """ Sets the 'default' input string for the next command line.
1855 """ Sets the 'default' input string for the next command line.
1856
1856
1857 Requires readline.
1857 Requires readline.
1858
1858
1859 Example:
1859 Example:
1860
1860
1861 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1861 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1862 [D:\ipython]|2> Hello Word_ # cursor is here
1862 [D:\ipython]|2> Hello Word_ # cursor is here
1863 """
1863 """
1864 self.rl_next_input = py3compat.cast_bytes_py2(s)
1864 self.rl_next_input = py3compat.cast_bytes_py2(s)
1865
1865
1866 # Maybe move this to the terminal subclass?
1866 # Maybe move this to the terminal subclass?
1867 def pre_readline(self):
1867 def pre_readline(self):
1868 """readline hook to be used at the start of each line.
1868 """readline hook to be used at the start of each line.
1869
1869
1870 Currently it handles auto-indent only."""
1870 Currently it handles auto-indent only."""
1871
1871
1872 if self.rl_do_indent:
1872 if self.rl_do_indent:
1873 self.readline.insert_text(self._indent_current_str())
1873 self.readline.insert_text(self._indent_current_str())
1874 if self.rl_next_input is not None:
1874 if self.rl_next_input is not None:
1875 self.readline.insert_text(self.rl_next_input)
1875 self.readline.insert_text(self.rl_next_input)
1876 self.rl_next_input = None
1876 self.rl_next_input = None
1877
1877
1878 def _indent_current_str(self):
1878 def _indent_current_str(self):
1879 """return the current level of indentation as a string"""
1879 """return the current level of indentation as a string"""
1880 return self.input_splitter.indent_spaces * ' '
1880 return self.input_splitter.indent_spaces * ' '
1881
1881
1882 #-------------------------------------------------------------------------
1882 #-------------------------------------------------------------------------
1883 # Things related to text completion
1883 # Things related to text completion
1884 #-------------------------------------------------------------------------
1884 #-------------------------------------------------------------------------
1885
1885
1886 def init_completer(self):
1886 def init_completer(self):
1887 """Initialize the completion machinery.
1887 """Initialize the completion machinery.
1888
1888
1889 This creates completion machinery that can be used by client code,
1889 This creates completion machinery that can be used by client code,
1890 either interactively in-process (typically triggered by the readline
1890 either interactively in-process (typically triggered by the readline
1891 library), programatically (such as in test suites) or out-of-prcess
1891 library), programatically (such as in test suites) or out-of-prcess
1892 (typically over the network by remote frontends).
1892 (typically over the network by remote frontends).
1893 """
1893 """
1894 from IPython.core.completer import IPCompleter
1894 from IPython.core.completer import IPCompleter
1895 from IPython.core.completerlib import (module_completer,
1895 from IPython.core.completerlib import (module_completer,
1896 magic_run_completer, cd_completer, reset_completer)
1896 magic_run_completer, cd_completer, reset_completer)
1897
1897
1898 self.Completer = IPCompleter(shell=self,
1898 self.Completer = IPCompleter(shell=self,
1899 namespace=self.user_ns,
1899 namespace=self.user_ns,
1900 global_namespace=self.user_global_ns,
1900 global_namespace=self.user_global_ns,
1901 alias_table=self.alias_manager.alias_table,
1901 alias_table=self.alias_manager.alias_table,
1902 use_readline=self.has_readline,
1902 use_readline=self.has_readline,
1903 config=self.config,
1903 config=self.config,
1904 )
1904 )
1905 self.configurables.append(self.Completer)
1905 self.configurables.append(self.Completer)
1906
1906
1907 # Add custom completers to the basic ones built into IPCompleter
1907 # Add custom completers to the basic ones built into IPCompleter
1908 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1908 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1909 self.strdispatchers['complete_command'] = sdisp
1909 self.strdispatchers['complete_command'] = sdisp
1910 self.Completer.custom_completers = sdisp
1910 self.Completer.custom_completers = sdisp
1911
1911
1912 self.set_hook('complete_command', module_completer, str_key = 'import')
1912 self.set_hook('complete_command', module_completer, str_key = 'import')
1913 self.set_hook('complete_command', module_completer, str_key = 'from')
1913 self.set_hook('complete_command', module_completer, str_key = 'from')
1914 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1914 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1915 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1915 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1916 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1916 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1917
1917
1918 # Only configure readline if we truly are using readline. IPython can
1918 # Only configure readline if we truly are using readline. IPython can
1919 # do tab-completion over the network, in GUIs, etc, where readline
1919 # do tab-completion over the network, in GUIs, etc, where readline
1920 # itself may be absent
1920 # itself may be absent
1921 if self.has_readline:
1921 if self.has_readline:
1922 self.set_readline_completer()
1922 self.set_readline_completer()
1923
1923
1924 def complete(self, text, line=None, cursor_pos=None):
1924 def complete(self, text, line=None, cursor_pos=None):
1925 """Return the completed text and a list of completions.
1925 """Return the completed text and a list of completions.
1926
1926
1927 Parameters
1927 Parameters
1928 ----------
1928 ----------
1929
1929
1930 text : string
1930 text : string
1931 A string of text to be completed on. It can be given as empty and
1931 A string of text to be completed on. It can be given as empty and
1932 instead a line/position pair are given. In this case, the
1932 instead a line/position pair are given. In this case, the
1933 completer itself will split the line like readline does.
1933 completer itself will split the line like readline does.
1934
1934
1935 line : string, optional
1935 line : string, optional
1936 The complete line that text is part of.
1936 The complete line that text is part of.
1937
1937
1938 cursor_pos : int, optional
1938 cursor_pos : int, optional
1939 The position of the cursor on the input line.
1939 The position of the cursor on the input line.
1940
1940
1941 Returns
1941 Returns
1942 -------
1942 -------
1943 text : string
1943 text : string
1944 The actual text that was completed.
1944 The actual text that was completed.
1945
1945
1946 matches : list
1946 matches : list
1947 A sorted list with all possible completions.
1947 A sorted list with all possible completions.
1948
1948
1949 The optional arguments allow the completion to take more context into
1949 The optional arguments allow the completion to take more context into
1950 account, and are part of the low-level completion API.
1950 account, and are part of the low-level completion API.
1951
1951
1952 This is a wrapper around the completion mechanism, similar to what
1952 This is a wrapper around the completion mechanism, similar to what
1953 readline does at the command line when the TAB key is hit. By
1953 readline does at the command line when the TAB key is hit. By
1954 exposing it as a method, it can be used by other non-readline
1954 exposing it as a method, it can be used by other non-readline
1955 environments (such as GUIs) for text completion.
1955 environments (such as GUIs) for text completion.
1956
1956
1957 Simple usage example:
1957 Simple usage example:
1958
1958
1959 In [1]: x = 'hello'
1959 In [1]: x = 'hello'
1960
1960
1961 In [2]: _ip.complete('x.l')
1961 In [2]: _ip.complete('x.l')
1962 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1962 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1963 """
1963 """
1964
1964
1965 # Inject names into __builtin__ so we can complete on the added names.
1965 # Inject names into __builtin__ so we can complete on the added names.
1966 with self.builtin_trap:
1966 with self.builtin_trap:
1967 return self.Completer.complete(text, line, cursor_pos)
1967 return self.Completer.complete(text, line, cursor_pos)
1968
1968
1969 def set_custom_completer(self, completer, pos=0):
1969 def set_custom_completer(self, completer, pos=0):
1970 """Adds a new custom completer function.
1970 """Adds a new custom completer function.
1971
1971
1972 The position argument (defaults to 0) is the index in the completers
1972 The position argument (defaults to 0) is the index in the completers
1973 list where you want the completer to be inserted."""
1973 list where you want the completer to be inserted."""
1974
1974
1975 newcomp = types.MethodType(completer,self.Completer)
1975 newcomp = types.MethodType(completer,self.Completer)
1976 self.Completer.matchers.insert(pos,newcomp)
1976 self.Completer.matchers.insert(pos,newcomp)
1977
1977
1978 def set_readline_completer(self):
1978 def set_readline_completer(self):
1979 """Reset readline's completer to be our own."""
1979 """Reset readline's completer to be our own."""
1980 self.readline.set_completer(self.Completer.rlcomplete)
1980 self.readline.set_completer(self.Completer.rlcomplete)
1981
1981
1982 def set_completer_frame(self, frame=None):
1982 def set_completer_frame(self, frame=None):
1983 """Set the frame of the completer."""
1983 """Set the frame of the completer."""
1984 if frame:
1984 if frame:
1985 self.Completer.namespace = frame.f_locals
1985 self.Completer.namespace = frame.f_locals
1986 self.Completer.global_namespace = frame.f_globals
1986 self.Completer.global_namespace = frame.f_globals
1987 else:
1987 else:
1988 self.Completer.namespace = self.user_ns
1988 self.Completer.namespace = self.user_ns
1989 self.Completer.global_namespace = self.user_global_ns
1989 self.Completer.global_namespace = self.user_global_ns
1990
1990
1991 #-------------------------------------------------------------------------
1991 #-------------------------------------------------------------------------
1992 # Things related to magics
1992 # Things related to magics
1993 #-------------------------------------------------------------------------
1993 #-------------------------------------------------------------------------
1994
1994
1995 def init_magics(self):
1995 def init_magics(self):
1996 from IPython.core import magic_functions as mf
1996 from IPython.core import magic_functions as mf
1997 from IPython.core import magics as m
1997 from IPython.core import magics as m
1998 self.magics_manager = magic.MagicsManager(shell=self,
1998 self.magics_manager = magic.MagicsManager(shell=self,
1999 confg=self.config,
1999 confg=self.config,
2000 user_magics=m.UserMagics(self))
2000 user_magics=m.UserMagics(self))
2001 self.configurables.append(self.magics_manager)
2001 self.configurables.append(self.magics_manager)
2002
2002
2003 # Expose as public API from the magics manager
2003 # Expose as public API from the magics manager
2004 self.register_magics = self.magics_manager.register
2004 self.register_magics = self.magics_manager.register
2005 self.register_magic_function = self.magics_manager.register_function
2005 self.register_magic_function = self.magics_manager.register_function
2006 self.define_magic = self.magics_manager.define_magic
2006 self.define_magic = self.magics_manager.define_magic
2007
2007
2008 self.register_magics(m.BasicMagics, mf.CodeMagics, mf.ConfigMagics,
2008 self.register_magics(m.BasicMagics, m.CodeMagics, mf.ConfigMagics,
2009 mf.ExecutionMagics, mf.NamespaceMagics, mf.AutoMagics,
2009 mf.ExecutionMagics, mf.NamespaceMagics, mf.AutoMagics,
2010 mf.OSMagics, mf.LoggingMagics, mf.ExtensionsMagics,
2010 mf.OSMagics, mf.LoggingMagics, mf.ExtensionsMagics,
2011 mf.PylabMagics, m.HistoryMagics, mf.DeprecatedMagics)
2011 mf.PylabMagics, m.HistoryMagics, mf.DeprecatedMagics)
2012
2012
2013 # FIXME: Move the color initialization to the DisplayHook, which
2013 # FIXME: Move the color initialization to the DisplayHook, which
2014 # should be split into a prompt manager and displayhook. We probably
2014 # should be split into a prompt manager and displayhook. We probably
2015 # even need a centralize colors management object.
2015 # even need a centralize colors management object.
2016 self.magic('colors %s' % self.colors)
2016 self.magic('colors %s' % self.colors)
2017
2017
2018 def line_magic(self, magic_name, line, next_input=None):
2018 def line_magic(self, magic_name, line, next_input=None):
2019 """Execute the given line magic.
2019 """Execute the given line magic.
2020
2020
2021 Parameters
2021 Parameters
2022 ----------
2022 ----------
2023 magic_name : str
2023 magic_name : str
2024 Name of the desired magic function, without '%' prefix.
2024 Name of the desired magic function, without '%' prefix.
2025
2025
2026 line : str
2026 line : str
2027 The rest of the input line as a single string.
2027 The rest of the input line as a single string.
2028
2028
2029 next_input : str, optional
2029 next_input : str, optional
2030 Text to pre-load into the next input line.
2030 Text to pre-load into the next input line.
2031 """
2031 """
2032 # Allow setting the next input - this is used if the user does `a=abs?`.
2032 # Allow setting the next input - this is used if the user does `a=abs?`.
2033 # We do this first so that magic functions can override it.
2033 # We do this first so that magic functions can override it.
2034 if next_input:
2034 if next_input:
2035 self.set_next_input(next_input)
2035 self.set_next_input(next_input)
2036
2036
2037 fn = self.find_line_magic(magic_name)
2037 fn = self.find_line_magic(magic_name)
2038 if fn is None:
2038 if fn is None:
2039 error("Magic function `%s` not found." % magic_name)
2039 error("Magic function `%s` not found." % magic_name)
2040 else:
2040 else:
2041 # Note: this is the distance in the stack to the user's frame.
2041 # Note: this is the distance in the stack to the user's frame.
2042 # This will need to be updated if the internal calling logic gets
2042 # This will need to be updated if the internal calling logic gets
2043 # refactored, or else we'll be expanding the wrong variables.
2043 # refactored, or else we'll be expanding the wrong variables.
2044 stack_depth = 2
2044 stack_depth = 2
2045 magic_arg_s = self.var_expand(line, stack_depth)
2045 magic_arg_s = self.var_expand(line, stack_depth)
2046 # Put magic args in a list so we can call with f(*a) syntax
2046 # Put magic args in a list so we can call with f(*a) syntax
2047 args = [magic_arg_s]
2047 args = [magic_arg_s]
2048 # Grab local namespace if we need it:
2048 # Grab local namespace if we need it:
2049 if getattr(fn, "needs_local_scope", False):
2049 if getattr(fn, "needs_local_scope", False):
2050 args.append(sys._getframe(stack_depth).f_locals)
2050 args.append(sys._getframe(stack_depth).f_locals)
2051 with self.builtin_trap:
2051 with self.builtin_trap:
2052 result = fn(*args)
2052 result = fn(*args)
2053 return result
2053 return result
2054
2054
2055 def cell_magic(self, magic_name, line, cell):
2055 def cell_magic(self, magic_name, line, cell):
2056 """Execute the given cell magic.
2056 """Execute the given cell magic.
2057 """
2057 """
2058 fn = self.find_cell_magic(magic_name)
2058 fn = self.find_cell_magic(magic_name)
2059 if fn is None:
2059 if fn is None:
2060 error("Magic function `%s` not found." % magic_name)
2060 error("Magic function `%s` not found." % magic_name)
2061 else:
2061 else:
2062 # Note: this is the distance in the stack to the user's frame.
2062 # Note: this is the distance in the stack to the user's frame.
2063 # This will need to be updated if the internal calling logic gets
2063 # This will need to be updated if the internal calling logic gets
2064 # refactored, or else we'll be expanding the wrong variables.
2064 # refactored, or else we'll be expanding the wrong variables.
2065 stack_depth = 2
2065 stack_depth = 2
2066 magic_arg_s = self.var_expand(line, stack_depth)
2066 magic_arg_s = self.var_expand(line, stack_depth)
2067 with self.builtin_trap:
2067 with self.builtin_trap:
2068 result = fn(line, cell)
2068 result = fn(line, cell)
2069 return result
2069 return result
2070
2070
2071 def find_line_magic(self, magic_name):
2071 def find_line_magic(self, magic_name):
2072 """Find and return a line magic by name.
2072 """Find and return a line magic by name.
2073
2073
2074 Returns None if the magic isn't found."""
2074 Returns None if the magic isn't found."""
2075 return self.magics_manager.magics['line'].get(magic_name)
2075 return self.magics_manager.magics['line'].get(magic_name)
2076
2076
2077 def find_cell_magic(self, magic_name):
2077 def find_cell_magic(self, magic_name):
2078 """Find and return a cell magic by name.
2078 """Find and return a cell magic by name.
2079
2079
2080 Returns None if the magic isn't found."""
2080 Returns None if the magic isn't found."""
2081 return self.magics_manager.magics['cell'].get(magic_name)
2081 return self.magics_manager.magics['cell'].get(magic_name)
2082
2082
2083 def find_magic(self, magic_name, magic_type='line'):
2083 def find_magic(self, magic_name, magic_type='line'):
2084 """Find and return a magic of the given type by name.
2084 """Find and return a magic of the given type by name.
2085
2085
2086 Returns None if the magic isn't found."""
2086 Returns None if the magic isn't found."""
2087 return self.magics_manager.magics[magic_type].get(magic_name)
2087 return self.magics_manager.magics[magic_type].get(magic_name)
2088
2088
2089 def magic(self, arg_s, next_input=None):
2089 def magic(self, arg_s, next_input=None):
2090 """DEPRECATED. Use line_magic() instead.
2090 """DEPRECATED. Use line_magic() instead.
2091
2091
2092 Call a magic function by name.
2092 Call a magic function by name.
2093
2093
2094 Input: a string containing the name of the magic function to call and
2094 Input: a string containing the name of the magic function to call and
2095 any additional arguments to be passed to the magic.
2095 any additional arguments to be passed to the magic.
2096
2096
2097 magic('name -opt foo bar') is equivalent to typing at the ipython
2097 magic('name -opt foo bar') is equivalent to typing at the ipython
2098 prompt:
2098 prompt:
2099
2099
2100 In[1]: %name -opt foo bar
2100 In[1]: %name -opt foo bar
2101
2101
2102 To call a magic without arguments, simply use magic('name').
2102 To call a magic without arguments, simply use magic('name').
2103
2103
2104 This provides a proper Python function to call IPython's magics in any
2104 This provides a proper Python function to call IPython's magics in any
2105 valid Python code you can type at the interpreter, including loops and
2105 valid Python code you can type at the interpreter, including loops and
2106 compound statements.
2106 compound statements.
2107 """
2107 """
2108 # TODO: should we issue a loud deprecation warning here?
2108 # TODO: should we issue a loud deprecation warning here?
2109 magic_name, _, magic_arg_s = arg_s.partition(' ')
2109 magic_name, _, magic_arg_s = arg_s.partition(' ')
2110 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2110 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2111 return self.line_magic(magic_name, magic_arg_s, next_input)
2111 return self.line_magic(magic_name, magic_arg_s, next_input)
2112
2112
2113 #-------------------------------------------------------------------------
2113 #-------------------------------------------------------------------------
2114 # Things related to macros
2114 # Things related to macros
2115 #-------------------------------------------------------------------------
2115 #-------------------------------------------------------------------------
2116
2116
2117 def define_macro(self, name, themacro):
2117 def define_macro(self, name, themacro):
2118 """Define a new macro
2118 """Define a new macro
2119
2119
2120 Parameters
2120 Parameters
2121 ----------
2121 ----------
2122 name : str
2122 name : str
2123 The name of the macro.
2123 The name of the macro.
2124 themacro : str or Macro
2124 themacro : str or Macro
2125 The action to do upon invoking the macro. If a string, a new
2125 The action to do upon invoking the macro. If a string, a new
2126 Macro object is created by passing the string to it.
2126 Macro object is created by passing the string to it.
2127 """
2127 """
2128
2128
2129 from IPython.core import macro
2129 from IPython.core import macro
2130
2130
2131 if isinstance(themacro, basestring):
2131 if isinstance(themacro, basestring):
2132 themacro = macro.Macro(themacro)
2132 themacro = macro.Macro(themacro)
2133 if not isinstance(themacro, macro.Macro):
2133 if not isinstance(themacro, macro.Macro):
2134 raise ValueError('A macro must be a string or a Macro instance.')
2134 raise ValueError('A macro must be a string or a Macro instance.')
2135 self.user_ns[name] = themacro
2135 self.user_ns[name] = themacro
2136
2136
2137 #-------------------------------------------------------------------------
2137 #-------------------------------------------------------------------------
2138 # Things related to the running of system commands
2138 # Things related to the running of system commands
2139 #-------------------------------------------------------------------------
2139 #-------------------------------------------------------------------------
2140
2140
2141 def system_piped(self, cmd):
2141 def system_piped(self, cmd):
2142 """Call the given cmd in a subprocess, piping stdout/err
2142 """Call the given cmd in a subprocess, piping stdout/err
2143
2143
2144 Parameters
2144 Parameters
2145 ----------
2145 ----------
2146 cmd : str
2146 cmd : str
2147 Command to execute (can not end in '&', as background processes are
2147 Command to execute (can not end in '&', as background processes are
2148 not supported. Should not be a command that expects input
2148 not supported. Should not be a command that expects input
2149 other than simple text.
2149 other than simple text.
2150 """
2150 """
2151 if cmd.rstrip().endswith('&'):
2151 if cmd.rstrip().endswith('&'):
2152 # this is *far* from a rigorous test
2152 # this is *far* from a rigorous test
2153 # We do not support backgrounding processes because we either use
2153 # We do not support backgrounding processes because we either use
2154 # pexpect or pipes to read from. Users can always just call
2154 # pexpect or pipes to read from. Users can always just call
2155 # os.system() or use ip.system=ip.system_raw
2155 # os.system() or use ip.system=ip.system_raw
2156 # if they really want a background process.
2156 # if they really want a background process.
2157 raise OSError("Background processes not supported.")
2157 raise OSError("Background processes not supported.")
2158
2158
2159 # we explicitly do NOT return the subprocess status code, because
2159 # we explicitly do NOT return the subprocess status code, because
2160 # a non-None value would trigger :func:`sys.displayhook` calls.
2160 # a non-None value would trigger :func:`sys.displayhook` calls.
2161 # Instead, we store the exit_code in user_ns.
2161 # Instead, we store the exit_code in user_ns.
2162 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2162 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2163
2163
2164 def system_raw(self, cmd):
2164 def system_raw(self, cmd):
2165 """Call the given cmd in a subprocess using os.system
2165 """Call the given cmd in a subprocess using os.system
2166
2166
2167 Parameters
2167 Parameters
2168 ----------
2168 ----------
2169 cmd : str
2169 cmd : str
2170 Command to execute.
2170 Command to execute.
2171 """
2171 """
2172 cmd = self.var_expand(cmd, depth=2)
2172 cmd = self.var_expand(cmd, depth=2)
2173 # protect os.system from UNC paths on Windows, which it can't handle:
2173 # protect os.system from UNC paths on Windows, which it can't handle:
2174 if sys.platform == 'win32':
2174 if sys.platform == 'win32':
2175 from IPython.utils._process_win32 import AvoidUNCPath
2175 from IPython.utils._process_win32 import AvoidUNCPath
2176 with AvoidUNCPath() as path:
2176 with AvoidUNCPath() as path:
2177 if path is not None:
2177 if path is not None:
2178 cmd = '"pushd %s &&"%s' % (path, cmd)
2178 cmd = '"pushd %s &&"%s' % (path, cmd)
2179 cmd = py3compat.unicode_to_str(cmd)
2179 cmd = py3compat.unicode_to_str(cmd)
2180 ec = os.system(cmd)
2180 ec = os.system(cmd)
2181 else:
2181 else:
2182 cmd = py3compat.unicode_to_str(cmd)
2182 cmd = py3compat.unicode_to_str(cmd)
2183 ec = os.system(cmd)
2183 ec = os.system(cmd)
2184
2184
2185 # We explicitly do NOT return the subprocess status code, because
2185 # We explicitly do NOT return the subprocess status code, because
2186 # a non-None value would trigger :func:`sys.displayhook` calls.
2186 # a non-None value would trigger :func:`sys.displayhook` calls.
2187 # Instead, we store the exit_code in user_ns.
2187 # Instead, we store the exit_code in user_ns.
2188 self.user_ns['_exit_code'] = ec
2188 self.user_ns['_exit_code'] = ec
2189
2189
2190 # use piped system by default, because it is better behaved
2190 # use piped system by default, because it is better behaved
2191 system = system_piped
2191 system = system_piped
2192
2192
2193 def getoutput(self, cmd, split=True):
2193 def getoutput(self, cmd, split=True):
2194 """Get output (possibly including stderr) from a subprocess.
2194 """Get output (possibly including stderr) from a subprocess.
2195
2195
2196 Parameters
2196 Parameters
2197 ----------
2197 ----------
2198 cmd : str
2198 cmd : str
2199 Command to execute (can not end in '&', as background processes are
2199 Command to execute (can not end in '&', as background processes are
2200 not supported.
2200 not supported.
2201 split : bool, optional
2201 split : bool, optional
2202
2202
2203 If True, split the output into an IPython SList. Otherwise, an
2203 If True, split the output into an IPython SList. Otherwise, an
2204 IPython LSString is returned. These are objects similar to normal
2204 IPython LSString is returned. These are objects similar to normal
2205 lists and strings, with a few convenience attributes for easier
2205 lists and strings, with a few convenience attributes for easier
2206 manipulation of line-based output. You can use '?' on them for
2206 manipulation of line-based output. You can use '?' on them for
2207 details.
2207 details.
2208 """
2208 """
2209 if cmd.rstrip().endswith('&'):
2209 if cmd.rstrip().endswith('&'):
2210 # this is *far* from a rigorous test
2210 # this is *far* from a rigorous test
2211 raise OSError("Background processes not supported.")
2211 raise OSError("Background processes not supported.")
2212 out = getoutput(self.var_expand(cmd, depth=2))
2212 out = getoutput(self.var_expand(cmd, depth=2))
2213 if split:
2213 if split:
2214 out = SList(out.splitlines())
2214 out = SList(out.splitlines())
2215 else:
2215 else:
2216 out = LSString(out)
2216 out = LSString(out)
2217 return out
2217 return out
2218
2218
2219 #-------------------------------------------------------------------------
2219 #-------------------------------------------------------------------------
2220 # Things related to aliases
2220 # Things related to aliases
2221 #-------------------------------------------------------------------------
2221 #-------------------------------------------------------------------------
2222
2222
2223 def init_alias(self):
2223 def init_alias(self):
2224 self.alias_manager = AliasManager(shell=self, config=self.config)
2224 self.alias_manager = AliasManager(shell=self, config=self.config)
2225 self.configurables.append(self.alias_manager)
2225 self.configurables.append(self.alias_manager)
2226 self.ns_table['alias'] = self.alias_manager.alias_table,
2226 self.ns_table['alias'] = self.alias_manager.alias_table,
2227
2227
2228 #-------------------------------------------------------------------------
2228 #-------------------------------------------------------------------------
2229 # Things related to extensions and plugins
2229 # Things related to extensions and plugins
2230 #-------------------------------------------------------------------------
2230 #-------------------------------------------------------------------------
2231
2231
2232 def init_extension_manager(self):
2232 def init_extension_manager(self):
2233 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2233 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2234 self.configurables.append(self.extension_manager)
2234 self.configurables.append(self.extension_manager)
2235
2235
2236 def init_plugin_manager(self):
2236 def init_plugin_manager(self):
2237 self.plugin_manager = PluginManager(config=self.config)
2237 self.plugin_manager = PluginManager(config=self.config)
2238 self.configurables.append(self.plugin_manager)
2238 self.configurables.append(self.plugin_manager)
2239
2239
2240
2240
2241 #-------------------------------------------------------------------------
2241 #-------------------------------------------------------------------------
2242 # Things related to payloads
2242 # Things related to payloads
2243 #-------------------------------------------------------------------------
2243 #-------------------------------------------------------------------------
2244
2244
2245 def init_payload(self):
2245 def init_payload(self):
2246 self.payload_manager = PayloadManager(config=self.config)
2246 self.payload_manager = PayloadManager(config=self.config)
2247 self.configurables.append(self.payload_manager)
2247 self.configurables.append(self.payload_manager)
2248
2248
2249 #-------------------------------------------------------------------------
2249 #-------------------------------------------------------------------------
2250 # Things related to the prefilter
2250 # Things related to the prefilter
2251 #-------------------------------------------------------------------------
2251 #-------------------------------------------------------------------------
2252
2252
2253 def init_prefilter(self):
2253 def init_prefilter(self):
2254 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2254 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2255 self.configurables.append(self.prefilter_manager)
2255 self.configurables.append(self.prefilter_manager)
2256 # Ultimately this will be refactored in the new interpreter code, but
2256 # Ultimately this will be refactored in the new interpreter code, but
2257 # for now, we should expose the main prefilter method (there's legacy
2257 # for now, we should expose the main prefilter method (there's legacy
2258 # code out there that may rely on this).
2258 # code out there that may rely on this).
2259 self.prefilter = self.prefilter_manager.prefilter_lines
2259 self.prefilter = self.prefilter_manager.prefilter_lines
2260
2260
2261 def auto_rewrite_input(self, cmd):
2261 def auto_rewrite_input(self, cmd):
2262 """Print to the screen the rewritten form of the user's command.
2262 """Print to the screen the rewritten form of the user's command.
2263
2263
2264 This shows visual feedback by rewriting input lines that cause
2264 This shows visual feedback by rewriting input lines that cause
2265 automatic calling to kick in, like::
2265 automatic calling to kick in, like::
2266
2266
2267 /f x
2267 /f x
2268
2268
2269 into::
2269 into::
2270
2270
2271 ------> f(x)
2271 ------> f(x)
2272
2272
2273 after the user's input prompt. This helps the user understand that the
2273 after the user's input prompt. This helps the user understand that the
2274 input line was transformed automatically by IPython.
2274 input line was transformed automatically by IPython.
2275 """
2275 """
2276 if not self.show_rewritten_input:
2276 if not self.show_rewritten_input:
2277 return
2277 return
2278
2278
2279 rw = self.prompt_manager.render('rewrite') + cmd
2279 rw = self.prompt_manager.render('rewrite') + cmd
2280
2280
2281 try:
2281 try:
2282 # plain ascii works better w/ pyreadline, on some machines, so
2282 # plain ascii works better w/ pyreadline, on some machines, so
2283 # we use it and only print uncolored rewrite if we have unicode
2283 # we use it and only print uncolored rewrite if we have unicode
2284 rw = str(rw)
2284 rw = str(rw)
2285 print >> io.stdout, rw
2285 print >> io.stdout, rw
2286 except UnicodeEncodeError:
2286 except UnicodeEncodeError:
2287 print "------> " + cmd
2287 print "------> " + cmd
2288
2288
2289 #-------------------------------------------------------------------------
2289 #-------------------------------------------------------------------------
2290 # Things related to extracting values/expressions from kernel and user_ns
2290 # Things related to extracting values/expressions from kernel and user_ns
2291 #-------------------------------------------------------------------------
2291 #-------------------------------------------------------------------------
2292
2292
2293 def _simple_error(self):
2293 def _simple_error(self):
2294 etype, value = sys.exc_info()[:2]
2294 etype, value = sys.exc_info()[:2]
2295 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2295 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2296
2296
2297 def user_variables(self, names):
2297 def user_variables(self, names):
2298 """Get a list of variable names from the user's namespace.
2298 """Get a list of variable names from the user's namespace.
2299
2299
2300 Parameters
2300 Parameters
2301 ----------
2301 ----------
2302 names : list of strings
2302 names : list of strings
2303 A list of names of variables to be read from the user namespace.
2303 A list of names of variables to be read from the user namespace.
2304
2304
2305 Returns
2305 Returns
2306 -------
2306 -------
2307 A dict, keyed by the input names and with the repr() of each value.
2307 A dict, keyed by the input names and with the repr() of each value.
2308 """
2308 """
2309 out = {}
2309 out = {}
2310 user_ns = self.user_ns
2310 user_ns = self.user_ns
2311 for varname in names:
2311 for varname in names:
2312 try:
2312 try:
2313 value = repr(user_ns[varname])
2313 value = repr(user_ns[varname])
2314 except:
2314 except:
2315 value = self._simple_error()
2315 value = self._simple_error()
2316 out[varname] = value
2316 out[varname] = value
2317 return out
2317 return out
2318
2318
2319 def user_expressions(self, expressions):
2319 def user_expressions(self, expressions):
2320 """Evaluate a dict of expressions in the user's namespace.
2320 """Evaluate a dict of expressions in the user's namespace.
2321
2321
2322 Parameters
2322 Parameters
2323 ----------
2323 ----------
2324 expressions : dict
2324 expressions : dict
2325 A dict with string keys and string values. The expression values
2325 A dict with string keys and string values. The expression values
2326 should be valid Python expressions, each of which will be evaluated
2326 should be valid Python expressions, each of which will be evaluated
2327 in the user namespace.
2327 in the user namespace.
2328
2328
2329 Returns
2329 Returns
2330 -------
2330 -------
2331 A dict, keyed like the input expressions dict, with the repr() of each
2331 A dict, keyed like the input expressions dict, with the repr() of each
2332 value.
2332 value.
2333 """
2333 """
2334 out = {}
2334 out = {}
2335 user_ns = self.user_ns
2335 user_ns = self.user_ns
2336 global_ns = self.user_global_ns
2336 global_ns = self.user_global_ns
2337 for key, expr in expressions.iteritems():
2337 for key, expr in expressions.iteritems():
2338 try:
2338 try:
2339 value = repr(eval(expr, global_ns, user_ns))
2339 value = repr(eval(expr, global_ns, user_ns))
2340 except:
2340 except:
2341 value = self._simple_error()
2341 value = self._simple_error()
2342 out[key] = value
2342 out[key] = value
2343 return out
2343 return out
2344
2344
2345 #-------------------------------------------------------------------------
2345 #-------------------------------------------------------------------------
2346 # Things related to the running of code
2346 # Things related to the running of code
2347 #-------------------------------------------------------------------------
2347 #-------------------------------------------------------------------------
2348
2348
2349 def ex(self, cmd):
2349 def ex(self, cmd):
2350 """Execute a normal python statement in user namespace."""
2350 """Execute a normal python statement in user namespace."""
2351 with self.builtin_trap:
2351 with self.builtin_trap:
2352 exec cmd in self.user_global_ns, self.user_ns
2352 exec cmd in self.user_global_ns, self.user_ns
2353
2353
2354 def ev(self, expr):
2354 def ev(self, expr):
2355 """Evaluate python expression expr in user namespace.
2355 """Evaluate python expression expr in user namespace.
2356
2356
2357 Returns the result of evaluation
2357 Returns the result of evaluation
2358 """
2358 """
2359 with self.builtin_trap:
2359 with self.builtin_trap:
2360 return eval(expr, self.user_global_ns, self.user_ns)
2360 return eval(expr, self.user_global_ns, self.user_ns)
2361
2361
2362 def safe_execfile(self, fname, *where, **kw):
2362 def safe_execfile(self, fname, *where, **kw):
2363 """A safe version of the builtin execfile().
2363 """A safe version of the builtin execfile().
2364
2364
2365 This version will never throw an exception, but instead print
2365 This version will never throw an exception, but instead print
2366 helpful error messages to the screen. This only works on pure
2366 helpful error messages to the screen. This only works on pure
2367 Python files with the .py extension.
2367 Python files with the .py extension.
2368
2368
2369 Parameters
2369 Parameters
2370 ----------
2370 ----------
2371 fname : string
2371 fname : string
2372 The name of the file to be executed.
2372 The name of the file to be executed.
2373 where : tuple
2373 where : tuple
2374 One or two namespaces, passed to execfile() as (globals,locals).
2374 One or two namespaces, passed to execfile() as (globals,locals).
2375 If only one is given, it is passed as both.
2375 If only one is given, it is passed as both.
2376 exit_ignore : bool (False)
2376 exit_ignore : bool (False)
2377 If True, then silence SystemExit for non-zero status (it is always
2377 If True, then silence SystemExit for non-zero status (it is always
2378 silenced for zero status, as it is so common).
2378 silenced for zero status, as it is so common).
2379 raise_exceptions : bool (False)
2379 raise_exceptions : bool (False)
2380 If True raise exceptions everywhere. Meant for testing.
2380 If True raise exceptions everywhere. Meant for testing.
2381
2381
2382 """
2382 """
2383 kw.setdefault('exit_ignore', False)
2383 kw.setdefault('exit_ignore', False)
2384 kw.setdefault('raise_exceptions', False)
2384 kw.setdefault('raise_exceptions', False)
2385
2385
2386 fname = os.path.abspath(os.path.expanduser(fname))
2386 fname = os.path.abspath(os.path.expanduser(fname))
2387
2387
2388 # Make sure we can open the file
2388 # Make sure we can open the file
2389 try:
2389 try:
2390 with open(fname) as thefile:
2390 with open(fname) as thefile:
2391 pass
2391 pass
2392 except:
2392 except:
2393 warn('Could not open file <%s> for safe execution.' % fname)
2393 warn('Could not open file <%s> for safe execution.' % fname)
2394 return
2394 return
2395
2395
2396 # Find things also in current directory. This is needed to mimic the
2396 # Find things also in current directory. This is needed to mimic the
2397 # behavior of running a script from the system command line, where
2397 # behavior of running a script from the system command line, where
2398 # Python inserts the script's directory into sys.path
2398 # Python inserts the script's directory into sys.path
2399 dname = os.path.dirname(fname)
2399 dname = os.path.dirname(fname)
2400
2400
2401 with prepended_to_syspath(dname):
2401 with prepended_to_syspath(dname):
2402 try:
2402 try:
2403 py3compat.execfile(fname,*where)
2403 py3compat.execfile(fname,*where)
2404 except SystemExit, status:
2404 except SystemExit, status:
2405 # If the call was made with 0 or None exit status (sys.exit(0)
2405 # If the call was made with 0 or None exit status (sys.exit(0)
2406 # or sys.exit() ), don't bother showing a traceback, as both of
2406 # or sys.exit() ), don't bother showing a traceback, as both of
2407 # these are considered normal by the OS:
2407 # these are considered normal by the OS:
2408 # > python -c'import sys;sys.exit(0)'; echo $?
2408 # > python -c'import sys;sys.exit(0)'; echo $?
2409 # 0
2409 # 0
2410 # > python -c'import sys;sys.exit()'; echo $?
2410 # > python -c'import sys;sys.exit()'; echo $?
2411 # 0
2411 # 0
2412 # For other exit status, we show the exception unless
2412 # For other exit status, we show the exception unless
2413 # explicitly silenced, but only in short form.
2413 # explicitly silenced, but only in short form.
2414 if kw['raise_exceptions']:
2414 if kw['raise_exceptions']:
2415 raise
2415 raise
2416 if status.code not in (0, None) and not kw['exit_ignore']:
2416 if status.code not in (0, None) and not kw['exit_ignore']:
2417 self.showtraceback(exception_only=True)
2417 self.showtraceback(exception_only=True)
2418 except:
2418 except:
2419 if kw['raise_exceptions']:
2419 if kw['raise_exceptions']:
2420 raise
2420 raise
2421 self.showtraceback()
2421 self.showtraceback()
2422
2422
2423 def safe_execfile_ipy(self, fname):
2423 def safe_execfile_ipy(self, fname):
2424 """Like safe_execfile, but for .ipy files with IPython syntax.
2424 """Like safe_execfile, but for .ipy files with IPython syntax.
2425
2425
2426 Parameters
2426 Parameters
2427 ----------
2427 ----------
2428 fname : str
2428 fname : str
2429 The name of the file to execute. The filename must have a
2429 The name of the file to execute. The filename must have a
2430 .ipy extension.
2430 .ipy extension.
2431 """
2431 """
2432 fname = os.path.abspath(os.path.expanduser(fname))
2432 fname = os.path.abspath(os.path.expanduser(fname))
2433
2433
2434 # Make sure we can open the file
2434 # Make sure we can open the file
2435 try:
2435 try:
2436 with open(fname) as thefile:
2436 with open(fname) as thefile:
2437 pass
2437 pass
2438 except:
2438 except:
2439 warn('Could not open file <%s> for safe execution.' % fname)
2439 warn('Could not open file <%s> for safe execution.' % fname)
2440 return
2440 return
2441
2441
2442 # Find things also in current directory. This is needed to mimic the
2442 # Find things also in current directory. This is needed to mimic the
2443 # behavior of running a script from the system command line, where
2443 # behavior of running a script from the system command line, where
2444 # Python inserts the script's directory into sys.path
2444 # Python inserts the script's directory into sys.path
2445 dname = os.path.dirname(fname)
2445 dname = os.path.dirname(fname)
2446
2446
2447 with prepended_to_syspath(dname):
2447 with prepended_to_syspath(dname):
2448 try:
2448 try:
2449 with open(fname) as thefile:
2449 with open(fname) as thefile:
2450 # self.run_cell currently captures all exceptions
2450 # self.run_cell currently captures all exceptions
2451 # raised in user code. It would be nice if there were
2451 # raised in user code. It would be nice if there were
2452 # versions of runlines, execfile that did raise, so
2452 # versions of runlines, execfile that did raise, so
2453 # we could catch the errors.
2453 # we could catch the errors.
2454 self.run_cell(thefile.read(), store_history=False)
2454 self.run_cell(thefile.read(), store_history=False)
2455 except:
2455 except:
2456 self.showtraceback()
2456 self.showtraceback()
2457 warn('Unknown failure executing file: <%s>' % fname)
2457 warn('Unknown failure executing file: <%s>' % fname)
2458
2458
2459 def safe_run_module(self, mod_name, where):
2459 def safe_run_module(self, mod_name, where):
2460 """A safe version of runpy.run_module().
2460 """A safe version of runpy.run_module().
2461
2461
2462 This version will never throw an exception, but instead print
2462 This version will never throw an exception, but instead print
2463 helpful error messages to the screen.
2463 helpful error messages to the screen.
2464
2464
2465 Parameters
2465 Parameters
2466 ----------
2466 ----------
2467 mod_name : string
2467 mod_name : string
2468 The name of the module to be executed.
2468 The name of the module to be executed.
2469 where : dict
2469 where : dict
2470 The globals namespace.
2470 The globals namespace.
2471 """
2471 """
2472 try:
2472 try:
2473 where.update(
2473 where.update(
2474 runpy.run_module(str(mod_name), run_name="__main__",
2474 runpy.run_module(str(mod_name), run_name="__main__",
2475 alter_sys=True)
2475 alter_sys=True)
2476 )
2476 )
2477 except:
2477 except:
2478 self.showtraceback()
2478 self.showtraceback()
2479 warn('Unknown failure executing module: <%s>' % mod_name)
2479 warn('Unknown failure executing module: <%s>' % mod_name)
2480
2480
2481 def call_cell_magic(self, raw_cell, store_history=False):
2481 def call_cell_magic(self, raw_cell, store_history=False):
2482 line, _, cell = raw_cell.partition(os.linesep)
2482 line, _, cell = raw_cell.partition(os.linesep)
2483 magic_name, _, line = line.partition(' ')
2483 magic_name, _, line = line.partition(' ')
2484 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2484 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2485 return self.cell_magic(magic_name, line, cell)
2485 return self.cell_magic(magic_name, line, cell)
2486
2486
2487 def run_cell(self, raw_cell, store_history=False, silent=False):
2487 def run_cell(self, raw_cell, store_history=False, silent=False):
2488 """Run a complete IPython cell.
2488 """Run a complete IPython cell.
2489
2489
2490 Parameters
2490 Parameters
2491 ----------
2491 ----------
2492 raw_cell : str
2492 raw_cell : str
2493 The code (including IPython code such as %magic functions) to run.
2493 The code (including IPython code such as %magic functions) to run.
2494 store_history : bool
2494 store_history : bool
2495 If True, the raw and translated cell will be stored in IPython's
2495 If True, the raw and translated cell will be stored in IPython's
2496 history. For user code calling back into IPython's machinery, this
2496 history. For user code calling back into IPython's machinery, this
2497 should be set to False.
2497 should be set to False.
2498 silent : bool
2498 silent : bool
2499 If True, avoid side-effets, such as implicit displayhooks, history,
2499 If True, avoid side-effets, such as implicit displayhooks, history,
2500 and logging. silent=True forces store_history=False.
2500 and logging. silent=True forces store_history=False.
2501 """
2501 """
2502 if (not raw_cell) or raw_cell.isspace():
2502 if (not raw_cell) or raw_cell.isspace():
2503 return
2503 return
2504
2504
2505 if silent:
2505 if silent:
2506 store_history = False
2506 store_history = False
2507
2507
2508 if raw_cell.startswith('%%'):
2508 if raw_cell.startswith('%%'):
2509 return self.call_cell_magic(raw_cell, store_history)
2509 return self.call_cell_magic(raw_cell, store_history)
2510
2510
2511 for line in raw_cell.splitlines():
2511 for line in raw_cell.splitlines():
2512 self.input_splitter.push(line)
2512 self.input_splitter.push(line)
2513 cell = self.input_splitter.source_reset()
2513 cell = self.input_splitter.source_reset()
2514
2514
2515 with self.builtin_trap:
2515 with self.builtin_trap:
2516 prefilter_failed = False
2516 prefilter_failed = False
2517 if len(cell.splitlines()) == 1:
2517 if len(cell.splitlines()) == 1:
2518 try:
2518 try:
2519 # use prefilter_lines to handle trailing newlines
2519 # use prefilter_lines to handle trailing newlines
2520 # restore trailing newline for ast.parse
2520 # restore trailing newline for ast.parse
2521 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2521 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2522 except AliasError as e:
2522 except AliasError as e:
2523 error(e)
2523 error(e)
2524 prefilter_failed = True
2524 prefilter_failed = True
2525 except Exception:
2525 except Exception:
2526 # don't allow prefilter errors to crash IPython
2526 # don't allow prefilter errors to crash IPython
2527 self.showtraceback()
2527 self.showtraceback()
2528 prefilter_failed = True
2528 prefilter_failed = True
2529
2529
2530 # Store raw and processed history
2530 # Store raw and processed history
2531 if store_history:
2531 if store_history:
2532 self.history_manager.store_inputs(self.execution_count,
2532 self.history_manager.store_inputs(self.execution_count,
2533 cell, raw_cell)
2533 cell, raw_cell)
2534 if not silent:
2534 if not silent:
2535 self.logger.log(cell, raw_cell)
2535 self.logger.log(cell, raw_cell)
2536
2536
2537 if not prefilter_failed:
2537 if not prefilter_failed:
2538 # don't run if prefilter failed
2538 # don't run if prefilter failed
2539 cell_name = self.compile.cache(cell, self.execution_count)
2539 cell_name = self.compile.cache(cell, self.execution_count)
2540
2540
2541 with self.display_trap:
2541 with self.display_trap:
2542 try:
2542 try:
2543 code_ast = self.compile.ast_parse(cell,
2543 code_ast = self.compile.ast_parse(cell,
2544 filename=cell_name)
2544 filename=cell_name)
2545 except IndentationError:
2545 except IndentationError:
2546 self.showindentationerror()
2546 self.showindentationerror()
2547 if store_history:
2547 if store_history:
2548 self.execution_count += 1
2548 self.execution_count += 1
2549 return None
2549 return None
2550 except (OverflowError, SyntaxError, ValueError, TypeError,
2550 except (OverflowError, SyntaxError, ValueError, TypeError,
2551 MemoryError):
2551 MemoryError):
2552 self.showsyntaxerror()
2552 self.showsyntaxerror()
2553 if store_history:
2553 if store_history:
2554 self.execution_count += 1
2554 self.execution_count += 1
2555 return None
2555 return None
2556
2556
2557 interactivity = "none" if silent else "last_expr"
2557 interactivity = "none" if silent else "last_expr"
2558 self.run_ast_nodes(code_ast.body, cell_name,
2558 self.run_ast_nodes(code_ast.body, cell_name,
2559 interactivity=interactivity)
2559 interactivity=interactivity)
2560
2560
2561 # Execute any registered post-execution functions.
2561 # Execute any registered post-execution functions.
2562 # unless we are silent
2562 # unless we are silent
2563 post_exec = [] if silent else self._post_execute.iteritems()
2563 post_exec = [] if silent else self._post_execute.iteritems()
2564
2564
2565 for func, status in post_exec:
2565 for func, status in post_exec:
2566 if self.disable_failing_post_execute and not status:
2566 if self.disable_failing_post_execute and not status:
2567 continue
2567 continue
2568 try:
2568 try:
2569 func()
2569 func()
2570 except KeyboardInterrupt:
2570 except KeyboardInterrupt:
2571 print >> io.stderr, "\nKeyboardInterrupt"
2571 print >> io.stderr, "\nKeyboardInterrupt"
2572 except Exception:
2572 except Exception:
2573 # register as failing:
2573 # register as failing:
2574 self._post_execute[func] = False
2574 self._post_execute[func] = False
2575 self.showtraceback()
2575 self.showtraceback()
2576 print >> io.stderr, '\n'.join([
2576 print >> io.stderr, '\n'.join([
2577 "post-execution function %r produced an error." % func,
2577 "post-execution function %r produced an error." % func,
2578 "If this problem persists, you can disable failing post-exec functions with:",
2578 "If this problem persists, you can disable failing post-exec functions with:",
2579 "",
2579 "",
2580 " get_ipython().disable_failing_post_execute = True"
2580 " get_ipython().disable_failing_post_execute = True"
2581 ])
2581 ])
2582
2582
2583 if store_history:
2583 if store_history:
2584 # Write output to the database. Does nothing unless
2584 # Write output to the database. Does nothing unless
2585 # history output logging is enabled.
2585 # history output logging is enabled.
2586 self.history_manager.store_output(self.execution_count)
2586 self.history_manager.store_output(self.execution_count)
2587 # Each cell is a *single* input, regardless of how many lines it has
2587 # Each cell is a *single* input, regardless of how many lines it has
2588 self.execution_count += 1
2588 self.execution_count += 1
2589
2589
2590 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2590 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2591 """Run a sequence of AST nodes. The execution mode depends on the
2591 """Run a sequence of AST nodes. The execution mode depends on the
2592 interactivity parameter.
2592 interactivity parameter.
2593
2593
2594 Parameters
2594 Parameters
2595 ----------
2595 ----------
2596 nodelist : list
2596 nodelist : list
2597 A sequence of AST nodes to run.
2597 A sequence of AST nodes to run.
2598 cell_name : str
2598 cell_name : str
2599 Will be passed to the compiler as the filename of the cell. Typically
2599 Will be passed to the compiler as the filename of the cell. Typically
2600 the value returned by ip.compile.cache(cell).
2600 the value returned by ip.compile.cache(cell).
2601 interactivity : str
2601 interactivity : str
2602 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2602 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2603 run interactively (displaying output from expressions). 'last_expr'
2603 run interactively (displaying output from expressions). 'last_expr'
2604 will run the last node interactively only if it is an expression (i.e.
2604 will run the last node interactively only if it is an expression (i.e.
2605 expressions in loops or other blocks are not displayed. Other values
2605 expressions in loops or other blocks are not displayed. Other values
2606 for this parameter will raise a ValueError.
2606 for this parameter will raise a ValueError.
2607 """
2607 """
2608 if not nodelist:
2608 if not nodelist:
2609 return
2609 return
2610
2610
2611 if interactivity == 'last_expr':
2611 if interactivity == 'last_expr':
2612 if isinstance(nodelist[-1], ast.Expr):
2612 if isinstance(nodelist[-1], ast.Expr):
2613 interactivity = "last"
2613 interactivity = "last"
2614 else:
2614 else:
2615 interactivity = "none"
2615 interactivity = "none"
2616
2616
2617 if interactivity == 'none':
2617 if interactivity == 'none':
2618 to_run_exec, to_run_interactive = nodelist, []
2618 to_run_exec, to_run_interactive = nodelist, []
2619 elif interactivity == 'last':
2619 elif interactivity == 'last':
2620 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2620 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2621 elif interactivity == 'all':
2621 elif interactivity == 'all':
2622 to_run_exec, to_run_interactive = [], nodelist
2622 to_run_exec, to_run_interactive = [], nodelist
2623 else:
2623 else:
2624 raise ValueError("Interactivity was %r" % interactivity)
2624 raise ValueError("Interactivity was %r" % interactivity)
2625
2625
2626 exec_count = self.execution_count
2626 exec_count = self.execution_count
2627
2627
2628 try:
2628 try:
2629 for i, node in enumerate(to_run_exec):
2629 for i, node in enumerate(to_run_exec):
2630 mod = ast.Module([node])
2630 mod = ast.Module([node])
2631 code = self.compile(mod, cell_name, "exec")
2631 code = self.compile(mod, cell_name, "exec")
2632 if self.run_code(code):
2632 if self.run_code(code):
2633 return True
2633 return True
2634
2634
2635 for i, node in enumerate(to_run_interactive):
2635 for i, node in enumerate(to_run_interactive):
2636 mod = ast.Interactive([node])
2636 mod = ast.Interactive([node])
2637 code = self.compile(mod, cell_name, "single")
2637 code = self.compile(mod, cell_name, "single")
2638 if self.run_code(code):
2638 if self.run_code(code):
2639 return True
2639 return True
2640
2640
2641 # Flush softspace
2641 # Flush softspace
2642 if softspace(sys.stdout, 0):
2642 if softspace(sys.stdout, 0):
2643 print
2643 print
2644
2644
2645 except:
2645 except:
2646 # It's possible to have exceptions raised here, typically by
2646 # It's possible to have exceptions raised here, typically by
2647 # compilation of odd code (such as a naked 'return' outside a
2647 # compilation of odd code (such as a naked 'return' outside a
2648 # function) that did parse but isn't valid. Typically the exception
2648 # function) that did parse but isn't valid. Typically the exception
2649 # is a SyntaxError, but it's safest just to catch anything and show
2649 # is a SyntaxError, but it's safest just to catch anything and show
2650 # the user a traceback.
2650 # the user a traceback.
2651
2651
2652 # We do only one try/except outside the loop to minimize the impact
2652 # We do only one try/except outside the loop to minimize the impact
2653 # on runtime, and also because if any node in the node list is
2653 # on runtime, and also because if any node in the node list is
2654 # broken, we should stop execution completely.
2654 # broken, we should stop execution completely.
2655 self.showtraceback()
2655 self.showtraceback()
2656
2656
2657 return False
2657 return False
2658
2658
2659 def run_code(self, code_obj):
2659 def run_code(self, code_obj):
2660 """Execute a code object.
2660 """Execute a code object.
2661
2661
2662 When an exception occurs, self.showtraceback() is called to display a
2662 When an exception occurs, self.showtraceback() is called to display a
2663 traceback.
2663 traceback.
2664
2664
2665 Parameters
2665 Parameters
2666 ----------
2666 ----------
2667 code_obj : code object
2667 code_obj : code object
2668 A compiled code object, to be executed
2668 A compiled code object, to be executed
2669
2669
2670 Returns
2670 Returns
2671 -------
2671 -------
2672 False : successful execution.
2672 False : successful execution.
2673 True : an error occurred.
2673 True : an error occurred.
2674 """
2674 """
2675
2675
2676 # Set our own excepthook in case the user code tries to call it
2676 # Set our own excepthook in case the user code tries to call it
2677 # directly, so that the IPython crash handler doesn't get triggered
2677 # directly, so that the IPython crash handler doesn't get triggered
2678 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2678 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2679
2679
2680 # we save the original sys.excepthook in the instance, in case config
2680 # we save the original sys.excepthook in the instance, in case config
2681 # code (such as magics) needs access to it.
2681 # code (such as magics) needs access to it.
2682 self.sys_excepthook = old_excepthook
2682 self.sys_excepthook = old_excepthook
2683 outflag = 1 # happens in more places, so it's easier as default
2683 outflag = 1 # happens in more places, so it's easier as default
2684 try:
2684 try:
2685 try:
2685 try:
2686 self.hooks.pre_run_code_hook()
2686 self.hooks.pre_run_code_hook()
2687 #rprint('Running code', repr(code_obj)) # dbg
2687 #rprint('Running code', repr(code_obj)) # dbg
2688 exec code_obj in self.user_global_ns, self.user_ns
2688 exec code_obj in self.user_global_ns, self.user_ns
2689 finally:
2689 finally:
2690 # Reset our crash handler in place
2690 # Reset our crash handler in place
2691 sys.excepthook = old_excepthook
2691 sys.excepthook = old_excepthook
2692 except SystemExit:
2692 except SystemExit:
2693 self.showtraceback(exception_only=True)
2693 self.showtraceback(exception_only=True)
2694 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2694 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2695 except self.custom_exceptions:
2695 except self.custom_exceptions:
2696 etype,value,tb = sys.exc_info()
2696 etype,value,tb = sys.exc_info()
2697 self.CustomTB(etype,value,tb)
2697 self.CustomTB(etype,value,tb)
2698 except:
2698 except:
2699 self.showtraceback()
2699 self.showtraceback()
2700 else:
2700 else:
2701 outflag = 0
2701 outflag = 0
2702 return outflag
2702 return outflag
2703
2703
2704 # For backwards compatibility
2704 # For backwards compatibility
2705 runcode = run_code
2705 runcode = run_code
2706
2706
2707 #-------------------------------------------------------------------------
2707 #-------------------------------------------------------------------------
2708 # Things related to GUI support and pylab
2708 # Things related to GUI support and pylab
2709 #-------------------------------------------------------------------------
2709 #-------------------------------------------------------------------------
2710
2710
2711 def enable_gui(self, gui=None):
2711 def enable_gui(self, gui=None):
2712 raise NotImplementedError('Implement enable_gui in a subclass')
2712 raise NotImplementedError('Implement enable_gui in a subclass')
2713
2713
2714 def enable_pylab(self, gui=None, import_all=True):
2714 def enable_pylab(self, gui=None, import_all=True):
2715 """Activate pylab support at runtime.
2715 """Activate pylab support at runtime.
2716
2716
2717 This turns on support for matplotlib, preloads into the interactive
2717 This turns on support for matplotlib, preloads into the interactive
2718 namespace all of numpy and pylab, and configures IPython to correctly
2718 namespace all of numpy and pylab, and configures IPython to correctly
2719 interact with the GUI event loop. The GUI backend to be used can be
2719 interact with the GUI event loop. The GUI backend to be used can be
2720 optionally selected with the optional :param:`gui` argument.
2720 optionally selected with the optional :param:`gui` argument.
2721
2721
2722 Parameters
2722 Parameters
2723 ----------
2723 ----------
2724 gui : optional, string
2724 gui : optional, string
2725
2725
2726 If given, dictates the choice of matplotlib GUI backend to use
2726 If given, dictates the choice of matplotlib GUI backend to use
2727 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2727 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2728 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2728 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2729 matplotlib (as dictated by the matplotlib build-time options plus the
2729 matplotlib (as dictated by the matplotlib build-time options plus the
2730 user's matplotlibrc configuration file). Note that not all backends
2730 user's matplotlibrc configuration file). Note that not all backends
2731 make sense in all contexts, for example a terminal ipython can't
2731 make sense in all contexts, for example a terminal ipython can't
2732 display figures inline.
2732 display figures inline.
2733 """
2733 """
2734 from IPython.core.pylabtools import mpl_runner
2734 from IPython.core.pylabtools import mpl_runner
2735 # We want to prevent the loading of pylab to pollute the user's
2735 # We want to prevent the loading of pylab to pollute the user's
2736 # namespace as shown by the %who* magics, so we execute the activation
2736 # namespace as shown by the %who* magics, so we execute the activation
2737 # code in an empty namespace, and we update *both* user_ns and
2737 # code in an empty namespace, and we update *both* user_ns and
2738 # user_ns_hidden with this information.
2738 # user_ns_hidden with this information.
2739 ns = {}
2739 ns = {}
2740 try:
2740 try:
2741 gui = pylab_activate(ns, gui, import_all, self)
2741 gui = pylab_activate(ns, gui, import_all, self)
2742 except KeyError:
2742 except KeyError:
2743 error("Backend %r not supported" % gui)
2743 error("Backend %r not supported" % gui)
2744 return
2744 return
2745 self.user_ns.update(ns)
2745 self.user_ns.update(ns)
2746 self.user_ns_hidden.update(ns)
2746 self.user_ns_hidden.update(ns)
2747 # Now we must activate the gui pylab wants to use, and fix %run to take
2747 # Now we must activate the gui pylab wants to use, and fix %run to take
2748 # plot updates into account
2748 # plot updates into account
2749 self.enable_gui(gui)
2749 self.enable_gui(gui)
2750 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2750 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2751 mpl_runner(self.safe_execfile)
2751 mpl_runner(self.safe_execfile)
2752
2752
2753 #-------------------------------------------------------------------------
2753 #-------------------------------------------------------------------------
2754 # Utilities
2754 # Utilities
2755 #-------------------------------------------------------------------------
2755 #-------------------------------------------------------------------------
2756
2756
2757 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2757 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2758 """Expand python variables in a string.
2758 """Expand python variables in a string.
2759
2759
2760 The depth argument indicates how many frames above the caller should
2760 The depth argument indicates how many frames above the caller should
2761 be walked to look for the local namespace where to expand variables.
2761 be walked to look for the local namespace where to expand variables.
2762
2762
2763 The global namespace for expansion is always the user's interactive
2763 The global namespace for expansion is always the user's interactive
2764 namespace.
2764 namespace.
2765 """
2765 """
2766 ns = self.user_ns.copy()
2766 ns = self.user_ns.copy()
2767 ns.update(sys._getframe(depth+1).f_locals)
2767 ns.update(sys._getframe(depth+1).f_locals)
2768 ns.pop('self', None)
2768 ns.pop('self', None)
2769 try:
2769 try:
2770 cmd = formatter.format(cmd, **ns)
2770 cmd = formatter.format(cmd, **ns)
2771 except Exception:
2771 except Exception:
2772 # if formatter couldn't format, just let it go untransformed
2772 # if formatter couldn't format, just let it go untransformed
2773 pass
2773 pass
2774 return cmd
2774 return cmd
2775
2775
2776 def mktempfile(self, data=None, prefix='ipython_edit_'):
2776 def mktempfile(self, data=None, prefix='ipython_edit_'):
2777 """Make a new tempfile and return its filename.
2777 """Make a new tempfile and return its filename.
2778
2778
2779 This makes a call to tempfile.mktemp, but it registers the created
2779 This makes a call to tempfile.mktemp, but it registers the created
2780 filename internally so ipython cleans it up at exit time.
2780 filename internally so ipython cleans it up at exit time.
2781
2781
2782 Optional inputs:
2782 Optional inputs:
2783
2783
2784 - data(None): if data is given, it gets written out to the temp file
2784 - data(None): if data is given, it gets written out to the temp file
2785 immediately, and the file is closed again."""
2785 immediately, and the file is closed again."""
2786
2786
2787 filename = tempfile.mktemp('.py', prefix)
2787 filename = tempfile.mktemp('.py', prefix)
2788 self.tempfiles.append(filename)
2788 self.tempfiles.append(filename)
2789
2789
2790 if data:
2790 if data:
2791 tmp_file = open(filename,'w')
2791 tmp_file = open(filename,'w')
2792 tmp_file.write(data)
2792 tmp_file.write(data)
2793 tmp_file.close()
2793 tmp_file.close()
2794 return filename
2794 return filename
2795
2795
2796 # TODO: This should be removed when Term is refactored.
2796 # TODO: This should be removed when Term is refactored.
2797 def write(self,data):
2797 def write(self,data):
2798 """Write a string to the default output"""
2798 """Write a string to the default output"""
2799 io.stdout.write(data)
2799 io.stdout.write(data)
2800
2800
2801 # TODO: This should be removed when Term is refactored.
2801 # TODO: This should be removed when Term is refactored.
2802 def write_err(self,data):
2802 def write_err(self,data):
2803 """Write a string to the default error output"""
2803 """Write a string to the default error output"""
2804 io.stderr.write(data)
2804 io.stderr.write(data)
2805
2805
2806 def ask_yes_no(self, prompt, default=None):
2806 def ask_yes_no(self, prompt, default=None):
2807 if self.quiet:
2807 if self.quiet:
2808 return True
2808 return True
2809 return ask_yes_no(prompt,default)
2809 return ask_yes_no(prompt,default)
2810
2810
2811 def show_usage(self):
2811 def show_usage(self):
2812 """Show a usage message"""
2812 """Show a usage message"""
2813 page.page(IPython.core.usage.interactive_usage)
2813 page.page(IPython.core.usage.interactive_usage)
2814
2814
2815 def extract_input_lines(self, range_str, raw=False):
2815 def extract_input_lines(self, range_str, raw=False):
2816 """Return as a string a set of input history slices.
2816 """Return as a string a set of input history slices.
2817
2817
2818 Parameters
2818 Parameters
2819 ----------
2819 ----------
2820 range_str : string
2820 range_str : string
2821 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
2821 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
2822 since this function is for use by magic functions which get their
2822 since this function is for use by magic functions which get their
2823 arguments as strings. The number before the / is the session
2823 arguments as strings. The number before the / is the session
2824 number: ~n goes n back from the current session.
2824 number: ~n goes n back from the current session.
2825
2825
2826 Optional Parameters:
2826 Optional Parameters:
2827 - raw(False): by default, the processed input is used. If this is
2827 - raw(False): by default, the processed input is used. If this is
2828 true, the raw input history is used instead.
2828 true, the raw input history is used instead.
2829
2829
2830 Note that slices can be called with two notations:
2830 Note that slices can be called with two notations:
2831
2831
2832 N:M -> standard python form, means including items N...(M-1).
2832 N:M -> standard python form, means including items N...(M-1).
2833
2833
2834 N-M -> include items N..M (closed endpoint)."""
2834 N-M -> include items N..M (closed endpoint)."""
2835 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
2835 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
2836 return "\n".join(x for _, _, x in lines)
2836 return "\n".join(x for _, _, x in lines)
2837
2837
2838 def find_user_code(self, target, raw=True, py_only=False):
2838 def find_user_code(self, target, raw=True, py_only=False):
2839 """Get a code string from history, file, url, or a string or macro.
2839 """Get a code string from history, file, url, or a string or macro.
2840
2840
2841 This is mainly used by magic functions.
2841 This is mainly used by magic functions.
2842
2842
2843 Parameters
2843 Parameters
2844 ----------
2844 ----------
2845
2845
2846 target : str
2846 target : str
2847
2847
2848 A string specifying code to retrieve. This will be tried respectively
2848 A string specifying code to retrieve. This will be tried respectively
2849 as: ranges of input history (see %history for syntax), url,
2849 as: ranges of input history (see %history for syntax), url,
2850 correspnding .py file, filename, or an expression evaluating to a
2850 correspnding .py file, filename, or an expression evaluating to a
2851 string or Macro in the user namespace.
2851 string or Macro in the user namespace.
2852
2852
2853 raw : bool
2853 raw : bool
2854 If true (default), retrieve raw history. Has no effect on the other
2854 If true (default), retrieve raw history. Has no effect on the other
2855 retrieval mechanisms.
2855 retrieval mechanisms.
2856
2856
2857 py_only : bool (default False)
2857 py_only : bool (default False)
2858 Only try to fetch python code, do not try alternative methods to decode file
2858 Only try to fetch python code, do not try alternative methods to decode file
2859 if unicode fails.
2859 if unicode fails.
2860
2860
2861 Returns
2861 Returns
2862 -------
2862 -------
2863 A string of code.
2863 A string of code.
2864
2864
2865 ValueError is raised if nothing is found, and TypeError if it evaluates
2865 ValueError is raised if nothing is found, and TypeError if it evaluates
2866 to an object of another type. In each case, .args[0] is a printable
2866 to an object of another type. In each case, .args[0] is a printable
2867 message.
2867 message.
2868 """
2868 """
2869 code = self.extract_input_lines(target, raw=raw) # Grab history
2869 code = self.extract_input_lines(target, raw=raw) # Grab history
2870 if code:
2870 if code:
2871 return code
2871 return code
2872 utarget = unquote_filename(target)
2872 utarget = unquote_filename(target)
2873 try:
2873 try:
2874 if utarget.startswith(('http://', 'https://')):
2874 if utarget.startswith(('http://', 'https://')):
2875 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2875 return openpy.read_py_url(utarget, skip_encoding_cookie=True)
2876 except UnicodeDecodeError:
2876 except UnicodeDecodeError:
2877 if not py_only :
2877 if not py_only :
2878 response = urllib.urlopen(target)
2878 response = urllib.urlopen(target)
2879 return response.read().decode('latin1')
2879 return response.read().decode('latin1')
2880 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2880 raise ValueError(("'%s' seem to be unreadable.") % utarget)
2881
2881
2882 potential_target = [target]
2882 potential_target = [target]
2883 try :
2883 try :
2884 potential_target.insert(0,get_py_filename(target))
2884 potential_target.insert(0,get_py_filename(target))
2885 except IOError:
2885 except IOError:
2886 pass
2886 pass
2887
2887
2888 for tgt in potential_target :
2888 for tgt in potential_target :
2889 if os.path.isfile(tgt): # Read file
2889 if os.path.isfile(tgt): # Read file
2890 try :
2890 try :
2891 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2891 return openpy.read_py_file(tgt, skip_encoding_cookie=True)
2892 except UnicodeDecodeError :
2892 except UnicodeDecodeError :
2893 if not py_only :
2893 if not py_only :
2894 with io_open(tgt,'r', encoding='latin1') as f :
2894 with io_open(tgt,'r', encoding='latin1') as f :
2895 return f.read()
2895 return f.read()
2896 raise ValueError(("'%s' seem to be unreadable.") % target)
2896 raise ValueError(("'%s' seem to be unreadable.") % target)
2897
2897
2898 try: # User namespace
2898 try: # User namespace
2899 codeobj = eval(target, self.user_ns)
2899 codeobj = eval(target, self.user_ns)
2900 except Exception:
2900 except Exception:
2901 raise ValueError(("'%s' was not found in history, as a file, url, "
2901 raise ValueError(("'%s' was not found in history, as a file, url, "
2902 "nor in the user namespace.") % target)
2902 "nor in the user namespace.") % target)
2903 if isinstance(codeobj, basestring):
2903 if isinstance(codeobj, basestring):
2904 return codeobj
2904 return codeobj
2905 elif isinstance(codeobj, Macro):
2905 elif isinstance(codeobj, Macro):
2906 return codeobj.value
2906 return codeobj.value
2907
2907
2908 raise TypeError("%s is neither a string nor a macro." % target,
2908 raise TypeError("%s is neither a string nor a macro." % target,
2909 codeobj)
2909 codeobj)
2910
2910
2911 #-------------------------------------------------------------------------
2911 #-------------------------------------------------------------------------
2912 # Things related to IPython exiting
2912 # Things related to IPython exiting
2913 #-------------------------------------------------------------------------
2913 #-------------------------------------------------------------------------
2914 def atexit_operations(self):
2914 def atexit_operations(self):
2915 """This will be executed at the time of exit.
2915 """This will be executed at the time of exit.
2916
2916
2917 Cleanup operations and saving of persistent data that is done
2917 Cleanup operations and saving of persistent data that is done
2918 unconditionally by IPython should be performed here.
2918 unconditionally by IPython should be performed here.
2919
2919
2920 For things that may depend on startup flags or platform specifics (such
2920 For things that may depend on startup flags or platform specifics (such
2921 as having readline or not), register a separate atexit function in the
2921 as having readline or not), register a separate atexit function in the
2922 code that has the appropriate information, rather than trying to
2922 code that has the appropriate information, rather than trying to
2923 clutter
2923 clutter
2924 """
2924 """
2925 # Close the history session (this stores the end time and line count)
2925 # Close the history session (this stores the end time and line count)
2926 # this must be *before* the tempfile cleanup, in case of temporary
2926 # this must be *before* the tempfile cleanup, in case of temporary
2927 # history db
2927 # history db
2928 self.history_manager.end_session()
2928 self.history_manager.end_session()
2929
2929
2930 # Cleanup all tempfiles left around
2930 # Cleanup all tempfiles left around
2931 for tfile in self.tempfiles:
2931 for tfile in self.tempfiles:
2932 try:
2932 try:
2933 os.unlink(tfile)
2933 os.unlink(tfile)
2934 except OSError:
2934 except OSError:
2935 pass
2935 pass
2936
2936
2937 # Clear all user namespaces to release all references cleanly.
2937 # Clear all user namespaces to release all references cleanly.
2938 self.reset(new_session=False)
2938 self.reset(new_session=False)
2939
2939
2940 # Run user hooks
2940 # Run user hooks
2941 self.hooks.shutdown_hook()
2941 self.hooks.shutdown_hook()
2942
2942
2943 def cleanup(self):
2943 def cleanup(self):
2944 self.restore_sys_module_state()
2944 self.restore_sys_module_state()
2945
2945
2946
2946
2947 class InteractiveShellABC(object):
2947 class InteractiveShellABC(object):
2948 """An abstract base class for InteractiveShell."""
2948 """An abstract base class for InteractiveShell."""
2949 __metaclass__ = abc.ABCMeta
2949 __metaclass__ = abc.ABCMeta
2950
2950
2951 InteractiveShellABC.register(InteractiveShell)
2951 InteractiveShellABC.register(InteractiveShell)
@@ -1,3236 +1,2797 b''
1 """Magic functions for InteractiveShell.
1 """Magic functions for InteractiveShell.
2 """
2 """
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
6 # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu>
6 # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu>
7 # Copyright (C) 2008 The IPython Development Team
7 # Copyright (C) 2008 The IPython Development Team
8
8
9 # Distributed under the terms of the BSD License. The full license is in
9 # Distributed under the terms of the BSD License. The full license is in
10 # the file COPYING, distributed as part of this software.
10 # the file COPYING, distributed as part of this software.
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13 # Imports
13 # Imports
14 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
15
15 # Stdlib
16 import __builtin__ as builtin_mod
16 import __builtin__ as builtin_mod
17 import bdb
17 import bdb
18 import gc
18 import gc
19 import inspect
19 import inspect
20 import io
20 import io
21 import json
21 import json
22 import os
22 import os
23 import re
23 import re
24 import sys
24 import sys
25 import time
25 import time
26 from StringIO import StringIO
26 from StringIO import StringIO
27 from pprint import pformat
27 from pprint import pformat
28 from urllib2 import urlopen
28 from urllib2 import urlopen
29
29
30 # cProfile was added in Python2.5
30 # cProfile was added in Python2.5
31 try:
31 try:
32 import cProfile as profile
32 import cProfile as profile
33 import pstats
33 import pstats
34 except ImportError:
34 except ImportError:
35 # profile isn't bundled by default in Debian for license reasons
35 # profile isn't bundled by default in Debian for license reasons
36 try:
36 try:
37 import profile, pstats
37 import profile, pstats
38 except ImportError:
38 except ImportError:
39 profile = pstats = None
39 profile = pstats = None
40
40
41 # Our own packages
41 from IPython.config.application import Application
42 from IPython.config.application import Application
42 from IPython.core import debugger, oinspect
43 from IPython.core import debugger, oinspect
43 from IPython.core import page
44 from IPython.core import page
44 from IPython.core.error import UsageError, StdinNotImplementedError, TryNext
45 from IPython.core.error import UsageError, StdinNotImplementedError, TryNext
45 from IPython.core.macro import Macro
46 from IPython.core.macro import Macro
46 from IPython.core.magic import (Bunch, Magics, compress_dhist,
47 from IPython.core.magic import (Bunch, Magics, compress_dhist,
47 on_off, needs_local_scope,
48 on_off, needs_local_scope,
48 register_magics, line_magic, cell_magic)
49 register_magics, line_magic, cell_magic)
49 from IPython.testing.skipdoctest import skip_doctest
50 from IPython.testing.skipdoctest import skip_doctest
50 from IPython.utils import openpy
51 from IPython.utils import openpy
51 from IPython.utils import py3compat
52 from IPython.utils import py3compat
52 from IPython.utils.encoding import DEFAULT_ENCODING
53 from IPython.utils.encoding import DEFAULT_ENCODING
53 from IPython.utils.io import file_read, nlprint
54 from IPython.utils.io import file_read, nlprint
54 from IPython.utils.ipstruct import Struct
55 from IPython.utils.ipstruct import Struct
55 from IPython.utils.module_paths import find_mod
56 from IPython.utils.module_paths import find_mod
56 from IPython.utils.path import get_py_filename, unquote_filename
57 from IPython.utils.path import get_py_filename, unquote_filename
57 from IPython.utils.process import abbrev_cwd
58 from IPython.utils.process import abbrev_cwd
58 from IPython.utils.terminal import set_term_title
59 from IPython.utils.terminal import set_term_title
59 from IPython.utils.timing import clock, clock2
60 from IPython.utils.timing import clock, clock2
60 from IPython.utils.warn import warn, error
61 from IPython.utils.warn import warn, error
61
62
62
63 #-----------------------------------------------------------------------------
63 # Used for exception handling in magic_edit
64 # Magic implementation classes
64 class MacroToEdit(ValueError): pass
65 #-----------------------------------------------------------------------------
65
66
67 @register_magics
68 class CodeMagics(Magics):
69 """Magics related to code management (loading, saving, editing, ...)."""
70
71 @line_magic
72 def save(self, parameter_s=''):
73 """Save a set of lines or a macro to a given filename.
74
75 Usage:\\
76 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
77
78 Options:
79
80 -r: use 'raw' input. By default, the 'processed' history is used,
81 so that magics are loaded in their transformed version to valid
82 Python. If this option is given, the raw input as typed as the
83 command line is used instead.
84
85 This function uses the same syntax as %history for input ranges,
86 then saves the lines to the filename you specify.
87
88 It adds a '.py' extension to the file if you don't do so yourself, and
89 it asks for confirmation before overwriting existing files."""
90
91 opts,args = self.parse_options(parameter_s,'r',mode='list')
92 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
93 if not fname.endswith('.py'):
94 fname += '.py'
95 if os.path.isfile(fname):
96 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
97 if ans.lower() not in ['y','yes']:
98 print 'Operation cancelled.'
99 return
100 try:
101 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
102 except (TypeError, ValueError) as e:
103 print e.args[0]
104 return
105 with io.open(fname,'w', encoding="utf-8") as f:
106 f.write(u"# coding: utf-8\n")
107 f.write(py3compat.cast_unicode(cmds))
108 print 'The following commands were written to file `%s`:' % fname
109 print cmds
110
111 @line_magic
112 def pastebin(self, parameter_s=''):
113 """Upload code to Github's Gist paste bin, returning the URL.
114
115 Usage:\\
116 %pastebin [-d "Custom description"] 1-7
117
118 The argument can be an input history range, a filename, or the name of a
119 string or macro.
120
121 Options:
122
123 -d: Pass a custom description for the gist. The default will say
124 "Pasted from IPython".
125 """
126 opts, args = self.parse_options(parameter_s, 'd:')
127
128 try:
129 code = self.shell.find_user_code(args)
130 except (ValueError, TypeError) as e:
131 print e.args[0]
132 return
133
134 post_data = json.dumps({
135 "description": opts.get('d', "Pasted from IPython"),
136 "public": True,
137 "files": {
138 "file1.py": {
139 "content": code
140 }
141 }
142 }).encode('utf-8')
143
144 response = urlopen("https://api.github.com/gists", post_data)
145 response_data = json.loads(response.read().decode('utf-8'))
146 return response_data['html_url']
147
148 @line_magic
149 def loadpy(self, arg_s):
150 """Load a .py python script into the GUI console.
151
152 This magic command can either take a local filename or a url::
153
154 %loadpy myscript.py
155 %loadpy http://www.example.com/myscript.py
156 """
157 arg_s = unquote_filename(arg_s)
158 remote_url = arg_s.startswith(('http://', 'https://'))
159 local_url = not remote_url
160 if local_url and not arg_s.endswith('.py'):
161 # Local files must be .py; for remote URLs it's possible that the
162 # fetch URL doesn't have a .py in it (many servers have an opaque
163 # URL, such as scipy-central.org).
164 raise ValueError('%%loadpy only works with .py files: %s' % arg_s)
165
166 # openpy takes care of finding the source encoding (per PEP 263)
167 if remote_url:
168 contents = openpy.read_py_url(arg_s, skip_encoding_cookie=True)
169 else:
170 contents = openpy.read_py_file(arg_s, skip_encoding_cookie=True)
171
172 self.shell.set_next_input(contents)
173
174 def _find_edit_target(self, args, opts, last_call):
175 """Utility method used by magic_edit to find what to edit."""
176
177 def make_filename(arg):
178 "Make a filename from the given args"
179 arg = unquote_filename(arg)
180 try:
181 filename = get_py_filename(arg)
182 except IOError:
183 # If it ends with .py but doesn't already exist, assume we want
184 # a new file.
185 if arg.endswith('.py'):
186 filename = arg
187 else:
188 filename = None
189 return filename
190
191 # Set a few locals from the options for convenience:
192 opts_prev = 'p' in opts
193 opts_raw = 'r' in opts
194
195 # custom exceptions
196 class DataIsObject(Exception): pass
197
198 # Default line number value
199 lineno = opts.get('n',None)
200
201 if opts_prev:
202 args = '_%s' % last_call[0]
203 if not self.shell.user_ns.has_key(args):
204 args = last_call[1]
205
206 # use last_call to remember the state of the previous call, but don't
207 # let it be clobbered by successive '-p' calls.
208 try:
209 last_call[0] = self.shell.displayhook.prompt_count
210 if not opts_prev:
211 last_call[1] = args
212 except:
213 pass
214
215 # by default this is done with temp files, except when the given
216 # arg is a filename
217 use_temp = True
218
219 data = ''
220
221 # First, see if the arguments should be a filename.
222 filename = make_filename(args)
223 if filename:
224 use_temp = False
225 elif args:
226 # Mode where user specifies ranges of lines, like in %macro.
227 data = self.shell.extract_input_lines(args, opts_raw)
228 if not data:
229 try:
230 # Load the parameter given as a variable. If not a string,
231 # process it as an object instead (below)
232
233 #print '*** args',args,'type',type(args) # dbg
234 data = eval(args, self.shell.user_ns)
235 if not isinstance(data, basestring):
236 raise DataIsObject
237
238 except (NameError,SyntaxError):
239 # given argument is not a variable, try as a filename
240 filename = make_filename(args)
241 if filename is None:
242 warn("Argument given (%s) can't be found as a variable "
243 "or as a filename." % args)
244 return
245 use_temp = False
246
247 except DataIsObject:
248 # macros have a special edit function
249 if isinstance(data, Macro):
250 raise MacroToEdit(data)
251
252 # For objects, try to edit the file where they are defined
253 try:
254 filename = inspect.getabsfile(data)
255 if 'fakemodule' in filename.lower() and \
256 inspect.isclass(data):
257 # class created by %edit? Try to find source
258 # by looking for method definitions instead, the
259 # __module__ in those classes is FakeModule.
260 attrs = [getattr(data, aname) for aname in dir(data)]
261 for attr in attrs:
262 if not inspect.ismethod(attr):
263 continue
264 filename = inspect.getabsfile(attr)
265 if filename and \
266 'fakemodule' not in filename.lower():
267 # change the attribute to be the edit
268 # target instead
269 data = attr
270 break
271
272 datafile = 1
273 except TypeError:
274 filename = make_filename(args)
275 datafile = 1
276 warn('Could not find file where `%s` is defined.\n'
277 'Opening a file named `%s`' % (args,filename))
278 # Now, make sure we can actually read the source (if it was
279 # in a temp file it's gone by now).
280 if datafile:
281 try:
282 if lineno is None:
283 lineno = inspect.getsourcelines(data)[1]
284 except IOError:
285 filename = make_filename(args)
286 if filename is None:
287 warn('The file `%s` where `%s` was defined cannot '
288 'be read.' % (filename,data))
289 return
290 use_temp = False
291
292 if use_temp:
293 filename = self.shell.mktempfile(data)
294 print 'IPython will make a temporary file named:',filename
295
296 return filename, lineno, use_temp
297
298 def _edit_macro(self,mname,macro):
299 """open an editor with the macro data in a file"""
300 filename = self.shell.mktempfile(macro.value)
301 self.shell.hooks.editor(filename)
302
303 # and make a new macro object, to replace the old one
304 mfile = open(filename)
305 mvalue = mfile.read()
306 mfile.close()
307 self.shell.user_ns[mname] = Macro(mvalue)
308
309 @line_magic
310 def ed(self, parameter_s=''):
311 """Alias to %edit."""
312 return self.edit(parameter_s)
313
314 @skip_doctest
315 @line_magic
316 def edit(self, parameter_s='',last_call=['','']):
317 """Bring up an editor and execute the resulting code.
318
319 Usage:
320 %edit [options] [args]
321
322 %edit runs IPython's editor hook. The default version of this hook is
323 set to call the editor specified by your $EDITOR environment variable.
324 If this isn't found, it will default to vi under Linux/Unix and to
325 notepad under Windows. See the end of this docstring for how to change
326 the editor hook.
327
328 You can also set the value of this editor via the
329 ``TerminalInteractiveShell.editor`` option in your configuration file.
330 This is useful if you wish to use a different editor from your typical
331 default with IPython (and for Windows users who typically don't set
332 environment variables).
333
334 This command allows you to conveniently edit multi-line code right in
335 your IPython session.
336
337 If called without arguments, %edit opens up an empty editor with a
338 temporary file and will execute the contents of this file when you
339 close it (don't forget to save it!).
340
341
342 Options:
343
344 -n <number>: open the editor at a specified line number. By default,
345 the IPython editor hook uses the unix syntax 'editor +N filename', but
346 you can configure this by providing your own modified hook if your
347 favorite editor supports line-number specifications with a different
348 syntax.
349
350 -p: this will call the editor with the same data as the previous time
351 it was used, regardless of how long ago (in your current session) it
352 was.
353
354 -r: use 'raw' input. This option only applies to input taken from the
355 user's history. By default, the 'processed' history is used, so that
356 magics are loaded in their transformed version to valid Python. If
357 this option is given, the raw input as typed as the command line is
358 used instead. When you exit the editor, it will be executed by
359 IPython's own processor.
360
361 -x: do not execute the edited code immediately upon exit. This is
362 mainly useful if you are editing programs which need to be called with
363 command line arguments, which you can then do using %run.
364
365
366 Arguments:
367
368 If arguments are given, the following possibilities exist:
369
370 - If the argument is a filename, IPython will load that into the
371 editor. It will execute its contents with execfile() when you exit,
372 loading any code in the file into your interactive namespace.
373
374 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
375 The syntax is the same as in the %history magic.
376
377 - If the argument is a string variable, its contents are loaded
378 into the editor. You can thus edit any string which contains
379 python code (including the result of previous edits).
380
381 - If the argument is the name of an object (other than a string),
382 IPython will try to locate the file where it was defined and open the
383 editor at the point where it is defined. You can use `%edit function`
384 to load an editor exactly at the point where 'function' is defined,
385 edit it and have the file be executed automatically.
386
387 - If the object is a macro (see %macro for details), this opens up your
388 specified editor with a temporary file containing the macro's data.
389 Upon exit, the macro is reloaded with the contents of the file.
390
391 Note: opening at an exact line is only supported under Unix, and some
392 editors (like kedit and gedit up to Gnome 2.8) do not understand the
393 '+NUMBER' parameter necessary for this feature. Good editors like
394 (X)Emacs, vi, jed, pico and joe all do.
395
396 After executing your code, %edit will return as output the code you
397 typed in the editor (except when it was an existing file). This way
398 you can reload the code in further invocations of %edit as a variable,
399 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
400 the output.
401
402 Note that %edit is also available through the alias %ed.
403
404 This is an example of creating a simple function inside the editor and
405 then modifying it. First, start up the editor::
406
407 In [1]: ed
408 Editing... done. Executing edited code...
409 Out[1]: 'def foo():\\n print "foo() was defined in an editing
410 session"\\n'
411
412 We can then call the function foo()::
413
414 In [2]: foo()
415 foo() was defined in an editing session
416
417 Now we edit foo. IPython automatically loads the editor with the
418 (temporary) file where foo() was previously defined::
419
420 In [3]: ed foo
421 Editing... done. Executing edited code...
422
423 And if we call foo() again we get the modified version::
424
425 In [4]: foo()
426 foo() has now been changed!
427
428 Here is an example of how to edit a code snippet successive
429 times. First we call the editor::
430
431 In [5]: ed
432 Editing... done. Executing edited code...
433 hello
434 Out[5]: "print 'hello'\\n"
435
436 Now we call it again with the previous output (stored in _)::
437
438 In [6]: ed _
439 Editing... done. Executing edited code...
440 hello world
441 Out[6]: "print 'hello world'\\n"
442
443 Now we call it with the output #8 (stored in _8, also as Out[8])::
444
445 In [7]: ed _8
446 Editing... done. Executing edited code...
447 hello again
448 Out[7]: "print 'hello again'\\n"
449
450
451 Changing the default editor hook:
452
453 If you wish to write your own editor hook, you can put it in a
454 configuration file which you load at startup time. The default hook
455 is defined in the IPython.core.hooks module, and you can use that as a
456 starting example for further modifications. That file also has
457 general instructions on how to set a new hook for use once you've
458 defined it."""
459 opts,args = self.parse_options(parameter_s,'prxn:')
460
461 try:
462 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
463 except MacroToEdit as e:
464 self._edit_macro(args, e.args[0])
465 return
466
467 # do actual editing here
468 print 'Editing...',
469 sys.stdout.flush()
470 try:
471 # Quote filenames that may have spaces in them
472 if ' ' in filename:
473 filename = "'%s'" % filename
474 self.shell.hooks.editor(filename,lineno)
475 except TryNext:
476 warn('Could not open editor')
477 return
478
479 # XXX TODO: should this be generalized for all string vars?
480 # For now, this is special-cased to blocks created by cpaste
481 if args.strip() == 'pasted_block':
482 self.shell.user_ns['pasted_block'] = file_read(filename)
483
484 if 'x' in opts: # -x prevents actual execution
485 print
486 else:
487 print 'done. Executing edited code...'
488 if 'r' in opts: # Untranslated IPython code
489 self.shell.run_cell(file_read(filename),
490 store_history=False)
491 else:
492 self.shell.safe_execfile(filename, self.shell.user_ns,
493 self.shell.user_ns)
494
495 if is_temp:
496 try:
497 return open(filename).read()
498 except IOError,msg:
499 if msg.filename == filename:
500 warn('File not found. Did you forget to save?')
501 return
502 else:
503 self.shell.showtraceback()
504
505
66
506 @register_magics
67 @register_magics
507 class ConfigMagics(Magics):
68 class ConfigMagics(Magics):
508
69
509 def __init__(self, shell):
70 def __init__(self, shell):
510 super(ConfigMagics, self).__init__(shell)
71 super(ConfigMagics, self).__init__(shell)
511 self.configurables = []
72 self.configurables = []
512
73
513 @line_magic
74 @line_magic
514 def config(self, s):
75 def config(self, s):
515 """configure IPython
76 """configure IPython
516
77
517 %config Class[.trait=value]
78 %config Class[.trait=value]
518
79
519 This magic exposes most of the IPython config system. Any
80 This magic exposes most of the IPython config system. Any
520 Configurable class should be able to be configured with the simple
81 Configurable class should be able to be configured with the simple
521 line::
82 line::
522
83
523 %config Class.trait=value
84 %config Class.trait=value
524
85
525 Where `value` will be resolved in the user's namespace, if it is an
86 Where `value` will be resolved in the user's namespace, if it is an
526 expression or variable name.
87 expression or variable name.
527
88
528 Examples
89 Examples
529 --------
90 --------
530
91
531 To see what classes are available for config, pass no arguments::
92 To see what classes are available for config, pass no arguments::
532
93
533 In [1]: %config
94 In [1]: %config
534 Available objects for config:
95 Available objects for config:
535 TerminalInteractiveShell
96 TerminalInteractiveShell
536 HistoryManager
97 HistoryManager
537 PrefilterManager
98 PrefilterManager
538 AliasManager
99 AliasManager
539 IPCompleter
100 IPCompleter
540 PromptManager
101 PromptManager
541 DisplayFormatter
102 DisplayFormatter
542
103
543 To view what is configurable on a given class, just pass the class
104 To view what is configurable on a given class, just pass the class
544 name::
105 name::
545
106
546 In [2]: %config IPCompleter
107 In [2]: %config IPCompleter
547 IPCompleter options
108 IPCompleter options
548 -----------------
109 -----------------
549 IPCompleter.omit__names=<Enum>
110 IPCompleter.omit__names=<Enum>
550 Current: 2
111 Current: 2
551 Choices: (0, 1, 2)
112 Choices: (0, 1, 2)
552 Instruct the completer to omit private method names
113 Instruct the completer to omit private method names
553 Specifically, when completing on ``object.<tab>``.
114 Specifically, when completing on ``object.<tab>``.
554 When 2 [default]: all names that start with '_' will be excluded.
115 When 2 [default]: all names that start with '_' will be excluded.
555 When 1: all 'magic' names (``__foo__``) will be excluded.
116 When 1: all 'magic' names (``__foo__``) will be excluded.
556 When 0: nothing will be excluded.
117 When 0: nothing will be excluded.
557 IPCompleter.merge_completions=<CBool>
118 IPCompleter.merge_completions=<CBool>
558 Current: True
119 Current: True
559 Whether to merge completion results into a single list
120 Whether to merge completion results into a single list
560 If False, only the completion results from the first non-empty
121 If False, only the completion results from the first non-empty
561 completer will be returned.
122 completer will be returned.
562 IPCompleter.limit_to__all__=<CBool>
123 IPCompleter.limit_to__all__=<CBool>
563 Current: False
124 Current: False
564 Instruct the completer to use __all__ for the completion
125 Instruct the completer to use __all__ for the completion
565 Specifically, when completing on ``object.<tab>``.
126 Specifically, when completing on ``object.<tab>``.
566 When True: only those names in obj.__all__ will be included.
127 When True: only those names in obj.__all__ will be included.
567 When False [default]: the __all__ attribute is ignored
128 When False [default]: the __all__ attribute is ignored
568 IPCompleter.greedy=<CBool>
129 IPCompleter.greedy=<CBool>
569 Current: False
130 Current: False
570 Activate greedy completion
131 Activate greedy completion
571 This will enable completion on elements of lists, results of
132 This will enable completion on elements of lists, results of
572 function calls, etc., but can be unsafe because the code is
133 function calls, etc., but can be unsafe because the code is
573 actually evaluated on TAB.
134 actually evaluated on TAB.
574
135
575 but the real use is in setting values::
136 but the real use is in setting values::
576
137
577 In [3]: %config IPCompleter.greedy = True
138 In [3]: %config IPCompleter.greedy = True
578
139
579 and these values are read from the user_ns if they are variables::
140 and these values are read from the user_ns if they are variables::
580
141
581 In [4]: feeling_greedy=False
142 In [4]: feeling_greedy=False
582
143
583 In [5]: %config IPCompleter.greedy = feeling_greedy
144 In [5]: %config IPCompleter.greedy = feeling_greedy
584
145
585 """
146 """
586 from IPython.config.loader import Config
147 from IPython.config.loader import Config
587 # some IPython objects are Configurable, but do not yet have
148 # some IPython objects are Configurable, but do not yet have
588 # any configurable traits. Exclude them from the effects of
149 # any configurable traits. Exclude them from the effects of
589 # this magic, as their presence is just noise:
150 # this magic, as their presence is just noise:
590 configurables = [ c for c in self.shell.configurables
151 configurables = [ c for c in self.shell.configurables
591 if c.__class__.class_traits(config=True) ]
152 if c.__class__.class_traits(config=True) ]
592 classnames = [ c.__class__.__name__ for c in configurables ]
153 classnames = [ c.__class__.__name__ for c in configurables ]
593
154
594 line = s.strip()
155 line = s.strip()
595 if not line:
156 if not line:
596 # print available configurable names
157 # print available configurable names
597 print "Available objects for config:"
158 print "Available objects for config:"
598 for name in classnames:
159 for name in classnames:
599 print " ", name
160 print " ", name
600 return
161 return
601 elif line in classnames:
162 elif line in classnames:
602 # `%config TerminalInteractiveShell` will print trait info for
163 # `%config TerminalInteractiveShell` will print trait info for
603 # TerminalInteractiveShell
164 # TerminalInteractiveShell
604 c = configurables[classnames.index(line)]
165 c = configurables[classnames.index(line)]
605 cls = c.__class__
166 cls = c.__class__
606 help = cls.class_get_help(c)
167 help = cls.class_get_help(c)
607 # strip leading '--' from cl-args:
168 # strip leading '--' from cl-args:
608 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
169 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
609 print help
170 print help
610 return
171 return
611 elif '=' not in line:
172 elif '=' not in line:
612 raise UsageError("Invalid config statement: %r, "
173 raise UsageError("Invalid config statement: %r, "
613 "should be Class.trait = value" % line)
174 "should be Class.trait = value" % line)
614
175
615 # otherwise, assume we are setting configurables.
176 # otherwise, assume we are setting configurables.
616 # leave quotes on args when splitting, because we want
177 # leave quotes on args when splitting, because we want
617 # unquoted args to eval in user_ns
178 # unquoted args to eval in user_ns
618 cfg = Config()
179 cfg = Config()
619 exec "cfg."+line in locals(), self.shell.user_ns
180 exec "cfg."+line in locals(), self.shell.user_ns
620
181
621 for configurable in configurables:
182 for configurable in configurables:
622 try:
183 try:
623 configurable.update_config(cfg)
184 configurable.update_config(cfg)
624 except Exception as e:
185 except Exception as e:
625 error(e)
186 error(e)
626
187
627
188
628 @register_magics
189 @register_magics
629 class NamespaceMagics(Magics):
190 class NamespaceMagics(Magics):
630 """Magics to manage various aspects of the user's namespace.
191 """Magics to manage various aspects of the user's namespace.
631
192
632 These include listing variables, introspecting into them, etc.
193 These include listing variables, introspecting into them, etc.
633 """
194 """
634
195
635 @line_magic
196 @line_magic
636 def pinfo(self, parameter_s='', namespaces=None):
197 def pinfo(self, parameter_s='', namespaces=None):
637 """Provide detailed information about an object.
198 """Provide detailed information about an object.
638
199
639 '%pinfo object' is just a synonym for object? or ?object."""
200 '%pinfo object' is just a synonym for object? or ?object."""
640
201
641 #print 'pinfo par: <%s>' % parameter_s # dbg
202 #print 'pinfo par: <%s>' % parameter_s # dbg
642
203
643
204
644 # detail_level: 0 -> obj? , 1 -> obj??
205 # detail_level: 0 -> obj? , 1 -> obj??
645 detail_level = 0
206 detail_level = 0
646 # We need to detect if we got called as 'pinfo pinfo foo', which can
207 # We need to detect if we got called as 'pinfo pinfo foo', which can
647 # happen if the user types 'pinfo foo?' at the cmd line.
208 # happen if the user types 'pinfo foo?' at the cmd line.
648 pinfo,qmark1,oname,qmark2 = \
209 pinfo,qmark1,oname,qmark2 = \
649 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
210 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
650 if pinfo or qmark1 or qmark2:
211 if pinfo or qmark1 or qmark2:
651 detail_level = 1
212 detail_level = 1
652 if "*" in oname:
213 if "*" in oname:
653 self.psearch(oname)
214 self.psearch(oname)
654 else:
215 else:
655 self.shell._inspect('pinfo', oname, detail_level=detail_level,
216 self.shell._inspect('pinfo', oname, detail_level=detail_level,
656 namespaces=namespaces)
217 namespaces=namespaces)
657
218
658 @line_magic
219 @line_magic
659 def pinfo2(self, parameter_s='', namespaces=None):
220 def pinfo2(self, parameter_s='', namespaces=None):
660 """Provide extra detailed information about an object.
221 """Provide extra detailed information about an object.
661
222
662 '%pinfo2 object' is just a synonym for object?? or ??object."""
223 '%pinfo2 object' is just a synonym for object?? or ??object."""
663 self.shell._inspect('pinfo', parameter_s, detail_level=1,
224 self.shell._inspect('pinfo', parameter_s, detail_level=1,
664 namespaces=namespaces)
225 namespaces=namespaces)
665
226
666 @skip_doctest
227 @skip_doctest
667 @line_magic
228 @line_magic
668 def pdef(self, parameter_s='', namespaces=None):
229 def pdef(self, parameter_s='', namespaces=None):
669 """Print the definition header for any callable object.
230 """Print the definition header for any callable object.
670
231
671 If the object is a class, print the constructor information.
232 If the object is a class, print the constructor information.
672
233
673 Examples
234 Examples
674 --------
235 --------
675 ::
236 ::
676
237
677 In [3]: %pdef urllib.urlopen
238 In [3]: %pdef urllib.urlopen
678 urllib.urlopen(url, data=None, proxies=None)
239 urllib.urlopen(url, data=None, proxies=None)
679 """
240 """
680 self._inspect('pdef',parameter_s, namespaces)
241 self._inspect('pdef',parameter_s, namespaces)
681
242
682 @line_magic
243 @line_magic
683 def pdoc(self, parameter_s='', namespaces=None):
244 def pdoc(self, parameter_s='', namespaces=None):
684 """Print the docstring for an object.
245 """Print the docstring for an object.
685
246
686 If the given object is a class, it will print both the class and the
247 If the given object is a class, it will print both the class and the
687 constructor docstrings."""
248 constructor docstrings."""
688 self._inspect('pdoc',parameter_s, namespaces)
249 self._inspect('pdoc',parameter_s, namespaces)
689
250
690 @line_magic
251 @line_magic
691 def psource(self, parameter_s='', namespaces=None):
252 def psource(self, parameter_s='', namespaces=None):
692 """Print (or run through pager) the source code for an object."""
253 """Print (or run through pager) the source code for an object."""
693 self._inspect('psource',parameter_s, namespaces)
254 self._inspect('psource',parameter_s, namespaces)
694
255
695 @line_magic
256 @line_magic
696 def pfile(self, parameter_s=''):
257 def pfile(self, parameter_s=''):
697 """Print (or run through pager) the file where an object is defined.
258 """Print (or run through pager) the file where an object is defined.
698
259
699 The file opens at the line where the object definition begins. IPython
260 The file opens at the line where the object definition begins. IPython
700 will honor the environment variable PAGER if set, and otherwise will
261 will honor the environment variable PAGER if set, and otherwise will
701 do its best to print the file in a convenient form.
262 do its best to print the file in a convenient form.
702
263
703 If the given argument is not an object currently defined, IPython will
264 If the given argument is not an object currently defined, IPython will
704 try to interpret it as a filename (automatically adding a .py extension
265 try to interpret it as a filename (automatically adding a .py extension
705 if needed). You can thus use %pfile as a syntax highlighting code
266 if needed). You can thus use %pfile as a syntax highlighting code
706 viewer."""
267 viewer."""
707
268
708 # first interpret argument as an object name
269 # first interpret argument as an object name
709 out = self._inspect('pfile',parameter_s)
270 out = self._inspect('pfile',parameter_s)
710 # if not, try the input as a filename
271 # if not, try the input as a filename
711 if out == 'not found':
272 if out == 'not found':
712 try:
273 try:
713 filename = get_py_filename(parameter_s)
274 filename = get_py_filename(parameter_s)
714 except IOError,msg:
275 except IOError,msg:
715 print msg
276 print msg
716 return
277 return
717 page.page(self.shell.inspector.format(open(filename).read()))
278 page.page(self.shell.inspector.format(open(filename).read()))
718
279
719 @line_magic
280 @line_magic
720 def psearch(self, parameter_s=''):
281 def psearch(self, parameter_s=''):
721 """Search for object in namespaces by wildcard.
282 """Search for object in namespaces by wildcard.
722
283
723 %psearch [options] PATTERN [OBJECT TYPE]
284 %psearch [options] PATTERN [OBJECT TYPE]
724
285
725 Note: ? can be used as a synonym for %psearch, at the beginning or at
286 Note: ? can be used as a synonym for %psearch, at the beginning or at
726 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
287 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
727 rest of the command line must be unchanged (options come first), so
288 rest of the command line must be unchanged (options come first), so
728 for example the following forms are equivalent
289 for example the following forms are equivalent
729
290
730 %psearch -i a* function
291 %psearch -i a* function
731 -i a* function?
292 -i a* function?
732 ?-i a* function
293 ?-i a* function
733
294
734 Arguments:
295 Arguments:
735
296
736 PATTERN
297 PATTERN
737
298
738 where PATTERN is a string containing * as a wildcard similar to its
299 where PATTERN is a string containing * as a wildcard similar to its
739 use in a shell. The pattern is matched in all namespaces on the
300 use in a shell. The pattern is matched in all namespaces on the
740 search path. By default objects starting with a single _ are not
301 search path. By default objects starting with a single _ are not
741 matched, many IPython generated objects have a single
302 matched, many IPython generated objects have a single
742 underscore. The default is case insensitive matching. Matching is
303 underscore. The default is case insensitive matching. Matching is
743 also done on the attributes of objects and not only on the objects
304 also done on the attributes of objects and not only on the objects
744 in a module.
305 in a module.
745
306
746 [OBJECT TYPE]
307 [OBJECT TYPE]
747
308
748 Is the name of a python type from the types module. The name is
309 Is the name of a python type from the types module. The name is
749 given in lowercase without the ending type, ex. StringType is
310 given in lowercase without the ending type, ex. StringType is
750 written string. By adding a type here only objects matching the
311 written string. By adding a type here only objects matching the
751 given type are matched. Using all here makes the pattern match all
312 given type are matched. Using all here makes the pattern match all
752 types (this is the default).
313 types (this is the default).
753
314
754 Options:
315 Options:
755
316
756 -a: makes the pattern match even objects whose names start with a
317 -a: makes the pattern match even objects whose names start with a
757 single underscore. These names are normally omitted from the
318 single underscore. These names are normally omitted from the
758 search.
319 search.
759
320
760 -i/-c: make the pattern case insensitive/sensitive. If neither of
321 -i/-c: make the pattern case insensitive/sensitive. If neither of
761 these options are given, the default is read from your configuration
322 these options are given, the default is read from your configuration
762 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
323 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
763 If this option is not specified in your configuration file, IPython's
324 If this option is not specified in your configuration file, IPython's
764 internal default is to do a case sensitive search.
325 internal default is to do a case sensitive search.
765
326
766 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
327 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
767 specify can be searched in any of the following namespaces:
328 specify can be searched in any of the following namespaces:
768 'builtin', 'user', 'user_global','internal', 'alias', where
329 'builtin', 'user', 'user_global','internal', 'alias', where
769 'builtin' and 'user' are the search defaults. Note that you should
330 'builtin' and 'user' are the search defaults. Note that you should
770 not use quotes when specifying namespaces.
331 not use quotes when specifying namespaces.
771
332
772 'Builtin' contains the python module builtin, 'user' contains all
333 'Builtin' contains the python module builtin, 'user' contains all
773 user data, 'alias' only contain the shell aliases and no python
334 user data, 'alias' only contain the shell aliases and no python
774 objects, 'internal' contains objects used by IPython. The
335 objects, 'internal' contains objects used by IPython. The
775 'user_global' namespace is only used by embedded IPython instances,
336 'user_global' namespace is only used by embedded IPython instances,
776 and it contains module-level globals. You can add namespaces to the
337 and it contains module-level globals. You can add namespaces to the
777 search with -s or exclude them with -e (these options can be given
338 search with -s or exclude them with -e (these options can be given
778 more than once).
339 more than once).
779
340
780 Examples
341 Examples
781 --------
342 --------
782 ::
343 ::
783
344
784 %psearch a* -> objects beginning with an a
345 %psearch a* -> objects beginning with an a
785 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
346 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
786 %psearch a* function -> all functions beginning with an a
347 %psearch a* function -> all functions beginning with an a
787 %psearch re.e* -> objects beginning with an e in module re
348 %psearch re.e* -> objects beginning with an e in module re
788 %psearch r*.e* -> objects that start with e in modules starting in r
349 %psearch r*.e* -> objects that start with e in modules starting in r
789 %psearch r*.* string -> all strings in modules beginning with r
350 %psearch r*.* string -> all strings in modules beginning with r
790
351
791 Case sensitive search::
352 Case sensitive search::
792
353
793 %psearch -c a* list all object beginning with lower case a
354 %psearch -c a* list all object beginning with lower case a
794
355
795 Show objects beginning with a single _::
356 Show objects beginning with a single _::
796
357
797 %psearch -a _* list objects beginning with a single underscore
358 %psearch -a _* list objects beginning with a single underscore
798 """
359 """
799 try:
360 try:
800 parameter_s.encode('ascii')
361 parameter_s.encode('ascii')
801 except UnicodeEncodeError:
362 except UnicodeEncodeError:
802 print 'Python identifiers can only contain ascii characters.'
363 print 'Python identifiers can only contain ascii characters.'
803 return
364 return
804
365
805 # default namespaces to be searched
366 # default namespaces to be searched
806 def_search = ['user_local', 'user_global', 'builtin']
367 def_search = ['user_local', 'user_global', 'builtin']
807
368
808 # Process options/args
369 # Process options/args
809 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
370 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
810 opt = opts.get
371 opt = opts.get
811 shell = self.shell
372 shell = self.shell
812 psearch = shell.inspector.psearch
373 psearch = shell.inspector.psearch
813
374
814 # select case options
375 # select case options
815 if opts.has_key('i'):
376 if opts.has_key('i'):
816 ignore_case = True
377 ignore_case = True
817 elif opts.has_key('c'):
378 elif opts.has_key('c'):
818 ignore_case = False
379 ignore_case = False
819 else:
380 else:
820 ignore_case = not shell.wildcards_case_sensitive
381 ignore_case = not shell.wildcards_case_sensitive
821
382
822 # Build list of namespaces to search from user options
383 # Build list of namespaces to search from user options
823 def_search.extend(opt('s',[]))
384 def_search.extend(opt('s',[]))
824 ns_exclude = ns_exclude=opt('e',[])
385 ns_exclude = ns_exclude=opt('e',[])
825 ns_search = [nm for nm in def_search if nm not in ns_exclude]
386 ns_search = [nm for nm in def_search if nm not in ns_exclude]
826
387
827 # Call the actual search
388 # Call the actual search
828 try:
389 try:
829 psearch(args,shell.ns_table,ns_search,
390 psearch(args,shell.ns_table,ns_search,
830 show_all=opt('a'),ignore_case=ignore_case)
391 show_all=opt('a'),ignore_case=ignore_case)
831 except:
392 except:
832 shell.showtraceback()
393 shell.showtraceback()
833
394
834 @skip_doctest
395 @skip_doctest
835 @line_magic
396 @line_magic
836 def who_ls(self, parameter_s=''):
397 def who_ls(self, parameter_s=''):
837 """Return a sorted list of all interactive variables.
398 """Return a sorted list of all interactive variables.
838
399
839 If arguments are given, only variables of types matching these
400 If arguments are given, only variables of types matching these
840 arguments are returned.
401 arguments are returned.
841
402
842 Examples
403 Examples
843 --------
404 --------
844
405
845 Define two variables and list them with who_ls::
406 Define two variables and list them with who_ls::
846
407
847 In [1]: alpha = 123
408 In [1]: alpha = 123
848
409
849 In [2]: beta = 'test'
410 In [2]: beta = 'test'
850
411
851 In [3]: %who_ls
412 In [3]: %who_ls
852 Out[3]: ['alpha', 'beta']
413 Out[3]: ['alpha', 'beta']
853
414
854 In [4]: %who_ls int
415 In [4]: %who_ls int
855 Out[4]: ['alpha']
416 Out[4]: ['alpha']
856
417
857 In [5]: %who_ls str
418 In [5]: %who_ls str
858 Out[5]: ['beta']
419 Out[5]: ['beta']
859 """
420 """
860
421
861 user_ns = self.shell.user_ns
422 user_ns = self.shell.user_ns
862 user_ns_hidden = self.shell.user_ns_hidden
423 user_ns_hidden = self.shell.user_ns_hidden
863 out = [ i for i in user_ns
424 out = [ i for i in user_ns
864 if not i.startswith('_') \
425 if not i.startswith('_') \
865 and not i in user_ns_hidden ]
426 and not i in user_ns_hidden ]
866
427
867 typelist = parameter_s.split()
428 typelist = parameter_s.split()
868 if typelist:
429 if typelist:
869 typeset = set(typelist)
430 typeset = set(typelist)
870 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
431 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
871
432
872 out.sort()
433 out.sort()
873 return out
434 return out
874
435
875 @skip_doctest
436 @skip_doctest
876 @line_magic
437 @line_magic
877 def who(self, parameter_s=''):
438 def who(self, parameter_s=''):
878 """Print all interactive variables, with some minimal formatting.
439 """Print all interactive variables, with some minimal formatting.
879
440
880 If any arguments are given, only variables whose type matches one of
441 If any arguments are given, only variables whose type matches one of
881 these are printed. For example::
442 these are printed. For example::
882
443
883 %who function str
444 %who function str
884
445
885 will only list functions and strings, excluding all other types of
446 will only list functions and strings, excluding all other types of
886 variables. To find the proper type names, simply use type(var) at a
447 variables. To find the proper type names, simply use type(var) at a
887 command line to see how python prints type names. For example:
448 command line to see how python prints type names. For example:
888
449
889 ::
450 ::
890
451
891 In [1]: type('hello')\\
452 In [1]: type('hello')\\
892 Out[1]: <type 'str'>
453 Out[1]: <type 'str'>
893
454
894 indicates that the type name for strings is 'str'.
455 indicates that the type name for strings is 'str'.
895
456
896 ``%who`` always excludes executed names loaded through your configuration
457 ``%who`` always excludes executed names loaded through your configuration
897 file and things which are internal to IPython.
458 file and things which are internal to IPython.
898
459
899 This is deliberate, as typically you may load many modules and the
460 This is deliberate, as typically you may load many modules and the
900 purpose of %who is to show you only what you've manually defined.
461 purpose of %who is to show you only what you've manually defined.
901
462
902 Examples
463 Examples
903 --------
464 --------
904
465
905 Define two variables and list them with who::
466 Define two variables and list them with who::
906
467
907 In [1]: alpha = 123
468 In [1]: alpha = 123
908
469
909 In [2]: beta = 'test'
470 In [2]: beta = 'test'
910
471
911 In [3]: %who
472 In [3]: %who
912 alpha beta
473 alpha beta
913
474
914 In [4]: %who int
475 In [4]: %who int
915 alpha
476 alpha
916
477
917 In [5]: %who str
478 In [5]: %who str
918 beta
479 beta
919 """
480 """
920
481
921 varlist = self.who_ls(parameter_s)
482 varlist = self.who_ls(parameter_s)
922 if not varlist:
483 if not varlist:
923 if parameter_s:
484 if parameter_s:
924 print 'No variables match your requested type.'
485 print 'No variables match your requested type.'
925 else:
486 else:
926 print 'Interactive namespace is empty.'
487 print 'Interactive namespace is empty.'
927 return
488 return
928
489
929 # if we have variables, move on...
490 # if we have variables, move on...
930 count = 0
491 count = 0
931 for i in varlist:
492 for i in varlist:
932 print i+'\t',
493 print i+'\t',
933 count += 1
494 count += 1
934 if count > 8:
495 if count > 8:
935 count = 0
496 count = 0
936 print
497 print
937 print
498 print
938
499
939 @skip_doctest
500 @skip_doctest
940 @line_magic
501 @line_magic
941 def whos(self, parameter_s=''):
502 def whos(self, parameter_s=''):
942 """Like %who, but gives some extra information about each variable.
503 """Like %who, but gives some extra information about each variable.
943
504
944 The same type filtering of %who can be applied here.
505 The same type filtering of %who can be applied here.
945
506
946 For all variables, the type is printed. Additionally it prints:
507 For all variables, the type is printed. Additionally it prints:
947
508
948 - For {},[],(): their length.
509 - For {},[],(): their length.
949
510
950 - For numpy arrays, a summary with shape, number of
511 - For numpy arrays, a summary with shape, number of
951 elements, typecode and size in memory.
512 elements, typecode and size in memory.
952
513
953 - Everything else: a string representation, snipping their middle if
514 - Everything else: a string representation, snipping their middle if
954 too long.
515 too long.
955
516
956 Examples
517 Examples
957 --------
518 --------
958
519
959 Define two variables and list them with whos::
520 Define two variables and list them with whos::
960
521
961 In [1]: alpha = 123
522 In [1]: alpha = 123
962
523
963 In [2]: beta = 'test'
524 In [2]: beta = 'test'
964
525
965 In [3]: %whos
526 In [3]: %whos
966 Variable Type Data/Info
527 Variable Type Data/Info
967 --------------------------------
528 --------------------------------
968 alpha int 123
529 alpha int 123
969 beta str test
530 beta str test
970 """
531 """
971
532
972 varnames = self.who_ls(parameter_s)
533 varnames = self.who_ls(parameter_s)
973 if not varnames:
534 if not varnames:
974 if parameter_s:
535 if parameter_s:
975 print 'No variables match your requested type.'
536 print 'No variables match your requested type.'
976 else:
537 else:
977 print 'Interactive namespace is empty.'
538 print 'Interactive namespace is empty.'
978 return
539 return
979
540
980 # if we have variables, move on...
541 # if we have variables, move on...
981
542
982 # for these types, show len() instead of data:
543 # for these types, show len() instead of data:
983 seq_types = ['dict', 'list', 'tuple']
544 seq_types = ['dict', 'list', 'tuple']
984
545
985 # for numpy arrays, display summary info
546 # for numpy arrays, display summary info
986 ndarray_type = None
547 ndarray_type = None
987 if 'numpy' in sys.modules:
548 if 'numpy' in sys.modules:
988 try:
549 try:
989 from numpy import ndarray
550 from numpy import ndarray
990 except ImportError:
551 except ImportError:
991 pass
552 pass
992 else:
553 else:
993 ndarray_type = ndarray.__name__
554 ndarray_type = ndarray.__name__
994
555
995 # Find all variable names and types so we can figure out column sizes
556 # Find all variable names and types so we can figure out column sizes
996 def get_vars(i):
557 def get_vars(i):
997 return self.shell.user_ns[i]
558 return self.shell.user_ns[i]
998
559
999 # some types are well known and can be shorter
560 # some types are well known and can be shorter
1000 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
561 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
1001 def type_name(v):
562 def type_name(v):
1002 tn = type(v).__name__
563 tn = type(v).__name__
1003 return abbrevs.get(tn,tn)
564 return abbrevs.get(tn,tn)
1004
565
1005 varlist = map(get_vars,varnames)
566 varlist = map(get_vars,varnames)
1006
567
1007 typelist = []
568 typelist = []
1008 for vv in varlist:
569 for vv in varlist:
1009 tt = type_name(vv)
570 tt = type_name(vv)
1010
571
1011 if tt=='instance':
572 if tt=='instance':
1012 typelist.append( abbrevs.get(str(vv.__class__),
573 typelist.append( abbrevs.get(str(vv.__class__),
1013 str(vv.__class__)))
574 str(vv.__class__)))
1014 else:
575 else:
1015 typelist.append(tt)
576 typelist.append(tt)
1016
577
1017 # column labels and # of spaces as separator
578 # column labels and # of spaces as separator
1018 varlabel = 'Variable'
579 varlabel = 'Variable'
1019 typelabel = 'Type'
580 typelabel = 'Type'
1020 datalabel = 'Data/Info'
581 datalabel = 'Data/Info'
1021 colsep = 3
582 colsep = 3
1022 # variable format strings
583 # variable format strings
1023 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
584 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
1024 aformat = "%s: %s elems, type `%s`, %s bytes"
585 aformat = "%s: %s elems, type `%s`, %s bytes"
1025 # find the size of the columns to format the output nicely
586 # find the size of the columns to format the output nicely
1026 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
587 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
1027 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
588 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
1028 # table header
589 # table header
1029 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
590 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
1030 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
591 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
1031 # and the table itself
592 # and the table itself
1032 kb = 1024
593 kb = 1024
1033 Mb = 1048576 # kb**2
594 Mb = 1048576 # kb**2
1034 for vname,var,vtype in zip(varnames,varlist,typelist):
595 for vname,var,vtype in zip(varnames,varlist,typelist):
1035 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
596 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
1036 if vtype in seq_types:
597 if vtype in seq_types:
1037 print "n="+str(len(var))
598 print "n="+str(len(var))
1038 elif vtype == ndarray_type:
599 elif vtype == ndarray_type:
1039 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
600 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
1040 if vtype==ndarray_type:
601 if vtype==ndarray_type:
1041 # numpy
602 # numpy
1042 vsize = var.size
603 vsize = var.size
1043 vbytes = vsize*var.itemsize
604 vbytes = vsize*var.itemsize
1044 vdtype = var.dtype
605 vdtype = var.dtype
1045
606
1046 if vbytes < 100000:
607 if vbytes < 100000:
1047 print aformat % (vshape,vsize,vdtype,vbytes)
608 print aformat % (vshape,vsize,vdtype,vbytes)
1048 else:
609 else:
1049 print aformat % (vshape,vsize,vdtype,vbytes),
610 print aformat % (vshape,vsize,vdtype,vbytes),
1050 if vbytes < Mb:
611 if vbytes < Mb:
1051 print '(%s kb)' % (vbytes/kb,)
612 print '(%s kb)' % (vbytes/kb,)
1052 else:
613 else:
1053 print '(%s Mb)' % (vbytes/Mb,)
614 print '(%s Mb)' % (vbytes/Mb,)
1054 else:
615 else:
1055 try:
616 try:
1056 vstr = str(var)
617 vstr = str(var)
1057 except UnicodeEncodeError:
618 except UnicodeEncodeError:
1058 vstr = unicode(var).encode(DEFAULT_ENCODING,
619 vstr = unicode(var).encode(DEFAULT_ENCODING,
1059 'backslashreplace')
620 'backslashreplace')
1060 except:
621 except:
1061 vstr = "<object with id %d (str() failed)>" % id(var)
622 vstr = "<object with id %d (str() failed)>" % id(var)
1062 vstr = vstr.replace('\n','\\n')
623 vstr = vstr.replace('\n','\\n')
1063 if len(vstr) < 50:
624 if len(vstr) < 50:
1064 print vstr
625 print vstr
1065 else:
626 else:
1066 print vstr[:25] + "<...>" + vstr[-25:]
627 print vstr[:25] + "<...>" + vstr[-25:]
1067
628
1068 @line_magic
629 @line_magic
1069 def reset(self, parameter_s=''):
630 def reset(self, parameter_s=''):
1070 """Resets the namespace by removing all names defined by the user, if
631 """Resets the namespace by removing all names defined by the user, if
1071 called without arguments, or by removing some types of objects, such
632 called without arguments, or by removing some types of objects, such
1072 as everything currently in IPython's In[] and Out[] containers (see
633 as everything currently in IPython's In[] and Out[] containers (see
1073 the parameters for details).
634 the parameters for details).
1074
635
1075 Parameters
636 Parameters
1076 ----------
637 ----------
1077 -f : force reset without asking for confirmation.
638 -f : force reset without asking for confirmation.
1078
639
1079 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
640 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
1080 References to objects may be kept. By default (without this option),
641 References to objects may be kept. By default (without this option),
1081 we do a 'hard' reset, giving you a new session and removing all
642 we do a 'hard' reset, giving you a new session and removing all
1082 references to objects from the current session.
643 references to objects from the current session.
1083
644
1084 in : reset input history
645 in : reset input history
1085
646
1086 out : reset output history
647 out : reset output history
1087
648
1088 dhist : reset directory history
649 dhist : reset directory history
1089
650
1090 array : reset only variables that are NumPy arrays
651 array : reset only variables that are NumPy arrays
1091
652
1092 See Also
653 See Also
1093 --------
654 --------
1094 magic_reset_selective : invoked as ``%reset_selective``
655 magic_reset_selective : invoked as ``%reset_selective``
1095
656
1096 Examples
657 Examples
1097 --------
658 --------
1098 ::
659 ::
1099
660
1100 In [6]: a = 1
661 In [6]: a = 1
1101
662
1102 In [7]: a
663 In [7]: a
1103 Out[7]: 1
664 Out[7]: 1
1104
665
1105 In [8]: 'a' in _ip.user_ns
666 In [8]: 'a' in _ip.user_ns
1106 Out[8]: True
667 Out[8]: True
1107
668
1108 In [9]: %reset -f
669 In [9]: %reset -f
1109
670
1110 In [1]: 'a' in _ip.user_ns
671 In [1]: 'a' in _ip.user_ns
1111 Out[1]: False
672 Out[1]: False
1112
673
1113 In [2]: %reset -f in
674 In [2]: %reset -f in
1114 Flushing input history
675 Flushing input history
1115
676
1116 In [3]: %reset -f dhist in
677 In [3]: %reset -f dhist in
1117 Flushing directory history
678 Flushing directory history
1118 Flushing input history
679 Flushing input history
1119
680
1120 Notes
681 Notes
1121 -----
682 -----
1122 Calling this magic from clients that do not implement standard input,
683 Calling this magic from clients that do not implement standard input,
1123 such as the ipython notebook interface, will reset the namespace
684 such as the ipython notebook interface, will reset the namespace
1124 without confirmation.
685 without confirmation.
1125 """
686 """
1126 opts, args = self.parse_options(parameter_s,'sf', mode='list')
687 opts, args = self.parse_options(parameter_s,'sf', mode='list')
1127 if 'f' in opts:
688 if 'f' in opts:
1128 ans = True
689 ans = True
1129 else:
690 else:
1130 try:
691 try:
1131 ans = self.shell.ask_yes_no(
692 ans = self.shell.ask_yes_no(
1132 "Once deleted, variables cannot be recovered. Proceed (y/[n])?",
693 "Once deleted, variables cannot be recovered. Proceed (y/[n])?",
1133 default='n')
694 default='n')
1134 except StdinNotImplementedError:
695 except StdinNotImplementedError:
1135 ans = True
696 ans = True
1136 if not ans:
697 if not ans:
1137 print 'Nothing done.'
698 print 'Nothing done.'
1138 return
699 return
1139
700
1140 if 's' in opts: # Soft reset
701 if 's' in opts: # Soft reset
1141 user_ns = self.shell.user_ns
702 user_ns = self.shell.user_ns
1142 for i in self.who_ls():
703 for i in self.who_ls():
1143 del(user_ns[i])
704 del(user_ns[i])
1144 elif len(args) == 0: # Hard reset
705 elif len(args) == 0: # Hard reset
1145 self.shell.reset(new_session = False)
706 self.shell.reset(new_session = False)
1146
707
1147 # reset in/out/dhist/array: previously extensinions/clearcmd.py
708 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1148 ip = self.shell
709 ip = self.shell
1149 user_ns = self.shell.user_ns # local lookup, heavily used
710 user_ns = self.shell.user_ns # local lookup, heavily used
1150
711
1151 for target in args:
712 for target in args:
1152 target = target.lower() # make matches case insensitive
713 target = target.lower() # make matches case insensitive
1153 if target == 'out':
714 if target == 'out':
1154 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
715 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1155 self.shell.displayhook.flush()
716 self.shell.displayhook.flush()
1156
717
1157 elif target == 'in':
718 elif target == 'in':
1158 print "Flushing input history"
719 print "Flushing input history"
1159 pc = self.shell.displayhook.prompt_count + 1
720 pc = self.shell.displayhook.prompt_count + 1
1160 for n in range(1, pc):
721 for n in range(1, pc):
1161 key = '_i'+repr(n)
722 key = '_i'+repr(n)
1162 user_ns.pop(key,None)
723 user_ns.pop(key,None)
1163 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
724 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1164 hm = ip.history_manager
725 hm = ip.history_manager
1165 # don't delete these, as %save and %macro depending on the
726 # don't delete these, as %save and %macro depending on the
1166 # length of these lists to be preserved
727 # length of these lists to be preserved
1167 hm.input_hist_parsed[:] = [''] * pc
728 hm.input_hist_parsed[:] = [''] * pc
1168 hm.input_hist_raw[:] = [''] * pc
729 hm.input_hist_raw[:] = [''] * pc
1169 # hm has internal machinery for _i,_ii,_iii, clear it out
730 # hm has internal machinery for _i,_ii,_iii, clear it out
1170 hm._i = hm._ii = hm._iii = hm._i00 = u''
731 hm._i = hm._ii = hm._iii = hm._i00 = u''
1171
732
1172 elif target == 'array':
733 elif target == 'array':
1173 # Support cleaning up numpy arrays
734 # Support cleaning up numpy arrays
1174 try:
735 try:
1175 from numpy import ndarray
736 from numpy import ndarray
1176 # This must be done with items and not iteritems because
737 # This must be done with items and not iteritems because
1177 # we're going to modify the dict in-place.
738 # we're going to modify the dict in-place.
1178 for x,val in user_ns.items():
739 for x,val in user_ns.items():
1179 if isinstance(val,ndarray):
740 if isinstance(val,ndarray):
1180 del user_ns[x]
741 del user_ns[x]
1181 except ImportError:
742 except ImportError:
1182 print "reset array only works if Numpy is available."
743 print "reset array only works if Numpy is available."
1183
744
1184 elif target == 'dhist':
745 elif target == 'dhist':
1185 print "Flushing directory history"
746 print "Flushing directory history"
1186 del user_ns['_dh'][:]
747 del user_ns['_dh'][:]
1187
748
1188 else:
749 else:
1189 print "Don't know how to reset ",
750 print "Don't know how to reset ",
1190 print target + ", please run `%reset?` for details"
751 print target + ", please run `%reset?` for details"
1191
752
1192 gc.collect()
753 gc.collect()
1193
754
1194 @line_magic
755 @line_magic
1195 def reset_selective(self, parameter_s=''):
756 def reset_selective(self, parameter_s=''):
1196 """Resets the namespace by removing names defined by the user.
757 """Resets the namespace by removing names defined by the user.
1197
758
1198 Input/Output history are left around in case you need them.
759 Input/Output history are left around in case you need them.
1199
760
1200 %reset_selective [-f] regex
761 %reset_selective [-f] regex
1201
762
1202 No action is taken if regex is not included
763 No action is taken if regex is not included
1203
764
1204 Options
765 Options
1205 -f : force reset without asking for confirmation.
766 -f : force reset without asking for confirmation.
1206
767
1207 See Also
768 See Also
1208 --------
769 --------
1209 magic_reset : invoked as ``%reset``
770 magic_reset : invoked as ``%reset``
1210
771
1211 Examples
772 Examples
1212 --------
773 --------
1213
774
1214 We first fully reset the namespace so your output looks identical to
775 We first fully reset the namespace so your output looks identical to
1215 this example for pedagogical reasons; in practice you do not need a
776 this example for pedagogical reasons; in practice you do not need a
1216 full reset::
777 full reset::
1217
778
1218 In [1]: %reset -f
779 In [1]: %reset -f
1219
780
1220 Now, with a clean namespace we can make a few variables and use
781 Now, with a clean namespace we can make a few variables and use
1221 ``%reset_selective`` to only delete names that match our regexp::
782 ``%reset_selective`` to only delete names that match our regexp::
1222
783
1223 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
784 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1224
785
1225 In [3]: who_ls
786 In [3]: who_ls
1226 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
787 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1227
788
1228 In [4]: %reset_selective -f b[2-3]m
789 In [4]: %reset_selective -f b[2-3]m
1229
790
1230 In [5]: who_ls
791 In [5]: who_ls
1231 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
792 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1232
793
1233 In [6]: %reset_selective -f d
794 In [6]: %reset_selective -f d
1234
795
1235 In [7]: who_ls
796 In [7]: who_ls
1236 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
797 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1237
798
1238 In [8]: %reset_selective -f c
799 In [8]: %reset_selective -f c
1239
800
1240 In [9]: who_ls
801 In [9]: who_ls
1241 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
802 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1242
803
1243 In [10]: %reset_selective -f b
804 In [10]: %reset_selective -f b
1244
805
1245 In [11]: who_ls
806 In [11]: who_ls
1246 Out[11]: ['a']
807 Out[11]: ['a']
1247
808
1248 Notes
809 Notes
1249 -----
810 -----
1250 Calling this magic from clients that do not implement standard input,
811 Calling this magic from clients that do not implement standard input,
1251 such as the ipython notebook interface, will reset the namespace
812 such as the ipython notebook interface, will reset the namespace
1252 without confirmation.
813 without confirmation.
1253 """
814 """
1254
815
1255 opts, regex = self.parse_options(parameter_s,'f')
816 opts, regex = self.parse_options(parameter_s,'f')
1256
817
1257 if opts.has_key('f'):
818 if opts.has_key('f'):
1258 ans = True
819 ans = True
1259 else:
820 else:
1260 try:
821 try:
1261 ans = self.shell.ask_yes_no(
822 ans = self.shell.ask_yes_no(
1262 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
823 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1263 default='n')
824 default='n')
1264 except StdinNotImplementedError:
825 except StdinNotImplementedError:
1265 ans = True
826 ans = True
1266 if not ans:
827 if not ans:
1267 print 'Nothing done.'
828 print 'Nothing done.'
1268 return
829 return
1269 user_ns = self.shell.user_ns
830 user_ns = self.shell.user_ns
1270 if not regex:
831 if not regex:
1271 print 'No regex pattern specified. Nothing done.'
832 print 'No regex pattern specified. Nothing done.'
1272 return
833 return
1273 else:
834 else:
1274 try:
835 try:
1275 m = re.compile(regex)
836 m = re.compile(regex)
1276 except TypeError:
837 except TypeError:
1277 raise TypeError('regex must be a string or compiled pattern')
838 raise TypeError('regex must be a string or compiled pattern')
1278 for i in self.who_ls():
839 for i in self.who_ls():
1279 if m.search(i):
840 if m.search(i):
1280 del(user_ns[i])
841 del(user_ns[i])
1281
842
1282 @line_magic
843 @line_magic
1283 def xdel(self, parameter_s=''):
844 def xdel(self, parameter_s=''):
1284 """Delete a variable, trying to clear it from anywhere that
845 """Delete a variable, trying to clear it from anywhere that
1285 IPython's machinery has references to it. By default, this uses
846 IPython's machinery has references to it. By default, this uses
1286 the identity of the named object in the user namespace to remove
847 the identity of the named object in the user namespace to remove
1287 references held under other names. The object is also removed
848 references held under other names. The object is also removed
1288 from the output history.
849 from the output history.
1289
850
1290 Options
851 Options
1291 -n : Delete the specified name from all namespaces, without
852 -n : Delete the specified name from all namespaces, without
1292 checking their identity.
853 checking their identity.
1293 """
854 """
1294 opts, varname = self.parse_options(parameter_s,'n')
855 opts, varname = self.parse_options(parameter_s,'n')
1295 try:
856 try:
1296 self.shell.del_var(varname, ('n' in opts))
857 self.shell.del_var(varname, ('n' in opts))
1297 except (NameError, ValueError) as e:
858 except (NameError, ValueError) as e:
1298 print type(e).__name__ +": "+ str(e)
859 print type(e).__name__ +": "+ str(e)
1299
860
1300
861
1301 @register_magics
862 @register_magics
1302 class ExecutionMagics(Magics):
863 class ExecutionMagics(Magics):
1303 """Magics related to code execution, debugging, profiling, etc.
864 """Magics related to code execution, debugging, profiling, etc.
1304
865
1305 """
866 """
1306
867
1307 def __init__(self, shell):
868 def __init__(self, shell):
1308 super(ExecutionMagics, self).__init__(shell)
869 super(ExecutionMagics, self).__init__(shell)
1309 if profile is None:
870 if profile is None:
1310 self.prun = self.profile_missing_notice
871 self.prun = self.profile_missing_notice
1311 # Default execution function used to actually run user code.
872 # Default execution function used to actually run user code.
1312 self.default_runner = None
873 self.default_runner = None
1313
874
1314 def profile_missing_notice(self, *args, **kwargs):
875 def profile_missing_notice(self, *args, **kwargs):
1315 error("""\
876 error("""\
1316 The profile module could not be found. It has been removed from the standard
877 The profile module could not be found. It has been removed from the standard
1317 python packages because of its non-free license. To use profiling, install the
878 python packages because of its non-free license. To use profiling, install the
1318 python-profiler package from non-free.""")
879 python-profiler package from non-free.""")
1319
880
1320 @skip_doctest
881 @skip_doctest
1321 @line_magic
882 @line_magic
1322 def prun(self, parameter_s='',user_mode=1,
883 def prun(self, parameter_s='',user_mode=1,
1323 opts=None,arg_lst=None,prog_ns=None):
884 opts=None,arg_lst=None,prog_ns=None):
1324
885
1325 """Run a statement through the python code profiler.
886 """Run a statement through the python code profiler.
1326
887
1327 Usage:
888 Usage:
1328 %prun [options] statement
889 %prun [options] statement
1329
890
1330 The given statement (which doesn't require quote marks) is run via the
891 The given statement (which doesn't require quote marks) is run via the
1331 python profiler in a manner similar to the profile.run() function.
892 python profiler in a manner similar to the profile.run() function.
1332 Namespaces are internally managed to work correctly; profile.run
893 Namespaces are internally managed to work correctly; profile.run
1333 cannot be used in IPython because it makes certain assumptions about
894 cannot be used in IPython because it makes certain assumptions about
1334 namespaces which do not hold under IPython.
895 namespaces which do not hold under IPython.
1335
896
1336 Options:
897 Options:
1337
898
1338 -l <limit>: you can place restrictions on what or how much of the
899 -l <limit>: you can place restrictions on what or how much of the
1339 profile gets printed. The limit value can be:
900 profile gets printed. The limit value can be:
1340
901
1341 * A string: only information for function names containing this string
902 * A string: only information for function names containing this string
1342 is printed.
903 is printed.
1343
904
1344 * An integer: only these many lines are printed.
905 * An integer: only these many lines are printed.
1345
906
1346 * A float (between 0 and 1): this fraction of the report is printed
907 * A float (between 0 and 1): this fraction of the report is printed
1347 (for example, use a limit of 0.4 to see the topmost 40% only).
908 (for example, use a limit of 0.4 to see the topmost 40% only).
1348
909
1349 You can combine several limits with repeated use of the option. For
910 You can combine several limits with repeated use of the option. For
1350 example, '-l __init__ -l 5' will print only the topmost 5 lines of
911 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1351 information about class constructors.
912 information about class constructors.
1352
913
1353 -r: return the pstats.Stats object generated by the profiling. This
914 -r: return the pstats.Stats object generated by the profiling. This
1354 object has all the information about the profile in it, and you can
915 object has all the information about the profile in it, and you can
1355 later use it for further analysis or in other functions.
916 later use it for further analysis or in other functions.
1356
917
1357 -s <key>: sort profile by given key. You can provide more than one key
918 -s <key>: sort profile by given key. You can provide more than one key
1358 by using the option several times: '-s key1 -s key2 -s key3...'. The
919 by using the option several times: '-s key1 -s key2 -s key3...'. The
1359 default sorting key is 'time'.
920 default sorting key is 'time'.
1360
921
1361 The following is copied verbatim from the profile documentation
922 The following is copied verbatim from the profile documentation
1362 referenced below:
923 referenced below:
1363
924
1364 When more than one key is provided, additional keys are used as
925 When more than one key is provided, additional keys are used as
1365 secondary criteria when the there is equality in all keys selected
926 secondary criteria when the there is equality in all keys selected
1366 before them.
927 before them.
1367
928
1368 Abbreviations can be used for any key names, as long as the
929 Abbreviations can be used for any key names, as long as the
1369 abbreviation is unambiguous. The following are the keys currently
930 abbreviation is unambiguous. The following are the keys currently
1370 defined:
931 defined:
1371
932
1372 Valid Arg Meaning
933 Valid Arg Meaning
1373 "calls" call count
934 "calls" call count
1374 "cumulative" cumulative time
935 "cumulative" cumulative time
1375 "file" file name
936 "file" file name
1376 "module" file name
937 "module" file name
1377 "pcalls" primitive call count
938 "pcalls" primitive call count
1378 "line" line number
939 "line" line number
1379 "name" function name
940 "name" function name
1380 "nfl" name/file/line
941 "nfl" name/file/line
1381 "stdname" standard name
942 "stdname" standard name
1382 "time" internal time
943 "time" internal time
1383
944
1384 Note that all sorts on statistics are in descending order (placing
945 Note that all sorts on statistics are in descending order (placing
1385 most time consuming items first), where as name, file, and line number
946 most time consuming items first), where as name, file, and line number
1386 searches are in ascending order (i.e., alphabetical). The subtle
947 searches are in ascending order (i.e., alphabetical). The subtle
1387 distinction between "nfl" and "stdname" is that the standard name is a
948 distinction between "nfl" and "stdname" is that the standard name is a
1388 sort of the name as printed, which means that the embedded line
949 sort of the name as printed, which means that the embedded line
1389 numbers get compared in an odd way. For example, lines 3, 20, and 40
950 numbers get compared in an odd way. For example, lines 3, 20, and 40
1390 would (if the file names were the same) appear in the string order
951 would (if the file names were the same) appear in the string order
1391 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
952 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1392 line numbers. In fact, sort_stats("nfl") is the same as
953 line numbers. In fact, sort_stats("nfl") is the same as
1393 sort_stats("name", "file", "line").
954 sort_stats("name", "file", "line").
1394
955
1395 -T <filename>: save profile results as shown on screen to a text
956 -T <filename>: save profile results as shown on screen to a text
1396 file. The profile is still shown on screen.
957 file. The profile is still shown on screen.
1397
958
1398 -D <filename>: save (via dump_stats) profile statistics to given
959 -D <filename>: save (via dump_stats) profile statistics to given
1399 filename. This data is in a format understood by the pstats module, and
960 filename. This data is in a format understood by the pstats module, and
1400 is generated by a call to the dump_stats() method of profile
961 is generated by a call to the dump_stats() method of profile
1401 objects. The profile is still shown on screen.
962 objects. The profile is still shown on screen.
1402
963
1403 -q: suppress output to the pager. Best used with -T and/or -D above.
964 -q: suppress output to the pager. Best used with -T and/or -D above.
1404
965
1405 If you want to run complete programs under the profiler's control, use
966 If you want to run complete programs under the profiler's control, use
1406 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
967 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1407 contains profiler specific options as described here.
968 contains profiler specific options as described here.
1408
969
1409 You can read the complete documentation for the profile module with::
970 You can read the complete documentation for the profile module with::
1410
971
1411 In [1]: import profile; profile.help()
972 In [1]: import profile; profile.help()
1412 """
973 """
1413
974
1414 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
975 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1415
976
1416 if user_mode: # regular user call
977 if user_mode: # regular user call
1417 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
978 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
1418 list_all=1, posix=False)
979 list_all=1, posix=False)
1419 namespace = self.shell.user_ns
980 namespace = self.shell.user_ns
1420 else: # called to run a program by %run -p
981 else: # called to run a program by %run -p
1421 try:
982 try:
1422 filename = get_py_filename(arg_lst[0])
983 filename = get_py_filename(arg_lst[0])
1423 except IOError as e:
984 except IOError as e:
1424 try:
985 try:
1425 msg = str(e)
986 msg = str(e)
1426 except UnicodeError:
987 except UnicodeError:
1427 msg = e.message
988 msg = e.message
1428 error(msg)
989 error(msg)
1429 return
990 return
1430
991
1431 arg_str = 'execfile(filename,prog_ns)'
992 arg_str = 'execfile(filename,prog_ns)'
1432 namespace = {
993 namespace = {
1433 'execfile': self.shell.safe_execfile,
994 'execfile': self.shell.safe_execfile,
1434 'prog_ns': prog_ns,
995 'prog_ns': prog_ns,
1435 'filename': filename
996 'filename': filename
1436 }
997 }
1437
998
1438 opts.merge(opts_def)
999 opts.merge(opts_def)
1439
1000
1440 prof = profile.Profile()
1001 prof = profile.Profile()
1441 try:
1002 try:
1442 prof = prof.runctx(arg_str,namespace,namespace)
1003 prof = prof.runctx(arg_str,namespace,namespace)
1443 sys_exit = ''
1004 sys_exit = ''
1444 except SystemExit:
1005 except SystemExit:
1445 sys_exit = """*** SystemExit exception caught in code being profiled."""
1006 sys_exit = """*** SystemExit exception caught in code being profiled."""
1446
1007
1447 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1008 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1448
1009
1449 lims = opts.l
1010 lims = opts.l
1450 if lims:
1011 if lims:
1451 lims = [] # rebuild lims with ints/floats/strings
1012 lims = [] # rebuild lims with ints/floats/strings
1452 for lim in opts.l:
1013 for lim in opts.l:
1453 try:
1014 try:
1454 lims.append(int(lim))
1015 lims.append(int(lim))
1455 except ValueError:
1016 except ValueError:
1456 try:
1017 try:
1457 lims.append(float(lim))
1018 lims.append(float(lim))
1458 except ValueError:
1019 except ValueError:
1459 lims.append(lim)
1020 lims.append(lim)
1460
1021
1461 # Trap output.
1022 # Trap output.
1462 stdout_trap = StringIO()
1023 stdout_trap = StringIO()
1463
1024
1464 if hasattr(stats,'stream'):
1025 if hasattr(stats,'stream'):
1465 # In newer versions of python, the stats object has a 'stream'
1026 # In newer versions of python, the stats object has a 'stream'
1466 # attribute to write into.
1027 # attribute to write into.
1467 stats.stream = stdout_trap
1028 stats.stream = stdout_trap
1468 stats.print_stats(*lims)
1029 stats.print_stats(*lims)
1469 else:
1030 else:
1470 # For older versions, we manually redirect stdout during printing
1031 # For older versions, we manually redirect stdout during printing
1471 sys_stdout = sys.stdout
1032 sys_stdout = sys.stdout
1472 try:
1033 try:
1473 sys.stdout = stdout_trap
1034 sys.stdout = stdout_trap
1474 stats.print_stats(*lims)
1035 stats.print_stats(*lims)
1475 finally:
1036 finally:
1476 sys.stdout = sys_stdout
1037 sys.stdout = sys_stdout
1477
1038
1478 output = stdout_trap.getvalue()
1039 output = stdout_trap.getvalue()
1479 output = output.rstrip()
1040 output = output.rstrip()
1480
1041
1481 if 'q' not in opts:
1042 if 'q' not in opts:
1482 page.page(output)
1043 page.page(output)
1483 print sys_exit,
1044 print sys_exit,
1484
1045
1485 dump_file = opts.D[0]
1046 dump_file = opts.D[0]
1486 text_file = opts.T[0]
1047 text_file = opts.T[0]
1487 if dump_file:
1048 if dump_file:
1488 dump_file = unquote_filename(dump_file)
1049 dump_file = unquote_filename(dump_file)
1489 prof.dump_stats(dump_file)
1050 prof.dump_stats(dump_file)
1490 print '\n*** Profile stats marshalled to file',\
1051 print '\n*** Profile stats marshalled to file',\
1491 `dump_file`+'.',sys_exit
1052 `dump_file`+'.',sys_exit
1492 if text_file:
1053 if text_file:
1493 text_file = unquote_filename(text_file)
1054 text_file = unquote_filename(text_file)
1494 pfile = open(text_file,'w')
1055 pfile = open(text_file,'w')
1495 pfile.write(output)
1056 pfile.write(output)
1496 pfile.close()
1057 pfile.close()
1497 print '\n*** Profile printout saved to text file',\
1058 print '\n*** Profile printout saved to text file',\
1498 `text_file`+'.',sys_exit
1059 `text_file`+'.',sys_exit
1499
1060
1500 if opts.has_key('r'):
1061 if opts.has_key('r'):
1501 return stats
1062 return stats
1502 else:
1063 else:
1503 return None
1064 return None
1504
1065
1505 @line_magic
1066 @line_magic
1506 def pdb(self, parameter_s=''):
1067 def pdb(self, parameter_s=''):
1507 """Control the automatic calling of the pdb interactive debugger.
1068 """Control the automatic calling of the pdb interactive debugger.
1508
1069
1509 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1070 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1510 argument it works as a toggle.
1071 argument it works as a toggle.
1511
1072
1512 When an exception is triggered, IPython can optionally call the
1073 When an exception is triggered, IPython can optionally call the
1513 interactive pdb debugger after the traceback printout. %pdb toggles
1074 interactive pdb debugger after the traceback printout. %pdb toggles
1514 this feature on and off.
1075 this feature on and off.
1515
1076
1516 The initial state of this feature is set in your configuration
1077 The initial state of this feature is set in your configuration
1517 file (the option is ``InteractiveShell.pdb``).
1078 file (the option is ``InteractiveShell.pdb``).
1518
1079
1519 If you want to just activate the debugger AFTER an exception has fired,
1080 If you want to just activate the debugger AFTER an exception has fired,
1520 without having to type '%pdb on' and rerunning your code, you can use
1081 without having to type '%pdb on' and rerunning your code, you can use
1521 the %debug magic."""
1082 the %debug magic."""
1522
1083
1523 par = parameter_s.strip().lower()
1084 par = parameter_s.strip().lower()
1524
1085
1525 if par:
1086 if par:
1526 try:
1087 try:
1527 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1088 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1528 except KeyError:
1089 except KeyError:
1529 print ('Incorrect argument. Use on/1, off/0, '
1090 print ('Incorrect argument. Use on/1, off/0, '
1530 'or nothing for a toggle.')
1091 'or nothing for a toggle.')
1531 return
1092 return
1532 else:
1093 else:
1533 # toggle
1094 # toggle
1534 new_pdb = not self.shell.call_pdb
1095 new_pdb = not self.shell.call_pdb
1535
1096
1536 # set on the shell
1097 # set on the shell
1537 self.shell.call_pdb = new_pdb
1098 self.shell.call_pdb = new_pdb
1538 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1099 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1539
1100
1540 @line_magic
1101 @line_magic
1541 def debug(self, parameter_s=''):
1102 def debug(self, parameter_s=''):
1542 """Activate the interactive debugger in post-mortem mode.
1103 """Activate the interactive debugger in post-mortem mode.
1543
1104
1544 If an exception has just occurred, this lets you inspect its stack
1105 If an exception has just occurred, this lets you inspect its stack
1545 frames interactively. Note that this will always work only on the last
1106 frames interactively. Note that this will always work only on the last
1546 traceback that occurred, so you must call this quickly after an
1107 traceback that occurred, so you must call this quickly after an
1547 exception that you wish to inspect has fired, because if another one
1108 exception that you wish to inspect has fired, because if another one
1548 occurs, it clobbers the previous one.
1109 occurs, it clobbers the previous one.
1549
1110
1550 If you want IPython to automatically do this on every exception, see
1111 If you want IPython to automatically do this on every exception, see
1551 the %pdb magic for more details.
1112 the %pdb magic for more details.
1552 """
1113 """
1553 self.shell.debugger(force=True)
1114 self.shell.debugger(force=True)
1554
1115
1555 @line_magic
1116 @line_magic
1556 def tb(self, s):
1117 def tb(self, s):
1557 """Print the last traceback with the currently active exception mode.
1118 """Print the last traceback with the currently active exception mode.
1558
1119
1559 See %xmode for changing exception reporting modes."""
1120 See %xmode for changing exception reporting modes."""
1560 self.shell.showtraceback()
1121 self.shell.showtraceback()
1561
1122
1562 @skip_doctest
1123 @skip_doctest
1563 @line_magic
1124 @line_magic
1564 def run(self, parameter_s='', runner=None,
1125 def run(self, parameter_s='', runner=None,
1565 file_finder=get_py_filename):
1126 file_finder=get_py_filename):
1566 """Run the named file inside IPython as a program.
1127 """Run the named file inside IPython as a program.
1567
1128
1568 Usage:\\
1129 Usage:\\
1569 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1130 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1570
1131
1571 Parameters after the filename are passed as command-line arguments to
1132 Parameters after the filename are passed as command-line arguments to
1572 the program (put in sys.argv). Then, control returns to IPython's
1133 the program (put in sys.argv). Then, control returns to IPython's
1573 prompt.
1134 prompt.
1574
1135
1575 This is similar to running at a system prompt:\\
1136 This is similar to running at a system prompt:\\
1576 $ python file args\\
1137 $ python file args\\
1577 but with the advantage of giving you IPython's tracebacks, and of
1138 but with the advantage of giving you IPython's tracebacks, and of
1578 loading all variables into your interactive namespace for further use
1139 loading all variables into your interactive namespace for further use
1579 (unless -p is used, see below).
1140 (unless -p is used, see below).
1580
1141
1581 The file is executed in a namespace initially consisting only of
1142 The file is executed in a namespace initially consisting only of
1582 __name__=='__main__' and sys.argv constructed as indicated. It thus
1143 __name__=='__main__' and sys.argv constructed as indicated. It thus
1583 sees its environment as if it were being run as a stand-alone program
1144 sees its environment as if it were being run as a stand-alone program
1584 (except for sharing global objects such as previously imported
1145 (except for sharing global objects such as previously imported
1585 modules). But after execution, the IPython interactive namespace gets
1146 modules). But after execution, the IPython interactive namespace gets
1586 updated with all variables defined in the program (except for __name__
1147 updated with all variables defined in the program (except for __name__
1587 and sys.argv). This allows for very convenient loading of code for
1148 and sys.argv). This allows for very convenient loading of code for
1588 interactive work, while giving each program a 'clean sheet' to run in.
1149 interactive work, while giving each program a 'clean sheet' to run in.
1589
1150
1590 Options:
1151 Options:
1591
1152
1592 -n: __name__ is NOT set to '__main__', but to the running file's name
1153 -n: __name__ is NOT set to '__main__', but to the running file's name
1593 without extension (as python does under import). This allows running
1154 without extension (as python does under import). This allows running
1594 scripts and reloading the definitions in them without calling code
1155 scripts and reloading the definitions in them without calling code
1595 protected by an ' if __name__ == "__main__" ' clause.
1156 protected by an ' if __name__ == "__main__" ' clause.
1596
1157
1597 -i: run the file in IPython's namespace instead of an empty one. This
1158 -i: run the file in IPython's namespace instead of an empty one. This
1598 is useful if you are experimenting with code written in a text editor
1159 is useful if you are experimenting with code written in a text editor
1599 which depends on variables defined interactively.
1160 which depends on variables defined interactively.
1600
1161
1601 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1162 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1602 being run. This is particularly useful if IPython is being used to
1163 being run. This is particularly useful if IPython is being used to
1603 run unittests, which always exit with a sys.exit() call. In such
1164 run unittests, which always exit with a sys.exit() call. In such
1604 cases you are interested in the output of the test results, not in
1165 cases you are interested in the output of the test results, not in
1605 seeing a traceback of the unittest module.
1166 seeing a traceback of the unittest module.
1606
1167
1607 -t: print timing information at the end of the run. IPython will give
1168 -t: print timing information at the end of the run. IPython will give
1608 you an estimated CPU time consumption for your script, which under
1169 you an estimated CPU time consumption for your script, which under
1609 Unix uses the resource module to avoid the wraparound problems of
1170 Unix uses the resource module to avoid the wraparound problems of
1610 time.clock(). Under Unix, an estimate of time spent on system tasks
1171 time.clock(). Under Unix, an estimate of time spent on system tasks
1611 is also given (for Windows platforms this is reported as 0.0).
1172 is also given (for Windows platforms this is reported as 0.0).
1612
1173
1613 If -t is given, an additional -N<N> option can be given, where <N>
1174 If -t is given, an additional -N<N> option can be given, where <N>
1614 must be an integer indicating how many times you want the script to
1175 must be an integer indicating how many times you want the script to
1615 run. The final timing report will include total and per run results.
1176 run. The final timing report will include total and per run results.
1616
1177
1617 For example (testing the script uniq_stable.py)::
1178 For example (testing the script uniq_stable.py)::
1618
1179
1619 In [1]: run -t uniq_stable
1180 In [1]: run -t uniq_stable
1620
1181
1621 IPython CPU timings (estimated):\\
1182 IPython CPU timings (estimated):\\
1622 User : 0.19597 s.\\
1183 User : 0.19597 s.\\
1623 System: 0.0 s.\\
1184 System: 0.0 s.\\
1624
1185
1625 In [2]: run -t -N5 uniq_stable
1186 In [2]: run -t -N5 uniq_stable
1626
1187
1627 IPython CPU timings (estimated):\\
1188 IPython CPU timings (estimated):\\
1628 Total runs performed: 5\\
1189 Total runs performed: 5\\
1629 Times : Total Per run\\
1190 Times : Total Per run\\
1630 User : 0.910862 s, 0.1821724 s.\\
1191 User : 0.910862 s, 0.1821724 s.\\
1631 System: 0.0 s, 0.0 s.
1192 System: 0.0 s, 0.0 s.
1632
1193
1633 -d: run your program under the control of pdb, the Python debugger.
1194 -d: run your program under the control of pdb, the Python debugger.
1634 This allows you to execute your program step by step, watch variables,
1195 This allows you to execute your program step by step, watch variables,
1635 etc. Internally, what IPython does is similar to calling:
1196 etc. Internally, what IPython does is similar to calling:
1636
1197
1637 pdb.run('execfile("YOURFILENAME")')
1198 pdb.run('execfile("YOURFILENAME")')
1638
1199
1639 with a breakpoint set on line 1 of your file. You can change the line
1200 with a breakpoint set on line 1 of your file. You can change the line
1640 number for this automatic breakpoint to be <N> by using the -bN option
1201 number for this automatic breakpoint to be <N> by using the -bN option
1641 (where N must be an integer). For example::
1202 (where N must be an integer). For example::
1642
1203
1643 %run -d -b40 myscript
1204 %run -d -b40 myscript
1644
1205
1645 will set the first breakpoint at line 40 in myscript.py. Note that
1206 will set the first breakpoint at line 40 in myscript.py. Note that
1646 the first breakpoint must be set on a line which actually does
1207 the first breakpoint must be set on a line which actually does
1647 something (not a comment or docstring) for it to stop execution.
1208 something (not a comment or docstring) for it to stop execution.
1648
1209
1649 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1210 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1650 first enter 'c' (without quotes) to start execution up to the first
1211 first enter 'c' (without quotes) to start execution up to the first
1651 breakpoint.
1212 breakpoint.
1652
1213
1653 Entering 'help' gives information about the use of the debugger. You
1214 Entering 'help' gives information about the use of the debugger. You
1654 can easily see pdb's full documentation with "import pdb;pdb.help()"
1215 can easily see pdb's full documentation with "import pdb;pdb.help()"
1655 at a prompt.
1216 at a prompt.
1656
1217
1657 -p: run program under the control of the Python profiler module (which
1218 -p: run program under the control of the Python profiler module (which
1658 prints a detailed report of execution times, function calls, etc).
1219 prints a detailed report of execution times, function calls, etc).
1659
1220
1660 You can pass other options after -p which affect the behavior of the
1221 You can pass other options after -p which affect the behavior of the
1661 profiler itself. See the docs for %prun for details.
1222 profiler itself. See the docs for %prun for details.
1662
1223
1663 In this mode, the program's variables do NOT propagate back to the
1224 In this mode, the program's variables do NOT propagate back to the
1664 IPython interactive namespace (because they remain in the namespace
1225 IPython interactive namespace (because they remain in the namespace
1665 where the profiler executes them).
1226 where the profiler executes them).
1666
1227
1667 Internally this triggers a call to %prun, see its documentation for
1228 Internally this triggers a call to %prun, see its documentation for
1668 details on the options available specifically for profiling.
1229 details on the options available specifically for profiling.
1669
1230
1670 There is one special usage for which the text above doesn't apply:
1231 There is one special usage for which the text above doesn't apply:
1671 if the filename ends with .ipy, the file is run as ipython script,
1232 if the filename ends with .ipy, the file is run as ipython script,
1672 just as if the commands were written on IPython prompt.
1233 just as if the commands were written on IPython prompt.
1673
1234
1674 -m: specify module name to load instead of script path. Similar to
1235 -m: specify module name to load instead of script path. Similar to
1675 the -m option for the python interpreter. Use this option last if you
1236 the -m option for the python interpreter. Use this option last if you
1676 want to combine with other %run options. Unlike the python interpreter
1237 want to combine with other %run options. Unlike the python interpreter
1677 only source modules are allowed no .pyc or .pyo files.
1238 only source modules are allowed no .pyc or .pyo files.
1678 For example::
1239 For example::
1679
1240
1680 %run -m example
1241 %run -m example
1681
1242
1682 will run the example module.
1243 will run the example module.
1683
1244
1684 """
1245 """
1685
1246
1686 # get arguments and set sys.argv for program to be run.
1247 # get arguments and set sys.argv for program to be run.
1687 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1248 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1688 mode='list', list_all=1)
1249 mode='list', list_all=1)
1689 if "m" in opts:
1250 if "m" in opts:
1690 modulename = opts["m"][0]
1251 modulename = opts["m"][0]
1691 modpath = find_mod(modulename)
1252 modpath = find_mod(modulename)
1692 if modpath is None:
1253 if modpath is None:
1693 warn('%r is not a valid modulename on sys.path'%modulename)
1254 warn('%r is not a valid modulename on sys.path'%modulename)
1694 return
1255 return
1695 arg_lst = [modpath] + arg_lst
1256 arg_lst = [modpath] + arg_lst
1696 try:
1257 try:
1697 filename = file_finder(arg_lst[0])
1258 filename = file_finder(arg_lst[0])
1698 except IndexError:
1259 except IndexError:
1699 warn('you must provide at least a filename.')
1260 warn('you must provide at least a filename.')
1700 print '\n%run:\n', oinspect.getdoc(self.run)
1261 print '\n%run:\n', oinspect.getdoc(self.run)
1701 return
1262 return
1702 except IOError as e:
1263 except IOError as e:
1703 try:
1264 try:
1704 msg = str(e)
1265 msg = str(e)
1705 except UnicodeError:
1266 except UnicodeError:
1706 msg = e.message
1267 msg = e.message
1707 error(msg)
1268 error(msg)
1708 return
1269 return
1709
1270
1710 if filename.lower().endswith('.ipy'):
1271 if filename.lower().endswith('.ipy'):
1711 self.shell.safe_execfile_ipy(filename)
1272 self.shell.safe_execfile_ipy(filename)
1712 return
1273 return
1713
1274
1714 # Control the response to exit() calls made by the script being run
1275 # Control the response to exit() calls made by the script being run
1715 exit_ignore = 'e' in opts
1276 exit_ignore = 'e' in opts
1716
1277
1717 # Make sure that the running script gets a proper sys.argv as if it
1278 # Make sure that the running script gets a proper sys.argv as if it
1718 # were run from a system shell.
1279 # were run from a system shell.
1719 save_argv = sys.argv # save it for later restoring
1280 save_argv = sys.argv # save it for later restoring
1720
1281
1721 # simulate shell expansion on arguments, at least tilde expansion
1282 # simulate shell expansion on arguments, at least tilde expansion
1722 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1283 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1723
1284
1724 sys.argv = [filename] + args # put in the proper filename
1285 sys.argv = [filename] + args # put in the proper filename
1725 # protect sys.argv from potential unicode strings on Python 2:
1286 # protect sys.argv from potential unicode strings on Python 2:
1726 if not py3compat.PY3:
1287 if not py3compat.PY3:
1727 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1288 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1728
1289
1729 if 'i' in opts:
1290 if 'i' in opts:
1730 # Run in user's interactive namespace
1291 # Run in user's interactive namespace
1731 prog_ns = self.shell.user_ns
1292 prog_ns = self.shell.user_ns
1732 __name__save = self.shell.user_ns['__name__']
1293 __name__save = self.shell.user_ns['__name__']
1733 prog_ns['__name__'] = '__main__'
1294 prog_ns['__name__'] = '__main__'
1734 main_mod = self.shell.new_main_mod(prog_ns)
1295 main_mod = self.shell.new_main_mod(prog_ns)
1735 else:
1296 else:
1736 # Run in a fresh, empty namespace
1297 # Run in a fresh, empty namespace
1737 if 'n' in opts:
1298 if 'n' in opts:
1738 name = os.path.splitext(os.path.basename(filename))[0]
1299 name = os.path.splitext(os.path.basename(filename))[0]
1739 else:
1300 else:
1740 name = '__main__'
1301 name = '__main__'
1741
1302
1742 main_mod = self.shell.new_main_mod()
1303 main_mod = self.shell.new_main_mod()
1743 prog_ns = main_mod.__dict__
1304 prog_ns = main_mod.__dict__
1744 prog_ns['__name__'] = name
1305 prog_ns['__name__'] = name
1745
1306
1746 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1307 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1747 # set the __file__ global in the script's namespace
1308 # set the __file__ global in the script's namespace
1748 prog_ns['__file__'] = filename
1309 prog_ns['__file__'] = filename
1749
1310
1750 # pickle fix. See interactiveshell for an explanation. But we need to
1311 # pickle fix. See interactiveshell for an explanation. But we need to
1751 # make sure that, if we overwrite __main__, we replace it at the end
1312 # make sure that, if we overwrite __main__, we replace it at the end
1752 main_mod_name = prog_ns['__name__']
1313 main_mod_name = prog_ns['__name__']
1753
1314
1754 if main_mod_name == '__main__':
1315 if main_mod_name == '__main__':
1755 restore_main = sys.modules['__main__']
1316 restore_main = sys.modules['__main__']
1756 else:
1317 else:
1757 restore_main = False
1318 restore_main = False
1758
1319
1759 # This needs to be undone at the end to prevent holding references to
1320 # This needs to be undone at the end to prevent holding references to
1760 # every single object ever created.
1321 # every single object ever created.
1761 sys.modules[main_mod_name] = main_mod
1322 sys.modules[main_mod_name] = main_mod
1762
1323
1763 try:
1324 try:
1764 stats = None
1325 stats = None
1765 with self.shell.readline_no_record:
1326 with self.shell.readline_no_record:
1766 if 'p' in opts:
1327 if 'p' in opts:
1767 stats = self.prun('', 0, opts, arg_lst, prog_ns)
1328 stats = self.prun('', 0, opts, arg_lst, prog_ns)
1768 else:
1329 else:
1769 if 'd' in opts:
1330 if 'd' in opts:
1770 deb = debugger.Pdb(self.shell.colors)
1331 deb = debugger.Pdb(self.shell.colors)
1771 # reset Breakpoint state, which is moronically kept
1332 # reset Breakpoint state, which is moronically kept
1772 # in a class
1333 # in a class
1773 bdb.Breakpoint.next = 1
1334 bdb.Breakpoint.next = 1
1774 bdb.Breakpoint.bplist = {}
1335 bdb.Breakpoint.bplist = {}
1775 bdb.Breakpoint.bpbynumber = [None]
1336 bdb.Breakpoint.bpbynumber = [None]
1776 # Set an initial breakpoint to stop execution
1337 # Set an initial breakpoint to stop execution
1777 maxtries = 10
1338 maxtries = 10
1778 bp = int(opts.get('b', [1])[0])
1339 bp = int(opts.get('b', [1])[0])
1779 checkline = deb.checkline(filename, bp)
1340 checkline = deb.checkline(filename, bp)
1780 if not checkline:
1341 if not checkline:
1781 for bp in range(bp + 1, bp + maxtries + 1):
1342 for bp in range(bp + 1, bp + maxtries + 1):
1782 if deb.checkline(filename, bp):
1343 if deb.checkline(filename, bp):
1783 break
1344 break
1784 else:
1345 else:
1785 msg = ("\nI failed to find a valid line to set "
1346 msg = ("\nI failed to find a valid line to set "
1786 "a breakpoint\n"
1347 "a breakpoint\n"
1787 "after trying up to line: %s.\n"
1348 "after trying up to line: %s.\n"
1788 "Please set a valid breakpoint manually "
1349 "Please set a valid breakpoint manually "
1789 "with the -b option." % bp)
1350 "with the -b option." % bp)
1790 error(msg)
1351 error(msg)
1791 return
1352 return
1792 # if we find a good linenumber, set the breakpoint
1353 # if we find a good linenumber, set the breakpoint
1793 deb.do_break('%s:%s' % (filename, bp))
1354 deb.do_break('%s:%s' % (filename, bp))
1794 # Start file run
1355 # Start file run
1795 print "NOTE: Enter 'c' at the",
1356 print "NOTE: Enter 'c' at the",
1796 print "%s prompt to start your script." % deb.prompt
1357 print "%s prompt to start your script." % deb.prompt
1797 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1358 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1798 try:
1359 try:
1799 deb.run('execfile("%s", prog_ns)' % filename, ns)
1360 deb.run('execfile("%s", prog_ns)' % filename, ns)
1800
1361
1801 except:
1362 except:
1802 etype, value, tb = sys.exc_info()
1363 etype, value, tb = sys.exc_info()
1803 # Skip three frames in the traceback: the %run one,
1364 # Skip three frames in the traceback: the %run one,
1804 # one inside bdb.py, and the command-line typed by the
1365 # one inside bdb.py, and the command-line typed by the
1805 # user (run by exec in pdb itself).
1366 # user (run by exec in pdb itself).
1806 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1367 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1807 else:
1368 else:
1808 if runner is None:
1369 if runner is None:
1809 runner = self.default_runner
1370 runner = self.default_runner
1810 if runner is None:
1371 if runner is None:
1811 runner = self.shell.safe_execfile
1372 runner = self.shell.safe_execfile
1812 if 't' in opts:
1373 if 't' in opts:
1813 # timed execution
1374 # timed execution
1814 try:
1375 try:
1815 nruns = int(opts['N'][0])
1376 nruns = int(opts['N'][0])
1816 if nruns < 1:
1377 if nruns < 1:
1817 error('Number of runs must be >=1')
1378 error('Number of runs must be >=1')
1818 return
1379 return
1819 except (KeyError):
1380 except (KeyError):
1820 nruns = 1
1381 nruns = 1
1821 twall0 = time.time()
1382 twall0 = time.time()
1822 if nruns == 1:
1383 if nruns == 1:
1823 t0 = clock2()
1384 t0 = clock2()
1824 runner(filename, prog_ns, prog_ns,
1385 runner(filename, prog_ns, prog_ns,
1825 exit_ignore=exit_ignore)
1386 exit_ignore=exit_ignore)
1826 t1 = clock2()
1387 t1 = clock2()
1827 t_usr = t1[0] - t0[0]
1388 t_usr = t1[0] - t0[0]
1828 t_sys = t1[1] - t0[1]
1389 t_sys = t1[1] - t0[1]
1829 print "\nIPython CPU timings (estimated):"
1390 print "\nIPython CPU timings (estimated):"
1830 print " User : %10.2f s." % t_usr
1391 print " User : %10.2f s." % t_usr
1831 print " System : %10.2f s." % t_sys
1392 print " System : %10.2f s." % t_sys
1832 else:
1393 else:
1833 runs = range(nruns)
1394 runs = range(nruns)
1834 t0 = clock2()
1395 t0 = clock2()
1835 for nr in runs:
1396 for nr in runs:
1836 runner(filename, prog_ns, prog_ns,
1397 runner(filename, prog_ns, prog_ns,
1837 exit_ignore=exit_ignore)
1398 exit_ignore=exit_ignore)
1838 t1 = clock2()
1399 t1 = clock2()
1839 t_usr = t1[0] - t0[0]
1400 t_usr = t1[0] - t0[0]
1840 t_sys = t1[1] - t0[1]
1401 t_sys = t1[1] - t0[1]
1841 print "\nIPython CPU timings (estimated):"
1402 print "\nIPython CPU timings (estimated):"
1842 print "Total runs performed:", nruns
1403 print "Total runs performed:", nruns
1843 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1404 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1844 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1405 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1845 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1406 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1846 twall1 = time.time()
1407 twall1 = time.time()
1847 print "Wall time: %10.2f s." % (twall1 - twall0)
1408 print "Wall time: %10.2f s." % (twall1 - twall0)
1848
1409
1849 else:
1410 else:
1850 # regular execution
1411 # regular execution
1851 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1412 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1852
1413
1853 if 'i' in opts:
1414 if 'i' in opts:
1854 self.shell.user_ns['__name__'] = __name__save
1415 self.shell.user_ns['__name__'] = __name__save
1855 else:
1416 else:
1856 # The shell MUST hold a reference to prog_ns so after %run
1417 # The shell MUST hold a reference to prog_ns so after %run
1857 # exits, the python deletion mechanism doesn't zero it out
1418 # exits, the python deletion mechanism doesn't zero it out
1858 # (leaving dangling references).
1419 # (leaving dangling references).
1859 self.shell.cache_main_mod(prog_ns, filename)
1420 self.shell.cache_main_mod(prog_ns, filename)
1860 # update IPython interactive namespace
1421 # update IPython interactive namespace
1861
1422
1862 # Some forms of read errors on the file may mean the
1423 # Some forms of read errors on the file may mean the
1863 # __name__ key was never set; using pop we don't have to
1424 # __name__ key was never set; using pop we don't have to
1864 # worry about a possible KeyError.
1425 # worry about a possible KeyError.
1865 prog_ns.pop('__name__', None)
1426 prog_ns.pop('__name__', None)
1866
1427
1867 self.shell.user_ns.update(prog_ns)
1428 self.shell.user_ns.update(prog_ns)
1868 finally:
1429 finally:
1869 # It's a bit of a mystery why, but __builtins__ can change from
1430 # It's a bit of a mystery why, but __builtins__ can change from
1870 # being a module to becoming a dict missing some key data after
1431 # being a module to becoming a dict missing some key data after
1871 # %run. As best I can see, this is NOT something IPython is doing
1432 # %run. As best I can see, this is NOT something IPython is doing
1872 # at all, and similar problems have been reported before:
1433 # at all, and similar problems have been reported before:
1873 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1434 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1874 # Since this seems to be done by the interpreter itself, the best
1435 # Since this seems to be done by the interpreter itself, the best
1875 # we can do is to at least restore __builtins__ for the user on
1436 # we can do is to at least restore __builtins__ for the user on
1876 # exit.
1437 # exit.
1877 self.shell.user_ns['__builtins__'] = builtin_mod
1438 self.shell.user_ns['__builtins__'] = builtin_mod
1878
1439
1879 # Ensure key global structures are restored
1440 # Ensure key global structures are restored
1880 sys.argv = save_argv
1441 sys.argv = save_argv
1881 if restore_main:
1442 if restore_main:
1882 sys.modules['__main__'] = restore_main
1443 sys.modules['__main__'] = restore_main
1883 else:
1444 else:
1884 # Remove from sys.modules the reference to main_mod we'd
1445 # Remove from sys.modules the reference to main_mod we'd
1885 # added. Otherwise it will trap references to objects
1446 # added. Otherwise it will trap references to objects
1886 # contained therein.
1447 # contained therein.
1887 del sys.modules[main_mod_name]
1448 del sys.modules[main_mod_name]
1888
1449
1889 return stats
1450 return stats
1890
1451
1891 @skip_doctest
1452 @skip_doctest
1892 @line_magic
1453 @line_magic
1893 def timeit(self, parameter_s=''):
1454 def timeit(self, parameter_s=''):
1894 """Time execution of a Python statement or expression
1455 """Time execution of a Python statement or expression
1895
1456
1896 Usage:\\
1457 Usage:\\
1897 %timeit [-n<N> -r<R> [-t|-c]] statement
1458 %timeit [-n<N> -r<R> [-t|-c]] statement
1898
1459
1899 Time execution of a Python statement or expression using the timeit
1460 Time execution of a Python statement or expression using the timeit
1900 module.
1461 module.
1901
1462
1902 Options:
1463 Options:
1903 -n<N>: execute the given statement <N> times in a loop. If this value
1464 -n<N>: execute the given statement <N> times in a loop. If this value
1904 is not given, a fitting value is chosen.
1465 is not given, a fitting value is chosen.
1905
1466
1906 -r<R>: repeat the loop iteration <R> times and take the best result.
1467 -r<R>: repeat the loop iteration <R> times and take the best result.
1907 Default: 3
1468 Default: 3
1908
1469
1909 -t: use time.time to measure the time, which is the default on Unix.
1470 -t: use time.time to measure the time, which is the default on Unix.
1910 This function measures wall time.
1471 This function measures wall time.
1911
1472
1912 -c: use time.clock to measure the time, which is the default on
1473 -c: use time.clock to measure the time, which is the default on
1913 Windows and measures wall time. On Unix, resource.getrusage is used
1474 Windows and measures wall time. On Unix, resource.getrusage is used
1914 instead and returns the CPU user time.
1475 instead and returns the CPU user time.
1915
1476
1916 -p<P>: use a precision of <P> digits to display the timing result.
1477 -p<P>: use a precision of <P> digits to display the timing result.
1917 Default: 3
1478 Default: 3
1918
1479
1919
1480
1920 Examples
1481 Examples
1921 --------
1482 --------
1922 ::
1483 ::
1923
1484
1924 In [1]: %timeit pass
1485 In [1]: %timeit pass
1925 10000000 loops, best of 3: 53.3 ns per loop
1486 10000000 loops, best of 3: 53.3 ns per loop
1926
1487
1927 In [2]: u = None
1488 In [2]: u = None
1928
1489
1929 In [3]: %timeit u is None
1490 In [3]: %timeit u is None
1930 10000000 loops, best of 3: 184 ns per loop
1491 10000000 loops, best of 3: 184 ns per loop
1931
1492
1932 In [4]: %timeit -r 4 u == None
1493 In [4]: %timeit -r 4 u == None
1933 1000000 loops, best of 4: 242 ns per loop
1494 1000000 loops, best of 4: 242 ns per loop
1934
1495
1935 In [5]: import time
1496 In [5]: import time
1936
1497
1937 In [6]: %timeit -n1 time.sleep(2)
1498 In [6]: %timeit -n1 time.sleep(2)
1938 1 loops, best of 3: 2 s per loop
1499 1 loops, best of 3: 2 s per loop
1939
1500
1940
1501
1941 The times reported by %timeit will be slightly higher than those
1502 The times reported by %timeit will be slightly higher than those
1942 reported by the timeit.py script when variables are accessed. This is
1503 reported by the timeit.py script when variables are accessed. This is
1943 due to the fact that %timeit executes the statement in the namespace
1504 due to the fact that %timeit executes the statement in the namespace
1944 of the shell, compared with timeit.py, which uses a single setup
1505 of the shell, compared with timeit.py, which uses a single setup
1945 statement to import function or create variables. Generally, the bias
1506 statement to import function or create variables. Generally, the bias
1946 does not matter as long as results from timeit.py are not mixed with
1507 does not matter as long as results from timeit.py are not mixed with
1947 those from %timeit."""
1508 those from %timeit."""
1948
1509
1949 import timeit
1510 import timeit
1950 import math
1511 import math
1951
1512
1952 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1513 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1953 # certain terminals. Until we figure out a robust way of
1514 # certain terminals. Until we figure out a robust way of
1954 # auto-detecting if the terminal can deal with it, use plain 'us' for
1515 # auto-detecting if the terminal can deal with it, use plain 'us' for
1955 # microseconds. I am really NOT happy about disabling the proper
1516 # microseconds. I am really NOT happy about disabling the proper
1956 # 'micro' prefix, but crashing is worse... If anyone knows what the
1517 # 'micro' prefix, but crashing is worse... If anyone knows what the
1957 # right solution for this is, I'm all ears...
1518 # right solution for this is, I'm all ears...
1958 #
1519 #
1959 # Note: using
1520 # Note: using
1960 #
1521 #
1961 # s = u'\xb5'
1522 # s = u'\xb5'
1962 # s.encode(sys.getdefaultencoding())
1523 # s.encode(sys.getdefaultencoding())
1963 #
1524 #
1964 # is not sufficient, as I've seen terminals where that fails but
1525 # is not sufficient, as I've seen terminals where that fails but
1965 # print s
1526 # print s
1966 #
1527 #
1967 # succeeds
1528 # succeeds
1968 #
1529 #
1969 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1530 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1970
1531
1971 #units = [u"s", u"ms",u'\xb5',"ns"]
1532 #units = [u"s", u"ms",u'\xb5',"ns"]
1972 units = [u"s", u"ms",u'us',"ns"]
1533 units = [u"s", u"ms",u'us',"ns"]
1973
1534
1974 scaling = [1, 1e3, 1e6, 1e9]
1535 scaling = [1, 1e3, 1e6, 1e9]
1975
1536
1976 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1537 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1977 posix=False, strict=False)
1538 posix=False, strict=False)
1978 if stmt == "":
1539 if stmt == "":
1979 return
1540 return
1980 timefunc = timeit.default_timer
1541 timefunc = timeit.default_timer
1981 number = int(getattr(opts, "n", 0))
1542 number = int(getattr(opts, "n", 0))
1982 repeat = int(getattr(opts, "r", timeit.default_repeat))
1543 repeat = int(getattr(opts, "r", timeit.default_repeat))
1983 precision = int(getattr(opts, "p", 3))
1544 precision = int(getattr(opts, "p", 3))
1984 if hasattr(opts, "t"):
1545 if hasattr(opts, "t"):
1985 timefunc = time.time
1546 timefunc = time.time
1986 if hasattr(opts, "c"):
1547 if hasattr(opts, "c"):
1987 timefunc = clock
1548 timefunc = clock
1988
1549
1989 timer = timeit.Timer(timer=timefunc)
1550 timer = timeit.Timer(timer=timefunc)
1990 # this code has tight coupling to the inner workings of timeit.Timer,
1551 # this code has tight coupling to the inner workings of timeit.Timer,
1991 # but is there a better way to achieve that the code stmt has access
1552 # but is there a better way to achieve that the code stmt has access
1992 # to the shell namespace?
1553 # to the shell namespace?
1993
1554
1994 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1555 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1995 'setup': "pass"}
1556 'setup': "pass"}
1996 # Track compilation time so it can be reported if too long
1557 # Track compilation time so it can be reported if too long
1997 # Minimum time above which compilation time will be reported
1558 # Minimum time above which compilation time will be reported
1998 tc_min = 0.1
1559 tc_min = 0.1
1999
1560
2000 t0 = clock()
1561 t0 = clock()
2001 code = compile(src, "<magic-timeit>", "exec")
1562 code = compile(src, "<magic-timeit>", "exec")
2002 tc = clock()-t0
1563 tc = clock()-t0
2003
1564
2004 ns = {}
1565 ns = {}
2005 exec code in self.shell.user_ns, ns
1566 exec code in self.shell.user_ns, ns
2006 timer.inner = ns["inner"]
1567 timer.inner = ns["inner"]
2007
1568
2008 if number == 0:
1569 if number == 0:
2009 # determine number so that 0.2 <= total time < 2.0
1570 # determine number so that 0.2 <= total time < 2.0
2010 number = 1
1571 number = 1
2011 for i in range(1, 10):
1572 for i in range(1, 10):
2012 if timer.timeit(number) >= 0.2:
1573 if timer.timeit(number) >= 0.2:
2013 break
1574 break
2014 number *= 10
1575 number *= 10
2015
1576
2016 best = min(timer.repeat(repeat, number)) / number
1577 best = min(timer.repeat(repeat, number)) / number
2017
1578
2018 if best > 0.0 and best < 1000.0:
1579 if best > 0.0 and best < 1000.0:
2019 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1580 order = min(-int(math.floor(math.log10(best)) // 3), 3)
2020 elif best >= 1000.0:
1581 elif best >= 1000.0:
2021 order = 0
1582 order = 0
2022 else:
1583 else:
2023 order = 3
1584 order = 3
2024 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1585 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
2025 precision,
1586 precision,
2026 best * scaling[order],
1587 best * scaling[order],
2027 units[order])
1588 units[order])
2028 if tc > tc_min:
1589 if tc > tc_min:
2029 print "Compiler time: %.2f s" % tc
1590 print "Compiler time: %.2f s" % tc
2030
1591
2031 @skip_doctest
1592 @skip_doctest
2032 @needs_local_scope
1593 @needs_local_scope
2033 @line_magic
1594 @line_magic
2034 def time(self,parameter_s, user_locals):
1595 def time(self,parameter_s, user_locals):
2035 """Time execution of a Python statement or expression.
1596 """Time execution of a Python statement or expression.
2036
1597
2037 The CPU and wall clock times are printed, and the value of the
1598 The CPU and wall clock times are printed, and the value of the
2038 expression (if any) is returned. Note that under Win32, system time
1599 expression (if any) is returned. Note that under Win32, system time
2039 is always reported as 0, since it can not be measured.
1600 is always reported as 0, since it can not be measured.
2040
1601
2041 This function provides very basic timing functionality. In Python
1602 This function provides very basic timing functionality. In Python
2042 2.3, the timeit module offers more control and sophistication, so this
1603 2.3, the timeit module offers more control and sophistication, so this
2043 could be rewritten to use it (patches welcome).
1604 could be rewritten to use it (patches welcome).
2044
1605
2045 Examples
1606 Examples
2046 --------
1607 --------
2047 ::
1608 ::
2048
1609
2049 In [1]: time 2**128
1610 In [1]: time 2**128
2050 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1611 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2051 Wall time: 0.00
1612 Wall time: 0.00
2052 Out[1]: 340282366920938463463374607431768211456L
1613 Out[1]: 340282366920938463463374607431768211456L
2053
1614
2054 In [2]: n = 1000000
1615 In [2]: n = 1000000
2055
1616
2056 In [3]: time sum(range(n))
1617 In [3]: time sum(range(n))
2057 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1618 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2058 Wall time: 1.37
1619 Wall time: 1.37
2059 Out[3]: 499999500000L
1620 Out[3]: 499999500000L
2060
1621
2061 In [4]: time print 'hello world'
1622 In [4]: time print 'hello world'
2062 hello world
1623 hello world
2063 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1624 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2064 Wall time: 0.00
1625 Wall time: 0.00
2065
1626
2066 Note that the time needed by Python to compile the given expression
1627 Note that the time needed by Python to compile the given expression
2067 will be reported if it is more than 0.1s. In this example, the
1628 will be reported if it is more than 0.1s. In this example, the
2068 actual exponentiation is done by Python at compilation time, so while
1629 actual exponentiation is done by Python at compilation time, so while
2069 the expression can take a noticeable amount of time to compute, that
1630 the expression can take a noticeable amount of time to compute, that
2070 time is purely due to the compilation:
1631 time is purely due to the compilation:
2071
1632
2072 In [5]: time 3**9999;
1633 In [5]: time 3**9999;
2073 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1634 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2074 Wall time: 0.00 s
1635 Wall time: 0.00 s
2075
1636
2076 In [6]: time 3**999999;
1637 In [6]: time 3**999999;
2077 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1638 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2078 Wall time: 0.00 s
1639 Wall time: 0.00 s
2079 Compiler : 0.78 s
1640 Compiler : 0.78 s
2080 """
1641 """
2081
1642
2082 # fail immediately if the given expression can't be compiled
1643 # fail immediately if the given expression can't be compiled
2083
1644
2084 expr = self.shell.prefilter(parameter_s,False)
1645 expr = self.shell.prefilter(parameter_s,False)
2085
1646
2086 # Minimum time above which compilation time will be reported
1647 # Minimum time above which compilation time will be reported
2087 tc_min = 0.1
1648 tc_min = 0.1
2088
1649
2089 try:
1650 try:
2090 mode = 'eval'
1651 mode = 'eval'
2091 t0 = clock()
1652 t0 = clock()
2092 code = compile(expr,'<timed eval>',mode)
1653 code = compile(expr,'<timed eval>',mode)
2093 tc = clock()-t0
1654 tc = clock()-t0
2094 except SyntaxError:
1655 except SyntaxError:
2095 mode = 'exec'
1656 mode = 'exec'
2096 t0 = clock()
1657 t0 = clock()
2097 code = compile(expr,'<timed exec>',mode)
1658 code = compile(expr,'<timed exec>',mode)
2098 tc = clock()-t0
1659 tc = clock()-t0
2099 # skew measurement as little as possible
1660 # skew measurement as little as possible
2100 glob = self.shell.user_ns
1661 glob = self.shell.user_ns
2101 wtime = time.time
1662 wtime = time.time
2102 # time execution
1663 # time execution
2103 wall_st = wtime()
1664 wall_st = wtime()
2104 if mode=='eval':
1665 if mode=='eval':
2105 st = clock2()
1666 st = clock2()
2106 out = eval(code, glob, user_locals)
1667 out = eval(code, glob, user_locals)
2107 end = clock2()
1668 end = clock2()
2108 else:
1669 else:
2109 st = clock2()
1670 st = clock2()
2110 exec code in glob, user_locals
1671 exec code in glob, user_locals
2111 end = clock2()
1672 end = clock2()
2112 out = None
1673 out = None
2113 wall_end = wtime()
1674 wall_end = wtime()
2114 # Compute actual times and report
1675 # Compute actual times and report
2115 wall_time = wall_end-wall_st
1676 wall_time = wall_end-wall_st
2116 cpu_user = end[0]-st[0]
1677 cpu_user = end[0]-st[0]
2117 cpu_sys = end[1]-st[1]
1678 cpu_sys = end[1]-st[1]
2118 cpu_tot = cpu_user+cpu_sys
1679 cpu_tot = cpu_user+cpu_sys
2119 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1680 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2120 (cpu_user,cpu_sys,cpu_tot)
1681 (cpu_user,cpu_sys,cpu_tot)
2121 print "Wall time: %.2f s" % wall_time
1682 print "Wall time: %.2f s" % wall_time
2122 if tc > tc_min:
1683 if tc > tc_min:
2123 print "Compiler : %.2f s" % tc
1684 print "Compiler : %.2f s" % tc
2124 return out
1685 return out
2125
1686
2126 @skip_doctest
1687 @skip_doctest
2127 @line_magic
1688 @line_magic
2128 def macro(self, parameter_s=''):
1689 def macro(self, parameter_s=''):
2129 """Define a macro for future re-execution. It accepts ranges of history,
1690 """Define a macro for future re-execution. It accepts ranges of history,
2130 filenames or string objects.
1691 filenames or string objects.
2131
1692
2132 Usage:\\
1693 Usage:\\
2133 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1694 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2134
1695
2135 Options:
1696 Options:
2136
1697
2137 -r: use 'raw' input. By default, the 'processed' history is used,
1698 -r: use 'raw' input. By default, the 'processed' history is used,
2138 so that magics are loaded in their transformed version to valid
1699 so that magics are loaded in their transformed version to valid
2139 Python. If this option is given, the raw input as typed as the
1700 Python. If this option is given, the raw input as typed as the
2140 command line is used instead.
1701 command line is used instead.
2141
1702
2142 This will define a global variable called `name` which is a string
1703 This will define a global variable called `name` which is a string
2143 made of joining the slices and lines you specify (n1,n2,... numbers
1704 made of joining the slices and lines you specify (n1,n2,... numbers
2144 above) from your input history into a single string. This variable
1705 above) from your input history into a single string. This variable
2145 acts like an automatic function which re-executes those lines as if
1706 acts like an automatic function which re-executes those lines as if
2146 you had typed them. You just type 'name' at the prompt and the code
1707 you had typed them. You just type 'name' at the prompt and the code
2147 executes.
1708 executes.
2148
1709
2149 The syntax for indicating input ranges is described in %history.
1710 The syntax for indicating input ranges is described in %history.
2150
1711
2151 Note: as a 'hidden' feature, you can also use traditional python slice
1712 Note: as a 'hidden' feature, you can also use traditional python slice
2152 notation, where N:M means numbers N through M-1.
1713 notation, where N:M means numbers N through M-1.
2153
1714
2154 For example, if your history contains (%hist prints it)::
1715 For example, if your history contains (%hist prints it)::
2155
1716
2156 44: x=1
1717 44: x=1
2157 45: y=3
1718 45: y=3
2158 46: z=x+y
1719 46: z=x+y
2159 47: print x
1720 47: print x
2160 48: a=5
1721 48: a=5
2161 49: print 'x',x,'y',y
1722 49: print 'x',x,'y',y
2162
1723
2163 you can create a macro with lines 44 through 47 (included) and line 49
1724 you can create a macro with lines 44 through 47 (included) and line 49
2164 called my_macro with::
1725 called my_macro with::
2165
1726
2166 In [55]: %macro my_macro 44-47 49
1727 In [55]: %macro my_macro 44-47 49
2167
1728
2168 Now, typing `my_macro` (without quotes) will re-execute all this code
1729 Now, typing `my_macro` (without quotes) will re-execute all this code
2169 in one pass.
1730 in one pass.
2170
1731
2171 You don't need to give the line-numbers in order, and any given line
1732 You don't need to give the line-numbers in order, and any given line
2172 number can appear multiple times. You can assemble macros with any
1733 number can appear multiple times. You can assemble macros with any
2173 lines from your input history in any order.
1734 lines from your input history in any order.
2174
1735
2175 The macro is a simple object which holds its value in an attribute,
1736 The macro is a simple object which holds its value in an attribute,
2176 but IPython's display system checks for macros and executes them as
1737 but IPython's display system checks for macros and executes them as
2177 code instead of printing them when you type their name.
1738 code instead of printing them when you type their name.
2178
1739
2179 You can view a macro's contents by explicitly printing it with::
1740 You can view a macro's contents by explicitly printing it with::
2180
1741
2181 print macro_name
1742 print macro_name
2182
1743
2183 """
1744 """
2184 opts,args = self.parse_options(parameter_s,'r',mode='list')
1745 opts,args = self.parse_options(parameter_s,'r',mode='list')
2185 if not args: # List existing macros
1746 if not args: # List existing macros
2186 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
1747 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2187 isinstance(v, Macro))
1748 isinstance(v, Macro))
2188 if len(args) == 1:
1749 if len(args) == 1:
2189 raise UsageError(
1750 raise UsageError(
2190 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
1751 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2191 name, codefrom = args[0], " ".join(args[1:])
1752 name, codefrom = args[0], " ".join(args[1:])
2192
1753
2193 #print 'rng',ranges # dbg
1754 #print 'rng',ranges # dbg
2194 try:
1755 try:
2195 lines = self.shell.find_user_code(codefrom, 'r' in opts)
1756 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2196 except (ValueError, TypeError) as e:
1757 except (ValueError, TypeError) as e:
2197 print e.args[0]
1758 print e.args[0]
2198 return
1759 return
2199 macro = Macro(lines)
1760 macro = Macro(lines)
2200 self.shell.define_macro(name, macro)
1761 self.shell.define_macro(name, macro)
2201 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
1762 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2202 print '=== Macro contents: ==='
1763 print '=== Macro contents: ==='
2203 print macro,
1764 print macro,
2204
1765
2205
1766
2206 @register_magics
1767 @register_magics
2207 class AutoMagics(Magics):
1768 class AutoMagics(Magics):
2208 """Magics that control various autoX behaviors."""
1769 """Magics that control various autoX behaviors."""
2209
1770
2210 def __init__(self, shell):
1771 def __init__(self, shell):
2211 super(AutoMagics, self).__init__(shell)
1772 super(AutoMagics, self).__init__(shell)
2212 # namespace for holding state we may need
1773 # namespace for holding state we may need
2213 self._magic_state = Bunch()
1774 self._magic_state = Bunch()
2214
1775
2215 @line_magic
1776 @line_magic
2216 def automagic(self, parameter_s=''):
1777 def automagic(self, parameter_s=''):
2217 """Make magic functions callable without having to type the initial %.
1778 """Make magic functions callable without having to type the initial %.
2218
1779
2219 Without argumentsl toggles on/off (when off, you must call it as
1780 Without argumentsl toggles on/off (when off, you must call it as
2220 %automagic, of course). With arguments it sets the value, and you can
1781 %automagic, of course). With arguments it sets the value, and you can
2221 use any of (case insensitive):
1782 use any of (case insensitive):
2222
1783
2223 - on, 1, True: to activate
1784 - on, 1, True: to activate
2224
1785
2225 - off, 0, False: to deactivate.
1786 - off, 0, False: to deactivate.
2226
1787
2227 Note that magic functions have lowest priority, so if there's a
1788 Note that magic functions have lowest priority, so if there's a
2228 variable whose name collides with that of a magic fn, automagic won't
1789 variable whose name collides with that of a magic fn, automagic won't
2229 work for that function (you get the variable instead). However, if you
1790 work for that function (you get the variable instead). However, if you
2230 delete the variable (del var), the previously shadowed magic function
1791 delete the variable (del var), the previously shadowed magic function
2231 becomes visible to automagic again."""
1792 becomes visible to automagic again."""
2232
1793
2233 arg = parameter_s.lower()
1794 arg = parameter_s.lower()
2234 mman = self.shell.magics_manager
1795 mman = self.shell.magics_manager
2235 if arg in ('on', '1', 'true'):
1796 if arg in ('on', '1', 'true'):
2236 val = True
1797 val = True
2237 elif arg in ('off', '0', 'false'):
1798 elif arg in ('off', '0', 'false'):
2238 val = False
1799 val = False
2239 else:
1800 else:
2240 val = not mman.auto_magic
1801 val = not mman.auto_magic
2241 mman.auto_magic = val
1802 mman.auto_magic = val
2242 print '\n' + self.shell.magics_manager.auto_status()
1803 print '\n' + self.shell.magics_manager.auto_status()
2243
1804
2244 @skip_doctest
1805 @skip_doctest
2245 @line_magic
1806 @line_magic
2246 def autocall(self, parameter_s=''):
1807 def autocall(self, parameter_s=''):
2247 """Make functions callable without having to type parentheses.
1808 """Make functions callable without having to type parentheses.
2248
1809
2249 Usage:
1810 Usage:
2250
1811
2251 %autocall [mode]
1812 %autocall [mode]
2252
1813
2253 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
1814 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
2254 value is toggled on and off (remembering the previous state).
1815 value is toggled on and off (remembering the previous state).
2255
1816
2256 In more detail, these values mean:
1817 In more detail, these values mean:
2257
1818
2258 0 -> fully disabled
1819 0 -> fully disabled
2259
1820
2260 1 -> active, but do not apply if there are no arguments on the line.
1821 1 -> active, but do not apply if there are no arguments on the line.
2261
1822
2262 In this mode, you get::
1823 In this mode, you get::
2263
1824
2264 In [1]: callable
1825 In [1]: callable
2265 Out[1]: <built-in function callable>
1826 Out[1]: <built-in function callable>
2266
1827
2267 In [2]: callable 'hello'
1828 In [2]: callable 'hello'
2268 ------> callable('hello')
1829 ------> callable('hello')
2269 Out[2]: False
1830 Out[2]: False
2270
1831
2271 2 -> Active always. Even if no arguments are present, the callable
1832 2 -> Active always. Even if no arguments are present, the callable
2272 object is called::
1833 object is called::
2273
1834
2274 In [2]: float
1835 In [2]: float
2275 ------> float()
1836 ------> float()
2276 Out[2]: 0.0
1837 Out[2]: 0.0
2277
1838
2278 Note that even with autocall off, you can still use '/' at the start of
1839 Note that even with autocall off, you can still use '/' at the start of
2279 a line to treat the first argument on the command line as a function
1840 a line to treat the first argument on the command line as a function
2280 and add parentheses to it::
1841 and add parentheses to it::
2281
1842
2282 In [8]: /str 43
1843 In [8]: /str 43
2283 ------> str(43)
1844 ------> str(43)
2284 Out[8]: '43'
1845 Out[8]: '43'
2285
1846
2286 # all-random (note for auto-testing)
1847 # all-random (note for auto-testing)
2287 """
1848 """
2288
1849
2289 if parameter_s:
1850 if parameter_s:
2290 arg = int(parameter_s)
1851 arg = int(parameter_s)
2291 else:
1852 else:
2292 arg = 'toggle'
1853 arg = 'toggle'
2293
1854
2294 if not arg in (0, 1, 2,'toggle'):
1855 if not arg in (0, 1, 2,'toggle'):
2295 error('Valid modes: (0->Off, 1->Smart, 2->Full')
1856 error('Valid modes: (0->Off, 1->Smart, 2->Full')
2296 return
1857 return
2297
1858
2298 if arg in (0, 1, 2):
1859 if arg in (0, 1, 2):
2299 self.shell.autocall = arg
1860 self.shell.autocall = arg
2300 else: # toggle
1861 else: # toggle
2301 if self.shell.autocall:
1862 if self.shell.autocall:
2302 self._magic_state.autocall_save = self.shell.autocall
1863 self._magic_state.autocall_save = self.shell.autocall
2303 self.shell.autocall = 0
1864 self.shell.autocall = 0
2304 else:
1865 else:
2305 try:
1866 try:
2306 self.shell.autocall = self._magic_state.autocall_save
1867 self.shell.autocall = self._magic_state.autocall_save
2307 except AttributeError:
1868 except AttributeError:
2308 self.shell.autocall = self._magic_state.autocall_save = 1
1869 self.shell.autocall = self._magic_state.autocall_save = 1
2309
1870
2310 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
1871 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
2311
1872
2312
1873
2313 @register_magics
1874 @register_magics
2314 class OSMagics(Magics):
1875 class OSMagics(Magics):
2315 """Magics to interact with the underlying OS (shell-type functionality).
1876 """Magics to interact with the underlying OS (shell-type functionality).
2316 """
1877 """
2317
1878
2318 @skip_doctest
1879 @skip_doctest
2319 @line_magic
1880 @line_magic
2320 def alias(self, parameter_s=''):
1881 def alias(self, parameter_s=''):
2321 """Define an alias for a system command.
1882 """Define an alias for a system command.
2322
1883
2323 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
1884 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2324
1885
2325 Then, typing 'alias_name params' will execute the system command 'cmd
1886 Then, typing 'alias_name params' will execute the system command 'cmd
2326 params' (from your underlying operating system).
1887 params' (from your underlying operating system).
2327
1888
2328 Aliases have lower precedence than magic functions and Python normal
1889 Aliases have lower precedence than magic functions and Python normal
2329 variables, so if 'foo' is both a Python variable and an alias, the
1890 variables, so if 'foo' is both a Python variable and an alias, the
2330 alias can not be executed until 'del foo' removes the Python variable.
1891 alias can not be executed until 'del foo' removes the Python variable.
2331
1892
2332 You can use the %l specifier in an alias definition to represent the
1893 You can use the %l specifier in an alias definition to represent the
2333 whole line when the alias is called. For example::
1894 whole line when the alias is called. For example::
2334
1895
2335 In [2]: alias bracket echo "Input in brackets: <%l>"
1896 In [2]: alias bracket echo "Input in brackets: <%l>"
2336 In [3]: bracket hello world
1897 In [3]: bracket hello world
2337 Input in brackets: <hello world>
1898 Input in brackets: <hello world>
2338
1899
2339 You can also define aliases with parameters using %s specifiers (one
1900 You can also define aliases with parameters using %s specifiers (one
2340 per parameter)::
1901 per parameter)::
2341
1902
2342 In [1]: alias parts echo first %s second %s
1903 In [1]: alias parts echo first %s second %s
2343 In [2]: %parts A B
1904 In [2]: %parts A B
2344 first A second B
1905 first A second B
2345 In [3]: %parts A
1906 In [3]: %parts A
2346 Incorrect number of arguments: 2 expected.
1907 Incorrect number of arguments: 2 expected.
2347 parts is an alias to: 'echo first %s second %s'
1908 parts is an alias to: 'echo first %s second %s'
2348
1909
2349 Note that %l and %s are mutually exclusive. You can only use one or
1910 Note that %l and %s are mutually exclusive. You can only use one or
2350 the other in your aliases.
1911 the other in your aliases.
2351
1912
2352 Aliases expand Python variables just like system calls using ! or !!
1913 Aliases expand Python variables just like system calls using ! or !!
2353 do: all expressions prefixed with '$' get expanded. For details of
1914 do: all expressions prefixed with '$' get expanded. For details of
2354 the semantic rules, see PEP-215:
1915 the semantic rules, see PEP-215:
2355 http://www.python.org/peps/pep-0215.html. This is the library used by
1916 http://www.python.org/peps/pep-0215.html. This is the library used by
2356 IPython for variable expansion. If you want to access a true shell
1917 IPython for variable expansion. If you want to access a true shell
2357 variable, an extra $ is necessary to prevent its expansion by
1918 variable, an extra $ is necessary to prevent its expansion by
2358 IPython::
1919 IPython::
2359
1920
2360 In [6]: alias show echo
1921 In [6]: alias show echo
2361 In [7]: PATH='A Python string'
1922 In [7]: PATH='A Python string'
2362 In [8]: show $PATH
1923 In [8]: show $PATH
2363 A Python string
1924 A Python string
2364 In [9]: show $$PATH
1925 In [9]: show $$PATH
2365 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
1926 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2366
1927
2367 You can use the alias facility to acess all of $PATH. See the %rehash
1928 You can use the alias facility to acess all of $PATH. See the %rehash
2368 and %rehashx functions, which automatically create aliases for the
1929 and %rehashx functions, which automatically create aliases for the
2369 contents of your $PATH.
1930 contents of your $PATH.
2370
1931
2371 If called with no parameters, %alias prints the current alias table."""
1932 If called with no parameters, %alias prints the current alias table."""
2372
1933
2373 par = parameter_s.strip()
1934 par = parameter_s.strip()
2374 if not par:
1935 if not par:
2375 aliases = sorted(self.shell.alias_manager.aliases)
1936 aliases = sorted(self.shell.alias_manager.aliases)
2376 # stored = self.shell.db.get('stored_aliases', {} )
1937 # stored = self.shell.db.get('stored_aliases', {} )
2377 # for k, v in stored:
1938 # for k, v in stored:
2378 # atab.append(k, v[0])
1939 # atab.append(k, v[0])
2379
1940
2380 print "Total number of aliases:", len(aliases)
1941 print "Total number of aliases:", len(aliases)
2381 sys.stdout.flush()
1942 sys.stdout.flush()
2382 return aliases
1943 return aliases
2383
1944
2384 # Now try to define a new one
1945 # Now try to define a new one
2385 try:
1946 try:
2386 alias,cmd = par.split(None, 1)
1947 alias,cmd = par.split(None, 1)
2387 except:
1948 except:
2388 print oinspect.getdoc(self.alias)
1949 print oinspect.getdoc(self.alias)
2389 else:
1950 else:
2390 self.shell.alias_manager.soft_define_alias(alias, cmd)
1951 self.shell.alias_manager.soft_define_alias(alias, cmd)
2391 # end magic_alias
1952 # end magic_alias
2392
1953
2393 @line_magic
1954 @line_magic
2394 def unalias(self, parameter_s=''):
1955 def unalias(self, parameter_s=''):
2395 """Remove an alias"""
1956 """Remove an alias"""
2396
1957
2397 aname = parameter_s.strip()
1958 aname = parameter_s.strip()
2398 self.shell.alias_manager.undefine_alias(aname)
1959 self.shell.alias_manager.undefine_alias(aname)
2399 stored = self.shell.db.get('stored_aliases', {} )
1960 stored = self.shell.db.get('stored_aliases', {} )
2400 if aname in stored:
1961 if aname in stored:
2401 print "Removing %stored alias",aname
1962 print "Removing %stored alias",aname
2402 del stored[aname]
1963 del stored[aname]
2403 self.shell.db['stored_aliases'] = stored
1964 self.shell.db['stored_aliases'] = stored
2404
1965
2405 @line_magic
1966 @line_magic
2406 def rehashx(self, parameter_s=''):
1967 def rehashx(self, parameter_s=''):
2407 """Update the alias table with all executable files in $PATH.
1968 """Update the alias table with all executable files in $PATH.
2408
1969
2409 This version explicitly checks that every entry in $PATH is a file
1970 This version explicitly checks that every entry in $PATH is a file
2410 with execute access (os.X_OK), so it is much slower than %rehash.
1971 with execute access (os.X_OK), so it is much slower than %rehash.
2411
1972
2412 Under Windows, it checks executability as a match against a
1973 Under Windows, it checks executability as a match against a
2413 '|'-separated string of extensions, stored in the IPython config
1974 '|'-separated string of extensions, stored in the IPython config
2414 variable win_exec_ext. This defaults to 'exe|com|bat'.
1975 variable win_exec_ext. This defaults to 'exe|com|bat'.
2415
1976
2416 This function also resets the root module cache of module completer,
1977 This function also resets the root module cache of module completer,
2417 used on slow filesystems.
1978 used on slow filesystems.
2418 """
1979 """
2419 from IPython.core.alias import InvalidAliasError
1980 from IPython.core.alias import InvalidAliasError
2420
1981
2421 # for the benefit of module completer in ipy_completers.py
1982 # for the benefit of module completer in ipy_completers.py
2422 del self.shell.db['rootmodules']
1983 del self.shell.db['rootmodules']
2423
1984
2424 path = [os.path.abspath(os.path.expanduser(p)) for p in
1985 path = [os.path.abspath(os.path.expanduser(p)) for p in
2425 os.environ.get('PATH','').split(os.pathsep)]
1986 os.environ.get('PATH','').split(os.pathsep)]
2426 path = filter(os.path.isdir,path)
1987 path = filter(os.path.isdir,path)
2427
1988
2428 syscmdlist = []
1989 syscmdlist = []
2429 # Now define isexec in a cross platform manner.
1990 # Now define isexec in a cross platform manner.
2430 if os.name == 'posix':
1991 if os.name == 'posix':
2431 isexec = lambda fname:os.path.isfile(fname) and \
1992 isexec = lambda fname:os.path.isfile(fname) and \
2432 os.access(fname,os.X_OK)
1993 os.access(fname,os.X_OK)
2433 else:
1994 else:
2434 try:
1995 try:
2435 winext = os.environ['pathext'].replace(';','|').replace('.','')
1996 winext = os.environ['pathext'].replace(';','|').replace('.','')
2436 except KeyError:
1997 except KeyError:
2437 winext = 'exe|com|bat|py'
1998 winext = 'exe|com|bat|py'
2438 if 'py' not in winext:
1999 if 'py' not in winext:
2439 winext += '|py'
2000 winext += '|py'
2440 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2001 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2441 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2002 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2442 savedir = os.getcwdu()
2003 savedir = os.getcwdu()
2443
2004
2444 # Now walk the paths looking for executables to alias.
2005 # Now walk the paths looking for executables to alias.
2445 try:
2006 try:
2446 # write the whole loop for posix/Windows so we don't have an if in
2007 # write the whole loop for posix/Windows so we don't have an if in
2447 # the innermost part
2008 # the innermost part
2448 if os.name == 'posix':
2009 if os.name == 'posix':
2449 for pdir in path:
2010 for pdir in path:
2450 os.chdir(pdir)
2011 os.chdir(pdir)
2451 for ff in os.listdir(pdir):
2012 for ff in os.listdir(pdir):
2452 if isexec(ff):
2013 if isexec(ff):
2453 try:
2014 try:
2454 # Removes dots from the name since ipython
2015 # Removes dots from the name since ipython
2455 # will assume names with dots to be python.
2016 # will assume names with dots to be python.
2456 self.shell.alias_manager.define_alias(
2017 self.shell.alias_manager.define_alias(
2457 ff.replace('.',''), ff)
2018 ff.replace('.',''), ff)
2458 except InvalidAliasError:
2019 except InvalidAliasError:
2459 pass
2020 pass
2460 else:
2021 else:
2461 syscmdlist.append(ff)
2022 syscmdlist.append(ff)
2462 else:
2023 else:
2463 no_alias = self.shell.alias_manager.no_alias
2024 no_alias = self.shell.alias_manager.no_alias
2464 for pdir in path:
2025 for pdir in path:
2465 os.chdir(pdir)
2026 os.chdir(pdir)
2466 for ff in os.listdir(pdir):
2027 for ff in os.listdir(pdir):
2467 base, ext = os.path.splitext(ff)
2028 base, ext = os.path.splitext(ff)
2468 if isexec(ff) and base.lower() not in no_alias:
2029 if isexec(ff) and base.lower() not in no_alias:
2469 if ext.lower() == '.exe':
2030 if ext.lower() == '.exe':
2470 ff = base
2031 ff = base
2471 try:
2032 try:
2472 # Removes dots from the name since ipython
2033 # Removes dots from the name since ipython
2473 # will assume names with dots to be python.
2034 # will assume names with dots to be python.
2474 self.shell.alias_manager.define_alias(
2035 self.shell.alias_manager.define_alias(
2475 base.lower().replace('.',''), ff)
2036 base.lower().replace('.',''), ff)
2476 except InvalidAliasError:
2037 except InvalidAliasError:
2477 pass
2038 pass
2478 syscmdlist.append(ff)
2039 syscmdlist.append(ff)
2479 self.shell.db['syscmdlist'] = syscmdlist
2040 self.shell.db['syscmdlist'] = syscmdlist
2480 finally:
2041 finally:
2481 os.chdir(savedir)
2042 os.chdir(savedir)
2482
2043
2483 @skip_doctest
2044 @skip_doctest
2484 @line_magic
2045 @line_magic
2485 def pwd(self, parameter_s=''):
2046 def pwd(self, parameter_s=''):
2486 """Return the current working directory path.
2047 """Return the current working directory path.
2487
2048
2488 Examples
2049 Examples
2489 --------
2050 --------
2490 ::
2051 ::
2491
2052
2492 In [9]: pwd
2053 In [9]: pwd
2493 Out[9]: '/home/tsuser/sprint/ipython'
2054 Out[9]: '/home/tsuser/sprint/ipython'
2494 """
2055 """
2495 return os.getcwdu()
2056 return os.getcwdu()
2496
2057
2497 @skip_doctest
2058 @skip_doctest
2498 @line_magic
2059 @line_magic
2499 def cd(self, parameter_s=''):
2060 def cd(self, parameter_s=''):
2500 """Change the current working directory.
2061 """Change the current working directory.
2501
2062
2502 This command automatically maintains an internal list of directories
2063 This command automatically maintains an internal list of directories
2503 you visit during your IPython session, in the variable _dh. The
2064 you visit during your IPython session, in the variable _dh. The
2504 command %dhist shows this history nicely formatted. You can also
2065 command %dhist shows this history nicely formatted. You can also
2505 do 'cd -<tab>' to see directory history conveniently.
2066 do 'cd -<tab>' to see directory history conveniently.
2506
2067
2507 Usage:
2068 Usage:
2508
2069
2509 cd 'dir': changes to directory 'dir'.
2070 cd 'dir': changes to directory 'dir'.
2510
2071
2511 cd -: changes to the last visited directory.
2072 cd -: changes to the last visited directory.
2512
2073
2513 cd -<n>: changes to the n-th directory in the directory history.
2074 cd -<n>: changes to the n-th directory in the directory history.
2514
2075
2515 cd --foo: change to directory that matches 'foo' in history
2076 cd --foo: change to directory that matches 'foo' in history
2516
2077
2517 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2078 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2518 (note: cd <bookmark_name> is enough if there is no
2079 (note: cd <bookmark_name> is enough if there is no
2519 directory <bookmark_name>, but a bookmark with the name exists.)
2080 directory <bookmark_name>, but a bookmark with the name exists.)
2520 'cd -b <tab>' allows you to tab-complete bookmark names.
2081 'cd -b <tab>' allows you to tab-complete bookmark names.
2521
2082
2522 Options:
2083 Options:
2523
2084
2524 -q: quiet. Do not print the working directory after the cd command is
2085 -q: quiet. Do not print the working directory after the cd command is
2525 executed. By default IPython's cd command does print this directory,
2086 executed. By default IPython's cd command does print this directory,
2526 since the default prompts do not display path information.
2087 since the default prompts do not display path information.
2527
2088
2528 Note that !cd doesn't work for this purpose because the shell where
2089 Note that !cd doesn't work for this purpose because the shell where
2529 !command runs is immediately discarded after executing 'command'.
2090 !command runs is immediately discarded after executing 'command'.
2530
2091
2531 Examples
2092 Examples
2532 --------
2093 --------
2533 ::
2094 ::
2534
2095
2535 In [10]: cd parent/child
2096 In [10]: cd parent/child
2536 /home/tsuser/parent/child
2097 /home/tsuser/parent/child
2537 """
2098 """
2538
2099
2539 #bkms = self.shell.persist.get("bookmarks",{})
2100 #bkms = self.shell.persist.get("bookmarks",{})
2540
2101
2541 oldcwd = os.getcwdu()
2102 oldcwd = os.getcwdu()
2542 numcd = re.match(r'(-)(\d+)$',parameter_s)
2103 numcd = re.match(r'(-)(\d+)$',parameter_s)
2543 # jump in directory history by number
2104 # jump in directory history by number
2544 if numcd:
2105 if numcd:
2545 nn = int(numcd.group(2))
2106 nn = int(numcd.group(2))
2546 try:
2107 try:
2547 ps = self.shell.user_ns['_dh'][nn]
2108 ps = self.shell.user_ns['_dh'][nn]
2548 except IndexError:
2109 except IndexError:
2549 print 'The requested directory does not exist in history.'
2110 print 'The requested directory does not exist in history.'
2550 return
2111 return
2551 else:
2112 else:
2552 opts = {}
2113 opts = {}
2553 elif parameter_s.startswith('--'):
2114 elif parameter_s.startswith('--'):
2554 ps = None
2115 ps = None
2555 fallback = None
2116 fallback = None
2556 pat = parameter_s[2:]
2117 pat = parameter_s[2:]
2557 dh = self.shell.user_ns['_dh']
2118 dh = self.shell.user_ns['_dh']
2558 # first search only by basename (last component)
2119 # first search only by basename (last component)
2559 for ent in reversed(dh):
2120 for ent in reversed(dh):
2560 if pat in os.path.basename(ent) and os.path.isdir(ent):
2121 if pat in os.path.basename(ent) and os.path.isdir(ent):
2561 ps = ent
2122 ps = ent
2562 break
2123 break
2563
2124
2564 if fallback is None and pat in ent and os.path.isdir(ent):
2125 if fallback is None and pat in ent and os.path.isdir(ent):
2565 fallback = ent
2126 fallback = ent
2566
2127
2567 # if we have no last part match, pick the first full path match
2128 # if we have no last part match, pick the first full path match
2568 if ps is None:
2129 if ps is None:
2569 ps = fallback
2130 ps = fallback
2570
2131
2571 if ps is None:
2132 if ps is None:
2572 print "No matching entry in directory history"
2133 print "No matching entry in directory history"
2573 return
2134 return
2574 else:
2135 else:
2575 opts = {}
2136 opts = {}
2576
2137
2577
2138
2578 else:
2139 else:
2579 #turn all non-space-escaping backslashes to slashes,
2140 #turn all non-space-escaping backslashes to slashes,
2580 # for c:\windows\directory\names\
2141 # for c:\windows\directory\names\
2581 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2142 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2582 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2143 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2583 # jump to previous
2144 # jump to previous
2584 if ps == '-':
2145 if ps == '-':
2585 try:
2146 try:
2586 ps = self.shell.user_ns['_dh'][-2]
2147 ps = self.shell.user_ns['_dh'][-2]
2587 except IndexError:
2148 except IndexError:
2588 raise UsageError('%cd -: No previous directory to change to.')
2149 raise UsageError('%cd -: No previous directory to change to.')
2589 # jump to bookmark if needed
2150 # jump to bookmark if needed
2590 else:
2151 else:
2591 if not os.path.isdir(ps) or opts.has_key('b'):
2152 if not os.path.isdir(ps) or opts.has_key('b'):
2592 bkms = self.shell.db.get('bookmarks', {})
2153 bkms = self.shell.db.get('bookmarks', {})
2593
2154
2594 if bkms.has_key(ps):
2155 if bkms.has_key(ps):
2595 target = bkms[ps]
2156 target = bkms[ps]
2596 print '(bookmark:%s) -> %s' % (ps,target)
2157 print '(bookmark:%s) -> %s' % (ps,target)
2597 ps = target
2158 ps = target
2598 else:
2159 else:
2599 if opts.has_key('b'):
2160 if opts.has_key('b'):
2600 raise UsageError("Bookmark '%s' not found. "
2161 raise UsageError("Bookmark '%s' not found. "
2601 "Use '%%bookmark -l' to see your bookmarks." % ps)
2162 "Use '%%bookmark -l' to see your bookmarks." % ps)
2602
2163
2603 # strip extra quotes on Windows, because os.chdir doesn't like them
2164 # strip extra quotes on Windows, because os.chdir doesn't like them
2604 ps = unquote_filename(ps)
2165 ps = unquote_filename(ps)
2605 # at this point ps should point to the target dir
2166 # at this point ps should point to the target dir
2606 if ps:
2167 if ps:
2607 try:
2168 try:
2608 os.chdir(os.path.expanduser(ps))
2169 os.chdir(os.path.expanduser(ps))
2609 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2170 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2610 set_term_title('IPython: ' + abbrev_cwd())
2171 set_term_title('IPython: ' + abbrev_cwd())
2611 except OSError:
2172 except OSError:
2612 print sys.exc_info()[1]
2173 print sys.exc_info()[1]
2613 else:
2174 else:
2614 cwd = os.getcwdu()
2175 cwd = os.getcwdu()
2615 dhist = self.shell.user_ns['_dh']
2176 dhist = self.shell.user_ns['_dh']
2616 if oldcwd != cwd:
2177 if oldcwd != cwd:
2617 dhist.append(cwd)
2178 dhist.append(cwd)
2618 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
2179 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
2619
2180
2620 else:
2181 else:
2621 os.chdir(self.shell.home_dir)
2182 os.chdir(self.shell.home_dir)
2622 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2183 if hasattr(self.shell, 'term_title') and self.shell.term_title:
2623 set_term_title('IPython: ' + '~')
2184 set_term_title('IPython: ' + '~')
2624 cwd = os.getcwdu()
2185 cwd = os.getcwdu()
2625 dhist = self.shell.user_ns['_dh']
2186 dhist = self.shell.user_ns['_dh']
2626
2187
2627 if oldcwd != cwd:
2188 if oldcwd != cwd:
2628 dhist.append(cwd)
2189 dhist.append(cwd)
2629 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
2190 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
2630 if not 'q' in opts and self.shell.user_ns['_dh']:
2191 if not 'q' in opts and self.shell.user_ns['_dh']:
2631 print self.shell.user_ns['_dh'][-1]
2192 print self.shell.user_ns['_dh'][-1]
2632
2193
2633
2194
2634 @line_magic
2195 @line_magic
2635 def env(self, parameter_s=''):
2196 def env(self, parameter_s=''):
2636 """List environment variables."""
2197 """List environment variables."""
2637
2198
2638 return dict(os.environ)
2199 return dict(os.environ)
2639
2200
2640 @line_magic
2201 @line_magic
2641 def pushd(self, parameter_s=''):
2202 def pushd(self, parameter_s=''):
2642 """Place the current dir on stack and change directory.
2203 """Place the current dir on stack and change directory.
2643
2204
2644 Usage:\\
2205 Usage:\\
2645 %pushd ['dirname']
2206 %pushd ['dirname']
2646 """
2207 """
2647
2208
2648 dir_s = self.shell.dir_stack
2209 dir_s = self.shell.dir_stack
2649 tgt = os.path.expanduser(unquote_filename(parameter_s))
2210 tgt = os.path.expanduser(unquote_filename(parameter_s))
2650 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
2211 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
2651 if tgt:
2212 if tgt:
2652 self.cd(parameter_s)
2213 self.cd(parameter_s)
2653 dir_s.insert(0,cwd)
2214 dir_s.insert(0,cwd)
2654 return self.shell.magic('dirs')
2215 return self.shell.magic('dirs')
2655
2216
2656 @line_magic
2217 @line_magic
2657 def popd(self, parameter_s=''):
2218 def popd(self, parameter_s=''):
2658 """Change to directory popped off the top of the stack.
2219 """Change to directory popped off the top of the stack.
2659 """
2220 """
2660 if not self.shell.dir_stack:
2221 if not self.shell.dir_stack:
2661 raise UsageError("%popd on empty stack")
2222 raise UsageError("%popd on empty stack")
2662 top = self.shell.dir_stack.pop(0)
2223 top = self.shell.dir_stack.pop(0)
2663 self.cd(top)
2224 self.cd(top)
2664 print "popd ->",top
2225 print "popd ->",top
2665
2226
2666 @line_magic
2227 @line_magic
2667 def dirs(self, parameter_s=''):
2228 def dirs(self, parameter_s=''):
2668 """Return the current directory stack."""
2229 """Return the current directory stack."""
2669
2230
2670 return self.shell.dir_stack
2231 return self.shell.dir_stack
2671
2232
2672 @line_magic
2233 @line_magic
2673 def dhist(self, parameter_s=''):
2234 def dhist(self, parameter_s=''):
2674 """Print your history of visited directories.
2235 """Print your history of visited directories.
2675
2236
2676 %dhist -> print full history\\
2237 %dhist -> print full history\\
2677 %dhist n -> print last n entries only\\
2238 %dhist n -> print last n entries only\\
2678 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2239 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2679
2240
2680 This history is automatically maintained by the %cd command, and
2241 This history is automatically maintained by the %cd command, and
2681 always available as the global list variable _dh. You can use %cd -<n>
2242 always available as the global list variable _dh. You can use %cd -<n>
2682 to go to directory number <n>.
2243 to go to directory number <n>.
2683
2244
2684 Note that most of time, you should view directory history by entering
2245 Note that most of time, you should view directory history by entering
2685 cd -<TAB>.
2246 cd -<TAB>.
2686
2247
2687 """
2248 """
2688
2249
2689 dh = self.shell.user_ns['_dh']
2250 dh = self.shell.user_ns['_dh']
2690 if parameter_s:
2251 if parameter_s:
2691 try:
2252 try:
2692 args = map(int,parameter_s.split())
2253 args = map(int,parameter_s.split())
2693 except:
2254 except:
2694 self.arg_err(self.dhist)
2255 self.arg_err(self.dhist)
2695 return
2256 return
2696 if len(args) == 1:
2257 if len(args) == 1:
2697 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2258 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2698 elif len(args) == 2:
2259 elif len(args) == 2:
2699 ini,fin = args
2260 ini,fin = args
2700 else:
2261 else:
2701 self.arg_err(self.dhist)
2262 self.arg_err(self.dhist)
2702 return
2263 return
2703 else:
2264 else:
2704 ini,fin = 0,len(dh)
2265 ini,fin = 0,len(dh)
2705 nlprint(dh,
2266 nlprint(dh,
2706 header = 'Directory history (kept in _dh)',
2267 header = 'Directory history (kept in _dh)',
2707 start=ini,stop=fin)
2268 start=ini,stop=fin)
2708
2269
2709 @skip_doctest
2270 @skip_doctest
2710 @line_magic
2271 @line_magic
2711 def sc(self, parameter_s=''):
2272 def sc(self, parameter_s=''):
2712 """Shell capture - execute a shell command and capture its output.
2273 """Shell capture - execute a shell command and capture its output.
2713
2274
2714 DEPRECATED. Suboptimal, retained for backwards compatibility.
2275 DEPRECATED. Suboptimal, retained for backwards compatibility.
2715
2276
2716 You should use the form 'var = !command' instead. Example:
2277 You should use the form 'var = !command' instead. Example:
2717
2278
2718 "%sc -l myfiles = ls ~" should now be written as
2279 "%sc -l myfiles = ls ~" should now be written as
2719
2280
2720 "myfiles = !ls ~"
2281 "myfiles = !ls ~"
2721
2282
2722 myfiles.s, myfiles.l and myfiles.n still apply as documented
2283 myfiles.s, myfiles.l and myfiles.n still apply as documented
2723 below.
2284 below.
2724
2285
2725 --
2286 --
2726 %sc [options] varname=command
2287 %sc [options] varname=command
2727
2288
2728 IPython will run the given command using commands.getoutput(), and
2289 IPython will run the given command using commands.getoutput(), and
2729 will then update the user's interactive namespace with a variable
2290 will then update the user's interactive namespace with a variable
2730 called varname, containing the value of the call. Your command can
2291 called varname, containing the value of the call. Your command can
2731 contain shell wildcards, pipes, etc.
2292 contain shell wildcards, pipes, etc.
2732
2293
2733 The '=' sign in the syntax is mandatory, and the variable name you
2294 The '=' sign in the syntax is mandatory, and the variable name you
2734 supply must follow Python's standard conventions for valid names.
2295 supply must follow Python's standard conventions for valid names.
2735
2296
2736 (A special format without variable name exists for internal use)
2297 (A special format without variable name exists for internal use)
2737
2298
2738 Options:
2299 Options:
2739
2300
2740 -l: list output. Split the output on newlines into a list before
2301 -l: list output. Split the output on newlines into a list before
2741 assigning it to the given variable. By default the output is stored
2302 assigning it to the given variable. By default the output is stored
2742 as a single string.
2303 as a single string.
2743
2304
2744 -v: verbose. Print the contents of the variable.
2305 -v: verbose. Print the contents of the variable.
2745
2306
2746 In most cases you should not need to split as a list, because the
2307 In most cases you should not need to split as a list, because the
2747 returned value is a special type of string which can automatically
2308 returned value is a special type of string which can automatically
2748 provide its contents either as a list (split on newlines) or as a
2309 provide its contents either as a list (split on newlines) or as a
2749 space-separated string. These are convenient, respectively, either
2310 space-separated string. These are convenient, respectively, either
2750 for sequential processing or to be passed to a shell command.
2311 for sequential processing or to be passed to a shell command.
2751
2312
2752 For example::
2313 For example::
2753
2314
2754 # Capture into variable a
2315 # Capture into variable a
2755 In [1]: sc a=ls *py
2316 In [1]: sc a=ls *py
2756
2317
2757 # a is a string with embedded newlines
2318 # a is a string with embedded newlines
2758 In [2]: a
2319 In [2]: a
2759 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2320 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2760
2321
2761 # which can be seen as a list:
2322 # which can be seen as a list:
2762 In [3]: a.l
2323 In [3]: a.l
2763 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2324 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2764
2325
2765 # or as a whitespace-separated string:
2326 # or as a whitespace-separated string:
2766 In [4]: a.s
2327 In [4]: a.s
2767 Out[4]: 'setup.py win32_manual_post_install.py'
2328 Out[4]: 'setup.py win32_manual_post_install.py'
2768
2329
2769 # a.s is useful to pass as a single command line:
2330 # a.s is useful to pass as a single command line:
2770 In [5]: !wc -l $a.s
2331 In [5]: !wc -l $a.s
2771 146 setup.py
2332 146 setup.py
2772 130 win32_manual_post_install.py
2333 130 win32_manual_post_install.py
2773 276 total
2334 276 total
2774
2335
2775 # while the list form is useful to loop over:
2336 # while the list form is useful to loop over:
2776 In [6]: for f in a.l:
2337 In [6]: for f in a.l:
2777 ...: !wc -l $f
2338 ...: !wc -l $f
2778 ...:
2339 ...:
2779 146 setup.py
2340 146 setup.py
2780 130 win32_manual_post_install.py
2341 130 win32_manual_post_install.py
2781
2342
2782 Similarly, the lists returned by the -l option are also special, in
2343 Similarly, the lists returned by the -l option are also special, in
2783 the sense that you can equally invoke the .s attribute on them to
2344 the sense that you can equally invoke the .s attribute on them to
2784 automatically get a whitespace-separated string from their contents::
2345 automatically get a whitespace-separated string from their contents::
2785
2346
2786 In [7]: sc -l b=ls *py
2347 In [7]: sc -l b=ls *py
2787
2348
2788 In [8]: b
2349 In [8]: b
2789 Out[8]: ['setup.py', 'win32_manual_post_install.py']
2350 Out[8]: ['setup.py', 'win32_manual_post_install.py']
2790
2351
2791 In [9]: b.s
2352 In [9]: b.s
2792 Out[9]: 'setup.py win32_manual_post_install.py'
2353 Out[9]: 'setup.py win32_manual_post_install.py'
2793
2354
2794 In summary, both the lists and strings used for output capture have
2355 In summary, both the lists and strings used for output capture have
2795 the following special attributes::
2356 the following special attributes::
2796
2357
2797 .l (or .list) : value as list.
2358 .l (or .list) : value as list.
2798 .n (or .nlstr): value as newline-separated string.
2359 .n (or .nlstr): value as newline-separated string.
2799 .s (or .spstr): value as space-separated string.
2360 .s (or .spstr): value as space-separated string.
2800 """
2361 """
2801
2362
2802 opts,args = self.parse_options(parameter_s,'lv')
2363 opts,args = self.parse_options(parameter_s,'lv')
2803 # Try to get a variable name and command to run
2364 # Try to get a variable name and command to run
2804 try:
2365 try:
2805 # the variable name must be obtained from the parse_options
2366 # the variable name must be obtained from the parse_options
2806 # output, which uses shlex.split to strip options out.
2367 # output, which uses shlex.split to strip options out.
2807 var,_ = args.split('=',1)
2368 var,_ = args.split('=',1)
2808 var = var.strip()
2369 var = var.strip()
2809 # But the command has to be extracted from the original input
2370 # But the command has to be extracted from the original input
2810 # parameter_s, not on what parse_options returns, to avoid the
2371 # parameter_s, not on what parse_options returns, to avoid the
2811 # quote stripping which shlex.split performs on it.
2372 # quote stripping which shlex.split performs on it.
2812 _,cmd = parameter_s.split('=',1)
2373 _,cmd = parameter_s.split('=',1)
2813 except ValueError:
2374 except ValueError:
2814 var,cmd = '',''
2375 var,cmd = '',''
2815 # If all looks ok, proceed
2376 # If all looks ok, proceed
2816 split = 'l' in opts
2377 split = 'l' in opts
2817 out = self.shell.getoutput(cmd, split=split)
2378 out = self.shell.getoutput(cmd, split=split)
2818 if opts.has_key('v'):
2379 if opts.has_key('v'):
2819 print '%s ==\n%s' % (var,pformat(out))
2380 print '%s ==\n%s' % (var,pformat(out))
2820 if var:
2381 if var:
2821 self.shell.user_ns.update({var:out})
2382 self.shell.user_ns.update({var:out})
2822 else:
2383 else:
2823 return out
2384 return out
2824
2385
2825 @line_magic
2386 @line_magic
2826 def sx(self, parameter_s=''):
2387 def sx(self, parameter_s=''):
2827 """Shell execute - run a shell command and capture its output.
2388 """Shell execute - run a shell command and capture its output.
2828
2389
2829 %sx command
2390 %sx command
2830
2391
2831 IPython will run the given command using commands.getoutput(), and
2392 IPython will run the given command using commands.getoutput(), and
2832 return the result formatted as a list (split on '\\n'). Since the
2393 return the result formatted as a list (split on '\\n'). Since the
2833 output is _returned_, it will be stored in ipython's regular output
2394 output is _returned_, it will be stored in ipython's regular output
2834 cache Out[N] and in the '_N' automatic variables.
2395 cache Out[N] and in the '_N' automatic variables.
2835
2396
2836 Notes:
2397 Notes:
2837
2398
2838 1) If an input line begins with '!!', then %sx is automatically
2399 1) If an input line begins with '!!', then %sx is automatically
2839 invoked. That is, while::
2400 invoked. That is, while::
2840
2401
2841 !ls
2402 !ls
2842
2403
2843 causes ipython to simply issue system('ls'), typing::
2404 causes ipython to simply issue system('ls'), typing::
2844
2405
2845 !!ls
2406 !!ls
2846
2407
2847 is a shorthand equivalent to::
2408 is a shorthand equivalent to::
2848
2409
2849 %sx ls
2410 %sx ls
2850
2411
2851 2) %sx differs from %sc in that %sx automatically splits into a list,
2412 2) %sx differs from %sc in that %sx automatically splits into a list,
2852 like '%sc -l'. The reason for this is to make it as easy as possible
2413 like '%sc -l'. The reason for this is to make it as easy as possible
2853 to process line-oriented shell output via further python commands.
2414 to process line-oriented shell output via further python commands.
2854 %sc is meant to provide much finer control, but requires more
2415 %sc is meant to provide much finer control, but requires more
2855 typing.
2416 typing.
2856
2417
2857 3) Just like %sc -l, this is a list with special attributes:
2418 3) Just like %sc -l, this is a list with special attributes:
2858 ::
2419 ::
2859
2420
2860 .l (or .list) : value as list.
2421 .l (or .list) : value as list.
2861 .n (or .nlstr): value as newline-separated string.
2422 .n (or .nlstr): value as newline-separated string.
2862 .s (or .spstr): value as whitespace-separated string.
2423 .s (or .spstr): value as whitespace-separated string.
2863
2424
2864 This is very useful when trying to use such lists as arguments to
2425 This is very useful when trying to use such lists as arguments to
2865 system commands."""
2426 system commands."""
2866
2427
2867 if parameter_s:
2428 if parameter_s:
2868 return self.shell.getoutput(parameter_s)
2429 return self.shell.getoutput(parameter_s)
2869
2430
2870
2431
2871 @line_magic
2432 @line_magic
2872 def bookmark(self, parameter_s=''):
2433 def bookmark(self, parameter_s=''):
2873 """Manage IPython's bookmark system.
2434 """Manage IPython's bookmark system.
2874
2435
2875 %bookmark <name> - set bookmark to current dir
2436 %bookmark <name> - set bookmark to current dir
2876 %bookmark <name> <dir> - set bookmark to <dir>
2437 %bookmark <name> <dir> - set bookmark to <dir>
2877 %bookmark -l - list all bookmarks
2438 %bookmark -l - list all bookmarks
2878 %bookmark -d <name> - remove bookmark
2439 %bookmark -d <name> - remove bookmark
2879 %bookmark -r - remove all bookmarks
2440 %bookmark -r - remove all bookmarks
2880
2441
2881 You can later on access a bookmarked folder with::
2442 You can later on access a bookmarked folder with::
2882
2443
2883 %cd -b <name>
2444 %cd -b <name>
2884
2445
2885 or simply '%cd <name>' if there is no directory called <name> AND
2446 or simply '%cd <name>' if there is no directory called <name> AND
2886 there is such a bookmark defined.
2447 there is such a bookmark defined.
2887
2448
2888 Your bookmarks persist through IPython sessions, but they are
2449 Your bookmarks persist through IPython sessions, but they are
2889 associated with each profile."""
2450 associated with each profile."""
2890
2451
2891 opts,args = self.parse_options(parameter_s,'drl',mode='list')
2452 opts,args = self.parse_options(parameter_s,'drl',mode='list')
2892 if len(args) > 2:
2453 if len(args) > 2:
2893 raise UsageError("%bookmark: too many arguments")
2454 raise UsageError("%bookmark: too many arguments")
2894
2455
2895 bkms = self.shell.db.get('bookmarks',{})
2456 bkms = self.shell.db.get('bookmarks',{})
2896
2457
2897 if opts.has_key('d'):
2458 if opts.has_key('d'):
2898 try:
2459 try:
2899 todel = args[0]
2460 todel = args[0]
2900 except IndexError:
2461 except IndexError:
2901 raise UsageError(
2462 raise UsageError(
2902 "%bookmark -d: must provide a bookmark to delete")
2463 "%bookmark -d: must provide a bookmark to delete")
2903 else:
2464 else:
2904 try:
2465 try:
2905 del bkms[todel]
2466 del bkms[todel]
2906 except KeyError:
2467 except KeyError:
2907 raise UsageError(
2468 raise UsageError(
2908 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
2469 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
2909
2470
2910 elif opts.has_key('r'):
2471 elif opts.has_key('r'):
2911 bkms = {}
2472 bkms = {}
2912 elif opts.has_key('l'):
2473 elif opts.has_key('l'):
2913 bks = bkms.keys()
2474 bks = bkms.keys()
2914 bks.sort()
2475 bks.sort()
2915 if bks:
2476 if bks:
2916 size = max(map(len,bks))
2477 size = max(map(len,bks))
2917 else:
2478 else:
2918 size = 0
2479 size = 0
2919 fmt = '%-'+str(size)+'s -> %s'
2480 fmt = '%-'+str(size)+'s -> %s'
2920 print 'Current bookmarks:'
2481 print 'Current bookmarks:'
2921 for bk in bks:
2482 for bk in bks:
2922 print fmt % (bk,bkms[bk])
2483 print fmt % (bk,bkms[bk])
2923 else:
2484 else:
2924 if not args:
2485 if not args:
2925 raise UsageError("%bookmark: You must specify the bookmark name")
2486 raise UsageError("%bookmark: You must specify the bookmark name")
2926 elif len(args)==1:
2487 elif len(args)==1:
2927 bkms[args[0]] = os.getcwdu()
2488 bkms[args[0]] = os.getcwdu()
2928 elif len(args)==2:
2489 elif len(args)==2:
2929 bkms[args[0]] = args[1]
2490 bkms[args[0]] = args[1]
2930 self.shell.db['bookmarks'] = bkms
2491 self.shell.db['bookmarks'] = bkms
2931
2492
2932 @line_magic
2493 @line_magic
2933 def pycat(self, parameter_s=''):
2494 def pycat(self, parameter_s=''):
2934 """Show a syntax-highlighted file through a pager.
2495 """Show a syntax-highlighted file through a pager.
2935
2496
2936 This magic is similar to the cat utility, but it will assume the file
2497 This magic is similar to the cat utility, but it will assume the file
2937 to be Python source and will show it with syntax highlighting. """
2498 to be Python source and will show it with syntax highlighting. """
2938
2499
2939 try:
2500 try:
2940 filename = get_py_filename(parameter_s)
2501 filename = get_py_filename(parameter_s)
2941 cont = file_read(filename)
2502 cont = file_read(filename)
2942 except IOError:
2503 except IOError:
2943 try:
2504 try:
2944 cont = eval(parameter_s, self.shell.user_ns)
2505 cont = eval(parameter_s, self.shell.user_ns)
2945 except NameError:
2506 except NameError:
2946 cont = None
2507 cont = None
2947 if cont is None:
2508 if cont is None:
2948 print "Error: no such file or variable"
2509 print "Error: no such file or variable"
2949 return
2510 return
2950
2511
2951 page.page(self.shell.pycolorize(cont))
2512 page.page(self.shell.pycolorize(cont))
2952
2513
2953
2514
2954 @register_magics
2515 @register_magics
2955 class LoggingMagics(Magics):
2516 class LoggingMagics(Magics):
2956 """Magics related to all logging machinery."""
2517 """Magics related to all logging machinery."""
2957
2518
2958 @line_magic
2519 @line_magic
2959 def logstart(self, parameter_s=''):
2520 def logstart(self, parameter_s=''):
2960 """Start logging anywhere in a session.
2521 """Start logging anywhere in a session.
2961
2522
2962 %logstart [-o|-r|-t] [log_name [log_mode]]
2523 %logstart [-o|-r|-t] [log_name [log_mode]]
2963
2524
2964 If no name is given, it defaults to a file named 'ipython_log.py' in your
2525 If no name is given, it defaults to a file named 'ipython_log.py' in your
2965 current directory, in 'rotate' mode (see below).
2526 current directory, in 'rotate' mode (see below).
2966
2527
2967 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
2528 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
2968 history up to that point and then continues logging.
2529 history up to that point and then continues logging.
2969
2530
2970 %logstart takes a second optional parameter: logging mode. This can be one
2531 %logstart takes a second optional parameter: logging mode. This can be one
2971 of (note that the modes are given unquoted):\\
2532 of (note that the modes are given unquoted):\\
2972 append: well, that says it.\\
2533 append: well, that says it.\\
2973 backup: rename (if exists) to name~ and start name.\\
2534 backup: rename (if exists) to name~ and start name.\\
2974 global: single logfile in your home dir, appended to.\\
2535 global: single logfile in your home dir, appended to.\\
2975 over : overwrite existing log.\\
2536 over : overwrite existing log.\\
2976 rotate: create rotating logs name.1~, name.2~, etc.
2537 rotate: create rotating logs name.1~, name.2~, etc.
2977
2538
2978 Options:
2539 Options:
2979
2540
2980 -o: log also IPython's output. In this mode, all commands which
2541 -o: log also IPython's output. In this mode, all commands which
2981 generate an Out[NN] prompt are recorded to the logfile, right after
2542 generate an Out[NN] prompt are recorded to the logfile, right after
2982 their corresponding input line. The output lines are always
2543 their corresponding input line. The output lines are always
2983 prepended with a '#[Out]# ' marker, so that the log remains valid
2544 prepended with a '#[Out]# ' marker, so that the log remains valid
2984 Python code.
2545 Python code.
2985
2546
2986 Since this marker is always the same, filtering only the output from
2547 Since this marker is always the same, filtering only the output from
2987 a log is very easy, using for example a simple awk call::
2548 a log is very easy, using for example a simple awk call::
2988
2549
2989 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
2550 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
2990
2551
2991 -r: log 'raw' input. Normally, IPython's logs contain the processed
2552 -r: log 'raw' input. Normally, IPython's logs contain the processed
2992 input, so that user lines are logged in their final form, converted
2553 input, so that user lines are logged in their final form, converted
2993 into valid Python. For example, %Exit is logged as
2554 into valid Python. For example, %Exit is logged as
2994 _ip.magic("Exit"). If the -r flag is given, all input is logged
2555 _ip.magic("Exit"). If the -r flag is given, all input is logged
2995 exactly as typed, with no transformations applied.
2556 exactly as typed, with no transformations applied.
2996
2557
2997 -t: put timestamps before each input line logged (these are put in
2558 -t: put timestamps before each input line logged (these are put in
2998 comments)."""
2559 comments)."""
2999
2560
3000 opts,par = self.parse_options(parameter_s,'ort')
2561 opts,par = self.parse_options(parameter_s,'ort')
3001 log_output = 'o' in opts
2562 log_output = 'o' in opts
3002 log_raw_input = 'r' in opts
2563 log_raw_input = 'r' in opts
3003 timestamp = 't' in opts
2564 timestamp = 't' in opts
3004
2565
3005 logger = self.shell.logger
2566 logger = self.shell.logger
3006
2567
3007 # if no args are given, the defaults set in the logger constructor by
2568 # if no args are given, the defaults set in the logger constructor by
3008 # ipython remain valid
2569 # ipython remain valid
3009 if par:
2570 if par:
3010 try:
2571 try:
3011 logfname,logmode = par.split()
2572 logfname,logmode = par.split()
3012 except:
2573 except:
3013 logfname = par
2574 logfname = par
3014 logmode = 'backup'
2575 logmode = 'backup'
3015 else:
2576 else:
3016 logfname = logger.logfname
2577 logfname = logger.logfname
3017 logmode = logger.logmode
2578 logmode = logger.logmode
3018 # put logfname into rc struct as if it had been called on the command
2579 # put logfname into rc struct as if it had been called on the command
3019 # line, so it ends up saved in the log header Save it in case we need
2580 # line, so it ends up saved in the log header Save it in case we need
3020 # to restore it...
2581 # to restore it...
3021 old_logfile = self.shell.logfile
2582 old_logfile = self.shell.logfile
3022 if logfname:
2583 if logfname:
3023 logfname = os.path.expanduser(logfname)
2584 logfname = os.path.expanduser(logfname)
3024 self.shell.logfile = logfname
2585 self.shell.logfile = logfname
3025
2586
3026 loghead = '# IPython log file\n\n'
2587 loghead = '# IPython log file\n\n'
3027 try:
2588 try:
3028 logger.logstart(logfname, loghead, logmode, log_output, timestamp,
2589 logger.logstart(logfname, loghead, logmode, log_output, timestamp,
3029 log_raw_input)
2590 log_raw_input)
3030 except:
2591 except:
3031 self.shell.logfile = old_logfile
2592 self.shell.logfile = old_logfile
3032 warn("Couldn't start log: %s" % sys.exc_info()[1])
2593 warn("Couldn't start log: %s" % sys.exc_info()[1])
3033 else:
2594 else:
3034 # log input history up to this point, optionally interleaving
2595 # log input history up to this point, optionally interleaving
3035 # output if requested
2596 # output if requested
3036
2597
3037 if timestamp:
2598 if timestamp:
3038 # disable timestamping for the previous history, since we've
2599 # disable timestamping for the previous history, since we've
3039 # lost those already (no time machine here).
2600 # lost those already (no time machine here).
3040 logger.timestamp = False
2601 logger.timestamp = False
3041
2602
3042 if log_raw_input:
2603 if log_raw_input:
3043 input_hist = self.shell.history_manager.input_hist_raw
2604 input_hist = self.shell.history_manager.input_hist_raw
3044 else:
2605 else:
3045 input_hist = self.shell.history_manager.input_hist_parsed
2606 input_hist = self.shell.history_manager.input_hist_parsed
3046
2607
3047 if log_output:
2608 if log_output:
3048 log_write = logger.log_write
2609 log_write = logger.log_write
3049 output_hist = self.shell.history_manager.output_hist
2610 output_hist = self.shell.history_manager.output_hist
3050 for n in range(1,len(input_hist)-1):
2611 for n in range(1,len(input_hist)-1):
3051 log_write(input_hist[n].rstrip() + '\n')
2612 log_write(input_hist[n].rstrip() + '\n')
3052 if n in output_hist:
2613 if n in output_hist:
3053 log_write(repr(output_hist[n]),'output')
2614 log_write(repr(output_hist[n]),'output')
3054 else:
2615 else:
3055 logger.log_write('\n'.join(input_hist[1:]))
2616 logger.log_write('\n'.join(input_hist[1:]))
3056 logger.log_write('\n')
2617 logger.log_write('\n')
3057 if timestamp:
2618 if timestamp:
3058 # re-enable timestamping
2619 # re-enable timestamping
3059 logger.timestamp = True
2620 logger.timestamp = True
3060
2621
3061 print ('Activating auto-logging. '
2622 print ('Activating auto-logging. '
3062 'Current session state plus future input saved.')
2623 'Current session state plus future input saved.')
3063 logger.logstate()
2624 logger.logstate()
3064
2625
3065 @line_magic
2626 @line_magic
3066 def logstop(self, parameter_s=''):
2627 def logstop(self, parameter_s=''):
3067 """Fully stop logging and close log file.
2628 """Fully stop logging and close log file.
3068
2629
3069 In order to start logging again, a new %logstart call needs to be made,
2630 In order to start logging again, a new %logstart call needs to be made,
3070 possibly (though not necessarily) with a new filename, mode and other
2631 possibly (though not necessarily) with a new filename, mode and other
3071 options."""
2632 options."""
3072 self.logger.logstop()
2633 self.logger.logstop()
3073
2634
3074 @line_magic
2635 @line_magic
3075 def logoff(self, parameter_s=''):
2636 def logoff(self, parameter_s=''):
3076 """Temporarily stop logging.
2637 """Temporarily stop logging.
3077
2638
3078 You must have previously started logging."""
2639 You must have previously started logging."""
3079 self.shell.logger.switch_log(0)
2640 self.shell.logger.switch_log(0)
3080
2641
3081 @line_magic
2642 @line_magic
3082 def logon(self, parameter_s=''):
2643 def logon(self, parameter_s=''):
3083 """Restart logging.
2644 """Restart logging.
3084
2645
3085 This function is for restarting logging which you've temporarily
2646 This function is for restarting logging which you've temporarily
3086 stopped with %logoff. For starting logging for the first time, you
2647 stopped with %logoff. For starting logging for the first time, you
3087 must use the %logstart function, which allows you to specify an
2648 must use the %logstart function, which allows you to specify an
3088 optional log filename."""
2649 optional log filename."""
3089
2650
3090 self.shell.logger.switch_log(1)
2651 self.shell.logger.switch_log(1)
3091
2652
3092 @line_magic
2653 @line_magic
3093 def logstate(self, parameter_s=''):
2654 def logstate(self, parameter_s=''):
3094 """Print the status of the logging system."""
2655 """Print the status of the logging system."""
3095
2656
3096 self.shell.logger.logstate()
2657 self.shell.logger.logstate()
3097
2658
3098
2659
3099 @register_magics
2660 @register_magics
3100 class ExtensionsMagics(Magics):
2661 class ExtensionsMagics(Magics):
3101 """Magics to manage the IPython extensions system."""
2662 """Magics to manage the IPython extensions system."""
3102
2663
3103 @line_magic
2664 @line_magic
3104 def install_ext(self, parameter_s=''):
2665 def install_ext(self, parameter_s=''):
3105 """Download and install an extension from a URL, e.g.::
2666 """Download and install an extension from a URL, e.g.::
3106
2667
3107 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
2668 %install_ext https://bitbucket.org/birkenfeld/ipython-physics/raw/d1310a2ab15d/physics.py
3108
2669
3109 The URL should point to an importable Python module - either a .py file
2670 The URL should point to an importable Python module - either a .py file
3110 or a .zip file.
2671 or a .zip file.
3111
2672
3112 Parameters:
2673 Parameters:
3113
2674
3114 -n filename : Specify a name for the file, rather than taking it from
2675 -n filename : Specify a name for the file, rather than taking it from
3115 the URL.
2676 the URL.
3116 """
2677 """
3117 opts, args = self.parse_options(parameter_s, 'n:')
2678 opts, args = self.parse_options(parameter_s, 'n:')
3118 try:
2679 try:
3119 filename = self.shell.extension_manager.install_extension(args,
2680 filename = self.shell.extension_manager.install_extension(args,
3120 opts.get('n'))
2681 opts.get('n'))
3121 except ValueError as e:
2682 except ValueError as e:
3122 print e
2683 print e
3123 return
2684 return
3124
2685
3125 filename = os.path.basename(filename)
2686 filename = os.path.basename(filename)
3126 print "Installed %s. To use it, type:" % filename
2687 print "Installed %s. To use it, type:" % filename
3127 print " %%load_ext %s" % os.path.splitext(filename)[0]
2688 print " %%load_ext %s" % os.path.splitext(filename)[0]
3128
2689
3129
2690
3130 @line_magic
2691 @line_magic
3131 def load_ext(self, module_str):
2692 def load_ext(self, module_str):
3132 """Load an IPython extension by its module name."""
2693 """Load an IPython extension by its module name."""
3133 return self.shell.extension_manager.load_extension(module_str)
2694 return self.shell.extension_manager.load_extension(module_str)
3134
2695
3135 @line_magic
2696 @line_magic
3136 def unload_ext(self, module_str):
2697 def unload_ext(self, module_str):
3137 """Unload an IPython extension by its module name."""
2698 """Unload an IPython extension by its module name."""
3138 self.shell.extension_manager.unload_extension(module_str)
2699 self.shell.extension_manager.unload_extension(module_str)
3139
2700
3140 @line_magic
2701 @line_magic
3141 def reload_ext(self, module_str):
2702 def reload_ext(self, module_str):
3142 """Reload an IPython extension by its module name."""
2703 """Reload an IPython extension by its module name."""
3143 self.shell.extension_manager.reload_extension(module_str)
2704 self.shell.extension_manager.reload_extension(module_str)
3144
2705
3145
2706
3146 @register_magics
2707 @register_magics
3147 class PylabMagics(Magics):
2708 class PylabMagics(Magics):
3148 """Magics related to matplotlib's pylab support"""
2709 """Magics related to matplotlib's pylab support"""
3149
2710
3150 @skip_doctest
2711 @skip_doctest
3151 @line_magic
2712 @line_magic
3152 def pylab(self, parameter_s=''):
2713 def pylab(self, parameter_s=''):
3153 """Load numpy and matplotlib to work interactively.
2714 """Load numpy and matplotlib to work interactively.
3154
2715
3155 %pylab [GUINAME]
2716 %pylab [GUINAME]
3156
2717
3157 This function lets you activate pylab (matplotlib, numpy and
2718 This function lets you activate pylab (matplotlib, numpy and
3158 interactive support) at any point during an IPython session.
2719 interactive support) at any point during an IPython session.
3159
2720
3160 It will import at the top level numpy as np, pyplot as plt, matplotlib,
2721 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3161 pylab and mlab, as well as all names from numpy and pylab.
2722 pylab and mlab, as well as all names from numpy and pylab.
3162
2723
3163 If you are using the inline matplotlib backend for embedded figures,
2724 If you are using the inline matplotlib backend for embedded figures,
3164 you can adjust its behavior via the %config magic::
2725 you can adjust its behavior via the %config magic::
3165
2726
3166 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
2727 # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
3167 In [1]: %config InlineBackend.figure_format = 'svg'
2728 In [1]: %config InlineBackend.figure_format = 'svg'
3168
2729
3169 # change the behavior of closing all figures at the end of each
2730 # change the behavior of closing all figures at the end of each
3170 # execution (cell), or allowing reuse of active figures across
2731 # execution (cell), or allowing reuse of active figures across
3171 # cells:
2732 # cells:
3172 In [2]: %config InlineBackend.close_figures = False
2733 In [2]: %config InlineBackend.close_figures = False
3173
2734
3174 Parameters
2735 Parameters
3175 ----------
2736 ----------
3176 guiname : optional
2737 guiname : optional
3177 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
2738 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk',
3178 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
2739 'osx' or 'tk'). If given, the corresponding Matplotlib backend is
3179 used, otherwise matplotlib's default (which you can override in your
2740 used, otherwise matplotlib's default (which you can override in your
3180 matplotlib config file) is used.
2741 matplotlib config file) is used.
3181
2742
3182 Examples
2743 Examples
3183 --------
2744 --------
3184 In this case, where the MPL default is TkAgg::
2745 In this case, where the MPL default is TkAgg::
3185
2746
3186 In [2]: %pylab
2747 In [2]: %pylab
3187
2748
3188 Welcome to pylab, a matplotlib-based Python environment.
2749 Welcome to pylab, a matplotlib-based Python environment.
3189 Backend in use: TkAgg
2750 Backend in use: TkAgg
3190 For more information, type 'help(pylab)'.
2751 For more information, type 'help(pylab)'.
3191
2752
3192 But you can explicitly request a different backend::
2753 But you can explicitly request a different backend::
3193
2754
3194 In [3]: %pylab qt
2755 In [3]: %pylab qt
3195
2756
3196 Welcome to pylab, a matplotlib-based Python environment.
2757 Welcome to pylab, a matplotlib-based Python environment.
3197 Backend in use: Qt4Agg
2758 Backend in use: Qt4Agg
3198 For more information, type 'help(pylab)'.
2759 For more information, type 'help(pylab)'.
3199 """
2760 """
3200
2761
3201 if Application.initialized():
2762 if Application.initialized():
3202 app = Application.instance()
2763 app = Application.instance()
3203 try:
2764 try:
3204 import_all_status = app.pylab_import_all
2765 import_all_status = app.pylab_import_all
3205 except AttributeError:
2766 except AttributeError:
3206 import_all_status = True
2767 import_all_status = True
3207 else:
2768 else:
3208 import_all_status = True
2769 import_all_status = True
3209
2770
3210 self.shell.enable_pylab(parameter_s, import_all=import_all_status)
2771 self.shell.enable_pylab(parameter_s, import_all=import_all_status)
3211
2772
3212
2773
3213 @register_magics
2774 @register_magics
3214 class DeprecatedMagics(Magics):
2775 class DeprecatedMagics(Magics):
3215 """Magics slated for later removal."""
2776 """Magics slated for later removal."""
3216
2777
3217 @line_magic
2778 @line_magic
3218 def install_profiles(self, parameter_s=''):
2779 def install_profiles(self, parameter_s=''):
3219 """%install_profiles has been deprecated."""
2780 """%install_profiles has been deprecated."""
3220 print '\n'.join([
2781 print '\n'.join([
3221 "%install_profiles has been deprecated.",
2782 "%install_profiles has been deprecated.",
3222 "Use `ipython profile list` to view available profiles.",
2783 "Use `ipython profile list` to view available profiles.",
3223 "Requesting a profile with `ipython profile create <name>`",
2784 "Requesting a profile with `ipython profile create <name>`",
3224 "or `ipython --profile=<name>` will start with the bundled",
2785 "or `ipython --profile=<name>` will start with the bundled",
3225 "profile of that name if it exists."
2786 "profile of that name if it exists."
3226 ])
2787 ])
3227
2788
3228 @line_magic
2789 @line_magic
3229 def install_default_config(self, parameter_s=''):
2790 def install_default_config(self, parameter_s=''):
3230 """%install_default_config has been deprecated."""
2791 """%install_default_config has been deprecated."""
3231 print '\n'.join([
2792 print '\n'.join([
3232 "%install_default_config has been deprecated.",
2793 "%install_default_config has been deprecated.",
3233 "Use `ipython profile create <name>` to initialize a profile",
2794 "Use `ipython profile create <name>` to initialize a profile",
3234 "with the default config files.",
2795 "with the default config files.",
3235 "Add `--reset` to overwrite already existing config files with defaults."
2796 "Add `--reset` to overwrite already existing config files with defaults."
3236 ])
2797 ])
@@ -1,30 +1,31 b''
1 """Implementation of all the magic functions built into IPython.
1 """Implementation of all the magic functions built into IPython.
2 """
2 """
3 #-----------------------------------------------------------------------------
3 #-----------------------------------------------------------------------------
4 # Copyright (c) 2012, IPython Development Team.
4 # Copyright (c) 2012, IPython Development Team.
5 #
5 #
6 # Distributed under the terms of the Modified BSD License.
6 # Distributed under the terms of the Modified BSD License.
7 #
7 #
8 # The full license is in the file COPYING.txt, distributed with this software.
8 # The full license is in the file COPYING.txt, distributed with this software.
9 #-----------------------------------------------------------------------------
9 #-----------------------------------------------------------------------------
10
10
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12 # Imports
12 # Imports
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14
14
15 from IPython.core.magic import Magics, register_magics
15 from IPython.core.magic import Magics, register_magics
16 from basic import BasicMagics
16 from .basic import BasicMagics
17 from history import HistoryMagics
17 from .code import CodeMagics, MacroToEdit
18 from .history import HistoryMagics
18
19
19 #-----------------------------------------------------------------------------
20 #-----------------------------------------------------------------------------
20 # Magic implementation classes
21 # Magic implementation classes
21 #-----------------------------------------------------------------------------
22 #-----------------------------------------------------------------------------
22
23
23 @register_magics
24 @register_magics
24 class UserMagics(Magics):
25 class UserMagics(Magics):
25 """Placeholder for user-defined magics to be added at runtime.
26 """Placeholder for user-defined magics to be added at runtime.
26
27
27 All magics are eventually merged into a single namespace at runtime, but we
28 All magics are eventually merged into a single namespace at runtime, but we
28 use this class to isolate the magics defined dynamically by the user into
29 use this class to isolate the magics defined dynamically by the user into
29 their own class.
30 their own class.
30 """
31 """
General Comments 0
You need to be logged in to leave comments. Login now