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