substitute open(...) for file(...)

The file type is gone in py3k, and all file objects are under the new io hierarchy.  Since open(...) is supported
on both Python 2 and 3, use it instead of file in all instances. This isn't caught by 2to3.

IPython/core/page.py

@@ -1,340 +1,340 b''
 # encoding: utf-8
 """
 Paging capabilities for IPython.core
 
 Authors:
 
 * Brian Granger
 * Fernando Perez
 
 Notes
 -----
 
 For now this uses ipapi, so it can't be in IPython.utils.  If we can get
 rid of that dependency, we could move it there.
 -----
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 import re
 import sys
 import tempfile
 
 from io import UnsupportedOperation
 
 from IPython.core import ipapi
 from IPython.core.error import TryNext
 from IPython.utils.cursesimport import use_curses
 from IPython.utils.data import chop
 from IPython.utils import io
 from IPython.utils.process import system
 from IPython.utils.terminal import get_terminal_size
 
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 esc_re = re.compile(r"(\x1b[^m]+m)")
 
 def page_dumb(strng, start=0, screen_lines=25):
     """Very dumb 'pager' in Python, for when nothing else works.
 
     Only moves forward, same interface as page(), except for pager_cmd and
     mode."""
 
     out_ln  = strng.splitlines()[start:]
     screens = chop(out_ln,screen_lines-1)
     if len(screens) == 1:
         print >>io.stdout, os.linesep.join(screens[0])
     else:
         last_escape = ""
         for scr in screens[0:-1]:
             hunk = os.linesep.join(scr)
             print >>io.stdout, last_escape + hunk
             if not page_more():
                 return
             esc_list = esc_re.findall(hunk)
             if len(esc_list) > 0:
                 last_escape = esc_list[-1]
         print >>io.stdout, last_escape + os.linesep.join(screens[-1])
 
 def _detect_screen_size(use_curses, screen_lines_def):
     """Attempt to work out the number of lines on the screen.
     
     This is called by page(). It can raise an error (e.g. when run in the
     test suite), so it's separated out so it can easily be called in a try block.
     """
     TERM = os.environ.get('TERM',None)
     if (TERM=='xterm' or TERM=='xterm-color') and sys.platform != 'sunos5':
         local_use_curses = use_curses
     else:
         # curses causes problems on many terminals other than xterm, and
         # some termios calls lock up on Sun OS5.
         local_use_curses = False
     if local_use_curses:
         import termios
         import curses
         # There is a bug in curses, where *sometimes* it fails to properly
         # initialize, and then after the endwin() call is made, the
         # terminal is left in an unusable state.  Rather than trying to
         # check everytime for this (by requesting and comparing termios
         # flags each time), we just save the initial terminal state and
         # unconditionally reset it every time.  It's cheaper than making
         # the checks.
         term_flags = termios.tcgetattr(sys.stdout)
 
         # Curses modifies the stdout buffer size by default, which messes
         # up Python's normal stdout buffering.  This would manifest itself
         # to IPython users as delayed printing on stdout after having used
         # the pager.
         #
         # We can prevent this by manually setting the NCURSES_NO_SETBUF
         # environment variable.  For more details, see:
         # http://bugs.python.org/issue10144
         NCURSES_NO_SETBUF = os.environ.get('NCURSES_NO_SETBUF', None)
         os.environ['NCURSES_NO_SETBUF'] = ''
         
         # Proceed with curses initialization
         scr = curses.initscr()
         screen_lines_real,screen_cols = scr.getmaxyx()
         curses.endwin()
 
         # Restore environment
         if NCURSES_NO_SETBUF is None:
             del os.environ['NCURSES_NO_SETBUF']
         else:
             os.environ['NCURSES_NO_SETBUF'] = NCURSES_NO_SETBUF
             
         # Restore terminal state in case endwin() didn't.
         termios.tcsetattr(sys.stdout,termios.TCSANOW,term_flags)
         # Now we have what we needed: the screen size in rows/columns
         return screen_lines_real
         #print '***Screen size:',screen_lines_real,'lines x',\
         #screen_cols,'columns.' # dbg
     else:
         return screen_lines_def
 
 def page(strng, start=0, screen_lines=0, pager_cmd=None):
     """Print a string, piping through a pager after a certain length.
 
     The screen_lines parameter specifies the number of *usable* lines of your
     terminal screen (total lines minus lines you need to reserve to show other
     information).
 
     If you set screen_lines to a number <=0, page() will try to auto-determine
     your screen size and will only use up to (screen_size+screen_lines) for
     printing, paging after that. That is, if you want auto-detection but need
     to reserve the bottom 3 lines of the screen, use screen_lines = -3, and for
     auto-detection without any lines reserved simply use screen_lines = 0.
 
     If a string won't fit in the allowed lines, it is sent through the
     specified pager command. If none given, look for PAGER in the environment,
     and ultimately default to less.
 
     If no system pager works, the string is sent through a 'dumb pager'
     written in python, very simplistic.
     """
 
     # Some routines may auto-compute start offsets incorrectly and pass a
     # negative value.  Offset to 0 for robustness.
     start = max(0, start)
 
     # first, try the hook
     ip = ipapi.get()
     if ip:
         try:
             ip.hooks.show_in_pager(strng)
             return
         except TryNext:
             pass
 
     # Ugly kludge, but calling curses.initscr() flat out crashes in emacs
     TERM = os.environ.get('TERM','dumb')
     if TERM in ['dumb','emacs'] and os.name != 'nt':
         print strng
         return
     # chop off the topmost part of the string we don't want to see
     str_lines = strng.splitlines()[start:]
     str_toprint = os.linesep.join(str_lines)
     num_newlines = len(str_lines)
     len_str = len(str_toprint)
 
     # Dumb heuristics to guesstimate number of on-screen lines the string
     # takes.  Very basic, but good enough for docstrings in reasonable
     # terminals. If someone later feels like refining it, it's not hard.
     numlines = max(num_newlines,int(len_str/80)+1)
 
     screen_lines_def = get_terminal_size()[1]
 
     # auto-determine screen size
     if screen_lines <= 0:
         try:
             screen_lines += _detect_screen_size(use_curses, screen_lines_def)
         except (TypeError, UnsupportedOperation):
             print >>io.stdout, str_toprint
             return
 
     #print 'numlines',numlines,'screenlines',screen_lines  # dbg
     if numlines <= screen_lines :
         #print '*** normal print'  # dbg
         print >>io.stdout, str_toprint
     else:
         # Try to open pager and default to internal one if that fails.
         # All failure modes are tagged as 'retval=1', to match the return
         # value of a failed system command.  If any intermediate attempt
         # sets retval to 1, at the end we resort to our own page_dumb() pager.
         pager_cmd = get_pager_cmd(pager_cmd)
         pager_cmd += ' ' + get_pager_start(pager_cmd,start)
         if os.name == 'nt':
             if pager_cmd.startswith('type'):
                 # The default WinXP 'type' command is failing on complex strings.
                 retval = 1
             else:
                 tmpname = tempfile.mktemp('.txt')
-                tmpfile = file(tmpname,'wt')
+                tmpfile = open(tmpname,'wt')
                 tmpfile.write(strng)
                 tmpfile.close()
                 cmd = "%s < %s" % (pager_cmd,tmpname)
                 if os.system(cmd):
                   retval = 1
                 else:
                   retval = None
                 os.remove(tmpname)
         else:
             try:
                 retval = None
                 # if I use popen4, things hang. No idea why.
                 #pager,shell_out = os.popen4(pager_cmd)
                 pager = os.popen(pager_cmd,'w')
                 pager.write(strng)
                 pager.close()
                 retval = pager.close()  # success returns None
             except IOError,msg:  # broken pipe when user quits
                 if msg.args == (32,'Broken pipe'):
                     retval = None
                 else:
                     retval = 1
             except OSError:
                 # Other strange problems, sometimes seen in Win2k/cygwin
                 retval = 1
         if retval is not None:
             page_dumb(strng,screen_lines=screen_lines)
 
 
 def page_file(fname, start=0, pager_cmd=None):
     """Page a file, using an optional pager command and starting line.
     """
 
     pager_cmd = get_pager_cmd(pager_cmd)
     pager_cmd += ' ' + get_pager_start(pager_cmd,start)
 
     try:
         if os.environ['TERM'] in ['emacs','dumb']:
             raise EnvironmentError
         system(pager_cmd + ' ' + fname)
     except:
         try:
             if start > 0:
                 start -= 1
             page(open(fname).read(),start)
         except:
             print 'Unable to show file',`fname`
 
 
 def get_pager_cmd(pager_cmd=None):
     """Return a pager command.
 
     Makes some attempts at finding an OS-correct one.
     """
     if os.name == 'posix':
         default_pager_cmd = 'less -r'  # -r for color control sequences
     elif os.name in ['nt','dos']:
         default_pager_cmd = 'type'
 
     if pager_cmd is None:
         try:
             pager_cmd = os.environ['PAGER']
         except:
             pager_cmd = default_pager_cmd
     return pager_cmd
 
 
 def get_pager_start(pager, start):
     """Return the string for paging files with an offset.
 
     This is the '+N' argument which less and more (under Unix) accept.
     """
 
     if pager in ['less','more']:
         if start:
             start_string = '+' + str(start)
         else:
             start_string = ''
     else:
         start_string = ''
     return start_string
 
 
 # (X)emacs on win32 doesn't like to be bypassed with msvcrt.getch()
 if os.name == 'nt' and os.environ.get('TERM','dumb') != 'emacs':
     import msvcrt
     def page_more():
         """ Smart pausing between pages
 
         @return:    True if need print more lines, False if quit
         """
         io.stdout.write('---Return to continue, q to quit--- ')
         ans = msvcrt.getch()
         if ans in ("q", "Q"):
             result = False
         else:
             result = True
         io.stdout.write("\b"*37 + " "*37 + "\b"*37)
         return result
 else:
     def page_more():
         ans = raw_input('---Return to continue, q to quit--- ')
         if ans.lower().startswith('q'):
             return False
         else:
             return True
 
 
 def snip_print(str,width = 75,print_full = 0,header = ''):
     """Print a string snipping the midsection to fit in width.
 
     print_full: mode control:
       - 0: only snip long strings
       - 1: send to page() directly.
       - 2: snip long strings and ask for full length viewing with page()
     Return 1 if snipping was necessary, 0 otherwise."""
 
     if print_full == 1:
         page(header+str)
         return 0
 
     print header,
     if len(str) < width:
         print str
         snip = 0
     else:
         whalf = int((width -5)/2)
         print str[:whalf] + ' <...> ' + str[-whalf:]
         snip = 1
     if snip and print_full == 2:
         if raw_input(header+' Snipped. View (y/n)? [N]').lower() == 'y':
             page(str)
     return snip
 

IPython/external/path/_path.py

@@ -1,947 +1,947 b''
 """ path.py - An object representing a path to a file or directory.
 
 Example:
 
 from IPython.external.path import path
 d = path('/home/guido/bin')
 for f in d.files('*.py'):
     f.chmod(0755)
 
 This module requires Python 2.5 or later.
 
 
 URL:     http://pypi.python.org/pypi/path.py
 Author:  Jason Orendorff <jason.orendorff\x40gmail\x2ecom> (and others - see the url!)
 Date:    9 Mar 2007
 """
 
 
 # TODO
 #   - Tree-walking functions don't avoid symlink loops.  Matt Harrison
 #     sent me a patch for this.
 #   - Bug in write_text().  It doesn't support Universal newline mode.
 #   - Better error message in listdir() when self isn't a
 #     directory. (On Windows, the error message really sucks.)
 #   - Make sure everything has a good docstring.
 #   - Add methods for regex find and replace.
 #   - guess_content_type() method?
 #   - Perhaps support arguments to touch().
 
 from __future__ import generators
 
 import sys, warnings, os, fnmatch, glob, shutil, codecs
 from hashlib import md5
 
 __version__ = '2.2'
 __all__ = ['path']
 
 # Platform-specific support for path.owner
 if os.name == 'nt':
     try:
         import win32security
     except ImportError:
         win32security = None
 else:
     try:
         import pwd
     except ImportError:
         pwd = None
 
 
 class TreeWalkWarning(Warning):
     pass
 
 class path(unicode):
     """ Represents a filesystem path.
 
     For documentation on individual methods, consult their
     counterparts in os.path.
     """
 
     # --- Special Python methods.
 
     def __repr__(self):
         return 'path(%s)' % unicode.__repr__(self)
 
     # Adding a path and a string yields a path.
     def __add__(self, more):
         try:
             resultStr = unicode.__add__(self, more)
         except TypeError:  #Python bug
             resultStr = NotImplemented
         if resultStr is NotImplemented:
             return resultStr
         return self.__class__(resultStr)
 
     def __radd__(self, other):
         if isinstance(other, basestring):
             return self.__class__(other.__add__(self))
         else:
             return NotImplemented
 
     # The / operator joins paths.
     def __div__(self, rel):
         """ fp.__div__(rel) == fp / rel == fp.joinpath(rel)
 
         Join two path components, adding a separator character if
         needed.
         """
         return self.__class__(os.path.join(self, rel))
 
     # Make the / operator work even when true division is enabled.
     __truediv__ = __div__
 
     def getcwd(cls):
         """ Return the current working directory as a path object. """
         return cls(os.getcwdu())
     getcwd = classmethod(getcwd)
 
 
     # --- Operations on path strings.
 
     def isabs(s): return os.path.isabs(s)
     def abspath(self):       return self.__class__(os.path.abspath(self))
     def normcase(self):      return self.__class__(os.path.normcase(self))
     def normpath(self):      return self.__class__(os.path.normpath(self))
     def realpath(self):      return self.__class__(os.path.realpath(self))
     def expanduser(self):    return self.__class__(os.path.expanduser(self))
     def expandvars(self):    return self.__class__(os.path.expandvars(self))
     def dirname(self):       return self.__class__(os.path.dirname(self))
     def basename(s): return os.path.basename(s)
 
     def expand(self):
         """ Clean up a filename by calling expandvars(),
         expanduser(), and normpath() on it.
 
         This is commonly everything needed to clean up a filename
         read from a configuration file, for example.
         """
         return self.expandvars().expanduser().normpath()
 
     def _get_namebase(self):
         base, ext = os.path.splitext(self.name)
         return base
 
     def _get_ext(self):
         f, ext = os.path.splitext(unicode(self))
         return ext
 
     def _get_drive(self):
         drive, r = os.path.splitdrive(self)
         return self.__class__(drive)
 
     parent = property(
         dirname, None, None,
         """ This path's parent directory, as a new path object.
 
         For example, path('/usr/local/lib/libpython.so').parent == path('/usr/local/lib')
         """)
 
     name = property(
         basename, None, None,
         """ The name of this file or directory without the full path.
 
         For example, path('/usr/local/lib/libpython.so').name == 'libpython.so'
         """)
 
     namebase = property(
         _get_namebase, None, None,
         """ The same as path.name, but with one file extension stripped off.
 
         For example, path('/home/guido/python.tar.gz').name     == 'python.tar.gz',
         but          path('/home/guido/python.tar.gz').namebase == 'python.tar'
         """)
 
     ext = property(
         _get_ext, None, None,
         """ The file extension, for example '.py'. """)
 
     drive = property(
         _get_drive, None, None,
         """ The drive specifier, for example 'C:'.
         This is always empty on systems that don't use drive specifiers.
         """)
 
     def splitpath(self):
         """ p.splitpath() -> Return (p.parent, p.name). """
         parent, child = os.path.split(self)
         return self.__class__(parent), child
 
     def splitdrive(self):
         """ p.splitdrive() -> Return (p.drive, <the rest of p>).
 
         Split the drive specifier from this path.  If there is
         no drive specifier, p.drive is empty, so the return value
         is simply (path(''), p).  This is always the case on Unix.
         """
         drive, rel = os.path.splitdrive(self)
         return self.__class__(drive), rel
 
     def splitext(self):
         """ p.splitext() -> Return (p.stripext(), p.ext).
 
         Split the filename extension from this path and return
         the two parts.  Either part may be empty.
 
         The extension is everything from '.' to the end of the
         last path segment.  This has the property that if
         (a, b) == p.splitext(), then a + b == p.
         """
         filename, ext = os.path.splitext(self)
         return self.__class__(filename), ext
 
     def stripext(self):
         """ p.stripext() -> Remove one file extension from the path.
 
         For example, path('/home/guido/python.tar.gz').stripext()
         returns path('/home/guido/python.tar').
         """
         return self.splitext()[0]
 
     if hasattr(os.path, 'splitunc'):
         def splitunc(self):
             unc, rest = os.path.splitunc(self)
             return self.__class__(unc), rest
 
         def _get_uncshare(self):
             unc, r = os.path.splitunc(self)
             return self.__class__(unc)
 
         uncshare = property(
             _get_uncshare, None, None,
             """ The UNC mount point for this path.
             This is empty for paths on local drives. """)
 
     def joinpath(self, *args):
         """ Join two or more path components, adding a separator
         character (os.sep) if needed.  Returns a new path
         object.
         """
         return self.__class__(os.path.join(self, *args))
 
     def splitall(self):
         r""" Return a list of the path components in this path.
 
         The first item in the list will be a path.  Its value will be
         either os.curdir, os.pardir, empty, or the root directory of
         this path (for example, '/' or 'C:\\').  The other items in
         the list will be strings.
 
         path.path.joinpath(*result) will yield the original path.
         """
         parts = []
         loc = self
         while loc != os.curdir and loc != os.pardir:
             prev = loc
             loc, child = prev.splitpath()
             if loc == prev:
                 break
             parts.append(child)
         parts.append(loc)
         parts.reverse()
         return parts
 
     def relpath(self):
         """ Return this path as a relative path,
         based from the current working directory.
         """
         cwd = self.__class__(os.getcwdu())
         return cwd.relpathto(self)
 
     def relpathto(self, dest):
         """ Return a relative path from self to dest.
 
         If there is no relative path from self to dest, for example if
         they reside on different drives in Windows, then this returns
         dest.abspath().
         """
         origin = self.abspath()
         dest = self.__class__(dest).abspath()
 
         orig_list = origin.normcase().splitall()
         # Don't normcase dest!  We want to preserve the case.
         dest_list = dest.splitall()
 
         if orig_list[0] != os.path.normcase(dest_list[0]):
             # Can't get here from there.
             return dest
 
         # Find the location where the two paths start to differ.
         i = 0
         for start_seg, dest_seg in zip(orig_list, dest_list):
             if start_seg != os.path.normcase(dest_seg):
                 break
             i += 1
 
         # Now i is the point where the two paths diverge.
         # Need a certain number of "os.pardir"s to work up
         # from the origin to the point of divergence.
         segments = [os.pardir] * (len(orig_list) - i)
         # Need to add the diverging part of dest_list.
         segments += dest_list[i:]
         if len(segments) == 0:
             # If they happen to be identical, use os.curdir.
             relpath = os.curdir
         else:
             relpath = os.path.join(*segments)
         return self.__class__(relpath)
 
     # --- Listing, searching, walking, and matching
 
     def listdir(self, pattern=None):
         """ D.listdir() -> List of items in this directory.
 
         Use D.files() or D.dirs() instead if you want a listing
         of just files or just subdirectories.
 
         The elements of the list are path objects.
 
         With the optional 'pattern' argument, this only lists
         items whose names match the given pattern.
         """
         names = os.listdir(self)
         if pattern is not None:
             names = fnmatch.filter(names, pattern)
         return [self / child for child in names]
 
     def dirs(self, pattern=None):
         """ D.dirs() -> List of this directory's subdirectories.
 
         The elements of the list are path objects.
         This does not walk recursively into subdirectories
         (but see path.walkdirs).
 
         With the optional 'pattern' argument, this only lists
         directories whose names match the given pattern.  For
         example, d.dirs('build-*').
         """
         return [p for p in self.listdir(pattern) if p.isdir()]
 
     def files(self, pattern=None):
         """ D.files() -> List of the files in this directory.
 
         The elements of the list are path objects.
         This does not walk into subdirectories (see path.walkfiles).
 
         With the optional 'pattern' argument, this only lists files
         whose names match the given pattern.  For example,
         d.files('*.pyc').
         """
         
         return [p for p in self.listdir(pattern) if p.isfile()]
 
     def walk(self, pattern=None, errors='strict'):
         """ D.walk() -> iterator over files and subdirs, recursively.
 
         The iterator yields path objects naming each child item of
         this directory and its descendants.  This requires that
         D.isdir().
 
         This performs a depth-first traversal of the directory tree.
         Each directory is returned just before all its children.
 
         The errors= keyword argument controls behavior when an
         error occurs.  The default is 'strict', which causes an
         exception.  The other allowed values are 'warn', which
         reports the error via warnings.warn(), and 'ignore'.
         """
         if errors not in ('strict', 'warn', 'ignore'):
             raise ValueError("invalid errors parameter")
 
         try:
             childList = self.listdir()
         except Exception:
             if errors == 'ignore':
                 return
             elif errors == 'warn':
                 warnings.warn(
                     "Unable to list directory '%s': %s"
                     % (self, sys.exc_info()[1]),
                     TreeWalkWarning)
                 return
             else:
                 raise
 
         for child in childList:
             if pattern is None or child.fnmatch(pattern):
                 yield child
             try:
                 isdir = child.isdir()
             except Exception:
                 if errors == 'ignore':
                     isdir = False
                 elif errors == 'warn':
                     warnings.warn(
                         "Unable to access '%s': %s"
                         % (child, sys.exc_info()[1]),
                         TreeWalkWarning)
                     isdir = False
                 else:
                     raise
 
             if isdir:
                 for item in child.walk(pattern, errors):
                     yield item
 
     def walkdirs(self, pattern=None, errors='strict'):
         """ D.walkdirs() -> iterator over subdirs, recursively.
 
         With the optional 'pattern' argument, this yields only
         directories whose names match the given pattern.  For
         example, mydir.walkdirs('*test') yields only directories
         with names ending in 'test'.
 
         The errors= keyword argument controls behavior when an
         error occurs.  The default is 'strict', which causes an
         exception.  The other allowed values are 'warn', which
         reports the error via warnings.warn(), and 'ignore'.
         """
         if errors not in ('strict', 'warn', 'ignore'):
             raise ValueError("invalid errors parameter")
 
         try:
             dirs = self.dirs()
         except Exception:
             if errors == 'ignore':
                 return
             elif errors == 'warn':
                 warnings.warn(
                     "Unable to list directory '%s': %s"
                     % (self, sys.exc_info()[1]),
                     TreeWalkWarning)
                 return
             else:
                 raise
 
         for child in dirs:
             if pattern is None or child.fnmatch(pattern):
                 yield child
             for subsubdir in child.walkdirs(pattern, errors):
                 yield subsubdir
 
     def walkfiles(self, pattern=None, errors='strict'):
         """ D.walkfiles() -> iterator over files in D, recursively.
 
         The optional argument, pattern, limits the results to files
         with names that match the pattern.  For example,
         mydir.walkfiles('*.tmp') yields only files with the .tmp
         extension.
         """
         if errors not in ('strict', 'warn', 'ignore'):
             raise ValueError("invalid errors parameter")
 
         try:
             childList = self.listdir()
         except Exception:
             if errors == 'ignore':
                 return
             elif errors == 'warn':
                 warnings.warn(
                     "Unable to list directory '%s': %s"
                     % (self, sys.exc_info()[1]),
                     TreeWalkWarning)
                 return
             else:
                 raise
 
         for child in childList:
             try:
                 isfile = child.isfile()
                 isdir = not isfile and child.isdir()
             except:
                 if errors == 'ignore':
                     continue
                 elif errors == 'warn':
                     warnings.warn(
                         "Unable to access '%s': %s"
                         % (self, sys.exc_info()[1]),
                         TreeWalkWarning)
                     continue
                 else:
                     raise
 
             if isfile:
                 if pattern is None or child.fnmatch(pattern):
                     yield child
             elif isdir:
                 for f in child.walkfiles(pattern, errors):
                     yield f
 
     def fnmatch(self, pattern):
         """ Return True if self.name matches the given pattern.
 
         pattern - A filename pattern with wildcards,
             for example '*.py'.
         """
         return fnmatch.fnmatch(self.name, pattern)
 
     def glob(self, pattern):
         """ Return a list of path objects that match the pattern.
 
         pattern - a path relative to this directory, with wildcards.
 
         For example, path('/users').glob('*/bin/*') returns a list
         of all the files users have in their bin directories.
         """
         cls = self.__class__
         return [cls(s) for s in glob.glob(unicode(self / pattern))]
 
 
     # --- Reading or writing an entire file at once.
 
     def open(self, mode='r'):
         """ Open this file.  Return a file object. """
         return open(self, mode)
 
     def bytes(self):
         """ Open this file, read all bytes, return them as a string. """
         f = self.open('rb')
         try:
             return f.read()
         finally:
             f.close()
 
     def write_bytes(self, bytes, append=False):
         """ Open this file and write the given bytes to it.
 
         Default behavior is to overwrite any existing file.
         Call p.write_bytes(bytes, append=True) to append instead.
         """
         if append:
             mode = 'ab'
         else:
             mode = 'wb'
         f = self.open(mode)
         try:
             f.write(bytes)
         finally:
             f.close()
 
     def text(self, encoding=None, errors='strict'):
         r""" Open this file, read it in, return the content as a string.
 
         This uses 'U' mode in Python 2.3 and later, so '\r\n' and '\r'
         are automatically translated to '\n'.
 
         Optional arguments:
 
         encoding - The Unicode encoding (or character set) of
             the file.  If present, the content of the file is
             decoded and returned as a unicode object; otherwise
             it is returned as an 8-bit str.
         errors - How to handle Unicode errors; see help(str.decode)
             for the options.  Default is 'strict'.
         """
         if encoding is None:
             # 8-bit
             f = self.open('U')
             try:
                 return f.read()
             finally:
                 f.close()
         else:
             # Unicode
             f = codecs.open(self, 'r', encoding, errors)
             # (Note - Can't use 'U' mode here, since codecs.open
             # doesn't support 'U' mode, even in Python 2.3.)
             try:
                 t = f.read()
             finally:
                 f.close()
             return (t.replace(u'\r\n', u'\n')
                      .replace(u'\r\x85', u'\n')
                      .replace(u'\r', u'\n')
                      .replace(u'\x85', u'\n')
                      .replace(u'\u2028', u'\n'))
 
     def write_text(self, text, encoding=None, errors='strict', linesep=os.linesep, append=False):
         r""" Write the given text to this file.
 
         The default behavior is to overwrite any existing file;
         to append instead, use the 'append=True' keyword argument.
 
         There are two differences between path.write_text() and
         path.write_bytes(): newline handling and Unicode handling.
         See below.
 
         Parameters:
 
           - text - str/unicode - The text to be written.
 
           - encoding - str - The Unicode encoding that will be used.
             This is ignored if 'text' isn't a Unicode string.
 
           - errors - str - How to handle Unicode encoding errors.
             Default is 'strict'.  See help(unicode.encode) for the
             options.  This is ignored if 'text' isn't a Unicode
             string.
 
           - linesep - keyword argument - str/unicode - The sequence of
             characters to be used to mark end-of-line.  The default is
             os.linesep.  You can also specify None; this means to
             leave all newlines as they are in 'text'.
 
           - append - keyword argument - bool - Specifies what to do if
             the file already exists (True: append to the end of it;
             False: overwrite it.)  The default is False.
 
 
         --- Newline handling.
 
         write_text() converts all standard end-of-line sequences
         ('\n', '\r', and '\r\n') to your platform's default end-of-line
         sequence (see os.linesep; on Windows, for example, the
         end-of-line marker is '\r\n').
 
         If you don't like your platform's default, you can override it
         using the 'linesep=' keyword argument.  If you specifically want
         write_text() to preserve the newlines as-is, use 'linesep=None'.
 
         This applies to Unicode text the same as to 8-bit text, except
         there are three additional standard Unicode end-of-line sequences:
         u'\x85', u'\r\x85', and u'\u2028'.
 
         (This is slightly different from when you open a file for
-        writing with fopen(filename, "w") in C or file(filename, 'w')
+        writing with fopen(filename, "w") in C or open(filename, 'w')
         in Python.)
 
 
         --- Unicode
 
         If 'text' isn't Unicode, then apart from newline handling, the
         bytes are written verbatim to the file.  The 'encoding' and
         'errors' arguments are not used and must be omitted.
 
         If 'text' is Unicode, it is first converted to bytes using the
         specified 'encoding' (or the default encoding if 'encoding'
         isn't specified).  The 'errors' argument applies only to this
         conversion.
 
         """
         if isinstance(text, unicode):
             if linesep is not None:
                 # Convert all standard end-of-line sequences to
                 # ordinary newline characters.
                 text = (text.replace(u'\r\n', u'\n')
                             .replace(u'\r\x85', u'\n')
                             .replace(u'\r', u'\n')
                             .replace(u'\x85', u'\n')
                             .replace(u'\u2028', u'\n'))
                 text = text.replace(u'\n', linesep)
             if encoding is None:
                 encoding = sys.getdefaultencoding()
             bytes = text.encode(encoding, errors)
         else:
             # It is an error to specify an encoding if 'text' is
             # an 8-bit string.
             assert encoding is None
 
             if linesep is not None:
                 text = (text.replace('\r\n', '\n')
                             .replace('\r', '\n'))
                 bytes = text.replace('\n', linesep)
 
         self.write_bytes(bytes, append)
 
     def lines(self, encoding=None, errors='strict', retain=True):
         r""" Open this file, read all lines, return them in a list.
 
         Optional arguments:
             encoding - The Unicode encoding (or character set) of
                 the file.  The default is None, meaning the content
                 of the file is read as 8-bit characters and returned
                 as a list of (non-Unicode) str objects.
             errors - How to handle Unicode errors; see help(str.decode)
                 for the options.  Default is 'strict'
             retain - If true, retain newline characters; but all newline
                 character combinations ('\r', '\n', '\r\n') are
                 translated to '\n'.  If false, newline characters are
                 stripped off.  Default is True.
 
         This uses 'U' mode in Python 2.3 and later.
         """
         if encoding is None and retain:
             f = self.open('U')
             try:
                 return f.readlines()
             finally:
                 f.close()
         else:
             return self.text(encoding, errors).splitlines(retain)
 
     def write_lines(self, lines, encoding=None, errors='strict',
                     linesep=os.linesep, append=False):
         r""" Write the given lines of text to this file.
 
         By default this overwrites any existing file at this path.
 
         This puts a platform-specific newline sequence on every line.
         See 'linesep' below.
 
         lines - A list of strings.
 
         encoding - A Unicode encoding to use.  This applies only if
             'lines' contains any Unicode strings.
 
         errors - How to handle errors in Unicode encoding.  This
             also applies only to Unicode strings.
 
         linesep - The desired line-ending.  This line-ending is
             applied to every line.  If a line already has any
             standard line ending ('\r', '\n', '\r\n', u'\x85',
             u'\r\x85', u'\u2028'), that will be stripped off and
             this will be used instead.  The default is os.linesep,
             which is platform-dependent ('\r\n' on Windows, '\n' on
             Unix, etc.)  Specify None to write the lines as-is,
             like file.writelines().
 
         Use the keyword argument append=True to append lines to the
         file.  The default is to overwrite the file.  Warning:
         When you use this with Unicode data, if the encoding of the
         existing data in the file is different from the encoding
         you specify with the encoding= parameter, the result is
         mixed-encoding data, which can really confuse someone trying
         to read the file later.
         """
         if append:
             mode = 'ab'
         else:
             mode = 'wb'
         f = self.open(mode)
         try:
             for line in lines:
                 isUnicode = isinstance(line, unicode)
                 if linesep is not None:
                     # Strip off any existing line-end and add the
                     # specified linesep string.
                     if isUnicode:
                         if line[-2:] in (u'\r\n', u'\x0d\x85'):
                             line = line[:-2]
                         elif line[-1:] in (u'\r', u'\n',
                                            u'\x85', u'\u2028'):
                             line = line[:-1]
                     else:
                         if line[-2:] == '\r\n':
                             line = line[:-2]
                         elif line[-1:] in ('\r', '\n'):
                             line = line[:-1]
                     line += linesep
                 if isUnicode:
                     if encoding is None:
                         encoding = sys.getdefaultencoding()
                     line = line.encode(encoding, errors)
                 f.write(line)
         finally:
             f.close()
 
     def read_md5(self):
         """ Calculate the md5 hash for this file.
 
         This reads through the entire file.
         """
         f = self.open('rb')
         try:
             m = md5()
             while True:
                 d = f.read(8192)
                 if not d:
                     break
                 m.update(d)
         finally:
             f.close()
         return m.digest()
 
     # --- Methods for querying the filesystem.
     # N.B. We can't assign the functions directly, because they may on some
     # platforms be implemented in C, and compiled functions don't get bound.
     # See gh-737 for discussion of this.
 
     def exists(s): return os.path.exists(s)
     def isdir(s): return os.path.isdir(s)
     def isfile(s): return os.path.isfile(s)
     def islink(s): return os.path.islink(s)
     def ismount(s): return os.path.ismount(s)
 
     if hasattr(os.path, 'samefile'):
         def samefile(s, o): return os.path.samefile(s, o)
 
     def getatime(s): return os.path.getatime(s)
     atime = property(
         getatime, None, None,
         """ Last access time of the file. """)
 
     def getmtime(s): return os.path.getmtime(s)
     mtime = property(
         getmtime, None, None,
         """ Last-modified time of the file. """)
 
     if hasattr(os.path, 'getctime'):
         def getctime(s): return os.path.getctime(s)
         ctime = property(
             getctime, None, None,
             """ Creation time of the file. """)
 
     def getsize(s): return os.path.getsize(s)
     size = property(
         getsize, None, None,
         """ Size of the file, in bytes. """)
 
     if hasattr(os, 'access'):
         def access(self, mode):
             """ Return true if current user has access to this path.
 
             mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK
             """
             return os.access(self, mode)
 
     def stat(self):
         """ Perform a stat() system call on this path. """
         return os.stat(self)
 
     def lstat(self):
         """ Like path.stat(), but do not follow symbolic links. """
         return os.lstat(self)
 
     def get_owner(self):
         r""" Return the name of the owner of this file or directory.
 
         This follows symbolic links.
 
         On Windows, this returns a name of the form ur'DOMAIN\User Name'.
         On Windows, a group can own a file or directory.
         """
         if os.name == 'nt':
             if win32security is None:
                 raise Exception("path.owner requires win32all to be installed")
             desc = win32security.GetFileSecurity(
                 self, win32security.OWNER_SECURITY_INFORMATION)
             sid = desc.GetSecurityDescriptorOwner()
             account, domain, typecode = win32security.LookupAccountSid(None, sid)
             return domain + u'\\' + account
         else:
             if pwd is None:
                 raise NotImplementedError("path.owner is not implemented on this platform.")
             st = self.stat()
             return pwd.getpwuid(st.st_uid).pw_name
 
     owner = property(
         get_owner, None, None,
         """ Name of the owner of this file or directory. """)
 
     if hasattr(os, 'statvfs'):
         def statvfs(self):
             """ Perform a statvfs() system call on this path. """
             return os.statvfs(self)
 
     if hasattr(os, 'pathconf'):
         def pathconf(self, name):
             return os.pathconf(self, name)
 
 
     # --- Modifying operations on files and directories
 
     def utime(self, times):
         """ Set the access and modified times of this file. """
         os.utime(self, times)
 
     def chmod(self, mode):
         os.chmod(self, mode)
 
     if hasattr(os, 'chown'):
         def chown(self, uid, gid):
             os.chown(self, uid, gid)
 
     def rename(self, new):
         os.rename(self, new)
 
     def renames(self, new):
         os.renames(self, new)
 
 
     # --- Create/delete operations on directories
 
     def mkdir(self, mode=0777):
         os.mkdir(self, mode)
 
     def makedirs(self, mode=0777):
         os.makedirs(self, mode)
 
     def rmdir(self):
         os.rmdir(self)
 
     def removedirs(self):
         os.removedirs(self)
 
 
     # --- Modifying operations on files
 
     def touch(self):
         """ Set the access/modified times of this file to the current time.
         Create the file if it does not exist.
         """
         fd = os.open(self, os.O_WRONLY | os.O_CREAT, 0666)
         os.close(fd)
         os.utime(self, None)
 
     def remove(self):
         os.remove(self)
 
     def unlink(self):
         os.unlink(self)
 
 
     # --- Links
 
     if hasattr(os, 'link'):
         def link(self, newpath):
             """ Create a hard link at 'newpath', pointing to this file. """
             os.link(self, newpath)
 
     if hasattr(os, 'symlink'):
         def symlink(self, newlink):
             """ Create a symbolic link at 'newlink', pointing here. """
             os.symlink(self, newlink)
 
     if hasattr(os, 'readlink'):
         def readlink(self):
             """ Return the path to which this symbolic link points.
 
             The result may be an absolute or a relative path.
             """
             return self.__class__(os.readlink(self))
 
         def readlinkabs(self):
             """ Return the path to which this symbolic link points.
 
             The result is always an absolute path.
             """
             p = self.readlink()
             if p.isabs():
                 return p
             else:
                 return (self.parent / p).abspath()
 
 
     # --- High-level functions from shutil
 
     copyfile = shutil.copyfile
     copymode = shutil.copymode
     copystat = shutil.copystat
     copy = shutil.copy
     copy2 = shutil.copy2
     copytree = shutil.copytree
     if hasattr(shutil, 'move'):
         move = shutil.move
     rmtree = shutil.rmtree
 
 
     # --- Special stuff from os
 
     if hasattr(os, 'chroot'):
         def chroot(self):
             os.chroot(self)
 
     if hasattr(os, 'startfile'):
         def startfile(self):
             os.startfile(self)
 

IPython/external/pexpect/_pexpect.py

@@ -1,1900 +1,1900 b''
 """Pexpect is a Python module for spawning child applications and controlling
 them automatically. Pexpect can be used for automating interactive applications
 such as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup
 scripts for duplicating software package installations on different servers. It
 can be used for automated software testing. Pexpect is in the spirit of Don
 Libes' Expect, but Pexpect is pure Python. Other Expect-like modules for Python
 require TCL and Expect or require C extensions to be compiled. Pexpect does not
 use C, Expect, or TCL extensions. It should work on any platform that supports
 the standard Python pty module. The Pexpect interface focuses on ease of use so
 that simple tasks are easy.
 
 There are two main interfaces to the Pexpect system; these are the function,
 run() and the class, spawn. The spawn class is more powerful. The run()
 function is simpler than spawn, and is good for quickly calling program. When
 you call the run() function it executes a given program and then returns the
 output. This is a handy replacement for os.system().
 
 For example::
 
     pexpect.run('ls -la')
 
 The spawn class is the more powerful interface to the Pexpect system. You can
 use this to spawn a child program then interact with it by sending input and
 expecting responses (waiting for patterns in the child's output).
 
 For example::
 
     child = pexpect.spawn('scp foo [e-mail]:.')
     child.expect ('Password:')
     child.sendline (mypassword)
 
 This works even for commands that ask for passwords or other input outside of
 the normal stdio streams. For example, ssh reads input directly from the TTY
 device which bypasses stdin.
 
 Credits: Noah Spurrier, Richard Holden, Marco Molteni, Kimberley Burchett,
 Robert Stone, Hartmut Goebel, Chad Schroeder, Erick Tryzelaar, Dave Kirby, Ids
 vander Molen, George Todd, Noel Taylor, Nicolas D. Cesar, Alexander Gattin,
 Jacques-Etienne Baudoux, Geoffrey Marshall, Francisco Lourenco, Glen Mabey,
 Karthik Gurusamy, Fernando Perez, Corey Minyard, Jon Cohen, Guillaume
 Chazarain, Andrew Ryan, Nick Craig-Wood, Andrew Stone, Jorgen Grahn, John
 Spiegel, Jan Grant, Shane Kerr and Thomas Kluyver. Let me know if I forgot anyone.
 
 Pexpect is free, open source, and all that good stuff.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
 the Software without restriction, including without limitation the rights to
 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do
 so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 Pexpect Copyright (c) 2008-2011 Noah Spurrier
 http://pexpect.sourceforge.net/
 """
 
 try:
     import os, sys, time
     import select
     import re
     import struct
     import resource
     import types
     import pty
     import tty
     import termios
     import fcntl
     import errno
     import traceback
     import signal
 except ImportError, e:
     raise ImportError (str(e) + """
 
 A critical module was not found. Probably this operating system does not
 support it. Pexpect is intended for UNIX-like operating systems.""")
 
 __version__ = '2.6.dev'
 version = __version__
 version_info = (2,6,'dev')
 __all__ = ['ExceptionPexpect', 'EOF', 'TIMEOUT', 'spawn', 'spawnb', 'run', 'which',
     'split_command_line', '__version__']
 
 # Exception classes used by this module.
 class ExceptionPexpect(Exception):
 
     """Base class for all exceptions raised by this module.
     """
 
     def __init__(self, value):
 
         self.value = value
 
     def __str__(self):
 
         return str(self.value)
 
     def get_trace(self):
 
         """This returns an abbreviated stack trace with lines that only concern
         the caller. In other words, the stack trace inside the Pexpect module
         is not included. """
 
         tblist = traceback.extract_tb(sys.exc_info()[2])
         #tblist = filter(self.__filter_not_pexpect, tblist)
         tblist = [item for item in tblist if self.__filter_not_pexpect(item)]
         tblist = traceback.format_list(tblist)
         return ''.join(tblist)
 
     def __filter_not_pexpect(self, trace_list_item):
 
         """This returns True if list item 0 the string 'pexpect.py' in it. """
 
         if trace_list_item[0].find('pexpect.py') == -1:
             return True
         else:
             return False
 
 class EOF(ExceptionPexpect):
 
     """Raised when EOF is read from a child. This usually means the child has exited."""
 
 class TIMEOUT(ExceptionPexpect):
 
     """Raised when a read time exceeds the timeout. """
 
 ##class TIMEOUT_PATTERN(TIMEOUT):
 ##    """Raised when the pattern match time exceeds the timeout.
 ##    This is different than a read TIMEOUT because the child process may
 ##    give output, thus never give a TIMEOUT, but the output
 ##    may never match a pattern.
 ##    """
 ##class MAXBUFFER(ExceptionPexpect):
 ##    """Raised when a scan buffer fills before matching an expected pattern."""
 
 PY3 = (sys.version_info[0] >= 3)
 
 def _cast_bytes(s, enc):
     if isinstance(s, unicode):
         return s.encode(enc)
     return s
 
 def _cast_unicode(s, enc):
     if isinstance(s, bytes):
         return s.decode(enc)
     return s
 
 re_type = type(re.compile(''))
 
 def run (command, timeout=-1, withexitstatus=False, events=None, extra_args=None,
          logfile=None, cwd=None, env=None, encoding='utf-8'):
 
     """
     This function runs the given command; waits for it to finish; then
     returns all output as a string. STDERR is included in output. If the full
     path to the command is not given then the path is searched.
 
     Note that lines are terminated by CR/LF (\\r\\n) combination even on
     UNIX-like systems because this is the standard for pseudo ttys. If you set
     'withexitstatus' to true, then run will return a tuple of (command_output,
     exitstatus). If 'withexitstatus' is false then this returns just
     command_output.
 
     The run() function can often be used instead of creating a spawn instance.
     For example, the following code uses spawn::
 
         from pexpect import *
         child = spawn('scp foo [e-mail]:.')
         child.expect ('(?i)password')
         child.sendline (mypassword)
 
     The previous code can be replace with the following::
 
         from pexpect import *
         run ('scp foo [e-mail]:.', events={'(?i)password': mypassword})
 
     Examples
     ========
 
     Start the apache daemon on the local machine::
 
         from pexpect import *
         run ("/usr/local/apache/bin/apachectl start")
 
     Check in a file using SVN::
 
         from pexpect import *
         run ("svn ci -m 'automatic commit' my_file.py")
 
     Run a command and capture exit status::
 
         from pexpect import *
         (command_output, exitstatus) = run ('ls -l /bin', withexitstatus=1)
 
     Tricky Examples
     ===============
 
     The following will run SSH and execute 'ls -l' on the remote machine. The
     password 'secret' will be sent if the '(?i)password' pattern is ever seen::
 
         run ("ssh [e-mail] 'ls -l'", events={'(?i)password':'secret\\n'})
 
     This will start mencoder to rip a video from DVD. This will also display
     progress ticks every 5 seconds as it runs. For example::
 
         from pexpect import *
         def print_ticks(d):
             print d['event_count'],
         run ("mencoder dvd://1 -o video.avi -oac copy -ovc copy", events={TIMEOUT:print_ticks}, timeout=5)
 
     The 'events' argument should be a dictionary of patterns and responses.
     Whenever one of the patterns is seen in the command out run() will send the
     associated response string. Note that you should put newlines in your
     string if Enter is necessary. The responses may also contain callback
     functions. Any callback is function that takes a dictionary as an argument.
     The dictionary contains all the locals from the run() function, so you can
     access the child spawn object or any other variable defined in run()
     (event_count, child, and extra_args are the most useful). A callback may
     return True to stop the current run process otherwise run() continues until
     the next event. A callback may also return a string which will be sent to
     the child. 'extra_args' is not used by directly run(). It provides a way to
     pass data to a callback function through run() through the locals
     dictionary passed to a callback."""
 
     if timeout == -1:
         child = spawn(command, maxread=2000, logfile=logfile, cwd=cwd, env=env,
                       encoding=encoding)
     else:
         child = spawn(command, timeout=timeout, maxread=2000, logfile=logfile,
                       cwd=cwd, env=env, encoding=encoding)
     if events is not None:
         patterns = events.keys()
         responses = events.values()
     else:
         patterns=None # We assume that EOF or TIMEOUT will save us.
         responses=None
     child_result_list = []
     event_count = 0
     while 1:
         try:
             index = child.expect (patterns)
             if isinstance(child.after, basestring):
                 child_result_list.append(child.before + child.after)
             else: # child.after may have been a TIMEOUT or EOF, so don't cat those.
                 child_result_list.append(child.before)
             if isinstance(responses[index], basestring):
                 child.send(responses[index])
             elif type(responses[index]) is types.FunctionType:
                 callback_result = responses[index](locals())
                 sys.stdout.flush()
                 if isinstance(callback_result, basestring):
                     child.send(callback_result)
                 elif callback_result:
                     break
             else:
                 raise TypeError ('The callback must be a string or function type.')
             event_count = event_count + 1
         except TIMEOUT, e:
             child_result_list.append(child.before)
             break
         except EOF, e:
             child_result_list.append(child.before)
             break
     child_result = child._empty_buffer.join(child_result_list)
     if withexitstatus:
         child.close()
         return (child_result, child.exitstatus)
     else:
         return child_result
 
 class spawnb(object):
     """Use this class to start and control child applications with a pure-bytes
     interface."""
     
     _buffer_type = bytes
     def _cast_buffer_type(self, s):
         return _cast_bytes(s, self.encoding)
     _empty_buffer = b''
     _pty_newline = b'\r\n'
     
     # Some code needs this to exist, but it's mainly for the spawn subclass.
     encoding = 'utf-8'
 
     def __init__(self, command, args=[], timeout=30, maxread=2000, searchwindowsize=None,
                  logfile=None, cwd=None, env=None):
 
         """This is the constructor. The command parameter may be a string that
         includes a command and any arguments to the command. For example::
 
             child = pexpect.spawn ('/usr/bin/ftp')
             child = pexpect.spawn ('/usr/bin/ssh [e-mail]')
             child = pexpect.spawn ('ls -latr /tmp')
 
         You may also construct it with a list of arguments like so::
 
             child = pexpect.spawn ('/usr/bin/ftp', [])
             child = pexpect.spawn ('/usr/bin/ssh', ['[e-mail]'])
             child = pexpect.spawn ('ls', ['-latr', '/tmp'])
 
         After this the child application will be created and will be ready to
         talk to. For normal use, see expect() and send() and sendline().
 
         Remember that Pexpect does NOT interpret shell meta characters such as
         redirect, pipe, or wild cards (>, |, or *). This is a common mistake.
         If you want to run a command and pipe it through another command then
         you must also start a shell. For example::
 
             child = pexpect.spawn('/bin/bash -c "ls -l | grep LOG > log_list.txt"')
             child.expect(pexpect.EOF)
 
         The second form of spawn (where you pass a list of arguments) is useful
         in situations where you wish to spawn a command and pass it its own
         argument list. This can make syntax more clear. For example, the
         following is equivalent to the previous example::
 
             shell_cmd = 'ls -l | grep LOG > log_list.txt'
             child = pexpect.spawn('/bin/bash', ['-c', shell_cmd])
             child.expect(pexpect.EOF)
 
         The maxread attribute sets the read buffer size. This is maximum number
         of bytes that Pexpect will try to read from a TTY at one time. Setting
         the maxread size to 1 will turn off buffering. Setting the maxread
         value higher may help performance in cases where large amounts of
         output are read back from the child. This feature is useful in
         conjunction with searchwindowsize.
 
         The searchwindowsize attribute sets the how far back in the incomming
         seach buffer Pexpect will search for pattern matches. Every time
         Pexpect reads some data from the child it will append the data to the
         incomming buffer. The default is to search from the beginning of the
         imcomming buffer each time new data is read from the child. But this is
         very inefficient if you are running a command that generates a large
         amount of data where you want to match The searchwindowsize does not
         effect the size of the incomming data buffer. You will still have
         access to the full buffer after expect() returns.
 
         The logfile member turns on or off logging. All input and output will
         be copied to the given file object. Set logfile to None to stop
         logging. This is the default. Set logfile to sys.stdout to echo
         everything to standard output. The logfile is flushed after each write.
 
         Example log input and output to a file::
 
             child = pexpect.spawn('some_command')
-            fout = file('mylog.txt','w')
+            fout = open('mylog.txt','w')
             child.logfile = fout
 
         Example log to stdout::
 
             child = pexpect.spawn('some_command')
             child.logfile = sys.stdout
 
         The logfile_read and logfile_send members can be used to separately log
         the input from the child and output sent to the child. Sometimes you
         don't want to see everything you write to the child. You only want to
         log what the child sends back. For example::
 
             child = pexpect.spawn('some_command')
             child.logfile_read = sys.stdout
 
         To separately log output sent to the child use logfile_send::
 
             self.logfile_send = fout
 
         The delaybeforesend helps overcome a weird behavior that many users
         were experiencing. The typical problem was that a user would expect() a
         "Password:" prompt and then immediately call sendline() to send the
         password. The user would then see that their password was echoed back
         to them. Passwords don't normally echo. The problem is caused by the
         fact that most applications print out the "Password" prompt and then
         turn off stdin echo, but if you send your password before the
         application turned off echo, then you get your password echoed.
         Normally this wouldn't be a problem when interacting with a human at a
         real keyboard. If you introduce a slight delay just before writing then
         this seems to clear up the problem. This was such a common problem for
         many users that I decided that the default pexpect behavior should be
         to sleep just before writing to the child application. 1/20th of a
         second (50 ms) seems to be enough to clear up the problem. You can set
         delaybeforesend to 0 to return to the old behavior. Most Linux machines
         don't like this to be below 0.03. I don't know why.
 
         Note that spawn is clever about finding commands on your path.
         It uses the same logic that "which" uses to find executables.
 
         If you wish to get the exit status of the child you must call the
         close() method. The exit or signal status of the child will be stored
         in self.exitstatus or self.signalstatus. If the child exited normally
         then exitstatus will store the exit return code and signalstatus will
         be None. If the child was terminated abnormally with a signal then
         signalstatus will store the signal value and exitstatus will be None.
         If you need more detail you can also read the self.status member which
         stores the status returned by os.waitpid. You can interpret this using
         os.WIFEXITED/os.WEXITSTATUS or os.WIFSIGNALED/os.TERMSIG. """
 
         self.STDIN_FILENO = pty.STDIN_FILENO
         self.STDOUT_FILENO = pty.STDOUT_FILENO
         self.STDERR_FILENO = pty.STDERR_FILENO
         self.stdin = sys.stdin
         self.stdout = sys.stdout
         self.stderr = sys.stderr
 
         self.searcher = None
         self.ignorecase = False
         self.before = None
         self.after = None
         self.match = None
         self.match_index = None
         self.terminated = True
         self.exitstatus = None
         self.signalstatus = None
         self.status = None # status returned by os.waitpid
         self.flag_eof = False
         self.pid = None
         self.child_fd = -1 # initially closed
         self.timeout = timeout
         self.delimiter = EOF
         self.logfile = logfile
         self.logfile_read = None # input from child (read_nonblocking)
         self.logfile_send = None # output to send (send, sendline)
         self.maxread = maxread # max bytes to read at one time into buffer
         self.buffer = self._empty_buffer # This is the read buffer. See maxread.
         self.searchwindowsize = searchwindowsize # Anything before searchwindowsize point is preserved, but not searched.
         # Most Linux machines don't like delaybeforesend to be below 0.03 (30 ms).
         self.delaybeforesend = 0.05 # Sets sleep time used just before sending data to child. Time in seconds.
         self.delayafterclose = 0.1 # Sets delay in close() method to allow kernel time to update process status. Time in seconds.
         self.delayafterterminate = 0.1 # Sets delay in terminate() method to allow kernel time to update process status. Time in seconds.
         self.softspace = False # File-like object.
         self.name = '<' + repr(self) + '>' # File-like object.
         self.closed = True # File-like object.
         self.cwd = cwd
         self.env = env
         self.__irix_hack = (sys.platform.lower().find('irix')>=0) # This flags if we are running on irix
         # Solaris uses internal __fork_pty(). All others use pty.fork().
         if 'solaris' in sys.platform.lower() or 'sunos5' in sys.platform.lower():
             self.use_native_pty_fork = False
         else:
             self.use_native_pty_fork = True
 
 
         # allow dummy instances for subclasses that may not use command or args.
         if command is None:
             self.command = None
             self.args = None
             self.name = '<pexpect factory incomplete>'
         else:
             self._spawn (command, args)
 
     def __del__(self):
 
         """This makes sure that no system resources are left open. Python only
         garbage collects Python objects. OS file descriptors are not Python
         objects, so they must be handled explicitly. If the child file
         descriptor was opened outside of this class (passed to the constructor)
         then this does not close it. """
 
         if not self.closed:
             # It is possible for __del__ methods to execute during the
             # teardown of the Python VM itself. Thus self.close() may
             # trigger an exception because os.close may be None.
             # -- Fernando Perez
             try:
                 self.close()
             except:
                 pass
 
     def __str__(self):
 
         """This returns a human-readable string that represents the state of
         the object. """
 
         s = []
         s.append(repr(self))
         s.append('version: ' + __version__)
         s.append('command: ' + str(self.command))
         s.append('args: ' + str(self.args))
         s.append('searcher: ' + str(self.searcher))
         s.append('buffer (last 100 chars): ' + str(self.buffer)[-100:])
         s.append('before (last 100 chars): ' + str(self.before)[-100:])
         s.append('after: ' + str(self.after))
         s.append('match: ' + str(self.match))
         s.append('match_index: ' + str(self.match_index))
         s.append('exitstatus: ' + str(self.exitstatus))
         s.append('flag_eof: ' + str(self.flag_eof))
         s.append('pid: ' + str(self.pid))
         s.append('child_fd: ' + str(self.child_fd))
         s.append('closed: ' + str(self.closed))
         s.append('timeout: ' + str(self.timeout))
         s.append('delimiter: ' + str(self.delimiter))
         s.append('logfile: ' + str(self.logfile))
         s.append('logfile_read: ' + str(self.logfile_read))
         s.append('logfile_send: ' + str(self.logfile_send))
         s.append('maxread: ' + str(self.maxread))
         s.append('ignorecase: ' + str(self.ignorecase))
         s.append('searchwindowsize: ' + str(self.searchwindowsize))
         s.append('delaybeforesend: ' + str(self.delaybeforesend))
         s.append('delayafterclose: ' + str(self.delayafterclose))
         s.append('delayafterterminate: ' + str(self.delayafterterminate))
         return '\n'.join(s)
 
     def _spawn(self,command,args=[]):
 
         """This starts the given command in a child process. This does all the
         fork/exec type of stuff for a pty. This is called by __init__. If args
         is empty then command will be parsed (split on spaces) and args will be
         set to parsed arguments. """
 
         # The pid and child_fd of this object get set by this method.
         # Note that it is difficult for this method to fail.
         # You cannot detect if the child process cannot start.
         # So the only way you can tell if the child process started
         # or not is to try to read from the file descriptor. If you get
         # EOF immediately then it means that the child is already dead.
         # That may not necessarily be bad because you may haved spawned a child
         # that performs some task; creates no stdout output; and then dies.
 
         # If command is an int type then it may represent a file descriptor.
         if type(command) == type(0):
             raise ExceptionPexpect ('Command is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.')
 
         if type (args) != type([]):
             raise TypeError ('The argument, args, must be a list.')
 
         if args == []:
             self.args = split_command_line(command)
             self.command = self.args[0]
         else:
             self.args = args[:] # work with a copy
             self.args.insert (0, command)
             self.command = command
 
         command_with_path = which(self.command)
         if command_with_path is None:
             raise ExceptionPexpect ('The command was not found or was not executable: %s.' % self.command)
         self.command = command_with_path
         self.args[0] = self.command
 
         self.name = '<' + ' '.join (self.args) + '>'
 
         assert self.pid is None, 'The pid member should be None.'
         assert self.command is not None, 'The command member should not be None.'
 
         if self.use_native_pty_fork:
             try:
                 self.pid, self.child_fd = pty.fork()
             except OSError, e:
                 raise ExceptionPexpect('Error! pty.fork() failed: ' + str(e))
         else: # Use internal __fork_pty
             self.pid, self.child_fd = self.__fork_pty()
 
         if self.pid == 0: # Child
             try:
                 self.child_fd = sys.stdout.fileno() # used by setwinsize()
                 self.setwinsize(24, 80)
             except:
                 # Some platforms do not like setwinsize (Cygwin).
                 # This will cause problem when running applications that
                 # are very picky about window size.
                 # This is a serious limitation, but not a show stopper.
                 pass
             # Do not allow child to inherit open file descriptors from parent.
             max_fd = resource.getrlimit(resource.RLIMIT_NOFILE)[0]
             for i in range (3, max_fd):
                 try:
                     os.close (i)
                 except OSError:
                     pass
 
             # I don't know why this works, but ignoring SIGHUP fixes a
             # problem when trying to start a Java daemon with sudo
             # (specifically, Tomcat).
             signal.signal(signal.SIGHUP, signal.SIG_IGN)
 
             if self.cwd is not None:
                 os.chdir(self.cwd)
             if self.env is None:
                 os.execv(self.command, self.args)
             else:
                 os.execvpe(self.command, self.args, self.env)
 
         # Parent
         self.terminated = False
         self.closed = False
 
     def __fork_pty(self):
 
         """This implements a substitute for the forkpty system call. This
         should be more portable than the pty.fork() function. Specifically,
         this should work on Solaris.
 
         Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to
         resolve the issue with Python's pty.fork() not supporting Solaris,
         particularly ssh. Based on patch to posixmodule.c authored by Noah
         Spurrier::
 
             http://mail.python.org/pipermail/python-dev/2003-May/035281.html
 
         """
 
         parent_fd, child_fd = os.openpty()
         if parent_fd < 0 or child_fd < 0:
             raise ExceptionPexpect, "Error! Could not open pty with os.openpty()."
 
         pid = os.fork()
         if pid < 0:
             raise ExceptionPexpect, "Error! Failed os.fork()."
         elif pid == 0:
             # Child.
             os.close(parent_fd)
             self.__pty_make_controlling_tty(child_fd)
 
             os.dup2(child_fd, 0)
             os.dup2(child_fd, 1)
             os.dup2(child_fd, 2)
 
             if child_fd > 2:
                 os.close(child_fd)
         else:
             # Parent.
             os.close(child_fd)
 
         return pid, parent_fd
 
     def __pty_make_controlling_tty(self, tty_fd):
 
         """This makes the pseudo-terminal the controlling tty. This should be
         more portable than the pty.fork() function. Specifically, this should
         work on Solaris. """
 
         child_name = os.ttyname(tty_fd)
 
         # Disconnect from controlling tty. Harmless if not already connected.
         try:
             fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY);
             if fd >= 0:
                 os.close(fd)
         except:
             # Already disconnected. This happens if running inside cron.
             pass
 
         os.setsid()
 
         # Verify we are disconnected from controlling tty
         # by attempting to open it again.
         try:
             fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY);
             if fd >= 0:
                 os.close(fd)
                 raise ExceptionPexpect, "Error! Failed to disconnect from controlling tty. It is still possible to open /dev/tty."
         except:
             # Good! We are disconnected from a controlling tty.
             pass
 
         # Verify we can open child pty.
         fd = os.open(child_name, os.O_RDWR);
         if fd < 0:
             raise ExceptionPexpect, "Error! Could not open child pty, " + child_name
         else:
             os.close(fd)
 
         # Verify we now have a controlling tty.
         fd = os.open("/dev/tty", os.O_WRONLY)
         if fd < 0:
             raise ExceptionPexpect, "Error! Could not open controlling tty, /dev/tty"
         else:
             os.close(fd)
 
     def fileno (self):   # File-like object.
 
         """This returns the file descriptor of the pty for the child.
         """
 
         return self.child_fd
 
     def close (self, force=True):   # File-like object.
 
         """This closes the connection with the child application. Note that
         calling close() more than once is valid. This emulates standard Python
         behavior with files. Set force to True if you want to make sure that
         the child is terminated (SIGKILL is sent if the child ignores SIGHUP
         and SIGINT). """
 
         if not self.closed:
             self.flush()
             os.close (self.child_fd)
             time.sleep(self.delayafterclose) # Give kernel time to update process status.
             if self.isalive():
                 if not self.terminate(force):
                     raise ExceptionPexpect ('close() could not terminate the child using terminate()')
             self.child_fd = -1
             self.closed = True
             #self.pid = None
 
     def flush (self):   # File-like object.
 
         """This does nothing. It is here to support the interface for a
         File-like object. """
 
         pass
 
     def isatty (self):   # File-like object.
 
         """This returns True if the file descriptor is open and connected to a
         tty(-like) device, else False. """
 
         return os.isatty(self.child_fd)
 
     def waitnoecho (self, timeout=-1):
 
         """This waits until the terminal ECHO flag is set False. This returns
         True if the echo mode is off. This returns False if the ECHO flag was
         not set False before the timeout. This can be used to detect when the
         child is waiting for a password. Usually a child application will turn
         off echo mode when it is waiting for the user to enter a password. For
         example, instead of expecting the "password:" prompt you can wait for
         the child to set ECHO off::
 
             p = pexpect.spawn ('ssh [e-mail]')
             p.waitnoecho()
             p.sendline(mypassword)
 
         If timeout==-1 then this method will use the value in self.timeout.
         If timeout==None then this method to block until ECHO flag is False.
         """
 
         if timeout == -1:
             timeout = self.timeout
         if timeout is not None:
             end_time = time.time() + timeout
         while True:
             if not self.getecho():
                 return True
             if timeout < 0 and timeout is not None:
                 return False
             if timeout is not None:
                 timeout = end_time - time.time()
             time.sleep(0.1)
 
     def getecho (self):
 
         """This returns the terminal echo mode. This returns True if echo is
         on or False if echo is off. Child applications that are expecting you
         to enter a password often set ECHO False. See waitnoecho(). """
 
         attr = termios.tcgetattr(self.child_fd)
         if attr[3] & termios.ECHO:
             return True
         return False
 
     def setecho (self, state):
 
         """This sets the terminal echo mode on or off. Note that anything the
         child sent before the echo will be lost, so you should be sure that
         your input buffer is empty before you call setecho(). For example, the
         following will work as expected::
 
             p = pexpect.spawn('cat')
             p.sendline ('1234') # We will see this twice (once from tty echo and again from cat).
             p.expect (['1234'])
             p.expect (['1234'])
             p.setecho(False) # Turn off tty echo
             p.sendline ('abcd') # We will set this only once (echoed by cat).
             p.sendline ('wxyz') # We will set this only once (echoed by cat)
             p.expect (['abcd'])
             p.expect (['wxyz'])
 
         The following WILL NOT WORK because the lines sent before the setecho
         will be lost::
 
             p = pexpect.spawn('cat')
             p.sendline ('1234') # We will see this twice (once from tty echo and again from cat).
             p.setecho(False) # Turn off tty echo
             p.sendline ('abcd') # We will set this only once (echoed by cat).
             p.sendline ('wxyz') # We will set this only once (echoed by cat)
             p.expect (['1234'])
             p.expect (['1234'])
             p.expect (['abcd'])
             p.expect (['wxyz'])
         """
 
         self.child_fd
         attr = termios.tcgetattr(self.child_fd)
         if state:
             attr[3] = attr[3] | termios.ECHO
         else:
             attr[3] = attr[3] & ~termios.ECHO
         # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent
         # and blocked on some platforms. TCSADRAIN is probably ideal if it worked.
         termios.tcsetattr(self.child_fd, termios.TCSANOW, attr)
 
     def read_nonblocking (self, size = 1, timeout = -1):
 
         """This reads at most size bytes from the child application. It
         includes a timeout. If the read does not complete within the timeout
         period then a TIMEOUT exception is raised. If the end of file is read
         then an EOF exception will be raised. If a log file was set using
         setlog() then all data will also be written to the log file.
 
         If timeout is None then the read may block indefinitely. If timeout is -1
         then the self.timeout value is used. If timeout is 0 then the child is
         polled and if there was no data immediately ready then this will raise
         a TIMEOUT exception.
 
         The timeout refers only to the amount of time to read at least one
         character. This is not effected by the 'size' parameter, so if you call
         read_nonblocking(size=100, timeout=30) and only one character is
         available right away then one character will be returned immediately.
         It will not wait for 30 seconds for another 99 characters to come in.
 
         This is a wrapper around os.read(). It uses select.select() to
         implement the timeout. """
 
         if self.closed:
             raise ValueError ('I/O operation on closed file in read_nonblocking().')
 
         if timeout == -1:
             timeout = self.timeout
 
         # Note that some systems such as Solaris do not give an EOF when
         # the child dies. In fact, you can still try to read
         # from the child_fd -- it will block forever or until TIMEOUT.
         # For this case, I test isalive() before doing any reading.
         # If isalive() is false, then I pretend that this is the same as EOF.
         if not self.isalive():
             r,w,e = self.__select([self.child_fd], [], [], 0) # timeout of 0 means "poll"
             if not r:
                 self.flag_eof = True
                 raise EOF ('End Of File (EOF) in read_nonblocking(). Braindead platform.')
         elif self.__irix_hack:
             # This is a hack for Irix. It seems that Irix requires a long delay before checking isalive.
             # This adds a 2 second delay, but only when the child is terminated.
             r, w, e = self.__select([self.child_fd], [], [], 2)
             if not r and not self.isalive():
                 self.flag_eof = True
                 raise EOF ('End Of File (EOF) in read_nonblocking(). Pokey platform.')
 
         r,w,e = self.__select([self.child_fd], [], [], timeout)
 
         if not r:
             if not self.isalive():
                 # Some platforms, such as Irix, will claim that their processes are alive;
                 # then timeout on the select; and then finally admit that they are not alive.
                 self.flag_eof = True
                 raise EOF ('End of File (EOF) in read_nonblocking(). Very pokey platform.')
             else:
                 raise TIMEOUT ('Timeout exceeded in read_nonblocking().')
 
         if self.child_fd in r:
             try:
                 s = os.read(self.child_fd, size)
             except OSError, e: # Linux does this
                 self.flag_eof = True
                 raise EOF ('End Of File (EOF) in read_nonblocking(). Exception style platform.')
             if s == b'': # BSD style
                 self.flag_eof = True
                 raise EOF ('End Of File (EOF) in read_nonblocking(). Empty string style platform.')
 
             s2 = self._cast_buffer_type(s)
             if self.logfile is not None:
                 self.logfile.write(s2)
                 self.logfile.flush()
             if self.logfile_read is not None:
                 self.logfile_read.write(s2)
                 self.logfile_read.flush()
 
             return s
 
         raise ExceptionPexpect ('Reached an unexpected state in read_nonblocking().')
 
     def read (self, size = -1):         # File-like object.
         """This reads at most "size" bytes from the file (less if the read hits
         EOF before obtaining size bytes). If the size argument is negative or
         omitted, read all data until EOF is reached. The bytes are returned as
         a string object. An empty string is returned when EOF is encountered
         immediately. """
 
         if size == 0:
             return self._empty_buffer
         if size < 0:
             self.expect (self.delimiter) # delimiter default is EOF
             return self.before
 
         # I could have done this more directly by not using expect(), but
         # I deliberately decided to couple read() to expect() so that
         # I would catch any bugs early and ensure consistant behavior.
         # It's a little less efficient, but there is less for me to
         # worry about if I have to later modify read() or expect().
         # Note, it's OK if size==-1 in the regex. That just means it
         # will never match anything in which case we stop only on EOF.
         if self._buffer_type is bytes:
             pat = (u'.{%d}' % size).encode('ascii')
         else:
             pat = u'.{%d}' % size
         cre = re.compile(pat, re.DOTALL)
         index = self.expect ([cre, self.delimiter]) # delimiter default is EOF
         if index == 0:
             return self.after ### self.before should be ''. Should I assert this?
         return self.before
 
     def readline(self, size = -1):
         """This reads and returns one entire line. A trailing newline is kept
         in the string, but may be absent when a file ends with an incomplete
         line. Note: This readline() looks for a \\r\\n pair even on UNIX
         because this is what the pseudo tty device returns. So contrary to what
         you may expect you will receive the newline as \\r\\n. An empty string
         is returned when EOF is hit immediately. Currently, the size argument is
         mostly ignored, so this behavior is not standard for a file-like
         object. If size is 0 then an empty string is returned. """
 
         if size == 0:
             return self._empty_buffer
         index = self.expect ([self._pty_newline, self.delimiter]) # delimiter default is EOF
         if index == 0:
             return self.before + self._pty_newline
         return self.before
 
     def __iter__ (self):    # File-like object.
 
         """This is to support iterators over a file-like object.
         """
 
         return self
 
     def next (self):    # File-like object.
 
         """This is to support iterators over a file-like object.
         """
 
         result = self.readline()
         if result == self._empty_buffer:
             raise StopIteration
         return result
 
     def readlines (self, sizehint = -1):    # File-like object.
 
         """This reads until EOF using readline() and returns a list containing
         the lines thus read. The optional "sizehint" argument is ignored. """
 
         lines = []
         while True:
             line = self.readline()
             if not line:
                 break
             lines.append(line)
         return lines
 
     def write(self, s):   # File-like object.
 
         """This is similar to send() except that there is no return value.
         """
 
         self.send (s)
 
     def writelines (self, sequence):   # File-like object.
 
         """This calls write() for each element in the sequence. The sequence
         can be any iterable object producing strings, typically a list of
         strings. This does not add line separators There is no return value.
         """
 
         for s in sequence:
             self.write (s)
 
     def send(self, s):
 
         """This sends a string to the child process. This returns the number of
         bytes written. If a log file was set then the data is also written to
         the log. """
 
         time.sleep(self.delaybeforesend)
         
         s2 = self._cast_buffer_type(s)
         if self.logfile is not None:
             self.logfile.write(s2)
             self.logfile.flush()
         if self.logfile_send is not None:
             self.logfile_send.write(s2)
             self.logfile_send.flush()
         c = os.write (self.child_fd, _cast_bytes(s, self.encoding))
         return c
 
     def sendline(self, s=''):
 
         """This is like send(), but it adds a line feed (os.linesep). This
         returns the number of bytes written. """
 
         n = self.send (s)
         n = n + self.send (os.linesep)
         return n
 
     def sendcontrol(self, char):
 
         """This sends a control character to the child such as Ctrl-C or
         Ctrl-D. For example, to send a Ctrl-G (ASCII 7)::
 
             child.sendcontrol('g')
 
         See also, sendintr() and sendeof().
         """
 
         char = char.lower()
         a = ord(char)
         if a>=97 and a<=122:
             a = a - ord('a') + 1
             return self.send (chr(a))
         d = {'@':0, '`':0,
             '[':27, '{':27,
             '\\':28, '|':28,
             ']':29, '}': 29,
             '^':30, '~':30,
             '_':31,
             '?':127}
         if char not in d:
             return 0
         return self.send (chr(d[char]))
 
     def sendeof(self):
 
         """This sends an EOF to the child. This sends a character which causes
         the pending parent output buffer to be sent to the waiting child
         program without waiting for end-of-line. If it is the first character
         of the line, the read() in the user program returns 0, which signifies
         end-of-file. This means to work as expected a sendeof() has to be
         called at the beginning of a line. This method does not send a newline.
         It is the responsibility of the caller to ensure the eof is sent at the
         beginning of a line. """
 
         ### Hmmm... how do I send an EOF?
         ###C  if ((m = write(pty, *buf, p - *buf)) < 0)
         ###C      return (errno == EWOULDBLOCK) ? n : -1;
         #fd = sys.stdin.fileno()
         #old = termios.tcgetattr(fd) # remember current state
         #attr = termios.tcgetattr(fd)
         #attr[3] = attr[3] | termios.ICANON # ICANON must be set to recognize EOF
         #try: # use try/finally to ensure state gets restored
         #    termios.tcsetattr(fd, termios.TCSADRAIN, attr)
         #    if hasattr(termios, 'CEOF'):
         #        os.write (self.child_fd, '%c' % termios.CEOF)
         #    else:
         #        # Silly platform does not define CEOF so assume CTRL-D
         #        os.write (self.child_fd, '%c' % 4)
         #finally: # restore state
         #    termios.tcsetattr(fd, termios.TCSADRAIN, old)
         if hasattr(termios, 'VEOF'):
             char = termios.tcgetattr(self.child_fd)[6][termios.VEOF]
         else:
             # platform does not define VEOF so assume CTRL-D
             char = chr(4)
         self.send(char)
 
     def sendintr(self):
 
         """This sends a SIGINT to the child. It does not require
         the SIGINT to be the first character on a line. """
 
         if hasattr(termios, 'VINTR'):
             char = termios.tcgetattr(self.child_fd)[6][termios.VINTR]
         else:
             # platform does not define VINTR so assume CTRL-C
             char = chr(3)
         self.send (char)
 
     def eof (self):
 
         """This returns True if the EOF exception was ever raised.
         """
 
         return self.flag_eof
 
     def terminate(self, force=False):
 
         """This forces a child process to terminate. It starts nicely with
         SIGHUP and SIGINT. If "force" is True then moves onto SIGKILL. This
         returns True if the child was terminated. This returns False if the
         child could not be terminated. """
 
         if not self.isalive():
             return True
         try:
             self.kill(signal.SIGHUP)
             time.sleep(self.delayafterterminate)
             if not self.isalive():
                 return True
             self.kill(signal.SIGCONT)
             time.sleep(self.delayafterterminate)
             if not self.isalive():
                 return True
             self.kill(signal.SIGINT)
             time.sleep(self.delayafterterminate)
             if not self.isalive():
                 return True
             if force:
                 self.kill(signal.SIGKILL)
                 time.sleep(self.delayafterterminate)
                 if not self.isalive():
                     return True
                 else:
                     return False
             return False
         except OSError, e:
             # I think there are kernel timing issues that sometimes cause
             # this to happen. I think isalive() reports True, but the
             # process is dead to the kernel.
             # Make one last attempt to see if the kernel is up to date.
             time.sleep(self.delayafterterminate)
             if not self.isalive():
                 return True
             else:
                 return False
 
     def wait(self):
 
         """This waits until the child exits. This is a blocking call. This will
         not read any data from the child, so this will block forever if the
         child has unread output and has terminated. In other words, the child
         may have printed output then called exit(); but, technically, the child
         is still alive until its output is read. """
 
         if self.isalive():
             pid, status = os.waitpid(self.pid, 0)
         else:
             raise ExceptionPexpect ('Cannot wait for dead child process.')
         self.exitstatus = os.WEXITSTATUS(status)
         if os.WIFEXITED (status):
             self.status = status
             self.exitstatus = os.WEXITSTATUS(status)
             self.signalstatus = None
             self.terminated = True
         elif os.WIFSIGNALED (status):
             self.status = status
             self.exitstatus = None
             self.signalstatus = os.WTERMSIG(status)
             self.terminated = True
         elif os.WIFSTOPPED (status):
             raise ExceptionPexpect ('Wait was called for a child process that is stopped. This is not supported. Is some other process attempting job control with our child pid?')
         return self.exitstatus
 
     def isalive(self):
 
         """This tests if the child process is running or not. This is
         non-blocking. If the child was terminated then this will read the
         exitstatus or signalstatus of the child. This returns True if the child
         process appears to be running or False if not. It can take literally
         SECONDS for Solaris to return the right status. """
 
         if self.terminated:
             return False
 
         if self.flag_eof:
             # This is for Linux, which requires the blocking form of waitpid to get
             # status of a defunct process. This is super-lame. The flag_eof would have
             # been set in read_nonblocking(), so this should be safe.
             waitpid_options = 0
         else:
             waitpid_options = os.WNOHANG
 
         try:
             pid, status = os.waitpid(self.pid, waitpid_options)
         except OSError as e: # No child processes
             if e.errno == errno.ECHILD:
                 raise ExceptionPexpect ('isalive() encountered condition where "terminated" is 0, but there was no child process. Did someone else call waitpid() on our process?')
             else:
                 raise e
 
         # I have to do this twice for Solaris. I can't even believe that I figured this out...
         # If waitpid() returns 0 it means that no child process wishes to
         # report, and the value of status is undefined.
         if pid == 0:
             try:
                 pid, status = os.waitpid(self.pid, waitpid_options) ### os.WNOHANG) # Solaris!
             except OSError, e: # This should never happen...
                 if e[0] == errno.ECHILD:
                     raise ExceptionPexpect ('isalive() encountered condition that should never happen. There was no child process. Did someone else call waitpid() on our process?')
                 else:
                     raise e
 
             # If pid is still 0 after two calls to waitpid() then
             # the process really is alive. This seems to work on all platforms, except
             # for Irix which seems to require a blocking call on waitpid or select, so I let read_nonblocking
             # take care of this situation (unfortunately, this requires waiting through the timeout).
             if pid == 0:
                 return True
 
         if pid == 0:
             return True
 
         if os.WIFEXITED (status):
             self.status = status
             self.exitstatus = os.WEXITSTATUS(status)
             self.signalstatus = None
             self.terminated = True
         elif os.WIFSIGNALED (status):
             self.status = status
             self.exitstatus = None
             self.signalstatus = os.WTERMSIG(status)
             self.terminated = True
         elif os.WIFSTOPPED (status):
             raise ExceptionPexpect ('isalive() encountered condition where child process is stopped. This is not supported. Is some other process attempting job control with our child pid?')
         return False
 
     def kill(self, sig):
 
         """This sends the given signal to the child application. In keeping
         with UNIX tradition it has a misleading name. It does not necessarily
         kill the child unless you send the right signal. """
 
         # Same as os.kill, but the pid is given for you.
         if self.isalive():
             os.kill(self.pid, sig)
 
     def compile_pattern_list(self, patterns):
 
         """This compiles a pattern-string or a list of pattern-strings.
         Patterns must be a StringType, EOF, TIMEOUT, SRE_Pattern, or a list of
         those. Patterns may also be None which results in an empty list (you
         might do this if waiting for an EOF or TIMEOUT condition without
         expecting any pattern).
 
         This is used by expect() when calling expect_list(). Thus expect() is
         nothing more than::
 
              cpl = self.compile_pattern_list(pl)
              return self.expect_list(cpl, timeout)
 
         If you are using expect() within a loop it may be more
         efficient to compile the patterns first and then call expect_list().
         This avoid calls in a loop to compile_pattern_list()::
 
              cpl = self.compile_pattern_list(my_pattern)
              while some_condition:
                 ...
                 i = self.expect_list(clp, timeout)
                 ...
         """
 
         if patterns is None:
             return []
         if not isinstance(patterns, list):
             patterns = [patterns]
 
         compile_flags = re.DOTALL # Allow dot to match \n
         if self.ignorecase:
             compile_flags = compile_flags | re.IGNORECASE
         compiled_pattern_list = []
         for p in patterns:
             if isinstance(p, (bytes, unicode)):
                 p = self._cast_buffer_type(p)
                 compiled_pattern_list.append(re.compile(p, compile_flags))
             elif p is EOF:
                 compiled_pattern_list.append(EOF)
             elif p is TIMEOUT:
                 compiled_pattern_list.append(TIMEOUT)
             elif type(p) is re_type:
                 p = self._prepare_regex_pattern(p)
                 compiled_pattern_list.append(p)
             else:
                 raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, SRE_Pattern, or a list of those type. %s' % str(type(p)))
 
         return compiled_pattern_list
     
     def _prepare_regex_pattern(self, p):
         "Recompile unicode regexes as bytes regexes. Overridden in subclass."
         if isinstance(p.pattern, unicode):
             p = re.compile(p.pattern.encode('utf-8'), p.flags &~ re.UNICODE)
         return p
 
     def expect(self, pattern, timeout = -1, searchwindowsize=-1):
 
         """This seeks through the stream until a pattern is matched. The
         pattern is overloaded and may take several types. The pattern can be a
         StringType, EOF, a compiled re, or a list of any of those types.
         Strings will be compiled to re types. This returns the index into the
         pattern list. If the pattern was not a list this returns index 0 on a
         successful match. This may raise exceptions for EOF or TIMEOUT. To
         avoid the EOF or TIMEOUT exceptions add EOF or TIMEOUT to the pattern
         list. That will cause expect to match an EOF or TIMEOUT condition
         instead of raising an exception.
 
         If you pass a list of patterns and more than one matches, the first match
         in the stream is chosen. If more than one pattern matches at that point,
         the leftmost in the pattern list is chosen. For example::
 
             # the input is 'foobar'
             index = p.expect (['bar', 'foo', 'foobar'])
             # returns 1 ('foo') even though 'foobar' is a "better" match
 
         Please note, however, that buffering can affect this behavior, since
         input arrives in unpredictable chunks. For example::
 
             # the input is 'foobar'
             index = p.expect (['foobar', 'foo'])
             # returns 0 ('foobar') if all input is available at once,
             # but returs 1 ('foo') if parts of the final 'bar' arrive late
 
         After a match is found the instance attributes 'before', 'after' and
         'match' will be set. You can see all the data read before the match in
         'before'. You can see the data that was matched in 'after'. The
         re.MatchObject used in the re match will be in 'match'. If an error
         occurred then 'before' will be set to all the data read so far and
         'after' and 'match' will be None.
 
         If timeout is -1 then timeout will be set to the self.timeout value.
 
         A list entry may be EOF or TIMEOUT instead of a string. This will
         catch these exceptions and return the index of the list entry instead
         of raising the exception. The attribute 'after' will be set to the
         exception type. The attribute 'match' will be None. This allows you to
         write code like this::
 
                 index = p.expect (['good', 'bad', pexpect.EOF, pexpect.TIMEOUT])
                 if index == 0:
                     do_something()
                 elif index == 1:
                     do_something_else()
                 elif index == 2:
                     do_some_other_thing()
                 elif index == 3:
                     do_something_completely_different()
 
         instead of code like this::
 
                 try:
                     index = p.expect (['good', 'bad'])
                     if index == 0:
                         do_something()
                     elif index == 1:
                         do_something_else()
                 except EOF:
                     do_some_other_thing()
                 except TIMEOUT:
                     do_something_completely_different()
 
         These two forms are equivalent. It all depends on what you want. You
         can also just expect the EOF if you are waiting for all output of a
         child to finish. For example::
 
                 p = pexpect.spawn('/bin/ls')
                 p.expect (pexpect.EOF)
                 print p.before
 
         If you are trying to optimize for speed then see expect_list().
         """
 
         compiled_pattern_list = self.compile_pattern_list(pattern)
         return self.expect_list(compiled_pattern_list, timeout, searchwindowsize)
 
     def expect_list(self, pattern_list, timeout = -1, searchwindowsize = -1):
 
         """This takes a list of compiled regular expressions and returns the
         index into the pattern_list that matched the child output. The list may
         also contain EOF or TIMEOUT (which are not compiled regular
         expressions). This method is similar to the expect() method except that
         expect_list() does not recompile the pattern list on every call. This
         may help if you are trying to optimize for speed, otherwise just use
         the expect() method.  This is called by expect(). If timeout==-1 then
         the self.timeout value is used. If searchwindowsize==-1 then the
         self.searchwindowsize value is used. """
 
         return self.expect_loop(searcher_re(pattern_list), timeout, searchwindowsize)
 
     def expect_exact(self, pattern_list, timeout = -1, searchwindowsize = -1):
 
         """This is similar to expect(), but uses plain string matching instead
         of compiled regular expressions in 'pattern_list'. The 'pattern_list'
         may be a string; a list or other sequence of strings; or TIMEOUT and
         EOF.
 
         This call might be faster than expect() for two reasons: string
         searching is faster than RE matching and it is possible to limit the
         search to just the end of the input buffer.
 
         This method is also useful when you don't want to have to worry about
         escaping regular expression characters that you want to match."""
 
         if isinstance(pattern_list, (bytes, unicode)) or pattern_list in (TIMEOUT, EOF):
             pattern_list = [pattern_list]
         return self.expect_loop(searcher_string(pattern_list), timeout, searchwindowsize)
 
     def expect_loop(self, searcher, timeout = -1, searchwindowsize = -1):
 
         """This is the common loop used inside expect. The 'searcher' should be
         an instance of searcher_re or searcher_string, which describes how and what
         to search for in the input.
 
         See expect() for other arguments, return value and exceptions. """
 
         self.searcher = searcher
 
         if timeout == -1:
             timeout = self.timeout
         if timeout is not None:
             end_time = time.time() + timeout
         if searchwindowsize == -1:
             searchwindowsize = self.searchwindowsize
 
         try:
             incoming = self.buffer
             freshlen = len(incoming)
             while True: # Keep reading until exception or return.
                 index = searcher.search(incoming, freshlen, searchwindowsize)
                 if index >= 0:
                     self.buffer = incoming[searcher.end : ]
                     self.before = incoming[ : searcher.start]
                     self.after = incoming[searcher.start : searcher.end]
                     self.match = searcher.match
                     self.match_index = index
                     return self.match_index
                 # No match at this point
                 if timeout is not None and timeout < 0:
                     raise TIMEOUT ('Timeout exceeded in expect_any().')
                 # Still have time left, so read more data
                 c = self.read_nonblocking (self.maxread, timeout)
                 freshlen = len(c)
                 time.sleep (0.0001)
                 incoming = incoming + c
                 if timeout is not None:
                     timeout = end_time - time.time()
         except EOF, e:
             self.buffer = self._empty_buffer
             self.before = incoming
             self.after = EOF
             index = searcher.eof_index
             if index >= 0:
                 self.match = EOF
                 self.match_index = index
                 return self.match_index
             else:
                 self.match = None
                 self.match_index = None
                 raise EOF (str(e) + '\n' + str(self))
         except TIMEOUT, e:
             self.buffer = incoming
             self.before = incoming
             self.after = TIMEOUT
             index = searcher.timeout_index
             if index >= 0:
                 self.match = TIMEOUT
                 self.match_index = index
                 return self.match_index
             else:
                 self.match = None
                 self.match_index = None
                 raise TIMEOUT (str(e) + '\n' + str(self))
         except:
             self.before = incoming
             self.after = None
             self.match = None
             self.match_index = None
             raise
 
     def getwinsize(self):
 
         """This returns the terminal window size of the child tty. The return
         value is a tuple of (rows, cols). """
 
         TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912L)
         s = struct.pack('HHHH', 0, 0, 0, 0)
         x = fcntl.ioctl(self.fileno(), TIOCGWINSZ, s)
         return struct.unpack('HHHH', x)[0:2]
 
     def setwinsize(self, r, c):
 
         """This sets the terminal window size of the child tty. This will cause
         a SIGWINCH signal to be sent to the child. This does not change the
         physical window size. It changes the size reported to TTY-aware
         applications like vi or curses -- applications that respond to the
         SIGWINCH signal. """
 
         # Check for buggy platforms. Some Python versions on some platforms
         # (notably OSF1 Alpha and RedHat 7.1) truncate the value for
         # termios.TIOCSWINSZ. It is not clear why this happens.
         # These platforms don't seem to handle the signed int very well;
         # yet other platforms like OpenBSD have a large negative value for
         # TIOCSWINSZ and they don't have a truncate problem.
         # Newer versions of Linux have totally different values for TIOCSWINSZ.
         # Note that this fix is a hack.
         TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)
         if TIOCSWINSZ == 2148037735L: # L is not required in Python >= 2.2.
             TIOCSWINSZ = -2146929561 # Same bits, but with sign.
         # Note, assume ws_xpixel and ws_ypixel are zero.
         s = struct.pack('HHHH', r, c, 0, 0)
         fcntl.ioctl(self.fileno(), TIOCSWINSZ, s)
 
     def interact(self, escape_character = b'\x1d', input_filter = None, output_filter = None):
 
         """This gives control of the child process to the interactive user (the
         human at the keyboard). Keystrokes are sent to the child process, and
         the stdout and stderr output of the child process is printed. This
         simply echos the child stdout and child stderr to the real stdout and
         it echos the real stdin to the child stdin. When the user types the
         escape_character this method will stop. The default for
         escape_character is ^]. This should not be confused with ASCII 27 --
         the ESC character. ASCII 29 was chosen for historical merit because
         this is the character used by 'telnet' as the escape character. The
         escape_character will not be sent to the child process.
 
         You may pass in optional input and output filter functions. These
         functions should take a string and return a string. The output_filter
         will be passed all the output from the child process. The input_filter
         will be passed all the keyboard input from the user. The input_filter
         is run BEFORE the check for the escape_character.
 
         Note that if you change the window size of the parent the SIGWINCH
         signal will not be passed through to the child. If you want the child
         window size to change when the parent's window size changes then do
         something like the following example::
 
             import pexpect, struct, fcntl, termios, signal, sys
             def sigwinch_passthrough (sig, data):
                 s = struct.pack("HHHH", 0, 0, 0, 0)
                 a = struct.unpack('hhhh', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ , s))
                 global p
                 p.setwinsize(a[0],a[1])
             p = pexpect.spawn('/bin/bash') # Note this is global and used in sigwinch_passthrough.
             signal.signal(signal.SIGWINCH, sigwinch_passthrough)
             p.interact()
         """
 
         # Flush the buffer.
         if PY3: self.stdout.write(_cast_unicode(self.buffer, self.encoding))
         else:   self.stdout.write(self.buffer)
         self.stdout.flush()
         self.buffer = self._empty_buffer
         mode = tty.tcgetattr(self.STDIN_FILENO)
         tty.setraw(self.STDIN_FILENO)
         try:
             self.__interact_copy(escape_character, input_filter, output_filter)
         finally:
             tty.tcsetattr(self.STDIN_FILENO, tty.TCSAFLUSH, mode)
 
     def __interact_writen(self, fd, data):
 
         """This is used by the interact() method.
         """
 
         while data != b'' and self.isalive():
             n = os.write(fd, data)
             data = data[n:]
 
     def __interact_read(self, fd):
 
         """This is used by the interact() method.
         """
 
         return os.read(fd, 1000)
 
     def __interact_copy(self, escape_character = None, input_filter = None, output_filter = None):
 
         """This is used by the interact() method.
         """
 
         while self.isalive():
             r,w,e = self.__select([self.child_fd, self.STDIN_FILENO], [], [])
             if self.child_fd in r:
                 data = self.__interact_read(self.child_fd)
                 if output_filter: data = output_filter(data)
                 if self.logfile is not None:
                     self.logfile.write (data)
                     self.logfile.flush()
                 os.write(self.STDOUT_FILENO, data)
             if self.STDIN_FILENO in r:
                 data = self.__interact_read(self.STDIN_FILENO)
                 if input_filter: data = input_filter(data)
                 i = data.rfind(escape_character)
                 if i != -1:
                     data = data[:i]
                     self.__interact_writen(self.child_fd, data)
                     break
                 self.__interact_writen(self.child_fd, data)
 
     def __select (self, iwtd, owtd, ewtd, timeout=None):
 
         """This is a wrapper around select.select() that ignores signals. If
         select.select raises a select.error exception and errno is an EINTR
         error then it is ignored. Mainly this is used to ignore sigwinch
         (terminal resize). """
 
         # if select() is interrupted by a signal (errno==EINTR) then
         # we loop back and enter the select() again.
         if timeout is not None:
             end_time = time.time() + timeout
         while True:
             try:
                 return select.select (iwtd, owtd, ewtd, timeout)
             except select.error as e:
                 if e.args[0] == errno.EINTR:
                     # if we loop back we have to subtract the amount of time we already waited.
                     if timeout is not None:
                         timeout = end_time - time.time()
                         if timeout < 0:
                             return ([],[],[])
                 else: # something else caused the select.error, so this really is an exception
                     raise
 
 class spawn(spawnb):
     """This is the main class interface for Pexpect. Use this class to start
     and control child applications."""
     
     _buffer_type = unicode
     def _cast_buffer_type(self, s):
         return _cast_unicode(s, self.encoding)
     _empty_buffer = u''
     _pty_newline = u'\r\n'
     
     def __init__(self, command, args=[], timeout=30, maxread=2000, searchwindowsize=None,
                  logfile=None, cwd=None, env=None, encoding='utf-8'):
         super(spawn, self).__init__(command, args, timeout=timeout, maxread=maxread,
                     searchwindowsize=searchwindowsize, logfile=logfile, cwd=cwd, env=env)
         self.encoding = encoding
     
     def _prepare_regex_pattern(self, p):
         "Recompile bytes regexes as unicode regexes."
         if isinstance(p.pattern, bytes):
             p = re.compile(p.pattern.decode(self.encoding), p.flags)
         return p
     
     def read_nonblocking(self, size=1, timeout=-1):
         return super(spawn, self).read_nonblocking(size=size, timeout=timeout)\
                                     .decode(self.encoding)
     
     read_nonblocking.__doc__ = spawnb.read_nonblocking.__doc__
         
 
 ##############################################################################
 # End of spawn class
 ##############################################################################
 
 class searcher_string (object):
 
     """This is a plain string search helper for the spawn.expect_any() method.
     This helper class is for speed. For more powerful regex patterns
     see the helper class, searcher_re.
 
     Attributes:
 
         eof_index     - index of EOF, or -1
         timeout_index - index of TIMEOUT, or -1
 
     After a successful match by the search() method the following attributes
     are available:
 
         start - index into the buffer, first byte of match
         end   - index into the buffer, first byte after match
         match - the matching string itself
 
     """
 
     def __init__(self, strings):
 
         """This creates an instance of searcher_string. This argument 'strings'
         may be a list; a sequence of strings; or the EOF or TIMEOUT types. """
 
         self.eof_index = -1
         self.timeout_index = -1
         self._strings = []
         for n, s in enumerate(strings):
             if s is EOF:
                 self.eof_index = n
                 continue
             if s is TIMEOUT:
                 self.timeout_index = n
                 continue
             self._strings.append((n, s))
 
     def __str__(self):
 
         """This returns a human-readable string that represents the state of
         the object."""
 
         ss =  [ (ns[0],'    %d: "%s"' % ns) for ns in self._strings ]
         ss.append((-1,'searcher_string:'))
         if self.eof_index >= 0:
             ss.append ((self.eof_index,'    %d: EOF' % self.eof_index))
         if self.timeout_index >= 0:
             ss.append ((self.timeout_index,'    %d: TIMEOUT' % self.timeout_index))
         ss.sort()
         return '\n'.join(a[1] for a in ss)
 
     def search(self, buffer, freshlen, searchwindowsize=None):
 
         """This searches 'buffer' for the first occurence of one of the search
         strings.  'freshlen' must indicate the number of bytes at the end of
         'buffer' which have not been searched before. It helps to avoid
         searching the same, possibly big, buffer over and over again.
 
         See class spawn for the 'searchwindowsize' argument.
 
         If there is a match this returns the index of that string, and sets
         'start', 'end' and 'match'. Otherwise, this returns -1. """
 
         absurd_match = len(buffer)
         first_match = absurd_match
 
         # 'freshlen' helps a lot here. Further optimizations could
         # possibly include:
         #
         # using something like the Boyer-Moore Fast String Searching
         # Algorithm; pre-compiling the search through a list of
         # strings into something that can scan the input once to
         # search for all N strings; realize that if we search for
         # ['bar', 'baz'] and the input is '...foo' we need not bother
         # rescanning until we've read three more bytes.
         #
         # Sadly, I don't know enough about this interesting topic. /grahn
 
         for index, s in self._strings:
             if searchwindowsize is None:
                 # the match, if any, can only be in the fresh data,
                 # or at the very end of the old data
                 offset = -(freshlen+len(s))
             else:
                 # better obey searchwindowsize
                 offset = -searchwindowsize
             n = buffer.find(s, offset)
             if n >= 0 and n < first_match:
                 first_match = n
                 best_index, best_match = index, s
         if first_match == absurd_match:
             return -1
         self.match = best_match
         self.start = first_match
         self.end = self.start + len(self.match)
         return best_index
 
 class searcher_re (object):
 
     """This is regular expression string search helper for the
     spawn.expect_any() method. This helper class is for powerful
     pattern matching. For speed, see the helper class, searcher_string.
 
     Attributes:
 
         eof_index     - index of EOF, or -1
         timeout_index - index of TIMEOUT, or -1
 
     After a successful match by the search() method the following attributes
     are available:
 
         start - index into the buffer, first byte of match
         end   - index into the buffer, first byte after match
         match - the re.match object returned by a succesful re.search
 
     """
 
     def __init__(self, patterns):
 
         """This creates an instance that searches for 'patterns' Where
         'patterns' may be a list or other sequence of compiled regular
         expressions, or the EOF or TIMEOUT types."""
 
         self.eof_index = -1
         self.timeout_index = -1
         self._searches = []
         for n, s in enumerate(patterns):
             if s is EOF:
                 self.eof_index = n
                 continue
             if s is TIMEOUT:
                 self.timeout_index = n
                 continue
             self._searches.append((n, s))
 
     def __str__(self):
 
         """This returns a human-readable string that represents the state of
         the object."""
 
         ss =  [ (n,'    %d: re.compile("%s")' % (n,str(s.pattern))) for n,s in self._searches]
         ss.append((-1,'searcher_re:'))
         if self.eof_index >= 0:
             ss.append ((self.eof_index,'    %d: EOF' % self.eof_index))
         if self.timeout_index >= 0:
             ss.append ((self.timeout_index,'    %d: TIMEOUT' % self.timeout_index))
         ss.sort()
         return '\n'.join(a[1] for a in ss)
 
     def search(self, buffer, freshlen, searchwindowsize=None):
 
         """This searches 'buffer' for the first occurence of one of the regular
         expressions. 'freshlen' must indicate the number of bytes at the end of
         'buffer' which have not been searched before.
 
         See class spawn for the 'searchwindowsize' argument.
 
         If there is a match this returns the index of that string, and sets
         'start', 'end' and 'match'. Otherwise, returns -1."""
 
         absurd_match = len(buffer)
         first_match = absurd_match
         # 'freshlen' doesn't help here -- we cannot predict the
         # length of a match, and the re module provides no help.
         if searchwindowsize is None:
             searchstart = 0
         else:
             searchstart = max(0, len(buffer)-searchwindowsize)
         for index, s in self._searches:
             match = s.search(buffer, searchstart)
             if match is None:
                 continue
             n = match.start()
             if n < first_match:
                 first_match = n
                 the_match = match
                 best_index = index
         if first_match == absurd_match:
             return -1
         self.start = first_match
         self.match = the_match
         self.end = self.match.end()
         return best_index
 
 def which (filename):
 
     """This takes a given filename; tries to find it in the environment path;
     then checks if it is executable. This returns the full path to the filename
     if found and executable. Otherwise this returns None."""
 
     # Special case where filename already contains a path.
     if os.path.dirname(filename) != '':
         if os.access (filename, os.X_OK):
             return filename
 
     if not os.environ.has_key('PATH') or os.environ['PATH'] == '':
         p = os.defpath
     else:
         p = os.environ['PATH']
 
     pathlist = p.split(os.pathsep)
 
     for path in pathlist:
         f = os.path.join(path, filename)
         if os.access(f, os.X_OK):
             return f
     return None
 
 def split_command_line(command_line):
 
     """This splits a command line into a list of arguments. It splits arguments
     on spaces, but handles embedded quotes, doublequotes, and escaped
     characters. It's impossible to do this with a regular expression, so I
     wrote a little state machine to parse the command line. """
 
     arg_list = []
     arg = ''
 
     # Constants to name the states we can be in.
     state_basic = 0
     state_esc = 1
     state_singlequote = 2
     state_doublequote = 3
     state_whitespace = 4 # The state of consuming whitespace between commands.
     state = state_basic
 
     for c in command_line:
         if state == state_basic or state == state_whitespace:
             if c == '\\': # Escape the next character
                 state = state_esc
             elif c == r"'": # Handle single quote
                 state = state_singlequote
             elif c == r'"': # Handle double quote
                 state = state_doublequote
             elif c.isspace():
                 # Add arg to arg_list if we aren't in the middle of whitespace.
                 if state == state_whitespace:
                     None # Do nothing.
                 else:
                     arg_list.append(arg)
                     arg = ''
                     state = state_whitespace
             else:
                 arg = arg + c
                 state = state_basic
         elif state == state_esc:
             arg = arg + c
             state = state_basic
         elif state == state_singlequote:
             if c == r"'":
                 state = state_basic
             else:
                 arg = arg + c
         elif state == state_doublequote:
             if c == r'"':
                 state = state_basic
             else:
                 arg = arg + c
 
     if arg != '':
         arg_list.append(arg)
     return arg_list
 
 # vi:set sr et ts=4 sw=4 ft=python :

IPython/frontend/terminal/interactiveshell.py

@@ -1,668 +1,668 b''
 # -*- coding: utf-8 -*-
 """Subclass of InteractiveShell for terminal based frontends."""
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2001 Janko Hauser <[e-mail]>
 #  Copyright (C) 2001-2007 Fernando Perez. <[e-mail]>
 #  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import __builtin__
 import bdb
 import os
 import re
 import sys
 import textwrap
 
 try:
     from contextlib import nested
 except:
     from IPython.utils.nested_context import nested
 
 from IPython.core.error import TryNext, UsageError
 from IPython.core.usage import interactive_usage, default_banner
 from IPython.core.interactiveshell import InteractiveShell, InteractiveShellABC
 from IPython.core.pylabtools import pylab_activate
 from IPython.testing.skipdoctest import skip_doctest
 from IPython.utils import py3compat
 from IPython.utils.terminal import toggle_set_term_title, set_term_title
 from IPython.utils.process import abbrev_cwd
 from IPython.utils.warn import warn, error
 from IPython.utils.text import num_ini_spaces, SList
 from IPython.utils.traitlets import Integer, CBool, Unicode
 
 #-----------------------------------------------------------------------------
 # Utilities
 #-----------------------------------------------------------------------------
 
 def get_default_editor():
     try:
         ed = os.environ['EDITOR']
     except KeyError:
         if os.name == 'posix':
             ed = 'vi'  # the only one guaranteed to be there!
         else:
             ed = 'notepad' # same in Windows!
     return ed
 
 
 def get_pasted_lines(sentinel, l_input=py3compat.input):
     """ Yield pasted lines until the user enters the given sentinel value.
     """
     print "Pasting code; enter '%s' alone on the line to stop or use Ctrl-D." \
           % sentinel
     while True:
         try:
             l = l_input(':')
             if l == sentinel:
                 return
             else:
                 yield l
         except EOFError:
             print '<EOF>'
             return
 
 
 def strip_email_quotes(raw_lines):
     """ Strip email quotation marks at the beginning of each line.
 
     We don't do any more input transofrmations here because the main shell's
     prefiltering handles other cases.
     """
     lines = [re.sub(r'^\s*(\s?>)+', '', l) for l in raw_lines]
     return '\n'.join(lines) + '\n'
 
 
 # These two functions are needed by the %paste/%cpaste magics.  In practice
 # they are basically methods (they take the shell as their first argument), but
 # we leave them as standalone functions because eventually the magics
 # themselves will become separate objects altogether.  At that point, the
 # magics will have access to the shell object, and these functions can be made
 # methods of the magic object, but not of the shell.
 
 def store_or_execute(shell, block, name):
     """ Execute a block, or store it in a variable, per the user's request.
     """
     # Dedent and prefilter so what we store matches what is executed by
     # run_cell.
     b = shell.prefilter(textwrap.dedent(block))
 
     if name:
         # If storing it for further editing, run the prefilter on it
         shell.user_ns[name] = SList(b.splitlines())
         print "Block assigned to '%s'" % name
     else:
         shell.user_ns['pasted_block'] = b
         shell.run_cell(b)
 
 
 def rerun_pasted(shell, name='pasted_block'):
     """ Rerun a previously pasted command.
     """
     b = shell.user_ns.get(name)
 
     # Sanity checks
     if b is None:
         raise UsageError('No previous pasted block available')
     if not isinstance(b, basestring):
         raise UsageError(
             "Variable 'pasted_block' is not a string, can't execute")
 
     print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
     shell.run_cell(b)
 
 
 #-----------------------------------------------------------------------------
 # Main class
 #-----------------------------------------------------------------------------
 
 class TerminalInteractiveShell(InteractiveShell):
 
     autoedit_syntax = CBool(False, config=True,
         help="auto editing of files with syntax errors.")
     banner = Unicode('')
     banner1 = Unicode(default_banner, config=True,
         help="""The part of the banner to be printed before the profile"""
     )
     banner2 = Unicode('', config=True,
         help="""The part of the banner to be printed after the profile"""
     )
     confirm_exit = CBool(True, config=True,
         help="""
         Set to confirm when you try to exit IPython with an EOF (Control-D
         in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
         you can force a direct exit without any confirmation.""",
     )
     # This display_banner only controls whether or not self.show_banner()
     # is called when mainloop/interact are called.  The default is False
     # because for the terminal based application, the banner behavior
     # is controlled by Global.display_banner, which IPythonApp looks at
     # to determine if *it* should call show_banner() by hand or not.
     display_banner = CBool(False) # This isn't configurable!
     embedded = CBool(False)
     embedded_active = CBool(False)
     editor = Unicode(get_default_editor(), config=True,
         help="Set the editor used by IPython (default to $EDITOR/vi/notepad)."
     )
     pager = Unicode('less', config=True,
         help="The shell program to be used for paging.")
 
     screen_length = Integer(0, config=True,
         help=
         """Number of lines of your screen, used to control printing of very
         long strings.  Strings longer than this number of lines will be sent
         through a pager instead of directly printed.  The default value for
         this is 0, which means IPython will auto-detect your screen size every
         time it needs to print certain potentially long strings (this doesn't
         change the behavior of the 'print' keyword, it's only triggered
         internally). If for some reason this isn't working well (it needs
         curses support), specify it yourself. Otherwise don't change the
         default.""",
     )
     term_title = CBool(False, config=True,
         help="Enable auto setting the terminal title."
     )
 
     # In the terminal, GUI control is done via PyOS_InputHook
     from IPython.lib.inputhook import enable_gui
     enable_gui = staticmethod(enable_gui)
     
     def __init__(self, config=None, ipython_dir=None, profile_dir=None,
                  user_ns=None, user_module=None, custom_exceptions=((),None),
                  usage=None, banner1=None, banner2=None, display_banner=None):
 
         super(TerminalInteractiveShell, self).__init__(
             config=config, profile_dir=profile_dir, user_ns=user_ns,
             user_module=user_module, custom_exceptions=custom_exceptions
         )
         # use os.system instead of utils.process.system by default,
         # because piped system doesn't make sense in the Terminal:
         self.system = self.system_raw
 
         self.init_term_title()
         self.init_usage(usage)
         self.init_banner(banner1, banner2, display_banner)
 
     #-------------------------------------------------------------------------
     # Things related to the terminal
     #-------------------------------------------------------------------------
 
     @property
     def usable_screen_length(self):
         if self.screen_length == 0:
             return 0
         else:
             num_lines_bot = self.separate_in.count('\n')+1
             return self.screen_length - num_lines_bot
 
     def init_term_title(self):
         # Enable or disable the terminal title.
         if self.term_title:
             toggle_set_term_title(True)
             set_term_title('IPython: ' + abbrev_cwd())
         else:
             toggle_set_term_title(False)
 
     #-------------------------------------------------------------------------
     # Things related to aliases
     #-------------------------------------------------------------------------
 
     def init_alias(self):
         # The parent class defines aliases that can be safely used with any
         # frontend.
         super(TerminalInteractiveShell, self).init_alias()
 
         # Now define aliases that only make sense on the terminal, because they
         # need direct access to the console in a way that we can't emulate in
         # GUI or web frontend
         if os.name == 'posix':
             aliases = [('clear', 'clear'), ('more', 'more'), ('less', 'less'),
                        ('man', 'man')]
         elif os.name == 'nt':
             aliases = [('cls', 'cls')]
 
 
         for name, cmd in aliases:
             self.alias_manager.define_alias(name, cmd)
 
     #-------------------------------------------------------------------------
     # Things related to the banner and usage
     #-------------------------------------------------------------------------
 
     def _banner1_changed(self):
         self.compute_banner()
 
     def _banner2_changed(self):
         self.compute_banner()
 
     def _term_title_changed(self, name, new_value):
         self.init_term_title()
 
     def init_banner(self, banner1, banner2, display_banner):
         if banner1 is not None:
             self.banner1 = banner1
         if banner2 is not None:
             self.banner2 = banner2
         if display_banner is not None:
             self.display_banner = display_banner
         self.compute_banner()
 
     def show_banner(self, banner=None):
         if banner is None:
             banner = self.banner
         self.write(banner)
 
     def compute_banner(self):
         self.banner = self.banner1
         if self.profile and self.profile != 'default':
             self.banner += '\nIPython profile: %s\n' % self.profile
         if self.banner2:
             self.banner += '\n' + self.banner2
 
     def init_usage(self, usage=None):
         if usage is None:
             self.usage = interactive_usage
         else:
             self.usage = usage
 
     #-------------------------------------------------------------------------
     # Mainloop and code execution logic
     #-------------------------------------------------------------------------
 
     def mainloop(self, display_banner=None):
         """Start the mainloop.
 
         If an optional banner argument is given, it will override the
         internally created default banner.
         """
 
         with nested(self.builtin_trap, self.display_trap):
 
             while 1:
                 try:
                     self.interact(display_banner=display_banner)
                     #self.interact_with_readline()
                     # XXX for testing of a readline-decoupled repl loop, call
                     # interact_with_readline above
                     break
                 except KeyboardInterrupt:
                     # this should not be necessary, but KeyboardInterrupt
                     # handling seems rather unpredictable...
                     self.write("\nKeyboardInterrupt in interact()\n")
 
     def _replace_rlhist_multiline(self, source_raw, hlen_before_cell):
         """Store multiple lines as a single entry in history"""
 
         # do nothing without readline or disabled multiline
         if not self.has_readline or not self.multiline_history:
             return hlen_before_cell
 
         # windows rl has no remove_history_item
         if not hasattr(self.readline, "remove_history_item"):
             return hlen_before_cell
 
         # skip empty cells
         if not source_raw.rstrip():
             return hlen_before_cell
 
         # nothing changed do nothing, e.g. when rl removes consecutive dups
         hlen = self.readline.get_current_history_length()
         if hlen == hlen_before_cell:
             return hlen_before_cell
 
         for i in range(hlen - hlen_before_cell):
             self.readline.remove_history_item(hlen - i - 1)
         stdin_encoding = sys.stdin.encoding or "utf-8"
         self.readline.add_history(py3compat.unicode_to_str(source_raw.rstrip(),
                                     stdin_encoding))
         return self.readline.get_current_history_length()
 
     def interact(self, display_banner=None):
         """Closely emulate the interactive Python console."""
 
         # batch run -> do not interact
         if self.exit_now:
             return
 
         if display_banner is None:
             display_banner = self.display_banner
 
         if isinstance(display_banner, basestring):
             self.show_banner(display_banner)
         elif display_banner:
             self.show_banner()
 
         more = False
 
         if self.has_readline:
             self.readline_startup_hook(self.pre_readline)
             hlen_b4_cell = self.readline.get_current_history_length()
         else:
             hlen_b4_cell = 0
         # exit_now is set by a call to %Exit or %Quit, through the
         # ask_exit callback.
 
         while not self.exit_now:
             self.hooks.pre_prompt_hook()
             if more:
                 try:
                     prompt = self.prompt_manager.render('in2')
                 except:
                     self.showtraceback()
                 if self.autoindent:
                     self.rl_do_indent = True
 
             else:
                 try:
                     prompt = self.separate_in + self.prompt_manager.render('in')
                 except:
                     self.showtraceback()
             try:
                 line = self.raw_input(prompt)
                 if self.exit_now:
                     # quick exit on sys.std[in|out] close
                     break
                 if self.autoindent:
                     self.rl_do_indent = False
 
             except KeyboardInterrupt:
                 #double-guard against keyboardinterrupts during kbdint handling
                 try:
                     self.write('\nKeyboardInterrupt\n')
                     source_raw = self.input_splitter.source_raw_reset()[1]
                     hlen_b4_cell = \
                         self._replace_rlhist_multiline(source_raw, hlen_b4_cell)
                     more = False
                 except KeyboardInterrupt:
                     pass
             except EOFError:
                 if self.autoindent:
                     self.rl_do_indent = False
                     if self.has_readline:
                         self.readline_startup_hook(None)
                 self.write('\n')
                 self.exit()
             except bdb.BdbQuit:
                 warn('The Python debugger has exited with a BdbQuit exception.\n'
                      'Because of how pdb handles the stack, it is impossible\n'
                      'for IPython to properly format this particular exception.\n'
                      'IPython will resume normal operation.')
             except:
                 # exceptions here are VERY RARE, but they can be triggered
                 # asynchronously by signal handlers, for example.
                 self.showtraceback()
             else:
                 self.input_splitter.push(line)
                 more = self.input_splitter.push_accepts_more()
                 if (self.SyntaxTB.last_syntax_error and
                     self.autoedit_syntax):
                     self.edit_syntax_error()
                 if not more:
                     source_raw = self.input_splitter.source_raw_reset()[1]
                     self.run_cell(source_raw, store_history=True)
                     hlen_b4_cell = \
                         self._replace_rlhist_multiline(source_raw, hlen_b4_cell)
 
         # Turn off the exit flag, so the mainloop can be restarted if desired
         self.exit_now = False
 
     def raw_input(self, prompt=''):
         """Write a prompt and read a line.
 
         The returned line does not include the trailing newline.
         When the user enters the EOF key sequence, EOFError is raised.
 
         Optional inputs:
 
           - prompt(''): a string to be printed to prompt the user.
 
           - continue_prompt(False): whether this line is the first one or a
           continuation in a sequence of inputs.
         """
         # Code run by the user may have modified the readline completer state.
         # We must ensure that our completer is back in place.
 
         if self.has_readline:
             self.set_readline_completer()
 
         try:
             line = py3compat.str_to_unicode(self.raw_input_original(prompt))
         except ValueError:
             warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
                  " or sys.stdout.close()!\nExiting IPython!")
             self.ask_exit()
             return ""
 
         # Try to be reasonably smart about not re-indenting pasted input more
         # than necessary.  We do this by trimming out the auto-indent initial
         # spaces, if the user's actual input started itself with whitespace.
         if self.autoindent:
             if num_ini_spaces(line) > self.indent_current_nsp:
                 line = line[self.indent_current_nsp:]
                 self.indent_current_nsp = 0
 
         return line
 
     #-------------------------------------------------------------------------
     # Methods to support auto-editing of SyntaxErrors.
     #-------------------------------------------------------------------------
 
     def edit_syntax_error(self):
         """The bottom half of the syntax error handler called in the main loop.
 
         Loop until syntax error is fixed or user cancels.
         """
 
         while self.SyntaxTB.last_syntax_error:
             # copy and clear last_syntax_error
             err = self.SyntaxTB.clear_err_state()
             if not self._should_recompile(err):
                 return
             try:
                 # may set last_syntax_error again if a SyntaxError is raised
                 self.safe_execfile(err.filename,self.user_ns)
             except:
                 self.showtraceback()
             else:
                 try:
-                    f = file(err.filename)
+                    f = open(err.filename)
                     try:
                         # This should be inside a display_trap block and I
                         # think it is.
                         sys.displayhook(f.read())
                     finally:
                         f.close()
                 except:
                     self.showtraceback()
 
     def _should_recompile(self,e):
         """Utility routine for edit_syntax_error"""
 
         if e.filename in ('<ipython console>','<input>','<string>',
                           '<console>','<BackgroundJob compilation>',
                           None):
 
             return False
         try:
             if (self.autoedit_syntax and
                 not self.ask_yes_no('Return to editor to correct syntax error? '
                               '[Y/n] ','y')):
                 return False
         except EOFError:
             return False
 
         def int0(x):
             try:
                 return int(x)
             except TypeError:
                 return 0
         # always pass integer line and offset values to editor hook
         try:
             self.hooks.fix_error_editor(e.filename,
                 int0(e.lineno),int0(e.offset),e.msg)
         except TryNext:
             warn('Could not open editor')
             return False
         return True
 
     #-------------------------------------------------------------------------
     # Things related to exiting
     #-------------------------------------------------------------------------
 
     def ask_exit(self):
         """ Ask the shell to exit. Can be overiden and used as a callback. """
         self.exit_now = True
 
     def exit(self):
         """Handle interactive exit.
 
         This method calls the ask_exit callback."""
         if self.confirm_exit:
             if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
                 self.ask_exit()
         else:
             self.ask_exit()
 
     #------------------------------------------------------------------------
     # Magic overrides
     #------------------------------------------------------------------------
     # Once the base class stops inheriting from magic, this code needs to be
     # moved into a separate machinery as well.  For now, at least isolate here
     # the magics which this class needs to implement differently from the base
     # class, or that are unique to it.
 
     def magic_autoindent(self, parameter_s = ''):
         """Toggle autoindent on/off (if available)."""
 
         self.shell.set_autoindent()
         print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent]
 
     @skip_doctest
     def magic_cpaste(self, parameter_s=''):
         """Paste & execute a pre-formatted code block from clipboard.
 
         You must terminate the block with '--' (two minus-signs) or Ctrl-D
         alone on the line. You can also provide your own sentinel with '%paste
         -s %%' ('%%' is the new sentinel for this operation)
 
         The block is dedented prior to execution to enable execution of method
         definitions. '>' and '+' characters at the beginning of a line are
         ignored, to allow pasting directly from e-mails, diff files and
         doctests (the '...' continuation prompt is also stripped).  The
         executed block is also assigned to variable named 'pasted_block' for
         later editing with '%edit pasted_block'.
 
         You can also pass a variable name as an argument, e.g. '%cpaste foo'.
         This assigns the pasted block to variable 'foo' as string, without
         dedenting or executing it (preceding >>> and + is still stripped)
 
         '%cpaste -r' re-executes the block previously entered by cpaste.
 
         Do not be alarmed by garbled output on Windows (it's a readline bug).
         Just press enter and type -- (and press enter again) and the block
         will be what was just pasted.
 
         IPython statements (magics, shell escapes) are not supported (yet).
 
         See also
         --------
         paste: automatically pull code from clipboard.
 
         Examples
         --------
         ::
 
           In [8]: %cpaste
           Pasting code; enter '--' alone on the line to stop.
           :>>> a = ["world!", "Hello"]
           :>>> print " ".join(sorted(a))
           :--
           Hello world!
         """
 
         opts, name = self.parse_options(parameter_s, 'rs:', mode='string')
         if 'r' in opts:
             rerun_pasted(self.shell)
             return
 
         sentinel = opts.get('s', '--')
         block = strip_email_quotes(get_pasted_lines(sentinel))
         store_or_execute(self.shell, block, name)
 
     def magic_paste(self, parameter_s=''):
         """Paste & execute a pre-formatted code block from clipboard.
 
         The text is pulled directly from the clipboard without user
         intervention and printed back on the screen before execution (unless
         the -q flag is given to force quiet mode).
 
         The block is dedented prior to execution to enable execution of method
         definitions. '>' and '+' characters at the beginning of a line are
         ignored, to allow pasting directly from e-mails, diff files and
         doctests (the '...' continuation prompt is also stripped).  The
         executed block is also assigned to variable named 'pasted_block' for
         later editing with '%edit pasted_block'.
 
         You can also pass a variable name as an argument, e.g. '%paste foo'.
         This assigns the pasted block to variable 'foo' as string, without
         dedenting or executing it (preceding >>> and + is still stripped)
 
         Options
         -------
 
           -r: re-executes the block previously entered by cpaste.
 
           -q: quiet mode: do not echo the pasted text back to the terminal.
 
         IPython statements (magics, shell escapes) are not supported (yet).
 
         See also
         --------
         cpaste: manually paste code into terminal until you mark its end.
         """
         opts, name = self.parse_options(parameter_s, 'rq', mode='string')
         if 'r' in opts:
             rerun_pasted(self.shell)
             return
         try:
             text = self.shell.hooks.clipboard_get()
             block = strip_email_quotes(text.splitlines())
         except TryNext as clipboard_exc:
             message = getattr(clipboard_exc, 'args')
             if message:
                 error(message[0])
             else:
                 error('Could not get text from the clipboard.')
             return
 
         # By default, echo back to terminal unless quiet mode is requested
         if 'q' not in opts:
             write = self.shell.write
             write(self.shell.pycolorize(block))
             if not block.endswith('\n'):
                 write('\n')
             write("## -- End pasted text --\n")
 
         store_or_execute(self.shell, block, name)
 
     # Class-level: add a '%cls' magic only on Windows
     if sys.platform == 'win32':
         def magic_cls(self, s):
             """Clear screen.
             """
             os.system("cls")
 
     def showindentationerror(self):
         super(TerminalInteractiveShell, self).showindentationerror()
         print("If you want to paste code into IPython, try the "
               "%paste and %cpaste magic functions.")
 
 
 InteractiveShellABC.register(TerminalInteractiveShell)

IPython/utils/PyColorize.py

@@ -1,306 +1,306 b''
 # -*- coding: utf-8 -*-
 """
 Class and program to colorize python source code for ANSI terminals.
 
 Based on an HTML code highlighter by Jurgen Hermann found at:
 http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52298
 
 Modifications by Fernando Perez ([e-mail]).
 
 Information on the original HTML highlighter follows:
 
 MoinMoin - Python Source Parser
 
 Title: Colorize Python source using the built-in tokenizer
 
 Submitter: Jurgen Hermann
 Last Updated:2001/04/06
 
 Version no:1.2
 
 Description:
 
 This code is part of MoinMoin (http://moin.sourceforge.net/) and converts
 Python source code to HTML markup, rendering comments, keywords,
 operators, numeric and string literals in different colors.
 
 It shows how to use the built-in keyword, token and tokenize modules to
 scan Python source code and re-emit it with no changes to its original
 formatting (which is the hard part).
 """
 
 __all__ = ['ANSICodeColors','Parser']
 
 _scheme_default = 'Linux'
 
 # Imports
 import StringIO
 import keyword
 import os
 import optparse
 import sys
 import token
 import tokenize
 
 try:
     generate_tokens = tokenize.generate_tokens
 except AttributeError:
     # Python 3. Note that we use the undocumented _tokenize because it expects
     # strings, not bytes. See also Python issue #9969.
     generate_tokens = tokenize._tokenize
 
 from IPython.utils.coloransi import *
 
 #############################################################################
 ### Python Source Parser (does Hilighting)
 #############################################################################
 
 _KEYWORD = token.NT_OFFSET + 1
 _TEXT    = token.NT_OFFSET + 2
 
 #****************************************************************************
 # Builtin color schemes
 
 Colors = TermColors  # just a shorthand
 
 # Build a few color schemes
 NoColor = ColorScheme(
     'NoColor',{
     token.NUMBER     : Colors.NoColor,
     token.OP         : Colors.NoColor,
     token.STRING     : Colors.NoColor,
     tokenize.COMMENT : Colors.NoColor,
     token.NAME       : Colors.NoColor,
     token.ERRORTOKEN : Colors.NoColor,
 
     _KEYWORD         : Colors.NoColor,
     _TEXT            : Colors.NoColor,
 
     'normal'         : Colors.NoColor  # color off (usu. Colors.Normal)
     }  )
 
 LinuxColors = ColorScheme(
     'Linux',{
     token.NUMBER     : Colors.LightCyan,
     token.OP         : Colors.Yellow,
     token.STRING     : Colors.LightBlue,
     tokenize.COMMENT : Colors.LightRed,
     token.NAME       : Colors.Normal,
     token.ERRORTOKEN : Colors.Red,
 
     _KEYWORD         : Colors.LightGreen,
     _TEXT            : Colors.Yellow,
 
     'normal'         : Colors.Normal  # color off (usu. Colors.Normal)
     } )
 
 LightBGColors = ColorScheme(
     'LightBG',{
     token.NUMBER     : Colors.Cyan,
     token.OP         : Colors.Blue,
     token.STRING     : Colors.Blue,
     tokenize.COMMENT : Colors.Red,
     token.NAME       : Colors.Normal,
     token.ERRORTOKEN : Colors.Red,
 
     _KEYWORD         : Colors.Green,
     _TEXT            : Colors.Blue,
 
     'normal'         : Colors.Normal  # color off (usu. Colors.Normal)
     }  )
 
 # Build table of color schemes (needed by the parser)
 ANSICodeColors = ColorSchemeTable([NoColor,LinuxColors,LightBGColors],
                                   _scheme_default)
 
 class Parser:
     """ Format colored Python source.
     """
 
     def __init__(self, color_table=None,out = sys.stdout):
         """ Create a parser with a specified color table and output channel.
 
         Call format() to process code.
         """
         self.color_table = color_table and color_table or ANSICodeColors
         self.out = out
 
     def format(self, raw, out = None, scheme = ''):
         return self.format2(raw, out, scheme)[0]
 
     def format2(self, raw, out = None, scheme = ''):
         """ Parse and send the colored source.
 
         If out and scheme are not specified, the defaults (given to
         constructor) are used.
 
         out should be a file-type object. Optionally, out can be given as the
         string 'str' and the parser will automatically return the output in a
         string."""
 
         string_output = 0
         if out == 'str' or self.out == 'str' or \
            isinstance(self.out,StringIO.StringIO):
             # XXX - I don't really like this state handling logic, but at this
             # point I don't want to make major changes, so adding the
             # isinstance() check is the simplest I can do to ensure correct
             # behavior.
             out_old = self.out
             self.out = StringIO.StringIO()
             string_output = 1
         elif out is not None:
             self.out = out
 
         # Fast return of the unmodified input for NoColor scheme
         if scheme == 'NoColor':
             error = False
             self.out.write(raw)
             if string_output:
                 return raw,error
             else:
                 return None,error
 
         # local shorthands
         colors = self.color_table[scheme].colors
         self.colors = colors # put in object so __call__ sees it
 
         # Remove trailing whitespace and normalize tabs
         self.raw = raw.expandtabs().rstrip()
 
         # store line offsets in self.lines
         self.lines = [0, 0]
         pos = 0
         raw_find = self.raw.find
         lines_append = self.lines.append
         while 1:
             pos = raw_find('\n', pos) + 1
             if not pos: break
             lines_append(pos)
         lines_append(len(self.raw))
 
         # parse the source and write it
         self.pos = 0
         text = StringIO.StringIO(self.raw)
 
         error = False
         try:
             for atoken in generate_tokens(text.readline):
                 self(*atoken)
         except tokenize.TokenError as ex:
             msg = ex.args[0]
             line = ex.args[1][0]
             self.out.write("%s\n\n*** ERROR: %s%s%s\n" %
                            (colors[token.ERRORTOKEN],
                             msg, self.raw[self.lines[line]:],
                             colors.normal)
                            )
             error = True
         self.out.write(colors.normal+'\n')
         if string_output:
             output = self.out.getvalue()
             self.out = out_old
             return (output, error)
         return (None, error)
 
     def __call__(self, toktype, toktext, (srow,scol), (erow,ecol), line):
         """ Token handler, with syntax highlighting."""
 
         # local shorthands
         colors = self.colors
         owrite = self.out.write
 
         # line separator, so this works across platforms
         linesep = os.linesep
 
         # calculate new positions
         oldpos = self.pos
         newpos = self.lines[srow] + scol
         self.pos = newpos + len(toktext)
 
         # send the original whitespace, if needed
         if newpos > oldpos:
             owrite(self.raw[oldpos:newpos])
 
         # skip indenting tokens
         if toktype in [token.INDENT, token.DEDENT]:
             self.pos = newpos
             return
 
         # map token type to a color group
         if token.LPAR <= toktype and toktype <= token.OP:
             toktype = token.OP
         elif toktype == token.NAME and keyword.iskeyword(toktext):
             toktype = _KEYWORD
         color = colors.get(toktype, colors[_TEXT])
 
         #print '<%s>' % toktext,    # dbg
 
         # Triple quoted strings must be handled carefully so that backtracking
         # in pagers works correctly. We need color terminators on _each_ line.
         if linesep in toktext:
             toktext = toktext.replace(linesep, '%s%s%s' %
                                       (colors.normal,linesep,color))
 
         # send text
         owrite('%s%s%s' % (color,toktext,colors.normal))
 
 def main(argv=None):
     """Run as a command-line script: colorize a python file or stdin using ANSI
     color escapes and print to stdout.
 
     Inputs:
 
       - argv(None): a list of strings like sys.argv[1:] giving the command-line
         arguments. If None, use sys.argv[1:].
     """
 
     usage_msg = """%prog [options] [filename]
 
 Colorize a python file or stdin using ANSI color escapes and print to stdout.
 If no filename is given, or if filename is -, read standard input."""
 
     parser = optparse.OptionParser(usage=usage_msg)
     newopt = parser.add_option
     newopt('-s','--scheme',metavar='NAME',dest='scheme_name',action='store',
            choices=['Linux','LightBG','NoColor'],default=_scheme_default,
            help="give the color scheme to use. Currently only 'Linux'\
  (default) and 'LightBG' and 'NoColor' are implemented (give without\
  quotes)")
 
     opts,args = parser.parse_args(argv)
 
     if len(args) > 1:
         parser.error("you must give at most one filename.")
 
     if len(args) == 0:
         fname = '-' # no filename given; setup to read from stdin
     else:
         fname = args[0]
 
     if fname == '-':
         stream = sys.stdin
     else:
         try:
-            stream = file(fname)
+            stream = open(fname)
         except IOError,msg:
             print >> sys.stderr, msg
             sys.exit(1)
 
     parser = Parser()
 
     # we need nested try blocks because pre-2.5 python doesn't support unified
     # try-except-finally
     try:
         try:
             # write colorized version to stdout
             parser.format(stream.read(),scheme=opts.scheme_name)
         except IOError,msg:
             # if user reads through a pager and quits, don't print traceback
             if msg.args != (32,'Broken pipe'):
                 raise
     finally:
         if stream is not sys.stdin:
             stream.close() # in case a non-handled exception happened above
 
 if __name__ == "__main__":
     main()

IPython/zmq/kernelapp.py

@@ -1,306 +1,306 b''
 """An Application for launching a kernel
 
 Authors
 -------
 * MinRK
 """
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING.txt, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 # Standard library imports.
 import json
 import os
 import sys
 
 # System library imports.
 import zmq
 
 # IPython imports.
 from IPython.core.ultratb import FormattedTB
 from IPython.core.application import (
     BaseIPythonApplication, base_flags, base_aliases, catch_config_error
 )
 from IPython.utils import io
 from IPython.utils.localinterfaces import LOCALHOST
 from IPython.utils.path import filefind
 from IPython.utils.py3compat import str_to_bytes
 from IPython.utils.traitlets import (Any, Instance, Dict, Unicode, Integer, Bool,
                                         DottedObjectName)
 from IPython.utils.importstring import import_item
 # local imports
 from IPython.zmq.entry_point import write_connection_file
 from IPython.zmq.heartbeat import Heartbeat
 from IPython.zmq.parentpoller import ParentPollerUnix, ParentPollerWindows
 from IPython.zmq.session import (
     Session, session_flags, session_aliases, default_secure,
 )
 
 
 #-----------------------------------------------------------------------------
 # Flags and Aliases
 #-----------------------------------------------------------------------------
 
 kernel_aliases = dict(base_aliases)
 kernel_aliases.update({
     'ip' : 'KernelApp.ip',
     'hb' : 'KernelApp.hb_port',
     'shell' : 'KernelApp.shell_port',
     'iopub' : 'KernelApp.iopub_port',
     'stdin' : 'KernelApp.stdin_port',
     'f' : 'KernelApp.connection_file',
     'parent': 'KernelApp.parent',
 })
 if sys.platform.startswith('win'):
     kernel_aliases['interrupt'] = 'KernelApp.interrupt'
 
 kernel_flags = dict(base_flags)
 kernel_flags.update({
     'no-stdout' : (
             {'KernelApp' : {'no_stdout' : True}},
             "redirect stdout to the null device"),
     'no-stderr' : (
             {'KernelApp' : {'no_stderr' : True}},
             "redirect stderr to the null device"),
 })
 
 # inherit flags&aliases for Sessions
 kernel_aliases.update(session_aliases)
 kernel_flags.update(session_flags)
 
 
 
 #-----------------------------------------------------------------------------
 # Application class for starting a Kernel
 #-----------------------------------------------------------------------------
 
 class KernelApp(BaseIPythonApplication):
     name='pykernel'
     aliases = Dict(kernel_aliases)
     flags = Dict(kernel_flags)
     classes = [Session]
     # the kernel class, as an importstring
     kernel_class = DottedObjectName('IPython.zmq.pykernel.Kernel')
     kernel = Any()
     poller = Any() # don't restrict this even though current pollers are all Threads
     heartbeat = Instance(Heartbeat)
     session = Instance('IPython.zmq.session.Session')
     ports = Dict()
     
     # inherit config file name from parent:
     parent_appname = Unicode(config=True)
     def _parent_appname_changed(self, name, old, new):
         if self.config_file_specified:
             # it was manually specified, ignore
             return
         self.config_file_name = new.replace('-','_') + u'_config.py'
         # don't let this count as specifying the config file
         self.config_file_specified = False
         
     # connection info:
     ip = Unicode(LOCALHOST, config=True,
         help="Set the IP or interface on which the kernel will listen.")
     hb_port = Integer(0, config=True, help="set the heartbeat port [default: random]")
     shell_port = Integer(0, config=True, help="set the shell (XREP) port [default: random]")
     iopub_port = Integer(0, config=True, help="set the iopub (PUB) port [default: random]")
     stdin_port = Integer(0, config=True, help="set the stdin (XREQ) port [default: random]")
     connection_file = Unicode('', config=True, 
     help="""JSON file in which to store connection info [default: kernel-<pid>.json]
     
     This file will contain the IP, ports, and authentication key needed to connect
     clients to this kernel. By default, this file will be created in the security-dir
     of the current profile, but can be specified by absolute path.
     """)
 
     # streams, etc.
     no_stdout = Bool(False, config=True, help="redirect stdout to the null device")
     no_stderr = Bool(False, config=True, help="redirect stderr to the null device")
     outstream_class = DottedObjectName('IPython.zmq.iostream.OutStream',
         config=True, help="The importstring for the OutStream factory")
     displayhook_class = DottedObjectName('IPython.zmq.displayhook.ZMQDisplayHook',
         config=True, help="The importstring for the DisplayHook factory")
 
     # polling
     parent = Integer(0, config=True,
         help="""kill this process if its parent dies.  On Windows, the argument
         specifies the HANDLE of the parent process, otherwise it is simply boolean.
         """)
     interrupt = Integer(0, config=True,
         help="""ONLY USED ON WINDOWS
         Interrupt this process when the parent is signalled.
         """)
 
     def init_crash_handler(self):
         # Install minimal exception handling
         sys.excepthook = FormattedTB(mode='Verbose', color_scheme='NoColor',
                                      ostream=sys.__stdout__)
 
     def init_poller(self):
         if sys.platform == 'win32':
             if self.interrupt or self.parent:
                 self.poller = ParentPollerWindows(self.interrupt, self.parent)
         elif self.parent:
             self.poller = ParentPollerUnix()
 
     def _bind_socket(self, s, port):
         iface = 'tcp://%s' % self.ip
         if port <= 0:
             port = s.bind_to_random_port(iface)
         else:
             s.bind(iface + ':%i'%port)
         return port
 
     def load_connection_file(self):
         """load ip/port/hmac config from JSON connection file"""
         try:
             fname = filefind(self.connection_file, ['.', self.profile_dir.security_dir])
         except IOError:
             self.log.debug("Connection file not found: %s", self.connection_file)
             return
         self.log.debug(u"Loading connection file %s", fname)
         with open(fname) as f:
             s = f.read()
         cfg = json.loads(s)
         if self.ip == LOCALHOST and 'ip' in cfg:
             # not overridden by config or cl_args
             self.ip = cfg['ip']
         for channel in ('hb', 'shell', 'iopub', 'stdin'):
             name = channel + '_port'
             if getattr(self, name) == 0 and name in cfg:
                 # not overridden by config or cl_args
                 setattr(self, name, cfg[name])
         if 'key' in cfg:
             self.config.Session.key = str_to_bytes(cfg['key'])
     
     def write_connection_file(self):
         """write connection info to JSON file"""
         if os.path.basename(self.connection_file) == self.connection_file:
             cf = os.path.join(self.profile_dir.security_dir, self.connection_file)
         else:
             cf = self.connection_file
         write_connection_file(cf, ip=self.ip, key=self.session.key,
         shell_port=self.shell_port, stdin_port=self.stdin_port, hb_port=self.hb_port,
         iopub_port=self.iopub_port)
     
     def init_connection_file(self):
         if not self.connection_file:
             self.connection_file = "kernel-%s.json"%os.getpid()
         try:
             self.load_connection_file()
         except Exception:
             self.log.error("Failed to load connection file: %r", self.connection_file, exc_info=True)
             self.exit(1)
     
     def init_sockets(self):
         # Create a context, a session, and the kernel sockets.
         self.log.info("Starting the kernel at pid: %i", os.getpid())
         context = zmq.Context.instance()
         # Uncomment this to try closing the context.
         # atexit.register(context.term)
 
         self.shell_socket = context.socket(zmq.ROUTER)
         self.shell_port = self._bind_socket(self.shell_socket, self.shell_port)
         self.log.debug("shell ROUTER Channel on port: %i"%self.shell_port)
 
         self.iopub_socket = context.socket(zmq.PUB)
         self.iopub_port = self._bind_socket(self.iopub_socket, self.iopub_port)
         self.log.debug("iopub PUB Channel on port: %i"%self.iopub_port)
 
         self.stdin_socket = context.socket(zmq.ROUTER)
         self.stdin_port = self._bind_socket(self.stdin_socket, self.stdin_port)
         self.log.debug("stdin ROUTER Channel on port: %i"%self.stdin_port)
         
         # heartbeat doesn't share context, because it mustn't be blocked
         # by the GIL, which is accessed by libzmq when freeing zero-copy messages
         hb_ctx = zmq.Context()
         self.heartbeat = Heartbeat(hb_ctx, (self.ip, self.hb_port))
         self.hb_port = self.heartbeat.port
         self.log.debug("Heartbeat REP Channel on port: %i"%self.hb_port)
 
         # Helper to make it easier to connect to an existing kernel.
         # set log-level to critical, to make sure it is output
         self.log.critical("To connect another client to this kernel, use:")
         
         basename = os.path.basename(self.connection_file)
         if basename == self.connection_file or \
             os.path.dirname(self.connection_file) == self.profile_dir.security_dir:
             # use shortname
             tail = basename
             if self.profile != 'default':
                 tail += " --profile %s" % self.profile
         else:
             tail = self.connection_file
         self.log.critical("--existing %s", tail)
 
 
         self.ports = dict(shell=self.shell_port, iopub=self.iopub_port,
                                 stdin=self.stdin_port, hb=self.hb_port)
 
     def init_session(self):
         """create our session object"""
         default_secure(self.config)
         self.session = Session(config=self.config, username=u'kernel')
 
     def init_blackhole(self):
         """redirects stdout/stderr to devnull if necessary"""
         if self.no_stdout or self.no_stderr:
-            blackhole = file(os.devnull, 'w')
+            blackhole = open(os.devnull, 'w')
             if self.no_stdout:
                 sys.stdout = sys.__stdout__ = blackhole
             if self.no_stderr:
                 sys.stderr = sys.__stderr__ = blackhole
     
     def init_io(self):
         """Redirect input streams and set a display hook."""
         if self.outstream_class:
             outstream_factory = import_item(str(self.outstream_class))
             sys.stdout = outstream_factory(self.session, self.iopub_socket, u'stdout')
             sys.stderr = outstream_factory(self.session, self.iopub_socket, u'stderr')
         if self.displayhook_class:
             displayhook_factory = import_item(str(self.displayhook_class))
             sys.displayhook = displayhook_factory(self.session, self.iopub_socket)
 
     def init_kernel(self):
         """Create the Kernel object itself"""
         kernel_factory = import_item(str(self.kernel_class))
         self.kernel = kernel_factory(config=self.config, session=self.session,
                                 shell_socket=self.shell_socket,
                                 iopub_socket=self.iopub_socket,
                                 stdin_socket=self.stdin_socket,
                                 log=self.log
         )
         self.kernel.record_ports(self.ports)
 
     @catch_config_error
     def initialize(self, argv=None):
         super(KernelApp, self).initialize(argv)
         self.init_blackhole()
         self.init_connection_file()
         self.init_session()
         self.init_poller()
         self.init_sockets()
         # writing connection file must be *after* init_sockets
         self.write_connection_file()
         self.init_io()
         self.init_kernel()
         # flush stdout/stderr, so that anything written to these streams during
         # initialization do not get associated with the first execution request
         sys.stdout.flush()
         sys.stderr.flush()
 
     def start(self):
         self.heartbeat.start()
         if self.poller is not None:
             self.poller.start()
         try:
             self.kernel.start()
         except KeyboardInterrupt:
             pass