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