Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	editdlrm
abc.rst.txt	11805	0644	editdlrm
aifc.rst.txt	7503	0644	editdlrm
allos.rst.txt	678	0644	editdlrm
archiving.rst.txt	440	0644	editdlrm
argparse.rst.txt	77480	0644	editdlrm
array.rst.txt	10812	0644	editdlrm
ast.rst.txt	10159	0644	editdlrm
asynchat.rst.txt	8528	0644	editdlrm
asyncio-dev.rst.txt	13398	0644	editdlrm
asyncio-eventloop.rst.txt	33701	0644	editdlrm
asyncio-eventloops.rst.txt	7660	0644	editdlrm
asyncio-protocol.rst.txt	25170	0644	editdlrm
asyncio-queue.rst.txt	4328	0644	editdlrm
asyncio-stream.rst.txt	14363	0644	editdlrm
asyncio-subprocess.rst.txt	15544	0644	editdlrm
asyncio-sync.rst.txt	9078	0644	editdlrm
asyncio-task.rst.txt	25406	0644	editdlrm
asyncio.rst.txt	2272	0644	editdlrm
asyncore.rst.txt	13624	0644	editdlrm
atexit.rst.txt	3669	0644	editdlrm
audioop.rst.txt	10712	0644	editdlrm
base64.rst.txt	10371	0644	editdlrm
bdb.rst.txt	12985	0644	editdlrm
binary.rst.txt	654	0644	editdlrm
binascii.rst.txt	6539	0644	editdlrm
binhex.rst.txt	1709	0644	editdlrm
bisect.rst.txt	5398	0644	editdlrm
builtins.rst.txt	1465	0644	editdlrm
bz2.rst.txt	8825	0644	editdlrm
calendar.rst.txt	10988	0644	editdlrm
cgi.rst.txt	22650	0644	editdlrm
cgitb.rst.txt	2918	0644	editdlrm
chunk.rst.txt	5094	0644	editdlrm
cmath.rst.txt	9326	0644	editdlrm
cmd.rst.txt	13795	0644	editdlrm
code.rst.txt	7817	0644	editdlrm
codecs.rst.txt	75564	0644	editdlrm
codeop.rst.txt	3021	0644	editdlrm
collections.abc.rst.txt	12861	0644	editdlrm
collections.rst.txt	46063	0644	editdlrm
colorsys.rst.txt	1820	0644	editdlrm
compileall.rst.txt	8975	0644	editdlrm
concurrency.rst.txt	673	0644	editdlrm
concurrent.futures.rst.txt	16910	0644	editdlrm
concurrent.rst.txt	171	0644	editdlrm
configparser.rst.txt	48756	0644	editdlrm
constants.rst.txt	3331	0644	editdlrm
contextlib.rst.txt	28175	0644	editdlrm
copy.rst.txt	3378	0644	editdlrm
copyreg.rst.txt	2182	0644	editdlrm
crypt.rst.txt	5122	0644	editdlrm
crypto.rst.txt	411	0644	editdlrm
csv.rst.txt	19902	0644	editdlrm
ctypes.rst.txt	88613	0644	editdlrm
curses.ascii.rst.txt	8920	0644	editdlrm
curses.panel.rst.txt	2764	0644	editdlrm
curses.rst.txt	76397	0644	editdlrm
custominterp.rst.txt	569	0644	editdlrm
datatypes.rst.txt	751	0644	editdlrm
datetime.rst.txt	90524	0644	editdlrm
dbm.rst.txt	14293	0644	editdlrm
debug.rst.txt	471	0644	editdlrm
decimal.rst.txt	74869	0644	editdlrm
development.rst.txt	704	0644	editdlrm
difflib.rst.txt	29861	0644	editdlrm
dis.rst.txt	32567	0644	editdlrm
distribution.rst.txt	452	0644	editdlrm
distutils.rst.txt	1974	0644	editdlrm
doctest.rst.txt	71743	0644	editdlrm
dummy_threading.rst.txt	784	0644	editdlrm
email.charset.rst.txt	9293	0644	editdlrm
email.compat32-message.rst.txt	33493	0644	editdlrm
email.contentmanager.rst.txt	9112	0644	editdlrm
email.encoders.rst.txt	2715	0644	editdlrm
email.errors.rst.txt	4792	0644	editdlrm
email.examples.rst.txt	1915	0644	editdlrm
email.generator.rst.txt	13637	0644	editdlrm
email.header.rst.txt	9188	0644	editdlrm
email.headerregistry.rst.txt	17957	0644	editdlrm
email.iterators.rst.txt	2795	0644	editdlrm
email.message.rst.txt	33008	0644	editdlrm
email.mime.rst.txt	11721	0644	editdlrm
email.parser.rst.txt	14092	0644	editdlrm
email.policy.rst.txt	27022	0644	editdlrm
email.rst.txt	6785	0644	editdlrm
email.util.rst.txt	9214	0644	editdlrm
ensurepip.rst.txt	4987	0644	editdlrm
enum.rst.txt	32751	0644	editdlrm
errno.rst.txt	6811	0644	editdlrm
exceptions.rst.txt	25570	0644	editdlrm
faulthandler.rst.txt	6136	0644	editdlrm
fcntl.rst.txt	7152	0644	editdlrm
filecmp.rst.txt	5623	0644	editdlrm
fileformats.rst.txt	287	0644	editdlrm
fileinput.rst.txt	8051	0644	editdlrm
filesys.rst.txt	961	0644	editdlrm
fnmatch.rst.txt	3103	0644	editdlrm
formatter.rst.txt	13242	0644	editdlrm
fpectl.rst.txt	4180	0644	editdlrm
fractions.rst.txt	6364	0644	editdlrm
frameworks.rst.txt	391	0644	editdlrm
ftplib.rst.txt	17552	0644	editdlrm
functional.rst.txt	365	0644	editdlrm
functions.rst.txt	71621	0644	editdlrm
functools.rst.txt	18503	0644	editdlrm
gc.rst.txt	9694	0644	editdlrm
getopt.rst.txt	6557	0644	editdlrm
getpass.rst.txt	1882	0644	editdlrm
gettext.rst.txt	25588	0644	editdlrm
glob.rst.txt	3508	0644	editdlrm
grp.rst.txt	2417	0644	editdlrm
gzip.rst.txt	8301	0644	editdlrm
hashlib.rst.txt	26523	0644	editdlrm
heapq.rst.txt	13402	0644	editdlrm
hmac.rst.txt	4020	0644	editdlrm
html.entities.rst.txt	1319	0644	editdlrm
html.parser.rst.txt	11275	0644	editdlrm
html.rst.txt	1304	0644	editdlrm
http.client.rst.txt	18870	0644	editdlrm
http.cookiejar.rst.txt	27832	0644	editdlrm
http.cookies.rst.txt	8645	0644	editdlrm
http.rst.txt	7096	0644	editdlrm
http.server.rst.txt	17639	0644	editdlrm
i18n.rst.txt	408	0644	editdlrm
idle.rst.txt	25834	0644	editdlrm
imaplib.rst.txt	20367	0644	editdlrm
imghdr.rst.txt	2938	0644	editdlrm
imp.rst.txt	15548	0644	editdlrm
importlib.rst.txt	53563	0644	editdlrm
index.rst.txt	2258	0644	editdlrm
inspect.rst.txt	53928	0644	editdlrm
internet.rst.txt	992	0644	editdlrm
intro.rst.txt	2645	0644	editdlrm
io.rst.txt	40328	0644	editdlrm
ipaddress.rst.txt	32340	0644	editdlrm
ipc.rst.txt	649	0644	editdlrm
itertools.rst.txt	38459	0644	editdlrm
json.rst.txt	27876	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	522	0644	editdlrm
linecache.rst.txt	2408	0644	editdlrm
locale.rst.txt	25470	0644	editdlrm
logging.config.rst.txt	33886	0644	editdlrm
logging.handlers.rst.txt	42497	0644	editdlrm
logging.rst.txt	60479	0644	editdlrm
lzma.rst.txt	17361	0644	editdlrm
macpath.rst.txt	707	0644	editdlrm
mailbox.rst.txt	63055	0644	editdlrm
mailcap.rst.txt	3691	0644	editdlrm
markup.rst.txt	679	0644	editdlrm
marshal.rst.txt	4855	0644	editdlrm
math.rst.txt	14375	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
misc.rst.txt	247	0644	editdlrm
mm.rst.txt	431	0644	editdlrm
mmap.rst.txt	11232	0644	editdlrm
modulefinder.rst.txt	3240	0644	editdlrm
modules.rst.txt	355	0644	editdlrm
msilib.rst.txt	18612	0644	editdlrm
msvcrt.rst.txt	4392	0644	editdlrm
multiprocessing.rst.txt	104494	0644	editdlrm
netdata.rst.txt	339	0644	editdlrm
netrc.rst.txt	3007	0644	editdlrm
nis.rst.txt	1993	0644	editdlrm
nntplib.rst.txt	21821	0644	editdlrm
numbers.rst.txt	8089	0644	editdlrm
numeric.rst.txt	696	0644	editdlrm
operator.rst.txt	18989	0644	editdlrm
optparse.rst.txt	76996	0644	editdlrm
os.path.rst.txt	16419	0644	editdlrm
os.rst.txt	137534	0644	editdlrm
ossaudiodev.rst.txt	17845	0644	editdlrm
othergui.rst.txt	2822	0644	editdlrm
parser.rst.txt	15148	0644	editdlrm
pathlib.rst.txt	30045	0644	editdlrm
pdb.rst.txt	19454	0644	editdlrm
persistence.rst.txt	591	0644	editdlrm
pickle.rst.txt	37440	0644	editdlrm
pickletools.rst.txt	3729	0644	editdlrm
pipes.rst.txt	2557	0644	editdlrm
pkgutil.rst.txt	8730	0644	editdlrm
platform.rst.txt	9624	0644	editdlrm
plistlib.rst.txt	7398	0644	editdlrm
poplib.rst.txt	8197	0644	editdlrm
posix.rst.txt	3694	0644	editdlrm
pprint.rst.txt	14274	0644	editdlrm
profile.rst.txt	27969	0644	editdlrm
pty.rst.txt	3123	0644	editdlrm
pwd.rst.txt	2739	0644	editdlrm
pyclbr.rst.txt	3297	0644	editdlrm
pydoc.rst.txt	4688	0644	editdlrm
pyexpat.rst.txt	28620	0644	editdlrm
python.rst.txt	475	0644	editdlrm
py_compile.rst.txt	3851	0644	editdlrm
queue.rst.txt	7268	0644	editdlrm
quopri.rst.txt	2571	0644	editdlrm
random.rst.txt	18503	0644	editdlrm
re.rst.txt	64936	0644	editdlrm
readline.rst.txt	11943	0644	editdlrm
reprlib.rst.txt	5162	0644	editdlrm
resource.rst.txt	12291	0644	editdlrm
rlcompleter.rst.txt	2294	0644	editdlrm
runpy.rst.txt	8285	0644	editdlrm
sched.rst.txt	4842	0644	editdlrm
secrets.rst.txt	5930	0644	editdlrm
select.rst.txt	28175	0644	editdlrm
selectors.rst.txt	8925	0644	editdlrm
shelve.rst.txt	8390	0644	editdlrm
shlex.rst.txt	16441	0644	editdlrm
shutil.rst.txt	26014	0644	editdlrm
signal.rst.txt	17218	0644	editdlrm
site.rst.txt	9628	0644	editdlrm
smtpd.rst.txt	10806	0644	editdlrm
smtplib.rst.txt	23439	0644	editdlrm
sndhdr.rst.txt	1994	0644	editdlrm
socket.rst.txt	68202	0644	editdlrm
socketserver.rst.txt	23712	0644	editdlrm
spwd.rst.txt	2958	0644	editdlrm
sqlite3.rst.txt	39215	0644	editdlrm
ssl.rst.txt	96021	0644	editdlrm
stat.rst.txt	9805	0644	editdlrm
statistics.rst.txt	15301	0644	editdlrm
stdtypes.rst.txt	179240	0644	editdlrm
string.rst.txt	35374	0644	editdlrm
stringprep.rst.txt	4279	0644	editdlrm
struct.rst.txt	19581	0644	editdlrm
subprocess.rst.txt	45793	0644	editdlrm
sunau.rst.txt	7390	0644	editdlrm
superseded.rst.txt	258	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	4964	0644	editdlrm
sys.rst.txt	58273	0644	editdlrm
sysconfig.rst.txt	8749	0644	editdlrm
syslog.rst.txt	4302	0644	editdlrm
tabnanny.rst.txt	2007	0644	editdlrm
tarfile.rst.txt	31749	0644	editdlrm
telnetlib.rst.txt	7899	0644	editdlrm
tempfile.rst.txt	13857	0644	editdlrm
termios.rst.txt	3751	0644	editdlrm
test.rst.txt	25764	0644	editdlrm
text.rst.txt	584	0644	editdlrm
textwrap.rst.txt	10519	0644	editdlrm
threading.rst.txt	39257	0644	editdlrm
time.rst.txt	32967	0644	editdlrm
timeit.rst.txt	13000	0644	editdlrm
tk.rst.txt	1639	0644	editdlrm
tkinter.rst.txt	33027	0644	editdlrm
tkinter.scrolledtext.rst.txt	1255	0644	editdlrm
tkinter.tix.rst.txt	22653	0644	editdlrm
tkinter.ttk.rst.txt	58489	0644	editdlrm
token.rst.txt	2607	0644	editdlrm
tokenize.rst.txt	10002	0644	editdlrm
trace.rst.txt	6914	0644	editdlrm
traceback.rst.txt	17854	0644	editdlrm
tracemalloc.rst.txt	22089	0644	editdlrm
tty.rst.txt	1097	0644	editdlrm
turtle.rst.txt	71221	0644	editdlrm
types.rst.txt	9999	0644	editdlrm
typing.rst.txt	34332	0644	editdlrm
undoc.rst.txt	780	0644	editdlrm
unicodedata.rst.txt	5762	0644	editdlrm
unittest.mock-examples.rst.txt	46206	0644	editdlrm
unittest.mock.rst.txt	85991	0644	editdlrm
unittest.rst.txt	93304	0644	editdlrm
unix.rst.txt	446	0644	editdlrm
urllib.error.rst.txt	2199	0644	editdlrm
urllib.parse.rst.txt	27332	0644	editdlrm
urllib.request.rst.txt	59360	0644	editdlrm
urllib.robotparser.rst.txt	2969	0644	editdlrm
urllib.rst.txt	466	0644	editdlrm
uu.rst.txt	2387	0644	editdlrm
uuid.rst.txt	8760	0644	editdlrm
venv.rst.txt	20621	0644	editdlrm
warnings.rst.txt	20152	0644	editdlrm
wave.rst.txt	6870	0644	editdlrm
weakref.rst.txt	21328	0644	editdlrm
webbrowser.rst.txt	9783	0644	editdlrm
windows.rst.txt	272	0644	editdlrm
winreg.rst.txt	24073	0644	editdlrm
winsound.rst.txt	5134	0644	editdlrm
wsgiref.rst.txt	33047	0644	editdlrm
xdrlib.rst.txt	8078	0644	editdlrm
xml.dom.minidom.rst.txt	10198	0644	editdlrm
xml.dom.pulldom.rst.txt	5186	0644	editdlrm
xml.dom.rst.txt	39507	0644	editdlrm
xml.etree.elementtree.rst.txt	43871	0644	editdlrm
xml.rst.txt	6071	0644	editdlrm
xml.sax.handler.rst.txt	15399	0644	editdlrm
xml.sax.reader.rst.txt	12133	0644	editdlrm
xml.sax.rst.txt	7159	0644	editdlrm
xml.sax.utils.rst.txt	3901	0644	editdlrm
xmlrpc.client.rst.txt	23071	0644	editdlrm
xmlrpc.rst.txt	475	0644	editdlrm
xmlrpc.server.rst.txt	14990	0644	editdlrm
zipapp.rst.txt	17392	0644	editdlrm
zipfile.rst.txt	24005	0644	editdlrm
zipimport.rst.txt	5805	0644	editdlrm
zlib.rst.txt	13912	0644	editdlrm
_dummy_thread.rst.txt	762	0644	editdlrm
_thread.rst.txt	6886	0644	editdlrm
__future__.rst.txt	5245	0644	editdlrm
__main__.rst.txt	904	0644	editdlrm

:mod:`formatter` --- Generic output formatting ============================================== .. module:: formatter :synopsis: Generic output formatter and device interface. :deprecated: .. deprecated:: 3.4 Due to lack of usage, the formatter module has been deprecated. -------------- This module supports two interface definitions, each with multiple implementations: The *formatter* interface, and the *writer* interface which is required by the formatter interface. Formatter objects transform an abstract flow of formatting events into specific output events on writer objects. Formatters manage several stack structures to allow various properties of a writer object to be changed and restored; writers need not be able to handle relative changes nor any sort of "change back" operation. Specific writer properties which may be controlled via formatter objects are horizontal alignment, font, and left margin indentations. A mechanism is provided which supports providing arbitrary, non-exclusive style settings to a writer as well. Additional interfaces facilitate formatting events which are not reversible, such as paragraph separation. Writer objects encapsulate device interfaces. Abstract devices, such as file formats, are supported as well as physical devices. The provided implementations all work with abstract devices. The interface makes available mechanisms for setting the properties which formatter objects manage and inserting data into the output. .. _formatter-interface: The Formatter Interface ----------------------- Interfaces to create formatters are dependent on the specific formatter class being instantiated. The interfaces described below are the required interfaces which all formatters must support once initialized. One data element is defined at the module level: .. data:: AS_IS Value which can be used in the font specification passed to the ``push_font()`` method described below, or as the new value to any other ``push_property()`` method. Pushing the ``AS_IS`` value allows the corresponding ``pop_property()`` method to be called without having to track whether the property was changed. The following attributes are defined for formatter instance objects: .. attribute:: formatter.writer The writer instance with which the formatter interacts. .. method:: formatter.end_paragraph(blanklines) Close any open paragraphs and insert at least *blanklines* before the next paragraph. .. method:: formatter.add_line_break() Add a hard line break if one does not already exist. This does not break the logical paragraph. .. method:: formatter.add_hor_rule(*args, **kw) Insert a horizontal rule in the output. A hard break is inserted if there is data in the current paragraph, but the logical paragraph is not broken. The arguments and keywords are passed on to the writer's :meth:`send_line_break` method. .. method:: formatter.add_flowing_data(data) Provide data which should be formatted with collapsed whitespace. Whitespace from preceding and successive calls to :meth:`add_flowing_data` is considered as well when the whitespace collapse is performed. The data which is passed to this method is expected to be word-wrapped by the output device. Note that any word-wrapping still must be performed by the writer object due to the need to rely on device and font information. .. method:: formatter.add_literal_data(data) Provide data which should be passed to the writer unchanged. Whitespace, including newline and tab characters, are considered legal in the value of *data*. .. method:: formatter.add_label_data(format, counter) Insert a label which should be placed to the left of the current left margin. This should be used for constructing bulleted or numbered lists. If the *format* value is a string, it is interpreted as a format specification for *counter*, which should be an integer. The result of this formatting becomes the value of the label; if *format* is not a string it is used as the label value directly. The label value is passed as the only argument to the writer's :meth:`send_label_data` method. Interpretation of non-string label values is dependent on the associated writer. Format specifications are strings which, in combination with a counter value, are used to compute label values. Each character in the format string is copied to the label value, with some characters recognized to indicate a transform on the counter value. Specifically, the character ``'1'`` represents the counter value formatter as an Arabic number, the characters ``'A'`` and ``'a'`` represent alphabetic representations of the counter value in upper and lower case, respectively, and ``'I'`` and ``'i'`` represent the counter value in Roman numerals, in upper and lower case. Note that the alphabetic and roman transforms require that the counter value be greater than zero. .. method:: formatter.flush_softspace() Send any pending whitespace buffered from a previous call to :meth:`add_flowing_data` to the associated writer object. This should be called before any direct manipulation of the writer object. .. method:: formatter.push_alignment(align) Push a new alignment setting onto the alignment stack. This may be :const:`AS_IS` if no change is desired. If the alignment value is changed from the previous setting, the writer's :meth:`new_alignment` method is called with the *align* value. .. method:: formatter.pop_alignment() Restore the previous alignment. .. method:: formatter.push_font((size, italic, bold, teletype)) Change some or all font properties of the writer object. Properties which are not set to :const:`AS_IS` are set to the values passed in while others are maintained at their current settings. The writer's :meth:`new_font` method is called with the fully resolved font specification. .. method:: formatter.pop_font() Restore the previous font. .. method:: formatter.push_margin(margin) Increase the number of left margin indentations by one, associating the logical tag *margin* with the new indentation. The initial margin level is ``0``. Changed values of the logical tag must be true values; false values other than :const:`AS_IS` are not sufficient to change the margin. .. method:: formatter.pop_margin() Restore the previous margin. .. method:: formatter.push_style(*styles) Push any number of arbitrary style specifications. All styles are pushed onto the styles stack in order. A tuple representing the entire stack, including :const:`AS_IS` values, is passed to the writer's :meth:`new_styles` method. .. method:: formatter.pop_style(n=1) Pop the last *n* style specifications passed to :meth:`push_style`. A tuple representing the revised stack, including :const:`AS_IS` values, is passed to the writer's :meth:`new_styles` method. .. method:: formatter.set_spacing(spacing) Set the spacing style for the writer. .. method:: formatter.assert_line_data(flag=1) Inform the formatter that data has been added to the current paragraph out-of-band. This should be used when the writer has been manipulated directly. The optional *flag* argument can be set to false if the writer manipulations produced a hard line break at the end of the output. .. _formatter-impls: Formatter Implementations ------------------------- Two implementations of formatter objects are provided by this module. Most applications may use one of these classes without modification or subclassing. .. class:: NullFormatter(writer=None) A formatter which does nothing. If *writer* is omitted, a :class:`NullWriter` instance is created. No methods of the writer are called by :class:`NullFormatter` instances. Implementations should inherit from this class if implementing a writer interface but don't need to inherit any implementation. .. class:: AbstractFormatter(writer) The standard formatter. This implementation has demonstrated wide applicability to many writers, and may be used directly in most circumstances. It has been used to implement a full-featured World Wide Web browser. .. _writer-interface: The Writer Interface -------------------- Interfaces to create writers are dependent on the specific writer class being instantiated. The interfaces described below are the required interfaces which all writers must support once initialized. Note that while most applications can use the :class:`AbstractFormatter` class as a formatter, the writer must typically be provided by the application. .. method:: writer.flush() Flush any buffered output or device control events. .. method:: writer.new_alignment(align) Set the alignment style. The *align* value can be any object, but by convention is a string or ``None``, where ``None`` indicates that the writer's "preferred" alignment should be used. Conventional *align* values are ``'left'``, ``'center'``, ``'right'``, and ``'justify'``. .. method:: writer.new_font(font) Set the font style. The value of *font* will be ``None``, indicating that the device's default font should be used, or a tuple of the form ``(size, italic, bold, teletype)``. Size will be a string indicating the size of font that should be used; specific strings and their interpretation must be defined by the application. The *italic*, *bold*, and *teletype* values are Boolean values specifying which of those font attributes should be used. .. method:: writer.new_margin(margin, level) Set the margin level to the integer *level* and the logical tag to *margin*. Interpretation of the logical tag is at the writer's discretion; the only restriction on the value of the logical tag is that it not be a false value for non-zero values of *level*. .. method:: writer.new_spacing(spacing) Set the spacing style to *spacing*. .. method:: writer.new_styles(styles) Set additional styles. The *styles* value is a tuple of arbitrary values; the value :const:`AS_IS` should be ignored. The *styles* tuple may be interpreted either as a set or as a stack depending on the requirements of the application and writer implementation. .. method:: writer.send_line_break() Break the current line. .. method:: writer.send_paragraph(blankline) Produce a paragraph separation of at least *blankline* blank lines, or the equivalent. The *blankline* value will be an integer. Note that the implementation will receive a call to :meth:`send_line_break` before this call if a line break is needed; this method should not include ending the last line of the paragraph. It is only responsible for vertical spacing between paragraphs. .. method:: writer.send_hor_rule(*args, **kw) Display a horizontal rule on the output device. The arguments to this method are entirely application- and writer-specific, and should be interpreted with care. The method implementation may assume that a line break has already been issued via :meth:`send_line_break`. .. method:: writer.send_flowing_data(data) Output character data which may be word-wrapped and re-flowed as needed. Within any sequence of calls to this method, the writer may assume that spans of multiple whitespace characters have been collapsed to single space characters. .. method:: writer.send_literal_data(data) Output character data which has already been formatted for display. Generally, this should be interpreted to mean that line breaks indicated by newline characters should be preserved and no new line breaks should be introduced. The data may contain embedded newline and tab characters, unlike data provided to the :meth:`send_formatted_data` interface. .. method:: writer.send_label_data(data) Set *data* to the left of the current left margin, if possible. The value of *data* is not restricted; treatment of non-string values is entirely application- and writer-dependent. This method will only be called at the beginning of a line. .. _writer-impls: Writer Implementations ---------------------- 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 :class:`NullWriter` class. .. class:: NullWriter() 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. .. class:: AbstractWriter() 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. .. class:: DumbWriter(file=None, maxcol=72) Simple writer class which writes output on the :term:`file object` passed in as *file* or, if *file* is omitted, on standard output. The output is simply word-wrapped to the number of columns specified by *maxcol*. This class is suitable for reflowing a sequence of paragraphs.