forked from softlayer/softlayer-python
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathexample_module.html
More file actions
182 lines (148 loc) · 9.7 KB
/
example_module.html
File metadata and controls
182 lines (148 loc) · 9.7 KB
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
<!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/html; charset=utf-8" />
<title><no title> — SoftLayer API Python Client 2.3.1 documentation</title>
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="SoftLayer API Python Client 2.3.1 documentation" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">SoftLayer API Python Client 2.3.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="highlight-python"><div class="highlight"><pre><span class="sd">"""</span>
<span class="sd">usage: sl example [<command>] [<args>...] [options]</span>
<span class="sd">Example implementation of a CLI module</span>
<span class="sd">Available commands are:</span>
<span class="sd"> print print example</span>
<span class="sd"> pretty formatted print example</span>
<span class="sd"> parse parsing args example</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">SoftLayer.CLI</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">CLIRunnable</span><span class="p">,</span> <span class="n">Table</span><span class="p">,</span> <span class="n">no_going_back</span><span class="p">,</span> <span class="n">confirm</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ExampleAction</span><span class="p">(</span><span class="n">CLIRunnable</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd">usage: sl example print [options]</span>
<span class="sd">Print example</span>
<span class="sd">"""</span>
<span class="n">action</span> <span class="o">=</span> <span class="s">'print'</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"EXAMPLE!"</span>
<span class="k">class</span> <span class="nc">ExamplePretty</span><span class="p">(</span><span class="n">CLIRunnable</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd">usage: sl example pretty [options]</span>
<span class="sd">Pretty output example</span>
<span class="sd">"""</span>
<span class="n">action</span> <span class="o">=</span> <span class="s">'pretty'</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="c"># create a table with two columns: col1, col2</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">Table</span><span class="p">([</span><span class="s">'col1'</span><span class="p">,</span> <span class="s">'col2'</span><span class="p">])</span>
<span class="c"># align the data facing each other</span>
<span class="c"># valid values are r, c, l for right, center, left</span>
<span class="c"># note, these are suggestions based on the format chosen by the user</span>
<span class="n">t</span><span class="o">.</span><span class="n">align</span><span class="p">[</span><span class="s">'col1'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'r'</span>
<span class="n">t</span><span class="o">.</span><span class="n">align</span><span class="p">[</span><span class="s">'col2'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'l'</span>
<span class="c"># add rows</span>
<span class="n">t</span><span class="o">.</span><span class="n">add_row</span><span class="p">([</span><span class="s">'test'</span><span class="p">,</span> <span class="s">'test'</span><span class="p">])</span>
<span class="n">t</span><span class="o">.</span><span class="n">add_row</span><span class="p">([</span><span class="s">'test2'</span><span class="p">,</span> <span class="s">'test2'</span><span class="p">])</span>
<span class="k">return</span> <span class="n">t</span>
<span class="k">class</span> <span class="nc">ExampleArgs</span><span class="p">(</span><span class="n">CLIRunnable</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd">usage: sl example parse [--test] [--this=THIS|--that=THAT]</span>
<span class="sd"> (--one|--two) [options]</span>
<span class="sd">Argument parsing example</span>
<span class="sd">Options:</span>
<span class="sd"> --test Print different output</span>
<span class="sd">"""</span>
<span class="n">action</span> <span class="o">=</span> <span class="s">'parse'</span>
<span class="n">options</span> <span class="o">=</span> <span class="p">[</span><span class="s">'confirm'</span><span class="p">]</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'--test'</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"Just testing, move along..."</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">print</span> <span class="s">"This is fo'realz!"</span>
<span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="s">'--one'</span><span class="p">]:</span>
<span class="k">print</span> <span class="mi">1</span>
<span class="k">elif</span> <span class="n">args</span><span class="p">[</span><span class="s">'--two'</span><span class="p">]:</span>
<span class="k">print</span> <span class="mi">2</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'--this'</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"I gots"</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="s">'--this'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'--that'</span><span class="p">):</span>
<span class="k">print</span> <span class="s">"you dont have"</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="s">'--that'</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/cli/example_module.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">SoftLayer API Python Client 2.3.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, SoftLayer Technologies, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>