annotate Lib/StringIO.py @ 20354:fdc1914406e2 legacy-trunk

Updated, and added a very terse description of PyMac_SetConsoleHandler().
author Jack Jansen <jack.jansen@cwi.nl>
date Tue, 09 Oct 2001 23:14:06 +0000
parents ccec02bfe9a0
children 6b0e16cb65d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11691
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
1 """File-like objects that read from or write to a string buffer.
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
2
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
3 This implements (nearly) all stdio methods.
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
4
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
5 f = StringIO() # ready for writing
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
6 f = StringIO(buf) # ready for reading
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
7 f.close() # explicitly release resources held
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
8 flag = f.isatty() # always false
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
9 pos = f.tell() # get current position
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
10 f.seek(pos) # set current position
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
11 f.seek(pos, mode) # mode 0: absolute; 1: relative; 2: relative to EOF
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
12 buf = f.read() # read until EOF
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
13 buf = f.read(n) # read up to n bytes
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
14 buf = f.readline() # read until end of line ('\n') or EOF
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
15 list = f.readlines()# list of f.readline() results until EOF
14904
b15fce868e50 Add truncate() method to StringIO objects.
Fred Drake <fdrake@acm.org>
parents: 14680
diff changeset
16 f.truncate([size]) # truncate file at to at most size (default: current pos)
11691
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
17 f.write(buf) # write at current position
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
18 f.writelines(list) # for line in list: f.write(line)
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
19 f.getvalue() # return whole file's contents as a string
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
20
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
21 Notes:
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
22 - Using a real file is often faster (but less convenient).
11870
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11691
diff changeset
23 - There's also a much faster implementation in C, called cStringIO, but
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11691
diff changeset
24 it's not subclassable.
11691
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
25 - fileno() is left unimplemented so that code which uses it triggers
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
26 an exception early.
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
27 - Seeking far beyond EOF and then writing will insert real null
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
28 bytes that occupy space in the buffer.
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
29 - There's a simple test set (see end of this file).
e34991022571 Mass patch by Ka-Ping Yee:
Guido van Rossum <guido@python.org>
parents: 9016
diff changeset
30 """
1680
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
31
15541
58bc99e012a8 Accept Finn Bock's patch #102208 to hardcode EINVAL to 22 when errno
Barry Warsaw <barry@python.org>
parents: 15174
diff changeset
32 try:
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
33 from errno import EINVAL
15541
58bc99e012a8 Accept Finn Bock's patch #102208 to hardcode EINVAL to 22 when errno
Barry Warsaw <barry@python.org>
parents: 15174
diff changeset
34 except ImportError:
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
35 EINVAL = 22
15541
58bc99e012a8 Accept Finn Bock's patch #102208 to hardcode EINVAL to 22 when errno
Barry Warsaw <barry@python.org>
parents: 15174
diff changeset
36
16070
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 15555
diff changeset
37 __all__ = ["StringIO"]
b5345e99596b added __all__ lists to a number of Python modules
Skip Montanaro <skip@pobox.com>
parents: 15555
diff changeset
38
1680
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 class StringIO:
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
40 def __init__(self, buf = ''):
20060
ccec02bfe9a0 StringIO patch #462596: let's [c]StringIO accept read buffers on
Marc-André Lemburg <mal@egenix.com>
parents: 20032
diff changeset
41 # Force self.buf to be a string
ccec02bfe9a0 StringIO patch #462596: let's [c]StringIO accept read buffers on
Marc-André Lemburg <mal@egenix.com>
parents: 20032
diff changeset
42 self.buf = str(buf)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
43 self.len = len(buf)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
44 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
45 self.pos = 0
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
46 self.closed = 0
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
47 self.softspace = 0
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
48
20032
5c9a955ef17c __iter__(): New method so that StringIO's can participate in the
Barry Warsaw <barry@python.org>
parents: 16522
diff changeset
49 def __iter__(self):
5c9a955ef17c __iter__(): New method so that StringIO's can participate in the
Barry Warsaw <barry@python.org>
parents: 16522
diff changeset
50 return iter(self.readline, '')
5c9a955ef17c __iter__(): New method so that StringIO's can participate in the
Barry Warsaw <barry@python.org>
parents: 16522
diff changeset
51
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
52 def close(self):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
53 if not self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
54 self.closed = 1
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
55 del self.buf, self.pos
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
56
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
57 def isatty(self):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
58 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
59 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
60 return 0
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
61
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
62 def seek(self, pos, mode = 0):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
63 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
64 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
65 if self.buflist:
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
66 self.buf += ''.join(self.buflist)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
67 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
68 if mode == 1:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
69 pos += self.pos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
70 elif mode == 2:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
71 pos += self.len
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
72 self.pos = max(0, pos)
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
73
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
74 def tell(self):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
75 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
76 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
77 return self.pos
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
78
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
79 def read(self, n = -1):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
80 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
81 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
82 if self.buflist:
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
83 self.buf += ''.join(self.buflist)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
84 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
85 if n < 0:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
86 newpos = self.len
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
87 else:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
88 newpos = min(self.pos+n, self.len)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
89 r = self.buf[self.pos:newpos]
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
90 self.pos = newpos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
91 return r
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
92
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
93 def readline(self, length=None):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
94 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
95 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
96 if self.buflist:
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
97 self.buf += ''.join(self.buflist)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
98 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
99 i = self.buf.find('\n', self.pos)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
100 if i < 0:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
101 newpos = self.len
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
102 else:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
103 newpos = i+1
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
104 if length is not None:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
105 if self.pos + length < newpos:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
106 newpos = self.pos + length
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
107 r = self.buf[self.pos:newpos]
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
108 self.pos = newpos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
109 return r
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
110
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
111 def readlines(self, sizehint = 0):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
112 total = 0
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
113 lines = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
114 line = self.readline()
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
115 while line:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
116 lines.append(line)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
117 total += len(line)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
118 if 0 < sizehint <= total:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
119 break
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
120 line = self.readline()
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
121 return lines
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
122
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
123 def truncate(self, size=None):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
124 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
125 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
126 if size is None:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
127 size = self.pos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
128 elif size < 0:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
129 raise IOError(EINVAL, "Negative size not allowed")
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
130 elif size < self.pos:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
131 self.pos = size
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
132 self.buf = self.getvalue()[:size]
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
133
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
134 def write(self, s):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
135 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
136 raise ValueError, "I/O operation on closed file"
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
137 if not s: return
20060
ccec02bfe9a0 StringIO patch #462596: let's [c]StringIO accept read buffers on
Marc-André Lemburg <mal@egenix.com>
parents: 20032
diff changeset
138 # Force s to be a string
ccec02bfe9a0 StringIO patch #462596: let's [c]StringIO accept read buffers on
Marc-André Lemburg <mal@egenix.com>
parents: 20032
diff changeset
139 s = str(s)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
140 if self.pos > self.len:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
141 self.buflist.append('\0'*(self.pos - self.len))
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
142 self.len = self.pos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
143 newpos = self.pos + len(s)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
144 if self.pos < self.len:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
145 if self.buflist:
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
146 self.buf += ''.join(self.buflist)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
147 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
148 self.buflist = [self.buf[:self.pos], s, self.buf[newpos:]]
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
149 self.buf = ''
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
150 if newpos > self.len:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
151 self.len = newpos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
152 else:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
153 self.buflist.append(s)
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
154 self.len = newpos
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
155 self.pos = newpos
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
156
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
157 def writelines(self, list):
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
158 self.write(''.join(list))
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
159
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
160 def flush(self):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
161 if self.closed:
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
162 raise ValueError, "I/O operation on closed file"
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
163
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
164 def getvalue(self):
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
165 if self.buflist:
16522
f42799c68929 Remove silly EMPTYSTRING global. Saves a global lookup.
Marc-André Lemburg <mal@egenix.com>
parents: 16070
diff changeset
166 self.buf += ''.join(self.buflist)
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
167 self.buflist = []
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
168 return self.buf
1680
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
169
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
170
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
171 # A little test suite
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
172
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
173 def test():
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
174 import sys
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
175 if sys.argv[1:]:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
176 file = sys.argv[1]
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
177 else:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
178 file = '/etc/passwd'
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
179 lines = open(file, 'r').readlines()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
180 text = open(file, 'r').read()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
181 f = StringIO()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
182 for line in lines[:-2]:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
183 f.write(line)
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
184 f.writelines(lines[-2:])
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
185 if f.getvalue() != text:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
186 raise RuntimeError, 'write failed'
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
187 length = f.tell()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
188 print 'File length =', length
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
189 f.seek(len(lines[0]))
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
190 f.write(lines[1])
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
191 f.seek(0)
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
192 print 'First line =', `f.readline()`
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
193 here = f.tell()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
194 line = f.readline()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
195 print 'Second line =', `line`
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
196 f.seek(-len(line), 1)
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
197 line2 = f.read(len(line))
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
198 if line != line2:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
199 raise RuntimeError, 'bad result after seek back'
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
200 f.seek(len(line2), 1)
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
201 list = f.readlines()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
202 line = list[-1]
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
203 f.seek(f.tell() - len(line))
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
204 line2 = f.read()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
205 if line != line2:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
206 raise RuntimeError, 'bad result after seek back from EOF'
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
207 print 'Read', len(list), 'more lines'
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
208 print 'File length =', f.tell()
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
209 if f.tell() != length:
15555
f72345b43662 Untabify! (Barry, this is gonna cost you a bottle of wine! ;)
Fred Drake <fdrake@acm.org>
parents: 15542
diff changeset
210 raise RuntimeError, 'bad length'
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
211 f.close()
1680
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
212
0a60460e99f0 Two new generally useful modules: types defines names for all built-in types,
Guido van Rossum <guido@python.org>
parents:
diff changeset
213 if __name__ == '__main__':
15542
6359480106ec Change the file's indentation from tabs to 4 spaces per level.
Barry Warsaw <barry@python.org>
parents: 15541
diff changeset
214 test()