Added a highlight dictionary to DocType.meta (closes #62)

elasticsearch_dsl/document.py

@@ -120,6 +120,8 @@ def get(cls, id, using=None, index=None, **kwargs):
     def from_es(cls, hit):
         # don't modify in place
         meta = hit.copy()
+        # make sure highlighting information ends up in meta
+        meta['_highlight'] = meta.pop('highlight', {})
         doc = meta.pop('_source')
         return cls(meta=meta, **doc)
 

test_elasticsearch_dsl/test_integration/test_document.py

@@ -19,6 +19,7 @@ class Meta:
 class Commit(DocType):
     committed_date = Date()
     authored_date = Date()
+    description = String(analyzer='snowball')
 
     class Meta:
         index = 'git'
@@ -76,9 +77,9 @@ def test_delete(write_client):
     )
 
     test_repo = Repository(meta={'id': 'elasticsearch-dsl-py'})
-    test_repo.meta.index='test-document'
+    test_repo.meta.index = 'test-document'
     test_repo.delete()
-    
+
     assert not write_client.exists(
         index='test-document',
         doc_type='repos',
@@ -109,3 +110,11 @@ class Meta:
     assert 'description' in Commit._doc_type.mapping
     assert 'committed_date' in Commit._doc_type.mapping
     assert isinstance(Commit._doc_type.mapping['committed_date'], Date)
+
+def test_highlight_in_meta(data_client):
+    commit = Commit.search().query('match', description='inverting').highlight('description').execute()[0]
+
+    assert isinstance(commit, Commit)
+    assert 'description' in commit.meta.highlight
+    assert isinstance(commit.meta.highlight['description'], list)
+    assert len(commit.meta.highlight['description']) > 0