better doctests

Author: yatharthmathur

Diff for: other/lru_cache_pythonic.py

@@ -6,45 +6,51 @@
 the Python dictionary maintains the order of insertion of keys and ensures O(1) operations on insert, delete and access.
 '''
 class LRUCache(dict):
-    '''
-    Initialize an LRU Cache with given capacity.
-    capacity : int -> the capacity of the LRU Cache
-    '''
     def __init__(self, capacity : int)->None:
+        '''
+        Initialize an LRU Cache with given capacity.
+        capacity : int -> the capacity of the LRU Cache
+        >>> cache = LRUCache(2)
+        >>> cache
+        {}
+        '''
         self.remaining:int = capacity
 
-    '''
-    This method gets the value associated with the key.
-    key : Hashable -> a hashable object that is mapped to a value inside of the LRU cache.
-    returns -> value : Any -> any object that is stored as a value inside of the LRU cache.
-
-    >>> cache = LRUCache(2)
-    >>> cache.put(1,1)
-    >>> cache.get(1)
-    1
-    >>> cache.get(2)
-    KeyError: '2 not found.'
-    '''
     def get(self, key:Hashable)->Any:
+        '''
+        This method gets the value associated with the key.
+        key : Hashable -> a hashable object that is mapped to a value inside of the LRU cache.
+        returns -> value : Any -> any object that is stored as a value inside of the LRU cache.
+
+        >>> cache = LRUCache(2)
+        >>> cache.put(1,1)
+        >>> cache.get(1)
+        1
+        >>> cache.get(2)
+        Traceback (most recent call last):
+        ...
+        KeyError: '2 not found.'
+        '''
         if key not in self:
             raise KeyError(f"{key} not found.")
         val = self.pop(key) # Pop the key-value and re-insert to maintain the order
         self[key] = val
         return val
 
-    '''
-    This method puts the value associated with the key provided inside of the LRU cache.
-    key : Hashable -> a hashable object that is mapped to a value inside of the LRU cache.
-    value: Any -> any object that is to be associated with the key inside of the LRU cache.
-    >>> cache = LRUCache(2)
-    >>> cache.put(3,3)
-    >>> cache
-    {3:3}
-    >>> cache.put(2,2)
-    >>> cache
-    {3:3, 2:2}
-    '''
+   
     def put(self, key:Hashable, value:Any)->None:
+        '''
+        This method puts the value associated with the key provided inside of the LRU cache.
+        key : Hashable -> a hashable object that is mapped to a value inside of the LRU cache.
+        value: Any -> any object that is to be associated with the key inside of the LRU cache.
+        >>> cache = LRUCache(2)
+        >>> cache.put(3,3)
+        >>> cache
+        {3: 3}
+        >>> cache.put(2,2)
+        >>> cache
+        {3: 3, 2: 2}
+        '''
         # To pop the last value inside of the LRU cache
         if key in self:
             self.pop(key)
@@ -85,9 +91,10 @@ def main()->None:
     except KeyError:
         print("Key not found in cache")
 
-    import doctest
-    doctest.testmod()
+    
 
 if __name__ == '__main__':
+    import doctest
+    doctest.testmod()
     main()