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