Add support for redaction

anonymiser/models.py

@@ -155,3 +155,21 @@ def post_anonymise_object(
 
         """
         pass
+
+    def collect_redactions(self) -> dict[str, Any]:
+        """
+        Return a dict of field names to redaction functions.
+
+        This is used by the redact_queryset method to redact fields that
+        support redaction. Each value can be a static value or a callable,
+        such as a function (e.g. F expression) or a class (e.g. Func).
+
+        """
+        return {
+            f.name: getattr(self, f"redact_{f.name}")
+            for f in self.get_model_fields()
+            if hasattr(self, f"redact_{f.name}")
+        }
+
+    def redact_queryset(self, queryset: models.QuerySet[models.Model]) -> int:
+        return queryset.update(**self.collect_redactions())

tests/anon.py

@@ -1,3 +1,7 @@
+from django.db import models
+from django.db.models.functions import Concat
+
+from anonymiser.db.expressions import GenerateUuid4
 from anonymiser.decorators import register_anonymiser
 from anonymiser.models import BaseAnonymiser
 
@@ -8,6 +12,16 @@
 class UserAnonymiser(BaseAnonymiser):
     model = User
 
+    redact_first_name = "FIRST_NAME"
+    redact_last_name = "LAST_NAME"
+    redact_uuid = GenerateUuid4()
+    redact_email = Concat(
+        models.F("first_name"),
+        models.Value("."),
+        models.F("last_name"),
+        models.Value("@example.com"),
+    )
+
     def anonymise_first_name(self, obj: User) -> None:
         obj.first_name = "Anonymous"