Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.upgrader.html
src/eric7/Documentation/Source/eric7.UI.upgrader.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8972
- 54816b8f740f
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.upgrader</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.UI.upgrader</h1> | |
| 10 | |
| 11 <p> | |
| 12 Script to upgrade the packages eric depends on. | |
| 13 </p> | |
| 14 <p> | |
| 15 This process must be performed while eric is closed. The script will upgrade | |
| 16 the requested packages and will restart eric. | |
| 17 </p> | |
| 18 <h3>Global Attributes</h3> | |
| 19 | |
| 20 <table> | |
| 21 <tr><td>_ericPackages</td></tr><tr><td>_pyqtPackages</td></tr> | |
| 22 </table> | |
| 23 <h3>Classes</h3> | |
| 24 | |
| 25 <table> | |
| 26 <tr><td>None</td></tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#doUpgrade">doUpgrade</a></td> | |
| 34 <td>Function to upgrade the given packages via pip.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#main">main</a></td> | |
| 38 <td>Main entry point into the upgrader.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#startEric">startEric</a></td> | |
| 42 <td>Function to start eric with the given arguments.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="doUpgrade" ID="doUpgrade"></a> | |
| 48 <h2>doUpgrade</h2> | |
| 49 <b>doUpgrade</b>(<i>packages</i>) | |
| 50 | |
| 51 <p> | |
| 52 Function to upgrade the given packages via pip. | |
| 53 </p> | |
| 54 <dl> | |
| 55 | |
| 56 <dt><i>packages</i> (list of str)</dt> | |
| 57 <dd> | |
| 58 list of packages to be upgraded | |
| 59 </dd> | |
| 60 </dl> | |
| 61 <dl> | |
| 62 <dt>Return:</dt> | |
| 63 <dd> | |
| 64 flag indicating a successful installation | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <dl> | |
| 68 <dt>Return Type:</dt> | |
| 69 <dd> | |
| 70 bool | |
| 71 </dd> | |
| 72 </dl> | |
| 73 <div align="right"><a href="#top">Up</a></div> | |
| 74 <hr /> | |
| 75 <hr /> | |
| 76 <a NAME="main" ID="main"></a> | |
| 77 <h2>main</h2> | |
| 78 <b>main</b>(<i></i>) | |
| 79 | |
| 80 <p> | |
| 81 Main entry point into the upgrader. | |
| 82 </p> | |
| 83 <div align="right"><a href="#top">Up</a></div> | |
| 84 <hr /> | |
| 85 <hr /> | |
| 86 <a NAME="startEric" ID="startEric"></a> | |
| 87 <h2>startEric</h2> | |
| 88 <b>startEric</b>(<i>args</i>) | |
| 89 | |
| 90 <p> | |
| 91 Function to start eric with the given arguments. | |
| 92 </p> | |
| 93 <dl> | |
| 94 | |
| 95 <dt><i>args</i> (list of str)</dt> | |
| 96 <dd> | |
| 97 list containing the start arguments | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <div align="right"><a href="#top">Up</a></div> | |
| 101 <hr /> | |
| 102 </body></html> |
