fix: when user quits GUI during processing, forcibly kill all processes

Author: paulmueller

CHANGELOG

@@ -1,5 +1,7 @@
-0.7.1
+0.8.0
+ - fix: when user quits GUI during processing, forcibly kill all processes
  - docs: add installation section
+ - setup: add psutil dependency
 0.7.0
  - build: add torch-CUDA libraries to release binaries
 0.6.8

chipstream/gui/main_window.py

@@ -6,12 +6,14 @@
 import pathlib
 import signal
 import sys
+import time
 import traceback
 import webbrowser
 
 from dcnum.feat import feat_background
 from dcnum.meta import paths as dcnum_paths
 from dcnum.segm import get_available_segmenters
+import psutil
 from PyQt6 import uic, QtCore, QtWidgets
 from PyQt6.QtCore import QStandardPaths
 
@@ -157,6 +159,19 @@ def append_paths(self, path_list):
                 self.job_manager.add_path(pp)
             self.tableWidget_input.update_from_job_manager()
 
+    @QtCore.pyqtSlot(QtCore.QEvent)
+    def closeEvent(self, event):
+        jobs_running = self.is_running()
+        if jobs_running:
+            self.job_manager.close(force=True)
+        event.accept()
+        if jobs_running:
+            time.sleep(1)
+            # We have killed all background jobs, we might be littered with
+            # zombies. Everything is probably broken. Just get rid of
+            # ourselves.
+            psutil.Process().kill()
+
     @QtCore.pyqtSlot(QtCore.QEvent)
     def dragEnterEvent(self, e):
         """Whether files are accepted"""

chipstream/gui/main_window.ui

@@ -39,7 +39,7 @@
       <item>
        <widget class="QSplitter" name="splitter">
         <property name="orientation">
-         <enum>Qt::Vertical</enum>
+         <enum>Qt::Orientation::Vertical</enum>
         </property>
         <widget class="ProgressTable" name="tableWidget_input">
          <property name="sizePolicy">
@@ -49,25 +49,25 @@
           </sizepolicy>
          </property>
          <property name="editTriggers">
-          <set>QAbstractItemView::NoEditTriggers</set>
+          <set>QAbstractItemView::EditTrigger::NoEditTriggers</set>
          </property>
          <property name="dragDropMode">
-          <enum>QAbstractItemView::NoDragDrop</enum>
+          <enum>QAbstractItemView::DragDropMode::NoDragDrop</enum>
          </property>
          <property name="alternatingRowColors">
           <bool>true</bool>
          </property>
          <property name="selectionMode">
-          <enum>QAbstractItemView::SingleSelection</enum>
+          <enum>QAbstractItemView::SelectionMode::SingleSelection</enum>
          </property>
          <property name="selectionBehavior">
-          <enum>QAbstractItemView::SelectRows</enum>
+          <enum>QAbstractItemView::SelectionBehavior::SelectRows</enum>
          </property>
          <property name="textElideMode">
-          <enum>Qt::ElideMiddle</enum>
+          <enum>Qt::TextElideMode::ElideMiddle</enum>
          </property>
          <property name="horizontalScrollMode">
-          <enum>QAbstractItemView::ScrollPerPixel</enum>
+          <enum>QAbstractItemView::ScrollMode::ScrollPerPixel</enum>
          </property>
          <property name="sortingEnabled">
           <bool>true</bool>
@@ -139,7 +139,7 @@
        <item>
         <spacer name="verticalSpacer_2">
          <property name="orientation">
-          <enum>Qt::Vertical</enum>
+          <enum>Qt::Orientation::Vertical</enum>
          </property>
          <property name="sizeHint" stdset="0">
           <size>
@@ -246,7 +246,7 @@
               <item row="1" column="0">
                <spacer name="verticalSpacer">
                 <property name="orientation">
-                 <enum>Qt::Vertical</enum>
+                 <enum>Qt::Orientation::Vertical</enum>
                 </property>
                 <property name="sizeHint" stdset="0">
                  <size>
@@ -507,7 +507,7 @@
      <x>0</x>
      <y>0</y>
      <width>1116</width>
-     <height>22</height>
+     <height>23</height>
     </rect>
    </property>
    <widget class="QMenu" name="menuHelp">
@@ -608,5 +608,21 @@
     </hint>
    </hints>
   </connection>
+  <connection>
+   <sender>actionQuit</sender>
+   <signal>triggered()</signal>
+   <receiver>MainWindow</receiver>
+   <slot>close()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>-1</x>
+     <y>-1</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>557</x>
+     <y>342</y>
+    </hint>
+   </hints>
+  </connection>
  </connections>
 </ui>

chipstream/gui/manager.py

@@ -8,6 +8,7 @@
 import dcnum.read
 from dcnum import logic as dclogic
 import h5py
+import psutil
 
 
 class JobStillRunningError(BaseException):
@@ -56,6 +57,30 @@ def clear(self):
         self._runner_list.clear()
         self._worker = None
 
+    def close(self, force=True):
+        if force:
+            # Get the current process
+            proc = psutil.Process()
+            # Forcibly kill all children. This is not very clean, and it
+            # might leave zombie processes behind. But these zombie
+            # processes will not be doing anything with data anymore.
+            for ii in range(100):
+                killed = 0
+                children = list(proc.children(recursive=True))
+                for child in children:
+                    try:
+                        child.kill()
+                        killed += 1
+                    except (psutil.ZombieProcess, psutil.NoSuchProcess):
+                        continue
+                if not killed:
+                    break
+
+            self.clear()
+        elif self.is_busy():
+            raise ValueError(
+                "Manager is busy, use `force=True` to close regardless")
+
     def is_busy(self):
         return self.busy_lock.locked()
 

chipstream/gui/table_progress.py

@@ -74,10 +74,11 @@ def update_from_job_manager(self):
 
     @QtCore.pyqtSlot()
     def update_from_job_manager_progress(self):
-        for ii in range(len(self.job_manager)):
-            st = self.item(ii, 1)
-            st.setText(self.job_manager[ii]["state"])
-            pb = self.cellWidget(ii, 2)
-            progress = self.job_manager[ii]["progress"]
-            if pb is not None and pb.value() != int(progress*1000):
-                pb.setValue(int(progress*1000))
+        if self.job_manager:
+            for ii in range(len(self.job_manager)):
+                st = self.item(ii, 1)
+                st.setText(self.job_manager[ii]["state"])
+                pb = self.cellWidget(ii, 2)
+                progress = self.job_manager[ii]["progress"]
+                if pb is not None and pb.value() != int(progress*1000):
+                    pb.setValue(int(progress*1000))

pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "dcnum>=0.25.10",
     "h5py>=3.0.0, <4",
     "numpy>=1.21, <3",  # CVE-2021-33430
+    "psutil>=7",
 ]
 dynamic = ["version"]