Add post_index signal (#349)

* Add `post_index` signal

* Add actions to post_index signal

* Update post_index_signal test

Author: saadmk11

django_elasticsearch_dsl/documents.py

@@ -23,6 +23,7 @@
     TextField,
 )
 from .search import Search
+from .signals import post_index
 
 model_field_class_to_field_class = {
     models.AutoField: IntegerField,
@@ -144,7 +145,15 @@ def to_field(cls, field_name, model_field):
             )
 
     def bulk(self, actions, **kwargs):
-        return bulk(client=self._get_connection(), actions=actions, **kwargs)
+        response = bulk(client=self._get_connection(), actions=actions, **kwargs)
+        # send post index signal
+        post_index.send(
+            sender=self.__class__,
+            instance=self,
+            actions=actions,
+            response=response
+        )
+        return response
 
     def parallel_bulk(self, actions, **kwargs):
         if self.django.queryset_pagination and 'chunk_size' not in kwargs:

django_elasticsearch_dsl/signals.py

@@ -7,6 +7,7 @@
 from __future__ import absolute_import
 
 from django.db import models
+from django.dispatch import Signal
 
 from .registries import registry
 
@@ -94,3 +95,7 @@ def teardown(self):
         models.signals.post_delete.disconnect(self.handle_delete)
         models.signals.m2m_changed.disconnect(self.handle_m2m_changed)
         models.signals.pre_delete.disconnect(self.handle_pre_delete)
+
+
+# Sent after document indexing is completed
+post_index = Signal()

docs/source/es_index.rst

@@ -1,5 +1,5 @@
 Index
-######
+#####
 
 In typical scenario using `class Index` on a `Document` class is sufficient to perform any action.
 In a few cases though it can be useful to manipulate an Index object directly.
@@ -60,3 +60,25 @@ in Elasticsearch with appropriate mapping.
 ** If your model have huge amount of data, its preferred to use `parallel` indexing.
 To do that, you can pass `--parallel` flag while reindexing or populating.
 **
+
+
+Signals
+=======
+
+* ``django_elasticsearch_dsl.signals.post_index``
+    Sent after document indexing is completed. (not applicable for ``parallel`` indexing).
+    Provides the following arguments:
+
+    ``sender``
+        A subclass of ``django_elasticsearch_dsl.documents.DocType`` used
+        to perform indexing.
+
+    ``instance``
+        A ``django_elasticsearch_dsl.documents.DocType`` subclass instance.
+
+    ``actions``
+        A generator containing document data that were sent to elasticsearch for indexing.
+
+    ``response``
+        The response from ``bulk()`` function of ``elasticsearch-py``,
+        which includes ``success`` count and ``failed`` count or ``error`` list.

tests/test_signals.py

@@ -0,0 +1,45 @@
+from unittest import TestCase
+
+from mock import Mock, patch
+
+from django_elasticsearch_dsl.documents import DocType
+from django_elasticsearch_dsl.registries import registry
+from django_elasticsearch_dsl.signals import post_index
+
+from .models import Car
+
+
+class PostIndexSignalTestCase(TestCase):
+
+    @patch('django_elasticsearch_dsl.documents.DocType._get_actions')
+    @patch('django_elasticsearch_dsl.documents.bulk')
+    def test_post_index_signal_sent(self, bulk, get_actions):
+
+        @registry.register_document
+        class CarDocument(DocType):
+            class Django:
+                fields = ['name']
+                model = Car
+
+        bulk.return_value = (1, [])
+
+        # register a mock signal receiver
+        mock_receiver = Mock()
+        post_index.connect(mock_receiver)
+
+        doc = CarDocument()
+        car = Car(
+            pk=51,
+            name="Type 57"
+        )
+        doc.update(car)
+
+        bulk.assert_called_once()
+
+        mock_receiver.assert_called_once_with(
+            signal=post_index,
+            sender=CarDocument,
+            instance=doc,
+            actions=get_actions(),
+            response=(1, [])
+        )