eric6/Documentation/Source/eric6.MicroPython.MicroPythonFileManager.html

changeset 7273
391d6b7b1eff
parent 7174
de8175253dfc
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.MicroPython.MicroPythonFileManager</h1> 23 <h1>eric6.MicroPython.MicroPythonFileManager</h1>
24
23 <p> 25 <p>
24 Module implementing some file system commands for MicroPython. 26 Module implementing some file system commands for MicroPython.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#MicroPythonFileManager">MicroPythonFileManager</a></td> 38 <td><a href="#MicroPythonFileManager">MicroPythonFileManager</a></td>
34 <td>Class implementing an interface to the device file system commands with some additional sugar.</td> 39 <td>Class implementing an interface to the device file system commands with some additional sugar.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="MicroPythonFileManager" ID="MicroPythonFileManager"></a> 49 <a NAME="MicroPythonFileManager" ID="MicroPythonFileManager"></a>
43 <h2>MicroPythonFileManager</h2> 50 <h2>MicroPythonFileManager</h2>
51
44 <p> 52 <p>
45 Class implementing an interface to the device file system commands with 53 Class implementing an interface to the device file system commands with
46 some additional sugar. 54 some additional sugar.
47 </p><h3>Signals</h3> 55 </p>
48 <dl> 56 <h3>Signals</h3>
57 <dl>
58
49 <dt>createDirectoryDone()</dt> 59 <dt>createDirectoryDone()</dt>
50 <dd> 60 <dd>
51 emitted after a directory was created 61 emitted after a directory was created
52 </dd><dt>currentDir(dirname)</dt> 62 </dd>
63 <dt>currentDir(dirname)</dt>
53 <dd> 64 <dd>
54 emitted to report the current directory of the 65 emitted to report the current directory of the
55 device 66 device
56 </dd><dt>currentDirChanged(dirname)</dt> 67 </dd>
68 <dt>currentDirChanged(dirname)</dt>
57 <dd> 69 <dd>
58 emitted to report back a change of the 70 emitted to report back a change of the
59 current directory 71 current directory
60 </dd><dt>deleteFileDone(deviceFile)</dt> 72 </dd>
73 <dt>deleteFileDone(deviceFile)</dt>
61 <dd> 74 <dd>
62 emitted after the file has been deleted 75 emitted after the file has been deleted
63 on the connected device 76 on the connected device
64 </dd><dt>error(exc)</dt> 77 </dd>
78 <dt>error(exc)</dt>
65 <dd> 79 <dd>
66 emitted with a failure message to indicate a failure 80 emitted with a failure message to indicate a failure
67 during the most recent operation 81 during the most recent operation
68 </dd><dt>fsinfoDone(fsinfo)</dt> 82 </dd>
83 <dt>fsinfoDone(fsinfo)</dt>
69 <dd> 84 <dd>
70 emitted after the file system information was 85 emitted after the file system information was
71 obtained 86 obtained
72 </dd><dt>getFileDone(deviceFile, localFile)</dt> 87 </dd>
88 <dt>getFileDone(deviceFile, localFile)</dt>
73 <dd> 89 <dd>
74 emitted after the file was 90 emitted after the file was
75 fetched from the connected device and written to the local file system 91 fetched from the connected device and written to the local file system
76 </dd><dt>longListFiles(result)</dt> 92 </dd>
93 <dt>longListFiles(result)</dt>
77 <dd> 94 <dd>
78 emitted with a tuple of tuples containing the 95 emitted with a tuple of tuples containing the
79 name, mode, size and time for each directory entry 96 name, mode, size and time for each directory entry
80 </dd><dt>putFileDone(localFile, deviceFile)</dt> 97 </dd>
98 <dt>putFileDone(localFile, deviceFile)</dt>
81 <dd> 99 <dd>
82 emitted after the file was 100 emitted after the file was
83 copied to the connected device 101 copied to the connected device
84 </dd><dt>removeDirectoryDone()</dt> 102 </dd>
103 <dt>removeDirectoryDone()</dt>
85 <dd> 104 <dd>
86 emitted after a directory has been deleted 105 emitted after a directory has been deleted
87 </dd><dt>rsyncDone(localName, deviceName)</dt> 106 </dd>
107 <dt>rsyncDone(localName, deviceName)</dt>
88 <dd> 108 <dd>
89 emitted after the rsync operation 109 emitted after the rsync operation
90 has been completed 110 has been completed
91 </dd><dt>rsyncProgressMessage(msg)</dt> 111 </dd>
112 <dt>rsyncProgressMessage(msg)</dt>
92 <dd> 113 <dd>
93 emitted to send a message about what 114 emitted to send a message about what
94 rsync is doing 115 rsync is doing
95 </dd> 116 </dd>
96 </dl> 117 </dl>
97 <h3>Derived from</h3> 118 <h3>Derived from</h3>
98 QObject 119 QObject
99 <h3>Class Attributes</h3> 120 <h3>Class Attributes</h3>
121
100 <table> 122 <table>
101 <tr><td>None</td></tr> 123 <tr><td>None</td></tr>
102 </table> 124 </table>
103 <h3>Class Methods</h3> 125 <h3>Class Methods</h3>
126
104 <table> 127 <table>
105 <tr><td>None</td></tr> 128 <tr><td>None</td></tr>
106 </table> 129 </table>
107 <h3>Methods</h3> 130 <h3>Methods</h3>
108 <table> 131
132 <table>
133
109 <tr> 134 <tr>
110 <td><a href="#MicroPythonFileManager.__init__">MicroPythonFileManager</a></td> 135 <td><a href="#MicroPythonFileManager.__init__">MicroPythonFileManager</a></td>
111 <td>Constructor</td> 136 <td>Constructor</td>
112 </tr><tr> 137 </tr>
138 <tr>
113 <td><a href="#MicroPythonFileManager.__rsync">__rsync</a></td> 139 <td><a href="#MicroPythonFileManager.__rsync">__rsync</a></td>
114 <td>Private method to synchronize a local directory to the device.</td> 140 <td>Private method to synchronize a local directory to the device.</td>
115 </tr><tr> 141 </tr>
142 <tr>
116 <td><a href="#MicroPythonFileManager.cd">cd</a></td> 143 <td><a href="#MicroPythonFileManager.cd">cd</a></td>
117 <td>Public slot to change the current directory of the device.</td> 144 <td>Public slot to change the current directory of the device.</td>
118 </tr><tr> 145 </tr>
146 <tr>
119 <td><a href="#MicroPythonFileManager.delete">delete</a></td> 147 <td><a href="#MicroPythonFileManager.delete">delete</a></td>
120 <td>Public slot to delete a file on the device.</td> 148 <td>Public slot to delete a file on the device.</td>
121 </tr><tr> 149 </tr>
150 <tr>
122 <td><a href="#MicroPythonFileManager.fileSystemInfo">fileSystemInfo</a></td> 151 <td><a href="#MicroPythonFileManager.fileSystemInfo">fileSystemInfo</a></td>
123 <td>Public method to obtain information about the currently mounted file systems.</td> 152 <td>Public method to obtain information about the currently mounted file systems.</td>
124 </tr><tr> 153 </tr>
154 <tr>
125 <td><a href="#MicroPythonFileManager.get">get</a></td> 155 <td><a href="#MicroPythonFileManager.get">get</a></td>
126 <td>Public slot to get a file from the connected device.</td> 156 <td>Public slot to get a file from the connected device.</td>
127 </tr><tr> 157 </tr>
158 <tr>
128 <td><a href="#MicroPythonFileManager.lls">lls</a></td> 159 <td><a href="#MicroPythonFileManager.lls">lls</a></td>
129 <td>Public slot to get a long listing of the given directory.</td> 160 <td>Public slot to get a long listing of the given directory.</td>
130 </tr><tr> 161 </tr>
162 <tr>
131 <td><a href="#MicroPythonFileManager.mkdir">mkdir</a></td> 163 <td><a href="#MicroPythonFileManager.mkdir">mkdir</a></td>
132 <td>Public slot to create a new directory.</td> 164 <td>Public slot to create a new directory.</td>
133 </tr><tr> 165 </tr>
166 <tr>
134 <td><a href="#MicroPythonFileManager.put">put</a></td> 167 <td><a href="#MicroPythonFileManager.put">put</a></td>
135 <td>Public slot to put a file onto the device.</td> 168 <td>Public slot to put a file onto the device.</td>
136 </tr><tr> 169 </tr>
170 <tr>
137 <td><a href="#MicroPythonFileManager.pwd">pwd</a></td> 171 <td><a href="#MicroPythonFileManager.pwd">pwd</a></td>
138 <td>Public slot to get the current directory of the device.</td> 172 <td>Public slot to get the current directory of the device.</td>
139 </tr><tr> 173 </tr>
174 <tr>
140 <td><a href="#MicroPythonFileManager.rmdir">rmdir</a></td> 175 <td><a href="#MicroPythonFileManager.rmdir">rmdir</a></td>
141 <td>Public slot to (recursively) remove a directory.</td> 176 <td>Public slot to (recursively) remove a directory.</td>
142 </tr><tr> 177 </tr>
178 <tr>
143 <td><a href="#MicroPythonFileManager.rsync">rsync</a></td> 179 <td><a href="#MicroPythonFileManager.rsync">rsync</a></td>
144 <td>Public slot to synchronize a local directory to the device.</td> 180 <td>Public slot to synchronize a local directory to the device.</td>
145 </tr> 181 </tr>
146 </table> 182 </table>
147 <h3>Static Methods</h3> 183 <h3>Static Methods</h3>
184
148 <table> 185 <table>
149 <tr><td>None</td></tr> 186 <tr><td>None</td></tr>
150 </table> 187 </table>
188
151 <a NAME="MicroPythonFileManager.__init__" ID="MicroPythonFileManager.__init__"></a> 189 <a NAME="MicroPythonFileManager.__init__" ID="MicroPythonFileManager.__init__"></a>
152 <h4>MicroPythonFileManager (Constructor)</h4> 190 <h4>MicroPythonFileManager (Constructor)</h4>
153 <b>MicroPythonFileManager</b>(<i>commandsInterface, parent=None</i>) 191 <b>MicroPythonFileManager</b>(<i>commandsInterface, parent=None</i>)
192
154 <p> 193 <p>
155 Constructor 194 Constructor
156 </p><dl> 195 </p>
196 <dl>
197
157 <dt><i>commandsInterface</i> (MicroPythonCommandsInterface)</dt> 198 <dt><i>commandsInterface</i> (MicroPythonCommandsInterface)</dt>
158 <dd> 199 <dd>
159 reference to the commands interface object 200 reference to the commands interface object
160 </dd><dt><i>parent</i> (QObject)</dt> 201 </dd>
202 <dt><i>parent</i> (QObject)</dt>
161 <dd> 203 <dd>
162 reference to the parent object 204 reference to the parent object
163 </dd> 205 </dd>
164 </dl><a NAME="MicroPythonFileManager.__rsync" ID="MicroPythonFileManager.__rsync"></a> 206 </dl>
207 <a NAME="MicroPythonFileManager.__rsync" ID="MicroPythonFileManager.__rsync"></a>
165 <h4>MicroPythonFileManager.__rsync</h4> 208 <h4>MicroPythonFileManager.__rsync</h4>
166 <b>__rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False, indentLevel=0</i>) 209 <b>__rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False, indentLevel=0</i>)
210
167 <p> 211 <p>
168 Private method to synchronize a local directory to the device. 212 Private method to synchronize a local directory to the device.
169 </p><dl> 213 </p>
214 <dl>
215
170 <dt><i>hostDirectory</i> (str)</dt> 216 <dt><i>hostDirectory</i> (str)</dt>
171 <dd> 217 <dd>
172 name of the local directory 218 name of the local directory
173 </dd><dt><i>deviceDirectory</i> (str)</dt> 219 </dd>
220 <dt><i>deviceDirectory</i> (str)</dt>
174 <dd> 221 <dd>
175 name of the directory on the device 222 name of the directory on the device
176 </dd><dt><i>mirror</i> (bool)</dt> 223 </dd>
224 <dt><i>mirror</i> (bool)</dt>
177 <dd> 225 <dd>
178 flag indicating to mirror the local directory to 226 flag indicating to mirror the local directory to
179 the device directory 227 the device directory
180 </dd><dt><i>localDevice</i> (bool)</dt> 228 </dd>
229 <dt><i>localDevice</i> (bool)</dt>
181 <dd> 230 <dd>
182 flag indicating device access via local file system 231 flag indicating device access via local file system
183 </dd><dt><i>indentLevel</i> (int)</dt> 232 </dd>
233 <dt><i>indentLevel</i> (int)</dt>
184 <dd> 234 <dd>
185 indentation level for progress messages 235 indentation level for progress messages
186 </dd> 236 </dd>
187 </dl><dl> 237 </dl>
238 <dl>
188 <dt>Returns:</dt> 239 <dt>Returns:</dt>
189 <dd> 240 <dd>
190 list of errors 241 list of errors
191 </dd> 242 </dd>
192 </dl><dl> 243 </dl>
244 <dl>
193 <dt>Return Type:</dt> 245 <dt>Return Type:</dt>
194 <dd> 246 <dd>
195 list of str 247 list of str
196 </dd> 248 </dd>
197 </dl><a NAME="MicroPythonFileManager.cd" ID="MicroPythonFileManager.cd"></a> 249 </dl>
250 <a NAME="MicroPythonFileManager.cd" ID="MicroPythonFileManager.cd"></a>
198 <h4>MicroPythonFileManager.cd</h4> 251 <h4>MicroPythonFileManager.cd</h4>
199 <b>cd</b>(<i>dirname</i>) 252 <b>cd</b>(<i>dirname</i>)
253
200 <p> 254 <p>
201 Public slot to change the current directory of the device. 255 Public slot to change the current directory of the device.
202 </p><dl> 256 </p>
257 <dl>
258
203 <dt><i>dirname</i> (str)</dt> 259 <dt><i>dirname</i> (str)</dt>
204 <dd> 260 <dd>
205 name of the desired current directory 261 name of the desired current directory
206 </dd> 262 </dd>
207 </dl><a NAME="MicroPythonFileManager.delete" ID="MicroPythonFileManager.delete"></a> 263 </dl>
264 <a NAME="MicroPythonFileManager.delete" ID="MicroPythonFileManager.delete"></a>
208 <h4>MicroPythonFileManager.delete</h4> 265 <h4>MicroPythonFileManager.delete</h4>
209 <b>delete</b>(<i>deviceFileName</i>) 266 <b>delete</b>(<i>deviceFileName</i>)
267
210 <p> 268 <p>
211 Public slot to delete a file on the device. 269 Public slot to delete a file on the device.
212 </p><dl> 270 </p>
271 <dl>
272
213 <dt><i>deviceFileName</i> (str)</dt> 273 <dt><i>deviceFileName</i> (str)</dt>
214 <dd> 274 <dd>
215 name of the file on the connected device 275 name of the file on the connected device
216 </dd> 276 </dd>
217 </dl><a NAME="MicroPythonFileManager.fileSystemInfo" ID="MicroPythonFileManager.fileSystemInfo"></a> 277 </dl>
278 <a NAME="MicroPythonFileManager.fileSystemInfo" ID="MicroPythonFileManager.fileSystemInfo"></a>
218 <h4>MicroPythonFileManager.fileSystemInfo</h4> 279 <h4>MicroPythonFileManager.fileSystemInfo</h4>
219 <b>fileSystemInfo</b>(<i></i>) 280 <b>fileSystemInfo</b>(<i></i>)
281
220 <p> 282 <p>
221 Public method to obtain information about the currently mounted file 283 Public method to obtain information about the currently mounted file
222 systems. 284 systems.
223 </p><a NAME="MicroPythonFileManager.get" ID="MicroPythonFileManager.get"></a> 285 </p>
286 <a NAME="MicroPythonFileManager.get" ID="MicroPythonFileManager.get"></a>
224 <h4>MicroPythonFileManager.get</h4> 287 <h4>MicroPythonFileManager.get</h4>
225 <b>get</b>(<i>deviceFileName, hostFileName=""</i>) 288 <b>get</b>(<i>deviceFileName, hostFileName=""</i>)
289
226 <p> 290 <p>
227 Public slot to get a file from the connected device. 291 Public slot to get a file from the connected device.
228 </p><dl> 292 </p>
293 <dl>
294
229 <dt><i>deviceFileName</i> (str)</dt> 295 <dt><i>deviceFileName</i> (str)</dt>
230 <dd> 296 <dd>
231 name of the file on the device 297 name of the file on the device
232 </dd><dt><i>hostFileName</i> (str)</dt> 298 </dd>
299 <dt><i>hostFileName</i> (str)</dt>
233 <dd> 300 <dd>
234 name of the local file 301 name of the local file
235 </dd> 302 </dd>
236 </dl><a NAME="MicroPythonFileManager.lls" ID="MicroPythonFileManager.lls"></a> 303 </dl>
304 <a NAME="MicroPythonFileManager.lls" ID="MicroPythonFileManager.lls"></a>
237 <h4>MicroPythonFileManager.lls</h4> 305 <h4>MicroPythonFileManager.lls</h4>
238 <b>lls</b>(<i>dirname, showHidden=False</i>) 306 <b>lls</b>(<i>dirname, showHidden=False</i>)
307
239 <p> 308 <p>
240 Public slot to get a long listing of the given directory. 309 Public slot to get a long listing of the given directory.
241 </p><dl> 310 </p>
311 <dl>
312
242 <dt><i>dirname</i> (str)</dt> 313 <dt><i>dirname</i> (str)</dt>
243 <dd> 314 <dd>
244 name of the directory to list 315 name of the directory to list
245 </dd><dt><i>showHidden</i> (bool)</dt> 316 </dd>
317 <dt><i>showHidden</i> (bool)</dt>
246 <dd> 318 <dd>
247 flag indicating to show hidden files as well 319 flag indicating to show hidden files as well
248 </dd> 320 </dd>
249 </dl><a NAME="MicroPythonFileManager.mkdir" ID="MicroPythonFileManager.mkdir"></a> 321 </dl>
322 <a NAME="MicroPythonFileManager.mkdir" ID="MicroPythonFileManager.mkdir"></a>
250 <h4>MicroPythonFileManager.mkdir</h4> 323 <h4>MicroPythonFileManager.mkdir</h4>
251 <b>mkdir</b>(<i>dirname</i>) 324 <b>mkdir</b>(<i>dirname</i>)
325
252 <p> 326 <p>
253 Public slot to create a new directory. 327 Public slot to create a new directory.
254 </p><dl> 328 </p>
329 <dl>
330
255 <dt><i>dirname</i> (str)</dt> 331 <dt><i>dirname</i> (str)</dt>
256 <dd> 332 <dd>
257 name of the directory to create 333 name of the directory to create
258 </dd> 334 </dd>
259 </dl><a NAME="MicroPythonFileManager.put" ID="MicroPythonFileManager.put"></a> 335 </dl>
336 <a NAME="MicroPythonFileManager.put" ID="MicroPythonFileManager.put"></a>
260 <h4>MicroPythonFileManager.put</h4> 337 <h4>MicroPythonFileManager.put</h4>
261 <b>put</b>(<i>hostFileName, deviceFileName=""</i>) 338 <b>put</b>(<i>hostFileName, deviceFileName=""</i>)
339
262 <p> 340 <p>
263 Public slot to put a file onto the device. 341 Public slot to put a file onto the device.
264 </p><dl> 342 </p>
343 <dl>
344
265 <dt><i>hostFileName</i> (str)</dt> 345 <dt><i>hostFileName</i> (str)</dt>
266 <dd> 346 <dd>
267 name of the local file 347 name of the local file
268 </dd><dt><i>deviceFileName</i> (str)</dt> 348 </dd>
349 <dt><i>deviceFileName</i> (str)</dt>
269 <dd> 350 <dd>
270 name of the file on the connected device 351 name of the file on the connected device
271 </dd> 352 </dd>
272 </dl><a NAME="MicroPythonFileManager.pwd" ID="MicroPythonFileManager.pwd"></a> 353 </dl>
354 <a NAME="MicroPythonFileManager.pwd" ID="MicroPythonFileManager.pwd"></a>
273 <h4>MicroPythonFileManager.pwd</h4> 355 <h4>MicroPythonFileManager.pwd</h4>
274 <b>pwd</b>(<i></i>) 356 <b>pwd</b>(<i></i>)
357
275 <p> 358 <p>
276 Public slot to get the current directory of the device. 359 Public slot to get the current directory of the device.
277 </p><a NAME="MicroPythonFileManager.rmdir" ID="MicroPythonFileManager.rmdir"></a> 360 </p>
361 <a NAME="MicroPythonFileManager.rmdir" ID="MicroPythonFileManager.rmdir"></a>
278 <h4>MicroPythonFileManager.rmdir</h4> 362 <h4>MicroPythonFileManager.rmdir</h4>
279 <b>rmdir</b>(<i>dirname, recursive=False</i>) 363 <b>rmdir</b>(<i>dirname, recursive=False</i>)
364
280 <p> 365 <p>
281 Public slot to (recursively) remove a directory. 366 Public slot to (recursively) remove a directory.
282 </p><dl> 367 </p>
368 <dl>
369
283 <dt><i>dirname</i> (str)</dt> 370 <dt><i>dirname</i> (str)</dt>
284 <dd> 371 <dd>
285 name of the directory to be removed 372 name of the directory to be removed
286 </dd><dt><i>recursive</i> (bool)</dt> 373 </dd>
374 <dt><i>recursive</i> (bool)</dt>
287 <dd> 375 <dd>
288 flag indicating a recursive removal 376 flag indicating a recursive removal
289 </dd> 377 </dd>
290 </dl><a NAME="MicroPythonFileManager.rsync" ID="MicroPythonFileManager.rsync"></a> 378 </dl>
379 <a NAME="MicroPythonFileManager.rsync" ID="MicroPythonFileManager.rsync"></a>
291 <h4>MicroPythonFileManager.rsync</h4> 380 <h4>MicroPythonFileManager.rsync</h4>
292 <b>rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False</i>) 381 <b>rsync</b>(<i>hostDirectory, deviceDirectory, mirror=True, localDevice=False</i>)
382
293 <p> 383 <p>
294 Public slot to synchronize a local directory to the device. 384 Public slot to synchronize a local directory to the device.
295 </p><dl> 385 </p>
386 <dl>
387
296 <dt><i>hostDirectory</i> (str)</dt> 388 <dt><i>hostDirectory</i> (str)</dt>
297 <dd> 389 <dd>
298 name of the local directory 390 name of the local directory
299 </dd><dt><i>deviceDirectory</i> (str)</dt> 391 </dd>
392 <dt><i>deviceDirectory</i> (str)</dt>
300 <dd> 393 <dd>
301 name of the directory on the device 394 name of the directory on the device
302 </dd><dt><i>mirror</i> (bool)</dt> 395 </dd>
396 <dt><i>mirror</i> (bool)</dt>
303 <dd> 397 <dd>
304 flag indicating to mirror the local directory to 398 flag indicating to mirror the local directory to
305 the device directory 399 the device directory
306 </dd><dt><i>localDevice</i> (bool)</dt> 400 </dd>
401 <dt><i>localDevice</i> (bool)</dt>
307 <dd> 402 <dd>
308 flag indicating device access via local file system 403 flag indicating device access via local file system
309 </dd> 404 </dd>
310 </dl> 405 </dl>
311 <div align="right"><a href="#top">Up</a></div> 406 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial