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