home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 April / PCWorld_2001-04_cd.bin / Software / TemaCD / webclean / !!!python!!! / BeOpen-Python-2.0.exe / STRINGIO.PY < prev    next >
Encoding:
Python Source  |  2000-10-12  |  5.4 KB  |  194 lines
  1. """File-like objects that read from or write to a string buffer.
  2.  
  3. This implements (nearly) all stdio methods.
  4.  
  5. f = StringIO()      # ready for writing
  6. f = StringIO(buf)   # ready for reading
  7. f.close()           # explicitly release resources held
  8. flag = f.isatty()   # always false
  9. pos = f.tell()      # get current position
  10. f.seek(pos)         # set current position
  11. f.seek(pos, mode)   # mode 0: absolute; 1: relative; 2: relative to EOF
  12. buf = f.read()      # read until EOF
  13. buf = f.read(n)     # read up to n bytes
  14. buf = f.readline()  # read until end of line ('\n') or EOF
  15. list = f.readlines()# list of f.readline() results until EOF
  16. f.truncate([size])  # truncate file at to at most size (default: current pos)
  17. f.write(buf)        # write at current position
  18. f.writelines(list)  # for line in list: f.write(line)
  19. f.getvalue()        # return whole file's contents as a string
  20.  
  21. Notes:
  22. - Using a real file is often faster (but less convenient).
  23. - There's also a much faster implementation in C, called cStringIO, but
  24.   it's not subclassable.
  25. - fileno() is left unimplemented so that code which uses it triggers
  26.   an exception early.
  27. - Seeking far beyond EOF and then writing will insert real null
  28.   bytes that occupy space in the buffer.
  29. - There's a simple test set (see end of this file).
  30. """
  31.  
  32. import errno
  33. import string
  34.  
  35. class StringIO:
  36.     def __init__(self, buf = ''):
  37.         self.buf = buf
  38.         self.len = len(buf)
  39.         self.buflist = []
  40.         self.pos = 0
  41.         self.closed = 0
  42.         self.softspace = 0
  43.     def close(self):
  44.         if not self.closed:
  45.             self.closed = 1
  46.             del self.buf, self.pos
  47.     def isatty(self):
  48.         if self.closed:
  49.             raise ValueError, "I/O operation on closed file"
  50.         return 0
  51.     def seek(self, pos, mode = 0):
  52.         if self.closed:
  53.             raise ValueError, "I/O operation on closed file"
  54.         if self.buflist:
  55.             self.buf = self.buf + string.joinfields(self.buflist, '')
  56.             self.buflist = []
  57.         if mode == 1:
  58.             pos = pos + self.pos
  59.         elif mode == 2:
  60.             pos = pos + self.len
  61.         self.pos = max(0, pos)
  62.     def tell(self):
  63.         if self.closed:
  64.             raise ValueError, "I/O operation on closed file"
  65.         return self.pos
  66.     def read(self, n = -1):
  67.         if self.closed:
  68.             raise ValueError, "I/O operation on closed file"
  69.         if self.buflist:
  70.             self.buf = self.buf + string.joinfields(self.buflist, '')
  71.             self.buflist = []
  72.         if n < 0:
  73.             newpos = self.len
  74.         else:
  75.             newpos = min(self.pos+n, self.len)
  76.         r = self.buf[self.pos:newpos]
  77.         self.pos = newpos
  78.         return r
  79.     def readline(self, length=None):
  80.         if self.closed:
  81.             raise ValueError, "I/O operation on closed file"
  82.         if self.buflist:
  83.             self.buf = self.buf + string.joinfields(self.buflist, '')
  84.             self.buflist = []
  85.         i = string.find(self.buf, '\n', self.pos)
  86.         if i < 0:
  87.             newpos = self.len
  88.         else:
  89.             newpos = i+1
  90.         if length is not None:
  91.             if self.pos + length < newpos:
  92.                 newpos = self.pos + length
  93.         r = self.buf[self.pos:newpos]
  94.         self.pos = newpos
  95.         return r
  96.     def readlines(self, sizehint = 0):
  97.         total = 0
  98.         lines = []
  99.         line = self.readline()
  100.         while line:
  101.             lines.append(line)
  102.             total += len(line)
  103.             if 0 < sizehint <= total:
  104.                 break
  105.             line = self.readline()
  106.         return lines
  107.     def truncate(self, size=None):
  108.         if self.closed:
  109.             raise ValueError, "I/O operation on closed file"
  110.         if size is None:
  111.             size = self.pos
  112.         elif size < 0:
  113.             raise IOError(errno.EINVAL,
  114.                                       "Negative size not allowed")
  115.         elif size < self.pos:
  116.             self.pos = size
  117.         self.buf = self.getvalue()[:size]
  118.     def write(self, s):
  119.         if self.closed:
  120.             raise ValueError, "I/O operation on closed file"
  121.         if not s: return
  122.         if self.pos > self.len:
  123.             self.buflist.append('\0'*(self.pos - self.len))
  124.             self.len = self.pos
  125.         newpos = self.pos + len(s)
  126.         if self.pos < self.len:
  127.             if self.buflist:
  128.                 self.buf = self.buf + string.joinfields(self.buflist, '')
  129.                 self.buflist = []
  130.             self.buflist = [self.buf[:self.pos], s, self.buf[newpos:]]
  131.             self.buf = ''
  132.             if newpos > self.len:
  133.                 self.len = newpos
  134.         else:
  135.             self.buflist.append(s)
  136.             self.len = newpos
  137.         self.pos = newpos
  138.     def writelines(self, list):
  139.         self.write(string.joinfields(list, ''))
  140.     def flush(self):
  141.         if self.closed:
  142.             raise ValueError, "I/O operation on closed file"
  143.     def getvalue(self):
  144.         if self.buflist:
  145.             self.buf = self.buf + string.joinfields(self.buflist, '')
  146.             self.buflist = []
  147.         return self.buf
  148.  
  149.  
  150. # A little test suite
  151.  
  152. def test():
  153.     import sys
  154.     if sys.argv[1:]:
  155.         file = sys.argv[1]
  156.     else:
  157.         file = '/etc/passwd'
  158.     lines = open(file, 'r').readlines()
  159.     text = open(file, 'r').read()
  160.     f = StringIO()
  161.     for line in lines[:-2]:
  162.         f.write(line)
  163.     f.writelines(lines[-2:])
  164.     if f.getvalue() != text:
  165.         raise RuntimeError, 'write failed'
  166.     length = f.tell()
  167.     print 'File length =', length
  168.     f.seek(len(lines[0]))
  169.     f.write(lines[1])
  170.     f.seek(0)
  171.     print 'First line =', `f.readline()`
  172.     here = f.tell()
  173.     line = f.readline()
  174.     print 'Second line =', `line`
  175.     f.seek(-len(line), 1)
  176.     line2 = f.read(len(line))
  177.     if line != line2:
  178.         raise RuntimeError, 'bad result after seek back'
  179.     f.seek(len(line2), 1)
  180.     list = f.readlines()
  181.     line = list[-1]
  182.     f.seek(f.tell() - len(line))
  183.     line2 = f.read()
  184.     if line != line2:
  185.         raise RuntimeError, 'bad result after seek back from EOF'
  186.     print 'Read', len(list), 'more lines'
  187.     print 'File length =', f.tell()
  188.     if f.tell() != length:
  189.         raise RuntimeError, 'bad length'
  190.     f.close()
  191.  
  192. if __name__ == '__main__':
  193.     test()
  194.