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