Snippet

Django Custom Model Manager with Chaining Methods

Custom managers allow you to define reusable query logic directly on your models. By chaining custom methods with Django's QuerySet methods, you create a fluent API for common queries. The default.objects manager remains accessible while adding a custom published manager for publication-specific queries.

snippet.py

python

from django.db import models
from django.utils import timezone
 
class PublishedManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(status='published')
    
    def by_year(self, year):
        return self.get_queryset().filter(published_at__year=year)
    
    def this_month(self):
        now = timezone.now()
        return self.get_queryset().filter(
            published_at__month=now.month,
            published_at__year=now.year
        )
 
class Article(models.Model):
    title = models.CharField(max_length=200)
    status = models.CharField(max_length=10, default='draft')
    published_at = models.DateTimeField(null=True, blank=True)
    
    objects = models.Manager()
    published = PublishedManager()
    
    class Meta:
        ordering = ['-published_at']
 
# Usage examples:
Article.published.all()  # Only published articles
Article.published.by_year(2024)  # Published in 2024
Article.published.this_month()  # Published this month
Article.published.by_year(2024).count()

django

Breakdown

class PublishedManager(models.Manager):

Extend models.Manager to create custom manager with publication-specific logic

def get_queryset(self):

Override to return filtered queryset by default - only 'published' status articles

def by_year(self, year):

Custom method that returns QuerySet filtered by publication year, chainable

def this_month(self):

Uses timezone.now() to filter articles published in current month

objects = models.Manager()

Keep default Manager accessible alongside custom manager

published = PublishedManager()

Custom manager instance allows Article.published.* query interface

Article.published.by_year(2024).count()

Chain custom methods with QuerySet methods for powerful, readable queries

Previous snippet Next snippet

More Intermediate Python exercises →

Django Custom Model Manager with Chaining Methods

Related