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