1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
from __future__ import annotations
import os
import sys
from pathlib import Path
from typing import TYPE_CHECKING, Any
import pytest
from platformdirs.macos import MacOS
if TYPE_CHECKING:
from pytest_mock import MockerFixture
_XDG_ENV_VARS = (
"XDG_DATA_HOME",
"XDG_DATA_DIRS",
"XDG_CONFIG_HOME",
"XDG_CONFIG_DIRS",
"XDG_CACHE_HOME",
"XDG_STATE_HOME",
"XDG_RUNTIME_DIR",
"XDG_DOCUMENTS_DIR",
"XDG_DOWNLOAD_DIR",
"XDG_PICTURES_DIR",
"XDG_VIDEOS_DIR",
"XDG_MUSIC_DIR",
"XDG_DESKTOP_DIR",
)
@pytest.fixture(autouse=True)
def _fix_os_pathsep(mocker: MockerFixture) -> None:
"""If we're not running on macOS, set `os.pathsep` to what it should be on macOS."""
if sys.platform != "darwin": # pragma: darwin no cover
mocker.patch("os.pathsep", ":")
mocker.patch("os.path.pathsep", ":")
@pytest.fixture
def _clear_xdg_env(monkeypatch: pytest.MonkeyPatch) -> None:
for var in _XDG_ENV_VARS:
monkeypatch.delenv(var, raising=False)
@pytest.mark.parametrize(
"params",
[
pytest.param({}, id="no_args"),
pytest.param({"appname": "foo"}, id="app_name"),
pytest.param({"appname": "foo", "version": "v1.0"}, id="app_name_version"),
],
)
@pytest.mark.usefixtures("_clear_xdg_env")
def test_macos(mocker: MockerFixture, params: dict[str, Any], func: str) -> None:
py_version = sys.version_info
builtin_py_prefix = (
"/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework"
f"/Versions/{py_version.major}.{py_version.minor}"
)
mocker.patch("sys.prefix", builtin_py_prefix)
result = getattr(MacOS(**params), func)
home = str(Path("~").expanduser())
suffix_elements = tuple(params[i] for i in ("appname", "version") if i in params)
suffix = os.sep.join(("", *suffix_elements)) if suffix_elements else "" # noqa: PTH118
expected_map = {
"user_data_dir": f"{home}/Library/Application Support{suffix}",
"site_data_dir": f"/Library/Application Support{suffix}",
"user_config_dir": f"{home}/Library/Application Support{suffix}",
"site_config_dir": f"/Library/Application Support{suffix}",
"user_cache_dir": f"{home}/Library/Caches{suffix}",
"site_cache_dir": f"/Library/Caches{suffix}",
"user_state_dir": f"{home}/Library/Application Support{suffix}",
"site_state_dir": f"/Library/Application Support{suffix}",
"user_log_dir": f"{home}/Library/Logs{suffix}",
"site_log_dir": f"/Library/Logs{suffix}",
"user_documents_dir": f"{home}/Documents",
"user_downloads_dir": f"{home}/Downloads",
"user_pictures_dir": f"{home}/Pictures",
"user_videos_dir": f"{home}/Movies",
"user_music_dir": f"{home}/Music",
"user_desktop_dir": f"{home}/Desktop",
"user_bin_dir": f"{home}/.local/bin",
"site_bin_dir": "/usr/local/bin",
"user_applications_dir": f"{home}/Applications",
"site_applications_dir": "/Applications",
"user_runtime_dir": f"{home}/Library/Caches/TemporaryItems{suffix}",
"site_runtime_dir": f"{home}/Library/Caches/TemporaryItems{suffix}",
}
expected = expected_map[func]
assert result == expected
@pytest.mark.parametrize(
"params",
[
pytest.param({}, id="no_args"),
pytest.param({"appname": "foo"}, id="app_name"),
pytest.param({"appname": "foo", "version": "v1.0"}, id="app_name_version"),
],
)
@pytest.mark.parametrize(
"site_func",
[
"site_data_dir",
"site_config_dir",
"site_cache_dir",
"site_runtime_dir",
"site_cache_path",
"site_data_path",
],
)
@pytest.mark.parametrize("multipath", [pytest.param(True, id="multipath"), pytest.param(False, id="singlepath")])
@pytest.mark.usefixtures("_clear_xdg_env")
def test_macos_homebrew(mocker: MockerFixture, params: dict[str, Any], multipath: bool, site_func: str) -> None:
test_data = [
{
"sys_prefix": "/opt/homebrew/opt/python@3.13/Frameworks/Python.framework/Versions/3.13",
"homebrew_prefix": "/opt/homebrew",
},
{
"sys_prefix": "/usr/local/opt/python@3.13/Frameworks/Python.framework/Versions/3.13",
"homebrew_prefix": "/usr/local",
},
{
"sys_prefix": "/myown/arbitrary/prefix/opt/python@3.13/Frameworks/Python.framework/Versions/3.13",
"homebrew_prefix": "/myown/arbitrary/prefix",
},
]
for prefix in test_data:
mocker.patch("sys.prefix", prefix["sys_prefix"])
result = getattr(MacOS(multipath=multipath, **params), site_func)
home = str(Path("~").expanduser())
suffix_elements = tuple(params[i] for i in ("appname", "version") if i in params)
suffix = os.sep.join(("", *suffix_elements)) if suffix_elements else "" # noqa: PTH118
expected_path_map = {
"site_cache_path": Path(f"{prefix['homebrew_prefix']}/var/cache{suffix}"),
"site_data_path": Path(f"{prefix['homebrew_prefix']}/share{suffix}"),
}
expected_map = {
"site_data_dir": f"{prefix['homebrew_prefix']}/share{suffix}",
"site_config_dir": f"{prefix['homebrew_prefix']}/share{suffix}",
"site_cache_dir": f"{prefix['homebrew_prefix']}/var/cache{suffix}",
"site_runtime_dir": f"{home}/Library/Caches/TemporaryItems{suffix}",
}
if multipath:
expected_map["site_data_dir"] += f":/Library/Application Support{suffix}"
expected_map["site_config_dir"] += f":/Library/Application Support{suffix}"
expected_map["site_cache_dir"] += f":/Library/Caches{suffix}"
expected = expected_path_map[site_func] if site_func.endswith("_path") else expected_map[site_func]
assert result == expected
@pytest.mark.parametrize(
("env_var", "prop", "xdg_path"),
[
pytest.param("XDG_DATA_HOME", "user_data_dir", "/custom/data", id="user_data_dir"),
pytest.param("XDG_CONFIG_HOME", "user_config_dir", "/custom/config", id="user_config_dir"),
pytest.param("XDG_CACHE_HOME", "user_cache_dir", "/custom/cache", id="user_cache_dir"),
pytest.param("XDG_STATE_HOME", "user_state_dir", "/custom/state", id="user_state_dir"),
pytest.param("XDG_RUNTIME_DIR", "user_runtime_dir", "/custom/runtime", id="user_runtime_dir"),
pytest.param("XDG_RUNTIME_DIR", "site_runtime_dir", "/custom/runtime", id="site_runtime_dir"),
],
)
@pytest.mark.parametrize(
"params",
[
pytest.param({}, id="no_args"),
pytest.param({"appname": "foo"}, id="app_name"),
pytest.param({"appname": "foo", "version": "v1.0"}, id="app_name_version"),
],
)
def test_macos_xdg_env_vars(
monkeypatch: pytest.MonkeyPatch,
env_var: str,
prop: str,
xdg_path: str,
params: dict[str, Any],
) -> None:
monkeypatch.setenv(env_var, xdg_path)
result = getattr(MacOS(**params), prop)
suffix_elements = tuple(params[i] for i in ("appname", "version") if i in params)
suffix = os.sep.join(("", *suffix_elements)) if suffix_elements else "" # noqa: PTH118
assert result == f"{xdg_path}{suffix}"
@pytest.mark.parametrize(
("env_var", "prop"),
[
pytest.param("XDG_DATA_DIRS", "site_data_dir", id="site_data_dir"),
pytest.param("XDG_CONFIG_DIRS", "site_config_dir", id="site_config_dir"),
],
)
@pytest.mark.parametrize("multipath", [pytest.param(True, id="multipath"), pytest.param(False, id="singlepath")])
def test_macos_xdg_site_dirs(
monkeypatch: pytest.MonkeyPatch,
env_var: str,
prop: str,
multipath: bool,
) -> None:
monkeypatch.setenv(env_var, "/custom/first:/custom/second")
result = getattr(MacOS(multipath=multipath), prop)
if multipath:
assert result == "/custom/first:/custom/second"
else:
assert result == "/custom/first"
@pytest.mark.parametrize(
("env_var", "prop"),
[
pytest.param("XDG_DOCUMENTS_DIR", "user_documents_dir", id="user_documents_dir"),
pytest.param("XDG_DOWNLOAD_DIR", "user_downloads_dir", id="user_downloads_dir"),
pytest.param("XDG_PICTURES_DIR", "user_pictures_dir", id="user_pictures_dir"),
pytest.param("XDG_VIDEOS_DIR", "user_videos_dir", id="user_videos_dir"),
pytest.param("XDG_MUSIC_DIR", "user_music_dir", id="user_music_dir"),
pytest.param("XDG_DESKTOP_DIR", "user_desktop_dir", id="user_desktop_dir"),
],
)
def test_macos_xdg_media_dirs(monkeypatch: pytest.MonkeyPatch, env_var: str, prop: str) -> None:
monkeypatch.setenv(env_var, "/custom/media")
assert getattr(MacOS(), prop) == "/custom/media"
@pytest.mark.parametrize(
("env_var", "prop"),
[
pytest.param("XDG_DATA_HOME", "user_data_dir", id="user_data_dir"),
pytest.param("XDG_CONFIG_HOME", "user_config_dir", id="user_config_dir"),
pytest.param("XDG_CACHE_HOME", "user_cache_dir", id="user_cache_dir"),
pytest.param("XDG_STATE_HOME", "user_state_dir", id="user_state_dir"),
pytest.param("XDG_RUNTIME_DIR", "user_runtime_dir", id="user_runtime_dir"),
pytest.param("XDG_DOCUMENTS_DIR", "user_documents_dir", id="user_documents_dir"),
pytest.param("XDG_DOWNLOAD_DIR", "user_downloads_dir", id="user_downloads_dir"),
pytest.param("XDG_PICTURES_DIR", "user_pictures_dir", id="user_pictures_dir"),
pytest.param("XDG_VIDEOS_DIR", "user_videos_dir", id="user_videos_dir"),
pytest.param("XDG_MUSIC_DIR", "user_music_dir", id="user_music_dir"),
pytest.param("XDG_DESKTOP_DIR", "user_desktop_dir", id="user_desktop_dir"),
],
)
@pytest.mark.usefixtures("_clear_xdg_env")
def test_macos_xdg_empty_falls_back(
monkeypatch: pytest.MonkeyPatch, mocker: MockerFixture, env_var: str, prop: str
) -> None:
py_version = sys.version_info
builtin_py_prefix = (
"/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework"
f"/Versions/{py_version.major}.{py_version.minor}"
)
mocker.patch("sys.prefix", builtin_py_prefix)
monkeypatch.setenv(env_var, "")
home = str(Path("~").expanduser())
expected_map = {
"user_data_dir": f"{home}/Library/Application Support",
"user_config_dir": f"{home}/Library/Application Support",
"user_cache_dir": f"{home}/Library/Caches",
"user_state_dir": f"{home}/Library/Application Support",
"user_runtime_dir": f"{home}/Library/Caches/TemporaryItems",
"user_documents_dir": f"{home}/Documents",
"user_downloads_dir": f"{home}/Downloads",
"user_pictures_dir": f"{home}/Pictures",
"user_videos_dir": f"{home}/Movies",
"user_music_dir": f"{home}/Music",
"user_desktop_dir": f"{home}/Desktop",
"user_bin_dir": f"{home}/.local/bin",
"site_bin_dir": "/usr/local/bin",
"user_applications_dir": f"{home}/Applications",
}
assert getattr(MacOS(), prop) == expected_map[prop]
def test_iter_data_dirs_xdg(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("XDG_DATA_HOME", "/xdg/data")
monkeypatch.setenv("XDG_DATA_DIRS", "/xdg/share1:/xdg/share2")
dirs = list(MacOS().iter_data_dirs())
assert dirs == ["/xdg/data", "/xdg/share1", "/xdg/share2"]
def test_iter_config_dirs_xdg(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("XDG_CONFIG_HOME", "/xdg/config")
monkeypatch.setenv("XDG_CONFIG_DIRS", "/xdg/etc1:/xdg/etc2")
dirs = list(MacOS().iter_config_dirs())
assert dirs == ["/xdg/config", "/xdg/etc1", "/xdg/etc2"]
@pytest.mark.usefixtures("_clear_xdg_env")
def test_iter_data_dirs_homebrew(mocker: MockerFixture) -> None:
mocker.patch("sys.prefix", "/opt/homebrew/opt/python@3.13/Frameworks/Python.framework/Versions/3.13")
dirs = list(MacOS().iter_data_dirs())
home = str(Path("~").expanduser())
assert dirs == [f"{home}/Library/Application Support", "/opt/homebrew/share", "/Library/Application Support"]
@pytest.mark.usefixtures("_clear_xdg_env")
def test_iter_config_dirs_homebrew(mocker: MockerFixture) -> None:
mocker.patch("sys.prefix", "/opt/homebrew/opt/python@3.13/Frameworks/Python.framework/Versions/3.13")
dirs = list(MacOS().iter_config_dirs())
home = str(Path("~").expanduser())
assert dirs == [f"{home}/Library/Application Support", "/opt/homebrew/share", "/Library/Application Support"]
@pytest.mark.usefixtures("_clear_xdg_env")
def test_iter_data_dirs_no_homebrew(mocker: MockerFixture) -> None:
py_version = sys.version_info
builtin_py_prefix = (
"/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework"
f"/Versions/{py_version.major}.{py_version.minor}"
)
mocker.patch("sys.prefix", builtin_py_prefix)
dirs = list(MacOS().iter_data_dirs())
home = str(Path("~").expanduser())
assert dirs == [f"{home}/Library/Application Support", "/Library/Application Support"]
|
