Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="module-cStringIO.html" /> | |
13 | <link rel="prev" href="module-fpformat.html" /> | |
14 | <link rel="parent" href="strings.html" /> | |
15 | <link rel="next" href="module-cStringIO.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>4.6 StringIO -- Read and write strings as files</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="4.5 fpformat " | |
25 | href="module-fpformat.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="4. String Services" | |
28 | href="strings.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="4.7 cStringIO " | |
31 | href="module-cStringIO.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="module-fpformat.html">4.5 fpformat </A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="strings.html">4. String Services</A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="module-cStringIO.html">4.7 cStringIO </A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H1><A NAME="SECTION006600000000000000000"> | |
56 | 4.6 <tt class="module">StringIO</tt> -- | |
57 | Read and write strings as files</A> | |
58 | </H1> | |
59 | ||
60 | <P> | |
61 | <A NAME="module-StringIO"></A> | |
62 | ||
63 | <P> | |
64 | This module implements a file-like class, <tt class="class">StringIO</tt>, | |
65 | that reads and writes a string buffer (also known as <em>memory | |
66 | files</em>). See the description of file objects for operations (section | |
67 | <A href="bltin-file-objects.html#bltin-file-objects">2.3.9</A>). | |
68 | ||
69 | <P> | |
70 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
71 | <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-954' xml:id='l2h-954' class="class">StringIO</tt></b>(</nobr></td> | |
72 | <td><var></var><big>[</big><var>buffer</var><big>]</big><var></var>)</td></tr></table></dt> | |
73 | <dd> | |
74 | When a <tt class="class">StringIO</tt> object is created, it can be initialized | |
75 | to an existing string by passing the string to the constructor. | |
76 | If no string is given, the <tt class="class">StringIO</tt> will start empty. | |
77 | In both cases, the initial file position starts at zero. | |
78 | ||
79 | <P> | |
80 | The <tt class="class">StringIO</tt> object can accept either Unicode or 8-bit | |
81 | strings, but mixing the two may take some care. If both are used, | |
82 | 8-bit strings that cannot be interpreted as 7-bit ASCII (that | |
83 | use the 8th bit) will cause a <tt class="exception">UnicodeError</tt> to be raised | |
84 | when <tt class="method">getvalue()</tt> is called. | |
85 | </dl> | |
86 | ||
87 | <P> | |
88 | The following methods of <tt class="class">StringIO</tt> objects require special | |
89 | mention: | |
90 | ||
91 | <P> | |
92 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
93 | <td><nobr><b><tt id='l2h-955' xml:id='l2h-955' class="method">getvalue</tt></b>(</nobr></td> | |
94 | <td><var></var>)</td></tr></table></dt> | |
95 | <dd> | |
96 | Retrieve the entire contents of the ``file'' at any time before the | |
97 | <tt class="class">StringIO</tt> object's <tt class="method">close()</tt> method is called. See the | |
98 | note above for information about mixing Unicode and 8-bit strings; | |
99 | such mixing can cause this method to raise <tt class="exception">UnicodeError</tt>. | |
100 | </dl> | |
101 | ||
102 | <P> | |
103 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
104 | <td><nobr><b><tt id='l2h-956' xml:id='l2h-956' class="method">close</tt></b>(</nobr></td> | |
105 | <td><var></var>)</td></tr></table></dt> | |
106 | <dd> | |
107 | Free the memory buffer. | |
108 | </dl> | |
109 | ||
110 | <P> | |
111 | ||
112 | <DIV CLASS="navigation"> | |
113 | <div class='online-navigation'> | |
114 | <p></p><hr /> | |
115 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
116 | <tr> | |
117 | <td class='online-navigation'><a rel="prev" title="4.5 fpformat " | |
118 | href="module-fpformat.html"><img src='../icons/previous.png' | |
119 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
120 | <td class='online-navigation'><a rel="parent" title="4. String Services" | |
121 | href="strings.html"><img src='../icons/up.png' | |
122 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
123 | <td class='online-navigation'><a rel="next" title="4.7 cStringIO " | |
124 | href="module-cStringIO.html"><img src='../icons/next.png' | |
125 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
126 | <td align="center" width="100%">Python Library Reference</td> | |
127 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
128 | href="contents.html"><img src='../icons/contents.png' | |
129 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
130 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
131 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
132 | <td class='online-navigation'><a rel="index" title="Index" | |
133 | href="genindex.html"><img src='../icons/index.png' | |
134 | border='0' height='32' alt='Index' width='32' /></A></td> | |
135 | </tr></table> | |
136 | <div class='online-navigation'> | |
137 | <b class="navlabel">Previous:</b> | |
138 | <a class="sectref" rel="prev" href="module-fpformat.html">4.5 fpformat </A> | |
139 | <b class="navlabel">Up:</b> | |
140 | <a class="sectref" rel="parent" href="strings.html">4. String Services</A> | |
141 | <b class="navlabel">Next:</b> | |
142 | <a class="sectref" rel="next" href="module-cStringIO.html">4.7 cStringIO </A> | |
143 | </div> | |
144 | </div> | |
145 | <hr /> | |
146 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
147 | </DIV> | |
148 | <!--End of Navigation Panel--> | |
149 | <ADDRESS> | |
150 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
151 | </ADDRESS> | |
152 | </BODY> | |
153 | </HTML> |