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