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