[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / 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.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="warning-filter.html" />
	13	<link rel="prev" href="module-warnings.html" />
	14	<link rel="parent" href="module-warnings.html" />
	15	<link rel="next" href="warning-filter.html" />
	16	<meta name='aesop' content='information' />
	17	<title>3.20.1 Warning Categories </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="3.20 warnings "
	25	href="module-warnings.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="3.20 warnings "
	28	href="module-warnings.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="3.20.2 The Warnings Filter"
	31	href="warning-filter.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="module-warnings.html">3.20 warnings </A>
	46	<b class="navlabel">Up:</b>
	47	<a class="sectref" rel="parent" href="module-warnings.html">3.20 warnings </A>
	48	<b class="navlabel">Next:</b>
	49	<a class="sectref" rel="next" href="warning-filter.html">3.20.2 The Warnings Filter</A>
	50	</div>
	51	<hr /></div>
	52	</DIV>
	53	<!--End of Navigation Panel-->
	54
	55	<H2><A NAME="SECTION0052010000000000000000"></A><A NAME="warning-categories"></A>
	56	<BR>
	57	3.20.1 Warning Categories
	58	</H2>
	59
	60	<P>
	61	There are a number of built-in exceptions that represent warning
	62	categories. This categorization is useful to be able to filter out
	63	groups of warnings. The following warnings category classes are
	64	currently defined:
65
66	<P>
67	<div class="center"><table class="realtable">
68	<thead>
69	<tr>
70	<th class="left" >Class</th>
71	<th class="left" >Description</th>
72	</tr>
73	</thead>
74	<tbody>
75	<P>
76
77	<tr><td class="left" valign="baseline"><tt class="exception">Warning</tt></td>
78	<td class="left" >This is the base class of all warning category
79	classes. It is a subclass of <tt class="exception">Exception</tt>.</td></tr><P>
80
81	<tr><td class="left" valign="baseline"><tt class="exception">UserWarning</tt></td>
82	<td class="left" >The default category for <tt class="function">warn()</tt>.</td></tr><P>
83
84	<tr><td class="left" valign="baseline"><tt class="exception">DeprecationWarning</tt></td>
85	<td class="left" >Base category for warnings about
86	deprecated features.</td></tr><P>
87
88	<tr><td class="left" valign="baseline"><tt class="exception">SyntaxWarning</tt></td>
89	<td class="left" >Base category for warnings about dubious
90	syntactic features.</td></tr><P>
91
92	<tr><td class="left" valign="baseline"><tt class="exception">RuntimeWarning</tt></td>
93	<td class="left" >Base category for warnings about dubious
94	runtime features.</td></tr><P>
95
96	<tr><td class="left" valign="baseline"><tt class="exception">FutureWarning</tt></td>
97	<td class="left" >Base category for warnings about constructs
98	that will change semantically in the future.</td></tr><P>
99
100	</tbody>
101	</table></div>
102
103	<P>
104	While these are technically built-in exceptions, they are documented
105	here, because conceptually they belong to the warnings mechanism.
106
107	<P>
108	User code can define additional warning categories by subclassing one
109	of the standard warning categories. A warning category must always be
110	a subclass of the <tt class="exception">Warning</tt> class.
111
112	<P>
113
114	<DIV CLASS="navigation">
115	<div class='online-navigation'>
116	<p></p><hr />
117	<table align="center" width="100%" cellpadding="0" cellspacing="2">
118	<tr>
119	<td class='online-navigation'><a rel="prev" title="3.20 warnings "
120	href="module-warnings.html"><img src='../icons/previous.png'
121	border='0' height='32' alt='Previous Page' width='32' /></A></td>
122	<td class='online-navigation'><a rel="parent" title="3.20 warnings "
123	href="module-warnings.html"><img src='../icons/up.png'
124	border='0' height='32' alt='Up One Level' width='32' /></A></td>
125	<td class='online-navigation'><a rel="next" title="3.20.2 The Warnings Filter"
126	href="warning-filter.html"><img src='../icons/next.png'
127	border='0' height='32' alt='Next Page' width='32' /></A></td>
128	<td align="center" width="100%">Python Library Reference</td>
129	<td class='online-navigation'><a rel="contents" title="Table of Contents"
130	href="contents.html"><img src='../icons/contents.png'
131	border='0' height='32' alt='Contents' width='32' /></A></td>
132	<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
133	border='0' height='32' alt='Module Index' width='32' /></a></td>
134	<td class='online-navigation'><a rel="index" title="Index"
135	href="genindex.html"><img src='../icons/index.png'
136	border='0' height='32' alt='Index' width='32' /></A></td>
137	</tr></table>
138	<div class='online-navigation'>
139	<b class="navlabel">Previous:</b>
140	<a class="sectref" rel="prev" href="module-warnings.html">3.20 warnings </A>
141	<b class="navlabel">Up:</b>
142	<a class="sectref" rel="parent" href="module-warnings.html">3.20 warnings </A>
143	<b class="navlabel">Next:</b>
144	<a class="sectref" rel="next" href="warning-filter.html">3.20.2 The Warnings Filter</A>
145	</div>
146	</div>
147	<hr />
148	<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
149	</DIV>
150	<!--End of Navigation Panel-->
151	<ADDRESS>
152	See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
153	</ADDRESS>
154	</BODY>
155	</HTML>