[GUI/PySide6] port basic execution support from old UI

Author: Shengjie Xu

.github/actions/build/action.yml

@@ -21,7 +21,11 @@ runs:
         git describe --tags
       shell: bash
     - name: install dependencies
-      run: pip install --upgrade build twine
+      run: pip install --upgrade build twine pyside6
+      shell: bash
+    - name: compile Qt UI files
+      run: |
+        cd src/preppipe_gui_pyside6/forms ; make ; cd ../../..
       shell: bash
     - name: build
       run: python3 -X utf8 -m build

preppipe_gui_entry.py

@@ -1,6 +1,6 @@
 import os
-import preppipe_gui
-import preppipe_gui.main
+import preppipe_gui_pyside6
+import preppipe_gui_pyside6.main
 
 if __name__ == '__main__':
-  preppipe_gui.main.gui_main(settings_path=os.path.dirname(__file__))
+  preppipe_gui_pyside6.main.gui_main(settings_path=os.path.dirname(__file__))

setup.cfg

@@ -48,7 +48,7 @@ install_requires =
 # https://setuptools.pypa.io/en/latest/userguide/declarative_config.html#configuring-setup-using-setup-cfg-files
 [options.extras_require]
 gui =
-  tkinterdnd2
+  pyside6
 
 [options.packages.find]
 where = src

src/preppipe_gui_pyside6/componentwidgets/fileselectionwidget.py

@@ -0,0 +1,168 @@
+import os
+import typing
+from PySide6.QtWidgets import *
+from PySide6.QtCore import *
+from PySide6.QtGui import *
+from ..forms.generated.ui_fileselectionwidget import Ui_FileSelectionWidget
+from preppipe.language import *
+from ..translatablewidgetinterface import *
+
+class FileSelectionWidget(QWidget, TranslatableWidgetInterface):
+  # Signal to indicate that the file path has been updated.
+  filePathUpdated = Signal(str)
+
+  TR_gui_fileselectionwidget = TranslationDomain("gui_fileselectionwidget")
+
+  tr_pleaseselect = TR_gui_fileselectionwidget.tr("pleaseselect",
+    en="Please select {fieldname}",
+    zh_cn="请选择{fieldname}",
+    zh_hk="請選擇{fieldname}",
+  )
+  tr_notselected = TR_gui_fileselectionwidget.tr("notselected",
+    en="({fieldname}: Not selected)",
+    zh_cn="({fieldname}: 未选择)",
+    zh_hk="({fieldname}: 未選擇)",
+  )
+  tr_select = TR_gui_fileselectionwidget.tr("select",
+    en="Select",
+    zh_cn="选择",
+    zh_hk="選擇",
+  )
+
+  @staticmethod
+  def default_file_checker(path: str) -> bool:
+    return os.path.exists(path) and os.path.isfile(path)
+
+  @staticmethod
+  def default_directory_checker(path: str) -> bool:
+    return os.path.exists(path) and os.path.isdir(path)
+
+  ui : Ui_FileSelectionWidget
+  isDirectoryMode : bool
+  isOutputInsteadofInput : bool
+  isExistingOnly : bool
+  verifyCB : typing.Callable[[str], bool] | None
+  currentPath : str
+  fieldName : Translatable | str
+  filter : Translatable | str
+  defaultName : Translatable | str
+
+  def __init__(self, parent=None):
+    super().__init__(parent)
+    # Instantiate the UI from the compiled .ui file.
+    self.ui = Ui_FileSelectionWidget()
+    self.ui.setupUi(self)
+
+    # Initial state
+    self.isDirectoryMode = False
+    self.isOutputInsteadofInput = False
+    self.isExistingOnly = False
+    self.verifyCB = None
+    self.currentPath = ""
+    self.fieldName = ""
+    self.filter = ""
+    self.defaultName = ""
+
+    # Connect the push button's clicked signal to open the dialog.
+    self.ui.pushButton.clicked.connect(self.requestOpenDialog)
+    self.bind_text(self.ui.pushButton.setText, self.tr_select)
+
+    # Enable drag and drop.
+    self.setAcceptDrops(True)
+    # Initialize the verifier based on the directory mode.
+    self.setDirectoryMode(self.isDirectoryMode)
+
+  def setDirectoryMode(self, v: bool):
+    self.isDirectoryMode = v
+    self.verifyCB = FileSelectionWidget.getDefaultVerifier(self.isDirectoryMode)
+
+  def getIsDirectoryMode(self) -> bool:
+    return self.isDirectoryMode
+
+  @staticmethod
+  def getDefaultVerifier(isDirectoryMode: bool):
+    if isDirectoryMode:
+      return FileSelectionWidget.default_directory_checker
+    else:
+      return FileSelectionWidget.default_file_checker
+
+  def setVerifyCallBack(self, cb):
+    self.verifyCB = cb
+
+  def setIsOutputInsteadofInput(self, v: bool):
+    self.isOutputInsteadofInput = v
+
+  def getIsOutputInsteadofInput(self) -> bool:
+    return self.isOutputInsteadofInput
+
+  def setExistingOnly(self, v: bool):
+    self.isExistingOnly = v
+
+  def setFieldName(self, name: Translatable | str):
+    self.fieldName = name
+    self.updateLabelText()
+
+  def getFieldName(self) -> Translatable | str:
+    return self.fieldName
+
+  def setFilter(self, filter_str: Translatable | str):
+    self.filter = filter_str
+
+  def getFilter(self) -> Translatable | str:
+    return self.filter
+
+  def getCurrentPath(self) -> str:
+    return self.currentPath
+
+  def setDefaultName(self, name: Translatable | str):
+    self.defaultName = name
+
+  def getDefaultName(self) -> Translatable | str:
+    return self.defaultName
+
+  def setCurrentPath(self, newpath: str):
+    """Slot to update the current path and refresh the label."""
+    self.currentPath = newpath
+    self.updateLabelText()
+    self.filePathUpdated.emit(self.currentPath)
+
+  def requestOpenDialog(self):
+    dialogTitle = self.tr_pleaseselect.format(fieldname=str(self.fieldName))
+    dialog = QFileDialog(self, dialogTitle, self.currentPath, str(self.filter))
+    if self.isDirectoryMode:
+      dialog.setFileMode(QFileDialog.Directory)
+      dialog.setOption(QFileDialog.ShowDirsOnly, True)
+    else:
+      dialog.setFileMode(QFileDialog.ExistingFile if self.isExistingOnly else QFileDialog.AnyFile)
+    if self.isOutputInsteadofInput:
+      dialog.setAcceptMode(QFileDialog.AcceptSave)
+    else:
+      dialog.setAcceptMode(QFileDialog.AcceptOpen)
+    dialog.fileSelected.connect(self.setCurrentPath)
+    dialog.finished.connect(dialog.deleteLater)
+    dialog.show()
+
+  def updateLabelText(self):
+    if not self.currentPath:
+      self.ui.pathLabel.setText(self.tr_notselected.format(fieldname=str(self.fieldName)))
+    else:
+      self.ui.pathLabel.setText(self.currentPath)
+
+  def update_text(self):
+    super().update_text()
+    self.updateLabelText()
+
+  def dragEnterEvent(self, e: QDragEnterEvent):
+    if e.mimeData().hasUrls():
+      path = e.mimeData().urls()[0].toLocalFile()
+      if not self.verifyCB or self.verifyCB(path):
+        e.acceptProposedAction()
+    else:
+      super().dragEnterEvent(e)
+
+  def dropEvent(self, event: QDropEvent):
+    for url in event.mimeData().urls():
+      path = url.toLocalFile()
+      if not self.verifyCB or self.verifyCB(path):
+        self.setCurrentPath(path)
+        return

src/preppipe_gui_pyside6/componentwidgets/outputentrywidget.py

@@ -0,0 +1,146 @@
+import sys
+import subprocess
+from PySide6.QtWidgets import *
+from PySide6.QtCore import *
+from PySide6.QtGui import QDesktopServices
+from preppipe.language import *
+from ..forms.generated.ui_outputentrywidget import Ui_OutputEntryWidget
+from ..translatablewidgetinterface import *
+
+class OutputEntryWidget(QWidget, TranslatableWidgetInterface):
+  TR_gui_outputentrywidget = TranslationDomain("gui_outputentrywidget")
+  _tr_open_containing_directory = TR_gui_outputentrywidget.tr("open_containing_directory",
+    en="Open Containing Directory",
+    zh_cn="打开所在目录",
+    zh_hk="打開所在目錄",
+  )
+  _tr_open = TR_gui_outputentrywidget.tr("open",
+    en="Open",
+    zh_cn="打开",
+    zh_hk="打開",
+  )
+  _tr_filestate_initial = TR_gui_outputentrywidget.tr("filestate_initial",
+    en="Init",
+    zh_cn="初始",
+    zh_hk="初始",
+  )
+  _tr_filestate_generated = TR_gui_outputentrywidget.tr("filestate_generated",
+    en="Generated",
+    zh_cn="已生成",
+    zh_hk="已生成",
+  )
+  _tr_filestate_not_updated = TR_gui_outputentrywidget.tr("filestate_not_updated",
+    en="Not Updated",
+    zh_cn="未更新",
+    zh_hk="未更新",
+  )
+  _tr_filestate_not_generated_yet = TR_gui_outputentrywidget.tr("filestate_not_generated_yet",
+    en="Not Generated Yet",
+    zh_cn="尚未生成",
+    zh_hk="尚未生成",
+  )
+  _tr_not_supported = TR_gui_outputentrywidget.tr("not_supported",
+    en="Not Supported",
+    zh_cn="暂不支持",
+    zh_hk="暫不支持",
+  )
+  _tr_not_supporting_open_directory = TR_gui_outputentrywidget.tr("not_supporting_open_directory",
+    en="Sorry, we do not support opening directories in the current system yet.",
+    zh_cn="抱歉，我们暂不支持在当前系统下打开目录。",
+    zh_hk="抱歉，我們暫不支持在當前系統下打開目錄。",
+  )
+
+  ui : Ui_OutputEntryWidget
+  fieldName : Translatable | str
+  path : str
+  lastModified : QDateTime
+
+  def __init__(self, parent=None):
+    super().__init__(parent)
+    self.ui = Ui_OutputEntryWidget()
+    self.ui.setupUi(self)
+
+    # Connect UI signals
+    self.ui.openInExplorerPushButton.clicked.connect(self.requestOpenContainingDirectory)
+    self.ui.openPushButton.clicked.connect(self.requestOpen)
+
+    self.fieldName = ""
+    self.path = ""
+    self.lastModified = QDateTime()
+
+    self.bind_text(self.ui.openPushButton.setText, self._tr_open)
+    self.bind_text(self.ui.openInExplorerPushButton.setText, self._tr_open_containing_directory)
+
+  @staticmethod
+  def getLatestModificationInDir(dirpath: str) -> QDateTime:
+    """Recursively iterates through the directory and returns the latest modification time."""
+    result = QDateTime()
+    iterator = QDirIterator(dirpath, QDir.Files | QDir.Dirs, QDirIterator.Subdirectories)
+    while iterator.hasNext():
+      file_info = QFileInfo(iterator.next())
+      if not result.isValid() or result < file_info.lastModified():
+        result = file_info.lastModified()
+    return result
+
+  def setData(self, fieldName: Translatable | str, path: str):
+    """Set the field name and path, update labels and store the initial modification time."""
+    self.fieldName = fieldName
+    self.path = path
+    if isinstance(fieldName, Translatable):
+      self.bind_text(self.ui.fieldNameLabel.setText, fieldName)
+    else:
+      self.ui.fieldNameLabel.setText(fieldName)
+    self.ui.pathLabel.setText(path)
+    self.bind_text(self.ui.statusLabel.setText, self._tr_filestate_initial)
+
+    info = QFileInfo(path)
+    if info.exists():
+      if info.isDir():
+        # 如果是目录的话，我们使用当前时间
+        # 其实应该遍历目录下所有文件、取最新的时间的，这里就先不这样做了
+        self.lastModified = QDateTime.currentDateTime()
+      else:
+        self.lastModified = info.lastModified()
+    else:
+      self.lastModified = QDateTime()
+
+  def updateStatus(self):
+    """Updates the status label based on the modification time of the target file/directory."""
+    info = QFileInfo(self.path)
+    if info.exists():
+      curtime = info.lastModified()
+      if info.isDir():
+        curtime = self.getLatestModificationInDir(self.path)
+      if not self.lastModified.isValid() or self.lastModified < curtime:
+        self.bind_text(self.ui.statusLabel.setText, self._tr_filestate_generated)
+        return
+      self.bind_text(self.ui.statusLabel.setText, self._tr_filestate_not_updated)
+    else:
+      self.bind_text(self.ui.statusLabel.setText, self._tr_filestate_not_generated_yet)
+
+  def requestOpenContainingDirectory(self):
+    if not os.path.exists(self.path):
+      return
+
+    if sys.platform.startswith('win'):
+      # Windows
+      explorer = 'explorer'
+      path = os.path.normpath(self.path)
+      subprocess.Popen([explorer, '/select,', path])
+    elif sys.platform.startswith('darwin'):
+      # macOS
+      subprocess.Popen(['open', '-R', self.path])
+    elif sys.platform.startswith('linux'):
+      # Linux
+      try:
+        subprocess.Popen(['xdg-open', os.path.dirname(self.path)])
+      except Exception:
+        QMessageBox.warning(self, self._tr_not_supported.get(), self._tr_not_supporting_open_directory.get())
+    else:
+      QMessageBox.warning(self, self._tr_not_supported.get(), self._tr_not_supporting_open_directory.get())
+
+  def requestOpen(self):
+    """Opens the target file or directory using the default system handler."""
+    info = QFileInfo(self.path)
+    if info.exists():
+      QDesktopServices.openUrl(QUrl.fromLocalFile(self.path))