Commit 539e3693 authored by Jim Bailey's avatar Jim Bailey Committed by Anssi Kääriäinen
Browse files

Fixed #20849 -- ModelForms do not work well with prefetch_related. 

model_to_dict() (used when rendering forms) queries the database
to get the list of primary keys for ManyToMany fields. This is
unnecessary if the field queryset has been prefetched, all the
keys are already in memory and can be obtained with a simple
iteration.
parent 4202d9cf

django/forms/models.py

+5 −1
Original line number Diff line number Diff line
@@ -134,7 +134,11 @@ def model_to_dict(instance, fields=None, exclude=None): 
                data[f.name] = []

            else:

                # MultipleChoiceWidget needs a list of pks, not object instances.

                data[f.name] = list(f.value_from_object(instance).values_list('pk', flat=True))

                qs = f.value_from_object(instance)

                if qs._result_cache is not None:

                    data[f.name] = [item.pk for item in qs]

                else:

                    data[f.name] = list(qs.values_list('pk', flat=True))

        else:

            data[f.name] = f.value_from_object(instance)

    return data

tests/model_forms/tests.py

+35 −0
Original line number Diff line number Diff line
@@ -824,6 +824,41 @@ class ModelToDictTests(TestCase): 
        # Ensure many-to-many relation appears as a list

        self.assertIsInstance(d['categories'], list)



    def test_reuse_prefetched(self):

        # model_to_dict should not hit the database if it can reuse

        # the data populated by prefetch_related.

        categories = [

            Category(name='TestName1', slug='TestName1', url='url1'),

            Category(name='TestName2', slug='TestName2', url='url2'),

            Category(name='TestName3', slug='TestName3', url='url3')

        ]

        for c in categories:

            c.save()

        writer = Writer(name='Test writer')

        writer.save()



        art = Article(

            headline='Test article',

            slug='test-article',

            pub_date=datetime.date(1988, 1, 4),

            writer=writer,

            article='Hello.'

        )

        art.save()

        for c in categories:

            art.categories.add(c)



        art = Article.objects.prefetch_related('categories').get(pk=art.pk)



        with self.assertNumQueries(0):

            d = model_to_dict(art)



        #Ensure all many-to-many categories appear in model_to_dict

        for c in categories:

            self.assertIn(c.pk, d['categories'])

        #Ensure many-to-many relation appears as a list

        self.assertIsInstance(d['categories'], list)



class OldFormForXTests(TestCase):

    def test_base_form(self):

        self.assertEqual(Category.objects.count(), 0)