projects / OpenSPARC-T2-SAM / blame
| 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="optparse-parsing-arguments.html" /> | |
| 13 | <link rel="prev" href="optparse-option-attributes.html" /> | |
| 14 | <link rel="parent" href="optparse-reference-guide.html" /> | |
| 15 | <link rel="next" href="optparse-parsing-arguments.html" /> | |
| 16 | <meta name='aesop' content='information' /> | |
| 17 | <title>6.21.3.6 Standard option types</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.21.3.5 Option attributes" | |
| 25 | href="optparse-option-attributes.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.21.3 Reference Guide" | |
| 28 | href="optparse-reference-guide.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.21.3.7 Parsing arguments" | |
| 31 | href="optparse-parsing-arguments.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="optparse-option-attributes.html">6.21.3.5 Option attributes</A> | |
| 46 | <b class="navlabel">Up:</b> | |
| 47 | <a class="sectref" rel="parent" href="optparse-reference-guide.html">6.21.3 Reference Guide</A> | |
| 48 | <b class="navlabel">Next:</b> | |
| 49 | <a class="sectref" rel="next" href="optparse-parsing-arguments.html">6.21.3.7 Parsing arguments</A> | |
| 50 | </div> | |
| 51 | <hr /></div> | |
| 52 | </DIV> | |
| 53 | <!--End of Navigation Panel--> | |
| 54 | ||
| 55 | <H3><A NAME="SECTION0082136000000000000000"></A><A NAME="optparse-standard-option-types"></A> | |
| 56 | <BR> | |
| 57 | 6.21.3.6 Standard option types | |
| 58 | </H3> | |
| 59 | ||
| 60 | <P> | |
| 61 | <tt class="module">optparse</tt> has six built-in option types: <code>string</code>, <code>int</code>, <code>long</code>, | |
| 62 | <code>choice</code>, <code>float</code> and <code>complex</code>. If you need to add new option | |
| 63 | types, see section <A HREF="#optparse-extending"><tex2html_cross_ref_visible_mark></A>, Extending <tt class="module">optparse</tt>. | |
| 64 | ||
| 65 | <P> | |
| 66 | Arguments to string options are not checked or converted in any way: the | |
| 67 | text on the command line is stored in the destination (or passed to the | |
| 68 | callback) as-is. | |
| 69 | ||
| 70 | <P> | |
| 71 | Integer arguments are passed to <code>int()</code> to convert them to Python | |
| 72 | integers. If <code>int()</code> fails, so will <tt class="module">optparse</tt>, although with a more | |
| 73 | useful error message. (Internally, <tt class="module">optparse</tt> raises OptionValueError; | |
| 74 | OptionParser catches this exception higher up and terminates your | |
| 75 | program with a useful error message.) | |
| 76 | ||
| 77 | <P> | |
| 78 | Likewise, <code>float</code> arguments are passed to <code>float()</code> for conversion, | |
| 79 | <code>long</code> arguments to <code>long()</code>, and <code>complex</code> arguments to | |
| 80 | <code>complex()</code>. Apart from that, they are handled identically to integer | |
| 81 | arguments. | |
| 82 | ||
| 83 | <P> | |
| 84 | <code>choice</code> options are a subtype of <code>string</code> options. The <code>choices</code> | |
| 85 | option attribute (a sequence of strings) defines the set of allowed | |
| 86 | option arguments. <code>optparse.check_choice()</code> compares | |
| 87 | user-supplied option arguments against this master list and raises | |
| 88 | OptionValueError if an invalid string is given. | |
| 89 | ||
| 90 | <P> | |
| 91 | ||
| 92 | <DIV CLASS="navigation"> | |
| 93 | <div class='online-navigation'> | |
| 94 | <p></p><hr /> | |
| 95 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 96 | <tr> | |
| 97 | <td class='online-navigation'><a rel="prev" title="6.21.3.5 Option attributes" | |
| 98 | href="optparse-option-attributes.html"><img src='../icons/previous.png' | |
| 99 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 100 | <td class='online-navigation'><a rel="parent" title="6.21.3 Reference Guide" | |
| 101 | href="optparse-reference-guide.html"><img src='../icons/up.png' | |
| 102 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 103 | <td class='online-navigation'><a rel="next" title="6.21.3.7 Parsing arguments" | |
| 104 | href="optparse-parsing-arguments.html"><img src='../icons/next.png' | |
| 105 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 106 | <td align="center" width="100%">Python Library Reference</td> | |
| 107 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 108 | href="contents.html"><img src='../icons/contents.png' | |
| 109 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 110 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 111 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 112 | <td class='online-navigation'><a rel="index" title="Index" | |
| 113 | href="genindex.html"><img src='../icons/index.png' | |
| 114 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 115 | </tr></table> | |
| 116 | <div class='online-navigation'> | |
| 117 | <b class="navlabel">Previous:</b> | |
| 118 | <a class="sectref" rel="prev" href="optparse-option-attributes.html">6.21.3.5 Option attributes</A> | |
| 119 | <b class="navlabel">Up:</b> | |
| 120 | <a class="sectref" rel="parent" href="optparse-reference-guide.html">6.21.3 Reference Guide</A> | |
| 121 | <b class="navlabel">Next:</b> | |
| 122 | <a class="sectref" rel="next" href="optparse-parsing-arguments.html">6.21.3.7 Parsing arguments</A> | |
| 123 | </div> | |
| 124 | </div> | |
| 125 | <hr /> | |
| 126 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 127 | </DIV> | |
| 128 | <!--End of Navigation Panel--> | |
| 129 | <ADDRESS> | |
| 130 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 131 | </ADDRESS> | |
| 132 | </BODY> | |
| 133 | </HTML> |