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