feat: add default_date optional parameter for bulk create and update (#687)

* feat: add default_date optional parameter for bulk create and update

* chore: appy `make format`

Author: Stefan Borer

AUTHORS.rst

@@ -94,6 +94,7 @@ Authors
 - Sergey Ozeranskiy (`ozeranskiy <https://github.com/ozeranskiy>`_)
 - Shane Engelman
 - Steeve Chailloux
+- Stefan Borer (`sbor23 <https://github.com/sbor23>`_)
 - Steven Klass
 - Tommy Beadle (`tbeadle <https://github.com/tbeadle>`_)
 - Trey Hunner (`treyhunner <https://github.com/treyhunner>`_)

CHANGES.rst

@@ -1,6 +1,10 @@
 Changes
 =======
 
+Unreleased
+----------
+- Add default date to ``bulk_create_with_history`` and ``bulk_update_with_history`` (gh-687)
+
 2.11.0 (2020-06-20)
 -------------------
 - Added ``clean_old_history`` management command (gh-675)

docs/common_issues.rst

@@ -33,19 +33,20 @@ history:
     1000
 
 If you want to specify a change reason or history user for each record in the bulk create,
-you can add `_change_reason` or `_history_user` on each instance:
+you can add `_change_reason`, `_history_user` or `_history_date` on each instance:
 
 .. code-block:: pycon
 
     >>> for poll in data:
             poll._change_reason = 'reason'
             poll._history_user = my_user
+            poll._history_date = some_date
     >>> objs = bulk_create_with_history(data, Poll, batch_size=500)
     >>> Poll.history.get(id=data[0].id).history_change_reason
     'reason'
 
 You can also specify a default user or default change reason responsible for the change
-(`_history_user` and `_change_reason` take precedence).
+(`_change_reason`, `_history_user` and `_history_date` take precedence).
 
 .. code-block:: pycon
 

simple_history/manager.py

@@ -107,6 +107,7 @@ def bulk_history_create(
         update=False,
         default_user=None,
         default_change_reason="",
+        default_date=None,
     ):
         """
         Bulk create the history for the objects specified by objs.
@@ -126,7 +127,9 @@ def bulk_history_create(
                 default_user or self.model.get_default_history_user(instance),
             )
             row = self.model(
-                history_date=getattr(instance, "_history_date", timezone.now()),
+                history_date=getattr(
+                    instance, "_history_date", default_date or timezone.now()
+                ),
                 history_user=history_user,
                 history_change_reason=get_change_reason_from_object(instance)
                 or default_change_reason,

simple_history/tests/tests/test_utils.py

@@ -1,4 +1,5 @@
 from unittest import skipIf
+from datetime import datetime
 
 import django
 from django.contrib.auth import get_user_model
@@ -70,6 +71,14 @@ def test_bulk_create_history_with_default_change_reason(self):
             )
         )
 
+    def test_bulk_create_history_with_default_date(self):
+        date = datetime(2020, 7, 1)
+        bulk_create_with_history(self.data, Poll, default_date=date)
+
+        self.assertTrue(
+            all([history.history_date == date for history in Poll.history.all()])
+        )
+
     def test_bulk_create_history_num_queries_is_two(self):
         with self.assertNumQueries(2):
             bulk_create_with_history(self.data, Poll)
@@ -175,7 +184,11 @@ def test_bulk_create_no_ids_return(self, hist_manager_mock):
         result = bulk_create_with_history(objects, model)
         self.assertEqual(result, objects)
         hist_manager_mock().bulk_history_create.assert_called_with(
-            objects, batch_size=None, default_user=None, default_change_reason=None
+            objects,
+            batch_size=None,
+            default_user=None,
+            default_change_reason=None,
+            default_date=None,
         )
 
 
@@ -236,6 +249,21 @@ def test_bulk_update_history_with_default_change_reason(self):
             )
         )
 
+    def test_bulk_update_history_with_default_date(self):
+        date = datetime(2020, 7, 1)
+        bulk_update_with_history(
+            self.data, Poll, fields=["question"], default_date=date
+        )
+
+        self.assertTrue(
+            all(
+                [
+                    history.history_date == date
+                    for history in Poll.history.filter(history_type="~")
+                ]
+            )
+        )
+
     def test_bulk_update_history_num_queries_is_two(self):
         with self.assertNumQueries(2):
             bulk_update_with_history(

simple_history/utils.py

@@ -45,7 +45,12 @@ def get_history_model_for_model(model):
 
 
 def bulk_create_with_history(
-    objs, model, batch_size=None, default_user=None, default_change_reason=None
+    objs,
+    model,
+    batch_size=None,
+    default_user=None,
+    default_change_reason=None,
+    default_date=None,
 ):
     """
     Bulk create the objects specified by objs while also bulk creating
@@ -60,6 +65,8 @@ def bulk_create_with_history(
         record
     :param default_change_reason: Optional change reason to specify as the change_reason
         in each historical record
+    :param default_date: Optional date to specify as the history_date in each historical
+        record
     :return: List of objs with IDs
     """
 
@@ -74,6 +81,7 @@ def bulk_create_with_history(
                 batch_size=batch_size,
                 default_user=default_user,
                 default_change_reason=default_change_reason,
+                default_date=default_date,
             )
     if second_transaction_required:
         obj_list = []
@@ -88,13 +96,20 @@ def bulk_create_with_history(
                 batch_size=batch_size,
                 default_user=default_user,
                 default_change_reason=default_change_reason,
+                default_date=default_date,
             )
         objs_with_id = obj_list
     return objs_with_id
 
 
 def bulk_update_with_history(
-    objs, model, fields, batch_size=None, default_user=None, default_change_reason=None,
+    objs,
+    model,
+    fields,
+    batch_size=None,
+    default_user=None,
+    default_change_reason=None,
+    default_date=None,
 ):
     """
     Bulk update the objects specified by objs while also bulk creating
@@ -107,6 +122,8 @@ def bulk_update_with_history(
         record
     :param default_change_reason: Optional change reason to specify as the change_reason
         in each historical record
+    :param default_date: Optional date to specify as the history_date in each historical
+        record
     """
     if django.VERSION < (2, 2,):
         raise NotImplementedError(
@@ -115,15 +132,14 @@ def bulk_update_with_history(
         )
     history_manager = get_history_manager_for_model(model)
     with transaction.atomic(savepoint=False):
-        model.objects.bulk_update(
-            objs, fields, batch_size=batch_size,
-        )
+        model.objects.bulk_update(objs, fields, batch_size=batch_size)
         history_manager.bulk_history_create(
             objs,
             batch_size=batch_size,
             update=True,
             default_user=default_user,
             default_change_reason=default_change_reason,
+            default_date=default_date,
         )