Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6976
66913de629f6
child 7626
7f643d41464e
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.PipInterface.Pip</h1> 23 <h1>eric6.PipInterface.Pip</h1>
24
23 <p> 25 <p>
24 Package implementing the pip GUI logic. 26 Package implementing the pip GUI logic.
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>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#Pip">Pip</a></td> 38 <td><a href="#Pip">Pip</a></td>
34 <td>Class implementing the pip GUI logic.</td> 39 <td>Class implementing the pip GUI logic.</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="Pip" ID="Pip"></a> 49 <a NAME="Pip" ID="Pip"></a>
43 <h2>Pip</h2> 50 <h2>Pip</h2>
51
44 <p> 52 <p>
45 Class implementing the pip GUI logic. 53 Class implementing the pip GUI logic.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>DefaultIndexUrlPip</td></tr><tr><td>DefaultIndexUrlXml</td></tr><tr><td>DefaultPyPiUrl</td></tr> 60 <tr><td>DefaultIndexUrlPip</td></tr><tr><td>DefaultIndexUrlXml</td></tr><tr><td>DefaultPyPiUrl</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#Pip.__init__">Pip</a></td> 72 <td><a href="#Pip.__init__">Pip</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td> 76 <td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td>
64 <td>Private method to check, if an upgrade of PyQt packages is attempted.</td> 77 <td>Private method to check, if an upgrade of PyQt packages is attempted.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#Pip.getIndexUrl">getIndexUrl</a></td> 80 <td><a href="#Pip.getIndexUrl">getIndexUrl</a></td>
67 <td>Public method to get the index URL for PyPI.</td> 81 <td>Public method to get the index URL for PyPI.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Pip.getIndexUrlXml">getIndexUrlXml</a></td> 84 <td><a href="#Pip.getIndexUrlXml">getIndexUrlXml</a></td>
70 <td>Public method to get the index URL for XML RPC calls.</td> 85 <td>Public method to get the index URL for XML RPC calls.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td> 88 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td>
73 <td>Public method to get the list of installed packages.</td> 89 <td>Public method to get the list of installed packages.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td> 92 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td>
76 <td>Public method to get the list of outdated packages.</td> 93 <td>Public method to get the list of outdated packages.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#Pip.getPackageDetails">getPackageDetails</a></td> 96 <td><a href="#Pip.getPackageDetails">getPackageDetails</a></td>
79 <td>Public method to get package details using the PyPI JSON interface.</td> 97 <td>Public method to get package details using the PyPI JSON interface.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#Pip.getProjectEnvironmentString">getProjectEnvironmentString</a></td> 100 <td><a href="#Pip.getProjectEnvironmentString">getProjectEnvironmentString</a></td>
82 <td>Public method to get the string for the project environment.</td> 101 <td>Public method to get the string for the project environment.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#Pip.getUserConfig">getUserConfig</a></td> 104 <td><a href="#Pip.getUserConfig">getUserConfig</a></td>
85 <td>Public method to get the name of the user configuration file.</td> 105 <td>Public method to get the name of the user configuration file.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#Pip.getVirtualenvConfig">getVirtualenvConfig</a></td> 108 <td><a href="#Pip.getVirtualenvConfig">getVirtualenvConfig</a></td>
88 <td>Public method to get the name of the virtualenv configuration file.</td> 109 <td>Public method to get the name of the virtualenv configuration file.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> 112 <td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td>
91 <td>Public method to get the interpreter for a virtual environment.</td> 113 <td>Public method to get the interpreter for a virtual environment.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td> 116 <td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td>
94 <td>Public method to get a sorted list of virtual environment names.</td> 117 <td>Public method to get a sorted list of virtual environment names.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#Pip.installPackages">installPackages</a></td> 120 <td><a href="#Pip.installPackages">installPackages</a></td>
97 <td>Public method to install the given list of packages.</td> 121 <td>Public method to install the given list of packages.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#Pip.installPip">installPip</a></td> 124 <td><a href="#Pip.installPip">installPip</a></td>
100 <td>Public method to install pip.</td> 125 <td>Public method to install pip.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#Pip.installRequirements">installRequirements</a></td> 128 <td><a href="#Pip.installRequirements">installRequirements</a></td>
103 <td>Public method to install packages as given in a requirements file.</td> 129 <td>Public method to install packages as given in a requirements file.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#Pip.repairPip">repairPip</a></td> 132 <td><a href="#Pip.repairPip">repairPip</a></td>
106 <td>Public method to repair the pip installation.</td> 133 <td>Public method to repair the pip installation.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#Pip.runProcess">runProcess</a></td> 136 <td><a href="#Pip.runProcess">runProcess</a></td>
109 <td>Public method to execute the current pip with the given arguments.</td> 137 <td>Public method to execute the current pip with the given arguments.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#Pip.uninstallPackages">uninstallPackages</a></td> 140 <td><a href="#Pip.uninstallPackages">uninstallPackages</a></td>
112 <td>Public method to uninstall the given list of packages.</td> 141 <td>Public method to uninstall the given list of packages.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#Pip.uninstallRequirements">uninstallRequirements</a></td> 144 <td><a href="#Pip.uninstallRequirements">uninstallRequirements</a></td>
115 <td>Public method to uninstall packages as given in a requirements file.</td> 145 <td>Public method to uninstall packages as given in a requirements file.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#Pip.upgradePackages">upgradePackages</a></td> 148 <td><a href="#Pip.upgradePackages">upgradePackages</a></td>
118 <td>Public method to upgrade the given list of packages.</td> 149 <td>Public method to upgrade the given list of packages.</td>
119 </tr> 150 </tr>
120 </table> 151 </table>
121 <h3>Static Methods</h3> 152 <h3>Static Methods</h3>
153
122 <table> 154 <table>
123 <tr><td>None</td></tr> 155 <tr><td>None</td></tr>
124 </table> 156 </table>
157
125 <a NAME="Pip.__init__" ID="Pip.__init__"></a> 158 <a NAME="Pip.__init__" ID="Pip.__init__"></a>
126 <h4>Pip (Constructor)</h4> 159 <h4>Pip (Constructor)</h4>
127 <b>Pip</b>(<i>parent=None</i>) 160 <b>Pip</b>(<i>parent=None</i>)
161
128 <p> 162 <p>
129 Constructor 163 Constructor
130 </p><dl> 164 </p>
165 <dl>
166
131 <dt><i>parent</i> (QObject)</dt> 167 <dt><i>parent</i> (QObject)</dt>
132 <dd> 168 <dd>
133 parent 169 parent
134 </dd> 170 </dd>
135 </dl><a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a> 171 </dl>
172 <a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a>
136 <h4>Pip.__checkUpgradePyQt</h4> 173 <h4>Pip.__checkUpgradePyQt</h4>
137 <b>__checkUpgradePyQt</b>(<i>packages</i>) 174 <b>__checkUpgradePyQt</b>(<i>packages</i>)
175
138 <p> 176 <p>
139 Private method to check, if an upgrade of PyQt packages is attempted. 177 Private method to check, if an upgrade of PyQt packages is attempted.
140 </p><dl> 178 </p>
179 <dl>
180
141 <dt><i>packages</i> (list of str)</dt> 181 <dt><i>packages</i> (list of str)</dt>
142 <dd> 182 <dd>
143 list of packages to upgrade 183 list of packages to upgrade
144 </dd> 184 </dd>
145 </dl><dl> 185 </dl>
186 <dl>
146 <dt>Returns:</dt> 187 <dt>Returns:</dt>
147 <dd> 188 <dd>
148 flag indicating to abort the upgrade attempt 189 flag indicating to abort the upgrade attempt
149 </dd> 190 </dd>
150 </dl><dl> 191 </dl>
192 <dl>
151 <dt>Return Type:</dt> 193 <dt>Return Type:</dt>
152 <dd> 194 <dd>
153 bool 195 bool
154 </dd> 196 </dd>
155 </dl><a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a> 197 </dl>
198 <a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a>
156 <h4>Pip.getIndexUrl</h4> 199 <h4>Pip.getIndexUrl</h4>
157 <b>getIndexUrl</b>(<i></i>) 200 <b>getIndexUrl</b>(<i></i>)
201
158 <p> 202 <p>
159 Public method to get the index URL for PyPI. 203 Public method to get the index URL for PyPI.
160 </p><dl> 204 </p>
205 <dl>
161 <dt>Returns:</dt> 206 <dt>Returns:</dt>
162 <dd> 207 <dd>
163 index URL for PyPI 208 index URL for PyPI
164 </dd> 209 </dd>
165 </dl><dl> 210 </dl>
211 <dl>
166 <dt>Return Type:</dt> 212 <dt>Return Type:</dt>
167 <dd> 213 <dd>
168 str 214 str
169 </dd> 215 </dd>
170 </dl><a NAME="Pip.getIndexUrlXml" ID="Pip.getIndexUrlXml"></a> 216 </dl>
217 <a NAME="Pip.getIndexUrlXml" ID="Pip.getIndexUrlXml"></a>
171 <h4>Pip.getIndexUrlXml</h4> 218 <h4>Pip.getIndexUrlXml</h4>
172 <b>getIndexUrlXml</b>(<i></i>) 219 <b>getIndexUrlXml</b>(<i></i>)
220
173 <p> 221 <p>
174 Public method to get the index URL for XML RPC calls. 222 Public method to get the index URL for XML RPC calls.
175 </p><dl> 223 </p>
224 <dl>
176 <dt>Returns:</dt> 225 <dt>Returns:</dt>
177 <dd> 226 <dd>
178 index URL for XML RPC calls 227 index URL for XML RPC calls
179 </dd> 228 </dd>
180 </dl><dl> 229 </dl>
230 <dl>
181 <dt>Return Type:</dt> 231 <dt>Return Type:</dt>
182 <dd> 232 <dd>
183 str 233 str
184 </dd> 234 </dd>
185 </dl><a NAME="Pip.getInstalledPackages" ID="Pip.getInstalledPackages"></a> 235 </dl>
236 <a NAME="Pip.getInstalledPackages" ID="Pip.getInstalledPackages"></a>
186 <h4>Pip.getInstalledPackages</h4> 237 <h4>Pip.getInstalledPackages</h4>
187 <b>getInstalledPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>) 238 <b>getInstalledPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
239
188 <p> 240 <p>
189 Public method to get the list of installed packages. 241 Public method to get the list of installed packages.
190 </p><dl> 242 </p>
243 <dl>
244
191 <dt><i>envName</i> (str)</dt> 245 <dt><i>envName</i> (str)</dt>
192 <dd> 246 <dd>
193 name of the environment to get the packages for 247 name of the environment to get the packages for
194 </dd><dt><i>localPackages</i> (bool)</dt> 248 </dd>
249 <dt><i>localPackages</i> (bool)</dt>
195 <dd> 250 <dd>
196 flag indicating to get local packages only 251 flag indicating to get local packages only
197 </dd><dt><i>notRequired</i> (bool)</dt> 252 </dd>
253 <dt><i>notRequired</i> (bool)</dt>
198 <dd> 254 <dd>
199 flag indicating to list packages that are not 255 flag indicating to list packages that are not
200 dependencies of installed packages as well 256 dependencies of installed packages as well
201 </dd><dt><i>usersite</i> (bool)</dt> 257 </dd>
258 <dt><i>usersite</i> (bool)</dt>
202 <dd> 259 <dd>
203 flag indicating to only list packages installed 260 flag indicating to only list packages installed
204 in user-site 261 in user-site
205 </dd> 262 </dd>
206 </dl><dl> 263 </dl>
264 <dl>
207 <dt>Returns:</dt> 265 <dt>Returns:</dt>
208 <dd> 266 <dd>
209 list of tuples containing the package name and version 267 list of tuples containing the package name and version
210 </dd> 268 </dd>
211 </dl><dl> 269 </dl>
270 <dl>
212 <dt>Return Type:</dt> 271 <dt>Return Type:</dt>
213 <dd> 272 <dd>
214 list of tuple of (str, str) 273 list of tuple of (str, str)
215 </dd> 274 </dd>
216 </dl><a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a> 275 </dl>
276 <a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a>
217 <h4>Pip.getOutdatedPackages</h4> 277 <h4>Pip.getOutdatedPackages</h4>
218 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>) 278 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
279
219 <p> 280 <p>
220 Public method to get the list of outdated packages. 281 Public method to get the list of outdated packages.
221 </p><dl> 282 </p>
283 <dl>
284
222 <dt><i>envName</i> (str)</dt> 285 <dt><i>envName</i> (str)</dt>
223 <dd> 286 <dd>
224 name of the environment to get the packages for 287 name of the environment to get the packages for
225 </dd><dt><i>localPackages</i> (bool)</dt> 288 </dd>
289 <dt><i>localPackages</i> (bool)</dt>
226 <dd> 290 <dd>
227 flag indicating to get local packages only 291 flag indicating to get local packages only
228 </dd><dt><i>notRequired</i> (bool)</dt> 292 </dd>
293 <dt><i>notRequired</i> (bool)</dt>
229 <dd> 294 <dd>
230 flag indicating to list packages that are not 295 flag indicating to list packages that are not
231 dependencies of installed packages as well 296 dependencies of installed packages as well
232 </dd><dt><i>usersite</i> (bool)</dt> 297 </dd>
298 <dt><i>usersite</i> (bool)</dt>
233 <dd> 299 <dd>
234 flag indicating to only list packages installed 300 flag indicating to only list packages installed
235 in user-site 301 in user-site
236 </dd> 302 </dd>
237 </dl><dl> 303 </dl>
304 <dl>
238 <dt>Returns:</dt> 305 <dt>Returns:</dt>
239 <dd> 306 <dd>
240 list of tuples containing the package name, installed version 307 list of tuples containing the package name, installed version
241 and available version 308 and available version
242 </dd> 309 </dd>
243 </dl><dl> 310 </dl>
311 <dl>
244 <dt>Return Type:</dt> 312 <dt>Return Type:</dt>
245 <dd> 313 <dd>
246 list of tuple of (str, str, str) 314 list of tuple of (str, str, str)
247 </dd> 315 </dd>
248 </dl><a NAME="Pip.getPackageDetails" ID="Pip.getPackageDetails"></a> 316 </dl>
317 <a NAME="Pip.getPackageDetails" ID="Pip.getPackageDetails"></a>
249 <h4>Pip.getPackageDetails</h4> 318 <h4>Pip.getPackageDetails</h4>
250 <b>getPackageDetails</b>(<i>name, version</i>) 319 <b>getPackageDetails</b>(<i>name, version</i>)
320
251 <p> 321 <p>
252 Public method to get package details using the PyPI JSON interface. 322 Public method to get package details using the PyPI JSON interface.
253 </p><dl> 323 </p>
324 <dl>
325
254 <dt><i>name</i> (str)</dt> 326 <dt><i>name</i> (str)</dt>
255 <dd> 327 <dd>
256 package name 328 package name
257 </dd><dt><i>version</i> (str)</dt> 329 </dd>
330 <dt><i>version</i> (str)</dt>
258 <dd> 331 <dd>
259 package version 332 package version
260 </dd> 333 </dd>
261 </dl><dl> 334 </dl>
335 <dl>
262 <dt>Returns:</dt> 336 <dt>Returns:</dt>
263 <dd> 337 <dd>
264 dictionary containing PyPI package data 338 dictionary containing PyPI package data
265 </dd> 339 </dd>
266 </dl><dl> 340 </dl>
341 <dl>
267 <dt>Return Type:</dt> 342 <dt>Return Type:</dt>
268 <dd> 343 <dd>
269 dict 344 dict
270 </dd> 345 </dd>
271 </dl><a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a> 346 </dl>
347 <a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a>
272 <h4>Pip.getProjectEnvironmentString</h4> 348 <h4>Pip.getProjectEnvironmentString</h4>
273 <b>getProjectEnvironmentString</b>(<i></i>) 349 <b>getProjectEnvironmentString</b>(<i></i>)
350
274 <p> 351 <p>
275 Public method to get the string for the project environment. 352 Public method to get the string for the project environment.
276 </p><dl> 353 </p>
354 <dl>
277 <dt>Returns:</dt> 355 <dt>Returns:</dt>
278 <dd> 356 <dd>
279 string for the project environment 357 string for the project environment
280 </dd> 358 </dd>
281 </dl><dl> 359 </dl>
360 <dl>
282 <dt>Return Type:</dt> 361 <dt>Return Type:</dt>
283 <dd> 362 <dd>
284 str 363 str
285 </dd> 364 </dd>
286 </dl><a NAME="Pip.getUserConfig" ID="Pip.getUserConfig"></a> 365 </dl>
366 <a NAME="Pip.getUserConfig" ID="Pip.getUserConfig"></a>
287 <h4>Pip.getUserConfig</h4> 367 <h4>Pip.getUserConfig</h4>
288 <b>getUserConfig</b>(<i></i>) 368 <b>getUserConfig</b>(<i></i>)
369
289 <p> 370 <p>
290 Public method to get the name of the user configuration file. 371 Public method to get the name of the user configuration file.
291 </p><dl> 372 </p>
373 <dl>
292 <dt>Returns:</dt> 374 <dt>Returns:</dt>
293 <dd> 375 <dd>
294 path of the user configuration file 376 path of the user configuration file
295 </dd> 377 </dd>
296 </dl><dl> 378 </dl>
379 <dl>
297 <dt>Return Type:</dt> 380 <dt>Return Type:</dt>
298 <dd> 381 <dd>
299 str 382 str
300 </dd> 383 </dd>
301 </dl><a NAME="Pip.getVirtualenvConfig" ID="Pip.getVirtualenvConfig"></a> 384 </dl>
385 <a NAME="Pip.getVirtualenvConfig" ID="Pip.getVirtualenvConfig"></a>
302 <h4>Pip.getVirtualenvConfig</h4> 386 <h4>Pip.getVirtualenvConfig</h4>
303 <b>getVirtualenvConfig</b>(<i>venvName</i>) 387 <b>getVirtualenvConfig</b>(<i>venvName</i>)
388
304 <p> 389 <p>
305 Public method to get the name of the virtualenv configuration file. 390 Public method to get the name of the virtualenv configuration file.
306 </p><dl> 391 </p>
392 <dl>
393
307 <dt><i>venvName</i> (str)</dt> 394 <dt><i>venvName</i> (str)</dt>
308 <dd> 395 <dd>
309 name of the environment to get config file path for 396 name of the environment to get config file path for
310 </dd> 397 </dd>
311 </dl><dl> 398 </dl>
399 <dl>
312 <dt>Returns:</dt> 400 <dt>Returns:</dt>
313 <dd> 401 <dd>
314 path of the virtualenv configuration file 402 path of the virtualenv configuration file
315 </dd> 403 </dd>
316 </dl><dl> 404 </dl>
405 <dl>
317 <dt>Return Type:</dt> 406 <dt>Return Type:</dt>
318 <dd> 407 <dd>
319 str 408 str
320 </dd> 409 </dd>
321 </dl><a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a> 410 </dl>
411 <a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a>
322 <h4>Pip.getVirtualenvInterpreter</h4> 412 <h4>Pip.getVirtualenvInterpreter</h4>
323 <b>getVirtualenvInterpreter</b>(<i>venvName</i>) 413 <b>getVirtualenvInterpreter</b>(<i>venvName</i>)
414
324 <p> 415 <p>
325 Public method to get the interpreter for a virtual environment. 416 Public method to get the interpreter for a virtual environment.
326 </p><dl> 417 </p>
418 <dl>
419
327 <dt><i>venvName</i> (str)</dt> 420 <dt><i>venvName</i> (str)</dt>
328 <dd> 421 <dd>
329 logical name for the virtual environment 422 logical name for the virtual environment
330 </dd> 423 </dd>
331 </dl><dl> 424 </dl>
425 <dl>
332 <dt>Returns:</dt> 426 <dt>Returns:</dt>
333 <dd> 427 <dd>
334 interpreter path 428 interpreter path
335 </dd> 429 </dd>
336 </dl><dl> 430 </dl>
431 <dl>
337 <dt>Return Type:</dt> 432 <dt>Return Type:</dt>
338 <dd> 433 <dd>
339 str 434 str
340 </dd> 435 </dd>
341 </dl><a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a> 436 </dl>
437 <a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a>
342 <h4>Pip.getVirtualenvNames</h4> 438 <h4>Pip.getVirtualenvNames</h4>
343 <b>getVirtualenvNames</b>(<i>noRemote=False</i>) 439 <b>getVirtualenvNames</b>(<i>noRemote=False</i>)
440
344 <p> 441 <p>
345 Public method to get a sorted list of virtual environment names. 442 Public method to get a sorted list of virtual environment names.
346 </p><dl> 443 </p>
444 <dl>
445
347 <dt><i>noRemote</i> (bool)</dt> 446 <dt><i>noRemote</i> (bool)</dt>
348 <dd> 447 <dd>
349 flag indicating to exclude environments for remote 448 flag indicating to exclude environments for remote
350 debugging 449 debugging
351 </dd> 450 </dd>
352 </dl><dl> 451 </dl>
452 <dl>
353 <dt>Returns:</dt> 453 <dt>Returns:</dt>
354 <dd> 454 <dd>
355 sorted list of virtual environment names 455 sorted list of virtual environment names
356 </dd> 456 </dd>
357 </dl><dl> 457 </dl>
458 <dl>
358 <dt>Return Type:</dt> 459 <dt>Return Type:</dt>
359 <dd> 460 <dd>
360 list of str 461 list of str
361 </dd> 462 </dd>
362 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a> 463 </dl>
464 <a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
363 <h4>Pip.installPackages</h4> 465 <h4>Pip.installPackages</h4>
364 <b>installPackages</b>(<i>packages, venvName="", userSite=False, interpreter=""</i>) 466 <b>installPackages</b>(<i>packages, venvName="", userSite=False, interpreter=""</i>)
467
365 <p> 468 <p>
366 Public method to install the given list of packages. 469 Public method to install the given list of packages.
367 </p><dl> 470 </p>
471 <dl>
472
368 <dt><i>packages</i> (list of str)</dt> 473 <dt><i>packages</i> (list of str)</dt>
369 <dd> 474 <dd>
370 list of packages to install 475 list of packages to install
371 </dd><dt><i>venvName</i> (str)</dt> 476 </dd>
477 <dt><i>venvName</i> (str)</dt>
372 <dd> 478 <dd>
373 name of the virtual environment to be used 479 name of the virtual environment to be used
374 </dd><dt><i>userSite</i> (bool)</dt> 480 </dd>
481 <dt><i>userSite</i> (bool)</dt>
375 <dd> 482 <dd>
376 flag indicating an install to the user install 483 flag indicating an install to the user install
377 directory 484 directory
378 </dd><dt><i>interpreter</i> (str)</dt> 485 </dd>
486 <dt><i>interpreter</i> (str)</dt>
379 <dd> 487 <dd>
380 interpreter to be used for execution 488 interpreter to be used for execution
381 </dd> 489 </dd>
382 </dl><a NAME="Pip.installPip" ID="Pip.installPip"></a> 490 </dl>
491 <a NAME="Pip.installPip" ID="Pip.installPip"></a>
383 <h4>Pip.installPip</h4> 492 <h4>Pip.installPip</h4>
384 <b>installPip</b>(<i>venvName, userSite=False</i>) 493 <b>installPip</b>(<i>venvName, userSite=False</i>)
494
385 <p> 495 <p>
386 Public method to install pip. 496 Public method to install pip.
387 </p><dl> 497 </p>
498 <dl>
499
388 <dt><i>venvName</i> (str)</dt> 500 <dt><i>venvName</i> (str)</dt>
389 <dd> 501 <dd>
390 name of the environment to install pip into 502 name of the environment to install pip into
391 </dd><dt><i>userSite</i> (bool)</dt> 503 </dd>
504 <dt><i>userSite</i> (bool)</dt>
392 <dd> 505 <dd>
393 flag indicating an install to the user install 506 flag indicating an install to the user install
394 directory 507 directory
395 </dd> 508 </dd>
396 </dl><a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a> 509 </dl>
510 <a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a>
397 <h4>Pip.installRequirements</h4> 511 <h4>Pip.installRequirements</h4>
398 <b>installRequirements</b>(<i>venvName</i>) 512 <b>installRequirements</b>(<i>venvName</i>)
513
399 <p> 514 <p>
400 Public method to install packages as given in a requirements file. 515 Public method to install packages as given in a requirements file.
401 </p><dl> 516 </p>
517 <dl>
518
402 <dt><i>venvName</i> (str)</dt> 519 <dt><i>venvName</i> (str)</dt>
403 <dd> 520 <dd>
404 name of the virtual environment to be used 521 name of the virtual environment to be used
405 </dd> 522 </dd>
406 </dl><a NAME="Pip.repairPip" ID="Pip.repairPip"></a> 523 </dl>
524 <a NAME="Pip.repairPip" ID="Pip.repairPip"></a>
407 <h4>Pip.repairPip</h4> 525 <h4>Pip.repairPip</h4>
408 <b>repairPip</b>(<i>venvName</i>) 526 <b>repairPip</b>(<i>venvName</i>)
527
409 <p> 528 <p>
410 Public method to repair the pip installation. 529 Public method to repair the pip installation.
411 </p><dl> 530 </p>
531 <dl>
532
412 <dt><i>venvName</i> (str)</dt> 533 <dt><i>venvName</i> (str)</dt>
413 <dd> 534 <dd>
414 name of the environment to install pip into 535 name of the environment to install pip into
415 </dd> 536 </dd>
416 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a> 537 </dl>
538 <a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
417 <h4>Pip.runProcess</h4> 539 <h4>Pip.runProcess</h4>
418 <b>runProcess</b>(<i>args, interpreter</i>) 540 <b>runProcess</b>(<i>args, interpreter</i>)
541
419 <p> 542 <p>
420 Public method to execute the current pip with the given arguments. 543 Public method to execute the current pip with the given arguments.
421 </p><p> 544 </p>
545 <p>
422 The selected pip executable is called with the given arguments and 546 The selected pip executable is called with the given arguments and
423 waited for its end. 547 waited for its end.
424 </p><dl> 548 </p>
549 <dl>
550
425 <dt><i>args</i> (list of str)</dt> 551 <dt><i>args</i> (list of str)</dt>
426 <dd> 552 <dd>
427 list of command line arguments 553 list of command line arguments
428 </dd><dt><i>interpreter</i> (str)</dt> 554 </dd>
555 <dt><i>interpreter</i> (str)</dt>
429 <dd> 556 <dd>
430 path of the Python interpreter to be used 557 path of the Python interpreter to be used
431 </dd> 558 </dd>
432 </dl><dl> 559 </dl>
560 <dl>
433 <dt>Returns:</dt> 561 <dt>Returns:</dt>
434 <dd> 562 <dd>
435 tuple containing a flag indicating success and the output 563 tuple containing a flag indicating success and the output
436 of the process 564 of the process
437 </dd> 565 </dd>
438 </dl><dl> 566 </dl>
567 <dl>
439 <dt>Return Type:</dt> 568 <dt>Return Type:</dt>
440 <dd> 569 <dd>
441 tuple of (bool, str) 570 tuple of (bool, str)
442 </dd> 571 </dd>
443 </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a> 572 </dl>
573 <a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
444 <h4>Pip.uninstallPackages</h4> 574 <h4>Pip.uninstallPackages</h4>
445 <b>uninstallPackages</b>(<i>packages, venvName</i>) 575 <b>uninstallPackages</b>(<i>packages, venvName</i>)
576
446 <p> 577 <p>
447 Public method to uninstall the given list of packages. 578 Public method to uninstall the given list of packages.
448 </p><dl> 579 </p>
580 <dl>
581
449 <dt><i>packages</i> (list of str)</dt> 582 <dt><i>packages</i> (list of str)</dt>
450 <dd> 583 <dd>
451 list of packages to uninstall 584 list of packages to uninstall
452 </dd><dt><i>venvName</i> (str)</dt> 585 </dd>
586 <dt><i>venvName</i> (str)</dt>
453 <dd> 587 <dd>
454 name of the virtual environment to be used 588 name of the virtual environment to be used
455 </dd> 589 </dd>
456 </dl><dl> 590 </dl>
591 <dl>
457 <dt>Returns:</dt> 592 <dt>Returns:</dt>
458 <dd> 593 <dd>
459 flag indicating a successful execution 594 flag indicating a successful execution
460 </dd> 595 </dd>
461 </dl><dl> 596 </dl>
597 <dl>
462 <dt>Return Type:</dt> 598 <dt>Return Type:</dt>
463 <dd> 599 <dd>
464 bool 600 bool
465 </dd> 601 </dd>
466 </dl><a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a> 602 </dl>
603 <a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a>
467 <h4>Pip.uninstallRequirements</h4> 604 <h4>Pip.uninstallRequirements</h4>
468 <b>uninstallRequirements</b>(<i>venvName</i>) 605 <b>uninstallRequirements</b>(<i>venvName</i>)
606
469 <p> 607 <p>
470 Public method to uninstall packages as given in a requirements file. 608 Public method to uninstall packages as given in a requirements file.
471 </p><dl> 609 </p>
610 <dl>
611
472 <dt><i>venvName</i> (str)</dt> 612 <dt><i>venvName</i> (str)</dt>
473 <dd> 613 <dd>
474 name of the virtual environment to be used 614 name of the virtual environment to be used
475 </dd> 615 </dd>
476 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a> 616 </dl>
617 <a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
477 <h4>Pip.upgradePackages</h4> 618 <h4>Pip.upgradePackages</h4>
478 <b>upgradePackages</b>(<i>packages, venvName, userSite=False</i>) 619 <b>upgradePackages</b>(<i>packages, venvName, userSite=False</i>)
620
479 <p> 621 <p>
480 Public method to upgrade the given list of packages. 622 Public method to upgrade the given list of packages.
481 </p><dl> 623 </p>
624 <dl>
625
482 <dt><i>packages</i> (list of str)</dt> 626 <dt><i>packages</i> (list of str)</dt>
483 <dd> 627 <dd>
484 list of packages to upgrade 628 list of packages to upgrade
485 </dd><dt><i>venvName</i> (str)</dt> 629 </dd>
630 <dt><i>venvName</i> (str)</dt>
486 <dd> 631 <dd>
487 name of the virtual environment to be used 632 name of the virtual environment to be used
488 </dd><dt><i>userSite</i> (bool)</dt> 633 </dd>
634 <dt><i>userSite</i> (bool)</dt>
489 <dd> 635 <dd>
490 flag indicating an install to the user install 636 flag indicating an install to the user install
491 directory 637 directory
492 </dd> 638 </dd>
493 </dl><dl> 639 </dl>
640 <dl>
494 <dt>Returns:</dt> 641 <dt>Returns:</dt>
495 <dd> 642 <dd>
496 flag indicating a successful execution 643 flag indicating a successful execution
497 </dd> 644 </dd>
498 </dl><dl> 645 </dl>
646 <dl>
499 <dt>Return Type:</dt> 647 <dt>Return Type:</dt>
500 <dd> 648 <dd>
501 bool 649 bool
502 </dd> 650 </dd>
503 </dl> 651 </dl>

Mercurial Repository: eric

eric ide

mercurial