merge master > tymofij/solr-hl-options

Author: Steve Byerly

haystack/backends/solr_backend.py

@@ -189,7 +189,13 @@ def build_search_kwargs(self, query_string, sort_by=None, start_offset=0, end_of
             kwargs['hl.fragsize'] = '200'
 
             if isinstance(highlight, dict):
-                kwargs.update(highlight)
+                # autoprefix highlighter options with 'hl.', all of them start with it anyway
+                # this makes option dicts shorter: {'maxAnalyzedChars': 42}
+                # and lets some of options be used as keyword arguments: `.highlight(preserveMulti=False)`
+                kwargs.update({
+                    key if key.startswith("hl.") else ('hl.' + key): highlight[key] 
+                    for key in highlight.keys()
+                })
 
         if self.include_spelling is True:
             kwargs['spellcheck'] = 'true'

test_haystack/solr_tests/test_solr_backend.py

@@ -390,6 +390,22 @@ def test_search(self):
         self.assertEqual(self.sb.search('Index', highlight=True)['hits'], 3)
         self.assertEqual([result.highlighted['text'][0] for result in self.sb.search('Index', highlight=True)['results']], ['<em>Indexed</em>!\n1', '<em>Indexed</em>!\n2', '<em>Indexed</em>!\n3'])
 
+        # shortened highlighting options
+        highlight_dict = {'simple.pre':'<i>', 'simple.post': '</i>'}
+        self.assertEqual(self.sb.search('', highlight=highlight_dict), {'hits': 0, 'results': []})
+        self.assertEqual(self.sb.search('Index', highlight=highlight_dict)['hits'], 3)
+        self.assertEqual([result.highlighted['text'][0] for result in self.sb.search('Index', highlight=highlight_dict)['results']], 
+            ['<i>Indexed</i>!\n1', '<i>Indexed</i>!\n2', '<i>Indexed</i>!\n3'])
+
+        # full-form highlighting options
+        highlight_dict = {'hl.simple.pre':'<i>', 'hl.simple.post': '</i>'}
+        self.assertEqual([result.highlighted['text'][0] for result in self.sb.search('Index', highlight=highlight_dict)['results']], 
+            ['<i>Indexed</i>!\n1', '<i>Indexed</i>!\n2', '<i>Indexed</i>!\n3'])
+
+        self.assertEqual(self.sb.search('Indx')['hits'], 0)
+        self.assertEqual(self.sb.search('indax')['spelling_suggestion'], 'index')
+        self.assertEqual(self.sb.search('Indx', spelling_query='indexy')['spelling_suggestion'], 'index')
+
         self.assertEqual(self.sb.search('', facets={'name': {}}), {'hits': 0, 'results': []})
         results = self.sb.search('Index', facets={'name': {}})
         self.assertEqual(results['hits'], 3)