diff options
author | Skip Montanaro <skip@pobox.com> | 2006-04-21 02:31:07 (GMT) |
---|---|---|
committer | Skip Montanaro <skip@pobox.com> | 2006-04-21 02:31:07 (GMT) |
commit | 262fb9256b33ca592655361d4982ad8d49a88ffe (patch) | |
tree | 2b46894200892adb274224f528ae22218e7d4ccc /Doc | |
parent | c34b931d78d6a8bc534ddea8aed0845b063c9e2a (diff) | |
download | cpython-262fb9256b33ca592655361d4982ad8d49a88ffe.zip cpython-262fb9256b33ca592655361d4982ad8d49a88ffe.tar.gz cpython-262fb9256b33ca592655361d4982ad8d49a88ffe.tar.bz2 |
Allow pstats.Stats creator to specify an alternate to stdout.
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/lib/libprofile.tex | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/lib/libprofile.tex b/Doc/lib/libprofile.tex index 97c7191..9ff5ba0 100644 --- a/Doc/lib/libprofile.tex +++ b/Doc/lib/libprofile.tex @@ -391,17 +391,17 @@ Analysis of the profiler data is done using this class from the % (This \stmodindex use may be hard to change ;-( ) \stmodindex{pstats} -\begin{classdesc}{Stats}{filename\optional{, \moreargs}} +\begin{classdesc}{Stats}{filename\optional{, \moreargs\optional{, stream=sys.stdout}}} This class constructor creates an instance of a ``statistics object'' from a \var{filename} (or set of filenames). \class{Stats} objects are -manipulated by methods, in order to print useful reports. - -The file selected by the above constructor must have been created by -the corresponding version of \module{profile} or \module{cProfile}. -To be specific, there is -\emph{no} file compatibility guaranteed with future versions of this -profiler, and there is no compatibility with files produced by other -profilers. +manipulated by methods, in order to print useful reports. You may specify +an alternate output stream by giving the keyword argument, \code{stream}. + +The file selected by the above constructor must have been created by the +corresponding version of \module{profile} or \module{cProfile}. To be +specific, there is \emph{no} file compatibility guaranteed with future +versions of this profiler, and there is no compatibility with files produced +by other profilers. %(such as the old system profiler). If several files are provided, all the statistics for identical |