Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.install.html
Documentation/Source/eric4.install.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.install</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.install</h1> | |
| 24 <p> | |
| 25 Installation script for the eric4 IDE and all eric4 related tools. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>distDir</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr><td>None</td></tr> | |
| 34 </table> | |
| 35 <h3>Functions</h3> | |
| 36 <table> | |
| 37 <tr> | |
| 38 <td><a href="#cleanUp">cleanUp</a></td> | |
| 39 <td>Uninstall the old eric files.</td> | |
| 40 </tr><tr> | |
| 41 <td><a href="#compileUiDir">compileUiDir</a></td> | |
| 42 <td>Creates Python modules from Qt Designer .ui files in a directory or directory tree.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#compileUiFiles">compileUiFiles</a></td> | |
| 45 <td>Compile the .ui files to Python sources.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#compile_ui">compile_ui</a></td> | |
| 48 <td>Local function to compile a single .ui file.</td> | |
| 49 </tr><tr> | |
| 50 <td><a href="#copyToFile">copyToFile</a></td> | |
| 51 <td>Copy a string to a file.</td> | |
| 52 </tr><tr> | |
| 53 <td><a href="#copyTree">copyTree</a></td> | |
| 54 <td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td> | |
| 55 </tr><tr> | |
| 56 <td><a href="#createConfig">createConfig</a></td> | |
| 57 <td>Create a config file with the respective config entries.</td> | |
| 58 </tr><tr> | |
| 59 <td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td> | |
| 60 <td>Create the global plugins directory, if it doesn't exist.</td> | |
| 61 </tr><tr> | |
| 62 <td><a href="#createInstallConfig">createInstallConfig</a></td> | |
| 63 <td>Create the installation config dictionary.</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#createPyWrapper">createPyWrapper</a></td> | |
| 66 <td>Create an executable wrapper for a Python script.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#doDependancyChecks">doDependancyChecks</a></td> | |
| 69 <td>Perform some dependency checks.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#initGlobals">initGlobals</a></td> | |
| 72 <td>Sets the values of globals that need more than a simple assignment.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#installEric">installEric</a></td> | |
| 75 <td>Actually perform the installation steps.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#main">main</a></td> | |
| 78 <td>The main function of the script.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#pyName">pyName</a></td> | |
| 81 <td>Local function to create the Python source file name for the compiled .ui file.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#usage">usage</a></td> | |
| 84 <td>Display a usage message and exit.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#wrapperName">wrapperName</a></td> | |
| 87 <td>Create the platform specific name for the wrapper script.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <hr /><hr /> | |
| 91 <a NAME="cleanUp" ID="cleanUp"></a> | |
| 92 <h2>cleanUp</h2> | |
| 93 <b>cleanUp</b>(<i></i>) | |
| 94 <p> | |
| 95 Uninstall the old eric files. | |
| 96 </p> | |
| 97 <div align="right"><a href="#top">Up</a></div> | |
| 98 <hr /><hr /> | |
| 99 <a NAME="compileUiDir" ID="compileUiDir"></a> | |
| 100 <h2>compileUiDir</h2> | |
| 101 <b>compileUiDir</b>(<i>dir, recurse = False, map = None, **compileUi_args</i>) | |
| 102 <p> | |
| 103 Creates Python modules from Qt Designer .ui files in a directory or | |
| 104 directory tree. | |
| 105 </p><p> | |
| 106 Note: This function is a modified version of the one found in PyQt4. | |
| 107 </p><dl> | |
| 108 <dt><i>dir</i></dt> | |
| 109 <dd> | |
| 110 Name of the directory to scan for files whose name ends with | |
| 111 '.ui'. By default the generated Python module is created in the same | |
| 112 directory ending with '.py'. | |
| 113 </dd><dt><i>recurse</i></dt> | |
| 114 <dd> | |
| 115 flag indicating that any sub-directories should be scanned. | |
| 116 </dd><dt><i>map</i></dt> | |
| 117 <dd> | |
| 118 an optional callable that is passed the name of the directory | |
| 119 containing the '.ui' file and the name of the Python module that will be | |
| 120 created. The callable should return a tuple of the name of the directory | |
| 121 in which the Python module will be created and the (possibly modified) | |
| 122 name of the module. | |
| 123 </dd><dt><i>compileUi_args</i></dt> | |
| 124 <dd> | |
| 125 any additional keyword arguments that are passed to | |
| 126 the compileUi() function that is called to create each Python module. | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <div align="right"><a href="#top">Up</a></div> | |
| 130 <hr /><hr /> | |
| 131 <a NAME="compileUiFiles" ID="compileUiFiles"></a> | |
| 132 <h2>compileUiFiles</h2> | |
| 133 <b>compileUiFiles</b>(<i></i>) | |
| 134 <p> | |
| 135 Compile the .ui files to Python sources. | |
| 136 </p> | |
| 137 <div align="right"><a href="#top">Up</a></div> | |
| 138 <hr /><hr /> | |
| 139 <a NAME="compile_ui" ID="compile_ui"></a> | |
| 140 <h2>compile_ui</h2> | |
| 141 <b>compile_ui</b>(<i>ui_dir, ui_file</i>) | |
| 142 <p> | |
| 143 Local function to compile a single .ui file. | |
| 144 </p><dl> | |
| 145 <dt><i>ui_dir</i></dt> | |
| 146 <dd> | |
| 147 directory containing the .ui file (string) | |
| 148 </dd><dt><i>ui_file</i></dt> | |
| 149 <dd> | |
| 150 file name of the .ui file (string) | |
| 151 </dd> | |
| 152 </dl> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /><hr /> | |
| 155 <a NAME="copyToFile" ID="copyToFile"></a> | |
| 156 <h2>copyToFile</h2> | |
| 157 <b>copyToFile</b>(<i>name, text</i>) | |
| 158 <p> | |
| 159 Copy a string to a file. | |
| 160 </p><dl> | |
| 161 <dt><i>name</i></dt> | |
| 162 <dd> | |
| 163 the name of the file. | |
| 164 </dd><dt><i>text</i></dt> | |
| 165 <dd> | |
| 166 the contents to copy to the file. | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /><hr /> | |
| 171 <a NAME="copyTree" ID="copyTree"></a> | |
| 172 <h2>copyTree</h2> | |
| 173 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=[]</i>) | |
| 174 <p> | |
| 175 Copy Python, translation, documentation, wizards configuration, | |
| 176 designer template files and DTDs of a directory tree. | |
| 177 </p><dl> | |
| 178 <dt><i>src</i></dt> | |
| 179 <dd> | |
| 180 name of the source directory | |
| 181 </dd><dt><i>dst</i></dt> | |
| 182 <dd> | |
| 183 name of the destination directory | |
| 184 </dd><dt><i>filters</i></dt> | |
| 185 <dd> | |
| 186 list of filter pattern determining the files to be copied | |
| 187 </dd><dt><i>excludeDirs</i></dt> | |
| 188 <dd> | |
| 189 list of (sub)directories to exclude from copying | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <div align="right"><a href="#top">Up</a></div> | |
| 193 <hr /><hr /> | |
| 194 <a NAME="createConfig" ID="createConfig"></a> | |
| 195 <h2>createConfig</h2> | |
| 196 <b>createConfig</b>(<i></i>) | |
| 197 <p> | |
| 198 Create a config file with the respective config entries. | |
| 199 </p> | |
| 200 <div align="right"><a href="#top">Up</a></div> | |
| 201 <hr /><hr /> | |
| 202 <a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a> | |
| 203 <h2>createGlobalPluginsDir</h2> | |
| 204 <b>createGlobalPluginsDir</b>(<i></i>) | |
| 205 <p> | |
| 206 Create the global plugins directory, if it doesn't exist. | |
| 207 </p> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /><hr /> | |
| 210 <a NAME="createInstallConfig" ID="createInstallConfig"></a> | |
| 211 <h2>createInstallConfig</h2> | |
| 212 <b>createInstallConfig</b>(<i></i>) | |
| 213 <p> | |
| 214 Create the installation config dictionary. | |
| 215 </p> | |
| 216 <div align="right"><a href="#top">Up</a></div> | |
| 217 <hr /><hr /> | |
| 218 <a NAME="createPyWrapper" ID="createPyWrapper"></a> | |
| 219 <h2>createPyWrapper</h2> | |
| 220 <b>createPyWrapper</b>(<i>pydir, wfile</i>) | |
| 221 <p> | |
| 222 Create an executable wrapper for a Python script. | |
| 223 </p><dl> | |
| 224 <dt><i>pydir</i></dt> | |
| 225 <dd> | |
| 226 the name of the directory where the Python script will eventually | |
| 227 be installed | |
| 228 </dd><dt><i>wfile</i></dt> | |
| 229 <dd> | |
| 230 the basename of the wrapper | |
| 231 </dd> | |
| 232 </dl><dl> | |
| 233 <dt>Returns:</dt> | |
| 234 <dd> | |
| 235 the platform specific name of the wrapper | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <div align="right"><a href="#top">Up</a></div> | |
| 239 <hr /><hr /> | |
| 240 <a NAME="doDependancyChecks" ID="doDependancyChecks"></a> | |
| 241 <h2>doDependancyChecks</h2> | |
| 242 <b>doDependancyChecks</b>(<i></i>) | |
| 243 <p> | |
| 244 Perform some dependency checks. | |
| 245 </p> | |
| 246 <div align="right"><a href="#top">Up</a></div> | |
| 247 <hr /><hr /> | |
| 248 <a NAME="initGlobals" ID="initGlobals"></a> | |
| 249 <h2>initGlobals</h2> | |
| 250 <b>initGlobals</b>(<i></i>) | |
| 251 <p> | |
| 252 Sets the values of globals that need more than a simple assignment. | |
| 253 </p> | |
| 254 <div align="right"><a href="#top">Up</a></div> | |
| 255 <hr /><hr /> | |
| 256 <a NAME="installEric" ID="installEric"></a> | |
| 257 <h2>installEric</h2> | |
| 258 <b>installEric</b>(<i></i>) | |
| 259 <p> | |
| 260 Actually perform the installation steps. | |
| 261 </p> | |
| 262 <div align="right"><a href="#top">Up</a></div> | |
| 263 <hr /><hr /> | |
| 264 <a NAME="main" ID="main"></a> | |
| 265 <h2>main</h2> | |
| 266 <b>main</b>(<i>argv</i>) | |
| 267 <p> | |
| 268 The main function of the script. | |
| 269 </p><dl> | |
| 270 <dt><i>argv</i></dt> | |
| 271 <dd> | |
| 272 the list of command line arguments. | |
| 273 </dd> | |
| 274 </dl> | |
| 275 <div align="right"><a href="#top">Up</a></div> | |
| 276 <hr /><hr /> | |
| 277 <a NAME="pyName" ID="pyName"></a> | |
| 278 <h2>pyName</h2> | |
| 279 <b>pyName</b>(<i>py_dir, py_file</i>) | |
| 280 <p> | |
| 281 Local function to create the Python source file name for the compiled .ui file. | |
| 282 </p><dl> | |
| 283 <dt><i>py_dir</i></dt> | |
| 284 <dd> | |
| 285 suggested name of the directory (string) | |
| 286 </dd><dt><i>py_file</i></dt> | |
| 287 <dd> | |
| 288 suggested name for the compile source file (string) | |
| 289 </dd> | |
| 290 </dl><dl> | |
| 291 <dt>Returns:</dt> | |
| 292 <dd> | |
| 293 tuple of directory name (string) and source file name (string) | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /><hr /> | |
| 298 <a NAME="usage" ID="usage"></a> | |
| 299 <h2>usage</h2> | |
| 300 <b>usage</b>(<i>rcode = 2</i>) | |
| 301 <p> | |
| 302 Display a usage message and exit. | |
| 303 </p><dl> | |
| 304 <dt><i>rcode</i></dt> | |
| 305 <dd> | |
| 306 the return code passed back to the calling process. | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <div align="right"><a href="#top">Up</a></div> | |
| 310 <hr /><hr /> | |
| 311 <a NAME="wrapperName" ID="wrapperName"></a> | |
| 312 <h2>wrapperName</h2> | |
| 313 <b>wrapperName</b>(<i>dname, wfile</i>) | |
| 314 <p> | |
| 315 Create the platform specific name for the wrapper script. | |
| 316 </p><dl> | |
| 317 <dt><i>dname</i></dt> | |
| 318 <dd> | |
| 319 name of the directory to place the wrapper into | |
| 320 </dd><dt><i>wfile</i></dt> | |
| 321 <dd> | |
| 322 basename (without extension) of the wrapper script | |
| 323 </dd> | |
| 324 </dl><dl> | |
| 325 <dt>Returns:</dt> | |
| 326 <dd> | |
| 327 the name of the wrapper script | |
| 328 </dd> | |
| 329 </dl> | |
| 330 <div align="right"><a href="#top">Up</a></div> | |
| 331 <hr /> | |
| 332 </body></html> |
