stWDBRN/cache.py
Nathan Woodburn feba858628
All checks were successful
Build Docker / BuildImage (push) Successful in 31s
fix: Split line in string literal
2024-12-05 12:59:24 +11:00

83 lines
3.2 KiB
Python

import os
import json
import hashlib
import threading
from functools import wraps
from time import time, sleep
def file_cache(folder="cache", ttl=3600):
"""
Decorator to cache function results in the specified folder with a TTL.
Args:
folder (str): Directory where cached files will be stored.
ttl (int): Time-to-live for the cache in seconds.
"""
if not os.path.exists(folder):
os.makedirs(folder)
def refresh_cache(func, cache_file, cache_key, args, kwargs):
def refresh_loop():
while True:
sleep(ttl)
try:
# Check if the cache is less than half the ttl (wait for half ttl to pass)
if os.path.exists(cache_file):
with open(cache_file, "r") as f:
cached_data = json.load(f)
if time() - cached_data["timestamp"] < ttl / 2:
return
# Re-compute the result and update the cache
print(f"Refreshing cache for {func.__name__}...")
result = func(*args, **kwargs)
with open(cache_file, "w") as f:
json.dump({"timestamp": time(), "result": result}, f)
except Exception as e:
print(f"Error during cache refresh: {e}")
threading.Thread(target=refresh_loop, daemon=True).start()
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
# Create a unique cache key based on the function name and arguments
cache_key = hashlib.md5(
f"{func.__name__}-{args}-{kwargs}".encode("utf-8")
).hexdigest()
cache_file = os.path.join(folder, f"{cache_key}.json")
# Start a background thread for auto-refresh if it doesn't exist
if not os.path.exists(cache_file):
print(f"Creating cache for {func.__name__} with auto-refresh.")
result = func(*args, **kwargs)
with open(cache_file, "w") as f:
json.dump({"timestamp": time(), "result": result}, f)
# Start refresh thread
refresh_cache(func, cache_file, cache_key, args, kwargs)
# Check if cache exists and is valid
if os.path.exists(cache_file):
try:
with open(cache_file, "r") as f:
cached_data = json.load(f)
# Check if the cache has expired
if time() - cached_data["timestamp"] < ttl:
return cached_data["result"]
except (IOError, ValueError, KeyError):
pass # In case of error, re-compute the result
# If cache is expired or invalid, recompute and update
result = func(*args, **kwargs)
with open(cache_file, "w") as f:
json.dump({"timestamp": time(), "result": result}, f)
# Start refresh thread if it doesn't exist
refresh_cache(func, cache_file, cache_key, args, kwargs)
return result
return wrapper
return decorator