Added request parameter to ModelSelect2Mixin.result_from_instance() method.

Author: sdolemelipone

django_select2/forms.py

@@ -554,17 +554,20 @@ def label_from_instance(obj):
         """
         return str(obj)
 
-    def result_from_instance(self, obj):
+    def result_from_instance(self, obj, request):
         """
         Return a dictionary representing the object.
 
         Can be overridden to change the result returned by
         :class:`.AutoResponseView` for each object.
 
+        The request passed in will correspond to the request sent to the
+        :class:`.AutoResponseView` by the widget.
+
         Example usage::
 
             class MyWidget(ModelSelect2Widget):
-                def result_from_instance(obj):
+                def result_from_instance(obj, request):
                     return {
                         'id': obj.pk,
                         'text': self.label_from_instance(obj),

django_select2/views.py

@@ -44,7 +44,7 @@ def get(self, request, *args, **kwargs):
         return JsonResponse(
             {
                 "results": [
-                    self.widget.result_from_instance(obj)
+                    self.widget.result_from_instance(obj, request)
                     for obj in context["object_list"]
                 ],
                 "more": context["page_obj"].has_next(),

tests/test_forms.py

@@ -442,7 +442,7 @@ def test_result_from_instance_ModelSelect2Widget(self, genres):
         widget = ModelSelect2Widget()
         widget.model = Genre
         genre = Genre.objects.first()
-        assert widget.result_from_instance(genre) == {
+        assert widget.result_from_instance(genre, request=None) == {
             "id": genre.pk,
             "text": str(genre),
         }

tests/testapp/forms.py

@@ -238,7 +238,7 @@ class CityModelSelect2Widget(ModelSelect2Widget):
     model = City
     search_fields = ["name"]
 
-    def result_from_instance(self, obj):
+    def result_from_instance(self, obj, request):
         return {"id": obj.pk, "text": obj.name, "country": str(obj.country)}