File: //usr/share/doc/python-docs-2.4.3/html/lib/warning-categories.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="warning-filter.html" />
<link rel="prev" href="module-warnings.html" />
<link rel="parent" href="module-warnings.html" />
<link rel="next" href="warning-filter.html" />
<meta name='aesop' content='information' />
<title>3.20.1 Warning Categories </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="3.20 warnings "
href="module-warnings.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="3.20 warnings "
href="module-warnings.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="3.20.2 The Warnings Filter"
href="warning-filter.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-warnings.html">3.20 warnings </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-warnings.html">3.20 warnings </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="warning-filter.html">3.20.2 The Warnings Filter</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION0052010000000000000000"></A><A NAME="warning-categories"></A>
<BR>
3.20.1 Warning Categories
</H2>
<P>
There are a number of built-in exceptions that represent warning
categories. This categorization is useful to be able to filter out
groups of warnings. The following warnings category classes are
currently defined:
<P>
<div class="center"><table class="realtable">
<thead>
<tr>
<th class="left" >Class</th>
<th class="left" >Description</th>
</tr>
</thead>
<tbody>
<P>
<tr><td class="left" valign="baseline"><tt class="exception">Warning</tt></td>
<td class="left" >This is the base class of all warning category
classes. It is a subclass of <tt class="exception">Exception</tt>.</td></tr><P>
<tr><td class="left" valign="baseline"><tt class="exception">UserWarning</tt></td>
<td class="left" >The default category for <tt class="function">warn()</tt>.</td></tr><P>
<tr><td class="left" valign="baseline"><tt class="exception">DeprecationWarning</tt></td>
<td class="left" >Base category for warnings about
deprecated features.</td></tr><P>
<tr><td class="left" valign="baseline"><tt class="exception">SyntaxWarning</tt></td>
<td class="left" >Base category for warnings about dubious
syntactic features.</td></tr><P>
<tr><td class="left" valign="baseline"><tt class="exception">RuntimeWarning</tt></td>
<td class="left" >Base category for warnings about dubious
runtime features.</td></tr><P>
<tr><td class="left" valign="baseline"><tt class="exception">FutureWarning</tt></td>
<td class="left" >Base category for warnings about constructs
that will change semantically in the future.</td></tr><P>
</tbody>
</table></div>
<P>
While these are technically built-in exceptions, they are documented
here, because conceptually they belong to the warnings mechanism.
<P>
User code can define additional warning categories by subclassing one
of the standard warning categories. A warning category must always be
a subclass of the <tt class="exception">Warning</tt> class.
<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="3.20 warnings "
href="module-warnings.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="3.20 warnings "
href="module-warnings.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="3.20.2 The Warnings Filter"
href="warning-filter.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-warnings.html">3.20 warnings </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-warnings.html">3.20 warnings </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="warning-filter.html">3.20.2 The Warnings Filter</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.3, documentation updated on 29 March 2006.</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>