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