feat: Add XDG base directory support for cache path - Default cache dir now respects - Falls back to ~/.cachier/ if not set - Updated Params and set_global_params to support dynamic cache_dir - Added tests for XDG compliance and fallback behavior

Author: habib049

src/cachier/config.py

@@ -2,7 +2,7 @@
 import os
 import pickle
 import threading
-from dataclasses import dataclass, replace
+from dataclasses import dataclass, field
 from datetime import datetime, timedelta
 from typing import Any, Optional, Union
 
@@ -18,6 +18,19 @@ def _default_hash_func(args, kwds):
     return hashlib.sha256(serialized).hexdigest()
 
 
+def _default_cache_dir():
+    """Return default cache directory based on XDG specification.
+
+    Uses $XDG_CACHE_HOME if defined, otherwise falls back to ~/.cachier/
+    """
+    xdg_cache_home = os.environ.get("XDG_CACHE_HOME")
+    if xdg_cache_home:
+        # Use XDG-compliant cache directory
+        return os.path.join(xdg_cache_home, "cachier")
+    # Default fallback if XDG is not set
+    return os.path.expanduser("~/.cachier/")
+
+
 @dataclass
 class Params:
     """Default definition for cachier parameters."""
@@ -28,12 +41,24 @@ class Params:
     mongetter: Optional[Mongetter] = None
     stale_after: timedelta = timedelta.max
     next_time: bool = False
-    cache_dir: Union[str, os.PathLike] = "~/.cachier/"
+    _cache_dir: Union[str, os.PathLike] = field(default_factory=_default_cache_dir)
     pickle_reload: bool = True
     separate_files: bool = False
     wait_for_calc_timeout: int = 0
     allow_none: bool = False
 
+    @property
+    def cache_dir(self) -> Union[str, os.PathLike]:
+        """Dynamically get the cache directory, respecting XDG_CACHE_HOME."""
+        default_cache = os.path.expanduser("~/.cachier/")
+        if self._cache_dir == _default_cache_dir or self._cache_dir == default_cache:
+            return _default_cache_dir()
+        return self._cache_dir
+
+    @cache_dir.setter
+    def cache_dir(self, value: Union[str, os.PathLike]):
+        self._cache_dir = value
+
 
 _global_params = Params()
 
@@ -91,17 +116,9 @@ def set_global_params(**params: Any) -> None:
     only have an effect on decorators applied after this function is run.
 
     """
-    import cachier
-
-    valid_params = {
-        k: v
-        for k, v in params.items()
-        if hasattr(cachier.config._global_params, k)
-    }
-    cachier.config._global_params = replace(
-        cachier.config._global_params,
-        **valid_params,  # type: ignore[arg-type]
-    )
+    valid_params = {k: v for k, v in params.items() if hasattr(_global_params, k)}
+    for k, v in valid_params.items():
+        setattr(_global_params, k, v)
 
 
 def get_default_params() -> Params:

tests/test_defaults.py

@@ -97,6 +97,36 @@ def global_test_2():
     assert global_test_2.cache_dpath() == str(tmpdir / "2")
 
 
+def test_cache_dir_respects_xdg(monkeypatch, tmpdir):
+    xdg_path = str(tmpdir / "xdg_home")
+    monkeypatch.setenv("XDG_CACHE_HOME", xdg_path)
+
+    expected_path = os.path.join(xdg_path, "cachier")
+
+    @cachier.cachier(backend="pickle")
+    def my_func():
+        return 123
+
+    actual_path = my_func.cache_dpath()
+    assert str(actual_path) == expected_path
+
+    my_func()  # Create cache file
+    assert os.path.exists(expected_path)
+    files = os.listdir(expected_path) if os.path.exists(expected_path) else []
+    assert any(os.path.isfile(os.path.join(expected_path, f)) for f in files)
+
+
+def test_cache_dir_default_fallback(monkeypatch):
+    monkeypatch.delenv("XDG_CACHE_HOME", raising=False)
+
+    @cachier.cachier()
+    def my_func():
+        return 123
+
+    expected_path = os.path.expanduser("~/.cachier/")
+    assert my_func.cache_dpath().startswith(expected_path)
+
+
 def test_separate_files_default_param(tmpdir):
     cachier.set_global_params(separate_files=True)
 
@@ -277,17 +307,17 @@ def dummy_func(a, b=2):
     dummy_func.clear_cache()
     assert count == 0
     with pytest.deprecated_call(
-        match="`verbose_cache` is deprecated and will be removed"
+            match="`verbose_cache` is deprecated and will be removed"
     ):
         assert dummy_func(1, verbose_cache=True) == 3
     assert count == 1
     with pytest.deprecated_call(
-        match="`ignore_cache` is deprecated and will be removed"
+            match="`ignore_cache` is deprecated and will be removed"
     ):
         assert dummy_func(1, ignore_cache=True) == 3
     assert count == 2
     with pytest.deprecated_call(
-        match="`overwrite_cache` is deprecated and will be removed"
+            match="`overwrite_cache` is deprecated and will be removed"
     ):
         assert dummy_func(1, overwrite_cache=True) == 3
     assert count == 3