Skip to content

Caching

PeterCache

This class provides methods to interact with the cache for the Peter Explains CLI.

Source code in peter_explains/cache.py 
 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
class PeterCache:
    """
    This class provides methods to interact with the cache for the Peter Explains CLI.
    """

    def __init__(self):
        """
        Initializes the PeterCache class.
        """
        self.cache = Cache(self.get_cache_dir(__app_name__))

    @staticmethod
    def get_cache_dir(cache_dir_name: str) -> str:
        """
        This function gets the cache directory for the Peter Explains CLI based on the operating system.

        Args:
            cache_dir_name (str): The name of the Peter Explains CLI cache directory.

        Returns:
            cache_dir (str): The cache directory for the Peter Explains CLI.
        """
        if os.name == "nt":
            cache_dir = os.path.join(os.getenv("LOCALAPPDATA"), cache_dir_name, "cache")
        elif os.name == "posix":
            home = os.path.expanduser("~")
            if sys.platform == "darwin":
                cache_dir = os.path.join(
                    home, "Library", "Application Support", cache_dir_name, "cache"
                )
            else:
                cache_dir = os.path.join(home, ".config", cache_dir_name, "cache")

        return cache_dir

    def __contains__(self, key):
        """
        Check if the cache contains a specific key.

        Args:
            key: The key to check.

        Returns:
            True if the cache contains the key, False otherwise.
        """
        return key in self.cache

    def save(self, key: str, value: CommandExplanation | CommandExplanationWithArguments):
        """
        Saves the given value in the cache with the specified key.

        Args:
            key (str): The key to associate with the value in the cache.
            value (CommandExplanation | CommandExplanationWithArguments): The value to be saved in the cache.

        Returns:
            None
        """
        self.cache[key] = value

    def get(self, key) -> CommandExplanation | CommandExplanationWithArguments | None:
        """
        Retrieve the value associated with the given key from the cache.

        Parameters:
            key (any): The key to retrieve the value for.

        Returns:
            The value associated with the key, or None if the key is not found.
        """
        return self.cache.get(key)

    def delete(self, key):
        """
        Deletes the specified key from the cache.

        Args:
            key: The key to be deleted from the cache.

        Returns:
            None
        """
        del self.cache[key]

    def clear(self):
        """
        Clears the cache by removing all stored items.
        """
        self.cache.clear()
        print("A fresh new start! How 'bout that?")

__contains__(key)

Check if the cache contains a specific key.

Parameters:

Name Type Description Default
key

The key to check.

 required

Returns:

Type Description

True if the cache contains the key, False otherwise.
Source code in peter_explains/cache.py 
44
45
46
47
48
49
50
51
52
53
54
def __contains__(self, key):
    """
    Check if the cache contains a specific key.

    Args:
        key: The key to check.

    Returns:
        True if the cache contains the key, False otherwise.
    """
    return key in self.cache

__init__()

Initializes the PeterCache class.

Source code in peter_explains/cache.py 
14
15
16
17
18
def __init__(self):
    """
    Initializes the PeterCache class.
    """
    self.cache = Cache(self.get_cache_dir(__app_name__))

clear()

Clears the cache by removing all stored items.

Source code in peter_explains/cache.py 
93
94
95
96
97
98
def clear(self):
    """
    Clears the cache by removing all stored items.
    """
    self.cache.clear()
    print("A fresh new start! How 'bout that?")

delete(key)

Deletes the specified key from the cache.

Parameters:

Name Type Description Default
key

The key to be deleted from the cache.

 required

Returns:

Type Description

None
Source code in peter_explains/cache.py 
81
82
83
84
85
86
87
88
89
90
91
def delete(self, key):
    """
    Deletes the specified key from the cache.

    Args:
        key: The key to be deleted from the cache.

    Returns:
        None
    """
    del self.cache[key]

get(key)

Retrieve the value associated with the given key from the cache.

Parameters:

Name Type Description Default
key any

The key to retrieve the value for.

 required

Returns:

Type Description
CommandExplanation | CommandExplanationWithArguments | None

The value associated with the key, or None if the key is not found.
Source code in peter_explains/cache.py 
69
70
71
72
73
74
75
76
77
78
79
def get(self, key) -> CommandExplanation | CommandExplanationWithArguments | None:
    """
    Retrieve the value associated with the given key from the cache.

    Parameters:
        key (any): The key to retrieve the value for.

    Returns:
        The value associated with the key, or None if the key is not found.
    """
    return self.cache.get(key)

get_cache_dir(cache_dir_name) staticmethod

This function gets the cache directory for the Peter Explains CLI based on the operating system.

Parameters:

Name Type Description Default
cache_dir_name str

The name of the Peter Explains CLI cache directory.

 required

Returns:

Name Type Description
cache_dir str

The cache directory for the Peter Explains CLI.
Source code in peter_explains/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
@staticmethod
def get_cache_dir(cache_dir_name: str) -> str:
    """
    This function gets the cache directory for the Peter Explains CLI based on the operating system.

    Args:
        cache_dir_name (str): The name of the Peter Explains CLI cache directory.

    Returns:
        cache_dir (str): The cache directory for the Peter Explains CLI.
    """
    if os.name == "nt":
        cache_dir = os.path.join(os.getenv("LOCALAPPDATA"), cache_dir_name, "cache")
    elif os.name == "posix":
        home = os.path.expanduser("~")
        if sys.platform == "darwin":
            cache_dir = os.path.join(
                home, "Library", "Application Support", cache_dir_name, "cache"
            )
        else:
            cache_dir = os.path.join(home, ".config", cache_dir_name, "cache")

    return cache_dir

save(key, value)

Saves the given value in the cache with the specified key.

Parameters:

Name Type Description Default
key str

The key to associate with the value in the cache.

 required
value CommandExplanation | CommandExplanationWithArguments

The value to be saved in the cache.

 required

Returns:

Type Description

None
Source code in peter_explains/cache.py 
56
57
58
59
60
61
62
63
64
65
66
67
def save(self, key: str, value: CommandExplanation | CommandExplanationWithArguments):
    """
    Saves the given value in the cache with the specified key.

    Args:
        key (str): The key to associate with the value in the cache.
        value (CommandExplanation | CommandExplanationWithArguments): The value to be saved in the cache.

    Returns:
        None
    """
    self.cache[key] = value