Skip to content

C
cpython
Commit 2c8aa650 authored by Fred Drake's avatar Fred Drake
Browse files
Options

Added \label{}s for logical addressing. 

Logical markup.
parent d67e12e6
Hide whitespace changes
Inline Side-by-side
Showing with 74 additions and 70 deletions
Doc/lib/libpprint.tex
View file @ 2c8aa650
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
\stmodindex{pprint} \stmodindex{pprint}
\label{module-pprint} \label{module-pprint}
The \code{pprint} module provides a capability to ``pretty-print'' The \module{pprint} module provides a capability to ``pretty-print''
arbitrary Python data structures in a form which can be used as input arbitrary Python data structures in a form which can be used as input
to the interpreter. If the formatted structures include objects which to the interpreter. If the formatted structures include objects which
are not fundamental Python types, the representation may not be are not fundamental Python types, the representation may not be
...@@ -14,33 +14,33 @@ objects which are not representable as Python constants. ...@@ -14,33 +14,33 @@ objects which are not representable as Python constants.
The formatted representation keeps objects on a single line if it can, The formatted representation keeps objects on a single line if it can,
and breaks them onto multiple lines if they don't fit within the and breaks them onto multiple lines if they don't fit within the
allowed width. Construct PrettyPrinter objects explicitly if you need allowed width. Construct \class{PrettyPrinter} objects explicitly if
to adjust the width constraint. you need to adjust the width constraint.
The \code{pprint} module defines one class: The \module{pprint} module defines one class:
\setindexsubitem{(in module pprint)} \setindexsubitem{(in module pprint)}
% First the implementation class: % First the implementation class:
\begin{funcdesc}{PrettyPrinter}{...} \begin{classdesc}{PrettyPrinter}{...}
Construct a PrettyPrinter instance. This constructor understands Construct a \class{PrettyPrinter} instance. This constructor
several keyword parameters. An output stream may be set using the understands several keyword parameters. An output stream may be set
\var{stream} keyword; the only method used on the stream object is the using the \var{stream} keyword; the only method used on the stream
file protocol's \code{write()} method. If not specified, the object is the file protocol's \method{write()} method. If not
PrettyPrinter adopts \code{sys.stdout}. Three additional parameters specified, the \class{PrettyPrinter} adopts \code{sys.stdout}. Three
may be used to control the formatted representation. The keywords are additional parameters may be used to control the formatted
\var{indent}, \var{depth}, and \var{width}. The amount of indentation representation. The keywords are \var{indent}, \var{depth}, and
added for each recursive level is specified by \var{indent}; the \var{width}. The amount of indentation added for each recursive level
default is one. Other values can cause output to look a little odd, is specified by \var{indent}; the default is one. Other values can
but can make nesting easier to spot. The number of levels which may cause output to look a little odd, but can make nesting easier to
be printed is controlled by \var{depth}; if the data structure being spot. The number of levels which may be printed is controlled by
printed is too deep, the next contained level is replaced by \var{depth}; if the data structure being printed is too deep, the next
\samp{...}. By default, there is no constraint on the depth of the contained level is replaced by \samp{...}. By default, there is no
objects being formatted. The desired output width is constrained constraint on the depth of the objects being formatted. The desired
using the \var{width} parameter; the default is eighty characters. If output width is constrained using the \var{width} parameter; the
a structure cannot be formatted within the constrained width, a best default is eighty characters. If a structure cannot be formatted
effort will be made. within the constrained width, a best effort will be made.
\begin{verbatim} \begin{verbatim}
>>> import pprint, sys >>> import pprint, sys
...@@ -68,12 +68,12 @@ effort will be made. ...@@ -68,12 +68,12 @@ effort will be made.
>>> pp.pprint(tup) >>> pp.pprint(tup)
(266, (267, (307, (287, (288, (...)))))) (266, (267, (307, (287, (288, (...))))))
\end{verbatim} \end{verbatim}
\end{funcdesc} \end{classdesc}
% Now the derivative functions: % Now the derivative functions:
The PrettyPrinter class supports several derivative functions: The \class{PrettyPrinter} class supports several derivative functions:
\begin{funcdesc}{pformat}{object} \begin{funcdesc}{pformat}{object}
Return the formatted representation of \var{object} as a string. The Return the formatted representation of \var{object} as a string. The
...@@ -84,8 +84,8 @@ default parameters for formatting are used. ...@@ -84,8 +84,8 @@ default parameters for formatting are used.
Prints the formatted representation of \var{object} on \var{stream}, Prints the formatted representation of \var{object} on \var{stream},
followed by a newline. If \var{stream} is omitted, \code{sys.stdout} followed by a newline. If \var{stream} is omitted, \code{sys.stdout}
is used. This may be used in the interactive interpreter instead of a is used. This may be used in the interactive interpreter instead of a
\code{print} command for inspecting values. The default parameters \keyword{print} statement for inspecting values. The default
for formatting are used. parameters for formatting are used.
\begin{verbatim} \begin{verbatim}
>>> stuff = sys.path[:] >>> stuff = sys.path[:]
...@@ -104,7 +104,8 @@ for formatting are used. ...@@ -104,7 +104,8 @@ for formatting are used.
\begin{funcdesc}{isreadable}{object} \begin{funcdesc}{isreadable}{object}
Determine if the formatted representation of \var{object} is Determine if the formatted representation of \var{object} is
``readable,'' or can be used to reconstruct the value using ``readable,'' or can be used to reconstruct the value using
\code{eval()}. Note that this returns false for recursive objects. \function{eval()}\bifuncindex{eval}. Note that this returns false for
recursive objects.
\begin{verbatim} \begin{verbatim}
>>> pprint.isreadable(stuff) >>> pprint.isreadable(stuff)
...@@ -136,15 +137,15 @@ l/lib/python1.4/test', '/usr/local/lib/python1.4/sunos5', '/usr/local/lib/python ...@@ -136,15 +137,15 @@ l/lib/python1.4/test', '/usr/local/lib/python1.4/sunos5', '/usr/local/lib/python
\subsection{PrettyPrinter Objects} \subsection{PrettyPrinter Objects}
\label{PrettyPrinter Objects}
PrettyPrinter instances (returned by \code{PrettyPrinter()} above) PrettyPrinter instances have the following methods:
have the following methods.
\setindexsubitem{(PrettyPrinter method)} \setindexsubitem{(PrettyPrinter method)}
\begin{funcdesc}{pformat}{object} \begin{funcdesc}{pformat}{object}
Return the formatted representation of \var{object}. This takes into Return the formatted representation of \var{object}. This takes into
account the options passed to the PrettyPrinter constructor. account the options passed to the \class{PrettyPrinter} constructor.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{pprint}{object} \begin{funcdesc}{pprint}{object}
...@@ -154,15 +155,16 @@ stream, followed by a newline. ...@@ -154,15 +155,16 @@ stream, followed by a newline.
The following methods provide the implementations for the The following methods provide the implementations for the
corresponding functions of the same names. Using these methods on an corresponding functions of the same names. Using these methods on an
instance is slightly more efficient since new PrettyPrinter objects instance is slightly more efficient since new \class{PrettyPrinter}
don't need to be created. objects don't need to be created.
\begin{funcdesc}{isreadable}{object} \begin{funcdesc}{isreadable}{object}
Determine if the formatted representation of the object is Determine if the formatted representation of the object is
``readable,'' or can be used to reconstruct the value using ``readable,'' or can be used to reconstruct the value using
\code{eval()}. Note that this returns false for recursive objects. \function{eval()}\bifuncindex{eval}. Note that this returns false for
If the \var{depth} parameter of the PrettyPrinter is set and the recursive objects. If the \var{depth} parameter of the
object is deeper than allowed, this returns false. \class{PrettyPrinter} is set and the object is deeper than allowed,
this returns false.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{isrecursive}{object} \begin{funcdesc}{isrecursive}{object}
......
Doc/libpprint.tex
View file @ 2c8aa650
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
\stmodindex{pprint} \stmodindex{pprint}
\label{module-pprint} \label{module-pprint}
The \code{pprint} module provides a capability to ``pretty-print'' The \module{pprint} module provides a capability to ``pretty-print''
arbitrary Python data structures in a form which can be used as input arbitrary Python data structures in a form which can be used as input
to the interpreter. If the formatted structures include objects which to the interpreter. If the formatted structures include objects which
are not fundamental Python types, the representation may not be are not fundamental Python types, the representation may not be
...@@ -14,33 +14,33 @@ objects which are not representable as Python constants. ...@@ -14,33 +14,33 @@ objects which are not representable as Python constants.
The formatted representation keeps objects on a single line if it can, The formatted representation keeps objects on a single line if it can,
and breaks them onto multiple lines if they don't fit within the and breaks them onto multiple lines if they don't fit within the
allowed width. Construct PrettyPrinter objects explicitly if you need allowed width. Construct \class{PrettyPrinter} objects explicitly if
to adjust the width constraint. you need to adjust the width constraint.
The \code{pprint} module defines one class: The \module{pprint} module defines one class:
\setindexsubitem{(in module pprint)} \setindexsubitem{(in module pprint)}
% First the implementation class: % First the implementation class:
\begin{funcdesc}{PrettyPrinter}{...} \begin{classdesc}{PrettyPrinter}{...}
Construct a PrettyPrinter instance. This constructor understands Construct a \class{PrettyPrinter} instance. This constructor
several keyword parameters. An output stream may be set using the understands several keyword parameters. An output stream may be set
\var{stream} keyword; the only method used on the stream object is the using the \var{stream} keyword; the only method used on the stream
file protocol's \code{write()} method. If not specified, the object is the file protocol's \method{write()} method. If not
PrettyPrinter adopts \code{sys.stdout}. Three additional parameters specified, the \class{PrettyPrinter} adopts \code{sys.stdout}. Three
may be used to control the formatted representation. The keywords are additional parameters may be used to control the formatted
\var{indent}, \var{depth}, and \var{width}. The amount of indentation representation. The keywords are \var{indent}, \var{depth}, and
added for each recursive level is specified by \var{indent}; the \var{width}. The amount of indentation added for each recursive level
default is one. Other values can cause output to look a little odd, is specified by \var{indent}; the default is one. Other values can
but can make nesting easier to spot. The number of levels which may cause output to look a little odd, but can make nesting easier to
be printed is controlled by \var{depth}; if the data structure being spot. The number of levels which may be printed is controlled by
printed is too deep, the next contained level is replaced by \var{depth}; if the data structure being printed is too deep, the next
\samp{...}. By default, there is no constraint on the depth of the contained level is replaced by \samp{...}. By default, there is no
objects being formatted. The desired output width is constrained constraint on the depth of the objects being formatted. The desired
using the \var{width} parameter; the default is eighty characters. If output width is constrained using the \var{width} parameter; the
a structure cannot be formatted within the constrained width, a best default is eighty characters. If a structure cannot be formatted
effort will be made. within the constrained width, a best effort will be made.
\begin{verbatim} \begin{verbatim}
>>> import pprint, sys >>> import pprint, sys
...@@ -68,12 +68,12 @@ effort will be made. ...@@ -68,12 +68,12 @@ effort will be made.
>>> pp.pprint(tup) >>> pp.pprint(tup)
(266, (267, (307, (287, (288, (...)))))) (266, (267, (307, (287, (288, (...))))))
\end{verbatim} \end{verbatim}
\end{funcdesc} \end{classdesc}
% Now the derivative functions: % Now the derivative functions:
The PrettyPrinter class supports several derivative functions: The \class{PrettyPrinter} class supports several derivative functions:
\begin{funcdesc}{pformat}{object} \begin{funcdesc}{pformat}{object}
Return the formatted representation of \var{object} as a string. The Return the formatted representation of \var{object} as a string. The
...@@ -84,8 +84,8 @@ default parameters for formatting are used. ...@@ -84,8 +84,8 @@ default parameters for formatting are used.
Prints the formatted representation of \var{object} on \var{stream}, Prints the formatted representation of \var{object} on \var{stream},
followed by a newline. If \var{stream} is omitted, \code{sys.stdout} followed by a newline. If \var{stream} is omitted, \code{sys.stdout}
is used. This may be used in the interactive interpreter instead of a is used. This may be used in the interactive interpreter instead of a
\code{print} command for inspecting values. The default parameters \keyword{print} statement for inspecting values. The default
for formatting are used. parameters for formatting are used.
\begin{verbatim} \begin{verbatim}
>>> stuff = sys.path[:] >>> stuff = sys.path[:]
...@@ -104,7 +104,8 @@ for formatting are used. ...@@ -104,7 +104,8 @@ for formatting are used.
\begin{funcdesc}{isreadable}{object} \begin{funcdesc}{isreadable}{object}
Determine if the formatted representation of \var{object} is Determine if the formatted representation of \var{object} is
``readable,'' or can be used to reconstruct the value using ``readable,'' or can be used to reconstruct the value using
\code{eval()}. Note that this returns false for recursive objects. \function{eval()}\bifuncindex{eval}. Note that this returns false for
recursive objects.
\begin{verbatim} \begin{verbatim}
>>> pprint.isreadable(stuff) >>> pprint.isreadable(stuff)
...@@ -136,15 +137,15 @@ l/lib/python1.4/test', '/usr/local/lib/python1.4/sunos5', '/usr/local/lib/python ...@@ -136,15 +137,15 @@ l/lib/python1.4/test', '/usr/local/lib/python1.4/sunos5', '/usr/local/lib/python
\subsection{PrettyPrinter Objects} \subsection{PrettyPrinter Objects}
\label{PrettyPrinter Objects}
PrettyPrinter instances (returned by \code{PrettyPrinter()} above) PrettyPrinter instances have the following methods:
have the following methods.
\setindexsubitem{(PrettyPrinter method)} \setindexsubitem{(PrettyPrinter method)}
\begin{funcdesc}{pformat}{object} \begin{funcdesc}{pformat}{object}
Return the formatted representation of \var{object}. This takes into Return the formatted representation of \var{object}. This takes into
account the options passed to the PrettyPrinter constructor. account the options passed to the \class{PrettyPrinter} constructor.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{pprint}{object} \begin{funcdesc}{pprint}{object}
...@@ -154,15 +155,16 @@ stream, followed by a newline. ...@@ -154,15 +155,16 @@ stream, followed by a newline.
The following methods provide the implementations for the The following methods provide the implementations for the
corresponding functions of the same names. Using these methods on an corresponding functions of the same names. Using these methods on an
instance is slightly more efficient since new PrettyPrinter objects instance is slightly more efficient since new \class{PrettyPrinter}
don't need to be created. objects don't need to be created.
\begin{funcdesc}{isreadable}{object} \begin{funcdesc}{isreadable}{object}
Determine if the formatted representation of the object is Determine if the formatted representation of the object is
``readable,'' or can be used to reconstruct the value using ``readable,'' or can be used to reconstruct the value using
\code{eval()}. Note that this returns false for recursive objects. \function{eval()}\bifuncindex{eval}. Note that this returns false for
If the \var{depth} parameter of the PrettyPrinter is set and the recursive objects. If the \var{depth} parameter of the
object is deeper than allowed, this returns false. \class{PrettyPrinter} is set and the object is deeper than allowed,
this returns false.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{isrecursive}{object} \begin{funcdesc}{isrecursive}{object}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7