Cache

This module contains the Cache class which provides a simple caching mechanism. It stores key-value pairs in a JSON file located in the Manga_Data directory.

Cache

Cache(cache_file: str)

A simple caching class that stores key-value pairs in a JSON file.

ATTRIBUTE	DESCRIPTION
cache_file	The path to the file where the cache is stored. TYPE: str
cache	The cache data. TYPE: dict

Source code in AnilistMangaUpdater/Utils/cache.py

def __init__(self, cache_file: str) -> None:
    self.cache_file: str = cache_file
    self.cache: dict = {}  # Initialize cache as an empty dictionary
    Logger.INFO(f"Cache initialized with file: {self.cache_file}")
    self.load_cache()

cache instance-attribute

cache: dict = {}

cache_file instance-attribute

cache_file: str = cache_file

get

get(key: str) -> Union[str, None]

Gets a value from the cache.

PARAMETER	DESCRIPTION
key	The key to get the value for. TYPE: str

RETURNS	DESCRIPTION
Union[str, None]	The value for the key, or None if the key is not in the cache.

Source code in AnilistMangaUpdater/Utils/cache.py

def get(self, key: str) -> Union[str, None]:
    """
    Gets a value from the cache.

    Parameters:
        key (str): The key to get the value for.

    Returns:
        The value for the key, or None if the key is not in the cache.
    """
    Logger.INFO(f"Getting value for key: {key} from cache.")
    value = self.cache.get(key)
    if value is None:
        Logger.WARNING(f"No value found in cache for key: {key}.")
    else:
        Logger.INFO(f"Found value in cache for key: {key}.")
    return value

load_cache

load_cache() -> None

Loads the cache from a file.

Source code in AnilistMangaUpdater/Utils/cache.py

def load_cache(self) -> None:
    """
    Loads the cache from a file.
    """
    Logger.INFO("Loading cache from file.")
    try:
        os.makedirs(os.path.dirname(self.cache_file), exist_ok=True)
        with open(self.cache_file, "r", encoding="utf-8") as f:
            self.cache.update(json.load(f))
        Logger.INFO("Cache loaded successfully.")
    except FileNotFoundError:
        Logger.WARNING("Cache file not found. Initializing cache with default values.")
        if "format_cache.json" in self.cache_file:
            self.cache.update(cache_format_dict)
        else:
            self.cache.update(cache_title_dict)
        self.save_cache()

save_cache

save_cache() -> None

Saves the cache to a file.

Source code in AnilistMangaUpdater/Utils/cache.py

def save_cache(self) -> None:
    """
    Saves the cache to a file.
    """
    Logger.INFO("Saving cache to file.")
    os.makedirs(os.path.dirname(self.cache_file), exist_ok=True)
    with open(self.cache_file, "w", encoding="utf-8") as f:
        json.dump(self.cache, f)
    Logger.INFO("Cache saved successfully.")

set

set(key: str, value: Any) -> None

Sets a value in the cache and saves the cache to a file.

PARAMETER	DESCRIPTION
key	The key to set the value for. TYPE: str
value	The value to set. TYPE: Any

Source code in AnilistMangaUpdater/Utils/cache.py

def set(self, key: str, value: Any) -> None:
    """
    Sets a value in the cache and saves the cache to a file.

    Parameters:
        key (str): The key to set the value for.
        value: The value to set.
    """
    Logger.INFO(f"Setting value for key: {key} in cache.")
    self.cache[key] = value
    self.save_cache()