Support tag for builder app

iquip/apps/explorer.py

@@ -2,12 +2,13 @@
 
 import posixpath
 import logging
-from typing import Dict, List, Optional, Tuple, Union
+from typing import Dict, Iterable, List, Optional, Tuple, Union
 
 import requests
 from PyQt5.QtCore import QObject, Qt, QThread, pyqtSlot, pyqtSignal
 from PyQt5.QtWidgets import (
-    QInputDialog, QPushButton, QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
+    QComboBox, QDialog, QHBoxLayout, QLineEdit, QPushButton, QTreeWidget, QTreeWidgetItem,
+    QVBoxLayout, QWidget,
 )
 
 import qiwis
@@ -96,6 +97,48 @@ def run(self):
         self.fetched.emit(experimentList, self.widget)
 
 
+class BuilderInfoDialog(QDialog):
+    """Dialog for setting builder info.
+
+    There are two types of info.
+        clsName: Target experiment class name.
+        tag: Additive tag for multiple builder apps.
+    """
+
+    def __init__(self, clsNames: Iterable[str], parent: Optional[QWidget] = None):
+        """Extended.
+
+        Args:
+            See thread.ExperimentInfoThread.fetched signal.
+        """
+        super().__init__(parent=parent)
+        # widgets
+        self.comboBox = QComboBox(self)
+        self.comboBox.addItems(clsNames)
+        self.lineEdit = QLineEdit(self)
+        self.lineEdit.setPlaceholderText("Tag")
+        self.okButton = QPushButton("OK", self)
+        self.okButton.clicked.connect(self.accept)
+        self.cancelButton = QPushButton("Cancel", self)
+        self.cancelButton.clicked.connect(self.reject)
+        # layout
+        buttonLayout = QHBoxLayout()
+        buttonLayout.addWidget(self.okButton)
+        buttonLayout.addWidget(self.cancelButton)
+        layout = QVBoxLayout(self)
+        layout.addWidget(self.comboBox)
+        layout.addWidget(self.lineEdit)
+        layout.addLayout(buttonLayout)
+
+    def getBuilderInfo(self) -> Tuple[str, str]:
+        """Returns the configured builder info.
+
+        Returns:
+            (clsName, tag): See BuilderInfoDialog.
+        """
+        return self.comboBox.currentText(), self.lineEdit.text()
+
+
 class ExplorerApp(qiwis.BaseApp):
     """App for showing the experiment list and opening an experiment.
 
@@ -216,54 +259,47 @@ def fetchExperimentInfo(self, item: QTreeWidgetItem):
             self.proxy_port,
             self
         )
-        self.experimentInfoThread.fetched.connect(self.selectExperimentCls,
+        self.experimentInfoThread.fetched.connect(self.openBuilderInfoDialog,
                                                   type=Qt.QueuedConnection)
         self.experimentInfoThread.finished.connect(self.experimentInfoThread.deleteLater)
         self.experimentInfoThread.start()
 
     @pyqtSlot(dict)
-    def selectExperimentCls(self, experimentInfos: Dict[str, ExperimentInfo]):
-        """Selects an experiment class to be opened as a builder.
+    def openBuilderInfoDialog(self, experimentInfos: Dict[str, ExperimentInfo]):
+        """Opens a dialog for setting builder info.
 
-        After selected, self.openBuilder() is called to open a builder.
-
-        If there is only one class, it is selected automatically without showing a QInputDialog.
-        If no class is selected, nothing happens.
+        If the dialog is confirmed, self.openBuilder() is called with the configured builder info.
+        Otherwise, nothing happens.
 
         Args:
             See thread.ExperimentInfoThread.fetched signal.
         """
-        if len(experimentInfos) > 1:
-            cls, ok = QInputDialog().getItem(None, "Select an experiment class",
-                                             "Experiment class: ", experimentInfos, editable=False)
-            if not ok:
-                return
-        else:
-            cls = next(iter(experimentInfos))
-        self.openBuilder(cls, experimentInfos[cls])
-
-    def openBuilder(
-        self,
-        experimentClsName: str,
-        experimentInfo: ExperimentInfo
-    ):
+        dialog = BuilderInfoDialog(experimentInfos)
+        if dialog.exec_():
+            clsName, tag = dialog.getBuilderInfo()
+            self.openBuilder(clsName, tag, experimentInfos[clsName])
+
+
+    def openBuilder(self, clsName: str, tag: str, experimentInfo: ExperimentInfo):
         """Opens the experiment builder with its information.
 
         The experiment is guaranteed to be the correct experiment file.
 
         Args:
-            experimentClsName: The class name of the experiment.
+            clsName, tag: See BuilderInfoDialog.
             experimentInfo: The experiment information. See protocols.ExperimentInfo.
         """
+        if tag:
+            tag = f" ({tag})"
         self.qiwiscall.createApp(
-            name=f"builder - {self.selectedExperimentPath}:{experimentClsName}",
+            name=f"builder{tag} - {self.selectedExperimentPath}:{clsName}",
             info=qiwis.AppInfo(
                 module="iquip.apps.builder",
                 cls="BuilderApp",
                 pos="center",
                 args={
                     "experimentPath": self.selectedExperimentPath,
-                    "experimentClsName": experimentClsName,
+                    "experimentClsName": clsName,
                     "experimentInfo": experimentInfo
                 }
             )

tests/test_explorer.py

@@ -200,16 +200,16 @@ def test_open_builder(self):
         app.selectedExperimentPath = "experimentPath"
         experimentInfo = protocols.ExperimentInfo("name", {"arg0": "value0"})
         with mock.patch.object(app, "qiwiscall") as mocked_qiwiscall:
-            app.openBuilder("experimentClsName", experimentInfo)
+            app.openBuilder("cls", "tag", experimentInfo)
         mocked_qiwiscall.createApp.assert_called_with(
-            name="builder - experimentPath:experimentClsName",
+            name="builder (tag) - experimentPath:cls",
             info=qiwis.AppInfo(
                 module="iquip.apps.builder",
                 cls="BuilderApp",
                 pos="center",
                 args={
                     "experimentPath": "experimentPath",
-                    "experimentClsName": "experimentClsName",
+                    "experimentClsName": "cls",
                     "experimentInfo": experimentInfo
                 }
             )