Django

Code

Ticket #9897 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

Misleading model formsets docs

Reported by: sorl Assigned to: jacob
Milestone: 1.1 Component: Documentation
Version: 1.0 Keywords:
Cc: mikko@sorl.net Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

The following example could easily generate an invalid queryset: 

from django.forms.models import BaseModelFormSet

class BaseAuthorFormSet(BaseModelFormSet):
    def get_queryset(self):
        return super(BaseAuthorFormSet, self).get_queryset().filter(name__startswith='O')

Calling super method will slice the queryset if max_num is set, and thus filter on the slice will be invalid. The following would be more correct: 

from django.forms.models import BaseModelFormSet

class BaseAuthorFormSet(BaseModelFormSet):
    def get_queryset(self):
        if not hasattr(self, '_queryset'):
            if self.queryset is not None:
                qs = self.queryset
            else:
                qs = self.model._default_manager.get_query_set().filter(name__startswith='O')
            if self.max_num > 0:
                self._queryset = qs[:self.max_num]
            else:
                self._queryset = qs
        return self._queryset

Attachments

Change History

12/20/08 17:08:55 changed by sorl

  • needs_better_patch changed.
  • component changed from Forms to Documentation.
  • needs_tests changed.
  • needs_docs changed.

02/27/09 08:50:51 changed by jacob

  • stage changed from Unreviewed to Accepted.
  • milestone set to 1.1.

02/27/09 13:58:21 changed by sorl

Reviewing it again I realize it should read: 

from django.forms.models import BaseModelFormSet

class BaseAuthorFormSet(BaseModelFormSet):
    def get_queryset(self):
        if not hasattr(self, '_queryset'):
            if self.queryset is not None:
                qs = self.queryset
            else:
                qs = self.model._default_manager.get_query_set()
            qs = qs.filter(name__startswith='O')
            if self.max_num > 0:
                self._queryset = qs[:self.max_num]
            else:
                self._queryset = qs
        return self._queryset

04/02/09 13:44:35 changed by jacob

  • owner changed from nobody to jacob.
  • status changed from new to assigned.

04/03/09 13:30:55 changed by jacob

  • status changed from assigned to closed.
  • resolution set to fixed.

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.

Add/Change #9897 (Misleading model formsets docs)




Change Properties
Action