<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"prev" href=
"module-pprint.html" />
<link rel=
"parent" href=
"module-pprint.html" />
<link rel=
"next" href=
"module-repr.html" />
<meta name='aesop' content='information'
/>
<title>3.27.1 PrettyPrinter Objects
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"3.27 pprint "
href=
"module-pprint.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"3.27 pprint "
href=
"module-pprint.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"3.28 repr "
href=
"module-repr.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-pprint.html">3.27 pprint
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-pprint.html">3.27 pprint
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-repr.html">3.28 repr
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION0052710000000000000000"></A>
<A NAME=
"PrettyPrinter_Objects"></A>
3.27.1 PrettyPrinter Objects
<tt class=
"class">PrettyPrinter
</tt> instances have the following methods:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
769' xml:id='l2h-
769'
class=
"method">pformat
</tt></b>(
</nobr></td>
<td><var>object
</var>)
</td></tr></table></dt>
Return the formatted representation of
<var>object
</var>. This takes into
Account the options passed to the
<tt class=
"class">PrettyPrinter
</tt> constructor.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
770' xml:id='l2h-
770'
class=
"method">pprint
</tt></b>(
</nobr></td>
<td><var>object
</var>)
</td></tr></table></dt>
Print the formatted representation of
<var>object
</var> on the configured
stream, followed by a newline.
The following methods provide the implementations for the
corresponding functions of the same names. Using these methods on an
instance is slightly more efficient since new
<tt class=
"class">PrettyPrinter
</tt>
objects don't need to be created.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
771' xml:id='l2h-
771'
class=
"method">isreadable
</tt></b>(
</nobr></td>
<td><var>object
</var>)
</td></tr></table></dt>
Determine if the formatted representation of the object is
``readable,'' or can be used to reconstruct the value using
<tt class=
"function">eval()
</tt><a id='l2h-
772' xml:id='l2h-
772'
></a>. Note that this returns false for
recursive objects. If the
<var>depth
</var> parameter of the
<tt class=
"class">PrettyPrinter
</tt> is set and the object is deeper than allowed,
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
773' xml:id='l2h-
773'
class=
"method">isrecursive
</tt></b>(
</nobr></td>
<td><var>object
</var>)
</td></tr></table></dt>
Determine if the object requires a recursive representation.
This method is provided as a hook to allow subclasses to modify the
way objects are converted to strings. The default implementation uses
the internals of the
<tt class=
"function">saferepr()
</tt> implementation.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
774' xml:id='l2h-
774'
class=
"method">format
</tt></b>(
</nobr></td>
<td><var>object, context, maxlevels, level
</var>)
</td></tr></table></dt>
Returns three values: the formatted version of
<var>object
</var> as a
string, a flag indicating whether the result is readable, and a flag
indicating whether recursion was detected. The first argument is the
object to be presented. The second is a dictionary which contains the
<tt class=
"function">id()
</tt> of objects that are part of the current presentation
context (direct and indirect containers for
<var>object
</var> that are
affecting the presentation) as the keys; if an object needs to be
presented which is already represented in
<var>context
</var>, the third
return value should be true. Recursive calls to the
<tt class=
"method">format()
</tt>
method should add additional entries for containers to this
dictionary. The fourth argument,
<var>maxlevels
</var>, gives the requested
limit to recursion; this will be
<code>0</code> if there is no requested
limit. This argument should be passed unmodified to recursive calls.
The fourth argument,
<var>level
</var> gives the current level; recursive
calls should be passed a value less than that of the current call.
<span class=
"versionnote">New in version
2.3.
</span>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"3.27 pprint "
href=
"module-pprint.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"3.27 pprint "
href=
"module-pprint.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"3.28 repr "
href=
"module-repr.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-pprint.html">3.27 pprint
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-pprint.html">3.27 pprint
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-repr.html">3.28 repr
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.