sam-t2/devtools/v9/html/python/lib/hotshot-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<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="next" href="module-hotshot.stats.html" />
<link rel="prev" href="module-hotshot.html" />
<link rel="parent" href="module-hotshot.html" />
<link rel="next" href="module-hotshot.stats.html" />
<meta name='aesop' content='information' />
<title>10.9.1 Profile Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.9 hotshot  "
  href="module-hotshot.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="10.9 hotshot  "
  href="module-hotshot.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="10.9.2 Using hotshot data"
  href="module-hotshot.stats.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-hotshot.html">10.9 hotshot  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-hotshot.html">10.9 hotshot  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-hotshot.stats.html">10.9.2 Using hotshot data</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0012910000000000000000"></A><A NAME="hotshot-objects"></A>
<BR>
10.9.1 Profile Objects
</H2>

<P>
Profile objects have the following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3123' xml:id='l2h-3123' class="method">addinfo</tt></b>(</nobr></td>
  <td><var>key, value</var>)</td></tr></table></dt>
<dd>
Add an arbitrary labelled value to the profile output.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3124' xml:id='l2h-3124' class="method">close</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Close the logfile and terminate the profiler.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3125' xml:id='l2h-3125' class="method">fileno</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return the file descriptor of the profiler's log file.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3126' xml:id='l2h-3126' class="method">run</tt></b>(</nobr></td>
  <td><var>cmd</var>)</td></tr></table></dt>
<dd>
Profile an <tt class="keyword">exec</tt>-compatible string in the script environment.
The globals from the <tt class="module"><a href="module-main.html">__main__</a></tt> module are used as
both the globals and locals for the script.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3127' xml:id='l2h-3127' class="method">runcall</tt></b>(</nobr></td>
  <td><var>func, *args, **keywords</var>)</td></tr></table></dt>
<dd>
Profile a single call of a callable.
Additional positional and keyword arguments may be passed
along; the result of the call is returned, and exceptions are
allowed to propagate cleanly, while ensuring that profiling is
disabled on the way out.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3128' xml:id='l2h-3128' class="method">runctx</tt></b>(</nobr></td>
  <td><var>cmd, globals, locals</var>)</td></tr></table></dt>
<dd>
Evaluate an <tt class="keyword">exec</tt>-compatible string in a specific environment.
The string is compiled before profiling begins.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3129' xml:id='l2h-3129' class="method">start</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Start the profiler.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-3130' xml:id='l2h-3130' class="method">stop</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Stop the profiler.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="10.9 hotshot  "
  href="module-hotshot.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="10.9 hotshot  "
  href="module-hotshot.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="10.9.2 Using hotshot data"
  href="module-hotshot.stats.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>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-hotshot.html">10.9 hotshot  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-hotshot.html">10.9 hotshot  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-hotshot.stats.html">10.9.2 Using hotshot data</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>