annotate Lib/ArrayIO.py @ 3718:9e544a2c19a2 legacy-trunk

typo
author Guido van Rossum <guido@python.org>
date Wed, 26 Jun 1996 19:27:05 +0000
parents 49ee89e017ab
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
1 """File-like objects that read/write an array buffer.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
2
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
3 This implements (nearly) all stdio methods.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
4
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
5 f = ArrayIO() # ready for writing
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
6 f = ArrayIO(buf) # ready for reading
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
7 f.close() # explicitly release resources held
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
8 flag = f.isatty() # always false
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
9 pos = f.tell() # get current position
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
10 f.seek(pos) # set current position
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
11 f.seek(pos, mode) # mode 0: absolute; 1: relative; 2: relative to EOF
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
12 buf = f.read() # read until EOF
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
13 buf = f.read(n) # read up to n bytes
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
14 buf = f.readline() # read until end of line ('\n') or EOF
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
15 list = f.readlines()# list of f.readline() results until EOF
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
16 f.write(buf) # write at current position
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
17 f.writelines(list) # for line in list: f.write(line)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
18 f.getvalue() # return whole file's contents as a string
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
19
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
20 Notes:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
21 - This is very similar to StringIO. StringIO is faster for reading,
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
22 but ArrayIO is faster for writing.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
23 - ArrayIO uses an array object internally, but all its interfaces
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
24 accept and return strings.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
25 - Using a real file is often faster (but less convenient).
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
26 - fileno() is left unimplemented so that code which uses it triggers
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
27 an exception early.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
28 - Seeking far beyond EOF and then writing will insert real null
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
29 bytes that occupy space in the buffer.
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
30 - There's a simple test set (see end of this file).
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
31 """
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
32
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 import string
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
34 from array import array
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
35
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
36 class ArrayIO:
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 def __init__(self, buf = ''):
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
38 self.buf = array('c', buf)
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 self.pos = 0
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 self.closed = 0
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
41 self.softspace = 0
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
42 def close(self):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
43 if not self.closed:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
44 self.closed = 1
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
45 del self.buf, self.pos
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
46 def isatty(self):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
47 return 0
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
48 def seek(self, pos, mode = 0):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
49 if mode == 1:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
50 pos = pos + self.pos
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
51 elif mode == 2:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
52 pos = pos + len(self.buf)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
53 self.pos = max(0, pos)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
54 def tell(self):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
55 return self.pos
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
56 def read(self, n = -1):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
57 if n < 0:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
58 newpos = len(self.buf)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
59 else:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
60 newpos = min(self.pos+n, len(self.buf))
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
61 r = self.buf[self.pos:newpos].tostring()
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
62 self.pos = newpos
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
63 return r
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 def readline(self):
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
65 i = string.find(self.buf[self.pos:].tostring(), '\n')
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 if i < 0:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 newpos = len(self.buf)
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 else:
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
69 newpos = self.pos+i+1
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 r = self.buf[self.pos:newpos].tostring()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 self.pos = newpos
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 return r
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
73 def readlines(self):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
74 lines = string.splitfields(self.read(), '\n')
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
75 if not lines:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
76 return lines
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
77 for i in range(len(lines)-1):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
78 lines[i] = lines[i] + '\n'
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
79 if not lines[-1]:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
80 del lines[-1]
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
81 return lines
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 def write(self, s):
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 if not s: return
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
84 a = array('c', s)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
85 n = self.pos - len(self.buf)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
86 if n > 0:
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
87 self.buf[len(self.buf):] = array('c', '\0')*n
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
88 newpos = self.pos + len(a)
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
89 self.buf[self.pos:newpos] = a
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 self.pos = newpos
3645
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
91 def writelines(self, list):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
92 self.write(string.joinfields(list, ''))
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
93 def flush(self):
49ee89e017ab Total rewrite
Guido van Rossum <guido@python.org>
parents: 3423
diff changeset
94 pass
3423
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 def getvalue(self):
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 return self.buf.tostring()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
97
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
98
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
99 # A little test suite
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
100
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 def test():
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 import sys
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
103 if sys.argv[1:]:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
104 file = sys.argv[1]
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
105 else:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
106 file = '/etc/passwd'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 lines = open(file, 'r').readlines()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 text = open(file, 'r').read()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 f = ArrayIO()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
110 for line in lines[:-2]:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
111 f.write(line)
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
112 f.writelines(lines[-2:])
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 if f.getvalue() != text:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 raise RuntimeError, 'write failed'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 length = f.tell()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
116 print 'File length =', length
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
117 f.seek(len(lines[0]))
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
118 f.write(lines[1])
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
119 f.seek(0)
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
120 print 'First line =', `f.readline()`
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
121 here = f.tell()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
122 line = f.readline()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
123 print 'Second line =', `line`
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 f.seek(-len(line), 1)
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
125 line2 = f.read(len(line))
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
126 if line != line2:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
127 raise RuntimeError, 'bad result after seek back'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
128 f.seek(len(line2), 1)
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
129 list = f.readlines()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 line = list[-1]
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
131 f.seek(f.tell() - len(line))
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
132 line2 = f.read()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
133 if line != line2:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
134 raise RuntimeError, 'bad result after seek back from EOF'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
135 print 'Read', len(list), 'more lines'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
136 print 'File length =', f.tell()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
137 if f.tell() != length:
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
138 raise RuntimeError, 'bad length'
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
139 f.close()
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
140
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
141 if __name__ == '__main__':
02c9da20b41e *** empty log message ***
Guido van Rossum <guido@python.org>
parents:
diff changeset
142 test()