1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
<html xmlns="http://www.w3.org/1999/xhtml">
7
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9
<title>33.1. formatter — Generic output formatting — Python 3.5.1 documentation</title>
11
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
12
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
<script type="text/javascript">
15
var DOCUMENTATION_OPTIONS = {
18
COLLAPSE_INDEX: false,
23
<script type="text/javascript" src="../_static/jquery.js"></script>
24
<script type="text/javascript" src="../_static/underscore.js"></script>
25
<script type="text/javascript" src="../_static/doctools.js"></script>
26
<script type="text/javascript" src="../_static/sidebar.js"></script>
27
<link rel="search" type="application/opensearchdescription+xml"
28
title="Search within Python 3.5.1 documentation"
29
href="../_static/opensearch.xml"/>
30
<link rel="author" title="About these documents" href="../about.html" />
31
<link rel="copyright" title="Copyright" href="../copyright.html" />
32
<link rel="top" title="Python 3.5.1 documentation" href="../contents.html" />
33
<link rel="up" title="33. Miscellaneous Services" href="misc.html" />
34
<link rel="next" title="34. MS Windows Specific Services" href="windows.html" />
35
<link rel="prev" title="33. Miscellaneous Services" href="misc.html" />
36
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
37
<script type="text/javascript" src="../_static/copybutton.js"></script>
38
<script type="text/javascript" src="../_static/version_switch.js"></script>
43
<body role="document">
44
<div class="related" role="navigation" aria-label="related navigation">
47
<li class="right" style="margin-right: 10px">
48
<a href="../genindex.html" title="General Index"
49
accesskey="I">index</a></li>
51
<a href="../py-modindex.html" title="Python Module Index"
54
<a href="windows.html" title="34. MS Windows Specific Services"
55
accesskey="N">next</a> |</li>
57
<a href="misc.html" title="33. Miscellaneous Services"
58
accesskey="P">previous</a> |</li>
59
<li><img src="../_static/py.png" alt=""
60
style="vertical-align: middle; margin-top: -1px"/></li>
61
<li><a href="https://www.python.org/">Python</a> »</li>
63
<span class="version_switcher_placeholder">3.5.1</span>
64
<a href="../index.html">Documentation </a> »
67
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
68
<li class="nav-item nav-item-2"><a href="misc.html" accesskey="U">33. Miscellaneous Services</a> »</li>
72
<div class="document">
73
<div class="documentwrapper">
74
<div class="bodywrapper">
75
<div class="body" role="main">
77
<div class="section" id="module-formatter">
78
<span id="formatter-generic-output-formatting"></span><h1>33.1. <a class="reference internal" href="#module-formatter" title="formatter: Generic output formatter and device interface. (deprecated)"><code class="xref py py-mod docutils literal"><span class="pre">formatter</span></code></a> — Generic output formatting<a class="headerlink" href="#module-formatter" title="Permalink to this headline">¶</a></h1>
79
<div class="deprecated">
80
<p><span class="versionmodified">Deprecated since version 3.4: </span>Due to lack of usage, the formatter module has been deprecated.</p>
82
<p>This module supports two interface definitions, each with multiple
83
implementations: The <em>formatter</em> interface, and the <em>writer</em> interface which is
84
required by the formatter interface.</p>
85
<p>Formatter objects transform an abstract flow of formatting events into specific
86
output events on writer objects. Formatters manage several stack structures to
87
allow various properties of a writer object to be changed and restored; writers
88
need not be able to handle relative changes nor any sort of “change back”
89
operation. Specific writer properties which may be controlled via formatter
90
objects are horizontal alignment, font, and left margin indentations. A
91
mechanism is provided which supports providing arbitrary, non-exclusive style
92
settings to a writer as well. Additional interfaces facilitate formatting
93
events which are not reversible, such as paragraph separation.</p>
94
<p>Writer objects encapsulate device interfaces. Abstract devices, such as file
95
formats, are supported as well as physical devices. The provided
96
implementations all work with abstract devices. The interface makes available
97
mechanisms for setting the properties which formatter objects manage and
98
inserting data into the output.</p>
99
<div class="section" id="the-formatter-interface">
100
<span id="formatter-interface"></span><h2>33.1.1. The Formatter Interface<a class="headerlink" href="#the-formatter-interface" title="Permalink to this headline">¶</a></h2>
101
<p>Interfaces to create formatters are dependent on the specific formatter class
102
being instantiated. The interfaces described below are the required interfaces
103
which all formatters must support once initialized.</p>
104
<p>One data element is defined at the module level:</p>
106
<dt id="formatter.AS_IS">
107
<code class="descclassname">formatter.</code><code class="descname">AS_IS</code><a class="headerlink" href="#formatter.AS_IS" title="Permalink to this definition">¶</a></dt>
108
<dd><p>Value which can be used in the font specification passed to the <code class="docutils literal"><span class="pre">push_font()</span></code>
109
method described below, or as the new value to any other <code class="docutils literal"><span class="pre">push_property()</span></code>
110
method. Pushing the <code class="docutils literal"><span class="pre">AS_IS</span></code> value allows the corresponding <code class="docutils literal"><span class="pre">pop_property()</span></code>
111
method to be called without having to track whether the property was changed.</p>
114
<p>The following attributes are defined for formatter instance objects:</p>
115
<dl class="attribute">
116
<dt id="formatter.formatter.writer">
117
<code class="descclassname">formatter.</code><code class="descname">writer</code><a class="headerlink" href="#formatter.formatter.writer" title="Permalink to this definition">¶</a></dt>
118
<dd><p>The writer instance with which the formatter interacts.</p>
122
<dt id="formatter.formatter.end_paragraph">
123
<code class="descclassname">formatter.</code><code class="descname">end_paragraph</code><span class="sig-paren">(</span><em>blanklines</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.end_paragraph" title="Permalink to this definition">¶</a></dt>
124
<dd><p>Close any open paragraphs and insert at least <em>blanklines</em> before the next
129
<dt id="formatter.formatter.add_line_break">
130
<code class="descclassname">formatter.</code><code class="descname">add_line_break</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.add_line_break" title="Permalink to this definition">¶</a></dt>
131
<dd><p>Add a hard line break if one does not already exist. This does not break the
132
logical paragraph.</p>
136
<dt id="formatter.formatter.add_hor_rule">
137
<code class="descclassname">formatter.</code><code class="descname">add_hor_rule</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.add_hor_rule" title="Permalink to this definition">¶</a></dt>
138
<dd><p>Insert a horizontal rule in the output. A hard break is inserted if there is
139
data in the current paragraph, but the logical paragraph is not broken. The
140
arguments and keywords are passed on to the writer’s <code class="xref py py-meth docutils literal"><span class="pre">send_line_break()</span></code>
145
<dt id="formatter.formatter.add_flowing_data">
146
<code class="descclassname">formatter.</code><code class="descname">add_flowing_data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.add_flowing_data" title="Permalink to this definition">¶</a></dt>
147
<dd><p>Provide data which should be formatted with collapsed whitespace. Whitespace
148
from preceding and successive calls to <a class="reference internal" href="#formatter.formatter.add_flowing_data" title="formatter.formatter.add_flowing_data"><code class="xref py py-meth docutils literal"><span class="pre">add_flowing_data()</span></code></a> is considered as
149
well when the whitespace collapse is performed. The data which is passed to
150
this method is expected to be word-wrapped by the output device. Note that any
151
word-wrapping still must be performed by the writer object due to the need to
152
rely on device and font information.</p>
156
<dt id="formatter.formatter.add_literal_data">
157
<code class="descclassname">formatter.</code><code class="descname">add_literal_data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.add_literal_data" title="Permalink to this definition">¶</a></dt>
158
<dd><p>Provide data which should be passed to the writer unchanged. Whitespace,
159
including newline and tab characters, are considered legal in the value of
164
<dt id="formatter.formatter.add_label_data">
165
<code class="descclassname">formatter.</code><code class="descname">add_label_data</code><span class="sig-paren">(</span><em>format</em>, <em>counter</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.add_label_data" title="Permalink to this definition">¶</a></dt>
166
<dd><p>Insert a label which should be placed to the left of the current left margin.
167
This should be used for constructing bulleted or numbered lists. If the
168
<em>format</em> value is a string, it is interpreted as a format specification for
169
<em>counter</em>, which should be an integer. The result of this formatting becomes the
170
value of the label; if <em>format</em> is not a string it is used as the label value
171
directly. The label value is passed as the only argument to the writer’s
172
<code class="xref py py-meth docutils literal"><span class="pre">send_label_data()</span></code> method. Interpretation of non-string label values is
173
dependent on the associated writer.</p>
174
<p>Format specifications are strings which, in combination with a counter value,
175
are used to compute label values. Each character in the format string is copied
176
to the label value, with some characters recognized to indicate a transform on
177
the counter value. Specifically, the character <code class="docutils literal"><span class="pre">'1'</span></code> represents the counter
178
value formatter as an Arabic number, the characters <code class="docutils literal"><span class="pre">'A'</span></code> and <code class="docutils literal"><span class="pre">'a'</span></code>
179
represent alphabetic representations of the counter value in upper and lower
180
case, respectively, and <code class="docutils literal"><span class="pre">'I'</span></code> and <code class="docutils literal"><span class="pre">'i'</span></code> represent the counter value in Roman
181
numerals, in upper and lower case. Note that the alphabetic and roman
182
transforms require that the counter value be greater than zero.</p>
186
<dt id="formatter.formatter.flush_softspace">
187
<code class="descclassname">formatter.</code><code class="descname">flush_softspace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.flush_softspace" title="Permalink to this definition">¶</a></dt>
188
<dd><p>Send any pending whitespace buffered from a previous call to
189
<a class="reference internal" href="#formatter.formatter.add_flowing_data" title="formatter.formatter.add_flowing_data"><code class="xref py py-meth docutils literal"><span class="pre">add_flowing_data()</span></code></a> to the associated writer object. This should be called
190
before any direct manipulation of the writer object.</p>
194
<dt id="formatter.formatter.push_alignment">
195
<code class="descclassname">formatter.</code><code class="descname">push_alignment</code><span class="sig-paren">(</span><em>align</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.push_alignment" title="Permalink to this definition">¶</a></dt>
196
<dd><p>Push a new alignment setting onto the alignment stack. This may be
197
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> if no change is desired. If the alignment value is changed from
198
the previous setting, the writer’s <code class="xref py py-meth docutils literal"><span class="pre">new_alignment()</span></code> method is called with
199
the <em>align</em> value.</p>
203
<dt id="formatter.formatter.pop_alignment">
204
<code class="descclassname">formatter.</code><code class="descname">pop_alignment</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.pop_alignment" title="Permalink to this definition">¶</a></dt>
205
<dd><p>Restore the previous alignment.</p>
209
<dt id="formatter.formatter.push_font">
210
<code class="descclassname">formatter.</code><code class="descname">push_font</code><span class="sig-paren">(</span><em>(size</em>, <em>italic</em>, <em>bold</em>, <em>teletype)</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.push_font" title="Permalink to this definition">¶</a></dt>
211
<dd><p>Change some or all font properties of the writer object. Properties which are
212
not set to <a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> are set to the values passed in while others are
213
maintained at their current settings. The writer’s <code class="xref py py-meth docutils literal"><span class="pre">new_font()</span></code> method is
214
called with the fully resolved font specification.</p>
218
<dt id="formatter.formatter.pop_font">
219
<code class="descclassname">formatter.</code><code class="descname">pop_font</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.pop_font" title="Permalink to this definition">¶</a></dt>
220
<dd><p>Restore the previous font.</p>
224
<dt id="formatter.formatter.push_margin">
225
<code class="descclassname">formatter.</code><code class="descname">push_margin</code><span class="sig-paren">(</span><em>margin</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.push_margin" title="Permalink to this definition">¶</a></dt>
226
<dd><p>Increase the number of left margin indentations by one, associating the logical
227
tag <em>margin</em> with the new indentation. The initial margin level is <code class="docutils literal"><span class="pre">0</span></code>.
228
Changed values of the logical tag must be true values; false values other than
229
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> are not sufficient to change the margin.</p>
233
<dt id="formatter.formatter.pop_margin">
234
<code class="descclassname">formatter.</code><code class="descname">pop_margin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.pop_margin" title="Permalink to this definition">¶</a></dt>
235
<dd><p>Restore the previous margin.</p>
239
<dt id="formatter.formatter.push_style">
240
<code class="descclassname">formatter.</code><code class="descname">push_style</code><span class="sig-paren">(</span><em>*styles</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.push_style" title="Permalink to this definition">¶</a></dt>
241
<dd><p>Push any number of arbitrary style specifications. All styles are pushed onto
242
the styles stack in order. A tuple representing the entire stack, including
243
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> values, is passed to the writer’s <code class="xref py py-meth docutils literal"><span class="pre">new_styles()</span></code> method.</p>
247
<dt id="formatter.formatter.pop_style">
248
<code class="descclassname">formatter.</code><code class="descname">pop_style</code><span class="sig-paren">(</span><em>n=1</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.pop_style" title="Permalink to this definition">¶</a></dt>
249
<dd><p>Pop the last <em>n</em> style specifications passed to <a class="reference internal" href="#formatter.formatter.push_style" title="formatter.formatter.push_style"><code class="xref py py-meth docutils literal"><span class="pre">push_style()</span></code></a>. A tuple
250
representing the revised stack, including <a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> values, is passed to
251
the writer’s <code class="xref py py-meth docutils literal"><span class="pre">new_styles()</span></code> method.</p>
255
<dt id="formatter.formatter.set_spacing">
256
<code class="descclassname">formatter.</code><code class="descname">set_spacing</code><span class="sig-paren">(</span><em>spacing</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.set_spacing" title="Permalink to this definition">¶</a></dt>
257
<dd><p>Set the spacing style for the writer.</p>
261
<dt id="formatter.formatter.assert_line_data">
262
<code class="descclassname">formatter.</code><code class="descname">assert_line_data</code><span class="sig-paren">(</span><em>flag=1</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.formatter.assert_line_data" title="Permalink to this definition">¶</a></dt>
263
<dd><p>Inform the formatter that data has been added to the current paragraph
264
out-of-band. This should be used when the writer has been manipulated
265
directly. The optional <em>flag</em> argument can be set to false if the writer
266
manipulations produced a hard line break at the end of the output.</p>
270
<div class="section" id="formatter-implementations">
271
<span id="formatter-impls"></span><h2>33.1.2. Formatter Implementations<a class="headerlink" href="#formatter-implementations" title="Permalink to this headline">¶</a></h2>
272
<p>Two implementations of formatter objects are provided by this module. Most
273
applications may use one of these classes without modification or subclassing.</p>
275
<dt id="formatter.NullFormatter">
276
<em class="property">class </em><code class="descclassname">formatter.</code><code class="descname">NullFormatter</code><span class="sig-paren">(</span><em>writer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.NullFormatter" title="Permalink to this definition">¶</a></dt>
277
<dd><p>A formatter which does nothing. If <em>writer</em> is omitted, a <a class="reference internal" href="#formatter.NullWriter" title="formatter.NullWriter"><code class="xref py py-class docutils literal"><span class="pre">NullWriter</span></code></a>
278
instance is created. No methods of the writer are called by
279
<a class="reference internal" href="#formatter.NullFormatter" title="formatter.NullFormatter"><code class="xref py py-class docutils literal"><span class="pre">NullFormatter</span></code></a> instances. Implementations should inherit from this
280
class if implementing a writer interface but don’t need to inherit any
285
<dt id="formatter.AbstractFormatter">
286
<em class="property">class </em><code class="descclassname">formatter.</code><code class="descname">AbstractFormatter</code><span class="sig-paren">(</span><em>writer</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.AbstractFormatter" title="Permalink to this definition">¶</a></dt>
287
<dd><p>The standard formatter. This implementation has demonstrated wide applicability
288
to many writers, and may be used directly in most circumstances. It has been
289
used to implement a full-featured World Wide Web browser.</p>
293
<div class="section" id="the-writer-interface">
294
<span id="writer-interface"></span><h2>33.1.3. The Writer Interface<a class="headerlink" href="#the-writer-interface" title="Permalink to this headline">¶</a></h2>
295
<p>Interfaces to create writers are dependent on the specific writer class being
296
instantiated. The interfaces described below are the required interfaces which
297
all writers must support once initialized. Note that while most applications can
298
use the <a class="reference internal" href="#formatter.AbstractFormatter" title="formatter.AbstractFormatter"><code class="xref py py-class docutils literal"><span class="pre">AbstractFormatter</span></code></a> class as a formatter, the writer must
299
typically be provided by the application.</p>
301
<dt id="formatter.writer.flush">
302
<code class="descclassname">writer.</code><code class="descname">flush</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.flush" title="Permalink to this definition">¶</a></dt>
303
<dd><p>Flush any buffered output or device control events.</p>
307
<dt id="formatter.writer.new_alignment">
308
<code class="descclassname">writer.</code><code class="descname">new_alignment</code><span class="sig-paren">(</span><em>align</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.new_alignment" title="Permalink to this definition">¶</a></dt>
309
<dd><p>Set the alignment style. The <em>align</em> value can be any object, but by convention
310
is a string or <code class="docutils literal"><span class="pre">None</span></code>, where <code class="docutils literal"><span class="pre">None</span></code> indicates that the writer’s “preferred”
311
alignment should be used. Conventional <em>align</em> values are <code class="docutils literal"><span class="pre">'left'</span></code>,
312
<code class="docutils literal"><span class="pre">'center'</span></code>, <code class="docutils literal"><span class="pre">'right'</span></code>, and <code class="docutils literal"><span class="pre">'justify'</span></code>.</p>
316
<dt id="formatter.writer.new_font">
317
<code class="descclassname">writer.</code><code class="descname">new_font</code><span class="sig-paren">(</span><em>font</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.new_font" title="Permalink to this definition">¶</a></dt>
318
<dd><p>Set the font style. The value of <em>font</em> will be <code class="docutils literal"><span class="pre">None</span></code>, indicating that the
319
device’s default font should be used, or a tuple of the form <code class="docutils literal"><span class="pre">(size,</span>
320
<span class="pre">italic,</span> <span class="pre">bold,</span> <span class="pre">teletype)</span></code>. Size will be a string indicating the size of
321
font that should be used; specific strings and their interpretation must be
322
defined by the application. The <em>italic</em>, <em>bold</em>, and <em>teletype</em> values are
323
Boolean values specifying which of those font attributes should be used.</p>
327
<dt id="formatter.writer.new_margin">
328
<code class="descclassname">writer.</code><code class="descname">new_margin</code><span class="sig-paren">(</span><em>margin</em>, <em>level</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.new_margin" title="Permalink to this definition">¶</a></dt>
329
<dd><p>Set the margin level to the integer <em>level</em> and the logical tag to <em>margin</em>.
330
Interpretation of the logical tag is at the writer’s discretion; the only
331
restriction on the value of the logical tag is that it not be a false value for
332
non-zero values of <em>level</em>.</p>
336
<dt id="formatter.writer.new_spacing">
337
<code class="descclassname">writer.</code><code class="descname">new_spacing</code><span class="sig-paren">(</span><em>spacing</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.new_spacing" title="Permalink to this definition">¶</a></dt>
338
<dd><p>Set the spacing style to <em>spacing</em>.</p>
342
<dt id="formatter.writer.new_styles">
343
<code class="descclassname">writer.</code><code class="descname">new_styles</code><span class="sig-paren">(</span><em>styles</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.new_styles" title="Permalink to this definition">¶</a></dt>
344
<dd><p>Set additional styles. The <em>styles</em> value is a tuple of arbitrary values; the
345
value <a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal"><span class="pre">AS_IS</span></code></a> should be ignored. The <em>styles</em> tuple may be interpreted
346
either as a set or as a stack depending on the requirements of the application
347
and writer implementation.</p>
351
<dt id="formatter.writer.send_line_break">
352
<code class="descclassname">writer.</code><code class="descname">send_line_break</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_line_break" title="Permalink to this definition">¶</a></dt>
353
<dd><p>Break the current line.</p>
357
<dt id="formatter.writer.send_paragraph">
358
<code class="descclassname">writer.</code><code class="descname">send_paragraph</code><span class="sig-paren">(</span><em>blankline</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_paragraph" title="Permalink to this definition">¶</a></dt>
359
<dd><p>Produce a paragraph separation of at least <em>blankline</em> blank lines, or the
360
equivalent. The <em>blankline</em> value will be an integer. Note that the
361
implementation will receive a call to <a class="reference internal" href="#formatter.writer.send_line_break" title="formatter.writer.send_line_break"><code class="xref py py-meth docutils literal"><span class="pre">send_line_break()</span></code></a> before this call
362
if a line break is needed; this method should not include ending the last line
363
of the paragraph. It is only responsible for vertical spacing between
368
<dt id="formatter.writer.send_hor_rule">
369
<code class="descclassname">writer.</code><code class="descname">send_hor_rule</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_hor_rule" title="Permalink to this definition">¶</a></dt>
370
<dd><p>Display a horizontal rule on the output device. The arguments to this method
371
are entirely application- and writer-specific, and should be interpreted with
372
care. The method implementation may assume that a line break has already been
373
issued via <a class="reference internal" href="#formatter.writer.send_line_break" title="formatter.writer.send_line_break"><code class="xref py py-meth docutils literal"><span class="pre">send_line_break()</span></code></a>.</p>
377
<dt id="formatter.writer.send_flowing_data">
378
<code class="descclassname">writer.</code><code class="descname">send_flowing_data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_flowing_data" title="Permalink to this definition">¶</a></dt>
379
<dd><p>Output character data which may be word-wrapped and re-flowed as needed. Within
380
any sequence of calls to this method, the writer may assume that spans of
381
multiple whitespace characters have been collapsed to single space characters.</p>
385
<dt id="formatter.writer.send_literal_data">
386
<code class="descclassname">writer.</code><code class="descname">send_literal_data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_literal_data" title="Permalink to this definition">¶</a></dt>
387
<dd><p>Output character data which has already been formatted for display. Generally,
388
this should be interpreted to mean that line breaks indicated by newline
389
characters should be preserved and no new line breaks should be introduced. The
390
data may contain embedded newline and tab characters, unlike data provided to
391
the <code class="xref py py-meth docutils literal"><span class="pre">send_formatted_data()</span></code> interface.</p>
395
<dt id="formatter.writer.send_label_data">
396
<code class="descclassname">writer.</code><code class="descname">send_label_data</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.writer.send_label_data" title="Permalink to this definition">¶</a></dt>
397
<dd><p>Set <em>data</em> to the left of the current left margin, if possible. The value of
398
<em>data</em> is not restricted; treatment of non-string values is entirely
399
application- and writer-dependent. This method will only be called at the
400
beginning of a line.</p>
404
<div class="section" id="writer-implementations">
405
<span id="writer-impls"></span><h2>33.1.4. Writer Implementations<a class="headerlink" href="#writer-implementations" title="Permalink to this headline">¶</a></h2>
406
<p>Three implementations of the writer object interface are provided as examples by
407
this module. Most applications will need to derive new writer classes from the
408
<a class="reference internal" href="#formatter.NullWriter" title="formatter.NullWriter"><code class="xref py py-class docutils literal"><span class="pre">NullWriter</span></code></a> class.</p>
410
<dt id="formatter.NullWriter">
411
<em class="property">class </em><code class="descclassname">formatter.</code><code class="descname">NullWriter</code><a class="headerlink" href="#formatter.NullWriter" title="Permalink to this definition">¶</a></dt>
412
<dd><p>A writer which only provides the interface definition; no actions are taken on
413
any methods. This should be the base class for all writers which do not need to
414
inherit any implementation methods.</p>
418
<dt id="formatter.AbstractWriter">
419
<em class="property">class </em><code class="descclassname">formatter.</code><code class="descname">AbstractWriter</code><a class="headerlink" href="#formatter.AbstractWriter" title="Permalink to this definition">¶</a></dt>
420
<dd><p>A writer which can be used in debugging formatters, but not much else. Each
421
method simply announces itself by printing its name and arguments on standard
426
<dt id="formatter.DumbWriter">
427
<em class="property">class </em><code class="descclassname">formatter.</code><code class="descname">DumbWriter</code><span class="sig-paren">(</span><em>file=None</em>, <em>maxcol=72</em><span class="sig-paren">)</span><a class="headerlink" href="#formatter.DumbWriter" title="Permalink to this definition">¶</a></dt>
428
<dd><p>Simple writer class which writes output on the <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a> passed
429
in as <em>file</em> or, if <em>file</em> is omitted, on standard output. The output is
430
simply word-wrapped to the number of columns specified by <em>maxcol</em>. This
431
class is suitable for reflowing a sequence of paragraphs.</p>
441
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
442
<div class="sphinxsidebarwrapper">
443
<h3><a href="../contents.html">Table Of Contents</a></h3>
445
<li><a class="reference internal" href="#">33.1. <code class="docutils literal"><span class="pre">formatter</span></code> — Generic output formatting</a><ul>
446
<li><a class="reference internal" href="#the-formatter-interface">33.1.1. The Formatter Interface</a></li>
447
<li><a class="reference internal" href="#formatter-implementations">33.1.2. Formatter Implementations</a></li>
448
<li><a class="reference internal" href="#the-writer-interface">33.1.3. The Writer Interface</a></li>
449
<li><a class="reference internal" href="#writer-implementations">33.1.4. Writer Implementations</a></li>
454
<h4>Previous topic</h4>
455
<p class="topless"><a href="misc.html"
456
title="previous chapter">33. Miscellaneous Services</a></p>
458
<p class="topless"><a href="windows.html"
459
title="next chapter">34. MS Windows Specific Services</a></p>
461
<ul class="this-page-menu">
462
<li><a href="../bugs.html">Report a Bug</a></li>
463
<li><a href="../_sources/library/formatter.txt"
464
rel="nofollow">Show Source</a></li>
467
<div id="searchbox" style="display: none" role="search">
468
<h3>Quick search</h3>
469
<form class="search" action="../search.html" method="get">
470
<input type="text" name="q" />
471
<input type="submit" value="Go" />
472
<input type="hidden" name="check_keywords" value="yes" />
473
<input type="hidden" name="area" value="default" />
475
<p class="searchtip" style="font-size: 90%">
476
Enter search terms or a module, class or function name.
479
<script type="text/javascript">$('#searchbox').show(0);</script>
482
<div class="clearer"></div>
484
<div class="related" role="navigation" aria-label="related navigation">
487
<li class="right" style="margin-right: 10px">
488
<a href="../genindex.html" title="General Index"
491
<a href="../py-modindex.html" title="Python Module Index"
494
<a href="windows.html" title="34. MS Windows Specific Services"
497
<a href="misc.html" title="33. Miscellaneous Services"
499
<li><img src="../_static/py.png" alt=""
500
style="vertical-align: middle; margin-top: -1px"/></li>
501
<li><a href="https://www.python.org/">Python</a> »</li>
503
<span class="version_switcher_placeholder">3.5.1</span>
504
<a href="../index.html">Documentation </a> »
507
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
508
<li class="nav-item nav-item-2"><a href="misc.html" >33. Miscellaneous Services</a> »</li>
512
© <a href="../copyright.html">Copyright</a> 1990-2016, Python Software Foundation.
514
The Python Software Foundation is a non-profit corporation.
515
<a href="https://www.python.org/psf/donations/">Please donate.</a>
517
Last updated on Jan 22, 2016.
518
<a href="../bugs.html">Found a bug</a>?
520
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3.
b'\\ No newline at end of file'
added
removed
python-3.5.1-docs-html/library/formatter.html
