twisted.python.log.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.python.log</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.python.html">Package python</a> ::
Module log
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.python.log.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.python.log</h2>
Logging and metrics infrastructure.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.DefaultObserver.html"><code>DefaultObserver</code></a></b></td>
<td>Default observer.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital.html"><code>EscapeFromTheMeaninglessConfinesOfCapital</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.FileLogObserver.html"><code>FileLogObserver</code></a></b></td>
<td>Log observer that writes to a file-like object.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.ILogContext.html"><code>ILogContext</code></a></b></td>
<td>Actually, this interface is just a synoym for the dictionary
interface, but it serves as a key for the default information in a
log.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.Logger.html"><code>Logger</code></a></b></td>
<td>This represents a class which may 'own' a log.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.LogPublisher.html"><code>LogPublisher</code></a></b></td>
<td>Class for singleton log message publishing.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.NullFile.html"><code>NullFile</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.log.StdioOnnaStick.html"><code>StdioOnnaStick</code></a></b></td>
<td>Class that pretends to be stout/err.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="callWithContext"></a><span class="summary-sig"><span class="summary-sig-name">callWithContext</span>(<span class=summary-sig-arg>ctx</span>,
<span class=summary-sig-arg>func</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#callWithLogger" class="summary-sig-name"><code>callWithLogger</code></a>(<span class=summary-sig-arg>logger</span>,
<span class=summary-sig-arg>func</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Utility method which wraps a function in a try:/except:, logs a
failure if one occurrs, and uses the system's logPrefix.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="clearIgnores"></a><span class="summary-sig"><span class="summary-sig-name">clearIgnores</span>()</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#debug" class="summary-sig-name"><code>debug</code></a>(<span class="summary-sig-vararg">*stuff</span>,
<span class="summary-sig-kwarg">**otherstuff</span>)</span></code>
<br />
Write some data to the log, indented, so it's easier to distinguish
from 'normal' output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#err" class="summary-sig-name"><code>deferr</code></a>(<span class=summary-sig-arg>_stuff</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Write a failure to the log.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#discardLogs" class="summary-sig-name"><code>discardLogs</code></a>()</span></code>
<br />
Throw away all logs.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#err" class="summary-sig-name"><code>err</code></a>(<span class=summary-sig-arg>_stuff</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Write a failure to the log.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#flushErrors" class="summary-sig-name"><code>flushErrors</code></a>(<span class="summary-sig-vararg">*errorTypes</span>)</span></code>
<br />
Support function for testing frameworks.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="ignoreErrors"></a><span class="summary-sig"><span class="summary-sig-name">ignoreErrors</span>(<span class="summary-sig-vararg">*types</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="initThreads"></a><span class="summary-sig"><span class="summary-sig-name">initThreads</span>()</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="showwarning"></a><span class="summary-sig"><span class="summary-sig-name">showwarning</span>(<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>category</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>lineno</span>,
<span class=summary-sig-arg>file</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#startKeepingErrors" class="summary-sig-name"><code>startKeepingErrors</code></a>()</span></code>
<br />
Support function for testing frameworks.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#startLogging" class="summary-sig-name"><code>startLogging</code></a>(<span class=summary-sig-arg>file</span>,
<span class="summary-sig-vararg">*a</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Initialize logging to a specified file.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#startLoggingWithObserver" class="summary-sig-name"><code>startLoggingWithObserver</code></a>(<span class=summary-sig-arg>observer</span>,
<span class=summary-sig-arg>setStdout</span>)</span></code>
<br />
Initialize logging to a specified observer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.log.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>stuff</span>)</span></code>
<br />
Write some data to the log.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.log.html#_ignoreErrors"><code>_ignoreErrors</code></a></b> = <span title="[]"><code>[] </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.python.log.html#_keepErrors"><code>_keepErrors</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.log.html#_keptErrors"><code>_keptErrors</code></a></b> = <span title="[]"><code>[] </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a
href="twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital.html"
class="link"><code>EscapeFromTheMeaninglessConfinesOfCapital</code></a></font></td>
<td><b><a href="twisted.python.log.html#logOwner"><code>logOwner</code></a></b> = <span title="<twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital instance at 0x8158b44>"><code><twisted.python.log.EscapeFromTheMeaninglessC<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="callWithLogger"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">callWithLogger</span>(<span class=sig-arg>logger</span>,
<span class=sig-arg>func</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Utility method which wraps a function in a try:/except:, logs a
failure if one occurrs, and uses the system's logPrefix.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="debug"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">debug</span>(<span class="sig-vararg">*stuff</span>,
<span class="sig-kwarg">**otherstuff</span>)</span>
</h3>
Write some data to the log, indented, so it's easier to distinguish
from 'normal' output.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="err"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deferr</span>(<span class=sig-arg>_stuff</span>=<span class=sig-default>None</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Write a failure to the log.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="discardLogs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">discardLogs</span>()</span>
</h3>
Throw away all logs.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="err"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">err</span>(<span class=sig-arg>_stuff</span>=<span class=sig-default>None</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Write a failure to the log.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="flushErrors"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">flushErrors</span>(<span class="sig-vararg">*errorTypes</span>)</span>
</h3>
<p>Support function for testing frameworks.</p>
Return a list of errors that occurred since the last call to
flushErrors(). (This will return None unless startKeepingErrors has
been called.)
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="startKeepingErrors"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startKeepingErrors</span>()</span>
</h3>
<p>Support function for testing frameworks.</p>
Start keeping errors in a buffer which can be retrieved (and
emptied) with flushErrors.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="startLogging"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startLogging</span>(<span class=sig-arg>file</span>,
<span class="sig-vararg">*a</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Initialize logging to a specified file.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="startLoggingWithObserver"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startLoggingWithObserver</span>(<span class=sig-arg>observer</span>,
<span class=sig-arg>setStdout</span>=<span class=sig-default>1</span>)</span>
</h3>
Initialize logging to a specified observer. If setStdout is true
(defaults to yes), also redirect sys.stdout and sys.stderr to the
specified file.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="write"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>stuff</span>)</span>
</h3>
Write some data to the log. DEPRECATED. Use <a
href="twisted.python.log.LogPublisher.html#msg"
class="link"><code>msg</code></a> instead.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_ignoreErrors"></a>
<h3>_ignoreErrors</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_keepErrors"></a>
<h3>_keepErrors</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_keptErrors"></a>
<h3>_keptErrors</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="logOwner"></a>
<h3>logOwner</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a
href="twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital.html"
class="link"><code>EscapeFromTheMeaninglessConfinesOfCapital</code></a>
</dd>
<span title="<twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital instance at 0x8158b44>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<twisted.python.log.EscapeFromTheMeaninglessConfinesOfCapital instance<span class="variable-linewrap">\</span>
at 0x8158b44> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:19 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>