Clear metadatastore cache from settings

Author: mrvisscher

activity_browser/app/actions/__init__.py

@@ -97,3 +97,4 @@
 from .metadatastore_open import MetaDataStoreOpen
 from .node_select_open import NodeSelectOpen
 from .save_parameters_to_excel import SaveParametersToExcel
+from .metadatastore_cache_clear import MetaDataStoreCacheClear

activity_browser/app/actions/metadatastore_cache_clear.py

@@ -0,0 +1,20 @@
+from activity_browser import app
+from activity_browser.app.actions.base import ABAction, exception_dialogs
+from activity_browser.ui.icons import qicons
+
+import bw2data as bd
+
+from .project.project_switch import ProjectSwitch
+
+
+class MetaDataStoreCacheClear(ABAction):
+
+    icon = qicons.right
+    text = "Clear Metadata Store Cache"
+    tool_tip = "Clear the Metadata Store cache and reload the current project"
+
+    @staticmethod
+    @exception_dialogs
+    def run():
+        app.metadata.clear_cache()
+        ProjectSwitch.run(bd.projects.current, reload=True)

activity_browser/app/actions/project/project_switch.py

@@ -37,9 +37,9 @@ class ProjectSwitch(ABAction):
 
     @staticmethod
     @exception_dialogs
-    def run(project_name: str):
+    def run(project_name: str, reload: bool = False):
         # compare the new to the current project name and switch to the new one if the two are not the same
-        if project_name == bd.projects.current:
+        if project_name == bd.projects.current and not reload:
             logger.debug(f"Brightway2 already selected: {project_name}")
             return
 

activity_browser/app/pages/settings/metadatastore.py

@@ -3,6 +3,7 @@
 from qtpy import QtWidgets
 
 from activity_browser.app import settings
+from activity_browser.app.actions.metadatastore_cache_clear import MetaDataStoreCacheClear
 from activity_browser.app.pages.settings.base import BaseSettingsChapter
 
 
@@ -26,6 +27,13 @@ def __init__(self, parent=None):
             "Disable if you experience performance issues with large databases."
         )
 
+        # Clear cache button
+        self.clear_cache_button = QtWidgets.QPushButton("Clear Cache")
+        self.clear_cache_button.setToolTip(
+            "Clear the metadata store cache and reload the current project. "
+            "Use this if you experience issues with outdated or corrupted cache data."
+        )
+
         self.build_layout()
         self.connect_signals()
         self.reset()
@@ -36,6 +44,9 @@ def connect_signals(self):
         self.caching_checkbox.stateChanged.connect(lambda: self.changed.emit())
         self.searcher_checkbox.stateChanged.connect(lambda: self.changed.emit())
 
+        # Connect clear cache button
+        self.clear_cache_button.clicked.connect(MetaDataStoreCacheClear.run)
+
     def build_layout(self):
         """Build the chapter layout."""
         layout = QtWidgets.QVBoxLayout()
@@ -47,10 +58,13 @@ def build_layout(self):
         metadatastore_layout.addWidget(self.caching_checkbox)
         metadatastore_layout.addWidget(self.searcher_checkbox)
 
+        # Add clear cache button
+        metadatastore_layout.addWidget(self.clear_cache_button)
+
         # Add description label
         description = QtWidgets.QLabel(
             "These settings control the behavior of the metadata store, "
-            "which manages activity and exchange metadata for improved performance."
+            "which manages activity data for improved performance."
         )
         description.setWordWrap(True)
         description.setStyleSheet("color: gray; font-size: 10pt;")

activity_browser/bwutils/metadata/metadata.py

@@ -248,6 +248,16 @@ def auto_complete(self, word: str, context: Optional[set] = None, database: Opti
         completions = self.searcher.auto_complete(word, context=context, database=database)
         return completions
 
+    def clear_cache(self):
+        from activity_browser.bwutils import filesystem
+
+        cache_path = filesystem.get_project_ab_path() / "metadatastore_cache.pkl"
+        if cache_path.exists():
+            cache_path.unlink()
+            logger.info("Metadata store cache cleared.")
+        else:
+            logger.info("No metadata store cache found to clear.")
+
 
 def get_query_parameters(query: str) -> tuple[dict[str, str], str]:
     """Extract key-value pairs from a query string of the form 'key1:value1 key2:value2'."""