##// END OF EJS Templates
fixed help message about history cache size
Ming Zhang -
Show More
@@ -1,3210 +1,3210 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 3 (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 3, 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 if not oname.startswith(ESC_MAGIC) and \
1375 if not oname.startswith(ESC_MAGIC) and \
1376 not oname.startswith(ESC_MAGIC2) and \
1376 not oname.startswith(ESC_MAGIC2) and \
1377 not all(a.isidentifier() for a in oname.split(".")):
1377 not all(a.isidentifier() for a in oname.split(".")):
1378 return {'found': False}
1378 return {'found': False}
1379
1379
1380 if namespaces is None:
1380 if namespaces is None:
1381 # Namespaces to search in:
1381 # Namespaces to search in:
1382 # Put them in a list. The order is important so that we
1382 # Put them in a list. The order is important so that we
1383 # find things in the same order that Python finds them.
1383 # find things in the same order that Python finds them.
1384 namespaces = [ ('Interactive', self.user_ns),
1384 namespaces = [ ('Interactive', self.user_ns),
1385 ('Interactive (global)', self.user_global_ns),
1385 ('Interactive (global)', self.user_global_ns),
1386 ('Python builtin', builtin_mod.__dict__),
1386 ('Python builtin', builtin_mod.__dict__),
1387 ]
1387 ]
1388
1388
1389 ismagic = False
1389 ismagic = False
1390 isalias = False
1390 isalias = False
1391 found = False
1391 found = False
1392 ospace = None
1392 ospace = None
1393 parent = None
1393 parent = None
1394 obj = None
1394 obj = None
1395
1395
1396 # Look for the given name by splitting it in parts. If the head is
1396 # Look for the given name by splitting it in parts. If the head is
1397 # found, then we look for all the remaining parts as members, and only
1397 # found, then we look for all the remaining parts as members, and only
1398 # declare success if we can find them all.
1398 # declare success if we can find them all.
1399 oname_parts = oname.split('.')
1399 oname_parts = oname.split('.')
1400 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1400 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1401 for nsname,ns in namespaces:
1401 for nsname,ns in namespaces:
1402 try:
1402 try:
1403 obj = ns[oname_head]
1403 obj = ns[oname_head]
1404 except KeyError:
1404 except KeyError:
1405 continue
1405 continue
1406 else:
1406 else:
1407 for idx, part in enumerate(oname_rest):
1407 for idx, part in enumerate(oname_rest):
1408 try:
1408 try:
1409 parent = obj
1409 parent = obj
1410 # The last part is looked up in a special way to avoid
1410 # The last part is looked up in a special way to avoid
1411 # descriptor invocation as it may raise or have side
1411 # descriptor invocation as it may raise or have side
1412 # effects.
1412 # effects.
1413 if idx == len(oname_rest) - 1:
1413 if idx == len(oname_rest) - 1:
1414 obj = self._getattr_property(obj, part)
1414 obj = self._getattr_property(obj, part)
1415 else:
1415 else:
1416 obj = getattr(obj, part)
1416 obj = getattr(obj, part)
1417 except:
1417 except:
1418 # Blanket except b/c some badly implemented objects
1418 # Blanket except b/c some badly implemented objects
1419 # allow __getattr__ to raise exceptions other than
1419 # allow __getattr__ to raise exceptions other than
1420 # AttributeError, which then crashes IPython.
1420 # AttributeError, which then crashes IPython.
1421 break
1421 break
1422 else:
1422 else:
1423 # If we finish the for loop (no break), we got all members
1423 # If we finish the for loop (no break), we got all members
1424 found = True
1424 found = True
1425 ospace = nsname
1425 ospace = nsname
1426 break # namespace loop
1426 break # namespace loop
1427
1427
1428 # Try to see if it's magic
1428 # Try to see if it's magic
1429 if not found:
1429 if not found:
1430 obj = None
1430 obj = None
1431 if oname.startswith(ESC_MAGIC2):
1431 if oname.startswith(ESC_MAGIC2):
1432 oname = oname.lstrip(ESC_MAGIC2)
1432 oname = oname.lstrip(ESC_MAGIC2)
1433 obj = self.find_cell_magic(oname)
1433 obj = self.find_cell_magic(oname)
1434 elif oname.startswith(ESC_MAGIC):
1434 elif oname.startswith(ESC_MAGIC):
1435 oname = oname.lstrip(ESC_MAGIC)
1435 oname = oname.lstrip(ESC_MAGIC)
1436 obj = self.find_line_magic(oname)
1436 obj = self.find_line_magic(oname)
1437 else:
1437 else:
1438 # search without prefix, so run? will find %run?
1438 # search without prefix, so run? will find %run?
1439 obj = self.find_line_magic(oname)
1439 obj = self.find_line_magic(oname)
1440 if obj is None:
1440 if obj is None:
1441 obj = self.find_cell_magic(oname)
1441 obj = self.find_cell_magic(oname)
1442 if obj is not None:
1442 if obj is not None:
1443 found = True
1443 found = True
1444 ospace = 'IPython internal'
1444 ospace = 'IPython internal'
1445 ismagic = True
1445 ismagic = True
1446 isalias = isinstance(obj, Alias)
1446 isalias = isinstance(obj, Alias)
1447
1447
1448 return {'found':found, 'obj':obj, 'namespace':ospace,
1448 return {'found':found, 'obj':obj, 'namespace':ospace,
1449 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1449 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1450
1450
1451 @staticmethod
1451 @staticmethod
1452 def _getattr_property(obj, attrname):
1452 def _getattr_property(obj, attrname):
1453 """Property-aware getattr to use in object finding.
1453 """Property-aware getattr to use in object finding.
1454
1454
1455 If attrname represents a property, return it unevaluated (in case it has
1455 If attrname represents a property, return it unevaluated (in case it has
1456 side effects or raises an error.
1456 side effects or raises an error.
1457
1457
1458 """
1458 """
1459 if not isinstance(obj, type):
1459 if not isinstance(obj, type):
1460 try:
1460 try:
1461 # `getattr(type(obj), attrname)` is not guaranteed to return
1461 # `getattr(type(obj), attrname)` is not guaranteed to return
1462 # `obj`, but does so for property:
1462 # `obj`, but does so for property:
1463 #
1463 #
1464 # property.__get__(self, None, cls) -> self
1464 # property.__get__(self, None, cls) -> self
1465 #
1465 #
1466 # The universal alternative is to traverse the mro manually
1466 # The universal alternative is to traverse the mro manually
1467 # searching for attrname in class dicts.
1467 # searching for attrname in class dicts.
1468 attr = getattr(type(obj), attrname)
1468 attr = getattr(type(obj), attrname)
1469 except AttributeError:
1469 except AttributeError:
1470 pass
1470 pass
1471 else:
1471 else:
1472 # This relies on the fact that data descriptors (with both
1472 # This relies on the fact that data descriptors (with both
1473 # __get__ & __set__ magic methods) take precedence over
1473 # __get__ & __set__ magic methods) take precedence over
1474 # instance-level attributes:
1474 # instance-level attributes:
1475 #
1475 #
1476 # class A(object):
1476 # class A(object):
1477 # @property
1477 # @property
1478 # def foobar(self): return 123
1478 # def foobar(self): return 123
1479 # a = A()
1479 # a = A()
1480 # a.__dict__['foobar'] = 345
1480 # a.__dict__['foobar'] = 345
1481 # a.foobar # == 123
1481 # a.foobar # == 123
1482 #
1482 #
1483 # So, a property may be returned right away.
1483 # So, a property may be returned right away.
1484 if isinstance(attr, property):
1484 if isinstance(attr, property):
1485 return attr
1485 return attr
1486
1486
1487 # Nothing helped, fall back.
1487 # Nothing helped, fall back.
1488 return getattr(obj, attrname)
1488 return getattr(obj, attrname)
1489
1489
1490 def _object_find(self, oname, namespaces=None):
1490 def _object_find(self, oname, namespaces=None):
1491 """Find an object and return a struct with info about it."""
1491 """Find an object and return a struct with info about it."""
1492 return Struct(self._ofind(oname, namespaces))
1492 return Struct(self._ofind(oname, namespaces))
1493
1493
1494 def _inspect(self, meth, oname, namespaces=None, **kw):
1494 def _inspect(self, meth, oname, namespaces=None, **kw):
1495 """Generic interface to the inspector system.
1495 """Generic interface to the inspector system.
1496
1496
1497 This function is meant to be called by pdef, pdoc & friends.
1497 This function is meant to be called by pdef, pdoc & friends.
1498 """
1498 """
1499 info = self._object_find(oname, namespaces)
1499 info = self._object_find(oname, namespaces)
1500 docformat = sphinxify if self.sphinxify_docstring else None
1500 docformat = sphinxify if self.sphinxify_docstring else None
1501 if info.found:
1501 if info.found:
1502 pmethod = getattr(self.inspector, meth)
1502 pmethod = getattr(self.inspector, meth)
1503 # TODO: only apply format_screen to the plain/text repr of the mime
1503 # TODO: only apply format_screen to the plain/text repr of the mime
1504 # bundle.
1504 # bundle.
1505 formatter = format_screen if info.ismagic else docformat
1505 formatter = format_screen if info.ismagic else docformat
1506 if meth == 'pdoc':
1506 if meth == 'pdoc':
1507 pmethod(info.obj, oname, formatter)
1507 pmethod(info.obj, oname, formatter)
1508 elif meth == 'pinfo':
1508 elif meth == 'pinfo':
1509 pmethod(info.obj, oname, formatter, info,
1509 pmethod(info.obj, oname, formatter, info,
1510 enable_html_pager=self.enable_html_pager, **kw)
1510 enable_html_pager=self.enable_html_pager, **kw)
1511 else:
1511 else:
1512 pmethod(info.obj, oname)
1512 pmethod(info.obj, oname)
1513 else:
1513 else:
1514 print('Object `%s` not found.' % oname)
1514 print('Object `%s` not found.' % oname)
1515 return 'not found' # so callers can take other action
1515 return 'not found' # so callers can take other action
1516
1516
1517 def object_inspect(self, oname, detail_level=0):
1517 def object_inspect(self, oname, detail_level=0):
1518 """Get object info about oname"""
1518 """Get object info about oname"""
1519 with self.builtin_trap:
1519 with self.builtin_trap:
1520 info = self._object_find(oname)
1520 info = self._object_find(oname)
1521 if info.found:
1521 if info.found:
1522 return self.inspector.info(info.obj, oname, info=info,
1522 return self.inspector.info(info.obj, oname, info=info,
1523 detail_level=detail_level
1523 detail_level=detail_level
1524 )
1524 )
1525 else:
1525 else:
1526 return oinspect.object_info(name=oname, found=False)
1526 return oinspect.object_info(name=oname, found=False)
1527
1527
1528 def object_inspect_text(self, oname, detail_level=0):
1528 def object_inspect_text(self, oname, detail_level=0):
1529 """Get object info as formatted text"""
1529 """Get object info as formatted text"""
1530 return self.object_inspect_mime(oname, detail_level)['text/plain']
1530 return self.object_inspect_mime(oname, detail_level)['text/plain']
1531
1531
1532 def object_inspect_mime(self, oname, detail_level=0):
1532 def object_inspect_mime(self, oname, detail_level=0):
1533 """Get object info as a mimebundle of formatted representations.
1533 """Get object info as a mimebundle of formatted representations.
1534
1534
1535 A mimebundle is a dictionary, keyed by mime-type.
1535 A mimebundle is a dictionary, keyed by mime-type.
1536 It must always have the key `'text/plain'`.
1536 It must always have the key `'text/plain'`.
1537 """
1537 """
1538 with self.builtin_trap:
1538 with self.builtin_trap:
1539 info = self._object_find(oname)
1539 info = self._object_find(oname)
1540 if info.found:
1540 if info.found:
1541 return self.inspector._get_info(info.obj, oname, info=info,
1541 return self.inspector._get_info(info.obj, oname, info=info,
1542 detail_level=detail_level
1542 detail_level=detail_level
1543 )
1543 )
1544 else:
1544 else:
1545 raise KeyError(oname)
1545 raise KeyError(oname)
1546
1546
1547 #-------------------------------------------------------------------------
1547 #-------------------------------------------------------------------------
1548 # Things related to history management
1548 # Things related to history management
1549 #-------------------------------------------------------------------------
1549 #-------------------------------------------------------------------------
1550
1550
1551 def init_history(self):
1551 def init_history(self):
1552 """Sets up the command history, and starts regular autosaves."""
1552 """Sets up the command history, and starts regular autosaves."""
1553 self.history_manager = HistoryManager(shell=self, parent=self)
1553 self.history_manager = HistoryManager(shell=self, parent=self)
1554 self.configurables.append(self.history_manager)
1554 self.configurables.append(self.history_manager)
1555
1555
1556 #-------------------------------------------------------------------------
1556 #-------------------------------------------------------------------------
1557 # Things related to exception handling and tracebacks (not debugging)
1557 # Things related to exception handling and tracebacks (not debugging)
1558 #-------------------------------------------------------------------------
1558 #-------------------------------------------------------------------------
1559
1559
1560 debugger_cls = Pdb
1560 debugger_cls = Pdb
1561
1561
1562 def init_traceback_handlers(self, custom_exceptions):
1562 def init_traceback_handlers(self, custom_exceptions):
1563 # Syntax error handler.
1563 # Syntax error handler.
1564 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self)
1564 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self)
1565
1565
1566 # The interactive one is initialized with an offset, meaning we always
1566 # The interactive one is initialized with an offset, meaning we always
1567 # want to remove the topmost item in the traceback, which is our own
1567 # want to remove the topmost item in the traceback, which is our own
1568 # internal code. Valid modes: ['Plain','Context','Verbose']
1568 # internal code. Valid modes: ['Plain','Context','Verbose']
1569 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1569 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1570 color_scheme='NoColor',
1570 color_scheme='NoColor',
1571 tb_offset = 1,
1571 tb_offset = 1,
1572 check_cache=check_linecache_ipython,
1572 check_cache=check_linecache_ipython,
1573 debugger_cls=self.debugger_cls, parent=self)
1573 debugger_cls=self.debugger_cls, parent=self)
1574
1574
1575 # The instance will store a pointer to the system-wide exception hook,
1575 # The instance will store a pointer to the system-wide exception hook,
1576 # so that runtime code (such as magics) can access it. This is because
1576 # so that runtime code (such as magics) can access it. This is because
1577 # during the read-eval loop, it may get temporarily overwritten.
1577 # during the read-eval loop, it may get temporarily overwritten.
1578 self.sys_excepthook = sys.excepthook
1578 self.sys_excepthook = sys.excepthook
1579
1579
1580 # and add any custom exception handlers the user may have specified
1580 # and add any custom exception handlers the user may have specified
1581 self.set_custom_exc(*custom_exceptions)
1581 self.set_custom_exc(*custom_exceptions)
1582
1582
1583 # Set the exception mode
1583 # Set the exception mode
1584 self.InteractiveTB.set_mode(mode=self.xmode)
1584 self.InteractiveTB.set_mode(mode=self.xmode)
1585
1585
1586 def set_custom_exc(self, exc_tuple, handler):
1586 def set_custom_exc(self, exc_tuple, handler):
1587 """set_custom_exc(exc_tuple, handler)
1587 """set_custom_exc(exc_tuple, handler)
1588
1588
1589 Set a custom exception handler, which will be called if any of the
1589 Set a custom exception handler, which will be called if any of the
1590 exceptions in exc_tuple occur in the mainloop (specifically, in the
1590 exceptions in exc_tuple occur in the mainloop (specifically, in the
1591 run_code() method).
1591 run_code() method).
1592
1592
1593 Parameters
1593 Parameters
1594 ----------
1594 ----------
1595
1595
1596 exc_tuple : tuple of exception classes
1596 exc_tuple : tuple of exception classes
1597 A *tuple* of exception classes, for which to call the defined
1597 A *tuple* of exception classes, for which to call the defined
1598 handler. It is very important that you use a tuple, and NOT A
1598 handler. It is very important that you use a tuple, and NOT A
1599 LIST here, because of the way Python's except statement works. If
1599 LIST here, because of the way Python's except statement works. If
1600 you only want to trap a single exception, use a singleton tuple::
1600 you only want to trap a single exception, use a singleton tuple::
1601
1601
1602 exc_tuple == (MyCustomException,)
1602 exc_tuple == (MyCustomException,)
1603
1603
1604 handler : callable
1604 handler : callable
1605 handler must have the following signature::
1605 handler must have the following signature::
1606
1606
1607 def my_handler(self, etype, value, tb, tb_offset=None):
1607 def my_handler(self, etype, value, tb, tb_offset=None):
1608 ...
1608 ...
1609 return structured_traceback
1609 return structured_traceback
1610
1610
1611 Your handler must return a structured traceback (a list of strings),
1611 Your handler must return a structured traceback (a list of strings),
1612 or None.
1612 or None.
1613
1613
1614 This will be made into an instance method (via types.MethodType)
1614 This will be made into an instance method (via types.MethodType)
1615 of IPython itself, and it will be called if any of the exceptions
1615 of IPython itself, and it will be called if any of the exceptions
1616 listed in the exc_tuple are caught. If the handler is None, an
1616 listed in the exc_tuple are caught. If the handler is None, an
1617 internal basic one is used, which just prints basic info.
1617 internal basic one is used, which just prints basic info.
1618
1618
1619 To protect IPython from crashes, if your handler ever raises an
1619 To protect IPython from crashes, if your handler ever raises an
1620 exception or returns an invalid result, it will be immediately
1620 exception or returns an invalid result, it will be immediately
1621 disabled.
1621 disabled.
1622
1622
1623 WARNING: by putting in your own exception handler into IPython's main
1623 WARNING: by putting in your own exception handler into IPython's main
1624 execution loop, you run a very good chance of nasty crashes. This
1624 execution loop, you run a very good chance of nasty crashes. This
1625 facility should only be used if you really know what you are doing."""
1625 facility should only be used if you really know what you are doing."""
1626 if not isinstance(exc_tuple, tuple):
1626 if not isinstance(exc_tuple, tuple):
1627 raise TypeError("The custom exceptions must be given as a tuple.")
1627 raise TypeError("The custom exceptions must be given as a tuple.")
1628
1628
1629 def dummy_handler(self, etype, value, tb, tb_offset=None):
1629 def dummy_handler(self, etype, value, tb, tb_offset=None):
1630 print('*** Simple custom exception handler ***')
1630 print('*** Simple custom exception handler ***')
1631 print('Exception type :', etype)
1631 print('Exception type :', etype)
1632 print('Exception value:', value)
1632 print('Exception value:', value)
1633 print('Traceback :', tb)
1633 print('Traceback :', tb)
1634
1634
1635 def validate_stb(stb):
1635 def validate_stb(stb):
1636 """validate structured traceback return type
1636 """validate structured traceback return type
1637
1637
1638 return type of CustomTB *should* be a list of strings, but allow
1638 return type of CustomTB *should* be a list of strings, but allow
1639 single strings or None, which are harmless.
1639 single strings or None, which are harmless.
1640
1640
1641 This function will *always* return a list of strings,
1641 This function will *always* return a list of strings,
1642 and will raise a TypeError if stb is inappropriate.
1642 and will raise a TypeError if stb is inappropriate.
1643 """
1643 """
1644 msg = "CustomTB must return list of strings, not %r" % stb
1644 msg = "CustomTB must return list of strings, not %r" % stb
1645 if stb is None:
1645 if stb is None:
1646 return []
1646 return []
1647 elif isinstance(stb, str):
1647 elif isinstance(stb, str):
1648 return [stb]
1648 return [stb]
1649 elif not isinstance(stb, list):
1649 elif not isinstance(stb, list):
1650 raise TypeError(msg)
1650 raise TypeError(msg)
1651 # it's a list
1651 # it's a list
1652 for line in stb:
1652 for line in stb:
1653 # check every element
1653 # check every element
1654 if not isinstance(line, str):
1654 if not isinstance(line, str):
1655 raise TypeError(msg)
1655 raise TypeError(msg)
1656 return stb
1656 return stb
1657
1657
1658 if handler is None:
1658 if handler is None:
1659 wrapped = dummy_handler
1659 wrapped = dummy_handler
1660 else:
1660 else:
1661 def wrapped(self,etype,value,tb,tb_offset=None):
1661 def wrapped(self,etype,value,tb,tb_offset=None):
1662 """wrap CustomTB handler, to protect IPython from user code
1662 """wrap CustomTB handler, to protect IPython from user code
1663
1663
1664 This makes it harder (but not impossible) for custom exception
1664 This makes it harder (but not impossible) for custom exception
1665 handlers to crash IPython.
1665 handlers to crash IPython.
1666 """
1666 """
1667 try:
1667 try:
1668 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1668 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1669 return validate_stb(stb)
1669 return validate_stb(stb)
1670 except:
1670 except:
1671 # clear custom handler immediately
1671 # clear custom handler immediately
1672 self.set_custom_exc((), None)
1672 self.set_custom_exc((), None)
1673 print("Custom TB Handler failed, unregistering", file=sys.stderr)
1673 print("Custom TB Handler failed, unregistering", file=sys.stderr)
1674 # show the exception in handler first
1674 # show the exception in handler first
1675 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1675 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1676 print(self.InteractiveTB.stb2text(stb))
1676 print(self.InteractiveTB.stb2text(stb))
1677 print("The original exception:")
1677 print("The original exception:")
1678 stb = self.InteractiveTB.structured_traceback(
1678 stb = self.InteractiveTB.structured_traceback(
1679 (etype,value,tb), tb_offset=tb_offset
1679 (etype,value,tb), tb_offset=tb_offset
1680 )
1680 )
1681 return stb
1681 return stb
1682
1682
1683 self.CustomTB = types.MethodType(wrapped,self)
1683 self.CustomTB = types.MethodType(wrapped,self)
1684 self.custom_exceptions = exc_tuple
1684 self.custom_exceptions = exc_tuple
1685
1685
1686 def excepthook(self, etype, value, tb):
1686 def excepthook(self, etype, value, tb):
1687 """One more defense for GUI apps that call sys.excepthook.
1687 """One more defense for GUI apps that call sys.excepthook.
1688
1688
1689 GUI frameworks like wxPython trap exceptions and call
1689 GUI frameworks like wxPython trap exceptions and call
1690 sys.excepthook themselves. I guess this is a feature that
1690 sys.excepthook themselves. I guess this is a feature that
1691 enables them to keep running after exceptions that would
1691 enables them to keep running after exceptions that would
1692 otherwise kill their mainloop. This is a bother for IPython
1692 otherwise kill their mainloop. This is a bother for IPython
1693 which excepts to catch all of the program exceptions with a try:
1693 which excepts to catch all of the program exceptions with a try:
1694 except: statement.
1694 except: statement.
1695
1695
1696 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1696 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1697 any app directly invokes sys.excepthook, it will look to the user like
1697 any app directly invokes sys.excepthook, it will look to the user like
1698 IPython crashed. In order to work around this, we can disable the
1698 IPython crashed. In order to work around this, we can disable the
1699 CrashHandler and replace it with this excepthook instead, which prints a
1699 CrashHandler and replace it with this excepthook instead, which prints a
1700 regular traceback using our InteractiveTB. In this fashion, apps which
1700 regular traceback using our InteractiveTB. In this fashion, apps which
1701 call sys.excepthook will generate a regular-looking exception from
1701 call sys.excepthook will generate a regular-looking exception from
1702 IPython, and the CrashHandler will only be triggered by real IPython
1702 IPython, and the CrashHandler will only be triggered by real IPython
1703 crashes.
1703 crashes.
1704
1704
1705 This hook should be used sparingly, only in places which are not likely
1705 This hook should be used sparingly, only in places which are not likely
1706 to be true IPython errors.
1706 to be true IPython errors.
1707 """
1707 """
1708 self.showtraceback((etype, value, tb), tb_offset=0)
1708 self.showtraceback((etype, value, tb), tb_offset=0)
1709
1709
1710 def _get_exc_info(self, exc_tuple=None):
1710 def _get_exc_info(self, exc_tuple=None):
1711 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1711 """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc.
1712
1712
1713 Ensures sys.last_type,value,traceback hold the exc_info we found,
1713 Ensures sys.last_type,value,traceback hold the exc_info we found,
1714 from whichever source.
1714 from whichever source.
1715
1715
1716 raises ValueError if none of these contain any information
1716 raises ValueError if none of these contain any information
1717 """
1717 """
1718 if exc_tuple is None:
1718 if exc_tuple is None:
1719 etype, value, tb = sys.exc_info()
1719 etype, value, tb = sys.exc_info()
1720 else:
1720 else:
1721 etype, value, tb = exc_tuple
1721 etype, value, tb = exc_tuple
1722
1722
1723 if etype is None:
1723 if etype is None:
1724 if hasattr(sys, 'last_type'):
1724 if hasattr(sys, 'last_type'):
1725 etype, value, tb = sys.last_type, sys.last_value, \
1725 etype, value, tb = sys.last_type, sys.last_value, \
1726 sys.last_traceback
1726 sys.last_traceback
1727
1727
1728 if etype is None:
1728 if etype is None:
1729 raise ValueError("No exception to find")
1729 raise ValueError("No exception to find")
1730
1730
1731 # Now store the exception info in sys.last_type etc.
1731 # Now store the exception info in sys.last_type etc.
1732 # WARNING: these variables are somewhat deprecated and not
1732 # WARNING: these variables are somewhat deprecated and not
1733 # necessarily safe to use in a threaded environment, but tools
1733 # necessarily safe to use in a threaded environment, but tools
1734 # like pdb depend on their existence, so let's set them. If we
1734 # like pdb depend on their existence, so let's set them. If we
1735 # find problems in the field, we'll need to revisit their use.
1735 # find problems in the field, we'll need to revisit their use.
1736 sys.last_type = etype
1736 sys.last_type = etype
1737 sys.last_value = value
1737 sys.last_value = value
1738 sys.last_traceback = tb
1738 sys.last_traceback = tb
1739
1739
1740 return etype, value, tb
1740 return etype, value, tb
1741
1741
1742 def show_usage_error(self, exc):
1742 def show_usage_error(self, exc):
1743 """Show a short message for UsageErrors
1743 """Show a short message for UsageErrors
1744
1744
1745 These are special exceptions that shouldn't show a traceback.
1745 These are special exceptions that shouldn't show a traceback.
1746 """
1746 """
1747 print("UsageError: %s" % exc, file=sys.stderr)
1747 print("UsageError: %s" % exc, file=sys.stderr)
1748
1748
1749 def get_exception_only(self, exc_tuple=None):
1749 def get_exception_only(self, exc_tuple=None):
1750 """
1750 """
1751 Return as a string (ending with a newline) the exception that
1751 Return as a string (ending with a newline) the exception that
1752 just occurred, without any traceback.
1752 just occurred, without any traceback.
1753 """
1753 """
1754 etype, value, tb = self._get_exc_info(exc_tuple)
1754 etype, value, tb = self._get_exc_info(exc_tuple)
1755 msg = traceback.format_exception_only(etype, value)
1755 msg = traceback.format_exception_only(etype, value)
1756 return ''.join(msg)
1756 return ''.join(msg)
1757
1757
1758 def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None,
1758 def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None,
1759 exception_only=False):
1759 exception_only=False):
1760 """Display the exception that just occurred.
1760 """Display the exception that just occurred.
1761
1761
1762 If nothing is known about the exception, this is the method which
1762 If nothing is known about the exception, this is the method which
1763 should be used throughout the code for presenting user tracebacks,
1763 should be used throughout the code for presenting user tracebacks,
1764 rather than directly invoking the InteractiveTB object.
1764 rather than directly invoking the InteractiveTB object.
1765
1765
1766 A specific showsyntaxerror() also exists, but this method can take
1766 A specific showsyntaxerror() also exists, but this method can take
1767 care of calling it if needed, so unless you are explicitly catching a
1767 care of calling it if needed, so unless you are explicitly catching a
1768 SyntaxError exception, don't try to analyze the stack manually and
1768 SyntaxError exception, don't try to analyze the stack manually and
1769 simply call this method."""
1769 simply call this method."""
1770
1770
1771 try:
1771 try:
1772 try:
1772 try:
1773 etype, value, tb = self._get_exc_info(exc_tuple)
1773 etype, value, tb = self._get_exc_info(exc_tuple)
1774 except ValueError:
1774 except ValueError:
1775 print('No traceback available to show.', file=sys.stderr)
1775 print('No traceback available to show.', file=sys.stderr)
1776 return
1776 return
1777
1777
1778 if issubclass(etype, SyntaxError):
1778 if issubclass(etype, SyntaxError):
1779 # Though this won't be called by syntax errors in the input
1779 # Though this won't be called by syntax errors in the input
1780 # line, there may be SyntaxError cases with imported code.
1780 # line, there may be SyntaxError cases with imported code.
1781 self.showsyntaxerror(filename)
1781 self.showsyntaxerror(filename)
1782 elif etype is UsageError:
1782 elif etype is UsageError:
1783 self.show_usage_error(value)
1783 self.show_usage_error(value)
1784 else:
1784 else:
1785 if exception_only:
1785 if exception_only:
1786 stb = ['An exception has occurred, use %tb to see '
1786 stb = ['An exception has occurred, use %tb to see '
1787 'the full traceback.\n']
1787 'the full traceback.\n']
1788 stb.extend(self.InteractiveTB.get_exception_only(etype,
1788 stb.extend(self.InteractiveTB.get_exception_only(etype,
1789 value))
1789 value))
1790 else:
1790 else:
1791 try:
1791 try:
1792 # Exception classes can customise their traceback - we
1792 # Exception classes can customise their traceback - we
1793 # use this in IPython.parallel for exceptions occurring
1793 # use this in IPython.parallel for exceptions occurring
1794 # in the engines. This should return a list of strings.
1794 # in the engines. This should return a list of strings.
1795 stb = value._render_traceback_()
1795 stb = value._render_traceback_()
1796 except Exception:
1796 except Exception:
1797 stb = self.InteractiveTB.structured_traceback(etype,
1797 stb = self.InteractiveTB.structured_traceback(etype,
1798 value, tb, tb_offset=tb_offset)
1798 value, tb, tb_offset=tb_offset)
1799
1799
1800 self._showtraceback(etype, value, stb)
1800 self._showtraceback(etype, value, stb)
1801 if self.call_pdb:
1801 if self.call_pdb:
1802 # drop into debugger
1802 # drop into debugger
1803 self.debugger(force=True)
1803 self.debugger(force=True)
1804 return
1804 return
1805
1805
1806 # Actually show the traceback
1806 # Actually show the traceback
1807 self._showtraceback(etype, value, stb)
1807 self._showtraceback(etype, value, stb)
1808
1808
1809 except KeyboardInterrupt:
1809 except KeyboardInterrupt:
1810 print('\n' + self.get_exception_only(), file=sys.stderr)
1810 print('\n' + self.get_exception_only(), file=sys.stderr)
1811
1811
1812 def _showtraceback(self, etype, evalue, stb):
1812 def _showtraceback(self, etype, evalue, stb):
1813 """Actually show a traceback.
1813 """Actually show a traceback.
1814
1814
1815 Subclasses may override this method to put the traceback on a different
1815 Subclasses may override this method to put the traceback on a different
1816 place, like a side channel.
1816 place, like a side channel.
1817 """
1817 """
1818 print(self.InteractiveTB.stb2text(stb))
1818 print(self.InteractiveTB.stb2text(stb))
1819
1819
1820 def showsyntaxerror(self, filename=None):
1820 def showsyntaxerror(self, filename=None):
1821 """Display the syntax error that just occurred.
1821 """Display the syntax error that just occurred.
1822
1822
1823 This doesn't display a stack trace because there isn't one.
1823 This doesn't display a stack trace because there isn't one.
1824
1824
1825 If a filename is given, it is stuffed in the exception instead
1825 If a filename is given, it is stuffed in the exception instead
1826 of what was there before (because Python's parser always uses
1826 of what was there before (because Python's parser always uses
1827 "<string>" when reading from a string).
1827 "<string>" when reading from a string).
1828 """
1828 """
1829 etype, value, last_traceback = self._get_exc_info()
1829 etype, value, last_traceback = self._get_exc_info()
1830
1830
1831 if filename and issubclass(etype, SyntaxError):
1831 if filename and issubclass(etype, SyntaxError):
1832 try:
1832 try:
1833 value.filename = filename
1833 value.filename = filename
1834 except:
1834 except:
1835 # Not the format we expect; leave it alone
1835 # Not the format we expect; leave it alone
1836 pass
1836 pass
1837
1837
1838 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1838 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1839 self._showtraceback(etype, value, stb)
1839 self._showtraceback(etype, value, stb)
1840
1840
1841 # This is overridden in TerminalInteractiveShell to show a message about
1841 # This is overridden in TerminalInteractiveShell to show a message about
1842 # the %paste magic.
1842 # the %paste magic.
1843 def showindentationerror(self):
1843 def showindentationerror(self):
1844 """Called by run_cell when there's an IndentationError in code entered
1844 """Called by run_cell when there's an IndentationError in code entered
1845 at the prompt.
1845 at the prompt.
1846
1846
1847 This is overridden in TerminalInteractiveShell to show a message about
1847 This is overridden in TerminalInteractiveShell to show a message about
1848 the %paste magic."""
1848 the %paste magic."""
1849 self.showsyntaxerror()
1849 self.showsyntaxerror()
1850
1850
1851 #-------------------------------------------------------------------------
1851 #-------------------------------------------------------------------------
1852 # Things related to readline
1852 # Things related to readline
1853 #-------------------------------------------------------------------------
1853 #-------------------------------------------------------------------------
1854
1854
1855 def init_readline(self):
1855 def init_readline(self):
1856 """DEPRECATED
1856 """DEPRECATED
1857
1857
1858 Moved to terminal subclass, here only to simplify the init logic."""
1858 Moved to terminal subclass, here only to simplify the init logic."""
1859 # Set a number of methods that depend on readline to be no-op
1859 # Set a number of methods that depend on readline to be no-op
1860 warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated',
1860 warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated',
1861 DeprecationWarning, stacklevel=2)
1861 DeprecationWarning, stacklevel=2)
1862 self.set_custom_completer = no_op
1862 self.set_custom_completer = no_op
1863
1863
1864 @skip_doctest
1864 @skip_doctest
1865 def set_next_input(self, s, replace=False):
1865 def set_next_input(self, s, replace=False):
1866 """ Sets the 'default' input string for the next command line.
1866 """ Sets the 'default' input string for the next command line.
1867
1867
1868 Example::
1868 Example::
1869
1869
1870 In [1]: _ip.set_next_input("Hello Word")
1870 In [1]: _ip.set_next_input("Hello Word")
1871 In [2]: Hello Word_ # cursor is here
1871 In [2]: Hello Word_ # cursor is here
1872 """
1872 """
1873 self.rl_next_input = py3compat.cast_bytes_py2(s)
1873 self.rl_next_input = py3compat.cast_bytes_py2(s)
1874
1874
1875 def _indent_current_str(self):
1875 def _indent_current_str(self):
1876 """return the current level of indentation as a string"""
1876 """return the current level of indentation as a string"""
1877 return self.input_splitter.indent_spaces * ' '
1877 return self.input_splitter.indent_spaces * ' '
1878
1878
1879 #-------------------------------------------------------------------------
1879 #-------------------------------------------------------------------------
1880 # Things related to text completion
1880 # Things related to text completion
1881 #-------------------------------------------------------------------------
1881 #-------------------------------------------------------------------------
1882
1882
1883 def init_completer(self):
1883 def init_completer(self):
1884 """Initialize the completion machinery.
1884 """Initialize the completion machinery.
1885
1885
1886 This creates completion machinery that can be used by client code,
1886 This creates completion machinery that can be used by client code,
1887 either interactively in-process (typically triggered by the readline
1887 either interactively in-process (typically triggered by the readline
1888 library), programmatically (such as in test suites) or out-of-process
1888 library), programmatically (such as in test suites) or out-of-process
1889 (typically over the network by remote frontends).
1889 (typically over the network by remote frontends).
1890 """
1890 """
1891 from IPython.core.completer import IPCompleter
1891 from IPython.core.completer import IPCompleter
1892 from IPython.core.completerlib import (module_completer,
1892 from IPython.core.completerlib import (module_completer,
1893 magic_run_completer, cd_completer, reset_completer)
1893 magic_run_completer, cd_completer, reset_completer)
1894
1894
1895 self.Completer = IPCompleter(shell=self,
1895 self.Completer = IPCompleter(shell=self,
1896 namespace=self.user_ns,
1896 namespace=self.user_ns,
1897 global_namespace=self.user_global_ns,
1897 global_namespace=self.user_global_ns,
1898 parent=self,
1898 parent=self,
1899 )
1899 )
1900 self.configurables.append(self.Completer)
1900 self.configurables.append(self.Completer)
1901
1901
1902 # Add custom completers to the basic ones built into IPCompleter
1902 # Add custom completers to the basic ones built into IPCompleter
1903 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1903 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1904 self.strdispatchers['complete_command'] = sdisp
1904 self.strdispatchers['complete_command'] = sdisp
1905 self.Completer.custom_completers = sdisp
1905 self.Completer.custom_completers = sdisp
1906
1906
1907 self.set_hook('complete_command', module_completer, str_key = 'import')
1907 self.set_hook('complete_command', module_completer, str_key = 'import')
1908 self.set_hook('complete_command', module_completer, str_key = 'from')
1908 self.set_hook('complete_command', module_completer, str_key = 'from')
1909 self.set_hook('complete_command', module_completer, str_key = '%aimport')
1909 self.set_hook('complete_command', module_completer, str_key = '%aimport')
1910 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1910 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1911 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1911 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1912 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1912 self.set_hook('complete_command', reset_completer, str_key = '%reset')
1913
1913
1914
1914
1915 def complete(self, text, line=None, cursor_pos=None):
1915 def complete(self, text, line=None, cursor_pos=None):
1916 """Return the completed text and a list of completions.
1916 """Return the completed text and a list of completions.
1917
1917
1918 Parameters
1918 Parameters
1919 ----------
1919 ----------
1920
1920
1921 text : string
1921 text : string
1922 A string of text to be completed on. It can be given as empty and
1922 A string of text to be completed on. It can be given as empty and
1923 instead a line/position pair are given. In this case, the
1923 instead a line/position pair are given. In this case, the
1924 completer itself will split the line like readline does.
1924 completer itself will split the line like readline does.
1925
1925
1926 line : string, optional
1926 line : string, optional
1927 The complete line that text is part of.
1927 The complete line that text is part of.
1928
1928
1929 cursor_pos : int, optional
1929 cursor_pos : int, optional
1930 The position of the cursor on the input line.
1930 The position of the cursor on the input line.
1931
1931
1932 Returns
1932 Returns
1933 -------
1933 -------
1934 text : string
1934 text : string
1935 The actual text that was completed.
1935 The actual text that was completed.
1936
1936
1937 matches : list
1937 matches : list
1938 A sorted list with all possible completions.
1938 A sorted list with all possible completions.
1939
1939
1940 The optional arguments allow the completion to take more context into
1940 The optional arguments allow the completion to take more context into
1941 account, and are part of the low-level completion API.
1941 account, and are part of the low-level completion API.
1942
1942
1943 This is a wrapper around the completion mechanism, similar to what
1943 This is a wrapper around the completion mechanism, similar to what
1944 readline does at the command line when the TAB key is hit. By
1944 readline does at the command line when the TAB key is hit. By
1945 exposing it as a method, it can be used by other non-readline
1945 exposing it as a method, it can be used by other non-readline
1946 environments (such as GUIs) for text completion.
1946 environments (such as GUIs) for text completion.
1947
1947
1948 Simple usage example:
1948 Simple usage example:
1949
1949
1950 In [1]: x = 'hello'
1950 In [1]: x = 'hello'
1951
1951
1952 In [2]: _ip.complete('x.l')
1952 In [2]: _ip.complete('x.l')
1953 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1953 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1954 """
1954 """
1955
1955
1956 # Inject names into __builtin__ so we can complete on the added names.
1956 # Inject names into __builtin__ so we can complete on the added names.
1957 with self.builtin_trap:
1957 with self.builtin_trap:
1958 return self.Completer.complete(text, line, cursor_pos)
1958 return self.Completer.complete(text, line, cursor_pos)
1959
1959
1960 def set_custom_completer(self, completer, pos=0):
1960 def set_custom_completer(self, completer, pos=0):
1961 """Adds a new custom completer function.
1961 """Adds a new custom completer function.
1962
1962
1963 The position argument (defaults to 0) is the index in the completers
1963 The position argument (defaults to 0) is the index in the completers
1964 list where you want the completer to be inserted."""
1964 list where you want the completer to be inserted."""
1965
1965
1966 newcomp = types.MethodType(completer,self.Completer)
1966 newcomp = types.MethodType(completer,self.Completer)
1967 self.Completer.matchers.insert(pos,newcomp)
1967 self.Completer.matchers.insert(pos,newcomp)
1968
1968
1969 def set_completer_frame(self, frame=None):
1969 def set_completer_frame(self, frame=None):
1970 """Set the frame of the completer."""
1970 """Set the frame of the completer."""
1971 if frame:
1971 if frame:
1972 self.Completer.namespace = frame.f_locals
1972 self.Completer.namespace = frame.f_locals
1973 self.Completer.global_namespace = frame.f_globals
1973 self.Completer.global_namespace = frame.f_globals
1974 else:
1974 else:
1975 self.Completer.namespace = self.user_ns
1975 self.Completer.namespace = self.user_ns
1976 self.Completer.global_namespace = self.user_global_ns
1976 self.Completer.global_namespace = self.user_global_ns
1977
1977
1978 #-------------------------------------------------------------------------
1978 #-------------------------------------------------------------------------
1979 # Things related to magics
1979 # Things related to magics
1980 #-------------------------------------------------------------------------
1980 #-------------------------------------------------------------------------
1981
1981
1982 def init_magics(self):
1982 def init_magics(self):
1983 from IPython.core import magics as m
1983 from IPython.core import magics as m
1984 self.magics_manager = magic.MagicsManager(shell=self,
1984 self.magics_manager = magic.MagicsManager(shell=self,
1985 parent=self,
1985 parent=self,
1986 user_magics=m.UserMagics(self))
1986 user_magics=m.UserMagics(self))
1987 self.configurables.append(self.magics_manager)
1987 self.configurables.append(self.magics_manager)
1988
1988
1989 # Expose as public API from the magics manager
1989 # Expose as public API from the magics manager
1990 self.register_magics = self.magics_manager.register
1990 self.register_magics = self.magics_manager.register
1991
1991
1992 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
1992 self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
1993 m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics,
1993 m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics,
1994 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
1994 m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics,
1995 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
1995 m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics,
1996 )
1996 )
1997
1997
1998 # Register Magic Aliases
1998 # Register Magic Aliases
1999 mman = self.magics_manager
1999 mman = self.magics_manager
2000 # FIXME: magic aliases should be defined by the Magics classes
2000 # FIXME: magic aliases should be defined by the Magics classes
2001 # or in MagicsManager, not here
2001 # or in MagicsManager, not here
2002 mman.register_alias('ed', 'edit')
2002 mman.register_alias('ed', 'edit')
2003 mman.register_alias('hist', 'history')
2003 mman.register_alias('hist', 'history')
2004 mman.register_alias('rep', 'recall')
2004 mman.register_alias('rep', 'recall')
2005 mman.register_alias('SVG', 'svg', 'cell')
2005 mman.register_alias('SVG', 'svg', 'cell')
2006 mman.register_alias('HTML', 'html', 'cell')
2006 mman.register_alias('HTML', 'html', 'cell')
2007 mman.register_alias('file', 'writefile', 'cell')
2007 mman.register_alias('file', 'writefile', 'cell')
2008
2008
2009 # FIXME: Move the color initialization to the DisplayHook, which
2009 # FIXME: Move the color initialization to the DisplayHook, which
2010 # should be split into a prompt manager and displayhook. We probably
2010 # should be split into a prompt manager and displayhook. We probably
2011 # even need a centralize colors management object.
2011 # even need a centralize colors management object.
2012 self.magic('colors %s' % self.colors)
2012 self.magic('colors %s' % self.colors)
2013
2013
2014 # Defined here so that it's included in the documentation
2014 # Defined here so that it's included in the documentation
2015 @functools.wraps(magic.MagicsManager.register_function)
2015 @functools.wraps(magic.MagicsManager.register_function)
2016 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2016 def register_magic_function(self, func, magic_kind='line', magic_name=None):
2017 self.magics_manager.register_function(func,
2017 self.magics_manager.register_function(func,
2018 magic_kind=magic_kind, magic_name=magic_name)
2018 magic_kind=magic_kind, magic_name=magic_name)
2019
2019
2020 def run_line_magic(self, magic_name, line):
2020 def run_line_magic(self, magic_name, line):
2021 """Execute the given line magic.
2021 """Execute the given line magic.
2022
2022
2023 Parameters
2023 Parameters
2024 ----------
2024 ----------
2025 magic_name : str
2025 magic_name : str
2026 Name of the desired magic function, without '%' prefix.
2026 Name of the desired magic function, without '%' prefix.
2027
2027
2028 line : str
2028 line : str
2029 The rest of the input line as a single string.
2029 The rest of the input line as a single string.
2030 """
2030 """
2031 fn = self.find_line_magic(magic_name)
2031 fn = self.find_line_magic(magic_name)
2032 if fn is None:
2032 if fn is None:
2033 cm = self.find_cell_magic(magic_name)
2033 cm = self.find_cell_magic(magic_name)
2034 etpl = "Line magic function `%%%s` not found%s."
2034 etpl = "Line magic function `%%%s` not found%s."
2035 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2035 extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, '
2036 'did you mean that instead?)' % magic_name )
2036 'did you mean that instead?)' % magic_name )
2037 error(etpl % (magic_name, extra))
2037 error(etpl % (magic_name, extra))
2038 else:
2038 else:
2039 # Note: this is the distance in the stack to the user's frame.
2039 # Note: this is the distance in the stack to the user's frame.
2040 # This will need to be updated if the internal calling logic gets
2040 # This will need to be updated if the internal calling logic gets
2041 # refactored, or else we'll be expanding the wrong variables.
2041 # refactored, or else we'll be expanding the wrong variables.
2042 stack_depth = 2
2042 stack_depth = 2
2043 magic_arg_s = self.var_expand(line, stack_depth)
2043 magic_arg_s = self.var_expand(line, stack_depth)
2044 # Put magic args in a list so we can call with f(*a) syntax
2044 # Put magic args in a list so we can call with f(*a) syntax
2045 args = [magic_arg_s]
2045 args = [magic_arg_s]
2046 kwargs = {}
2046 kwargs = {}
2047 # Grab local namespace if we need it:
2047 # Grab local namespace if we need it:
2048 if getattr(fn, "needs_local_scope", False):
2048 if getattr(fn, "needs_local_scope", False):
2049 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2049 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
2050 with self.builtin_trap:
2050 with self.builtin_trap:
2051 result = fn(*args,**kwargs)
2051 result = fn(*args,**kwargs)
2052 return result
2052 return result
2053
2053
2054 def run_cell_magic(self, magic_name, line, cell):
2054 def run_cell_magic(self, magic_name, line, cell):
2055 """Execute the given cell magic.
2055 """Execute the given cell magic.
2056
2056
2057 Parameters
2057 Parameters
2058 ----------
2058 ----------
2059 magic_name : str
2059 magic_name : str
2060 Name of the desired magic function, without '%' prefix.
2060 Name of the desired magic function, without '%' prefix.
2061
2061
2062 line : str
2062 line : str
2063 The rest of the first input line as a single string.
2063 The rest of the first input line as a single string.
2064
2064
2065 cell : str
2065 cell : str
2066 The body of the cell as a (possibly multiline) string.
2066 The body of the cell as a (possibly multiline) string.
2067 """
2067 """
2068 fn = self.find_cell_magic(magic_name)
2068 fn = self.find_cell_magic(magic_name)
2069 if fn is None:
2069 if fn is None:
2070 lm = self.find_line_magic(magic_name)
2070 lm = self.find_line_magic(magic_name)
2071 etpl = "Cell magic `%%{0}` not found{1}."
2071 etpl = "Cell magic `%%{0}` not found{1}."
2072 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2072 extra = '' if lm is None else (' (But line magic `%{0}` exists, '
2073 'did you mean that instead?)'.format(magic_name))
2073 'did you mean that instead?)'.format(magic_name))
2074 error(etpl.format(magic_name, extra))
2074 error(etpl.format(magic_name, extra))
2075 elif cell == '':
2075 elif cell == '':
2076 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2076 message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name)
2077 if self.find_line_magic(magic_name) is not None:
2077 if self.find_line_magic(magic_name) is not None:
2078 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2078 message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name)
2079 raise UsageError(message)
2079 raise UsageError(message)
2080 else:
2080 else:
2081 # Note: this is the distance in the stack to the user's frame.
2081 # Note: this is the distance in the stack to the user's frame.
2082 # This will need to be updated if the internal calling logic gets
2082 # This will need to be updated if the internal calling logic gets
2083 # refactored, or else we'll be expanding the wrong variables.
2083 # refactored, or else we'll be expanding the wrong variables.
2084 stack_depth = 2
2084 stack_depth = 2
2085 magic_arg_s = self.var_expand(line, stack_depth)
2085 magic_arg_s = self.var_expand(line, stack_depth)
2086 with self.builtin_trap:
2086 with self.builtin_trap:
2087 result = fn(magic_arg_s, cell)
2087 result = fn(magic_arg_s, cell)
2088 return result
2088 return result
2089
2089
2090 def find_line_magic(self, magic_name):
2090 def find_line_magic(self, magic_name):
2091 """Find and return a line magic by name.
2091 """Find and return a line magic by name.
2092
2092
2093 Returns None if the magic isn't found."""
2093 Returns None if the magic isn't found."""
2094 return self.magics_manager.magics['line'].get(magic_name)
2094 return self.magics_manager.magics['line'].get(magic_name)
2095
2095
2096 def find_cell_magic(self, magic_name):
2096 def find_cell_magic(self, magic_name):
2097 """Find and return a cell magic by name.
2097 """Find and return a cell magic by name.
2098
2098
2099 Returns None if the magic isn't found."""
2099 Returns None if the magic isn't found."""
2100 return self.magics_manager.magics['cell'].get(magic_name)
2100 return self.magics_manager.magics['cell'].get(magic_name)
2101
2101
2102 def find_magic(self, magic_name, magic_kind='line'):
2102 def find_magic(self, magic_name, magic_kind='line'):
2103 """Find and return a magic of the given type by name.
2103 """Find and return a magic of the given type by name.
2104
2104
2105 Returns None if the magic isn't found."""
2105 Returns None if the magic isn't found."""
2106 return self.magics_manager.magics[magic_kind].get(magic_name)
2106 return self.magics_manager.magics[magic_kind].get(magic_name)
2107
2107
2108 def magic(self, arg_s):
2108 def magic(self, arg_s):
2109 """DEPRECATED. Use run_line_magic() instead.
2109 """DEPRECATED. Use run_line_magic() instead.
2110
2110
2111 Call a magic function by name.
2111 Call a magic function by name.
2112
2112
2113 Input: a string containing the name of the magic function to call and
2113 Input: a string containing the name of the magic function to call and
2114 any additional arguments to be passed to the magic.
2114 any additional arguments to be passed to the magic.
2115
2115
2116 magic('name -opt foo bar') is equivalent to typing at the ipython
2116 magic('name -opt foo bar') is equivalent to typing at the ipython
2117 prompt:
2117 prompt:
2118
2118
2119 In[1]: %name -opt foo bar
2119 In[1]: %name -opt foo bar
2120
2120
2121 To call a magic without arguments, simply use magic('name').
2121 To call a magic without arguments, simply use magic('name').
2122
2122
2123 This provides a proper Python function to call IPython's magics in any
2123 This provides a proper Python function to call IPython's magics in any
2124 valid Python code you can type at the interpreter, including loops and
2124 valid Python code you can type at the interpreter, including loops and
2125 compound statements.
2125 compound statements.
2126 """
2126 """
2127 # TODO: should we issue a loud deprecation warning here?
2127 # TODO: should we issue a loud deprecation warning here?
2128 magic_name, _, magic_arg_s = arg_s.partition(' ')
2128 magic_name, _, magic_arg_s = arg_s.partition(' ')
2129 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2129 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
2130 return self.run_line_magic(magic_name, magic_arg_s)
2130 return self.run_line_magic(magic_name, magic_arg_s)
2131
2131
2132 #-------------------------------------------------------------------------
2132 #-------------------------------------------------------------------------
2133 # Things related to macros
2133 # Things related to macros
2134 #-------------------------------------------------------------------------
2134 #-------------------------------------------------------------------------
2135
2135
2136 def define_macro(self, name, themacro):
2136 def define_macro(self, name, themacro):
2137 """Define a new macro
2137 """Define a new macro
2138
2138
2139 Parameters
2139 Parameters
2140 ----------
2140 ----------
2141 name : str
2141 name : str
2142 The name of the macro.
2142 The name of the macro.
2143 themacro : str or Macro
2143 themacro : str or Macro
2144 The action to do upon invoking the macro. If a string, a new
2144 The action to do upon invoking the macro. If a string, a new
2145 Macro object is created by passing the string to it.
2145 Macro object is created by passing the string to it.
2146 """
2146 """
2147
2147
2148 from IPython.core import macro
2148 from IPython.core import macro
2149
2149
2150 if isinstance(themacro, str):
2150 if isinstance(themacro, str):
2151 themacro = macro.Macro(themacro)
2151 themacro = macro.Macro(themacro)
2152 if not isinstance(themacro, macro.Macro):
2152 if not isinstance(themacro, macro.Macro):
2153 raise ValueError('A macro must be a string or a Macro instance.')
2153 raise ValueError('A macro must be a string or a Macro instance.')
2154 self.user_ns[name] = themacro
2154 self.user_ns[name] = themacro
2155
2155
2156 #-------------------------------------------------------------------------
2156 #-------------------------------------------------------------------------
2157 # Things related to the running of system commands
2157 # Things related to the running of system commands
2158 #-------------------------------------------------------------------------
2158 #-------------------------------------------------------------------------
2159
2159
2160 def system_piped(self, cmd):
2160 def system_piped(self, cmd):
2161 """Call the given cmd in a subprocess, piping stdout/err
2161 """Call the given cmd in a subprocess, piping stdout/err
2162
2162
2163 Parameters
2163 Parameters
2164 ----------
2164 ----------
2165 cmd : str
2165 cmd : str
2166 Command to execute (can not end in '&', as background processes are
2166 Command to execute (can not end in '&', as background processes are
2167 not supported. Should not be a command that expects input
2167 not supported. Should not be a command that expects input
2168 other than simple text.
2168 other than simple text.
2169 """
2169 """
2170 if cmd.rstrip().endswith('&'):
2170 if cmd.rstrip().endswith('&'):
2171 # this is *far* from a rigorous test
2171 # this is *far* from a rigorous test
2172 # We do not support backgrounding processes because we either use
2172 # We do not support backgrounding processes because we either use
2173 # pexpect or pipes to read from. Users can always just call
2173 # pexpect or pipes to read from. Users can always just call
2174 # os.system() or use ip.system=ip.system_raw
2174 # os.system() or use ip.system=ip.system_raw
2175 # if they really want a background process.
2175 # if they really want a background process.
2176 raise OSError("Background processes not supported.")
2176 raise OSError("Background processes not supported.")
2177
2177
2178 # we explicitly do NOT return the subprocess status code, because
2178 # we explicitly do NOT return the subprocess status code, because
2179 # a non-None value would trigger :func:`sys.displayhook` calls.
2179 # a non-None value would trigger :func:`sys.displayhook` calls.
2180 # Instead, we store the exit_code in user_ns.
2180 # Instead, we store the exit_code in user_ns.
2181 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2181 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1))
2182
2182
2183 def system_raw(self, cmd):
2183 def system_raw(self, cmd):
2184 """Call the given cmd in a subprocess using os.system on Windows or
2184 """Call the given cmd in a subprocess using os.system on Windows or
2185 subprocess.call using the system shell on other platforms.
2185 subprocess.call using the system shell on other platforms.
2186
2186
2187 Parameters
2187 Parameters
2188 ----------
2188 ----------
2189 cmd : str
2189 cmd : str
2190 Command to execute.
2190 Command to execute.
2191 """
2191 """
2192 cmd = self.var_expand(cmd, depth=1)
2192 cmd = self.var_expand(cmd, depth=1)
2193 # protect os.system from UNC paths on Windows, which it can't handle:
2193 # protect os.system from UNC paths on Windows, which it can't handle:
2194 if sys.platform == 'win32':
2194 if sys.platform == 'win32':
2195 from IPython.utils._process_win32 import AvoidUNCPath
2195 from IPython.utils._process_win32 import AvoidUNCPath
2196 with AvoidUNCPath() as path:
2196 with AvoidUNCPath() as path:
2197 if path is not None:
2197 if path is not None:
2198 cmd = '"pushd %s &&"%s' % (path, cmd)
2198 cmd = '"pushd %s &&"%s' % (path, cmd)
2199 try:
2199 try:
2200 ec = os.system(cmd)
2200 ec = os.system(cmd)
2201 except KeyboardInterrupt:
2201 except KeyboardInterrupt:
2202 print('\n' + self.get_exception_only(), file=sys.stderr)
2202 print('\n' + self.get_exception_only(), file=sys.stderr)
2203 ec = -2
2203 ec = -2
2204 else:
2204 else:
2205 # For posix the result of the subprocess.call() below is an exit
2205 # For posix the result of the subprocess.call() below is an exit
2206 # code, which by convention is zero for success, positive for
2206 # code, which by convention is zero for success, positive for
2207 # program failure. Exit codes above 128 are reserved for signals,
2207 # program failure. Exit codes above 128 are reserved for signals,
2208 # and the formula for converting a signal to an exit code is usually
2208 # and the formula for converting a signal to an exit code is usually
2209 # signal_number+128. To more easily differentiate between exit
2209 # signal_number+128. To more easily differentiate between exit
2210 # codes and signals, ipython uses negative numbers. For instance
2210 # codes and signals, ipython uses negative numbers. For instance
2211 # since control-c is signal 2 but exit code 130, ipython's
2211 # since control-c is signal 2 but exit code 130, ipython's
2212 # _exit_code variable will read -2. Note that some shells like
2212 # _exit_code variable will read -2. Note that some shells like
2213 # csh and fish don't follow sh/bash conventions for exit codes.
2213 # csh and fish don't follow sh/bash conventions for exit codes.
2214 executable = os.environ.get('SHELL', None)
2214 executable = os.environ.get('SHELL', None)
2215 try:
2215 try:
2216 # Use env shell instead of default /bin/sh
2216 # Use env shell instead of default /bin/sh
2217 ec = subprocess.call(cmd, shell=True, executable=executable)
2217 ec = subprocess.call(cmd, shell=True, executable=executable)
2218 except KeyboardInterrupt:
2218 except KeyboardInterrupt:
2219 # intercept control-C; a long traceback is not useful here
2219 # intercept control-C; a long traceback is not useful here
2220 print('\n' + self.get_exception_only(), file=sys.stderr)
2220 print('\n' + self.get_exception_only(), file=sys.stderr)
2221 ec = 130
2221 ec = 130
2222 if ec > 128:
2222 if ec > 128:
2223 ec = -(ec - 128)
2223 ec = -(ec - 128)
2224
2224
2225 # We explicitly do NOT return the subprocess status code, because
2225 # We explicitly do NOT return the subprocess status code, because
2226 # a non-None value would trigger :func:`sys.displayhook` calls.
2226 # a non-None value would trigger :func:`sys.displayhook` calls.
2227 # Instead, we store the exit_code in user_ns. Note the semantics
2227 # Instead, we store the exit_code in user_ns. Note the semantics
2228 # of _exit_code: for control-c, _exit_code == -signal.SIGNIT,
2228 # of _exit_code: for control-c, _exit_code == -signal.SIGNIT,
2229 # but raising SystemExit(_exit_code) will give status 254!
2229 # but raising SystemExit(_exit_code) will give status 254!
2230 self.user_ns['_exit_code'] = ec
2230 self.user_ns['_exit_code'] = ec
2231
2231
2232 # use piped system by default, because it is better behaved
2232 # use piped system by default, because it is better behaved
2233 system = system_piped
2233 system = system_piped
2234
2234
2235 def getoutput(self, cmd, split=True, depth=0):
2235 def getoutput(self, cmd, split=True, depth=0):
2236 """Get output (possibly including stderr) from a subprocess.
2236 """Get output (possibly including stderr) from a subprocess.
2237
2237
2238 Parameters
2238 Parameters
2239 ----------
2239 ----------
2240 cmd : str
2240 cmd : str
2241 Command to execute (can not end in '&', as background processes are
2241 Command to execute (can not end in '&', as background processes are
2242 not supported.
2242 not supported.
2243 split : bool, optional
2243 split : bool, optional
2244 If True, split the output into an IPython SList. Otherwise, an
2244 If True, split the output into an IPython SList. Otherwise, an
2245 IPython LSString is returned. These are objects similar to normal
2245 IPython LSString is returned. These are objects similar to normal
2246 lists and strings, with a few convenience attributes for easier
2246 lists and strings, with a few convenience attributes for easier
2247 manipulation of line-based output. You can use '?' on them for
2247 manipulation of line-based output. You can use '?' on them for
2248 details.
2248 details.
2249 depth : int, optional
2249 depth : int, optional
2250 How many frames above the caller are the local variables which should
2250 How many frames above the caller are the local variables which should
2251 be expanded in the command string? The default (0) assumes that the
2251 be expanded in the command string? The default (0) assumes that the
2252 expansion variables are in the stack frame calling this function.
2252 expansion variables are in the stack frame calling this function.
2253 """
2253 """
2254 if cmd.rstrip().endswith('&'):
2254 if cmd.rstrip().endswith('&'):
2255 # this is *far* from a rigorous test
2255 # this is *far* from a rigorous test
2256 raise OSError("Background processes not supported.")
2256 raise OSError("Background processes not supported.")
2257 out = getoutput(self.var_expand(cmd, depth=depth+1))
2257 out = getoutput(self.var_expand(cmd, depth=depth+1))
2258 if split:
2258 if split:
2259 out = SList(out.splitlines())
2259 out = SList(out.splitlines())
2260 else:
2260 else:
2261 out = LSString(out)
2261 out = LSString(out)
2262 return out
2262 return out
2263
2263
2264 #-------------------------------------------------------------------------
2264 #-------------------------------------------------------------------------
2265 # Things related to aliases
2265 # Things related to aliases
2266 #-------------------------------------------------------------------------
2266 #-------------------------------------------------------------------------
2267
2267
2268 def init_alias(self):
2268 def init_alias(self):
2269 self.alias_manager = AliasManager(shell=self, parent=self)
2269 self.alias_manager = AliasManager(shell=self, parent=self)
2270 self.configurables.append(self.alias_manager)
2270 self.configurables.append(self.alias_manager)
2271
2271
2272 #-------------------------------------------------------------------------
2272 #-------------------------------------------------------------------------
2273 # Things related to extensions
2273 # Things related to extensions
2274 #-------------------------------------------------------------------------
2274 #-------------------------------------------------------------------------
2275
2275
2276 def init_extension_manager(self):
2276 def init_extension_manager(self):
2277 self.extension_manager = ExtensionManager(shell=self, parent=self)
2277 self.extension_manager = ExtensionManager(shell=self, parent=self)
2278 self.configurables.append(self.extension_manager)
2278 self.configurables.append(self.extension_manager)
2279
2279
2280 #-------------------------------------------------------------------------
2280 #-------------------------------------------------------------------------
2281 # Things related to payloads
2281 # Things related to payloads
2282 #-------------------------------------------------------------------------
2282 #-------------------------------------------------------------------------
2283
2283
2284 def init_payload(self):
2284 def init_payload(self):
2285 self.payload_manager = PayloadManager(parent=self)
2285 self.payload_manager = PayloadManager(parent=self)
2286 self.configurables.append(self.payload_manager)
2286 self.configurables.append(self.payload_manager)
2287
2287
2288 #-------------------------------------------------------------------------
2288 #-------------------------------------------------------------------------
2289 # Things related to the prefilter
2289 # Things related to the prefilter
2290 #-------------------------------------------------------------------------
2290 #-------------------------------------------------------------------------
2291
2291
2292 def init_prefilter(self):
2292 def init_prefilter(self):
2293 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2293 self.prefilter_manager = PrefilterManager(shell=self, parent=self)
2294 self.configurables.append(self.prefilter_manager)
2294 self.configurables.append(self.prefilter_manager)
2295 # Ultimately this will be refactored in the new interpreter code, but
2295 # Ultimately this will be refactored in the new interpreter code, but
2296 # for now, we should expose the main prefilter method (there's legacy
2296 # for now, we should expose the main prefilter method (there's legacy
2297 # code out there that may rely on this).
2297 # code out there that may rely on this).
2298 self.prefilter = self.prefilter_manager.prefilter_lines
2298 self.prefilter = self.prefilter_manager.prefilter_lines
2299
2299
2300 def auto_rewrite_input(self, cmd):
2300 def auto_rewrite_input(self, cmd):
2301 """Print to the screen the rewritten form of the user's command.
2301 """Print to the screen the rewritten form of the user's command.
2302
2302
2303 This shows visual feedback by rewriting input lines that cause
2303 This shows visual feedback by rewriting input lines that cause
2304 automatic calling to kick in, like::
2304 automatic calling to kick in, like::
2305
2305
2306 /f x
2306 /f x
2307
2307
2308 into::
2308 into::
2309
2309
2310 ------> f(x)
2310 ------> f(x)
2311
2311
2312 after the user's input prompt. This helps the user understand that the
2312 after the user's input prompt. This helps the user understand that the
2313 input line was transformed automatically by IPython.
2313 input line was transformed automatically by IPython.
2314 """
2314 """
2315 if not self.show_rewritten_input:
2315 if not self.show_rewritten_input:
2316 return
2316 return
2317
2317
2318 # This is overridden in TerminalInteractiveShell to use fancy prompts
2318 # This is overridden in TerminalInteractiveShell to use fancy prompts
2319 print("------> " + cmd)
2319 print("------> " + cmd)
2320
2320
2321 #-------------------------------------------------------------------------
2321 #-------------------------------------------------------------------------
2322 # Things related to extracting values/expressions from kernel and user_ns
2322 # Things related to extracting values/expressions from kernel and user_ns
2323 #-------------------------------------------------------------------------
2323 #-------------------------------------------------------------------------
2324
2324
2325 def _user_obj_error(self):
2325 def _user_obj_error(self):
2326 """return simple exception dict
2326 """return simple exception dict
2327
2327
2328 for use in user_expressions
2328 for use in user_expressions
2329 """
2329 """
2330
2330
2331 etype, evalue, tb = self._get_exc_info()
2331 etype, evalue, tb = self._get_exc_info()
2332 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2332 stb = self.InteractiveTB.get_exception_only(etype, evalue)
2333
2333
2334 exc_info = {
2334 exc_info = {
2335 u'status' : 'error',
2335 u'status' : 'error',
2336 u'traceback' : stb,
2336 u'traceback' : stb,
2337 u'ename' : etype.__name__,
2337 u'ename' : etype.__name__,
2338 u'evalue' : py3compat.safe_unicode(evalue),
2338 u'evalue' : py3compat.safe_unicode(evalue),
2339 }
2339 }
2340
2340
2341 return exc_info
2341 return exc_info
2342
2342
2343 def _format_user_obj(self, obj):
2343 def _format_user_obj(self, obj):
2344 """format a user object to display dict
2344 """format a user object to display dict
2345
2345
2346 for use in user_expressions
2346 for use in user_expressions
2347 """
2347 """
2348
2348
2349 data, md = self.display_formatter.format(obj)
2349 data, md = self.display_formatter.format(obj)
2350 value = {
2350 value = {
2351 'status' : 'ok',
2351 'status' : 'ok',
2352 'data' : data,
2352 'data' : data,
2353 'metadata' : md,
2353 'metadata' : md,
2354 }
2354 }
2355 return value
2355 return value
2356
2356
2357 def user_expressions(self, expressions):
2357 def user_expressions(self, expressions):
2358 """Evaluate a dict of expressions in the user's namespace.
2358 """Evaluate a dict of expressions in the user's namespace.
2359
2359
2360 Parameters
2360 Parameters
2361 ----------
2361 ----------
2362 expressions : dict
2362 expressions : dict
2363 A dict with string keys and string values. The expression values
2363 A dict with string keys and string values. The expression values
2364 should be valid Python expressions, each of which will be evaluated
2364 should be valid Python expressions, each of which will be evaluated
2365 in the user namespace.
2365 in the user namespace.
2366
2366
2367 Returns
2367 Returns
2368 -------
2368 -------
2369 A dict, keyed like the input expressions dict, with the rich mime-typed
2369 A dict, keyed like the input expressions dict, with the rich mime-typed
2370 display_data of each value.
2370 display_data of each value.
2371 """
2371 """
2372 out = {}
2372 out = {}
2373 user_ns = self.user_ns
2373 user_ns = self.user_ns
2374 global_ns = self.user_global_ns
2374 global_ns = self.user_global_ns
2375
2375
2376 for key, expr in expressions.items():
2376 for key, expr in expressions.items():
2377 try:
2377 try:
2378 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2378 value = self._format_user_obj(eval(expr, global_ns, user_ns))
2379 except:
2379 except:
2380 value = self._user_obj_error()
2380 value = self._user_obj_error()
2381 out[key] = value
2381 out[key] = value
2382 return out
2382 return out
2383
2383
2384 #-------------------------------------------------------------------------
2384 #-------------------------------------------------------------------------
2385 # Things related to the running of code
2385 # Things related to the running of code
2386 #-------------------------------------------------------------------------
2386 #-------------------------------------------------------------------------
2387
2387
2388 def ex(self, cmd):
2388 def ex(self, cmd):
2389 """Execute a normal python statement in user namespace."""
2389 """Execute a normal python statement in user namespace."""
2390 with self.builtin_trap:
2390 with self.builtin_trap:
2391 exec(cmd, self.user_global_ns, self.user_ns)
2391 exec(cmd, self.user_global_ns, self.user_ns)
2392
2392
2393 def ev(self, expr):
2393 def ev(self, expr):
2394 """Evaluate python expression expr in user namespace.
2394 """Evaluate python expression expr in user namespace.
2395
2395
2396 Returns the result of evaluation
2396 Returns the result of evaluation
2397 """
2397 """
2398 with self.builtin_trap:
2398 with self.builtin_trap:
2399 return eval(expr, self.user_global_ns, self.user_ns)
2399 return eval(expr, self.user_global_ns, self.user_ns)
2400
2400
2401 def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False):
2401 def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False):
2402 """A safe version of the builtin execfile().
2402 """A safe version of the builtin execfile().
2403
2403
2404 This version will never throw an exception, but instead print
2404 This version will never throw an exception, but instead print
2405 helpful error messages to the screen. This only works on pure
2405 helpful error messages to the screen. This only works on pure
2406 Python files with the .py extension.
2406 Python files with the .py extension.
2407
2407
2408 Parameters
2408 Parameters
2409 ----------
2409 ----------
2410 fname : string
2410 fname : string
2411 The name of the file to be executed.
2411 The name of the file to be executed.
2412 where : tuple
2412 where : tuple
2413 One or two namespaces, passed to execfile() as (globals,locals).
2413 One or two namespaces, passed to execfile() as (globals,locals).
2414 If only one is given, it is passed as both.
2414 If only one is given, it is passed as both.
2415 exit_ignore : bool (False)
2415 exit_ignore : bool (False)
2416 If True, then silence SystemExit for non-zero status (it is always
2416 If True, then silence SystemExit for non-zero status (it is always
2417 silenced for zero status, as it is so common).
2417 silenced for zero status, as it is so common).
2418 raise_exceptions : bool (False)
2418 raise_exceptions : bool (False)
2419 If True raise exceptions everywhere. Meant for testing.
2419 If True raise exceptions everywhere. Meant for testing.
2420 shell_futures : bool (False)
2420 shell_futures : bool (False)
2421 If True, the code will share future statements with the interactive
2421 If True, the code will share future statements with the interactive
2422 shell. It will both be affected by previous __future__ imports, and
2422 shell. It will both be affected by previous __future__ imports, and
2423 any __future__ imports in the code will affect the shell. If False,
2423 any __future__ imports in the code will affect the shell. If False,
2424 __future__ imports are not shared in either direction.
2424 __future__ imports are not shared in either direction.
2425
2425
2426 """
2426 """
2427 fname = os.path.abspath(os.path.expanduser(fname))
2427 fname = os.path.abspath(os.path.expanduser(fname))
2428
2428
2429 # Make sure we can open the file
2429 # Make sure we can open the file
2430 try:
2430 try:
2431 with open(fname):
2431 with open(fname):
2432 pass
2432 pass
2433 except:
2433 except:
2434 warn('Could not open file <%s> for safe execution.' % fname)
2434 warn('Could not open file <%s> for safe execution.' % fname)
2435 return
2435 return
2436
2436
2437 # Find things also in current directory. This is needed to mimic the
2437 # Find things also in current directory. This is needed to mimic the
2438 # behavior of running a script from the system command line, where
2438 # behavior of running a script from the system command line, where
2439 # Python inserts the script's directory into sys.path
2439 # Python inserts the script's directory into sys.path
2440 dname = os.path.dirname(fname)
2440 dname = os.path.dirname(fname)
2441
2441
2442 with prepended_to_syspath(dname), self.builtin_trap:
2442 with prepended_to_syspath(dname), self.builtin_trap:
2443 try:
2443 try:
2444 glob, loc = (where + (None, ))[:2]
2444 glob, loc = (where + (None, ))[:2]
2445 py3compat.execfile(
2445 py3compat.execfile(
2446 fname, glob, loc,
2446 fname, glob, loc,
2447 self.compile if shell_futures else None)
2447 self.compile if shell_futures else None)
2448 except SystemExit as status:
2448 except SystemExit as status:
2449 # If the call was made with 0 or None exit status (sys.exit(0)
2449 # If the call was made with 0 or None exit status (sys.exit(0)
2450 # or sys.exit() ), don't bother showing a traceback, as both of
2450 # or sys.exit() ), don't bother showing a traceback, as both of
2451 # these are considered normal by the OS:
2451 # these are considered normal by the OS:
2452 # > python -c'import sys;sys.exit(0)'; echo $?
2452 # > python -c'import sys;sys.exit(0)'; echo $?
2453 # 0
2453 # 0
2454 # > python -c'import sys;sys.exit()'; echo $?
2454 # > python -c'import sys;sys.exit()'; echo $?
2455 # 0
2455 # 0
2456 # For other exit status, we show the exception unless
2456 # For other exit status, we show the exception unless
2457 # explicitly silenced, but only in short form.
2457 # explicitly silenced, but only in short form.
2458 if status.code:
2458 if status.code:
2459 if raise_exceptions:
2459 if raise_exceptions:
2460 raise
2460 raise
2461 if not exit_ignore:
2461 if not exit_ignore:
2462 self.showtraceback(exception_only=True)
2462 self.showtraceback(exception_only=True)
2463 except:
2463 except:
2464 if raise_exceptions:
2464 if raise_exceptions:
2465 raise
2465 raise
2466 # tb offset is 2 because we wrap execfile
2466 # tb offset is 2 because we wrap execfile
2467 self.showtraceback(tb_offset=2)
2467 self.showtraceback(tb_offset=2)
2468
2468
2469 def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False):
2469 def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False):
2470 """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
2470 """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
2471
2471
2472 Parameters
2472 Parameters
2473 ----------
2473 ----------
2474 fname : str
2474 fname : str
2475 The name of the file to execute. The filename must have a
2475 The name of the file to execute. The filename must have a
2476 .ipy or .ipynb extension.
2476 .ipy or .ipynb extension.
2477 shell_futures : bool (False)
2477 shell_futures : bool (False)
2478 If True, the code will share future statements with the interactive
2478 If True, the code will share future statements with the interactive
2479 shell. It will both be affected by previous __future__ imports, and
2479 shell. It will both be affected by previous __future__ imports, and
2480 any __future__ imports in the code will affect the shell. If False,
2480 any __future__ imports in the code will affect the shell. If False,
2481 __future__ imports are not shared in either direction.
2481 __future__ imports are not shared in either direction.
2482 raise_exceptions : bool (False)
2482 raise_exceptions : bool (False)
2483 If True raise exceptions everywhere. Meant for testing.
2483 If True raise exceptions everywhere. Meant for testing.
2484 """
2484 """
2485 fname = os.path.abspath(os.path.expanduser(fname))
2485 fname = os.path.abspath(os.path.expanduser(fname))
2486
2486
2487 # Make sure we can open the file
2487 # Make sure we can open the file
2488 try:
2488 try:
2489 with open(fname):
2489 with open(fname):
2490 pass
2490 pass
2491 except:
2491 except:
2492 warn('Could not open file <%s> for safe execution.' % fname)
2492 warn('Could not open file <%s> for safe execution.' % fname)
2493 return
2493 return
2494
2494
2495 # Find things also in current directory. This is needed to mimic the
2495 # Find things also in current directory. This is needed to mimic the
2496 # behavior of running a script from the system command line, where
2496 # behavior of running a script from the system command line, where
2497 # Python inserts the script's directory into sys.path
2497 # Python inserts the script's directory into sys.path
2498 dname = os.path.dirname(fname)
2498 dname = os.path.dirname(fname)
2499
2499
2500 def get_cells():
2500 def get_cells():
2501 """generator for sequence of code blocks to run"""
2501 """generator for sequence of code blocks to run"""
2502 if fname.endswith('.ipynb'):
2502 if fname.endswith('.ipynb'):
2503 from nbformat import read
2503 from nbformat import read
2504 with io_open(fname) as f:
2504 with io_open(fname) as f:
2505 nb = read(f, as_version=4)
2505 nb = read(f, as_version=4)
2506 if not nb.cells:
2506 if not nb.cells:
2507 return
2507 return
2508 for cell in nb.cells:
2508 for cell in nb.cells:
2509 if cell.cell_type == 'code':
2509 if cell.cell_type == 'code':
2510 yield cell.source
2510 yield cell.source
2511 else:
2511 else:
2512 with open(fname) as f:
2512 with open(fname) as f:
2513 yield f.read()
2513 yield f.read()
2514
2514
2515 with prepended_to_syspath(dname):
2515 with prepended_to_syspath(dname):
2516 try:
2516 try:
2517 for cell in get_cells():
2517 for cell in get_cells():
2518 result = self.run_cell(cell, silent=True, shell_futures=shell_futures)
2518 result = self.run_cell(cell, silent=True, shell_futures=shell_futures)
2519 if raise_exceptions:
2519 if raise_exceptions:
2520 result.raise_error()
2520 result.raise_error()
2521 elif not result.success:
2521 elif not result.success:
2522 break
2522 break
2523 except:
2523 except:
2524 if raise_exceptions:
2524 if raise_exceptions:
2525 raise
2525 raise
2526 self.showtraceback()
2526 self.showtraceback()
2527 warn('Unknown failure executing file: <%s>' % fname)
2527 warn('Unknown failure executing file: <%s>' % fname)
2528
2528
2529 def safe_run_module(self, mod_name, where):
2529 def safe_run_module(self, mod_name, where):
2530 """A safe version of runpy.run_module().
2530 """A safe version of runpy.run_module().
2531
2531
2532 This version will never throw an exception, but instead print
2532 This version will never throw an exception, but instead print
2533 helpful error messages to the screen.
2533 helpful error messages to the screen.
2534
2534
2535 `SystemExit` exceptions with status code 0 or None are ignored.
2535 `SystemExit` exceptions with status code 0 or None are ignored.
2536
2536
2537 Parameters
2537 Parameters
2538 ----------
2538 ----------
2539 mod_name : string
2539 mod_name : string
2540 The name of the module to be executed.
2540 The name of the module to be executed.
2541 where : dict
2541 where : dict
2542 The globals namespace.
2542 The globals namespace.
2543 """
2543 """
2544 try:
2544 try:
2545 try:
2545 try:
2546 where.update(
2546 where.update(
2547 runpy.run_module(str(mod_name), run_name="__main__",
2547 runpy.run_module(str(mod_name), run_name="__main__",
2548 alter_sys=True)
2548 alter_sys=True)
2549 )
2549 )
2550 except SystemExit as status:
2550 except SystemExit as status:
2551 if status.code:
2551 if status.code:
2552 raise
2552 raise
2553 except:
2553 except:
2554 self.showtraceback()
2554 self.showtraceback()
2555 warn('Unknown failure executing module: <%s>' % mod_name)
2555 warn('Unknown failure executing module: <%s>' % mod_name)
2556
2556
2557 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2557 def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True):
2558 """Run a complete IPython cell.
2558 """Run a complete IPython cell.
2559
2559
2560 Parameters
2560 Parameters
2561 ----------
2561 ----------
2562 raw_cell : str
2562 raw_cell : str
2563 The code (including IPython code such as %magic functions) to run.
2563 The code (including IPython code such as %magic functions) to run.
2564 store_history : bool
2564 store_history : bool
2565 If True, the raw and translated cell will be stored in IPython's
2565 If True, the raw and translated cell will be stored in IPython's
2566 history. For user code calling back into IPython's machinery, this
2566 history. For user code calling back into IPython's machinery, this
2567 should be set to False.
2567 should be set to False.
2568 silent : bool
2568 silent : bool
2569 If True, avoid side-effects, such as implicit displayhooks and
2569 If True, avoid side-effects, such as implicit displayhooks and
2570 and logging. silent=True forces store_history=False.
2570 and logging. silent=True forces store_history=False.
2571 shell_futures : bool
2571 shell_futures : bool
2572 If True, the code will share future statements with the interactive
2572 If True, the code will share future statements with the interactive
2573 shell. It will both be affected by previous __future__ imports, and
2573 shell. It will both be affected by previous __future__ imports, and
2574 any __future__ imports in the code will affect the shell. If False,
2574 any __future__ imports in the code will affect the shell. If False,
2575 __future__ imports are not shared in either direction.
2575 __future__ imports are not shared in either direction.
2576
2576
2577 Returns
2577 Returns
2578 -------
2578 -------
2579 result : :class:`ExecutionResult`
2579 result : :class:`ExecutionResult`
2580 """
2580 """
2581 result = ExecutionResult()
2581 result = ExecutionResult()
2582
2582
2583 if (not raw_cell) or raw_cell.isspace():
2583 if (not raw_cell) or raw_cell.isspace():
2584 self.last_execution_succeeded = True
2584 self.last_execution_succeeded = True
2585 return result
2585 return result
2586
2586
2587 if silent:
2587 if silent:
2588 store_history = False
2588 store_history = False
2589
2589
2590 if store_history:
2590 if store_history:
2591 result.execution_count = self.execution_count
2591 result.execution_count = self.execution_count
2592
2592
2593 def error_before_exec(value):
2593 def error_before_exec(value):
2594 result.error_before_exec = value
2594 result.error_before_exec = value
2595 self.last_execution_succeeded = False
2595 self.last_execution_succeeded = False
2596 return result
2596 return result
2597
2597
2598 self.events.trigger('pre_execute')
2598 self.events.trigger('pre_execute')
2599 if not silent:
2599 if not silent:
2600 self.events.trigger('pre_run_cell')
2600 self.events.trigger('pre_run_cell')
2601
2601
2602 # If any of our input transformation (input_transformer_manager or
2602 # If any of our input transformation (input_transformer_manager or
2603 # prefilter_manager) raises an exception, we store it in this variable
2603 # prefilter_manager) raises an exception, we store it in this variable
2604 # so that we can display the error after logging the input and storing
2604 # so that we can display the error after logging the input and storing
2605 # it in the history.
2605 # it in the history.
2606 preprocessing_exc_tuple = None
2606 preprocessing_exc_tuple = None
2607 try:
2607 try:
2608 # Static input transformations
2608 # Static input transformations
2609 cell = self.input_transformer_manager.transform_cell(raw_cell)
2609 cell = self.input_transformer_manager.transform_cell(raw_cell)
2610 except SyntaxError:
2610 except SyntaxError:
2611 preprocessing_exc_tuple = sys.exc_info()
2611 preprocessing_exc_tuple = sys.exc_info()
2612 cell = raw_cell # cell has to exist so it can be stored/logged
2612 cell = raw_cell # cell has to exist so it can be stored/logged
2613 else:
2613 else:
2614 if len(cell.splitlines()) == 1:
2614 if len(cell.splitlines()) == 1:
2615 # Dynamic transformations - only applied for single line commands
2615 # Dynamic transformations - only applied for single line commands
2616 with self.builtin_trap:
2616 with self.builtin_trap:
2617 try:
2617 try:
2618 # use prefilter_lines to handle trailing newlines
2618 # use prefilter_lines to handle trailing newlines
2619 # restore trailing newline for ast.parse
2619 # restore trailing newline for ast.parse
2620 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2620 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2621 except Exception:
2621 except Exception:
2622 # don't allow prefilter errors to crash IPython
2622 # don't allow prefilter errors to crash IPython
2623 preprocessing_exc_tuple = sys.exc_info()
2623 preprocessing_exc_tuple = sys.exc_info()
2624
2624
2625 # Store raw and processed history
2625 # Store raw and processed history
2626 if store_history:
2626 if store_history:
2627 self.history_manager.store_inputs(self.execution_count,
2627 self.history_manager.store_inputs(self.execution_count,
2628 cell, raw_cell)
2628 cell, raw_cell)
2629 if not silent:
2629 if not silent:
2630 self.logger.log(cell, raw_cell)
2630 self.logger.log(cell, raw_cell)
2631
2631
2632 # Display the exception if input processing failed.
2632 # Display the exception if input processing failed.
2633 if preprocessing_exc_tuple is not None:
2633 if preprocessing_exc_tuple is not None:
2634 self.showtraceback(preprocessing_exc_tuple)
2634 self.showtraceback(preprocessing_exc_tuple)
2635 if store_history:
2635 if store_history:
2636 self.execution_count += 1
2636 self.execution_count += 1
2637 return error_before_exec(preprocessing_exc_tuple[2])
2637 return error_before_exec(preprocessing_exc_tuple[2])
2638
2638
2639 # Our own compiler remembers the __future__ environment. If we want to
2639 # Our own compiler remembers the __future__ environment. If we want to
2640 # run code with a separate __future__ environment, use the default
2640 # run code with a separate __future__ environment, use the default
2641 # compiler
2641 # compiler
2642 compiler = self.compile if shell_futures else CachingCompiler()
2642 compiler = self.compile if shell_futures else CachingCompiler()
2643
2643
2644 with self.builtin_trap:
2644 with self.builtin_trap:
2645 cell_name = self.compile.cache(cell, self.execution_count)
2645 cell_name = self.compile.cache(cell, self.execution_count)
2646
2646
2647 with self.display_trap:
2647 with self.display_trap:
2648 # Compile to bytecode
2648 # Compile to bytecode
2649 try:
2649 try:
2650 code_ast = compiler.ast_parse(cell, filename=cell_name)
2650 code_ast = compiler.ast_parse(cell, filename=cell_name)
2651 except self.custom_exceptions as e:
2651 except self.custom_exceptions as e:
2652 etype, value, tb = sys.exc_info()
2652 etype, value, tb = sys.exc_info()
2653 self.CustomTB(etype, value, tb)
2653 self.CustomTB(etype, value, tb)
2654 return error_before_exec(e)
2654 return error_before_exec(e)
2655 except IndentationError as e:
2655 except IndentationError as e:
2656 self.showindentationerror()
2656 self.showindentationerror()
2657 if store_history:
2657 if store_history:
2658 self.execution_count += 1
2658 self.execution_count += 1
2659 return error_before_exec(e)
2659 return error_before_exec(e)
2660 except (OverflowError, SyntaxError, ValueError, TypeError,
2660 except (OverflowError, SyntaxError, ValueError, TypeError,
2661 MemoryError) as e:
2661 MemoryError) as e:
2662 self.showsyntaxerror()
2662 self.showsyntaxerror()
2663 if store_history:
2663 if store_history:
2664 self.execution_count += 1
2664 self.execution_count += 1
2665 return error_before_exec(e)
2665 return error_before_exec(e)
2666
2666
2667 # Apply AST transformations
2667 # Apply AST transformations
2668 try:
2668 try:
2669 code_ast = self.transform_ast(code_ast)
2669 code_ast = self.transform_ast(code_ast)
2670 except InputRejected as e:
2670 except InputRejected as e:
2671 self.showtraceback()
2671 self.showtraceback()
2672 if store_history:
2672 if store_history:
2673 self.execution_count += 1
2673 self.execution_count += 1
2674 return error_before_exec(e)
2674 return error_before_exec(e)
2675
2675
2676 # Give the displayhook a reference to our ExecutionResult so it
2676 # Give the displayhook a reference to our ExecutionResult so it
2677 # can fill in the output value.
2677 # can fill in the output value.
2678 self.displayhook.exec_result = result
2678 self.displayhook.exec_result = result
2679
2679
2680 # Execute the user code
2680 # Execute the user code
2681 interactivity = "none" if silent else self.ast_node_interactivity
2681 interactivity = "none" if silent else self.ast_node_interactivity
2682 has_raised = self.run_ast_nodes(code_ast.body, cell_name,
2682 has_raised = self.run_ast_nodes(code_ast.body, cell_name,
2683 interactivity=interactivity, compiler=compiler, result=result)
2683 interactivity=interactivity, compiler=compiler, result=result)
2684
2684
2685 self.last_execution_succeeded = not has_raised
2685 self.last_execution_succeeded = not has_raised
2686
2686
2687 # Reset this so later displayed values do not modify the
2687 # Reset this so later displayed values do not modify the
2688 # ExecutionResult
2688 # ExecutionResult
2689 self.displayhook.exec_result = None
2689 self.displayhook.exec_result = None
2690
2690
2691 self.events.trigger('post_execute')
2691 self.events.trigger('post_execute')
2692 if not silent:
2692 if not silent:
2693 self.events.trigger('post_run_cell')
2693 self.events.trigger('post_run_cell')
2694
2694
2695 if store_history:
2695 if store_history:
2696 # Write output to the database. Does nothing unless
2696 # Write output to the database. Does nothing unless
2697 # history output logging is enabled.
2697 # history output logging is enabled.
2698 self.history_manager.store_output(self.execution_count)
2698 self.history_manager.store_output(self.execution_count)
2699 # Each cell is a *single* input, regardless of how many lines it has
2699 # Each cell is a *single* input, regardless of how many lines it has
2700 self.execution_count += 1
2700 self.execution_count += 1
2701
2701
2702 return result
2702 return result
2703
2703
2704 def transform_ast(self, node):
2704 def transform_ast(self, node):
2705 """Apply the AST transformations from self.ast_transformers
2705 """Apply the AST transformations from self.ast_transformers
2706
2706
2707 Parameters
2707 Parameters
2708 ----------
2708 ----------
2709 node : ast.Node
2709 node : ast.Node
2710 The root node to be transformed. Typically called with the ast.Module
2710 The root node to be transformed. Typically called with the ast.Module
2711 produced by parsing user input.
2711 produced by parsing user input.
2712
2712
2713 Returns
2713 Returns
2714 -------
2714 -------
2715 An ast.Node corresponding to the node it was called with. Note that it
2715 An ast.Node corresponding to the node it was called with. Note that it
2716 may also modify the passed object, so don't rely on references to the
2716 may also modify the passed object, so don't rely on references to the
2717 original AST.
2717 original AST.
2718 """
2718 """
2719 for transformer in self.ast_transformers:
2719 for transformer in self.ast_transformers:
2720 try:
2720 try:
2721 node = transformer.visit(node)
2721 node = transformer.visit(node)
2722 except InputRejected:
2722 except InputRejected:
2723 # User-supplied AST transformers can reject an input by raising
2723 # User-supplied AST transformers can reject an input by raising
2724 # an InputRejected. Short-circuit in this case so that we
2724 # an InputRejected. Short-circuit in this case so that we
2725 # don't unregister the transform.
2725 # don't unregister the transform.
2726 raise
2726 raise
2727 except Exception:
2727 except Exception:
2728 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2728 warn("AST transformer %r threw an error. It will be unregistered." % transformer)
2729 self.ast_transformers.remove(transformer)
2729 self.ast_transformers.remove(transformer)
2730
2730
2731 if self.ast_transformers:
2731 if self.ast_transformers:
2732 ast.fix_missing_locations(node)
2732 ast.fix_missing_locations(node)
2733 return node
2733 return node
2734
2734
2735
2735
2736 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2736 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr',
2737 compiler=compile, result=None):
2737 compiler=compile, result=None):
2738 """Run a sequence of AST nodes. The execution mode depends on the
2738 """Run a sequence of AST nodes. The execution mode depends on the
2739 interactivity parameter.
2739 interactivity parameter.
2740
2740
2741 Parameters
2741 Parameters
2742 ----------
2742 ----------
2743 nodelist : list
2743 nodelist : list
2744 A sequence of AST nodes to run.
2744 A sequence of AST nodes to run.
2745 cell_name : str
2745 cell_name : str
2746 Will be passed to the compiler as the filename of the cell. Typically
2746 Will be passed to the compiler as the filename of the cell. Typically
2747 the value returned by ip.compile.cache(cell).
2747 the value returned by ip.compile.cache(cell).
2748 interactivity : str
2748 interactivity : str
2749 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2749 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2750 run interactively (displaying output from expressions). 'last_expr'
2750 run interactively (displaying output from expressions). 'last_expr'
2751 will run the last node interactively only if it is an expression (i.e.
2751 will run the last node interactively only if it is an expression (i.e.
2752 expressions in loops or other blocks are not displayed. Other values
2752 expressions in loops or other blocks are not displayed. Other values
2753 for this parameter will raise a ValueError.
2753 for this parameter will raise a ValueError.
2754 compiler : callable
2754 compiler : callable
2755 A function with the same interface as the built-in compile(), to turn
2755 A function with the same interface as the built-in compile(), to turn
2756 the AST nodes into code objects. Default is the built-in compile().
2756 the AST nodes into code objects. Default is the built-in compile().
2757 result : ExecutionResult, optional
2757 result : ExecutionResult, optional
2758 An object to store exceptions that occur during execution.
2758 An object to store exceptions that occur during execution.
2759
2759
2760 Returns
2760 Returns
2761 -------
2761 -------
2762 True if an exception occurred while running code, False if it finished
2762 True if an exception occurred while running code, False if it finished
2763 running.
2763 running.
2764 """
2764 """
2765 if not nodelist:
2765 if not nodelist:
2766 return
2766 return
2767
2767
2768 if interactivity == 'last_expr':
2768 if interactivity == 'last_expr':
2769 if isinstance(nodelist[-1], ast.Expr):
2769 if isinstance(nodelist[-1], ast.Expr):
2770 interactivity = "last"
2770 interactivity = "last"
2771 else:
2771 else:
2772 interactivity = "none"
2772 interactivity = "none"
2773
2773
2774 if interactivity == 'none':
2774 if interactivity == 'none':
2775 to_run_exec, to_run_interactive = nodelist, []
2775 to_run_exec, to_run_interactive = nodelist, []
2776 elif interactivity == 'last':
2776 elif interactivity == 'last':
2777 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2777 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2778 elif interactivity == 'all':
2778 elif interactivity == 'all':
2779 to_run_exec, to_run_interactive = [], nodelist
2779 to_run_exec, to_run_interactive = [], nodelist
2780 else:
2780 else:
2781 raise ValueError("Interactivity was %r" % interactivity)
2781 raise ValueError("Interactivity was %r" % interactivity)
2782
2782
2783 try:
2783 try:
2784 for i, node in enumerate(to_run_exec):
2784 for i, node in enumerate(to_run_exec):
2785 mod = ast.Module([node])
2785 mod = ast.Module([node])
2786 code = compiler(mod, cell_name, "exec")
2786 code = compiler(mod, cell_name, "exec")
2787 if self.run_code(code, result):
2787 if self.run_code(code, result):
2788 return True
2788 return True
2789
2789
2790 for i, node in enumerate(to_run_interactive):
2790 for i, node in enumerate(to_run_interactive):
2791 mod = ast.Interactive([node])
2791 mod = ast.Interactive([node])
2792 code = compiler(mod, cell_name, "single")
2792 code = compiler(mod, cell_name, "single")
2793 if self.run_code(code, result):
2793 if self.run_code(code, result):
2794 return True
2794 return True
2795
2795
2796 # Flush softspace
2796 # Flush softspace
2797 if softspace(sys.stdout, 0):
2797 if softspace(sys.stdout, 0):
2798 print()
2798 print()
2799
2799
2800 except:
2800 except:
2801 # It's possible to have exceptions raised here, typically by
2801 # It's possible to have exceptions raised here, typically by
2802 # compilation of odd code (such as a naked 'return' outside a
2802 # compilation of odd code (such as a naked 'return' outside a
2803 # function) that did parse but isn't valid. Typically the exception
2803 # function) that did parse but isn't valid. Typically the exception
2804 # is a SyntaxError, but it's safest just to catch anything and show
2804 # is a SyntaxError, but it's safest just to catch anything and show
2805 # the user a traceback.
2805 # the user a traceback.
2806
2806
2807 # We do only one try/except outside the loop to minimize the impact
2807 # We do only one try/except outside the loop to minimize the impact
2808 # on runtime, and also because if any node in the node list is
2808 # on runtime, and also because if any node in the node list is
2809 # broken, we should stop execution completely.
2809 # broken, we should stop execution completely.
2810 if result:
2810 if result:
2811 result.error_before_exec = sys.exc_info()[1]
2811 result.error_before_exec = sys.exc_info()[1]
2812 self.showtraceback()
2812 self.showtraceback()
2813 return True
2813 return True
2814
2814
2815 return False
2815 return False
2816
2816
2817 def run_code(self, code_obj, result=None):
2817 def run_code(self, code_obj, result=None):
2818 """Execute a code object.
2818 """Execute a code object.
2819
2819
2820 When an exception occurs, self.showtraceback() is called to display a
2820 When an exception occurs, self.showtraceback() is called to display a
2821 traceback.
2821 traceback.
2822
2822
2823 Parameters
2823 Parameters
2824 ----------
2824 ----------
2825 code_obj : code object
2825 code_obj : code object
2826 A compiled code object, to be executed
2826 A compiled code object, to be executed
2827 result : ExecutionResult, optional
2827 result : ExecutionResult, optional
2828 An object to store exceptions that occur during execution.
2828 An object to store exceptions that occur during execution.
2829
2829
2830 Returns
2830 Returns
2831 -------
2831 -------
2832 False : successful execution.
2832 False : successful execution.
2833 True : an error occurred.
2833 True : an error occurred.
2834 """
2834 """
2835 # Set our own excepthook in case the user code tries to call it
2835 # Set our own excepthook in case the user code tries to call it
2836 # directly, so that the IPython crash handler doesn't get triggered
2836 # directly, so that the IPython crash handler doesn't get triggered
2837 old_excepthook, sys.excepthook = sys.excepthook, self.excepthook
2837 old_excepthook, sys.excepthook = sys.excepthook, self.excepthook
2838
2838
2839 # we save the original sys.excepthook in the instance, in case config
2839 # we save the original sys.excepthook in the instance, in case config
2840 # code (such as magics) needs access to it.
2840 # code (such as magics) needs access to it.
2841 self.sys_excepthook = old_excepthook
2841 self.sys_excepthook = old_excepthook
2842 outflag = True # happens in more places, so it's easier as default
2842 outflag = True # happens in more places, so it's easier as default
2843 try:
2843 try:
2844 try:
2844 try:
2845 self.hooks.pre_run_code_hook()
2845 self.hooks.pre_run_code_hook()
2846 #rprint('Running code', repr(code_obj)) # dbg
2846 #rprint('Running code', repr(code_obj)) # dbg
2847 exec(code_obj, self.user_global_ns, self.user_ns)
2847 exec(code_obj, self.user_global_ns, self.user_ns)
2848 finally:
2848 finally:
2849 # Reset our crash handler in place
2849 # Reset our crash handler in place
2850 sys.excepthook = old_excepthook
2850 sys.excepthook = old_excepthook
2851 except SystemExit as e:
2851 except SystemExit as e:
2852 if result is not None:
2852 if result is not None:
2853 result.error_in_exec = e
2853 result.error_in_exec = e
2854 self.showtraceback(exception_only=True)
2854 self.showtraceback(exception_only=True)
2855 warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
2855 warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1)
2856 except self.custom_exceptions:
2856 except self.custom_exceptions:
2857 etype, value, tb = sys.exc_info()
2857 etype, value, tb = sys.exc_info()
2858 if result is not None:
2858 if result is not None:
2859 result.error_in_exec = value
2859 result.error_in_exec = value
2860 self.CustomTB(etype, value, tb)
2860 self.CustomTB(etype, value, tb)
2861 except:
2861 except:
2862 if result is not None:
2862 if result is not None:
2863 result.error_in_exec = sys.exc_info()[1]
2863 result.error_in_exec = sys.exc_info()[1]
2864 self.showtraceback()
2864 self.showtraceback()
2865 else:
2865 else:
2866 outflag = False
2866 outflag = False
2867 return outflag
2867 return outflag
2868
2868
2869 # For backwards compatibility
2869 # For backwards compatibility
2870 runcode = run_code
2870 runcode = run_code
2871
2871
2872 #-------------------------------------------------------------------------
2872 #-------------------------------------------------------------------------
2873 # Things related to GUI support and pylab
2873 # Things related to GUI support and pylab
2874 #-------------------------------------------------------------------------
2874 #-------------------------------------------------------------------------
2875
2875
2876 active_eventloop = None
2876 active_eventloop = None
2877
2877
2878 def enable_gui(self, gui=None):
2878 def enable_gui(self, gui=None):
2879 raise NotImplementedError('Implement enable_gui in a subclass')
2879 raise NotImplementedError('Implement enable_gui in a subclass')
2880
2880
2881 def enable_matplotlib(self, gui=None):
2881 def enable_matplotlib(self, gui=None):
2882 """Enable interactive matplotlib and inline figure support.
2882 """Enable interactive matplotlib and inline figure support.
2883
2883
2884 This takes the following steps:
2884 This takes the following steps:
2885
2885
2886 1. select the appropriate eventloop and matplotlib backend
2886 1. select the appropriate eventloop and matplotlib backend
2887 2. set up matplotlib for interactive use with that backend
2887 2. set up matplotlib for interactive use with that backend
2888 3. configure formatters for inline figure display
2888 3. configure formatters for inline figure display
2889 4. enable the selected gui eventloop
2889 4. enable the selected gui eventloop
2890
2890
2891 Parameters
2891 Parameters
2892 ----------
2892 ----------
2893 gui : optional, string
2893 gui : optional, string
2894 If given, dictates the choice of matplotlib GUI backend to use
2894 If given, dictates the choice of matplotlib GUI backend to use
2895 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2895 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2896 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2896 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2897 matplotlib (as dictated by the matplotlib build-time options plus the
2897 matplotlib (as dictated by the matplotlib build-time options plus the
2898 user's matplotlibrc configuration file). Note that not all backends
2898 user's matplotlibrc configuration file). Note that not all backends
2899 make sense in all contexts, for example a terminal ipython can't
2899 make sense in all contexts, for example a terminal ipython can't
2900 display figures inline.
2900 display figures inline.
2901 """
2901 """
2902 from IPython.core import pylabtools as pt
2902 from IPython.core import pylabtools as pt
2903 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2903 gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select)
2904
2904
2905 if gui != 'inline':
2905 if gui != 'inline':
2906 # If we have our first gui selection, store it
2906 # If we have our first gui selection, store it
2907 if self.pylab_gui_select is None:
2907 if self.pylab_gui_select is None:
2908 self.pylab_gui_select = gui
2908 self.pylab_gui_select = gui
2909 # Otherwise if they are different
2909 # Otherwise if they are different
2910 elif gui != self.pylab_gui_select:
2910 elif gui != self.pylab_gui_select:
2911 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2911 print ('Warning: Cannot change to a different GUI toolkit: %s.'
2912 ' Using %s instead.' % (gui, self.pylab_gui_select))
2912 ' Using %s instead.' % (gui, self.pylab_gui_select))
2913 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2913 gui, backend = pt.find_gui_and_backend(self.pylab_gui_select)
2914
2914
2915 pt.activate_matplotlib(backend)
2915 pt.activate_matplotlib(backend)
2916 pt.configure_inline_support(self, backend)
2916 pt.configure_inline_support(self, backend)
2917
2917
2918 # Now we must activate the gui pylab wants to use, and fix %run to take
2918 # Now we must activate the gui pylab wants to use, and fix %run to take
2919 # plot updates into account
2919 # plot updates into account
2920 self.enable_gui(gui)
2920 self.enable_gui(gui)
2921 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2921 self.magics_manager.registry['ExecutionMagics'].default_runner = \
2922 pt.mpl_runner(self.safe_execfile)
2922 pt.mpl_runner(self.safe_execfile)
2923
2923
2924 return gui, backend
2924 return gui, backend
2925
2925
2926 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2926 def enable_pylab(self, gui=None, import_all=True, welcome_message=False):
2927 """Activate pylab support at runtime.
2927 """Activate pylab support at runtime.
2928
2928
2929 This turns on support for matplotlib, preloads into the interactive
2929 This turns on support for matplotlib, preloads into the interactive
2930 namespace all of numpy and pylab, and configures IPython to correctly
2930 namespace all of numpy and pylab, and configures IPython to correctly
2931 interact with the GUI event loop. The GUI backend to be used can be
2931 interact with the GUI event loop. The GUI backend to be used can be
2932 optionally selected with the optional ``gui`` argument.
2932 optionally selected with the optional ``gui`` argument.
2933
2933
2934 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2934 This method only adds preloading the namespace to InteractiveShell.enable_matplotlib.
2935
2935
2936 Parameters
2936 Parameters
2937 ----------
2937 ----------
2938 gui : optional, string
2938 gui : optional, string
2939 If given, dictates the choice of matplotlib GUI backend to use
2939 If given, dictates the choice of matplotlib GUI backend to use
2940 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2940 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2941 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2941 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2942 matplotlib (as dictated by the matplotlib build-time options plus the
2942 matplotlib (as dictated by the matplotlib build-time options plus the
2943 user's matplotlibrc configuration file). Note that not all backends
2943 user's matplotlibrc configuration file). Note that not all backends
2944 make sense in all contexts, for example a terminal ipython can't
2944 make sense in all contexts, for example a terminal ipython can't
2945 display figures inline.
2945 display figures inline.
2946 import_all : optional, bool, default: True
2946 import_all : optional, bool, default: True
2947 Whether to do `from numpy import *` and `from pylab import *`
2947 Whether to do `from numpy import *` and `from pylab import *`
2948 in addition to module imports.
2948 in addition to module imports.
2949 welcome_message : deprecated
2949 welcome_message : deprecated
2950 This argument is ignored, no welcome message will be displayed.
2950 This argument is ignored, no welcome message will be displayed.
2951 """
2951 """
2952 from IPython.core.pylabtools import import_pylab
2952 from IPython.core.pylabtools import import_pylab
2953
2953
2954 gui, backend = self.enable_matplotlib(gui)
2954 gui, backend = self.enable_matplotlib(gui)
2955
2955
2956 # We want to prevent the loading of pylab to pollute the user's
2956 # We want to prevent the loading of pylab to pollute the user's
2957 # namespace as shown by the %who* magics, so we execute the activation
2957 # namespace as shown by the %who* magics, so we execute the activation
2958 # code in an empty namespace, and we update *both* user_ns and
2958 # code in an empty namespace, and we update *both* user_ns and
2959 # user_ns_hidden with this information.
2959 # user_ns_hidden with this information.
2960 ns = {}
2960 ns = {}
2961 import_pylab(ns, import_all)
2961 import_pylab(ns, import_all)
2962 # warn about clobbered names
2962 # warn about clobbered names
2963 ignored = {"__builtins__"}
2963 ignored = {"__builtins__"}
2964 both = set(ns).intersection(self.user_ns).difference(ignored)
2964 both = set(ns).intersection(self.user_ns).difference(ignored)
2965 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2965 clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ]
2966 self.user_ns.update(ns)
2966 self.user_ns.update(ns)
2967 self.user_ns_hidden.update(ns)
2967 self.user_ns_hidden.update(ns)
2968 return gui, backend, clobbered
2968 return gui, backend, clobbered
2969
2969
2970 #-------------------------------------------------------------------------
2970 #-------------------------------------------------------------------------
2971 # Utilities
2971 # Utilities
2972 #-------------------------------------------------------------------------
2972 #-------------------------------------------------------------------------
2973
2973
2974 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2974 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2975 """Expand python variables in a string.
2975 """Expand python variables in a string.
2976
2976
2977 The depth argument indicates how many frames above the caller should
2977 The depth argument indicates how many frames above the caller should
2978 be walked to look for the local namespace where to expand variables.
2978 be walked to look for the local namespace where to expand variables.
2979
2979
2980 The global namespace for expansion is always the user's interactive
2980 The global namespace for expansion is always the user's interactive
2981 namespace.
2981 namespace.
2982 """
2982 """
2983 ns = self.user_ns.copy()
2983 ns = self.user_ns.copy()
2984 try:
2984 try:
2985 frame = sys._getframe(depth+1)
2985 frame = sys._getframe(depth+1)
2986 except ValueError:
2986 except ValueError:
2987 # This is thrown if there aren't that many frames on the stack,
2987 # This is thrown if there aren't that many frames on the stack,
2988 # e.g. if a script called run_line_magic() directly.
2988 # e.g. if a script called run_line_magic() directly.
2989 pass
2989 pass
2990 else:
2990 else:
2991 ns.update(frame.f_locals)
2991 ns.update(frame.f_locals)
2992
2992
2993 try:
2993 try:
2994 # We have to use .vformat() here, because 'self' is a valid and common
2994 # We have to use .vformat() here, because 'self' is a valid and common
2995 # name, and expanding **ns for .format() would make it collide with
2995 # name, and expanding **ns for .format() would make it collide with
2996 # the 'self' argument of the method.
2996 # the 'self' argument of the method.
2997 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2997 cmd = formatter.vformat(cmd, args=[], kwargs=ns)
2998 except Exception:
2998 except Exception:
2999 # if formatter couldn't format, just let it go untransformed
2999 # if formatter couldn't format, just let it go untransformed
3000 pass
3000 pass
3001 return cmd
3001 return cmd
3002
3002
3003 def mktempfile(self, data=None, prefix='ipython_edit_'):
3003 def mktempfile(self, data=None, prefix='ipython_edit_'):
3004 """Make a new tempfile and return its filename.
3004 """Make a new tempfile and return its filename.
3005
3005
3006 This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp),
3006 This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp),
3007 but it registers the created filename internally so ipython cleans it up
3007 but it registers the created filename internally so ipython cleans it up
3008 at exit time.
3008 at exit time.
3009
3009
3010 Optional inputs:
3010 Optional inputs:
3011
3011
3012 - data(None): if data is given, it gets written out to the temp file
3012 - data(None): if data is given, it gets written out to the temp file
3013 immediately, and the file is closed again."""
3013 immediately, and the file is closed again."""
3014
3014
3015 dirname = tempfile.mkdtemp(prefix=prefix)
3015 dirname = tempfile.mkdtemp(prefix=prefix)
3016 self.tempdirs.append(dirname)
3016 self.tempdirs.append(dirname)
3017
3017
3018 handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname)
3018 handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname)
3019 os.close(handle) # On Windows, there can only be one open handle on a file
3019 os.close(handle) # On Windows, there can only be one open handle on a file
3020 self.tempfiles.append(filename)
3020 self.tempfiles.append(filename)
3021
3021
3022 if data:
3022 if data:
3023 tmp_file = open(filename,'w')
3023 tmp_file = open(filename,'w')
3024 tmp_file.write(data)
3024 tmp_file.write(data)
3025 tmp_file.close()
3025 tmp_file.close()
3026 return filename
3026 return filename
3027
3027
3028 @undoc
3028 @undoc
3029 def write(self,data):
3029 def write(self,data):
3030 """DEPRECATED: Write a string to the default output"""
3030 """DEPRECATED: Write a string to the default output"""
3031 warn('InteractiveShell.write() is deprecated, use sys.stdout instead',
3031 warn('InteractiveShell.write() is deprecated, use sys.stdout instead',
3032 DeprecationWarning, stacklevel=2)
3032 DeprecationWarning, stacklevel=2)
3033 sys.stdout.write(data)
3033 sys.stdout.write(data)
3034
3034
3035 @undoc
3035 @undoc
3036 def write_err(self,data):
3036 def write_err(self,data):
3037 """DEPRECATED: Write a string to the default error output"""
3037 """DEPRECATED: Write a string to the default error output"""
3038 warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead',
3038 warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead',
3039 DeprecationWarning, stacklevel=2)
3039 DeprecationWarning, stacklevel=2)
3040 sys.stderr.write(data)
3040 sys.stderr.write(data)
3041
3041
3042 def ask_yes_no(self, prompt, default=None, interrupt=None):
3042 def ask_yes_no(self, prompt, default=None, interrupt=None):
3043 if self.quiet:
3043 if self.quiet:
3044 return True
3044 return True
3045 return ask_yes_no(prompt,default,interrupt)
3045 return ask_yes_no(prompt,default,interrupt)
3046
3046
3047 def show_usage(self):
3047 def show_usage(self):
3048 """Show a usage message"""
3048 """Show a usage message"""
3049 page.page(IPython.core.usage.interactive_usage)
3049 page.page(IPython.core.usage.interactive_usage)
3050
3050
3051 def extract_input_lines(self, range_str, raw=False):
3051 def extract_input_lines(self, range_str, raw=False):
3052 """Return as a string a set of input history slices.
3052 """Return as a string a set of input history slices.
3053
3053
3054 Parameters
3054 Parameters
3055 ----------
3055 ----------
3056 range_str : string
3056 range_str : string
3057 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3057 The set of slices is given as a string, like "~5/6-~4/2 4:8 9",
3058 since this function is for use by magic functions which get their
3058 since this function is for use by magic functions which get their
3059 arguments as strings. The number before the / is the session
3059 arguments as strings. The number before the / is the session
3060 number: ~n goes n back from the current session.
3060 number: ~n goes n back from the current session.
3061
3061
3062 raw : bool, optional
3062 raw : bool, optional
3063 By default, the processed input is used. If this is true, the raw
3063 By default, the processed input is used. If this is true, the raw
3064 input history is used instead.
3064 input history is used instead.
3065
3065
3066 Notes
3066 Notes
3067 -----
3067 -----
3068
3068
3069 Slices can be described with two notations:
3069 Slices can be described with two notations:
3070
3070
3071 * ``N:M`` -> standard python form, means including items N...(M-1).
3071 * ``N:M`` -> standard python form, means including items N...(M-1).
3072 * ``N-M`` -> include items N..M (closed endpoint).
3072 * ``N-M`` -> include items N..M (closed endpoint).
3073 """
3073 """
3074 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3074 lines = self.history_manager.get_range_by_str(range_str, raw=raw)
3075 return "\n".join(x for _, _, x in lines)
3075 return "\n".join(x for _, _, x in lines)
3076
3076
3077 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False):
3077 def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False):
3078 """Get a code string from history, file, url, or a string or macro.
3078 """Get a code string from history, file, url, or a string or macro.
3079
3079
3080 This is mainly used by magic functions.
3080 This is mainly used by magic functions.
3081
3081
3082 Parameters
3082 Parameters
3083 ----------
3083 ----------
3084
3084
3085 target : str
3085 target : str
3086
3086
3087 A string specifying code to retrieve. This will be tried respectively
3087 A string specifying code to retrieve. This will be tried respectively
3088 as: ranges of input history (see %history for syntax), url,
3088 as: ranges of input history (see %history for syntax), url,
3089 corresponding .py file, filename, or an expression evaluating to a
3089 corresponding .py file, filename, or an expression evaluating to a
3090 string or Macro in the user namespace.
3090 string or Macro in the user namespace.
3091
3091
3092 raw : bool
3092 raw : bool
3093 If true (default), retrieve raw history. Has no effect on the other
3093 If true (default), retrieve raw history. Has no effect on the other
3094 retrieval mechanisms.
3094 retrieval mechanisms.
3095
3095
3096 py_only : bool (default False)
3096 py_only : bool (default False)
3097 Only try to fetch python code, do not try alternative methods to decode file
3097 Only try to fetch python code, do not try alternative methods to decode file
3098 if unicode fails.
3098 if unicode fails.
3099
3099
3100 Returns
3100 Returns
3101 -------
3101 -------
3102 A string of code.
3102 A string of code.
3103
3103
3104 ValueError is raised if nothing is found, and TypeError if it evaluates
3104 ValueError is raised if nothing is found, and TypeError if it evaluates
3105 to an object of another type. In each case, .args[0] is a printable
3105 to an object of another type. In each case, .args[0] is a printable
3106 message.
3106 message.
3107 """
3107 """
3108 code = self.extract_input_lines(target, raw=raw) # Grab history
3108 code = self.extract_input_lines(target, raw=raw) # Grab history
3109 if code:
3109 if code:
3110 return code
3110 return code
3111 try:
3111 try:
3112 if target.startswith(('http://', 'https://')):
3112 if target.startswith(('http://', 'https://')):
3113 return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie)
3113 return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie)
3114 except UnicodeDecodeError:
3114 except UnicodeDecodeError:
3115 if not py_only :
3115 if not py_only :
3116 # Deferred import
3116 # Deferred import
3117 from urllib.request import urlopen
3117 from urllib.request import urlopen
3118 response = urlopen(target)
3118 response = urlopen(target)
3119 return response.read().decode('latin1')
3119 return response.read().decode('latin1')
3120 raise ValueError(("'%s' seem to be unreadable.") % target)
3120 raise ValueError(("'%s' seem to be unreadable.") % target)
3121
3121
3122 potential_target = [target]
3122 potential_target = [target]
3123 try :
3123 try :
3124 potential_target.insert(0,get_py_filename(target))
3124 potential_target.insert(0,get_py_filename(target))
3125 except IOError:
3125 except IOError:
3126 pass
3126 pass
3127
3127
3128 for tgt in potential_target :
3128 for tgt in potential_target :
3129 if os.path.isfile(tgt): # Read file
3129 if os.path.isfile(tgt): # Read file
3130 try :
3130 try :
3131 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3131 return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie)
3132 except UnicodeDecodeError :
3132 except UnicodeDecodeError :
3133 if not py_only :
3133 if not py_only :
3134 with io_open(tgt,'r', encoding='latin1') as f :
3134 with io_open(tgt,'r', encoding='latin1') as f :
3135 return f.read()
3135 return f.read()
3136 raise ValueError(("'%s' seem to be unreadable.") % target)
3136 raise ValueError(("'%s' seem to be unreadable.") % target)
3137 elif os.path.isdir(os.path.expanduser(tgt)):
3137 elif os.path.isdir(os.path.expanduser(tgt)):
3138 raise ValueError("'%s' is a directory, not a regular file." % target)
3138 raise ValueError("'%s' is a directory, not a regular file." % target)
3139
3139
3140 if search_ns:
3140 if search_ns:
3141 # Inspect namespace to load object source
3141 # Inspect namespace to load object source
3142 object_info = self.object_inspect(target, detail_level=1)
3142 object_info = self.object_inspect(target, detail_level=1)
3143 if object_info['found'] and object_info['source']:
3143 if object_info['found'] and object_info['source']:
3144 return object_info['source']
3144 return object_info['source']
3145
3145
3146 try: # User namespace
3146 try: # User namespace
3147 codeobj = eval(target, self.user_ns)
3147 codeobj = eval(target, self.user_ns)
3148 except Exception:
3148 except Exception:
3149 raise ValueError(("'%s' was not found in history, as a file, url, "
3149 raise ValueError(("'%s' was not found in history, as a file, url, "
3150 "nor in the user namespace.") % target)
3150 "nor in the user namespace.") % target)
3151
3151
3152 if isinstance(codeobj, str):
3152 if isinstance(codeobj, str):
3153 return codeobj
3153 return codeobj
3154 elif isinstance(codeobj, Macro):
3154 elif isinstance(codeobj, Macro):
3155 return codeobj.value
3155 return codeobj.value
3156
3156
3157 raise TypeError("%s is neither a string nor a macro." % target,
3157 raise TypeError("%s is neither a string nor a macro." % target,
3158 codeobj)
3158 codeobj)
3159
3159
3160 #-------------------------------------------------------------------------
3160 #-------------------------------------------------------------------------
3161 # Things related to IPython exiting
3161 # Things related to IPython exiting
3162 #-------------------------------------------------------------------------
3162 #-------------------------------------------------------------------------
3163 def atexit_operations(self):
3163 def atexit_operations(self):
3164 """This will be executed at the time of exit.
3164 """This will be executed at the time of exit.
3165
3165
3166 Cleanup operations and saving of persistent data that is done
3166 Cleanup operations and saving of persistent data that is done
3167 unconditionally by IPython should be performed here.
3167 unconditionally by IPython should be performed here.
3168
3168
3169 For things that may depend on startup flags or platform specifics (such
3169 For things that may depend on startup flags or platform specifics (such
3170 as having readline or not), register a separate atexit function in the
3170 as having readline or not), register a separate atexit function in the
3171 code that has the appropriate information, rather than trying to
3171 code that has the appropriate information, rather than trying to
3172 clutter
3172 clutter
3173 """
3173 """
3174 # Close the history session (this stores the end time and line count)
3174 # Close the history session (this stores the end time and line count)
3175 # this must be *before* the tempfile cleanup, in case of temporary
3175 # this must be *before* the tempfile cleanup, in case of temporary
3176 # history db
3176 # history db
3177 self.history_manager.end_session()
3177 self.history_manager.end_session()
3178
3178
3179 # Cleanup all tempfiles and folders left around
3179 # Cleanup all tempfiles and folders left around
3180 for tfile in self.tempfiles:
3180 for tfile in self.tempfiles:
3181 try:
3181 try:
3182 os.unlink(tfile)
3182 os.unlink(tfile)
3183 except OSError:
3183 except OSError:
3184 pass
3184 pass
3185
3185
3186 for tdir in self.tempdirs:
3186 for tdir in self.tempdirs:
3187 try:
3187 try:
3188 os.rmdir(tdir)
3188 os.rmdir(tdir)
3189 except OSError:
3189 except OSError:
3190 pass
3190 pass
3191
3191
3192 # Clear all user namespaces to release all references cleanly.
3192 # Clear all user namespaces to release all references cleanly.
3193 self.reset(new_session=False)
3193 self.reset(new_session=False)
3194
3194
3195 # Run user hooks
3195 # Run user hooks
3196 self.hooks.shutdown_hook()
3196 self.hooks.shutdown_hook()
3197
3197
3198 def cleanup(self):
3198 def cleanup(self):
3199 self.restore_sys_module_state()
3199 self.restore_sys_module_state()
3200
3200
3201
3201
3202 # Overridden in terminal subclass to change prompts
3202 # Overridden in terminal subclass to change prompts
3203 def switch_doctest_mode(self, mode):
3203 def switch_doctest_mode(self, mode):
3204 pass
3204 pass
3205
3205
3206
3206
3207 class InteractiveShellABC(metaclass=abc.ABCMeta):
3207 class InteractiveShellABC(metaclass=abc.ABCMeta):
3208 """An abstract base class for InteractiveShell."""
3208 """An abstract base class for InteractiveShell."""
3209
3209
3210 InteractiveShellABC.register(InteractiveShell)
3210 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now