Bulk create and update support for alternative managers (#709)

* Use default manager for bulk_create_with_history

* Add optional manager arg to bulk_update_with_history

* Update documentation

Author: georgek

AUTHORS.rst

@@ -38,6 +38,7 @@ Authors
 - Filipe Pina (@fopina)
 - Florian Eßer
 - Frank Sachsenheim
+- George Kettleborough (`georgek <https://github.com/georgek>`_)
 - George Vilches
 - Gregory Bataille
 - Grzegorz Bialy

CHANGES.rst

@@ -7,6 +7,10 @@ Unreleased
 - Exclude ManyToManyFields when using ``bulk_create_with_history`` (gh-699)
 - Added ``--excluded_fields`` argument to ``clean_duplicate_history`` command (gh-674)
 - Exclude ManyToManyFields when fetching excluded fields (gh-707)
+- Use default model manager for ``bulk_create_with_history`` and
+  ``bulk_update_with_history`` instead of ``objects`` (gh-703)
+- Add optional ``manager`` argument to ``bulk_update_with_history`` to use instead of
+  the default manager (gh-703)
 
 2.11.0 (2020-06-20)
 -------------------

docs/common_issues.rst

@@ -56,9 +56,11 @@ You can also specify a default user or default change reason responsible for the
     True
 
 Bulk Updating a Model with History (New)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Bulk update was introduced with Django 2.2. We can use the utility function
-``bulk_update_with_history`` in order to bulk update objects using Django's ``bulk_update`` function while saving the object history:
+``bulk_update_with_history`` in order to bulk update objects using Django's
+``bulk_update`` function while saving the object history:
 
 
 .. code-block:: pycon
@@ -72,7 +74,19 @@ Bulk update was introduced with Django 2.2. We can use the utility function
     >>> for obj in objs: obj.question = 'Duplicate Questions'
     >>> bulk_update_with_history(objs, Poll, ['question'], batch_size=500)
     >>> Poll.objects.first().question
-    'Duplicate Question'
+    'Duplicate Question``
+
+If your models require the use of an alternative model manager (usually because the
+default manager returns a filtered set), you can specify which manager to use with the
+``manager`` argument:
+
+.. code-block:: pycon
+
+    >>> from simple_history.utils import bulk_update_with_history
+    >>> from simple_history.tests.models import PollWithAlternativeManager
+    >>>
+    >>> data = [PollWithAlternativeManager(id=x, question='Question ' + str(x), pub_date=now()) for x in range(1000)]
+    >>> objs = bulk_create_with_history(data, PollWithAlternativeManager, batch_size=500, manager=PollWithAlternativeManager.all_polls)
 
 QuerySet Updates with History (Updated in Django 2.2)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

simple_history/exceptions.py

@@ -19,3 +19,9 @@ class RelatedNameConflictError(Exception):
     """Related name conflicting with history manager"""
 
     pass
+
+
+class AlternativeManagerError(Exception):
+    """Manager does not belong to model"""
+
+    pass

simple_history/tests/models.py

@@ -63,6 +63,21 @@ class PollWithExcludedFKField(models.Model):
     history = HistoricalRecords(excluded_fields=["place"])
 
 
+class AlternativePollManager(models.Manager):
+    def get_queryset(self):
+        return super(AlternativePollManager, self).get_queryset().exclude(id=1)
+
+
+class PollWithAlternativeManager(models.Model):
+    some_objects = AlternativePollManager()
+    all_objects = models.Manager()
+
+    question = models.CharField(max_length=200)
+    pub_date = models.DateTimeField("date published")
+
+    history = HistoricalRecords()
+
+
 class IPAddressHistoricalModel(models.Model):
     ip_address = models.GenericIPAddressField()
 

simple_history/tests/tests/test_utils.py

@@ -8,12 +8,13 @@
 from django.utils import timezone
 from mock import Mock, patch
 
-from simple_history.exceptions import NotHistoricalModelError
+from simple_history.exceptions import AlternativeManagerError, NotHistoricalModelError
 from simple_history.tests.models import (
     BulkCreateManyToManyModel,
     Document,
     Place,
     Poll,
+    PollWithAlternativeManager,
     PollWithExcludeFields,
     Street,
 )
@@ -42,13 +43,38 @@ def setUp(self):
             PollWithExcludeFields(id=4, question="Question 4", pub_date=timezone.now()),
             PollWithExcludeFields(id=5, question="Question 5", pub_date=timezone.now()),
         ]
+        self.data_with_alternative_manager = [
+            PollWithAlternativeManager(
+                id=1, question="Question 1", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=2, question="Question 2", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=3, question="Question 3", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=4, question="Question 4", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=5, question="Question 5", pub_date=timezone.now()
+            ),
+        ]
 
     def test_bulk_create_history(self):
         bulk_create_with_history(self.data, Poll)
 
         self.assertEqual(Poll.objects.count(), 5)
         self.assertEqual(Poll.history.count(), 5)
 
+    def test_bulk_create_history_alternative_manager(self):
+        bulk_create_with_history(
+            self.data, PollWithAlternativeManager,
+        )
+
+        self.assertEqual(PollWithAlternativeManager.all_objects.count(), 5)
+        self.assertEqual(PollWithAlternativeManager.history.count(), 5)
+
     def test_bulk_create_history_with_default_user(self):
         user = User.objects.create_user("tester", "[email protected]")
 
@@ -177,7 +203,7 @@ def test_bulk_create_fails_with_wrong_model(self):
     def test_bulk_create_no_ids_return(self, hist_manager_mock):
         objects = [Place(id=1, name="Place 1")]
         model = Mock(
-            objects=Mock(
+            _default_manager=Mock(
                 bulk_create=Mock(return_value=[Place(name="Place 1")]),
                 filter=Mock(return_value=objects),
             ),
@@ -311,6 +337,78 @@ def test_bulk_update_history_with_batch_size(self):
         self.assertEqual(Poll.history.filter(history_type="~").count(), 5)
 
 
+@skipIf(django.VERSION < (2, 2,), reason="bulk_update does not exist before 2.2")
+class BulkUpdateWithHistoryAlternativeManagersTestCase(TestCase):
+    def setUp(self):
+        self.data = [
+            PollWithAlternativeManager(
+                id=1, question="Question 1", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=2, question="Question 2", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=3, question="Question 3", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=4, question="Question 4", pub_date=timezone.now()
+            ),
+            PollWithAlternativeManager(
+                id=5, question="Question 5", pub_date=timezone.now()
+            ),
+        ]
+        bulk_create_with_history(
+            self.data, PollWithAlternativeManager,
+        )
+
+    def test_bulk_update_history_default_manager(self):
+        self.data[3].question = "Updated question"
+
+        bulk_update_with_history(
+            self.data, PollWithAlternativeManager, fields=["question"],
+        )
+
+        self.assertEqual(PollWithAlternativeManager.all_objects.count(), 5)
+        self.assertEqual(
+            PollWithAlternativeManager.all_objects.get(id=4).question,
+            "Updated question",
+        )
+        self.assertEqual(PollWithAlternativeManager.history.count(), 10)
+        self.assertEqual(
+            PollWithAlternativeManager.history.filter(history_type="~").count(), 5
+        )
+
+    def test_bulk_update_history_other_manager(self):
+        # filtered by default manager
+        self.data[0].question = "Updated question"
+
+        bulk_update_with_history(
+            self.data,
+            PollWithAlternativeManager,
+            fields=["question"],
+            manager=PollWithAlternativeManager.all_objects,
+        )
+
+        self.assertEqual(PollWithAlternativeManager.all_objects.count(), 5)
+        self.assertEqual(
+            PollWithAlternativeManager.all_objects.get(id=1).question,
+            "Updated question",
+        )
+        self.assertEqual(PollWithAlternativeManager.history.count(), 10)
+        self.assertEqual(
+            PollWithAlternativeManager.history.filter(history_type="~").count(), 5
+        )
+
+    def test_bulk_update_history_wrong_manager(self):
+        with self.assertRaises(AlternativeManagerError):
+            bulk_update_with_history(
+                self.data,
+                PollWithAlternativeManager,
+                fields=["question"],
+                manager=Poll.objects,
+            )
+
+
 class UpdateChangeReasonTestCase(TestCase):
     def test_update_change_reason_with_excluded_fields(self):
         poll = PollWithExcludeFields(

simple_history/utils.py

@@ -5,7 +5,7 @@
 from django.db.models import ManyToManyField
 from django.forms.models import model_to_dict
 
-from simple_history.exceptions import NotHistoricalModelError
+from simple_history.exceptions import AlternativeManagerError, NotHistoricalModelError
 
 
 def update_change_reason(instance, reason):
@@ -78,9 +78,11 @@ def bulk_create_with_history(
         if isinstance(field, ManyToManyField)
     ]
     history_manager = get_history_manager_for_model(model)
+    model_manager = model._default_manager
+
     second_transaction_required = True
     with transaction.atomic(savepoint=False):
-        objs_with_id = model.objects.bulk_create(objs, batch_size=batch_size)
+        objs_with_id = model_manager.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(
@@ -100,7 +102,7 @@ def bulk_create_with_history(
                         model_to_dict(obj, exclude=exclude_fields).items(),
                     )
                 )
-                obj_list += model.objects.filter(**attributes)
+                obj_list += model_manager.filter(**attributes)
             history_manager.bulk_history_create(
                 obj_list,
                 batch_size=batch_size,
@@ -120,6 +122,7 @@ def bulk_update_with_history(
     default_user=None,
     default_change_reason=None,
     default_date=None,
+    manager=None,
 ):
     """
     Bulk update the objects specified by objs while also bulk creating
@@ -134,15 +137,21 @@ def bulk_update_with_history(
         in each historical record
     :param default_date: Optional date to specify as the history_date in each historical
         record
+    :param manager: Optional model manager to use for the model instead of the default
+        manager
     """
     if django.VERSION < (2, 2,):
         raise NotImplementedError(
             "bulk_update_with_history is only available on "
             "Django versions 2.2 and later"
         )
     history_manager = get_history_manager_for_model(model)
+    model_manager = manager or model._default_manager
+    if model_manager.model is not model:
+        raise AlternativeManagerError("The given manager does not belong to the model.")
+
     with transaction.atomic(savepoint=False):
-        model.objects.bulk_update(objs, fields, batch_size=batch_size)
+        model_manager.bulk_update(objs, fields, batch_size=batch_size)
         history_manager.bulk_history_create(
             objs,
             batch_size=batch_size,