junifer 0.0.6.dev213__tar.gz → 0.0.6.dev219__tar.gz

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: junifer
-Version: 0.0.6.dev213
+Version: 0.0.6.dev219
 Summary: JUelich NeuroImaging FEature extractoR
 Author-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>
 Maintainer-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>

junifer-0.0.6.dev219/docs/changes/newsfragments/389.enh

@@ -0,0 +1 @@
+Add a ``cleanup`` parameter to the :class:`junifer.pipeline.WorkDirManager`, which allows to disable cleaning up temporary directories by `Fede Raimondo`_

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/junifer/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.6.dev213'
-__version_tuple__ = version_tuple = (0, 0, 6, 'dev213')
+__version__ = version = '0.0.6.dev219'
+__version_tuple__ = version_tuple = (0, 0, 6, 'dev219')

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/junifer/pipeline/tests/test_workdir_manager.py

@@ -102,3 +102,45 @@ def test_workdir_manager_get_and_delete_tempdir(tmp_path: Path) -> None:
     workdir_mgr._cleanup()
     # Should remove temporary directory
     assert workdir_mgr.root_tempdir is None
+
+def test_workdir_manager_no_cleanup(tmp_path: Path) -> None:
+    """Test WorkDirManager correctly bypasses cleanup.
+
+    Parameters
+    ----------
+    tmp_path : pathlib.Path
+        The path to the test directory.
+
+    """
+    workdir_mgr = WorkDirManager(cleanup=False)
+    workdir_mgr.workdir = tmp_path
+    # Check no root temporary directory
+    assert workdir_mgr.root_tempdir is None
+
+    tempdir = workdir_mgr.get_tempdir()
+    assert tempdir.exists()
+    # Should create a temporary directory
+    assert workdir_mgr.root_tempdir is not None
+
+    workdir_mgr.delete_tempdir(tempdir)
+    workdir_mgr._cleanup()
+
+    # Should remove temporary directory
+    assert workdir_mgr.root_tempdir is None
+    # But the temporary directory should still exist
+    assert tempdir.exists()
+
+    # Now the same but for the element directory
+
+    # Check no element directory
+    assert workdir_mgr.elementdir is None
+
+    tempdir = workdir_mgr.get_element_tempdir()
+    # Should create a temporary directory
+    assert workdir_mgr.elementdir is not None
+
+    workdir_mgr.cleanup_elementdir()
+    # Should remove temporary directory
+    assert workdir_mgr.elementdir is None
+    # But the temporary directory should still exist
+    assert tempdir.exists()

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/junifer/pipeline/workdir_manager.py

@@ -39,15 +39,20 @@ class WorkDirManager(metaclass=Singleton):
         The path to the element directory.
     root_tempdir : pathlib.Path or None
         The path to the root temporary directory.
+    cleanup : bool, optional
+        If False, the directories are not cleaned up after the object is
+        destroyed. This is useful for debugging purposes (default True).
 
     """
 
-    def __init__(self, workdir: Optional[Union[str, Path]] = None) -> None:
+    def __init__(
+        self, workdir: Optional[Union[str, Path]] = None, cleanup=True
+    ) -> None:
         """Initialize the class."""
         self._workdir = Path(workdir) if isinstance(workdir, str) else workdir
         self._elementdir = None
         self._root_tempdir = None
-
+        self._cleanup_dirs = cleanup
         self._set_default_workdir()
 
     def _set_default_workdir(self) -> None:
@@ -72,6 +77,9 @@ class WorkDirManager(metaclass=Singleton):
 
     def _cleanup(self) -> None:
         """Clean up the element and temporary directories."""
+        if self._cleanup_dirs is False:
+            self._root_tempdir = None
+            return
         # Remove element directory
         self.cleanup_elementdir()
         # Remove root temporary directory
@@ -171,6 +179,8 @@ class WorkDirManager(metaclass=Singleton):
             The temporary directory path to be deleted.
 
         """
+        if self._cleanup_dirs is False:
+            return
         logger.debug(f"Deleting element temporary directory at {tempdir}")
         shutil.rmtree(tempdir, ignore_errors=True)
 
@@ -182,6 +192,9 @@ class WorkDirManager(metaclass=Singleton):
         can lead to required intermediate files not being found.
 
         """
+        if self._cleanup_dirs is False:
+            self._elementdir = None
+            return
         if self._elementdir is not None:
             logger.debug(
                 "Deleting element directory at "
@@ -244,5 +257,7 @@ class WorkDirManager(metaclass=Singleton):
             The temporary directory path to be deleted.
 
         """
+        if self._cleanup_dirs is False:
+            return
         logger.debug(f"Deleting temporary directory at {tempdir}")
         shutil.rmtree(tempdir, ignore_errors=True)

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/junifer.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: junifer
-Version: 0.0.6.dev213
+Version: 0.0.6.dev219
 Summary: JUelich NeuroImaging FEature extractoR
 Author-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>
 Maintainer-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>

{junifer-0.0.6.dev213 → junifer-0.0.6.dev219}/junifer.egg-info/SOURCES.txt

@@ -87,6 +87,7 @@ docs/changes/newsfragments/384.misc
 docs/changes/newsfragments/386.bugfix
 docs/changes/newsfragments/387.change
 docs/changes/newsfragments/387.feature
+docs/changes/newsfragments/389.enh
 docs/changes/newsfragments/391.misc
 docs/extending/coordinates.rst
 docs/extending/datagrabber.rst