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-querying-manipulating-option-parser.html" /> | |
| 13 | <link rel="prev" href="optparse-standard-option-types.html" /> | |
| 14 | <link rel="parent" href="optparse-reference-guide.html" /> | |
| 15 | <link rel="next" href="optparse-querying-manipulating-option-parser.html" /> | |
| 16 | <meta name='aesop' content='information' /> | |
| 17 | <title>6.21.3.7 Parsing arguments</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.6 Standard option types" | |
| 25 | href="optparse-standard-option-types.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.8 Querying and manipulating" | |
| 31 | href="optparse-querying-manipulating-option-parser.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-standard-option-types.html">6.21.3.6 Standard option types</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-querying-manipulating-option-parser.html">6.21.3.8 Querying and manipulating</A> | |
| 50 | </div> | |
| 51 | <hr /></div> | |
| 52 | </DIV> | |
| 53 | <!--End of Navigation Panel--> | |
| 54 | ||
| 55 | <H3><A NAME="SECTION0082137000000000000000"></A><A NAME="optparse-parsing-arguments"></A> | |
| 56 | <BR> | |
| 57 | 6.21.3.7 Parsing arguments | |
| 58 | </H3> | |
| 59 | ||
| 60 | <P> | |
| 61 | The whole point of creating and populating an OptionParser is to call | |
| 62 | its <tt class="method">parse_args()</tt> method: | |
| 63 | <div class="verbatim"><pre> | |
| 64 | (options, args) = parser.parse_args(args=None, options=None) | |
| 65 | </pre></div> | |
| 66 | ||
| 67 | <P> | |
| 68 | where the input parameters are | |
| 69 | <DL> | |
| 70 | <DT><STRONG><code>args</code></STRONG></DT> | |
| 71 | <DD>the list of arguments to process (<code>sys.argv[1:]</code> by default) | |
| 72 | </DD> | |
| 73 | <DT><STRONG><code>options</code></STRONG></DT> | |
| 74 | <DD>object to store option arguments in (a new instance of | |
| 75 | optparse.Values by default) | |
| 76 | </DD> | |
| 77 | </DL> | |
| 78 | ||
| 79 | <P> | |
| 80 | and the return values are | |
| 81 | <DL> | |
| 82 | <DT><STRONG><code>options</code></STRONG></DT> | |
| 83 | <DD>the same object as was passed in as <code>options</code>, or the new | |
| 84 | optparse.Values instance created by <tt class="module">optparse</tt> | |
| 85 | </DD> | |
| 86 | <DT><STRONG><code>args</code></STRONG></DT> | |
| 87 | <DD>the leftover positional arguments after all options have been | |
| 88 | processed | |
| 89 | </DD> | |
| 90 | </DL> | |
| 91 | ||
| 92 | <P> | |
| 93 | The most common usage is to supply neither keyword argument. If you | |
| 94 | supply a <code>values</code> object, it will be repeatedly modified with a | |
| 95 | <code>setattr()</code> call for every option argument written to an option | |
| 96 | destination, and finally returned by <tt class="method">parse_args()</tt>. | |
| 97 | ||
| 98 | <P> | |
| 99 | If <tt class="method">parse_args()</tt> encounters any errors in the argument list, it calls | |
| 100 | the OptionParser's <tt class="method">error()</tt> method with an appropriate end-user error | |
| 101 | message. This ultimately terminates your process with an exit status of | |
| 102 | 2 (the traditional <span class="Unix">Unix</span> exit status for command-line errors). | |
| 103 | ||
| 104 | <P> | |
| 105 | ||
| 106 | <DIV CLASS="navigation"> | |
| 107 | <div class='online-navigation'> | |
| 108 | <p></p><hr /> | |
| 109 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 110 | <tr> | |
| 111 | <td class='online-navigation'><a rel="prev" title="6.21.3.6 Standard option types" | |
| 112 | href="optparse-standard-option-types.html"><img src='../icons/previous.png' | |
| 113 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 114 | <td class='online-navigation'><a rel="parent" title="6.21.3 Reference Guide" | |
| 115 | href="optparse-reference-guide.html"><img src='../icons/up.png' | |
| 116 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 117 | <td class='online-navigation'><a rel="next" title="6.21.3.8 Querying and manipulating" | |
| 118 | href="optparse-querying-manipulating-option-parser.html"><img src='../icons/next.png' | |
| 119 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 120 | <td align="center" width="100%">Python Library Reference</td> | |
| 121 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 122 | href="contents.html"><img src='../icons/contents.png' | |
| 123 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 124 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 125 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 126 | <td class='online-navigation'><a rel="index" title="Index" | |
| 127 | href="genindex.html"><img src='../icons/index.png' | |
| 128 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 129 | </tr></table> | |
| 130 | <div class='online-navigation'> | |
| 131 | <b class="navlabel">Previous:</b> | |
| 132 | <a class="sectref" rel="prev" href="optparse-standard-option-types.html">6.21.3.6 Standard option types</A> | |
| 133 | <b class="navlabel">Up:</b> | |
| 134 | <a class="sectref" rel="parent" href="optparse-reference-guide.html">6.21.3 Reference Guide</A> | |
| 135 | <b class="navlabel">Next:</b> | |
| 136 | <a class="sectref" rel="next" href="optparse-querying-manipulating-option-parser.html">6.21.3.8 Querying and manipulating</A> | |
| 137 | </div> | |
| 138 | </div> | |
| 139 | <hr /> | |
| 140 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 141 | </DIV> | |
| 142 | <!--End of Navigation Panel--> | |
| 143 | <ADDRESS> | |
| 144 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 145 | </ADDRESS> | |
| 146 | </BODY> | |
| 147 | </HTML> |