1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Camelot.camelot.bin.camelot_manage.CommandOptionParser</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package Camelot ::
<a href="Camelot.camelot-module.html">Package camelot</a> ::
<a href="Camelot.camelot.bin-module.html">Package bin</a> ::
<a href="Camelot.camelot.bin.camelot_manage-module.html">Module camelot_manage</a> ::
Class CommandOptionParser
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Camelot.camelot.bin.camelot_manage.CommandOptionParser-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class CommandOptionParser</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#CommandOptionParser">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_camelot__22" name="uml_class_diagram_for_camelot__22">
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.standard_option_list" alt="" coords="17,233,1319,252"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.__init__" alt="" coords="17,255,1319,273"/>
<area shape="rect" href="javascript:void(0);" title="Declare that you are done with this OptionParser.  This cleans up reference cycles so the OptionParser (and all objects referenced by it) can be garbage-collected promptly.  After calling destroy(), the OptionParser is unusable." alt="" coords="17,273,1319,292"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.set_usage" alt="" coords="17,292,1319,311"/>
<area shape="rect" href="javascript:void(0);" title="Set parsing to not stop on the first non-option, allowing interspersing switches with command arguments. This is the default behavior. See also disable_interspersed_args() and the class documentation description of the attribute allow_interspersed_args." alt="" coords="17,311,1319,329"/>
<area shape="rect" href="javascript:void(0);" title="Set parsing to stop on the first non-option. Use this if you have a command processor which runs another command that has options of its own and you want to make sure these options don't get confused." alt="" coords="17,329,1319,348"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.set_process_default_values" alt="" coords="17,348,1319,367"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.set_default" alt="" coords="17,367,1319,385"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.set_defaults" alt="" coords="17,385,1319,404"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.get_default_values" alt="" coords="17,404,1319,423"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.add_option_group" alt="" coords="17,423,1319,441"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionParser.get_option_group" alt="" coords="17,441,1319,460"/>
<area shape="rect" href="javascript:void(0);" title="values : Values = None)" alt="" coords="17,460,1319,479"/>
<area shape="rect" href="javascript:void(0);" title="check_values(values : Values, args : [string]) -> (values : Values, args : [string])" alt="" coords="17,479,1319,497"/>
<area shape="rect" href="javascript:void(0);" title="print_help(file : file = stdout)" alt="" coords="17,516,1319,535"/>
<area shape="rect" href="javascript:void(0);" title="Class attributes: standard_option_list : [Option] list of standard options that will be accepted by all instances of this parser class (intended to be overridden by subclasses)." alt="" coords="16,216,1320,536"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.CommandOptionParser-class.html#format_help" title="Camelot.camelot.bin.camelot_manage.CommandOptionParser.format_help" alt="" coords="569,591,767,609"/>
<area shape="rect" href="Camelot.camelot.bin.camelot_manage.CommandOptionParser-class.html" title="Camelot.camelot.bin.camelot_manage.CommandOptionParser" alt="" coords="568,565,768,611"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.set_conflict_handler" alt="" coords="568,36,768,55"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.set_description" alt="" coords="568,55,768,73"/>
<area shape="rect" href="javascript:void(0);" title="add_option(opt_str, ..., kwarg=val, ...)" alt="" coords="568,73,768,92"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.add_options" alt="" coords="568,92,768,111"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.get_option" alt="" coords="568,111,768,129"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.has_option" alt="" coords="568,129,768,148"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.remove_option" alt="" coords="568,148,768,167"/>
<area shape="rect" href="javascript:void(0);" title="optparse.OptionContainer.format_description" alt="" coords="568,167,768,185"/>
<area shape="rect" href="javascript:void(0);" title="Abstract base class." alt="" coords="567,11,769,187"/>
</map>
<img src="uml_class_diagram_for_camelot__22.gif" alt='' usemap="#uml_class_diagram_for_camelot__22" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.bin.camelot_manage.CommandOptionParser-class.html#format_help" class="summary-sig-name">format_help</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">formatter</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#CommandOptionParser.format_help">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionParser</code></b>:
<code>__init__</code>,
<code>add_option_group</code>,
<code>check_values</code>,
<code>destroy</code>,
<code>disable_interspersed_args</code>,
<code>enable_interspersed_args</code>,
<code>error</code>,
<code>exit</code>,
<code>expand_prog_name</code>,
<code>format_epilog</code>,
<code>format_option_help</code>,
<code>get_default_values</code>,
<code>get_description</code>,
<code>get_option_group</code>,
<code>get_prog_name</code>,
<code>get_usage</code>,
<code>get_version</code>,
<code>parse_args</code>,
<code>print_help</code>,
<code>print_usage</code>,
<code>print_version</code>,
<code>set_default</code>,
<code>set_defaults</code>,
<code>set_process_default_values</code>,
<code>set_usage</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionContainer</code></b>:
<code>add_option</code>,
<code>add_options</code>,
<code>format_description</code>,
<code>get_option</code>,
<code>has_option</code>,
<code>remove_option</code>,
<code>set_conflict_handler</code>,
<code>set_description</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>optparse.OptionParser</code></b>:
<code>standard_option_list</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="format_help"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">format_help</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">formatter</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.bin.camelot_manage-pysrc.html#CommandOptionParser.format_help">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
optparse.OptionContainer.format_help
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sat Jun 12 15:41:32 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
