Adds cache_clear() function to clear the cache. (iamsinghrajat#23)

* Adds cache_clear() function to clear the cache.

* Add docstring to cache_clear().

Author: MarijnHoum

cache/async_lru.py

@@ -8,6 +8,17 @@ def __init__(self, maxsize=128):
         :param maxsize: Use maxsize as None for unlimited size cache
         """
         self.lru = LRU(maxsize=maxsize)
+        
+    def cache_clear(self):
+        """
+        Clears the LRU cache.
+
+        This method empties the cache, removing all stored
+        entries and effectively resetting the cache.
+
+        :return: None
+        """
+        self.lru.clear()
 
     def __call__(self, func):
         async def wrapper(*args, use_cache=True, **kwargs):
@@ -19,5 +30,6 @@ async def wrapper(*args, use_cache=True, **kwargs):
                 return self.lru[key]
 
         wrapper.__name__ += func.__name__
+        wrapper.__dict__['cache_clear'] = self.cache_clear
 
         return wrapper

cache/async_ttl.py

@@ -48,6 +48,17 @@ def __init__(self, time_to_live=60, maxsize=1024, skip_args: int = 0):
         self.ttl = self._TTL(time_to_live=time_to_live, maxsize=maxsize)
         self.skip_args = skip_args
 
+    def cache_clear(self):
+        """
+        Clears the TTL cache.
+
+        This method empties the cache, removing all stored
+        entries and effectively resetting the cache.
+
+        :return: None
+        """
+        self.ttl.clear()
+
     def __call__(self, func):
         async def wrapper(*args, use_cache=True, **kwargs):
             key = KEY(args[self.skip_args:], kwargs)
@@ -60,5 +71,6 @@ async def wrapper(*args, use_cache=True, **kwargs):
             return val
 
         wrapper.__name__ += func.__name__
+        wrapper.__dict__['cache_clear'] = self.cache_clear
 
         return wrapper

tests/lru_test.py

@@ -9,6 +9,10 @@
 async def func(wait: int):
     await asyncio.sleep(wait)
 
+@AsyncLRU(maxsize=128)
+async def cache_clear_fn(wait: int):
+    await asyncio.sleep(wait)
+
 
 class TestClassFunc:
     @AsyncLRU(maxsize=128)
@@ -104,9 +108,30 @@ def test_cache_refreshing_lru():
     assert t1 - t3 <= 0.1
 
 
+def test_cache_clear():
+    # print("call function. Cache miss.")
+    t1 = time.time()
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t2 = time.time()
+    # print("call function again. Cache hit")
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t3 = time.time()
+    cache_clear_fn.cache_clear()
+    # print("Call cache_clear() to clear the cache.")
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t4 = time.time()
+    # print("call function third time. Cache miss)")
+
+    assert t2 - t1 > 1, t2 - t1 # Cache miss
+    assert t3 - t2 < 1, t3 - t2 # Cache hit
+    assert t4 - t3 > 1, t4 - t3 # Cache miss
+
+
+
 if __name__ == "__main__":
     test()
     test_obj_fn()
     test_class_fn()
     test_skip_args()
     test_cache_refreshing_lru()
+    test_cache_clear()

tests/ttl_test.py

@@ -22,6 +22,11 @@ async def short_cleanup_fn(wait: int):
     await asyncio.sleep(wait)
     return wait
 
+@AsyncTTL(time_to_live=3)
+async def cache_clear_fn(wait: int):
+    await asyncio.sleep(wait)
+    return wait
+
 
 def cache_hit_test():
     t1 = time.time()
@@ -69,8 +74,27 @@ def test_cache_refreshing_ttl():
     assert t1 > t2
     assert t1 - t3 <= 0.1
 
+def cache_clear_test():
+    # print("call function. Cache miss.")
+    t1 = time.time()
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t2 = time.time()
+    # print("call function again. Cache hit")
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t3 = time.time()
+    cache_clear_fn.cache_clear()
+    # print("Call cache_clear() to clear the cache.")
+    asyncio.get_event_loop().run_until_complete(cache_clear_fn(1))
+    t4 = time.time()
+    # print("call function third time. Cache miss)")
+
+    assert t2 - t1 > 1, t2 - t1 # Cache miss
+    assert t3 - t2 < 1, t3 - t2 # Cache hit
+    assert t4 - t3 > 1, t4 - t3 # Cache miss
+
 
 if __name__ == "__main__":
     cache_hit_test()
     cache_expiration_test()
     test_cache_refreshing_ttl()
+    cache_clear_test()