return empty dict when no highlight

Author: dojutsu-user

readthedocs/search/api.py

@@ -1,6 +1,5 @@
 import itertools
 import logging
-from operator import attrgetter
 from pprint import pformat
 
 from rest_framework import generics, serializers
@@ -48,27 +47,13 @@ def get_inner_hits(self, obj):
             sections = inner_hits.sections or []
             domains = inner_hits.domains or []
             all_results = itertools.chain(sections, domains)
-
-            sorted_results = [
-                {
-                    'type': hit._nested.field,
-                    '_source': hit._source.to_dict(),
-                    'highlight': self._get_inner_hits_highlights(hit),
-                }
-                for hit in sorted(all_results, key=attrgetter('_score'), reverse=True)
-            ]
-
+            sorted_results = list(utils._get_sorted_results(
+                results=all_results,
+                source_key='_source',
+                logging=True,
+            ))
             return sorted_results
 
-    def _get_inner_hits_highlights(self, hit):
-        """Removes new lines from highlight and log it."""
-        highlight_dict = utils._remove_newlines_from_dict(
-            hit.highlight.to_dict()
-        )
-
-        log.debug('API Search highlight: %s', pformat(highlight_dict))
-        return highlight_dict
-
 
 class PageSearchAPIView(generics.ListAPIView):
 

readthedocs/search/utils.py

@@ -1,6 +1,8 @@
 """Utilities related to reading and generating indexable search content."""
 
 import logging
+from pprint import pformat
+from operator import attrgetter
 
 from django.shortcuts import get_object_or_404
 from django_elasticsearch_dsl.apps import DEDConfig
@@ -174,3 +176,31 @@ def _remove_newlines_from_dict(highlight):
                 highlight[k] = v_new_list
 
     return highlight
+
+
+def _get_inner_hits_highlights(hit, logging=False):
+    """Removes new lines from highlight dict"""
+    if hasattr(hit, 'highlight'):
+        highlight_dict = _remove_newlines_from_dict(
+            hit.highlight.to_dict()
+        )
+
+        if logging:
+            log.debug('API Search highlight: %s', pformat(highlight_dict))
+
+        return highlight_dict
+    return {}
+
+
+def _get_sorted_results(results, source_key='_source', logging=False):
+    """Sort results according to their score and return a generator expression."""
+    sorted_results = (
+        {
+            'type': hit._nested.field,
+            source_key: hit._source.to_dict(),
+            'highlight': _get_inner_hits_highlights(hit, logging)
+        }
+        for hit in sorted(results, key=attrgetter('_score'), reverse=True)
+    )
+
+    return sorted_results

readthedocs/search/views.py

@@ -117,21 +117,11 @@ def elastic_search(request, project_slug=None):
                     domains = inner_hits.domains or []
                     all_results = itertools.chain(sections, domains)
 
-                    sorted_results = [
-                        {
-                            'type': hit._nested.field,
-
-                            # here _source term is not used because
-                            # django gives error if the names of the
-                            # variables start with underscore
-                            'source': hit._source.to_dict(),
-
-                            'highlight': utils._remove_newlines_from_dict(
-                                hit.highlight.to_dict()
-                            ),
-                        }
-                        for hit in sorted(all_results, key=attrgetter('_score'), reverse=True)
-                    ]
+                    sorted_results = list(utils._get_sorted_results(
+                        results=all_results,
+                        source_key='source',
+                        logging=False,
+                    ))
 
                     result.meta.inner_hits = sorted_results
             except Exception: