Always close thread-specific SQLite connections (#1222)

* Added close all DB clauses to the end of some QThreads

* Created ABThread that auto-closed sqlite-connections

* Added run_safely method to ABThread

* Updated `CopyDatabaseThread()` as well

* Added `python 3.10` to dependencies

* Updated github workflows

Author: mrvisscher

.github/workflows/install-canary.yaml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
     defaults:
       run:
         shell: bash -l {0}

.github/workflows/main.yaml

@@ -33,7 +33,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
     defaults:
       run:
         shell: bash -l {0}

activity_browser/ui/threading.py

@@ -0,0 +1,28 @@
+from PySide2.QtCore import QThread
+import brightway2 as bw
+
+
+class ABThread(QThread):
+
+    def run(self):
+        """Reimplemented from QThread to close any database connections before finishing."""
+        # call run_safely and finish by closing the connections
+        try:
+            self.run_safely()
+            self.close_connections()
+        # also close the connections if any exception occurs
+        except Exception as e:
+            self.close_connections()
+            raise e
+
+    def close_connections(self):
+        """
+        Closes all connections for this thread
+        todo: move to an appropriate controller
+        """
+        for _, SubstitutableDatabase in bw.config.sqlite3_databases:
+            if not SubstitutableDatabase.db.is_closed():
+                SubstitutableDatabase.db.close()
+
+    def run_safely(self):
+        raise NotImplementedError

activity_browser/ui/widgets/biosphere_update.py

@@ -8,6 +8,7 @@
 
 import logging
 from activity_browser.logger import ABHandler
+from ..threading import ABThread
 
 logger = logging.getLogger('ab_logs')
 log = ABHandler.setup_with_logger(logger, __name__)
@@ -40,7 +41,7 @@ def update_progress(self, current: int):
         self.setValue(current)
 
 
-class UpdateBiosphereThread(QtCore.QThread):
+class UpdateBiosphereThread(ABThread):
     PATCHES = [patch for patch in dir(data) if patch.startswith('add_ecoinvent') and patch.endswith('biosphere_flows')]
     progress = Signal(int)
     def __init__(self, ei_versions, parent=None):
@@ -51,7 +52,7 @@ def __init__(self, ei_versions, parent=None):
 
         self.total_patches = len(self.PATCHES)
 
-    def run(self):
+    def run_safely(self):
         try:
             for i, patch in enumerate(self.PATCHES):
                 self.progress.emit(i)

activity_browser/ui/widgets/database_copy.py

@@ -3,6 +3,7 @@
 from PySide2 import QtCore, QtWidgets
 
 from ...signals import signals
+from ..threading import ABThread
 
 
 class CopyDatabaseDialog(QtWidgets.QProgressDialog):
@@ -36,7 +37,7 @@ def finished(self, result: int = None) -> None:
         signals.databases_changed.emit()
 
 
-class CopyDatabaseThread(QtCore.QThread):
+class CopyDatabaseThread(ABThread):
     def __init__(self, parent=None):
         super().__init__(parent=parent)
         self.copy_from = None
@@ -46,5 +47,5 @@ def configure(self, copy_from: str, copy_to: str):
         self.copy_from = copy_from
         self.copy_to = copy_to
 
-    def run(self):
+    def run_safely(self):
         bw.Database(self.copy_from).copy(self.copy_to)

activity_browser/ui/widgets/dialog.py

@@ -4,11 +4,12 @@
 
 import brightway2 as bw
 from PySide2 import QtGui, QtWidgets
-from PySide2.QtCore import QRegExp, QThread, Qt, Signal, Slot
+from PySide2.QtCore import Qt, Signal, Slot
 
 from activity_browser.bwutils.superstructure import get_sheet_names
 from activity_browser.settings import project_settings
 from activity_browser.signals import signals
+from ..threading import ABThread
 from ..style import style_group_box, vertical_line
 from ...ui.icons import qicons
 from ...ui.widgets import BiosphereUpdater
@@ -549,14 +550,14 @@ def check_patches(self):
         dialog.show()
 
 
-class DefaultBiosphereThread(QThread):
+class DefaultBiosphereThread(ABThread):
     update = Signal(int, str)
 
     def __init__(self, version, parent=None):
         super().__init__(parent=parent)
         self.version = version
 
-    def run(self):
+    def run_safely(self):
         project = "<b>{}</b>".format(bw.projects.current)
         if "biosphere3" not in bw.databases:
             self.update.emit(0, "Creating default biosphere for {}".format(project))

activity_browser/ui/wizards/db_import_wizard.py

@@ -16,6 +16,7 @@
 from PySide2 import QtWidgets, QtCore
 from PySide2.QtCore import Signal, Slot
 
+from ..threading import ABThread
 from ...bwutils.errors import ImportCanceledError, LinkingFailed
 from ...bwutils.importers import ABExcelImporter, ABPackage
 from ...signals import signals
@@ -707,7 +708,7 @@ def report_failed_unarchive(self, file: str) -> None:
         return
 
 
-class MainWorkerThread(QtCore.QThread):
+class MainWorkerThread(ABThread):
     def __init__(self, downloader, parent=None):
         super().__init__(parent)
         self.downloader = downloader
@@ -729,7 +730,7 @@ def update(self, db_name: str, archive_path=None, datasets_path=None,
         self.use_local = use_local
         self.relink = relink or {}
 
-    def run(self):
+    def run_safely(self):
         # Set the cancel sentinal to false whenever the thread (re-)starts
         import_signals.cancel_sentinel = False
         if self.use_forwast:

recipe/meta.yaml

@@ -24,20 +24,20 @@ requirements:
     - python
     - setuptools
   run:
-    - python >=3.8,<=3.11,!=3.10
+    - python >=3.8,<3.12
     - arrow
     - brightway2 =2.4.4
-    - pyperclip
     - eidl >=2.0.1
+    - libxml2 <=2.10.4
     - networkx
+    - numpy >=1.23.5
+    - pandas <=2.1.4
+    - pint <=0.21
+    - pyperclip
     - pyside2 >=5.15.5
     - qt-webengine
-    - numpy >=1.23.5
     - salib >=1.4
     - seaborn
-    - libxml2 <=2.10.4
-    - pint <=0.21
-    - pandas <=2.1.4
 
 about:
   home: https://github.com/LCA-ActivityBrowser/activity-browser