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