##// END OF EJS Templates
Initial changes to make alias system use magics
Thomas Kluyver -
Show More
@@ -1,262 +1,293 b''
1 # encoding: utf-8
1 # encoding: utf-8
2 """
2 """
3 System command aliases.
3 System command aliases.
4
4
5 Authors:
5 Authors:
6
6
7 * Fernando Perez
7 * Fernando Perez
8 * Brian Granger
8 * Brian Granger
9 """
9 """
10
10
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12 # Copyright (C) 2008-2011 The IPython Development Team
12 # Copyright (C) 2008-2011 The IPython Development Team
13 #
13 #
14 # Distributed under the terms of the BSD License.
14 # Distributed under the terms of the BSD License.
15 #
15 #
16 # The full license is in the file COPYING.txt, distributed with this software.
16 # The full license is in the file COPYING.txt, distributed with this software.
17 #-----------------------------------------------------------------------------
17 #-----------------------------------------------------------------------------
18
18
19 #-----------------------------------------------------------------------------
19 #-----------------------------------------------------------------------------
20 # Imports
20 # Imports
21 #-----------------------------------------------------------------------------
21 #-----------------------------------------------------------------------------
22
22
23 import __builtin__
23 import __builtin__
24 import keyword
24 import keyword
25 import os
25 import os
26 import re
26 import re
27 import sys
27 import sys
28
28
29 from IPython.config.configurable import Configurable
29 from IPython.config.configurable import Configurable
30 from IPython.core.splitinput import split_user_input
30 from IPython.core.splitinput import split_user_input
31
31
32 from IPython.utils.traitlets import List, Instance
32 from IPython.utils.traitlets import List, Instance
33 from IPython.utils.warn import warn, error
33 from IPython.utils.warn import warn, error
34
34
35 #-----------------------------------------------------------------------------
35 #-----------------------------------------------------------------------------
36 # Utilities
36 # Utilities
37 #-----------------------------------------------------------------------------
37 #-----------------------------------------------------------------------------
38
38
39 # This is used as the pattern for calls to split_user_input.
39 # This is used as the pattern for calls to split_user_input.
40 shell_line_split = re.compile(r'^(\s*)()(\S+)(.*$)')
40 shell_line_split = re.compile(r'^(\s*)()(\S+)(.*$)')
41
41
42 def default_aliases():
42 def default_aliases():
43 """Return list of shell aliases to auto-define.
43 """Return list of shell aliases to auto-define.
44 """
44 """
45 # Note: the aliases defined here should be safe to use on a kernel
45 # Note: the aliases defined here should be safe to use on a kernel
46 # regardless of what frontend it is attached to. Frontends that use a
46 # regardless of what frontend it is attached to. Frontends that use a
47 # kernel in-process can define additional aliases that will only work in
47 # kernel in-process can define additional aliases that will only work in
48 # their case. For example, things like 'less' or 'clear' that manipulate
48 # their case. For example, things like 'less' or 'clear' that manipulate
49 # the terminal should NOT be declared here, as they will only work if the
49 # the terminal should NOT be declared here, as they will only work if the
50 # kernel is running inside a true terminal, and not over the network.
50 # kernel is running inside a true terminal, and not over the network.
51
51
52 if os.name == 'posix':
52 if os.name == 'posix':
53 default_aliases = [('mkdir', 'mkdir'), ('rmdir', 'rmdir'),
53 default_aliases = [('mkdir', 'mkdir'), ('rmdir', 'rmdir'),
54 ('mv', 'mv -i'), ('rm', 'rm -i'), ('cp', 'cp -i'),
54 ('mv', 'mv -i'), ('rm', 'rm -i'), ('cp', 'cp -i'),
55 ('cat', 'cat'),
55 ('cat', 'cat'),
56 ]
56 ]
57 # Useful set of ls aliases. The GNU and BSD options are a little
57 # Useful set of ls aliases. The GNU and BSD options are a little
58 # different, so we make aliases that provide as similar as possible
58 # different, so we make aliases that provide as similar as possible
59 # behavior in ipython, by passing the right flags for each platform
59 # behavior in ipython, by passing the right flags for each platform
60 if sys.platform.startswith('linux'):
60 if sys.platform.startswith('linux'):
61 ls_aliases = [('ls', 'ls -F --color'),
61 ls_aliases = [('ls', 'ls -F --color'),
62 # long ls
62 # long ls
63 ('ll', 'ls -F -o --color'),
63 ('ll', 'ls -F -o --color'),
64 # ls normal files only
64 # ls normal files only
65 ('lf', 'ls -F -o --color %l | grep ^-'),
65 ('lf', 'ls -F -o --color %l | grep ^-'),
66 # ls symbolic links
66 # ls symbolic links
67 ('lk', 'ls -F -o --color %l | grep ^l'),
67 ('lk', 'ls -F -o --color %l | grep ^l'),
68 # directories or links to directories,
68 # directories or links to directories,
69 ('ldir', 'ls -F -o --color %l | grep /$'),
69 ('ldir', 'ls -F -o --color %l | grep /$'),
70 # things which are executable
70 # things which are executable
71 ('lx', 'ls -F -o --color %l | grep ^-..x'),
71 ('lx', 'ls -F -o --color %l | grep ^-..x'),
72 ]
72 ]
73 else:
73 else:
74 # BSD, OSX, etc.
74 # BSD, OSX, etc.
75 ls_aliases = [('ls', 'ls -F -G'),
75 ls_aliases = [('ls', 'ls -F -G'),
76 # long ls
76 # long ls
77 ('ll', 'ls -F -l -G'),
77 ('ll', 'ls -F -l -G'),
78 # ls normal files only
78 # ls normal files only
79 ('lf', 'ls -F -l -G %l | grep ^-'),
79 ('lf', 'ls -F -l -G %l | grep ^-'),
80 # ls symbolic links
80 # ls symbolic links
81 ('lk', 'ls -F -l -G %l | grep ^l'),
81 ('lk', 'ls -F -l -G %l | grep ^l'),
82 # directories or links to directories,
82 # directories or links to directories,
83 ('ldir', 'ls -F -G -l %l | grep /$'),
83 ('ldir', 'ls -F -G -l %l | grep /$'),
84 # things which are executable
84 # things which are executable
85 ('lx', 'ls -F -l -G %l | grep ^-..x'),
85 ('lx', 'ls -F -l -G %l | grep ^-..x'),
86 ]
86 ]
87 default_aliases = default_aliases + ls_aliases
87 default_aliases = default_aliases + ls_aliases
88 elif os.name in ['nt', 'dos']:
88 elif os.name in ['nt', 'dos']:
89 default_aliases = [('ls', 'dir /on'),
89 default_aliases = [('ls', 'dir /on'),
90 ('ddir', 'dir /ad /on'), ('ldir', 'dir /ad /on'),
90 ('ddir', 'dir /ad /on'), ('ldir', 'dir /ad /on'),
91 ('mkdir', 'mkdir'), ('rmdir', 'rmdir'),
91 ('mkdir', 'mkdir'), ('rmdir', 'rmdir'),
92 ('echo', 'echo'), ('ren', 'ren'), ('copy', 'copy'),
92 ('echo', 'echo'), ('ren', 'ren'), ('copy', 'copy'),
93 ]
93 ]
94 else:
94 else:
95 default_aliases = []
95 default_aliases = []
96
96
97 return default_aliases
97 return default_aliases
98
98
99
99
100 class AliasError(Exception):
100 class AliasError(Exception):
101 pass
101 pass
102
102
103
103
104 class InvalidAliasError(AliasError):
104 class InvalidAliasError(AliasError):
105 pass
105 pass
106
106
107 class AliasCaller(object):
108 def __init__(self, shell, cmd):
109 self.shell = shell
110 self.cmd = cmd
111 self.nargs = cmd.count('%s')
112 if (self.nargs > 0) and (cmd.find('%l') >= 0):
113 raise InvalidAliasError('The %s and %l specifiers are mutually '
114 'exclusive in alias definitions.')
115
116 def __call__(self, rest=''):
117 cmd = self.cmd
118 nargs = self.nargs
119 # Expand the %l special to be the user's input line
120 if cmd.find('%l') >= 0:
121 cmd = cmd.replace('%l', rest)
122 rest = ''
123 if nargs==0:
124 # Simple, argument-less aliases
125 cmd = '%s %s' % (cmd, rest)
126 else:
127 # Handle aliases with positional arguments
128 args = rest.split(None, nargs)
129 if len(args) < nargs:
130 raise AliasError('Alias <%s> requires %s arguments, %s given.' %
131 (alias, nargs, len(args)))
132 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
133
134 self.shell.system(cmd)
135
107 #-----------------------------------------------------------------------------
136 #-----------------------------------------------------------------------------
108 # Main AliasManager class
137 # Main AliasManager class
109 #-----------------------------------------------------------------------------
138 #-----------------------------------------------------------------------------
110
139
111 class AliasManager(Configurable):
140 class AliasManager(Configurable):
112
141
113 default_aliases = List(default_aliases(), config=True)
142 default_aliases = List(default_aliases(), config=True)
114 user_aliases = List(default_value=[], config=True)
143 user_aliases = List(default_value=[], config=True)
115 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
144 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
116
145
117 def __init__(self, shell=None, **kwargs):
146 def __init__(self, shell=None, **kwargs):
118 super(AliasManager, self).__init__(shell=shell, **kwargs)
147 super(AliasManager, self).__init__(shell=shell, **kwargs)
119 self.alias_table = {}
148 self.alias_table = {}
120 self.exclude_aliases()
149 self.init_exclusions()
121 self.init_aliases()
150 self.init_aliases()
122
151
123 def __contains__(self, name):
152 def __contains__(self, name):
124 return name in self.alias_table
153 return name in self.alias_table
125
154
126 @property
155 @property
127 def aliases(self):
156 def aliases(self):
128 return [(item[0], item[1][1]) for item in self.alias_table.iteritems()]
157 return [(item[0], item[1][1]) for item in self.alias_table.iteritems()]
129
158
130 def exclude_aliases(self):
159 def init_exclusions(self):
131 # set of things NOT to alias (keywords, builtins and some magics)
160 # set of things NOT to alias (keywords, builtins and some magics)
132 no_alias = set(['cd','popd','pushd','dhist','alias','unalias'])
161 no_alias = {'cd','popd','pushd','dhist','alias','unalias'}
133 no_alias.update(set(keyword.kwlist))
162 no_alias.update(set(keyword.kwlist))
134 no_alias.update(set(__builtin__.__dict__.keys()))
163 no_alias.update(set(__builtin__.__dict__.keys()))
135 self.no_alias = no_alias
164 self.no_alias = no_alias
136
165
137 def init_aliases(self):
166 def init_aliases(self):
138 # Load default aliases
167 # Load default aliases
139 for name, cmd in self.default_aliases:
168 for name, cmd in self.default_aliases:
140 self.soft_define_alias(name, cmd)
169 self.soft_define_alias(name, cmd)
141
170
142 # Load user aliases
171 # Load user aliases
143 for name, cmd in self.user_aliases:
172 for name, cmd in self.user_aliases:
144 self.soft_define_alias(name, cmd)
173 self.soft_define_alias(name, cmd)
145
174
146 def clear_aliases(self):
175 def clear_aliases(self):
147 self.alias_table.clear()
176 self.alias_table.clear()
148
177
149 def soft_define_alias(self, name, cmd):
178 def soft_define_alias(self, name, cmd):
150 """Define an alias, but don't raise on an AliasError."""
179 """Define an alias, but don't raise on an AliasError."""
151 try:
180 try:
152 self.define_alias(name, cmd)
181 self.define_alias(name, cmd)
153 except AliasError as e:
182 except AliasError as e:
154 error("Invalid alias: %s" % e)
183 error("Invalid alias: %s" % e)
155
184
156 def define_alias(self, name, cmd):
185 def define_alias(self, name, cmd):
157 """Define a new alias after validating it.
186 """Define a new alias after validating it.
158
187
159 This will raise an :exc:`AliasError` if there are validation
188 This will raise an :exc:`AliasError` if there are validation
160 problems.
189 problems.
161 """
190 """
162 nargs = self.validate_alias(name, cmd)
191 self.validate_alias(name, cmd)
163 self.alias_table[name] = (nargs, cmd)
192 caller = AliasCaller(shell=self.shell, cmd=cmd)
193 self.shell.magics_manager.register_function(caller, magic_kind='line',
194 magic_name=name)
164
195
165 def undefine_alias(self, name):
196 def undefine_alias(self, name):
166 if name in self.alias_table:
197 linemagics = self.shell.magics_manager.magics['line']
167 del self.alias_table[name]
198 caller = linemagics.get(name, None)
199 if isinstance(caller, AliasCaller):
200 del linemagics[name]
201 else:
202 raise ValueError('%s is not an alias' % name)
168
203
169 def validate_alias(self, name, cmd):
204 def validate_alias(self, name, cmd):
170 """Validate an alias and return the its number of arguments."""
205 """Validate an alias and return the its number of arguments."""
171 if name in self.no_alias:
206 if name in self.no_alias:
172 raise InvalidAliasError("The name %s can't be aliased "
207 raise InvalidAliasError("The name %s can't be aliased "
173 "because it is a keyword or builtin." % name)
208 "because it is a keyword or builtin." % name)
174 if not (isinstance(cmd, basestring)):
209 if not (isinstance(cmd, basestring)):
175 raise InvalidAliasError("An alias command must be a string, "
210 raise InvalidAliasError("An alias command must be a string, "
176 "got: %r" % cmd)
211 "got: %r" % cmd)
177 nargs = cmd.count('%s')
212 return True
178 if nargs>0 and cmd.find('%l')>=0:
179 raise InvalidAliasError('The %s and %l specifiers are mutually '
180 'exclusive in alias definitions.')
181 return nargs
182
213
183 def call_alias(self, alias, rest=''):
214 def call_alias(self, alias, rest=''):
184 """Call an alias given its name and the rest of the line."""
215 """Call an alias given its name and the rest of the line."""
185 cmd = self.transform_alias(alias, rest)
216 cmd = self.transform_alias(alias, rest)
186 try:
217 try:
187 self.shell.system(cmd)
218 self.shell.system(cmd)
188 except:
219 except:
189 self.shell.showtraceback()
220 self.shell.showtraceback()
190
221
191 def transform_alias(self, alias,rest=''):
222 def transform_alias(self, alias,rest=''):
192 """Transform alias to system command string."""
223 """Transform alias to system command string."""
193 nargs, cmd = self.alias_table[alias]
224 nargs, cmd = self.alias_table[alias]
194
225
195 if ' ' in cmd and os.path.isfile(cmd):
226 if ' ' in cmd and os.path.isfile(cmd):
196 cmd = '"%s"' % cmd
227 cmd = '"%s"' % cmd
197
228
198 # Expand the %l special to be the user's input line
229 # Expand the %l special to be the user's input line
199 if cmd.find('%l') >= 0:
230 if cmd.find('%l') >= 0:
200 cmd = cmd.replace('%l', rest)
231 cmd = cmd.replace('%l', rest)
201 rest = ''
232 rest = ''
202 if nargs==0:
233 if nargs==0:
203 # Simple, argument-less aliases
234 # Simple, argument-less aliases
204 cmd = '%s %s' % (cmd, rest)
235 cmd = '%s %s' % (cmd, rest)
205 else:
236 else:
206 # Handle aliases with positional arguments
237 # Handle aliases with positional arguments
207 args = rest.split(None, nargs)
238 args = rest.split(None, nargs)
208 if len(args) < nargs:
239 if len(args) < nargs:
209 raise AliasError('Alias <%s> requires %s arguments, %s given.' %
240 raise AliasError('Alias <%s> requires %s arguments, %s given.' %
210 (alias, nargs, len(args)))
241 (alias, nargs, len(args)))
211 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
242 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
212 return cmd
243 return cmd
213
244
214 def expand_alias(self, line):
245 def expand_alias(self, line):
215 """ Expand an alias in the command line
246 """ Expand an alias in the command line
216
247
217 Returns the provided command line, possibly with the first word
248 Returns the provided command line, possibly with the first word
218 (command) translated according to alias expansion rules.
249 (command) translated according to alias expansion rules.
219
250
220 [ipython]|16> _ip.expand_aliases("np myfile.txt")
251 [ipython]|16> _ip.expand_aliases("np myfile.txt")
221 <16> 'q:/opt/np/notepad++.exe myfile.txt'
252 <16> 'q:/opt/np/notepad++.exe myfile.txt'
222 """
253 """
223
254
224 pre,_,fn,rest = split_user_input(line)
255 pre,_,fn,rest = split_user_input(line)
225 res = pre + self.expand_aliases(fn, rest)
256 res = pre + self.expand_aliases(fn, rest)
226 return res
257 return res
227
258
228 def expand_aliases(self, fn, rest):
259 def expand_aliases(self, fn, rest):
229 """Expand multiple levels of aliases:
260 """Expand multiple levels of aliases:
230
261
231 if:
262 if:
232
263
233 alias foo bar /tmp
264 alias foo bar /tmp
234 alias baz foo
265 alias baz foo
235
266
236 then:
267 then:
237
268
238 baz huhhahhei -> bar /tmp huhhahhei
269 baz huhhahhei -> bar /tmp huhhahhei
239 """
270 """
240 line = fn + " " + rest
271 line = fn + " " + rest
241
272
242 done = set()
273 done = set()
243 while 1:
274 while 1:
244 pre,_,fn,rest = split_user_input(line, shell_line_split)
275 pre,_,fn,rest = split_user_input(line, shell_line_split)
245 if fn in self.alias_table:
276 if fn in self.alias_table:
246 if fn in done:
277 if fn in done:
247 warn("Cyclic alias definition, repeated '%s'" % fn)
278 warn("Cyclic alias definition, repeated '%s'" % fn)
248 return ""
279 return ""
249 done.add(fn)
280 done.add(fn)
250
281
251 l2 = self.transform_alias(fn, rest)
282 l2 = self.transform_alias(fn, rest)
252 if l2 == line:
283 if l2 == line:
253 break
284 break
254 # ls -> ls -F should not recurse forever
285 # ls -> ls -F should not recurse forever
255 if l2.split(None,1)[0] == line.split(None,1)[0]:
286 if l2.split(None,1)[0] == line.split(None,1)[0]:
256 line = l2
287 line = l2
257 break
288 break
258 line = l2
289 line = l2
259 else:
290 else:
260 break
291 break
261
292
262 return line
293 return line
@@ -1,3160 +1,3160 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 absolute_import
17 from __future__ import absolute_import
18 from __future__ import print_function
18 from __future__ import print_function
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 functools
25 import functools
26 import os
26 import os
27 import re
27 import re
28 import runpy
28 import runpy
29 import sys
29 import sys
30 import tempfile
30 import tempfile
31 import types
31 import types
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 magic
36 from IPython.core import magic
37 from IPython.core import page
37 from IPython.core import page
38 from IPython.core import prefilter
38 from IPython.core import prefilter
39 from IPython.core import shadowns
39 from IPython.core import shadowns
40 from IPython.core import ultratb
40 from IPython.core import ultratb
41 from IPython.core.alias import AliasManager, AliasError
41 from IPython.core.alias import AliasManager, AliasError
42 from IPython.core.autocall import ExitAutocall
42 from IPython.core.autocall import ExitAutocall
43 from IPython.core.builtin_trap import BuiltinTrap
43 from IPython.core.builtin_trap import BuiltinTrap
44 from IPython.core.compilerop import CachingCompiler, check_linecache_ipython
44 from IPython.core.compilerop import CachingCompiler, check_linecache_ipython
45 from IPython.core.display_trap import DisplayTrap
45 from IPython.core.display_trap import DisplayTrap
46 from IPython.core.displayhook import DisplayHook
46 from IPython.core.displayhook import DisplayHook
47 from IPython.core.displaypub import DisplayPublisher
47 from IPython.core.displaypub import DisplayPublisher
48 from IPython.core.error import UsageError
48 from IPython.core.error import UsageError
49 from IPython.core.extensions import ExtensionManager
49 from IPython.core.extensions import ExtensionManager
50 from IPython.core.formatters import DisplayFormatter
50 from IPython.core.formatters import DisplayFormatter
51 from IPython.core.history import HistoryManager
51 from IPython.core.history import HistoryManager
52 from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2
52 from IPython.core.inputsplitter import IPythonInputSplitter, ESC_MAGIC, ESC_MAGIC2
53 from IPython.core.logger import Logger
53 from IPython.core.logger import Logger
54 from IPython.core.macro import Macro
54 from IPython.core.macro import Macro
55 from IPython.core.payload import PayloadManager
55 from IPython.core.payload import PayloadManager
56 from IPython.core.prefilter import PrefilterManager
56 from IPython.core.prefilter import PrefilterManager
57 from IPython.core.profiledir import ProfileDir
57 from IPython.core.profiledir import ProfileDir
58 from IPython.core.prompts import PromptManager
58 from IPython.core.prompts import PromptManager
59 from IPython.lib.latextools import LaTeXTool
59 from IPython.lib.latextools import LaTeXTool
60 from IPython.testing.skipdoctest import skip_doctest
60 from IPython.testing.skipdoctest import skip_doctest
61 from IPython.utils import PyColorize
61 from IPython.utils import PyColorize
62 from IPython.utils import io
62 from IPython.utils import io
63 from IPython.utils import py3compat
63 from IPython.utils import py3compat
64 from IPython.utils import openpy
64 from IPython.utils import openpy
65 from IPython.utils.decorators import undoc
65 from IPython.utils.decorators import undoc
66 from IPython.utils.io import ask_yes_no
66 from IPython.utils.io import ask_yes_no
67 from IPython.utils.ipstruct import Struct
67 from IPython.utils.ipstruct import Struct
68 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
68 from IPython.utils.path import get_home_dir, get_ipython_dir, get_py_filename, unquote_filename
69 from IPython.utils.pickleshare import PickleShareDB
69 from IPython.utils.pickleshare import PickleShareDB
70 from IPython.utils.process import system, getoutput
70 from IPython.utils.process import system, getoutput
71 from IPython.utils.strdispatch import StrDispatch
71 from IPython.utils.strdispatch import StrDispatch
72 from IPython.utils.syspathcontext import prepended_to_syspath
72 from IPython.utils.syspathcontext import prepended_to_syspath
73 from IPython.utils.text import (format_screen, LSString, SList,
73 from IPython.utils.text import (format_screen, LSString, SList,
74 DollarFormatter)
74 DollarFormatter)
75 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
75 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
76 List, Unicode, Instance, Type)
76 List, Unicode, Instance, Type)
77 from IPython.utils.warn import warn, error
77 from IPython.utils.warn import warn, error
78 import IPython.core.hooks
78 import IPython.core.hooks
79
79
80 #-----------------------------------------------------------------------------
80 #-----------------------------------------------------------------------------
81 # Globals
81 # Globals
82 #-----------------------------------------------------------------------------
82 #-----------------------------------------------------------------------------
83
83
84 # compiled regexps for autoindent management
84 # compiled regexps for autoindent management
85 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
85 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
86
86
87 #-----------------------------------------------------------------------------
87 #-----------------------------------------------------------------------------
88 # Utilities
88 # Utilities
89 #-----------------------------------------------------------------------------
89 #-----------------------------------------------------------------------------
90
90
91 @undoc
91 @undoc
92 def softspace(file, newvalue):
92 def softspace(file, newvalue):
93 """Copied from code.py, to remove the dependency"""
93 """Copied from code.py, to remove the dependency"""
94
94
95 oldvalue = 0
95 oldvalue = 0
96 try:
96 try:
97 oldvalue = file.softspace
97 oldvalue = file.softspace
98 except AttributeError:
98 except AttributeError:
99 pass
99 pass
100 try:
100 try:
101 file.softspace = newvalue
101 file.softspace = newvalue
102 except (AttributeError, TypeError):
102 except (AttributeError, TypeError):
103 # "attribute-less object" or "read-only attributes"
103 # "attribute-less object" or "read-only attributes"
104 pass
104 pass
105 return oldvalue
105 return oldvalue
106
106
107 @undoc
107 @undoc
108 def no_op(*a, **kw): pass
108 def no_op(*a, **kw): pass
109
109
110 @undoc
110 @undoc
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 @undoc
118 @undoc
119 class Bunch: pass
119 class Bunch: pass
120
120
121
121
122 def get_default_colors():
122 def get_default_colors():
123 if sys.platform=='darwin':
123 if sys.platform=='darwin':
124 return "LightBG"
124 return "LightBG"
125 elif os.name=='nt':
125 elif os.name=='nt':
126 return 'Linux'
126 return 'Linux'
127 else:
127 else:
128 return 'Linux'
128 return 'Linux'
129
129
130
130
131 class SeparateUnicode(Unicode):
131 class SeparateUnicode(Unicode):
132 """A Unicode subclass to validate separate_in, separate_out, etc.
132 """A Unicode subclass to validate separate_in, separate_out, etc.
133
133
134 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
134 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
135 """
135 """
136
136
137 def validate(self, obj, value):
137 def validate(self, obj, value):
138 if value == '0': value = ''
138 if value == '0': value = ''
139 value = value.replace('\\n','\n')
139 value = value.replace('\\n','\n')
140 return super(SeparateUnicode, self).validate(obj, value)
140 return super(SeparateUnicode, self).validate(obj, value)
141
141
142
142
143 class ReadlineNoRecord(object):
143 class ReadlineNoRecord(object):
144 """Context manager to execute some code, then reload readline history
144 """Context manager to execute some code, then reload readline history
145 so that interactive input to the code doesn't appear when pressing up."""
145 so that interactive input to the code doesn't appear when pressing up."""
146 def __init__(self, shell):
146 def __init__(self, shell):
147 self.shell = shell
147 self.shell = shell
148 self._nested_level = 0
148 self._nested_level = 0
149
149
150 def __enter__(self):
150 def __enter__(self):
151 if self._nested_level == 0:
151 if self._nested_level == 0:
152 try:
152 try:
153 self.orig_length = self.current_length()
153 self.orig_length = self.current_length()
154 self.readline_tail = self.get_readline_tail()
154 self.readline_tail = self.get_readline_tail()
155 except (AttributeError, IndexError): # Can fail with pyreadline
155 except (AttributeError, IndexError): # Can fail with pyreadline
156 self.orig_length, self.readline_tail = 999999, []
156 self.orig_length, self.readline_tail = 999999, []
157 self._nested_level += 1
157 self._nested_level += 1
158
158
159 def __exit__(self, type, value, traceback):
159 def __exit__(self, type, value, traceback):
160 self._nested_level -= 1
160 self._nested_level -= 1
161 if self._nested_level == 0:
161 if self._nested_level == 0:
162 # Try clipping the end if it's got longer
162 # Try clipping the end if it's got longer
163 try:
163 try:
164 e = self.current_length() - self.orig_length
164 e = self.current_length() - self.orig_length
165 if e > 0:
165 if e > 0:
166 for _ in range(e):
166 for _ in range(e):
167 self.shell.readline.remove_history_item(self.orig_length)
167 self.shell.readline.remove_history_item(self.orig_length)
168
168
169 # If it still doesn't match, just reload readline history.
169 # If it still doesn't match, just reload readline history.
170 if self.current_length() != self.orig_length \
170 if self.current_length() != self.orig_length \
171 or self.get_readline_tail() != self.readline_tail:
171 or self.get_readline_tail() != self.readline_tail:
172 self.shell.refill_readline_hist()
172 self.shell.refill_readline_hist()
173 except (AttributeError, IndexError):
173 except (AttributeError, IndexError):
174 pass
174 pass
175 # Returning False will cause exceptions to propagate
175 # Returning False will cause exceptions to propagate
176 return False
176 return False
177
177
178 def current_length(self):
178 def current_length(self):
179 return self.shell.readline.get_current_history_length()
179 return self.shell.readline.get_current_history_length()
180
180
181 def get_readline_tail(self, n=10):
181 def get_readline_tail(self, n=10):
182 """Get the last n items in readline history."""
182 """Get the last n items in readline history."""
183 end = self.shell.readline.get_current_history_length() + 1
183 end = self.shell.readline.get_current_history_length() + 1
184 start = max(end-n, 1)
184 start = max(end-n, 1)
185 ghi = self.shell.readline.get_history_item
185 ghi = self.shell.readline.get_history_item
186 return [ghi(x) for x in range(start, end)]
186 return [ghi(x) for x in range(start, end)]
187
187
188
188
189 @undoc
189 @undoc
190 class DummyMod(object):
190 class DummyMod(object):
191 """A dummy module used for IPython's interactive module when
191 """A dummy module used for IPython's interactive module when
192 a namespace must be assigned to the module's __dict__."""
192 a namespace must be assigned to the module's __dict__."""
193 pass
193 pass
194
194
195 #-----------------------------------------------------------------------------
195 #-----------------------------------------------------------------------------
196 # Main IPython class
196 # Main IPython class
197 #-----------------------------------------------------------------------------
197 #-----------------------------------------------------------------------------
198
198
199 class InteractiveShell(SingletonConfigurable):
199 class InteractiveShell(SingletonConfigurable):
200 """An enhanced, interactive shell for Python."""
200 """An enhanced, interactive shell for Python."""
201
201
202 _instance = None
202 _instance = None
203
203
204 ast_transformers = List([], config=True, help=
204 ast_transformers = List([], config=True, help=
205 """
205 """
206 A list of ast.NodeTransformer subclass instances, which will be applied
206 A list of ast.NodeTransformer subclass instances, which will be applied
207 to user input before code is run.
207 to user input before code is run.
208 """
208 """
209 )
209 )
210
210
211 autocall = Enum((0,1,2), default_value=0, config=True, help=
211 autocall = Enum((0,1,2), default_value=0, config=True, help=
212 """
212 """
213 Make IPython automatically call any callable object even if you didn't
213 Make IPython automatically call any callable object even if you didn't
214 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
214 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
215 automatically. The value can be '0' to disable the feature, '1' for
215 automatically. The value can be '0' to disable the feature, '1' for
216 'smart' autocall, where it is not applied if there are no more
216 'smart' autocall, where it is not applied if there are no more
217 arguments on the line, and '2' for 'full' autocall, where all callable
217 arguments on the line, and '2' for 'full' autocall, where all callable
218 objects are automatically called (even if no arguments are present).
218 objects are automatically called (even if no arguments are present).
219 """
219 """
220 )
220 )
221 # TODO: remove all autoindent logic and put into frontends.
221 # TODO: remove all autoindent logic and put into frontends.
222 # We can't do this yet because even runlines uses the autoindent.
222 # We can't do this yet because even runlines uses the autoindent.
223 autoindent = CBool(True, config=True, help=
223 autoindent = CBool(True, config=True, help=
224 """
224 """
225 Autoindent IPython code entered interactively.
225 Autoindent IPython code entered interactively.
226 """
226 """
227 )
227 )
228 automagic = CBool(True, config=True, help=
228 automagic = CBool(True, config=True, help=
229 """
229 """
230 Enable magic commands to be called without the leading %.
230 Enable magic commands to be called without the leading %.
231 """
231 """
232 )
232 )
233 cache_size = Integer(1000, config=True, help=
233 cache_size = Integer(1000, config=True, help=
234 """
234 """
235 Set the size of the output cache. The default is 1000, you can
235 Set the size of the output cache. The default is 1000, you can
236 change it permanently in your config file. Setting it to 0 completely
236 change it permanently in your config file. Setting it to 0 completely
237 disables the caching system, and the minimum value accepted is 20 (if
237 disables the caching system, and the minimum value accepted is 20 (if
238 you provide a value less than 20, it is reset to 0 and a warning is
238 you provide a value less than 20, it is reset to 0 and a warning is
239 issued). This limit is defined because otherwise you'll spend more
239 issued). This limit is defined because otherwise you'll spend more
240 time re-flushing a too small cache than working
240 time re-flushing a too small cache than working
241 """
241 """
242 )
242 )
243 color_info = CBool(True, config=True, help=
243 color_info = CBool(True, config=True, help=
244 """
244 """
245 Use colors for displaying information about objects. Because this
245 Use colors for displaying information about objects. Because this
246 information is passed through a pager (like 'less'), and some pagers
246 information is passed through a pager (like 'less'), and some pagers
247 get confused with color codes, this capability can be turned off.
247 get confused with color codes, this capability can be turned off.
248 """
248 """
249 )
249 )
250 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
250 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
251 default_value=get_default_colors(), config=True,
251 default_value=get_default_colors(), config=True,
252 help="Set the color scheme (NoColor, Linux, or LightBG)."
252 help="Set the color scheme (NoColor, Linux, or LightBG)."
253 )
253 )
254 colors_force = CBool(False, help=
254 colors_force = CBool(False, help=
255 """
255 """
256 Force use of ANSI color codes, regardless of OS and readline
256 Force use of ANSI color codes, regardless of OS and readline
257 availability.
257 availability.
258 """
258 """
259 # FIXME: This is essentially a hack to allow ZMQShell to show colors
259 # FIXME: This is essentially a hack to allow ZMQShell to show colors
260 # without readline on Win32. When the ZMQ formatting system is
260 # without readline on Win32. When the ZMQ formatting system is
261 # refactored, this should be removed.
261 # refactored, this should be removed.
262 )
262 )
263 debug = CBool(False, config=True)
263 debug = CBool(False, config=True)
264 deep_reload = CBool(False, config=True, help=
264 deep_reload = CBool(False, config=True, help=
265 """
265 """
266 Enable deep (recursive) reloading by default. IPython can use the
266 Enable deep (recursive) reloading by default. IPython can use the
267 deep_reload module which reloads changes in modules recursively (it
267 deep_reload module which reloads changes in modules recursively (it
268 replaces the reload() function, so you don't need to change anything to
268 replaces the reload() function, so you don't need to change anything to
269 use it). deep_reload() forces a full reload of modules whose code may
269 use it). deep_reload() forces a full reload of modules whose code may
270 have changed, which the default reload() function does not. When
270 have changed, which the default reload() function does not. When
271 deep_reload is off, IPython will use the normal reload(), but
271 deep_reload is off, IPython will use the normal reload(), but
272 deep_reload will still be available as dreload().
272 deep_reload will still be available as dreload().
273 """
273 """
274 )
274 )
275 disable_failing_post_execute = CBool(False, config=True,
275 disable_failing_post_execute = CBool(False, config=True,
276 help="Don't call post-execute functions that have failed in the past."
276 help="Don't call post-execute functions that have failed in the past."
277 )
277 )
278 display_formatter = Instance(DisplayFormatter)
278 display_formatter = Instance(DisplayFormatter)
279 displayhook_class = Type(DisplayHook)
279 displayhook_class = Type(DisplayHook)
280 display_pub_class = Type(DisplayPublisher)
280 display_pub_class = Type(DisplayPublisher)
281 data_pub_class = None
281 data_pub_class = None
282
282
283 exit_now = CBool(False)
283 exit_now = CBool(False)
284 exiter = Instance(ExitAutocall)
284 exiter = Instance(ExitAutocall)
285 def _exiter_default(self):
285 def _exiter_default(self):
286 return ExitAutocall(self)
286 return ExitAutocall(self)
287 # Monotonically increasing execution counter
287 # Monotonically increasing execution counter
288 execution_count = Integer(1)
288 execution_count = Integer(1)
289 filename = Unicode("<ipython console>")
289 filename = Unicode("<ipython console>")
290 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
290 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
291
291
292 # Input splitter, to transform input line by line and detect when a block
292 # Input splitter, to transform input line by line and detect when a block
293 # is ready to be executed.
293 # is ready to be executed.
294 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
294 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
295 (), {'line_input_checker': True})
295 (), {'line_input_checker': True})
296
296
297 # This InputSplitter instance is used to transform completed cells before
297 # This InputSplitter instance is used to transform completed cells before
298 # running them. It allows cell magics to contain blank lines.
298 # running them. It allows cell magics to contain blank lines.
299 input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
299 input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
300 (), {'line_input_checker': False})
300 (), {'line_input_checker': False})
301
301
302 logstart = CBool(False, config=True, help=
302 logstart = CBool(False, config=True, help=
303 """
303 """
304 Start logging to the default log file.
304 Start logging to the default log file.
305 """
305 """
306 )
306 )
307 logfile = Unicode('', config=True, help=
307 logfile = Unicode('', config=True, help=
308 """
308 """
309 The name of the logfile to use.
309 The name of the logfile to use.
310 """
310 """
311 )
311 )
312 logappend = Unicode('', config=True, help=
312 logappend = Unicode('', config=True, help=
313 """
313 """
314 Start logging to the given file in append mode.
314 Start logging to the given file in append mode.
315 """
315 """
316 )
316 )
317 object_info_string_level = Enum((0,1,2), default_value=0,
317 object_info_string_level = Enum((0,1,2), default_value=0,
318 config=True)
318 config=True)
319 pdb = CBool(False, config=True, help=
319 pdb = CBool(False, config=True, help=
320 """
320 """
321 Automatically call the pdb debugger after every exception.
321 Automatically call the pdb debugger after every exception.
322 """
322 """
323 )
323 )
324 multiline_history = CBool(sys.platform != 'win32', config=True,
324 multiline_history = CBool(sys.platform != 'win32', config=True,
325 help="Save multi-line entries as one entry in readline history"
325 help="Save multi-line entries as one entry in readline history"
326 )
326 )
327
327
328 # deprecated prompt traits:
328 # deprecated prompt traits:
329
329
330 prompt_in1 = Unicode('In [\\#]: ', config=True,
330 prompt_in1 = Unicode('In [\\#]: ', config=True,
331 help="Deprecated, use PromptManager.in_template")
331 help="Deprecated, use PromptManager.in_template")
332 prompt_in2 = Unicode(' .\\D.: ', config=True,
332 prompt_in2 = Unicode(' .\\D.: ', config=True,
333 help="Deprecated, use PromptManager.in2_template")
333 help="Deprecated, use PromptManager.in2_template")
334 prompt_out = Unicode('Out[\\#]: ', config=True,
334 prompt_out = Unicode('Out[\\#]: ', config=True,
335 help="Deprecated, use PromptManager.out_template")
335 help="Deprecated, use PromptManager.out_template")
336 prompts_pad_left = CBool(True, config=True,
336 prompts_pad_left = CBool(True, config=True,
337 help="Deprecated, use PromptManager.justify")
337 help="Deprecated, use PromptManager.justify")
338
338
339 def _prompt_trait_changed(self, name, old, new):
339 def _prompt_trait_changed(self, name, old, new):
340 table = {
340 table = {
341 'prompt_in1' : 'in_template',
341 'prompt_in1' : 'in_template',
342 'prompt_in2' : 'in2_template',
342 'prompt_in2' : 'in2_template',
343 'prompt_out' : 'out_template',
343 'prompt_out' : 'out_template',
344 'prompts_pad_left' : 'justify',
344 'prompts_pad_left' : 'justify',
345 }
345 }
346 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format(
346 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}".format(
347 name=name, newname=table[name])
347 name=name, newname=table[name])
348 )
348 )
349 # protect against weird cases where self.config may not exist:
349 # protect against weird cases where self.config may not exist:
350 if self.config is not None:
350 if self.config is not None:
351 # propagate to corresponding PromptManager trait
351 # propagate to corresponding PromptManager trait
352 setattr(self.config.PromptManager, table[name], new)
352 setattr(self.config.PromptManager, table[name], new)
353
353
354 _prompt_in1_changed = _prompt_trait_changed
354 _prompt_in1_changed = _prompt_trait_changed
355 _prompt_in2_changed = _prompt_trait_changed
355 _prompt_in2_changed = _prompt_trait_changed
356 _prompt_out_changed = _prompt_trait_changed
356 _prompt_out_changed = _prompt_trait_changed
357 _prompt_pad_left_changed = _prompt_trait_changed
357 _prompt_pad_left_changed = _prompt_trait_changed
358
358
359 show_rewritten_input = CBool(True, config=True,
359 show_rewritten_input = CBool(True, config=True,
360 help="Show rewritten input, e.g. for autocall."
360 help="Show rewritten input, e.g. for autocall."
361 )
361 )
362
362
363 quiet = CBool(False, config=True)
363 quiet = CBool(False, config=True)
364
364
365 history_length = Integer(10000, config=True)
365 history_length = Integer(10000, config=True)
366
366
367 # The readline stuff will eventually be moved to the terminal subclass
367 # The readline stuff will eventually be moved to the terminal subclass
368 # but for now, we can't do that as readline is welded in everywhere.
368 # but for now, we can't do that as readline is welded in everywhere.
369 readline_use = CBool(True, config=True)
369 readline_use = CBool(True, config=True)
370 readline_remove_delims = Unicode('-/~', config=True)
370 readline_remove_delims = Unicode('-/~', config=True)
371 readline_delims = Unicode() # set by init_readline()
371 readline_delims = Unicode() # set by init_readline()
372 # don't use \M- bindings by default, because they
372 # don't use \M- bindings by default, because they
373 # conflict with 8-bit encodings. See gh-58,gh-88
373 # conflict with 8-bit encodings. See gh-58,gh-88
374 readline_parse_and_bind = List([
374 readline_parse_and_bind = List([
375 'tab: complete',
375 'tab: complete',
376 '"\C-l": clear-screen',
376 '"\C-l": clear-screen',
377 'set show-all-if-ambiguous on',
377 'set show-all-if-ambiguous on',
378 '"\C-o": tab-insert',
378 '"\C-o": tab-insert',
379 '"\C-r": reverse-search-history',
379 '"\C-r": reverse-search-history',
380 '"\C-s": forward-search-history',
380 '"\C-s": forward-search-history',
381 '"\C-p": history-search-backward',
381 '"\C-p": history-search-backward',
382 '"\C-n": history-search-forward',
382 '"\C-n": history-search-forward',
383 '"\e[A": history-search-backward',
383 '"\e[A": history-search-backward',
384 '"\e[B": history-search-forward',
384 '"\e[B": history-search-forward',
385 '"\C-k": kill-line',
385 '"\C-k": kill-line',
386 '"\C-u": unix-line-discard',
386 '"\C-u": unix-line-discard',
387 ], allow_none=False, config=True)
387 ], allow_none=False, config=True)
388
388
389 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'],
389 ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'],
390 default_value='last_expr', config=True,
390 default_value='last_expr', config=True,
391 help="""
391 help="""
392 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
392 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
393 run interactively (displaying output from expressions).""")
393 run interactively (displaying output from expressions).""")
394
394
395 # TODO: this part of prompt management should be moved to the frontends.
395 # TODO: this part of prompt management should be moved to the frontends.
396 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
396 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
397 separate_in = SeparateUnicode('\n', config=True)
397 separate_in = SeparateUnicode('\n', config=True)
398 separate_out = SeparateUnicode('', config=True)
398 separate_out = SeparateUnicode('', config=True)
399 separate_out2 = SeparateUnicode('', config=True)
399 separate_out2 = SeparateUnicode('', config=True)
400 wildcards_case_sensitive = CBool(True, config=True)
400 wildcards_case_sensitive = CBool(True, config=True)
401 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
401 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
402 default_value='Context', config=True)
402 default_value='Context', config=True)
403
403
404 # Subcomponents of InteractiveShell
404 # Subcomponents of InteractiveShell
405 alias_manager = Instance('IPython.core.alias.AliasManager')
405 alias_manager = Instance('IPython.core.alias.AliasManager')
406 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
406 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
407 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
407 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
408 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
408 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
409 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
409 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
410 payload_manager = Instance('IPython.core.payload.PayloadManager')
410 payload_manager = Instance('IPython.core.payload.PayloadManager')
411 history_manager = Instance('IPython.core.history.HistoryManager')
411 history_manager = Instance('IPython.core.history.HistoryManager')
412 magics_manager = Instance('IPython.core.magic.MagicsManager')
412 magics_manager = Instance('IPython.core.magic.MagicsManager')
413
413
414 profile_dir = Instance('IPython.core.application.ProfileDir')
414 profile_dir = Instance('IPython.core.application.ProfileDir')
415 @property
415 @property
416 def profile(self):
416 def profile(self):
417 if self.profile_dir is not None:
417 if self.profile_dir is not None:
418 name = os.path.basename(self.profile_dir.location)
418 name = os.path.basename(self.profile_dir.location)
419 return name.replace('profile_','')
419 return name.replace('profile_','')
420
420
421
421
422 # Private interface
422 # Private interface
423 _post_execute = Instance(dict)
423 _post_execute = Instance(dict)
424
424
425 # Tracks any GUI loop loaded for pylab
425 # Tracks any GUI loop loaded for pylab
426 pylab_gui_select = None
426 pylab_gui_select = None
427
427
428 def __init__(self, ipython_dir=None, profile_dir=None,
428 def __init__(self, ipython_dir=None, profile_dir=None,
429 user_module=None, user_ns=None,
429 user_module=None, user_ns=None,
430 custom_exceptions=((), None), **kwargs):
430 custom_exceptions=((), None), **kwargs):
431
431
432 # This is where traits with a config_key argument are updated
432 # This is where traits with a config_key argument are updated
433 # from the values on config.
433 # from the values on config.
434 super(InteractiveShell, self).__init__(**kwargs)
434 super(InteractiveShell, self).__init__(**kwargs)
435 self.configurables = [self]
435 self.configurables = [self]
436
436
437 # These are relatively independent and stateless
437 # These are relatively independent and stateless
438 self.init_ipython_dir(ipython_dir)
438 self.init_ipython_dir(ipython_dir)
439 self.init_profile_dir(profile_dir)
439 self.init_profile_dir(profile_dir)
440 self.init_instance_attrs()
440 self.init_instance_attrs()
441 self.init_environment()
441 self.init_environment()
442
442
443 # Check if we're in a virtualenv, and set up sys.path.
443 # Check if we're in a virtualenv, and set up sys.path.
444 self.init_virtualenv()
444 self.init_virtualenv()
445
445
446 # Create namespaces (user_ns, user_global_ns, etc.)
446 # Create namespaces (user_ns, user_global_ns, etc.)
447 self.init_create_namespaces(user_module, user_ns)
447 self.init_create_namespaces(user_module, user_ns)
448 # This has to be done after init_create_namespaces because it uses
448 # This has to be done after init_create_namespaces because it uses
449 # something in self.user_ns, but before init_sys_modules, which
449 # something in self.user_ns, but before init_sys_modules, which
450 # is the first thing to modify sys.
450 # is the first thing to modify sys.
451 # TODO: When we override sys.stdout and sys.stderr before this class
451 # TODO: When we override sys.stdout and sys.stderr before this class
452 # is created, we are saving the overridden ones here. Not sure if this
452 # is created, we are saving the overridden ones here. Not sure if this
453 # is what we want to do.
453 # is what we want to do.
454 self.save_sys_module_state()
454 self.save_sys_module_state()
455 self.init_sys_modules()
455 self.init_sys_modules()
456
456
457 # While we're trying to have each part of the code directly access what
457 # While we're trying to have each part of the code directly access what
458 # it needs without keeping redundant references to objects, we have too
458 # it needs without keeping redundant references to objects, we have too
459 # much legacy code that expects ip.db to exist.
459 # much legacy code that expects ip.db to exist.
460 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
460 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
461
461
462 self.init_history()
462 self.init_history()
463 self.init_encoding()
463 self.init_encoding()
464 self.init_prefilter()
464 self.init_prefilter()
465
465
466 self.init_syntax_highlighting()
466 self.init_syntax_highlighting()
467 self.init_hooks()
467 self.init_hooks()
468 self.init_pushd_popd_magic()
468 self.init_pushd_popd_magic()
469 # self.init_traceback_handlers use to be here, but we moved it below
469 # self.init_traceback_handlers use to be here, but we moved it below
470 # because it and init_io have to come after init_readline.
470 # because it and init_io have to come after init_readline.
471 self.init_user_ns()
471 self.init_user_ns()
472 self.init_logger()
472 self.init_logger()
473 self.init_alias()
474 self.init_builtins()
473 self.init_builtins()
475
474
476 # The following was in post_config_initialization
475 # The following was in post_config_initialization
477 self.init_inspector()
476 self.init_inspector()
478 # init_readline() must come before init_io(), because init_io uses
477 # init_readline() must come before init_io(), because init_io uses
479 # readline related things.
478 # readline related things.
480 self.init_readline()
479 self.init_readline()
481 # We save this here in case user code replaces raw_input, but it needs
480 # We save this here in case user code replaces raw_input, but it needs
482 # to be after init_readline(), because PyPy's readline works by replacing
481 # to be after init_readline(), because PyPy's readline works by replacing
483 # raw_input.
482 # raw_input.
484 if py3compat.PY3:
483 if py3compat.PY3:
485 self.raw_input_original = input
484 self.raw_input_original = input
486 else:
485 else:
487 self.raw_input_original = raw_input
486 self.raw_input_original = raw_input
488 # init_completer must come after init_readline, because it needs to
487 # init_completer must come after init_readline, because it needs to
489 # know whether readline is present or not system-wide to configure the
488 # know whether readline is present or not system-wide to configure the
490 # completers, since the completion machinery can now operate
489 # completers, since the completion machinery can now operate
491 # independently of readline (e.g. over the network)
490 # independently of readline (e.g. over the network)
492 self.init_completer()
491 self.init_completer()
493 # TODO: init_io() needs to happen before init_traceback handlers
492 # TODO: init_io() needs to happen before init_traceback handlers
494 # because the traceback handlers hardcode the stdout/stderr streams.
493 # because the traceback handlers hardcode the stdout/stderr streams.
495 # This logic in in debugger.Pdb and should eventually be changed.
494 # This logic in in debugger.Pdb and should eventually be changed.
496 self.init_io()
495 self.init_io()
497 self.init_traceback_handlers(custom_exceptions)
496 self.init_traceback_handlers(custom_exceptions)
498 self.init_prompts()
497 self.init_prompts()
499 self.init_display_formatter()
498 self.init_display_formatter()
500 self.init_display_pub()
499 self.init_display_pub()
501 self.init_data_pub()
500 self.init_data_pub()
502 self.init_displayhook()
501 self.init_displayhook()
503 self.init_latextool()
502 self.init_latextool()
504 self.init_magics()
503 self.init_magics()
504 self.init_alias()
505 self.init_logstart()
505 self.init_logstart()
506 self.init_pdb()
506 self.init_pdb()
507 self.init_extension_manager()
507 self.init_extension_manager()
508 self.init_payload()
508 self.init_payload()
509 self.hooks.late_startup_hook()
509 self.hooks.late_startup_hook()
510 atexit.register(self.atexit_operations)
510 atexit.register(self.atexit_operations)
511
511
512 def get_ipython(self):
512 def get_ipython(self):
513 """Return the currently running IPython instance."""
513 """Return the currently running IPython instance."""
514 return self
514 return self
515
515
516 #-------------------------------------------------------------------------
516 #-------------------------------------------------------------------------
517 # Trait changed handlers
517 # Trait changed handlers
518 #-------------------------------------------------------------------------
518 #-------------------------------------------------------------------------
519
519
520 def _ipython_dir_changed(self, name, new):
520 def _ipython_dir_changed(self, name, new):
521 if not os.path.isdir(new):
521 if not os.path.isdir(new):
522 os.makedirs(new, mode = 0o777)
522 os.makedirs(new, mode = 0o777)
523
523
524 def set_autoindent(self,value=None):
524 def set_autoindent(self,value=None):
525 """Set the autoindent flag, checking for readline support.
525 """Set the autoindent flag, checking for readline support.
526
526
527 If called with no arguments, it acts as a toggle."""
527 If called with no arguments, it acts as a toggle."""
528
528
529 if value != 0 and not self.has_readline:
529 if value != 0 and not self.has_readline:
530 if os.name == 'posix':
530 if os.name == 'posix':
531 warn("The auto-indent feature requires the readline library")
531 warn("The auto-indent feature requires the readline library")
532 self.autoindent = 0
532 self.autoindent = 0
533 return
533 return
534 if value is None:
534 if value is None:
535 self.autoindent = not self.autoindent
535 self.autoindent = not self.autoindent
536 else:
536 else:
537 self.autoindent = value
537 self.autoindent = value
538
538
539 #-------------------------------------------------------------------------
539 #-------------------------------------------------------------------------
540 # init_* methods called by __init__
540 # init_* methods called by __init__
541 #-------------------------------------------------------------------------
541 #-------------------------------------------------------------------------
542
542
543 def init_ipython_dir(self, ipython_dir):
543 def init_ipython_dir(self, ipython_dir):
544 if ipython_dir is not None:
544 if ipython_dir is not None:
545 self.ipython_dir = ipython_dir
545 self.ipython_dir = ipython_dir
546 return
546 return
547
547
548 self.ipython_dir = get_ipython_dir()
548 self.ipython_dir = get_ipython_dir()
549
549
550 def init_profile_dir(self, profile_dir):
550 def init_profile_dir(self, profile_dir):
551 if profile_dir is not None:
551 if profile_dir is not None:
552 self.profile_dir = profile_dir
552 self.profile_dir = profile_dir
553 return
553 return
554 self.profile_dir =\
554 self.profile_dir =\
555 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
555 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
556
556
557 def init_instance_attrs(self):
557 def init_instance_attrs(self):
558 self.more = False
558 self.more = False
559
559
560 # command compiler
560 # command compiler
561 self.compile = CachingCompiler()
561 self.compile = CachingCompiler()
562
562
563 # Make an empty namespace, which extension writers can rely on both
563 # Make an empty namespace, which extension writers can rely on both
564 # existing and NEVER being used by ipython itself. This gives them a
564 # existing and NEVER being used by ipython itself. This gives them a
565 # convenient location for storing additional information and state
565 # convenient location for storing additional information and state
566 # their extensions may require, without fear of collisions with other
566 # their extensions may require, without fear of collisions with other
567 # ipython names that may develop later.
567 # ipython names that may develop later.
568 self.meta = Struct()
568 self.meta = Struct()
569
569
570 # Temporary files used for various purposes. Deleted at exit.
570 # Temporary files used for various purposes. Deleted at exit.
571 self.tempfiles = []
571 self.tempfiles = []
572
572
573 # Keep track of readline usage (later set by init_readline)
573 # Keep track of readline usage (later set by init_readline)
574 self.has_readline = False
574 self.has_readline = False
575
575
576 # keep track of where we started running (mainly for crash post-mortem)
576 # keep track of where we started running (mainly for crash post-mortem)
577 # This is not being used anywhere currently.
577 # This is not being used anywhere currently.
578 self.starting_dir = os.getcwdu()
578 self.starting_dir = os.getcwdu()
579
579
580 # Indentation management
580 # Indentation management
581 self.indent_current_nsp = 0
581 self.indent_current_nsp = 0
582
582
583 # Dict to track post-execution functions that have been registered
583 # Dict to track post-execution functions that have been registered
584 self._post_execute = {}
584 self._post_execute = {}
585
585
586 def init_environment(self):
586 def init_environment(self):
587 """Any changes we need to make to the user's environment."""
587 """Any changes we need to make to the user's environment."""
588 pass
588 pass
589
589
590 def init_encoding(self):
590 def init_encoding(self):
591 # Get system encoding at startup time. Certain terminals (like Emacs
591 # Get system encoding at startup time. Certain terminals (like Emacs
592 # under Win32 have it set to None, and we need to have a known valid
592 # under Win32 have it set to None, and we need to have a known valid
593 # encoding to use in the raw_input() method
593 # encoding to use in the raw_input() method
594 try:
594 try:
595 self.stdin_encoding = sys.stdin.encoding or 'ascii'
595 self.stdin_encoding = sys.stdin.encoding or 'ascii'
596 except AttributeError:
596 except AttributeError:
597 self.stdin_encoding = 'ascii'
597 self.stdin_encoding = 'ascii'
598
598
599 def init_syntax_highlighting(self):
599 def init_syntax_highlighting(self):
600 # Python source parser/formatter for syntax highlighting
600 # Python source parser/formatter for syntax highlighting
601 pyformat = PyColorize.Parser().format
601 pyformat = PyColorize.Parser().format
602 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
602 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
603
603
604 def init_pushd_popd_magic(self):
604 def init_pushd_popd_magic(self):
605 # for pushd/popd management
605 # for pushd/popd management
606 self.home_dir = get_home_dir()
606 self.home_dir = get_home_dir()
607
607
608 self.dir_stack = []
608 self.dir_stack = []
609
609
610 def init_logger(self):
610 def init_logger(self):
611 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
611 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
612 logmode='rotate')
612 logmode='rotate')
613
613
614 def init_logstart(self):
614 def init_logstart(self):
615 """Initialize logging in case it was requested at the command line.
615 """Initialize logging in case it was requested at the command line.
616 """
616 """
617 if self.logappend:
617 if self.logappend:
618 self.magic('logstart %s append' % self.logappend)
618 self.magic('logstart %s append' % self.logappend)
619 elif self.logfile:
619 elif self.logfile:
620 self.magic('logstart %s' % self.logfile)
620 self.magic('logstart %s' % self.logfile)
621 elif self.logstart:
621 elif self.logstart:
622 self.magic('logstart')
622 self.magic('logstart')
623
623
624 def init_builtins(self):
624 def init_builtins(self):
625 # A single, static flag that we set to True. Its presence indicates
625 # A single, static flag that we set to True. Its presence indicates
626 # that an IPython shell has been created, and we make no attempts at
626 # that an IPython shell has been created, and we make no attempts at
627 # removing on exit or representing the existence of more than one
627 # removing on exit or representing the existence of more than one
628 # IPython at a time.
628 # IPython at a time.
629 builtin_mod.__dict__['__IPYTHON__'] = True
629 builtin_mod.__dict__['__IPYTHON__'] = True
630
630
631 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
631 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
632 # manage on enter/exit, but with all our shells it's virtually
632 # manage on enter/exit, but with all our shells it's virtually
633 # impossible to get all the cases right. We're leaving the name in for
633 # impossible to get all the cases right. We're leaving the name in for
634 # those who adapted their codes to check for this flag, but will
634 # those who adapted their codes to check for this flag, but will
635 # eventually remove it after a few more releases.
635 # eventually remove it after a few more releases.
636 builtin_mod.__dict__['__IPYTHON__active'] = \
636 builtin_mod.__dict__['__IPYTHON__active'] = \
637 'Deprecated, check for __IPYTHON__'
637 'Deprecated, check for __IPYTHON__'
638
638
639 self.builtin_trap = BuiltinTrap(shell=self)
639 self.builtin_trap = BuiltinTrap(shell=self)
640
640
641 def init_inspector(self):
641 def init_inspector(self):
642 # Object inspector
642 # Object inspector
643 self.inspector = oinspect.Inspector(oinspect.InspectColors,
643 self.inspector = oinspect.Inspector(oinspect.InspectColors,
644 PyColorize.ANSICodeColors,
644 PyColorize.ANSICodeColors,
645 'NoColor',
645 'NoColor',
646 self.object_info_string_level)
646 self.object_info_string_level)
647
647
648 def init_io(self):
648 def init_io(self):
649 # This will just use sys.stdout and sys.stderr. If you want to
649 # This will just use sys.stdout and sys.stderr. If you want to
650 # override sys.stdout and sys.stderr themselves, you need to do that
650 # override sys.stdout and sys.stderr themselves, you need to do that
651 # *before* instantiating this class, because io holds onto
651 # *before* instantiating this class, because io holds onto
652 # references to the underlying streams.
652 # references to the underlying streams.
653 if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline:
653 if (sys.platform == 'win32' or sys.platform == 'cli') and self.has_readline:
654 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
654 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
655 else:
655 else:
656 io.stdout = io.IOStream(sys.stdout)
656 io.stdout = io.IOStream(sys.stdout)
657 io.stderr = io.IOStream(sys.stderr)
657 io.stderr = io.IOStream(sys.stderr)
658
658
659 def init_prompts(self):
659 def init_prompts(self):
660 self.prompt_manager = PromptManager(shell=self, parent=self)
660 self.prompt_manager = PromptManager(shell=self, parent=self)
661 self.configurables.append(self.prompt_manager)
661 self.configurables.append(self.prompt_manager)
662 # Set system prompts, so that scripts can decide if they are running
662 # Set system prompts, so that scripts can decide if they are running
663 # interactively.
663 # interactively.
664 sys.ps1 = 'In : '
664 sys.ps1 = 'In : '
665 sys.ps2 = '...: '
665 sys.ps2 = '...: '
666 sys.ps3 = 'Out: '
666 sys.ps3 = 'Out: '
667
667
668 def init_display_formatter(self):
668 def init_display_formatter(self):
669 self.display_formatter = DisplayFormatter(parent=self)
669 self.display_formatter = DisplayFormatter(parent=self)
670 self.configurables.append(self.display_formatter)
670 self.configurables.append(self.display_formatter)
671
671
672 def init_display_pub(self):
672 def init_display_pub(self):
673 self.display_pub = self.display_pub_class(parent=self)
673 self.display_pub = self.display_pub_class(parent=self)
674 self.configurables.append(self.display_pub)
674 self.configurables.append(self.display_pub)
675
675
676 def init_data_pub(self):
676 def init_data_pub(self):
677 if not self.data_pub_class:
677 if not self.data_pub_class:
678 self.data_pub = None
678 self.data_pub = None
679 return
679 return
680 self.data_pub = self.data_pub_class(parent=self)
680 self.data_pub = self.data_pub_class(parent=self)
681 self.configurables.append(self.data_pub)
681 self.configurables.append(self.data_pub)
682
682
683 def init_displayhook(self):
683 def init_displayhook(self):
684 # Initialize displayhook, set in/out prompts and printing system
684 # Initialize displayhook, set in/out prompts and printing system
685 self.displayhook = self.displayhook_class(
685 self.displayhook = self.displayhook_class(
686 parent=self,
686 parent=self,
687 shell=self,
687 shell=self,
688 cache_size=self.cache_size,
688 cache_size=self.cache_size,
689 )
689 )
690 self.configurables.append(self.displayhook)
690 self.configurables.append(self.displayhook)
691 # This is a context manager that installs/revmoes the displayhook at
691 # This is a context manager that installs/revmoes the displayhook at
692 # the appropriate time.
692 # the appropriate time.
693 self.display_trap = DisplayTrap(hook=self.displayhook)
693 self.display_trap = DisplayTrap(hook=self.displayhook)
694
694
695 def init_latextool(self):
695 def init_latextool(self):
696 """Configure LaTeXTool."""
696 """Configure LaTeXTool."""
697 cfg = LaTeXTool.instance(parent=self)
697 cfg = LaTeXTool.instance(parent=self)
698 if cfg not in self.configurables:
698 if cfg not in self.configurables:
699 self.configurables.append(cfg)
699 self.configurables.append(cfg)
700
700
701 def init_virtualenv(self):
701 def init_virtualenv(self):
702 """Add a virtualenv to sys.path so the user can import modules from it.
702 """Add a virtualenv to sys.path so the user can import modules from it.
703 This isn't perfect: it doesn't use the Python interpreter with which the
703 This isn't perfect: it doesn't use the Python interpreter with which the
704 virtualenv was built, and it ignores the --no-site-packages option. A
704 virtualenv was built, and it ignores the --no-site-packages option. A
705 warning will appear suggesting the user installs IPython in the
705 warning will appear suggesting the user installs IPython in the
706 virtualenv, but for many cases, it probably works well enough.
706 virtualenv, but for many cases, it probably works well enough.
707
707
708 Adapted from code snippets online.
708 Adapted from code snippets online.
709
709
710 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
710 http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv
711 """
711 """
712 if 'VIRTUAL_ENV' not in os.environ:
712 if 'VIRTUAL_ENV' not in os.environ:
713 # Not in a virtualenv
713 # Not in a virtualenv
714 return
714 return
715
715
716 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
716 if sys.executable.startswith(os.environ['VIRTUAL_ENV']):
717 # Running properly in the virtualenv, don't need to do anything
717 # Running properly in the virtualenv, don't need to do anything
718 return
718 return
719
719
720 warn("Attempting to work in a virtualenv. If you encounter problems, please "
720 warn("Attempting to work in a virtualenv. If you encounter problems, please "
721 "install IPython inside the virtualenv.")
721 "install IPython inside the virtualenv.")
722 if sys.platform == "win32":
722 if sys.platform == "win32":
723 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
723 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')
724 else:
724 else:
725 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
725 virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',
726 'python%d.%d' % sys.version_info[:2], 'site-packages')
726 'python%d.%d' % sys.version_info[:2], 'site-packages')
727
727
728 import site
728 import site
729 sys.path.insert(0, virtual_env)
729 sys.path.insert(0, virtual_env)
730 site.addsitedir(virtual_env)
730 site.addsitedir(virtual_env)
731
731
732 #-------------------------------------------------------------------------
732 #-------------------------------------------------------------------------
733 # Things related to injections into the sys module
733 # Things related to injections into the sys module
734 #-------------------------------------------------------------------------
734 #-------------------------------------------------------------------------
735
735
736 def save_sys_module_state(self):
736 def save_sys_module_state(self):
737 """Save the state of hooks in the sys module.
737 """Save the state of hooks in the sys module.
738
738
739 This has to be called after self.user_module is created.
739 This has to be called after self.user_module is created.
740 """
740 """
741 self._orig_sys_module_state = {}
741 self._orig_sys_module_state = {}
742 self._orig_sys_module_state['stdin'] = sys.stdin
742 self._orig_sys_module_state['stdin'] = sys.stdin
743 self._orig_sys_module_state['stdout'] = sys.stdout
743 self._orig_sys_module_state['stdout'] = sys.stdout
744 self._orig_sys_module_state['stderr'] = sys.stderr
744 self._orig_sys_module_state['stderr'] = sys.stderr
745 self._orig_sys_module_state['excepthook'] = sys.excepthook
745 self._orig_sys_module_state['excepthook'] = sys.excepthook
746 self._orig_sys_modules_main_name = self.user_module.__name__
746 self._orig_sys_modules_main_name = self.user_module.__name__
747 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
747 self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)
748
748
749 def restore_sys_module_state(self):
749 def restore_sys_module_state(self):
750 """Restore the state of the sys module."""
750 """Restore the state of the sys module."""
751 try:
751 try:
752 for k, v in self._orig_sys_module_state.iteritems():
752 for k, v in self._orig_sys_module_state.iteritems():
753 setattr(sys, k, v)
753 setattr(sys, k, v)
754 except AttributeError:
754 except AttributeError:
755 pass
755 pass
756 # Reset what what done in self.init_sys_modules
756 # Reset what what done in self.init_sys_modules
757 if self._orig_sys_modules_main_mod is not None:
757 if self._orig_sys_modules_main_mod is not None:
758 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
758 sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod
759
759
760 #-------------------------------------------------------------------------
760 #-------------------------------------------------------------------------
761 # Things related to hooks
761 # Things related to hooks
762 #-------------------------------------------------------------------------
762 #-------------------------------------------------------------------------
763
763
764 def init_hooks(self):
764 def init_hooks(self):
765 # hooks holds pointers used for user-side customizations
765 # hooks holds pointers used for user-side customizations
766 self.hooks = Struct()
766 self.hooks = Struct()
767
767
768 self.strdispatchers = {}
768 self.strdispatchers = {}
769
769
770 # Set all default hooks, defined in the IPython.hooks module.
770 # Set all default hooks, defined in the IPython.hooks module.
771 hooks = IPython.core.hooks
771 hooks = IPython.core.hooks
772 for hook_name in hooks.__all__:
772 for hook_name in hooks.__all__:
773 # default hooks have priority 100, i.e. low; user hooks should have
773 # default hooks have priority 100, i.e. low; user hooks should have
774 # 0-100 priority
774 # 0-100 priority
775 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
775 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
776
776
777 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
777 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
778 """set_hook(name,hook) -> sets an internal IPython hook.
778 """set_hook(name,hook) -> sets an internal IPython hook.
779
779
780 IPython exposes some of its internal API as user-modifiable hooks. By
780 IPython exposes some of its internal API as user-modifiable hooks. By
781 adding your function to one of these hooks, you can modify IPython's
781 adding your function to one of these hooks, you can modify IPython's
782 behavior to call at runtime your own routines."""
782 behavior to call at runtime your own routines."""
783
783
784 # At some point in the future, this should validate the hook before it
784 # At some point in the future, this should validate the hook before it
785 # accepts it. Probably at least check that the hook takes the number
785 # accepts it. Probably at least check that the hook takes the number
786 # of args it's supposed to.
786 # of args it's supposed to.
787
787
788 f = types.MethodType(hook,self)
788 f = types.MethodType(hook,self)
789
789
790 # check if the hook is for strdispatcher first
790 # check if the hook is for strdispatcher first
791 if str_key is not None:
791 if str_key is not None:
792 sdp = self.strdispatchers.get(name, StrDispatch())
792 sdp = self.strdispatchers.get(name, StrDispatch())
793 sdp.add_s(str_key, f, priority )
793 sdp.add_s(str_key, f, priority )
794 self.strdispatchers[name] = sdp
794 self.strdispatchers[name] = sdp
795 return
795 return
796 if re_key is not None:
796 if re_key is not None:
797 sdp = self.strdispatchers.get(name, StrDispatch())
797 sdp = self.strdispatchers.get(name, StrDispatch())
798 sdp.add_re(re.compile(re_key), f, priority )
798 sdp.add_re(re.compile(re_key), f, priority )
799 self.strdispatchers[name] = sdp
799 self.strdispatchers[name] = sdp
800 return
800 return
801
801
802 dp = getattr(self.hooks, name, None)
802 dp = getattr(self.hooks, name, None)
803 if name not in IPython.core.hooks.__all__:
803 if name not in IPython.core.hooks.__all__:
804 print("Warning! Hook '%s' is not one of %s" % \
804 print("Warning! Hook '%s' is not one of %s" % \
805 (name, IPython.core.hooks.__all__ ))
805 (name, IPython.core.hooks.__all__ ))
806 if not dp:
806 if not dp:
807 dp = IPython.core.hooks.CommandChainDispatcher()
807 dp = IPython.core.hooks.CommandChainDispatcher()
808
808
809 try:
809 try:
810 dp.add(f,priority)
810 dp.add(f,priority)
811 except AttributeError:
811 except AttributeError:
812 # it was not commandchain, plain old func - replace
812 # it was not commandchain, plain old func - replace
813 dp = f
813 dp = f
814
814
815 setattr(self.hooks,name, dp)
815 setattr(self.hooks,name, dp)
816
816
817 def register_post_execute(self, func):
817 def register_post_execute(self, func):
818 """Register a function for calling after code execution.
818 """Register a function for calling after code execution.
819 """
819 """
820 if not callable(func):
820 if not callable(func):
821 raise ValueError('argument %s must be callable' % func)
821 raise ValueError('argument %s must be callable' % func)
822 self._post_execute[func] = True
822 self._post_execute[func] = True
823
823
824 #-------------------------------------------------------------------------
824 #-------------------------------------------------------------------------
825 # Things related to the "main" module
825 # Things related to the "main" module
826 #-------------------------------------------------------------------------
826 #-------------------------------------------------------------------------
827
827
828 def new_main_mod(self, filename, modname):
828 def new_main_mod(self, filename, modname):
829 """Return a new 'main' module object for user code execution.
829 """Return a new 'main' module object for user code execution.
830
830
831 ``filename`` should be the path of the script which will be run in the
831 ``filename`` should be the path of the script which will be run in the
832 module. Requests with the same filename will get the same module, with
832 module. Requests with the same filename will get the same module, with
833 its namespace cleared.
833 its namespace cleared.
834
834
835 ``modname`` should be the module name - normally either '__main__' or
835 ``modname`` should be the module name - normally either '__main__' or
836 the basename of the file without the extension.
836 the basename of the file without the extension.
837
837
838 When scripts are executed via %run, we must keep a reference to their
838 When scripts are executed via %run, we must keep a reference to their
839 __main__ module around so that Python doesn't
839 __main__ module around so that Python doesn't
840 clear it, rendering references to module globals useless.
840 clear it, rendering references to module globals useless.
841
841
842 This method keeps said reference in a private dict, keyed by the
842 This method keeps said reference in a private dict, keyed by the
843 absolute path of the script. This way, for multiple executions of the
843 absolute path of the script. This way, for multiple executions of the
844 same script we only keep one copy of the namespace (the last one),
844 same script we only keep one copy of the namespace (the last one),
845 thus preventing memory leaks from old references while allowing the
845 thus preventing memory leaks from old references while allowing the
846 objects from the last execution to be accessible.
846 objects from the last execution to be accessible.
847 """
847 """
848 filename = os.path.abspath(filename)
848 filename = os.path.abspath(filename)
849 try:
849 try:
850 main_mod = self._main_mod_cache[filename]
850 main_mod = self._main_mod_cache[filename]
851 except KeyError:
851 except KeyError:
852 main_mod = self._main_mod_cache[filename] = types.ModuleType(modname,
852 main_mod = self._main_mod_cache[filename] = types.ModuleType(modname,
853 doc="Module created for script run in IPython")
853 doc="Module created for script run in IPython")
854 else:
854 else:
855 main_mod.__dict__.clear()
855 main_mod.__dict__.clear()
856 main_mod.__name__ = modname
856 main_mod.__name__ = modname
857
857
858 main_mod.__file__ = filename
858 main_mod.__file__ = filename
859 # It seems pydoc (and perhaps others) needs any module instance to
859 # It seems pydoc (and perhaps others) needs any module instance to
860 # implement a __nonzero__ method
860 # implement a __nonzero__ method
861 main_mod.__nonzero__ = lambda : True
861 main_mod.__nonzero__ = lambda : True
862
862
863 return main_mod
863 return main_mod
864
864
865 def clear_main_mod_cache(self):
865 def clear_main_mod_cache(self):
866 """Clear the cache of main modules.
866 """Clear the cache of main modules.
867
867
868 Mainly for use by utilities like %reset.
868 Mainly for use by utilities like %reset.
869
869
870 Examples
870 Examples
871 --------
871 --------
872
872
873 In [15]: import IPython
873 In [15]: import IPython
874
874
875 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
875 In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')
876
876
877 In [17]: len(_ip._main_mod_cache) > 0
877 In [17]: len(_ip._main_mod_cache) > 0
878 Out[17]: True
878 Out[17]: True
879
879
880 In [18]: _ip.clear_main_mod_cache()
880 In [18]: _ip.clear_main_mod_cache()
881
881
882 In [19]: len(_ip._main_mod_cache) == 0
882 In [19]: len(_ip._main_mod_cache) == 0
883 Out[19]: True
883 Out[19]: True
884 """
884 """
885 self._main_mod_cache.clear()
885 self._main_mod_cache.clear()
886
886
887 #-------------------------------------------------------------------------
887 #-------------------------------------------------------------------------
888 # Things related to debugging
888 # Things related to debugging
889 #-------------------------------------------------------------------------
889 #-------------------------------------------------------------------------
890
890
891 def init_pdb(self):
891 def init_pdb(self):
892 # Set calling of pdb on exceptions
892 # Set calling of pdb on exceptions
893 # self.call_pdb is a property
893 # self.call_pdb is a property
894 self.call_pdb = self.pdb
894 self.call_pdb = self.pdb
895
895
896 def _get_call_pdb(self):
896 def _get_call_pdb(self):
897 return self._call_pdb
897 return self._call_pdb
898
898
899 def _set_call_pdb(self,val):
899 def _set_call_pdb(self,val):
900
900
901 if val not in (0,1,False,True):
901 if val not in (0,1,False,True):
902 raise ValueError('new call_pdb value must be boolean')
902 raise ValueError('new call_pdb value must be boolean')
903
903
904 # store value in instance
904 # store value in instance
905 self._call_pdb = val
905 self._call_pdb = val
906
906
907 # notify the actual exception handlers
907 # notify the actual exception handlers
908 self.InteractiveTB.call_pdb = val
908 self.InteractiveTB.call_pdb = val
909
909
910 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
910 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
911 'Control auto-activation of pdb at exceptions')
911 'Control auto-activation of pdb at exceptions')
912
912
913 def debugger(self,force=False):
913 def debugger(self,force=False):
914 """Call the pydb/pdb debugger.
914 """Call the pydb/pdb debugger.
915
915
916 Keywords:
916 Keywords:
917
917
918 - force(False): by default, this routine checks the instance call_pdb
918 - force(False): by default, this routine checks the instance call_pdb
919 flag and does not actually invoke the debugger if the flag is false.
919 flag and does not actually invoke the debugger if the flag is false.
920 The 'force' option forces the debugger to activate even if the flag
920 The 'force' option forces the debugger to activate even if the flag
921 is false.
921 is false.
922 """
922 """
923
923
924 if not (force or self.call_pdb):
924 if not (force or self.call_pdb):
925 return
925 return
926
926
927 if not hasattr(sys,'last_traceback'):
927 if not hasattr(sys,'last_traceback'):
928 error('No traceback has been produced, nothing to debug.')
928 error('No traceback has been produced, nothing to debug.')
929 return
929 return
930
930
931 # use pydb if available
931 # use pydb if available
932 if debugger.has_pydb:
932 if debugger.has_pydb:
933 from pydb import pm
933 from pydb import pm
934 else:
934 else:
935 # fallback to our internal debugger
935 # fallback to our internal debugger
936 pm = lambda : self.InteractiveTB.debugger(force=True)
936 pm = lambda : self.InteractiveTB.debugger(force=True)
937
937
938 with self.readline_no_record:
938 with self.readline_no_record:
939 pm()
939 pm()
940
940
941 #-------------------------------------------------------------------------
941 #-------------------------------------------------------------------------
942 # Things related to IPython's various namespaces
942 # Things related to IPython's various namespaces
943 #-------------------------------------------------------------------------
943 #-------------------------------------------------------------------------
944 default_user_namespaces = True
944 default_user_namespaces = True
945
945
946 def init_create_namespaces(self, user_module=None, user_ns=None):
946 def init_create_namespaces(self, user_module=None, user_ns=None):
947 # Create the namespace where the user will operate. user_ns is
947 # Create the namespace where the user will operate. user_ns is
948 # normally the only one used, and it is passed to the exec calls as
948 # normally the only one used, and it is passed to the exec calls as
949 # the locals argument. But we do carry a user_global_ns namespace
949 # the locals argument. But we do carry a user_global_ns namespace
950 # given as the exec 'globals' argument, This is useful in embedding
950 # given as the exec 'globals' argument, This is useful in embedding
951 # situations where the ipython shell opens in a context where the
951 # situations where the ipython shell opens in a context where the
952 # distinction between locals and globals is meaningful. For
952 # distinction between locals and globals is meaningful. For
953 # non-embedded contexts, it is just the same object as the user_ns dict.
953 # non-embedded contexts, it is just the same object as the user_ns dict.
954
954
955 # FIXME. For some strange reason, __builtins__ is showing up at user
955 # FIXME. For some strange reason, __builtins__ is showing up at user
956 # level as a dict instead of a module. This is a manual fix, but I
956 # level as a dict instead of a module. This is a manual fix, but I
957 # should really track down where the problem is coming from. Alex
957 # should really track down where the problem is coming from. Alex
958 # Schmolck reported this problem first.
958 # Schmolck reported this problem first.
959
959
960 # A useful post by Alex Martelli on this topic:
960 # A useful post by Alex Martelli on this topic:
961 # Re: inconsistent value from __builtins__
961 # Re: inconsistent value from __builtins__
962 # Von: Alex Martelli <aleaxit@yahoo.com>
962 # Von: Alex Martelli <aleaxit@yahoo.com>
963 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
963 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
964 # Gruppen: comp.lang.python
964 # Gruppen: comp.lang.python
965
965
966 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
966 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
967 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
967 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
968 # > <type 'dict'>
968 # > <type 'dict'>
969 # > >>> print type(__builtins__)
969 # > >>> print type(__builtins__)
970 # > <type 'module'>
970 # > <type 'module'>
971 # > Is this difference in return value intentional?
971 # > Is this difference in return value intentional?
972
972
973 # Well, it's documented that '__builtins__' can be either a dictionary
973 # Well, it's documented that '__builtins__' can be either a dictionary
974 # or a module, and it's been that way for a long time. Whether it's
974 # or a module, and it's been that way for a long time. Whether it's
975 # intentional (or sensible), I don't know. In any case, the idea is
975 # intentional (or sensible), I don't know. In any case, the idea is
976 # that if you need to access the built-in namespace directly, you
976 # that if you need to access the built-in namespace directly, you
977 # should start with "import __builtin__" (note, no 's') which will
977 # should start with "import __builtin__" (note, no 's') which will
978 # definitely give you a module. Yeah, it's somewhat confusing:-(.
978 # definitely give you a module. Yeah, it's somewhat confusing:-(.
979
979
980 # These routines return a properly built module and dict as needed by
980 # These routines return a properly built module and dict as needed by
981 # the rest of the code, and can also be used by extension writers to
981 # the rest of the code, and can also be used by extension writers to
982 # generate properly initialized namespaces.
982 # generate properly initialized namespaces.
983 if (user_ns is not None) or (user_module is not None):
983 if (user_ns is not None) or (user_module is not None):
984 self.default_user_namespaces = False
984 self.default_user_namespaces = False
985 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
985 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
986
986
987 # A record of hidden variables we have added to the user namespace, so
987 # A record of hidden variables we have added to the user namespace, so
988 # we can list later only variables defined in actual interactive use.
988 # we can list later only variables defined in actual interactive use.
989 self.user_ns_hidden = {}
989 self.user_ns_hidden = {}
990
990
991 # Now that FakeModule produces a real module, we've run into a nasty
991 # Now that FakeModule produces a real module, we've run into a nasty
992 # problem: after script execution (via %run), the module where the user
992 # problem: after script execution (via %run), the module where the user
993 # code ran is deleted. Now that this object is a true module (needed
993 # code ran is deleted. Now that this object is a true module (needed
994 # so docetst and other tools work correctly), the Python module
994 # so docetst and other tools work correctly), the Python module
995 # teardown mechanism runs over it, and sets to None every variable
995 # teardown mechanism runs over it, and sets to None every variable
996 # present in that module. Top-level references to objects from the
996 # present in that module. Top-level references to objects from the
997 # script survive, because the user_ns is updated with them. However,
997 # script survive, because the user_ns is updated with them. However,
998 # calling functions defined in the script that use other things from
998 # calling functions defined in the script that use other things from
999 # the script will fail, because the function's closure had references
999 # the script will fail, because the function's closure had references
1000 # to the original objects, which are now all None. So we must protect
1000 # to the original objects, which are now all None. So we must protect
1001 # these modules from deletion by keeping a cache.
1001 # these modules from deletion by keeping a cache.
1002 #
1002 #
1003 # To avoid keeping stale modules around (we only need the one from the
1003 # To avoid keeping stale modules around (we only need the one from the
1004 # last run), we use a dict keyed with the full path to the script, so
1004 # last run), we use a dict keyed with the full path to the script, so
1005 # only the last version of the module is held in the cache. Note,
1005 # only the last version of the module is held in the cache. Note,
1006 # however, that we must cache the module *namespace contents* (their
1006 # however, that we must cache the module *namespace contents* (their
1007 # __dict__). Because if we try to cache the actual modules, old ones
1007 # __dict__). Because if we try to cache the actual modules, old ones
1008 # (uncached) could be destroyed while still holding references (such as
1008 # (uncached) could be destroyed while still holding references (such as
1009 # those held by GUI objects that tend to be long-lived)>
1009 # those held by GUI objects that tend to be long-lived)>
1010 #
1010 #
1011 # The %reset command will flush this cache. See the cache_main_mod()
1011 # The %reset command will flush this cache. See the cache_main_mod()
1012 # and clear_main_mod_cache() methods for details on use.
1012 # and clear_main_mod_cache() methods for details on use.
1013
1013
1014 # This is the cache used for 'main' namespaces
1014 # This is the cache used for 'main' namespaces
1015 self._main_mod_cache = {}
1015 self._main_mod_cache = {}
1016
1016
1017 # A table holding all the namespaces IPython deals with, so that
1017 # A table holding all the namespaces IPython deals with, so that
1018 # introspection facilities can search easily.
1018 # introspection facilities can search easily.
1019 self.ns_table = {'user_global':self.user_module.__dict__,
1019 self.ns_table = {'user_global':self.user_module.__dict__,
1020 'user_local':self.user_ns,
1020 'user_local':self.user_ns,
1021 'builtin':builtin_mod.__dict__
1021 'builtin':builtin_mod.__dict__
1022 }
1022 }
1023
1023
1024 @property
1024 @property
1025 def user_global_ns(self):
1025 def user_global_ns(self):
1026 return self.user_module.__dict__
1026 return self.user_module.__dict__
1027
1027
1028 def prepare_user_module(self, user_module=None, user_ns=None):
1028 def prepare_user_module(self, user_module=None, user_ns=None):
1029 """Prepare the module and namespace in which user code will be run.
1029 """Prepare the module and namespace in which user code will be run.
1030
1030
1031 When IPython is started normally, both parameters are None: a new module
1031 When IPython is started normally, both parameters are None: a new module
1032 is created automatically, and its __dict__ used as the namespace.
1032 is created automatically, and its __dict__ used as the namespace.
1033
1033
1034 If only user_module is provided, its __dict__ is used as the namespace.
1034 If only user_module is provided, its __dict__ is used as the namespace.
1035 If only user_ns is provided, a dummy module is created, and user_ns
1035 If only user_ns is provided, a dummy module is created, and user_ns
1036 becomes the global namespace. If both are provided (as they may be
1036 becomes the global namespace. If both are provided (as they may be
1037 when embedding), user_ns is the local namespace, and user_module
1037 when embedding), user_ns is the local namespace, and user_module
1038 provides the global namespace.
1038 provides the global namespace.
1039
1039
1040 Parameters
1040 Parameters
1041 ----------
1041 ----------
1042 user_module : module, optional
1042 user_module : module, optional
1043 The current user module in which IPython is being run. If None,
1043 The current user module in which IPython is being run. If None,
1044 a clean module will be created.
1044 a clean module will be created.
1045 user_ns : dict, optional
1045 user_ns : dict, optional
1046 A namespace in which to run interactive commands.
1046 A namespace in which to run interactive commands.
1047
1047
1048 Returns
1048 Returns
1049 -------
1049 -------
1050 A tuple of user_module and user_ns, each properly initialised.
1050 A tuple of user_module and user_ns, each properly initialised.
1051 """
1051 """
1052 if user_module is None and user_ns is not None:
1052 if user_module is None and user_ns is not None:
1053 user_ns.setdefault("__name__", "__main__")
1053 user_ns.setdefault("__name__", "__main__")
1054 user_module = DummyMod()
1054 user_module = DummyMod()
1055 user_module.__dict__ = user_ns
1055 user_module.__dict__ = user_ns
1056
1056
1057 if user_module is None:
1057 if user_module is None:
1058 user_module = types.ModuleType("__main__",
1058 user_module = types.ModuleType("__main__",
1059 doc="Automatically created module for IPython interactive environment")
1059 doc="Automatically created module for IPython interactive environment")
1060
1060
1061 # We must ensure that __builtin__ (without the final 's') is always
1061 # We must ensure that __builtin__ (without the final 's') is always
1062 # available and pointing to the __builtin__ *module*. For more details:
1062 # available and pointing to the __builtin__ *module*. For more details:
1063 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1063 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1064 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1064 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1065 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1065 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1066
1066
1067 if user_ns is None:
1067 if user_ns is None:
1068 user_ns = user_module.__dict__
1068 user_ns = user_module.__dict__
1069
1069
1070 return user_module, user_ns
1070 return user_module, user_ns
1071
1071
1072 def init_sys_modules(self):
1072 def init_sys_modules(self):
1073 # We need to insert into sys.modules something that looks like a
1073 # We need to insert into sys.modules something that looks like a
1074 # module but which accesses the IPython namespace, for shelve and
1074 # module but which accesses the IPython namespace, for shelve and
1075 # pickle to work interactively. Normally they rely on getting
1075 # pickle to work interactively. Normally they rely on getting
1076 # everything out of __main__, but for embedding purposes each IPython
1076 # everything out of __main__, but for embedding purposes each IPython
1077 # instance has its own private namespace, so we can't go shoving
1077 # instance has its own private namespace, so we can't go shoving
1078 # everything into __main__.
1078 # everything into __main__.
1079
1079
1080 # note, however, that we should only do this for non-embedded
1080 # note, however, that we should only do this for non-embedded
1081 # ipythons, which really mimic the __main__.__dict__ with their own
1081 # ipythons, which really mimic the __main__.__dict__ with their own
1082 # namespace. Embedded instances, on the other hand, should not do
1082 # namespace. Embedded instances, on the other hand, should not do
1083 # this because they need to manage the user local/global namespaces
1083 # this because they need to manage the user local/global namespaces
1084 # only, but they live within a 'normal' __main__ (meaning, they
1084 # only, but they live within a 'normal' __main__ (meaning, they
1085 # shouldn't overtake the execution environment of the script they're
1085 # shouldn't overtake the execution environment of the script they're
1086 # embedded in).
1086 # embedded in).
1087
1087
1088 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1088 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1089 main_name = self.user_module.__name__
1089 main_name = self.user_module.__name__
1090 sys.modules[main_name] = self.user_module
1090 sys.modules[main_name] = self.user_module
1091
1091
1092 def init_user_ns(self):
1092 def init_user_ns(self):
1093 """Initialize all user-visible namespaces to their minimum defaults.
1093 """Initialize all user-visible namespaces to their minimum defaults.
1094
1094
1095 Certain history lists are also initialized here, as they effectively
1095 Certain history lists are also initialized here, as they effectively
1096 act as user namespaces.
1096 act as user namespaces.
1097
1097
1098 Notes
1098 Notes
1099 -----
1099 -----
1100 All data structures here are only filled in, they are NOT reset by this
1100 All data structures here are only filled in, they are NOT reset by this
1101 method. If they were not empty before, data will simply be added to
1101 method. If they were not empty before, data will simply be added to
1102 therm.
1102 therm.
1103 """
1103 """
1104 # This function works in two parts: first we put a few things in
1104 # This function works in two parts: first we put a few things in
1105 # user_ns, and we sync that contents into user_ns_hidden so that these
1105 # user_ns, and we sync that contents into user_ns_hidden so that these
1106 # initial variables aren't shown by %who. After the sync, we add the
1106 # initial variables aren't shown by %who. After the sync, we add the
1107 # rest of what we *do* want the user to see with %who even on a new
1107 # rest of what we *do* want the user to see with %who even on a new
1108 # session (probably nothing, so theye really only see their own stuff)
1108 # session (probably nothing, so theye really only see their own stuff)
1109
1109
1110 # The user dict must *always* have a __builtin__ reference to the
1110 # The user dict must *always* have a __builtin__ reference to the
1111 # Python standard __builtin__ namespace, which must be imported.
1111 # Python standard __builtin__ namespace, which must be imported.
1112 # This is so that certain operations in prompt evaluation can be
1112 # This is so that certain operations in prompt evaluation can be
1113 # reliably executed with builtins. Note that we can NOT use
1113 # reliably executed with builtins. Note that we can NOT use
1114 # __builtins__ (note the 's'), because that can either be a dict or a
1114 # __builtins__ (note the 's'), because that can either be a dict or a
1115 # module, and can even mutate at runtime, depending on the context
1115 # module, and can even mutate at runtime, depending on the context
1116 # (Python makes no guarantees on it). In contrast, __builtin__ is
1116 # (Python makes no guarantees on it). In contrast, __builtin__ is
1117 # always a module object, though it must be explicitly imported.
1117 # always a module object, though it must be explicitly imported.
1118
1118
1119 # For more details:
1119 # For more details:
1120 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1120 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1121 ns = dict()
1121 ns = dict()
1122
1122
1123 # Put 'help' in the user namespace
1123 # Put 'help' in the user namespace
1124 try:
1124 try:
1125 from site import _Helper
1125 from site import _Helper
1126 ns['help'] = _Helper()
1126 ns['help'] = _Helper()
1127 except ImportError:
1127 except ImportError:
1128 warn('help() not available - check site.py')
1128 warn('help() not available - check site.py')
1129
1129
1130 # make global variables for user access to the histories
1130 # make global variables for user access to the histories
1131 ns['_ih'] = self.history_manager.input_hist_parsed
1131 ns['_ih'] = self.history_manager.input_hist_parsed
1132 ns['_oh'] = self.history_manager.output_hist
1132 ns['_oh'] = self.history_manager.output_hist
1133 ns['_dh'] = self.history_manager.dir_hist
1133 ns['_dh'] = self.history_manager.dir_hist
1134
1134
1135 ns['_sh'] = shadowns
1135 ns['_sh'] = shadowns
1136
1136
1137 # user aliases to input and output histories. These shouldn't show up
1137 # user aliases to input and output histories. These shouldn't show up
1138 # in %who, as they can have very large reprs.
1138 # in %who, as they can have very large reprs.
1139 ns['In'] = self.history_manager.input_hist_parsed
1139 ns['In'] = self.history_manager.input_hist_parsed
1140 ns['Out'] = self.history_manager.output_hist
1140 ns['Out'] = self.history_manager.output_hist
1141
1141
1142 # Store myself as the public api!!!
1142 # Store myself as the public api!!!
1143 ns['get_ipython'] = self.get_ipython
1143 ns['get_ipython'] = self.get_ipython
1144
1144
1145 ns['exit'] = self.exiter
1145 ns['exit'] = self.exiter
1146 ns['quit'] = self.exiter
1146 ns['quit'] = self.exiter
1147
1147
1148 # Sync what we've added so far to user_ns_hidden so these aren't seen
1148 # Sync what we've added so far to user_ns_hidden so these aren't seen
1149 # by %who
1149 # by %who
1150 self.user_ns_hidden.update(ns)
1150 self.user_ns_hidden.update(ns)
1151
1151
1152 # Anything put into ns now would show up in %who. Think twice before
1152 # Anything put into ns now would show up in %who. Think twice before
1153 # putting anything here, as we really want %who to show the user their
1153 # putting anything here, as we really want %who to show the user their
1154 # stuff, not our variables.
1154 # stuff, not our variables.
1155
1155
1156 # Finally, update the real user's namespace
1156 # Finally, update the real user's namespace
1157 self.user_ns.update(ns)
1157 self.user_ns.update(ns)
1158
1158
1159 @property
1159 @property
1160 def all_ns_refs(self):
1160 def all_ns_refs(self):
1161 """Get a list of references to all the namespace dictionaries in which
1161 """Get a list of references to all the namespace dictionaries in which
1162 IPython might store a user-created object.
1162 IPython might store a user-created object.
1163
1163
1164 Note that this does not include the displayhook, which also caches
1164 Note that this does not include the displayhook, which also caches
1165 objects from the output."""
1165 objects from the output."""
1166 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1166 return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \
1167 [m.__dict__ for m in self._main_mod_cache.values()]
1167 [m.__dict__ for m in self._main_mod_cache.values()]
1168
1168
1169 def reset(self, new_session=True):
1169 def reset(self, new_session=True):
1170 """Clear all internal namespaces, and attempt to release references to
1170 """Clear all internal namespaces, and attempt to release references to
1171 user objects.
1171 user objects.
1172
1172
1173 If new_session is True, a new history session will be opened.
1173 If new_session is True, a new history session will be opened.
1174 """
1174 """
1175 # Clear histories
1175 # Clear histories
1176 self.history_manager.reset(new_session)
1176 self.history_manager.reset(new_session)
1177 # Reset counter used to index all histories
1177 # Reset counter used to index all histories
1178 if new_session:
1178 if new_session:
1179 self.execution_count = 1
1179 self.execution_count = 1
1180
1180
1181 # Flush cached output items
1181 # Flush cached output items
1182 if self.displayhook.do_full_cache:
1182 if self.displayhook.do_full_cache:
1183 self.displayhook.flush()
1183 self.displayhook.flush()
1184
1184
1185 # The main execution namespaces must be cleared very carefully,
1185 # The main execution namespaces must be cleared very carefully,
1186 # skipping the deletion of the builtin-related keys, because doing so
1186 # skipping the deletion of the builtin-related keys, because doing so
1187 # would cause errors in many object's __del__ methods.
1187 # would cause errors in many object's __del__ methods.
1188 if self.user_ns is not self.user_global_ns:
1188 if self.user_ns is not self.user_global_ns:
1189 self.user_ns.clear()
1189 self.user_ns.clear()
1190 ns = self.user_global_ns
1190 ns = self.user_global_ns
1191 drop_keys = set(ns.keys())
1191 drop_keys = set(ns.keys())
1192 drop_keys.discard('__builtin__')
1192 drop_keys.discard('__builtin__')
1193 drop_keys.discard('__builtins__')
1193 drop_keys.discard('__builtins__')
1194 drop_keys.discard('__name__')
1194 drop_keys.discard('__name__')
1195 for k in drop_keys:
1195 for k in drop_keys:
1196 del ns[k]
1196 del ns[k]
1197
1197
1198 self.user_ns_hidden.clear()
1198 self.user_ns_hidden.clear()
1199
1199
1200 # Restore the user namespaces to minimal usability
1200 # Restore the user namespaces to minimal usability
1201 self.init_user_ns()
1201 self.init_user_ns()
1202
1202
1203 # Restore the default and user aliases
1203 # Restore the default and user aliases
1204 self.alias_manager.clear_aliases()
1204 self.alias_manager.clear_aliases()
1205 self.alias_manager.init_aliases()
1205 self.alias_manager.init_aliases()
1206
1206
1207 # Flush the private list of module references kept for script
1207 # Flush the private list of module references kept for script
1208 # execution protection
1208 # execution protection
1209 self.clear_main_mod_cache()
1209 self.clear_main_mod_cache()
1210
1210
1211 def del_var(self, varname, by_name=False):
1211 def del_var(self, varname, by_name=False):
1212 """Delete a variable from the various namespaces, so that, as
1212 """Delete a variable from the various namespaces, so that, as
1213 far as possible, we're not keeping any hidden references to it.
1213 far as possible, we're not keeping any hidden references to it.
1214
1214
1215 Parameters
1215 Parameters
1216 ----------
1216 ----------
1217 varname : str
1217 varname : str
1218 The name of the variable to delete.
1218 The name of the variable to delete.
1219 by_name : bool
1219 by_name : bool
1220 If True, delete variables with the given name in each
1220 If True, delete variables with the given name in each
1221 namespace. If False (default), find the variable in the user
1221 namespace. If False (default), find the variable in the user
1222 namespace, and delete references to it.
1222 namespace, and delete references to it.
1223 """
1223 """
1224 if varname in ('__builtin__', '__builtins__'):
1224 if varname in ('__builtin__', '__builtins__'):
1225 raise ValueError("Refusing to delete %s" % varname)
1225 raise ValueError("Refusing to delete %s" % varname)
1226
1226
1227 ns_refs = self.all_ns_refs
1227 ns_refs = self.all_ns_refs
1228
1228
1229 if by_name: # Delete by name
1229 if by_name: # Delete by name
1230 for ns in ns_refs:
1230 for ns in ns_refs:
1231 try:
1231 try:
1232 del ns[varname]
1232 del ns[varname]
1233 except KeyError:
1233 except KeyError:
1234 pass
1234 pass
1235 else: # Delete by object
1235 else: # Delete by object
1236 try:
1236 try:
1237 obj = self.user_ns[varname]
1237 obj = self.user_ns[varname]
1238 except KeyError:
1238 except KeyError:
1239 raise NameError("name '%s' is not defined" % varname)
1239 raise NameError("name '%s' is not defined" % varname)
1240 # Also check in output history
1240 # Also check in output history
1241 ns_refs.append(self.history_manager.output_hist)
1241 ns_refs.append(self.history_manager.output_hist)
1242 for ns in ns_refs:
1242 for ns in ns_refs:
1243 to_delete = [n for n, o in ns.iteritems() if o is obj]
1243 to_delete = [n for n, o in ns.iteritems() if o is obj]
1244 for name in to_delete:
1244 for name in to_delete:
1245 del ns[name]
1245 del ns[name]
1246
1246
1247 # displayhook keeps extra references, but not in a dictionary
1247 # displayhook keeps extra references, but not in a dictionary
1248 for name in ('_', '__', '___'):
1248 for name in ('_', '__', '___'):
1249 if getattr(self.displayhook, name) is obj:
1249 if getattr(self.displayhook, name) is obj:
1250 setattr(self.displayhook, name, None)
1250 setattr(self.displayhook, name, None)
1251
1251
1252 def reset_selective(self, regex=None):
1252 def reset_selective(self, regex=None):
1253 """Clear selective variables from internal namespaces based on a
1253 """Clear selective variables from internal namespaces based on a
1254 specified regular expression.
1254 specified regular expression.
1255
1255
1256 Parameters
1256 Parameters
1257 ----------
1257 ----------
1258 regex : string or compiled pattern, optional
1258 regex : string or compiled pattern, optional
1259 A regular expression pattern that will be used in searching
1259 A regular expression pattern that will be used in searching
1260 variable names in the users namespaces.
1260 variable names in the users namespaces.
1261 """
1261 """
1262 if regex is not None:
1262 if regex is not None:
1263 try:
1263 try:
1264 m = re.compile(regex)
1264 m = re.compile(regex)
1265 except TypeError:
1265 except TypeError:
1266 raise TypeError('regex must be a string or compiled pattern')
1266 raise TypeError('regex must be a string or compiled pattern')
1267 # Search for keys in each namespace that match the given regex
1267 # Search for keys in each namespace that match the given regex
1268 # If a match is found, delete the key/value pair.
1268 # If a match is found, delete the key/value pair.
1269 for ns in self.all_ns_refs:
1269 for ns in self.all_ns_refs:
1270 for var in ns:
1270 for var in ns:
1271 if m.search(var):
1271 if m.search(var):
1272 del ns[var]
1272 del ns[var]
1273
1273
1274 def push(self, variables, interactive=True):
1274 def push(self, variables, interactive=True):
1275 """Inject a group of variables into the IPython user namespace.
1275 """Inject a group of variables into the IPython user namespace.
1276
1276
1277 Parameters
1277 Parameters
1278 ----------
1278 ----------
1279 variables : dict, str or list/tuple of str
1279 variables : dict, str or list/tuple of str
1280 The variables to inject into the user's namespace. If a dict, a
1280 The variables to inject into the user's namespace. If a dict, a
1281 simple update is done. If a str, the string is assumed to have
1281 simple update is done. If a str, the string is assumed to have
1282 variable names separated by spaces. A list/tuple of str can also
1282 variable names separated by spaces. A list/tuple of str can also
1283 be used to give the variable names. If just the variable names are
1283 be used to give the variable names. If just the variable names are
1284 give (list/tuple/str) then the variable values looked up in the
1284 give (list/tuple/str) then the variable values looked up in the
1285 callers frame.
1285 callers frame.
1286 interactive : bool
1286 interactive : bool
1287 If True (default), the variables will be listed with the ``who``
1287 If True (default), the variables will be listed with the ``who``
1288 magic.
1288 magic.
1289 """
1289 """
1290 vdict = None
1290 vdict = None
1291
1291
1292 # We need a dict of name/value pairs to do namespace updates.
1292 # We need a dict of name/value pairs to do namespace updates.
1293 if isinstance(variables, dict):
1293 if isinstance(variables, dict):
1294 vdict = variables
1294 vdict = variables
1295 elif isinstance(variables, (basestring, list, tuple)):
1295 elif isinstance(variables, (basestring, list, tuple)):
1296 if isinstance(variables, basestring):
1296 if isinstance(variables, basestring):
1297 vlist = variables.split()
1297 vlist = variables.split()
1298 else:
1298 else:
1299 vlist = variables
1299 vlist = variables
1300 vdict = {}
1300 vdict = {}
1301 cf = sys._getframe(1)
1301 cf = sys._getframe(1)
1302 for name in vlist:
1302 for name in vlist:
1303 try:
1303 try:
1304 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1304 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1305 except:
1305 except:
1306 print('Could not get variable %s from %s' %
1306 print('Could not get variable %s from %s' %
1307 (name,cf.f_code.co_name))
1307 (name,cf.f_code.co_name))
1308 else:
1308 else:
1309 raise ValueError('variables must be a dict/str/list/tuple')
1309 raise ValueError('variables must be a dict/str/list/tuple')
1310
1310
1311 # Propagate variables to user namespace
1311 # Propagate variables to user namespace
1312 self.user_ns.update(vdict)
1312 self.user_ns.update(vdict)
1313
1313
1314 # And configure interactive visibility
1314 # And configure interactive visibility
1315 user_ns_hidden = self.user_ns_hidden
1315 user_ns_hidden = self.user_ns_hidden
1316 if interactive:
1316 if interactive:
1317 for name in vdict:
1317 for name in vdict:
1318 user_ns_hidden.pop(name, None)
1318 user_ns_hidden.pop(name, None)
1319 else:
1319 else:
1320 user_ns_hidden.update(vdict)
1320 user_ns_hidden.update(vdict)
1321
1321
1322 def drop_by_id(self, variables):
1322 def drop_by_id(self, variables):
1323 """Remove a dict of variables from the user namespace, if they are the
1323 """Remove a dict of variables from the user namespace, if they are the
1324 same as the values in the dictionary.
1324 same as the values in the dictionary.
1325
1325
1326 This is intended for use by extensions: variables that they've added can
1326 This is intended for use by extensions: variables that they've added can
1327 be taken back out if they are unloaded, without removing any that the
1327 be taken back out if they are unloaded, without removing any that the
1328 user has overwritten.
1328 user has overwritten.
1329
1329
1330 Parameters
1330 Parameters
1331 ----------
1331 ----------
1332 variables : dict
1332 variables : dict
1333 A dictionary mapping object names (as strings) to the objects.
1333 A dictionary mapping object names (as strings) to the objects.
1334 """
1334 """
1335 for name, obj in variables.iteritems():
1335 for name, obj in variables.iteritems():
1336 if name in self.user_ns and self.user_ns[name] is obj:
1336 if name in self.user_ns and self.user_ns[name] is obj:
1337 del self.user_ns[name]
1337 del self.user_ns[name]
1338 self.user_ns_hidden.pop(name, None)
1338 self.user_ns_hidden.pop(name, None)
1339
1339
1340 #-------------------------------------------------------------------------
1340 #-------------------------------------------------------------------------
1341 # Things related to object introspection
1341 # Things related to object introspection
1342 #-------------------------------------------------------------------------
1342 #-------------------------------------------------------------------------
1343
1343
1344 def _ofind(self, oname, namespaces=None):
1344 def _ofind(self, oname, namespaces=None):
1345 """Find an object in the available namespaces.
1345 """Find an object in the available namespaces.
1346
1346
1347 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1347 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1348
1348
1349 Has special code to detect magic functions.
1349 Has special code to detect magic functions.
1350 """
1350 """
1351 oname = oname.strip()
1351 oname = oname.strip()
1352 #print '1- oname: <%r>' % oname # dbg
1352 #print '1- oname: <%r>' % oname # dbg
1353 if not oname.startswith(ESC_MAGIC) and \
1353 if not oname.startswith(ESC_MAGIC) and \
1354 not oname.startswith(ESC_MAGIC2) and \
1354 not oname.startswith(ESC_MAGIC2) and \
1355 not py3compat.isidentifier(oname, dotted=True):
1355 not py3compat.isidentifier(oname, dotted=True):
1356 return dict(found=False)
1356 return dict(found=False)
1357
1357
1358 alias_ns = None
1358 alias_ns = None
1359 if namespaces is None:
1359 if namespaces is None:
1360 # Namespaces to search in:
1360 # Namespaces to search in:
1361 # Put them in a list. The order is important so that we
1361 # Put them in a list. The order is important so that we
1362 # find things in the same order that Python finds them.
1362 # find things in the same order that Python finds them.
1363 namespaces = [ ('Interactive', self.user_ns),
1363 namespaces = [ ('Interactive', self.user_ns),
1364 ('Interactive (global)', self.user_global_ns),
1364 ('Interactive (global)', self.user_global_ns),
1365 ('Python builtin', builtin_mod.__dict__),
1365 ('Python builtin', builtin_mod.__dict__),
1366 ('Alias', self.alias_manager.alias_table),
1366 ('Alias', self.alias_manager.alias_table),
1367 ]
1367 ]
1368 alias_ns = self.alias_manager.alias_table
1368 alias_ns = self.alias_manager.alias_table
1369
1369
1370 # initialize results to 'null'
1370 # initialize results to 'null'
1371 found = False; obj = None; ospace = None; ds = None;
1371 found = False; obj = None; ospace = None; ds = None;
1372 ismagic = False; isalias = False; parent = None
1372 ismagic = False; isalias = False; parent = None
1373
1373
1374 # We need to special-case 'print', which as of python2.6 registers as a
1374 # We need to special-case 'print', which as of python2.6 registers as a
1375 # function but should only be treated as one if print_function was
1375 # function but should only be treated as one if print_function was
1376 # loaded with a future import. In this case, just bail.
1376 # loaded with a future import. In this case, just bail.
1377 if (oname == 'print' and not py3compat.PY3 and not \
1377 if (oname == 'print' and not py3compat.PY3 and not \
1378 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1378 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1379 return {'found':found, 'obj':obj, 'namespace':ospace,
1379 return {'found':found, 'obj':obj, 'namespace':ospace,
1380 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1380 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1381
1381
1382 # Look for the given name by splitting it in parts. If the head is
1382 # Look for the given name by splitting it in parts. If the head is
1383 # found, then we look for all the remaining parts as members, and only
1383 # found, then we look for all the remaining parts as members, and only
1384 # declare success if we can find them all.
1384 # declare success if we can find them all.
1385 oname_parts = oname.split('.')
1385 oname_parts = oname.split('.')
1386 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1386 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1387 for nsname,ns in namespaces:
1387 for nsname,ns in namespaces:
1388 try:
1388 try:
1389 obj = ns[oname_head]
1389 obj = ns[oname_head]
1390 except KeyError:
1390 except KeyError:
1391 continue
1391 continue
1392 else:
1392 else:
1393 #print 'oname_rest:', oname_rest # dbg
1393 #print 'oname_rest:', oname_rest # dbg
1394 for part in oname_rest:
1394 for part in oname_rest:
1395 try:
1395 try:
1396 parent = obj
1396 parent = obj
1397 obj = getattr(obj,part)
1397 obj = getattr(obj,part)
1398 except:
1398 except:
1399 # Blanket except b/c some badly implemented objects
1399 # Blanket except b/c some badly implemented objects
1400 # allow __getattr__ to raise exceptions other than
1400 # allow __getattr__ to raise exceptions other than
1401 # AttributeError, which then crashes IPython.
1401 # AttributeError, which then crashes IPython.
1402 break
1402 break
1403 else:
1403 else:
1404 # If we finish the for loop (no break), we got all members
1404 # If we finish the for loop (no break), we got all members
1405 found = True
1405 found = True
1406 ospace = nsname
1406 ospace = nsname
1407 if ns == alias_ns:
1407 if ns == alias_ns:
1408 isalias = True
1408 isalias = True
1409 break # namespace loop
1409 break # namespace loop
1410
1410
1411 # Try to see if it's magic
1411 # Try to see if it's magic
1412 if not found:
1412 if not found:
1413 obj = None
1413 obj = None
1414 if oname.startswith(ESC_MAGIC2):
1414 if oname.startswith(ESC_MAGIC2):
1415 oname = oname.lstrip(ESC_MAGIC2)
1415 oname = oname.lstrip(ESC_MAGIC2)
1416 obj = self.find_cell_magic(oname)
1416 obj = self.find_cell_magic(oname)
1417 elif oname.startswith(ESC_MAGIC):
1417 elif oname.startswith(ESC_MAGIC):
1418 oname = oname.lstrip(ESC_MAGIC)
1418 oname = oname.lstrip(ESC_MAGIC)
1419 obj = self.find_line_magic(oname)
1419 obj = self.find_line_magic(oname)
1420 else:
1420 else:
1421 # search without prefix, so run? will find %run?
1421 # search without prefix, so run? will find %run?
1422 obj = self.find_line_magic(oname)
1422 obj = self.find_line_magic(oname)
1423 if obj is None:
1423 if obj is None:
1424 obj = self.find_cell_magic(oname)
1424 obj = self.find_cell_magic(oname)
1425 if obj is not None:
1425 if obj is not None:
1426 found = True
1426 found = True
1427 ospace = 'IPython internal'
1427 ospace = 'IPython internal'
1428 ismagic = True
1428 ismagic = True
1429
1429
1430 # Last try: special-case some literals like '', [], {}, etc:
1430 # Last try: special-case some literals like '', [], {}, etc:
1431 if not found and oname_head in ["''",'""','[]','{}','()']:
1431 if not found and oname_head in ["''",'""','[]','{}','()']:
1432 obj = eval(oname_head)
1432 obj = eval(oname_head)
1433 found = True
1433 found = True
1434 ospace = 'Interactive'
1434 ospace = 'Interactive'
1435
1435
1436 return {'found':found, 'obj':obj, 'namespace':ospace,
1436 return {'found':found, 'obj':obj, 'namespace':ospace,
1437 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1437 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1438
1438
1439 def _ofind_property(self, oname, info):
1439 def _ofind_property(self, oname, info):
1440 """Second part of object finding, to look for property details."""
1440 """Second part of object finding, to look for property details."""
1441 if info.found:
1441 if info.found:
1442 # Get the docstring of the class property if it exists.
1442 # Get the docstring of the class property if it exists.
1443 path = oname.split('.')
1443 path = oname.split('.')
1444 root = '.'.join(path[:-1])
1444 root = '.'.join(path[:-1])
1445 if info.parent is not None:
1445 if info.parent is not None:
1446 try:
1446 try:
1447 target = getattr(info.parent, '__class__')
1447 target = getattr(info.parent, '__class__')
1448 # The object belongs to a class instance.
1448 # The object belongs to a class instance.
1449 try:
1449 try:
1450 target = getattr(target, path[-1])
1450 target = getattr(target, path[-1])
1451 # The class defines the object.
1451 # The class defines the object.
1452 if isinstance(target, property):
1452 if isinstance(target, property):
1453 oname = root + '.__class__.' + path[-1]
1453 oname = root + '.__class__.' + path[-1]
1454 info = Struct(self._ofind(oname))
1454 info = Struct(self._ofind(oname))
1455 except AttributeError: pass
1455 except AttributeError: pass
1456 except AttributeError: pass
1456 except AttributeError: pass
1457
1457
1458 # We return either the new info or the unmodified input if the object
1458 # We return either the new info or the unmodified input if the object
1459 # hadn't been found
1459 # hadn't been found
1460 return info
1460 return info
1461
1461
1462 def _object_find(self, oname, namespaces=None):
1462 def _object_find(self, oname, namespaces=None):
1463 """Find an object and return a struct with info about it."""
1463 """Find an object and return a struct with info about it."""
1464 inf = Struct(self._ofind(oname, namespaces))
1464 inf = Struct(self._ofind(oname, namespaces))
1465 return Struct(self._ofind_property(oname, inf))
1465 return Struct(self._ofind_property(oname, inf))
1466
1466
1467 def _inspect(self, meth, oname, namespaces=None, **kw):
1467 def _inspect(self, meth, oname, namespaces=None, **kw):
1468 """Generic interface to the inspector system.
1468 """Generic interface to the inspector system.
1469
1469
1470 This function is meant to be called by pdef, pdoc & friends."""
1470 This function is meant to be called by pdef, pdoc & friends."""
1471 info = self._object_find(oname, namespaces)
1471 info = self._object_find(oname, namespaces)
1472 if info.found:
1472 if info.found:
1473 pmethod = getattr(self.inspector, meth)
1473 pmethod = getattr(self.inspector, meth)
1474 formatter = format_screen if info.ismagic else None
1474 formatter = format_screen if info.ismagic else None
1475 if meth == 'pdoc':
1475 if meth == 'pdoc':
1476 pmethod(info.obj, oname, formatter)
1476 pmethod(info.obj, oname, formatter)
1477 elif meth == 'pinfo':
1477 elif meth == 'pinfo':
1478 pmethod(info.obj, oname, formatter, info, **kw)
1478 pmethod(info.obj, oname, formatter, info, **kw)
1479 else:
1479 else:
1480 pmethod(info.obj, oname)
1480 pmethod(info.obj, oname)
1481 else:
1481 else:
1482 print('Object `%s` not found.' % oname)
1482 print('Object `%s` not found.' % oname)
1483 return 'not found' # so callers can take other action
1483 return 'not found' # so callers can take other action
1484
1484
1485 def object_inspect(self, oname, detail_level=0):
1485 def object_inspect(self, oname, detail_level=0):
1486 with self.builtin_trap:
1486 with self.builtin_trap:
1487 info = self._object_find(oname)
1487 info = self._object_find(oname)
1488 if info.found:
1488 if info.found:
1489 return self.inspector.info(info.obj, oname, info=info,
1489 return self.inspector.info(info.obj, oname, info=info,
1490 detail_level=detail_level
1490 detail_level=detail_level
1491 )
1491 )
1492 else:
1492 else:
1493 return oinspect.object_info(name=oname, found=False)
1493 return oinspect.object_info(name=oname, found=False)
1494
1494
1495 #-------------------------------------------------------------------------
1495 #-------------------------------------------------------------------------
1496 # Things related to history management
1496 # Things related to history management
1497 #-------------------------------------------------------------------------
1497 #-------------------------------------------------------------------------
1498
1498
1499 def init_history(self):
1499 def init_history(self):
1500 """Sets up the command history, and starts regular autosaves."""
1500 """Sets up the command history, and starts regular autosaves."""
1501 self.history_manager = HistoryManager(shell=self, parent=self)
1501 self.history_manager = HistoryManager(shell=self, parent=self)
1502 self.configurables.append(self.history_manager)
1502 self.configurables.append(self.history_manager)
1503
1503
1504 #-------------------------------------------------------------------------
1504 #-------------------------------------------------------------------------
1505 # Things related to exception handling and tracebacks (not debugging)
1505 # Things related to exception handling and tracebacks (not debugging)
1506 #-------------------------------------------------------------------------
1506 #-------------------------------------------------------------------------
1507
1507
1508 def init_traceback_handlers(self, custom_exceptions):
1508 def init_traceback_handlers(self, custom_exceptions):
1509 # Syntax error handler.
1509 # Syntax error handler.
1510 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1510 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1511
1511
1512 # The interactive one is initialized with an offset, meaning we always
1512 # The interactive one is initialized with an offset, meaning we always
1513 # want to remove the topmost item in the traceback, which is our own
1513 # want to remove the topmost item in the traceback, which is our own
1514 # internal code. Valid modes: ['Plain','Context','Verbose']
1514 # internal code. Valid modes: ['Plain','Context','Verbose']
1515 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1515 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1516 color_scheme='NoColor',
1516 color_scheme='NoColor',
1517 tb_offset = 1,
1517 tb_offset = 1,
1518 check_cache=check_linecache_ipython)
1518 check_cache=check_linecache_ipython)
1519
1519
1520 # The instance will store a pointer to the system-wide exception hook,
1520 # The instance will store a pointer to the system-wide exception hook,
1521 # so that runtime code (such as magics) can access it. This is because
1521 # so that runtime code (such as magics) can access it. This is because
1522 # during the read-eval loop, it may get temporarily overwritten.
1522 # during the read-eval loop, it may get temporarily overwritten.
1523 self.sys_excepthook = sys.excepthook
1523 self.sys_excepthook = sys.excepthook
1524
1524
1525 # and add any custom exception handlers the user may have specified
1525 # and add any custom exception handlers the user may have specified
1526 self.set_custom_exc(*custom_exceptions)
1526 self.set_custom_exc(*custom_exceptions)
1527
1527
1528 # Set the exception mode
1528 # Set the exception mode
1529 self.InteractiveTB.set_mode(mode=self.xmode)
1529 self.InteractiveTB.set_mode(mode=self.xmode)
1530
1530
1531 def set_custom_exc(self, exc_tuple, handler):
1531 def set_custom_exc(self, exc_tuple, handler):
1532 """set_custom_exc(exc_tuple,handler)
1532 """set_custom_exc(exc_tuple,handler)
1533
1533
1534 Set a custom exception handler, which will be called if any of the
1534 Set a custom exception handler, which will be called if any of the
1535 exceptions in exc_tuple occur in the mainloop (specifically, in the
1535 exceptions in exc_tuple occur in the mainloop (specifically, in the
1536 run_code() method).
1536 run_code() method).
1537
1537
1538 Parameters
1538 Parameters
1539 ----------
1539 ----------
1540
1540
1541 exc_tuple : tuple of exception classes
1541 exc_tuple : tuple of exception classes
1542 A *tuple* of exception classes, for which to call the defined
1542 A *tuple* of exception classes, for which to call the defined
1543 handler. It is very important that you use a tuple, and NOT A
1543 handler. It is very important that you use a tuple, and NOT A
1544 LIST here, because of the way Python's except statement works. If
1544 LIST here, because of the way Python's except statement works. If
1545 you only want to trap a single exception, use a singleton tuple::
1545 you only want to trap a single exception, use a singleton tuple::
1546
1546
1547 exc_tuple == (MyCustomException,)
1547 exc_tuple == (MyCustomException,)
1548
1548
1549 handler : callable
1549 handler : callable
1550 handler must have the following signature::
1550 handler must have the following signature::
1551
1551
1552 def my_handler(self, etype, value, tb, tb_offset=None):
1552 def my_handler(self, etype, value, tb, tb_offset=None):
1553 ...
1553 ...
1554 return structured_traceback
1554 return structured_traceback
1555
1555
1556 Your handler must return a structured traceback (a list of strings),
1556 Your handler must return a structured traceback (a list of strings),
1557 or None.
1557 or None.
1558
1558
1559 This will be made into an instance method (via types.MethodType)
1559 This will be made into an instance method (via types.MethodType)
1560 of IPython itself, and it will be called if any of the exceptions
1560 of IPython itself, and it will be called if any of the exceptions
1561 listed in the exc_tuple are caught. If the handler is None, an
1561 listed in the exc_tuple are caught. If the handler is None, an
1562 internal basic one is used, which just prints basic info.
1562 internal basic one is used, which just prints basic info.
1563
1563
1564 To protect IPython from crashes, if your handler ever raises an
1564 To protect IPython from crashes, if your handler ever raises an
1565 exception or returns an invalid result, it will be immediately
1565 exception or returns an invalid result, it will be immediately
1566 disabled.
1566 disabled.
1567
1567
1568 WARNING: by putting in your own exception handler into IPython's main
1568 WARNING: by putting in your own exception handler into IPython's main
1569 execution loop, you run a very good chance of nasty crashes. This
1569 execution loop, you run a very good chance of nasty crashes. This
1570 facility should only be used if you really know what you are doing."""
1570 facility should only be used if you really know what you are doing."""
1571
1571
1572 assert type(exc_tuple)==type(()) , \
1572 assert type(exc_tuple)==type(()) , \
1573 "The custom exceptions must be given AS A TUPLE."
1573 "The custom exceptions must be given AS A TUPLE."
1574
1574
1575 def dummy_handler(self,etype,value,tb,tb_offset=None):
1575 def dummy_handler(self,etype,value,tb,tb_offset=None):
1576 print('*** Simple custom exception handler ***')
1576 print('*** Simple custom exception handler ***')
1577 print('Exception type :',etype)
1577 print('Exception type :',etype)
1578 print('Exception value:',value)
1578 print('Exception value:',value)
1579 print('Traceback :',tb)
1579 print('Traceback :',tb)
1580 #print 'Source code :','\n'.join(self.buffer)
1580 #print 'Source code :','\n'.join(self.buffer)
1581
1581
1582 def validate_stb(stb):
1582 def validate_stb(stb):
1583 """validate structured traceback return type
1583 """validate structured traceback return type
1584
1584
1585 return type of CustomTB *should* be a list of strings, but allow
1585 return type of CustomTB *should* be a list of strings, but allow
1586 single strings or None, which are harmless.
1586 single strings or None, which are harmless.
1587
1587
1588 This function will *always* return a list of strings,
1588 This function will *always* return a list of strings,
1589 and will raise a TypeError if stb is inappropriate.
1589 and will raise a TypeError if stb is inappropriate.
1590 """
1590 """
1591 msg = "CustomTB must return list of strings, not %r" % stb
1591 msg = "CustomTB must return list of strings, not %r" % stb
1592 if stb is None:
1592 if stb is None:
1593 return []
1593 return []
1594 elif isinstance(stb, basestring):
1594 elif isinstance(stb, basestring):
1595 return [stb]
1595 return [stb]
1596 elif not isinstance(stb, list):
1596 elif not isinstance(stb, list):
1597 raise TypeError(msg)
1597 raise TypeError(msg)
1598 # it's a list
1598 # it's a list
1599 for line in stb:
1599 for line in stb:
1600 # check every element
1600 # check every element
1601 if not isinstance(line, basestring):
1601 if not isinstance(line, basestring):
1602 raise TypeError(msg)
1602 raise TypeError(msg)
1603 return stb
1603 return stb
1604
1604
1605 if handler is None:
1605 if handler is None:
1606 wrapped = dummy_handler
1606 wrapped = dummy_handler
1607 else:
1607 else:
1608 def wrapped(self,etype,value,tb,tb_offset=None):
1608 def wrapped(self,etype,value,tb,tb_offset=None):
1609 """wrap CustomTB handler, to protect IPython from user code
1609 """wrap CustomTB handler, to protect IPython from user code
1610
1610
1611 This makes it harder (but not impossible) for custom exception
1611 This makes it harder (but not impossible) for custom exception
1612 handlers to crash IPython.
1612 handlers to crash IPython.
1613 """
1613 """
1614 try:
1614 try:
1615 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1615 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1616 return validate_stb(stb)
1616 return validate_stb(stb)
1617 except:
1617 except:
1618 # clear custom handler immediately
1618 # clear custom handler immediately
1619 self.set_custom_exc((), None)
1619 self.set_custom_exc((), None)
1620 print("Custom TB Handler failed, unregistering", file=io.stderr)
1620 print("Custom TB Handler failed, unregistering", file=io.stderr)
1621 # show the exception in handler first
1621 # show the exception in handler first
1622 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1622 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1623 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1623 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1624 print("The original exception:", file=io.stdout)
1624 print("The original exception:", file=io.stdout)
1625 stb = self.InteractiveTB.structured_traceback(
1625 stb = self.InteractiveTB.structured_traceback(
1626 (etype,value,tb), tb_offset=tb_offset
1626 (etype,value,tb), tb_offset=tb_offset
1627 )
1627 )
1628 return stb
1628 return stb
1629
1629
1630 self.CustomTB = types.MethodType(wrapped,self)
1630 self.CustomTB = types.MethodType(wrapped,self)
1631 self.custom_exceptions = exc_tuple
1631 self.custom_exceptions = exc_tuple
1632
1632
1633 def excepthook(self, etype, value, tb):
1633 def excepthook(self, etype, value, tb):
1634 """One more defense for GUI apps that call sys.excepthook.
1634 """One more defense for GUI apps that call sys.excepthook.
1635
1635
1636 GUI frameworks like wxPython trap exceptions and call
1636 GUI frameworks like wxPython trap exceptions and call
1637 sys.excepthook themselves. I guess this is a feature that
1637 sys.excepthook themselves. I guess this is a feature that
1638 enables them to keep running after exceptions that would
1638 enables them to keep running after exceptions that would
1639 otherwise kill their mainloop. This is a bother for IPython
1639 otherwise kill their mainloop. This is a bother for IPython
1640 which excepts to catch all of the program exceptions with a try:
1640 which excepts to catch all of the program exceptions with a try:
1641 except: statement.
1641 except: statement.
1642
1642
1643 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1643 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1644 any app directly invokes sys.excepthook, it will look to the user like
1644 any app directly invokes sys.excepthook, it will look to the user like
1645 IPython crashed. In order to work around this, we can disable the
1645 IPython crashed. In order to work around this, we can disable the
1646 CrashHandler and replace it with this excepthook instead, which prints a
1646 CrashHandler and replace it with this excepthook instead, which prints a
1647 regular traceback using our InteractiveTB. In this fashion, apps which
1647 regular traceback using our InteractiveTB. In this fashion, apps which
1648 call sys.excepthook will generate a regular-looking exception from
1648 call sys.excepthook will generate a regular-looking exception from
1649 IPython, and the CrashHandler will only be triggered by real IPython
1649 IPython, and the CrashHandler will only be triggered by real IPython
1650 crashes.
1650 crashes.
1651
1651
1652 This hook should be used sparingly, only in places which are not likely
1652 This hook should be used sparingly, only in places which are not likely
1653 to be true IPython errors.
1653 to be true IPython errors.
1654 """
1654 """
1655 self.showtraceback((etype,value,tb),tb_offset=0)
1655 self.showtraceback((etype,value,tb),tb_offset=0)
1656
1656
1657 def _get_exc_info(self, exc_tuple=None):
1657 def _get_exc_info(self, exc_tuple=None):
1658 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1658 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1659
1659
1660 Ensures sys.last_type,value,traceback hold the exc_info we found,
1660 Ensures sys.last_type,value,traceback hold the exc_info we found,
1661 from whichever source.
1661 from whichever source.
1662
1662
1663 raises ValueError if none of these contain any information
1663 raises ValueError if none of these contain any information
1664 """
1664 """
1665 if exc_tuple is None:
1665 if exc_tuple is None:
1666 etype, value, tb = sys.exc_info()
1666 etype, value, tb = sys.exc_info()
1667 else:
1667 else:
1668 etype, value, tb = exc_tuple
1668 etype, value, tb = exc_tuple
1669
1669
1670 if etype is None:
1670 if etype is None:
1671 if hasattr(sys, 'last_type'):
1671 if hasattr(sys, 'last_type'):
1672 etype, value, tb = sys.last_type, sys.last_value, \
1672 etype, value, tb = sys.last_type, sys.last_value, \
1673 sys.last_traceback
1673 sys.last_traceback
1674
1674
1675 if etype is None:
1675 if etype is None:
1676 raise ValueError("No exception to find")
1676 raise ValueError("No exception to find")
1677
1677
1678 # Now store the exception info in sys.last_type etc.
1678 # Now store the exception info in sys.last_type etc.
1679 # WARNING: these variables are somewhat deprecated and not
1679 # WARNING: these variables are somewhat deprecated and not
1680 # necessarily safe to use in a threaded environment, but tools
1680 # necessarily safe to use in a threaded environment, but tools
1681 # like pdb depend on their existence, so let's set them. If we
1681 # like pdb depend on their existence, so let's set them. If we
1682 # find problems in the field, we'll need to revisit their use.
1682 # find problems in the field, we'll need to revisit their use.
1683 sys.last_type = etype
1683 sys.last_type = etype
1684 sys.last_value = value
1684 sys.last_value = value
1685 sys.last_traceback = tb
1685 sys.last_traceback = tb
1686
1686
1687 return etype, value, tb
1687 return etype, value, tb
1688
1688
1689 def show_usage_error(self, exc):
1689 def show_usage_error(self, exc):
1690 """Show a short message for UsageErrors
1690 """Show a short message for UsageErrors
1691
1691
1692 These are special exceptions that shouldn't show a traceback.
1692 These are special exceptions that shouldn't show a traceback.
1693 """
1693 """
1694 self.write_err("UsageError: %s" % exc)
1694 self.write_err("UsageError: %s" % exc)
1695
1695
1696 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1696 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1697 exception_only=False):
1697 exception_only=False):
1698 """Display the exception that just occurred.
1698 """Display the exception that just occurred.
1699
1699
1700 If nothing is known about the exception, this is the method which
1700 If nothing is known about the exception, this is the method which
1701 should be used throughout the code for presenting user tracebacks,
1701 should be used throughout the code for presenting user tracebacks,
1702 rather than directly invoking the InteractiveTB object.
1702 rather than directly invoking the InteractiveTB object.
1703
1703
1704 A specific showsyntaxerror() also exists, but this method can take
1704 A specific showsyntaxerror() also exists, but this method can take
1705 care of calling it if needed, so unless you are explicitly catching a
1705 care of calling it if needed, so unless you are explicitly catching a
1706 SyntaxError exception, don't try to analyze the stack manually and
1706 SyntaxError exception, don't try to analyze the stack manually and
1707 simply call this method."""
1707 simply call this method."""
1708
1708
1709 try:
1709 try:
1710 try:
1710 try:
1711 etype, value, tb = self._get_exc_info(exc_tuple)
1711 etype, value, tb = self._get_exc_info(exc_tuple)
1712 except ValueError:
1712 except ValueError:
1713 self.write_err('No traceback available to show.\n')
1713 self.write_err('No traceback available to show.\n')
1714 return
1714 return
1715
1715
1716 if issubclass(etype, SyntaxError):
1716 if issubclass(etype, SyntaxError):
1717 # Though this won't be called by syntax errors in the input
1717 # Though this won't be called by syntax errors in the input
1718 # line, there may be SyntaxError cases with imported code.
1718 # line, there may be SyntaxError cases with imported code.
1719 self.showsyntaxerror(filename)
1719 self.showsyntaxerror(filename)
1720 elif etype is UsageError:
1720 elif etype is UsageError:
1721 self.show_usage_error(value)
1721 self.show_usage_error(value)
1722 else:
1722 else:
1723 if exception_only:
1723 if exception_only:
1724 stb = ['An exception has occurred, use %tb to see '
1724 stb = ['An exception has occurred, use %tb to see '
1725 'the full traceback.\n']
1725 'the full traceback.\n']
1726 stb.extend(self.InteractiveTB.get_exception_only(etype,
1726 stb.extend(self.InteractiveTB.get_exception_only(etype,
1727 value))
1727 value))
1728 else:
1728 else:
1729 try:
1729 try:
1730 # Exception classes can customise their traceback - we
1730 # Exception classes can customise their traceback - we
1731 # use this in IPython.parallel for exceptions occurring
1731 # use this in IPython.parallel for exceptions occurring
1732 # in the engines. This should return a list of strings.
1732 # in the engines. This should return a list of strings.
1733 stb = value._render_traceback_()
1733 stb = value._render_traceback_()
1734 except Exception:
1734 except Exception:
1735 stb = self.InteractiveTB.structured_traceback(etype,
1735 stb = self.InteractiveTB.structured_traceback(etype,
1736 value, tb, tb_offset=tb_offset)
1736 value, tb, tb_offset=tb_offset)
1737
1737
1738 self._showtraceback(etype, value, stb)
1738 self._showtraceback(etype, value, stb)
1739 if self.call_pdb:
1739 if self.call_pdb:
1740 # drop into debugger
1740 # drop into debugger
1741 self.debugger(force=True)
1741 self.debugger(force=True)
1742 return
1742 return
1743
1743
1744 # Actually show the traceback
1744 # Actually show the traceback
1745 self._showtraceback(etype, value, stb)
1745 self._showtraceback(etype, value, stb)
1746
1746
1747 except KeyboardInterrupt:
1747 except KeyboardInterrupt:
1748 self.write_err("\nKeyboardInterrupt\n")
1748 self.write_err("\nKeyboardInterrupt\n")
1749
1749
1750 def _showtraceback(self, etype, evalue, stb):
1750 def _showtraceback(self, etype, evalue, stb):
1751 """Actually show a traceback.
1751 """Actually show a traceback.
1752
1752
1753 Subclasses may override this method to put the traceback on a different
1753 Subclasses may override this method to put the traceback on a different
1754 place, like a side channel.
1754 place, like a side channel.
1755 """
1755 """
1756 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1756 print(self.InteractiveTB.stb2text(stb), file=io.stdout)
1757
1757
1758 def showsyntaxerror(self, filename=None):
1758 def showsyntaxerror(self, filename=None):
1759 """Display the syntax error that just occurred.
1759 """Display the syntax error that just occurred.
1760
1760
1761 This doesn't display a stack trace because there isn't one.
1761 This doesn't display a stack trace because there isn't one.
1762
1762
1763 If a filename is given, it is stuffed in the exception instead
1763 If a filename is given, it is stuffed in the exception instead
1764 of what was there before (because Python's parser always uses
1764 of what was there before (because Python's parser always uses
1765 "<string>" when reading from a string).
1765 "<string>" when reading from a string).
1766 """
1766 """
1767 etype, value, last_traceback = self._get_exc_info()
1767 etype, value, last_traceback = self._get_exc_info()
1768
1768
1769 if filename and issubclass(etype, SyntaxError):
1769 if filename and issubclass(etype, SyntaxError):
1770 try:
1770 try:
1771 value.filename = filename
1771 value.filename = filename
1772 except:
1772 except:
1773 # Not the format we expect; leave it alone
1773 # Not the format we expect; leave it alone
1774 pass
1774 pass
1775
1775
1776 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1776 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1777 self._showtraceback(etype, value, stb)
1777 self._showtraceback(etype, value, stb)
1778
1778
1779 # This is overridden in TerminalInteractiveShell to show a message about
1779 # This is overridden in TerminalInteractiveShell to show a message about
1780 # the %paste magic.
1780 # the %paste magic.
1781 def showindentationerror(self):
1781 def showindentationerror(self):
1782 """Called by run_cell when there's an IndentationError in code entered
1782 """Called by run_cell when there's an IndentationError in code entered
1783 at the prompt.
1783 at the prompt.
1784
1784
1785 This is overridden in TerminalInteractiveShell to show a message about
1785 This is overridden in TerminalInteractiveShell to show a message about
1786 the %paste magic."""
1786 the %paste magic."""
1787 self.showsyntaxerror()
1787 self.showsyntaxerror()
1788
1788
1789 #-------------------------------------------------------------------------
1789 #-------------------------------------------------------------------------
1790 # Things related to readline
1790 # Things related to readline
1791 #-------------------------------------------------------------------------
1791 #-------------------------------------------------------------------------
1792
1792
1793 def init_readline(self):
1793 def init_readline(self):
1794 """Command history completion/saving/reloading."""
1794 """Command history completion/saving/reloading."""
1795
1795
1796 if self.readline_use:
1796 if self.readline_use:
1797 import IPython.utils.rlineimpl as readline
1797 import IPython.utils.rlineimpl as readline
1798
1798
1799 self.rl_next_input = None
1799 self.rl_next_input = None
1800 self.rl_do_indent = False
1800 self.rl_do_indent = False
1801
1801
1802 if not self.readline_use or not readline.have_readline:
1802 if not self.readline_use or not readline.have_readline:
1803 self.has_readline = False
1803 self.has_readline = False
1804 self.readline = None
1804 self.readline = None
1805 # Set a number of methods that depend on readline to be no-op
1805 # Set a number of methods that depend on readline to be no-op
1806 self.readline_no_record = no_op_context
1806 self.readline_no_record = no_op_context
1807 self.set_readline_completer = no_op
1807 self.set_readline_completer = no_op
1808 self.set_custom_completer = no_op
1808 self.set_custom_completer = no_op
1809 if self.readline_use:
1809 if self.readline_use:
1810 warn('Readline services not available or not loaded.')
1810 warn('Readline services not available or not loaded.')
1811 else:
1811 else:
1812 self.has_readline = True
1812 self.has_readline = True
1813 self.readline = readline
1813 self.readline = readline
1814 sys.modules['readline'] = readline
1814 sys.modules['readline'] = readline
1815
1815
1816 # Platform-specific configuration
1816 # Platform-specific configuration
1817 if os.name == 'nt':
1817 if os.name == 'nt':
1818 # FIXME - check with Frederick to see if we can harmonize
1818 # FIXME - check with Frederick to see if we can harmonize
1819 # naming conventions with pyreadline to avoid this
1819 # naming conventions with pyreadline to avoid this
1820 # platform-dependent check
1820 # platform-dependent check
1821 self.readline_startup_hook = readline.set_pre_input_hook
1821 self.readline_startup_hook = readline.set_pre_input_hook
1822 else:
1822 else:
1823 self.readline_startup_hook = readline.set_startup_hook
1823 self.readline_startup_hook = readline.set_startup_hook
1824
1824
1825 # Load user's initrc file (readline config)
1825 # Load user's initrc file (readline config)
1826 # Or if libedit is used, load editrc.
1826 # Or if libedit is used, load editrc.
1827 inputrc_name = os.environ.get('INPUTRC')
1827 inputrc_name = os.environ.get('INPUTRC')
1828 if inputrc_name is None:
1828 if inputrc_name is None:
1829 inputrc_name = '.inputrc'
1829 inputrc_name = '.inputrc'
1830 if readline.uses_libedit:
1830 if readline.uses_libedit:
1831 inputrc_name = '.editrc'
1831 inputrc_name = '.editrc'
1832 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1832 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1833 if os.path.isfile(inputrc_name):
1833 if os.path.isfile(inputrc_name):
1834 try:
1834 try:
1835 readline.read_init_file(inputrc_name)
1835 readline.read_init_file(inputrc_name)
1836 except:
1836 except:
1837 warn('Problems reading readline initialization file <%s>'
1837 warn('Problems reading readline initialization file <%s>'
1838 % inputrc_name)
1838 % inputrc_name)
1839
1839
1840 # Configure readline according to user's prefs
1840 # Configure readline according to user's prefs
1841 # This is only done if GNU readline is being used. If libedit
1841 # This is only done if GNU readline is being used. If libedit
1842 # is being used (as on Leopard) the readline config is
1842 # is being used (as on Leopard) the readline config is
1843 # not run as the syntax for libedit is different.
1843 # not run as the syntax for libedit is different.
1844 if not readline.uses_libedit:
1844 if not readline.uses_libedit:
1845 for rlcommand in self.readline_parse_and_bind:
1845 for rlcommand in self.readline_parse_and_bind:
1846 #print "loading rl:",rlcommand # dbg
1846 #print "loading rl:",rlcommand # dbg
1847 readline.parse_and_bind(rlcommand)
1847 readline.parse_and_bind(rlcommand)
1848
1848
1849 # Remove some chars from the delimiters list. If we encounter
1849 # Remove some chars from the delimiters list. If we encounter
1850 # unicode chars, discard them.
1850 # unicode chars, discard them.
1851 delims = readline.get_completer_delims()
1851 delims = readline.get_completer_delims()
1852 if not py3compat.PY3:
1852 if not py3compat.PY3:
1853 delims = delims.encode("ascii", "ignore")
1853 delims = delims.encode("ascii", "ignore")
1854 for d in self.readline_remove_delims:
1854 for d in self.readline_remove_delims:
1855 delims = delims.replace(d, "")
1855 delims = delims.replace(d, "")
1856 delims = delims.replace(ESC_MAGIC, '')
1856 delims = delims.replace(ESC_MAGIC, '')
1857 readline.set_completer_delims(delims)
1857 readline.set_completer_delims(delims)
1858 # Store these so we can restore them if something like rpy2 modifies
1858 # Store these so we can restore them if something like rpy2 modifies
1859 # them.
1859 # them.
1860 self.readline_delims = delims
1860 self.readline_delims = delims
1861 # otherwise we end up with a monster history after a while:
1861 # otherwise we end up with a monster history after a while:
1862 readline.set_history_length(self.history_length)
1862 readline.set_history_length(self.history_length)
1863
1863
1864 self.refill_readline_hist()
1864 self.refill_readline_hist()
1865 self.readline_no_record = ReadlineNoRecord(self)
1865 self.readline_no_record = ReadlineNoRecord(self)
1866
1866
1867 # Configure auto-indent for all platforms
1867 # Configure auto-indent for all platforms
1868 self.set_autoindent(self.autoindent)
1868 self.set_autoindent(self.autoindent)
1869
1869
1870 def refill_readline_hist(self):
1870 def refill_readline_hist(self):
1871 # Load the last 1000 lines from history
1871 # Load the last 1000 lines from history
1872 self.readline.clear_history()
1872 self.readline.clear_history()
1873 stdin_encoding = sys.stdin.encoding or "utf-8"
1873 stdin_encoding = sys.stdin.encoding or "utf-8"
1874 last_cell = u""
1874 last_cell = u""
1875 for _, _, cell in self.history_manager.get_tail(1000,
1875 for _, _, cell in self.history_manager.get_tail(1000,
1876 include_latest=True):
1876 include_latest=True):
1877 # Ignore blank lines and consecutive duplicates
1877 # Ignore blank lines and consecutive duplicates
1878 cell = cell.rstrip()
1878 cell = cell.rstrip()
1879 if cell and (cell != last_cell):
1879 if cell and (cell != last_cell):
1880 try:
1880 try:
1881 if self.multiline_history:
1881 if self.multiline_history:
1882 self.readline.add_history(py3compat.unicode_to_str(cell,
1882 self.readline.add_history(py3compat.unicode_to_str(cell,
1883 stdin_encoding))
1883 stdin_encoding))
1884 else:
1884 else:
1885 for line in cell.splitlines():
1885 for line in cell.splitlines():
1886 self.readline.add_history(py3compat.unicode_to_str(line,
1886 self.readline.add_history(py3compat.unicode_to_str(line,
1887 stdin_encoding))
1887 stdin_encoding))
1888 last_cell = cell
1888 last_cell = cell
1889
1889
1890 except TypeError:
1890 except TypeError:
1891 # The history DB can get corrupted so it returns strings
1891 # The history DB can get corrupted so it returns strings
1892 # containing null bytes, which readline objects to.
1892 # containing null bytes, which readline objects to.
1893 continue
1893 continue
1894
1894
1895 @skip_doctest
1895 @skip_doctest
1896 def set_next_input(self, s):
1896 def set_next_input(self, s):
1897 """ Sets the 'default' input string for the next command line.
1897 """ Sets the 'default' input string for the next command line.
1898
1898
1899 Requires readline.
1899 Requires readline.
1900
1900
1901 Example::
1901 Example::
1902
1902
1903 In [1]: _ip.set_next_input("Hello Word")
1903 In [1]: _ip.set_next_input("Hello Word")
1904 In [2]: Hello Word_ # cursor is here
1904 In [2]: Hello Word_ # cursor is here
1905 """
1905 """
1906 self.rl_next_input = py3compat.cast_bytes_py2(s)
1906 self.rl_next_input = py3compat.cast_bytes_py2(s)
1907
1907
1908 # Maybe move this to the terminal subclass?
1908 # Maybe move this to the terminal subclass?
1909 def pre_readline(self):
1909 def pre_readline(self):
1910 """readline hook to be used at the start of each line.
1910 """readline hook to be used at the start of each line.
1911
1911
1912 Currently it handles auto-indent only."""
1912 Currently it handles auto-indent only."""
1913
1913
1914 if self.rl_do_indent:
1914 if self.rl_do_indent:
1915 self.readline.insert_text(self._indent_current_str())
1915 self.readline.insert_text(self._indent_current_str())
1916 if self.rl_next_input is not None:
1916 if self.rl_next_input is not None:
1917 self.readline.insert_text(self.rl_next_input)
1917 self.readline.insert_text(self.rl_next_input)
1918 self.rl_next_input = None
1918 self.rl_next_input = None
1919
1919
1920 def _indent_current_str(self):
1920 def _indent_current_str(self):
1921 """return the current level of indentation as a string"""
1921 """return the current level of indentation as a string"""
1922 return self.input_splitter.indent_spaces * ' '
1922 return self.input_splitter.indent_spaces * ' '
1923
1923
1924 #-------------------------------------------------------------------------
1924 #-------------------------------------------------------------------------
1925 # Things related to text completion
1925 # Things related to text completion
1926 #-------------------------------------------------------------------------
1926 #-------------------------------------------------------------------------
1927
1927
1928 def init_completer(self):
1928 def init_completer(self):
1929 """Initialize the completion machinery.
1929 """Initialize the completion machinery.
1930
1930
1931 This creates completion machinery that can be used by client code,
1931 This creates completion machinery that can be used by client code,
1932 either interactively in-process (typically triggered by the readline
1932 either interactively in-process (typically triggered by the readline
1933 library), programatically (such as in test suites) or out-of-prcess
1933 library), programatically (such as in test suites) or out-of-prcess
1934 (typically over the network by remote frontends).
1934 (typically over the network by remote frontends).
1935 """
1935 """
1936 from IPython.core.completer import IPCompleter
1936 from IPython.core.completer import IPCompleter
1937 from IPython.core.completerlib import (module_completer,
1937 from IPython.core.completerlib import (module_completer,
1938 magic_run_completer, cd_completer, reset_completer)
1938 magic_run_completer, cd_completer, reset_completer)
1939
1939
1940 self.Completer = IPCompleter(shell=self,
1940 self.Completer = IPCompleter(shell=self,
1941 namespace=self.user_ns,
1941 namespace=self.user_ns,
1942 global_namespace=self.user_global_ns,
1942 global_namespace=self.user_global_ns,
1943 alias_table=self.alias_manager.alias_table,
1943 #alias_table=self.alias_manager.alias_table,
1944 use_readline=self.has_readline,
1944 use_readline=self.has_readline,
1945 parent=self,
1945 parent=self,
1946 )
1946 )
1947 self.configurables.append(self.Completer)
1947 self.configurables.append(self.Completer)
1948
1948
1949 # Add custom completers to the basic ones built into IPCompleter
1949 # Add custom completers to the basic ones built into IPCompleter
1950 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1950 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1951 self.strdispatchers['complete_command'] = sdisp
1951 self.strdispatchers['complete_command'] = sdisp
1952 self.Completer.custom_completers = sdisp
1952 self.Completer.custom_completers = sdisp
1953
1953
1954 self.set_hook('complete_command', module_completer, str_key = 'import')
1954 self.set_hook('complete_command', module_completer, str_key = 'import')
1955 self.set_hook('complete_command', module_completer, str_key = 'from')
1955 self.set_hook('complete_command', module_completer, str_key = 'from')
1956 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1956 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1957 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1957 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1958 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1958 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1959
1959
1960 # Only configure readline if we truly are using readline. IPython can
1960 # Only configure readline if we truly are using readline. IPython can
1961 # do tab-completion over the network, in GUIs, etc, where readline
1961 # do tab-completion over the network, in GUIs, etc, where readline
1962 # itself may be absent
1962 # itself may be absent
1963 if self.has_readline:
1963 if self.has_readline:
1964 self.set_readline_completer()
1964 self.set_readline_completer()
1965
1965
1966 def complete(self, text, line=None, cursor_pos=None):
1966 def complete(self, text, line=None, cursor_pos=None):
1967 """Return the completed text and a list of completions.
1967 """Return the completed text and a list of completions.
1968
1968
1969 Parameters
1969 Parameters
1970 ----------
1970 ----------
1971
1971
1972 text : string
1972 text : string
1973 A string of text to be completed on. It can be given as empty and
1973 A string of text to be completed on. It can be given as empty and
1974 instead a line/position pair are given. In this case, the
1974 instead a line/position pair are given. In this case, the
1975 completer itself will split the line like readline does.
1975 completer itself will split the line like readline does.
1976
1976
1977 line : string, optional
1977 line : string, optional
1978 The complete line that text is part of.
1978 The complete line that text is part of.
1979
1979
1980 cursor_pos : int, optional
1980 cursor_pos : int, optional
1981 The position of the cursor on the input line.
1981 The position of the cursor on the input line.
1982
1982
1983 Returns
1983 Returns
1984 -------
1984 -------
1985 text : string
1985 text : string
1986 The actual text that was completed.
1986 The actual text that was completed.
1987
1987
1988 matches : list
1988 matches : list
1989 A sorted list with all possible completions.
1989 A sorted list with all possible completions.
1990
1990
1991 The optional arguments allow the completion to take more context into
1991 The optional arguments allow the completion to take more context into
1992 account, and are part of the low-level completion API.
1992 account, and are part of the low-level completion API.
1993
1993
1994 This is a wrapper around the completion mechanism, similar to what
1994 This is a wrapper around the completion mechanism, similar to what
1995 readline does at the command line when the TAB key is hit. By
1995 readline does at the command line when the TAB key is hit. By
1996 exposing it as a method, it can be used by other non-readline
1996 exposing it as a method, it can be used by other non-readline
1997 environments (such as GUIs) for text completion.
1997 environments (such as GUIs) for text completion.
1998
1998
1999 Simple usage example:
1999 Simple usage example:
2000
2000
2001 In [1]: x = 'hello'
2001 In [1]: x = 'hello'
2002
2002
2003 In [2]: _ip.complete('x.l')
2003 In [2]: _ip.complete('x.l')
2004 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2004 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
2005 """
2005 """
2006
2006
2007 # Inject names into __builtin__ so we can complete on the added names.
2007 # Inject names into __builtin__ so we can complete on the added names.
2008 with self.builtin_trap:
2008 with self.builtin_trap:
2009 return self.Completer.complete(text, line, cursor_pos)
2009 return self.Completer.complete(text, line, cursor_pos)
2010
2010
2011 def set_custom_completer(self, completer, pos=0):
2011 def set_custom_completer(self, completer, pos=0):
2012 """Adds a new custom completer function.
2012 """Adds a new custom completer function.
2013
2013
2014 The position argument (defaults to 0) is the index in the completers
2014 The position argument (defaults to 0) is the index in the completers
2015 list where you want the completer to be inserted."""
2015 list where you want the completer to be inserted."""
2016
2016
2017 newcomp = types.MethodType(completer,self.Completer)
2017 newcomp = types.MethodType(completer,self.Completer)
2018 self.Completer.matchers.insert(pos,newcomp)
2018 self.Completer.matchers.insert(pos,newcomp)
2019
2019
2020 def set_readline_completer(self):
2020 def set_readline_completer(self):
2021 """Reset readline's completer to be our own."""
2021 """Reset readline's completer to be our own."""
2022 self.readline.set_completer(self.Completer.rlcomplete)
2022 self.readline.set_completer(self.Completer.rlcomplete)
2023
2023
2024 def set_completer_frame(self, frame=None):
2024 def set_completer_frame(self, frame=None):
2025 """Set the frame of the completer."""
2025 """Set the frame of the completer."""
2026 if frame:
2026 if frame:
2027 self.Completer.namespace = frame.f_locals
2027 self.Completer.namespace = frame.f_locals
2028 self.Completer.global_namespace = frame.f_globals
2028 self.Completer.global_namespace = frame.f_globals
2029 else:
2029 else:
2030 self.Completer.namespace = self.user_ns
2030 self.Completer.namespace = self.user_ns
2031 self.Completer.global_namespace = self.user_global_ns
2031 self.Completer.global_namespace = self.user_global_ns
2032
2032
2033 #-------------------------------------------------------------------------
2033 #-------------------------------------------------------------------------
2034 # Things related to magics
2034 # Things related to magics
2035 #-------------------------------------------------------------------------
2035 #-------------------------------------------------------------------------
2036
2036
2037 def init_magics(self):
2037 def init_magics(self):
2038 from IPython.core import magics as m
2038 from IPython.core import magics as m
2039 self.magics_manager = magic.MagicsManager(shell=self,
2039 self.magics_manager = magic.MagicsManager(shell=self,
2040 parent=self,
2040 parent=self,
2041 user_magics=m.UserMagics(self))
2041 user_magics=m.UserMagics(self))
2042 self.configurables.append(self.magics_manager)
2042 self.configurables.append(self.magics_manager)
2043
2043
2044 # Expose as public API from the magics manager
2044 # Expose as public API from the magics manager
2045 self.register_magics = self.magics_manager.register
2045 self.register_magics = self.magics_manager.register
2046 self.define_magic = self.magics_manager.define_magic
2046 self.define_magic = self.magics_manager.define_magic
2047
2047
2048 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2048 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
2049 m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics,
2049 m.ConfigMagics, m.DeprecatedMagics, m.DisplayMagics, m.ExecutionMagics,
2050 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2050 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
2051 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
2051 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
2052 )
2052 )
2053
2053
2054 # Register Magic Aliases
2054 # Register Magic Aliases
2055 mman = self.magics_manager
2055 mman = self.magics_manager
2056 # FIXME: magic aliases should be defined by the Magics classes
2056 # FIXME: magic aliases should be defined by the Magics classes
2057 # or in MagicsManager, not here
2057 # or in MagicsManager, not here
2058 mman.register_alias('ed', 'edit')
2058 mman.register_alias('ed', 'edit')
2059 mman.register_alias('hist', 'history')
2059 mman.register_alias('hist', 'history')
2060 mman.register_alias('rep', 'recall')
2060 mman.register_alias('rep', 'recall')
2061 mman.register_alias('SVG', 'svg', 'cell')
2061 mman.register_alias('SVG', 'svg', 'cell')
2062 mman.register_alias('HTML', 'html', 'cell')
2062 mman.register_alias('HTML', 'html', 'cell')
2063 mman.register_alias('file', 'writefile', 'cell')
2063 mman.register_alias('file', 'writefile', 'cell')
2064
2064
2065 # FIXME: Move the color initialization to the DisplayHook, which
2065 # FIXME: Move the color initialization to the DisplayHook, which
2066 # should be split into a prompt manager and displayhook. We probably
2066 # should be split into a prompt manager and displayhook. We probably
2067 # even need a centralize colors management object.
2067 # even need a centralize colors management object.
2068 self.magic('colors %s' % self.colors)
2068 self.magic('colors %s' % self.colors)
2069
2069
2070 # Defined here so that it's included in the documentation
2070 # Defined here so that it's included in the documentation
2071 @functools.wraps(magic.MagicsManager.register_function)
2071 @functools.wraps(magic.MagicsManager.register_function)
2072 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2072 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2073 self.magics_manager.register_function(func,
2073 self.magics_manager.register_function(func,
2074 magic_kind=magic_kind, magic_name=magic_name)
2074 magic_kind=magic_kind, magic_name=magic_name)
2075
2075
2076 def run_line_magic(self, magic_name, line):
2076 def run_line_magic(self, magic_name, line):
2077 """Execute the given line magic.
2077 """Execute the given line magic.
2078
2078
2079 Parameters
2079 Parameters
2080 ----------
2080 ----------
2081 magic_name : str
2081 magic_name : str
2082 Name of the desired magic function, without '%' prefix.
2082 Name of the desired magic function, without '%' prefix.
2083
2083
2084 line : str
2084 line : str
2085 The rest of the input line as a single string.
2085 The rest of the input line as a single string.
2086 """
2086 """
2087 fn = self.find_line_magic(magic_name)
2087 fn = self.find_line_magic(magic_name)
2088 if fn is None:
2088 if fn is None:
2089 cm = self.find_cell_magic(magic_name)
2089 cm = self.find_cell_magic(magic_name)
2090 etpl = "Line magic function `%%%s` not found%s."
2090 etpl = "Line magic function `%%%s` not found%s."
2091 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2091 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2092 'did you mean that instead?)' % magic_name )
2092 'did you mean that instead?)' % magic_name )
2093 error(etpl % (magic_name, extra))
2093 error(etpl % (magic_name, extra))
2094 else:
2094 else:
2095 # Note: this is the distance in the stack to the user's frame.
2095 # Note: this is the distance in the stack to the user's frame.
2096 # This will need to be updated if the internal calling logic gets
2096 # This will need to be updated if the internal calling logic gets
2097 # refactored, or else we'll be expanding the wrong variables.
2097 # refactored, or else we'll be expanding the wrong variables.
2098 stack_depth = 2
2098 stack_depth = 2
2099 magic_arg_s = self.var_expand(line, stack_depth)
2099 magic_arg_s = self.var_expand(line, stack_depth)
2100 # Put magic args in a list so we can call with f(*a) syntax
2100 # Put magic args in a list so we can call with f(*a) syntax
2101 args = [magic_arg_s]
2101 args = [magic_arg_s]
2102 kwargs = {}
2102 kwargs = {}
2103 # Grab local namespace if we need it:
2103 # Grab local namespace if we need it:
2104 if getattr(fn, "needs_local_scope", False):
2104 if getattr(fn, "needs_local_scope", False):
2105 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2105 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2106 with self.builtin_trap:
2106 with self.builtin_trap:
2107 result = fn(*args,**kwargs)
2107 result = fn(*args,**kwargs)
2108 return result
2108 return result
2109
2109
2110 def run_cell_magic(self, magic_name, line, cell):
2110 def run_cell_magic(self, magic_name, line, cell):
2111 """Execute the given cell magic.
2111 """Execute the given cell magic.
2112
2112
2113 Parameters
2113 Parameters
2114 ----------
2114 ----------
2115 magic_name : str
2115 magic_name : str
2116 Name of the desired magic function, without '%' prefix.
2116 Name of the desired magic function, without '%' prefix.
2117
2117
2118 line : str
2118 line : str
2119 The rest of the first input line as a single string.
2119 The rest of the first input line as a single string.
2120
2120
2121 cell : str
2121 cell : str
2122 The body of the cell as a (possibly multiline) string.
2122 The body of the cell as a (possibly multiline) string.
2123 """
2123 """
2124 fn = self.find_cell_magic(magic_name)
2124 fn = self.find_cell_magic(magic_name)
2125 if fn is None:
2125 if fn is None:
2126 lm = self.find_line_magic(magic_name)
2126 lm = self.find_line_magic(magic_name)
2127 etpl = "Cell magic `%%{0}` not found{1}."
2127 etpl = "Cell magic `%%{0}` not found{1}."
2128 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2128 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2129 'did you mean that instead?)'.format(magic_name))
2129 'did you mean that instead?)'.format(magic_name))
2130 error(etpl.format(magic_name, extra))
2130 error(etpl.format(magic_name, extra))
2131 elif cell == '':
2131 elif cell == '':
2132 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2132 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2133 if self.find_line_magic(magic_name) is not None:
2133 if self.find_line_magic(magic_name) is not None:
2134 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2134 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2135 raise UsageError(message)
2135 raise UsageError(message)
2136 else:
2136 else:
2137 # Note: this is the distance in the stack to the user's frame.
2137 # Note: this is the distance in the stack to the user's frame.
2138 # This will need to be updated if the internal calling logic gets
2138 # This will need to be updated if the internal calling logic gets
2139 # refactored, or else we'll be expanding the wrong variables.
2139 # refactored, or else we'll be expanding the wrong variables.
2140 stack_depth = 2
2140 stack_depth = 2
2141 magic_arg_s = self.var_expand(line, stack_depth)
2141 magic_arg_s = self.var_expand(line, stack_depth)
2142 with self.builtin_trap:
2142 with self.builtin_trap:
2143 result = fn(magic_arg_s, cell)
2143 result = fn(magic_arg_s, cell)
2144 return result
2144 return result
2145
2145
2146 def find_line_magic(self, magic_name):
2146 def find_line_magic(self, magic_name):
2147 """Find and return a line magic by name.
2147 """Find and return a line magic by name.
2148
2148
2149 Returns None if the magic isn't found."""
2149 Returns None if the magic isn't found."""
2150 return self.magics_manager.magics['line'].get(magic_name)
2150 return self.magics_manager.magics['line'].get(magic_name)
2151
2151
2152 def find_cell_magic(self, magic_name):
2152 def find_cell_magic(self, magic_name):
2153 """Find and return a cell magic by name.
2153 """Find and return a cell magic by name.
2154
2154
2155 Returns None if the magic isn't found."""
2155 Returns None if the magic isn't found."""
2156 return self.magics_manager.magics['cell'].get(magic_name)
2156 return self.magics_manager.magics['cell'].get(magic_name)
2157
2157
2158 def find_magic(self, magic_name, magic_kind='line'):
2158 def find_magic(self, magic_name, magic_kind='line'):
2159 """Find and return a magic of the given type by name.
2159 """Find and return a magic of the given type by name.
2160
2160
2161 Returns None if the magic isn't found."""
2161 Returns None if the magic isn't found."""
2162 return self.magics_manager.magics[magic_kind].get(magic_name)
2162 return self.magics_manager.magics[magic_kind].get(magic_name)
2163
2163
2164 def magic(self, arg_s):
2164 def magic(self, arg_s):
2165 """DEPRECATED. Use run_line_magic() instead.
2165 """DEPRECATED. Use run_line_magic() instead.
2166
2166
2167 Call a magic function by name.
2167 Call a magic function by name.
2168
2168
2169 Input: a string containing the name of the magic function to call and
2169 Input: a string containing the name of the magic function to call and
2170 any additional arguments to be passed to the magic.
2170 any additional arguments to be passed to the magic.
2171
2171
2172 magic('name -opt foo bar') is equivalent to typing at the ipython
2172 magic('name -opt foo bar') is equivalent to typing at the ipython
2173 prompt:
2173 prompt:
2174
2174
2175 In[1]: %name -opt foo bar
2175 In[1]: %name -opt foo bar
2176
2176
2177 To call a magic without arguments, simply use magic('name').
2177 To call a magic without arguments, simply use magic('name').
2178
2178
2179 This provides a proper Python function to call IPython's magics in any
2179 This provides a proper Python function to call IPython's magics in any
2180 valid Python code you can type at the interpreter, including loops and
2180 valid Python code you can type at the interpreter, including loops and
2181 compound statements.
2181 compound statements.
2182 """
2182 """
2183 # TODO: should we issue a loud deprecation warning here?
2183 # TODO: should we issue a loud deprecation warning here?
2184 magic_name, _, magic_arg_s = arg_s.partition(' ')
2184 magic_name, _, magic_arg_s = arg_s.partition(' ')
2185 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2185 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2186 return self.run_line_magic(magic_name, magic_arg_s)
2186 return self.run_line_magic(magic_name, magic_arg_s)
2187
2187
2188 #-------------------------------------------------------------------------
2188 #-------------------------------------------------------------------------
2189 # Things related to macros
2189 # Things related to macros
2190 #-------------------------------------------------------------------------
2190 #-------------------------------------------------------------------------
2191
2191
2192 def define_macro(self, name, themacro):
2192 def define_macro(self, name, themacro):
2193 """Define a new macro
2193 """Define a new macro
2194
2194
2195 Parameters
2195 Parameters
2196 ----------
2196 ----------
2197 name : str
2197 name : str
2198 The name of the macro.
2198 The name of the macro.
2199 themacro : str or Macro
2199 themacro : str or Macro
2200 The action to do upon invoking the macro. If a string, a new
2200 The action to do upon invoking the macro. If a string, a new
2201 Macro object is created by passing the string to it.
2201 Macro object is created by passing the string to it.
2202 """
2202 """
2203
2203
2204 from IPython.core import macro
2204 from IPython.core import macro
2205
2205
2206 if isinstance(themacro, basestring):
2206 if isinstance(themacro, basestring):
2207 themacro = macro.Macro(themacro)
2207 themacro = macro.Macro(themacro)
2208 if not isinstance(themacro, macro.Macro):
2208 if not isinstance(themacro, macro.Macro):
2209 raise ValueError('A macro must be a string or a Macro instance.')
2209 raise ValueError('A macro must be a string or a Macro instance.')
2210 self.user_ns[name] = themacro
2210 self.user_ns[name] = themacro
2211
2211
2212 #-------------------------------------------------------------------------
2212 #-------------------------------------------------------------------------
2213 # Things related to the running of system commands
2213 # Things related to the running of system commands
2214 #-------------------------------------------------------------------------
2214 #-------------------------------------------------------------------------
2215
2215
2216 def system_piped(self, cmd):
2216 def system_piped(self, cmd):
2217 """Call the given cmd in a subprocess, piping stdout/err
2217 """Call the given cmd in a subprocess, piping stdout/err
2218
2218
2219 Parameters
2219 Parameters
2220 ----------
2220 ----------
2221 cmd : str
2221 cmd : str
2222 Command to execute (can not end in '&', as background processes are
2222 Command to execute (can not end in '&', as background processes are
2223 not supported. Should not be a command that expects input
2223 not supported. Should not be a command that expects input
2224 other than simple text.
2224 other than simple text.
2225 """
2225 """
2226 if cmd.rstrip().endswith('&'):
2226 if cmd.rstrip().endswith('&'):
2227 # this is *far* from a rigorous test
2227 # this is *far* from a rigorous test
2228 # We do not support backgrounding processes because we either use
2228 # We do not support backgrounding processes because we either use
2229 # pexpect or pipes to read from. Users can always just call
2229 # pexpect or pipes to read from. Users can always just call
2230 # os.system() or use ip.system=ip.system_raw
2230 # os.system() or use ip.system=ip.system_raw
2231 # if they really want a background process.
2231 # if they really want a background process.
2232 raise OSError("Background processes not supported.")
2232 raise OSError("Background processes not supported.")
2233
2233
2234 # we explicitly do NOT return the subprocess status code, because
2234 # we explicitly do NOT return the subprocess status code, because
2235 # a non-None value would trigger :func:`sys.displayhook` calls.
2235 # a non-None value would trigger :func:`sys.displayhook` calls.
2236 # Instead, we store the exit_code in user_ns.
2236 # Instead, we store the exit_code in user_ns.
2237 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2237 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2238
2238
2239 def system_raw(self, cmd):
2239 def system_raw(self, cmd):
2240 """Call the given cmd in a subprocess using os.system
2240 """Call the given cmd in a subprocess using os.system
2241
2241
2242 Parameters
2242 Parameters
2243 ----------
2243 ----------
2244 cmd : str
2244 cmd : str
2245 Command to execute.
2245 Command to execute.
2246 """
2246 """
2247 cmd = self.var_expand(cmd, depth=1)
2247 cmd = self.var_expand(cmd, depth=1)
2248 # protect os.system from UNC paths on Windows, which it can't handle:
2248 # protect os.system from UNC paths on Windows, which it can't handle:
2249 if sys.platform == 'win32':
2249 if sys.platform == 'win32':
2250 from IPython.utils._process_win32 import AvoidUNCPath
2250 from IPython.utils._process_win32 import AvoidUNCPath
2251 with AvoidUNCPath() as path:
2251 with AvoidUNCPath() as path:
2252 if path is not None:
2252 if path is not None:
2253 cmd = '"pushd %s &&"%s' % (path, cmd)
2253 cmd = '"pushd %s &&"%s' % (path, cmd)
2254 cmd = py3compat.unicode_to_str(cmd)
2254 cmd = py3compat.unicode_to_str(cmd)
2255 ec = os.system(cmd)
2255 ec = os.system(cmd)
2256 else:
2256 else:
2257 cmd = py3compat.unicode_to_str(cmd)
2257 cmd = py3compat.unicode_to_str(cmd)
2258 ec = os.system(cmd)
2258 ec = os.system(cmd)
2259 # The high byte is the exit code, the low byte is a signal number
2259 # The high byte is the exit code, the low byte is a signal number
2260 # that we discard for now. See the docs for os.wait()
2260 # that we discard for now. See the docs for os.wait()
2261 if ec > 255:
2261 if ec > 255:
2262 ec >>= 8
2262 ec >>= 8
2263
2263
2264 # We explicitly do NOT return the subprocess status code, because
2264 # We explicitly do NOT return the subprocess status code, because
2265 # a non-None value would trigger :func:`sys.displayhook` calls.
2265 # a non-None value would trigger :func:`sys.displayhook` calls.
2266 # Instead, we store the exit_code in user_ns.
2266 # Instead, we store the exit_code in user_ns.
2267 self.user_ns['_exit_code'] = ec
2267 self.user_ns['_exit_code'] = ec
2268
2268
2269 # use piped system by default, because it is better behaved
2269 # use piped system by default, because it is better behaved
2270 system = system_piped
2270 system = system_piped
2271
2271
2272 def getoutput(self, cmd, split=True, depth=0):
2272 def getoutput(self, cmd, split=True, depth=0):
2273 """Get output (possibly including stderr) from a subprocess.
2273 """Get output (possibly including stderr) from a subprocess.
2274
2274
2275 Parameters
2275 Parameters
2276 ----------
2276 ----------
2277 cmd : str
2277 cmd : str
2278 Command to execute (can not end in '&', as background processes are
2278 Command to execute (can not end in '&', as background processes are
2279 not supported.
2279 not supported.
2280 split : bool, optional
2280 split : bool, optional
2281 If True, split the output into an IPython SList. Otherwise, an
2281 If True, split the output into an IPython SList. Otherwise, an
2282 IPython LSString is returned. These are objects similar to normal
2282 IPython LSString is returned. These are objects similar to normal
2283 lists and strings, with a few convenience attributes for easier
2283 lists and strings, with a few convenience attributes for easier
2284 manipulation of line-based output. You can use '?' on them for
2284 manipulation of line-based output. You can use '?' on them for
2285 details.
2285 details.
2286 depth : int, optional
2286 depth : int, optional
2287 How many frames above the caller are the local variables which should
2287 How many frames above the caller are the local variables which should
2288 be expanded in the command string? The default (0) assumes that the
2288 be expanded in the command string? The default (0) assumes that the
2289 expansion variables are in the stack frame calling this function.
2289 expansion variables are in the stack frame calling this function.
2290 """
2290 """
2291 if cmd.rstrip().endswith('&'):
2291 if cmd.rstrip().endswith('&'):
2292 # this is *far* from a rigorous test
2292 # this is *far* from a rigorous test
2293 raise OSError("Background processes not supported.")
2293 raise OSError("Background processes not supported.")
2294 out = getoutput(self.var_expand(cmd, depth=depth+1))
2294 out = getoutput(self.var_expand(cmd, depth=depth+1))
2295 if split:
2295 if split:
2296 out = SList(out.splitlines())
2296 out = SList(out.splitlines())
2297 else:
2297 else:
2298 out = LSString(out)
2298 out = LSString(out)
2299 return out
2299 return out
2300
2300
2301 #-------------------------------------------------------------------------
2301 #-------------------------------------------------------------------------
2302 # Things related to aliases
2302 # Things related to aliases
2303 #-------------------------------------------------------------------------
2303 #-------------------------------------------------------------------------
2304
2304
2305 def init_alias(self):
2305 def init_alias(self):
2306 self.alias_manager = AliasManager(shell=self, parent=self)
2306 self.alias_manager = AliasManager(shell=self, parent=self)
2307 self.configurables.append(self.alias_manager)
2307 self.configurables.append(self.alias_manager)
2308 self.ns_table['alias'] = self.alias_manager.alias_table,
2308 self.ns_table['alias'] = self.alias_manager.alias_table,
2309
2309
2310 #-------------------------------------------------------------------------
2310 #-------------------------------------------------------------------------
2311 # Things related to extensions
2311 # Things related to extensions
2312 #-------------------------------------------------------------------------
2312 #-------------------------------------------------------------------------
2313
2313
2314 def init_extension_manager(self):
2314 def init_extension_manager(self):
2315 self.extension_manager = ExtensionManager(shell=self, parent=self)
2315 self.extension_manager = ExtensionManager(shell=self, parent=self)
2316 self.configurables.append(self.extension_manager)
2316 self.configurables.append(self.extension_manager)
2317
2317
2318 #-------------------------------------------------------------------------
2318 #-------------------------------------------------------------------------
2319 # Things related to payloads
2319 # Things related to payloads
2320 #-------------------------------------------------------------------------
2320 #-------------------------------------------------------------------------
2321
2321
2322 def init_payload(self):
2322 def init_payload(self):
2323 self.payload_manager = PayloadManager(parent=self)
2323 self.payload_manager = PayloadManager(parent=self)
2324 self.configurables.append(self.payload_manager)
2324 self.configurables.append(self.payload_manager)
2325
2325
2326 #-------------------------------------------------------------------------
2326 #-------------------------------------------------------------------------
2327 # Things related to the prefilter
2327 # Things related to the prefilter
2328 #-------------------------------------------------------------------------
2328 #-------------------------------------------------------------------------
2329
2329
2330 def init_prefilter(self):
2330 def init_prefilter(self):
2331 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2331 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2332 self.configurables.append(self.prefilter_manager)
2332 self.configurables.append(self.prefilter_manager)
2333 # Ultimately this will be refactored in the new interpreter code, but
2333 # Ultimately this will be refactored in the new interpreter code, but
2334 # for now, we should expose the main prefilter method (there's legacy
2334 # for now, we should expose the main prefilter method (there's legacy
2335 # code out there that may rely on this).
2335 # code out there that may rely on this).
2336 self.prefilter = self.prefilter_manager.prefilter_lines
2336 self.prefilter = self.prefilter_manager.prefilter_lines
2337
2337
2338 def auto_rewrite_input(self, cmd):
2338 def auto_rewrite_input(self, cmd):
2339 """Print to the screen the rewritten form of the user's command.
2339 """Print to the screen the rewritten form of the user's command.
2340
2340
2341 This shows visual feedback by rewriting input lines that cause
2341 This shows visual feedback by rewriting input lines that cause
2342 automatic calling to kick in, like::
2342 automatic calling to kick in, like::
2343
2343
2344 /f x
2344 /f x
2345
2345
2346 into::
2346 into::
2347
2347
2348 ------> f(x)
2348 ------> f(x)
2349
2349
2350 after the user's input prompt. This helps the user understand that the
2350 after the user's input prompt. This helps the user understand that the
2351 input line was transformed automatically by IPython.
2351 input line was transformed automatically by IPython.
2352 """
2352 """
2353 if not self.show_rewritten_input:
2353 if not self.show_rewritten_input:
2354 return
2354 return
2355
2355
2356 rw = self.prompt_manager.render('rewrite') + cmd
2356 rw = self.prompt_manager.render('rewrite') + cmd
2357
2357
2358 try:
2358 try:
2359 # plain ascii works better w/ pyreadline, on some machines, so
2359 # plain ascii works better w/ pyreadline, on some machines, so
2360 # we use it and only print uncolored rewrite if we have unicode
2360 # we use it and only print uncolored rewrite if we have unicode
2361 rw = str(rw)
2361 rw = str(rw)
2362 print(rw, file=io.stdout)
2362 print(rw, file=io.stdout)
2363 except UnicodeEncodeError:
2363 except UnicodeEncodeError:
2364 print("------> " + cmd)
2364 print("------> " + cmd)
2365
2365
2366 #-------------------------------------------------------------------------
2366 #-------------------------------------------------------------------------
2367 # Things related to extracting values/expressions from kernel and user_ns
2367 # Things related to extracting values/expressions from kernel and user_ns
2368 #-------------------------------------------------------------------------
2368 #-------------------------------------------------------------------------
2369
2369
2370 def _user_obj_error(self):
2370 def _user_obj_error(self):
2371 """return simple exception dict
2371 """return simple exception dict
2372
2372
2373 for use in user_variables / expressions
2373 for use in user_variables / expressions
2374 """
2374 """
2375
2375
2376 etype, evalue, tb = self._get_exc_info()
2376 etype, evalue, tb = self._get_exc_info()
2377 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2377 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2378
2378
2379 exc_info = {
2379 exc_info = {
2380 u'status' : 'error',
2380 u'status' : 'error',
2381 u'traceback' : stb,
2381 u'traceback' : stb,
2382 u'ename' : unicode(etype.__name__),
2382 u'ename' : unicode(etype.__name__),
2383 u'evalue' : py3compat.safe_unicode(evalue),
2383 u'evalue' : py3compat.safe_unicode(evalue),
2384 }
2384 }
2385
2385
2386 return exc_info
2386 return exc_info
2387
2387
2388 def _format_user_obj(self, obj):
2388 def _format_user_obj(self, obj):
2389 """format a user object to display dict
2389 """format a user object to display dict
2390
2390
2391 for use in user_expressions / variables
2391 for use in user_expressions / variables
2392 """
2392 """
2393
2393
2394 data, md = self.display_formatter.format(obj)
2394 data, md = self.display_formatter.format(obj)
2395 value = {
2395 value = {
2396 'status' : 'ok',
2396 'status' : 'ok',
2397 'data' : data,
2397 'data' : data,
2398 'metadata' : md,
2398 'metadata' : md,
2399 }
2399 }
2400 return value
2400 return value
2401
2401
2402 def user_variables(self, names):
2402 def user_variables(self, names):
2403 """Get a list of variable names from the user's namespace.
2403 """Get a list of variable names from the user's namespace.
2404
2404
2405 Parameters
2405 Parameters
2406 ----------
2406 ----------
2407 names : list of strings
2407 names : list of strings
2408 A list of names of variables to be read from the user namespace.
2408 A list of names of variables to be read from the user namespace.
2409
2409
2410 Returns
2410 Returns
2411 -------
2411 -------
2412 A dict, keyed by the input names and with the rich mime-type repr(s) of each value.
2412 A dict, keyed by the input names and with the rich mime-type repr(s) of each value.
2413 Each element will be a sub-dict of the same form as a display_data message.
2413 Each element will be a sub-dict of the same form as a display_data message.
2414 """
2414 """
2415 out = {}
2415 out = {}
2416 user_ns = self.user_ns
2416 user_ns = self.user_ns
2417
2417
2418 for varname in names:
2418 for varname in names:
2419 try:
2419 try:
2420 value = self._format_user_obj(user_ns[varname])
2420 value = self._format_user_obj(user_ns[varname])
2421 except:
2421 except:
2422 value = self._user_obj_error()
2422 value = self._user_obj_error()
2423 out[varname] = value
2423 out[varname] = value
2424 return out
2424 return out
2425
2425
2426 def user_expressions(self, expressions):
2426 def user_expressions(self, expressions):
2427 """Evaluate a dict of expressions in the user's namespace.
2427 """Evaluate a dict of expressions in the user's namespace.
2428
2428
2429 Parameters
2429 Parameters
2430 ----------
2430 ----------
2431 expressions : dict
2431 expressions : dict
2432 A dict with string keys and string values. The expression values
2432 A dict with string keys and string values. The expression values
2433 should be valid Python expressions, each of which will be evaluated
2433 should be valid Python expressions, each of which will be evaluated
2434 in the user namespace.
2434 in the user namespace.
2435
2435
2436 Returns
2436 Returns
2437 -------
2437 -------
2438 A dict, keyed like the input expressions dict, with the rich mime-typed
2438 A dict, keyed like the input expressions dict, with the rich mime-typed
2439 display_data of each value.
2439 display_data of each value.
2440 """
2440 """
2441 out = {}
2441 out = {}
2442 user_ns = self.user_ns
2442 user_ns = self.user_ns
2443 global_ns = self.user_global_ns
2443 global_ns = self.user_global_ns
2444
2444
2445 for key, expr in expressions.iteritems():
2445 for key, expr in expressions.iteritems():
2446 try:
2446 try:
2447 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2447 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2448 except:
2448 except:
2449 value = self._user_obj_error()
2449 value = self._user_obj_error()
2450 out[key] = value
2450 out[key] = value
2451 return out
2451 return out
2452
2452
2453 #-------------------------------------------------------------------------
2453 #-------------------------------------------------------------------------
2454 # Things related to the running of code
2454 # Things related to the running of code
2455 #-------------------------------------------------------------------------
2455 #-------------------------------------------------------------------------
2456
2456
2457 def ex(self, cmd):
2457 def ex(self, cmd):
2458 """Execute a normal python statement in user namespace."""
2458 """Execute a normal python statement in user namespace."""
2459 with self.builtin_trap:
2459 with self.builtin_trap:
2460 exec cmd in self.user_global_ns, self.user_ns
2460 exec cmd in self.user_global_ns, self.user_ns
2461
2461
2462 def ev(self, expr):
2462 def ev(self, expr):
2463 """Evaluate python expression expr in user namespace.
2463 """Evaluate python expression expr in user namespace.
2464
2464
2465 Returns the result of evaluation
2465 Returns the result of evaluation
2466 """
2466 """
2467 with self.builtin_trap:
2467 with self.builtin_trap:
2468 return eval(expr, self.user_global_ns, self.user_ns)
2468 return eval(expr, self.user_global_ns, self.user_ns)
2469
2469
2470 def safe_execfile(self, fname, *where, **kw):
2470 def safe_execfile(self, fname, *where, **kw):
2471 """A safe version of the builtin execfile().
2471 """A safe version of the builtin execfile().
2472
2472
2473 This version will never throw an exception, but instead print
2473 This version will never throw an exception, but instead print
2474 helpful error messages to the screen. This only works on pure
2474 helpful error messages to the screen. This only works on pure
2475 Python files with the .py extension.
2475 Python files with the .py extension.
2476
2476
2477 Parameters
2477 Parameters
2478 ----------
2478 ----------
2479 fname : string
2479 fname : string
2480 The name of the file to be executed.
2480 The name of the file to be executed.
2481 where : tuple
2481 where : tuple
2482 One or two namespaces, passed to execfile() as (globals,locals).
2482 One or two namespaces, passed to execfile() as (globals,locals).
2483 If only one is given, it is passed as both.
2483 If only one is given, it is passed as both.
2484 exit_ignore : bool (False)
2484 exit_ignore : bool (False)
2485 If True, then silence SystemExit for non-zero status (it is always
2485 If True, then silence SystemExit for non-zero status (it is always
2486 silenced for zero status, as it is so common).
2486 silenced for zero status, as it is so common).
2487 raise_exceptions : bool (False)
2487 raise_exceptions : bool (False)
2488 If True raise exceptions everywhere. Meant for testing.
2488 If True raise exceptions everywhere. Meant for testing.
2489
2489
2490 """
2490 """
2491 kw.setdefault('exit_ignore', False)
2491 kw.setdefault('exit_ignore', False)
2492 kw.setdefault('raise_exceptions', False)
2492 kw.setdefault('raise_exceptions', False)
2493
2493
2494 fname = os.path.abspath(os.path.expanduser(fname))
2494 fname = os.path.abspath(os.path.expanduser(fname))
2495
2495
2496 # Make sure we can open the file
2496 # Make sure we can open the file
2497 try:
2497 try:
2498 with open(fname) as thefile:
2498 with open(fname) as thefile:
2499 pass
2499 pass
2500 except:
2500 except:
2501 warn('Could not open file <%s> for safe execution.' % fname)
2501 warn('Could not open file <%s> for safe execution.' % fname)
2502 return
2502 return
2503
2503
2504 # Find things also in current directory. This is needed to mimic the
2504 # Find things also in current directory. This is needed to mimic the
2505 # behavior of running a script from the system command line, where
2505 # behavior of running a script from the system command line, where
2506 # Python inserts the script's directory into sys.path
2506 # Python inserts the script's directory into sys.path
2507 dname = os.path.dirname(fname)
2507 dname = os.path.dirname(fname)
2508
2508
2509 with prepended_to_syspath(dname):
2509 with prepended_to_syspath(dname):
2510 try:
2510 try:
2511 py3compat.execfile(fname,*where)
2511 py3compat.execfile(fname,*where)
2512 except SystemExit as status:
2512 except SystemExit as status:
2513 # If the call was made with 0 or None exit status (sys.exit(0)
2513 # If the call was made with 0 or None exit status (sys.exit(0)
2514 # or sys.exit() ), don't bother showing a traceback, as both of
2514 # or sys.exit() ), don't bother showing a traceback, as both of
2515 # these are considered normal by the OS:
2515 # these are considered normal by the OS:
2516 # > python -c'import sys;sys.exit(0)'; echo $?
2516 # > python -c'import sys;sys.exit(0)'; echo $?
2517 # 0
2517 # 0
2518 # > python -c'import sys;sys.exit()'; echo $?
2518 # > python -c'import sys;sys.exit()'; echo $?
2519 # 0
2519 # 0
2520 # For other exit status, we show the exception unless
2520 # For other exit status, we show the exception unless
2521 # explicitly silenced, but only in short form.
2521 # explicitly silenced, but only in short form.
2522 if kw['raise_exceptions']:
2522 if kw['raise_exceptions']:
2523 raise
2523 raise
2524 if status.code and not kw['exit_ignore']:
2524 if status.code and not kw['exit_ignore']:
2525 self.showtraceback(exception_only=True)
2525 self.showtraceback(exception_only=True)
2526 except:
2526 except:
2527 if kw['raise_exceptions']:
2527 if kw['raise_exceptions']:
2528 raise
2528 raise
2529 self.showtraceback()
2529 self.showtraceback()
2530
2530
2531 def safe_execfile_ipy(self, fname):
2531 def safe_execfile_ipy(self, fname):
2532 """Like safe_execfile, but for .ipy files with IPython syntax.
2532 """Like safe_execfile, but for .ipy files with IPython syntax.
2533
2533
2534 Parameters
2534 Parameters
2535 ----------
2535 ----------
2536 fname : str
2536 fname : str
2537 The name of the file to execute. The filename must have a
2537 The name of the file to execute. The filename must have a
2538 .ipy extension.
2538 .ipy extension.
2539 """
2539 """
2540 fname = os.path.abspath(os.path.expanduser(fname))
2540 fname = os.path.abspath(os.path.expanduser(fname))
2541
2541
2542 # Make sure we can open the file
2542 # Make sure we can open the file
2543 try:
2543 try:
2544 with open(fname) as thefile:
2544 with open(fname) as thefile:
2545 pass
2545 pass
2546 except:
2546 except:
2547 warn('Could not open file <%s> for safe execution.' % fname)
2547 warn('Could not open file <%s> for safe execution.' % fname)
2548 return
2548 return
2549
2549
2550 # Find things also in current directory. This is needed to mimic the
2550 # Find things also in current directory. This is needed to mimic the
2551 # behavior of running a script from the system command line, where
2551 # behavior of running a script from the system command line, where
2552 # Python inserts the script's directory into sys.path
2552 # Python inserts the script's directory into sys.path
2553 dname = os.path.dirname(fname)
2553 dname = os.path.dirname(fname)
2554
2554
2555 with prepended_to_syspath(dname):
2555 with prepended_to_syspath(dname):
2556 try:
2556 try:
2557 with open(fname) as thefile:
2557 with open(fname) as thefile:
2558 # self.run_cell currently captures all exceptions
2558 # self.run_cell currently captures all exceptions
2559 # raised in user code. It would be nice if there were
2559 # raised in user code. It would be nice if there were
2560 # versions of runlines, execfile that did raise, so
2560 # versions of runlines, execfile that did raise, so
2561 # we could catch the errors.
2561 # we could catch the errors.
2562 self.run_cell(thefile.read(), store_history=False, shell_futures=False)
2562 self.run_cell(thefile.read(), store_history=False, shell_futures=False)
2563 except:
2563 except:
2564 self.showtraceback()
2564 self.showtraceback()
2565 warn('Unknown failure executing file: <%s>' % fname)
2565 warn('Unknown failure executing file: <%s>' % fname)
2566
2566
2567 def safe_run_module(self, mod_name, where):
2567 def safe_run_module(self, mod_name, where):
2568 """A safe version of runpy.run_module().
2568 """A safe version of runpy.run_module().
2569
2569
2570 This version will never throw an exception, but instead print
2570 This version will never throw an exception, but instead print
2571 helpful error messages to the screen.
2571 helpful error messages to the screen.
2572
2572
2573 `SystemExit` exceptions with status code 0 or None are ignored.
2573 `SystemExit` exceptions with status code 0 or None are ignored.
2574
2574
2575 Parameters
2575 Parameters
2576 ----------
2576 ----------
2577 mod_name : string
2577 mod_name : string
2578 The name of the module to be executed.
2578 The name of the module to be executed.
2579 where : dict
2579 where : dict
2580 The globals namespace.
2580 The globals namespace.
2581 """
2581 """
2582 try:
2582 try:
2583 try:
2583 try:
2584 where.update(
2584 where.update(
2585 runpy.run_module(str(mod_name), run_name="__main__",
2585 runpy.run_module(str(mod_name), run_name="__main__",
2586 alter_sys=True)
2586 alter_sys=True)
2587 )
2587 )
2588 except SystemExit as status:
2588 except SystemExit as status:
2589 if status.code:
2589 if status.code:
2590 raise
2590 raise
2591 except:
2591 except:
2592 self.showtraceback()
2592 self.showtraceback()
2593 warn('Unknown failure executing module: <%s>' % mod_name)
2593 warn('Unknown failure executing module: <%s>' % mod_name)
2594
2594
2595 def _run_cached_cell_magic(self, magic_name, line):
2595 def _run_cached_cell_magic(self, magic_name, line):
2596 """Special method to call a cell magic with the data stored in self.
2596 """Special method to call a cell magic with the data stored in self.
2597 """
2597 """
2598 cell = self._current_cell_magic_body
2598 cell = self._current_cell_magic_body
2599 self._current_cell_magic_body = None
2599 self._current_cell_magic_body = None
2600 return self.run_cell_magic(magic_name, line, cell)
2600 return self.run_cell_magic(magic_name, line, cell)
2601
2601
2602 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2602 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2603 """Run a complete IPython cell.
2603 """Run a complete IPython cell.
2604
2604
2605 Parameters
2605 Parameters
2606 ----------
2606 ----------
2607 raw_cell : str
2607 raw_cell : str
2608 The code (including IPython code such as %magic functions) to run.
2608 The code (including IPython code such as %magic functions) to run.
2609 store_history : bool
2609 store_history : bool
2610 If True, the raw and translated cell will be stored in IPython's
2610 If True, the raw and translated cell will be stored in IPython's
2611 history. For user code calling back into IPython's machinery, this
2611 history. For user code calling back into IPython's machinery, this
2612 should be set to False.
2612 should be set to False.
2613 silent : bool
2613 silent : bool
2614 If True, avoid side-effects, such as implicit displayhooks and
2614 If True, avoid side-effects, such as implicit displayhooks and
2615 and logging. silent=True forces store_history=False.
2615 and logging. silent=True forces store_history=False.
2616 shell_futures : bool
2616 shell_futures : bool
2617 If True, the code will share future statements with the interactive
2617 If True, the code will share future statements with the interactive
2618 shell. It will both be affected by previous __future__ imports, and
2618 shell. It will both be affected by previous __future__ imports, and
2619 any __future__ imports in the code will affect the shell. If False,
2619 any __future__ imports in the code will affect the shell. If False,
2620 __future__ imports are not shared in either direction.
2620 __future__ imports are not shared in either direction.
2621 """
2621 """
2622 if (not raw_cell) or raw_cell.isspace():
2622 if (not raw_cell) or raw_cell.isspace():
2623 return
2623 return
2624
2624
2625 if silent:
2625 if silent:
2626 store_history = False
2626 store_history = False
2627
2627
2628 self.input_transformer_manager.push(raw_cell)
2628 self.input_transformer_manager.push(raw_cell)
2629 cell = self.input_transformer_manager.source_reset()
2629 cell = self.input_transformer_manager.source_reset()
2630
2630
2631 # Our own compiler remembers the __future__ environment. If we want to
2631 # Our own compiler remembers the __future__ environment. If we want to
2632 # run code with a separate __future__ environment, use the default
2632 # run code with a separate __future__ environment, use the default
2633 # compiler
2633 # compiler
2634 compiler = self.compile if shell_futures else CachingCompiler()
2634 compiler = self.compile if shell_futures else CachingCompiler()
2635
2635
2636 with self.builtin_trap:
2636 with self.builtin_trap:
2637 prefilter_failed = False
2637 prefilter_failed = False
2638 if len(cell.splitlines()) == 1:
2638 if len(cell.splitlines()) == 1:
2639 try:
2639 try:
2640 # use prefilter_lines to handle trailing newlines
2640 # use prefilter_lines to handle trailing newlines
2641 # restore trailing newline for ast.parse
2641 # restore trailing newline for ast.parse
2642 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2642 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2643 except AliasError as e:
2643 except AliasError as e:
2644 error(e)
2644 error(e)
2645 prefilter_failed = True
2645 prefilter_failed = True
2646 except Exception:
2646 except Exception:
2647 # don't allow prefilter errors to crash IPython
2647 # don't allow prefilter errors to crash IPython
2648 self.showtraceback()
2648 self.showtraceback()
2649 prefilter_failed = True
2649 prefilter_failed = True
2650
2650
2651 # Store raw and processed history
2651 # Store raw and processed history
2652 if store_history:
2652 if store_history:
2653 self.history_manager.store_inputs(self.execution_count,
2653 self.history_manager.store_inputs(self.execution_count,
2654 cell, raw_cell)
2654 cell, raw_cell)
2655 if not silent:
2655 if not silent:
2656 self.logger.log(cell, raw_cell)
2656 self.logger.log(cell, raw_cell)
2657
2657
2658 if not prefilter_failed:
2658 if not prefilter_failed:
2659 # don't run if prefilter failed
2659 # don't run if prefilter failed
2660 cell_name = self.compile.cache(cell, self.execution_count)
2660 cell_name = self.compile.cache(cell, self.execution_count)
2661
2661
2662 with self.display_trap:
2662 with self.display_trap:
2663 try:
2663 try:
2664 code_ast = compiler.ast_parse(cell, filename=cell_name)
2664 code_ast = compiler.ast_parse(cell, filename=cell_name)
2665 except IndentationError:
2665 except IndentationError:
2666 self.showindentationerror()
2666 self.showindentationerror()
2667 if store_history:
2667 if store_history:
2668 self.execution_count += 1
2668 self.execution_count += 1
2669 return None
2669 return None
2670 except (OverflowError, SyntaxError, ValueError, TypeError,
2670 except (OverflowError, SyntaxError, ValueError, TypeError,
2671 MemoryError):
2671 MemoryError):
2672 self.showsyntaxerror()
2672 self.showsyntaxerror()
2673 if store_history:
2673 if store_history:
2674 self.execution_count += 1
2674 self.execution_count += 1
2675 return None
2675 return None
2676
2676
2677 code_ast = self.transform_ast(code_ast)
2677 code_ast = self.transform_ast(code_ast)
2678
2678
2679 interactivity = "none" if silent else self.ast_node_interactivity
2679 interactivity = "none" if silent else self.ast_node_interactivity
2680 self.run_ast_nodes(code_ast.body, cell_name,
2680 self.run_ast_nodes(code_ast.body, cell_name,
2681 interactivity=interactivity, compiler=compiler)
2681 interactivity=interactivity, compiler=compiler)
2682
2682
2683 # Execute any registered post-execution functions.
2683 # Execute any registered post-execution functions.
2684 # unless we are silent
2684 # unless we are silent
2685 post_exec = [] if silent else self._post_execute.iteritems()
2685 post_exec = [] if silent else self._post_execute.iteritems()
2686
2686
2687 for func, status in post_exec:
2687 for func, status in post_exec:
2688 if self.disable_failing_post_execute and not status:
2688 if self.disable_failing_post_execute and not status:
2689 continue
2689 continue
2690 try:
2690 try:
2691 func()
2691 func()
2692 except KeyboardInterrupt:
2692 except KeyboardInterrupt:
2693 print("\nKeyboardInterrupt", file=io.stderr)
2693 print("\nKeyboardInterrupt", file=io.stderr)
2694 except Exception:
2694 except Exception:
2695 # register as failing:
2695 # register as failing:
2696 self._post_execute[func] = False
2696 self._post_execute[func] = False
2697 self.showtraceback()
2697 self.showtraceback()
2698 print('\n'.join([
2698 print('\n'.join([
2699 "post-execution function %r produced an error." % func,
2699 "post-execution function %r produced an error." % func,
2700 "If this problem persists, you can disable failing post-exec functions with:",
2700 "If this problem persists, you can disable failing post-exec functions with:",
2701 "",
2701 "",
2702 " get_ipython().disable_failing_post_execute = True"
2702 " get_ipython().disable_failing_post_execute = True"
2703 ]), file=io.stderr)
2703 ]), file=io.stderr)
2704
2704
2705 if store_history:
2705 if store_history:
2706 # Write output to the database. Does nothing unless
2706 # Write output to the database. Does nothing unless
2707 # history output logging is enabled.
2707 # history output logging is enabled.
2708 self.history_manager.store_output(self.execution_count)
2708 self.history_manager.store_output(self.execution_count)
2709 # Each cell is a *single* input, regardless of how many lines it has
2709 # Each cell is a *single* input, regardless of how many lines it has
2710 self.execution_count += 1
2710 self.execution_count += 1
2711
2711
2712 def transform_ast(self, node):
2712 def transform_ast(self, node):
2713 """Apply the AST transformations from self.ast_transformers
2713 """Apply the AST transformations from self.ast_transformers
2714
2714
2715 Parameters
2715 Parameters
2716 ----------
2716 ----------
2717 node : ast.Node
2717 node : ast.Node
2718 The root node to be transformed. Typically called with the ast.Module
2718 The root node to be transformed. Typically called with the ast.Module
2719 produced by parsing user input.
2719 produced by parsing user input.
2720
2720
2721 Returns
2721 Returns
2722 -------
2722 -------
2723 An ast.Node corresponding to the node it was called with. Note that it
2723 An ast.Node corresponding to the node it was called with. Note that it
2724 may also modify the passed object, so don't rely on references to the
2724 may also modify the passed object, so don't rely on references to the
2725 original AST.
2725 original AST.
2726 """
2726 """
2727 for transformer in self.ast_transformers:
2727 for transformer in self.ast_transformers:
2728 try:
2728 try:
2729 node = transformer.visit(node)
2729 node = transformer.visit(node)
2730 except Exception:
2730 except Exception:
2731 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2731 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2732 self.ast_transformers.remove(transformer)
2732 self.ast_transformers.remove(transformer)
2733
2733
2734 if self.ast_transformers:
2734 if self.ast_transformers:
2735 ast.fix_missing_locations(node)
2735 ast.fix_missing_locations(node)
2736 return node
2736 return node
2737
2737
2738
2738
2739 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2739 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2740 compiler=compile):
2740 compiler=compile):
2741 """Run a sequence of AST nodes. The execution mode depends on the
2741 """Run a sequence of AST nodes. The execution mode depends on the
2742 interactivity parameter.
2742 interactivity parameter.
2743
2743
2744 Parameters
2744 Parameters
2745 ----------
2745 ----------
2746 nodelist : list
2746 nodelist : list
2747 A sequence of AST nodes to run.
2747 A sequence of AST nodes to run.
2748 cell_name : str
2748 cell_name : str
2749 Will be passed to the compiler as the filename of the cell. Typically
2749 Will be passed to the compiler as the filename of the cell. Typically
2750 the value returned by ip.compile.cache(cell).
2750 the value returned by ip.compile.cache(cell).
2751 interactivity : str
2751 interactivity : str
2752 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2752 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2753 run interactively (displaying output from expressions). 'last_expr'
2753 run interactively (displaying output from expressions). 'last_expr'
2754 will run the last node interactively only if it is an expression (i.e.
2754 will run the last node interactively only if it is an expression (i.e.
2755 expressions in loops or other blocks are not displayed. Other values
2755 expressions in loops or other blocks are not displayed. Other values
2756 for this parameter will raise a ValueError.
2756 for this parameter will raise a ValueError.
2757 compiler : callable
2757 compiler : callable
2758 A function with the same interface as the built-in compile(), to turn
2758 A function with the same interface as the built-in compile(), to turn
2759 the AST nodes into code objects. Default is the built-in compile().
2759 the AST nodes into code objects. Default is the built-in compile().
2760 """
2760 """
2761 if not nodelist:
2761 if not nodelist:
2762 return
2762 return
2763
2763
2764 if interactivity == 'last_expr':
2764 if interactivity == 'last_expr':
2765 if isinstance(nodelist[-1], ast.Expr):
2765 if isinstance(nodelist[-1], ast.Expr):
2766 interactivity = "last"
2766 interactivity = "last"
2767 else:
2767 else:
2768 interactivity = "none"
2768 interactivity = "none"
2769
2769
2770 if interactivity == 'none':
2770 if interactivity == 'none':
2771 to_run_exec, to_run_interactive = nodelist, []
2771 to_run_exec, to_run_interactive = nodelist, []
2772 elif interactivity == 'last':
2772 elif interactivity == 'last':
2773 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2773 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2774 elif interactivity == 'all':
2774 elif interactivity == 'all':
2775 to_run_exec, to_run_interactive = [], nodelist
2775 to_run_exec, to_run_interactive = [], nodelist
2776 else:
2776 else:
2777 raise ValueError("Interactivity was %r" % interactivity)
2777 raise ValueError("Interactivity was %r" % interactivity)
2778
2778
2779 exec_count = self.execution_count
2779 exec_count = self.execution_count
2780
2780
2781 try:
2781 try:
2782 for i, node in enumerate(to_run_exec):
2782 for i, node in enumerate(to_run_exec):
2783 mod = ast.Module([node])
2783 mod = ast.Module([node])
2784 code = compiler(mod, cell_name, "exec")
2784 code = compiler(mod, cell_name, "exec")
2785 if self.run_code(code):
2785 if self.run_code(code):
2786 return True
2786 return True
2787
2787
2788 for i, node in enumerate(to_run_interactive):
2788 for i, node in enumerate(to_run_interactive):
2789 mod = ast.Interactive([node])
2789 mod = ast.Interactive([node])
2790 code = compiler(mod, cell_name, "single")
2790 code = compiler(mod, cell_name, "single")
2791 if self.run_code(code):
2791 if self.run_code(code):
2792 return True
2792 return True
2793
2793
2794 # Flush softspace
2794 # Flush softspace
2795 if softspace(sys.stdout, 0):
2795 if softspace(sys.stdout, 0):
2796 print()
2796 print()
2797
2797
2798 except:
2798 except:
2799 # It's possible to have exceptions raised here, typically by
2799 # It's possible to have exceptions raised here, typically by
2800 # compilation of odd code (such as a naked 'return' outside a
2800 # compilation of odd code (such as a naked 'return' outside a
2801 # function) that did parse but isn't valid. Typically the exception
2801 # function) that did parse but isn't valid. Typically the exception
2802 # is a SyntaxError, but it's safest just to catch anything and show
2802 # is a SyntaxError, but it's safest just to catch anything and show
2803 # the user a traceback.
2803 # the user a traceback.
2804
2804
2805 # We do only one try/except outside the loop to minimize the impact
2805 # We do only one try/except outside the loop to minimize the impact
2806 # on runtime, and also because if any node in the node list is
2806 # on runtime, and also because if any node in the node list is
2807 # broken, we should stop execution completely.
2807 # broken, we should stop execution completely.
2808 self.showtraceback()
2808 self.showtraceback()
2809
2809
2810 return False
2810 return False
2811
2811
2812 def run_code(self, code_obj):
2812 def run_code(self, code_obj):
2813 """Execute a code object.
2813 """Execute a code object.
2814
2814
2815 When an exception occurs, self.showtraceback() is called to display a
2815 When an exception occurs, self.showtraceback() is called to display a
2816 traceback.
2816 traceback.
2817
2817
2818 Parameters
2818 Parameters
2819 ----------
2819 ----------
2820 code_obj : code object
2820 code_obj : code object
2821 A compiled code object, to be executed
2821 A compiled code object, to be executed
2822
2822
2823 Returns
2823 Returns
2824 -------
2824 -------
2825 False : successful execution.
2825 False : successful execution.
2826 True : an error occurred.
2826 True : an error occurred.
2827 """
2827 """
2828
2828
2829 # Set our own excepthook in case the user code tries to call it
2829 # Set our own excepthook in case the user code tries to call it
2830 # directly, so that the IPython crash handler doesn't get triggered
2830 # directly, so that the IPython crash handler doesn't get triggered
2831 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2831 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2832
2832
2833 # we save the original sys.excepthook in the instance, in case config
2833 # we save the original sys.excepthook in the instance, in case config
2834 # code (such as magics) needs access to it.
2834 # code (such as magics) needs access to it.
2835 self.sys_excepthook = old_excepthook
2835 self.sys_excepthook = old_excepthook
2836 outflag = 1 # happens in more places, so it's easier as default
2836 outflag = 1 # happens in more places, so it's easier as default
2837 try:
2837 try:
2838 try:
2838 try:
2839 self.hooks.pre_run_code_hook()
2839 self.hooks.pre_run_code_hook()
2840 #rprint('Running code', repr(code_obj)) # dbg
2840 #rprint('Running code', repr(code_obj)) # dbg
2841 exec code_obj in self.user_global_ns, self.user_ns
2841 exec code_obj in self.user_global_ns, self.user_ns
2842 finally:
2842 finally:
2843 # Reset our crash handler in place
2843 # Reset our crash handler in place
2844 sys.excepthook = old_excepthook
2844 sys.excepthook = old_excepthook
2845 except SystemExit:
2845 except SystemExit:
2846 self.showtraceback(exception_only=True)
2846 self.showtraceback(exception_only=True)
2847 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2847 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2848 except self.custom_exceptions:
2848 except self.custom_exceptions:
2849 etype,value,tb = sys.exc_info()
2849 etype,value,tb = sys.exc_info()
2850 self.CustomTB(etype,value,tb)
2850 self.CustomTB(etype,value,tb)
2851 except:
2851 except:
2852 self.showtraceback()
2852 self.showtraceback()
2853 else:
2853 else:
2854 outflag = 0
2854 outflag = 0
2855 return outflag
2855 return outflag
2856
2856
2857 # For backwards compatibility
2857 # For backwards compatibility
2858 runcode = run_code
2858 runcode = run_code
2859
2859
2860 #-------------------------------------------------------------------------
2860 #-------------------------------------------------------------------------
2861 # Things related to GUI support and pylab
2861 # Things related to GUI support and pylab
2862 #-------------------------------------------------------------------------
2862 #-------------------------------------------------------------------------
2863
2863
2864 def enable_gui(self, gui=None):
2864 def enable_gui(self, gui=None):
2865 raise NotImplementedError('Implement enable_gui in a subclass')
2865 raise NotImplementedError('Implement enable_gui in a subclass')
2866
2866
2867 def enable_matplotlib(self, gui=None):
2867 def enable_matplotlib(self, gui=None):
2868 """Enable interactive matplotlib and inline figure support.
2868 """Enable interactive matplotlib and inline figure support.
2869
2869
2870 This takes the following steps:
2870 This takes the following steps:
2871
2871
2872 1. select the appropriate eventloop and matplotlib backend
2872 1. select the appropriate eventloop and matplotlib backend
2873 2. set up matplotlib for interactive use with that backend
2873 2. set up matplotlib for interactive use with that backend
2874 3. configure formatters for inline figure display
2874 3. configure formatters for inline figure display
2875 4. enable the selected gui eventloop
2875 4. enable the selected gui eventloop
2876
2876
2877 Parameters
2877 Parameters
2878 ----------
2878 ----------
2879 gui : optional, string
2879 gui : optional, string
2880 If given, dictates the choice of matplotlib GUI backend to use
2880 If given, dictates the choice of matplotlib GUI backend to use
2881 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2881 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2882 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2882 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2883 matplotlib (as dictated by the matplotlib build-time options plus the
2883 matplotlib (as dictated by the matplotlib build-time options plus the
2884 user's matplotlibrc configuration file). Note that not all backends
2884 user's matplotlibrc configuration file). Note that not all backends
2885 make sense in all contexts, for example a terminal ipython can't
2885 make sense in all contexts, for example a terminal ipython can't
2886 display figures inline.
2886 display figures inline.
2887 """
2887 """
2888 from IPython.core import pylabtools as pt
2888 from IPython.core import pylabtools as pt
2889 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2889 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2890
2890
2891 if gui != 'inline':
2891 if gui != 'inline':
2892 # If we have our first gui selection, store it
2892 # If we have our first gui selection, store it
2893 if self.pylab_gui_select is None:
2893 if self.pylab_gui_select is None:
2894 self.pylab_gui_select = gui
2894 self.pylab_gui_select = gui
2895 # Otherwise if they are different
2895 # Otherwise if they are different
2896 elif gui != self.pylab_gui_select:
2896 elif gui != self.pylab_gui_select:
2897 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2897 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2898 ' Using %s instead.' % (gui, self.pylab_gui_select))
2898 ' Using %s instead.' % (gui, self.pylab_gui_select))
2899 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2899 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2900
2900
2901 pt.activate_matplotlib(backend)
2901 pt.activate_matplotlib(backend)
2902 pt.configure_inline_support(self, backend)
2902 pt.configure_inline_support(self, backend)
2903
2903
2904 # Now we must activate the gui pylab wants to use, and fix %run to take
2904 # Now we must activate the gui pylab wants to use, and fix %run to take
2905 # plot updates into account
2905 # plot updates into account
2906 self.enable_gui(gui)
2906 self.enable_gui(gui)
2907 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2907 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2908 pt.mpl_runner(self.safe_execfile)
2908 pt.mpl_runner(self.safe_execfile)
2909
2909
2910 return gui, backend
2910 return gui, backend
2911
2911
2912 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2912 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2913 """Activate pylab support at runtime.
2913 """Activate pylab support at runtime.
2914
2914
2915 This turns on support for matplotlib, preloads into the interactive
2915 This turns on support for matplotlib, preloads into the interactive
2916 namespace all of numpy and pylab, and configures IPython to correctly
2916 namespace all of numpy and pylab, and configures IPython to correctly
2917 interact with the GUI event loop. The GUI backend to be used can be
2917 interact with the GUI event loop. The GUI backend to be used can be
2918 optionally selected with the optional ``gui`` argument.
2918 optionally selected with the optional ``gui`` argument.
2919
2919
2920 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2920 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2921
2921
2922 Parameters
2922 Parameters
2923 ----------
2923 ----------
2924 gui : optional, string
2924 gui : optional, string
2925 If given, dictates the choice of matplotlib GUI backend to use
2925 If given, dictates the choice of matplotlib GUI backend to use
2926 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2926 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2927 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2927 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2928 matplotlib (as dictated by the matplotlib build-time options plus the
2928 matplotlib (as dictated by the matplotlib build-time options plus the
2929 user's matplotlibrc configuration file). Note that not all backends
2929 user's matplotlibrc configuration file). Note that not all backends
2930 make sense in all contexts, for example a terminal ipython can't
2930 make sense in all contexts, for example a terminal ipython can't
2931 display figures inline.
2931 display figures inline.
2932 import_all : optional, bool, default: True
2932 import_all : optional, bool, default: True
2933 Whether to do `from numpy import *` and `from pylab import *`
2933 Whether to do `from numpy import *` and `from pylab import *`
2934 in addition to module imports.
2934 in addition to module imports.
2935 welcome_message : deprecated
2935 welcome_message : deprecated
2936 This argument is ignored, no welcome message will be displayed.
2936 This argument is ignored, no welcome message will be displayed.
2937 """
2937 """
2938 from IPython.core.pylabtools import import_pylab
2938 from IPython.core.pylabtools import import_pylab
2939
2939
2940 gui, backend = self.enable_matplotlib(gui)
2940 gui, backend = self.enable_matplotlib(gui)
2941
2941
2942 # We want to prevent the loading of pylab to pollute the user's
2942 # We want to prevent the loading of pylab to pollute the user's
2943 # namespace as shown by the %who* magics, so we execute the activation
2943 # namespace as shown by the %who* magics, so we execute the activation
2944 # code in an empty namespace, and we update *both* user_ns and
2944 # code in an empty namespace, and we update *both* user_ns and
2945 # user_ns_hidden with this information.
2945 # user_ns_hidden with this information.
2946 ns = {}
2946 ns = {}
2947 import_pylab(ns, import_all)
2947 import_pylab(ns, import_all)
2948 # warn about clobbered names
2948 # warn about clobbered names
2949 ignored = set(["__builtins__"])
2949 ignored = set(["__builtins__"])
2950 both = set(ns).intersection(self.user_ns).difference(ignored)
2950 both = set(ns).intersection(self.user_ns).difference(ignored)
2951 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2951 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2952 self.user_ns.update(ns)
2952 self.user_ns.update(ns)
2953 self.user_ns_hidden.update(ns)
2953 self.user_ns_hidden.update(ns)
2954 return gui, backend, clobbered
2954 return gui, backend, clobbered
2955
2955
2956 #-------------------------------------------------------------------------
2956 #-------------------------------------------------------------------------
2957 # Utilities
2957 # Utilities
2958 #-------------------------------------------------------------------------
2958 #-------------------------------------------------------------------------
2959
2959
2960 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2960 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2961 """Expand python variables in a string.
2961 """Expand python variables in a string.
2962
2962
2963 The depth argument indicates how many frames above the caller should
2963 The depth argument indicates how many frames above the caller should
2964 be walked to look for the local namespace where to expand variables.
2964 be walked to look for the local namespace where to expand variables.
2965
2965
2966 The global namespace for expansion is always the user's interactive
2966 The global namespace for expansion is always the user's interactive
2967 namespace.
2967 namespace.
2968 """
2968 """
2969 ns = self.user_ns.copy()
2969 ns = self.user_ns.copy()
2970 ns.update(sys._getframe(depth+1).f_locals)
2970 ns.update(sys._getframe(depth+1).f_locals)
2971 try:
2971 try:
2972 # We have to use .vformat() here, because 'self' is a valid and common
2972 # We have to use .vformat() here, because 'self' is a valid and common
2973 # name, and expanding **ns for .format() would make it collide with
2973 # name, and expanding **ns for .format() would make it collide with
2974 # the 'self' argument of the method.
2974 # the 'self' argument of the method.
2975 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2975 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2976 except Exception:
2976 except Exception:
2977 # if formatter couldn't format, just let it go untransformed
2977 # if formatter couldn't format, just let it go untransformed
2978 pass
2978 pass
2979 return cmd
2979 return cmd
2980
2980
2981 def mktempfile(self, data=None, prefix='ipython_edit_'):
2981 def mktempfile(self, data=None, prefix='ipython_edit_'):
2982 """Make a new tempfile and return its filename.
2982 """Make a new tempfile and return its filename.
2983
2983
2984 This makes a call to tempfile.mktemp, but it registers the created
2984 This makes a call to tempfile.mktemp, but it registers the created
2985 filename internally so ipython cleans it up at exit time.
2985 filename internally so ipython cleans it up at exit time.
2986
2986
2987 Optional inputs:
2987 Optional inputs:
2988
2988
2989 - data(None): if data is given, it gets written out to the temp file
2989 - data(None): if data is given, it gets written out to the temp file
2990 immediately, and the file is closed again."""
2990 immediately, and the file is closed again."""
2991
2991
2992 filename = tempfile.mktemp('.py', prefix)
2992 filename = tempfile.mktemp('.py', prefix)
2993 self.tempfiles.append(filename)
2993 self.tempfiles.append(filename)
2994
2994
2995 if data:
2995 if data:
2996 tmp_file = open(filename,'w')
2996 tmp_file = open(filename,'w')
2997 tmp_file.write(data)
2997 tmp_file.write(data)
2998 tmp_file.close()
2998 tmp_file.close()
2999 return filename
2999 return filename
3000
3000
3001 # TODO: This should be removed when Term is refactored.
3001 # TODO: This should be removed when Term is refactored.
3002 def write(self,data):
3002 def write(self,data):
3003 """Write a string to the default output"""
3003 """Write a string to the default output"""
3004 io.stdout.write(data)
3004 io.stdout.write(data)
3005
3005
3006 # TODO: This should be removed when Term is refactored.
3006 # TODO: This should be removed when Term is refactored.
3007 def write_err(self,data):
3007 def write_err(self,data):
3008 """Write a string to the default error output"""
3008 """Write a string to the default error output"""
3009 io.stderr.write(data)
3009 io.stderr.write(data)
3010
3010
3011 def ask_yes_no(self, prompt, default=None):
3011 def ask_yes_no(self, prompt, default=None):
3012 if self.quiet:
3012 if self.quiet:
3013 return True
3013 return True
3014 return ask_yes_no(prompt,default)
3014 return ask_yes_no(prompt,default)
3015
3015
3016 def show_usage(self):
3016 def show_usage(self):
3017 """Show a usage message"""
3017 """Show a usage message"""
3018 page.page(IPython.core.usage.interactive_usage)
3018 page.page(IPython.core.usage.interactive_usage)
3019
3019
3020 def extract_input_lines(self, range_str, raw=False):
3020 def extract_input_lines(self, range_str, raw=False):
3021 """Return as a string a set of input history slices.
3021 """Return as a string a set of input history slices.
3022
3022
3023 Parameters
3023 Parameters
3024 ----------
3024 ----------
3025 range_str : string
3025 range_str : string
3026 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3026 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3027 since this function is for use by magic functions which get their
3027 since this function is for use by magic functions which get their
3028 arguments as strings. The number before the / is the session
3028 arguments as strings. The number before the / is the session
3029 number: ~n goes n back from the current session.
3029 number: ~n goes n back from the current session.
3030
3030
3031 Optional Parameters:
3031 Optional Parameters:
3032 - raw(False): by default, the processed input is used. If this is
3032 - raw(False): by default, the processed input is used. If this is
3033 true, the raw input history is used instead.
3033 true, the raw input history is used instead.
3034
3034
3035 Note that slices can be called with two notations:
3035 Note that slices can be called with two notations:
3036
3036
3037 N:M -> standard python form, means including items N...(M-1).
3037 N:M -> standard python form, means including items N...(M-1).
3038
3038
3039 N-M -> include items N..M (closed endpoint).
3039 N-M -> include items N..M (closed endpoint).
3040 """
3040 """
3041 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3041 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3042 return "\n".join(x for _, _, x in lines)
3042 return "\n".join(x for _, _, x in lines)
3043
3043
3044 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True):
3044 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True):
3045 """Get a code string from history, file, url, or a string or macro.
3045 """Get a code string from history, file, url, or a string or macro.
3046
3046
3047 This is mainly used by magic functions.
3047 This is mainly used by magic functions.
3048
3048
3049 Parameters
3049 Parameters
3050 ----------
3050 ----------
3051
3051
3052 target : str
3052 target : str
3053
3053
3054 A string specifying code to retrieve. This will be tried respectively
3054 A string specifying code to retrieve. This will be tried respectively
3055 as: ranges of input history (see %history for syntax), url,
3055 as: ranges of input history (see %history for syntax), url,
3056 correspnding .py file, filename, or an expression evaluating to a
3056 correspnding .py file, filename, or an expression evaluating to a
3057 string or Macro in the user namespace.
3057 string or Macro in the user namespace.
3058
3058
3059 raw : bool
3059 raw : bool
3060 If true (default), retrieve raw history. Has no effect on the other
3060 If true (default), retrieve raw history. Has no effect on the other
3061 retrieval mechanisms.
3061 retrieval mechanisms.
3062
3062
3063 py_only : bool (default False)
3063 py_only : bool (default False)
3064 Only try to fetch python code, do not try alternative methods to decode file
3064 Only try to fetch python code, do not try alternative methods to decode file
3065 if unicode fails.
3065 if unicode fails.
3066
3066
3067 Returns
3067 Returns
3068 -------
3068 -------
3069 A string of code.
3069 A string of code.
3070
3070
3071 ValueError is raised if nothing is found, and TypeError if it evaluates
3071 ValueError is raised if nothing is found, and TypeError if it evaluates
3072 to an object of another type. In each case, .args[0] is a printable
3072 to an object of another type. In each case, .args[0] is a printable
3073 message.
3073 message.
3074 """
3074 """
3075 code = self.extract_input_lines(target, raw=raw) # Grab history
3075 code = self.extract_input_lines(target, raw=raw) # Grab history
3076 if code:
3076 if code:
3077 return code
3077 return code
3078 utarget = unquote_filename(target)
3078 utarget = unquote_filename(target)
3079 try:
3079 try:
3080 if utarget.startswith(('http://', 'https://')):
3080 if utarget.startswith(('http://', 'https://')):
3081 return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie)
3081 return openpy.read_py_url(utarget, skip_encoding_cookie=skip_encoding_cookie)
3082 except UnicodeDecodeError:
3082 except UnicodeDecodeError:
3083 if not py_only :
3083 if not py_only :
3084 from urllib import urlopen # Deferred import
3084 from urllib import urlopen # Deferred import
3085 response = urlopen(target)
3085 response = urlopen(target)
3086 return response.read().decode('latin1')
3086 return response.read().decode('latin1')
3087 raise ValueError(("'%s' seem to be unreadable.") % utarget)
3087 raise ValueError(("'%s' seem to be unreadable.") % utarget)
3088
3088
3089 potential_target = [target]
3089 potential_target = [target]
3090 try :
3090 try :
3091 potential_target.insert(0,get_py_filename(target))
3091 potential_target.insert(0,get_py_filename(target))
3092 except IOError:
3092 except IOError:
3093 pass
3093 pass
3094
3094
3095 for tgt in potential_target :
3095 for tgt in potential_target :
3096 if os.path.isfile(tgt): # Read file
3096 if os.path.isfile(tgt): # Read file
3097 try :
3097 try :
3098 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3098 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3099 except UnicodeDecodeError :
3099 except UnicodeDecodeError :
3100 if not py_only :
3100 if not py_only :
3101 with io_open(tgt,'r', encoding='latin1') as f :
3101 with io_open(tgt,'r', encoding='latin1') as f :
3102 return f.read()
3102 return f.read()
3103 raise ValueError(("'%s' seem to be unreadable.") % target)
3103 raise ValueError(("'%s' seem to be unreadable.") % target)
3104 elif os.path.isdir(os.path.expanduser(tgt)):
3104 elif os.path.isdir(os.path.expanduser(tgt)):
3105 raise ValueError("'%s' is a directory, not a regular file." % target)
3105 raise ValueError("'%s' is a directory, not a regular file." % target)
3106
3106
3107 try: # User namespace
3107 try: # User namespace
3108 codeobj = eval(target, self.user_ns)
3108 codeobj = eval(target, self.user_ns)
3109 except Exception:
3109 except Exception:
3110 raise ValueError(("'%s' was not found in history, as a file, url, "
3110 raise ValueError(("'%s' was not found in history, as a file, url, "
3111 "nor in the user namespace.") % target)
3111 "nor in the user namespace.") % target)
3112 if isinstance(codeobj, basestring):
3112 if isinstance(codeobj, basestring):
3113 return codeobj
3113 return codeobj
3114 elif isinstance(codeobj, Macro):
3114 elif isinstance(codeobj, Macro):
3115 return codeobj.value
3115 return codeobj.value
3116
3116
3117 raise TypeError("%s is neither a string nor a macro." % target,
3117 raise TypeError("%s is neither a string nor a macro." % target,
3118 codeobj)
3118 codeobj)
3119
3119
3120 #-------------------------------------------------------------------------
3120 #-------------------------------------------------------------------------
3121 # Things related to IPython exiting
3121 # Things related to IPython exiting
3122 #-------------------------------------------------------------------------
3122 #-------------------------------------------------------------------------
3123 def atexit_operations(self):
3123 def atexit_operations(self):
3124 """This will be executed at the time of exit.
3124 """This will be executed at the time of exit.
3125
3125
3126 Cleanup operations and saving of persistent data that is done
3126 Cleanup operations and saving of persistent data that is done
3127 unconditionally by IPython should be performed here.
3127 unconditionally by IPython should be performed here.
3128
3128
3129 For things that may depend on startup flags or platform specifics (such
3129 For things that may depend on startup flags or platform specifics (such
3130 as having readline or not), register a separate atexit function in the
3130 as having readline or not), register a separate atexit function in the
3131 code that has the appropriate information, rather than trying to
3131 code that has the appropriate information, rather than trying to
3132 clutter
3132 clutter
3133 """
3133 """
3134 # Close the history session (this stores the end time and line count)
3134 # Close the history session (this stores the end time and line count)
3135 # this must be *before* the tempfile cleanup, in case of temporary
3135 # this must be *before* the tempfile cleanup, in case of temporary
3136 # history db
3136 # history db
3137 self.history_manager.end_session()
3137 self.history_manager.end_session()
3138
3138
3139 # Cleanup all tempfiles left around
3139 # Cleanup all tempfiles left around
3140 for tfile in self.tempfiles:
3140 for tfile in self.tempfiles:
3141 try:
3141 try:
3142 os.unlink(tfile)
3142 os.unlink(tfile)
3143 except OSError:
3143 except OSError:
3144 pass
3144 pass
3145
3145
3146 # Clear all user namespaces to release all references cleanly.
3146 # Clear all user namespaces to release all references cleanly.
3147 self.reset(new_session=False)
3147 self.reset(new_session=False)
3148
3148
3149 # Run user hooks
3149 # Run user hooks
3150 self.hooks.shutdown_hook()
3150 self.hooks.shutdown_hook()
3151
3151
3152 def cleanup(self):
3152 def cleanup(self):
3153 self.restore_sys_module_state()
3153 self.restore_sys_module_state()
3154
3154
3155
3155
3156 class InteractiveShellABC(object):
3156 class InteractiveShellABC(object):
3157 """An abstract base class for InteractiveShell."""
3157 """An abstract base class for InteractiveShell."""
3158 __metaclass__ = abc.ABCMeta
3158 __metaclass__ = abc.ABCMeta
3159
3159
3160 InteractiveShellABC.register(InteractiveShell)
3160 InteractiveShellABC.register(InteractiveShell)
@@ -1,728 +1,738 b''
1 """Implementation of magic functions for interaction with the OS.
1 """Implementation of magic functions for interaction with the OS.
2
2
3 Note: this module is named 'osm' instead of 'os' to avoid a collision with the
3 Note: this module is named 'osm' instead of 'os' to avoid a collision with the
4 builtin.
4 builtin.
5 """
5 """
6 #-----------------------------------------------------------------------------
6 #-----------------------------------------------------------------------------
7 # Copyright (c) 2012 The IPython Development Team.
7 # Copyright (c) 2012 The IPython Development Team.
8 #
8 #
9 # Distributed under the terms of the Modified BSD License.
9 # Distributed under the terms of the Modified BSD License.
10 #
10 #
11 # The full license is in the file COPYING.txt, distributed with this software.
11 # The full license is in the file COPYING.txt, distributed with this software.
12 #-----------------------------------------------------------------------------
12 #-----------------------------------------------------------------------------
13
13
14 #-----------------------------------------------------------------------------
14 #-----------------------------------------------------------------------------
15 # Imports
15 # Imports
16 #-----------------------------------------------------------------------------
16 #-----------------------------------------------------------------------------
17
17
18 # Stdlib
18 # Stdlib
19 import io
19 import io
20 import os
20 import os
21 import re
21 import re
22 import sys
22 import sys
23 from pprint import pformat
23 from pprint import pformat
24
24
25 # Our own packages
25 # Our own packages
26 from IPython.core import magic_arguments
26 from IPython.core import magic_arguments
27 from IPython.core import oinspect
27 from IPython.core import oinspect
28 from IPython.core import page
28 from IPython.core import page
29 from IPython.core.alias import AliasError
29 from IPython.core.error import UsageError
30 from IPython.core.error import UsageError
30 from IPython.core.magic import (
31 from IPython.core.magic import (
31 Magics, compress_dhist, magics_class, line_magic, cell_magic, line_cell_magic
32 Magics, compress_dhist, magics_class, line_magic, cell_magic, line_cell_magic
32 )
33 )
33 from IPython.testing.skipdoctest import skip_doctest
34 from IPython.testing.skipdoctest import skip_doctest
34 from IPython.utils.openpy import source_to_unicode
35 from IPython.utils.openpy import source_to_unicode
35 from IPython.utils.path import unquote_filename
36 from IPython.utils.path import unquote_filename
36 from IPython.utils.process import abbrev_cwd
37 from IPython.utils.process import abbrev_cwd
37 from IPython.utils.terminal import set_term_title
38 from IPython.utils.terminal import set_term_title
38
39
39 #-----------------------------------------------------------------------------
40 #-----------------------------------------------------------------------------
40 # Magic implementation classes
41 # Magic implementation classes
41 #-----------------------------------------------------------------------------
42 #-----------------------------------------------------------------------------
42 @magics_class
43 @magics_class
43 class OSMagics(Magics):
44 class OSMagics(Magics):
44 """Magics to interact with the underlying OS (shell-type functionality).
45 """Magics to interact with the underlying OS (shell-type functionality).
45 """
46 """
46
47
47 @skip_doctest
48 @skip_doctest
48 @line_magic
49 @line_magic
49 def alias(self, parameter_s=''):
50 def alias(self, parameter_s=''):
50 """Define an alias for a system command.
51 """Define an alias for a system command.
51
52
52 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
53 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
53
54
54 Then, typing 'alias_name params' will execute the system command 'cmd
55 Then, typing 'alias_name params' will execute the system command 'cmd
55 params' (from your underlying operating system).
56 params' (from your underlying operating system).
56
57
57 Aliases have lower precedence than magic functions and Python normal
58 Aliases have lower precedence than magic functions and Python normal
58 variables, so if 'foo' is both a Python variable and an alias, the
59 variables, so if 'foo' is both a Python variable and an alias, the
59 alias can not be executed until 'del foo' removes the Python variable.
60 alias can not be executed until 'del foo' removes the Python variable.
60
61
61 You can use the %l specifier in an alias definition to represent the
62 You can use the %l specifier in an alias definition to represent the
62 whole line when the alias is called. For example::
63 whole line when the alias is called. For example::
63
64
64 In [2]: alias bracket echo "Input in brackets: <%l>"
65 In [2]: alias bracket echo "Input in brackets: <%l>"
65 In [3]: bracket hello world
66 In [3]: bracket hello world
66 Input in brackets: <hello world>
67 Input in brackets: <hello world>
67
68
68 You can also define aliases with parameters using %s specifiers (one
69 You can also define aliases with parameters using %s specifiers (one
69 per parameter)::
70 per parameter)::
70
71
71 In [1]: alias parts echo first %s second %s
72 In [1]: alias parts echo first %s second %s
72 In [2]: %parts A B
73 In [2]: %parts A B
73 first A second B
74 first A second B
74 In [3]: %parts A
75 In [3]: %parts A
75 Incorrect number of arguments: 2 expected.
76 Incorrect number of arguments: 2 expected.
76 parts is an alias to: 'echo first %s second %s'
77 parts is an alias to: 'echo first %s second %s'
77
78
78 Note that %l and %s are mutually exclusive. You can only use one or
79 Note that %l and %s are mutually exclusive. You can only use one or
79 the other in your aliases.
80 the other in your aliases.
80
81
81 Aliases expand Python variables just like system calls using ! or !!
82 Aliases expand Python variables just like system calls using ! or !!
82 do: all expressions prefixed with '$' get expanded. For details of
83 do: all expressions prefixed with '$' get expanded. For details of
83 the semantic rules, see PEP-215:
84 the semantic rules, see PEP-215:
84 http://www.python.org/peps/pep-0215.html. This is the library used by
85 http://www.python.org/peps/pep-0215.html. This is the library used by
85 IPython for variable expansion. If you want to access a true shell
86 IPython for variable expansion. If you want to access a true shell
86 variable, an extra $ is necessary to prevent its expansion by
87 variable, an extra $ is necessary to prevent its expansion by
87 IPython::
88 IPython::
88
89
89 In [6]: alias show echo
90 In [6]: alias show echo
90 In [7]: PATH='A Python string'
91 In [7]: PATH='A Python string'
91 In [8]: show $PATH
92 In [8]: show $PATH
92 A Python string
93 A Python string
93 In [9]: show $$PATH
94 In [9]: show $$PATH
94 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
95 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
95
96
96 You can use the alias facility to acess all of $PATH. See the %rehash
97 You can use the alias facility to acess all of $PATH. See the %rehash
97 and %rehashx functions, which automatically create aliases for the
98 and %rehashx functions, which automatically create aliases for the
98 contents of your $PATH.
99 contents of your $PATH.
99
100
100 If called with no parameters, %alias prints the current alias table."""
101 If called with no parameters, %alias prints the current alias table."""
101
102
102 par = parameter_s.strip()
103 par = parameter_s.strip()
103 if not par:
104 if not par:
104 aliases = sorted(self.shell.alias_manager.aliases)
105 aliases = sorted(self.shell.alias_manager.aliases)
105 # stored = self.shell.db.get('stored_aliases', {} )
106 # stored = self.shell.db.get('stored_aliases', {} )
106 # for k, v in stored:
107 # for k, v in stored:
107 # atab.append(k, v[0])
108 # atab.append(k, v[0])
108
109
109 print "Total number of aliases:", len(aliases)
110 print "Total number of aliases:", len(aliases)
110 sys.stdout.flush()
111 sys.stdout.flush()
111 return aliases
112 return aliases
112
113
113 # Now try to define a new one
114 # Now try to define a new one
114 try:
115 try:
115 alias,cmd = par.split(None, 1)
116 alias,cmd = par.split(None, 1)
116 except:
117 except TypeError:
117 print oinspect.getdoc(self.alias)
118 print(oinspect.getdoc(self.alias))
118 else:
119 return
119 self.shell.alias_manager.soft_define_alias(alias, cmd)
120
121 try:
122 self.shell.alias_manager.define_alias(alias, cmd)
123 except AliasError as e:
124 print(e)
120 # end magic_alias
125 # end magic_alias
121
126
122 @line_magic
127 @line_magic
123 def unalias(self, parameter_s=''):
128 def unalias(self, parameter_s=''):
124 """Remove an alias"""
129 """Remove an alias"""
125
130
126 aname = parameter_s.strip()
131 aname = parameter_s.strip()
127 self.shell.alias_manager.undefine_alias(aname)
132 try:
133 self.shell.alias_manager.undefine_alias(aname)
134 except ValueError as e:
135 print(e)
136 return
137
128 stored = self.shell.db.get('stored_aliases', {} )
138 stored = self.shell.db.get('stored_aliases', {} )
129 if aname in stored:
139 if aname in stored:
130 print "Removing %stored alias",aname
140 print "Removing %stored alias",aname
131 del stored[aname]
141 del stored[aname]
132 self.shell.db['stored_aliases'] = stored
142 self.shell.db['stored_aliases'] = stored
133
143
134 @line_magic
144 @line_magic
135 def rehashx(self, parameter_s=''):
145 def rehashx(self, parameter_s=''):
136 """Update the alias table with all executable files in $PATH.
146 """Update the alias table with all executable files in $PATH.
137
147
138 This version explicitly checks that every entry in $PATH is a file
148 This version explicitly checks that every entry in $PATH is a file
139 with execute access (os.X_OK), so it is much slower than %rehash.
149 with execute access (os.X_OK), so it is much slower than %rehash.
140
150
141 Under Windows, it checks executability as a match against a
151 Under Windows, it checks executability as a match against a
142 '|'-separated string of extensions, stored in the IPython config
152 '|'-separated string of extensions, stored in the IPython config
143 variable win_exec_ext. This defaults to 'exe|com|bat'.
153 variable win_exec_ext. This defaults to 'exe|com|bat'.
144
154
145 This function also resets the root module cache of module completer,
155 This function also resets the root module cache of module completer,
146 used on slow filesystems.
156 used on slow filesystems.
147 """
157 """
148 from IPython.core.alias import InvalidAliasError
158 from IPython.core.alias import InvalidAliasError
149
159
150 # for the benefit of module completer in ipy_completers.py
160 # for the benefit of module completer in ipy_completers.py
151 del self.shell.db['rootmodules_cache']
161 del self.shell.db['rootmodules_cache']
152
162
153 path = [os.path.abspath(os.path.expanduser(p)) for p in
163 path = [os.path.abspath(os.path.expanduser(p)) for p in
154 os.environ.get('PATH','').split(os.pathsep)]
164 os.environ.get('PATH','').split(os.pathsep)]
155 path = filter(os.path.isdir,path)
165 path = filter(os.path.isdir,path)
156
166
157 syscmdlist = []
167 syscmdlist = []
158 # Now define isexec in a cross platform manner.
168 # Now define isexec in a cross platform manner.
159 if os.name == 'posix':
169 if os.name == 'posix':
160 isexec = lambda fname:os.path.isfile(fname) and \
170 isexec = lambda fname:os.path.isfile(fname) and \
161 os.access(fname,os.X_OK)
171 os.access(fname,os.X_OK)
162 else:
172 else:
163 try:
173 try:
164 winext = os.environ['pathext'].replace(';','|').replace('.','')
174 winext = os.environ['pathext'].replace(';','|').replace('.','')
165 except KeyError:
175 except KeyError:
166 winext = 'exe|com|bat|py'
176 winext = 'exe|com|bat|py'
167 if 'py' not in winext:
177 if 'py' not in winext:
168 winext += '|py'
178 winext += '|py'
169 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
179 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
170 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
180 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
171 savedir = os.getcwdu()
181 savedir = os.getcwdu()
172
182
173 # Now walk the paths looking for executables to alias.
183 # Now walk the paths looking for executables to alias.
174 try:
184 try:
175 # write the whole loop for posix/Windows so we don't have an if in
185 # write the whole loop for posix/Windows so we don't have an if in
176 # the innermost part
186 # the innermost part
177 if os.name == 'posix':
187 if os.name == 'posix':
178 for pdir in path:
188 for pdir in path:
179 os.chdir(pdir)
189 os.chdir(pdir)
180 for ff in os.listdir(pdir):
190 for ff in os.listdir(pdir):
181 if isexec(ff):
191 if isexec(ff):
182 try:
192 try:
183 # Removes dots from the name since ipython
193 # Removes dots from the name since ipython
184 # will assume names with dots to be python.
194 # will assume names with dots to be python.
185 if ff not in self.shell.alias_manager:
195 if ff not in self.shell.alias_manager:
186 self.shell.alias_manager.define_alias(
196 self.shell.alias_manager.define_alias(
187 ff.replace('.',''), ff)
197 ff.replace('.',''), ff)
188 except InvalidAliasError:
198 except InvalidAliasError:
189 pass
199 pass
190 else:
200 else:
191 syscmdlist.append(ff)
201 syscmdlist.append(ff)
192 else:
202 else:
193 no_alias = self.shell.alias_manager.no_alias
203 no_alias = self.shell.alias_manager.no_alias
194 for pdir in path:
204 for pdir in path:
195 os.chdir(pdir)
205 os.chdir(pdir)
196 for ff in os.listdir(pdir):
206 for ff in os.listdir(pdir):
197 base, ext = os.path.splitext(ff)
207 base, ext = os.path.splitext(ff)
198 if isexec(ff) and base.lower() not in no_alias:
208 if isexec(ff) and base.lower() not in no_alias:
199 if ext.lower() == '.exe':
209 if ext.lower() == '.exe':
200 ff = base
210 ff = base
201 try:
211 try:
202 # Removes dots from the name since ipython
212 # Removes dots from the name since ipython
203 # will assume names with dots to be python.
213 # will assume names with dots to be python.
204 self.shell.alias_manager.define_alias(
214 self.shell.alias_manager.define_alias(
205 base.lower().replace('.',''), ff)
215 base.lower().replace('.',''), ff)
206 except InvalidAliasError:
216 except InvalidAliasError:
207 pass
217 pass
208 syscmdlist.append(ff)
218 syscmdlist.append(ff)
209 self.shell.db['syscmdlist'] = syscmdlist
219 self.shell.db['syscmdlist'] = syscmdlist
210 finally:
220 finally:
211 os.chdir(savedir)
221 os.chdir(savedir)
212
222
213 @skip_doctest
223 @skip_doctest
214 @line_magic
224 @line_magic
215 def pwd(self, parameter_s=''):
225 def pwd(self, parameter_s=''):
216 """Return the current working directory path.
226 """Return the current working directory path.
217
227
218 Examples
228 Examples
219 --------
229 --------
220 ::
230 ::
221
231
222 In [9]: pwd
232 In [9]: pwd
223 Out[9]: '/home/tsuser/sprint/ipython'
233 Out[9]: '/home/tsuser/sprint/ipython'
224 """
234 """
225 return os.getcwdu()
235 return os.getcwdu()
226
236
227 @skip_doctest
237 @skip_doctest
228 @line_magic
238 @line_magic
229 def cd(self, parameter_s=''):
239 def cd(self, parameter_s=''):
230 """Change the current working directory.
240 """Change the current working directory.
231
241
232 This command automatically maintains an internal list of directories
242 This command automatically maintains an internal list of directories
233 you visit during your IPython session, in the variable _dh. The
243 you visit during your IPython session, in the variable _dh. The
234 command %dhist shows this history nicely formatted. You can also
244 command %dhist shows this history nicely formatted. You can also
235 do 'cd -<tab>' to see directory history conveniently.
245 do 'cd -<tab>' to see directory history conveniently.
236
246
237 Usage:
247 Usage:
238
248
239 cd 'dir': changes to directory 'dir'.
249 cd 'dir': changes to directory 'dir'.
240
250
241 cd -: changes to the last visited directory.
251 cd -: changes to the last visited directory.
242
252
243 cd -<n>: changes to the n-th directory in the directory history.
253 cd -<n>: changes to the n-th directory in the directory history.
244
254
245 cd --foo: change to directory that matches 'foo' in history
255 cd --foo: change to directory that matches 'foo' in history
246
256
247 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
257 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
248 (note: cd <bookmark_name> is enough if there is no
258 (note: cd <bookmark_name> is enough if there is no
249 directory <bookmark_name>, but a bookmark with the name exists.)
259 directory <bookmark_name>, but a bookmark with the name exists.)
250 'cd -b <tab>' allows you to tab-complete bookmark names.
260 'cd -b <tab>' allows you to tab-complete bookmark names.
251
261
252 Options:
262 Options:
253
263
254 -q: quiet. Do not print the working directory after the cd command is
264 -q: quiet. Do not print the working directory after the cd command is
255 executed. By default IPython's cd command does print this directory,
265 executed. By default IPython's cd command does print this directory,
256 since the default prompts do not display path information.
266 since the default prompts do not display path information.
257
267
258 Note that !cd doesn't work for this purpose because the shell where
268 Note that !cd doesn't work for this purpose because the shell where
259 !command runs is immediately discarded after executing 'command'.
269 !command runs is immediately discarded after executing 'command'.
260
270
261 Examples
271 Examples
262 --------
272 --------
263 ::
273 ::
264
274
265 In [10]: cd parent/child
275 In [10]: cd parent/child
266 /home/tsuser/parent/child
276 /home/tsuser/parent/child
267 """
277 """
268
278
269 oldcwd = os.getcwdu()
279 oldcwd = os.getcwdu()
270 numcd = re.match(r'(-)(\d+)$',parameter_s)
280 numcd = re.match(r'(-)(\d+)$',parameter_s)
271 # jump in directory history by number
281 # jump in directory history by number
272 if numcd:
282 if numcd:
273 nn = int(numcd.group(2))
283 nn = int(numcd.group(2))
274 try:
284 try:
275 ps = self.shell.user_ns['_dh'][nn]
285 ps = self.shell.user_ns['_dh'][nn]
276 except IndexError:
286 except IndexError:
277 print 'The requested directory does not exist in history.'
287 print 'The requested directory does not exist in history.'
278 return
288 return
279 else:
289 else:
280 opts = {}
290 opts = {}
281 elif parameter_s.startswith('--'):
291 elif parameter_s.startswith('--'):
282 ps = None
292 ps = None
283 fallback = None
293 fallback = None
284 pat = parameter_s[2:]
294 pat = parameter_s[2:]
285 dh = self.shell.user_ns['_dh']
295 dh = self.shell.user_ns['_dh']
286 # first search only by basename (last component)
296 # first search only by basename (last component)
287 for ent in reversed(dh):
297 for ent in reversed(dh):
288 if pat in os.path.basename(ent) and os.path.isdir(ent):
298 if pat in os.path.basename(ent) and os.path.isdir(ent):
289 ps = ent
299 ps = ent
290 break
300 break
291
301
292 if fallback is None and pat in ent and os.path.isdir(ent):
302 if fallback is None and pat in ent and os.path.isdir(ent):
293 fallback = ent
303 fallback = ent
294
304
295 # if we have no last part match, pick the first full path match
305 # if we have no last part match, pick the first full path match
296 if ps is None:
306 if ps is None:
297 ps = fallback
307 ps = fallback
298
308
299 if ps is None:
309 if ps is None:
300 print "No matching entry in directory history"
310 print "No matching entry in directory history"
301 return
311 return
302 else:
312 else:
303 opts = {}
313 opts = {}
304
314
305
315
306 else:
316 else:
307 #turn all non-space-escaping backslashes to slashes,
317 #turn all non-space-escaping backslashes to slashes,
308 # for c:\windows\directory\names\
318 # for c:\windows\directory\names\
309 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
319 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
310 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
320 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
311 # jump to previous
321 # jump to previous
312 if ps == '-':
322 if ps == '-':
313 try:
323 try:
314 ps = self.shell.user_ns['_dh'][-2]
324 ps = self.shell.user_ns['_dh'][-2]
315 except IndexError:
325 except IndexError:
316 raise UsageError('%cd -: No previous directory to change to.')
326 raise UsageError('%cd -: No previous directory to change to.')
317 # jump to bookmark if needed
327 # jump to bookmark if needed
318 else:
328 else:
319 if not os.path.isdir(ps) or 'b' in opts:
329 if not os.path.isdir(ps) or 'b' in opts:
320 bkms = self.shell.db.get('bookmarks', {})
330 bkms = self.shell.db.get('bookmarks', {})
321
331
322 if ps in bkms:
332 if ps in bkms:
323 target = bkms[ps]
333 target = bkms[ps]
324 print '(bookmark:%s) -> %s' % (ps, target)
334 print '(bookmark:%s) -> %s' % (ps, target)
325 ps = target
335 ps = target
326 else:
336 else:
327 if 'b' in opts:
337 if 'b' in opts:
328 raise UsageError("Bookmark '%s' not found. "
338 raise UsageError("Bookmark '%s' not found. "
329 "Use '%%bookmark -l' to see your bookmarks." % ps)
339 "Use '%%bookmark -l' to see your bookmarks." % ps)
330
340
331 # strip extra quotes on Windows, because os.chdir doesn't like them
341 # strip extra quotes on Windows, because os.chdir doesn't like them
332 ps = unquote_filename(ps)
342 ps = unquote_filename(ps)
333 # at this point ps should point to the target dir
343 # at this point ps should point to the target dir
334 if ps:
344 if ps:
335 try:
345 try:
336 os.chdir(os.path.expanduser(ps))
346 os.chdir(os.path.expanduser(ps))
337 if hasattr(self.shell, 'term_title') and self.shell.term_title:
347 if hasattr(self.shell, 'term_title') and self.shell.term_title:
338 set_term_title('IPython: ' + abbrev_cwd())
348 set_term_title('IPython: ' + abbrev_cwd())
339 except OSError:
349 except OSError:
340 print sys.exc_info()[1]
350 print sys.exc_info()[1]
341 else:
351 else:
342 cwd = os.getcwdu()
352 cwd = os.getcwdu()
343 dhist = self.shell.user_ns['_dh']
353 dhist = self.shell.user_ns['_dh']
344 if oldcwd != cwd:
354 if oldcwd != cwd:
345 dhist.append(cwd)
355 dhist.append(cwd)
346 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
356 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
347
357
348 else:
358 else:
349 os.chdir(self.shell.home_dir)
359 os.chdir(self.shell.home_dir)
350 if hasattr(self.shell, 'term_title') and self.shell.term_title:
360 if hasattr(self.shell, 'term_title') and self.shell.term_title:
351 set_term_title('IPython: ' + '~')
361 set_term_title('IPython: ' + '~')
352 cwd = os.getcwdu()
362 cwd = os.getcwdu()
353 dhist = self.shell.user_ns['_dh']
363 dhist = self.shell.user_ns['_dh']
354
364
355 if oldcwd != cwd:
365 if oldcwd != cwd:
356 dhist.append(cwd)
366 dhist.append(cwd)
357 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
367 self.shell.db['dhist'] = compress_dhist(dhist)[-100:]
358 if not 'q' in opts and self.shell.user_ns['_dh']:
368 if not 'q' in opts and self.shell.user_ns['_dh']:
359 print self.shell.user_ns['_dh'][-1]
369 print self.shell.user_ns['_dh'][-1]
360
370
361
371
362 @line_magic
372 @line_magic
363 def env(self, parameter_s=''):
373 def env(self, parameter_s=''):
364 """List environment variables."""
374 """List environment variables."""
365
375
366 return dict(os.environ)
376 return dict(os.environ)
367
377
368 @line_magic
378 @line_magic
369 def pushd(self, parameter_s=''):
379 def pushd(self, parameter_s=''):
370 """Place the current dir on stack and change directory.
380 """Place the current dir on stack and change directory.
371
381
372 Usage:\\
382 Usage:\\
373 %pushd ['dirname']
383 %pushd ['dirname']
374 """
384 """
375
385
376 dir_s = self.shell.dir_stack
386 dir_s = self.shell.dir_stack
377 tgt = os.path.expanduser(unquote_filename(parameter_s))
387 tgt = os.path.expanduser(unquote_filename(parameter_s))
378 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
388 cwd = os.getcwdu().replace(self.shell.home_dir,'~')
379 if tgt:
389 if tgt:
380 self.cd(parameter_s)
390 self.cd(parameter_s)
381 dir_s.insert(0,cwd)
391 dir_s.insert(0,cwd)
382 return self.shell.magic('dirs')
392 return self.shell.magic('dirs')
383
393
384 @line_magic
394 @line_magic
385 def popd(self, parameter_s=''):
395 def popd(self, parameter_s=''):
386 """Change to directory popped off the top of the stack.
396 """Change to directory popped off the top of the stack.
387 """
397 """
388 if not self.shell.dir_stack:
398 if not self.shell.dir_stack:
389 raise UsageError("%popd on empty stack")
399 raise UsageError("%popd on empty stack")
390 top = self.shell.dir_stack.pop(0)
400 top = self.shell.dir_stack.pop(0)
391 self.cd(top)
401 self.cd(top)
392 print "popd ->",top
402 print "popd ->",top
393
403
394 @line_magic
404 @line_magic
395 def dirs(self, parameter_s=''):
405 def dirs(self, parameter_s=''):
396 """Return the current directory stack."""
406 """Return the current directory stack."""
397
407
398 return self.shell.dir_stack
408 return self.shell.dir_stack
399
409
400 @line_magic
410 @line_magic
401 def dhist(self, parameter_s=''):
411 def dhist(self, parameter_s=''):
402 """Print your history of visited directories.
412 """Print your history of visited directories.
403
413
404 %dhist -> print full history\\
414 %dhist -> print full history\\
405 %dhist n -> print last n entries only\\
415 %dhist n -> print last n entries only\\
406 %dhist n1 n2 -> print entries between n1 and n2 (n2 not included)\\
416 %dhist n1 n2 -> print entries between n1 and n2 (n2 not included)\\
407
417
408 This history is automatically maintained by the %cd command, and
418 This history is automatically maintained by the %cd command, and
409 always available as the global list variable _dh. You can use %cd -<n>
419 always available as the global list variable _dh. You can use %cd -<n>
410 to go to directory number <n>.
420 to go to directory number <n>.
411
421
412 Note that most of time, you should view directory history by entering
422 Note that most of time, you should view directory history by entering
413 cd -<TAB>.
423 cd -<TAB>.
414
424
415 """
425 """
416
426
417 dh = self.shell.user_ns['_dh']
427 dh = self.shell.user_ns['_dh']
418 if parameter_s:
428 if parameter_s:
419 try:
429 try:
420 args = map(int,parameter_s.split())
430 args = map(int,parameter_s.split())
421 except:
431 except:
422 self.arg_err(self.dhist)
432 self.arg_err(self.dhist)
423 return
433 return
424 if len(args) == 1:
434 if len(args) == 1:
425 ini,fin = max(len(dh)-(args[0]),0),len(dh)
435 ini,fin = max(len(dh)-(args[0]),0),len(dh)
426 elif len(args) == 2:
436 elif len(args) == 2:
427 ini,fin = args
437 ini,fin = args
428 fin = min(fin, len(dh))
438 fin = min(fin, len(dh))
429 else:
439 else:
430 self.arg_err(self.dhist)
440 self.arg_err(self.dhist)
431 return
441 return
432 else:
442 else:
433 ini,fin = 0,len(dh)
443 ini,fin = 0,len(dh)
434 print 'Directory history (kept in _dh)'
444 print 'Directory history (kept in _dh)'
435 for i in range(ini, fin):
445 for i in range(ini, fin):
436 print "%d: %s" % (i, dh[i])
446 print "%d: %s" % (i, dh[i])
437
447
438 @skip_doctest
448 @skip_doctest
439 @line_magic
449 @line_magic
440 def sc(self, parameter_s=''):
450 def sc(self, parameter_s=''):
441 """Shell capture - run shell command and capture output (DEPRECATED use !).
451 """Shell capture - run shell command and capture output (DEPRECATED use !).
442
452
443 DEPRECATED. Suboptimal, retained for backwards compatibility.
453 DEPRECATED. Suboptimal, retained for backwards compatibility.
444
454
445 You should use the form 'var = !command' instead. Example:
455 You should use the form 'var = !command' instead. Example:
446
456
447 "%sc -l myfiles = ls ~" should now be written as
457 "%sc -l myfiles = ls ~" should now be written as
448
458
449 "myfiles = !ls ~"
459 "myfiles = !ls ~"
450
460
451 myfiles.s, myfiles.l and myfiles.n still apply as documented
461 myfiles.s, myfiles.l and myfiles.n still apply as documented
452 below.
462 below.
453
463
454 --
464 --
455 %sc [options] varname=command
465 %sc [options] varname=command
456
466
457 IPython will run the given command using commands.getoutput(), and
467 IPython will run the given command using commands.getoutput(), and
458 will then update the user's interactive namespace with a variable
468 will then update the user's interactive namespace with a variable
459 called varname, containing the value of the call. Your command can
469 called varname, containing the value of the call. Your command can
460 contain shell wildcards, pipes, etc.
470 contain shell wildcards, pipes, etc.
461
471
462 The '=' sign in the syntax is mandatory, and the variable name you
472 The '=' sign in the syntax is mandatory, and the variable name you
463 supply must follow Python's standard conventions for valid names.
473 supply must follow Python's standard conventions for valid names.
464
474
465 (A special format without variable name exists for internal use)
475 (A special format without variable name exists for internal use)
466
476
467 Options:
477 Options:
468
478
469 -l: list output. Split the output on newlines into a list before
479 -l: list output. Split the output on newlines into a list before
470 assigning it to the given variable. By default the output is stored
480 assigning it to the given variable. By default the output is stored
471 as a single string.
481 as a single string.
472
482
473 -v: verbose. Print the contents of the variable.
483 -v: verbose. Print the contents of the variable.
474
484
475 In most cases you should not need to split as a list, because the
485 In most cases you should not need to split as a list, because the
476 returned value is a special type of string which can automatically
486 returned value is a special type of string which can automatically
477 provide its contents either as a list (split on newlines) or as a
487 provide its contents either as a list (split on newlines) or as a
478 space-separated string. These are convenient, respectively, either
488 space-separated string. These are convenient, respectively, either
479 for sequential processing or to be passed to a shell command.
489 for sequential processing or to be passed to a shell command.
480
490
481 For example::
491 For example::
482
492
483 # Capture into variable a
493 # Capture into variable a
484 In [1]: sc a=ls *py
494 In [1]: sc a=ls *py
485
495
486 # a is a string with embedded newlines
496 # a is a string with embedded newlines
487 In [2]: a
497 In [2]: a
488 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
498 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
489
499
490 # which can be seen as a list:
500 # which can be seen as a list:
491 In [3]: a.l
501 In [3]: a.l
492 Out[3]: ['setup.py', 'win32_manual_post_install.py']
502 Out[3]: ['setup.py', 'win32_manual_post_install.py']
493
503
494 # or as a whitespace-separated string:
504 # or as a whitespace-separated string:
495 In [4]: a.s
505 In [4]: a.s
496 Out[4]: 'setup.py win32_manual_post_install.py'
506 Out[4]: 'setup.py win32_manual_post_install.py'
497
507
498 # a.s is useful to pass as a single command line:
508 # a.s is useful to pass as a single command line:
499 In [5]: !wc -l $a.s
509 In [5]: !wc -l $a.s
500 146 setup.py
510 146 setup.py
501 130 win32_manual_post_install.py
511 130 win32_manual_post_install.py
502 276 total
512 276 total
503
513
504 # while the list form is useful to loop over:
514 # while the list form is useful to loop over:
505 In [6]: for f in a.l:
515 In [6]: for f in a.l:
506 ...: !wc -l $f
516 ...: !wc -l $f
507 ...:
517 ...:
508 146 setup.py
518 146 setup.py
509 130 win32_manual_post_install.py
519 130 win32_manual_post_install.py
510
520
511 Similarly, the lists returned by the -l option are also special, in
521 Similarly, the lists returned by the -l option are also special, in
512 the sense that you can equally invoke the .s attribute on them to
522 the sense that you can equally invoke the .s attribute on them to
513 automatically get a whitespace-separated string from their contents::
523 automatically get a whitespace-separated string from their contents::
514
524
515 In [7]: sc -l b=ls *py
525 In [7]: sc -l b=ls *py
516
526
517 In [8]: b
527 In [8]: b
518 Out[8]: ['setup.py', 'win32_manual_post_install.py']
528 Out[8]: ['setup.py', 'win32_manual_post_install.py']
519
529
520 In [9]: b.s
530 In [9]: b.s
521 Out[9]: 'setup.py win32_manual_post_install.py'
531 Out[9]: 'setup.py win32_manual_post_install.py'
522
532
523 In summary, both the lists and strings used for output capture have
533 In summary, both the lists and strings used for output capture have
524 the following special attributes::
534 the following special attributes::
525
535
526 .l (or .list) : value as list.
536 .l (or .list) : value as list.
527 .n (or .nlstr): value as newline-separated string.
537 .n (or .nlstr): value as newline-separated string.
528 .s (or .spstr): value as space-separated string.
538 .s (or .spstr): value as space-separated string.
529 """
539 """
530
540
531 opts,args = self.parse_options(parameter_s, 'lv')
541 opts,args = self.parse_options(parameter_s, 'lv')
532 # Try to get a variable name and command to run
542 # Try to get a variable name and command to run
533 try:
543 try:
534 # the variable name must be obtained from the parse_options
544 # the variable name must be obtained from the parse_options
535 # output, which uses shlex.split to strip options out.
545 # output, which uses shlex.split to strip options out.
536 var,_ = args.split('=', 1)
546 var,_ = args.split('=', 1)
537 var = var.strip()
547 var = var.strip()
538 # But the command has to be extracted from the original input
548 # But the command has to be extracted from the original input
539 # parameter_s, not on what parse_options returns, to avoid the
549 # parameter_s, not on what parse_options returns, to avoid the
540 # quote stripping which shlex.split performs on it.
550 # quote stripping which shlex.split performs on it.
541 _,cmd = parameter_s.split('=', 1)
551 _,cmd = parameter_s.split('=', 1)
542 except ValueError:
552 except ValueError:
543 var,cmd = '',''
553 var,cmd = '',''
544 # If all looks ok, proceed
554 # If all looks ok, proceed
545 split = 'l' in opts
555 split = 'l' in opts
546 out = self.shell.getoutput(cmd, split=split)
556 out = self.shell.getoutput(cmd, split=split)
547 if 'v' in opts:
557 if 'v' in opts:
548 print '%s ==\n%s' % (var, pformat(out))
558 print '%s ==\n%s' % (var, pformat(out))
549 if var:
559 if var:
550 self.shell.user_ns.update({var:out})
560 self.shell.user_ns.update({var:out})
551 else:
561 else:
552 return out
562 return out
553
563
554 @line_cell_magic
564 @line_cell_magic
555 def sx(self, line='', cell=None):
565 def sx(self, line='', cell=None):
556 """Shell execute - run shell command and capture output (!! is short-hand).
566 """Shell execute - run shell command and capture output (!! is short-hand).
557
567
558 %sx command
568 %sx command
559
569
560 IPython will run the given command using commands.getoutput(), and
570 IPython will run the given command using commands.getoutput(), and
561 return the result formatted as a list (split on '\\n'). Since the
571 return the result formatted as a list (split on '\\n'). Since the
562 output is _returned_, it will be stored in ipython's regular output
572 output is _returned_, it will be stored in ipython's regular output
563 cache Out[N] and in the '_N' automatic variables.
573 cache Out[N] and in the '_N' automatic variables.
564
574
565 Notes:
575 Notes:
566
576
567 1) If an input line begins with '!!', then %sx is automatically
577 1) If an input line begins with '!!', then %sx is automatically
568 invoked. That is, while::
578 invoked. That is, while::
569
579
570 !ls
580 !ls
571
581
572 causes ipython to simply issue system('ls'), typing::
582 causes ipython to simply issue system('ls'), typing::
573
583
574 !!ls
584 !!ls
575
585
576 is a shorthand equivalent to::
586 is a shorthand equivalent to::
577
587
578 %sx ls
588 %sx ls
579
589
580 2) %sx differs from %sc in that %sx automatically splits into a list,
590 2) %sx differs from %sc in that %sx automatically splits into a list,
581 like '%sc -l'. The reason for this is to make it as easy as possible
591 like '%sc -l'. The reason for this is to make it as easy as possible
582 to process line-oriented shell output via further python commands.
592 to process line-oriented shell output via further python commands.
583 %sc is meant to provide much finer control, but requires more
593 %sc is meant to provide much finer control, but requires more
584 typing.
594 typing.
585
595
586 3) Just like %sc -l, this is a list with special attributes:
596 3) Just like %sc -l, this is a list with special attributes:
587 ::
597 ::
588
598
589 .l (or .list) : value as list.
599 .l (or .list) : value as list.
590 .n (or .nlstr): value as newline-separated string.
600 .n (or .nlstr): value as newline-separated string.
591 .s (or .spstr): value as whitespace-separated string.
601 .s (or .spstr): value as whitespace-separated string.
592
602
593 This is very useful when trying to use such lists as arguments to
603 This is very useful when trying to use such lists as arguments to
594 system commands."""
604 system commands."""
595
605
596 if cell is None:
606 if cell is None:
597 # line magic
607 # line magic
598 return self.shell.getoutput(line)
608 return self.shell.getoutput(line)
599 else:
609 else:
600 opts,args = self.parse_options(line, '', 'out=')
610 opts,args = self.parse_options(line, '', 'out=')
601 output = self.shell.getoutput(cell)
611 output = self.shell.getoutput(cell)
602 out_name = opts.get('out', opts.get('o'))
612 out_name = opts.get('out', opts.get('o'))
603 if out_name:
613 if out_name:
604 self.shell.user_ns[out_name] = output
614 self.shell.user_ns[out_name] = output
605 else:
615 else:
606 return output
616 return output
607
617
608 system = line_cell_magic('system')(sx)
618 system = line_cell_magic('system')(sx)
609 bang = cell_magic('!')(sx)
619 bang = cell_magic('!')(sx)
610
620
611 @line_magic
621 @line_magic
612 def bookmark(self, parameter_s=''):
622 def bookmark(self, parameter_s=''):
613 """Manage IPython's bookmark system.
623 """Manage IPython's bookmark system.
614
624
615 %bookmark <name> - set bookmark to current dir
625 %bookmark <name> - set bookmark to current dir
616 %bookmark <name> <dir> - set bookmark to <dir>
626 %bookmark <name> <dir> - set bookmark to <dir>
617 %bookmark -l - list all bookmarks
627 %bookmark -l - list all bookmarks
618 %bookmark -d <name> - remove bookmark
628 %bookmark -d <name> - remove bookmark
619 %bookmark -r - remove all bookmarks
629 %bookmark -r - remove all bookmarks
620
630
621 You can later on access a bookmarked folder with::
631 You can later on access a bookmarked folder with::
622
632
623 %cd -b <name>
633 %cd -b <name>
624
634
625 or simply '%cd <name>' if there is no directory called <name> AND
635 or simply '%cd <name>' if there is no directory called <name> AND
626 there is such a bookmark defined.
636 there is such a bookmark defined.
627
637
628 Your bookmarks persist through IPython sessions, but they are
638 Your bookmarks persist through IPython sessions, but they are
629 associated with each profile."""
639 associated with each profile."""
630
640
631 opts,args = self.parse_options(parameter_s,'drl',mode='list')
641 opts,args = self.parse_options(parameter_s,'drl',mode='list')
632 if len(args) > 2:
642 if len(args) > 2:
633 raise UsageError("%bookmark: too many arguments")
643 raise UsageError("%bookmark: too many arguments")
634
644
635 bkms = self.shell.db.get('bookmarks',{})
645 bkms = self.shell.db.get('bookmarks',{})
636
646
637 if 'd' in opts:
647 if 'd' in opts:
638 try:
648 try:
639 todel = args[0]
649 todel = args[0]
640 except IndexError:
650 except IndexError:
641 raise UsageError(
651 raise UsageError(
642 "%bookmark -d: must provide a bookmark to delete")
652 "%bookmark -d: must provide a bookmark to delete")
643 else:
653 else:
644 try:
654 try:
645 del bkms[todel]
655 del bkms[todel]
646 except KeyError:
656 except KeyError:
647 raise UsageError(
657 raise UsageError(
648 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
658 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
649
659
650 elif 'r' in opts:
660 elif 'r' in opts:
651 bkms = {}
661 bkms = {}
652 elif 'l' in opts:
662 elif 'l' in opts:
653 bks = bkms.keys()
663 bks = bkms.keys()
654 bks.sort()
664 bks.sort()
655 if bks:
665 if bks:
656 size = max(map(len, bks))
666 size = max(map(len, bks))
657 else:
667 else:
658 size = 0
668 size = 0
659 fmt = '%-'+str(size)+'s -> %s'
669 fmt = '%-'+str(size)+'s -> %s'
660 print 'Current bookmarks:'
670 print 'Current bookmarks:'
661 for bk in bks:
671 for bk in bks:
662 print fmt % (bk, bkms[bk])
672 print fmt % (bk, bkms[bk])
663 else:
673 else:
664 if not args:
674 if not args:
665 raise UsageError("%bookmark: You must specify the bookmark name")
675 raise UsageError("%bookmark: You must specify the bookmark name")
666 elif len(args)==1:
676 elif len(args)==1:
667 bkms[args[0]] = os.getcwdu()
677 bkms[args[0]] = os.getcwdu()
668 elif len(args)==2:
678 elif len(args)==2:
669 bkms[args[0]] = args[1]
679 bkms[args[0]] = args[1]
670 self.shell.db['bookmarks'] = bkms
680 self.shell.db['bookmarks'] = bkms
671
681
672 @line_magic
682 @line_magic
673 def pycat(self, parameter_s=''):
683 def pycat(self, parameter_s=''):
674 """Show a syntax-highlighted file through a pager.
684 """Show a syntax-highlighted file through a pager.
675
685
676 This magic is similar to the cat utility, but it will assume the file
686 This magic is similar to the cat utility, but it will assume the file
677 to be Python source and will show it with syntax highlighting.
687 to be Python source and will show it with syntax highlighting.
678
688
679 This magic command can either take a local filename, an url,
689 This magic command can either take a local filename, an url,
680 an history range (see %history) or a macro as argument ::
690 an history range (see %history) or a macro as argument ::
681
691
682 %pycat myscript.py
692 %pycat myscript.py
683 %pycat 7-27
693 %pycat 7-27
684 %pycat myMacro
694 %pycat myMacro
685 %pycat http://www.example.com/myscript.py
695 %pycat http://www.example.com/myscript.py
686 """
696 """
687 if not parameter_s:
697 if not parameter_s:
688 raise UsageError('Missing filename, URL, input history range, '
698 raise UsageError('Missing filename, URL, input history range, '
689 'or macro.')
699 'or macro.')
690
700
691 try :
701 try :
692 cont = self.shell.find_user_code(parameter_s, skip_encoding_cookie=False)
702 cont = self.shell.find_user_code(parameter_s, skip_encoding_cookie=False)
693 except (ValueError, IOError):
703 except (ValueError, IOError):
694 print "Error: no such file, variable, URL, history range or macro"
704 print "Error: no such file, variable, URL, history range or macro"
695 return
705 return
696
706
697 page.page(self.shell.pycolorize(source_to_unicode(cont)))
707 page.page(self.shell.pycolorize(source_to_unicode(cont)))
698
708
699 @magic_arguments.magic_arguments()
709 @magic_arguments.magic_arguments()
700 @magic_arguments.argument(
710 @magic_arguments.argument(
701 '-a', '--append', action='store_true', default=False,
711 '-a', '--append', action='store_true', default=False,
702 help='Append contents of the cell to an existing file. '
712 help='Append contents of the cell to an existing file. '
703 'The file will be created if it does not exist.'
713 'The file will be created if it does not exist.'
704 )
714 )
705 @magic_arguments.argument(
715 @magic_arguments.argument(
706 'filename', type=unicode,
716 'filename', type=unicode,
707 help='file to write'
717 help='file to write'
708 )
718 )
709 @cell_magic
719 @cell_magic
710 def writefile(self, line, cell):
720 def writefile(self, line, cell):
711 """Write the contents of the cell to a file.
721 """Write the contents of the cell to a file.
712
722
713 The file will be overwritten unless the -a (--append) flag is specified.
723 The file will be overwritten unless the -a (--append) flag is specified.
714 """
724 """
715 args = magic_arguments.parse_argstring(self.writefile, line)
725 args = magic_arguments.parse_argstring(self.writefile, line)
716 filename = os.path.expanduser(unquote_filename(args.filename))
726 filename = os.path.expanduser(unquote_filename(args.filename))
717
727
718 if os.path.exists(filename):
728 if os.path.exists(filename):
719 if args.append:
729 if args.append:
720 print "Appending to %s" % filename
730 print "Appending to %s" % filename
721 else:
731 else:
722 print "Overwriting %s" % filename
732 print "Overwriting %s" % filename
723 else:
733 else:
724 print "Writing %s" % filename
734 print "Writing %s" % filename
725
735
726 mode = 'a' if args.append else 'w'
736 mode = 'a' if args.append else 'w'
727 with io.open(filename, mode, encoding='utf-8') as f:
737 with io.open(filename, mode, encoding='utf-8') as f:
728 f.write(cell)
738 f.write(cell)
General Comments 0
You need to be logged in to leave comments. Login now