<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<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=
"node130.html" />
<link rel=
"next" href=
"stream-reader-objects.html" />
<meta name='aesop' content='information'
/>
<title>4.9.1.2 StreamWriter Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<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=
"node130.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><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=
"node130.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>
<!--End of Navigation Panel-->
<H3><A NAME=
"SECTION006912000000000000000"></A><A NAME=
"stream-writer-objects"></A>
4.9.1.2 StreamWriter Objects
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.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
1007' xml:id='l2h-
1007'
class=
"class">StreamWriter
</tt></b>(
</nobr></td>
<td><var>stream
</var><big>[
</big><var>, errors
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Constructor for a
<tt class=
"class">StreamWriter
</tt> instance.
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.
<var>stream
</var> must be a file-like object open for writing (binary)
The
<tt class=
"class">StreamWriter
</tt> may implement different error handling
schemes by providing the
<var>errors
</var> keyword argument. These
parameters are predefined:
<LI><code>'strict'
</code> Raise
<tt class=
"exception">ValueError
</tt> (or a subclass);
<LI><code>'ignore'
</code> Ignore the character and continue with the next.
<LI><code>'replace'
</code> Replace with a suitable replacement character
<LI><code>'xmlcharrefreplace'
</code> Replace with the appropriate XML
<LI><code>'backslashreplace'
</code> Replace with backslashed escape sequences.
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.
The set of allowed values for the
<var>errors
</var> argument can
be extended with
<tt class=
"function">register_error()
</tt>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
1008' xml:id='l2h-
1008'
class=
"method">write
</tt></b>(
</nobr></td>
<td><var>object
</var>)
</td></tr></table></dt>
Writes the object's contents encoded to the stream.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
1009' xml:id='l2h-
1009'
class=
"method">writelines
</tt></b>(
</nobr></td>
<td><var>list
</var>)
</td></tr></table></dt>
Writes the concatenated list of strings to the stream (possibly by
reusing the
<tt class=
"method">write()
</tt> method).
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
1010' xml:id='l2h-
1010'
class=
"method">reset
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
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.
In addition to the above methods, the
<tt class=
"class">StreamWriter
</tt> must also
inherit all other methods and attribute from the underlying stream.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<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=
"node130.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><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=
"node130.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>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.
projects / OpenSPARC-T2-SAM / blob