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

changeset 6333
3d4e7155d48f
parent 6296
db9b3a419845
child 6343
86cea8abd0f7
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html	Fri Jun 08 19:32:41 2018 +0200
@@ -291,10 +291,16 @@
         Private slot to install packages to be given by the user.
 </p><a NAME="Pip.__installPip" ID="Pip.__installPip"></a>
 <h4>Pip.__installPip</h4>
-<b>__installPip</b>(<i></i>)
+<b>__installPip</b>(<i>userSite=False</i>)
 <p>
         Private slot to install pip.
-</p><a NAME="Pip.__installRequirements" ID="Pip.__installRequirements"></a>
+</p><dl>
+<dt><i>userSite</i> (bool)</dt>
+<dd>
+flag indicating an install to the user install
+            directory
+</dd>
+</dl><a NAME="Pip.__installRequirements" ID="Pip.__installRequirements"></a>
 <h4>Pip.__installRequirements</h4>
 <b>__installRequirements</b>(<i></i>)
 <p>
@@ -402,16 +408,20 @@
 </dd>
 </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
 <h4>Pip.installPackages</h4>
-<b>installPackages</b>(<i>packages, cmd=""</i>)
+<b>installPackages</b>(<i>packages, cmd="", userSite=False</i>)
 <p>
         Public method to install the given list of packages.
 </p><dl>
-<dt><i>packages</i></dt>
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of packages to install
+</dd><dt><i>cmd</i> (str)</dt>
 <dd>
-list of packages to install (list of string)
-</dd><dt><i>cmd</i></dt>
+pip command to be used
+</dd><dt><i>userSite</i> (bool)</dt>
 <dd>
-pip command to be used (string)
+flag indicating an install to the user install
+            directory
 </dd>
 </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
 <h4>Pip.runProcess</h4>
@@ -460,31 +470,44 @@
 </dd>
 </dl><a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
 <h4>Pip.upgradePackages</h4>
-<b>upgradePackages</b>(<i>packages, cmd=""</i>)
+<b>upgradePackages</b>(<i>packages, cmd="", userSite=False</i>)
 <p>
         Public method to upgrade the given list of packages.
 </p><dl>
-<dt><i>packages</i></dt>
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of packages to upgrade
+</dd><dt><i>cmd</i> (str)</dt>
 <dd>
-list of packages to upgrade (list of string)
-</dd><dt><i>cmd</i></dt>
+pip command to be used
+</dd><dt><i>userSite</i> (bool)</dt>
 <dd>
-pip command to be used (string)
+flag indicating an install to the user install
+            directory
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating a successful execution (boolean)
+flag indicating a successful execution
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a>
 <h4>Pip.upgradePip</h4>
-<b>upgradePip</b>(<i>pip=""</i>)
+<b>upgradePip</b>(<i>pip="", userSite=False</i>)
 <p>
         Public method to upgrade pip itself.
 </p><dl>
 <dt><i>pip</i> (str)</dt>
 <dd>
 pip command to be used
+</dd><dt><i>userSite</i> (bool)</dt>
+<dd>
+flag indicating an install to the user install
+            directory
 </dd>
 </dl><dl>
 <dt>Returns:</dt>

eric ide

mercurial