Skip to content

cache

Private Methods

Private methods, if any (those starting with _), are documented for completeness but do not offer any stability guarantees. They may change or be removed at any time without notice.

Polytropos cache management.

This module handles the Polytropos cache directory, including cleanup of stale editable symlinks and full cache eviction via gc.

Defaults to /var/cache/polytropos/ when the process has write access to it, $XDG_CACHE_HOME/polytropos/ otherwise, or ~/.cache/polytropos/ as fallback.

Remove broken symlinks and empty dirs from the editable cache base.

Source code in src/polytropos/cache.py 
58
59
60
61
62
63
64
65
66
67
68
69
def _cleanup_stale_symlinks(cache_base: Path) -> None:
    """Remove broken symlinks and empty dirs from the editable cache base."""
    for entry in cache_base.iterdir():
        if not entry.is_dir() or entry.name.startswith("."):
            continue
        addons_dir = entry / "odoo" / "addons"
        if not addons_dir.is_dir():
            continue
        for file in addons_dir.iterdir():
            if file.is_symlink() and not file.exists():
                shutil.rmtree(entry)
                break

_get_editable_cache_base()

Get the base directory for editable install symlinks.

Resolution order: 1. POLYTROPOS_CACHE_DIR/editable/ (if POLYTROPOS_CACHE_DIR is set) 2. /var/cache/polytropos/editable/ (when writable) 3. XDG_CACHE_HOME/polytropos/editable/ (default) 4. ~/.cache/polytropos/editable/ (fallback)

Source code in src/polytropos/cache.py 
46
47
48
49
50
51
52
53
54
55
def _get_editable_cache_base() -> Path:
    """Get the base directory for editable install symlinks.

    Resolution order:
    1. ``POLYTROPOS_CACHE_DIR/editable/`` (if ``POLYTROPOS_CACHE_DIR`` is set)
    2. ``/var/cache/polytropos/editable/`` (when writable)
    3. ``XDG_CACHE_HOME/polytropos/editable/`` (default)
    4. ``~/.cache/polytropos/editable/`` (fallback)
    """
    return _get_polytropos_cache_dir() / "editable"

_get_polytropos_cache_dir()

Get the root Polytropos cache directory.

Resolution order: 1. POLYTROPOS_CACHE_DIR env var (explicit override) 2. /var/cache/polytropos/ (when writable — tries to create it) 3. XDG_CACHE_HOME/polytropos/ (default) 4. ~/.cache/polytropos/ (fallback)

Source code in src/polytropos/cache.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def _get_polytropos_cache_dir() -> Path:
    """Get the root Polytropos cache directory.

    Resolution order:
    1. ``POLYTROPOS_CACHE_DIR`` env var (explicit override)
    2. ``/var/cache/polytropos/`` (when writable — tries to create it)
    3. ``XDG_CACHE_HOME/polytropos/`` (default)
    4. ``~/.cache/polytropos/`` (fallback)
    """
    env_dir = os.environ.get("POLYTROPOS_CACHE_DIR")
    if env_dir:
        return Path(env_dir)
    var_cache = Path("/var/cache/polytropos")
    try:
        var_cache.mkdir(parents=True, exist_ok=True)
    except OSError:
        pass
    else:
        if os.access(str(var_cache), os.W_OK):
            return var_cache
    xdg_cache = os.environ.get("XDG_CACHE_HOME")
    if xdg_cache:
        return Path(xdg_cache) / "polytropos"
    return Path.home() / ".cache" / "polytropos"

_maybe_cleanup_stale_editables()

Remove broken symlinks from the editable cache, at most once per hour.

A marker file .last_cleanup stores the ISO 8601 timestamp of the last run. If the file is missing or older than 1 hour, scan all subdirectories of the editable cache base and remove broken symlinks (and empty parent dirs).

Source code in src/polytropos/cache.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def _maybe_cleanup_stale_editables() -> None:
    """Remove broken symlinks from the editable cache, at most once per hour.

    A marker file ``.last_cleanup`` stores the ISO 8601 timestamp of the last run.
    If the file is missing or older than 1 hour, scan all subdirectories of the
    editable cache base and remove broken symlinks (and empty parent dirs).
    """
    if os.environ.get("POLYTROPOS_EDITABLE_IN_SOURCE"):
        return
    cache_base = _get_editable_cache_base()
    marker = cache_base / ".last_cleanup"
    try:
        cache_base.mkdir(parents=True, exist_ok=True)
    except OSError:
        return
    now = time.time()
    try:
        last = datetime.fromisoformat(marker.read_text().strip()).timestamp()
    except (OSError, ValueError):
        last = 0.0
    if now - last < 3600:
        return
    marker.write_text(datetime.fromtimestamp(now).isoformat(timespec="seconds"))
    _cleanup_stale_symlinks(cache_base)

gc(full=False)

Garbage-collect the Polytropos cache.

See :func:_get_polytropos_cache_dir for the default cache directory resolution order.

Parameters:

Name Type Description Default
full bool

If True, delete the entire Polytropos cache directory. Otherwise, only remove broken symlinks from the editable cache.

 False
Source code in src/polytropos/cache.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def gc(full: bool = False) -> None:
    """Garbage-collect the Polytropos cache.

    See :func:`_get_polytropos_cache_dir` for the default cache directory
    resolution order.

    Args:
        full: If True, delete the entire Polytropos cache directory.
              Otherwise, only remove broken symlinks from the editable cache.
    """
    if full:
        cache_dir = _get_polytropos_cache_dir()
        if cache_dir.exists():
            shutil.rmtree(cache_dir)
            logger.info("Deleted cache: %s", cache_dir)
        return
    _maybe_cleanup_stale_editables()