Refactor _resolve_glob to support directories and cleanup

Author: JoelLucaAdams

src/sdf_xarray/__init__.py

@@ -96,23 +96,19 @@ def _process_latex_name(variable_name: str) -> str:
     return variable_name
 
 
-def _resolve_glob(path_glob: PathLike | Iterable[PathLike]) -> list[Path]:
-    """Resolve an input path/glob to sorted absolute SDF file paths.
+def resolve_paths(path_glob: PathLike | Iterable[PathLike]) -> list[Path]:
+    """Resolve a path/glob to sorted absolute SDF file paths.
 
-    Accepts either a single path-like glob pattern (e.g. ``"*.sdf"``) or a
+    Accepts a directory, single path-like glob pattern (e.g. ``"normal_*.sdf"``) or a
     list of path-like file names.
     """
 
-    if isinstance(path_glob, PathLike):
+    # Attempt to load directory or glob
+    try:
         p = Path(path_glob)
-        if p.is_dir():
-            raise TypeError(
-                "Directory paths are not supported; pass a glob pattern"
-                f"(e.g. {(p / '*.sdf').as_posix()}) or a list of file paths"
-                f"(e.g. {[(p / '0000.sdf').as_posix(), (p / '0001.sdf').as_posix()]})."
-            )
-        paths = list(p.parent.glob(p.name))
-    else:
+        paths = p.glob("*.sdf") if p.is_dir() else list(p.parent.glob(p.name))
+    # Otherwise assume the user has passed a list of file paths
+    except TypeError:
         paths = list({Path(p) for p in path_glob})
 
     resolved_paths = sorted(p.resolve() for p in paths)
@@ -121,9 +117,9 @@ def _resolve_glob(path_glob: PathLike | Iterable[PathLike]) -> list[Path]:
 
     for p in resolved_paths:
         if not p.is_file():
-            raise FileNotFoundError(f"{p.as_posix()} does not exist or is not a file.")
+            raise FileNotFoundError(f"{p.as_posix()} does not exist or is not a file")
         if p.suffix.lower() != ".sdf":
-            raise FileNotFoundError(f"{p.as_posix()} is not an SDF file.")
+            raise FileNotFoundError(f"{p.as_posix()} is not an SDF file")
     return resolved_paths
 
 
@@ -340,7 +336,7 @@ def open_mfdataset(
         from a relative or absolute file path. See :ref:`loading-input-deck` for details.
     """
 
-    paths = _resolve_glob(paths)
+    paths = resolve_paths(paths)
 
     if not separate_times:
         return combine_datasets(

tests/test_dataset.py

@@ -9,8 +9,8 @@
 from sdf_xarray import (
     SDFPreprocess,
     _process_latex_name,
-    _resolve_glob,
     download,
+    resolve_paths,
 )
 
 TEST_FILES_DIR = download.fetch_dataset("test_files_1D")
@@ -205,70 +205,95 @@ def test_multiple_files_multiple_time_dims():
         assert df["Absorption_Total_Laser_Energy_Injected"].shape == (11,)
 
 
-def test_resolve_glob_from_string_pattern():
+def test_resolve_paths_from_string_pattern():
     pattern = str(TEST_FILES_DIR / "*.sdf")
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = sorted(TEST_FILES_DIR.glob("*.sdf"))
     assert result == expected
 
 
-def test_resolve_glob_from_multiple_names_string_pattern(tmp_path):
+def test_resolve_paths_from_multiple_names_string_pattern(tmp_path):
     mock_test_files_dir = tmp_path
     (mock_test_files_dir / "normal_0000.sdf").touch()
     (mock_test_files_dir / "normal_0001.sdf").touch()
     (mock_test_files_dir / "other_0000.sdf").touch()
 
     pattern = str(mock_test_files_dir / "normal_*.sdf")
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = sorted(mock_test_files_dir.glob("normal_*.sdf"))
     assert result == expected
 
 
-def test_resolve_glob_from_path_glob():
+def test_resolve_paths_from_path_glob():
     pattern = TEST_FILES_DIR.glob("*.sdf")
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = sorted(TEST_FILES_DIR.glob("*.sdf"))
     assert result == expected
 
 
-def test_resolve_glob_from_path_missing_glob():
+def test_resolve_paths_from_directory_path():
     pattern = TEST_FILES_DIR
-    with pytest.raises(TypeError):
-        _resolve_glob(pattern)
+    result = resolve_paths(pattern)
+    expected = sorted(TEST_FILES_DIR.glob("*.sdf"))
+    assert result == expected
 
 
-def test_resolve_glob_from_path_list():
+def test_resolve_paths_from_path_list():
     pattern = [TEST_FILES_DIR / "0000.sdf"]
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = [TEST_FILES_DIR / "0000.sdf"]
     assert result == expected
 
 
-def test_resolve_glob_from_path_list_multiple():
+def test_resolve_paths_from_missing_file():
+    pattern = ["/test/0000.sdf"]
+    with pytest.raises(FileNotFoundError):
+        resolve_paths(pattern)
+
+
+def test_resolve_paths_from_non_sdf_file():
+    pattern = [TEST_FILES_DIR / "input.deck"]
+    with pytest.raises(FileNotFoundError):
+        resolve_paths(pattern)
+
+
+def test_resolve_paths_from_path_list_multiple():
     pattern = [TEST_FILES_DIR / "0000.sdf", TEST_FILES_DIR / "0001.sdf"]
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = [TEST_FILES_DIR / "0000.sdf", TEST_FILES_DIR / "0001.sdf"]
     assert result == expected
 
 
-def test_resolve_glob_from_path_list_multiple_unordered():
+def test_resolve_paths_from_path_list_multiple_unordered():
     pattern = [TEST_FILES_DIR / "0001.sdf", TEST_FILES_DIR / "0000.sdf"]
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = [TEST_FILES_DIR / "0000.sdf", TEST_FILES_DIR / "0001.sdf"]
     assert result == expected
 
 
-def test_resolve_glob_from_path_list_multiple_duplicates():
+def test_resolve_paths_from_path_list_multiple_duplicates():
     pattern = [
         TEST_FILES_DIR / "0000.sdf",
         TEST_FILES_DIR / "0000.sdf",
         TEST_FILES_DIR / "0001.sdf",
     ]
-    result = _resolve_glob(pattern)
+    result = resolve_paths(pattern)
     expected = [TEST_FILES_DIR / "0000.sdf", TEST_FILES_DIR / "0001.sdf"]
     assert result == expected
 
 
+def test_resolve_paths_from_path_list_missing_files():
+    pattern = [TEST_FILES_DIR / "0000.sdf", "/test/0000.sdf"]
+    with pytest.raises(FileNotFoundError):
+        resolve_paths(pattern)
+
+
+def test_resolve_paths_from_path_list_non_sdf_files():
+    pattern = [TEST_FILES_DIR / "0000.sdf", TEST_FILES_DIR / "input.deck"]
+    with pytest.raises(FileNotFoundError):
+        resolve_paths(pattern)
+
+
 @pytest.mark.parametrize(
     ("xrlib", "params"),
     [