##// END OF EJS Templates
Complete fix for __del__ errors with .reset(), add unit test.
Fernando Perez -
Show More
@@ -1,2586 +1,2587 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Main IPython class."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 7 # Copyright (C) 2008-2010 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__
21 21 import __future__
22 22 import abc
23 23 import atexit
24 24 import codeop
25 25 import exceptions
26 26 import new
27 27 import os
28 28 import re
29 29 import string
30 30 import sys
31 31 import tempfile
32 32 from contextlib import nested
33 33
34 34 from IPython.config.configurable import Configurable
35 35 from IPython.core import debugger, oinspect
36 36 from IPython.core import history as ipcorehist
37 37 from IPython.core import page
38 38 from IPython.core import prefilter
39 39 from IPython.core import shadowns
40 40 from IPython.core import ultratb
41 41 from IPython.core.alias import AliasManager
42 42 from IPython.core.builtin_trap import BuiltinTrap
43 43 from IPython.core.display_trap import DisplayTrap
44 44 from IPython.core.displayhook import DisplayHook
45 45 from IPython.core.error import TryNext, UsageError
46 46 from IPython.core.extensions import ExtensionManager
47 47 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
48 48 from IPython.core.inputlist import InputList
49 49 from IPython.core.inputsplitter import IPythonInputSplitter
50 50 from IPython.core.logger import Logger
51 51 from IPython.core.magic import Magic
52 52 from IPython.core.payload import PayloadManager
53 53 from IPython.core.plugin import PluginManager
54 54 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
55 55 from IPython.external.Itpl import ItplNS
56 56 from IPython.utils import PyColorize
57 57 from IPython.utils import io
58 58 from IPython.utils import pickleshare
59 59 from IPython.utils.doctestreload import doctest_reload
60 60 from IPython.utils.io import ask_yes_no, rprint
61 61 from IPython.utils.ipstruct import Struct
62 62 from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
63 63 from IPython.utils.process import system, getoutput
64 64 from IPython.utils.strdispatch import StrDispatch
65 65 from IPython.utils.syspathcontext import prepended_to_syspath
66 66 from IPython.utils.text import num_ini_spaces, format_screen, LSString, SList
67 67 from IPython.utils.traitlets import (Int, Str, CBool, CaselessStrEnum, Enum,
68 68 List, Unicode, Instance, Type)
69 69 from IPython.utils.warn import warn, error, fatal
70 70 import IPython.core.hooks
71 71
72 72 #-----------------------------------------------------------------------------
73 73 # Globals
74 74 #-----------------------------------------------------------------------------
75 75
76 76 # compiled regexps for autoindent management
77 77 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
78 78
79 79 #-----------------------------------------------------------------------------
80 80 # Utilities
81 81 #-----------------------------------------------------------------------------
82 82
83 83 # store the builtin raw_input globally, and use this always, in case user code
84 84 # overwrites it (like wx.py.PyShell does)
85 85 raw_input_original = raw_input
86 86
87 87 def softspace(file, newvalue):
88 88 """Copied from code.py, to remove the dependency"""
89 89
90 90 oldvalue = 0
91 91 try:
92 92 oldvalue = file.softspace
93 93 except AttributeError:
94 94 pass
95 95 try:
96 96 file.softspace = newvalue
97 97 except (AttributeError, TypeError):
98 98 # "attribute-less object" or "read-only attributes"
99 99 pass
100 100 return oldvalue
101 101
102 102
103 103 def no_op(*a, **kw): pass
104 104
105 105 class SpaceInInput(exceptions.Exception): pass
106 106
107 107 class Bunch: pass
108 108
109 109
110 110 def get_default_colors():
111 111 if sys.platform=='darwin':
112 112 return "LightBG"
113 113 elif os.name=='nt':
114 114 return 'Linux'
115 115 else:
116 116 return 'Linux'
117 117
118 118
119 119 class SeparateStr(Str):
120 120 """A Str subclass to validate separate_in, separate_out, etc.
121 121
122 122 This is a Str based trait that converts '0'->'' and '\\n'->'\n'.
123 123 """
124 124
125 125 def validate(self, obj, value):
126 126 if value == '0': value = ''
127 127 value = value.replace('\\n','\n')
128 128 return super(SeparateStr, self).validate(obj, value)
129 129
130 130 class MultipleInstanceError(Exception):
131 131 pass
132 132
133 133
134 134 #-----------------------------------------------------------------------------
135 135 # Main IPython class
136 136 #-----------------------------------------------------------------------------
137 137
138 138
139 139 class InteractiveShell(Configurable, Magic):
140 140 """An enhanced, interactive shell for Python."""
141 141
142 142 _instance = None
143 143 autocall = Enum((0,1,2), default_value=1, config=True)
144 144 # TODO: remove all autoindent logic and put into frontends.
145 145 # We can't do this yet because even runlines uses the autoindent.
146 146 autoindent = CBool(True, config=True)
147 147 automagic = CBool(True, config=True)
148 148 cache_size = Int(1000, config=True)
149 149 color_info = CBool(True, config=True)
150 150 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
151 151 default_value=get_default_colors(), config=True)
152 152 debug = CBool(False, config=True)
153 153 deep_reload = CBool(False, config=True)
154 154 displayhook_class = Type(DisplayHook)
155 155 exit_now = CBool(False)
156 156 filename = Str("<ipython console>")
157 157 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
158 158
159 159 # Input splitter, to split entire cells of input into either individual
160 160 # interactive statements or whole blocks.
161 161 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
162 162 (), {})
163 163 logstart = CBool(False, config=True)
164 164 logfile = Str('', config=True)
165 165 logappend = Str('', config=True)
166 166 object_info_string_level = Enum((0,1,2), default_value=0,
167 167 config=True)
168 168 pdb = CBool(False, config=True)
169 169
170 170 pprint = CBool(True, config=True)
171 171 profile = Str('', config=True)
172 172 prompt_in1 = Str('In [\\#]: ', config=True)
173 173 prompt_in2 = Str(' .\\D.: ', config=True)
174 174 prompt_out = Str('Out[\\#]: ', config=True)
175 175 prompts_pad_left = CBool(True, config=True)
176 176 quiet = CBool(False, config=True)
177 177
178 178 # The readline stuff will eventually be moved to the terminal subclass
179 179 # but for now, we can't do that as readline is welded in everywhere.
180 180 readline_use = CBool(True, config=True)
181 181 readline_merge_completions = CBool(True, config=True)
182 182 readline_omit__names = Enum((0,1,2), default_value=0, config=True)
183 183 readline_remove_delims = Str('-/~', config=True)
184 184 readline_parse_and_bind = List([
185 185 'tab: complete',
186 186 '"\C-l": clear-screen',
187 187 'set show-all-if-ambiguous on',
188 188 '"\C-o": tab-insert',
189 189 '"\M-i": " "',
190 190 '"\M-o": "\d\d\d\d"',
191 191 '"\M-I": "\d\d\d\d"',
192 192 '"\C-r": reverse-search-history',
193 193 '"\C-s": forward-search-history',
194 194 '"\C-p": history-search-backward',
195 195 '"\C-n": history-search-forward',
196 196 '"\e[A": history-search-backward',
197 197 '"\e[B": history-search-forward',
198 198 '"\C-k": kill-line',
199 199 '"\C-u": unix-line-discard',
200 200 ], allow_none=False, config=True)
201 201
202 202 # TODO: this part of prompt management should be moved to the frontends.
203 203 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
204 204 separate_in = SeparateStr('\n', config=True)
205 205 separate_out = SeparateStr('', config=True)
206 206 separate_out2 = SeparateStr('', config=True)
207 207 wildcards_case_sensitive = CBool(True, config=True)
208 208 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
209 209 default_value='Context', config=True)
210 210
211 211 # Subcomponents of InteractiveShell
212 212 alias_manager = Instance('IPython.core.alias.AliasManager')
213 213 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
214 214 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
215 215 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
216 216 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
217 217 plugin_manager = Instance('IPython.core.plugin.PluginManager')
218 218 payload_manager = Instance('IPython.core.payload.PayloadManager')
219 219
220 220 # Private interface
221 221 _post_execute = set()
222 222
223 223 def __init__(self, config=None, ipython_dir=None,
224 224 user_ns=None, user_global_ns=None,
225 225 custom_exceptions=((), None)):
226 226
227 227 # This is where traits with a config_key argument are updated
228 228 # from the values on config.
229 229 super(InteractiveShell, self).__init__(config=config)
230 230
231 231 # These are relatively independent and stateless
232 232 self.init_ipython_dir(ipython_dir)
233 233 self.init_instance_attrs()
234 234 self.init_environment()
235 235
236 236 # Create namespaces (user_ns, user_global_ns, etc.)
237 237 self.init_create_namespaces(user_ns, user_global_ns)
238 238 # This has to be done after init_create_namespaces because it uses
239 239 # something in self.user_ns, but before init_sys_modules, which
240 240 # is the first thing to modify sys.
241 241 # TODO: When we override sys.stdout and sys.stderr before this class
242 242 # is created, we are saving the overridden ones here. Not sure if this
243 243 # is what we want to do.
244 244 self.save_sys_module_state()
245 245 self.init_sys_modules()
246 246
247 247 self.init_history()
248 248 self.init_encoding()
249 249 self.init_prefilter()
250 250
251 251 Magic.__init__(self, self)
252 252
253 253 self.init_syntax_highlighting()
254 254 self.init_hooks()
255 255 self.init_pushd_popd_magic()
256 256 # self.init_traceback_handlers use to be here, but we moved it below
257 257 # because it and init_io have to come after init_readline.
258 258 self.init_user_ns()
259 259 self.init_logger()
260 260 self.init_alias()
261 261 self.init_builtins()
262 262
263 263 # pre_config_initialization
264 264 self.init_shadow_hist()
265 265
266 266 # The next section should contain everything that was in ipmaker.
267 267 self.init_logstart()
268 268
269 269 # The following was in post_config_initialization
270 270 self.init_inspector()
271 271 # init_readline() must come before init_io(), because init_io uses
272 272 # readline related things.
273 273 self.init_readline()
274 274 # init_completer must come after init_readline, because it needs to
275 275 # know whether readline is present or not system-wide to configure the
276 276 # completers, since the completion machinery can now operate
277 277 # independently of readline (e.g. over the network)
278 278 self.init_completer()
279 279 # TODO: init_io() needs to happen before init_traceback handlers
280 280 # because the traceback handlers hardcode the stdout/stderr streams.
281 281 # This logic in in debugger.Pdb and should eventually be changed.
282 282 self.init_io()
283 283 self.init_traceback_handlers(custom_exceptions)
284 284 self.init_prompts()
285 285 self.init_displayhook()
286 286 self.init_reload_doctest()
287 287 self.init_magics()
288 288 self.init_pdb()
289 289 self.init_extension_manager()
290 290 self.init_plugin_manager()
291 291 self.init_payload()
292 292 self.hooks.late_startup_hook()
293 293 atexit.register(self.atexit_operations)
294 294
295 295 @classmethod
296 296 def instance(cls, *args, **kwargs):
297 297 """Returns a global InteractiveShell instance."""
298 298 if cls._instance is None:
299 299 inst = cls(*args, **kwargs)
300 300 # Now make sure that the instance will also be returned by
301 301 # the subclasses instance attribute.
302 302 for subclass in cls.mro():
303 303 if issubclass(cls, subclass) and \
304 304 issubclass(subclass, InteractiveShell):
305 305 subclass._instance = inst
306 306 else:
307 307 break
308 308 if isinstance(cls._instance, cls):
309 309 return cls._instance
310 310 else:
311 311 raise MultipleInstanceError(
312 312 'Multiple incompatible subclass instances of '
313 313 'InteractiveShell are being created.'
314 314 )
315 315
316 316 @classmethod
317 317 def initialized(cls):
318 318 return hasattr(cls, "_instance")
319 319
320 320 def get_ipython(self):
321 321 """Return the currently running IPython instance."""
322 322 return self
323 323
324 324 #-------------------------------------------------------------------------
325 325 # Trait changed handlers
326 326 #-------------------------------------------------------------------------
327 327
328 328 def _ipython_dir_changed(self, name, new):
329 329 if not os.path.isdir(new):
330 330 os.makedirs(new, mode = 0777)
331 331
332 332 def set_autoindent(self,value=None):
333 333 """Set the autoindent flag, checking for readline support.
334 334
335 335 If called with no arguments, it acts as a toggle."""
336 336
337 337 if not self.has_readline:
338 338 if os.name == 'posix':
339 339 warn("The auto-indent feature requires the readline library")
340 340 self.autoindent = 0
341 341 return
342 342 if value is None:
343 343 self.autoindent = not self.autoindent
344 344 else:
345 345 self.autoindent = value
346 346
347 347 #-------------------------------------------------------------------------
348 348 # init_* methods called by __init__
349 349 #-------------------------------------------------------------------------
350 350
351 351 def init_ipython_dir(self, ipython_dir):
352 352 if ipython_dir is not None:
353 353 self.ipython_dir = ipython_dir
354 354 self.config.Global.ipython_dir = self.ipython_dir
355 355 return
356 356
357 357 if hasattr(self.config.Global, 'ipython_dir'):
358 358 self.ipython_dir = self.config.Global.ipython_dir
359 359 else:
360 360 self.ipython_dir = get_ipython_dir()
361 361
362 362 # All children can just read this
363 363 self.config.Global.ipython_dir = self.ipython_dir
364 364
365 365 def init_instance_attrs(self):
366 366 self.more = False
367 367
368 368 # command compiler
369 369 self.compile = codeop.CommandCompiler()
370 370
371 371 # User input buffer
372 372 self.buffer = []
373 373
374 374 # Make an empty namespace, which extension writers can rely on both
375 375 # existing and NEVER being used by ipython itself. This gives them a
376 376 # convenient location for storing additional information and state
377 377 # their extensions may require, without fear of collisions with other
378 378 # ipython names that may develop later.
379 379 self.meta = Struct()
380 380
381 381 # Object variable to store code object waiting execution. This is
382 382 # used mainly by the multithreaded shells, but it can come in handy in
383 383 # other situations. No need to use a Queue here, since it's a single
384 384 # item which gets cleared once run.
385 385 self.code_to_run = None
386 386
387 387 # Temporary files used for various purposes. Deleted at exit.
388 388 self.tempfiles = []
389 389
390 390 # Keep track of readline usage (later set by init_readline)
391 391 self.has_readline = False
392 392
393 393 # keep track of where we started running (mainly for crash post-mortem)
394 394 # This is not being used anywhere currently.
395 395 self.starting_dir = os.getcwd()
396 396
397 397 # Indentation management
398 398 self.indent_current_nsp = 0
399 399
400 400 def init_environment(self):
401 401 """Any changes we need to make to the user's environment."""
402 402 pass
403 403
404 404 def init_encoding(self):
405 405 # Get system encoding at startup time. Certain terminals (like Emacs
406 406 # under Win32 have it set to None, and we need to have a known valid
407 407 # encoding to use in the raw_input() method
408 408 try:
409 409 self.stdin_encoding = sys.stdin.encoding or 'ascii'
410 410 except AttributeError:
411 411 self.stdin_encoding = 'ascii'
412 412
413 413 def init_syntax_highlighting(self):
414 414 # Python source parser/formatter for syntax highlighting
415 415 pyformat = PyColorize.Parser().format
416 416 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
417 417
418 418 def init_pushd_popd_magic(self):
419 419 # for pushd/popd management
420 420 try:
421 421 self.home_dir = get_home_dir()
422 422 except HomeDirError, msg:
423 423 fatal(msg)
424 424
425 425 self.dir_stack = []
426 426
427 427 def init_logger(self):
428 428 self.logger = Logger(self, logfname='ipython_log.py', logmode='rotate')
429 429 # local shortcut, this is used a LOT
430 430 self.log = self.logger.log
431 431
432 432 def init_logstart(self):
433 433 if self.logappend:
434 434 self.magic_logstart(self.logappend + ' append')
435 435 elif self.logfile:
436 436 self.magic_logstart(self.logfile)
437 437 elif self.logstart:
438 438 self.magic_logstart()
439 439
440 440 def init_builtins(self):
441 441 self.builtin_trap = BuiltinTrap(shell=self)
442 442
443 443 def init_inspector(self):
444 444 # Object inspector
445 445 self.inspector = oinspect.Inspector(oinspect.InspectColors,
446 446 PyColorize.ANSICodeColors,
447 447 'NoColor',
448 448 self.object_info_string_level)
449 449
450 450 def init_io(self):
451 451 # This will just use sys.stdout and sys.stderr. If you want to
452 452 # override sys.stdout and sys.stderr themselves, you need to do that
453 453 # *before* instantiating this class, because Term holds onto
454 454 # references to the underlying streams.
455 455 if sys.platform == 'win32' and self.has_readline:
456 456 Term = io.IOTerm(cout=self.readline._outputfile,
457 457 cerr=self.readline._outputfile)
458 458 else:
459 459 Term = io.IOTerm()
460 460 io.Term = Term
461 461
462 462 def init_prompts(self):
463 463 # TODO: This is a pass for now because the prompts are managed inside
464 464 # the DisplayHook. Once there is a separate prompt manager, this
465 465 # will initialize that object and all prompt related information.
466 466 pass
467 467
468 468 def init_displayhook(self):
469 469 # Initialize displayhook, set in/out prompts and printing system
470 470 self.displayhook = self.displayhook_class(
471 471 shell=self,
472 472 cache_size=self.cache_size,
473 473 input_sep = self.separate_in,
474 474 output_sep = self.separate_out,
475 475 output_sep2 = self.separate_out2,
476 476 ps1 = self.prompt_in1,
477 477 ps2 = self.prompt_in2,
478 478 ps_out = self.prompt_out,
479 479 pad_left = self.prompts_pad_left
480 480 )
481 481 # This is a context manager that installs/revmoes the displayhook at
482 482 # the appropriate time.
483 483 self.display_trap = DisplayTrap(hook=self.displayhook)
484 484
485 485 def init_reload_doctest(self):
486 486 # Do a proper resetting of doctest, including the necessary displayhook
487 487 # monkeypatching
488 488 try:
489 489 doctest_reload()
490 490 except ImportError:
491 491 warn("doctest module does not exist.")
492 492
493 493 #-------------------------------------------------------------------------
494 494 # Things related to injections into the sys module
495 495 #-------------------------------------------------------------------------
496 496
497 497 def save_sys_module_state(self):
498 498 """Save the state of hooks in the sys module.
499 499
500 500 This has to be called after self.user_ns is created.
501 501 """
502 502 self._orig_sys_module_state = {}
503 503 self._orig_sys_module_state['stdin'] = sys.stdin
504 504 self._orig_sys_module_state['stdout'] = sys.stdout
505 505 self._orig_sys_module_state['stderr'] = sys.stderr
506 506 self._orig_sys_module_state['excepthook'] = sys.excepthook
507 507 try:
508 508 self._orig_sys_modules_main_name = self.user_ns['__name__']
509 509 except KeyError:
510 510 pass
511 511
512 512 def restore_sys_module_state(self):
513 513 """Restore the state of the sys module."""
514 514 try:
515 515 for k, v in self._orig_sys_module_state.items():
516 516 setattr(sys, k, v)
517 517 except AttributeError:
518 518 pass
519 519 # Reset what what done in self.init_sys_modules
520 520 try:
521 521 sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
522 522 except (AttributeError, KeyError):
523 523 pass
524 524
525 525 #-------------------------------------------------------------------------
526 526 # Things related to hooks
527 527 #-------------------------------------------------------------------------
528 528
529 529 def init_hooks(self):
530 530 # hooks holds pointers used for user-side customizations
531 531 self.hooks = Struct()
532 532
533 533 self.strdispatchers = {}
534 534
535 535 # Set all default hooks, defined in the IPython.hooks module.
536 536 hooks = IPython.core.hooks
537 537 for hook_name in hooks.__all__:
538 538 # default hooks have priority 100, i.e. low; user hooks should have
539 539 # 0-100 priority
540 540 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
541 541
542 542 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
543 543 """set_hook(name,hook) -> sets an internal IPython hook.
544 544
545 545 IPython exposes some of its internal API as user-modifiable hooks. By
546 546 adding your function to one of these hooks, you can modify IPython's
547 547 behavior to call at runtime your own routines."""
548 548
549 549 # At some point in the future, this should validate the hook before it
550 550 # accepts it. Probably at least check that the hook takes the number
551 551 # of args it's supposed to.
552 552
553 553 f = new.instancemethod(hook,self,self.__class__)
554 554
555 555 # check if the hook is for strdispatcher first
556 556 if str_key is not None:
557 557 sdp = self.strdispatchers.get(name, StrDispatch())
558 558 sdp.add_s(str_key, f, priority )
559 559 self.strdispatchers[name] = sdp
560 560 return
561 561 if re_key is not None:
562 562 sdp = self.strdispatchers.get(name, StrDispatch())
563 563 sdp.add_re(re.compile(re_key), f, priority )
564 564 self.strdispatchers[name] = sdp
565 565 return
566 566
567 567 dp = getattr(self.hooks, name, None)
568 568 if name not in IPython.core.hooks.__all__:
569 569 print "Warning! Hook '%s' is not one of %s" % \
570 570 (name, IPython.core.hooks.__all__ )
571 571 if not dp:
572 572 dp = IPython.core.hooks.CommandChainDispatcher()
573 573
574 574 try:
575 575 dp.add(f,priority)
576 576 except AttributeError:
577 577 # it was not commandchain, plain old func - replace
578 578 dp = f
579 579
580 580 setattr(self.hooks,name, dp)
581 581
582 582 def register_post_execute(self, func):
583 583 """Register a function for calling after code execution.
584 584 """
585 585 if not callable(func):
586 586 raise ValueError('argument %s must be callable' % func)
587 587 self._post_execute.add(func)
588 588
589 589 #-------------------------------------------------------------------------
590 590 # Things related to the "main" module
591 591 #-------------------------------------------------------------------------
592 592
593 593 def new_main_mod(self,ns=None):
594 594 """Return a new 'main' module object for user code execution.
595 595 """
596 596 main_mod = self._user_main_module
597 597 init_fakemod_dict(main_mod,ns)
598 598 return main_mod
599 599
600 600 def cache_main_mod(self,ns,fname):
601 601 """Cache a main module's namespace.
602 602
603 603 When scripts are executed via %run, we must keep a reference to the
604 604 namespace of their __main__ module (a FakeModule instance) around so
605 605 that Python doesn't clear it, rendering objects defined therein
606 606 useless.
607 607
608 608 This method keeps said reference in a private dict, keyed by the
609 609 absolute path of the module object (which corresponds to the script
610 610 path). This way, for multiple executions of the same script we only
611 611 keep one copy of the namespace (the last one), thus preventing memory
612 612 leaks from old references while allowing the objects from the last
613 613 execution to be accessible.
614 614
615 615 Note: we can not allow the actual FakeModule instances to be deleted,
616 616 because of how Python tears down modules (it hard-sets all their
617 617 references to None without regard for reference counts). This method
618 618 must therefore make a *copy* of the given namespace, to allow the
619 619 original module's __dict__ to be cleared and reused.
620 620
621 621
622 622 Parameters
623 623 ----------
624 624 ns : a namespace (a dict, typically)
625 625
626 626 fname : str
627 627 Filename associated with the namespace.
628 628
629 629 Examples
630 630 --------
631 631
632 632 In [10]: import IPython
633 633
634 634 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
635 635
636 636 In [12]: IPython.__file__ in _ip._main_ns_cache
637 637 Out[12]: True
638 638 """
639 639 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
640 640
641 641 def clear_main_mod_cache(self):
642 642 """Clear the cache of main modules.
643 643
644 644 Mainly for use by utilities like %reset.
645 645
646 646 Examples
647 647 --------
648 648
649 649 In [15]: import IPython
650 650
651 651 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
652 652
653 653 In [17]: len(_ip._main_ns_cache) > 0
654 654 Out[17]: True
655 655
656 656 In [18]: _ip.clear_main_mod_cache()
657 657
658 658 In [19]: len(_ip._main_ns_cache) == 0
659 659 Out[19]: True
660 660 """
661 661 self._main_ns_cache.clear()
662 662
663 663 #-------------------------------------------------------------------------
664 664 # Things related to debugging
665 665 #-------------------------------------------------------------------------
666 666
667 667 def init_pdb(self):
668 668 # Set calling of pdb on exceptions
669 669 # self.call_pdb is a property
670 670 self.call_pdb = self.pdb
671 671
672 672 def _get_call_pdb(self):
673 673 return self._call_pdb
674 674
675 675 def _set_call_pdb(self,val):
676 676
677 677 if val not in (0,1,False,True):
678 678 raise ValueError,'new call_pdb value must be boolean'
679 679
680 680 # store value in instance
681 681 self._call_pdb = val
682 682
683 683 # notify the actual exception handlers
684 684 self.InteractiveTB.call_pdb = val
685 685
686 686 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
687 687 'Control auto-activation of pdb at exceptions')
688 688
689 689 def debugger(self,force=False):
690 690 """Call the pydb/pdb debugger.
691 691
692 692 Keywords:
693 693
694 694 - force(False): by default, this routine checks the instance call_pdb
695 695 flag and does not actually invoke the debugger if the flag is false.
696 696 The 'force' option forces the debugger to activate even if the flag
697 697 is false.
698 698 """
699 699
700 700 if not (force or self.call_pdb):
701 701 return
702 702
703 703 if not hasattr(sys,'last_traceback'):
704 704 error('No traceback has been produced, nothing to debug.')
705 705 return
706 706
707 707 # use pydb if available
708 708 if debugger.has_pydb:
709 709 from pydb import pm
710 710 else:
711 711 # fallback to our internal debugger
712 712 pm = lambda : self.InteractiveTB.debugger(force=True)
713 713 self.history_saving_wrapper(pm)()
714 714
715 715 #-------------------------------------------------------------------------
716 716 # Things related to IPython's various namespaces
717 717 #-------------------------------------------------------------------------
718 718
719 719 def init_create_namespaces(self, user_ns=None, user_global_ns=None):
720 720 # Create the namespace where the user will operate. user_ns is
721 721 # normally the only one used, and it is passed to the exec calls as
722 722 # the locals argument. But we do carry a user_global_ns namespace
723 723 # given as the exec 'globals' argument, This is useful in embedding
724 724 # situations where the ipython shell opens in a context where the
725 725 # distinction between locals and globals is meaningful. For
726 726 # non-embedded contexts, it is just the same object as the user_ns dict.
727 727
728 728 # FIXME. For some strange reason, __builtins__ is showing up at user
729 729 # level as a dict instead of a module. This is a manual fix, but I
730 730 # should really track down where the problem is coming from. Alex
731 731 # Schmolck reported this problem first.
732 732
733 733 # A useful post by Alex Martelli on this topic:
734 734 # Re: inconsistent value from __builtins__
735 735 # Von: Alex Martelli <aleaxit@yahoo.com>
736 736 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
737 737 # Gruppen: comp.lang.python
738 738
739 739 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
740 740 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
741 741 # > <type 'dict'>
742 742 # > >>> print type(__builtins__)
743 743 # > <type 'module'>
744 744 # > Is this difference in return value intentional?
745 745
746 746 # Well, it's documented that '__builtins__' can be either a dictionary
747 747 # or a module, and it's been that way for a long time. Whether it's
748 748 # intentional (or sensible), I don't know. In any case, the idea is
749 749 # that if you need to access the built-in namespace directly, you
750 750 # should start with "import __builtin__" (note, no 's') which will
751 751 # definitely give you a module. Yeah, it's somewhat confusing:-(.
752 752
753 753 # These routines return properly built dicts as needed by the rest of
754 754 # the code, and can also be used by extension writers to generate
755 755 # properly initialized namespaces.
756 756 user_ns, user_global_ns = self.make_user_namespaces(user_ns,
757 757 user_global_ns)
758 758
759 759 # Assign namespaces
760 760 # This is the namespace where all normal user variables live
761 761 self.user_ns = user_ns
762 762 self.user_global_ns = user_global_ns
763 763
764 764 # An auxiliary namespace that checks what parts of the user_ns were
765 765 # loaded at startup, so we can list later only variables defined in
766 766 # actual interactive use. Since it is always a subset of user_ns, it
767 767 # doesn't need to be separately tracked in the ns_table.
768 768 self.user_ns_hidden = {}
769 769
770 770 # A namespace to keep track of internal data structures to prevent
771 771 # them from cluttering user-visible stuff. Will be updated later
772 772 self.internal_ns = {}
773 773
774 774 # Now that FakeModule produces a real module, we've run into a nasty
775 775 # problem: after script execution (via %run), the module where the user
776 776 # code ran is deleted. Now that this object is a true module (needed
777 777 # so docetst and other tools work correctly), the Python module
778 778 # teardown mechanism runs over it, and sets to None every variable
779 779 # present in that module. Top-level references to objects from the
780 780 # script survive, because the user_ns is updated with them. However,
781 781 # calling functions defined in the script that use other things from
782 782 # the script will fail, because the function's closure had references
783 783 # to the original objects, which are now all None. So we must protect
784 784 # these modules from deletion by keeping a cache.
785 785 #
786 786 # To avoid keeping stale modules around (we only need the one from the
787 787 # last run), we use a dict keyed with the full path to the script, so
788 788 # only the last version of the module is held in the cache. Note,
789 789 # however, that we must cache the module *namespace contents* (their
790 790 # __dict__). Because if we try to cache the actual modules, old ones
791 791 # (uncached) could be destroyed while still holding references (such as
792 792 # those held by GUI objects that tend to be long-lived)>
793 793 #
794 794 # The %reset command will flush this cache. See the cache_main_mod()
795 795 # and clear_main_mod_cache() methods for details on use.
796 796
797 797 # This is the cache used for 'main' namespaces
798 798 self._main_ns_cache = {}
799 799 # And this is the single instance of FakeModule whose __dict__ we keep
800 800 # copying and clearing for reuse on each %run
801 801 self._user_main_module = FakeModule()
802 802
803 803 # A table holding all the namespaces IPython deals with, so that
804 804 # introspection facilities can search easily.
805 805 self.ns_table = {'user':user_ns,
806 806 'user_global':user_global_ns,
807 807 'internal':self.internal_ns,
808 808 'builtin':__builtin__.__dict__
809 809 }
810 810
811 811 # Similarly, track all namespaces where references can be held and that
812 812 # we can safely clear (so it can NOT include builtin). This one can be
813 813 # a simple list. Note that the main execution namespaces, user_ns and
814 814 # user_global_ns, can NOT be listed here, as clearing them blindly
815 815 # causes errors in object __del__ methods. Instead, the reset() method
816 816 # clears them manually and carefully.
817 817 self.ns_refs_table = [ self.user_ns_hidden,
818 818 self.internal_ns, self._main_ns_cache ]
819 819
820 820 def make_user_namespaces(self, user_ns=None, user_global_ns=None):
821 821 """Return a valid local and global user interactive namespaces.
822 822
823 823 This builds a dict with the minimal information needed to operate as a
824 824 valid IPython user namespace, which you can pass to the various
825 825 embedding classes in ipython. The default implementation returns the
826 826 same dict for both the locals and the globals to allow functions to
827 827 refer to variables in the namespace. Customized implementations can
828 828 return different dicts. The locals dictionary can actually be anything
829 829 following the basic mapping protocol of a dict, but the globals dict
830 830 must be a true dict, not even a subclass. It is recommended that any
831 831 custom object for the locals namespace synchronize with the globals
832 832 dict somehow.
833 833
834 834 Raises TypeError if the provided globals namespace is not a true dict.
835 835
836 836 Parameters
837 837 ----------
838 838 user_ns : dict-like, optional
839 839 The current user namespace. The items in this namespace should
840 840 be included in the output. If None, an appropriate blank
841 841 namespace should be created.
842 842 user_global_ns : dict, optional
843 843 The current user global namespace. The items in this namespace
844 844 should be included in the output. If None, an appropriate
845 845 blank namespace should be created.
846 846
847 847 Returns
848 848 -------
849 849 A pair of dictionary-like object to be used as the local namespace
850 850 of the interpreter and a dict to be used as the global namespace.
851 851 """
852 852
853 853
854 854 # We must ensure that __builtin__ (without the final 's') is always
855 855 # available and pointing to the __builtin__ *module*. For more details:
856 856 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
857 857
858 858 if user_ns is None:
859 859 # Set __name__ to __main__ to better match the behavior of the
860 860 # normal interpreter.
861 861 user_ns = {'__name__' :'__main__',
862 862 '__builtin__' : __builtin__,
863 863 '__builtins__' : __builtin__,
864 864 }
865 865 else:
866 866 user_ns.setdefault('__name__','__main__')
867 867 user_ns.setdefault('__builtin__',__builtin__)
868 868 user_ns.setdefault('__builtins__',__builtin__)
869 869
870 870 if user_global_ns is None:
871 871 user_global_ns = user_ns
872 872 if type(user_global_ns) is not dict:
873 873 raise TypeError("user_global_ns must be a true dict; got %r"
874 874 % type(user_global_ns))
875 875
876 876 return user_ns, user_global_ns
877 877
878 878 def init_sys_modules(self):
879 879 # We need to insert into sys.modules something that looks like a
880 880 # module but which accesses the IPython namespace, for shelve and
881 881 # pickle to work interactively. Normally they rely on getting
882 882 # everything out of __main__, but for embedding purposes each IPython
883 883 # instance has its own private namespace, so we can't go shoving
884 884 # everything into __main__.
885 885
886 886 # note, however, that we should only do this for non-embedded
887 887 # ipythons, which really mimic the __main__.__dict__ with their own
888 888 # namespace. Embedded instances, on the other hand, should not do
889 889 # this because they need to manage the user local/global namespaces
890 890 # only, but they live within a 'normal' __main__ (meaning, they
891 891 # shouldn't overtake the execution environment of the script they're
892 892 # embedded in).
893 893
894 894 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
895 895
896 896 try:
897 897 main_name = self.user_ns['__name__']
898 898 except KeyError:
899 899 raise KeyError('user_ns dictionary MUST have a "__name__" key')
900 900 else:
901 901 sys.modules[main_name] = FakeModule(self.user_ns)
902 902
903 903 def init_user_ns(self):
904 904 """Initialize all user-visible namespaces to their minimum defaults.
905 905
906 906 Certain history lists are also initialized here, as they effectively
907 907 act as user namespaces.
908 908
909 909 Notes
910 910 -----
911 911 All data structures here are only filled in, they are NOT reset by this
912 912 method. If they were not empty before, data will simply be added to
913 913 therm.
914 914 """
915 915 # This function works in two parts: first we put a few things in
916 916 # user_ns, and we sync that contents into user_ns_hidden so that these
917 917 # initial variables aren't shown by %who. After the sync, we add the
918 918 # rest of what we *do* want the user to see with %who even on a new
919 919 # session (probably nothing, so theye really only see their own stuff)
920 920
921 921 # The user dict must *always* have a __builtin__ reference to the
922 922 # Python standard __builtin__ namespace, which must be imported.
923 923 # This is so that certain operations in prompt evaluation can be
924 924 # reliably executed with builtins. Note that we can NOT use
925 925 # __builtins__ (note the 's'), because that can either be a dict or a
926 926 # module, and can even mutate at runtime, depending on the context
927 927 # (Python makes no guarantees on it). In contrast, __builtin__ is
928 928 # always a module object, though it must be explicitly imported.
929 929
930 930 # For more details:
931 931 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
932 932 ns = dict(__builtin__ = __builtin__)
933 933
934 934 # Put 'help' in the user namespace
935 935 try:
936 936 from site import _Helper
937 937 ns['help'] = _Helper()
938 938 except ImportError:
939 939 warn('help() not available - check site.py')
940 940
941 941 # make global variables for user access to the histories
942 942 ns['_ih'] = self.input_hist
943 943 ns['_oh'] = self.output_hist
944 944 ns['_dh'] = self.dir_hist
945 945
946 946 ns['_sh'] = shadowns
947 947
948 948 # user aliases to input and output histories. These shouldn't show up
949 949 # in %who, as they can have very large reprs.
950 950 ns['In'] = self.input_hist
951 951 ns['Out'] = self.output_hist
952 952
953 953 # Store myself as the public api!!!
954 954 ns['get_ipython'] = self.get_ipython
955 955
956 956 # Sync what we've added so far to user_ns_hidden so these aren't seen
957 957 # by %who
958 958 self.user_ns_hidden.update(ns)
959 959
960 960 # Anything put into ns now would show up in %who. Think twice before
961 961 # putting anything here, as we really want %who to show the user their
962 962 # stuff, not our variables.
963 963
964 964 # Finally, update the real user's namespace
965 965 self.user_ns.update(ns)
966 966
967 967
968 968 def reset(self):
969 969 """Clear all internal namespaces.
970 970
971 971 Note that this is much more aggressive than %reset, since it clears
972 972 fully all namespaces, as well as all input/output lists.
973 973 """
974 974 self.alias_manager.clear_aliases()
975 975
976 976 # Clear input and output histories
977 977 self.input_hist[:] = []
978 978 self.input_hist_raw[:] = []
979 979 self.output_hist.clear()
980 980
981 981 # Clear namespaces holding user references
982 982 for ns in self.ns_refs_table:
983 983 ns.clear()
984 984
985 985 # The main execution namespaces must be cleared very carefully,
986 # skipping the deletion of the __builtin__ key, because doing so would
987 # cause errors in many object's __del__ methods.
986 # skipping the deletion of the builtin-related keys, because doing so
987 # would cause errors in many object's __del__ methods.
988 988 for ns in [self.user_ns, self.user_global_ns]:
989 989 drop_keys = set(ns.keys())
990 990 drop_keys.discard('__builtin__')
991 drop_keys.discard('__builtins__')
991 992 for k in drop_keys:
992 993 del ns[k]
993 994
994 995 # Restore the user namespaces to minimal usability
995 996 self.init_user_ns()
996 997
997 998 # Restore the default and user aliases
998 999 self.alias_manager.init_aliases()
999 1000
1000 1001 def reset_selective(self, regex=None):
1001 1002 """Clear selective variables from internal namespaces based on a
1002 1003 specified regular expression.
1003 1004
1004 1005 Parameters
1005 1006 ----------
1006 1007 regex : string or compiled pattern, optional
1007 1008 A regular expression pattern that will be used in searching
1008 1009 variable names in the users namespaces.
1009 1010 """
1010 1011 if regex is not None:
1011 1012 try:
1012 1013 m = re.compile(regex)
1013 1014 except TypeError:
1014 1015 raise TypeError('regex must be a string or compiled pattern')
1015 1016 # Search for keys in each namespace that match the given regex
1016 1017 # If a match is found, delete the key/value pair.
1017 1018 for ns in self.ns_refs_table:
1018 1019 for var in ns:
1019 1020 if m.search(var):
1020 1021 del ns[var]
1021 1022
1022 1023 def push(self, variables, interactive=True):
1023 1024 """Inject a group of variables into the IPython user namespace.
1024 1025
1025 1026 Parameters
1026 1027 ----------
1027 1028 variables : dict, str or list/tuple of str
1028 1029 The variables to inject into the user's namespace. If a dict, a
1029 1030 simple update is done. If a str, the string is assumed to have
1030 1031 variable names separated by spaces. A list/tuple of str can also
1031 1032 be used to give the variable names. If just the variable names are
1032 1033 give (list/tuple/str) then the variable values looked up in the
1033 1034 callers frame.
1034 1035 interactive : bool
1035 1036 If True (default), the variables will be listed with the ``who``
1036 1037 magic.
1037 1038 """
1038 1039 vdict = None
1039 1040
1040 1041 # We need a dict of name/value pairs to do namespace updates.
1041 1042 if isinstance(variables, dict):
1042 1043 vdict = variables
1043 1044 elif isinstance(variables, (basestring, list, tuple)):
1044 1045 if isinstance(variables, basestring):
1045 1046 vlist = variables.split()
1046 1047 else:
1047 1048 vlist = variables
1048 1049 vdict = {}
1049 1050 cf = sys._getframe(1)
1050 1051 for name in vlist:
1051 1052 try:
1052 1053 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1053 1054 except:
1054 1055 print ('Could not get variable %s from %s' %
1055 1056 (name,cf.f_code.co_name))
1056 1057 else:
1057 1058 raise ValueError('variables must be a dict/str/list/tuple')
1058 1059
1059 1060 # Propagate variables to user namespace
1060 1061 self.user_ns.update(vdict)
1061 1062
1062 1063 # And configure interactive visibility
1063 1064 config_ns = self.user_ns_hidden
1064 1065 if interactive:
1065 1066 for name, val in vdict.iteritems():
1066 1067 config_ns.pop(name, None)
1067 1068 else:
1068 1069 for name,val in vdict.iteritems():
1069 1070 config_ns[name] = val
1070 1071
1071 1072 #-------------------------------------------------------------------------
1072 1073 # Things related to object introspection
1073 1074 #-------------------------------------------------------------------------
1074 1075
1075 1076 def _ofind(self, oname, namespaces=None):
1076 1077 """Find an object in the available namespaces.
1077 1078
1078 1079 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1079 1080
1080 1081 Has special code to detect magic functions.
1081 1082 """
1082 1083 #oname = oname.strip()
1083 1084 #print '1- oname: <%r>' % oname # dbg
1084 1085 try:
1085 1086 oname = oname.strip().encode('ascii')
1086 1087 #print '2- oname: <%r>' % oname # dbg
1087 1088 except UnicodeEncodeError:
1088 1089 print 'Python identifiers can only contain ascii characters.'
1089 1090 return dict(found=False)
1090 1091
1091 1092 alias_ns = None
1092 1093 if namespaces is None:
1093 1094 # Namespaces to search in:
1094 1095 # Put them in a list. The order is important so that we
1095 1096 # find things in the same order that Python finds them.
1096 1097 namespaces = [ ('Interactive', self.user_ns),
1097 1098 ('IPython internal', self.internal_ns),
1098 1099 ('Python builtin', __builtin__.__dict__),
1099 1100 ('Alias', self.alias_manager.alias_table),
1100 1101 ]
1101 1102 alias_ns = self.alias_manager.alias_table
1102 1103
1103 1104 # initialize results to 'null'
1104 1105 found = False; obj = None; ospace = None; ds = None;
1105 1106 ismagic = False; isalias = False; parent = None
1106 1107
1107 1108 # We need to special-case 'print', which as of python2.6 registers as a
1108 1109 # function but should only be treated as one if print_function was
1109 1110 # loaded with a future import. In this case, just bail.
1110 1111 if (oname == 'print' and not (self.compile.compiler.flags &
1111 1112 __future__.CO_FUTURE_PRINT_FUNCTION)):
1112 1113 return {'found':found, 'obj':obj, 'namespace':ospace,
1113 1114 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1114 1115
1115 1116 # Look for the given name by splitting it in parts. If the head is
1116 1117 # found, then we look for all the remaining parts as members, and only
1117 1118 # declare success if we can find them all.
1118 1119 oname_parts = oname.split('.')
1119 1120 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1120 1121 for nsname,ns in namespaces:
1121 1122 try:
1122 1123 obj = ns[oname_head]
1123 1124 except KeyError:
1124 1125 continue
1125 1126 else:
1126 1127 #print 'oname_rest:', oname_rest # dbg
1127 1128 for part in oname_rest:
1128 1129 try:
1129 1130 parent = obj
1130 1131 obj = getattr(obj,part)
1131 1132 except:
1132 1133 # Blanket except b/c some badly implemented objects
1133 1134 # allow __getattr__ to raise exceptions other than
1134 1135 # AttributeError, which then crashes IPython.
1135 1136 break
1136 1137 else:
1137 1138 # If we finish the for loop (no break), we got all members
1138 1139 found = True
1139 1140 ospace = nsname
1140 1141 if ns == alias_ns:
1141 1142 isalias = True
1142 1143 break # namespace loop
1143 1144
1144 1145 # Try to see if it's magic
1145 1146 if not found:
1146 1147 if oname.startswith(ESC_MAGIC):
1147 1148 oname = oname[1:]
1148 1149 obj = getattr(self,'magic_'+oname,None)
1149 1150 if obj is not None:
1150 1151 found = True
1151 1152 ospace = 'IPython internal'
1152 1153 ismagic = True
1153 1154
1154 1155 # Last try: special-case some literals like '', [], {}, etc:
1155 1156 if not found and oname_head in ["''",'""','[]','{}','()']:
1156 1157 obj = eval(oname_head)
1157 1158 found = True
1158 1159 ospace = 'Interactive'
1159 1160
1160 1161 return {'found':found, 'obj':obj, 'namespace':ospace,
1161 1162 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1162 1163
1163 1164 def _ofind_property(self, oname, info):
1164 1165 """Second part of object finding, to look for property details."""
1165 1166 if info.found:
1166 1167 # Get the docstring of the class property if it exists.
1167 1168 path = oname.split('.')
1168 1169 root = '.'.join(path[:-1])
1169 1170 if info.parent is not None:
1170 1171 try:
1171 1172 target = getattr(info.parent, '__class__')
1172 1173 # The object belongs to a class instance.
1173 1174 try:
1174 1175 target = getattr(target, path[-1])
1175 1176 # The class defines the object.
1176 1177 if isinstance(target, property):
1177 1178 oname = root + '.__class__.' + path[-1]
1178 1179 info = Struct(self._ofind(oname))
1179 1180 except AttributeError: pass
1180 1181 except AttributeError: pass
1181 1182
1182 1183 # We return either the new info or the unmodified input if the object
1183 1184 # hadn't been found
1184 1185 return info
1185 1186
1186 1187 def _object_find(self, oname, namespaces=None):
1187 1188 """Find an object and return a struct with info about it."""
1188 1189 inf = Struct(self._ofind(oname, namespaces))
1189 1190 return Struct(self._ofind_property(oname, inf))
1190 1191
1191 1192 def _inspect(self, meth, oname, namespaces=None, **kw):
1192 1193 """Generic interface to the inspector system.
1193 1194
1194 1195 This function is meant to be called by pdef, pdoc & friends."""
1195 1196 info = self._object_find(oname)
1196 1197 if info.found:
1197 1198 pmethod = getattr(self.inspector, meth)
1198 1199 formatter = format_screen if info.ismagic else None
1199 1200 if meth == 'pdoc':
1200 1201 pmethod(info.obj, oname, formatter)
1201 1202 elif meth == 'pinfo':
1202 1203 pmethod(info.obj, oname, formatter, info, **kw)
1203 1204 else:
1204 1205 pmethod(info.obj, oname)
1205 1206 else:
1206 1207 print 'Object `%s` not found.' % oname
1207 1208 return 'not found' # so callers can take other action
1208 1209
1209 1210 def object_inspect(self, oname):
1210 1211 info = self._object_find(oname)
1211 1212 if info.found:
1212 1213 return self.inspector.info(info.obj, oname, info=info)
1213 1214 else:
1214 1215 return oinspect.object_info(name=oname, found=False)
1215 1216
1216 1217 #-------------------------------------------------------------------------
1217 1218 # Things related to history management
1218 1219 #-------------------------------------------------------------------------
1219 1220
1220 1221 def init_history(self):
1221 1222 # List of input with multi-line handling.
1222 1223 self.input_hist = InputList()
1223 1224 # This one will hold the 'raw' input history, without any
1224 1225 # pre-processing. This will allow users to retrieve the input just as
1225 1226 # it was exactly typed in by the user, with %hist -r.
1226 1227 self.input_hist_raw = InputList()
1227 1228
1228 1229 # list of visited directories
1229 1230 try:
1230 1231 self.dir_hist = [os.getcwd()]
1231 1232 except OSError:
1232 1233 self.dir_hist = []
1233 1234
1234 1235 # dict of output history
1235 1236 self.output_hist = {}
1236 1237
1237 1238 # Now the history file
1238 1239 if self.profile:
1239 1240 histfname = 'history-%s' % self.profile
1240 1241 else:
1241 1242 histfname = 'history'
1242 1243 self.histfile = os.path.join(self.ipython_dir, histfname)
1243 1244
1244 1245 # Fill the history zero entry, user counter starts at 1
1245 1246 self.input_hist.append('\n')
1246 1247 self.input_hist_raw.append('\n')
1247 1248
1248 1249 def init_shadow_hist(self):
1249 1250 try:
1250 1251 self.db = pickleshare.PickleShareDB(self.ipython_dir + "/db")
1251 1252 except exceptions.UnicodeDecodeError:
1252 1253 print "Your ipython_dir can't be decoded to unicode!"
1253 1254 print "Please set HOME environment variable to something that"
1254 1255 print r"only has ASCII characters, e.g. c:\home"
1255 1256 print "Now it is", self.ipython_dir
1256 1257 sys.exit()
1257 1258 self.shadowhist = ipcorehist.ShadowHist(self.db)
1258 1259
1259 1260 def savehist(self):
1260 1261 """Save input history to a file (via readline library)."""
1261 1262
1262 1263 try:
1263 1264 self.readline.write_history_file(self.histfile)
1264 1265 except:
1265 1266 print 'Unable to save IPython command history to file: ' + \
1266 1267 `self.histfile`
1267 1268
1268 1269 def reloadhist(self):
1269 1270 """Reload the input history from disk file."""
1270 1271
1271 1272 try:
1272 1273 self.readline.clear_history()
1273 1274 self.readline.read_history_file(self.shell.histfile)
1274 1275 except AttributeError:
1275 1276 pass
1276 1277
1277 1278 def history_saving_wrapper(self, func):
1278 1279 """ Wrap func for readline history saving
1279 1280
1280 1281 Convert func into callable that saves & restores
1281 1282 history around the call """
1282 1283
1283 1284 if self.has_readline:
1284 1285 from IPython.utils import rlineimpl as readline
1285 1286 else:
1286 1287 return func
1287 1288
1288 1289 def wrapper():
1289 1290 self.savehist()
1290 1291 try:
1291 1292 func()
1292 1293 finally:
1293 1294 readline.read_history_file(self.histfile)
1294 1295 return wrapper
1295 1296
1296 1297 def get_history(self, index=None, raw=False, output=True):
1297 1298 """Get the history list.
1298 1299
1299 1300 Get the input and output history.
1300 1301
1301 1302 Parameters
1302 1303 ----------
1303 1304 index : n or (n1, n2) or None
1304 1305 If n, then the last entries. If a tuple, then all in
1305 1306 range(n1, n2). If None, then all entries. Raises IndexError if
1306 1307 the format of index is incorrect.
1307 1308 raw : bool
1308 1309 If True, return the raw input.
1309 1310 output : bool
1310 1311 If True, then return the output as well.
1311 1312
1312 1313 Returns
1313 1314 -------
1314 1315 If output is True, then return a dict of tuples, keyed by the prompt
1315 1316 numbers and with values of (input, output). If output is False, then
1316 1317 a dict, keyed by the prompt number with the values of input. Raises
1317 1318 IndexError if no history is found.
1318 1319 """
1319 1320 if raw:
1320 1321 input_hist = self.input_hist_raw
1321 1322 else:
1322 1323 input_hist = self.input_hist
1323 1324 if output:
1324 1325 output_hist = self.user_ns['Out']
1325 1326 n = len(input_hist)
1326 1327 if index is None:
1327 1328 start=0; stop=n
1328 1329 elif isinstance(index, int):
1329 1330 start=n-index; stop=n
1330 1331 elif isinstance(index, tuple) and len(index) == 2:
1331 1332 start=index[0]; stop=index[1]
1332 1333 else:
1333 1334 raise IndexError('Not a valid index for the input history: %r'
1334 1335 % index)
1335 1336 hist = {}
1336 1337 for i in range(start, stop):
1337 1338 if output:
1338 1339 hist[i] = (input_hist[i], output_hist.get(i))
1339 1340 else:
1340 1341 hist[i] = input_hist[i]
1341 1342 if len(hist)==0:
1342 1343 raise IndexError('No history for range of indices: %r' % index)
1343 1344 return hist
1344 1345
1345 1346 #-------------------------------------------------------------------------
1346 1347 # Things related to exception handling and tracebacks (not debugging)
1347 1348 #-------------------------------------------------------------------------
1348 1349
1349 1350 def init_traceback_handlers(self, custom_exceptions):
1350 1351 # Syntax error handler.
1351 1352 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1352 1353
1353 1354 # The interactive one is initialized with an offset, meaning we always
1354 1355 # want to remove the topmost item in the traceback, which is our own
1355 1356 # internal code. Valid modes: ['Plain','Context','Verbose']
1356 1357 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1357 1358 color_scheme='NoColor',
1358 1359 tb_offset = 1)
1359 1360
1360 1361 # The instance will store a pointer to the system-wide exception hook,
1361 1362 # so that runtime code (such as magics) can access it. This is because
1362 1363 # during the read-eval loop, it may get temporarily overwritten.
1363 1364 self.sys_excepthook = sys.excepthook
1364 1365
1365 1366 # and add any custom exception handlers the user may have specified
1366 1367 self.set_custom_exc(*custom_exceptions)
1367 1368
1368 1369 # Set the exception mode
1369 1370 self.InteractiveTB.set_mode(mode=self.xmode)
1370 1371
1371 1372 def set_custom_exc(self, exc_tuple, handler):
1372 1373 """set_custom_exc(exc_tuple,handler)
1373 1374
1374 1375 Set a custom exception handler, which will be called if any of the
1375 1376 exceptions in exc_tuple occur in the mainloop (specifically, in the
1376 1377 runcode() method.
1377 1378
1378 1379 Inputs:
1379 1380
1380 1381 - exc_tuple: a *tuple* of valid exceptions to call the defined
1381 1382 handler for. It is very important that you use a tuple, and NOT A
1382 1383 LIST here, because of the way Python's except statement works. If
1383 1384 you only want to trap a single exception, use a singleton tuple:
1384 1385
1385 1386 exc_tuple == (MyCustomException,)
1386 1387
1387 1388 - handler: this must be defined as a function with the following
1388 1389 basic interface::
1389 1390
1390 1391 def my_handler(self, etype, value, tb, tb_offset=None)
1391 1392 ...
1392 1393 # The return value must be
1393 1394 return structured_traceback
1394 1395
1395 1396 This will be made into an instance method (via new.instancemethod)
1396 1397 of IPython itself, and it will be called if any of the exceptions
1397 1398 listed in the exc_tuple are caught. If the handler is None, an
1398 1399 internal basic one is used, which just prints basic info.
1399 1400
1400 1401 WARNING: by putting in your own exception handler into IPython's main
1401 1402 execution loop, you run a very good chance of nasty crashes. This
1402 1403 facility should only be used if you really know what you are doing."""
1403 1404
1404 1405 assert type(exc_tuple)==type(()) , \
1405 1406 "The custom exceptions must be given AS A TUPLE."
1406 1407
1407 1408 def dummy_handler(self,etype,value,tb):
1408 1409 print '*** Simple custom exception handler ***'
1409 1410 print 'Exception type :',etype
1410 1411 print 'Exception value:',value
1411 1412 print 'Traceback :',tb
1412 1413 print 'Source code :','\n'.join(self.buffer)
1413 1414
1414 1415 if handler is None: handler = dummy_handler
1415 1416
1416 1417 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1417 1418 self.custom_exceptions = exc_tuple
1418 1419
1419 1420 def excepthook(self, etype, value, tb):
1420 1421 """One more defense for GUI apps that call sys.excepthook.
1421 1422
1422 1423 GUI frameworks like wxPython trap exceptions and call
1423 1424 sys.excepthook themselves. I guess this is a feature that
1424 1425 enables them to keep running after exceptions that would
1425 1426 otherwise kill their mainloop. This is a bother for IPython
1426 1427 which excepts to catch all of the program exceptions with a try:
1427 1428 except: statement.
1428 1429
1429 1430 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1430 1431 any app directly invokes sys.excepthook, it will look to the user like
1431 1432 IPython crashed. In order to work around this, we can disable the
1432 1433 CrashHandler and replace it with this excepthook instead, which prints a
1433 1434 regular traceback using our InteractiveTB. In this fashion, apps which
1434 1435 call sys.excepthook will generate a regular-looking exception from
1435 1436 IPython, and the CrashHandler will only be triggered by real IPython
1436 1437 crashes.
1437 1438
1438 1439 This hook should be used sparingly, only in places which are not likely
1439 1440 to be true IPython errors.
1440 1441 """
1441 1442 self.showtraceback((etype,value,tb),tb_offset=0)
1442 1443
1443 1444 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1444 1445 exception_only=False):
1445 1446 """Display the exception that just occurred.
1446 1447
1447 1448 If nothing is known about the exception, this is the method which
1448 1449 should be used throughout the code for presenting user tracebacks,
1449 1450 rather than directly invoking the InteractiveTB object.
1450 1451
1451 1452 A specific showsyntaxerror() also exists, but this method can take
1452 1453 care of calling it if needed, so unless you are explicitly catching a
1453 1454 SyntaxError exception, don't try to analyze the stack manually and
1454 1455 simply call this method."""
1455 1456
1456 1457 try:
1457 1458 if exc_tuple is None:
1458 1459 etype, value, tb = sys.exc_info()
1459 1460 else:
1460 1461 etype, value, tb = exc_tuple
1461 1462
1462 1463 if etype is None:
1463 1464 if hasattr(sys, 'last_type'):
1464 1465 etype, value, tb = sys.last_type, sys.last_value, \
1465 1466 sys.last_traceback
1466 1467 else:
1467 1468 self.write_err('No traceback available to show.\n')
1468 1469 return
1469 1470
1470 1471 if etype is SyntaxError:
1471 1472 # Though this won't be called by syntax errors in the input
1472 1473 # line, there may be SyntaxError cases whith imported code.
1473 1474 self.showsyntaxerror(filename)
1474 1475 elif etype is UsageError:
1475 1476 print "UsageError:", value
1476 1477 else:
1477 1478 # WARNING: these variables are somewhat deprecated and not
1478 1479 # necessarily safe to use in a threaded environment, but tools
1479 1480 # like pdb depend on their existence, so let's set them. If we
1480 1481 # find problems in the field, we'll need to revisit their use.
1481 1482 sys.last_type = etype
1482 1483 sys.last_value = value
1483 1484 sys.last_traceback = tb
1484 1485
1485 1486 if etype in self.custom_exceptions:
1486 1487 # FIXME: Old custom traceback objects may just return a
1487 1488 # string, in that case we just put it into a list
1488 1489 stb = self.CustomTB(etype, value, tb, tb_offset)
1489 1490 if isinstance(ctb, basestring):
1490 1491 stb = [stb]
1491 1492 else:
1492 1493 if exception_only:
1493 1494 stb = ['An exception has occurred, use %tb to see '
1494 1495 'the full traceback.\n']
1495 1496 stb.extend(self.InteractiveTB.get_exception_only(etype,
1496 1497 value))
1497 1498 else:
1498 1499 stb = self.InteractiveTB.structured_traceback(etype,
1499 1500 value, tb, tb_offset=tb_offset)
1500 1501 # FIXME: the pdb calling should be done by us, not by
1501 1502 # the code computing the traceback.
1502 1503 if self.InteractiveTB.call_pdb:
1503 1504 # pdb mucks up readline, fix it back
1504 1505 self.set_readline_completer()
1505 1506
1506 1507 # Actually show the traceback
1507 1508 self._showtraceback(etype, value, stb)
1508 1509
1509 1510 except KeyboardInterrupt:
1510 1511 self.write_err("\nKeyboardInterrupt\n")
1511 1512
1512 1513 def _showtraceback(self, etype, evalue, stb):
1513 1514 """Actually show a traceback.
1514 1515
1515 1516 Subclasses may override this method to put the traceback on a different
1516 1517 place, like a side channel.
1517 1518 """
1518 1519 print >> io.Term.cout, self.InteractiveTB.stb2text(stb)
1519 1520
1520 1521 def showsyntaxerror(self, filename=None):
1521 1522 """Display the syntax error that just occurred.
1522 1523
1523 1524 This doesn't display a stack trace because there isn't one.
1524 1525
1525 1526 If a filename is given, it is stuffed in the exception instead
1526 1527 of what was there before (because Python's parser always uses
1527 1528 "<string>" when reading from a string).
1528 1529 """
1529 1530 etype, value, last_traceback = sys.exc_info()
1530 1531
1531 1532 # See note about these variables in showtraceback() above
1532 1533 sys.last_type = etype
1533 1534 sys.last_value = value
1534 1535 sys.last_traceback = last_traceback
1535 1536
1536 1537 if filename and etype is SyntaxError:
1537 1538 # Work hard to stuff the correct filename in the exception
1538 1539 try:
1539 1540 msg, (dummy_filename, lineno, offset, line) = value
1540 1541 except:
1541 1542 # Not the format we expect; leave it alone
1542 1543 pass
1543 1544 else:
1544 1545 # Stuff in the right filename
1545 1546 try:
1546 1547 # Assume SyntaxError is a class exception
1547 1548 value = SyntaxError(msg, (filename, lineno, offset, line))
1548 1549 except:
1549 1550 # If that failed, assume SyntaxError is a string
1550 1551 value = msg, (filename, lineno, offset, line)
1551 1552 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1552 1553 self._showtraceback(etype, value, stb)
1553 1554
1554 1555 #-------------------------------------------------------------------------
1555 1556 # Things related to readline
1556 1557 #-------------------------------------------------------------------------
1557 1558
1558 1559 def init_readline(self):
1559 1560 """Command history completion/saving/reloading."""
1560 1561
1561 1562 if self.readline_use:
1562 1563 import IPython.utils.rlineimpl as readline
1563 1564
1564 1565 self.rl_next_input = None
1565 1566 self.rl_do_indent = False
1566 1567
1567 1568 if not self.readline_use or not readline.have_readline:
1568 1569 self.has_readline = False
1569 1570 self.readline = None
1570 1571 # Set a number of methods that depend on readline to be no-op
1571 1572 self.savehist = no_op
1572 1573 self.reloadhist = no_op
1573 1574 self.set_readline_completer = no_op
1574 1575 self.set_custom_completer = no_op
1575 1576 self.set_completer_frame = no_op
1576 1577 warn('Readline services not available or not loaded.')
1577 1578 else:
1578 1579 self.has_readline = True
1579 1580 self.readline = readline
1580 1581 sys.modules['readline'] = readline
1581 1582
1582 1583 # Platform-specific configuration
1583 1584 if os.name == 'nt':
1584 1585 # FIXME - check with Frederick to see if we can harmonize
1585 1586 # naming conventions with pyreadline to avoid this
1586 1587 # platform-dependent check
1587 1588 self.readline_startup_hook = readline.set_pre_input_hook
1588 1589 else:
1589 1590 self.readline_startup_hook = readline.set_startup_hook
1590 1591
1591 1592 # Load user's initrc file (readline config)
1592 1593 # Or if libedit is used, load editrc.
1593 1594 inputrc_name = os.environ.get('INPUTRC')
1594 1595 if inputrc_name is None:
1595 1596 home_dir = get_home_dir()
1596 1597 if home_dir is not None:
1597 1598 inputrc_name = '.inputrc'
1598 1599 if readline.uses_libedit:
1599 1600 inputrc_name = '.editrc'
1600 1601 inputrc_name = os.path.join(home_dir, inputrc_name)
1601 1602 if os.path.isfile(inputrc_name):
1602 1603 try:
1603 1604 readline.read_init_file(inputrc_name)
1604 1605 except:
1605 1606 warn('Problems reading readline initialization file <%s>'
1606 1607 % inputrc_name)
1607 1608
1608 1609 # Configure readline according to user's prefs
1609 1610 # This is only done if GNU readline is being used. If libedit
1610 1611 # is being used (as on Leopard) the readline config is
1611 1612 # not run as the syntax for libedit is different.
1612 1613 if not readline.uses_libedit:
1613 1614 for rlcommand in self.readline_parse_and_bind:
1614 1615 #print "loading rl:",rlcommand # dbg
1615 1616 readline.parse_and_bind(rlcommand)
1616 1617
1617 1618 # Remove some chars from the delimiters list. If we encounter
1618 1619 # unicode chars, discard them.
1619 1620 delims = readline.get_completer_delims().encode("ascii", "ignore")
1620 1621 delims = delims.translate(string._idmap,
1621 1622 self.readline_remove_delims)
1622 1623 delims = delims.replace(ESC_MAGIC, '')
1623 1624 readline.set_completer_delims(delims)
1624 1625 # otherwise we end up with a monster history after a while:
1625 1626 readline.set_history_length(1000)
1626 1627 try:
1627 1628 #print '*** Reading readline history' # dbg
1628 1629 readline.read_history_file(self.histfile)
1629 1630 except IOError:
1630 1631 pass # It doesn't exist yet.
1631 1632
1632 1633 # If we have readline, we want our history saved upon ipython
1633 1634 # exiting.
1634 1635 atexit.register(self.savehist)
1635 1636
1636 1637 # Configure auto-indent for all platforms
1637 1638 self.set_autoindent(self.autoindent)
1638 1639
1639 1640 def set_next_input(self, s):
1640 1641 """ Sets the 'default' input string for the next command line.
1641 1642
1642 1643 Requires readline.
1643 1644
1644 1645 Example:
1645 1646
1646 1647 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1647 1648 [D:\ipython]|2> Hello Word_ # cursor is here
1648 1649 """
1649 1650
1650 1651 self.rl_next_input = s
1651 1652
1652 1653 # Maybe move this to the terminal subclass?
1653 1654 def pre_readline(self):
1654 1655 """readline hook to be used at the start of each line.
1655 1656
1656 1657 Currently it handles auto-indent only."""
1657 1658
1658 1659 if self.rl_do_indent:
1659 1660 self.readline.insert_text(self._indent_current_str())
1660 1661 if self.rl_next_input is not None:
1661 1662 self.readline.insert_text(self.rl_next_input)
1662 1663 self.rl_next_input = None
1663 1664
1664 1665 def _indent_current_str(self):
1665 1666 """return the current level of indentation as a string"""
1666 1667 return self.indent_current_nsp * ' '
1667 1668
1668 1669 #-------------------------------------------------------------------------
1669 1670 # Things related to text completion
1670 1671 #-------------------------------------------------------------------------
1671 1672
1672 1673 def init_completer(self):
1673 1674 """Initialize the completion machinery.
1674 1675
1675 1676 This creates completion machinery that can be used by client code,
1676 1677 either interactively in-process (typically triggered by the readline
1677 1678 library), programatically (such as in test suites) or out-of-prcess
1678 1679 (typically over the network by remote frontends).
1679 1680 """
1680 1681 from IPython.core.completer import IPCompleter
1681 1682 from IPython.core.completerlib import (module_completer,
1682 1683 magic_run_completer, cd_completer)
1683 1684
1684 1685 self.Completer = IPCompleter(self,
1685 1686 self.user_ns,
1686 1687 self.user_global_ns,
1687 1688 self.readline_omit__names,
1688 1689 self.alias_manager.alias_table,
1689 1690 self.has_readline)
1690 1691
1691 1692 # Add custom completers to the basic ones built into IPCompleter
1692 1693 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1693 1694 self.strdispatchers['complete_command'] = sdisp
1694 1695 self.Completer.custom_completers = sdisp
1695 1696
1696 1697 self.set_hook('complete_command', module_completer, str_key = 'import')
1697 1698 self.set_hook('complete_command', module_completer, str_key = 'from')
1698 1699 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1699 1700 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1700 1701
1701 1702 # Only configure readline if we truly are using readline. IPython can
1702 1703 # do tab-completion over the network, in GUIs, etc, where readline
1703 1704 # itself may be absent
1704 1705 if self.has_readline:
1705 1706 self.set_readline_completer()
1706 1707
1707 1708 def complete(self, text, line=None, cursor_pos=None):
1708 1709 """Return the completed text and a list of completions.
1709 1710
1710 1711 Parameters
1711 1712 ----------
1712 1713
1713 1714 text : string
1714 1715 A string of text to be completed on. It can be given as empty and
1715 1716 instead a line/position pair are given. In this case, the
1716 1717 completer itself will split the line like readline does.
1717 1718
1718 1719 line : string, optional
1719 1720 The complete line that text is part of.
1720 1721
1721 1722 cursor_pos : int, optional
1722 1723 The position of the cursor on the input line.
1723 1724
1724 1725 Returns
1725 1726 -------
1726 1727 text : string
1727 1728 The actual text that was completed.
1728 1729
1729 1730 matches : list
1730 1731 A sorted list with all possible completions.
1731 1732
1732 1733 The optional arguments allow the completion to take more context into
1733 1734 account, and are part of the low-level completion API.
1734 1735
1735 1736 This is a wrapper around the completion mechanism, similar to what
1736 1737 readline does at the command line when the TAB key is hit. By
1737 1738 exposing it as a method, it can be used by other non-readline
1738 1739 environments (such as GUIs) for text completion.
1739 1740
1740 1741 Simple usage example:
1741 1742
1742 1743 In [1]: x = 'hello'
1743 1744
1744 1745 In [2]: _ip.complete('x.l')
1745 1746 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1746 1747 """
1747 1748
1748 1749 # Inject names into __builtin__ so we can complete on the added names.
1749 1750 with self.builtin_trap:
1750 1751 return self.Completer.complete(text, line, cursor_pos)
1751 1752
1752 1753 def set_custom_completer(self, completer, pos=0):
1753 1754 """Adds a new custom completer function.
1754 1755
1755 1756 The position argument (defaults to 0) is the index in the completers
1756 1757 list where you want the completer to be inserted."""
1757 1758
1758 1759 newcomp = new.instancemethod(completer,self.Completer,
1759 1760 self.Completer.__class__)
1760 1761 self.Completer.matchers.insert(pos,newcomp)
1761 1762
1762 1763 def set_readline_completer(self):
1763 1764 """Reset readline's completer to be our own."""
1764 1765 self.readline.set_completer(self.Completer.rlcomplete)
1765 1766
1766 1767 def set_completer_frame(self, frame=None):
1767 1768 """Set the frame of the completer."""
1768 1769 if frame:
1769 1770 self.Completer.namespace = frame.f_locals
1770 1771 self.Completer.global_namespace = frame.f_globals
1771 1772 else:
1772 1773 self.Completer.namespace = self.user_ns
1773 1774 self.Completer.global_namespace = self.user_global_ns
1774 1775
1775 1776 #-------------------------------------------------------------------------
1776 1777 # Things related to magics
1777 1778 #-------------------------------------------------------------------------
1778 1779
1779 1780 def init_magics(self):
1780 1781 # FIXME: Move the color initialization to the DisplayHook, which
1781 1782 # should be split into a prompt manager and displayhook. We probably
1782 1783 # even need a centralize colors management object.
1783 1784 self.magic_colors(self.colors)
1784 1785 # History was moved to a separate module
1785 1786 from . import history
1786 1787 history.init_ipython(self)
1787 1788
1788 1789 def magic(self,arg_s):
1789 1790 """Call a magic function by name.
1790 1791
1791 1792 Input: a string containing the name of the magic function to call and
1792 1793 any additional arguments to be passed to the magic.
1793 1794
1794 1795 magic('name -opt foo bar') is equivalent to typing at the ipython
1795 1796 prompt:
1796 1797
1797 1798 In[1]: %name -opt foo bar
1798 1799
1799 1800 To call a magic without arguments, simply use magic('name').
1800 1801
1801 1802 This provides a proper Python function to call IPython's magics in any
1802 1803 valid Python code you can type at the interpreter, including loops and
1803 1804 compound statements.
1804 1805 """
1805 1806 args = arg_s.split(' ',1)
1806 1807 magic_name = args[0]
1807 1808 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
1808 1809
1809 1810 try:
1810 1811 magic_args = args[1]
1811 1812 except IndexError:
1812 1813 magic_args = ''
1813 1814 fn = getattr(self,'magic_'+magic_name,None)
1814 1815 if fn is None:
1815 1816 error("Magic function `%s` not found." % magic_name)
1816 1817 else:
1817 1818 magic_args = self.var_expand(magic_args,1)
1818 1819 with nested(self.builtin_trap,):
1819 1820 result = fn(magic_args)
1820 1821 return result
1821 1822
1822 1823 def define_magic(self, magicname, func):
1823 1824 """Expose own function as magic function for ipython
1824 1825
1825 1826 def foo_impl(self,parameter_s=''):
1826 1827 'My very own magic!. (Use docstrings, IPython reads them).'
1827 1828 print 'Magic function. Passed parameter is between < >:'
1828 1829 print '<%s>' % parameter_s
1829 1830 print 'The self object is:',self
1830 1831
1831 1832 self.define_magic('foo',foo_impl)
1832 1833 """
1833 1834
1834 1835 import new
1835 1836 im = new.instancemethod(func,self, self.__class__)
1836 1837 old = getattr(self, "magic_" + magicname, None)
1837 1838 setattr(self, "magic_" + magicname, im)
1838 1839 return old
1839 1840
1840 1841 #-------------------------------------------------------------------------
1841 1842 # Things related to macros
1842 1843 #-------------------------------------------------------------------------
1843 1844
1844 1845 def define_macro(self, name, themacro):
1845 1846 """Define a new macro
1846 1847
1847 1848 Parameters
1848 1849 ----------
1849 1850 name : str
1850 1851 The name of the macro.
1851 1852 themacro : str or Macro
1852 1853 The action to do upon invoking the macro. If a string, a new
1853 1854 Macro object is created by passing the string to it.
1854 1855 """
1855 1856
1856 1857 from IPython.core import macro
1857 1858
1858 1859 if isinstance(themacro, basestring):
1859 1860 themacro = macro.Macro(themacro)
1860 1861 if not isinstance(themacro, macro.Macro):
1861 1862 raise ValueError('A macro must be a string or a Macro instance.')
1862 1863 self.user_ns[name] = themacro
1863 1864
1864 1865 #-------------------------------------------------------------------------
1865 1866 # Things related to the running of system commands
1866 1867 #-------------------------------------------------------------------------
1867 1868
1868 1869 def system(self, cmd):
1869 1870 """Call the given cmd in a subprocess.
1870 1871
1871 1872 Parameters
1872 1873 ----------
1873 1874 cmd : str
1874 1875 Command to execute (can not end in '&', as bacground processes are
1875 1876 not supported.
1876 1877 """
1877 1878 # We do not support backgrounding processes because we either use
1878 1879 # pexpect or pipes to read from. Users can always just call
1879 1880 # os.system() if they really want a background process.
1880 1881 if cmd.endswith('&'):
1881 1882 raise OSError("Background processes not supported.")
1882 1883
1883 1884 return system(self.var_expand(cmd, depth=2))
1884 1885
1885 1886 def getoutput(self, cmd, split=True):
1886 1887 """Get output (possibly including stderr) from a subprocess.
1887 1888
1888 1889 Parameters
1889 1890 ----------
1890 1891 cmd : str
1891 1892 Command to execute (can not end in '&', as background processes are
1892 1893 not supported.
1893 1894 split : bool, optional
1894 1895
1895 1896 If True, split the output into an IPython SList. Otherwise, an
1896 1897 IPython LSString is returned. These are objects similar to normal
1897 1898 lists and strings, with a few convenience attributes for easier
1898 1899 manipulation of line-based output. You can use '?' on them for
1899 1900 details.
1900 1901 """
1901 1902 if cmd.endswith('&'):
1902 1903 raise OSError("Background processes not supported.")
1903 1904 out = getoutput(self.var_expand(cmd, depth=2))
1904 1905 if split:
1905 1906 out = SList(out.splitlines())
1906 1907 else:
1907 1908 out = LSString(out)
1908 1909 return out
1909 1910
1910 1911 #-------------------------------------------------------------------------
1911 1912 # Things related to aliases
1912 1913 #-------------------------------------------------------------------------
1913 1914
1914 1915 def init_alias(self):
1915 1916 self.alias_manager = AliasManager(shell=self, config=self.config)
1916 1917 self.ns_table['alias'] = self.alias_manager.alias_table,
1917 1918
1918 1919 #-------------------------------------------------------------------------
1919 1920 # Things related to extensions and plugins
1920 1921 #-------------------------------------------------------------------------
1921 1922
1922 1923 def init_extension_manager(self):
1923 1924 self.extension_manager = ExtensionManager(shell=self, config=self.config)
1924 1925
1925 1926 def init_plugin_manager(self):
1926 1927 self.plugin_manager = PluginManager(config=self.config)
1927 1928
1928 1929 #-------------------------------------------------------------------------
1929 1930 # Things related to payloads
1930 1931 #-------------------------------------------------------------------------
1931 1932
1932 1933 def init_payload(self):
1933 1934 self.payload_manager = PayloadManager(config=self.config)
1934 1935
1935 1936 #-------------------------------------------------------------------------
1936 1937 # Things related to the prefilter
1937 1938 #-------------------------------------------------------------------------
1938 1939
1939 1940 def init_prefilter(self):
1940 1941 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
1941 1942 # Ultimately this will be refactored in the new interpreter code, but
1942 1943 # for now, we should expose the main prefilter method (there's legacy
1943 1944 # code out there that may rely on this).
1944 1945 self.prefilter = self.prefilter_manager.prefilter_lines
1945 1946
1946 1947
1947 1948 def auto_rewrite_input(self, cmd):
1948 1949 """Print to the screen the rewritten form of the user's command.
1949 1950
1950 1951 This shows visual feedback by rewriting input lines that cause
1951 1952 automatic calling to kick in, like::
1952 1953
1953 1954 /f x
1954 1955
1955 1956 into::
1956 1957
1957 1958 ------> f(x)
1958 1959
1959 1960 after the user's input prompt. This helps the user understand that the
1960 1961 input line was transformed automatically by IPython.
1961 1962 """
1962 1963 rw = self.displayhook.prompt1.auto_rewrite() + cmd
1963 1964
1964 1965 try:
1965 1966 # plain ascii works better w/ pyreadline, on some machines, so
1966 1967 # we use it and only print uncolored rewrite if we have unicode
1967 1968 rw = str(rw)
1968 1969 print >> IPython.utils.io.Term.cout, rw
1969 1970 except UnicodeEncodeError:
1970 1971 print "------> " + cmd
1971 1972
1972 1973 #-------------------------------------------------------------------------
1973 1974 # Things related to extracting values/expressions from kernel and user_ns
1974 1975 #-------------------------------------------------------------------------
1975 1976
1976 1977 def _simple_error(self):
1977 1978 etype, value = sys.exc_info()[:2]
1978 1979 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
1979 1980
1980 1981 def user_variables(self, names):
1981 1982 """Get a list of variable names from the user's namespace.
1982 1983
1983 1984 Parameters
1984 1985 ----------
1985 1986 names : list of strings
1986 1987 A list of names of variables to be read from the user namespace.
1987 1988
1988 1989 Returns
1989 1990 -------
1990 1991 A dict, keyed by the input names and with the repr() of each value.
1991 1992 """
1992 1993 out = {}
1993 1994 user_ns = self.user_ns
1994 1995 for varname in names:
1995 1996 try:
1996 1997 value = repr(user_ns[varname])
1997 1998 except:
1998 1999 value = self._simple_error()
1999 2000 out[varname] = value
2000 2001 return out
2001 2002
2002 2003 def user_expressions(self, expressions):
2003 2004 """Evaluate a dict of expressions in the user's namespace.
2004 2005
2005 2006 Parameters
2006 2007 ----------
2007 2008 expressions : dict
2008 2009 A dict with string keys and string values. The expression values
2009 2010 should be valid Python expressions, each of which will be evaluated
2010 2011 in the user namespace.
2011 2012
2012 2013 Returns
2013 2014 -------
2014 2015 A dict, keyed like the input expressions dict, with the repr() of each
2015 2016 value.
2016 2017 """
2017 2018 out = {}
2018 2019 user_ns = self.user_ns
2019 2020 global_ns = self.user_global_ns
2020 2021 for key, expr in expressions.iteritems():
2021 2022 try:
2022 2023 value = repr(eval(expr, global_ns, user_ns))
2023 2024 except:
2024 2025 value = self._simple_error()
2025 2026 out[key] = value
2026 2027 return out
2027 2028
2028 2029 #-------------------------------------------------------------------------
2029 2030 # Things related to the running of code
2030 2031 #-------------------------------------------------------------------------
2031 2032
2032 2033 def ex(self, cmd):
2033 2034 """Execute a normal python statement in user namespace."""
2034 2035 with nested(self.builtin_trap,):
2035 2036 exec cmd in self.user_global_ns, self.user_ns
2036 2037
2037 2038 def ev(self, expr):
2038 2039 """Evaluate python expression expr in user namespace.
2039 2040
2040 2041 Returns the result of evaluation
2041 2042 """
2042 2043 with nested(self.builtin_trap,):
2043 2044 return eval(expr, self.user_global_ns, self.user_ns)
2044 2045
2045 2046 def safe_execfile(self, fname, *where, **kw):
2046 2047 """A safe version of the builtin execfile().
2047 2048
2048 2049 This version will never throw an exception, but instead print
2049 2050 helpful error messages to the screen. This only works on pure
2050 2051 Python files with the .py extension.
2051 2052
2052 2053 Parameters
2053 2054 ----------
2054 2055 fname : string
2055 2056 The name of the file to be executed.
2056 2057 where : tuple
2057 2058 One or two namespaces, passed to execfile() as (globals,locals).
2058 2059 If only one is given, it is passed as both.
2059 2060 exit_ignore : bool (False)
2060 2061 If True, then silence SystemExit for non-zero status (it is always
2061 2062 silenced for zero status, as it is so common).
2062 2063 """
2063 2064 kw.setdefault('exit_ignore', False)
2064 2065
2065 2066 fname = os.path.abspath(os.path.expanduser(fname))
2066 2067
2067 2068 # Make sure we have a .py file
2068 2069 if not fname.endswith('.py'):
2069 2070 warn('File must end with .py to be run using execfile: <%s>' % fname)
2070 2071
2071 2072 # Make sure we can open the file
2072 2073 try:
2073 2074 with open(fname) as thefile:
2074 2075 pass
2075 2076 except:
2076 2077 warn('Could not open file <%s> for safe execution.' % fname)
2077 2078 return
2078 2079
2079 2080 # Find things also in current directory. This is needed to mimic the
2080 2081 # behavior of running a script from the system command line, where
2081 2082 # Python inserts the script's directory into sys.path
2082 2083 dname = os.path.dirname(fname)
2083 2084
2084 2085 with prepended_to_syspath(dname):
2085 2086 try:
2086 2087 execfile(fname,*where)
2087 2088 except SystemExit, status:
2088 2089 # If the call was made with 0 or None exit status (sys.exit(0)
2089 2090 # or sys.exit() ), don't bother showing a traceback, as both of
2090 2091 # these are considered normal by the OS:
2091 2092 # > python -c'import sys;sys.exit(0)'; echo $?
2092 2093 # 0
2093 2094 # > python -c'import sys;sys.exit()'; echo $?
2094 2095 # 0
2095 2096 # For other exit status, we show the exception unless
2096 2097 # explicitly silenced, but only in short form.
2097 2098 if status.code not in (0, None) and not kw['exit_ignore']:
2098 2099 self.showtraceback(exception_only=True)
2099 2100 except:
2100 2101 self.showtraceback()
2101 2102
2102 2103 def safe_execfile_ipy(self, fname):
2103 2104 """Like safe_execfile, but for .ipy files with IPython syntax.
2104 2105
2105 2106 Parameters
2106 2107 ----------
2107 2108 fname : str
2108 2109 The name of the file to execute. The filename must have a
2109 2110 .ipy extension.
2110 2111 """
2111 2112 fname = os.path.abspath(os.path.expanduser(fname))
2112 2113
2113 2114 # Make sure we have a .py file
2114 2115 if not fname.endswith('.ipy'):
2115 2116 warn('File must end with .py to be run using execfile: <%s>' % fname)
2116 2117
2117 2118 # Make sure we can open the file
2118 2119 try:
2119 2120 with open(fname) as thefile:
2120 2121 pass
2121 2122 except:
2122 2123 warn('Could not open file <%s> for safe execution.' % fname)
2123 2124 return
2124 2125
2125 2126 # Find things also in current directory. This is needed to mimic the
2126 2127 # behavior of running a script from the system command line, where
2127 2128 # Python inserts the script's directory into sys.path
2128 2129 dname = os.path.dirname(fname)
2129 2130
2130 2131 with prepended_to_syspath(dname):
2131 2132 try:
2132 2133 with open(fname) as thefile:
2133 2134 script = thefile.read()
2134 2135 # self.runlines currently captures all exceptions
2135 2136 # raise in user code. It would be nice if there were
2136 2137 # versions of runlines, execfile that did raise, so
2137 2138 # we could catch the errors.
2138 2139 self.runlines(script, clean=True)
2139 2140 except:
2140 2141 self.showtraceback()
2141 2142 warn('Unknown failure executing file: <%s>' % fname)
2142 2143
2143 2144 def run_cell(self, cell):
2144 2145 """Run the contents of an entire multiline 'cell' of code.
2145 2146
2146 2147 The cell is split into separate blocks which can be executed
2147 2148 individually. Then, based on how many blocks there are, they are
2148 2149 executed as follows:
2149 2150
2150 2151 - A single block: 'single' mode.
2151 2152
2152 2153 If there's more than one block, it depends:
2153 2154
2154 2155 - if the last one is no more than two lines long, run all but the last
2155 2156 in 'exec' mode and the very last one in 'single' mode. This makes it
2156 2157 easy to type simple expressions at the end to see computed values. -
2157 2158 otherwise (last one is also multiline), run all in 'exec' mode
2158 2159
2159 2160 When code is executed in 'single' mode, :func:`sys.displayhook` fires,
2160 2161 results are displayed and output prompts are computed. In 'exec' mode,
2161 2162 no results are displayed unless :func:`print` is called explicitly;
2162 2163 this mode is more akin to running a script.
2163 2164
2164 2165 Parameters
2165 2166 ----------
2166 2167 cell : str
2167 2168 A single or multiline string.
2168 2169 """
2169 2170 #################################################################
2170 2171 # FIXME
2171 2172 # =====
2172 2173 # This execution logic should stop calling runlines altogether, and
2173 2174 # instead we should do what runlines does, in a controlled manner, here
2174 2175 # (runlines mutates lots of state as it goes calling sub-methods that
2175 2176 # also mutate state). Basically we should:
2176 2177 # - apply dynamic transforms for single-line input (the ones that
2177 2178 # split_blocks won't apply since they need context).
2178 2179 # - increment the global execution counter (we need to pull that out
2179 2180 # from outputcache's control; outputcache should instead read it from
2180 2181 # the main object).
2181 2182 # - do any logging of input
2182 2183 # - update histories (raw/translated)
2183 2184 # - then, call plain runsource (for single blocks, so displayhook is
2184 2185 # triggered) or runcode (for multiline blocks in exec mode).
2185 2186 #
2186 2187 # Once this is done, we'll be able to stop using runlines and we'll
2187 2188 # also have a much cleaner separation of logging, input history and
2188 2189 # output cache management.
2189 2190 #################################################################
2190 2191
2191 2192 # We need to break up the input into executable blocks that can be run
2192 2193 # in 'single' mode, to provide comfortable user behavior.
2193 2194 blocks = self.input_splitter.split_blocks(cell)
2194 2195
2195 2196 if not blocks:
2196 2197 return
2197 2198
2198 2199 # Single-block input should behave like an interactive prompt
2199 2200 if len(blocks) == 1:
2200 2201 self.runlines(blocks[0])
2201 2202 return
2202 2203
2203 2204 # In multi-block input, if the last block is a simple (one-two lines)
2204 2205 # expression, run it in single mode so it produces output. Otherwise
2205 2206 # just feed the whole thing to runcode.
2206 2207 # This seems like a reasonable usability design.
2207 2208 last = blocks[-1]
2208 2209
2209 2210 # Note: below, whenever we call runcode, we must sync history
2210 2211 # ourselves, because runcode is NOT meant to manage history at all.
2211 2212 if len(last.splitlines()) < 2:
2212 2213 # Get the main body to run as a cell
2213 2214 body = ''.join(blocks[:-1])
2214 2215 self.input_hist.append(body)
2215 2216 self.input_hist_raw.append(body)
2216 2217 retcode = self.runcode(body, post_execute=False)
2217 2218 if retcode==0:
2218 2219 # And the last expression via runlines so it produces output
2219 2220 self.runlines(last)
2220 2221 else:
2221 2222 # Run the whole cell as one entity
2222 2223 self.input_hist.append(cell)
2223 2224 self.input_hist_raw.append(cell)
2224 2225 self.runcode(cell)
2225 2226
2226 2227 def runlines(self, lines, clean=False):
2227 2228 """Run a string of one or more lines of source.
2228 2229
2229 2230 This method is capable of running a string containing multiple source
2230 2231 lines, as if they had been entered at the IPython prompt. Since it
2231 2232 exposes IPython's processing machinery, the given strings can contain
2232 2233 magic calls (%magic), special shell access (!cmd), etc.
2233 2234 """
2234 2235
2235 2236 if isinstance(lines, (list, tuple)):
2236 2237 lines = '\n'.join(lines)
2237 2238
2238 2239 if clean:
2239 2240 lines = self._cleanup_ipy_script(lines)
2240 2241
2241 2242 # We must start with a clean buffer, in case this is run from an
2242 2243 # interactive IPython session (via a magic, for example).
2243 2244 self.resetbuffer()
2244 2245 lines = lines.splitlines()
2245 2246 more = 0
2246 2247 with nested(self.builtin_trap, self.display_trap):
2247 2248 for line in lines:
2248 2249 # skip blank lines so we don't mess up the prompt counter, but
2249 2250 # do NOT skip even a blank line if we are in a code block (more
2250 2251 # is true)
2251 2252
2252 2253 if line or more:
2253 2254 # push to raw history, so hist line numbers stay in sync
2254 2255 self.input_hist_raw.append(line + '\n')
2255 2256 prefiltered = self.prefilter_manager.prefilter_lines(line,
2256 2257 more)
2257 2258 more = self.push_line(prefiltered)
2258 2259 # IPython's runsource returns None if there was an error
2259 2260 # compiling the code. This allows us to stop processing
2260 2261 # right away, so the user gets the error message at the
2261 2262 # right place.
2262 2263 if more is None:
2263 2264 break
2264 2265 else:
2265 2266 self.input_hist_raw.append("\n")
2266 2267 # final newline in case the input didn't have it, so that the code
2267 2268 # actually does get executed
2268 2269 if more:
2269 2270 self.push_line('\n')
2270 2271
2271 2272 def runsource(self, source, filename='<input>', symbol='single'):
2272 2273 """Compile and run some source in the interpreter.
2273 2274
2274 2275 Arguments are as for compile_command().
2275 2276
2276 2277 One several things can happen:
2277 2278
2278 2279 1) The input is incorrect; compile_command() raised an
2279 2280 exception (SyntaxError or OverflowError). A syntax traceback
2280 2281 will be printed by calling the showsyntaxerror() method.
2281 2282
2282 2283 2) The input is incomplete, and more input is required;
2283 2284 compile_command() returned None. Nothing happens.
2284 2285
2285 2286 3) The input is complete; compile_command() returned a code
2286 2287 object. The code is executed by calling self.runcode() (which
2287 2288 also handles run-time exceptions, except for SystemExit).
2288 2289
2289 2290 The return value is:
2290 2291
2291 2292 - True in case 2
2292 2293
2293 2294 - False in the other cases, unless an exception is raised, where
2294 2295 None is returned instead. This can be used by external callers to
2295 2296 know whether to continue feeding input or not.
2296 2297
2297 2298 The return value can be used to decide whether to use sys.ps1 or
2298 2299 sys.ps2 to prompt the next line."""
2299 2300
2300 2301 # We need to ensure that the source is unicode from here on.
2301 2302 if type(source)==str:
2302 2303 source = source.decode(self.stdin_encoding)
2303 2304
2304 2305 # if the source code has leading blanks, add 'if 1:\n' to it
2305 2306 # this allows execution of indented pasted code. It is tempting
2306 2307 # to add '\n' at the end of source to run commands like ' a=1'
2307 2308 # directly, but this fails for more complicated scenarios
2308 2309
2309 2310 if source[:1] in [' ', '\t']:
2310 2311 source = u'if 1:\n%s' % source
2311 2312
2312 2313 try:
2313 2314 code = self.compile(source,filename,symbol)
2314 2315 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2315 2316 # Case 1
2316 2317 self.showsyntaxerror(filename)
2317 2318 return None
2318 2319
2319 2320 if code is None:
2320 2321 # Case 2
2321 2322 return True
2322 2323
2323 2324 # Case 3
2324 2325 # We store the code object so that threaded shells and
2325 2326 # custom exception handlers can access all this info if needed.
2326 2327 # The source corresponding to this can be obtained from the
2327 2328 # buffer attribute as '\n'.join(self.buffer).
2328 2329 self.code_to_run = code
2329 2330 # now actually execute the code object
2330 2331 if self.runcode(code) == 0:
2331 2332 return False
2332 2333 else:
2333 2334 return None
2334 2335
2335 2336 def runcode(self, code_obj, post_execute=True):
2336 2337 """Execute a code object.
2337 2338
2338 2339 When an exception occurs, self.showtraceback() is called to display a
2339 2340 traceback.
2340 2341
2341 2342 Return value: a flag indicating whether the code to be run completed
2342 2343 successfully:
2343 2344
2344 2345 - 0: successful execution.
2345 2346 - 1: an error occurred.
2346 2347 """
2347 2348
2348 2349 # Set our own excepthook in case the user code tries to call it
2349 2350 # directly, so that the IPython crash handler doesn't get triggered
2350 2351 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2351 2352
2352 2353 # we save the original sys.excepthook in the instance, in case config
2353 2354 # code (such as magics) needs access to it.
2354 2355 self.sys_excepthook = old_excepthook
2355 2356 outflag = 1 # happens in more places, so it's easier as default
2356 2357 try:
2357 2358 try:
2358 2359 self.hooks.pre_runcode_hook()
2359 2360 #rprint('Running code') # dbg
2360 2361 exec code_obj in self.user_global_ns, self.user_ns
2361 2362 finally:
2362 2363 # Reset our crash handler in place
2363 2364 sys.excepthook = old_excepthook
2364 2365 except SystemExit:
2365 2366 self.resetbuffer()
2366 2367 self.showtraceback(exception_only=True)
2367 2368 warn("To exit: use any of 'exit', 'quit', %Exit or Ctrl-D.", level=1)
2368 2369 except self.custom_exceptions:
2369 2370 etype,value,tb = sys.exc_info()
2370 2371 self.CustomTB(etype,value,tb)
2371 2372 except:
2372 2373 self.showtraceback()
2373 2374 else:
2374 2375 outflag = 0
2375 2376 if softspace(sys.stdout, 0):
2376 2377 print
2377 2378
2378 2379 # Execute any registered post-execution functions. Here, any errors
2379 2380 # are reported only minimally and just on the terminal, because the
2380 2381 # main exception channel may be occupied with a user traceback.
2381 2382 # FIXME: we need to think this mechanism a little more carefully.
2382 2383 if post_execute:
2383 2384 for func in self._post_execute:
2384 2385 try:
2385 2386 func()
2386 2387 except:
2387 2388 head = '[ ERROR ] Evaluating post_execute function: %s' % \
2388 2389 func
2389 2390 print >> io.Term.cout, head
2390 2391 print >> io.Term.cout, self._simple_error()
2391 2392 print >> io.Term.cout, 'Removing from post_execute'
2392 2393 self._post_execute.remove(func)
2393 2394
2394 2395 # Flush out code object which has been run (and source)
2395 2396 self.code_to_run = None
2396 2397 return outflag
2397 2398
2398 2399 def push_line(self, line):
2399 2400 """Push a line to the interpreter.
2400 2401
2401 2402 The line should not have a trailing newline; it may have
2402 2403 internal newlines. The line is appended to a buffer and the
2403 2404 interpreter's runsource() method is called with the
2404 2405 concatenated contents of the buffer as source. If this
2405 2406 indicates that the command was executed or invalid, the buffer
2406 2407 is reset; otherwise, the command is incomplete, and the buffer
2407 2408 is left as it was after the line was appended. The return
2408 2409 value is 1 if more input is required, 0 if the line was dealt
2409 2410 with in some way (this is the same as runsource()).
2410 2411 """
2411 2412
2412 2413 # autoindent management should be done here, and not in the
2413 2414 # interactive loop, since that one is only seen by keyboard input. We
2414 2415 # need this done correctly even for code run via runlines (which uses
2415 2416 # push).
2416 2417
2417 2418 #print 'push line: <%s>' % line # dbg
2418 2419 for subline in line.splitlines():
2419 2420 self._autoindent_update(subline)
2420 2421 self.buffer.append(line)
2421 2422 more = self.runsource('\n'.join(self.buffer), self.filename)
2422 2423 if not more:
2423 2424 self.resetbuffer()
2424 2425 return more
2425 2426
2426 2427 def resetbuffer(self):
2427 2428 """Reset the input buffer."""
2428 2429 self.buffer[:] = []
2429 2430
2430 2431 def _is_secondary_block_start(self, s):
2431 2432 if not s.endswith(':'):
2432 2433 return False
2433 2434 if (s.startswith('elif') or
2434 2435 s.startswith('else') or
2435 2436 s.startswith('except') or
2436 2437 s.startswith('finally')):
2437 2438 return True
2438 2439
2439 2440 def _cleanup_ipy_script(self, script):
2440 2441 """Make a script safe for self.runlines()
2441 2442
2442 2443 Currently, IPython is lines based, with blocks being detected by
2443 2444 empty lines. This is a problem for block based scripts that may
2444 2445 not have empty lines after blocks. This script adds those empty
2445 2446 lines to make scripts safe for running in the current line based
2446 2447 IPython.
2447 2448 """
2448 2449 res = []
2449 2450 lines = script.splitlines()
2450 2451 level = 0
2451 2452
2452 2453 for l in lines:
2453 2454 lstripped = l.lstrip()
2454 2455 stripped = l.strip()
2455 2456 if not stripped:
2456 2457 continue
2457 2458 newlevel = len(l) - len(lstripped)
2458 2459 if level > 0 and newlevel == 0 and \
2459 2460 not self._is_secondary_block_start(stripped):
2460 2461 # add empty line
2461 2462 res.append('')
2462 2463 res.append(l)
2463 2464 level = newlevel
2464 2465
2465 2466 return '\n'.join(res) + '\n'
2466 2467
2467 2468 def _autoindent_update(self,line):
2468 2469 """Keep track of the indent level."""
2469 2470
2470 2471 #debugx('line')
2471 2472 #debugx('self.indent_current_nsp')
2472 2473 if self.autoindent:
2473 2474 if line:
2474 2475 inisp = num_ini_spaces(line)
2475 2476 if inisp < self.indent_current_nsp:
2476 2477 self.indent_current_nsp = inisp
2477 2478
2478 2479 if line[-1] == ':':
2479 2480 self.indent_current_nsp += 4
2480 2481 elif dedent_re.match(line):
2481 2482 self.indent_current_nsp -= 4
2482 2483 else:
2483 2484 self.indent_current_nsp = 0
2484 2485
2485 2486 #-------------------------------------------------------------------------
2486 2487 # Things related to GUI support and pylab
2487 2488 #-------------------------------------------------------------------------
2488 2489
2489 2490 def enable_pylab(self, gui=None):
2490 2491 raise NotImplementedError('Implement enable_pylab in a subclass')
2491 2492
2492 2493 #-------------------------------------------------------------------------
2493 2494 # Utilities
2494 2495 #-------------------------------------------------------------------------
2495 2496
2496 2497 def var_expand(self,cmd,depth=0):
2497 2498 """Expand python variables in a string.
2498 2499
2499 2500 The depth argument indicates how many frames above the caller should
2500 2501 be walked to look for the local namespace where to expand variables.
2501 2502
2502 2503 The global namespace for expansion is always the user's interactive
2503 2504 namespace.
2504 2505 """
2505 2506
2506 2507 return str(ItplNS(cmd,
2507 2508 self.user_ns, # globals
2508 2509 # Skip our own frame in searching for locals:
2509 2510 sys._getframe(depth+1).f_locals # locals
2510 2511 ))
2511 2512
2512 2513 def mktempfile(self,data=None):
2513 2514 """Make a new tempfile and return its filename.
2514 2515
2515 2516 This makes a call to tempfile.mktemp, but it registers the created
2516 2517 filename internally so ipython cleans it up at exit time.
2517 2518
2518 2519 Optional inputs:
2519 2520
2520 2521 - data(None): if data is given, it gets written out to the temp file
2521 2522 immediately, and the file is closed again."""
2522 2523
2523 2524 filename = tempfile.mktemp('.py','ipython_edit_')
2524 2525 self.tempfiles.append(filename)
2525 2526
2526 2527 if data:
2527 2528 tmp_file = open(filename,'w')
2528 2529 tmp_file.write(data)
2529 2530 tmp_file.close()
2530 2531 return filename
2531 2532
2532 2533 # TODO: This should be removed when Term is refactored.
2533 2534 def write(self,data):
2534 2535 """Write a string to the default output"""
2535 2536 io.Term.cout.write(data)
2536 2537
2537 2538 # TODO: This should be removed when Term is refactored.
2538 2539 def write_err(self,data):
2539 2540 """Write a string to the default error output"""
2540 2541 io.Term.cerr.write(data)
2541 2542
2542 2543 def ask_yes_no(self,prompt,default=True):
2543 2544 if self.quiet:
2544 2545 return True
2545 2546 return ask_yes_no(prompt,default)
2546 2547
2547 2548 def show_usage(self):
2548 2549 """Show a usage message"""
2549 2550 page.page(IPython.core.usage.interactive_usage)
2550 2551
2551 2552 #-------------------------------------------------------------------------
2552 2553 # Things related to IPython exiting
2553 2554 #-------------------------------------------------------------------------
2554 2555 def atexit_operations(self):
2555 2556 """This will be executed at the time of exit.
2556 2557
2557 2558 Cleanup operations and saving of persistent data that is done
2558 2559 unconditionally by IPython should be performed here.
2559 2560
2560 2561 For things that may depend on startup flags or platform specifics (such
2561 2562 as having readline or not), register a separate atexit function in the
2562 2563 code that has the appropriate information, rather than trying to
2563 2564 clutter
2564 2565 """
2565 2566 # Cleanup all tempfiles left around
2566 2567 for tfile in self.tempfiles:
2567 2568 try:
2568 2569 os.unlink(tfile)
2569 2570 except OSError:
2570 2571 pass
2571 2572
2572 2573 # Clear all user namespaces to release all references cleanly.
2573 2574 self.reset()
2574 2575
2575 2576 # Run user hooks
2576 2577 self.hooks.shutdown_hook()
2577 2578
2578 2579 def cleanup(self):
2579 2580 self.restore_sys_module_state()
2580 2581
2581 2582
2582 2583 class InteractiveShellABC(object):
2583 2584 """An abstract base class for InteractiveShell."""
2584 2585 __metaclass__ = abc.ABCMeta
2585 2586
2586 2587 InteractiveShellABC.register(InteractiveShell)
@@ -1,169 +1,185 b''
1 1 """Tests for code execution (%run and related), which is particularly tricky.
2 2
3 3 Because of how %run manages namespaces, and the fact that we are trying here to
4 4 verify subtle object deletion and reference counting issues, the %run tests
5 5 will be kept in this separate file. This makes it easier to aggregate in one
6 6 place the tricks needed to handle it; most other magics are much easier to test
7 7 and we do so in a common test_magic file.
8 8 """
9 9 from __future__ import absolute_import
10 10
11 11 #-----------------------------------------------------------------------------
12 12 # Imports
13 13 #-----------------------------------------------------------------------------
14 14
15 15 import os
16 16 import sys
17 17 import tempfile
18 18
19 19 import nose.tools as nt
20 20
21 21 from IPython.testing import decorators as dec
22 22 from IPython.testing import tools as tt
23 23
24 24 #-----------------------------------------------------------------------------
25 25 # Test functions begin
26 26 #-----------------------------------------------------------------------------
27 27
28 28 def doctest_refbug():
29 29 """Very nasty problem with references held by multiple runs of a script.
30 30 See: https://bugs.launchpad.net/ipython/+bug/269966
31 31
32 32 In [1]: _ip.clear_main_mod_cache()
33 33 # random
34 34
35 35 In [2]: %run refbug
36 36
37 37 In [3]: call_f()
38 38 lowercased: hello
39 39
40 40 In [4]: %run refbug
41 41
42 42 In [5]: call_f()
43 43 lowercased: hello
44 44 lowercased: hello
45 45 """
46 46
47 47
48 48 def doctest_run_builtins():
49 49 r"""Check that %run doesn't damage __builtins__.
50 50
51 51 In [1]: import tempfile
52 52
53 53 In [2]: bid1 = id(__builtins__)
54 54
55 55 In [3]: fname = tempfile.mkstemp('.py')[1]
56 56
57 57 In [3]: f = open(fname,'w')
58 58
59 59 In [4]: f.write('pass\n')
60 60
61 61 In [5]: f.flush()
62 62
63 63 In [6]: t1 = type(__builtins__)
64 64
65 65 In [7]: %run $fname
66 66
67 67 In [7]: f.close()
68 68
69 69 In [8]: bid2 = id(__builtins__)
70 70
71 71 In [9]: t2 = type(__builtins__)
72 72
73 73 In [10]: t1 == t2
74 74 Out[10]: True
75 75
76 76 In [10]: bid1 == bid2
77 77 Out[10]: True
78 78
79 79 In [12]: try:
80 80 ....: os.unlink(fname)
81 81 ....: except:
82 82 ....: pass
83 83 ....:
84 84 """
85 85
86 def doctest_reset_del():
87 """Test that resetting doesn't cause errors in __del__ methods.
88
89 In [2]: class A(object):
90 ...: def __del__(self):
91 ...: str("Hi")
92 ...:
93
94 In [3]: a = A()
95
96 In [4]: get_ipython().reset()
97
98 In [5]: 1+1
99 Out[5]: 2
100 """
101
86 102 # For some tests, it will be handy to organize them in a class with a common
87 103 # setup that makes a temp file
88 104
89 105 class TestMagicRunPass(tt.TempFileMixin):
90 106
91 107 def setup(self):
92 108 """Make a valid python temp file."""
93 109 self.mktmp('pass\n')
94 110
95 111 def run_tmpfile(self):
96 112 _ip = get_ipython()
97 113 # This fails on Windows if self.tmpfile.name has spaces or "~" in it.
98 114 # See below and ticket https://bugs.launchpad.net/bugs/366353
99 115 _ip.magic('run %s' % self.fname)
100 116
101 117 def test_builtins_id(self):
102 118 """Check that %run doesn't damage __builtins__ """
103 119 _ip = get_ipython()
104 120 # Test that the id of __builtins__ is not modified by %run
105 121 bid1 = id(_ip.user_ns['__builtins__'])
106 122 self.run_tmpfile()
107 123 bid2 = id(_ip.user_ns['__builtins__'])
108 124 tt.assert_equals(bid1, bid2)
109 125
110 126 def test_builtins_type(self):
111 127 """Check that the type of __builtins__ doesn't change with %run.
112 128
113 129 However, the above could pass if __builtins__ was already modified to
114 130 be a dict (it should be a module) by a previous use of %run. So we
115 131 also check explicitly that it really is a module:
116 132 """
117 133 _ip = get_ipython()
118 134 self.run_tmpfile()
119 135 tt.assert_equals(type(_ip.user_ns['__builtins__']),type(sys))
120 136
121 137 def test_prompts(self):
122 138 """Test that prompts correctly generate after %run"""
123 139 self.run_tmpfile()
124 140 _ip = get_ipython()
125 141 p2 = str(_ip.displayhook.prompt2).strip()
126 142 nt.assert_equals(p2[:3], '...')
127 143
128 144
129 145 class TestMagicRunSimple(tt.TempFileMixin):
130 146
131 147 def test_simpledef(self):
132 148 """Test that simple class definitions work."""
133 149 src = ("class foo: pass\n"
134 150 "def f(): return foo()")
135 151 self.mktmp(src)
136 152 _ip.magic('run %s' % self.fname)
137 153 _ip.runlines('t = isinstance(f(), foo)')
138 154 nt.assert_true(_ip.user_ns['t'])
139 155
140 156 # We have to skip these in win32 because getoutputerr() crashes,
141 157 # due to the fact that subprocess does not support close_fds when
142 158 # redirecting stdout/err. So unless someone who knows more tells us how to
143 159 # implement getoutputerr() in win32, we're stuck avoiding these.
144 160 @dec.skip_win32
145 161 def test_obj_del(self):
146 162 """Test that object's __del__ methods are called on exit."""
147 163
148 164 # This test is known to fail on win32.
149 165 # See ticket https://bugs.launchpad.net/bugs/366334
150 166 src = ("class A(object):\n"
151 167 " def __del__(self):\n"
152 168 " print 'object A deleted'\n"
153 169 "a = A()\n")
154 170 self.mktmp(src)
155 171 tt.ipexec_validate(self.fname, 'object A deleted')
156 172
157 173 @dec.skip_win32
158 174 def test_tclass(self):
159 175 mydir = os.path.dirname(__file__)
160 176 tc = os.path.join(mydir, 'tclass')
161 177 src = ("%%run '%s' C-first\n"
162 178 "%%run '%s' C-second\n") % (tc, tc)
163 179 self.mktmp(src, '.ipy')
164 180 out = """\
165 181 ARGV 1-: ['C-first']
166 182 ARGV 1-: ['C-second']
167 183 tclass.py: deleting object: C-first
168 184 """
169 185 tt.ipexec_validate(self.fname, out)
General Comments 0
You need to be logged in to leave comments. Login now