Skip to content

(fix) site_cache_dir() must return DVC_SITE_CACHE_DIR if it exists #10776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skshetry merged 3 commits into from
Jun 12, 2025
Merged

(fix) site_cache_dir() must return DVC_SITE_CACHE_DIR if it exists #10776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41a17ac
DVC_SITE_CACHE_DIR must be sent first, deal with platformdirs afterwards
rgoya Jun 12, 2025
07e88f8
Test should check default behaviour when no env var is set
rgoya Jun 12, 2025
86ea91c
Add test: site_cache_dir() must return the env var if set
rgoya Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions dvc/dirs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ def site_cache_dir():
from platformdirs import PlatformDirs
from platformdirs.unix import Unix

if dvc_site_cache_dir := os.getenv(env.DVC_SITE_CACHE_DIR):
return dvc_site_cache_dir

if issubclass(Unix, PlatformDirs):
# Return the cache directory shared by users, e.g. `/var/tmp/$appname`
# NOTE: platformdirs>=5 changed `site_cache_dir` to return /var/cache/$appname.
Expand All @@ -34,6 +37,4 @@ def site_cache_dir():
# In the future, consider migrating to a more secure directory.
return f"/var/tmp/{APPNAME}" # noqa: S108

return os.getenv(env.DVC_SITE_CACHE_DIR) or platformdirs.site_cache_dir(
APPNAME, APPAUTHOR, opinion=True
)
return platformdirs.site_cache_dir(APPNAME, APPAUTHOR, opinion=True)
10 changes: 8 additions & 2 deletions tests/unit/test_dirs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import pytest

from dvc.dirs import global_config_dir, site_cache_dir
from dvc.env import DVC_GLOBAL_CONFIG_DIR
from dvc.env import DVC_GLOBAL_CONFIG_DIR, DVC_SITE_CACHE_DIR


def test_global_config_dir_respects_env_var(monkeypatch):
Expand All @@ -13,5 +13,11 @@ def test_global_config_dir_respects_env_var(monkeypatch):


@pytest.mark.skipif(sys.platform != "linux", reason="Only for Unix platforms")
def test_site_cache_dir_on_unix():
def test_site_cache_dir_on_unix(monkeypatch):
monkeypatch.delenv(DVC_SITE_CACHE_DIR, raising=False)
assert site_cache_dir() == "/var/tmp/dvc"


def test_site_cache_dir_env_var(monkeypatch):
monkeypatch.setenv(DVC_SITE_CACHE_DIR, "foo_bar")
assert site_cache_dir() == "foo_bar"