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