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
|
"""Test the caching functionality."""
from __future__ import annotations
import sys
import types
from collections.abc import Hashable
from pathlib import Path
from typing import Any, cast
from unittest.mock import Mock
import pytest
import tldextract.cache
from tldextract.cache import DiskCache, get_cache_dir, get_pkg_unique_identifier
def test_disk_cache(tmp_path: Path) -> None:
"""Test DiskCache class basic use."""
cache = DiskCache(str(tmp_path))
cache.set("testing", "foo", "bar")
assert cache.get("testing", "foo") == "bar"
cache.clear()
with pytest.raises(KeyError):
cache.get("testing", "foo")
cache.set("testing", "foo", "baz")
assert cache.get("testing", "foo") == "baz"
def test_get_pkg_unique_identifier(monkeypatch: pytest.MonkeyPatch) -> None:
"""Test generating a unique identifier for the version of this package."""
monkeypatch.setattr(sys, "version_info", (3, 8, 1, "final", 0))
monkeypatch.setattr(sys, "prefix", "/home/john/.pyenv/versions/myvirtualenv")
mock_version_module = types.ModuleType("tldextract._version", "mocked module")
cast(Any, mock_version_module).version = "1.2.3"
monkeypatch.setitem(sys.modules, "tldextract._version", mock_version_module)
assert (
get_pkg_unique_identifier()
== "3.8.1.final__myvirtualenv__f01a7b__tldextract-1.2.3"
)
def test_get_cache_dir(monkeypatch: pytest.MonkeyPatch) -> None:
"""Test finding the cache directory."""
pkg_identifier = "3.8.1.final__myvirtualenv__f01a7b__tldextract-1.2.3"
monkeypatch.setattr(
tldextract.cache, "get_pkg_unique_identifier", lambda: pkg_identifier
)
# with no HOME set, fallback to attempting to use package directory itself
monkeypatch.delenv("HOME", raising=False)
monkeypatch.delenv("XDG_CACHE_HOME", raising=False)
monkeypatch.delenv("TLDEXTRACT_CACHE", raising=False)
assert get_cache_dir().endswith(str(Path("tldextract", ".suffix_cache")))
# with home set, but not anything else specified, use XDG_CACHE_HOME default
monkeypatch.setenv("HOME", "/home/john")
monkeypatch.delenv("XDG_CACHE_HOME", raising=False)
monkeypatch.delenv("TLDEXTRACT_CACHE", raising=False)
assert get_cache_dir() == str(
Path("/home/john", ".cache/python-tldextract", pkg_identifier)
)
# if XDG_CACHE_HOME is set, use it
monkeypatch.setenv("HOME", "/home/john")
monkeypatch.setenv("XDG_CACHE_HOME", "/my/alt/cache")
monkeypatch.delenv("TLDEXTRACT_CACHE", raising=False)
assert get_cache_dir() == str(
Path("/my/alt/cache/python-tldextract", pkg_identifier)
)
# if TLDEXTRACT_CACHE is set, use it
monkeypatch.setenv("HOME", "/home/john")
monkeypatch.setenv("XDG_CACHE_HOME", "/my/alt/cache")
monkeypatch.setenv("TLDEXTRACT_CACHE", "/alt-tld-cache")
assert get_cache_dir() == "/alt-tld-cache"
def test_run_and_cache(tmp_path: Path) -> None:
"""Test cache hits and misses.
Repeated cache requests with the same arguments should hit the cache and
not increment the call count of the underlying function.
"""
cache = DiskCache(str(tmp_path))
return_value1 = "unique return value"
some_fn = Mock(return_value=return_value1)
kwargs1: dict[str, Hashable] = {"value": 1}
assert some_fn.call_count == 0
call1 = cache.run_and_cache(some_fn, "test_namespace", kwargs1, kwargs1.keys())
assert call1 == return_value1
assert some_fn.call_count == 1
call2 = cache.run_and_cache(some_fn, "test_namespace", kwargs1, kwargs1.keys())
assert call2 == return_value1
assert some_fn.call_count == 1
kwargs2: dict[str, Hashable] = {"value": 2}
return_value2 = "another return value"
some_fn.return_value = return_value2
call3 = cache.run_and_cache(some_fn, "test_namespace", kwargs2, kwargs2.keys())
assert call3 == return_value2
assert some_fn.call_count == 2
|
