Close template trace resources

Author: rossant

phy/apps/_utils.py

@@ -0,0 +1,26 @@
+"""Shared application resource helpers."""
+
+
+def _close_trace_reader(traces):
+    """Close a phylib trace reader, including readers without a public close method."""
+    if traces is None:
+        return
+
+    close = getattr(traces, 'close', None)
+    if callable(close):
+        close()
+        return
+
+    arrays = list(getattr(traces, '_mmaps', ()))
+    arr = getattr(traces, 'arr', None)
+    if arr is not None:
+        arrays.append(arr)
+    for arr in arrays:
+        mmap = getattr(arr, '_mmap', None)
+        if mmap is not None and not mmap.closed:
+            mmap.close()
+
+    reader = getattr(traces, 'reader', None)
+    close = getattr(reader, 'close', None)
+    if callable(close):
+        close()

phy/apps/base.py

@@ -48,6 +48,8 @@
 from phy.utils.context import Context, _cache_methods
 from phy.utils.plugin import attach_plugins
 
+from ._utils import _close_trace_reader
+
 logger = logging.getLogger(__name__)
 
 
@@ -976,6 +978,7 @@ def close(self, close_model=True):
         recreate a GUI around the same model. Resource cleanup is therefore explicit.
         """
         if close_model and not self._model_closed:
+            _close_trace_reader(getattr(self.model, 'traces', None))
             close = getattr(self.model, 'close', None)
             if callable(close):
                 close()

phy/apps/template/tests/test_gui.py

@@ -48,6 +48,16 @@ def test_template_describe(qtbot, tempdir):
     assert '314' in stdout.getvalue()
 
 
+def test_template_controller_close(tempdir):
+    dataset = _make_dataset(tempdir, param='dense', has_spike_attributes=False)
+    controller = _template_controller(tempdir, dataset.parent)
+    mmaps = list(controller.model.traces._mmaps)
+
+    controller.close()
+
+    assert all(arr._mmap.closed for arr in mmaps)
+
+
 class TemplateControllerTests(GlobalViewsTests, BaseControllerTests):
     """Base template controller tests."""
 
@@ -114,9 +124,9 @@ def test_z1_close_reopen(self):
 
         # Close the GUI.
         self.__class__._close_gui()
-        self.__class__._controller.close(close_model=False)
+        self.__class__._controller.close()
 
-        # Recreate the controller on the model.
+        # Recreate the controller from the saved dataset.
         self.__class__._controller = _template_controller(
             self.__class__._tempdir, self.__class__._dataset.parent, clear_cache=False
         )

phy/apps/tests/test_base.py

@@ -319,6 +319,8 @@ class BaseControllerTests(MinimalControllerTests):
 
     def test_common_01(self):
         """Select one cluster."""
+        self.supervisor.select_actions.reset_wizard()
+        self.supervisor.block()
         self.next_best()
         self.assertEqual(len(self.selected), 1)
 

phy/apps/trace/gui.py

@@ -14,25 +14,9 @@
 from phy.cluster.views.trace import TraceView, select_traces
 from phy.gui import GUI, create_app, run_app
 
-logger = logging.getLogger(__name__)
-
-
-def _close_trace_reader(traces):
-    """Close a phylib trace reader, including readers without a public close method."""
-    close = getattr(traces, 'close', None)
-    if callable(close):
-        close()
-        return
+from .._utils import _close_trace_reader
 
-    for arr in getattr(traces, '_mmaps', ()):
-        mmap = getattr(arr, '_mmap', None)
-        if mmap is not None and not mmap.closed:
-            mmap.close()
-
-    reader = getattr(traces, 'reader', None)
-    close = getattr(reader, 'close', None)
-    if callable(close):
-        close()
+logger = logging.getLogger(__name__)
 
 
 # ------------------------------------------------------------------------------