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