Sentry Answers>Django>

How do you filter empty or null names in a QuerySet

How do you filter empty or null names in a QuerySet

Gareth D.

The Problem

How can you retrieve models in Django, filtering out those where a specific attribute is null or empty?

The Solution

If you’re using plain Python, you have access to operators such as != to negate an equality clause. But if you’re writing filter() queries in Django, you can only use =. To do more advanced queries, including except queries, you have a few options, including:

  • Using exclude
  • Using the __isnull field lookup
  • Using query objects

Assume you have a User object with an optional bio field that is null by default and set to "" by some users.

Click to Copy
class User(models.Model): name = models.CharField(max_length=100) bio = models.CharField(max_length=1000, blank=True, null=True, default=None)

The following examples show how to select the users with completed bio fields.

Using exclude

The simplest way to exclude all objects where a specific field is null (None) or empty (''), is to chain exclude filters.

To get all the users that have filled out their bio, you could use:

Click to Copy
users = User.objects.exclude(bio='').exclude(bio=None)

Using the __isnull field lookup

If you want to filter out only those that are set to NULL (equivalent to SQL IS NOT NULL), use the following. Note that in this case, you’ll still get users with a blank ('') bio field.

Click to Copy
users = User.objects.filter(bio__isnull=False)

Using a Q Query

For a simple case like this, you should avoid Django’s advanced Q objects, but they can be useful in more complex cases, and they are easy to negate using ~.

To use Q, you first need to import it:

Click to Copy
from django.db.models import Q

Now you can make two queries, one to look for bio=None and one to look for bio=''. You use the or operator (|) to chain them together, and the not operator (~) to invert the query. The following asks for the opposite of all users who have a null or blank bio.

Click to Copy
users = User.objects.filter(~(Q(bio=None) | Q(bio='')))
  • Syntax.fmListen to the Syntax Podcast
  • Community SeriesIdentify, Trace, and Fix Endpoint Regression Issues
  • ResourcesBackend Error Monitoring 101
  • Syntax.fm logo
    Listen to the Syntax Podcast

    Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.

    SEE EPISODES

Considered “not bad” by 4 million developers and more than 100,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

© 2024 • Sentry is a registered Trademark
of Functional Software, Inc.