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