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