Commit | Line | Data |
---|---|---|
86530b38 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-extending-optparse.html" /> | |
13 | <link rel="prev" href="optparse-reference-guide.html" /> | |
14 | <link rel="parent" href="module-optparse.html" /> | |
15 | <link rel="next" href="optparse-defining-callback-option.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>6.21.4 Option Callbacks</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.10 Other methods" | |
25 | href="optparse-other-methods.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 optparse " | |
28 | href="module-optparse.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.4.1 Defining a callback" | |
31 | href="optparse-defining-callback-option.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-other-methods.html">6.21.3.10 Other methods</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="module-optparse.html">6.21 optparse </A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="optparse-defining-callback-option.html">6.21.4.1 Defining a callback</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H2><A NAME="SECTION0082140000000000000000"></A><A NAME="optparse-option-callbacks"></A> | |
56 | <BR> | |
57 | 6.21.4 Option Callbacks | |
58 | </H2> | |
59 | ||
60 | <P> | |
61 | When <tt class="module">optparse</tt>'s built-in actions and types aren't quite enough for your | |
62 | needs, you have two choices: extend <tt class="module">optparse</tt> or define a callback option. | |
63 | Extending <tt class="module">optparse</tt> is more general, but overkill for a lot of simple | |
64 | cases. Quite often a simple callback is all you need. | |
65 | ||
66 | <P> | |
67 | There are two steps to defining a callback option: | |
68 | ||
69 | <UL> | |
70 | <LI> | |
71 | define the option itself using the <code>callback</code> action | |
72 | ||
73 | <P> | |
74 | </LI> | |
75 | <LI> | |
76 | write the callback; this is a function (or method) that | |
77 | takes at least four arguments, as described below | |
78 | ||
79 | <P> | |
80 | </LI> | |
81 | </UL> | |
82 | ||
83 | <P> | |
84 | ||
85 | <p><br /></p><hr class='online-navigation' /> | |
86 | <div class='online-navigation'> | |
87 | <!--Table of Child-Links--> | |
88 | <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> | |
89 | ||
90 | <UL CLASS="ChildLinks"> | |
91 | <LI><A href="optparse-defining-callback-option.html">6.21.4.1 Defining a callback option</a> | |
92 | <LI><A href="optparse-how-callbacks-called.html">6.21.4.2 How callbacks are called</a> | |
93 | <LI><A href="optparse-raising-errors-in-callback.html">6.21.4.3 Raising errors in a callback</a> | |
94 | <LI><A href="optparse-callback-example-1.html">6.21.4.4 Callback example 1: trivial callback</a> | |
95 | <LI><A href="optparse-callback-example-2.html">6.21.4.5 Callback example 2: check option order</a> | |
96 | <LI><A href="optparse-callback-example-3.html">6.21.4.6 Callback example 3: check option order (generalized)</a> | |
97 | <LI><A href="optparse-callback-example-4.html">6.21.4.7 Callback example 4: check arbitrary condition</a> | |
98 | <LI><A href="optparse-callback-example-5.html">6.21.4.8 Callback example 5: fixed arguments</a> | |
99 | <LI><A href="optparse-callback-example-6.html">6.21.4.9 Callback example 6: variable arguments</a> | |
100 | </ul> | |
101 | <!--End of Table of Child-Links--> | |
102 | </div> | |
103 | ||
104 | <DIV CLASS="navigation"> | |
105 | <div class='online-navigation'> | |
106 | <p></p><hr /> | |
107 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
108 | <tr> | |
109 | <td class='online-navigation'><a rel="prev" title="6.21.3.10 Other methods" | |
110 | href="optparse-other-methods.html"><img src='../icons/previous.png' | |
111 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
112 | <td class='online-navigation'><a rel="parent" title="6.21 optparse " | |
113 | href="module-optparse.html"><img src='../icons/up.png' | |
114 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
115 | <td class='online-navigation'><a rel="next" title="6.21.4.1 Defining a callback" | |
116 | href="optparse-defining-callback-option.html"><img src='../icons/next.png' | |
117 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
118 | <td align="center" width="100%">Python Library Reference</td> | |
119 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
120 | href="contents.html"><img src='../icons/contents.png' | |
121 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
122 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
123 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
124 | <td class='online-navigation'><a rel="index" title="Index" | |
125 | href="genindex.html"><img src='../icons/index.png' | |
126 | border='0' height='32' alt='Index' width='32' /></A></td> | |
127 | </tr></table> | |
128 | <div class='online-navigation'> | |
129 | <b class="navlabel">Previous:</b> | |
130 | <a class="sectref" rel="prev" href="optparse-other-methods.html">6.21.3.10 Other methods</A> | |
131 | <b class="navlabel">Up:</b> | |
132 | <a class="sectref" rel="parent" href="module-optparse.html">6.21 optparse </A> | |
133 | <b class="navlabel">Next:</b> | |
134 | <a class="sectref" rel="next" href="optparse-defining-callback-option.html">6.21.4.1 Defining a callback</A> | |
135 | </div> | |
136 | </div> | |
137 | <hr /> | |
138 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
139 | </DIV> | |
140 | <!--End of Navigation Panel--> | |
141 | <ADDRESS> | |
142 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
143 | </ADDRESS> | |
144 | </BODY> | |
145 | </HTML> |