--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/VirtualEnv/VirtualenvAddEditDialog.py Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,274 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018 - 2022 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog to enter the data of a virtual environment.
+"""
+
+import os
+
+from PyQt6.QtCore import pyqtSlot, Qt
+from PyQt6.QtWidgets import QDialog, QDialogButtonBox
+
+from EricWidgets.EricPathPicker import EricPathPickerModes
+
+from .Ui_VirtualenvAddEditDialog import Ui_VirtualenvAddEditDialog
+
+import Globals
+import Utilities
+
+
+class VirtualenvAddEditDialog(QDialog, Ui_VirtualenvAddEditDialog):
+ """
+ Class implementing a dialog to enter the data of a virtual environment.
+ """
+ def __init__(self, manager, venvName="", venvDirectory="",
+ venvInterpreter="", isGlobal=False, isConda=False,
+ isRemote=False, execPath="", baseDir="", parent=None):
+ """
+ Constructor
+
+ @param manager reference to the virtual environment manager
+ @type VirtualenvManager
+ @param venvName logical name of a virtual environment for editing
+ @type str
+ @param venvDirectory directory of the virtual environment
+ @type str
+ @param venvInterpreter Python interpreter of the virtual environment
+ @type str
+ @param isGlobal flag indicating a global environment
+ @type bool
+ @param isConda flag indicating an Anaconda virtual environment
+ @type bool
+ @param isRemote flag indicating a remotely accessed environment
+ @type bool
+ @param execPath search path string to be prepended to the PATH
+ environment variable
+ @type str
+ @param baseDir base directory for the virtual environments
+ @type str
+ @param parent reference to the parent widget
+ @type QWidget
+ """
+ super().__init__(parent)
+ self.setupUi(self)
+
+ self.__venvName = venvName
+ self.__manager = manager
+ self.__editMode = bool(venvName)
+
+ if self.__editMode:
+ self.setWindowTitle(self.tr("Edit Virtual Environment"))
+ else:
+ self.setWindowTitle(self.tr("Add Virtual Environment"))
+
+ self.__envBaseDir = baseDir
+ if not self.__envBaseDir:
+ self.__envBaseDir = Utilities.getHomeDir()
+
+ self.targetDirectoryPicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
+ self.targetDirectoryPicker.setWindowTitle(
+ self.tr("Virtualenv Target Directory"))
+ self.targetDirectoryPicker.setDefaultDirectory(self.__envBaseDir)
+
+ self.pythonExecPicker.setMode(EricPathPickerModes.OPEN_FILE_MODE)
+ self.pythonExecPicker.setWindowTitle(
+ self.tr("Python Interpreter"))
+ self.pythonExecPicker.setDefaultDirectory(
+ Globals.getPythonExecutable())
+
+ self.execPathEdit.setToolTip(self.tr(
+ "Enter the executable search path to be prepended to the PATH"
+ " environment variable. Use '{0}' as the separator.").format(
+ os.pathsep)
+ )
+
+ self.nameEdit.setText(venvName)
+ if venvDirectory:
+ self.targetDirectoryPicker.setText(venvDirectory,
+ toNative=not isRemote)
+ else:
+ self.targetDirectoryPicker.setText(self.__envBaseDir,
+ toNative=not isRemote)
+ if not venvInterpreter and venvDirectory and not isRemote:
+ py = self.__detectPythonInterpreter(venvDirectory)
+ self.pythonExecPicker.setText(py)
+ else:
+ self.pythonExecPicker.setText(venvInterpreter,
+ toNative=not isRemote)
+
+ self.globalCheckBox.setChecked(isGlobal)
+ self.anacondaCheckBox.setChecked(isConda)
+ self.remoteCheckBox.setChecked(isRemote)
+ self.execPathEdit.setText(execPath)
+
+ self.__updateOk()
+
+ self.nameEdit.setFocus(Qt.FocusReason.OtherFocusReason)
+
+ def __updateOk(self):
+ """
+ Private slot to update the state of the OK button.
+ """
+ enable = (
+ (bool(self.nameEdit.text()) and
+ (self.nameEdit.text() == self.__venvName or
+ self.__manager.isUnique(self.nameEdit.text())))
+ if self.__editMode else
+ (bool(self.nameEdit.text()) and
+ self.__manager.isUnique(self.nameEdit.text()))
+ )
+
+ if not self.globalCheckBox.isChecked():
+ enable &= (
+ self.remoteCheckBox.isChecked() or (
+ bool(self.targetDirectoryPicker.text()) and
+ self.targetDirectoryPicker.text() != self.__envBaseDir and
+ os.path.exists(self.targetDirectoryPicker.text())
+ )
+ )
+
+ enable = (
+ enable and
+ bool(self.pythonExecPicker.text()) and (
+ self.remoteCheckBox.isChecked() or
+ os.access(self.pythonExecPicker.text(), os.X_OK)
+ )
+ )
+
+ self.buttonBox.button(
+ QDialogButtonBox.StandardButton.Ok).setEnabled(enable)
+
+ def __detectPythonInterpreter(self, venvDirectory):
+ """
+ Private method to search for a suitable Python interpreter inside an
+ environment.
+
+ @param venvDirectory directory for the virtual environment
+ @type str
+ @return detected Python interpreter or empty string
+ @rtype str
+ """
+ if venvDirectory:
+ # try to determine a Python interpreter name
+ if Utilities.isWindowsPlatform():
+ candidates = (
+ os.path.join(venvDirectory, "Scripts", "python.exe"),
+ os.path.join(venvDirectory, "python.exe"),
+ )
+ else:
+ candidates = (
+ os.path.join(venvDirectory, "bin", "python3"),
+ )
+ for py in candidates:
+ if os.path.exists(py):
+ return py
+
+ return ""
+
+ @pyqtSlot(str)
+ def on_nameEdit_textChanged(self, txt):
+ """
+ Private slot to handle changes of the logical name.
+
+ @param txt current logical name
+ @type str
+ """
+ self.__updateOk()
+
+ @pyqtSlot(str)
+ def on_targetDirectoryPicker_textChanged(self, txt):
+ """
+ Private slot to handle changes of the virtual environment directory.
+
+ @param txt virtual environment directory
+ @type str
+ """
+ self.__updateOk()
+
+ if txt:
+ self.pythonExecPicker.setDefaultDirectory(txt)
+ else:
+ self.pythonExecPicker.setDefaultDirectory(
+ Globals.getPythonExecutable())
+ py = self.__detectPythonInterpreter(txt)
+ if py:
+ self.pythonExecPicker.setText(py)
+
+ @pyqtSlot(str)
+ def on_pythonExecPicker_textChanged(self, txt):
+ """
+ Private slot to handle changes of the virtual environment interpreter.
+
+ @param txt virtual environment interpreter
+ @type str
+ """
+ self.__updateOk()
+
+ @pyqtSlot(bool)
+ def on_globalCheckBox_toggled(self, checked):
+ """
+ Private slot handling a change of the global check box state.
+
+ @param checked state of the check box
+ @type bool
+ """
+ self.__updateOk()
+
+ @pyqtSlot(bool)
+ def on_remoteCheckBox_toggled(self, checked):
+ """
+ Private slot handling a change of the remote check box state.
+
+ @param checked state of the check box
+ @type bool
+ """
+ self.__updateOk()
+
+ @pyqtSlot(bool)
+ def on_anacondaCheckBox_clicked(self, checked):
+ """
+ Private slot handling a user click on this check box.
+
+ @param checked state of the check box
+ @type bool
+ """
+ if checked and not bool(self.execPathEdit.text()):
+ # prepopulate the execPathEdit widget
+ if Utilities.isWindowsPlatform():
+ self.execPathEdit.setText(os.pathsep.join([
+ self.targetDirectoryPicker.text(),
+ os.path.join(self.targetDirectoryPicker.text(),
+ "Scripts"),
+ os.path.join(self.targetDirectoryPicker.text(),
+ "Library", "bin"),
+ ]))
+ else:
+ self.execPathEdit.setText(
+ os.path.join(self.targetDirectoryPicker.text(),
+ "bin"),
+ )
+
+ def getData(self):
+ """
+ Public method to retrieve the entered data.
+
+ @return tuple containing the logical name, the directory, the
+ interpreter of the virtual environment, a flag indicating a
+ global environment, a flag indicating an Anaconda environment,
+ a flag indicating a remotely accessed environment and a string
+ to be prepended to the PATH environment variable
+ @rtype tuple of (str, str, str, bool, bool, bool, str)
+ """
+ nativePaths = not self.remoteCheckBox.isChecked()
+ return (
+ self.nameEdit.text(),
+ self.targetDirectoryPicker.text(toNative=nativePaths),
+ self.pythonExecPicker.text(toNative=nativePaths),
+ self.globalCheckBox.isChecked(),
+ self.anacondaCheckBox.isChecked(),
+ self.remoteCheckBox.isChecked(),
+ self.execPathEdit.text(),
+ )
