[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / writer-impls.html

<!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.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="prev" href="writer-interface.html" />
<link rel="parent" href="module-formatter.html" />
<link rel="next" href="module-email.html" />
<meta name='aesop' content='information' />
<title>12.1.4 Writer Implementations </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.1.3 The Writer Interface"
  href="writer-interface.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="12.1 formatter  "
  href="module-formatter.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="12.2 email  "
  href="module-email.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="writer-interface.html">12.1.3 The Writer Interface</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-formatter.html">12.1 formatter  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-email.html">12.2 email  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0014140000000000000000"></A><A NAME="writer-impls"></A>
<BR>
12.1.4 Writer Implementations 
</H2>

<P>
Three implementations of the writer object interface are provided as
examples by this module.  Most applications will need to derive new
writer classes from the <tt class="class">NullWriter</tt> class.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3824' xml:id='l2h-3824' class="class">NullWriter</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
A writer which only provides the interface definition; no actions are
taken on any methods.  This should be the base class for all writers
which do not need to inherit any implementation methods.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3825' xml:id='l2h-3825' class="class">AbstractWriter</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
A writer which can be used in debugging formatters, but not much
else.  Each method simply announces itself by printing its name and
arguments on standard output.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-3826' xml:id='l2h-3826' class="class">DumbWriter</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>file</var><big>[</big><var>, maxcol<code> = 72</code></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Simple writer class which writes output on the file object passed in
as <var>file</var> or, if <var>file</var> is omitted, on standard output.  The
output is simply word-wrapped to the number of columns specified by
<var>maxcol</var>.  This class is suitable for reflowing a sequence of
paragraphs.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.1.3 The Writer Interface"
  href="writer-interface.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="12.1 formatter  "
  href="module-formatter.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="12.2 email  "
  href="module-email.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="writer-interface.html">12.1.3 The Writer Interface</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-formatter.html">12.1 formatter  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-email.html">12.2 email  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</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>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="prev" href="writer-interface.html" />
	13	<link rel="parent" href="module-formatter.html" />
	14	<link rel="next" href="module-email.html" />
	15	<meta name='aesop' content='information' />
	16	<title>12.1.4 Writer Implementations </title>
	17	</head>
	18	<body>
	19	<DIV CLASS="navigation">
	20	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	21	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	22	<tr>
	23	<td class='online-navigation'><a rel="prev" title="12.1.3 The Writer Interface"
	24	href="writer-interface.html"><img src='../icons/previous.png'
	25	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	26	<td class='online-navigation'><a rel="parent" title="12.1 formatter "
	27	href="module-formatter.html"><img src='../icons/up.png'
	28	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	29	<td class='online-navigation'><a rel="next" title="12.2 email "
	30	href="module-email.html"><img src='../icons/next.png'
	31	border='0' height='32' alt='Next Page' width='32' /></A></td>
	32	<td align="center" width="100%">Python Library Reference</td>
	33	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	34	href="contents.html"><img src='../icons/contents.png'
	35	border='0' height='32' alt='Contents' width='32' /></A></td>
	36	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	37	border='0' height='32' alt='Module Index' width='32' /></a></td>
	38	<td class='online-navigation'><a rel="index" title="Index"
	39	href="genindex.html"><img src='../icons/index.png'
	40	border='0' height='32' alt='Index' width='32' /></A></td>
	41	</tr></table>
	42	<div class='online-navigation'>
	43	<b class="navlabel">Previous:</b>
	44	<a class="sectref" rel="prev" href="writer-interface.html">12.1.3 The Writer Interface</A>
	45	<b class="navlabel">Up:</b>
	46	<a class="sectref" rel="parent" href="module-formatter.html">12.1 formatter </A>
	47	<b class="navlabel">Next:</b>
	48	<a class="sectref" rel="next" href="module-email.html">12.2 email </A>
	49	</div>
	50	<hr /></div>
	51	</DIV>
	52	<!--End of Navigation Panel-->
	53
	54	<H2><A NAME="SECTION0014140000000000000000"></A><A NAME="writer-impls"></A>
	55	<BR>
	56	12.1.4 Writer Implementations
	57	</H2>
	58
	59	<P>
	60	Three implementations of the writer object interface are provided as
	61	examples by this module. Most applications will need to derive new
	62	writer classes from the <tt class="class">NullWriter</tt> class.
	63
	64	<P>
65	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
66	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3824' xml:id='l2h-3824' class="class">NullWriter</tt></b>(</nobr></td>
67	<td><var></var>)</td></tr></table></dt>
68	<dd>
69	A writer which only provides the interface definition; no actions are
70	taken on any methods. This should be the base class for all writers
71	which do not need to inherit any implementation methods.
72	</dl>
73
74	<P>
75	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
76	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3825' xml:id='l2h-3825' class="class">AbstractWriter</tt></b>(</nobr></td>
77	<td><var></var>)</td></tr></table></dt>
78	<dd>
79	A writer which can be used in debugging formatters, but not much
80	else. Each method simply announces itself by printing its name and
81	arguments on standard output.
82	</dl>
83
84	<P>
85	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
86	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3826' xml:id='l2h-3826' class="class">DumbWriter</tt></b>(</nobr></td>
87	<td><var></var><big>[</big><var>file</var><big>[</big><var>, maxcol<code> = 72</code></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
88	<dd>
89	Simple writer class which writes output on the file object passed in
90	as <var>file</var> or, if <var>file</var> is omitted, on standard output. The
91	output is simply word-wrapped to the number of columns specified by
92	<var>maxcol</var>. This class is suitable for reflowing a sequence of
93	paragraphs.
94	</dl>
95
96	<P>
97
98	<DIV CLASS="navigation">
99	<div class='online-navigation'>
100	<p></p><hr />
101	<table align="center" width="100%" cellpadding="0" cellspacing="2">
102	<tr>
103	<td class='online-navigation'><a rel="prev" title="12.1.3 The Writer Interface"
104	href="writer-interface.html"><img src='../icons/previous.png'
105	border='0' height='32' alt='Previous Page' width='32' /></A></td>
106	<td class='online-navigation'><a rel="parent" title="12.1 formatter "
107	href="module-formatter.html"><img src='../icons/up.png'
108	border='0' height='32' alt='Up One Level' width='32' /></A></td>
109	<td class='online-navigation'><a rel="next" title="12.2 email "
110	href="module-email.html"><img src='../icons/next.png'
111	border='0' height='32' alt='Next Page' width='32' /></A></td>
112	<td align="center" width="100%">Python Library Reference</td>
113	<td class='online-navigation'><a rel="contents" title="Table of Contents"
114	href="contents.html"><img src='../icons/contents.png'
115	border='0' height='32' alt='Contents' width='32' /></A></td>
116	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
117	border='0' height='32' alt='Module Index' width='32' /></a></td>
118	<td class='online-navigation'><a rel="index" title="Index"
119	href="genindex.html"><img src='../icons/index.png'
120	border='0' height='32' alt='Index' width='32' /></A></td>
121	</tr></table>
122	<div class='online-navigation'>
123	<b class="navlabel">Previous:</b>
124	<a class="sectref" rel="prev" href="writer-interface.html">12.1.3 The Writer Interface</A>
125	<b class="navlabel">Up:</b>
126	<a class="sectref" rel="parent" href="module-formatter.html">12.1 formatter </A>
127	<b class="navlabel">Next:</b>
128	<a class="sectref" rel="next" href="module-email.html">12.2 email </A>
129	</div>
130	</div>
131	<hr />
132	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
133	</DIV>
134	<!--End of Navigation Panel-->
135	<ADDRESS>
136	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
137	</ADDRESS>
138	</BODY>
139	</HTML>