Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PipInterface.Pip.html
src/eric7/Documentation/Source/eric7.PipInterface.Pip.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9123
- aefb731a4b4e
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PipInterface.Pip</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.PipInterface.Pip</h1> | |
| 10 | |
| 11 <p> | |
| 12 Package implementing the pip GUI logic. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Pip">Pip</a></td> | |
| 25 <td>Class implementing the pip GUI logic.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="Pip" ID="Pip"></a> | |
| 36 <h2>Pip</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the pip GUI logic. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QObject | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>DefaultIndexUrlPypi</td></tr><tr><td>DefaultIndexUrlSearch</td></tr><tr><td>DefaultIndexUrlSimple</td></tr><tr><td>DefaultPyPiUrl</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#Pip.__init__">Pip</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#Pip.__checkUpgradeEric">__checkUpgradeEric</a></td> | |
| 63 <td>Private method to check, if an upgrade of the eric-ide package is attempted.</td> | |
| 64 </tr> | |
| 65 <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> | |
| 69 <tr> | |
| 70 <td><a href="#Pip.cacheList">cacheList</a></td> | |
| 71 <td>Public method to list files contained in the pip cache.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#Pip.cachePurge">cachePurge</a></td> | |
| 75 <td>Public method to remove all files from the pip cache.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#Pip.cacheRemove">cacheRemove</a></td> | |
| 79 <td>Public method to remove files from the pip cache.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#Pip.checkPackageOutdated">checkPackageOutdated</a></td> | |
| 83 <td>Public method to check, if a group of packages is outdated.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#Pip.getDependencyTree">getDependencyTree</a></td> | |
| 87 <td>Public method to get the dependency tree of installed packages.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#Pip.getFrozenPackages">getFrozenPackages</a></td> | |
| 91 <td>Public method to get the list of package specifiers to freeze them.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#Pip.getIndexUrl">getIndexUrl</a></td> | |
| 95 <td>Public method to get the index URL for PyPI.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#Pip.getIndexUrlPypi">getIndexUrlPypi</a></td> | |
| 99 <td>Public method to get the index URL for PyPI API calls.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#Pip.getIndexUrlSearch">getIndexUrlSearch</a></td> | |
| 103 <td>Public method to get the index URL for PyPI API calls.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td> | |
| 107 <td>Public method to get the list of installed packages.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#Pip.getLicenses">getLicenses</a></td> | |
| 111 <td>Public method to get the licenses per package for a given environment.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#Pip.getLicensesSummary">getLicensesSummary</a></td> | |
| 115 <td>Public method to get a summary of licenses found in a given environment.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#Pip.getNetworkAccessManager">getNetworkAccessManager</a></td> | |
| 119 <td>Public method to get a reference to the network access manager object.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td> | |
| 123 <td>Public method to get the list of outdated packages.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#Pip.getPackageDetails">getPackageDetails</a></td> | |
| 127 <td>Public method to get package details using the PyPI JSON interface.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#Pip.getPackageVersions">getPackageVersions</a></td> | |
| 131 <td>Public method to get a list of versions available for the given package.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#Pip.getProjectEnvironmentString">getProjectEnvironmentString</a></td> | |
| 135 <td>Public method to get the string for the project environment.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#Pip.getUserConfig">getUserConfig</a></td> | |
| 139 <td>Public method to get the name of the user configuration file.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#Pip.getVirtualenvConfig">getVirtualenvConfig</a></td> | |
| 143 <td>Public method to get the name of the virtualenv configuration file.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> | |
| 147 <td>Public method to get the interpreter for a virtual environment.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td> | |
| 151 <td>Public method to get a sorted list of virtual environment names.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#Pip.getVulnerabilityChecker">getVulnerabilityChecker</a></td> | |
| 155 <td>Public method to get a reference to the vulnerability checker object.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#Pip.installPackages">installPackages</a></td> | |
| 159 <td>Public method to install the given list of packages.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#Pip.installPip">installPip</a></td> | |
| 163 <td>Public method to install pip.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#Pip.installRequirements">installRequirements</a></td> | |
| 167 <td>Public method to install packages as given in a requirements file.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#Pip.repairPip">repairPip</a></td> | |
| 171 <td>Public method to repair the pip installation.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#Pip.runProcess">runProcess</a></td> | |
| 175 <td>Public method to execute the current pip with the given arguments.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#Pip.showCacheInfo">showCacheInfo</a></td> | |
| 179 <td>Public method to show some information about the pip cache.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#Pip.uninstallPackages">uninstallPackages</a></td> | |
| 183 <td>Public method to uninstall the given list of packages.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#Pip.uninstallRequirements">uninstallRequirements</a></td> | |
| 187 <td>Public method to uninstall packages as given in a requirements file.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#Pip.upgradePackages">upgradePackages</a></td> | |
| 191 <td>Public method to upgrade the given list of packages.</td> | |
| 192 </tr> | |
| 193 </table> | |
| 194 <h3>Static Methods</h3> | |
| 195 | |
| 196 <table> | |
| 197 <tr><td>None</td></tr> | |
| 198 </table> | |
| 199 | |
| 200 <a NAME="Pip.__init__" ID="Pip.__init__"></a> | |
| 201 <h4>Pip (Constructor)</h4> | |
| 202 <b>Pip</b>(<i>parent=None</i>) | |
| 203 | |
| 204 <p> | |
| 205 Constructor | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>parent</i> (QObject)</dt> | |
| 210 <dd> | |
| 211 reference to the user interface object | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <a NAME="Pip.__checkUpgradeEric" ID="Pip.__checkUpgradeEric"></a> | |
| 215 <h4>Pip.__checkUpgradeEric</h4> | |
| 216 <b>__checkUpgradeEric</b>(<i>packages</i>) | |
| 217 | |
| 218 <p> | |
| 219 Private method to check, if an upgrade of the eric-ide package is | |
| 220 attempted. | |
| 221 </p> | |
| 222 <dl> | |
| 223 | |
| 224 <dt><i>packages</i> (list of str)</dt> | |
| 225 <dd> | |
| 226 list of packages to upgrade | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <dl> | |
| 230 <dt>Return:</dt> | |
| 231 <dd> | |
| 232 flag indicating an eric-ide upgrade | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <dl> | |
| 236 <dt>Return Type:</dt> | |
| 237 <dd> | |
| 238 bool | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a> | |
| 242 <h4>Pip.__checkUpgradePyQt</h4> | |
| 243 <b>__checkUpgradePyQt</b>(<i>packages</i>) | |
| 244 | |
| 245 <p> | |
| 246 Private method to check, if an upgrade of PyQt packages is attempted. | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>packages</i> (list of str)</dt> | |
| 251 <dd> | |
| 252 list of packages to upgrade | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <dl> | |
| 256 <dt>Return:</dt> | |
| 257 <dd> | |
| 258 flag indicating a PyQt upgrade | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <dl> | |
| 262 <dt>Return Type:</dt> | |
| 263 <dd> | |
| 264 bool | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <a NAME="Pip.cacheList" ID="Pip.cacheList"></a> | |
| 268 <h4>Pip.cacheList</h4> | |
| 269 <b>cacheList</b>(<i>venvName</i>) | |
| 270 | |
| 271 <p> | |
| 272 Public method to list files contained in the pip cache. | |
| 273 </p> | |
| 274 <dl> | |
| 275 | |
| 276 <dt><i>venvName</i> (str)</dt> | |
| 277 <dd> | |
| 278 name of the virtual environment to be used | |
| 279 </dd> | |
| 280 </dl> | |
| 281 <a NAME="Pip.cachePurge" ID="Pip.cachePurge"></a> | |
| 282 <h4>Pip.cachePurge</h4> | |
| 283 <b>cachePurge</b>(<i>venvName</i>) | |
| 284 | |
| 285 <p> | |
| 286 Public method to remove all files from the pip cache. | |
| 287 </p> | |
| 288 <dl> | |
| 289 | |
| 290 <dt><i>venvName</i> (str)</dt> | |
| 291 <dd> | |
| 292 name of the virtual environment to be used | |
| 293 </dd> | |
| 294 </dl> | |
| 295 <a NAME="Pip.cacheRemove" ID="Pip.cacheRemove"></a> | |
| 296 <h4>Pip.cacheRemove</h4> | |
| 297 <b>cacheRemove</b>(<i>venvName</i>) | |
| 298 | |
| 299 <p> | |
| 300 Public method to remove files from the pip cache. | |
| 301 </p> | |
| 302 <dl> | |
| 303 | |
| 304 <dt><i>venvName</i> (str)</dt> | |
| 305 <dd> | |
| 306 name of the virtual environment to be used | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <a NAME="Pip.checkPackageOutdated" ID="Pip.checkPackageOutdated"></a> | |
| 310 <h4>Pip.checkPackageOutdated</h4> | |
| 311 <b>checkPackageOutdated</b>(<i>packageStart, envName</i>) | |
| 312 | |
| 313 <p> | |
| 314 Public method to check, if a group of packages is outdated. | |
| 315 </p> | |
| 316 <dl> | |
| 317 | |
| 318 <dt><i>packageStart</i> (str)</dt> | |
| 319 <dd> | |
| 320 start string for package names to be checked | |
| 321 (case insensitive) | |
| 322 </dd> | |
| 323 <dt><i>envName</i> (str)</dt> | |
| 324 <dd> | |
| 325 name of the environment to get the packages for | |
| 326 </dd> | |
| 327 </dl> | |
| 328 <dl> | |
| 329 <dt>Return:</dt> | |
| 330 <dd> | |
| 331 tuple containing a flag indicating outdated packages and the | |
| 332 list of tuples containing the package name, installed version | |
| 333 and available version | |
| 334 </dd> | |
| 335 </dl> | |
| 336 <dl> | |
| 337 <dt>Return Type:</dt> | |
| 338 <dd> | |
| 339 tuple of (bool, (str, str, str)) | |
| 340 </dd> | |
| 341 </dl> | |
| 342 <a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a> | |
| 343 <h4>Pip.getDependencyTree</h4> | |
| 344 <b>getDependencyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>) | |
| 345 | |
| 346 <p> | |
| 347 Public method to get the dependency tree of installed packages. | |
| 348 </p> | |
| 349 <dl> | |
| 350 | |
| 351 <dt><i>envName</i> (str)</dt> | |
| 352 <dd> | |
| 353 name of the environment to get the packages for | |
| 354 </dd> | |
| 355 <dt><i>localPackages</i> (bool)</dt> | |
| 356 <dd> | |
| 357 flag indicating to get the tree for local | |
| 358 packages only | |
| 359 </dd> | |
| 360 <dt><i>usersite</i> (bool)</dt> | |
| 361 <dd> | |
| 362 flag indicating to get the tree for packages | |
| 363 installed in user-site directory only | |
| 364 </dd> | |
| 365 <dt><i>reverse</i> (bool)</dt> | |
| 366 <dd> | |
| 367 flag indicating to get the dependency tree in | |
| 368 reverse order (i.e. list packages needed by other) | |
| 369 </dd> | |
| 370 </dl> | |
| 371 <dl> | |
| 372 <dt>Return:</dt> | |
| 373 <dd> | |
| 374 list of nested dictionaries resembling the requested | |
| 375 dependency tree | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <dl> | |
| 379 <dt>Return Type:</dt> | |
| 380 <dd> | |
| 381 list of dict | |
| 382 </dd> | |
| 383 </dl> | |
| 384 <a NAME="Pip.getFrozenPackages" ID="Pip.getFrozenPackages"></a> | |
| 385 <h4>Pip.getFrozenPackages</h4> | |
| 386 <b>getFrozenPackages</b>(<i>envName, localPackages=True, usersite=False, requirement=None</i>) | |
| 387 | |
| 388 <p> | |
| 389 Public method to get the list of package specifiers to freeze them. | |
| 390 </p> | |
| 391 <dl> | |
| 392 | |
| 393 <dt><i>envName</i> (str)</dt> | |
| 394 <dd> | |
| 395 name of the environment to get the package specifiers | |
| 396 for | |
| 397 </dd> | |
| 398 <dt><i>localPackages</i> (bool)</dt> | |
| 399 <dd> | |
| 400 flag indicating to get package specifiers for | |
| 401 local packages only | |
| 402 </dd> | |
| 403 <dt><i>usersite</i> (bool)</dt> | |
| 404 <dd> | |
| 405 flag indicating to get package specifiers for packages | |
| 406 installed in user-site only | |
| 407 </dd> | |
| 408 <dt><i>requirement</i> (str)</dt> | |
| 409 <dd> | |
| 410 name of a requirements file | |
| 411 </dd> | |
| 412 </dl> | |
| 413 <dl> | |
| 414 <dt>Return:</dt> | |
| 415 <dd> | |
| 416 list of package specifiers | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <dl> | |
| 420 <dt>Return Type:</dt> | |
| 421 <dd> | |
| 422 list of str | |
| 423 </dd> | |
| 424 </dl> | |
| 425 <a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a> | |
| 426 <h4>Pip.getIndexUrl</h4> | |
| 427 <b>getIndexUrl</b>(<i></i>) | |
| 428 | |
| 429 <p> | |
| 430 Public method to get the index URL for PyPI. | |
| 431 </p> | |
| 432 <dl> | |
| 433 <dt>Return:</dt> | |
| 434 <dd> | |
| 435 index URL for PyPI | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <dl> | |
| 439 <dt>Return Type:</dt> | |
| 440 <dd> | |
| 441 str | |
| 442 </dd> | |
| 443 </dl> | |
| 444 <a NAME="Pip.getIndexUrlPypi" ID="Pip.getIndexUrlPypi"></a> | |
| 445 <h4>Pip.getIndexUrlPypi</h4> | |
| 446 <b>getIndexUrlPypi</b>(<i></i>) | |
| 447 | |
| 448 <p> | |
| 449 Public method to get the index URL for PyPI API calls. | |
| 450 </p> | |
| 451 <dl> | |
| 452 <dt>Return:</dt> | |
| 453 <dd> | |
| 454 index URL for XML RPC calls | |
| 455 </dd> | |
| 456 </dl> | |
| 457 <dl> | |
| 458 <dt>Return Type:</dt> | |
| 459 <dd> | |
| 460 str | |
| 461 </dd> | |
| 462 </dl> | |
| 463 <a NAME="Pip.getIndexUrlSearch" ID="Pip.getIndexUrlSearch"></a> | |
| 464 <h4>Pip.getIndexUrlSearch</h4> | |
| 465 <b>getIndexUrlSearch</b>(<i></i>) | |
| 466 | |
| 467 <p> | |
| 468 Public method to get the index URL for PyPI API calls. | |
| 469 </p> | |
| 470 <dl> | |
| 471 <dt>Return:</dt> | |
| 472 <dd> | |
| 473 index URL for XML RPC calls | |
| 474 </dd> | |
| 475 </dl> | |
| 476 <dl> | |
| 477 <dt>Return Type:</dt> | |
| 478 <dd> | |
| 479 str | |
| 480 </dd> | |
| 481 </dl> | |
| 482 <a NAME="Pip.getInstalledPackages" ID="Pip.getInstalledPackages"></a> | |
| 483 <h4>Pip.getInstalledPackages</h4> | |
| 484 <b>getInstalledPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>) | |
| 485 | |
| 486 <p> | |
| 487 Public method to get the list of installed packages. | |
| 488 </p> | |
| 489 <dl> | |
| 490 | |
| 491 <dt><i>envName</i> (str)</dt> | |
| 492 <dd> | |
| 493 name of the environment to get the packages for | |
| 494 </dd> | |
| 495 <dt><i>localPackages</i> (bool)</dt> | |
| 496 <dd> | |
| 497 flag indicating to get local packages only | |
| 498 </dd> | |
| 499 <dt><i>notRequired</i> (bool)</dt> | |
| 500 <dd> | |
| 501 flag indicating to list packages that are not | |
| 502 dependencies of installed packages as well | |
| 503 </dd> | |
| 504 <dt><i>usersite</i> (bool)</dt> | |
| 505 <dd> | |
| 506 flag indicating to only list packages installed | |
| 507 in user-site | |
| 508 </dd> | |
| 509 </dl> | |
| 510 <dl> | |
| 511 <dt>Return:</dt> | |
| 512 <dd> | |
| 513 list of tuples containing the package name and version | |
| 514 </dd> | |
| 515 </dl> | |
| 516 <dl> | |
| 517 <dt>Return Type:</dt> | |
| 518 <dd> | |
| 519 list of tuple of (str, str) | |
| 520 </dd> | |
| 521 </dl> | |
| 522 <a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a> | |
| 523 <h4>Pip.getLicenses</h4> | |
| 524 <b>getLicenses</b>(<i>envName, localPackages=True, usersite=False, summary=False</i>) | |
| 525 | |
| 526 <p> | |
| 527 Public method to get the licenses per package for a given environment. | |
| 528 </p> | |
| 529 <dl> | |
| 530 | |
| 531 <dt><i>envName</i> (str)</dt> | |
| 532 <dd> | |
| 533 name of the environment to get the licenses for | |
| 534 </dd> | |
| 535 <dt><i>localPackages</i> (bool)</dt> | |
| 536 <dd> | |
| 537 flag indicating to get the licenses for local | |
| 538 packages only | |
| 539 </dd> | |
| 540 <dt><i>usersite</i> (bool)</dt> | |
| 541 <dd> | |
| 542 flag indicating to get the licenses for packages | |
| 543 installed in user-site directory only | |
| 544 </dd> | |
| 545 <dt><i>summary</i> (bool (optional))</dt> | |
| 546 <dd> | |
| 547 flag indicating to get a summary listing (defaults to | |
| 548 False) | |
| 549 </dd> | |
| 550 </dl> | |
| 551 <dl> | |
| 552 <dt>Return:</dt> | |
| 553 <dd> | |
| 554 list of dictionaries containing the license and version per | |
| 555 package | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <dl> | |
| 559 <dt>Return Type:</dt> | |
| 560 <dd> | |
| 561 dict | |
| 562 </dd> | |
| 563 </dl> | |
| 564 <a NAME="Pip.getLicensesSummary" ID="Pip.getLicensesSummary"></a> | |
| 565 <h4>Pip.getLicensesSummary</h4> | |
| 566 <b>getLicensesSummary</b>(<i>envName, localPackages=True, usersite=False</i>) | |
| 567 | |
| 568 <p> | |
| 569 Public method to get a summary of licenses found in a given | |
| 570 environment. | |
| 571 </p> | |
| 572 <dl> | |
| 573 | |
| 574 <dt><i>envName</i> (str)</dt> | |
| 575 <dd> | |
| 576 name of the environment to get the licenses summary for | |
| 577 </dd> | |
| 578 <dt><i>localPackages</i> (bool)</dt> | |
| 579 <dd> | |
| 580 flag indicating to get the licenses summary for | |
| 581 local packages only | |
| 582 </dd> | |
| 583 <dt><i>usersite</i> (bool)</dt> | |
| 584 <dd> | |
| 585 flag indicating to get the licenses summary for | |
| 586 packages installed in user-site directory only | |
| 587 </dd> | |
| 588 </dl> | |
| 589 <dl> | |
| 590 <dt>Return:</dt> | |
| 591 <dd> | |
| 592 list of dictionaries containing the license and the count of | |
| 593 packages | |
| 594 </dd> | |
| 595 </dl> | |
| 596 <dl> | |
| 597 <dt>Return Type:</dt> | |
| 598 <dd> | |
| 599 dict | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="Pip.getNetworkAccessManager" ID="Pip.getNetworkAccessManager"></a> | |
| 603 <h4>Pip.getNetworkAccessManager</h4> | |
| 604 <b>getNetworkAccessManager</b>(<i></i>) | |
| 605 | |
| 606 <p> | |
| 607 Public method to get a reference to the network access manager object. | |
| 608 </p> | |
| 609 <dl> | |
| 610 <dt>Return:</dt> | |
| 611 <dd> | |
| 612 reference to the network access manager object | |
| 613 </dd> | |
| 614 </dl> | |
| 615 <dl> | |
| 616 <dt>Return Type:</dt> | |
| 617 <dd> | |
| 618 QNetworkAccessManager | |
| 619 </dd> | |
| 620 </dl> | |
| 621 <a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a> | |
| 622 <h4>Pip.getOutdatedPackages</h4> | |
| 623 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>) | |
| 624 | |
| 625 <p> | |
| 626 Public method to get the list of outdated packages. | |
| 627 </p> | |
| 628 <dl> | |
| 629 | |
| 630 <dt><i>envName</i> (str)</dt> | |
| 631 <dd> | |
| 632 name of the environment to get the packages for | |
| 633 </dd> | |
| 634 <dt><i>localPackages</i> (bool)</dt> | |
| 635 <dd> | |
| 636 flag indicating to get local packages only | |
| 637 </dd> | |
| 638 <dt><i>notRequired</i> (bool)</dt> | |
| 639 <dd> | |
| 640 flag indicating to list packages that are not | |
| 641 dependencies of installed packages as well | |
| 642 </dd> | |
| 643 <dt><i>usersite</i> (bool)</dt> | |
| 644 <dd> | |
| 645 flag indicating to only list packages installed | |
| 646 in user-site | |
| 647 </dd> | |
| 648 </dl> | |
| 649 <dl> | |
| 650 <dt>Return:</dt> | |
| 651 <dd> | |
| 652 list of tuples containing the package name, installed version | |
| 653 and available version | |
| 654 </dd> | |
| 655 </dl> | |
| 656 <dl> | |
| 657 <dt>Return Type:</dt> | |
| 658 <dd> | |
| 659 list of tuple of (str, str, str) | |
| 660 </dd> | |
| 661 </dl> | |
| 662 <a NAME="Pip.getPackageDetails" ID="Pip.getPackageDetails"></a> | |
| 663 <h4>Pip.getPackageDetails</h4> | |
| 664 <b>getPackageDetails</b>(<i>name, version</i>) | |
| 665 | |
| 666 <p> | |
| 667 Public method to get package details using the PyPI JSON interface. | |
| 668 </p> | |
| 669 <dl> | |
| 670 | |
| 671 <dt><i>name</i> (str)</dt> | |
| 672 <dd> | |
| 673 package name | |
| 674 </dd> | |
| 675 <dt><i>version</i> (str)</dt> | |
| 676 <dd> | |
| 677 package version | |
| 678 </dd> | |
| 679 </dl> | |
| 680 <dl> | |
| 681 <dt>Return:</dt> | |
| 682 <dd> | |
| 683 dictionary containing PyPI package data | |
| 684 </dd> | |
| 685 </dl> | |
| 686 <dl> | |
| 687 <dt>Return Type:</dt> | |
| 688 <dd> | |
| 689 dict | |
| 690 </dd> | |
| 691 </dl> | |
| 692 <a NAME="Pip.getPackageVersions" ID="Pip.getPackageVersions"></a> | |
| 693 <h4>Pip.getPackageVersions</h4> | |
| 694 <b>getPackageVersions</b>(<i>name</i>) | |
| 695 | |
| 696 <p> | |
| 697 Public method to get a list of versions available for the given | |
| 698 package. | |
| 699 </p> | |
| 700 <dl> | |
| 701 | |
| 702 <dt><i>name</i> (str)</dt> | |
| 703 <dd> | |
| 704 package name | |
| 705 </dd> | |
| 706 </dl> | |
| 707 <dl> | |
| 708 <dt>Return:</dt> | |
| 709 <dd> | |
| 710 list of available versions | |
| 711 </dd> | |
| 712 </dl> | |
| 713 <dl> | |
| 714 <dt>Return Type:</dt> | |
| 715 <dd> | |
| 716 list of str | |
| 717 </dd> | |
| 718 </dl> | |
| 719 <a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a> | |
| 720 <h4>Pip.getProjectEnvironmentString</h4> | |
| 721 <b>getProjectEnvironmentString</b>(<i></i>) | |
| 722 | |
| 723 <p> | |
| 724 Public method to get the string for the project environment. | |
| 725 </p> | |
| 726 <dl> | |
| 727 <dt>Return:</dt> | |
| 728 <dd> | |
| 729 string for the project environment | |
| 730 </dd> | |
| 731 </dl> | |
| 732 <dl> | |
| 733 <dt>Return Type:</dt> | |
| 734 <dd> | |
| 735 str | |
| 736 </dd> | |
| 737 </dl> | |
| 738 <a NAME="Pip.getUserConfig" ID="Pip.getUserConfig"></a> | |
| 739 <h4>Pip.getUserConfig</h4> | |
| 740 <b>getUserConfig</b>(<i></i>) | |
| 741 | |
| 742 <p> | |
| 743 Public method to get the name of the user configuration file. | |
| 744 </p> | |
| 745 <dl> | |
| 746 <dt>Return:</dt> | |
| 747 <dd> | |
| 748 path of the user configuration file | |
| 749 </dd> | |
| 750 </dl> | |
| 751 <dl> | |
| 752 <dt>Return Type:</dt> | |
| 753 <dd> | |
| 754 str | |
| 755 </dd> | |
| 756 </dl> | |
| 757 <a NAME="Pip.getVirtualenvConfig" ID="Pip.getVirtualenvConfig"></a> | |
| 758 <h4>Pip.getVirtualenvConfig</h4> | |
| 759 <b>getVirtualenvConfig</b>(<i>venvName</i>) | |
| 760 | |
| 761 <p> | |
| 762 Public method to get the name of the virtualenv configuration file. | |
| 763 </p> | |
| 764 <dl> | |
| 765 | |
| 766 <dt><i>venvName</i> (str)</dt> | |
| 767 <dd> | |
| 768 name of the environment to get config file path for | |
| 769 </dd> | |
| 770 </dl> | |
| 771 <dl> | |
| 772 <dt>Return:</dt> | |
| 773 <dd> | |
| 774 path of the virtualenv configuration file | |
| 775 </dd> | |
| 776 </dl> | |
| 777 <dl> | |
| 778 <dt>Return Type:</dt> | |
| 779 <dd> | |
| 780 str | |
| 781 </dd> | |
| 782 </dl> | |
| 783 <a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a> | |
| 784 <h4>Pip.getVirtualenvInterpreter</h4> | |
| 785 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) | |
| 786 | |
| 787 <p> | |
| 788 Public method to get the interpreter for a virtual environment. | |
| 789 </p> | |
| 790 <dl> | |
| 791 | |
| 792 <dt><i>venvName</i> (str)</dt> | |
| 793 <dd> | |
| 794 logical name for the virtual environment | |
| 795 </dd> | |
| 796 </dl> | |
| 797 <dl> | |
| 798 <dt>Return:</dt> | |
| 799 <dd> | |
| 800 interpreter path | |
| 801 </dd> | |
| 802 </dl> | |
| 803 <dl> | |
| 804 <dt>Return Type:</dt> | |
| 805 <dd> | |
| 806 str | |
| 807 </dd> | |
| 808 </dl> | |
| 809 <a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a> | |
| 810 <h4>Pip.getVirtualenvNames</h4> | |
| 811 <b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False</i>) | |
| 812 | |
| 813 <p> | |
| 814 Public method to get a sorted list of virtual environment names. | |
| 815 </p> | |
| 816 <dl> | |
| 817 | |
| 818 <dt><i>noRemote</i> (bool)</dt> | |
| 819 <dd> | |
| 820 flag indicating to exclude environments for remote | |
| 821 debugging | |
| 822 </dd> | |
| 823 <dt><i>noConda</i> (bool)</dt> | |
| 824 <dd> | |
| 825 flag indicating to exclude Conda environments | |
| 826 </dd> | |
| 827 </dl> | |
| 828 <dl> | |
| 829 <dt>Return:</dt> | |
| 830 <dd> | |
| 831 sorted list of virtual environment names | |
| 832 </dd> | |
| 833 </dl> | |
| 834 <dl> | |
| 835 <dt>Return Type:</dt> | |
| 836 <dd> | |
| 837 list of str | |
| 838 </dd> | |
| 839 </dl> | |
| 840 <a NAME="Pip.getVulnerabilityChecker" ID="Pip.getVulnerabilityChecker"></a> | |
| 841 <h4>Pip.getVulnerabilityChecker</h4> | |
| 842 <b>getVulnerabilityChecker</b>(<i></i>) | |
| 843 | |
| 844 <p> | |
| 845 Public method to get a reference to the vulnerability checker object. | |
| 846 </p> | |
| 847 <dl> | |
| 848 <dt>Return:</dt> | |
| 849 <dd> | |
| 850 reference to the vulnerability checker object | |
| 851 </dd> | |
| 852 </dl> | |
| 853 <dl> | |
| 854 <dt>Return Type:</dt> | |
| 855 <dd> | |
| 856 PipVulnerabilityChecker | |
| 857 </dd> | |
| 858 </dl> | |
| 859 <a NAME="Pip.installPackages" ID="Pip.installPackages"></a> | |
| 860 <h4>Pip.installPackages</h4> | |
| 861 <b>installPackages</b>(<i>packages, venvName="", userSite=False, interpreter="", forceReinstall=False</i>) | |
| 862 | |
| 863 <p> | |
| 864 Public method to install the given list of packages. | |
| 865 </p> | |
| 866 <dl> | |
| 867 | |
| 868 <dt><i>packages</i> (list of str)</dt> | |
| 869 <dd> | |
| 870 list of packages to install | |
| 871 </dd> | |
| 872 <dt><i>venvName</i> (str)</dt> | |
| 873 <dd> | |
| 874 name of the virtual environment to be used | |
| 875 </dd> | |
| 876 <dt><i>userSite</i> (bool)</dt> | |
| 877 <dd> | |
| 878 flag indicating an install to the user install | |
| 879 directory | |
| 880 </dd> | |
| 881 <dt><i>interpreter</i> (str)</dt> | |
| 882 <dd> | |
| 883 interpreter to be used for execution | |
| 884 </dd> | |
| 885 <dt><i>forceReinstall</i> (bool)</dt> | |
| 886 <dd> | |
| 887 flag indicating to force a reinstall of | |
| 888 the packages | |
| 889 </dd> | |
| 890 </dl> | |
| 891 <a NAME="Pip.installPip" ID="Pip.installPip"></a> | |
| 892 <h4>Pip.installPip</h4> | |
| 893 <b>installPip</b>(<i>venvName, userSite=False</i>) | |
| 894 | |
| 895 <p> | |
| 896 Public method to install pip. | |
| 897 </p> | |
| 898 <dl> | |
| 899 | |
| 900 <dt><i>venvName</i> (str)</dt> | |
| 901 <dd> | |
| 902 name of the environment to install pip into | |
| 903 </dd> | |
| 904 <dt><i>userSite</i> (bool)</dt> | |
| 905 <dd> | |
| 906 flag indicating an install to the user install | |
| 907 directory | |
| 908 </dd> | |
| 909 </dl> | |
| 910 <a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a> | |
| 911 <h4>Pip.installRequirements</h4> | |
| 912 <b>installRequirements</b>(<i>venvName</i>) | |
| 913 | |
| 914 <p> | |
| 915 Public method to install packages as given in a requirements file. | |
| 916 </p> | |
| 917 <dl> | |
| 918 | |
| 919 <dt><i>venvName</i> (str)</dt> | |
| 920 <dd> | |
| 921 name of the virtual environment to be used | |
| 922 </dd> | |
| 923 </dl> | |
| 924 <a NAME="Pip.repairPip" ID="Pip.repairPip"></a> | |
| 925 <h4>Pip.repairPip</h4> | |
| 926 <b>repairPip</b>(<i>venvName</i>) | |
| 927 | |
| 928 <p> | |
| 929 Public method to repair the pip installation. | |
| 930 </p> | |
| 931 <dl> | |
| 932 | |
| 933 <dt><i>venvName</i> (str)</dt> | |
| 934 <dd> | |
| 935 name of the environment to install pip into | |
| 936 </dd> | |
| 937 </dl> | |
| 938 <a NAME="Pip.runProcess" ID="Pip.runProcess"></a> | |
| 939 <h4>Pip.runProcess</h4> | |
| 940 <b>runProcess</b>(<i>args, interpreter</i>) | |
| 941 | |
| 942 <p> | |
| 943 Public method to execute the current pip with the given arguments. | |
| 944 </p> | |
| 945 <p> | |
| 946 The selected pip executable is called with the given arguments and | |
| 947 waited for its end. | |
| 948 </p> | |
| 949 <dl> | |
| 950 | |
| 951 <dt><i>args</i> (list of str)</dt> | |
| 952 <dd> | |
| 953 list of command line arguments | |
| 954 </dd> | |
| 955 <dt><i>interpreter</i> (str)</dt> | |
| 956 <dd> | |
| 957 path of the Python interpreter to be used | |
| 958 </dd> | |
| 959 </dl> | |
| 960 <dl> | |
| 961 <dt>Return:</dt> | |
| 962 <dd> | |
| 963 tuple containing a flag indicating success and the output | |
| 964 of the process | |
| 965 </dd> | |
| 966 </dl> | |
| 967 <dl> | |
| 968 <dt>Return Type:</dt> | |
| 969 <dd> | |
| 970 tuple of (bool, str) | |
| 971 </dd> | |
| 972 </dl> | |
| 973 <a NAME="Pip.showCacheInfo" ID="Pip.showCacheInfo"></a> | |
| 974 <h4>Pip.showCacheInfo</h4> | |
| 975 <b>showCacheInfo</b>(<i>venvName</i>) | |
| 976 | |
| 977 <p> | |
| 978 Public method to show some information about the pip cache. | |
| 979 </p> | |
| 980 <dl> | |
| 981 | |
| 982 <dt><i>venvName</i> (str)</dt> | |
| 983 <dd> | |
| 984 name of the virtual environment to be used | |
| 985 </dd> | |
| 986 </dl> | |
| 987 <a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a> | |
| 988 <h4>Pip.uninstallPackages</h4> | |
| 989 <b>uninstallPackages</b>(<i>packages, venvName</i>) | |
| 990 | |
| 991 <p> | |
| 992 Public method to uninstall the given list of packages. | |
| 993 </p> | |
| 994 <dl> | |
| 995 | |
| 996 <dt><i>packages</i> (list of str)</dt> | |
| 997 <dd> | |
| 998 list of packages to uninstall | |
| 999 </dd> | |
| 1000 <dt><i>venvName</i> (str)</dt> | |
| 1001 <dd> | |
| 1002 name of the virtual environment to be used | |
| 1003 </dd> | |
| 1004 </dl> | |
| 1005 <dl> | |
| 1006 <dt>Return:</dt> | |
| 1007 <dd> | |
| 1008 flag indicating a successful execution | |
| 1009 </dd> | |
| 1010 </dl> | |
| 1011 <dl> | |
| 1012 <dt>Return Type:</dt> | |
| 1013 <dd> | |
| 1014 bool | |
| 1015 </dd> | |
| 1016 </dl> | |
| 1017 <a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a> | |
| 1018 <h4>Pip.uninstallRequirements</h4> | |
| 1019 <b>uninstallRequirements</b>(<i>venvName</i>) | |
| 1020 | |
| 1021 <p> | |
| 1022 Public method to uninstall packages as given in a requirements file. | |
| 1023 </p> | |
| 1024 <dl> | |
| 1025 | |
| 1026 <dt><i>venvName</i> (str)</dt> | |
| 1027 <dd> | |
| 1028 name of the virtual environment to be used | |
| 1029 </dd> | |
| 1030 </dl> | |
| 1031 <a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a> | |
| 1032 <h4>Pip.upgradePackages</h4> | |
| 1033 <b>upgradePackages</b>(<i>packages, venvName, userSite=False</i>) | |
| 1034 | |
| 1035 <p> | |
| 1036 Public method to upgrade the given list of packages. | |
| 1037 </p> | |
| 1038 <dl> | |
| 1039 | |
| 1040 <dt><i>packages</i> (list of str)</dt> | |
| 1041 <dd> | |
| 1042 list of packages to upgrade | |
| 1043 </dd> | |
| 1044 <dt><i>venvName</i> (str)</dt> | |
| 1045 <dd> | |
| 1046 name of the virtual environment to be used | |
| 1047 </dd> | |
| 1048 <dt><i>userSite</i> (bool)</dt> | |
| 1049 <dd> | |
| 1050 flag indicating an install to the user install | |
| 1051 directory | |
| 1052 </dd> | |
| 1053 </dl> | |
| 1054 <dl> | |
| 1055 <dt>Return:</dt> | |
| 1056 <dd> | |
| 1057 flag indicating a successful execution | |
| 1058 </dd> | |
| 1059 </dl> | |
| 1060 <dl> | |
| 1061 <dt>Return Type:</dt> | |
| 1062 <dd> | |
| 1063 bool | |
| 1064 </dd> | |
| 1065 </dl> | |
| 1066 <div align="right"><a href="#top">Up</a></div> | |
| 1067 <hr /> | |
| 1068 </body></html> |
