Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html

Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html

branch
maintenance
changeset 6826
c6dda2cbe081
parent 6764
d14ddbfbbd36
parent 6825
e659bb96cdfa
child 6827
14680839ad7a
equal deleted inserted replaced
6764:d14ddbfbbd36 6826:c6dda2cbe081
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.UiExtensionPlugins.PipInterface.Pip</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.UiExtensionPlugins.PipInterface.Pip</h1>
23 <p>
24 Package implementing the pip GUI logic.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Pip">Pip</a></td>
34 <td>Class implementing the pip GUI logic.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Pip" ID="Pip"></a>
43 <h2>Pip</h2>
44 <p>
45 Class implementing the pip GUI logic.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#Pip.__init__">Pip</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Pip.__aboutToShowMenu">__aboutToShowMenu</a></td>
64 <td>Private slot to set the action enabled status.</td>
65 </tr><tr>
66 <td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td>
67 <td>Private method to check, if an upgrade of PyQt packages is attempted.</td>
68 </tr><tr>
69 <td><a href="#Pip.__editConfiguration">__editConfiguration</a></td>
70 <td>Private method to edit a configuration.</td>
71 </tr><tr>
72 <td><a href="#Pip.__editUserConfiguration">__editUserConfiguration</a></td>
73 <td>Private slot to edit the user configuration.</td>
74 </tr><tr>
75 <td><a href="#Pip.__editVirtualenvConfiguration">__editVirtualenvConfiguration</a></td>
76 <td>Private slot to edit the current virtualenv configuration.</td>
77 </tr><tr>
78 <td><a href="#Pip.__generateRequirements">__generateRequirements</a></td>
79 <td>Private slot to generate the contents for a requirements file.</td>
80 </tr><tr>
81 <td><a href="#Pip.__getUserConfig">__getUserConfig</a></td>
82 <td>Private method to get the name of the user configuration file.</td>
83 </tr><tr>
84 <td><a href="#Pip.__getVirtualenvConfig">__getVirtualenvConfig</a></td>
85 <td>Private method to get the name of the virtualenv configuration file.</td>
86 </tr><tr>
87 <td><a href="#Pip.__handleTearOffMenu">__handleTearOffMenu</a></td>
88 <td>Private slot to handle a change of the selected virtual environment.</td>
89 </tr><tr>
90 <td><a href="#Pip.__installLocalPackage">__installLocalPackage</a></td>
91 <td>Private slot to install a package available on local storage.</td>
92 </tr><tr>
93 <td><a href="#Pip.__installPackages">__installPackages</a></td>
94 <td>Private slot to install packages to be given by the user.</td>
95 </tr><tr>
96 <td><a href="#Pip.__installPip">__installPip</a></td>
97 <td>Private slot to install pip.</td>
98 </tr><tr>
99 <td><a href="#Pip.__installRequirements">__installRequirements</a></td>
100 <td>Private slot to install packages as given in a requirements file.</td>
101 </tr><tr>
102 <td><a href="#Pip.__listOutdatedPackages">__listOutdatedPackages</a></td>
103 <td>Private slot to list all installed, up-to-date packages.</td>
104 </tr><tr>
105 <td><a href="#Pip.__listPackages">__listPackages</a></td>
106 <td>Private slot to list all installed packages.</td>
107 </tr><tr>
108 <td><a href="#Pip.__listUptodatePackages">__listUptodatePackages</a></td>
109 <td>Private slot to list all installed, up-to-date packages.</td>
110 </tr><tr>
111 <td><a href="#Pip.__pipConfigure">__pipConfigure</a></td>
112 <td>Private slot to open the configuration page.</td>
113 </tr><tr>
114 <td><a href="#Pip.__repairPip">__repairPip</a></td>
115 <td>Private method to repair the pip installation.</td>
116 </tr><tr>
117 <td><a href="#Pip.__searchPyPI">__searchPyPI</a></td>
118 <td>Private slot to search the Python Package Index.</td>
119 </tr><tr>
120 <td><a href="#Pip.__selectPipVirtualenv">__selectPipVirtualenv</a></td>
121 <td>Private method to select the virtual environment to be used.</td>
122 </tr><tr>
123 <td><a href="#Pip.__uninstallPackages">__uninstallPackages</a></td>
124 <td>Private slot to uninstall packages to be given by the user.</td>
125 </tr><tr>
126 <td><a href="#Pip.__uninstallRequirements">__uninstallRequirements</a></td>
127 <td>Private slot to uninstall packages as given in a requirements file.</td>
128 </tr><tr>
129 <td><a href="#Pip.__upgradePackages">__upgradePackages</a></td>
130 <td>Private slot to upgrade packages to be given by the user.</td>
131 </tr><tr>
132 <td><a href="#Pip.getDefaultEnvironmentString">getDefaultEnvironmentString</a></td>
133 <td>Public method to get the string for the default environment.</td>
134 </tr><tr>
135 <td><a href="#Pip.getMenu">getMenu</a></td>
136 <td>Public method to get a reference to the requested menu.</td>
137 </tr><tr>
138 <td><a href="#Pip.getMenuNames">getMenuNames</a></td>
139 <td>Public method to get the names of all menus.</td>
140 </tr><tr>
141 <td><a href="#Pip.getProjectEnvironmentString">getProjectEnvironmentString</a></td>
142 <td>Public method to get the string for the project environment.</td>
143 </tr><tr>
144 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
145 <td>Public method to get the interpreter for a virtual environment.</td>
146 </tr><tr>
147 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td>
148 <td>Public method to get a sorted list of virtual environment names.</td>
149 </tr><tr>
150 <td><a href="#Pip.initActions">initActions</a></td>
151 <td>Public method to define the actions.</td>
152 </tr><tr>
153 <td><a href="#Pip.initMenu">initMenu</a></td>
154 <td>Public slot to initialize the menu.</td>
155 </tr><tr>
156 <td><a href="#Pip.installPackages">installPackages</a></td>
157 <td>Public method to install the given list of packages.</td>
158 </tr><tr>
159 <td><a href="#Pip.runProcess">runProcess</a></td>
160 <td>Public method to execute the current pip with the given arguments.</td>
161 </tr><tr>
162 <td><a href="#Pip.uninstallPackages">uninstallPackages</a></td>
163 <td>Public method to uninstall the given list of packages.</td>
164 </tr><tr>
165 <td><a href="#Pip.upgradePackages">upgradePackages</a></td>
166 <td>Public method to upgrade the given list of packages.</td>
167 </tr><tr>
168 <td><a href="#Pip.upgradePip">upgradePip</a></td>
169 <td>Public method to upgrade pip itself.</td>
170 </tr>
171 </table>
172 <h3>Static Methods</h3>
173 <table>
174 <tr><td>None</td></tr>
175 </table>
176 <a NAME="Pip.__init__" ID="Pip.__init__"></a>
177 <h4>Pip (Constructor)</h4>
178 <b>Pip</b>(<i>plugin, parent=None</i>)
179 <p>
180 Constructor
181 </p><dl>
182 <dt><i>plugin</i> (PipInterfacePlugin)</dt>
183 <dd>
184 reference to the plugin object
185 </dd><dt><i>parent</i> (QObject)</dt>
186 <dd>
187 parent
188 </dd>
189 </dl><a NAME="Pip.__aboutToShowMenu" ID="Pip.__aboutToShowMenu"></a>
190 <h4>Pip.__aboutToShowMenu</h4>
191 <b>__aboutToShowMenu</b>(<i></i>)
192 <p>
193 Private slot to set the action enabled status.
194 </p><a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a>
195 <h4>Pip.__checkUpgradePyQt</h4>
196 <b>__checkUpgradePyQt</b>(<i>packages</i>)
197 <p>
198 Private method to check, if an upgrade of PyQt packages is attempted.
199 </p><dl>
200 <dt><i>packages</i> (list of str)</dt>
201 <dd>
202 list of packages to upgrade
203 </dd>
204 </dl><dl>
205 <dt>Returns:</dt>
206 <dd>
207 flag indicating to abort the upgrade attempt
208 </dd>
209 </dl><dl>
210 <dt>Return Type:</dt>
211 <dd>
212 bool
213 </dd>
214 </dl><a NAME="Pip.__editConfiguration" ID="Pip.__editConfiguration"></a>
215 <h4>Pip.__editConfiguration</h4>
216 <b>__editConfiguration</b>(<i>virtualenv=False</i>)
217 <p>
218 Private method to edit a configuration.
219 </p><dl>
220 <dt><i>virtualenv</i> (bool)</dt>
221 <dd>
222 flag indicating to edit the current virtualenv
223 configuration file
224 </dd>
225 </dl><a NAME="Pip.__editUserConfiguration" ID="Pip.__editUserConfiguration"></a>
226 <h4>Pip.__editUserConfiguration</h4>
227 <b>__editUserConfiguration</b>(<i></i>)
228 <p>
229 Private slot to edit the user configuration.
230 </p><a NAME="Pip.__editVirtualenvConfiguration" ID="Pip.__editVirtualenvConfiguration"></a>
231 <h4>Pip.__editVirtualenvConfiguration</h4>
232 <b>__editVirtualenvConfiguration</b>(<i></i>)
233 <p>
234 Private slot to edit the current virtualenv configuration.
235 </p><a NAME="Pip.__generateRequirements" ID="Pip.__generateRequirements"></a>
236 <h4>Pip.__generateRequirements</h4>
237 <b>__generateRequirements</b>(<i></i>)
238 <p>
239 Private slot to generate the contents for a requirements file.
240 </p><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a>
241 <h4>Pip.__getUserConfig</h4>
242 <b>__getUserConfig</b>(<i></i>)
243 <p>
244 Private method to get the name of the user configuration file.
245 </p><dl>
246 <dt>Returns:</dt>
247 <dd>
248 path of the user configuration file
249 </dd>
250 </dl><dl>
251 <dt>Return Type:</dt>
252 <dd>
253 str
254 </dd>
255 </dl><a NAME="Pip.__getVirtualenvConfig" ID="Pip.__getVirtualenvConfig"></a>
256 <h4>Pip.__getVirtualenvConfig</h4>
257 <b>__getVirtualenvConfig</b>(<i></i>)
258 <p>
259 Private method to get the name of the virtualenv configuration file.
260 </p><dl>
261 <dt>Returns:</dt>
262 <dd>
263 path of the virtualenv configuration file
264 </dd>
265 </dl><dl>
266 <dt>Return Type:</dt>
267 <dd>
268 str
269 </dd>
270 </dl><a NAME="Pip.__handleTearOffMenu" ID="Pip.__handleTearOffMenu"></a>
271 <h4>Pip.__handleTearOffMenu</h4>
272 <b>__handleTearOffMenu</b>(<i>venvName</i>)
273 <p>
274 Private slot to handle a change of the selected virtual environment.
275 </p><dl>
276 <dt><i>venvName</i> (str)</dt>
277 <dd>
278 logical name of the virtual environment
279 </dd>
280 </dl><a NAME="Pip.__installLocalPackage" ID="Pip.__installLocalPackage"></a>
281 <h4>Pip.__installLocalPackage</h4>
282 <b>__installLocalPackage</b>(<i></i>)
283 <p>
284 Private slot to install a package available on local storage.
285 </p><a NAME="Pip.__installPackages" ID="Pip.__installPackages"></a>
286 <h4>Pip.__installPackages</h4>
287 <b>__installPackages</b>(<i></i>)
288 <p>
289 Private slot to install packages to be given by the user.
290 </p><a NAME="Pip.__installPip" ID="Pip.__installPip"></a>
291 <h4>Pip.__installPip</h4>
292 <b>__installPip</b>(<i>userSite=False</i>)
293 <p>
294 Private slot to install pip.
295 </p><dl>
296 <dt><i>userSite</i> (bool)</dt>
297 <dd>
298 flag indicating an install to the user install
299 directory
300 </dd>
301 </dl><a NAME="Pip.__installRequirements" ID="Pip.__installRequirements"></a>
302 <h4>Pip.__installRequirements</h4>
303 <b>__installRequirements</b>(<i></i>)
304 <p>
305 Private slot to install packages as given in a requirements file.
306 </p><a NAME="Pip.__listOutdatedPackages" ID="Pip.__listOutdatedPackages"></a>
307 <h4>Pip.__listOutdatedPackages</h4>
308 <b>__listOutdatedPackages</b>(<i></i>)
309 <p>
310 Private slot to list all installed, up-to-date packages.
311 </p><a NAME="Pip.__listPackages" ID="Pip.__listPackages"></a>
312 <h4>Pip.__listPackages</h4>
313 <b>__listPackages</b>(<i></i>)
314 <p>
315 Private slot to list all installed packages.
316 </p><a NAME="Pip.__listUptodatePackages" ID="Pip.__listUptodatePackages"></a>
317 <h4>Pip.__listUptodatePackages</h4>
318 <b>__listUptodatePackages</b>(<i></i>)
319 <p>
320 Private slot to list all installed, up-to-date packages.
321 </p><a NAME="Pip.__pipConfigure" ID="Pip.__pipConfigure"></a>
322 <h4>Pip.__pipConfigure</h4>
323 <b>__pipConfigure</b>(<i></i>)
324 <p>
325 Private slot to open the configuration page.
326 </p><a NAME="Pip.__repairPip" ID="Pip.__repairPip"></a>
327 <h4>Pip.__repairPip</h4>
328 <b>__repairPip</b>(<i></i>)
329 <p>
330 Private method to repair the pip installation.
331 </p><dl>
332 <dt>Returns:</dt>
333 <dd>
334 flag indicating a successful execution
335 </dd>
336 </dl><dl>
337 <dt>Return Type:</dt>
338 <dd>
339 bool
340 </dd>
341 </dl><a NAME="Pip.__searchPyPI" ID="Pip.__searchPyPI"></a>
342 <h4>Pip.__searchPyPI</h4>
343 <b>__searchPyPI</b>(<i></i>)
344 <p>
345 Private slot to search the Python Package Index.
346 </p><a NAME="Pip.__selectPipVirtualenv" ID="Pip.__selectPipVirtualenv"></a>
347 <h4>Pip.__selectPipVirtualenv</h4>
348 <b>__selectPipVirtualenv</b>(<i></i>)
349 <p>
350 Private method to select the virtual environment to be used.
351 </p><a NAME="Pip.__uninstallPackages" ID="Pip.__uninstallPackages"></a>
352 <h4>Pip.__uninstallPackages</h4>
353 <b>__uninstallPackages</b>(<i></i>)
354 <p>
355 Private slot to uninstall packages to be given by the user.
356 </p><a NAME="Pip.__uninstallRequirements" ID="Pip.__uninstallRequirements"></a>
357 <h4>Pip.__uninstallRequirements</h4>
358 <b>__uninstallRequirements</b>(<i></i>)
359 <p>
360 Private slot to uninstall packages as given in a requirements file.
361 </p><a NAME="Pip.__upgradePackages" ID="Pip.__upgradePackages"></a>
362 <h4>Pip.__upgradePackages</h4>
363 <b>__upgradePackages</b>(<i></i>)
364 <p>
365 Private slot to upgrade packages to be given by the user.
366 </p><a NAME="Pip.getDefaultEnvironmentString" ID="Pip.getDefaultEnvironmentString"></a>
367 <h4>Pip.getDefaultEnvironmentString</h4>
368 <b>getDefaultEnvironmentString</b>(<i></i>)
369 <p>
370 Public method to get the string for the default environment.
371 </p><dl>
372 <dt>Returns:</dt>
373 <dd>
374 string for the default environment
375 </dd>
376 </dl><dl>
377 <dt>Return Type:</dt>
378 <dd>
379 str
380 </dd>
381 </dl><a NAME="Pip.getMenu" ID="Pip.getMenu"></a>
382 <h4>Pip.getMenu</h4>
383 <b>getMenu</b>(<i>name</i>)
384 <p>
385 Public method to get a reference to the requested menu.
386 </p><dl>
387 <dt><i>name</i> (str)</dt>
388 <dd>
389 name of the menu
390 </dd>
391 </dl><dl>
392 <dt>Returns:</dt>
393 <dd>
394 reference to the menu or None, if no
395 menu with the given name exists
396 </dd>
397 </dl><dl>
398 <dt>Return Type:</dt>
399 <dd>
400 QMenu or None
401 </dd>
402 </dl><a NAME="Pip.getMenuNames" ID="Pip.getMenuNames"></a>
403 <h4>Pip.getMenuNames</h4>
404 <b>getMenuNames</b>(<i></i>)
405 <p>
406 Public method to get the names of all menus.
407 </p><dl>
408 <dt>Returns:</dt>
409 <dd>
410 menu names
411 </dd>
412 </dl><dl>
413 <dt>Return Type:</dt>
414 <dd>
415 list of str
416 </dd>
417 </dl><a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a>
418 <h4>Pip.getProjectEnvironmentString</h4>
419 <b>getProjectEnvironmentString</b>(<i></i>)
420 <p>
421 Public method to get the string for the project environment.
422 </p><dl>
423 <dt>Returns:</dt>
424 <dd>
425 string for the project environment
426 </dd>
427 </dl><dl>
428 <dt>Return Type:</dt>
429 <dd>
430 str
431 </dd>
432 </dl><a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a>
433 <h4>Pip.getVirtualenvInterpreter</h4>
434 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
435 <p>
436 Public method to get the interpreter for a virtual environment.
437 </p><dl>
438 <dt><i>venvName</i> (str)</dt>
439 <dd>
440 logical name for the virtual environment
441 </dd>
442 </dl><dl>
443 <dt>Returns:</dt>
444 <dd>
445 interpreter path
446 </dd>
447 </dl><dl>
448 <dt>Return Type:</dt>
449 <dd>
450 str
451 </dd>
452 </dl><a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a>
453 <h4>Pip.getVirtualenvNames</h4>
454 <b>getVirtualenvNames</b>(<i></i>)
455 <p>
456 Public method to get a sorted list of virtual environment names.
457 </p><dl>
458 <dt>Returns:</dt>
459 <dd>
460 sorted list of virtual environment names
461 </dd>
462 </dl><dl>
463 <dt>Return Type:</dt>
464 <dd>
465 list of str
466 </dd>
467 </dl><a NAME="Pip.initActions" ID="Pip.initActions"></a>
468 <h4>Pip.initActions</h4>
469 <b>initActions</b>(<i></i>)
470 <p>
471 Public method to define the actions.
472 </p><a NAME="Pip.initMenu" ID="Pip.initMenu"></a>
473 <h4>Pip.initMenu</h4>
474 <b>initMenu</b>(<i></i>)
475 <p>
476 Public slot to initialize the menu.
477 </p><dl>
478 <dt>Returns:</dt>
479 <dd>
480 the menu generated
481 </dd>
482 </dl><dl>
483 <dt>Return Type:</dt>
484 <dd>
485 QMenu
486 </dd>
487 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
488 <h4>Pip.installPackages</h4>
489 <b>installPackages</b>(<i>packages, venvName="", userSite=False</i>)
490 <p>
491 Public method to install the given list of packages.
492 </p><dl>
493 <dt><i>packages</i> (list of str)</dt>
494 <dd>
495 list of packages to install
496 </dd><dt><i>venvName</i> (str)</dt>
497 <dd>
498 name of the virtual environment to be used
499 </dd><dt><i>userSite</i> (bool)</dt>
500 <dd>
501 flag indicating an install to the user install
502 directory
503 </dd>
504 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
505 <h4>Pip.runProcess</h4>
506 <b>runProcess</b>(<i>args, interpreter</i>)
507 <p>
508 Public method to execute the current pip with the given arguments.
509 </p><p>
510 The selected pip executable is called with the given arguments and
511 waited for its end.
512 </p><dl>
513 <dt><i>args</i> (list of str)</dt>
514 <dd>
515 list of command line arguments
516 </dd><dt><i>interpreter</i> (str)</dt>
517 <dd>
518 path of the Python interpreter to be used
519 </dd>
520 </dl><dl>
521 <dt>Returns:</dt>
522 <dd>
523 tuple containing a flag indicating success and the output
524 of the process
525 </dd>
526 </dl><dl>
527 <dt>Return Type:</dt>
528 <dd>
529 tuple of (bool, str)
530 </dd>
531 </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
532 <h4>Pip.uninstallPackages</h4>
533 <b>uninstallPackages</b>(<i>packages, venvName=""</i>)
534 <p>
535 Public method to uninstall the given list of packages.
536 </p><dl>
537 <dt><i>packages</i> (list of str)</dt>
538 <dd>
539 list of packages to uninstall
540 </dd><dt><i>venvName</i> (str)</dt>
541 <dd>
542 name of the virtual environment to be used
543 </dd>
544 </dl><dl>
545 <dt>Returns:</dt>
546 <dd>
547 flag indicating a successful execution
548 </dd>
549 </dl><dl>
550 <dt>Return Type:</dt>
551 <dd>
552 bool
553 </dd>
554 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
555 <h4>Pip.upgradePackages</h4>
556 <b>upgradePackages</b>(<i>packages, venvName="", userSite=False</i>)
557 <p>
558 Public method to upgrade the given list of packages.
559 </p><dl>
560 <dt><i>packages</i> (list of str)</dt>
561 <dd>
562 list of packages to upgrade
563 </dd><dt><i>venvName</i> (str)</dt>
564 <dd>
565 name of the virtual environment to be used
566 </dd><dt><i>userSite</i> (bool)</dt>
567 <dd>
568 flag indicating an install to the user install
569 directory
570 </dd>
571 </dl><dl>
572 <dt>Returns:</dt>
573 <dd>
574 flag indicating a successful execution
575 </dd>
576 </dl><dl>
577 <dt>Return Type:</dt>
578 <dd>
579 bool
580 </dd>
581 </dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a>
582 <h4>Pip.upgradePip</h4>
583 <b>upgradePip</b>(<i>venvName="", userSite=False</i>)
584 <p>
585 Public method to upgrade pip itself.
586 </p><dl>
587 <dt><i>venvName</i> (str)</dt>
588 <dd>
589 name of the virtual environment to be used
590 </dd><dt><i>userSite</i> (bool)</dt>
591 <dd>
592 flag indicating an install to the user install
593 directory
594 </dd>
595 </dl><dl>
596 <dt>Returns:</dt>
597 <dd>
598 flag indicating a successful execution
599 </dd>
600 </dl><dl>
601 <dt>Return Type:</dt>
602 <dd>
603 bool
604 </dd>
605 </dl>
606 <div align="right"><a href="#top">Up</a></div>
607 <hr />
608 </body></html>

Mercurial Repository: eric

eric ide

mercurial