| \section{Standard Module \module{StringIO}} |
| \label{module-StringIO} |
| |
| \stmodindex{StringIO} |
| |
| This module implements a file-like class, \class{StringIO}, |
| that reads and writes a string buffer (also known as \emph{memory |
| files}). See the description on file objects for operations. |
| |
| \begin{classdesc}{StringIO}{\optional{buffer}} |
| When a \class{StringIO} object is created, it can be initialized |
| to an existing string by passing the string to the constructor. |
| If no string is given, the \class{StringIO} will start empty. |
| \end{classdesc} |
| |
| The following methods of \class{StringIO} objects require special |
| mention: |
| |
| \begin{methoddesc}{getvalue}{} |
| Retrieve the entire contents of the ``file'' at any time before the |
| \class{StringIO} object's \method{close()} method is called. |
| \end{methoddesc} |
| |
| \begin{methoddesc}{close}{} |
| Free the memory buffer. |
| \end{methoddesc} |