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