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