<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.gif" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<LINK rel="next" href="stream-reader-objects.html">
<LINK rel="prev" href="codec-objects.html">
<LINK rel="parent" href="node121.html">
<LINK rel="next" href="stream-reader-objects.html">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name='aesop' content='information' />
<META name="description" content="StreamWriter Objects ">
<META name="keywords" content="lib">
<META name="resource-type" content="document">
<META name="distribution" content="global">
<title>4.9.1.2 StreamWriter Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="4.9.1.1 Codec Objects"
href="codec-objects.html"><img src='../icons/previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4.9.1 Codec Base Classes"
href="node121.html"><img src='../icons/up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4.9.1.3 StreamReader Objects"
href="stream-reader-objects.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
href="contents.html"><img src='../icons/contents.png'
border='0' height='32' alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
href="genindex.html"><img src='../icons/index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="codec-objects.html">4.9.1.1 Codec Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node121.html">4.9.1 Codec Base Classes</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="stream-reader-objects.html">4.9.1.3 StreamReader Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION006912000000000000000"><!--x--></A><A NAME="stream-writer-objects"><!--z--></A>
<BR>
4.9.1.2 StreamWriter Objects
</H3>
<P>
The <tt class="class">StreamWriter</tt> class is a subclass of <tt class="class">Codec</tt> and
defines the following methods which every stream writer must define in
order to be compatible to the Python codec registry.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-966' class="class">StreamWriter</tt></b>(</nobr></td>
<td><var>stream</var><big>[</big><var>, errors</var><big>]</big>)</td></tr></table></dt>
<dd>
Constructor for a <tt class="class">StreamWriter</tt> instance.
<P>
All stream writers must provide this constructor interface. They are
free to add additional keyword arguments, but only the ones defined
here are used by the Python codec registry.
<P>
<var>stream</var> must be a file-like object open for writing (binary)
data.
<P>
The <tt class="class">StreamWriter</tt> may implement different error handling
schemes by providing the <var>errors</var> keyword argument. These
parameters are predefined:
<P>
<UL>
<LI><code>'strict'</code> Raise <tt class="exception">ValueError</tt> (or a subclass);
this is the default.
</LI>
<LI><code>'ignore'</code> Ignore the character and continue with the next.
</LI>
<LI><code>'replace'</code> Replace with a suitable replacement character
</LI>
<LI><code>'xmlcharrefreplace'</code> Replace with the appropriate XML
character reference
</LI>
<LI><code>'backslashreplace'</code> Replace with backslashed escape sequences.
</LI>
</UL>
<P>
The <var>errors</var> argument will be assigned to an attribute of the
same name. Assigning to this attribute makes it possible to switch
between different error handling strategies during the lifetime
of the <tt class="class">StreamWriter</tt> object.
<P>
The set of allowed values for the <var>errors</var> argument can
be extended with <tt class="function">register_error()</tt>.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-967' class="method">write</tt></b>(</nobr></td>
<td><var>object</var>)</td></tr></table></dt>
<dd>
Writes the object's contents encoded to the stream.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-968' class="method">writelines</tt></b>(</nobr></td>
<td><var>list</var>)</td></tr></table></dt>
<dd>
Writes the concatenated list of strings to the stream (possibly by
reusing the <tt class="method">write()</tt> method).
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-969' class="method">reset</tt></b>(</nobr></td>
<td>)</td></tr></table></dt>
<dd>
Flushes and resets the codec buffers used for keeping state.
<P>
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.
</dl>
<P>
In addition to the above methods, the <tt class="class">StreamWriter</tt> must also
inherit all other methods and attribute from the underlying stream.
<P>
<DIV CLASS="navigation">
<div class='online-navigation'><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="4.9.1.1 Codec Objects"
rel="prev" title="4.9.1.1 Codec Objects"
href="codec-objects.html"><img src='../icons/previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4.9.1 Codec Base Classes"
rel="parent" title="4.9.1 Codec Base Classes"
href="node121.html"><img src='../icons/up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4.9.1.3 StreamReader Objects"
rel="next" title="4.9.1.3 StreamReader Objects"
href="stream-reader-objects.html"><img src='../icons/next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
rel="contents" title="Table of Contents"
href="contents.html"><img src='../icons/contents.png'
border='0' height='32' alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
border='0' height='32' alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
rel="index" title="Index"
href="genindex.html"><img src='../icons/index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="codec-objects.html">4.9.1.1 Codec Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="node121.html">4.9.1 Codec Base Classes</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="stream-reader-objects.html">4.9.1.3 StreamReader Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.3.4, documentation updated on May 20, 2004.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
