sam-t2/devtools/v8plus/html/python/lib/optparse-raising-errors-in-callback.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="optparse-callback-example-1.html" />
<link rel="prev" href="optparse-how-callbacks-called.html" />
<link rel="parent" href="optparse-option-callbacks.html" />
<link rel="next" href="optparse-callback-example-1.html" />
<meta name='aesop' content='information' />
<title>6.21.4.3 Raising errors in a callback</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.21.4.2 How callbacks are"
  href="optparse-how-callbacks-called.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.21.4 Option Callbacks"
  href="optparse-option-callbacks.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.21.4.4 Callback example 1:"
  href="optparse-callback-example-1.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="optparse-how-callbacks-called.html">6.21.4.2 How callbacks are</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="optparse-option-callbacks.html">6.21.4 Option Callbacks</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="optparse-callback-example-1.html">6.21.4.4 Callback example 1:</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H3><A NAME="SECTION0082143000000000000000"></A><A NAME="optparse-raising-errors-in-callback"></A>
<BR>
6.21.4.3 Raising errors in a callback
</H3>

<P>
The callback function should raise OptionValueError if there are any
problems with the option or its argument(s).  <tt class="module">optparse</tt> catches this and
terminates the program, printing the error message you supply to
stderr.  Your message should be clear, concise, accurate, and mention
the option at fault.  Otherwise, the user will have a hard time
figuring out what he did wrong.

<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.21.4.2 How callbacks are"
  href="optparse-how-callbacks-called.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.21.4 Option Callbacks"
  href="optparse-option-callbacks.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.21.4.4 Callback example 1:"
  href="optparse-callback-example-1.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="optparse-how-callbacks-called.html">6.21.4.2 How callbacks are</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="optparse-option-callbacks.html">6.21.4 Option Callbacks</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="optparse-callback-example-1.html">6.21.4.4 Callback example 1:</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>