##// END OF EJS Templates
applied next part of jorgens patch does source.encode(self.stdin_encoding)
vivainio -
Show More
@@ -1,2569 +1,2570 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 IPython -- An enhanced Interactive Python
4 4
5 5 Requires Python 2.3 or newer.
6 6
7 7 This file contains all the classes and helper functions specific to IPython.
8 8
9 $Id: iplib.py 2844 2007-10-24 14:34:18Z vivainio $
9 $Id: iplib.py 2846 2007-10-24 14:44:48Z vivainio $
10 10 """
11 11
12 12 #*****************************************************************************
13 13 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
14 14 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
15 15 #
16 16 # Distributed under the terms of the BSD License. The full license is in
17 17 # the file COPYING, distributed as part of this software.
18 18 #
19 19 # Note: this code originally subclassed code.InteractiveConsole from the
20 20 # Python standard library. Over time, all of that class has been copied
21 21 # verbatim here for modifications which could not be accomplished by
22 22 # subclassing. At this point, there are no dependencies at all on the code
23 23 # module anymore (it is not even imported). The Python License (sec. 2)
24 24 # allows for this, but it's always nice to acknowledge credit where credit is
25 25 # due.
26 26 #*****************************************************************************
27 27
28 28 #****************************************************************************
29 29 # Modules and globals
30 30
31 31 from IPython import Release
32 32 __author__ = '%s <%s>\n%s <%s>' % \
33 33 ( Release.authors['Janko'] + Release.authors['Fernando'] )
34 34 __license__ = Release.license
35 35 __version__ = Release.version
36 36
37 37 # Python standard modules
38 38 import __main__
39 39 import __builtin__
40 40 import StringIO
41 41 import bdb
42 42 import cPickle as pickle
43 43 import codeop
44 44 import exceptions
45 45 import glob
46 46 import inspect
47 47 import keyword
48 48 import new
49 49 import os
50 50 import pydoc
51 51 import re
52 52 import shutil
53 53 import string
54 54 import sys
55 55 import tempfile
56 56 import traceback
57 57 import types
58 58 import pickleshare
59 59 from sets import Set
60 60 from pprint import pprint, pformat
61 61
62 62 # IPython's own modules
63 63 #import IPython
64 64 from IPython import Debugger,OInspect,PyColorize,ultraTB
65 65 from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names
66 66 from IPython.FakeModule import FakeModule
67 67 from IPython.Itpl import Itpl,itpl,printpl,ItplNS,itplns
68 68 from IPython.Logger import Logger
69 69 from IPython.Magic import Magic
70 70 from IPython.Prompts import CachedOutput
71 71 from IPython.ipstruct import Struct
72 72 from IPython.background_jobs import BackgroundJobManager
73 73 from IPython.usage import cmd_line_usage,interactive_usage
74 74 from IPython.genutils import *
75 75 from IPython.strdispatch import StrDispatch
76 76 import IPython.ipapi
77 77 import IPython.history
78 78 import IPython.prefilter as prefilter
79 79 import IPython.shadowns
80 80 # Globals
81 81
82 82 # store the builtin raw_input globally, and use this always, in case user code
83 83 # overwrites it (like wx.py.PyShell does)
84 84 raw_input_original = raw_input
85 85
86 86 # compiled regexps for autoindent management
87 87 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
88 88
89 89
90 90 #****************************************************************************
91 91 # Some utility function definitions
92 92
93 93 ini_spaces_re = re.compile(r'^(\s+)')
94 94
95 95 def num_ini_spaces(strng):
96 96 """Return the number of initial spaces in a string"""
97 97
98 98 ini_spaces = ini_spaces_re.match(strng)
99 99 if ini_spaces:
100 100 return ini_spaces.end()
101 101 else:
102 102 return 0
103 103
104 104 def softspace(file, newvalue):
105 105 """Copied from code.py, to remove the dependency"""
106 106
107 107 oldvalue = 0
108 108 try:
109 109 oldvalue = file.softspace
110 110 except AttributeError:
111 111 pass
112 112 try:
113 113 file.softspace = newvalue
114 114 except (AttributeError, TypeError):
115 115 # "attribute-less object" or "read-only attributes"
116 116 pass
117 117 return oldvalue
118 118
119 119
120 120 #****************************************************************************
121 121 # Local use exceptions
122 122 class SpaceInInput(exceptions.Exception): pass
123 123
124 124
125 125 #****************************************************************************
126 126 # Local use classes
127 127 class Bunch: pass
128 128
129 129 class Undefined: pass
130 130
131 131 class Quitter(object):
132 132 """Simple class to handle exit, similar to Python 2.5's.
133 133
134 134 It handles exiting in an ipython-safe manner, which the one in Python 2.5
135 135 doesn't do (obviously, since it doesn't know about ipython)."""
136 136
137 137 def __init__(self,shell,name):
138 138 self.shell = shell
139 139 self.name = name
140 140
141 141 def __repr__(self):
142 142 return 'Type %s() to exit.' % self.name
143 143 __str__ = __repr__
144 144
145 145 def __call__(self):
146 146 self.shell.exit()
147 147
148 148 class InputList(list):
149 149 """Class to store user input.
150 150
151 151 It's basically a list, but slices return a string instead of a list, thus
152 152 allowing things like (assuming 'In' is an instance):
153 153
154 154 exec In[4:7]
155 155
156 156 or
157 157
158 158 exec In[5:9] + In[14] + In[21:25]"""
159 159
160 160 def __getslice__(self,i,j):
161 161 return ''.join(list.__getslice__(self,i,j))
162 162
163 163 class SyntaxTB(ultraTB.ListTB):
164 164 """Extension which holds some state: the last exception value"""
165 165
166 166 def __init__(self,color_scheme = 'NoColor'):
167 167 ultraTB.ListTB.__init__(self,color_scheme)
168 168 self.last_syntax_error = None
169 169
170 170 def __call__(self, etype, value, elist):
171 171 self.last_syntax_error = value
172 172 ultraTB.ListTB.__call__(self,etype,value,elist)
173 173
174 174 def clear_err_state(self):
175 175 """Return the current error state and clear it"""
176 176 e = self.last_syntax_error
177 177 self.last_syntax_error = None
178 178 return e
179 179
180 180 #****************************************************************************
181 181 # Main IPython class
182 182
183 183 # FIXME: the Magic class is a mixin for now, and will unfortunately remain so
184 184 # until a full rewrite is made. I've cleaned all cross-class uses of
185 185 # attributes and methods, but too much user code out there relies on the
186 186 # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage.
187 187 #
188 188 # But at least now, all the pieces have been separated and we could, in
189 189 # principle, stop using the mixin. This will ease the transition to the
190 190 # chainsaw branch.
191 191
192 192 # For reference, the following is the list of 'self.foo' uses in the Magic
193 193 # class as of 2005-12-28. These are names we CAN'T use in the main ipython
194 194 # class, to prevent clashes.
195 195
196 196 # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind',
197 197 # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic',
198 198 # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell',
199 199 # 'self.value']
200 200
201 201 class InteractiveShell(object,Magic):
202 202 """An enhanced console for Python."""
203 203
204 204 # class attribute to indicate whether the class supports threads or not.
205 205 # Subclasses with thread support should override this as needed.
206 206 isthreaded = False
207 207
208 208 def __init__(self,name,usage=None,rc=Struct(opts=None,args=None),
209 209 user_ns = None,user_global_ns=None,banner2='',
210 210 custom_exceptions=((),None),embedded=False):
211 211
212 212 # log system
213 213 self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate')
214 214
215 215 # some minimal strict typechecks. For some core data structures, I
216 216 # want actual basic python types, not just anything that looks like
217 217 # one. This is especially true for namespaces.
218 218 for ns in (user_ns,user_global_ns):
219 219 if ns is not None and type(ns) != types.DictType:
220 220 raise TypeError,'namespace must be a dictionary'
221 221
222 222 # Job manager (for jobs run as background threads)
223 223 self.jobs = BackgroundJobManager()
224 224
225 225 # Store the actual shell's name
226 226 self.name = name
227 227
228 228 # We need to know whether the instance is meant for embedding, since
229 229 # global/local namespaces need to be handled differently in that case
230 230 self.embedded = embedded
231 231 if embedded:
232 232 # Control variable so users can, from within the embedded instance,
233 233 # permanently deactivate it.
234 234 self.embedded_active = True
235 235
236 236 # command compiler
237 237 self.compile = codeop.CommandCompiler()
238 238
239 239 # User input buffer
240 240 self.buffer = []
241 241
242 242 # Default name given in compilation of code
243 243 self.filename = '<ipython console>'
244 244
245 245 # Install our own quitter instead of the builtins. For python2.3-2.4,
246 246 # this brings in behavior like 2.5, and for 2.5 it's identical.
247 247 __builtin__.exit = Quitter(self,'exit')
248 248 __builtin__.quit = Quitter(self,'quit')
249 249
250 250 # Make an empty namespace, which extension writers can rely on both
251 251 # existing and NEVER being used by ipython itself. This gives them a
252 252 # convenient location for storing additional information and state
253 253 # their extensions may require, without fear of collisions with other
254 254 # ipython names that may develop later.
255 255 self.meta = Struct()
256 256
257 257 # Create the namespace where the user will operate. user_ns is
258 258 # normally the only one used, and it is passed to the exec calls as
259 259 # the locals argument. But we do carry a user_global_ns namespace
260 260 # given as the exec 'globals' argument, This is useful in embedding
261 261 # situations where the ipython shell opens in a context where the
262 262 # distinction between locals and globals is meaningful.
263 263
264 264 # FIXME. For some strange reason, __builtins__ is showing up at user
265 265 # level as a dict instead of a module. This is a manual fix, but I
266 266 # should really track down where the problem is coming from. Alex
267 267 # Schmolck reported this problem first.
268 268
269 269 # A useful post by Alex Martelli on this topic:
270 270 # Re: inconsistent value from __builtins__
271 271 # Von: Alex Martelli <aleaxit@yahoo.com>
272 272 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
273 273 # Gruppen: comp.lang.python
274 274
275 275 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
276 276 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
277 277 # > <type 'dict'>
278 278 # > >>> print type(__builtins__)
279 279 # > <type 'module'>
280 280 # > Is this difference in return value intentional?
281 281
282 282 # Well, it's documented that '__builtins__' can be either a dictionary
283 283 # or a module, and it's been that way for a long time. Whether it's
284 284 # intentional (or sensible), I don't know. In any case, the idea is
285 285 # that if you need to access the built-in namespace directly, you
286 286 # should start with "import __builtin__" (note, no 's') which will
287 287 # definitely give you a module. Yeah, it's somewhat confusing:-(.
288 288
289 289 # These routines return properly built dicts as needed by the rest of
290 290 # the code, and can also be used by extension writers to generate
291 291 # properly initialized namespaces.
292 292 user_ns = IPython.ipapi.make_user_ns(user_ns)
293 293 user_global_ns = IPython.ipapi.make_user_global_ns(user_global_ns)
294 294
295 295 # Assign namespaces
296 296 # This is the namespace where all normal user variables live
297 297 self.user_ns = user_ns
298 298 # Embedded instances require a separate namespace for globals.
299 299 # Normally this one is unused by non-embedded instances.
300 300 self.user_global_ns = user_global_ns
301 301 # A namespace to keep track of internal data structures to prevent
302 302 # them from cluttering user-visible stuff. Will be updated later
303 303 self.internal_ns = {}
304 304
305 305 # Namespace of system aliases. Each entry in the alias
306 306 # table must be a 2-tuple of the form (N,name), where N is the number
307 307 # of positional arguments of the alias.
308 308 self.alias_table = {}
309 309
310 310 # A table holding all the namespaces IPython deals with, so that
311 311 # introspection facilities can search easily.
312 312 self.ns_table = {'user':user_ns,
313 313 'user_global':user_global_ns,
314 314 'alias':self.alias_table,
315 315 'internal':self.internal_ns,
316 316 'builtin':__builtin__.__dict__
317 317 }
318 318 # The user namespace MUST have a pointer to the shell itself.
319 319 self.user_ns[name] = self
320 320
321 321 # We need to insert into sys.modules something that looks like a
322 322 # module but which accesses the IPython namespace, for shelve and
323 323 # pickle to work interactively. Normally they rely on getting
324 324 # everything out of __main__, but for embedding purposes each IPython
325 325 # instance has its own private namespace, so we can't go shoving
326 326 # everything into __main__.
327 327
328 328 # note, however, that we should only do this for non-embedded
329 329 # ipythons, which really mimic the __main__.__dict__ with their own
330 330 # namespace. Embedded instances, on the other hand, should not do
331 331 # this because they need to manage the user local/global namespaces
332 332 # only, but they live within a 'normal' __main__ (meaning, they
333 333 # shouldn't overtake the execution environment of the script they're
334 334 # embedded in).
335 335
336 336 if not embedded:
337 337 try:
338 338 main_name = self.user_ns['__name__']
339 339 except KeyError:
340 340 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
341 341 else:
342 342 #print "pickle hack in place" # dbg
343 343 #print 'main_name:',main_name # dbg
344 344 sys.modules[main_name] = FakeModule(self.user_ns)
345 345
346 346 # Now that FakeModule produces a real module, we've run into a nasty
347 347 # problem: after script execution (via %run), the module where the user
348 348 # code ran is deleted. Now that this object is a true module (needed
349 349 # so docetst and other tools work correctly), the Python module
350 350 # teardown mechanism runs over it, and sets to None every variable
351 351 # present in that module. This means that later calls to functions
352 352 # defined in the script (which have become interactively visible after
353 353 # script exit) fail, because they hold references to objects that have
354 354 # become overwritten into None. The only solution I see right now is
355 355 # to protect every FakeModule used by %run by holding an internal
356 356 # reference to it. This private list will be used for that. The
357 357 # %reset command will flush it as well.
358 358 self._user_main_modules = []
359 359
360 360 # List of input with multi-line handling.
361 361 # Fill its zero entry, user counter starts at 1
362 362 self.input_hist = InputList(['\n'])
363 363 # This one will hold the 'raw' input history, without any
364 364 # pre-processing. This will allow users to retrieve the input just as
365 365 # it was exactly typed in by the user, with %hist -r.
366 366 self.input_hist_raw = InputList(['\n'])
367 367
368 368 # list of visited directories
369 369 try:
370 370 self.dir_hist = [os.getcwd()]
371 371 except OSError:
372 372 self.dir_hist = []
373 373
374 374 # dict of output history
375 375 self.output_hist = {}
376 376
377 377 # Get system encoding at startup time. Certain terminals (like Emacs
378 378 # under Win32 have it set to None, and we need to have a known valid
379 379 # encoding to use in the raw_input() method
380 380 self.stdin_encoding = sys.stdin.encoding or 'ascii'
381 381
382 382 # dict of things NOT to alias (keywords, builtins and some magics)
383 383 no_alias = {}
384 384 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
385 385 for key in keyword.kwlist + no_alias_magics:
386 386 no_alias[key] = 1
387 387 no_alias.update(__builtin__.__dict__)
388 388 self.no_alias = no_alias
389 389
390 390 # make global variables for user access to these
391 391 self.user_ns['_ih'] = self.input_hist
392 392 self.user_ns['_oh'] = self.output_hist
393 393 self.user_ns['_dh'] = self.dir_hist
394 394
395 395 # user aliases to input and output histories
396 396 self.user_ns['In'] = self.input_hist
397 397 self.user_ns['Out'] = self.output_hist
398 398
399 399 self.user_ns['_sh'] = IPython.shadowns
400 400 # Object variable to store code object waiting execution. This is
401 401 # used mainly by the multithreaded shells, but it can come in handy in
402 402 # other situations. No need to use a Queue here, since it's a single
403 403 # item which gets cleared once run.
404 404 self.code_to_run = None
405 405
406 406 # escapes for automatic behavior on the command line
407 407 self.ESC_SHELL = '!'
408 408 self.ESC_SH_CAP = '!!'
409 409 self.ESC_HELP = '?'
410 410 self.ESC_MAGIC = '%'
411 411 self.ESC_QUOTE = ','
412 412 self.ESC_QUOTE2 = ';'
413 413 self.ESC_PAREN = '/'
414 414
415 415 # And their associated handlers
416 416 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
417 417 self.ESC_QUOTE : self.handle_auto,
418 418 self.ESC_QUOTE2 : self.handle_auto,
419 419 self.ESC_MAGIC : self.handle_magic,
420 420 self.ESC_HELP : self.handle_help,
421 421 self.ESC_SHELL : self.handle_shell_escape,
422 422 self.ESC_SH_CAP : self.handle_shell_escape,
423 423 }
424 424
425 425 # class initializations
426 426 Magic.__init__(self,self)
427 427
428 428 # Python source parser/formatter for syntax highlighting
429 429 pyformat = PyColorize.Parser().format
430 430 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
431 431
432 432 # hooks holds pointers used for user-side customizations
433 433 self.hooks = Struct()
434 434
435 435 self.strdispatchers = {}
436 436
437 437 # Set all default hooks, defined in the IPython.hooks module.
438 438 hooks = IPython.hooks
439 439 for hook_name in hooks.__all__:
440 440 # default hooks have priority 100, i.e. low; user hooks should have
441 441 # 0-100 priority
442 442 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
443 443 #print "bound hook",hook_name
444 444
445 445 # Flag to mark unconditional exit
446 446 self.exit_now = False
447 447
448 448 self.usage_min = """\
449 449 An enhanced console for Python.
450 450 Some of its features are:
451 451 - Readline support if the readline library is present.
452 452 - Tab completion in the local namespace.
453 453 - Logging of input, see command-line options.
454 454 - System shell escape via ! , eg !ls.
455 455 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
456 456 - Keeps track of locally defined variables via %who, %whos.
457 457 - Show object information with a ? eg ?x or x? (use ?? for more info).
458 458 """
459 459 if usage: self.usage = usage
460 460 else: self.usage = self.usage_min
461 461
462 462 # Storage
463 463 self.rc = rc # This will hold all configuration information
464 464 self.pager = 'less'
465 465 # temporary files used for various purposes. Deleted at exit.
466 466 self.tempfiles = []
467 467
468 468 # Keep track of readline usage (later set by init_readline)
469 469 self.has_readline = False
470 470
471 471 # template for logfile headers. It gets resolved at runtime by the
472 472 # logstart method.
473 473 self.loghead_tpl = \
474 474 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
475 475 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
476 476 #log# opts = %s
477 477 #log# args = %s
478 478 #log# It is safe to make manual edits below here.
479 479 #log#-----------------------------------------------------------------------
480 480 """
481 481 # for pushd/popd management
482 482 try:
483 483 self.home_dir = get_home_dir()
484 484 except HomeDirError,msg:
485 485 fatal(msg)
486 486
487 487 self.dir_stack = []
488 488
489 489 # Functions to call the underlying shell.
490 490
491 491 # The first is similar to os.system, but it doesn't return a value,
492 492 # and it allows interpolation of variables in the user's namespace.
493 493 self.system = lambda cmd: \
494 494 shell(self.var_expand(cmd,depth=2),
495 495 header=self.rc.system_header,
496 496 verbose=self.rc.system_verbose)
497 497
498 498 # These are for getoutput and getoutputerror:
499 499 self.getoutput = lambda cmd: \
500 500 getoutput(self.var_expand(cmd,depth=2),
501 501 header=self.rc.system_header,
502 502 verbose=self.rc.system_verbose)
503 503
504 504 self.getoutputerror = lambda cmd: \
505 505 getoutputerror(self.var_expand(cmd,depth=2),
506 506 header=self.rc.system_header,
507 507 verbose=self.rc.system_verbose)
508 508
509 509
510 510 # keep track of where we started running (mainly for crash post-mortem)
511 511 self.starting_dir = os.getcwd()
512 512
513 513 # Various switches which can be set
514 514 self.CACHELENGTH = 5000 # this is cheap, it's just text
515 515 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
516 516 self.banner2 = banner2
517 517
518 518 # TraceBack handlers:
519 519
520 520 # Syntax error handler.
521 521 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
522 522
523 523 # The interactive one is initialized with an offset, meaning we always
524 524 # want to remove the topmost item in the traceback, which is our own
525 525 # internal code. Valid modes: ['Plain','Context','Verbose']
526 526 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
527 527 color_scheme='NoColor',
528 528 tb_offset = 1)
529 529
530 530 # IPython itself shouldn't crash. This will produce a detailed
531 531 # post-mortem if it does. But we only install the crash handler for
532 532 # non-threaded shells, the threaded ones use a normal verbose reporter
533 533 # and lose the crash handler. This is because exceptions in the main
534 534 # thread (such as in GUI code) propagate directly to sys.excepthook,
535 535 # and there's no point in printing crash dumps for every user exception.
536 536 if self.isthreaded:
537 537 ipCrashHandler = ultraTB.FormattedTB()
538 538 else:
539 539 from IPython import CrashHandler
540 540 ipCrashHandler = CrashHandler.IPythonCrashHandler(self)
541 541 self.set_crash_handler(ipCrashHandler)
542 542
543 543 # and add any custom exception handlers the user may have specified
544 544 self.set_custom_exc(*custom_exceptions)
545 545
546 546 # indentation management
547 547 self.autoindent = False
548 548 self.indent_current_nsp = 0
549 549
550 550 # Make some aliases automatically
551 551 # Prepare list of shell aliases to auto-define
552 552 if os.name == 'posix':
553 553 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
554 554 'mv mv -i','rm rm -i','cp cp -i',
555 555 'cat cat','less less','clear clear',
556 556 # a better ls
557 557 'ls ls -F',
558 558 # long ls
559 559 'll ls -lF')
560 560 # Extra ls aliases with color, which need special treatment on BSD
561 561 # variants
562 562 ls_extra = ( # color ls
563 563 'lc ls -F -o --color',
564 564 # ls normal files only
565 565 'lf ls -F -o --color %l | grep ^-',
566 566 # ls symbolic links
567 567 'lk ls -F -o --color %l | grep ^l',
568 568 # directories or links to directories,
569 569 'ldir ls -F -o --color %l | grep /$',
570 570 # things which are executable
571 571 'lx ls -F -o --color %l | grep ^-..x',
572 572 )
573 573 # The BSDs don't ship GNU ls, so they don't understand the
574 574 # --color switch out of the box
575 575 if 'bsd' in sys.platform:
576 576 ls_extra = ( # ls normal files only
577 577 'lf ls -lF | grep ^-',
578 578 # ls symbolic links
579 579 'lk ls -lF | grep ^l',
580 580 # directories or links to directories,
581 581 'ldir ls -lF | grep /$',
582 582 # things which are executable
583 583 'lx ls -lF | grep ^-..x',
584 584 )
585 585 auto_alias = auto_alias + ls_extra
586 586 elif os.name in ['nt','dos']:
587 587 auto_alias = ('ls dir /on',
588 588 'ddir dir /ad /on', 'ldir dir /ad /on',
589 589 'mkdir mkdir','rmdir rmdir','echo echo',
590 590 'ren ren','cls cls','copy copy')
591 591 else:
592 592 auto_alias = ()
593 593 self.auto_alias = [s.split(None,1) for s in auto_alias]
594 594
595 595 # Produce a public API instance
596 596 self.api = IPython.ipapi.IPApi(self)
597 597
598 598 # Call the actual (public) initializer
599 599 self.init_auto_alias()
600 600
601 601 # track which builtins we add, so we can clean up later
602 602 self.builtins_added = {}
603 603 # This method will add the necessary builtins for operation, but
604 604 # tracking what it did via the builtins_added dict.
605 605 self.add_builtins()
606 606
607 607
608 608
609 609 # end __init__
610 610
611 611 def var_expand(self,cmd,depth=0):
612 612 """Expand python variables in a string.
613 613
614 614 The depth argument indicates how many frames above the caller should
615 615 be walked to look for the local namespace where to expand variables.
616 616
617 617 The global namespace for expansion is always the user's interactive
618 618 namespace.
619 619 """
620 620
621 621 return str(ItplNS(cmd.replace('#','\#'),
622 622 self.user_ns, # globals
623 623 # Skip our own frame in searching for locals:
624 624 sys._getframe(depth+1).f_locals # locals
625 625 ))
626 626
627 627 def pre_config_initialization(self):
628 628 """Pre-configuration init method
629 629
630 630 This is called before the configuration files are processed to
631 631 prepare the services the config files might need.
632 632
633 633 self.rc already has reasonable default values at this point.
634 634 """
635 635 rc = self.rc
636 636 try:
637 637 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
638 638 except exceptions.UnicodeDecodeError:
639 639 print "Your ipythondir can't be decoded to unicode!"
640 640 print "Please set HOME environment variable to something that"
641 641 print r"only has ASCII characters, e.g. c:\home"
642 642 print "Now it is",rc.ipythondir
643 643 sys.exit()
644 644 self.shadowhist = IPython.history.ShadowHist(self.db)
645 645
646 646
647 647 def post_config_initialization(self):
648 648 """Post configuration init method
649 649
650 650 This is called after the configuration files have been processed to
651 651 'finalize' the initialization."""
652 652
653 653 rc = self.rc
654 654
655 655 # Object inspector
656 656 self.inspector = OInspect.Inspector(OInspect.InspectColors,
657 657 PyColorize.ANSICodeColors,
658 658 'NoColor',
659 659 rc.object_info_string_level)
660 660
661 661 self.rl_next_input = None
662 662 self.rl_do_indent = False
663 663 # Load readline proper
664 664 if rc.readline:
665 665 self.init_readline()
666 666
667 667
668 668 # local shortcut, this is used a LOT
669 669 self.log = self.logger.log
670 670
671 671 # Initialize cache, set in/out prompts and printing system
672 672 self.outputcache = CachedOutput(self,
673 673 rc.cache_size,
674 674 rc.pprint,
675 675 input_sep = rc.separate_in,
676 676 output_sep = rc.separate_out,
677 677 output_sep2 = rc.separate_out2,
678 678 ps1 = rc.prompt_in1,
679 679 ps2 = rc.prompt_in2,
680 680 ps_out = rc.prompt_out,
681 681 pad_left = rc.prompts_pad_left)
682 682
683 683 # user may have over-ridden the default print hook:
684 684 try:
685 685 self.outputcache.__class__.display = self.hooks.display
686 686 except AttributeError:
687 687 pass
688 688
689 689 # I don't like assigning globally to sys, because it means when
690 690 # embedding instances, each embedded instance overrides the previous
691 691 # choice. But sys.displayhook seems to be called internally by exec,
692 692 # so I don't see a way around it. We first save the original and then
693 693 # overwrite it.
694 694 self.sys_displayhook = sys.displayhook
695 695 sys.displayhook = self.outputcache
696 696
697 697 # Do a proper resetting of doctest, including the necessary displayhook
698 698 # monkeypatching
699 699 doctest_reload()
700 700
701 701 # Set user colors (don't do it in the constructor above so that it
702 702 # doesn't crash if colors option is invalid)
703 703 self.magic_colors(rc.colors)
704 704
705 705 # Set calling of pdb on exceptions
706 706 self.call_pdb = rc.pdb
707 707
708 708 # Load user aliases
709 709 for alias in rc.alias:
710 710 self.magic_alias(alias)
711 711
712 712 self.hooks.late_startup_hook()
713 713
714 714 batchrun = False
715 715 for batchfile in [path(arg) for arg in self.rc.args
716 716 if arg.lower().endswith('.ipy')]:
717 717 if not batchfile.isfile():
718 718 print "No such batch file:", batchfile
719 719 continue
720 720 self.api.runlines(batchfile.text())
721 721 batchrun = True
722 722 # without -i option, exit after running the batch file
723 723 if batchrun and not self.rc.interact:
724 724 self.exit_now = True
725 725
726 726 def add_builtins(self):
727 727 """Store ipython references into the builtin namespace.
728 728
729 729 Some parts of ipython operate via builtins injected here, which hold a
730 730 reference to IPython itself."""
731 731
732 732 # TODO: deprecate all except _ip; 'jobs' should be installed
733 733 # by an extension and the rest are under _ip, ipalias is redundant
734 734 builtins_new = dict(__IPYTHON__ = self,
735 735 ip_set_hook = self.set_hook,
736 736 jobs = self.jobs,
737 737 ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'),
738 738 ipalias = wrap_deprecated(self.ipalias),
739 739 ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'),
740 740 _ip = self.api
741 741 )
742 742 for biname,bival in builtins_new.items():
743 743 try:
744 744 # store the orignal value so we can restore it
745 745 self.builtins_added[biname] = __builtin__.__dict__[biname]
746 746 except KeyError:
747 747 # or mark that it wasn't defined, and we'll just delete it at
748 748 # cleanup
749 749 self.builtins_added[biname] = Undefined
750 750 __builtin__.__dict__[biname] = bival
751 751
752 752 # Keep in the builtins a flag for when IPython is active. We set it
753 753 # with setdefault so that multiple nested IPythons don't clobber one
754 754 # another. Each will increase its value by one upon being activated,
755 755 # which also gives us a way to determine the nesting level.
756 756 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
757 757
758 758 def clean_builtins(self):
759 759 """Remove any builtins which might have been added by add_builtins, or
760 760 restore overwritten ones to their previous values."""
761 761 for biname,bival in self.builtins_added.items():
762 762 if bival is Undefined:
763 763 del __builtin__.__dict__[biname]
764 764 else:
765 765 __builtin__.__dict__[biname] = bival
766 766 self.builtins_added.clear()
767 767
768 768 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
769 769 """set_hook(name,hook) -> sets an internal IPython hook.
770 770
771 771 IPython exposes some of its internal API as user-modifiable hooks. By
772 772 adding your function to one of these hooks, you can modify IPython's
773 773 behavior to call at runtime your own routines."""
774 774
775 775 # At some point in the future, this should validate the hook before it
776 776 # accepts it. Probably at least check that the hook takes the number
777 777 # of args it's supposed to.
778 778
779 779 f = new.instancemethod(hook,self,self.__class__)
780 780
781 781 # check if the hook is for strdispatcher first
782 782 if str_key is not None:
783 783 sdp = self.strdispatchers.get(name, StrDispatch())
784 784 sdp.add_s(str_key, f, priority )
785 785 self.strdispatchers[name] = sdp
786 786 return
787 787 if re_key is not None:
788 788 sdp = self.strdispatchers.get(name, StrDispatch())
789 789 sdp.add_re(re.compile(re_key), f, priority )
790 790 self.strdispatchers[name] = sdp
791 791 return
792 792
793 793 dp = getattr(self.hooks, name, None)
794 794 if name not in IPython.hooks.__all__:
795 795 print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ )
796 796 if not dp:
797 797 dp = IPython.hooks.CommandChainDispatcher()
798 798
799 799 try:
800 800 dp.add(f,priority)
801 801 except AttributeError:
802 802 # it was not commandchain, plain old func - replace
803 803 dp = f
804 804
805 805 setattr(self.hooks,name, dp)
806 806
807 807
808 808 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
809 809
810 810 def set_crash_handler(self,crashHandler):
811 811 """Set the IPython crash handler.
812 812
813 813 This must be a callable with a signature suitable for use as
814 814 sys.excepthook."""
815 815
816 816 # Install the given crash handler as the Python exception hook
817 817 sys.excepthook = crashHandler
818 818
819 819 # The instance will store a pointer to this, so that runtime code
820 820 # (such as magics) can access it. This is because during the
821 821 # read-eval loop, it gets temporarily overwritten (to deal with GUI
822 822 # frameworks).
823 823 self.sys_excepthook = sys.excepthook
824 824
825 825
826 826 def set_custom_exc(self,exc_tuple,handler):
827 827 """set_custom_exc(exc_tuple,handler)
828 828
829 829 Set a custom exception handler, which will be called if any of the
830 830 exceptions in exc_tuple occur in the mainloop (specifically, in the
831 831 runcode() method.
832 832
833 833 Inputs:
834 834
835 835 - exc_tuple: a *tuple* of valid exceptions to call the defined
836 836 handler for. It is very important that you use a tuple, and NOT A
837 837 LIST here, because of the way Python's except statement works. If
838 838 you only want to trap a single exception, use a singleton tuple:
839 839
840 840 exc_tuple == (MyCustomException,)
841 841
842 842 - handler: this must be defined as a function with the following
843 843 basic interface: def my_handler(self,etype,value,tb).
844 844
845 845 This will be made into an instance method (via new.instancemethod)
846 846 of IPython itself, and it will be called if any of the exceptions
847 847 listed in the exc_tuple are caught. If the handler is None, an
848 848 internal basic one is used, which just prints basic info.
849 849
850 850 WARNING: by putting in your own exception handler into IPython's main
851 851 execution loop, you run a very good chance of nasty crashes. This
852 852 facility should only be used if you really know what you are doing."""
853 853
854 854 assert type(exc_tuple)==type(()) , \
855 855 "The custom exceptions must be given AS A TUPLE."
856 856
857 857 def dummy_handler(self,etype,value,tb):
858 858 print '*** Simple custom exception handler ***'
859 859 print 'Exception type :',etype
860 860 print 'Exception value:',value
861 861 print 'Traceback :',tb
862 862 print 'Source code :','\n'.join(self.buffer)
863 863
864 864 if handler is None: handler = dummy_handler
865 865
866 866 self.CustomTB = new.instancemethod(handler,self,self.__class__)
867 867 self.custom_exceptions = exc_tuple
868 868
869 869 def set_custom_completer(self,completer,pos=0):
870 870 """set_custom_completer(completer,pos=0)
871 871
872 872 Adds a new custom completer function.
873 873
874 874 The position argument (defaults to 0) is the index in the completers
875 875 list where you want the completer to be inserted."""
876 876
877 877 newcomp = new.instancemethod(completer,self.Completer,
878 878 self.Completer.__class__)
879 879 self.Completer.matchers.insert(pos,newcomp)
880 880
881 881 def set_completer(self):
882 882 """reset readline's completer to be our own."""
883 883 self.readline.set_completer(self.Completer.complete)
884 884
885 885 def _get_call_pdb(self):
886 886 return self._call_pdb
887 887
888 888 def _set_call_pdb(self,val):
889 889
890 890 if val not in (0,1,False,True):
891 891 raise ValueError,'new call_pdb value must be boolean'
892 892
893 893 # store value in instance
894 894 self._call_pdb = val
895 895
896 896 # notify the actual exception handlers
897 897 self.InteractiveTB.call_pdb = val
898 898 if self.isthreaded:
899 899 try:
900 900 self.sys_excepthook.call_pdb = val
901 901 except:
902 902 warn('Failed to activate pdb for threaded exception handler')
903 903
904 904 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
905 905 'Control auto-activation of pdb at exceptions')
906 906
907 907
908 908 # These special functions get installed in the builtin namespace, to
909 909 # provide programmatic (pure python) access to magics, aliases and system
910 910 # calls. This is important for logging, user scripting, and more.
911 911
912 912 # We are basically exposing, via normal python functions, the three
913 913 # mechanisms in which ipython offers special call modes (magics for
914 914 # internal control, aliases for direct system access via pre-selected
915 915 # names, and !cmd for calling arbitrary system commands).
916 916
917 917 def ipmagic(self,arg_s):
918 918 """Call a magic function by name.
919 919
920 920 Input: a string containing the name of the magic function to call and any
921 921 additional arguments to be passed to the magic.
922 922
923 923 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
924 924 prompt:
925 925
926 926 In[1]: %name -opt foo bar
927 927
928 928 To call a magic without arguments, simply use ipmagic('name').
929 929
930 930 This provides a proper Python function to call IPython's magics in any
931 931 valid Python code you can type at the interpreter, including loops and
932 932 compound statements. It is added by IPython to the Python builtin
933 933 namespace upon initialization."""
934 934
935 935 args = arg_s.split(' ',1)
936 936 magic_name = args[0]
937 937 magic_name = magic_name.lstrip(self.ESC_MAGIC)
938 938
939 939 try:
940 940 magic_args = args[1]
941 941 except IndexError:
942 942 magic_args = ''
943 943 fn = getattr(self,'magic_'+magic_name,None)
944 944 if fn is None:
945 945 error("Magic function `%s` not found." % magic_name)
946 946 else:
947 947 magic_args = self.var_expand(magic_args,1)
948 948 return fn(magic_args)
949 949
950 950 def ipalias(self,arg_s):
951 951 """Call an alias by name.
952 952
953 953 Input: a string containing the name of the alias to call and any
954 954 additional arguments to be passed to the magic.
955 955
956 956 ipalias('name -opt foo bar') is equivalent to typing at the ipython
957 957 prompt:
958 958
959 959 In[1]: name -opt foo bar
960 960
961 961 To call an alias without arguments, simply use ipalias('name').
962 962
963 963 This provides a proper Python function to call IPython's aliases in any
964 964 valid Python code you can type at the interpreter, including loops and
965 965 compound statements. It is added by IPython to the Python builtin
966 966 namespace upon initialization."""
967 967
968 968 args = arg_s.split(' ',1)
969 969 alias_name = args[0]
970 970 try:
971 971 alias_args = args[1]
972 972 except IndexError:
973 973 alias_args = ''
974 974 if alias_name in self.alias_table:
975 975 self.call_alias(alias_name,alias_args)
976 976 else:
977 977 error("Alias `%s` not found." % alias_name)
978 978
979 979 def ipsystem(self,arg_s):
980 980 """Make a system call, using IPython."""
981 981
982 982 self.system(arg_s)
983 983
984 984 def complete(self,text):
985 985 """Return a sorted list of all possible completions on text.
986 986
987 987 Inputs:
988 988
989 989 - text: a string of text to be completed on.
990 990
991 991 This is a wrapper around the completion mechanism, similar to what
992 992 readline does at the command line when the TAB key is hit. By
993 993 exposing it as a method, it can be used by other non-readline
994 994 environments (such as GUIs) for text completion.
995 995
996 996 Simple usage example:
997 997
998 998 In [1]: x = 'hello'
999 999
1000 1000 In [2]: __IP.complete('x.l')
1001 1001 Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']"""
1002 1002
1003 1003 complete = self.Completer.complete
1004 1004 state = 0
1005 1005 # use a dict so we get unique keys, since ipyhton's multiple
1006 1006 # completers can return duplicates. When we make 2.4 a requirement,
1007 1007 # start using sets instead, which are faster.
1008 1008 comps = {}
1009 1009 while True:
1010 1010 newcomp = complete(text,state,line_buffer=text)
1011 1011 if newcomp is None:
1012 1012 break
1013 1013 comps[newcomp] = 1
1014 1014 state += 1
1015 1015 outcomps = comps.keys()
1016 1016 outcomps.sort()
1017 1017 return outcomps
1018 1018
1019 1019 def set_completer_frame(self, frame=None):
1020 1020 if frame:
1021 1021 self.Completer.namespace = frame.f_locals
1022 1022 self.Completer.global_namespace = frame.f_globals
1023 1023 else:
1024 1024 self.Completer.namespace = self.user_ns
1025 1025 self.Completer.global_namespace = self.user_global_ns
1026 1026
1027 1027 def init_auto_alias(self):
1028 1028 """Define some aliases automatically.
1029 1029
1030 1030 These are ALL parameter-less aliases"""
1031 1031
1032 1032 for alias,cmd in self.auto_alias:
1033 1033 self.getapi().defalias(alias,cmd)
1034 1034
1035 1035
1036 1036 def alias_table_validate(self,verbose=0):
1037 1037 """Update information about the alias table.
1038 1038
1039 1039 In particular, make sure no Python keywords/builtins are in it."""
1040 1040
1041 1041 no_alias = self.no_alias
1042 1042 for k in self.alias_table.keys():
1043 1043 if k in no_alias:
1044 1044 del self.alias_table[k]
1045 1045 if verbose:
1046 1046 print ("Deleting alias <%s>, it's a Python "
1047 1047 "keyword or builtin." % k)
1048 1048
1049 1049 def set_autoindent(self,value=None):
1050 1050 """Set the autoindent flag, checking for readline support.
1051 1051
1052 1052 If called with no arguments, it acts as a toggle."""
1053 1053
1054 1054 if not self.has_readline:
1055 1055 if os.name == 'posix':
1056 1056 warn("The auto-indent feature requires the readline library")
1057 1057 self.autoindent = 0
1058 1058 return
1059 1059 if value is None:
1060 1060 self.autoindent = not self.autoindent
1061 1061 else:
1062 1062 self.autoindent = value
1063 1063
1064 1064 def rc_set_toggle(self,rc_field,value=None):
1065 1065 """Set or toggle a field in IPython's rc config. structure.
1066 1066
1067 1067 If called with no arguments, it acts as a toggle.
1068 1068
1069 1069 If called with a non-existent field, the resulting AttributeError
1070 1070 exception will propagate out."""
1071 1071
1072 1072 rc_val = getattr(self.rc,rc_field)
1073 1073 if value is None:
1074 1074 value = not rc_val
1075 1075 setattr(self.rc,rc_field,value)
1076 1076
1077 1077 def user_setup(self,ipythondir,rc_suffix,mode='install'):
1078 1078 """Install the user configuration directory.
1079 1079
1080 1080 Can be called when running for the first time or to upgrade the user's
1081 1081 .ipython/ directory with the mode parameter. Valid modes are 'install'
1082 1082 and 'upgrade'."""
1083 1083
1084 1084 def wait():
1085 1085 try:
1086 1086 raw_input("Please press <RETURN> to start IPython.")
1087 1087 except EOFError:
1088 1088 print >> Term.cout
1089 1089 print '*'*70
1090 1090
1091 1091 cwd = os.getcwd() # remember where we started
1092 1092 glb = glob.glob
1093 1093 print '*'*70
1094 1094 if mode == 'install':
1095 1095 print \
1096 1096 """Welcome to IPython. I will try to create a personal configuration directory
1097 1097 where you can customize many aspects of IPython's functionality in:\n"""
1098 1098 else:
1099 1099 print 'I am going to upgrade your configuration in:'
1100 1100
1101 1101 print ipythondir
1102 1102
1103 1103 rcdirend = os.path.join('IPython','UserConfig')
1104 1104 cfg = lambda d: os.path.join(d,rcdirend)
1105 1105 try:
1106 1106 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
1107 1107 print "Initializing from configuration",rcdir
1108 1108 except IndexError:
1109 1109 warning = """
1110 1110 Installation error. IPython's directory was not found.
1111 1111
1112 1112 Check the following:
1113 1113
1114 1114 The ipython/IPython directory should be in a directory belonging to your
1115 1115 PYTHONPATH environment variable (that is, it should be in a directory
1116 1116 belonging to sys.path). You can copy it explicitly there or just link to it.
1117 1117
1118 1118 IPython will create a minimal default configuration for you.
1119 1119
1120 1120 """
1121 1121 warn(warning)
1122 1122 wait()
1123 1123
1124 1124 if sys.platform =='win32':
1125 1125 inif = 'ipythonrc.ini'
1126 1126 else:
1127 1127 inif = 'ipythonrc'
1128 1128 minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', inif : '# intentionally left blank' }
1129 1129 os.makedirs(ipythondir)
1130 1130 for f, cont in minimal_setup.items():
1131 1131 open(ipythondir + '/' + f,'w').write(cont)
1132 1132
1133 1133 return
1134 1134
1135 1135 if mode == 'install':
1136 1136 try:
1137 1137 shutil.copytree(rcdir,ipythondir)
1138 1138 os.chdir(ipythondir)
1139 1139 rc_files = glb("ipythonrc*")
1140 1140 for rc_file in rc_files:
1141 1141 os.rename(rc_file,rc_file+rc_suffix)
1142 1142 except:
1143 1143 warning = """
1144 1144
1145 1145 There was a problem with the installation:
1146 1146 %s
1147 1147 Try to correct it or contact the developers if you think it's a bug.
1148 1148 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
1149 1149 warn(warning)
1150 1150 wait()
1151 1151 return
1152 1152
1153 1153 elif mode == 'upgrade':
1154 1154 try:
1155 1155 os.chdir(ipythondir)
1156 1156 except:
1157 1157 print """
1158 1158 Can not upgrade: changing to directory %s failed. Details:
1159 1159 %s
1160 1160 """ % (ipythondir,sys.exc_info()[1])
1161 1161 wait()
1162 1162 return
1163 1163 else:
1164 1164 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
1165 1165 for new_full_path in sources:
1166 1166 new_filename = os.path.basename(new_full_path)
1167 1167 if new_filename.startswith('ipythonrc'):
1168 1168 new_filename = new_filename + rc_suffix
1169 1169 # The config directory should only contain files, skip any
1170 1170 # directories which may be there (like CVS)
1171 1171 if os.path.isdir(new_full_path):
1172 1172 continue
1173 1173 if os.path.exists(new_filename):
1174 1174 old_file = new_filename+'.old'
1175 1175 if os.path.exists(old_file):
1176 1176 os.remove(old_file)
1177 1177 os.rename(new_filename,old_file)
1178 1178 shutil.copy(new_full_path,new_filename)
1179 1179 else:
1180 1180 raise ValueError,'unrecognized mode for install:',`mode`
1181 1181
1182 1182 # Fix line-endings to those native to each platform in the config
1183 1183 # directory.
1184 1184 try:
1185 1185 os.chdir(ipythondir)
1186 1186 except:
1187 1187 print """
1188 1188 Problem: changing to directory %s failed.
1189 1189 Details:
1190 1190 %s
1191 1191
1192 1192 Some configuration files may have incorrect line endings. This should not
1193 1193 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1])
1194 1194 wait()
1195 1195 else:
1196 1196 for fname in glb('ipythonrc*'):
1197 1197 try:
1198 1198 native_line_ends(fname,backup=0)
1199 1199 except IOError:
1200 1200 pass
1201 1201
1202 1202 if mode == 'install':
1203 1203 print """
1204 1204 Successful installation!
1205 1205
1206 1206 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
1207 1207 IPython manual (there are both HTML and PDF versions supplied with the
1208 1208 distribution) to make sure that your system environment is properly configured
1209 1209 to take advantage of IPython's features.
1210 1210
1211 1211 Important note: the configuration system has changed! The old system is
1212 1212 still in place, but its setting may be partly overridden by the settings in
1213 1213 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
1214 1214 if some of the new settings bother you.
1215 1215
1216 1216 """
1217 1217 else:
1218 1218 print """
1219 1219 Successful upgrade!
1220 1220
1221 1221 All files in your directory:
1222 1222 %(ipythondir)s
1223 1223 which would have been overwritten by the upgrade were backed up with a .old
1224 1224 extension. If you had made particular customizations in those files you may
1225 1225 want to merge them back into the new files.""" % locals()
1226 1226 wait()
1227 1227 os.chdir(cwd)
1228 1228 # end user_setup()
1229 1229
1230 1230 def atexit_operations(self):
1231 1231 """This will be executed at the time of exit.
1232 1232
1233 1233 Saving of persistent data should be performed here. """
1234 1234
1235 1235 #print '*** IPython exit cleanup ***' # dbg
1236 1236 # input history
1237 1237 self.savehist()
1238 1238
1239 1239 # Cleanup all tempfiles left around
1240 1240 for tfile in self.tempfiles:
1241 1241 try:
1242 1242 os.unlink(tfile)
1243 1243 except OSError:
1244 1244 pass
1245 1245
1246 1246 self.hooks.shutdown_hook()
1247 1247
1248 1248 def savehist(self):
1249 1249 """Save input history to a file (via readline library)."""
1250 1250 try:
1251 1251 self.readline.write_history_file(self.histfile)
1252 1252 except:
1253 1253 print 'Unable to save IPython command history to file: ' + \
1254 1254 `self.histfile`
1255 1255
1256 1256 def reloadhist(self):
1257 1257 """Reload the input history from disk file."""
1258 1258
1259 1259 if self.has_readline:
1260 1260 self.readline.clear_history()
1261 1261 self.readline.read_history_file(self.shell.histfile)
1262 1262
1263 1263 def history_saving_wrapper(self, func):
1264 1264 """ Wrap func for readline history saving
1265 1265
1266 1266 Convert func into callable that saves & restores
1267 1267 history around the call """
1268 1268
1269 1269 if not self.has_readline:
1270 1270 return func
1271 1271
1272 1272 def wrapper():
1273 1273 self.savehist()
1274 1274 try:
1275 1275 func()
1276 1276 finally:
1277 1277 readline.read_history_file(self.histfile)
1278 1278 return wrapper
1279 1279
1280 1280
1281 1281 def pre_readline(self):
1282 1282 """readline hook to be used at the start of each line.
1283 1283
1284 1284 Currently it handles auto-indent only."""
1285 1285
1286 1286 #debugx('self.indent_current_nsp','pre_readline:')
1287 1287
1288 1288 if self.rl_do_indent:
1289 1289 self.readline.insert_text(self.indent_current_str())
1290 1290 if self.rl_next_input is not None:
1291 1291 self.readline.insert_text(self.rl_next_input)
1292 1292 self.rl_next_input = None
1293 1293
1294 1294 def init_readline(self):
1295 1295 """Command history completion/saving/reloading."""
1296 1296
1297 1297
1298 1298 import IPython.rlineimpl as readline
1299 1299
1300 1300 if not readline.have_readline:
1301 1301 self.has_readline = 0
1302 1302 self.readline = None
1303 1303 # no point in bugging windows users with this every time:
1304 1304 warn('Readline services not available on this platform.')
1305 1305 else:
1306 1306 sys.modules['readline'] = readline
1307 1307 import atexit
1308 1308 from IPython.completer import IPCompleter
1309 1309 self.Completer = IPCompleter(self,
1310 1310 self.user_ns,
1311 1311 self.user_global_ns,
1312 1312 self.rc.readline_omit__names,
1313 1313 self.alias_table)
1314 1314 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1315 1315 self.strdispatchers['complete_command'] = sdisp
1316 1316 self.Completer.custom_completers = sdisp
1317 1317 # Platform-specific configuration
1318 1318 if os.name == 'nt':
1319 1319 self.readline_startup_hook = readline.set_pre_input_hook
1320 1320 else:
1321 1321 self.readline_startup_hook = readline.set_startup_hook
1322 1322
1323 1323 # Load user's initrc file (readline config)
1324 1324 inputrc_name = os.environ.get('INPUTRC')
1325 1325 if inputrc_name is None:
1326 1326 home_dir = get_home_dir()
1327 1327 if home_dir is not None:
1328 1328 inputrc_name = os.path.join(home_dir,'.inputrc')
1329 1329 if os.path.isfile(inputrc_name):
1330 1330 try:
1331 1331 readline.read_init_file(inputrc_name)
1332 1332 except:
1333 1333 warn('Problems reading readline initialization file <%s>'
1334 1334 % inputrc_name)
1335 1335
1336 1336 self.has_readline = 1
1337 1337 self.readline = readline
1338 1338 # save this in sys so embedded copies can restore it properly
1339 1339 sys.ipcompleter = self.Completer.complete
1340 1340 self.set_completer()
1341 1341
1342 1342 # Configure readline according to user's prefs
1343 1343 for rlcommand in self.rc.readline_parse_and_bind:
1344 1344 readline.parse_and_bind(rlcommand)
1345 1345
1346 1346 # remove some chars from the delimiters list
1347 1347 delims = readline.get_completer_delims()
1348 1348 delims = delims.translate(string._idmap,
1349 1349 self.rc.readline_remove_delims)
1350 1350 readline.set_completer_delims(delims)
1351 1351 # otherwise we end up with a monster history after a while:
1352 1352 readline.set_history_length(1000)
1353 1353 try:
1354 1354 #print '*** Reading readline history' # dbg
1355 1355 readline.read_history_file(self.histfile)
1356 1356 except IOError:
1357 1357 pass # It doesn't exist yet.
1358 1358
1359 1359 atexit.register(self.atexit_operations)
1360 1360 del atexit
1361 1361
1362 1362 # Configure auto-indent for all platforms
1363 1363 self.set_autoindent(self.rc.autoindent)
1364 1364
1365 1365 def ask_yes_no(self,prompt,default=True):
1366 1366 if self.rc.quiet:
1367 1367 return True
1368 1368 return ask_yes_no(prompt,default)
1369 1369
1370 1370 def _should_recompile(self,e):
1371 1371 """Utility routine for edit_syntax_error"""
1372 1372
1373 1373 if e.filename in ('<ipython console>','<input>','<string>',
1374 1374 '<console>','<BackgroundJob compilation>',
1375 1375 None):
1376 1376
1377 1377 return False
1378 1378 try:
1379 1379 if (self.rc.autoedit_syntax and
1380 1380 not self.ask_yes_no('Return to editor to correct syntax error? '
1381 1381 '[Y/n] ','y')):
1382 1382 return False
1383 1383 except EOFError:
1384 1384 return False
1385 1385
1386 1386 def int0(x):
1387 1387 try:
1388 1388 return int(x)
1389 1389 except TypeError:
1390 1390 return 0
1391 1391 # always pass integer line and offset values to editor hook
1392 1392 self.hooks.fix_error_editor(e.filename,
1393 1393 int0(e.lineno),int0(e.offset),e.msg)
1394 1394 return True
1395 1395
1396 1396 def edit_syntax_error(self):
1397 1397 """The bottom half of the syntax error handler called in the main loop.
1398 1398
1399 1399 Loop until syntax error is fixed or user cancels.
1400 1400 """
1401 1401
1402 1402 while self.SyntaxTB.last_syntax_error:
1403 1403 # copy and clear last_syntax_error
1404 1404 err = self.SyntaxTB.clear_err_state()
1405 1405 if not self._should_recompile(err):
1406 1406 return
1407 1407 try:
1408 1408 # may set last_syntax_error again if a SyntaxError is raised
1409 1409 self.safe_execfile(err.filename,self.user_ns)
1410 1410 except:
1411 1411 self.showtraceback()
1412 1412 else:
1413 1413 try:
1414 1414 f = file(err.filename)
1415 1415 try:
1416 1416 sys.displayhook(f.read())
1417 1417 finally:
1418 1418 f.close()
1419 1419 except:
1420 1420 self.showtraceback()
1421 1421
1422 1422 def showsyntaxerror(self, filename=None):
1423 1423 """Display the syntax error that just occurred.
1424 1424
1425 1425 This doesn't display a stack trace because there isn't one.
1426 1426
1427 1427 If a filename is given, it is stuffed in the exception instead
1428 1428 of what was there before (because Python's parser always uses
1429 1429 "<string>" when reading from a string).
1430 1430 """
1431 1431 etype, value, last_traceback = sys.exc_info()
1432 1432
1433 1433 # See note about these variables in showtraceback() below
1434 1434 sys.last_type = etype
1435 1435 sys.last_value = value
1436 1436 sys.last_traceback = last_traceback
1437 1437
1438 1438 if filename and etype is SyntaxError:
1439 1439 # Work hard to stuff the correct filename in the exception
1440 1440 try:
1441 1441 msg, (dummy_filename, lineno, offset, line) = value
1442 1442 except:
1443 1443 # Not the format we expect; leave it alone
1444 1444 pass
1445 1445 else:
1446 1446 # Stuff in the right filename
1447 1447 try:
1448 1448 # Assume SyntaxError is a class exception
1449 1449 value = SyntaxError(msg, (filename, lineno, offset, line))
1450 1450 except:
1451 1451 # If that failed, assume SyntaxError is a string
1452 1452 value = msg, (filename, lineno, offset, line)
1453 1453 self.SyntaxTB(etype,value,[])
1454 1454
1455 1455 def debugger(self,force=False):
1456 1456 """Call the pydb/pdb debugger.
1457 1457
1458 1458 Keywords:
1459 1459
1460 1460 - force(False): by default, this routine checks the instance call_pdb
1461 1461 flag and does not actually invoke the debugger if the flag is false.
1462 1462 The 'force' option forces the debugger to activate even if the flag
1463 1463 is false.
1464 1464 """
1465 1465
1466 1466 if not (force or self.call_pdb):
1467 1467 return
1468 1468
1469 1469 if not hasattr(sys,'last_traceback'):
1470 1470 error('No traceback has been produced, nothing to debug.')
1471 1471 return
1472 1472
1473 1473 # use pydb if available
1474 1474 if Debugger.has_pydb:
1475 1475 from pydb import pm
1476 1476 else:
1477 1477 # fallback to our internal debugger
1478 1478 pm = lambda : self.InteractiveTB.debugger(force=True)
1479 1479 self.history_saving_wrapper(pm)()
1480 1480
1481 1481 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None):
1482 1482 """Display the exception that just occurred.
1483 1483
1484 1484 If nothing is known about the exception, this is the method which
1485 1485 should be used throughout the code for presenting user tracebacks,
1486 1486 rather than directly invoking the InteractiveTB object.
1487 1487
1488 1488 A specific showsyntaxerror() also exists, but this method can take
1489 1489 care of calling it if needed, so unless you are explicitly catching a
1490 1490 SyntaxError exception, don't try to analyze the stack manually and
1491 1491 simply call this method."""
1492 1492
1493 1493
1494 1494 # Though this won't be called by syntax errors in the input line,
1495 1495 # there may be SyntaxError cases whith imported code.
1496 1496
1497 1497
1498 1498 if exc_tuple is None:
1499 1499 etype, value, tb = sys.exc_info()
1500 1500 else:
1501 1501 etype, value, tb = exc_tuple
1502 1502
1503 1503 if etype is SyntaxError:
1504 1504 self.showsyntaxerror(filename)
1505 1505 elif etype is IPython.ipapi.UsageError:
1506 1506 print "UsageError:", value
1507 1507 else:
1508 1508 # WARNING: these variables are somewhat deprecated and not
1509 1509 # necessarily safe to use in a threaded environment, but tools
1510 1510 # like pdb depend on their existence, so let's set them. If we
1511 1511 # find problems in the field, we'll need to revisit their use.
1512 1512 sys.last_type = etype
1513 1513 sys.last_value = value
1514 1514 sys.last_traceback = tb
1515 1515
1516 1516 if etype in self.custom_exceptions:
1517 1517 self.CustomTB(etype,value,tb)
1518 1518 else:
1519 1519 self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
1520 1520 if self.InteractiveTB.call_pdb and self.has_readline:
1521 1521 # pdb mucks up readline, fix it back
1522 1522 self.set_completer()
1523 1523
1524 1524
1525 1525 def mainloop(self,banner=None):
1526 1526 """Creates the local namespace and starts the mainloop.
1527 1527
1528 1528 If an optional banner argument is given, it will override the
1529 1529 internally created default banner."""
1530 1530
1531 1531 if self.rc.c: # Emulate Python's -c option
1532 1532 self.exec_init_cmd()
1533 1533 if banner is None:
1534 1534 if not self.rc.banner:
1535 1535 banner = ''
1536 1536 # banner is string? Use it directly!
1537 1537 elif isinstance(self.rc.banner,basestring):
1538 1538 banner = self.rc.banner
1539 1539 else:
1540 1540 banner = self.BANNER+self.banner2
1541 1541
1542 1542 self.interact(banner)
1543 1543
1544 1544 def exec_init_cmd(self):
1545 1545 """Execute a command given at the command line.
1546 1546
1547 1547 This emulates Python's -c option."""
1548 1548
1549 1549 #sys.argv = ['-c']
1550 1550 self.push(self.prefilter(self.rc.c, False))
1551 1551 if not self.rc.interact:
1552 1552 self.exit_now = True
1553 1553
1554 1554 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1555 1555 """Embeds IPython into a running python program.
1556 1556
1557 1557 Input:
1558 1558
1559 1559 - header: An optional header message can be specified.
1560 1560
1561 1561 - local_ns, global_ns: working namespaces. If given as None, the
1562 1562 IPython-initialized one is updated with __main__.__dict__, so that
1563 1563 program variables become visible but user-specific configuration
1564 1564 remains possible.
1565 1565
1566 1566 - stack_depth: specifies how many levels in the stack to go to
1567 1567 looking for namespaces (when local_ns and global_ns are None). This
1568 1568 allows an intermediate caller to make sure that this function gets
1569 1569 the namespace from the intended level in the stack. By default (0)
1570 1570 it will get its locals and globals from the immediate caller.
1571 1571
1572 1572 Warning: it's possible to use this in a program which is being run by
1573 1573 IPython itself (via %run), but some funny things will happen (a few
1574 1574 globals get overwritten). In the future this will be cleaned up, as
1575 1575 there is no fundamental reason why it can't work perfectly."""
1576 1576
1577 1577 # Get locals and globals from caller
1578 1578 if local_ns is None or global_ns is None:
1579 1579 call_frame = sys._getframe(stack_depth).f_back
1580 1580
1581 1581 if local_ns is None:
1582 1582 local_ns = call_frame.f_locals
1583 1583 if global_ns is None:
1584 1584 global_ns = call_frame.f_globals
1585 1585
1586 1586 # Update namespaces and fire up interpreter
1587 1587
1588 1588 # The global one is easy, we can just throw it in
1589 1589 self.user_global_ns = global_ns
1590 1590
1591 1591 # but the user/local one is tricky: ipython needs it to store internal
1592 1592 # data, but we also need the locals. We'll copy locals in the user
1593 1593 # one, but will track what got copied so we can delete them at exit.
1594 1594 # This is so that a later embedded call doesn't see locals from a
1595 1595 # previous call (which most likely existed in a separate scope).
1596 1596 local_varnames = local_ns.keys()
1597 1597 self.user_ns.update(local_ns)
1598 1598
1599 1599 # Patch for global embedding to make sure that things don't overwrite
1600 1600 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1601 1601 # FIXME. Test this a bit more carefully (the if.. is new)
1602 1602 if local_ns is None and global_ns is None:
1603 1603 self.user_global_ns.update(__main__.__dict__)
1604 1604
1605 1605 # make sure the tab-completer has the correct frame information, so it
1606 1606 # actually completes using the frame's locals/globals
1607 1607 self.set_completer_frame()
1608 1608
1609 1609 # before activating the interactive mode, we need to make sure that
1610 1610 # all names in the builtin namespace needed by ipython point to
1611 1611 # ourselves, and not to other instances.
1612 1612 self.add_builtins()
1613 1613
1614 1614 self.interact(header)
1615 1615
1616 1616 # now, purge out the user namespace from anything we might have added
1617 1617 # from the caller's local namespace
1618 1618 delvar = self.user_ns.pop
1619 1619 for var in local_varnames:
1620 1620 delvar(var,None)
1621 1621 # and clean builtins we may have overridden
1622 1622 self.clean_builtins()
1623 1623
1624 1624 def interact(self, banner=None):
1625 1625 """Closely emulate the interactive Python console.
1626 1626
1627 1627 The optional banner argument specify the banner to print
1628 1628 before the first interaction; by default it prints a banner
1629 1629 similar to the one printed by the real Python interpreter,
1630 1630 followed by the current class name in parentheses (so as not
1631 1631 to confuse this with the real interpreter -- since it's so
1632 1632 close!).
1633 1633
1634 1634 """
1635 1635
1636 1636 if self.exit_now:
1637 1637 # batch run -> do not interact
1638 1638 return
1639 1639 cprt = 'Type "copyright", "credits" or "license" for more information.'
1640 1640 if banner is None:
1641 1641 self.write("Python %s on %s\n%s\n(%s)\n" %
1642 1642 (sys.version, sys.platform, cprt,
1643 1643 self.__class__.__name__))
1644 1644 else:
1645 1645 self.write(banner)
1646 1646
1647 1647 more = 0
1648 1648
1649 1649 # Mark activity in the builtins
1650 1650 __builtin__.__dict__['__IPYTHON__active'] += 1
1651 1651
1652 1652 if self.has_readline:
1653 1653 self.readline_startup_hook(self.pre_readline)
1654 1654 # exit_now is set by a call to %Exit or %Quit
1655 1655
1656 1656 while not self.exit_now:
1657 1657 if more:
1658 1658 prompt = self.hooks.generate_prompt(True)
1659 1659 if self.autoindent:
1660 1660 self.rl_do_indent = True
1661 1661
1662 1662 else:
1663 1663 prompt = self.hooks.generate_prompt(False)
1664 1664 try:
1665 1665 line = self.raw_input(prompt,more)
1666 1666 if self.exit_now:
1667 1667 # quick exit on sys.std[in|out] close
1668 1668 break
1669 1669 if self.autoindent:
1670 1670 self.rl_do_indent = False
1671 1671
1672 1672 except KeyboardInterrupt:
1673 1673 self.write('\nKeyboardInterrupt\n')
1674 1674 self.resetbuffer()
1675 1675 # keep cache in sync with the prompt counter:
1676 1676 self.outputcache.prompt_count -= 1
1677 1677
1678 1678 if self.autoindent:
1679 1679 self.indent_current_nsp = 0
1680 1680 more = 0
1681 1681 except EOFError:
1682 1682 if self.autoindent:
1683 1683 self.rl_do_indent = False
1684 1684 self.readline_startup_hook(None)
1685 1685 self.write('\n')
1686 1686 self.exit()
1687 1687 except bdb.BdbQuit:
1688 1688 warn('The Python debugger has exited with a BdbQuit exception.\n'
1689 1689 'Because of how pdb handles the stack, it is impossible\n'
1690 1690 'for IPython to properly format this particular exception.\n'
1691 1691 'IPython will resume normal operation.')
1692 1692 except:
1693 1693 # exceptions here are VERY RARE, but they can be triggered
1694 1694 # asynchronously by signal handlers, for example.
1695 1695 self.showtraceback()
1696 1696 else:
1697 1697 more = self.push(line)
1698 1698 if (self.SyntaxTB.last_syntax_error and
1699 1699 self.rc.autoedit_syntax):
1700 1700 self.edit_syntax_error()
1701 1701
1702 1702 # We are off again...
1703 1703 __builtin__.__dict__['__IPYTHON__active'] -= 1
1704 1704
1705 1705 def excepthook(self, etype, value, tb):
1706 1706 """One more defense for GUI apps that call sys.excepthook.
1707 1707
1708 1708 GUI frameworks like wxPython trap exceptions and call
1709 1709 sys.excepthook themselves. I guess this is a feature that
1710 1710 enables them to keep running after exceptions that would
1711 1711 otherwise kill their mainloop. This is a bother for IPython
1712 1712 which excepts to catch all of the program exceptions with a try:
1713 1713 except: statement.
1714 1714
1715 1715 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1716 1716 any app directly invokes sys.excepthook, it will look to the user like
1717 1717 IPython crashed. In order to work around this, we can disable the
1718 1718 CrashHandler and replace it with this excepthook instead, which prints a
1719 1719 regular traceback using our InteractiveTB. In this fashion, apps which
1720 1720 call sys.excepthook will generate a regular-looking exception from
1721 1721 IPython, and the CrashHandler will only be triggered by real IPython
1722 1722 crashes.
1723 1723
1724 1724 This hook should be used sparingly, only in places which are not likely
1725 1725 to be true IPython errors.
1726 1726 """
1727 1727 self.showtraceback((etype,value,tb),tb_offset=0)
1728 1728
1729 1729 def expand_aliases(self,fn,rest):
1730 1730 """ Expand multiple levels of aliases:
1731 1731
1732 1732 if:
1733 1733
1734 1734 alias foo bar /tmp
1735 1735 alias baz foo
1736 1736
1737 1737 then:
1738 1738
1739 1739 baz huhhahhei -> bar /tmp huhhahhei
1740 1740
1741 1741 """
1742 1742 line = fn + " " + rest
1743 1743
1744 1744 done = Set()
1745 1745 while 1:
1746 1746 pre,fn,rest = prefilter.splitUserInput(line,
1747 1747 prefilter.shell_line_split)
1748 1748 if fn in self.alias_table:
1749 1749 if fn in done:
1750 1750 warn("Cyclic alias definition, repeated '%s'" % fn)
1751 1751 return ""
1752 1752 done.add(fn)
1753 1753
1754 1754 l2 = self.transform_alias(fn,rest)
1755 1755 # dir -> dir
1756 1756 # print "alias",line, "->",l2 #dbg
1757 1757 if l2 == line:
1758 1758 break
1759 1759 # ls -> ls -F should not recurse forever
1760 1760 if l2.split(None,1)[0] == line.split(None,1)[0]:
1761 1761 line = l2
1762 1762 break
1763 1763
1764 1764 line=l2
1765 1765
1766 1766
1767 1767 # print "al expand to",line #dbg
1768 1768 else:
1769 1769 break
1770 1770
1771 1771 return line
1772 1772
1773 1773 def transform_alias(self, alias,rest=''):
1774 1774 """ Transform alias to system command string.
1775 1775 """
1776 1776 trg = self.alias_table[alias]
1777 1777
1778 1778 nargs,cmd = trg
1779 1779 # print trg #dbg
1780 1780 if ' ' in cmd and os.path.isfile(cmd):
1781 1781 cmd = '"%s"' % cmd
1782 1782
1783 1783 # Expand the %l special to be the user's input line
1784 1784 if cmd.find('%l') >= 0:
1785 1785 cmd = cmd.replace('%l',rest)
1786 1786 rest = ''
1787 1787 if nargs==0:
1788 1788 # Simple, argument-less aliases
1789 1789 cmd = '%s %s' % (cmd,rest)
1790 1790 else:
1791 1791 # Handle aliases with positional arguments
1792 1792 args = rest.split(None,nargs)
1793 1793 if len(args)< nargs:
1794 1794 error('Alias <%s> requires %s arguments, %s given.' %
1795 1795 (alias,nargs,len(args)))
1796 1796 return None
1797 1797 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
1798 1798 # Now call the macro, evaluating in the user's namespace
1799 1799 #print 'new command: <%r>' % cmd # dbg
1800 1800 return cmd
1801 1801
1802 1802 def call_alias(self,alias,rest=''):
1803 1803 """Call an alias given its name and the rest of the line.
1804 1804
1805 1805 This is only used to provide backwards compatibility for users of
1806 1806 ipalias(), use of which is not recommended for anymore."""
1807 1807
1808 1808 # Now call the macro, evaluating in the user's namespace
1809 1809 cmd = self.transform_alias(alias, rest)
1810 1810 try:
1811 1811 self.system(cmd)
1812 1812 except:
1813 1813 self.showtraceback()
1814 1814
1815 1815 def indent_current_str(self):
1816 1816 """return the current level of indentation as a string"""
1817 1817 return self.indent_current_nsp * ' '
1818 1818
1819 1819 def autoindent_update(self,line):
1820 1820 """Keep track of the indent level."""
1821 1821
1822 1822 #debugx('line')
1823 1823 #debugx('self.indent_current_nsp')
1824 1824 if self.autoindent:
1825 1825 if line:
1826 1826 inisp = num_ini_spaces(line)
1827 1827 if inisp < self.indent_current_nsp:
1828 1828 self.indent_current_nsp = inisp
1829 1829
1830 1830 if line[-1] == ':':
1831 1831 self.indent_current_nsp += 4
1832 1832 elif dedent_re.match(line):
1833 1833 self.indent_current_nsp -= 4
1834 1834 else:
1835 1835 self.indent_current_nsp = 0
1836 1836 def runlines(self,lines):
1837 1837 """Run a string of one or more lines of source.
1838 1838
1839 1839 This method is capable of running a string containing multiple source
1840 1840 lines, as if they had been entered at the IPython prompt. Since it
1841 1841 exposes IPython's processing machinery, the given strings can contain
1842 1842 magic calls (%magic), special shell access (!cmd), etc."""
1843 1843
1844 1844 # We must start with a clean buffer, in case this is run from an
1845 1845 # interactive IPython session (via a magic, for example).
1846 1846 self.resetbuffer()
1847 1847 lines = lines.split('\n')
1848 1848 more = 0
1849 1849
1850 1850 for line in lines:
1851 1851 # skip blank lines so we don't mess up the prompt counter, but do
1852 1852 # NOT skip even a blank line if we are in a code block (more is
1853 1853 # true)
1854 1854
1855 1855
1856 1856 if line or more:
1857 1857 # push to raw history, so hist line numbers stay in sync
1858 1858 self.input_hist_raw.append("# " + line + "\n")
1859 1859 more = self.push(self.prefilter(line,more))
1860 1860 # IPython's runsource returns None if there was an error
1861 1861 # compiling the code. This allows us to stop processing right
1862 1862 # away, so the user gets the error message at the right place.
1863 1863 if more is None:
1864 1864 break
1865 1865 else:
1866 1866 self.input_hist_raw.append("\n")
1867 1867 # final newline in case the input didn't have it, so that the code
1868 1868 # actually does get executed
1869 1869 if more:
1870 1870 self.push('\n')
1871 1871
1872 1872 def runsource(self, source, filename='<input>', symbol='single'):
1873 1873 """Compile and run some source in the interpreter.
1874 1874
1875 1875 Arguments are as for compile_command().
1876 1876
1877 1877 One several things can happen:
1878 1878
1879 1879 1) The input is incorrect; compile_command() raised an
1880 1880 exception (SyntaxError or OverflowError). A syntax traceback
1881 1881 will be printed by calling the showsyntaxerror() method.
1882 1882
1883 1883 2) The input is incomplete, and more input is required;
1884 1884 compile_command() returned None. Nothing happens.
1885 1885
1886 1886 3) The input is complete; compile_command() returned a code
1887 1887 object. The code is executed by calling self.runcode() (which
1888 1888 also handles run-time exceptions, except for SystemExit).
1889 1889
1890 1890 The return value is:
1891 1891
1892 1892 - True in case 2
1893 1893
1894 1894 - False in the other cases, unless an exception is raised, where
1895 1895 None is returned instead. This can be used by external callers to
1896 1896 know whether to continue feeding input or not.
1897 1897
1898 1898 The return value can be used to decide whether to use sys.ps1 or
1899 1899 sys.ps2 to prompt the next line."""
1900 1900
1901 1901 # if the source code has leading blanks, add 'if 1:\n' to it
1902 1902 # this allows execution of indented pasted code. It is tempting
1903 1903 # to add '\n' at the end of source to run commands like ' a=1'
1904 1904 # directly, but this fails for more complicated scenarios
1905 source=source.encode(self.stdin_encoding)
1905 1906 if source[:1] in [' ', '\t']:
1906 1907 source = 'if 1:\n%s' % source
1907 1908
1908 1909 try:
1909 1910 code = self.compile(source,filename,symbol)
1910 1911 except (OverflowError, SyntaxError, ValueError):
1911 1912 # Case 1
1912 1913 self.showsyntaxerror(filename)
1913 1914 return None
1914 1915
1915 1916 if code is None:
1916 1917 # Case 2
1917 1918 return True
1918 1919
1919 1920 # Case 3
1920 1921 # We store the code object so that threaded shells and
1921 1922 # custom exception handlers can access all this info if needed.
1922 1923 # The source corresponding to this can be obtained from the
1923 1924 # buffer attribute as '\n'.join(self.buffer).
1924 1925 self.code_to_run = code
1925 1926 # now actually execute the code object
1926 1927 if self.runcode(code) == 0:
1927 1928 return False
1928 1929 else:
1929 1930 return None
1930 1931
1931 1932 def runcode(self,code_obj):
1932 1933 """Execute a code object.
1933 1934
1934 1935 When an exception occurs, self.showtraceback() is called to display a
1935 1936 traceback.
1936 1937
1937 1938 Return value: a flag indicating whether the code to be run completed
1938 1939 successfully:
1939 1940
1940 1941 - 0: successful execution.
1941 1942 - 1: an error occurred.
1942 1943 """
1943 1944
1944 1945 # Set our own excepthook in case the user code tries to call it
1945 1946 # directly, so that the IPython crash handler doesn't get triggered
1946 1947 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
1947 1948
1948 1949 # we save the original sys.excepthook in the instance, in case config
1949 1950 # code (such as magics) needs access to it.
1950 1951 self.sys_excepthook = old_excepthook
1951 1952 outflag = 1 # happens in more places, so it's easier as default
1952 1953 try:
1953 1954 try:
1954 1955 # Embedded instances require separate global/local namespaces
1955 1956 # so they can see both the surrounding (local) namespace and
1956 1957 # the module-level globals when called inside another function.
1957 1958 if self.embedded:
1958 1959 exec code_obj in self.user_global_ns, self.user_ns
1959 1960 # Normal (non-embedded) instances should only have a single
1960 1961 # namespace for user code execution, otherwise functions won't
1961 1962 # see interactive top-level globals.
1962 1963 else:
1963 1964 exec code_obj in self.user_ns
1964 1965 finally:
1965 1966 # Reset our crash handler in place
1966 1967 sys.excepthook = old_excepthook
1967 1968 except SystemExit:
1968 1969 self.resetbuffer()
1969 1970 self.showtraceback()
1970 1971 warn("Type %exit or %quit to exit IPython "
1971 1972 "(%Exit or %Quit do so unconditionally).",level=1)
1972 1973 except self.custom_exceptions:
1973 1974 etype,value,tb = sys.exc_info()
1974 1975 self.CustomTB(etype,value,tb)
1975 1976 except:
1976 1977 self.showtraceback()
1977 1978 else:
1978 1979 outflag = 0
1979 1980 if softspace(sys.stdout, 0):
1980 1981 print
1981 1982 # Flush out code object which has been run (and source)
1982 1983 self.code_to_run = None
1983 1984 return outflag
1984 1985
1985 1986 def push(self, line):
1986 1987 """Push a line to the interpreter.
1987 1988
1988 1989 The line should not have a trailing newline; it may have
1989 1990 internal newlines. The line is appended to a buffer and the
1990 1991 interpreter's runsource() method is called with the
1991 1992 concatenated contents of the buffer as source. If this
1992 1993 indicates that the command was executed or invalid, the buffer
1993 1994 is reset; otherwise, the command is incomplete, and the buffer
1994 1995 is left as it was after the line was appended. The return
1995 1996 value is 1 if more input is required, 0 if the line was dealt
1996 1997 with in some way (this is the same as runsource()).
1997 1998 """
1998 1999
1999 2000 # autoindent management should be done here, and not in the
2000 2001 # interactive loop, since that one is only seen by keyboard input. We
2001 2002 # need this done correctly even for code run via runlines (which uses
2002 2003 # push).
2003 2004
2004 2005 #print 'push line: <%s>' % line # dbg
2005 2006 for subline in line.splitlines():
2006 2007 self.autoindent_update(subline)
2007 2008 self.buffer.append(line)
2008 2009 more = self.runsource('\n'.join(self.buffer), self.filename)
2009 2010 if not more:
2010 2011 self.resetbuffer()
2011 2012 return more
2012 2013
2013 2014 def split_user_input(self, line):
2014 2015 # This is really a hold-over to support ipapi and some extensions
2015 2016 return prefilter.splitUserInput(line)
2016 2017
2017 2018 def resetbuffer(self):
2018 2019 """Reset the input buffer."""
2019 2020 self.buffer[:] = []
2020 2021
2021 2022 def raw_input(self,prompt='',continue_prompt=False):
2022 2023 """Write a prompt and read a line.
2023 2024
2024 2025 The returned line does not include the trailing newline.
2025 2026 When the user enters the EOF key sequence, EOFError is raised.
2026 2027
2027 2028 Optional inputs:
2028 2029
2029 2030 - prompt(''): a string to be printed to prompt the user.
2030 2031
2031 2032 - continue_prompt(False): whether this line is the first one or a
2032 2033 continuation in a sequence of inputs.
2033 2034 """
2034 2035
2035 2036 # Code run by the user may have modified the readline completer state.
2036 2037 # We must ensure that our completer is back in place.
2037 2038 if self.has_readline:
2038 2039 self.set_completer()
2039 2040
2040 2041 try:
2041 2042 line = raw_input_original(prompt).decode(self.stdin_encoding)
2042 2043 except ValueError:
2043 2044 warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
2044 2045 " or sys.stdout.close()!\nExiting IPython!")
2045 2046 self.exit_now = True
2046 2047 return ""
2047 2048
2048 2049 # Try to be reasonably smart about not re-indenting pasted input more
2049 2050 # than necessary. We do this by trimming out the auto-indent initial
2050 2051 # spaces, if the user's actual input started itself with whitespace.
2051 2052 #debugx('self.buffer[-1]')
2052 2053
2053 2054 if self.autoindent:
2054 2055 if num_ini_spaces(line) > self.indent_current_nsp:
2055 2056 line = line[self.indent_current_nsp:]
2056 2057 self.indent_current_nsp = 0
2057 2058
2058 2059 # store the unfiltered input before the user has any chance to modify
2059 2060 # it.
2060 2061 if line.strip():
2061 2062 if continue_prompt:
2062 2063 self.input_hist_raw[-1] += '%s\n' % line
2063 2064 if self.has_readline: # and some config option is set?
2064 2065 try:
2065 2066 histlen = self.readline.get_current_history_length()
2066 2067 newhist = self.input_hist_raw[-1].rstrip()
2067 2068 self.readline.remove_history_item(histlen-1)
2068 2069 self.readline.replace_history_item(histlen-2,newhist)
2069 2070 except AttributeError:
2070 2071 pass # re{move,place}_history_item are new in 2.4.
2071 2072 else:
2072 2073 self.input_hist_raw.append('%s\n' % line)
2073 2074 # only entries starting at first column go to shadow history
2074 2075 if line.lstrip() == line:
2075 2076 self.shadowhist.add(line.strip())
2076 2077 elif not continue_prompt:
2077 2078 self.input_hist_raw.append('\n')
2078 2079 try:
2079 2080 lineout = self.prefilter(line,continue_prompt)
2080 2081 except:
2081 2082 # blanket except, in case a user-defined prefilter crashes, so it
2082 2083 # can't take all of ipython with it.
2083 2084 self.showtraceback()
2084 2085 return ''
2085 2086 else:
2086 2087 return lineout
2087 2088
2088 2089 def _prefilter(self, line, continue_prompt):
2089 2090 """Calls different preprocessors, depending on the form of line."""
2090 2091
2091 2092 # All handlers *must* return a value, even if it's blank ('').
2092 2093
2093 2094 # Lines are NOT logged here. Handlers should process the line as
2094 2095 # needed, update the cache AND log it (so that the input cache array
2095 2096 # stays synced).
2096 2097
2097 2098 #.....................................................................
2098 2099 # Code begins
2099 2100
2100 2101 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
2101 2102
2102 2103 # save the line away in case we crash, so the post-mortem handler can
2103 2104 # record it
2104 2105 self._last_input_line = line
2105 2106
2106 2107 #print '***line: <%s>' % line # dbg
2107 2108
2108 2109 if not line:
2109 2110 # Return immediately on purely empty lines, so that if the user
2110 2111 # previously typed some whitespace that started a continuation
2111 2112 # prompt, he can break out of that loop with just an empty line.
2112 2113 # This is how the default python prompt works.
2113 2114
2114 2115 # Only return if the accumulated input buffer was just whitespace!
2115 2116 if ''.join(self.buffer).isspace():
2116 2117 self.buffer[:] = []
2117 2118 return ''
2118 2119
2119 2120 line_info = prefilter.LineInfo(line, continue_prompt)
2120 2121
2121 2122 # the input history needs to track even empty lines
2122 2123 stripped = line.strip()
2123 2124
2124 2125 if not stripped:
2125 2126 if not continue_prompt:
2126 2127 self.outputcache.prompt_count -= 1
2127 2128 return self.handle_normal(line_info)
2128 2129
2129 2130 # print '***cont',continue_prompt # dbg
2130 2131 # special handlers are only allowed for single line statements
2131 2132 if continue_prompt and not self.rc.multi_line_specials:
2132 2133 return self.handle_normal(line_info)
2133 2134
2134 2135
2135 2136 # See whether any pre-existing handler can take care of it
2136 2137 rewritten = self.hooks.input_prefilter(stripped)
2137 2138 if rewritten != stripped: # ok, some prefilter did something
2138 2139 rewritten = line_info.pre + rewritten # add indentation
2139 2140 return self.handle_normal(prefilter.LineInfo(rewritten,
2140 2141 continue_prompt))
2141 2142
2142 2143 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2143 2144
2144 2145 return prefilter.prefilter(line_info, self)
2145 2146
2146 2147
2147 2148 def _prefilter_dumb(self, line, continue_prompt):
2148 2149 """simple prefilter function, for debugging"""
2149 2150 return self.handle_normal(line,continue_prompt)
2150 2151
2151 2152
2152 2153 def multiline_prefilter(self, line, continue_prompt):
2153 2154 """ Run _prefilter for each line of input
2154 2155
2155 2156 Covers cases where there are multiple lines in the user entry,
2156 2157 which is the case when the user goes back to a multiline history
2157 2158 entry and presses enter.
2158 2159
2159 2160 """
2160 2161 out = []
2161 2162 for l in line.rstrip('\n').split('\n'):
2162 2163 out.append(self._prefilter(l, continue_prompt))
2163 2164 return '\n'.join(out)
2164 2165
2165 2166 # Set the default prefilter() function (this can be user-overridden)
2166 2167 prefilter = multiline_prefilter
2167 2168
2168 2169 def handle_normal(self,line_info):
2169 2170 """Handle normal input lines. Use as a template for handlers."""
2170 2171
2171 2172 # With autoindent on, we need some way to exit the input loop, and I
2172 2173 # don't want to force the user to have to backspace all the way to
2173 2174 # clear the line. The rule will be in this case, that either two
2174 2175 # lines of pure whitespace in a row, or a line of pure whitespace but
2175 2176 # of a size different to the indent level, will exit the input loop.
2176 2177 line = line_info.line
2177 2178 continue_prompt = line_info.continue_prompt
2178 2179
2179 2180 if (continue_prompt and self.autoindent and line.isspace() and
2180 2181 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
2181 2182 (self.buffer[-1]).isspace() )):
2182 2183 line = ''
2183 2184
2184 2185 self.log(line,line,continue_prompt)
2185 2186 return line
2186 2187
2187 2188 def handle_alias(self,line_info):
2188 2189 """Handle alias input lines. """
2189 2190 tgt = self.alias_table[line_info.iFun]
2190 2191 # print "=>",tgt #dbg
2191 2192 if callable(tgt):
2192 2193 if '$' in line_info.line:
2193 2194 call_meth = '(_ip, _ip.itpl(%s))'
2194 2195 else:
2195 2196 call_meth = '(_ip,%s)'
2196 2197 line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace,
2197 2198 line_info.iFun,
2198 2199 make_quoted_expr(line_info.line))
2199 2200 else:
2200 2201 transformed = self.expand_aliases(line_info.iFun,line_info.theRest)
2201 2202
2202 2203 # pre is needed, because it carries the leading whitespace. Otherwise
2203 2204 # aliases won't work in indented sections.
2204 2205 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2205 2206 make_quoted_expr( transformed ))
2206 2207
2207 2208 self.log(line_info.line,line_out,line_info.continue_prompt)
2208 2209 #print 'line out:',line_out # dbg
2209 2210 return line_out
2210 2211
2211 2212 def handle_shell_escape(self, line_info):
2212 2213 """Execute the line in a shell, empty return value"""
2213 2214 #print 'line in :', `line` # dbg
2214 2215 line = line_info.line
2215 2216 if line.lstrip().startswith('!!'):
2216 2217 # rewrite LineInfo's line, iFun and theRest to properly hold the
2217 2218 # call to %sx and the actual command to be executed, so
2218 2219 # handle_magic can work correctly. Note that this works even if
2219 2220 # the line is indented, so it handles multi_line_specials
2220 2221 # properly.
2221 2222 new_rest = line.lstrip()[2:]
2222 2223 line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest)
2223 2224 line_info.iFun = 'sx'
2224 2225 line_info.theRest = new_rest
2225 2226 return self.handle_magic(line_info)
2226 2227 else:
2227 2228 cmd = line.lstrip().lstrip('!')
2228 2229 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2229 2230 make_quoted_expr(cmd))
2230 2231 # update cache/log and return
2231 2232 self.log(line,line_out,line_info.continue_prompt)
2232 2233 return line_out
2233 2234
2234 2235 def handle_magic(self, line_info):
2235 2236 """Execute magic functions."""
2236 2237 iFun = line_info.iFun
2237 2238 theRest = line_info.theRest
2238 2239 cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace,
2239 2240 make_quoted_expr(iFun + " " + theRest))
2240 2241 self.log(line_info.line,cmd,line_info.continue_prompt)
2241 2242 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2242 2243 return cmd
2243 2244
2244 2245 def handle_auto(self, line_info):
2245 2246 """Hande lines which can be auto-executed, quoting if requested."""
2246 2247
2247 2248 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2248 2249 line = line_info.line
2249 2250 iFun = line_info.iFun
2250 2251 theRest = line_info.theRest
2251 2252 pre = line_info.pre
2252 2253 continue_prompt = line_info.continue_prompt
2253 2254 obj = line_info.ofind(self)['obj']
2254 2255
2255 2256 # This should only be active for single-line input!
2256 2257 if continue_prompt:
2257 2258 self.log(line,line,continue_prompt)
2258 2259 return line
2259 2260
2260 2261 force_auto = isinstance(obj, IPython.ipapi.IPyAutocall)
2261 2262 auto_rewrite = True
2262 2263
2263 2264 if pre == self.ESC_QUOTE:
2264 2265 # Auto-quote splitting on whitespace
2265 2266 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2266 2267 elif pre == self.ESC_QUOTE2:
2267 2268 # Auto-quote whole string
2268 2269 newcmd = '%s("%s")' % (iFun,theRest)
2269 2270 elif pre == self.ESC_PAREN:
2270 2271 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2271 2272 else:
2272 2273 # Auto-paren.
2273 2274 # We only apply it to argument-less calls if the autocall
2274 2275 # parameter is set to 2. We only need to check that autocall is <
2275 2276 # 2, since this function isn't called unless it's at least 1.
2276 2277 if not theRest and (self.rc.autocall < 2) and not force_auto:
2277 2278 newcmd = '%s %s' % (iFun,theRest)
2278 2279 auto_rewrite = False
2279 2280 else:
2280 2281 if not force_auto and theRest.startswith('['):
2281 2282 if hasattr(obj,'__getitem__'):
2282 2283 # Don't autocall in this case: item access for an object
2283 2284 # which is BOTH callable and implements __getitem__.
2284 2285 newcmd = '%s %s' % (iFun,theRest)
2285 2286 auto_rewrite = False
2286 2287 else:
2287 2288 # if the object doesn't support [] access, go ahead and
2288 2289 # autocall
2289 2290 newcmd = '%s(%s)' % (iFun.rstrip(),theRest)
2290 2291 elif theRest.endswith(';'):
2291 2292 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2292 2293 else:
2293 2294 newcmd = '%s(%s)' % (iFun.rstrip(), theRest)
2294 2295
2295 2296 if auto_rewrite:
2296 2297 rw = self.outputcache.prompt1.auto_rewrite() + newcmd
2297 2298
2298 2299 try:
2299 2300 # plain ascii works better w/ pyreadline, on some machines, so
2300 2301 # we use it and only print uncolored rewrite if we have unicode
2301 2302 rw = str(rw)
2302 2303 print >>Term.cout, rw
2303 2304 except UnicodeEncodeError:
2304 2305 print "-------------->" + newcmd
2305 2306
2306 2307 # log what is now valid Python, not the actual user input (without the
2307 2308 # final newline)
2308 2309 self.log(line,newcmd,continue_prompt)
2309 2310 return newcmd
2310 2311
2311 2312 def handle_help(self, line_info):
2312 2313 """Try to get some help for the object.
2313 2314
2314 2315 obj? or ?obj -> basic information.
2315 2316 obj?? or ??obj -> more details.
2316 2317 """
2317 2318
2318 2319 line = line_info.line
2319 2320 # We need to make sure that we don't process lines which would be
2320 2321 # otherwise valid python, such as "x=1 # what?"
2321 2322 try:
2322 2323 codeop.compile_command(line)
2323 2324 except SyntaxError:
2324 2325 # We should only handle as help stuff which is NOT valid syntax
2325 2326 if line[0]==self.ESC_HELP:
2326 2327 line = line[1:]
2327 2328 elif line[-1]==self.ESC_HELP:
2328 2329 line = line[:-1]
2329 2330 self.log(line,'#?'+line,line_info.continue_prompt)
2330 2331 if line:
2331 2332 #print 'line:<%r>' % line # dbg
2332 2333 self.magic_pinfo(line)
2333 2334 else:
2334 2335 page(self.usage,screen_lines=self.rc.screen_length)
2335 2336 return '' # Empty string is needed here!
2336 2337 except:
2337 2338 # Pass any other exceptions through to the normal handler
2338 2339 return self.handle_normal(line_info)
2339 2340 else:
2340 2341 # If the code compiles ok, we should handle it normally
2341 2342 return self.handle_normal(line_info)
2342 2343
2343 2344 def getapi(self):
2344 2345 """ Get an IPApi object for this shell instance
2345 2346
2346 2347 Getting an IPApi object is always preferable to accessing the shell
2347 2348 directly, but this holds true especially for extensions.
2348 2349
2349 2350 It should always be possible to implement an extension with IPApi
2350 2351 alone. If not, contact maintainer to request an addition.
2351 2352
2352 2353 """
2353 2354 return self.api
2354 2355
2355 2356 def handle_emacs(self, line_info):
2356 2357 """Handle input lines marked by python-mode."""
2357 2358
2358 2359 # Currently, nothing is done. Later more functionality can be added
2359 2360 # here if needed.
2360 2361
2361 2362 # The input cache shouldn't be updated
2362 2363 return line_info.line
2363 2364
2364 2365
2365 2366 def mktempfile(self,data=None):
2366 2367 """Make a new tempfile and return its filename.
2367 2368
2368 2369 This makes a call to tempfile.mktemp, but it registers the created
2369 2370 filename internally so ipython cleans it up at exit time.
2370 2371
2371 2372 Optional inputs:
2372 2373
2373 2374 - data(None): if data is given, it gets written out to the temp file
2374 2375 immediately, and the file is closed again."""
2375 2376
2376 2377 filename = tempfile.mktemp('.py','ipython_edit_')
2377 2378 self.tempfiles.append(filename)
2378 2379
2379 2380 if data:
2380 2381 tmp_file = open(filename,'w')
2381 2382 tmp_file.write(data)
2382 2383 tmp_file.close()
2383 2384 return filename
2384 2385
2385 2386 def write(self,data):
2386 2387 """Write a string to the default output"""
2387 2388 Term.cout.write(data)
2388 2389
2389 2390 def write_err(self,data):
2390 2391 """Write a string to the default error output"""
2391 2392 Term.cerr.write(data)
2392 2393
2393 2394 def exit(self):
2394 2395 """Handle interactive exit.
2395 2396
2396 2397 This method sets the exit_now attribute."""
2397 2398
2398 2399 if self.rc.confirm_exit:
2399 2400 if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2400 2401 self.exit_now = True
2401 2402 else:
2402 2403 self.exit_now = True
2403 2404
2404 2405 def safe_execfile(self,fname,*where,**kw):
2405 2406 """A safe version of the builtin execfile().
2406 2407
2407 2408 This version will never throw an exception, and knows how to handle
2408 2409 ipython logs as well.
2409 2410
2410 2411 :Parameters:
2411 2412 fname : string
2412 2413 Name of the file to be executed.
2413 2414
2414 2415 where : tuple
2415 2416 One or two namespaces, passed to execfile() as (globals,locals).
2416 2417 If only one is given, it is passed as both.
2417 2418
2418 2419 :Keywords:
2419 2420 islog : boolean (False)
2420 2421
2421 2422 quiet : boolean (True)
2422 2423
2423 2424 exit_ignore : boolean (False)
2424 2425 """
2425 2426
2426 2427 def syspath_cleanup():
2427 2428 """Internal cleanup routine for sys.path."""
2428 2429 if add_dname:
2429 2430 try:
2430 2431 sys.path.remove(dname)
2431 2432 except ValueError:
2432 2433 # For some reason the user has already removed it, ignore.
2433 2434 pass
2434 2435
2435 2436 fname = os.path.expanduser(fname)
2436 2437
2437 2438 # Find things also in current directory. This is needed to mimic the
2438 2439 # behavior of running a script from the system command line, where
2439 2440 # Python inserts the script's directory into sys.path
2440 2441 dname = os.path.dirname(os.path.abspath(fname))
2441 2442 add_dname = False
2442 2443 if dname not in sys.path:
2443 2444 sys.path.insert(0,dname)
2444 2445 add_dname = True
2445 2446
2446 2447 try:
2447 2448 xfile = open(fname)
2448 2449 except:
2449 2450 print >> Term.cerr, \
2450 2451 'Could not open file <%s> for safe execution.' % fname
2451 2452 syspath_cleanup()
2452 2453 return None
2453 2454
2454 2455 kw.setdefault('islog',0)
2455 2456 kw.setdefault('quiet',1)
2456 2457 kw.setdefault('exit_ignore',0)
2457 2458
2458 2459 first = xfile.readline()
2459 2460 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2460 2461 xfile.close()
2461 2462 # line by line execution
2462 2463 if first.startswith(loghead) or kw['islog']:
2463 2464 print 'Loading log file <%s> one line at a time...' % fname
2464 2465 if kw['quiet']:
2465 2466 stdout_save = sys.stdout
2466 2467 sys.stdout = StringIO.StringIO()
2467 2468 try:
2468 2469 globs,locs = where[0:2]
2469 2470 except:
2470 2471 try:
2471 2472 globs = locs = where[0]
2472 2473 except:
2473 2474 globs = locs = globals()
2474 2475 badblocks = []
2475 2476
2476 2477 # we also need to identify indented blocks of code when replaying
2477 2478 # logs and put them together before passing them to an exec
2478 2479 # statement. This takes a bit of regexp and look-ahead work in the
2479 2480 # file. It's easiest if we swallow the whole thing in memory
2480 2481 # first, and manually walk through the lines list moving the
2481 2482 # counter ourselves.
2482 2483 indent_re = re.compile('\s+\S')
2483 2484 xfile = open(fname)
2484 2485 filelines = xfile.readlines()
2485 2486 xfile.close()
2486 2487 nlines = len(filelines)
2487 2488 lnum = 0
2488 2489 while lnum < nlines:
2489 2490 line = filelines[lnum]
2490 2491 lnum += 1
2491 2492 # don't re-insert logger status info into cache
2492 2493 if line.startswith('#log#'):
2493 2494 continue
2494 2495 else:
2495 2496 # build a block of code (maybe a single line) for execution
2496 2497 block = line
2497 2498 try:
2498 2499 next = filelines[lnum] # lnum has already incremented
2499 2500 except:
2500 2501 next = None
2501 2502 while next and indent_re.match(next):
2502 2503 block += next
2503 2504 lnum += 1
2504 2505 try:
2505 2506 next = filelines[lnum]
2506 2507 except:
2507 2508 next = None
2508 2509 # now execute the block of one or more lines
2509 2510 try:
2510 2511 exec block in globs,locs
2511 2512 except SystemExit:
2512 2513 pass
2513 2514 except:
2514 2515 badblocks.append(block.rstrip())
2515 2516 if kw['quiet']: # restore stdout
2516 2517 sys.stdout.close()
2517 2518 sys.stdout = stdout_save
2518 2519 print 'Finished replaying log file <%s>' % fname
2519 2520 if badblocks:
2520 2521 print >> sys.stderr, ('\nThe following lines/blocks in file '
2521 2522 '<%s> reported errors:' % fname)
2522 2523
2523 2524 for badline in badblocks:
2524 2525 print >> sys.stderr, badline
2525 2526 else: # regular file execution
2526 2527 try:
2527 2528 if sys.platform == 'win32' and sys.version_info < (2,5,1):
2528 2529 # Work around a bug in Python for Windows. The bug was
2529 2530 # fixed in in Python 2.5 r54159 and 54158, but that's still
2530 2531 # SVN Python as of March/07. For details, see:
2531 2532 # http://projects.scipy.org/ipython/ipython/ticket/123
2532 2533 try:
2533 2534 globs,locs = where[0:2]
2534 2535 except:
2535 2536 try:
2536 2537 globs = locs = where[0]
2537 2538 except:
2538 2539 globs = locs = globals()
2539 2540 exec file(fname) in globs,locs
2540 2541 else:
2541 2542 execfile(fname,*where)
2542 2543 except SyntaxError:
2543 2544 self.showsyntaxerror()
2544 2545 warn('Failure executing file: <%s>' % fname)
2545 2546 except SystemExit,status:
2546 2547 # Code that correctly sets the exit status flag to success (0)
2547 2548 # shouldn't be bothered with a traceback. Note that a plain
2548 2549 # sys.exit() does NOT set the message to 0 (it's empty) so that
2549 2550 # will still get a traceback. Note that the structure of the
2550 2551 # SystemExit exception changed between Python 2.4 and 2.5, so
2551 2552 # the checks must be done in a version-dependent way.
2552 2553 show = False
2553 2554
2554 2555 if sys.version_info[:2] > (2,5):
2555 2556 if status.message!=0 and not kw['exit_ignore']:
2556 2557 show = True
2557 2558 else:
2558 2559 if status.code and not kw['exit_ignore']:
2559 2560 show = True
2560 2561 if show:
2561 2562 self.showtraceback()
2562 2563 warn('Failure executing file: <%s>' % fname)
2563 2564 except:
2564 2565 self.showtraceback()
2565 2566 warn('Failure executing file: <%s>' % fname)
2566 2567
2567 2568 syspath_cleanup()
2568 2569
2569 2570 #************************* end of file <iplib.py> *****************************
General Comments 0
You need to be logged in to leave comments. Login now