Module codecs :: Class StreamWriter

Class StreamWriter

Codec --+
        |
       StreamWriter

Known Subclasses:

Instance Methods

[hide private]

__init__(self, stream, errors='strict')
Creates a StreamWriter instance.

write(self, object)
Writes the object's contents encoded to self.stream.

writelines(self, list)
Writes the concatenated list of strings to the stream using .write().

reset(self)
Flushes and resets the codec buffers used for keeping state.

__getattr__(self, name, getattr=<built-in function getattr>)
Inherit all other methods from the underlying stream.

__enter__(self)

__exit__(self, type, value, tb)

Inherited from Codec: decode, encode

Method Details

[hide private]

init(self, stream, errors=`'strict'`)
(Constructor)

Creates a StreamWriter instance.

stream must be a file-like object open for writing
(binary) data.

The StreamWriter may use different error handling
schemes by providing the errors keyword argument. These
parameters are predefined:

 'strict' - raise a ValueError (or a subclass)
 'ignore' - ignore the character and continue with the next
 'replace'- replace with a suitable replacement character
 'xmlcharrefreplace' - Replace with the appropriate XML
                       character reference.
 'backslashreplace'  - Replace with backslashed escape
                       sequences (only for encoding).

The set of allowed parameter values can be extended via
register_error.

reset(self)

Flushes and resets the codec buffers used for keeping state.

Calling this method should ensure that the data on the output is put into a clean state, that allows appending of new fresh data without having to rescan the whole stream to recover state.

Class StreamWriter

__init__(self, stream, errors='strict') (Constructor)

reset(self)

init(self, stream, errors=`'strict'`)
(Constructor)