clear-skies 1.19.9__tar.gz → 1.19.11__tar.gz

{clear_skies-1.19.9 → clear_skies-1.19.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clear-skies
-Version: 1.19.9
+Version: 1.19.11
 Summary: A framework for building backends in the cloud
 Home-page: https://github.com/cmancone/clearskies
 License: MIT

{clear_skies-1.19.9 → clear_skies-1.19.11}/pyproject.toml

@@ -2,7 +2,7 @@
 
 [tool.poetry]
 name = "clear-skies"
-version = "1.19.9"
+version = "1.19.11"
 description = "A framework for building backends in the cloud"
 authors = [
     "Conor Mancone <cmancone@gmail.com>",

{clear_skies-1.19.9 → clear_skies-1.19.11}/src/clearskies/column_types/audit.py

@@ -29,6 +29,9 @@ class Audit(has_many.HasMany):
     With `exclude_columns` you can specify some names of columns to ignore.  If an update happens and only columns
     in `exclude_columns` are being set, then a history entry will not be created.  Also, these columns will
     not be included in the audit record.
+
+    With `mask_columns` you can specify the names of columns which should be noted as updated in the audit record,
+    but the actual values (before and after) should not be recorded.
     """
 
     _parent_columns = None
@@ -40,6 +43,7 @@ class Audit(has_many.HasMany):
     my_configs = [
         "child_models_class",
         "exclude_columns",
+        "mask_columns",
         "foreign_column_name",
         "is_readable",
         "readable_child_columns",
@@ -92,21 +96,21 @@ class Audit(has_many.HasMany):
                     + " but it has something else"
                 )
 
-        if "exclude_columns" in configuration:
-            exclude_columns = configuration["exclude_columns"]
-            if not hasattr(exclude_columns, "__iter__"):
-                raise ValueError(
-                    f"{error_prefix} 'exclude_columns' should be an iterable " + "with the list of columns to exclude."
-                )
-            if isinstance(exclude_columns, str):
+        for config_name in ["exclude_columns", "mask_columns"]:
+            if config_name not in configuration:
+                continue
+
+            config_columns = configuration[config_name]
+            if not hasattr(config_columns, "__iter__"):
+                raise ValueError(f"{error_prefix} '{config_name}' should be an iterable with the list of column names.")
+            if isinstance(config_columns, str):
                 raise ValueError(
-                    f"{error_prefix} 'exclude_columns' should be an iterable "
-                    + "with the list of child columns to output."
+                    f"{error_prefix} '{config_name}' should be an iterable " + "with a list of column names."
                 )
-            for column_name in exclude_columns:
+            for column_name in config_columns:
                 if column_name not in parent_columns:
                     raise ValueError(
-                        f"{error_prefix} 'exclude_columns' references column named '{column_name}' but this"
+                        f"{error_prefix} '{config_name}' references column named '{column_name}' but this"
                         + " column does not exist in the original model class."
                     )
 
@@ -118,6 +122,7 @@ class Audit(has_many.HasMany):
         old_data = model._previous_data
         new_data = model._data
         exclude_columns = self.config("exclude_columns")
+        mask_columns = self.config("mask_columns")
         parent_columns = self.parent_columns
 
         if not old_data:
@@ -129,6 +134,8 @@ class Audit(has_many.HasMany):
                     **create_data,
                     **parent_columns[key].to_json(model),
                 }
+                if key in mask_columns and key in create_data:
+                    key[column] = "****"
             self.record(model, "create", data=create_data)
             return
 
@@ -152,6 +159,9 @@ class Audit(has_many.HasMany):
                 **to_data,
                 **parent_columns[column].to_json(model),
             }
+            if column in mask_columns and column in to_data:
+                to_data[column] = "****"
+                from_data[column] = "****"
         if not from_data and not to_data:
             return
 
@@ -168,15 +178,28 @@ class Audit(has_many.HasMany):
         super().post_delete(model)
         exclude_columns = self.config("exclude_columns")
         parent_columns = self.parent_columns
+        mask_columns = self.config("mask_columns")
+
+        final_data = {}
+        for key in model._data.keys():
+            if key in exclude_columns:
+                continue
+            final_data = {
+                **final_data,
+                **parent_columns[key].to_json(model),
+            }
+
+        for key in mask_columns:
+            if key not in final_data:
+                continue
+            final_data[key] = "****"
 
         self.child_models.create(
             {
                 "class": self.config("parent_class_name"),
                 "resource_id": model.get(self.config("parent_id_column_name")),
                 "action": "delete",
-                "data": {
-                    key: parent_columns[key].to_json(model) for key in model._data.keys() if key not in exclude_columns
-                },
+                "data": final_data,
             }
         )