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