Is there Django List View model sort?

Question

I'm using ListView in my Class Based Views and I was wondering if there was a way to display the model object set on the template by sorting it. This is what I have so far:

My views:

class Reviews(ListView):
    model = ProductReview
    paginate_by = 50
    template_name = 'review_system/reviews.html'

The model ProductReview has a date_created field. I'd like to sort the date in descending order. How can I achieve this?

It may be possible that you may want the same ordering in multiple views. In that case, you may also look into Meta order which is set on the model itself. — Akshay Gaur
– Akshay Gaur, Commented Sep 28, 2018 at 13:58

FiddleStix · Accepted Answer · 2020-02-25 11:44:09Z

96

Set the ordering attribute for the view.

class Reviews(ListView):
    model = ProductReview
    paginate_by = 50
    template_name = 'review_system/reviews.html'

    ordering = ['-date_created']

If you need to change the ordering dynamically, you can use get_ordering instead.

class Reviews(ListView):
    ...
    def get_ordering(self):
        ordering = self.request.GET.get('ordering', '-date_created')
        # validate ordering here
        return ordering

If you are always sorting a fixed date field, you may be interested in the ArchiveIndexView.

from django.views.generic.dates import ArchiveIndexView

class Reviews(ArchiveIndexView):
    model = ProductReview
    paginate_by = 50
    template_name = 'review_system/reviews.html'
    date_field = "date_created"

Note that ArchiveIndexView won't show objects with a date in the future unless you set allow_future to True.

edited Feb 25, 2020 at 11:44

FiddleStix

3,91123 silver badges22 bronze badges

answered Mar 9, 2017 at 14:44

Alasdair

310k59 gold badges605 silver badges534 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

DeA Over a year ago

I like the ArchiveIndexView, it does the trick, but the template has a table that allows sorting columns by clicking on headers. When I do that, this doesn't work, do you know how I could make it work there as well?

Alasdair Over a year ago

If you're sorting by other fields, it sounds like the archive index view is not suitable.

Alasdair Over a year ago

@user3118363 please ask a new question, I’m not on Stack Overflow much any more so can’t help in the comments

nik_m · Accepted Answer · 2017-03-09 14:56:25Z

9

Why don't you override the get_queryset method like this:

class Reviews(ListView):
    model = ProductReview
    paginate_by = 50
    template_name = 'review_system/reviews.html'

    def get_queryset(self):
        return YourModel.objects.order_by('model_field_here')

edited Mar 9, 2017 at 14:56

answered Mar 9, 2017 at 14:45

nik_m

12.1k4 gold badges47 silver badges61 bronze badges

4 Comments

DeA Over a year ago

I'll try this, but your method is missing a def

DeA Over a year ago

This did not have any errors rendering or executing, but the order_by did not work.

Alasdair Over a year ago

@DeA Overriding get_queryset and using order_by should work, although with ListView you might prefer to override ordering or get_ordering instead.

Akshay Gaur Over a year ago

This works perfectly well. I had to do a custom order using Case, When, Then, Value clause which I could not do with get_ordering.

Collectives™ on Stack Overflow

Is there Django List View model sort?

2 Answers 2

3 Comments

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related