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