GNU Info

Info Node: (python2.1-lib.info)StringIO

(python2.1-lib.info)StringIO


Next: cStringIO Prev: fpformat Up: String Services
Enter node , (file) or (file)node

Read and write strings as files
===============================

Read and write strings as if they were files.

This module implements a file-like class, `StringIO', that reads and
writes a string buffer (also known as _memory files_).  See the
description of file objects for operations (section Note: File
Objectsfile).

`StringIO([buffer])'
     When a `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 `StringIO' will start empty.

     The `StringIO' object can accept either Unicode or 8-bit strings,
     but mixing the two may take some care.  If both are used, 8-bit
     strings that cannot be interpreted as 7-bit ASCII (i.e., that use
     the 8th bit) will cause a `UnicodeError' to be raised when
     `getvalue()' is called.

The following methods of `StringIO' objects require special mention:

`getvalue()'
     Retrieve the entire contents of the "file" at any time before the
     `StringIO' object's `close()' method is called.  See the note
     above for information about mixing Unicode and 8-bit strings; such
     mixing can cause this method to raise `UnicodeError'.

`close()'
     Free the memory buffer.


automatically generated by info2www version 1.2.2.9