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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cmd2: /Users/amrogers/Developer/Projects/cmd2/example/example.py Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Cmd2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('example_8py.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">example.py</div> </div>
</div>
<div class="contents">
<a href="example_8py.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a><a class="code" href="namespaceexample.html">00001</a> <span class="stringliteral">'''A sample application for cmd2.'''</span>
<a name="l00002"></a>00002
<a name="l00003"></a>00003 <span class="keyword">from</span> cmd2 <span class="keyword">import</span> Cmd, make_option, options
<a name="l00004"></a>00004 <span class="keyword">import</span> unittest, optparse, sys
<a name="l00005"></a>00005
<a name="l00006"></a><a class="code" href="classexample_1_1CmdLineApp.html">00006</a> <span class="keyword">class </span><a class="code" href="classexample_1_1CmdLineApp.html">CmdLineApp</a>(<a class="code" href="classcmd2_1_1Cmd.html">Cmd</a>):
<a name="l00007"></a><a class="code" href="classexample_1_1CmdLineApp.html#a7720e4d8dd45f289c3962be91c05ac33">00007</a> multilineCommands = [<span class="stringliteral">'orate'</span>]
<a name="l00008"></a>00008 Cmd.shortcuts.update({<span class="stringliteral">'&'</span>: <span class="stringliteral">'speak'</span>})
<a name="l00009"></a><a class="code" href="classexample_1_1CmdLineApp.html#a81a94979fcdd998c72d530e47bab88e0">00009</a> maxrepeats = 3
<a name="l00010"></a><a class="code" href="classexample_1_1CmdLineApp.html#adb66a4ed5e10aa018c7e3a4da6779c76">00010</a> redirector = <span class="stringliteral">'->'</span>
<a name="l00011"></a>00011 Cmd.settable.append(<span class="stringliteral">'maxrepeats Max number of `--repeat`s allowed'</span>)
<a name="l00012"></a>00012
<a name="l00013"></a>00013 @<a class="code" href="namespacecmd2.html#a863be2c5e3b9fdec03710fd550801c22">options</a>([make_option(<span class="stringliteral">'-p'</span>, <span class="stringliteral">'--piglatin'</span>, action=<span class="stringliteral">"store_true"</span>, help=<span class="stringliteral">"atinLay"</span>),
<a name="l00014"></a>00014 make_option(<span class="stringliteral">'-s'</span>, <span class="stringliteral">'--shout'</span>, action=<span class="stringliteral">"store_true"</span>, help=<span class="stringliteral">"N00B EMULATION MODE"</span>),
<a name="l00015"></a>00015 make_option(<span class="stringliteral">'-r'</span>, <span class="stringliteral">'--repeat'</span>, type=<span class="stringliteral">"int"</span>, help=<span class="stringliteral">"output [n] times"</span>)
<a name="l00016"></a>00016 ], arg_desc = <span class="stringliteral">'(text to say)'</span>)
<a name="l00017"></a><a class="code" href="classexample_1_1CmdLineApp.html#afdc6e3337a734471574398731d582ec9">00017</a> <span class="keyword">def </span><a class="code" href="classexample_1_1CmdLineApp.html#afdc6e3337a734471574398731d582ec9">do_speak</a>(self, arg, opts=None):
<a name="l00018"></a>00018 <span class="stringliteral">"""Repeats what you tell me to."""</span>
<a name="l00019"></a>00019 arg = <span class="stringliteral">''</span>.join(arg)
<a name="l00020"></a>00020 <span class="keywordflow">if</span> opts.piglatin:
<a name="l00021"></a>00021 arg = <span class="stringliteral">'%s%say'</span> % (arg[1:].rstrip(), arg[0])
<a name="l00022"></a>00022 <span class="keywordflow">if</span> opts.shout:
<a name="l00023"></a>00023 arg = arg.upper()
<a name="l00024"></a>00024 repetitions = opts.repeat <span class="keywordflow">or</span> 1
<a name="l00025"></a>00025 <span class="keywordflow">for</span> i <span class="keywordflow">in</span> range(min(repetitions, self.<a class="code" href="classexample_1_1CmdLineApp.html#a81a94979fcdd998c72d530e47bab88e0">maxrepeats</a>)):
<a name="l00026"></a>00026 self.stdout.write(arg)
<a name="l00027"></a>00027 self.stdout.write(<span class="stringliteral">'\n'</span>)
<a name="l00028"></a>00028 <span class="comment"># self.stdout.write is better than "print", because Cmd can be</span>
<a name="l00029"></a>00029 <span class="comment"># initialized with a non-standard output destination </span>
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="classexample_1_1CmdLineApp.html#a5acab19a8c4c609e944ea1cb345a5ec3">00031</a> do_say = do_speak <span class="comment"># now "say" is a synonym for "speak"</span>
<a name="l00032"></a><a class="code" href="classexample_1_1CmdLineApp.html#ac9058ddc022235f3876c6b410ddeb688">00032</a> do_orate = do_speak <span class="comment"># another synonym, but this one takes multi-line input</span>
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="namespaceexample.html#a067d058cce4025d9c13742cbc474e211">00034</a> c = <a class="code" href="classexample_1_1CmdLineApp.html">CmdLineApp</a>()
<a name="l00035"></a>00035 c.cmdloop()
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="example_8py.html">example.py</a> </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<li class="footer">Generated on Fri Sep 9 2011 10:50:47 for Cmd2 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
</ul>
</div>
</body>
</html>
|
