Skip to content

Cache

_cache

Cache directory management for povineq.

delete_cache()

Delete all cached HTTP responses.

Removes the entire cache directory and re-creates an empty one so subsequent calls can start fresh.

Example

import povineq povineq.delete_cache()

Source code in src/povineq/_cache.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def delete_cache() -> None:
    """Delete all cached HTTP responses.

    Removes the entire cache directory and re-creates an empty one so
    subsequent calls can start fresh.

    Example:
        >>> import povineq
        >>> povineq.delete_cache()
    """
    cache_path = _cache_dir()
    cached = list(cache_path.iterdir())
    if not cached:
        logger.info("Cache is empty. Nothing to delete.")
        return

    shutil.rmtree(cache_path)
    # Reset the lru_cache so the next call recreates the directory entry.
    if hasattr(_cache_dir, "cache_clear"):
        _cache_dir.cache_clear()
    cache_path.mkdir(parents=True, exist_ok=True)
    logger.info("All {} cached item(s) have been deleted.", len(cached))

get_cache_info()

Return statistics about the current HTTP response cache.

Returns:

Type Description
dict[str, object]

A dictionary with keys:
dict[str, object]
  • "path": absolute path to the cache directory.
dict[str, object]
  • "n_files": number of cached response files.
dict[str, object]
  • "total_bytes": total size of the cache in bytes.
Example

import povineq info = povineq.get_cache_info() print(info["n_files"])

Source code in src/povineq/_cache.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def get_cache_info() -> dict[str, object]:
    """Return statistics about the current HTTP response cache.

    Returns:
        A dictionary with keys:

        - ``"path"``: absolute path to the cache directory.
        - ``"n_files"``: number of cached response files.
        - ``"total_bytes"``: total size of the cache in bytes.

    Example:
        >>> import povineq
        >>> info = povineq.get_cache_info()
        >>> print(info["n_files"])
    """
    cache_path = _cache_dir()
    files = list(cache_path.rglob("*"))
    files = [f for f in files if f.is_file()]
    total_bytes = sum(f.stat().st_size for f in files)
    return {
        "path": str(cache_path),
        "n_files": len(files),
        "total_bytes": total_bytes,
    }