Bypass cleanup of temporary dirs if needed

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/pipeline/workdir_manager.py

@@ -40,15 +40,20 @@ class WorkDirManager:
         The path to the element directory.
     root_tempdir : pathlib.Path or None
         The path to the root temporary directory.
+    cleanup : bool
+        If false, the directories are not cleaned up after the object is
+        destroyed. This is useful for debugging purposes. Default is 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:
@@ -73,6 +78,8 @@ def __del__(self) -> None:
 
     def _cleanup(self) -> None:
         """Clean up the element and temporary directories."""
+        if self._cleanup_dirs is False:
+            return
         # Remove element directory
         self.cleanup_elementdir()
         # Remove root temporary directory
@@ -172,6 +179,8 @@ def delete_element_tempdir(self, tempdir: Path) -> None:
             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)
 
@@ -183,6 +192,8 @@ def cleanup_elementdir(self) -> None:
         can lead to required intermediate files not being found.
 
         """
+        if self._cleanup_dirs is False:
+            return
         if self._elementdir is not None:
             logger.debug(
                 "Deleting element directory at "
@@ -245,5 +256,7 @@ def delete_tempdir(self, tempdir: Path) -> None:
             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)