[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / html / python / lib / node358.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="node359.html" />
<link rel="prev" href="node357.html" />
<link rel="parent" href="module-logging.html" />
<link rel="next" href="node359.html" />
<meta name='aesop' content='information' />
<title>6.29.7 Filter 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="6.29.6 Formatter Objects"
  href="node357.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="6.29 logging  "
  href="module-logging.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="6.29.8 LogRecord Objects"
  href="node359.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="node357.html">6.29.6 Formatter Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-logging.html">6.29 logging  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node359.html">6.29.8 LogRecord Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0082970000000000000000">
6.29.7 Filter Objects</A>
</H2>

<P>
<tt class="class">Filter</tt>s can be used by <tt class="class">Handler</tt>s and <tt class="class">Logger</tt>s for
more sophisticated filtering than is provided by levels. The base filter
class only allows events which are below a certain point in the logger
hierarchy. For example, a filter initialized with "A.B" will allow events
logged by loggers "A.B", "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB",
"B.A.B" etc. If initialized with the empty string, all events are passed.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-2559' xml:id='l2h-2559' class="class">Filter</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>name</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Returns an instance of the <tt class="class">Filter</tt> class. If <var>name</var> is specified,
it names a logger which, together with its children, will have its events
allowed through the filter. If no name is specified, allows every event.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2560' xml:id='l2h-2560' class="method">filter</tt></b>(</nobr></td>
  <td><var>record</var>)</td></tr></table></dt>
<dd>
Is the specified record to be logged? Returns zero for no, nonzero for
yes. If deemed appropriate, the record may be modified in-place by this
method.
</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="6.29.6 Formatter Objects"
  href="node357.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="6.29 logging  "
  href="module-logging.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="6.29.8 LogRecord Objects"
  href="node359.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="node357.html">6.29.6 Formatter Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-logging.html">6.29 logging  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node359.html">6.29.8 LogRecord Objects</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>
Commit	Line	Data
920dae64 AT	1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	2	<html>
	3	<head>
	4	<link rel="STYLESHEET" href="lib.css" type='text/css' />
	5	<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
	6	<link rel='start' href='../index.html' title='Python Documentation Index' />
	7	<link rel="first" href="lib.html" title='Python Library Reference' />
	8	<link rel='contents' href='contents.html' title="Contents" />
	9	<link rel='index' href='genindex.html' title='Index' />
	10	<link rel='last' href='about.html' title='About this document...' />
	11	<link rel='help' href='about.html' title='About this document...' />
	12	<link rel="next" href="node359.html" />
	13	<link rel="prev" href="node357.html" />
	14	<link rel="parent" href="module-logging.html" />
	15	<link rel="next" href="node359.html" />
	16	<meta name='aesop' content='information' />
	17	<title>6.29.7 Filter Objects</title>
	18	</head>
	19	<body>
	20	<DIV CLASS="navigation">
	21	<div id='top-navigation-panel' xml:id='top-navigation-panel'>
	22	<table align="center" width="100%" cellpadding="0" cellspacing="2">
	23	<tr>
	24	<td class='online-navigation'><a rel="prev" title="6.29.6 Formatter Objects"
	25	href="node357.html"><img src='../icons/previous.png'
	26	border='0' height='32' alt='Previous Page' width='32' /></A></td>
	27	<td class='online-navigation'><a rel="parent" title="6.29 logging "
	28	href="module-logging.html"><img src='../icons/up.png'
	29	border='0' height='32' alt='Up One Level' width='32' /></A></td>
	30	<td class='online-navigation'><a rel="next" title="6.29.8 LogRecord Objects"
	31	href="node359.html"><img src='../icons/next.png'
	32	border='0' height='32' alt='Next Page' width='32' /></A></td>
	33	<td align="center" width="100%">Python Library Reference</td>
	34	<td class='online-navigation'><a rel="contents" title="Table of Contents"
	35	href="contents.html"><img src='../icons/contents.png'
	36	border='0' height='32' alt='Contents' width='32' /></A></td>
	37	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
	38	border='0' height='32' alt='Module Index' width='32' /></a></td>
	39	<td class='online-navigation'><a rel="index" title="Index"
	40	href="genindex.html"><img src='../icons/index.png'
	41	border='0' height='32' alt='Index' width='32' /></A></td>
	42	</tr></table>
	43	<div class='online-navigation'>
	44	<b class="navlabel">Previous:</b>
	45	<a class="sectref" rel="prev" href="node357.html">6.29.6 Formatter Objects</A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-logging.html">6.29 logging </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="node359.html">6.29.8 LogRecord Objects</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION0082970000000000000000">
	56	6.29.7 Filter Objects</A>
	57	</H2>
	58
	59	<P>
	60	<tt class="class">Filter</tt>s can be used by <tt class="class">Handler</tt>s and <tt class="class">Logger</tt>s for
	61	more sophisticated filtering than is provided by levels. The base filter
	62	class only allows events which are below a certain point in the logger
	63	hierarchy. For example, a filter initialized with "A.B" will allow events
	64	logged by loggers "A.B", "A.B.C", "A.B.C.D", "A.B.D" etc. but not "A.BB",
65	"B.A.B" etc. If initialized with the empty string, all events are passed.
66
67	<P>
68	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
69	<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-2559' xml:id='l2h-2559' class="class">Filter</tt></b>(</nobr></td>
70	<td><var></var><big>[</big><var>name</var><big>]</big><var></var>)</td></tr></table></dt>
71	<dd>
72	Returns an instance of the <tt class="class">Filter</tt> class. If <var>name</var> is specified,
73	it names a logger which, together with its children, will have its events
74	allowed through the filter. If no name is specified, allows every event.
75	</dl>
76
77	<P>
78	<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
79	<td><nobr><b><tt id='l2h-2560' xml:id='l2h-2560' class="method">filter</tt></b>(</nobr></td>
80	<td><var>record</var>)</td></tr></table></dt>
81	<dd>
82	Is the specified record to be logged? Returns zero for no, nonzero for
83	yes. If deemed appropriate, the record may be modified in-place by this
84	method.
85	</dl>
86
87	<P>
88
89	<DIV CLASS="navigation">
90	<div class='online-navigation'>
91	<p></p><hr />
92	<table align="center" width="100%" cellpadding="0" cellspacing="2">
93	<tr>
94	<td class='online-navigation'><a rel="prev" title="6.29.6 Formatter Objects"
95	href="node357.html"><img src='../icons/previous.png'
96	border='0' height='32' alt='Previous Page' width='32' /></A></td>
97	<td class='online-navigation'><a rel="parent" title="6.29 logging "
98	href="module-logging.html"><img src='../icons/up.png'
99	border='0' height='32' alt='Up One Level' width='32' /></A></td>
100	<td class='online-navigation'><a rel="next" title="6.29.8 LogRecord Objects"
101	href="node359.html"><img src='../icons/next.png'
102	border='0' height='32' alt='Next Page' width='32' /></A></td>
103	<td align="center" width="100%">Python Library Reference</td>
104	<td class='online-navigation'><a rel="contents" title="Table of Contents"
105	href="contents.html"><img src='../icons/contents.png'
106	border='0' height='32' alt='Contents' width='32' /></A></td>
107	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
108	border='0' height='32' alt='Module Index' width='32' /></a></td>
109	<td class='online-navigation'><a rel="index" title="Index"
110	href="genindex.html"><img src='../icons/index.png'
111	border='0' height='32' alt='Index' width='32' /></A></td>
112	</tr></table>
113	<div class='online-navigation'>
114	<b class="navlabel">Previous:</b>
115	<a class="sectref" rel="prev" href="node357.html">6.29.6 Formatter Objects</A>
116	<b class="navlabel">Up:</b>
117	<a class="sectref" rel="parent" href="module-logging.html">6.29 logging </A>
118	<b class="navlabel">Next:</b>
119	<a class="sectref" rel="next" href="node359.html">6.29.8 LogRecord Objects</A>
120	</div>
121	</div>
122	<hr />
123	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
124	</DIV>
125	<!--End of Navigation Panel-->
126	<ADDRESS>
127	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
128	</ADDRESS>
129	</BODY>
130	</HTML>