feat: Workspace 1054

Pipfile

@@ -33,8 +33,10 @@ cfl-common = "==8.9.19" # TODO: remove
 codeforlife-portal = "==8.9.19" # TODO: remove
 rapid-router = "==7.6.18" # TODO: remove
 phonenumbers = "==8.12.12" # TODO: remove
-google-auth = "==2.40.3"
+google-auth = "==2.48.0"
 google-cloud-bigquery = "==3.38.0"
+tink = {version = "==1.13.0", extras = ["gcpkms"]}
+cachetools = "==6.2.6"
 
 [dev-packages]
 celery-types = "==0.23.0"
@@ -57,6 +59,7 @@ django-stubs = {version = "==5.1.3", extras = ["compatible-mypy"]}
 djangorestframework-stubs = {version = "==3.15.3", extras = ["compatible-mypy"]}
 types-regex = "==2024.11.6.*"
 types-psutil = "==7.0.0.20250601"
+types-cachetools = "==6.2.*"
 
 [requires]
 python_version = "3.12"

codeforlife/caches/__init__.py

@@ -0,0 +1,8 @@
+"""
+© Ocado Group
+Created on 28/01/2026 at 16:52:19(+00:00).
+"""
+
+from .base import BaseCache
+from .base_dynamic_key import BaseDynamicKeyCache
+from .base_fixed_key import BaseFixedKeyCache

codeforlife/caches/base.py

@@ -0,0 +1,67 @@
+"""
+© Ocado Group
+Created on 28/01/2026 at 16:52:19(+00:00).
+"""
+
+import typing as t
+
+from django.core.cache import cache
+
+V = t.TypeVar("V")
+
+
+class BaseCache(t.Generic[V]):
+    """Base class which helps to get and set cache values."""
+
+    timeout: int | None = None
+
+    @classmethod
+    def get(
+        cls,
+        key: str,
+        default: t.Optional[V] = None,
+        version: t.Optional[int] = None,
+    ) -> t.Optional[V]:
+        """
+        Fetch a given key from the cache. If the key does not exist, return
+        default, which itself defaults to None.
+        """
+        return cache.get(
+            key=key,
+            default=default,
+            version=version,
+        )
+
+    @classmethod
+    def set(
+        cls,
+        key: str,
+        value: V,
+        timeout: t.Optional[int] = None,
+        version: t.Optional[int] = None,
+    ):
+        """
+        Set a value in the cache. If timeout is given, use that timeout for the
+        key; otherwise use the default cache timeout.
+        """
+        cache.set(
+            key=key,
+            value=value,
+            timeout=timeout or cls.timeout,
+            version=version,
+        )
+
+    @classmethod
+    def delete(
+        cls,
+        key: str,
+        version: t.Optional[int] = None,
+    ):
+        """
+        Delete a key from the cache and return whether it succeeded, failing
+        silently.
+        """
+        cache.delete(
+            key=key,
+            version=version,
+        )

codeforlife/caches/base_dynamic_key.py

@@ -0,0 +1,59 @@
+"""
+© Ocado Group
+Created on 28/01/2026 at 16:52:19(+00:00).
+"""
+
+import typing as t
+
+from .base import BaseCache
+
+V = t.TypeVar("V")
+K = t.TypeVar("K")
+
+
+class BaseDynamicKeyCache(BaseCache[V], t.Generic[K, V]):
+    """Base class which helps to get and set cache values with a dynamic key."""
+
+    @staticmethod
+    def make_key(key: K) -> str:
+        """Make the cache key from the key's data."""
+        raise NotImplementedError()
+
+    @classmethod
+    def get(  # type: ignore[override]
+        cls,
+        key: K,
+        default: t.Optional[V] = None,
+        version: t.Optional[int] = None,
+    ) -> t.Optional[V]:
+        return super().get(
+            key=cls.make_key(key),
+            default=default,
+            version=version,
+        )
+
+    @classmethod
+    def set(  # type: ignore[override]
+        cls,
+        key: K,
+        value: V,
+        timeout: t.Optional[int] = None,
+        version: t.Optional[int] = None,
+    ):
+        super().set(
+            key=cls.make_key(key),
+            value=value,
+            timeout=timeout,
+            version=version,
+        )
+
+    @classmethod
+    def delete(  # type: ignore[override]
+        cls,
+        key: K,
+        version: t.Optional[int] = None,
+    ):
+        super().delete(
+            key=cls.make_key(key),
+            version=version,
+        )

codeforlife/caches/base_fixed_key.py

@@ -0,0 +1,56 @@
+"""
+© Ocado Group
+Created on 28/01/2026 at 16:52:19(+00:00).
+"""
+
+import typing as t
+
+from .base import BaseCache
+
+V = t.TypeVar("V")
+
+
+class BaseFixedKeyCache(BaseCache[V], t.Generic[V]):
+    """Base class which helps to get and set cache values with a fixed key."""
+
+    key: str
+
+    # pylint: disable=arguments-differ
+
+    @classmethod
+    def get(  # type: ignore[override]
+        cls,
+        default: t.Optional[V] = None,
+        version: t.Optional[int] = None,
+    ) -> t.Optional[V]:
+        return super().get(
+            key=cls.key,
+            default=default,
+            version=version,
+        )
+
+    @classmethod
+    def set(  # type: ignore[override]
+        cls,
+        value: V,
+        timeout: t.Optional[int] = None,
+        version: t.Optional[int] = None,
+    ):
+        super().set(
+            key=cls.key,
+            value=value,
+            timeout=timeout,
+            version=version,
+        )
+
+    @classmethod
+    def delete(  # type: ignore[override]
+        cls,
+        version: t.Optional[int] = None,
+    ):
+        super().delete(
+            key=cls.key,
+            version=version,
+        )
+
+    # pylint: enable=arguments-differ