Mercurial Repositories > eric / changeset
changeset
Updated source docu.
Tue, 12 Jun 2018 19:02:21 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Tue, 12 Jun 2018 19:02:21 +0200
- changeset 6343
- 86cea8abd0f7
- parent 6342
- c79ecba9cde7
- child 6344
- 20b21d8045fc
Updated source docu.
--- a/APIs/Python3/eric6.api Tue Jun 12 19:01:06 2018 +0200 +++ b/APIs/Python3/eric6.api Tue Jun 12 19:02:21 2018 +0200 @@ -4410,15 +4410,13 @@ eric6.Plugins.PluginEricdoc.version?7 eric6.Plugins.PluginPipInterface.PipInterfacePlugin.PreferencesKey?7 eric6.Plugins.PluginPipInterface.PipInterfacePlugin.activate?4() -eric6.Plugins.PluginPipInterface.PipInterfacePlugin.currentPipChanged?7 +eric6.Plugins.PluginPipInterface.PipInterfacePlugin.currentEnvironmentChanged?7 eric6.Plugins.PluginPipInterface.PipInterfacePlugin.deactivate?4() -eric6.Plugins.PluginPipInterface.PipInterfacePlugin.getDefaultPipExecutables?4() eric6.Plugins.PluginPipInterface.PipInterfacePlugin.getMenu?4(name) eric6.Plugins.PluginPipInterface.PipInterfacePlugin.getMenuNames?4() eric6.Plugins.PluginPipInterface.PipInterfacePlugin.getPreferences?4(key) eric6.Plugins.PluginPipInterface.PipInterfacePlugin.setPreferences?4(key, value) eric6.Plugins.PluginPipInterface.PipInterfacePlugin?1(ui) -eric6.Plugins.PluginPipInterface._findDefaultExecutables?5(majorVersion) eric6.Plugins.PluginPipInterface.author?7 eric6.Plugins.PluginPipInterface.autoactivate?7 eric6.Plugins.PluginPipInterface.className?7 @@ -4427,7 +4425,6 @@ eric6.Plugins.PluginPipInterface.error?7 eric6.Plugins.PluginPipInterface.exeDisplayDataList?4() eric6.Plugins.PluginPipInterface.getConfigData?4() -eric6.Plugins.PluginPipInterface.getExePath?4(branch, access, versionStr) eric6.Plugins.PluginPipInterface.longDescription?7 eric6.Plugins.PluginPipInterface.name?7 eric6.Plugins.PluginPipInterface.needsRestart?7 @@ -4854,22 +4851,23 @@ eric6.Plugins.PluginWizardSetup.python2Compatible?7 eric6.Plugins.PluginWizardSetup.shortDescription?7 eric6.Plugins.PluginWizardSetup.version?7 -eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.PipPage.on_addButton_clicked?4() -eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.PipPage.on_defaultListButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.PipPage.save?4() eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.PipPage?1(plugin) eric6.Plugins.UiExtensionPlugins.PipInterface.DefaultIndexUrlPip?7 eric6.Plugins.UiExtensionPlugins.PipInterface.DefaultIndexUrlXml?7 eric6.Plugins.UiExtensionPlugins.PipInterface.DefaultPyPiUrl?7 +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getDefaultEnvironmentString?4() eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getMenu?4(name) eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getMenuNames?4() +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getVirtualenvInterpreter?4(venvName) +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.getVirtualenvNames?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="", 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="", userSite=False) -eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePip?4(pip="", userSite=False) +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.installPackages?4(packages, venvName="", userSite=False) +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.runProcess?4(args, interpreter) +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.uninstallPackages?4(packages, venvName="") +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePackages?4(packages, venvName="", userSite=False) +eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.Pip.upgradePip?4(venvName="", 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) @@ -4878,22 +4876,21 @@ 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, install=True, parent=None) +eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.PipFileSelectionDialog?1(pip, 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() -eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_fileButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_insertButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_localCheckBox_clicked?4(checked) -eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_pipComboBox_activated?4(txt) eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_replaceAllButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_replaceSelectionButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_requirementsEdit_textChanged?4() -eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_requirementsFileEdit_textChanged?4(txt) +eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_requirementsFilePicker_textChanged?4(txt) eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_saveButton_clicked?4() eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_saveToButton_clicked?4() +eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.on_venvComboBox_activated?4(txt) eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog.start?4() -eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog?1(pip, plugin, parent=None) +eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.PipFreezeDialog?1(pip, parent=None) eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.CommandArguments?7 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.ShowProcessClassifiersMode?7 eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.ShowProcessEntryPointsMode?7 @@ -4905,15 +4902,15 @@ eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.PipListDialog.on_localCheckBox_clicked?4(checked) 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_venvComboBox_activated?4(txt) 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.PipListDialog.PipListDialog?1(pip, mode, indexUrl, 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, install=True, parent=None) +eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.PipPackagesInputDialog?1(pip, 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) @@ -4922,9 +4919,9 @@ eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.PipSearchDialog.on_resultList_itemSelectionChanged?4() 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.PipSearchDialog.PipSearchDialog?1(pip, indexUrl, parent=None) eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.PipSelectionDialog.getData?4() -eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.PipSelectionDialog?1(plugin, parent=None) +eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.PipSelectionDialog?1(pip, 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() @@ -10576,6 +10573,7 @@ eric6.ViewManager.ViewManager.ViewManager?1() eric6.ViewManager.factory?4(parent, ui, dbs, pluginManager) eric6.VirtualEnv.VirtualenvAddEditDialog.VirtualenvAddEditDialog.getData?4() +eric6.VirtualEnv.VirtualenvAddEditDialog.VirtualenvAddEditDialog.on_globalCheckBox_toggled?4(checked) eric6.VirtualEnv.VirtualenvAddEditDialog.VirtualenvAddEditDialog.on_nameEdit_textChanged?4(txt) eric6.VirtualEnv.VirtualenvAddEditDialog.VirtualenvAddEditDialog.on_pythonExecPicker_textChanged?4(txt) eric6.VirtualEnv.VirtualenvAddEditDialog.VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged?4(txt) @@ -10596,6 +10594,7 @@ eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.createVirtualEnv?4() eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.deleteVirtualEnvs?4(venvNames) eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.getEnvironmentEntries?4() +eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.getVirtualenvDirectory?4(venvName) eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.getVirtualenvInterpreter?4(venvName) eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.getVirtualenvNames?4() eric6.VirtualEnv.VirtualenvManager.VirtualenvManager.isUnique?4(venvName)
--- a/Documentation/Help/source.qhp Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Help/source.qhp Tue Jun 12 19:02:21 2018 +0200 @@ -11967,7 +11967,6 @@ <keyword name="Pip.__editUserConfiguration" id="Pip.__editUserConfiguration" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__editUserConfiguration" /> <keyword name="Pip.__editVirtualenvConfiguration" id="Pip.__editVirtualenvConfiguration" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__editVirtualenvConfiguration" /> <keyword name="Pip.__generateRequirements" id="Pip.__generateRequirements" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__generateRequirements" /> - <keyword name="Pip.__getPython" id="Pip.__getPython" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__getPython" /> <keyword name="Pip.__getUserConfig" id="Pip.__getUserConfig" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__getUserConfig" /> <keyword name="Pip.__getVirtualenvConfig" id="Pip.__getVirtualenvConfig" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__getVirtualenvConfig" /> <keyword name="Pip.__handleTearOffMenu" id="Pip.__handleTearOffMenu" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__handleTearOffMenu" /> @@ -11981,12 +11980,15 @@ <keyword name="Pip.__pipConfigure" id="Pip.__pipConfigure" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__pipConfigure" /> <keyword name="Pip.__repairPip" id="Pip.__repairPip" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__repairPip" /> <keyword name="Pip.__searchPyPI" id="Pip.__searchPyPI" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__searchPyPI" /> - <keyword name="Pip.__selectPipExecutable" id="Pip.__selectPipExecutable" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__selectPipExecutable" /> + <keyword name="Pip.__selectPipVirtualenv" id="Pip.__selectPipVirtualenv" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__selectPipVirtualenv" /> <keyword name="Pip.__uninstallPackages" id="Pip.__uninstallPackages" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__uninstallPackages" /> <keyword name="Pip.__uninstallRequirements" id="Pip.__uninstallRequirements" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__uninstallRequirements" /> <keyword name="Pip.__upgradePackages" id="Pip.__upgradePackages" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.__upgradePackages" /> + <keyword name="Pip.getDefaultEnvironmentString" id="Pip.getDefaultEnvironmentString" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.getDefaultEnvironmentString" /> <keyword name="Pip.getMenu" id="Pip.getMenu" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.getMenu" /> <keyword name="Pip.getMenuNames" id="Pip.getMenuNames" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.getMenuNames" /> + <keyword name="Pip.getVirtualenvInterpreter" id="Pip.getVirtualenvInterpreter" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.getVirtualenvInterpreter" /> + <keyword name="Pip.getVirtualenvNames" id="Pip.getVirtualenvNames" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.getVirtualenvNames" /> <keyword name="Pip.initActions" id="Pip.initActions" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.initActions" /> <keyword name="Pip.initMenu" id="Pip.initMenu" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.initMenu" /> <keyword name="Pip.installPackages" id="Pip.installPackages" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html#Pip.installPackages" /> @@ -12020,16 +12022,15 @@ <keyword name="PipFreezeDialog.closeEvent" id="PipFreezeDialog.closeEvent" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.closeEvent" /> <keyword name="PipFreezeDialog.on_buttonBox_clicked" id="PipFreezeDialog.on_buttonBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_buttonBox_clicked" /> <keyword name="PipFreezeDialog.on_copyButton_clicked" id="PipFreezeDialog.on_copyButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_copyButton_clicked" /> - <keyword name="PipFreezeDialog.on_fileButton_clicked" id="PipFreezeDialog.on_fileButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_fileButton_clicked" /> <keyword name="PipFreezeDialog.on_insertButton_clicked" id="PipFreezeDialog.on_insertButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_insertButton_clicked" /> <keyword name="PipFreezeDialog.on_localCheckBox_clicked" id="PipFreezeDialog.on_localCheckBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_localCheckBox_clicked" /> - <keyword name="PipFreezeDialog.on_pipComboBox_activated" id="PipFreezeDialog.on_pipComboBox_activated" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_pipComboBox_activated" /> <keyword name="PipFreezeDialog.on_replaceAllButton_clicked" id="PipFreezeDialog.on_replaceAllButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_replaceAllButton_clicked" /> <keyword name="PipFreezeDialog.on_replaceSelectionButton_clicked" id="PipFreezeDialog.on_replaceSelectionButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_replaceSelectionButton_clicked" /> <keyword name="PipFreezeDialog.on_requirementsEdit_textChanged" id="PipFreezeDialog.on_requirementsEdit_textChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_requirementsEdit_textChanged" /> - <keyword name="PipFreezeDialog.on_requirementsFileEdit_textChanged" id="PipFreezeDialog.on_requirementsFileEdit_textChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_requirementsFileEdit_textChanged" /> + <keyword name="PipFreezeDialog.on_requirementsFilePicker_textChanged" id="PipFreezeDialog.on_requirementsFilePicker_textChanged" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_requirementsFilePicker_textChanged" /> <keyword name="PipFreezeDialog.on_saveButton_clicked" id="PipFreezeDialog.on_saveButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_saveButton_clicked" /> <keyword name="PipFreezeDialog.on_saveToButton_clicked" id="PipFreezeDialog.on_saveToButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_saveToButton_clicked" /> + <keyword name="PipFreezeDialog.on_venvComboBox_activated" id="PipFreezeDialog.on_venvComboBox_activated" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.on_venvComboBox_activated" /> <keyword name="PipFreezeDialog.start" id="PipFreezeDialog.start" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html#PipFreezeDialog.start" /> <keyword name="PipInterface (Package)" id="PipInterface (Package)" ref="index-eric6.Plugins.UiExtensionPlugins.PipInterface.html" /> <keyword name="PipInterfacePlugin" id="PipInterfacePlugin" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin" /> @@ -12037,7 +12038,6 @@ <keyword name="PipInterfacePlugin.__initialize" id="PipInterfacePlugin.__initialize" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.__initialize" /> <keyword name="PipInterfacePlugin.activate" id="PipInterfacePlugin.activate" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.activate" /> <keyword name="PipInterfacePlugin.deactivate" id="PipInterfacePlugin.deactivate" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.deactivate" /> - <keyword name="PipInterfacePlugin.getDefaultPipExecutables" id="PipInterfacePlugin.getDefaultPipExecutables" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.getDefaultPipExecutables" /> <keyword name="PipInterfacePlugin.getMenu" id="PipInterfacePlugin.getMenu" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.getMenu" /> <keyword name="PipInterfacePlugin.getMenuNames" id="PipInterfacePlugin.getMenuNames" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.getMenuNames" /> <keyword name="PipInterfacePlugin.getPreferences" id="PipInterfacePlugin.getPreferences" ref="eric6.Plugins.PluginPipInterface.html#PipInterfacePlugin.getPreferences" /> @@ -12063,8 +12063,8 @@ <keyword name="PipListDialog.on_localCheckBox_clicked" id="PipListDialog.on_localCheckBox_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_localCheckBox_clicked" /> <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_venvComboBox_activated" id="PipListDialog.on_venvComboBox_activated" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html#PipListDialog.on_venvComboBox_activated" /> <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" /> @@ -12084,8 +12084,6 @@ <keyword name="PipPage" id="PipPage" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html#PipPage" /> <keyword name="PipPage (Constructor)" id="PipPage (Constructor)" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html#PipPage.__init__" /> <keyword name="PipPage (Module)" id="PipPage (Module)" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html" /> - <keyword name="PipPage.on_addButton_clicked" id="PipPage.on_addButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html#PipPage.on_addButton_clicked" /> - <keyword name="PipPage.on_defaultListButton_clicked" id="PipPage.on_defaultListButton_clicked" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html#PipPage.on_defaultListButton_clicked" /> <keyword name="PipPage.save" id="PipPage.save" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html#PipPage.save" /> <keyword name="PipSearchDialog" id="PipSearchDialog" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html#PipSearchDialog" /> <keyword name="PipSearchDialog (Constructor)" id="PipSearchDialog (Constructor)" ref="eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html#PipSearchDialog.__init__" /> @@ -17393,6 +17391,7 @@ <keyword name="VirtualenvAddEditDialog (Module)" id="VirtualenvAddEditDialog (Module)" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html" /> <keyword name="VirtualenvAddEditDialog.__updateOk" id="VirtualenvAddEditDialog.__updateOk" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.__updateOk" /> <keyword name="VirtualenvAddEditDialog.getData" id="VirtualenvAddEditDialog.getData" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.getData" /> + <keyword name="VirtualenvAddEditDialog.on_globalCheckBox_toggled" id="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.on_globalCheckBox_toggled" /> <keyword name="VirtualenvAddEditDialog.on_nameEdit_textChanged" id="VirtualenvAddEditDialog.on_nameEdit_textChanged" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.on_nameEdit_textChanged" /> <keyword name="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" id="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" /> <keyword name="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" id="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ref="eric6.VirtualEnv.VirtualenvAddEditDialog.html#VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" /> @@ -17437,6 +17436,7 @@ <keyword name="VirtualenvManager.createVirtualEnv" id="VirtualenvManager.createVirtualEnv" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.createVirtualEnv" /> <keyword name="VirtualenvManager.deleteVirtualEnvs" id="VirtualenvManager.deleteVirtualEnvs" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.deleteVirtualEnvs" /> <keyword name="VirtualenvManager.getEnvironmentEntries" id="VirtualenvManager.getEnvironmentEntries" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.getEnvironmentEntries" /> + <keyword name="VirtualenvManager.getVirtualenvDirectory" id="VirtualenvManager.getVirtualenvDirectory" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.getVirtualenvDirectory" /> <keyword name="VirtualenvManager.getVirtualenvInterpreter" id="VirtualenvManager.getVirtualenvInterpreter" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.getVirtualenvInterpreter" /> <keyword name="VirtualenvManager.getVirtualenvNames" id="VirtualenvManager.getVirtualenvNames" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.getVirtualenvNames" /> <keyword name="VirtualenvManager.isUnique" id="VirtualenvManager.isUnique" ref="eric6.VirtualEnv.VirtualenvManager.html#VirtualenvManager.isUnique" /> @@ -18418,7 +18418,6 @@ <keyword name="_break_around_binary_operators" id="_break_around_binary_operators" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#_break_around_binary_operators" /> <keyword name="_buildChildrenLists" id="_buildChildrenLists" ref="eric6.Graphics.GraphicsUtilities.html#_buildChildrenLists" /> <keyword name="_encode_base64" id="_encode_base64" ref="eric6.UI.EmailDialog.html#_encode_base64" /> - <keyword name="_findDefaultExecutables" id="_findDefaultExecutables" ref="eric6.Plugins.PluginPipInterface.html#_findDefaultExecutables" /> <keyword name="_get_parameters" id="_get_parameters" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#_get_parameters" /> <keyword name="_getfullargs" id="_getfullargs" ref="eric6.DebugClients.Python.DebugUtilities.html#_getfullargs" /> <keyword name="_indent" id="_indent" ref="eric6.Utilities.ClassBrowsers.pyclbr.html#_indent" /> @@ -18745,7 +18744,6 @@ <keyword name="getEditorTyping" id="getEditorTyping" ref="eric6.Preferences.__init__.html#getEditorTyping" /> <keyword name="getEngineIcon" id="getEngineIcon" ref="eric6.Plugins.UiExtensionPlugins.Translator.TranslatorEngines.__init__.html#getEngineIcon" /> <keyword name="getEnvironmentEntry" id="getEnvironmentEntry" ref="eric6.Utilities.__init__.html#getEnvironmentEntry" /> - <keyword name="getExePath" id="getExePath" ref="eric6.Plugins.PluginPipInterface.html#getExePath" /> <keyword name="getExecutablePath" id="getExecutablePath" ref="eric6.Utilities.__init__.html#getExecutablePath" /> <keyword name="getExecutablePaths" id="getExecutablePaths" ref="eric6.Utilities.__init__.html#getExecutablePaths" /> <keyword name="getExistingDirectory" id="getExistingDirectory" ref="eric6.E5Gui.E5FileDialog.html#getExistingDirectory" />
--- a/Documentation/Source/eric6.Plugins.PluginPipInterface.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.PluginPipInterface.html Tue Jun 12 19:02:21 2018 +0200 @@ -37,9 +37,6 @@ <h3>Functions</h3> <table> <tr> -<td><a href="#_findDefaultExecutables">_findDefaultExecutables</a></td> -<td>Restricted function to determine the name and path of the executables.</td> -</tr><tr> <td><a href="#createPipPage">createPipPage</a></td> <td>Module function to create the pip configuration page.</td> </tr><tr> @@ -49,9 +46,6 @@ <td><a href="#getConfigData">getConfigData</a></td> <td>Module function returning data as required by the configuration dialog.</td> </tr><tr> -<td><a href="#getExePath">getExePath</a></td> -<td></td> -</tr><tr> <td><a href="#prepareUninstall">prepareUninstall</a></td> <td>Module function to prepare for an un-installation.</td> </tr> @@ -63,10 +57,10 @@ Class implementing the pip interface plug-in. </p><h3>Signals</h3> <dl> -<dt>currentPipChanged(exe)</dt> +<dt>currentEnvironmentChanged(str)</dt> <dd> -emitted to signal a change of the current - pip executable +emitted to signal a change of the + currently selected virtual environment </dd> </dl> <h3>Derived from</h3> @@ -94,9 +88,6 @@ <td><a href="#PipInterfacePlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> </tr><tr> -<td><a href="#PipInterfacePlugin.getDefaultPipExecutables">getDefaultPipExecutables</a></td> -<td>Public method to get the default list of pip executables.</td> -</tr><tr> <td><a href="#PipInterfacePlugin.getMenu">getMenu</a></td> <td>Public method to get a reference to the requested menu.</td> </tr><tr> @@ -104,10 +95,10 @@ <td>Public method to get the names of all menus.</td> </tr><tr> <td><a href="#PipInterfacePlugin.getPreferences">getPreferences</a></td> -<td>Public method to retrieve the various refactoring settings.</td> +<td>Public method to retrieve the various pip related settings.</td> </tr><tr> <td><a href="#PipInterfacePlugin.setPreferences">setPreferences</a></td> -<td>Public method to store the various refactoring settings.</td> +<td>Public method to store the various pip related settings.</td> </tr> </table> <h3>Static Methods</h3> @@ -137,39 +128,39 @@ </p><dl> <dt>Returns:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +tuple of (None, bool) </dd> </dl><a NAME="PipInterfacePlugin.deactivate" ID="PipInterfacePlugin.deactivate"></a> <h4>PipInterfacePlugin.deactivate</h4> <b>deactivate</b>(<i></i>) <p> Public method to deactivate this plugin. -</p><a NAME="PipInterfacePlugin.getDefaultPipExecutables" ID="PipInterfacePlugin.getDefaultPipExecutables"></a> -<h4>PipInterfacePlugin.getDefaultPipExecutables</h4> -<b>getDefaultPipExecutables</b>(<i></i>) -<p> - Public method to get the default list of pip executables. -</p><dl> -<dt>Returns:</dt> -<dd> -list of pip executables (list of string) -</dd> -</dl><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a> +</p><a NAME="PipInterfacePlugin.getMenu" ID="PipInterfacePlugin.getMenu"></a> <h4>PipInterfacePlugin.getMenu</h4> <b>getMenu</b>(<i>name</i>) <p> Public method to get a reference to the requested menu. </p><dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the menu (string) +name of the menu </dd> </dl><dl> <dt>Returns:</dt> <dd> -reference to the menu (QMenu) or None, if no +reference to the menu or None, if no menu with the given name exists </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +QMenu or None +</dd> </dl><a NAME="PipInterfacePlugin.getMenuNames" ID="PipInterfacePlugin.getMenuNames"></a> <h4>PipInterfacePlugin.getMenuNames</h4> <b>getMenuNames</b>(<i></i>) @@ -178,57 +169,49 @@ </p><dl> <dt>Returns:</dt> <dd> -menu names (list of string) +menu names +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl><a NAME="PipInterfacePlugin.getPreferences" ID="PipInterfacePlugin.getPreferences"></a> <h4>PipInterfacePlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) <p> - Public method to retrieve the various refactoring settings. + Public method to retrieve the various pip related settings. </p><dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> </dl><dl> <dt>Returns:</dt> <dd> -the requested refactoring setting +the requested setting +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +any </dd> </dl><a NAME="PipInterfacePlugin.setPreferences" ID="PipInterfacePlugin.setPreferences"></a> <h4>PipInterfacePlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) <p> - Public method to store the various refactoring settings. + Public method to store the various pip related settings. </p><dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> -the key of the setting to be set (string) -</dd><dt><i>value</i></dt> +the key of the setting to be set +</dd><dt><i>value</i> (any)</dt> <dd> the value to be set </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> -<a NAME="_findDefaultExecutables" ID="_findDefaultExecutables"></a> -<h2>_findDefaultExecutables</h2> -<b>_findDefaultExecutables</b>(<i>majorVersion</i>) -<p> - Restricted function to determine the name and path of the executables. -</p><dl> -<dt><i>majorVersion</i></dt> -<dd> -major python version of the executables (int) -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -path names of the executables (list of string) -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> <a NAME="createPipPage" ID="createPipPage"></a> <h2>createPipPage</h2> <b>createPipPage</b>(<i>configDlg</i>) @@ -274,12 +257,6 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> -<a NAME="getExePath" ID="getExePath"></a> -<h2>getExePath</h2> -<b>getExePath</b>(<i>branch, access, versionStr</i>) - -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> <a NAME="prepareUninstall" ID="prepareUninstall"></a> <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>)
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html Tue Jun 12 19:02:21 2018 +0200 @@ -21,7 +21,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage</h1> <p> -Package implementing the configuration page. +Package implementing the pip configuration page. </p> <h3>Global Attributes</h3> <table> @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#PipPage">PipPage</a></td> -<td>Class implementing the configuration page.</td> +<td>Class implementing the pip configuration page.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,7 @@ <a NAME="PipPage" ID="PipPage"></a> <h2>PipPage</h2> <p> - Class implementing the configuration page. + Class implementing the pip configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_PipPage @@ -60,12 +60,6 @@ <td><a href="#PipPage.__init__">PipPage</a></td> <td>Constructor</td> </tr><tr> -<td><a href="#PipPage.on_addButton_clicked">on_addButton_clicked</a></td> -<td>Private slot used to add an executable to the list.</td> -</tr><tr> -<td><a href="#PipPage.on_defaultListButton_clicked">on_defaultListButton_clicked</a></td> -<td>Private slot to load the default list of pip executables.</td> -</tr><tr> <td><a href="#PipPage.save">save</a></td> <td>Public slot to save the pip configuration.</td> </tr> @@ -80,21 +74,11 @@ <p> Constructor </p><dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (PipInterfacePlugin)</dt> <dd> reference to the plugin object </dd> -</dl><a NAME="PipPage.on_addButton_clicked" ID="PipPage.on_addButton_clicked"></a> -<h4>PipPage.on_addButton_clicked</h4> -<b>on_addButton_clicked</b>(<i></i>) -<p> - Private slot used to add an executable to the list. -</p><a NAME="PipPage.on_defaultListButton_clicked" ID="PipPage.on_defaultListButton_clicked"></a> -<h4>PipPage.on_defaultListButton_clicked</h4> -<b>on_defaultListButton_clicked</b>(<i></i>) -<p> - Private slot to load the default list of pip executables. -</p><a NAME="PipPage.save" ID="PipPage.save"></a> +</dl><a NAME="PipPage.save" ID="PipPage.save"></a> <h4>PipPage.save</h4> <b>save</b>(<i></i>) <p>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.Pip.html Tue Jun 12 19:02:21 2018 +0200 @@ -78,9 +78,6 @@ <td><a href="#Pip.__generateRequirements">__generateRequirements</a></td> <td>Private slot to generate the contents for a requirements file.</td> </tr><tr> -<td><a href="#Pip.__getPython">__getPython</a></td> -<td>Private method to derive the path to the python executable given the path to the pip executable.</td> -</tr><tr> <td><a href="#Pip.__getUserConfig">__getUserConfig</a></td> <td>Private method to get the name of the user configuration file.</td> </tr><tr> @@ -88,7 +85,7 @@ <td>Private method to get the name of the virtualenv configuration file.</td> </tr><tr> <td><a href="#Pip.__handleTearOffMenu">__handleTearOffMenu</a></td> -<td>Private slot to handle a change of the pip executable.</td> +<td>Private slot to handle a change of the selected virtual environment.</td> </tr><tr> <td><a href="#Pip.__installLocalPackage">__installLocalPackage</a></td> <td>Private slot to install a package available on local storage.</td> @@ -120,8 +117,8 @@ <td><a href="#Pip.__searchPyPI">__searchPyPI</a></td> <td>Private slot to search the Python Package Index.</td> </tr><tr> -<td><a href="#Pip.__selectPipExecutable">__selectPipExecutable</a></td> -<td>Private method to select the pip executable to be used.</td> +<td><a href="#Pip.__selectPipVirtualenv">__selectPipVirtualenv</a></td> +<td>Private method to select the virtual environment to be used.</td> </tr><tr> <td><a href="#Pip.__uninstallPackages">__uninstallPackages</a></td> <td>Private slot to uninstall packages to be given by the user.</td> @@ -132,17 +129,26 @@ <td><a href="#Pip.__upgradePackages">__upgradePackages</a></td> <td>Private slot to upgrade packages to be given by the user.</td> </tr><tr> +<td><a href="#Pip.getDefaultEnvironmentString">getDefaultEnvironmentString</a></td> +<td>Public method to get the string for the default environment.</td> +</tr><tr> <td><a href="#Pip.getMenu">getMenu</a></td> <td>Public method to get a reference to the requested menu.</td> </tr><tr> <td><a href="#Pip.getMenuNames">getMenuNames</a></td> <td>Public method to get the names of all menus.</td> </tr><tr> +<td><a href="#Pip.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> +<td>Public method to get the interpreter for a virtual environment.</td> +</tr><tr> +<td><a href="#Pip.getVirtualenvNames">getVirtualenvNames</a></td> +<td>Public method to get a sorted list of virtual environment names.</td> +</tr><tr> <td><a href="#Pip.initActions">initActions</a></td> -<td>Public method to define the Django actions.</td> +<td>Public method to define the actions.</td> </tr><tr> <td><a href="#Pip.initMenu">initMenu</a></td> -<td>Public slot to initialize the Django menu.</td> +<td>Public slot to initialize the menu.</td> </tr><tr> <td><a href="#Pip.installPackages">installPackages</a></td> <td>Public method to install the given list of packages.</td> @@ -170,12 +176,12 @@ <p> Constructor </p><dl> -<dt><i>plugin</i></dt> +<dt><i>plugin</i> (PipInterfacePlugin)</dt> <dd> reference to the plugin object -</dd><dt><i>parent</i></dt> +</dd><dt><i>parent</i> (QObject)</dt> <dd> -parent (QObject) +parent </dd> </dl><a NAME="Pip.__aboutToShowMenu" ID="Pip.__aboutToShowMenu"></a> <h4>Pip.__aboutToShowMenu</h4> @@ -208,10 +214,10 @@ <p> Private method to edit a configuration. </p><dl> -<dt><i>virtualenv</i></dt> +<dt><i>virtualenv</i> (bool)</dt> <dd> flag indicating to edit the current virtualenv - configuration file (boolean) + configuration file </dd> </dl><a NAME="Pip.__editUserConfiguration" ID="Pip.__editUserConfiguration"></a> <h4>Pip.__editUserConfiguration</h4> @@ -228,28 +234,7 @@ <b>__generateRequirements</b>(<i></i>) <p> Private slot to generate the contents for a requirements file. -</p><a NAME="Pip.__getPython" ID="Pip.__getPython"></a> -<h4>Pip.__getPython</h4> -<b>__getPython</b>(<i>cmd</i>) -<p> - Private method to derive the path to the python executable given the - path to the pip executable. -</p><dl> -<dt><i>cmd</i> (str)</dt> -<dd> -path of the pip executable -</dd> -</dl><dl> -<dt>Returns:</dt> -<dd> -path of the python executable -</dd> -</dl><dl> -<dt>Return Type:</dt> -<dd> -str -</dd> -</dl><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a> +</p><a NAME="Pip.__getUserConfig" ID="Pip.__getUserConfig"></a> <h4>Pip.__getUserConfig</h4> <b>__getUserConfig</b>(<i></i>) <p> @@ -257,7 +242,12 @@ </p><dl> <dt>Returns:</dt> <dd> -path of the user configuration file (string) +path of the user configuration file +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl><a NAME="Pip.__getVirtualenvConfig" ID="Pip.__getVirtualenvConfig"></a> <h4>Pip.__getVirtualenvConfig</h4> @@ -267,17 +257,22 @@ </p><dl> <dt>Returns:</dt> <dd> -path of the virtualenv configuration file (string) +path of the virtualenv configuration file +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl><a NAME="Pip.__handleTearOffMenu" ID="Pip.__handleTearOffMenu"></a> <h4>Pip.__handleTearOffMenu</h4> -<b>__handleTearOffMenu</b>(<i>pip</i>) +<b>__handleTearOffMenu</b>(<i>venvName</i>) <p> - Private slot to handle a change of the pip executable. + Private slot to handle a change of the selected virtual environment. </p><dl> -<dt><i>pip</i> (str)</dt> +<dt><i>venvName</i> (str)</dt> <dd> -path of the pip executable +logical name of the virtual environment </dd> </dl><a NAME="Pip.__installLocalPackage" ID="Pip.__installLocalPackage"></a> <h4>Pip.__installLocalPackage</h4> @@ -345,11 +340,11 @@ <b>__searchPyPI</b>(<i></i>) <p> Private slot to search the Python Package Index. -</p><a NAME="Pip.__selectPipExecutable" ID="Pip.__selectPipExecutable"></a> -<h4>Pip.__selectPipExecutable</h4> -<b>__selectPipExecutable</b>(<i></i>) +</p><a NAME="Pip.__selectPipVirtualenv" ID="Pip.__selectPipVirtualenv"></a> +<h4>Pip.__selectPipVirtualenv</h4> +<b>__selectPipVirtualenv</b>(<i></i>) <p> - Private method to select the pip executable to be used. + Private method to select the virtual environment to be used. </p><a NAME="Pip.__uninstallPackages" ID="Pip.__uninstallPackages"></a> <h4>Pip.__uninstallPackages</h4> <b>__uninstallPackages</b>(<i></i>) @@ -365,22 +360,42 @@ <b>__upgradePackages</b>(<i></i>) <p> Private slot to upgrade packages to be given by the user. -</p><a NAME="Pip.getMenu" ID="Pip.getMenu"></a> +</p><a NAME="Pip.getDefaultEnvironmentString" ID="Pip.getDefaultEnvironmentString"></a> +<h4>Pip.getDefaultEnvironmentString</h4> +<b>getDefaultEnvironmentString</b>(<i></i>) +<p> + Public method to get the string for the default environment. +</p><dl> +<dt>Returns:</dt> +<dd> +string for the default environment +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="Pip.getMenu" ID="Pip.getMenu"></a> <h4>Pip.getMenu</h4> <b>getMenu</b>(<i>name</i>) <p> Public method to get a reference to the requested menu. </p><dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the menu (string) +name of the menu </dd> </dl><dl> <dt>Returns:</dt> <dd> -reference to the menu (QMenu) or None, if no +reference to the menu or None, if no menu with the given name exists </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +QMenu or None +</dd> </dl><a NAME="Pip.getMenuNames" ID="Pip.getMenuNames"></a> <h4>Pip.getMenuNames</h4> <b>getMenuNames</b>(<i></i>) @@ -389,35 +404,80 @@ </p><dl> <dt>Returns:</dt> <dd> -menu names (list of string) +menu names +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl><a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a> +<h4>Pip.getVirtualenvInterpreter</h4> +<b>getVirtualenvInterpreter</b>(<i>venvName</i>) +<p> + Public method to get the interpreter for a virtual environment. +</p><dl> +<dt><i>venvName</i> (str)</dt> +<dd> +logical name for the virtual environment +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +interpreter path +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl><a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a> +<h4>Pip.getVirtualenvNames</h4> +<b>getVirtualenvNames</b>(<i></i>) +<p> + Public method to get a sorted list of virtual environment names. +</p><dl> +<dt>Returns:</dt> +<dd> +sorted list of virtual environment names +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl><a NAME="Pip.initActions" ID="Pip.initActions"></a> <h4>Pip.initActions</h4> <b>initActions</b>(<i></i>) <p> - Public method to define the Django actions. + Public method to define the actions. </p><a NAME="Pip.initMenu" ID="Pip.initMenu"></a> <h4>Pip.initMenu</h4> <b>initMenu</b>(<i></i>) <p> - Public slot to initialize the Django menu. + Public slot to initialize the menu. </p><dl> <dt>Returns:</dt> <dd> -the menu generated (QMenu) +the menu generated +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl><a NAME="Pip.installPackages" ID="Pip.installPackages"></a> <h4>Pip.installPackages</h4> -<b>installPackages</b>(<i>packages, cmd="", userSite=False</i>) +<b>installPackages</b>(<i>packages, venvName="", userSite=False</i>) <p> Public method to install the given list of packages. </p><dl> <dt><i>packages</i> (list of str)</dt> <dd> list of packages to install -</dd><dt><i>cmd</i> (str)</dt> +</dd><dt><i>venvName</i> (str)</dt> <dd> -pip command to be used +name of the virtual environment to be used </dd><dt><i>userSite</i> (bool)</dt> <dd> flag indicating an install to the user install @@ -425,7 +485,7 @@ </dd> </dl><a NAME="Pip.runProcess" ID="Pip.runProcess"></a> <h4>Pip.runProcess</h4> -<b>runProcess</b>(<i>args, cmd=""</i>) +<b>runProcess</b>(<i>args, interpreter</i>) <p> Public method to execute the current pip with the given arguments. </p><p> @@ -435,9 +495,9 @@ <dt><i>args</i> (list of str)</dt> <dd> list of command line arguments -</dd><dt><i>cmd</i> (str)</dt> +</dd><dt><i>interpreter</i> (str)</dt> <dd> -pip executable to be used +path of the Python interpreter to be used </dd> </dl><dl> <dt>Returns:</dt> @@ -452,34 +512,39 @@ </dd> </dl><a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a> <h4>Pip.uninstallPackages</h4> -<b>uninstallPackages</b>(<i>packages, cmd=""</i>) +<b>uninstallPackages</b>(<i>packages, venvName=""</i>) <p> Public method to uninstall 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 uninstall (list of string) -</dd><dt><i>cmd</i></dt> +list of packages to uninstall +</dd><dt><i>venvName</i> (str)</dt> <dd> -pip command to be used (string) +name of the virtual environment to be used </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.upgradePackages" ID="Pip.upgradePackages"></a> <h4>Pip.upgradePackages</h4> -<b>upgradePackages</b>(<i>packages, cmd="", userSite=False</i>) +<b>upgradePackages</b>(<i>packages, venvName="", userSite=False</i>) <p> Public method to upgrade the given list of packages. </p><dl> <dt><i>packages</i> (list of str)</dt> <dd> list of packages to upgrade -</dd><dt><i>cmd</i> (str)</dt> +</dd><dt><i>venvName</i> (str)</dt> <dd> -pip command to be used +name of the virtual environment to be used </dd><dt><i>userSite</i> (bool)</dt> <dd> flag indicating an install to the user install @@ -497,13 +562,13 @@ </dd> </dl><a NAME="Pip.upgradePip" ID="Pip.upgradePip"></a> <h4>Pip.upgradePip</h4> -<b>upgradePip</b>(<i>pip="", userSite=False</i>) +<b>upgradePip</b>(<i>venvName="", userSite=False</i>) <p> Public method to upgrade pip itself. </p><dl> -<dt><i>pip</i> (str)</dt> +<dt><i>venvName</i> (str)</dt> <dd> -pip command to be used +name of the virtual environment to be used </dd><dt><i>userSite</i> (bool)</dt> <dd> flag indicating an install to the user install
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -31,7 +31,7 @@ <table> <tr> <td><a href="#PipDialog">PipDialog</a></td> -<td>Class implementing a dialog showing the output of a pip command.</td> +<td>Class implementing a dialog showing the output of a 'python -m pip' command.</td> </tr> </table> <h3>Functions</h3> @@ -42,7 +42,8 @@ <a NAME="PipDialog" ID="PipDialog"></a> <h2>PipDialog</h2> <p> - Class implementing a dialog showing the output of a pip command. + Class implementing a dialog showing the output of a 'python -m pip' + command. </p> <h3>Derived from</h3> QDialog, Ui_PipDialog @@ -98,12 +99,12 @@ <p> Constructor </p><dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) -</dd><dt><i>parent</i></dt> +text to be shown by the label +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a> <h4>PipDialog.__addOutput</h4> @@ -127,12 +128,12 @@ <p> Private slot connected to the finished signal. </p><dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) -</dd><dt><i>exitStatus</i></dt> +exit code of the process +</dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl><a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a> <h4>PipDialog.__readStderr</h4> @@ -156,9 +157,9 @@ <p> Protected slot implementing a close event handler. </p><dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl><a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a> <h4>PipDialog.on_buttonBox_clicked</h4> @@ -166,9 +167,9 @@ <p> Private slot called by a button of the button box clicked. </p><dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl><a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a> <h4>PipDialog.startProcess</h4> @@ -176,28 +177,33 @@ <p> Public slot used to start the process. </p><dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (str)</dt> <dd> -name of the pip executable to be used (string) -</dd><dt><i>args</i></dt> +name of the pip executable to be used +</dd><dt><i>args</i> (list of str)</dt> <dd> -list of arguments for the process (list of strings) -</dd><dt><i>showArgs=</i></dt> +list of arguments for the process +</dd><dt><i>showArgs=</i> (bool)</dt> <dd> -flag indicating to show the arguments (boolean) +flag indicating to show the arguments </dd> </dl><dl> <dt>Returns:</dt> <dd> flag indicating a successful start of the process </dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> </dl><a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a> <h4>PipDialog.startProcesses</h4> <b>startProcesses</b>(<i>processParams</i>) <p> Public method to issue a list of commands to be executed. </p><dl> -<dt><i>processParams</i> (list of tuples of str and list of str)</dt> +<dt><i>processParams</i> (list of tuples of (str, list of str))</dt> <dd> list of tuples containing the command and arguments
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFileSelectionDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -73,13 +73,13 @@ </table> <a NAME="PipFileSelectionDialog.__init__" ID="PipFileSelectionDialog.__init__"></a> <h4>PipFileSelectionDialog (Constructor)</h4> -<b>PipFileSelectionDialog</b>(<i>plugin, mode, install=True, parent=None</i>) +<b>PipFileSelectionDialog</b>(<i>pip, mode, install=True, parent=None</i>) <p> Constructor </p><dl> -<dt><i>plugin</i> (PipInterfacePlugin)</dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the plugin object +reference to the pip object </dd><dt><i>mode</i> (str)</dt> <dd> mode of the dialog @@ -98,7 +98,7 @@ </p><dl> <dt>Returns:</dt> <dd> -tuple with the pip command, the name of the +tuple with the environment name, the name of the selected file and a flag indicating to install to the user install directory </dd>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipFreezeDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -78,18 +78,12 @@ <td><a href="#PipFreezeDialog.on_copyButton_clicked">on_copyButton_clicked</a></td> <td>Private slot to copy the requirements text to the clipboard.</td> </tr><tr> -<td><a href="#PipFreezeDialog.on_fileButton_clicked">on_fileButton_clicked</a></td> -<td>Private slot to enter the requirements file via a file selection dialog.</td> -</tr><tr> <td><a href="#PipFreezeDialog.on_insertButton_clicked">on_insertButton_clicked</a></td> <td>Private slot to insert the requirements text at the cursor position of the current editor.</td> </tr><tr> <td><a href="#PipFreezeDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td> <td>Private slot handling the switching of the local mode.</td> </tr><tr> -<td><a href="#PipFreezeDialog.on_pipComboBox_activated">on_pipComboBox_activated</a></td> -<td>Private slot handling the selection of a pip executable.</td> -</tr><tr> <td><a href="#PipFreezeDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> <td>Private slot to replace the text of the current editor with the requirements text.</td> </tr><tr> @@ -99,7 +93,7 @@ <td><a href="#PipFreezeDialog.on_requirementsEdit_textChanged">on_requirementsEdit_textChanged</a></td> <td>Private slot handling changes of the requirements text.</td> </tr><tr> -<td><a href="#PipFreezeDialog.on_requirementsFileEdit_textChanged">on_requirementsFileEdit_textChanged</a></td> +<td><a href="#PipFreezeDialog.on_requirementsFilePicker_textChanged">on_requirementsFilePicker_textChanged</a></td> <td>Private slot handling a change of the requirements file name.</td> </tr><tr> <td><a href="#PipFreezeDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> @@ -108,6 +102,9 @@ <td><a href="#PipFreezeDialog.on_saveToButton_clicked">on_saveToButton_clicked</a></td> <td>Private slot to write the requirements text to a new file.</td> </tr><tr> +<td><a href="#PipFreezeDialog.on_venvComboBox_activated">on_venvComboBox_activated</a></td> +<td>Private slot handling the selection of a virtual environment.</td> +</tr><tr> <td><a href="#PipFreezeDialog.start">start</a></td> <td>Public method to start the command.</td> </tr> @@ -118,19 +115,16 @@ </table> <a NAME="PipFreezeDialog.__init__" ID="PipFreezeDialog.__init__"></a> <h4>PipFreezeDialog (Constructor)</h4> -<b>PipFreezeDialog</b>(<i>pip, plugin, parent=None</i>) +<b>PipFreezeDialog</b>(<i>pip, parent=None</i>) <p> Constructor </p><dl> -<dt><i>pip</i></dt> -<dd> -reference to the master object (Pip) -</dd><dt><i>plugin</i></dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the plugin object (ToolPipPlugin) -</dd><dt><i>parent</i></dt> +reference to the master object +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="PipFreezeDialog.__refresh" ID="PipFreezeDialog.__refresh"></a> <h4>PipFreezeDialog.__refresh</h4> @@ -148,9 +142,9 @@ <p> Private method to write the requirements text to a file. </p><dl> -<dt><i>fileName</i></dt> +<dt><i>fileName</i> (str)</dt> <dd> -name of the file to write to (string) +name of the file to write to </dd> </dl><a NAME="PipFreezeDialog.closeEvent" ID="PipFreezeDialog.closeEvent"></a> <h4>PipFreezeDialog.closeEvent</h4> @@ -158,9 +152,9 @@ <p> Protected slot implementing a close event handler. </p><dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl><a NAME="PipFreezeDialog.on_buttonBox_clicked" ID="PipFreezeDialog.on_buttonBox_clicked"></a> <h4>PipFreezeDialog.on_buttonBox_clicked</h4> @@ -168,21 +162,15 @@ <p> Private slot called by a button of the button box clicked. </p><dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl><a NAME="PipFreezeDialog.on_copyButton_clicked" ID="PipFreezeDialog.on_copyButton_clicked"></a> <h4>PipFreezeDialog.on_copyButton_clicked</h4> <b>on_copyButton_clicked</b>(<i></i>) <p> Private slot to copy the requirements text to the clipboard. -</p><a NAME="PipFreezeDialog.on_fileButton_clicked" ID="PipFreezeDialog.on_fileButton_clicked"></a> -<h4>PipFreezeDialog.on_fileButton_clicked</h4> -<b>on_fileButton_clicked</b>(<i></i>) -<p> - Private slot to enter the requirements file via a file selection - dialog. </p><a NAME="PipFreezeDialog.on_insertButton_clicked" ID="PipFreezeDialog.on_insertButton_clicked"></a> <h4>PipFreezeDialog.on_insertButton_clicked</h4> <b>on_insertButton_clicked</b>(<i></i>) @@ -195,19 +183,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) -</dd> -</dl><a NAME="PipFreezeDialog.on_pipComboBox_activated" ID="PipFreezeDialog.on_pipComboBox_activated"></a> -<h4>PipFreezeDialog.on_pipComboBox_activated</h4> -<b>on_pipComboBox_activated</b>(<i>txt</i>) -<p> - Private slot handling the selection of a pip executable. -</p><dl> -<dt><i>txt</i></dt> -<dd> -path of the pip executable (string) +state of the local check box </dd> </dl><a NAME="PipFreezeDialog.on_replaceAllButton_clicked" ID="PipFreezeDialog.on_replaceAllButton_clicked"></a> <h4>PipFreezeDialog.on_replaceAllButton_clicked</h4> @@ -226,15 +204,15 @@ <b>on_requirementsEdit_textChanged</b>(<i></i>) <p> Private slot handling changes of the requirements text. -</p><a NAME="PipFreezeDialog.on_requirementsFileEdit_textChanged" ID="PipFreezeDialog.on_requirementsFileEdit_textChanged"></a> -<h4>PipFreezeDialog.on_requirementsFileEdit_textChanged</h4> -<b>on_requirementsFileEdit_textChanged</b>(<i>txt</i>) +</p><a NAME="PipFreezeDialog.on_requirementsFilePicker_textChanged" ID="PipFreezeDialog.on_requirementsFilePicker_textChanged"></a> +<h4>PipFreezeDialog.on_requirementsFilePicker_textChanged</h4> +<b>on_requirementsFilePicker_textChanged</b>(<i>txt</i>) <p> Private slot handling a change of the requirements file name. </p><dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the requirements file (string) +name of the requirements file </dd> </dl><a NAME="PipFreezeDialog.on_saveButton_clicked" ID="PipFreezeDialog.on_saveButton_clicked"></a> <h4>PipFreezeDialog.on_saveButton_clicked</h4> @@ -246,7 +224,17 @@ <b>on_saveToButton_clicked</b>(<i></i>) <p> Private slot to write the requirements text to a new file. -</p><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> +</p><a NAME="PipFreezeDialog.on_venvComboBox_activated" ID="PipFreezeDialog.on_venvComboBox_activated"></a> +<h4>PipFreezeDialog.on_venvComboBox_activated</h4> +<b>on_venvComboBox_activated</b>(<i>txt</i>) +<p> + Private slot handling the selection of a virtual environment. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +virtual environment +</dd> +</dl><a NAME="PipFreezeDialog.start" ID="PipFreezeDialog.start"></a> <h4>PipFreezeDialog.start</h4> <b>start</b>(<i></i>) <p>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -114,12 +114,12 @@ <td><a href="#PipListDialog.on_packageList_itemSelectionChanged">on_packageList_itemSelectionChanged</a></td> <td>Private slot handling the selection of a package.</td> </tr><tr> -<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_venvComboBox_activated">on_venvComboBox_activated</a></td> +<td>Private slot handling the selection of a virtual environment.</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> @@ -133,26 +133,25 @@ </table> <a NAME="PipListDialog.__init__" ID="PipListDialog.__init__"></a> <h4>PipListDialog (Constructor)</h4> -<b>PipListDialog</b>(<i>pip, mode, plugin, title, parent=None</i>) +<b>PipListDialog</b>(<i>pip, mode, indexUrl, title, parent=None</i>) <p> Constructor </p><dl> -<dt><i>pip</i></dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the master object (Pip) -</dd><dt><i>mode</i></dt> +reference to the master object +</dd><dt><i>mode</i> (str)</dt> +<dd> +list command mode (one of 'list', 'uptodate', 'outdated') +</dd><dt><i>indexUrl</i> (str)</dt> <dd> -list command mode (string; one of 'list', - 'uptodate', 'outdated') -</dd><dt><i>plugin</i></dt> +URL of the pypi index +</dd><dt><i>title</i> (str)</dt> <dd> -reference to the plugin object (ToolPipPlugin) -</dd><dt><i>title</i></dt> +title of the dialog +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -title of the dialog (string) -</dd><dt><i>parent</i></dt> -<dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="PipListDialog.__executeUpgradePackages" ID="PipListDialog.__executeUpgradePackages"></a> <h4>PipListDialog.__executeUpgradePackages</h4> @@ -176,12 +175,12 @@ <p> Private slot connected to the finished signal. </p><dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) -</dd><dt><i>exitStatus</i></dt> +exit code of the process +</dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl><a NAME="PipListDialog.__processOutput" ID="PipListDialog.__processOutput"></a> <h4>PipListDialog.__processOutput</h4> @@ -240,9 +239,9 @@ <p> Protected slot implementing a close event handler. </p><dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl><a NAME="PipListDialog.on_buttonBox_clicked" ID="PipListDialog.on_buttonBox_clicked"></a> <h4>PipListDialog.on_buttonBox_clicked</h4> @@ -250,9 +249,9 @@ <p> Private slot called by a button of the button box clicked. </p><dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl><a NAME="PipListDialog.on_installedFilesCheckBox_clicked" ID="PipListDialog.on_installedFilesCheckBox_clicked"></a> <h4>PipListDialog.on_installedFilesCheckBox_clicked</h4> @@ -290,17 +289,7 @@ <b>on_packageList_itemSelectionChanged</b>(<i></i>) <p> Private slot handling the selection of a package. -</p><a NAME="PipListDialog.on_pipComboBox_activated" ID="PipListDialog.on_pipComboBox_activated"></a> -<h4>PipListDialog.on_pipComboBox_activated</h4> -<b>on_pipComboBox_activated</b>(<i>txt</i>) -<p> - Private slot handling the selection of a pip executable. -</p><dl> -<dt><i>txt</i></dt> -<dd> -path of the pip executable (string) -</dd> -</dl><a NAME="PipListDialog.on_userCheckBox_clicked" ID="PipListDialog.on_userCheckBox_clicked"></a> +</p><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> @@ -310,6 +299,16 @@ <dd> state of the 'user-site' check box </dd> +</dl><a NAME="PipListDialog.on_venvComboBox_activated" ID="PipListDialog.on_venvComboBox_activated"></a> +<h4>PipListDialog.on_venvComboBox_activated</h4> +<b>on_venvComboBox_activated</b>(<i>txt</i>) +<p> + Private slot handling the selection of a virtual environment. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +virtual environment +</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.PipPackageDetailsDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackageDetailsDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -89,15 +89,15 @@ <p> Constructor </p><dl> -<dt><i>detailsData</i></dt> +<dt><i>detailsData</i> (dict)</dt> <dd> -package details (dict) -</dd><dt><i>downloadsData</i></dt> +package details +</dd><dt><i>downloadsData</i> (dict)</dt> <dd> -downloads information (dict) -</dd><dt><i>parent</i></dt> +downloads information +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="PipPackageDetailsDialog.__formatSize" ID="PipPackageDetailsDialog.__formatSize"></a> <h4>PipPackageDetailsDialog.__formatSize</h4> @@ -105,14 +105,19 @@ <p> Private slot to format the size. </p><dl> -<dt><i>size</i></dt> +<dt><i>size</i> (int)</dt> <dd> -size to be formatted (integer) +size to be formatted </dd> </dl><dl> <dt>Returns:</dt> <dd> -formatted size (string) +formatted size +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl><a NAME="PipPackageDetailsDialog.__formatUploadDate" ID="PipPackageDetailsDialog.__formatUploadDate"></a> <h4>PipPackageDetailsDialog.__formatUploadDate</h4> @@ -140,9 +145,9 @@ <p> Private method to populate the details tab. </p><dl> -<dt><i>detailsData</i></dt> +<dt><i>detailsData</i> (dict)</dt> <dd> -package details (dict) +package details </dd> </dl><a NAME="PipPackageDetailsDialog.__populateDownloadUrls" ID="PipPackageDetailsDialog.__populateDownloadUrls"></a> <h4>PipPackageDetailsDialog.__populateDownloadUrls</h4> @@ -150,9 +155,9 @@ <p> Private method to populate the download URLs tab. </p><dl> -<dt><i>downloadsData</i></dt> +<dt><i>downloadsData</i> (dict)</dt> <dd> -downloads information (dict) +downloads information </dd> </dl><a NAME="PipPackageDetailsDialog.__populateRequiresProvides" ID="PipPackageDetailsDialog.__populateRequiresProvides"></a> <h4>PipPackageDetailsDialog.__populateRequiresProvides</h4> @@ -160,9 +165,9 @@ <p> Private method to populate the requires/provides tab. </p><dl> -<dt><i>detailsData</i></dt> +<dt><i>detailsData</i> (dict)</dt> <dd> -package details (dict) +package details </dd> </dl><a NAME="PipPackageDetailsDialog.__sanitize" ID="PipPackageDetailsDialog.__sanitize"></a> <h4>PipPackageDetailsDialog.__sanitize</h4> @@ -170,17 +175,22 @@ <p> Private method to clean-up the given text. </p><dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -raw text (string) -</dd><dt><i>forUrl</i></dt> +raw text +</dd><dt><i>forUrl</i> (bool)</dt> <dd> -flag indicating to sanitize an URL text (boolean) +flag indicating to sanitize an URL text </dd> </dl><dl> <dt>Returns:</dt> <dd> -processed text (string) +processed text +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipPackagesInputDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -73,13 +73,13 @@ </table> <a NAME="PipPackagesInputDialog.__init__" ID="PipPackagesInputDialog.__init__"></a> <h4>PipPackagesInputDialog (Constructor)</h4> -<b>PipPackagesInputDialog</b>(<i>plugin, title, install=True, parent=None</i>) +<b>PipPackagesInputDialog</b>(<i>pip, title, install=True, parent=None</i>) <p> Constructor </p><dl> -<dt><i>plugin</i> (ToolPipPlugin)</dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the plugin object +reference to the pip object </dd><dt><i>title</i> (str)</dt> <dd> dialog title @@ -98,8 +98,9 @@ </p><dl> <dt>Returns:</dt> <dd> -tuple with the pip command, the list of package specifications - and a flag indicating to install to the user install directory +tuple with the environment name, the list of package + specifications and a flag indicating to install to the user + install directory </dd> </dl><dl> <dt>Return Type:</dt> @@ -112,9 +113,9 @@ <p> Private slot handling entering package names. </p><dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -name of the requirements file (string) +name of the requirements file </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSearchDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -118,19 +118,19 @@ </table> <a NAME="PipSearchDialog.__init__" ID="PipSearchDialog.__init__"></a> <h4>PipSearchDialog (Constructor)</h4> -<b>PipSearchDialog</b>(<i>pip, plugin, parent=None</i>) +<b>PipSearchDialog</b>(<i>pip, indexUrl, parent=None</i>) <p> Constructor </p><dl> -<dt><i>pip</i></dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the master object (Pip) -</dd><dt><i>plugin</i></dt> +reference to the master object +</dd><dt><i>indexUrl</i> (str)</dt> <dd> -reference to the plugin object (ToolPipPlugin) -</dd><dt><i>parent</i></dt> +URL of XML RPC interface to the pypi index +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -reference to the parent widget (QWidget) +reference to the parent widget </dd> </dl><a NAME="PipSearchDialog.__detailsError" ID="PipSearchDialog.__detailsError"></a> <h4>PipSearchDialog.__detailsError</h4> @@ -138,12 +138,12 @@ <p> Private method handling a details error. </p><dl> -<dt><i>errorCode</i></dt> +<dt><i>errorCode</i> (int)</dt> <dd> -code of the error (integer) -</dd><dt><i>errorString</i></dt> +code of the error +</dd><dt><i>errorString</i> (str)</dt> <dd> -error message (string) +error message </dd> </dl><a NAME="PipSearchDialog.__displayPackageDetails" ID="PipSearchDialog.__displayPackageDetails"></a> <h4>PipSearchDialog.__displayPackageDetails</h4> @@ -151,10 +151,9 @@ <p> Private method to display the returned package details. </p><dl> -<dt><i>data</i></dt> +<dt><i>data</i> (tuple)</dt> <dd> -result data (tuple) with downloads information in the first - element +result data with downloads information in the first element </dd> </dl><a NAME="PipSearchDialog.__finish" ID="PipSearchDialog.__finish"></a> <h4>PipSearchDialog.__finish</h4> @@ -192,9 +191,9 @@ <p> Private method to process the search result data from PyPI. </p><dl> -<dt><i>data</i></dt> +<dt><i>data</i> (tuple)</dt> <dd> -result data (tuple) with hits in the first element +result data with hits in the first element </dd> </dl><a NAME="PipSearchDialog.__score" ID="PipSearchDialog.__score"></a> <h4>PipSearchDialog.__score</h4> @@ -230,12 +229,12 @@ <p> Private method handling a search error. </p><dl> -<dt><i>errorCode</i></dt> +<dt><i>errorCode</i> (int)</dt> <dd> -code of the error (integer) -</dd><dt><i>errorString</i></dt> +code of the error +</dd><dt><i>errorString</i> (str)</dt> <dd> -error message (string) +error message </dd> </dl><a NAME="PipSearchDialog.__showDetails" ID="PipSearchDialog.__showDetails"></a> <h4>PipSearchDialog.__showDetails</h4> @@ -249,14 +248,19 @@ Private method to convert the list returned from pypi into a packages list. </p><dl> -<dt><i>hits</i></dt> +<dt><i>hits</i> (list of dict)</dt> <dd> -list returned from pypi (list of dict) +list returned from pypi </dd> </dl><dl> <dt>Returns:</dt> <dd> -list of packages (list of dict) +list of packages +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +list of dict </dd> </dl><a NAME="PipSearchDialog.closeEvent" ID="PipSearchDialog.closeEvent"></a> <h4>PipSearchDialog.closeEvent</h4> @@ -264,9 +268,9 @@ <p> Protected slot implementing a close event handler. </p><dl> -<dt><i>e</i></dt> +<dt><i>e</i> (QCloseEvent)</dt> <dd> -close event (QCloseEvent) +close event </dd> </dl><a NAME="PipSearchDialog.on_buttonBox_clicked" ID="PipSearchDialog.on_buttonBox_clicked"></a> <h4>PipSearchDialog.on_buttonBox_clicked</h4> @@ -274,9 +278,9 @@ <p> Private slot called by a button of the button box clicked. </p><dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl><a NAME="PipSearchDialog.on_resultList_itemActivated" ID="PipSearchDialog.on_resultList_itemActivated"></a> <h4>PipSearchDialog.on_resultList_itemActivated</h4> @@ -284,12 +288,12 @@ <p> Private slot reacting on an item activation. </p><dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QTreeWidgetItem)</dt> <dd> -reference to the activated item (QTreeWidgetItem) -</dd><dt><i>column</i></dt> +reference to the activated item +</dd><dt><i>column</i> (int)</dt> <dd> -activated column (integer) +activated column </dd> </dl><a NAME="PipSearchDialog.on_resultList_itemSelectionChanged" ID="PipSearchDialog.on_resultList_itemSelectionChanged"></a> <h4>PipSearchDialog.on_resultList_itemSelectionChanged</h4> @@ -307,9 +311,9 @@ <p> Private slot handling a change of the search term. </p><dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -search term (string) +search term </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipSelectionDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -70,13 +70,13 @@ </table> <a NAME="PipSelectionDialog.__init__" ID="PipSelectionDialog.__init__"></a> <h4>PipSelectionDialog (Constructor)</h4> -<b>PipSelectionDialog</b>(<i>plugin, parent=None</i>) +<b>PipSelectionDialog</b>(<i>pip, parent=None</i>) <p> Constructor </p><dl> -<dt><i>plugin</i> (ToolPipPlugin)</dt> +<dt><i>pip</i> (Pip)</dt> <dd> -reference to the plugin object +reference to the pip object </dd><dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget @@ -89,8 +89,8 @@ </p><dl> <dt>Returns:</dt> <dd> -tuple with the pip command and a flag indicating to install - to the user install directory +tuple with the environment name and a flag indicating to + install to the user install directory </dd> </dl><dl> <dt>Return Type:</dt>
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html Tue Jun 12 19:02:21 2018 +0200 @@ -66,6 +66,9 @@ <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td> <td>Public method to retrieve the entered data.</td> </tr><tr> +<td><a href="#VirtualenvAddEditDialog.on_globalCheckBox_toggled">on_globalCheckBox_toggled</a></td> +<td>Private slot handling a change of the global check box state.</td> +</tr><tr> <td><a href="#VirtualenvAddEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> <td>Private slot to handle changes of the logical name.</td> </tr><tr> @@ -123,6 +126,16 @@ <dd> tuple of (str, str, str) </dd> +</dl><a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a> +<h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4> +<b>on_globalCheckBox_toggled</b>(<i>checked</i>) +<p> + Private slot handling a change of the global check box state. +</p><dl> +<dt><i>checked</i> (bool)</dt> +<dd> +state of the check box +</dd> </dl><a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a> <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>txt</i>)
--- a/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/eric6.VirtualEnv.VirtualenvManager.html Tue Jun 12 19:02:21 2018 +0200 @@ -75,6 +75,9 @@ <td><a href="#VirtualenvManager.getEnvironmentEntries">getEnvironmentEntries</a></td> <td>Public method to a dictionary containing the defined virtual environment entries.</td> </tr><tr> +<td><a href="#VirtualenvManager.getVirtualenvDirectory">getVirtualenvDirectory</a></td> +<td>Public method to get the directory of a virtual environment.</td> +</tr><tr> <td><a href="#VirtualenvManager.getVirtualenvInterpreter">getVirtualenvInterpreter</a></td> <td>Public method to get the interpreter for a virtual environment.</td> </tr><tr> @@ -85,7 +88,7 @@ <td>Public method to check, if the give logical name is unique.</td> </tr><tr> <td><a href="#VirtualenvManager.removeVirtualEnvs">removeVirtualEnvs</a></td> -<td>Public method to delete virtuals environment from the list.</td> +<td>Public method to delete virtual environment from the list.</td> </tr><tr> <td><a href="#VirtualenvManager.renameVirtualEnv">renameVirtualEnv</a></td> <td>Public method to substitute a virtual environment entry with a new name.</td> @@ -167,6 +170,26 @@ <dd> dict of (str, str) </dd> +</dl><a NAME="VirtualenvManager.getVirtualenvDirectory" ID="VirtualenvManager.getVirtualenvDirectory"></a> +<h4>VirtualenvManager.getVirtualenvDirectory</h4> +<b>getVirtualenvDirectory</b>(<i>venvName</i>) +<p> + Public method to get the directory of a virtual environment. +</p><dl> +<dt><i>venvName</i> (str)</dt> +<dd> +logical name for the virtual environment +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +directory path +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str +</dd> </dl><a NAME="VirtualenvManager.getVirtualenvInterpreter" ID="VirtualenvManager.getVirtualenvInterpreter"></a> <h4>VirtualenvManager.getVirtualenvInterpreter</h4> <b>getVirtualenvInterpreter</b>(<i>venvName</i>) @@ -226,7 +249,7 @@ <h4>VirtualenvManager.removeVirtualEnvs</h4> <b>removeVirtualEnvs</b>(<i>venvNames</i>) <p> - Public method to delete virtuals environment from the list. + Public method to delete virtual environment from the list. </p><dl> <dt><i>venvNames</i> (list of str)</dt> <dd>
--- a/Documentation/Source/index-eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.html Tue Jun 12 19:01:06 2018 +0200 +++ b/Documentation/Source/index-eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.html Tue Jun 12 19:02:21 2018 +0200 @@ -29,7 +29,7 @@ <table> <tr> <td><a href="eric6.Plugins.UiExtensionPlugins.PipInterface.ConfigurationPage.PipPage.html">PipPage</a></td> -<td>Package implementing the configuration page.</td> +<td>Package implementing the pip configuration page.</td> </tr> </table> </body></html> \ No newline at end of file
