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