242 Fix

Author: barseghyanartur

CHANGELOG.rst

@@ -15,6 +15,13 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.22.1
+----
+2021-04-29
+
+- `DictionaryProxy` gets an optional `meta` argument, which will hold meta
+  information of the hit.
+
 0.22
 ----
 2021-03-26

docs/changelog.rst

@@ -15,6 +15,13 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.22.1
+----
+2021-04-29
+
+- `DictionaryProxy` gets an optional `meta` argument, which will hold meta
+  information of the hit.
+
 0.22
 ----
 2021-03-26

examples/simple/search_indexes/serializers/city.py

@@ -1,3 +1,5 @@
+from rest_framework import serializers
+
 from django_elasticsearch_dsl_drf.serializers import DocumentSerializer
 
 from ..documents import CityDocument
@@ -8,6 +10,8 @@
 class CityDocumentSerializer(DocumentSerializer):
     """Serializer for city document."""
 
+    es_id = serializers.SerializerMethodField()
+
     class Meta:
         """Meta options."""
 
@@ -23,4 +27,10 @@ class Meta:
             'datetime_list',
             'float_list',
             'integer_list',
+            'es_id',
         )
+
+    def get_es_id(self, obj):
+        if hasattr(obj.meta, 'id'):
+            return obj.meta.id
+        return None

examples/simple/search_indexes/serializers/journal.py

@@ -8,59 +8,6 @@
 )
 
 
-# class JournalDocumentSerializer(serializers.Serializer):
-#     """Serializer for the Book document."""
-#
-#     isbn = serializers.CharField(read_only=True)
-#
-#     title = serializers.CharField(read_only=True)
-#     description = serializers.CharField(read_only=True)
-#     summary = serializers.CharField(read_only=True)
-#
-#     publication_date = serializers.DateField(read_only=True)
-#
-#     price = serializers.FloatField(read_only=True)
-#     pages = serializers.IntegerField(read_only=True)
-#     stock_count = serializers.IntegerField(read_only=True)
-#     created = serializers.DateTimeField(read_only=True)
-#
-#     class Meta:
-#         """Meta options."""
-#
-#         fields = (
-#             'title',
-#             'description',
-#             'summary',
-#             'publication_date',
-#             'state',
-#             'isbn',
-#             'price',
-#             'pages',
-#             'stock_count',
-#             'created',
-#         )
-#         read_only_fields = fields
-#
-#     def create(self, validated_data):
-#         """Create.
-#
-#         Do nothing.
-#
-#         :param validated_data:
-#         :return:
-#         """
-#
-#     def update(self, instance, validated_data):
-#         """Update.
-#
-#         Do nothing.
-#
-#         :param instance:
-#         :param validated_data:
-#         :return:
-#         """
-
-
 class JournalDocumentSerializer(DocumentSerializer):
     """Serializer for the Book document."""
 

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import find_packages, setup
 
-version = '0.22'
+version = '0.22.1'
 
 DOCS_TRANSFORMATIONS = (
     (

src/django_elasticsearch_dsl_drf/__init__.py

@@ -3,14 +3,14 @@
 """
 
 __title__ = 'django-elasticsearch-dsl-drf'
-__version__ = '0.22'
+__version__ = '0.22.1'
 __author__ = 'Artur Barseghyan <[email protected]>'
 __copyright__ = '2017-2020 Artur Barseghyan'
 __license__ = 'GPL 2.0/LGPL 2.1'
 
 
 from django_nine import versions
 
-if versions.DJANGO_LT_3_2:
+if versions.DJANGO_LTE_3_1:
     __all__ = ('default_app_config',)
     default_app_config = 'django_elasticsearch_dsl_drf.apps.Config'

src/django_elasticsearch_dsl_drf/utils.py

@@ -54,8 +54,9 @@ def to_dict(self, *args, **kwargs):
 class DictionaryProxy(object):
     """Dictionary proxy."""
 
-    def __init__(self, mapping):
+    def __init__(self, mapping, meta=None):
         self.__mapping = mapping
+        self.meta = meta
 
     def __getattr__(self, item):
         val = self.__mapping.get(item, None)

src/django_elasticsearch_dsl_drf/viewsets.py

@@ -218,7 +218,14 @@ def get_object(self):
             if not obj and self.ignore:
                 raise Http404("No result matches the given query.")
             # TODO: Do we need obj on != ELASTICSEARCH_GTE_7_0 like below?
-            return self.dictionary_proxy(obj.to_dict())
+            if ELASTICSEARCH_GTE_7_0:
+                dictionary_proxy = self.dictionary_proxy(
+                    obj.to_dict(),
+                    obj.meta
+                )
+            else:
+                dictionary_proxy = self.dictionary_proxy(obj, obj.meta)
+            return dictionary_proxy
         else:
             queryset = queryset.filter(
                 'term',
@@ -234,9 +241,12 @@ def get_object(self):
                 # May raise a permission denied
                 self.check_object_permissions(self.request, obj)
                 if ELASTICSEARCH_GTE_7_0:
-                    dictionary_proxy = self.dictionary_proxy(obj.to_dict())
+                    dictionary_proxy = self.dictionary_proxy(
+                        obj.to_dict(),
+                        obj.meta
+                    )
                 else:
-                    dictionary_proxy = self.dictionary_proxy(obj)
+                    dictionary_proxy = self.dictionary_proxy(obj, obj.meta)
 
                 return dictionary_proxy