Added possibility to specify a default user for bulk_create_with_history

AUTHORS.rst

@@ -16,6 +16,7 @@ Authors
 - Alexander Anikeev
 - Amanda Ng (`AmandaCLNg <https://github.com/AmandaCLNg>`_)
 - Ben Lawson (`blawson <https://github.com/blawson>`_)
+- Benjamin Mampaey (`bmampaey <https://github.com/bmampaey>`_)
 - `bradford281 <https://github.com/bradford281>`_
 - Brian Armstrong (`barm <https://github.com/barm>`_)
 - Buddy Lindsey, Jr.

CHANGES.rst

@@ -7,6 +7,7 @@ Unreleased
 - Add setting to convert `FileField` to `CharField` instead of `TextField` (gh-623)
 - import model `ContentType` in `SimpleHistoryAdmin` using `django_apps.get_model`
   to avoid possible `AppRegistryNotReady` exception (gh-630)
+- Add default user to `bulk_create_with_history`
 
 2.8.0 (2019-12-02)
 ------------------

docs/common_issues.rst

@@ -42,6 +42,14 @@ can add `changeReason` on each instance:
     >>> Poll.history.get(id=data[0].id).history_change_reason
     'reason'
 
+You can also specify a default user responsible for the change ( _history_user keeps precedence)
+
+.. code-block:: pycon
+
+    >>> user = User.objects.create_user("tester", "tester@example.com")
+    >>> objs = bulk_create_with_history(data, Poll, batch_size=500, default_user=user)
+    >>> Poll.history.get(id=data[0].id).history_user == user
+    True
 
 QuerySet Updates with History
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

simple_history/manager.py

@@ -98,14 +98,14 @@ def _as_of_set(self, date):
                 continue
             yield last_change.instance
 
-    def bulk_history_create(self, objs, batch_size=None):
+    def bulk_history_create(self, objs, batch_size=None, default_user=None):
         """Bulk create the history for the objects specified by objs"""
 
         historical_instances = []
         for instance in objs:
             row = self.model(
                 history_date=getattr(instance, "_history_date", now()),
-                history_user=getattr(instance, "_history_user", None),
+                history_user=getattr(instance, "_history_user", default_user),
                 history_change_reason=getattr(instance, "changeReason", ""),
                 history_type="+",
                 **{

simple_history/tests/tests/test_manager.py

@@ -126,6 +126,15 @@ def test_bulk_history_create_with_change_reason(self):
             )
         )
 
+    def test_bulk_history_create_with_default_user(self):
+        user = User.objects.create_user("tester", "tester@example.com")
+
+        Poll.history.bulk_history_create(self.data, default_user=user)
+
+        self.assertTrue(
+            all([history.history_user == user for history in Poll.history.all()])
+        )
+
     def test_bulk_history_create_on_objs_without_ids(self):
         self.data = [
             Poll(question="Question 1", pub_date=datetime.now()),

simple_history/tests/tests/test_utils.py

@@ -1,3 +1,4 @@
+from django.contrib.auth import get_user_model
 from django.db import IntegrityError
 from django.test import TestCase, TransactionTestCase
 from django.utils.timezone import now
@@ -13,6 +14,8 @@
 )
 from simple_history.utils import bulk_create_with_history
 
+User = get_user_model()
+
 
 class BulkCreateWithHistoryTestCase(TestCase):
     def setUp(self):
@@ -37,6 +40,15 @@ def test_bulk_create_history(self):
         self.assertEqual(Poll.objects.count(), 5)
         self.assertEqual(Poll.history.count(), 5)
 
+    def test_bulk_create_history_with_default_user(self):
+        user = User.objects.create_user("tester", "tester@example.com")
+
+        bulk_create_with_history(self.data, Poll, default_user=user)
+
+        self.assertTrue(
+            all([history.history_user == user 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)

simple_history/utils.py

@@ -37,7 +37,7 @@ def get_history_model_for_model(model):
     return get_history_manager_for_model(model).model
 
 
-def bulk_create_with_history(objs, model, batch_size=None):
+def bulk_create_with_history(objs, model, batch_size=None, default_user=None):
     """
     Bulk create the objects specified by objs while also bulk creating
     their history (all in one transaction).
@@ -56,7 +56,9 @@ def bulk_create_with_history(objs, model, batch_size=None):
         objs_with_id = model.objects.bulk_create(objs, batch_size=batch_size)
         if objs_with_id and objs_with_id[0].pk:
             second_transaction_required = False
-            history_manager.bulk_history_create(objs_with_id, batch_size=batch_size)
+            history_manager.bulk_history_create(
+                objs_with_id, batch_size=batch_size, default_user=default_user
+            )
     if second_transaction_required:
         obj_list = []
         with transaction.atomic(savepoint=False):
@@ -65,6 +67,8 @@ def bulk_create_with_history(objs, model, batch_size=None):
                     filter(lambda x: x[1] is not None, model_to_dict(obj).items())
                 )
                 obj_list += model.objects.filter(**attributes)
-            history_manager.bulk_history_create(obj_list, batch_size=batch_size)
+            history_manager.bulk_history_create(
+                obj_list, batch_size=batch_size, default_user=default_user
+            )
         objs_with_id = obj_list
     return objs_with_id