Misleading Code in Admin Example

[wkschwartz@…]

In ​https://docs.djangoproject.com/en/1.7/ref/contrib/admin/#django.contrib.admin.ModelAdmin.get_search_results there is a code example:

def get_search_results(self, request, queryset, search_term):
    queryset, use_distinct = super(PersonAdmin, self).get_search_results(request, queryset, search_term)
    try:
        search_term_as_int = int(search_term)
        queryset |= self.model.objects.filter(age=search_term_as_int)
    except:
        pass
    return queryset, use_distinct

This code catches a SystemExit when all it meant to do was deal with the case when search_term is not an integer. See ​https://docs.python.org/2/howto/doanddont.html#except

Better would be:

def get_search_results(self, request, queryset, search_term):
    queryset, use_distinct = super(PersonAdmin, self).get_search_results(request, queryset, search_term)
    try:
        search_term_as_int = int(search_term)
    except ValueError:
        pass
    queryset |= self.model.objects.filter(age=search_term_as_int)
    return queryset, use_distinct

[Rainer Koirikivi]

Having the queryset |= ... line after the except clause, as in the suggested example, causes an exception in case int(search_term) fails.

[Tim Graham]

How about putting queryset != ... in the else clause of the try/except.

[Baptiste Mispelon <bmispelon@…>]

In e5619330e2d3bf901155e98ef3fa7d224b6a260a:

Fixed #23123 -- Don't use a bare except in ModelAdmin documentation

Thanks to wkschwartz for the report and to Tim for the patch.

[Baptiste Mispelon <bmispelon@…>]

In 9fb1652ac33f3ea7ba2f05e089d73691c9d41b8e:

[1.7.x] Fixed #23123 -- Don't use a bare except in ModelAdmin documentation

Thanks to wkschwartz for the report and to Tim for the patch.

Backport of e5619330e2d3bf901155e98ef3fa7d224b6a260a from master.

[Tim Graham <timograham@…>]

In 8e25b696ba896f7f9b07565e7559aa08e743288a:

[1.6.x] Fixed #23123 -- Don't use a bare except in ModelAdmin documentation

Thanks to wkschwartz for the report and to Tim for the patch.

Backport of e5619330e2 from master