Debian Codegraph @

doc/scripting/lib.scripting.System-class.html

raw
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>lib.scripting.System</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35 </table>
36 <table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 Package&nbsp;lib ::
41 <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
42 Class&nbsp;System
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="lib.scripting.System-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57 </table>
58 <!-- ==================== CLASS DESCRIPTION ==================== -->
59 <h1 class="epydoc">Class System</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#System">source&nbsp;code</a></span></p>
60 <p>Simplified access to some system commands.</p>
61
62 <!-- ==================== INSTANCE METHODS ==================== -->
63 <a name="section-InstanceMethods"></a>
64 <table class="summary" border="1" cellpadding="3"
65 cellspacing="0" width="100%" bgcolor="white">
66 <tr bgcolor="#70b0f0" class="table-header">
67 <td colspan="2" class="table-header">
68 <table border="0" cellpadding="0" cellspacing="0" width="100%">
69 <tr valign="top">
70 <td align="left"><span class="table-header">Instance Methods</span></td>
71 <td align="right" valign="top"
72 ><span class="options">[<a href="#section-InstanceMethods"
73 class="privatelink" onclick="toggle_private();"
74 >hide private</a>]</span></td>
75 </tr>
76 </table>
77 </td>
78 </tr>
79 <tr>
80 <td width="15%" align="right" valign="top" class="summary">
81 <span class="summary-type">&nbsp;</span>
82 </td><td class="summary">
83 <table width="100%" cellpadding="0" cellspacing="0" border="0">
84 <tr>
85 <td><span class="summary-sig"><a href="lib.scripting.System-class.html#exec_command" class="summary-sig-name">exec_command</a>(<span class="summary-sig-arg">self</span>,
86 <span class="summary-sig-arg">command</span>,
87 <span class="summary-sig-arg">getOutput</span>=<span class="summary-sig-default">True</span>)</span><br />
88 Execute a shell command</td>
89 <td align="right" valign="top">
90 <span class="codelink"><a href="lib.scripting-pysrc.html#System.exec_command">source&nbsp;code</a></span>
91
92 </td>
93 </tr>
94 </table>
95
96 </td>
97 </tr>
98 <tr>
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type">&nbsp;</span>
101 </td><td class="summary">
102 <table width="100%" cellpadding="0" cellspacing="0" border="0">
103 <tr>
104 <td><span class="summary-sig"><a href="lib.scripting.System-class.html#create_file" class="summary-sig-name">create_file</a>(<span class="summary-sig-arg">self</span>,
105 <span class="summary-sig-arg">fileName</span>,
106 <span class="summary-sig-arg">contents</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
107 Create a file with contents</td>
108 <td align="right" valign="top">
109 <span class="codelink"><a href="lib.scripting-pysrc.html#System.create_file">source&nbsp;code</a></span>
110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117 </table>
118 <!-- ==================== METHOD DETAILS ==================== -->
119 <a name="section-MethodDetails"></a>
120 <table class="details" border="1" cellpadding="3"
121 cellspacing="0" width="100%" bgcolor="white">
122 <tr bgcolor="#70b0f0" class="table-header">
123 <td colspan="2" class="table-header">
124 <table border="0" cellpadding="0" cellspacing="0" width="100%">
125 <tr valign="top">
126 <td align="left"><span class="table-header">Method Details</span></td>
127 <td align="right" valign="top"
128 ><span class="options">[<a href="#section-MethodDetails"
129 class="privatelink" onclick="toggle_private();"
130 >hide private</a>]</span></td>
131 </tr>
132 </table>
133 </td>
134 </tr>
135 </table>
136 <a name="exec_command"></a>
137 <div>
138 <table class="details" border="1" cellpadding="3"
139 cellspacing="0" width="100%" bgcolor="white">
140 <tr><td>
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
142 <tr valign="top"><td>
143 <h3 class="epydoc"><span class="sig"><span class="sig-name">exec_command</span>(<span class="sig-arg">self</span>,
144 <span class="sig-arg">command</span>,
145 <span class="sig-arg">getOutput</span>=<span class="sig-default">True</span>)</span>
146 </h3>
147 </td><td align="right" valign="top"
148 ><span class="codelink"><a href="lib.scripting-pysrc.html#System.exec_command">source&nbsp;code</a></span>&nbsp;
149 </td>
150 </tr></table>
151
152 <p>Execute a shell command</p>
153 <p>Usage: <code>system.exec_command(command, getOutput=True)</code></p>
154 <p>Set getOutput to False if the command does not exit and return
155 immediately. Otherwise AutoKey will not respond to any
156 hotkeys/abbreviations etc until the process started by the command
157 exits.</p>
158 <dl class="fields">
159 <dt>Parameters:</dt>
160 <dd><ul class="nomargin-top">
161 <li><strong class="pname"><code>command</code></strong> - command to be executed (including any arguments) - e.g. &quot;ls
162 -l&quot;</li>
163 <li><strong class="pname"><code>getOutput</code></strong> - whether to capture the (stdout) output of the command</li>
164 </ul></dd>
165 <dt>Raises:</dt>
166 <dd><ul class="nomargin-top">
167 <li><code><strong class='fraise'>subprocess.CalledProcessError</strong></code> - if the command returns a non-zero exit code</li>
168 </ul></dd>
169 </dl>
170 </td></tr></table>
171 </div>
172 <a name="create_file"></a>
173 <div>
174 <table class="details" border="1" cellpadding="3"
175 cellspacing="0" width="100%" bgcolor="white">
176 <tr><td>
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr valign="top"><td>
179 <h3 class="epydoc"><span class="sig"><span class="sig-name">create_file</span>(<span class="sig-arg">self</span>,
180 <span class="sig-arg">fileName</span>,
181 <span class="sig-arg">contents</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
182 </h3>
183 </td><td align="right" valign="top"
184 ><span class="codelink"><a href="lib.scripting-pysrc.html#System.create_file">source&nbsp;code</a></span>&nbsp;
185 </td>
186 </tr></table>
187
188 <p>Create a file with contents</p>
189 <p>Usage: <code>system.create_file(fileName,
190 contents=&quot;&quot;)</code></p>
191 <dl class="fields">
192 <dt>Parameters:</dt>
193 <dd><ul class="nomargin-top">
194 <li><strong class="pname"><code>fileName</code></strong> - full path to the file to be created</li>
195 <li><strong class="pname"><code>contents</code></strong> - contents to insert into the file</li>
196 </ul></dd>
197 </dl>
198 </td></tr></table>
199 </div>
200 <br />
201 <!-- ==================== NAVIGATION BAR ==================== -->
202 <table class="navbar" border="0" width="100%" cellpadding="0"
203 bgcolor="#a0c0ff" cellspacing="0">
204 <tr valign="middle">
205 <!-- Home link -->
206 <th>&nbsp;&nbsp;&nbsp;<a
207 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
208
209 <!-- Tree link -->
210 <th>&nbsp;&nbsp;&nbsp;<a
211 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
212
213 <!-- Index link -->
214 <th>&nbsp;&nbsp;&nbsp;<a
215 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
216
217 <!-- Help link -->
218 <th>&nbsp;&nbsp;&nbsp;<a
219 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
220
221 <th class="navbar" width="100%"></th>
222 </tr>
223 </table>
224 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
225 <tr>
226 <td align="left" class="footer">
227 Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
228 </td>
229 <td align="right" class="footer">
230 <a target="mainFrame" href="http://epydoc.sourceforge.net"
231 >http://epydoc.sourceforge.net</a>
232 </td>
233 </tr>
234 </table>
235
236 <script type="text/javascript">
237 <!--
238 // Private objects are initially displayed (because if
239 // javascript is turned off then we want them to be
240 // visible); but by default, we want to hide them. So hide
241 // them unless we have a cookie that says to show them.
242 checkCookie();
243 // -->
244 </script>
245 </body>
246 </html>