Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	editdlrm
abc.rst.txt	7219	0644	editdlrm
aepack.rst.txt	4257	0644	editdlrm
aetools.rst.txt	3532	0644	editdlrm
aetypes.rst.txt	4257	0644	editdlrm
aifc.rst.txt	7086	0644	editdlrm
al.rst.txt	5309	0644	editdlrm
allos.rst.txt	695	0644	editdlrm
anydbm.rst.txt	4111	0644	editdlrm
archiving.rst.txt	424	0644	editdlrm
argparse.rst.txt	74685	0644	editdlrm
array.rst.txt	10524	0644	editdlrm
ast.rst.txt	10111	0644	editdlrm
asynchat.rst.txt	9206	0644	editdlrm
asyncore.rst.txt	12937	0644	editdlrm
atexit.rst.txt	3910	0644	editdlrm
audioop.rst.txt	10395	0644	editdlrm
autogil.rst.txt	1015	0644	editdlrm
base64.rst.txt	6252	0644	editdlrm
basehttpserver.rst.txt	10404	0644	editdlrm
bastion.rst.txt	2611	0644	editdlrm
bdb.rst.txt	12456	0644	editdlrm
binascii.rst.txt	6508	0644	editdlrm
binhex.rst.txt	1910	0644	editdlrm
bisect.rst.txt	5415	0644	editdlrm
bsddb.rst.txt	7575	0644	editdlrm
bz2.rst.txt	8064	0644	editdlrm
calendar.rst.txt	11282	0644	editdlrm
carbon.rst.txt	15956	0644	editdlrm
cd.rst.txt	11974	0644	editdlrm
cgi.rst.txt	22853	0644	editdlrm
cgihttpserver.rst.txt	2788	0644	editdlrm
cgitb.rst.txt	2874	0644	editdlrm
chunk.rst.txt	4955	0644	editdlrm
cmath.rst.txt	7647	0644	editdlrm
cmd.rst.txt	8565	0644	editdlrm
code.rst.txt	7115	0644	editdlrm
codecs.rst.txt	66966	0644	editdlrm
codeop.rst.txt	3774	0644	editdlrm
collections.rst.txt	41448	0644	editdlrm
colorpicker.rst.txt	913	0644	editdlrm
colorsys.rst.txt	1819	0644	editdlrm
commands.rst.txt	2595	0644	editdlrm
compileall.rst.txt	4678	0644	editdlrm
compiler.rst.txt	37464	0644	editdlrm
configparser.rst.txt	19607	0644	editdlrm
constants.rst.txt	2328	0644	editdlrm
contextlib.rst.txt	6012	0644	editdlrm
cookie.rst.txt	9543	0644	editdlrm
cookielib.rst.txt	27875	0644	editdlrm
copy.rst.txt	3351	0644	editdlrm
copy_reg.rst.txt	2329	0644	editdlrm
crypt.rst.txt	2292	0644	editdlrm
crypto.rst.txt	355	0644	editdlrm
csv.rst.txt	22757	0644	editdlrm
ctypes.rst.txt	90513	0644	editdlrm
curses.ascii.rst.txt	9046	0644	editdlrm
curses.panel.rst.txt	2740	0644	editdlrm
curses.rst.txt	74877	0644	editdlrm
custominterp.rst.txt	570	0644	editdlrm
datatypes.rst.txt	864	0644	editdlrm
datetime.rst.txt	74679	0644	editdlrm
dbhash.rst.txt	3865	0644	editdlrm
dbm.rst.txt	3117	0644	editdlrm
debug.rst.txt	446	0644	editdlrm
decimal.rst.txt	70926	0644	editdlrm
development.rst.txt	640	0644	editdlrm
difflib.rst.txt	30716	0644	editdlrm
dircache.rst.txt	1813	0644	editdlrm
dis.rst.txt	23248	0644	editdlrm
distribution.rst.txt	426	0644	editdlrm
distutils.rst.txt	1958	0644	editdlrm
dl.rst.txt	3392	0644	editdlrm
doctest.rst.txt	73985	0644	editdlrm
docxmlrpcserver.rst.txt	3802	0644	editdlrm
dumbdbm.rst.txt	2841	0644	editdlrm
dummy_thread.rst.txt	1058	0644	editdlrm
dummy_threading.rst.txt	799	0644	editdlrm
easydialogs.rst.txt	10346	0644	editdlrm
email-examples.rst.txt	1271	0644	editdlrm
email.charset.rst.txt	9654	0644	editdlrm
email.encoders.rst.txt	2376	0644	editdlrm
email.errors.rst.txt	4006	0644	editdlrm
email.generator.rst.txt	6132	0644	editdlrm
email.header.rst.txt	7531	0644	editdlrm
email.iterators.rst.txt	2421	0644	editdlrm
email.message.rst.txt	25217	0644	editdlrm
email.mime.rst.txt	9917	0644	editdlrm
email.parser.rst.txt	10327	0644	editdlrm
email.rst.txt	16111	0644	editdlrm
email.utils.rst.txt	6475	0644	editdlrm
ensurepip.rst.txt	5022	0644	editdlrm
errno.rst.txt	6708	0644	editdlrm
exceptions.rst.txt	18343	0644	editdlrm
fcntl.rst.txt	7361	0644	editdlrm
filecmp.rst.txt	5348	0644	editdlrm
fileformats.rst.txt	302	0644	editdlrm
fileinput.rst.txt	7417	0644	editdlrm
filesys.rst.txt	806	0644	editdlrm
fl.rst.txt	17646	0644	editdlrm
fm.rst.txt	2699	0644	editdlrm
fnmatch.rst.txt	3104	0644	editdlrm
formatter.rst.txt	13245	0644	editdlrm
fpectl.rst.txt	4171	0644	editdlrm
fpformat.rst.txt	1747	0644	editdlrm
fractions.rst.txt	5297	0644	editdlrm
framework.rst.txt	11444	0644	editdlrm
frameworks.rst.txt	378	0644	editdlrm
ftplib.rst.txt	15720	0644	editdlrm
functions.rst.txt	75554	0644	editdlrm
functools.rst.txt	7448	0644	editdlrm
future_builtins.rst.txt	2010	0644	editdlrm
gc.rst.txt	9014	0644	editdlrm
gdbm.rst.txt	4882	0644	editdlrm
gensuitemodule.rst.txt	3113	0644	editdlrm
getopt.rst.txt	6670	0644	editdlrm
getpass.rst.txt	1876	0644	editdlrm
gettext.rst.txt	29040	0644	editdlrm
gl.rst.txt	6009	0644	editdlrm
glob.rst.txt	2414	0644	editdlrm
grp.rst.txt	2256	0644	editdlrm
gzip.rst.txt	4828	0644	editdlrm
hashlib.rst.txt	7379	0644	editdlrm
heapq.rst.txt	13185	0644	editdlrm
hmac.rst.txt	3073	0644	editdlrm
hotshot.rst.txt	4289	0644	editdlrm
htmllib.rst.txt	7379	0644	editdlrm
htmlparser.rst.txt	11640	0644	editdlrm
httplib.rst.txt	37454	0644	editdlrm
i18n.rst.txt	409	0644	editdlrm
ic.rst.txt	5005	0644	editdlrm
idle.rst.txt	22182	0644	editdlrm
imageop.rst.txt	4001	0644	editdlrm
imaplib.rst.txt	17221	0644	editdlrm
imgfile.rst.txt	2765	0644	editdlrm
imghdr.rst.txt	2635	0644	editdlrm
imp.rst.txt	12593	0644	editdlrm
importlib.rst.txt	1126	0644	editdlrm
imputil.rst.txt	7023	0644	editdlrm
index.rst.txt	2287	0644	editdlrm
inspect.rst.txt	28151	0644	editdlrm
internet.rst.txt	950	0644	editdlrm
intro.rst.txt	2803	0644	editdlrm
io.rst.txt	39015	0644	editdlrm
ipc.rst.txt	630	0644	editdlrm
itertools.rst.txt	36324	0644	editdlrm
jpeg.rst.txt	3858	0644	editdlrm
json.rst.txt	25545	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	523	0644	editdlrm
linecache.rst.txt	1887	0644	editdlrm
locale.rst.txt	24975	0644	editdlrm
logging.config.rst.txt	31560	0644	editdlrm
logging.handlers.rst.txt	28153	0644	editdlrm
logging.rst.txt	46882	0644	editdlrm
mac.rst.txt	791	0644	editdlrm
macos.rst.txt	3824	0644	editdlrm
macosa.rst.txt	3964	0644	editdlrm
macostools.rst.txt	4017	0644	editdlrm
macpath.rst.txt	650	0644	editdlrm
mailbox.rst.txt	68129	0644	editdlrm
mailcap.rst.txt	3675	0644	editdlrm
markup.rst.txt	1249	0644	editdlrm
marshal.rst.txt	5689	0644	editdlrm
math.rst.txt	10920	0644	editdlrm
md5.rst.txt	2815	0644	editdlrm
mhlib.rst.txt	3966	0644	editdlrm
mimetools.rst.txt	4504	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
mimewriter.rst.txt	3360	0644	editdlrm
mimify.rst.txt	3519	0644	editdlrm
miniaeframe.rst.txt	2564	0644	editdlrm
misc.rst.txt	248	0644	editdlrm
mm.rst.txt	447	0644	editdlrm
mmap.rst.txt	10481	0644	editdlrm
modulefinder.rst.txt	3380	0644	editdlrm
modules.rst.txt	382	0644	editdlrm
msilib.rst.txt	19062	0644	editdlrm
msvcrt.rst.txt	4346	0644	editdlrm
multifile.rst.txt	6613	0644	editdlrm
multiprocessing.rst.txt	92621	0644	editdlrm
mutex.rst.txt	1939	0644	editdlrm
netdata.rst.txt	432	0644	editdlrm
netrc.rst.txt	3119	0644	editdlrm
new.rst.txt	2653	0644	editdlrm
nis.rst.txt	2108	0644	editdlrm
nntplib.rst.txt	14531	0644	editdlrm
numbers.rst.txt	8007	0644	editdlrm
numeric.rst.txt	751	0644	editdlrm
operator.rst.txt	22092	0644	editdlrm
optparse.rst.txt	77101	0644	editdlrm
os.path.rst.txt	13094	0644	editdlrm
os.rst.txt	82580	0644	editdlrm
ossaudiodev.rst.txt	17309	0644	editdlrm
othergui.rst.txt	2721	0644	editdlrm
parser.rst.txt	15385	0644	editdlrm
pdb.rst.txt	16043	0644	editdlrm
persistence.rst.txt	826	0644	editdlrm
pickle.rst.txt	37262	0644	editdlrm
pickletools.rst.txt	1997	0644	editdlrm
pipes.rst.txt	3786	0644	editdlrm
pkgutil.rst.txt	7714	0644	editdlrm
platform.rst.txt	9554	0644	editdlrm
plistlib.rst.txt	4134	0644	editdlrm
popen2.rst.txt	7022	0644	editdlrm
poplib.rst.txt	6220	0644	editdlrm
posix.rst.txt	3630	0644	editdlrm
posixfile.rst.txt	7200	0644	editdlrm
pprint.rst.txt	9071	0644	editdlrm
profile.rst.txt	28666	0644	editdlrm
pty.rst.txt	1762	0644	editdlrm
pwd.rst.txt	2725	0644	editdlrm
pyclbr.rst.txt	3296	0644	editdlrm
pydoc.rst.txt	4083	0644	editdlrm
pyexpat.rst.txt	28891	0644	editdlrm
python.rst.txt	514	0644	editdlrm
py_compile.rst.txt	2479	0644	editdlrm
queue.rst.txt	7034	0644	editdlrm
quopri.rst.txt	2670	0644	editdlrm
random.rst.txt	13319	0644	editdlrm
re.rst.txt	55102	0644	editdlrm
readline.rst.txt	10513	0644	editdlrm
repr.rst.txt	4718	0644	editdlrm
resource.rst.txt	9595	0644	editdlrm
restricted.rst.txt	3327	0644	editdlrm
rexec.rst.txt	11742	0644	editdlrm
rfc822.rst.txt	14037	0644	editdlrm
rlcompleter.rst.txt	2494	0644	editdlrm
robotparser.rst.txt	2190	0644	editdlrm
runpy.rst.txt	6938	0644	editdlrm
sched.rst.txt	4644	0644	editdlrm
scrolledtext.rst.txt	1379	0644	editdlrm
select.rst.txt	20705	0644	editdlrm
sets.rst.txt	14973	0644	editdlrm
sgi.rst.txt	322	0644	editdlrm
sgmllib.rst.txt	10664	0644	editdlrm
sha.rst.txt	2807	0644	editdlrm
shelve.rst.txt	8319	0644	editdlrm
shlex.rst.txt	11313	0644	editdlrm
shutil.rst.txt	13491	0644	editdlrm
signal.rst.txt	10719	0644	editdlrm
simplehttpserver.rst.txt	4559	0644	editdlrm
simplexmlrpcserver.rst.txt	10881	0644	editdlrm
site.rst.txt	7880	0644	editdlrm
smtpd.rst.txt	2464	0644	editdlrm
smtplib.rst.txt	14906	0644	editdlrm
sndhdr.rst.txt	1759	0644	editdlrm
socket.rst.txt	40765	0644	editdlrm
socketserver.rst.txt	22512	0644	editdlrm
someos.rst.txt	599	0644	editdlrm
spwd.rst.txt	2825	0644	editdlrm
sqlite3.rst.txt	35448	0644	editdlrm
ssl.rst.txt	76554	0644	editdlrm
stat.rst.txt	7778	0644	editdlrm
statvfs.rst.txt	1300	0644	editdlrm
stdtypes.rst.txt	122668	0644	editdlrm
string.rst.txt	44085	0644	editdlrm
stringio.rst.txt	4166	0644	editdlrm
stringprep.rst.txt	4238	0644	editdlrm
strings.rst.txt	746	0644	editdlrm
struct.rst.txt	17100	0644	editdlrm
subprocess.rst.txt	33648	0644	editdlrm
sun.rst.txt	249	0644	editdlrm
sunau.rst.txt	7124	0644	editdlrm
sunaudio.rst.txt	5849	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	5064	0644	editdlrm
sys.rst.txt	47520	0644	editdlrm
sysconfig.rst.txt	7639	0644	editdlrm
syslog.rst.txt	3931	0644	editdlrm
tabnanny.rst.txt	1999	0644	editdlrm
tarfile.rst.txt	28214	0644	editdlrm
telnetlib.rst.txt	7482	0644	editdlrm
tempfile.rst.txt	10504	0644	editdlrm
termios.rst.txt	3733	0644	editdlrm
test.rst.txt	17659	0644	editdlrm
textwrap.rst.txt	8552	0644	editdlrm
thread.rst.txt	6588	0644	editdlrm
threading.rst.txt	32468	0644	editdlrm
time.rst.txt	26020	0644	editdlrm
timeit.rst.txt	11598	0644	editdlrm
tix.rst.txt	22693	0644	editdlrm
tk.rst.txt	1612	0644	editdlrm
tkinter.rst.txt	33456	0644	editdlrm
token.rst.txt	2451	0644	editdlrm
tokenize.rst.txt	5570	0644	editdlrm
trace.rst.txt	6724	0644	editdlrm
traceback.rst.txt	10711	0644	editdlrm
ttk.rst.txt	57411	0644	editdlrm
tty.rst.txt	1011	0644	editdlrm
turtle.rst.txt	64097	0644	editdlrm
types.rst.txt	6200	0644	editdlrm
undoc.rst.txt	6550	0644	editdlrm
unicodedata.rst.txt	5736	0644	editdlrm
unittest.rst.txt	82952	0644	editdlrm
unix.rst.txt	490	0644	editdlrm
urllib.rst.txt	24960	0644	editdlrm
urllib2.rst.txt	35211	0644	editdlrm
urlparse.rst.txt	16071	0644	editdlrm
user.rst.txt	2748	0644	editdlrm
userdict.rst.txt	9290	0644	editdlrm
uu.rst.txt	2369	0644	editdlrm
uuid.rst.txt	8378	0644	editdlrm
warnings.rst.txt	19815	0644	editdlrm
wave.rst.txt	5047	0644	editdlrm
weakref.rst.txt	12926	0644	editdlrm
webbrowser.rst.txt	9863	0644	editdlrm
whichdb.rst.txt	931	0644	editdlrm
windows.rst.txt	273	0644	editdlrm
winsound.rst.txt	5066	0644	editdlrm
wsgiref.rst.txt	30567	0644	editdlrm
xdrlib.rst.txt	8077	0644	editdlrm
xml.dom.minidom.rst.txt	11208	0644	editdlrm
xml.dom.pulldom.rst.txt	1571	0644	editdlrm
xml.dom.rst.txt	40182	0644	editdlrm
xml.etree.elementtree.rst.txt	35707	0644	editdlrm
xml.rst.txt	6090	0644	editdlrm
xml.sax.handler.rst.txt	15371	0644	editdlrm
xml.sax.reader.rst.txt	12257	0644	editdlrm
xml.sax.rst.txt	6460	0644	editdlrm
xml.sax.utils.rst.txt	3560	0644	editdlrm
xmlrpclib.rst.txt	22559	0644	editdlrm
zipfile.rst.txt	18871	0644	editdlrm
zipimport.rst.txt	5957	0644	editdlrm
zlib.rst.txt	12766	0644	editdlrm
_winreg.rst.txt	23305	0644	editdlrm
__builtin__.rst.txt	1494	0644	editdlrm
__future__.rst.txt	4952	0644	editdlrm
__main__.rst.txt	535	0644	editdlrm

:mod:`formatter` --- Generic output formatting ============================================== .. module:: formatter :synopsis: Generic output formatter and device interface. .. index:: single: HTMLParser (class in htmllib) This module supports two interface definitions, each with multiple implementations. The *formatter* interface is used by the :class:`~HTMLParser.HTMLParser` class of the :mod:`htmllib` module, and the *writer* interface 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]) 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 file object passed in as *file* or, if *file* is ``None``, 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.