refactor(policies): mark policy classes as final and update docstrings

- Added @Final decorator to all policy classes to prevent inheritance
- Updated module docstrings to clarify "eviction policy" terminology
- Imported typing.final in all policy modules
- Added Attributes section to AbstractScriptsMixin docstring
- Standardized docstring format across all policy classes
- Ensured consistent naming and key assignments for all policies

Author: tanbro

src/redis_func_cache/mixins/scripts.py

@@ -20,6 +20,9 @@ class AbstractScriptsMixin(ABC):
 
     .. inheritance-diagram:: AbstractScriptsMixin
         :parts: 1
+
+    Attributes:
+        __scripts__ (Tuple[str, str]): A pair of file name for ‘get’ and ‘put’ Lua scripts to be used by the policy.
     """
 
     __scripts__: Tuple[str, str]

src/redis_func_cache/policies/fifo.py

@@ -1,4 +1,6 @@
-"""FIFO policies"""
+"""FIFO eviction policies"""
+
+from typing import final
 
 from ..mixins.hash import PickleMd5HashMixin
 from ..mixins.scripts import FifoScriptsMixin, FifoTScriptsMixin
@@ -16,6 +18,7 @@
 )
 
 
+@final
 class FifoPolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     FIFO eviction policy, single key pair.
@@ -29,6 +32,7 @@ class FifoPolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "fifo"
 
 
+@final
 class FifoMultiplePolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     FIFO eviction policy, multiple key pairs.
@@ -42,6 +46,7 @@ class FifoMultiplePolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseMultiplePolic
     __key__ = "fifo-m"
 
 
+@final
 class FifoClusterPolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     FIFO eviction policy with Redis cluster support, single key pair.
@@ -55,6 +60,7 @@ class FifoClusterPolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseClusterSingleP
     __key__ = "fifo-c"
 
 
+@final
 class FifoClusterMultiplePolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     FIFO eviction policy with Redis cluster support, multiple key pairs.
@@ -68,6 +74,7 @@ class FifoClusterMultiplePolicy(FifoScriptsMixin, PickleMd5HashMixin, BaseCluste
     __key__ = "fifo-cm"
 
 
+@final
 class FifoTPolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     FIFO eviction policy (timestamp variant), single key pair.
@@ -81,6 +88,7 @@ class FifoTPolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "fifo_t"
 
 
+@final
 class FifoTMultiplePolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     FIFO eviction policy (timestamp variant), multiple key pairs.
@@ -94,6 +102,7 @@ class FifoTMultiplePolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseMultiplePol
     __key__ = "fifo_t-m"
 
 
+@final
 class FifoTClusterPolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     FIFO eviction policy (timestamp variant) with Redis cluster support, single key pair.
@@ -107,6 +116,7 @@ class FifoTClusterPolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseClusterSingl
     __key__ = "fifo_t-c"
 
 
+@final
 class FifoTClusterMultiplePolicy(FifoTScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     FIFO eviction policy (timestamp variant) with Redis cluster support, multiple key pairs.

src/redis_func_cache/policies/lfu.py

@@ -1,4 +1,6 @@
-"""LFU policy."""
+"""LFU eviction policy."""
+
+from typing import final
 
 from ..mixins.hash import PickleMd5HashMixin
 from ..mixins.scripts import LfuScriptsMixin
@@ -7,6 +9,7 @@
 __all__ = ("LfuPolicy", "LfuMultiplePolicy", "LfuClusterPolicy", "LfuClusterMultiplePolicy")
 
 
+@final
 class LfuPolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     LFU eviction policy, single key pair.
@@ -20,6 +23,7 @@ class LfuPolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "lfu"
 
 
+@final
 class LfuMultiplePolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     LFU eviction policy, multiple key pairs.
@@ -33,6 +37,7 @@ class LfuMultiplePolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy)
     __key__ = "lfu-m"
 
 
+@final
 class LfuClusterPolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     LFU eviction policy with Redis cluster support, single key pair.
@@ -46,6 +51,7 @@ class LfuClusterPolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePol
     __key__ = "lfu-c"
 
 
+@final
 class LfuClusterMultiplePolicy(LfuScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     LFU eviction policy with Redis cluster support, multiple key pairs.

src/redis_func_cache/policies/lru.py

@@ -1,4 +1,6 @@
-"""Least Recently Used cache policies."""
+"""Least Recently Used eviction cache policies."""
+
+from typing import final
 
 from ..mixins.hash import PickleMd5HashMixin
 from ..mixins.scripts import LruScriptsMixin, LruTScriptsMixin
@@ -16,6 +18,7 @@
 )
 
 
+@final
 class LruPolicy(LruScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     LRU eviction policy, single key pair.
@@ -29,6 +32,7 @@ class LruPolicy(LruScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "lru"
 
 
+@final
 class LruMultiplePolicy(LruScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     LRU eviction policy, multiple key pairs.
@@ -42,6 +46,7 @@ class LruMultiplePolicy(LruScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy)
     __key__ = "lru-m"
 
 
+@final
 class LruClusterPolicy(LruScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     LRU eviction policy with Redis cluster support, single key pair.
@@ -55,6 +60,7 @@ class LruClusterPolicy(LruScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePol
     __key__ = "lru-c"
 
 
+@final
 class LruClusterMultiplePolicy(LruScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     LRU eviction policy with Redis cluster support, multiple key pairs.
@@ -68,6 +74,7 @@ class LruClusterMultiplePolicy(LruScriptsMixin, PickleMd5HashMixin, BaseClusterM
     __key__ = "lru-cm"
 
 
+@final
 class LruTPolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     LRU-T (timestamp-based pseudo LRU) eviction policy, single key pair.
@@ -81,6 +88,7 @@ class LruTPolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "lru_t"
 
 
+@final
 class LruTMultiplePolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     LRU-T (timestamp-based pseudo LRU) eviction policy, multiple key pairs.
@@ -94,6 +102,7 @@ class LruTMultiplePolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseMultiplePolic
     __key__ = "lru_t-m"
 
 
+@final
 class LruTClusterPolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     LRU-T (timestamp-based pseudo LRU) eviction policy with Redis cluster support, single key pair.
@@ -107,6 +116,7 @@ class LruTClusterPolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseClusterSingleP
     __key__ = "lru_t-c"
 
 
+@final
 class LruTClusterMultiplePolicy(LruTScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     LRU-T (timestamp-based pseudo LRU) eviction policy with Redis cluster support, multiple key pairs.

src/redis_func_cache/policies/mru.py

@@ -1,3 +1,7 @@
+"""Most Recently Used eviction cache policies."""
+
+from typing import final
+
 from ..mixins.hash import PickleMd5HashMixin
 from ..mixins.scripts import MruScriptsMixin
 from .base import BaseClusterMultiplePolicy, BaseClusterSinglePolicy, BaseMultiplePolicy, BaseSinglePolicy
@@ -10,6 +14,7 @@ def calc_ext_args(self, *args, **kwargs):
         return ("mru",)
 
 
+@final
 class MruPolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     MRU eviction policy, single key pair.
@@ -23,6 +28,7 @@ class MruPolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMixin, Bas
     __key__ = "mru"
 
 
+@final
 class MruMultiplePolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     MRU eviction policy, multiple key pairs.
@@ -36,6 +42,7 @@ class MruMultiplePolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMi
     __key__ = "mru-m"
 
 
+@final
 class MruClusterPolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     MRU eviction policy with Redis cluster support, single key pair.
@@ -49,6 +56,7 @@ class MruClusterPolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMix
     __key__ = "mru-c"
 
 
+@final
 class MruClusterMultiplePolicy(_MruPolicyExtArgsMixin, MruScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     MRU eviction policy with Redis cluster support, multiple key pairs.

src/redis_func_cache/policies/rr.py

@@ -1,4 +1,6 @@
-"""Random replacement cache policy."""
+"""Random replacement eviction cache policy."""
+
+from typing import final
 
 from ..mixins.hash import PickleMd5HashMixin
 from ..mixins.scripts import RrScriptsMixin
@@ -7,6 +9,7 @@
 __all__ = ("RrPolicy", "RrMultiplePolicy", "RrClusterPolicy", "RrClusterMultiplePolicy")
 
 
+@final
 class RrPolicy(RrScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     """
     Random replacement (RR) eviction policy, single key pair.
@@ -20,6 +23,7 @@ class RrPolicy(RrScriptsMixin, PickleMd5HashMixin, BaseSinglePolicy):
     __key__ = "rr"
 
 
+@final
 class RrMultiplePolicy(RrScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     """
     Random replacement (RR) eviction policy, multiple key pairs.
@@ -33,6 +37,7 @@ class RrMultiplePolicy(RrScriptsMixin, PickleMd5HashMixin, BaseMultiplePolicy):
     __key__ = "rr-m"
 
 
+@final
 class RrClusterPolicy(RrScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolicy):
     """
     Random replacement (RR) eviction policy with Redis cluster support, single key pair.
@@ -46,6 +51,7 @@ class RrClusterPolicy(RrScriptsMixin, PickleMd5HashMixin, BaseClusterSinglePolic
     __key__ = "rr-c"
 
 
+@final
 class RrClusterMultiplePolicy(RrScriptsMixin, PickleMd5HashMixin, BaseClusterMultiplePolicy):
     """
     Random replacement (RR) eviction policy with Redis cluster support, multiple key pairs.