add util.ensure_dir for quick and easy creation of work directories

Author: soxofaan

openeo/util.py

@@ -5,6 +5,7 @@
 import re
 from datetime import datetime, date
 from typing import Any, Union, Tuple, Callable
+from pathlib import Path
 
 _rfc3339_date_format = re.compile(r'\d{4}-\d{2}-\d{2}')
 
@@ -34,6 +35,15 @@ def first_not_none(*args):
     raise ValueError("No not-None values given.")
 
 
+def ensure_dir(path: Union[str, Path]) -> Path:
+    """Create directory if it doesn't exist."""
+    path = Path(path)
+    if not path.exists():
+        path.mkdir(parents=True, exist_ok=True)
+    assert path.is_dir()
+    return path
+
+
 def ensure_list(x):
     """Convert given data structure to a list."""
     try:

tests/test_util.py

@@ -1,10 +1,12 @@
 import logging
+import os
+import pathlib
 import re
 from datetime import datetime
 
 import pytest
 
-from openeo.util import first_not_none, get_temporal_extent, TimingLogger, ensure_list
+from openeo.util import first_not_none, get_temporal_extent, TimingLogger, ensure_list, ensure_dir
 
 
 @pytest.mark.parametrize(['input', 'expected'], [
@@ -43,6 +45,27 @@ def test_ensure_list(input, expected):
     assert ensure_list(input) == expected
 
 
+def test_ensure_dir_str(tmp_path):
+    work_dir = str(tmp_path / "work/data/foo")
+    assert not os.path.exists(work_dir)
+    p = ensure_dir(work_dir)
+    assert os.path.exists(work_dir)
+    assert isinstance(p, pathlib.Path)
+    assert p.exists()
+    assert str(p) == str(work_dir)
+
+
+def test_ensure_dir_pathlib(tmp_path):
+    # Note: tmp_path might be pathlib2
+    work_dir = pathlib.Path(str(tmp_path / "work/data/foo"))
+    assert not work_dir.exists()
+    p = ensure_dir(work_dir)
+    assert work_dir.exists()
+    assert isinstance(p, pathlib.Path)
+    assert p.exists()
+    assert str(p) == str(work_dir)
+
+
 def test_get_temporal_extent():
     assert get_temporal_extent("2019-03-15") == ("2019-03-15", None)
     assert get_temporal_extent("2019-03-15", "2019-10-11") == ("2019-03-15", "2019-10-11")