Add path_from helper context manager

Author: benoit74

src/zimscraperlib/filesystem.py

@@ -4,6 +4,9 @@
 
 import os
 import pathlib
+from contextlib import contextmanager
+from tempfile import TemporaryDirectory
+from typing import Any
 
 import magic
 
@@ -41,3 +44,20 @@ def delete_callback(fpath: str | pathlib.Path):
     """helper deleting passed filepath"""
 
     os.unlink(fpath)
+
+
+@contextmanager
+def path_from(path: pathlib.Path | TemporaryDirectory[Any] | str):
+    """Context manager to get a Path from a path as string, Path or TemporaryDirectory
+
+    Since scraperlib wants to manipulate only Path, scrapers might often needs this
+    to create a path from what they have, especially since TemporaryDirectory context
+    manager returns a string which is not really handy.
+    """
+    if isinstance(path, pathlib.Path):
+        yield path
+    elif isinstance(path, TemporaryDirectory):
+        with path as pathname:
+            yield pathlib.Path(pathname)
+    else:
+        yield pathlib.Path(path)

tests/filesystem/test_filesystem.py

@@ -1,4 +1,5 @@
 import pathlib
+from tempfile import TemporaryDirectory
 from typing import Any
 
 import magic
@@ -8,6 +9,7 @@
     delete_callback,
     get_content_mimetype,
     get_file_mimetype,
+    path_from,
 )
 
 
@@ -54,3 +56,42 @@ def test_delete_callback(tmp_path: pathlib.Path):
     delete_callback(fpath)
 
     assert not fpath.exists()
+
+
+def test_path_from_tmp_dir():
+    tempdir = TemporaryDirectory()
+    with path_from(tempdir) as tmp_dir:
+        file = tmp_dir / "file.txt"
+        file.touch()
+        assert file.exists()
+        assert pathlib.Path(tempdir.name).exists()
+
+    assert not pathlib.Path(tempdir.name).exists()
+
+
+def test_path_from_path():
+    tempdir = TemporaryDirectory()
+    tempdir_path = pathlib.Path(tempdir.name)
+    with path_from(tempdir_path) as tmp_dir:
+        file = tmp_dir / "file.txt"
+        file.touch()
+        assert file.exists()
+        assert pathlib.Path(tempdir.name).exists()
+
+    assert pathlib.Path(tempdir.name).exists()
+    tempdir.cleanup()
+    assert not pathlib.Path(tempdir.name).exists()
+
+
+def test_path_from_str():
+    tempdir = TemporaryDirectory()
+    tempdir_path = pathlib.Path(tempdir.name)
+    with path_from(str(tempdir_path)) as tmp_dir:
+        file = tmp_dir / "file.txt"
+        file.touch()
+        assert file.exists()
+        assert pathlib.Path(tempdir.name).exists()
+
+    assert pathlib.Path(tempdir.name).exists()
+    tempdir.cleanup()
+    assert not pathlib.Path(tempdir.name).exists()