pip Interface: finished adding support for the '--user' option by updating the source docu.

Fri, 08 Jun 2018 19:32:41 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 08 Jun 2018 19:32:41 +0200
changeset 6333
3d4e7155d48f
parent 6332
1697b1f40833
child 6334
ca90aee56d20

pip Interface: finished adding support for the '--user' option by updating the source docu.

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
APIs/Python3/eric6.bas file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html file | annotate | diff | comparison | revisions
Documentation/Source/index-eric6.Plugins.UiExtensionPlugins.PipInterface.html file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Fri Jun 08 19:31:38 2018 +0200
+++ b/APIs/Python3/eric6.api	Fri Jun 08 19:32:41 2018 +0200
@@ -4881,11 +4881,11 @@
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getMenuNames?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.initActions?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.initMenu?4()
-eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.installPackages?4(packages, cmd="")
+eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.installPackages?4(packages, cmd="", userSite=False)
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.runProcess?4(args, cmd="")
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.uninstallPackages?4(packages, cmd="")
-eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePackages?4(packages, cmd="")
-eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePip?4(pip="")
+eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePackages?4(packages, cmd="", userSite=False)
+eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePip?4(pip="", userSite=False)
 eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip?1(plugin, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.PipDialog.closeEvent?4(e)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.PipDialog.on_buttonBox_clicked?4(button)
@@ -4894,7 +4894,7 @@
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.PipDialog?1(text, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.PipFileSelectionDialog.getData?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.PipFileSelectionDialog.on_filePicker_textChanged?4(txt)
-eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.PipFileSelectionDialog?1(plugin, mode, parent=None)
+eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.PipFileSelectionDialog?1(plugin, mode, install=True, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.closeEvent?4(e)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_buttonBox_clicked?4(button)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_copyButton_clicked?4()
@@ -4922,13 +4922,14 @@
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_notRequiredCheckBox_clicked?4(checked)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_packageList_itemSelectionChanged?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_pipComboBox_activated?4(txt)
+eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_userCheckBox_clicked?4(checked)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_verboseCheckBox_clicked?4(checked)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.start?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog?1(pip, mode, plugin, title, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.PipPackageDetailsDialog?1(detailsData, downloadsData, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog.getData?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog.on_packagesEdit_textChanged?4(txt)
-eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog?1(plugin, title, parent=None)
+eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog?1(plugin, title, install=True, parent=None)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.Stopwords?7
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.VersionRole?7
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.closeEvent?4(e)
@@ -4938,6 +4939,8 @@
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.on_searchButton_clicked?4()
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.on_searchEdit_textChanged?4(txt)
 eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog?1(pip, plugin, parent=None)
+eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.PipSelectionDialog.getData?4()
+eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.PipSelectionDialog?1(plugin, parent=None)
 eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.TranslatorPage.TranslatorPage.on_defaultButton_clicked?4()
 eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.TranslatorPage.TranslatorPage.on_languagesList_itemChanged?4(item)
 eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.TranslatorPage.TranslatorPage.on_setButton_clicked?4()
--- a/APIs/Python3/eric6.bas	Fri Jun 08 19:31:38 2018 +0200
+++ b/APIs/Python3/eric6.bas	Fri Jun 08 19:32:41 2018 +0200
@@ -662,6 +662,7 @@
 PipPackagesInputDialog QDialog Ui_PipPackagesInputDialog
 PipPage ConfigurationPageBase Ui_PipPage
 PipSearchDialog QDialog Ui_PipSearchDialog
+PipSelectionDialog QDialog Ui_PipSelectionDialog
 PixmapDiagram E5MainWindow
 PlainStrList list
 PlainTextDocumentationViewer QWidget
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Help/source.qhp	Fri Jun 08 19:32:41 2018 +0200
@@ -526,6 +526,7 @@
                 <section title="eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html" />
                 <section title="eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html" />
                 <section title="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html" />
+                <section title="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html" />
               </section>
               <section title="eric6.Plugins.UiExtensionPlugins.Translator" ref="index-eric6.Plugins.UiExtensionPlugins.Translator.html">
                 <section title="eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage" ref="index-eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.html">
@@ -12060,6 +12061,7 @@
       <keyword name="PipListDialog.on_notRequiredCheckBox_clicked" id="PipListDialog.on_notRequiredCheckBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_notRequiredCheckBox_clicked" />
       <keyword name="PipListDialog.on_packageList_itemSelectionChanged" id="PipListDialog.on_packageList_itemSelectionChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_packageList_itemSelectionChanged" />
       <keyword name="PipListDialog.on_pipComboBox_activated" id="PipListDialog.on_pipComboBox_activated" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_pipComboBox_activated" />
+      <keyword name="PipListDialog.on_userCheckBox_clicked" id="PipListDialog.on_userCheckBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_userCheckBox_clicked" />
       <keyword name="PipListDialog.on_verboseCheckBox_clicked" id="PipListDialog.on_verboseCheckBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_verboseCheckBox_clicked" />
       <keyword name="PipListDialog.start" id="PipListDialog.start" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.start" />
       <keyword name="PipPackageDetailsDialog" id="PipPackageDetailsDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html#PipPackageDetailsDialog" />
@@ -12102,6 +12104,10 @@
       <keyword name="PipSearchDialog.on_resultList_itemSelectionChanged" id="PipSearchDialog.on_resultList_itemSelectionChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html#PipSearchDialog.on_resultList_itemSelectionChanged" />
       <keyword name="PipSearchDialog.on_searchButton_clicked" id="PipSearchDialog.on_searchButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html#PipSearchDialog.on_searchButton_clicked" />
       <keyword name="PipSearchDialog.on_searchEdit_textChanged" id="PipSearchDialog.on_searchEdit_textChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html#PipSearchDialog.on_searchEdit_textChanged" />
+      <keyword name="PipSelectionDialog" id="PipSelectionDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html#PipSelectionDialog" />
+      <keyword name="PipSelectionDialog (Constructor)" id="PipSelectionDialog (Constructor)" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html#PipSelectionDialog.__init__" />
+      <keyword name="PipSelectionDialog (Module)" id="PipSelectionDialog (Module)" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html" />
+      <keyword name="PipSelectionDialog.getData" id="PipSelectionDialog.getData" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html#PipSelectionDialog.getData" />
       <keyword name="PixmapCache" id="PixmapCache" ref="eric6.UI.PixmapCache.html#PixmapCache" />
       <keyword name="PixmapCache (Constructor)" id="PixmapCache (Constructor)" ref="eric6.UI.PixmapCache.html#PixmapCache.__init__" />
       <keyword name="PixmapCache (Module)" id="PixmapCache (Module)" ref="eric6.UI.PixmapCache.html" />
@@ -19653,6 +19659,7 @@
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html</file>
+      <file>eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.Translator.ConfigurationPage.TranslatorPage.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.Translator.Translator.html</file>
       <file>eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.DeepLEngine.html</file>
--- 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>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html	Fri Jun 08 19:32:41 2018 +0200
@@ -73,7 +73,7 @@
 </table>
 <a NAME="PipFileSelectionDialog.__init__" ID="PipFileSelectionDialog.__init__"></a>
 <h4>PipFileSelectionDialog (Constructor)</h4>
-<b>PipFileSelectionDialog</b>(<i>plugin, mode, parent=None</i>)
+<b>PipFileSelectionDialog</b>(<i>plugin, mode, install=True, parent=None</i>)
 <p>
         Constructor
 </p><dl>
@@ -83,6 +83,9 @@
 </dd><dt><i>mode</i> (str)</dt>
 <dd>
 mode of the dialog
+</dd><dt><i>install</i> (bool)</dt>
+<dd>
+flag indicating an install action
 </dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
 reference to the parent widget
@@ -95,13 +98,14 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-tuple with the pip command and the name of the
-            selected file
+tuple with the pip command, the name of the
+            selected file and a flag indicating to install to the
+            user install directory
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (str, str)
+tuple of (str, str, bool)
 </dd>
 </dl><a NAME="PipFileSelectionDialog.on_filePicker_textChanged" ID="PipFileSelectionDialog.on_filePicker_textChanged"></a>
 <h4>PipFileSelectionDialog.on_filePicker_textChanged</h4>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html	Fri Jun 08 19:32:41 2018 +0200
@@ -117,6 +117,9 @@
 <td><a href="#PipListDialog.on_pipComboBox_activated">on_pipComboBox_activated</a></td>
 <td>Private slot handling the selection of a pip executable.</td>
 </tr><tr>
+<td><a href="#PipListDialog.on_userCheckBox_clicked">on_userCheckBox_clicked</a></td>
+<td>Private slot handling the switching of the 'user-site' mode.</td>
+</tr><tr>
 <td><a href="#PipListDialog.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
 <td>Private slot to handle a change of the verbose package information checkbox.</td>
 </tr><tr>
@@ -268,9 +271,9 @@
 <p>
         Private slot handling the switching of the local mode.
 </p><dl>
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the local check box (boolean)
+state of the local check box
 </dd>
 </dl><a NAME="PipListDialog.on_notRequiredCheckBox_clicked" ID="PipListDialog.on_notRequiredCheckBox_clicked"></a>
 <h4>PipListDialog.on_notRequiredCheckBox_clicked</h4>
@@ -278,9 +281,9 @@
 <p>
         Private slot handling the switching of the 'not required' mode.
 </p><dl>
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the 'not required' check box (boolean)
+state of the 'not required' check box
 </dd>
 </dl><a NAME="PipListDialog.on_packageList_itemSelectionChanged" ID="PipListDialog.on_packageList_itemSelectionChanged"></a>
 <h4>PipListDialog.on_packageList_itemSelectionChanged</h4>
@@ -297,6 +300,16 @@
 <dd>
 path of the pip executable (string)
 </dd>
+</dl><a NAME="PipListDialog.on_userCheckBox_clicked" ID="PipListDialog.on_userCheckBox_clicked"></a>
+<h4>PipListDialog.on_userCheckBox_clicked</h4>
+<b>on_userCheckBox_clicked</b>(<i>checked</i>)
+<p>
+        Private slot handling the switching of the 'user-site' mode.
+</p><dl>
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the 'user-site' check box
+</dd>
 </dl><a NAME="PipListDialog.on_verboseCheckBox_clicked" ID="PipListDialog.on_verboseCheckBox_clicked"></a>
 <h4>PipListDialog.on_verboseCheckBox_clicked</h4>
 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html	Fri Jun 08 19:32:41 2018 +0200
@@ -73,19 +73,22 @@
 </table>
 <a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a>
 <h4>PipPackagesInputDialog (Constructor)</h4>
-<b>PipPackagesInputDialog</b>(<i>plugin, title, parent=None</i>)
+<b>PipPackagesInputDialog</b>(<i>plugin, title, install=True, parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (ToolPipPlugin)</dt>
 <dd>
-reference to the plugin object (ToolPipPlugin)
-</dd><dt><i>title</i></dt>
+reference to the plugin object
+</dd><dt><i>title</i> (str)</dt>
 <dd>
-dialog title (string)
-</dd><dt><i>parent</i></dt>
+dialog title
+</dd><dt><i>install</i> (bool)</dt>
 <dd>
-reference to the parent widget (QWidget)
+flag indicating an install action
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
 </dd>
 </dl><a NAME="PipPackagesInputDialog.getData" ID="PipPackagesInputDialog.getData"></a>
 <h4>PipPackagesInputDialog.getData</h4>
@@ -95,8 +98,13 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-tuple with the pip command (string) and the list of
-            package specifications (list of string)
+tuple with the pip command, the list of package specifications
+            and a flag indicating to install to the user install directory
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, list of str, bool)
 </dd>
 </dl><a NAME="PipPackagesInputDialog.on_packagesEdit_textChanged" ID="PipPackagesInputDialog.on_packagesEdit_textChanged"></a>
 <h4>PipPackagesInputDialog.on_packagesEdit_textChanged</h4>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html	Fri Jun 08 19:32:41 2018 +0200
@@ -178,10 +178,15 @@
 </dd>
 </dl><a NAME="PipSearchDialog.__install" ID="PipSearchDialog.__install"></a>
 <h4>PipSearchDialog.__install</h4>
-<b>__install</b>(<i></i>)
+<b>__install</b>(<i>userSite=False</i>)
 <p>
         Private slot to install the selected packages.
-</p><a NAME="PipSearchDialog.__processSearchResult" ID="PipSearchDialog.__processSearchResult"></a>
+</p><dl>
+<dt><i>userSite</i> (bool)</dt>
+<dd>
+flag indicating to install to the user directory
+</dd>
+</dl><a NAME="PipSearchDialog.__processSearchResult" ID="PipSearchDialog.__processSearchResult"></a>
 <h4>PipSearchDialog.__processSearchResult</h4>
 <b>__processSearchResult</b>(<i>data</i>)
 <p>
--- a/Documentation/Source/index-eric6.Plugins.UiExtensionPlugins.PipInterface.html	Fri Jun 08 19:31:38 2018 +0200
+++ b/Documentation/Source/index-eric6.Plugins.UiExtensionPlugins.PipInterface.html	Fri Jun 08 19:32:41 2018 +0200
@@ -58,6 +58,9 @@
 </tr><tr>
 <td><a href="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html">PipSearchDialog</a></td>
 <td>Module implementing a dialog to search PyPI.</td>
+</tr><tr>
+<td><a href="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html">PipSelectionDialog</a></td>
+<td>Module implementing a dialog to select the pip executable to be used.</td>
 </tr>
 </table>
 </body></html>
\ No newline at end of file

eric ide

mercurial