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