Back
Jul 01, 2010

Overriding QuerySet in Django

Vladimir Sidorenko
Vladimir Sidorenko

As you know, model managers can be overriden in Django. It's convenient to add custom filtration method there:

Article.objects.published()
    Article.objects.old()

But these custom methods cannot be chained:

Article.objects.published().old()

Overriding manager doesn't allow it, because after first manager method is invoked (publishedin this case), we receive queryset as a result, which knows nothing about custom manager methods. So we have to add custom methods to queryset. This can look like this:

class ArticleQuerySet(models.query.QuerySet):

        def published(self):
            return self.filter("...")

        def old(self):
            return self.filter("...")

Now we need to make manager user this class. In order to do this, let's override manager's get_query_set method:

class ArticleManager(models.Manager):

        def get_query_set(self):
            return ArticleQuerySet(self.model, using=self._db)

    class Article(models.Model):

        # ...

        objects = ArticleManager()

This allows to make queties like:

Article.objects.all().published().old()

Here we invoke all to get queryset instance, because this time manager doesn't have custom methods - publishedand old. To avoid this, we can make manager look for undefined methods in queryset:

class ArticleManager(models.Manager):

        def get_query_set(self):
            return ArticleQuerySet(self.model, using=self._db)

        def getattr(self, key):
            return getattr(self.get_query_set(), key)

Note that getattris only invoked when attribute is not found by usual means.

Manager can be further improved to be more generic:

class QuerySetManager(models.Manager):

        def init(self, queryset_class, args, **kwargs):
            self.queryset_class = queryset_class
            super(QuerySetManager, self).init(args, **kwargs)

        def get_query_set(self):
            return self.queryset_class(self.model, using=self._db)

        def getattr(self, key):
            return getattr(self.get_query_set(), key)

       # Теперь можно писать просто:
       # objects = QuerySetManager(ArticleQuerySet)
       #

Update

After article was published, I found out that this idea is not all that new and unique :)

It's funny that only after I implemented my own solution, I've managed to make correct search query.

More thoughts

May 09, 2018Technology
How to Generate PDF Files in Python with Xhtml2pdf, WeasyPrint or Unoconv

Programmatic generation of PDF files is a frequent task when developing applications that can export reports, bills, or questionnaires. In this article, we will consider three common tools for creating PDFs, including their installation and converting principles.

Vladimir Sidorenko
Vladimir Sidorenko
Jun 14, 2017Technology
How to Deploy a Django Application on Heroku?

In this article I'll show you how to deploy Django with Celery and Postgres to Heroku.

Vladimir Kalyuzhny
Vladimir Kalyuzhny
Mar 12, 2017Technology
Creating a chat with Django Channels

Nowadays, when every second large company has developed its own instant messenger, in the era of iMessages, Slack, Hipchat, Messager, Google Allo, Zulip and others, I will tell you how to keep up with the trend and write your own chat, using django-channels 0.17.3, django 1.10.x, python 3.5.x.

Mikhail Andreev
Mikhail Andreev
Sep 23, 2010Technology
Dynamic class generation, QuerySetManager and use_for_related_fields

It appears that not everyone knows that in python you can create classes dynamically without metaclasses. I'll show an example of how to do it.So we've learned how to use custom QuerySet to chain requests:Article.objects.old().public()Now we need to make it work for related objects:user.articles.old().public()This is done using use_for_related_fields, but it needs a little trick.

Vladimir Sidorenko
Vladimir Sidorenko