Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : formatter.html

<!DOCTYPE html>

<title>34.1. formatter — Generic output formatting &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="35. MS Windows Specific Services" href="windows.html" />
 <link rel="prev" title="34. Miscellaneous Services" href="misc.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/formatter.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/formatter.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="35. MS Windows Specific Services"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="misc.html" title="34. Miscellaneous Services"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="misc.html" accesskey="U">34. Miscellaneous Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">34.1. <code class="xref py py-mod docutils literal notranslate">formatter</code> — Generic output formatting</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-formatter">
<h1>34.1. <a class="reference internal" href="#module-formatter" title="formatter: Generic output formatter and device interface."><code class="xref py py-mod docutils literal notranslate">formatter</code></a> — Generic output formatting<a class="headerlink" href="#module-formatter" title="Permalink to this headline">¶</a></h1>
This module supports two interface definitions, each with multiple
implementations. The formatter interface is used by the <a class="reference internal" href="htmlparser.html#HTMLParser.HTMLParser" title="HTMLParser.HTMLParser"><code class="xref py py-class docutils literal notranslate">HTMLParser</code></a>
class of the <a class="reference internal" href="htmllib.html#module-htmllib" title="htmllib: A parser for HTML documents. (deprecated)"><code class="xref py py-mod docutils literal notranslate">htmllib</code></a> 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.
<section id="the-formatter-interface">
<h2>34.1.1. The Formatter Interface<a class="headerlink" href="#the-formatter-interface" title="Permalink to this headline">¶</a></h2>
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:
<dl class="py data">
<dt class="sig sig-object py" id="formatter.AS_IS">
formatter.AS_IS<a class="headerlink" href="#formatter.AS_IS" title="Permalink to this definition">¶</a></dt>
<dd>Value which can be used in the font specification passed to the <code class="docutils literal notranslate">push_font()</code>
method described below, or as the new value to any other <code class="docutils literal notranslate">push_property()</code>
method. Pushing the <code class="docutils literal notranslate">AS_IS</code> value allows the corresponding <code class="docutils literal notranslate">pop_property()</code>
method to be called without having to track whether the property was changed.
</dd></dl>

The following attributes are defined for formatter instance objects:
<dl class="py attribute">
<dt class="sig sig-object py" id="formatter.formatter.writer">
formatter.writer<a class="headerlink" href="#formatter.formatter.writer" title="Permalink to this definition">¶</a></dt>
<dd>The writer instance with which the formatter interacts.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.end_paragraph">
formatter.end_paragraph(blanklines)<a class="headerlink" href="#formatter.formatter.end_paragraph" title="Permalink to this definition">¶</a></dt>
<dd>Close any open paragraphs and insert at least blanklines before the next
paragraph.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.add_line_break">
formatter.add_line_break()<a class="headerlink" href="#formatter.formatter.add_line_break" title="Permalink to this definition">¶</a></dt>
<dd>Add a hard line break if one does not already exist. This does not break the
logical paragraph.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.add_hor_rule">
formatter.add_hor_rule(*args, **kw)<a class="headerlink" href="#formatter.formatter.add_hor_rule" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="xref py py-meth docutils literal notranslate">send_line_break()</code>
method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.add_flowing_data">
formatter.add_flowing_data(data)<a class="headerlink" href="#formatter.formatter.add_flowing_data" title="Permalink to this definition">¶</a></dt>
<dd>Provide data which should be formatted with collapsed whitespace. Whitespace
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 notranslate">add_flowing_data()</code></a> 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.add_literal_data">
formatter.add_literal_data(data)<a class="headerlink" href="#formatter.formatter.add_literal_data" title="Permalink to this definition">¶</a></dt>
<dd>Provide data which should be passed to the writer unchanged. Whitespace,
including newline and tab characters, are considered legal in the value of
data.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.add_label_data">
formatter.add_label_data(format, counter)<a class="headerlink" href="#formatter.formatter.add_label_data" title="Permalink to this definition">¶</a></dt>
<dd>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
<code class="xref py py-meth docutils literal notranslate">send_label_data()</code> 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 <code class="docutils literal notranslate">'1'</code> represents the counter
value formatter as an Arabic number, the characters <code class="docutils literal notranslate">'A'</code> and <code class="docutils literal notranslate">'a'</code>
represent alphabetic representations of the counter value in upper and lower
case, respectively, and <code class="docutils literal notranslate">'I'</code> and <code class="docutils literal notranslate">'i'</code> 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.flush_softspace">
formatter.flush_softspace()<a class="headerlink" href="#formatter.formatter.flush_softspace" title="Permalink to this definition">¶</a></dt>
<dd>Send any pending whitespace buffered from a previous call 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 notranslate">add_flowing_data()</code></a> to the associated writer object. This should be called
before any direct manipulation of the writer object.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.push_alignment">
formatter.push_alignment(align)<a class="headerlink" href="#formatter.formatter.push_alignment" title="Permalink to this definition">¶</a></dt>
<dd>Push a new alignment setting onto the alignment stack. This may be
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal notranslate">AS_IS</code></a> if no change is desired. If the alignment value is changed from
the previous setting, the writer’s <code class="xref py py-meth docutils literal notranslate">new_alignment()</code> method is called with
the align value.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.pop_alignment">
formatter.pop_alignment()<a class="headerlink" href="#formatter.formatter.pop_alignment" title="Permalink to this definition">¶</a></dt>
<dd>Restore the previous alignment.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.push_font">
formatter.push_font((size, italic, bold, teletype))<a class="headerlink" href="#formatter.formatter.push_font" title="Permalink to this definition">¶</a></dt>
<dd>Change some or all font properties of the writer object. Properties which are
not set to <a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal notranslate">AS_IS</code></a> are set to the values passed in while others are
maintained at their current settings. The writer’s <code class="xref py py-meth docutils literal notranslate">new_font()</code> method is
called with the fully resolved font specification.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.pop_font">
formatter.pop_font()<a class="headerlink" href="#formatter.formatter.pop_font" title="Permalink to this definition">¶</a></dt>
<dd>Restore the previous font.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.push_margin">
formatter.push_margin(margin)<a class="headerlink" href="#formatter.formatter.push_margin" title="Permalink to this definition">¶</a></dt>
<dd>Increase the number of left margin indentations by one, associating the logical
tag margin with the new indentation. The initial margin level is <code class="docutils literal notranslate">0</code>.
Changed values of the logical tag must be true values; false values other than
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal notranslate">AS_IS</code></a> are not sufficient to change the margin.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.pop_margin">
formatter.pop_margin()<a class="headerlink" href="#formatter.formatter.pop_margin" title="Permalink to this definition">¶</a></dt>
<dd>Restore the previous margin.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.push_style">
formatter.push_style(*styles)<a class="headerlink" href="#formatter.formatter.push_style" title="Permalink to this definition">¶</a></dt>
<dd>Push any number of arbitrary style specifications. All styles are pushed onto
the styles stack in order. A tuple representing the entire stack, including
<a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal notranslate">AS_IS</code></a> values, is passed to the writer’s <code class="xref py py-meth docutils literal notranslate">new_styles()</code> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.pop_style">
formatter.pop_style([n=1])<a class="headerlink" href="#formatter.formatter.pop_style" title="Permalink to this definition">¶</a></dt>
<dd>Pop the last n 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 notranslate">push_style()</code></a>. A tuple
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 notranslate">AS_IS</code></a> values, is passed to
the writer’s <code class="xref py py-meth docutils literal notranslate">new_styles()</code> method.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.set_spacing">
formatter.set_spacing(spacing)<a class="headerlink" href="#formatter.formatter.set_spacing" title="Permalink to this definition">¶</a></dt>
<dd>Set the spacing style for the writer.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.formatter.assert_line_data">
formatter.assert_line_data([flag=1])<a class="headerlink" href="#formatter.formatter.assert_line_data" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

</section>
<section id="formatter-implementations">
<h2>34.1.2. Formatter Implementations<a class="headerlink" href="#formatter-implementations" title="Permalink to this headline">¶</a></h2>
Two implementations of formatter objects are provided by this module. Most
applications may use one of these classes without modification or subclassing.
<dl class="py class">
<dt class="sig sig-object py" id="formatter.NullFormatter">
class formatter.NullFormatter([writer])<a class="headerlink" href="#formatter.NullFormatter" title="Permalink to this definition">¶</a></dt>
<dd>A formatter which does nothing. If writer is omitted, a <a class="reference internal" href="#formatter.NullWriter" title="formatter.NullWriter"><code class="xref py py-class docutils literal notranslate">NullWriter</code></a>
instance is created. No methods of the writer are called by
<a class="reference internal" href="#formatter.NullFormatter" title="formatter.NullFormatter"><code class="xref py py-class docutils literal notranslate">NullFormatter</code></a> instances. Implementations should inherit from this
class if implementing a writer interface but don’t need to inherit any
implementation.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="formatter.AbstractFormatter">
class formatter.AbstractFormatter(writer)<a class="headerlink" href="#formatter.AbstractFormatter" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

</section>
<section id="the-writer-interface">
<h2>34.1.3. The Writer Interface<a class="headerlink" href="#the-writer-interface" title="Permalink to this headline">¶</a></h2>
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 <a class="reference internal" href="#formatter.AbstractFormatter" title="formatter.AbstractFormatter"><code class="xref py py-class docutils literal notranslate">AbstractFormatter</code></a> class as a formatter, the writer must
typically be provided by the application.
<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.flush">
writer.flush()<a class="headerlink" href="#formatter.writer.flush" title="Permalink to this definition">¶</a></dt>
<dd>Flush any buffered output or device control events.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.new_alignment">
writer.new_alignment(align)<a class="headerlink" href="#formatter.writer.new_alignment" title="Permalink to this definition">¶</a></dt>
<dd>Set the alignment style. The align value can be any object, but by convention
is a string or <code class="docutils literal notranslate">None</code>, where <code class="docutils literal notranslate">None</code> indicates that the writer’s “preferred”
alignment should be used. Conventional align values are <code class="docutils literal notranslate">'left'</code>,
<code class="docutils literal notranslate">'center'</code>, <code class="docutils literal notranslate">'right'</code>, and <code class="docutils literal notranslate">'justify'</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.new_font">
writer.new_font(font)<a class="headerlink" href="#formatter.writer.new_font" title="Permalink to this definition">¶</a></dt>
<dd>Set the font style. The value of font will be <code class="docutils literal notranslate">None</code>, indicating that the
device’s default font should be used, or a tuple of the form <code class="docutils literal notranslate">(size,
italic, bold, teletype)</code>. 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.new_margin">
writer.new_margin(margin, level)<a class="headerlink" href="#formatter.writer.new_margin" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.new_spacing">
writer.new_spacing(spacing)<a class="headerlink" href="#formatter.writer.new_spacing" title="Permalink to this definition">¶</a></dt>
<dd>Set the spacing style to spacing.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.new_styles">
writer.new_styles(styles)<a class="headerlink" href="#formatter.writer.new_styles" title="Permalink to this definition">¶</a></dt>
<dd>Set additional styles. The styles value is a tuple of arbitrary values; the
value <a class="reference internal" href="#formatter.AS_IS" title="formatter.AS_IS"><code class="xref py py-const docutils literal notranslate">AS_IS</code></a> 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_line_break">
writer.send_line_break()<a class="headerlink" href="#formatter.writer.send_line_break" title="Permalink to this definition">¶</a></dt>
<dd>Break the current line.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_paragraph">
writer.send_paragraph(blankline)<a class="headerlink" href="#formatter.writer.send_paragraph" title="Permalink to this definition">¶</a></dt>
<dd>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 <a class="reference internal" href="#formatter.writer.send_line_break" title="formatter.writer.send_line_break"><code class="xref py py-meth docutils literal notranslate">send_line_break()</code></a> 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_hor_rule">
writer.send_hor_rule(*args, **kw)<a class="headerlink" href="#formatter.writer.send_hor_rule" title="Permalink to this definition">¶</a></dt>
<dd>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 <a class="reference internal" href="#formatter.writer.send_line_break" title="formatter.writer.send_line_break"><code class="xref py py-meth docutils literal notranslate">send_line_break()</code></a>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_flowing_data">
writer.send_flowing_data(data)<a class="headerlink" href="#formatter.writer.send_flowing_data" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_literal_data">
writer.send_literal_data(data)<a class="headerlink" href="#formatter.writer.send_literal_data" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="xref py py-meth docutils literal notranslate">send_formatted_data()</code> interface.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="formatter.writer.send_label_data">
writer.send_label_data(data)<a class="headerlink" href="#formatter.writer.send_label_data" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

</section>
<section id="writer-implementations">
<h2>34.1.4. Writer Implementations<a class="headerlink" href="#writer-implementations" title="Permalink to this headline">¶</a></h2>
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
<a class="reference internal" href="#formatter.NullWriter" title="formatter.NullWriter"><code class="xref py py-class docutils literal notranslate">NullWriter</code></a> class.
<dl class="py class">
<dt class="sig sig-object py" id="formatter.NullWriter">
class formatter.NullWriter<a class="headerlink" href="#formatter.NullWriter" title="Permalink to this definition">¶</a></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.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="formatter.AbstractWriter">
class formatter.AbstractWriter<a class="headerlink" href="#formatter.AbstractWriter" title="Permalink to this definition">¶</a></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.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="formatter.DumbWriter">
class formatter.DumbWriter(file=None, maxcol=72)<a class="headerlink" href="#formatter.DumbWriter" title="Permalink to this definition">¶</a></dt>
<dd>Simple writer class which writes output on the file object passed in as file
or, if file is <code class="docutils literal notranslate">None</code>, 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.
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">34.1. <code class="xref py py-mod docutils literal notranslate">formatter</code> — Generic output formatting</a><ul>
<li><a class="reference internal" href="#the-formatter-interface">34.1.1. The Formatter Interface</a></li>
<li><a class="reference internal" href="#formatter-implementations">34.1.2. Formatter Implementations</a></li>
<li><a class="reference internal" href="#the-writer-interface">34.1.3. The Writer Interface</a></li>
<li><a class="reference internal" href="#writer-implementations">34.1.4. Writer Implementations</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="misc.html"
 title="previous chapter">34. Miscellaneous Services</a>
 <h4>Next topic</h4>
 <a href="windows.html"
 title="next chapter">35. MS Windows Specific Services</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/formatter.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="windows.html" title="35. MS Windows Specific Services"
 >next</a> |</li>
 <li class="right" >
 <a href="misc.html" title="34. Miscellaneous Services"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="misc.html" >34. Miscellaneous Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">34.1. <code class="xref py py-mod docutils literal notranslate">formatter</code> — Generic output formatting</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : formatter.html