Referencing User in Your Models

Introduction

Welcome to the first lesson in our course on implementing an API for a TODO app with Django . In this lesson, we will explore how to reference users in your models — a crucial step toward personalizing and managing user-related data in web applications. By the end of this lesson, you will understand how to use Django's built-in User model, incorporate user references into existing models, and validate these modifications with testing. This foundational knowledge will set the stage for developing user-centric features seamlessly.

Recap of the Existing Models

Before we dive into the new content, let's quickly revisit the Group, Tag, and Todo models that you've previously implemented. This will help us set the foundation for adding user references. Here is a summary code block of these models: Python class Group(models.Model): name = models.CharField(max_length=50) class Tag(models.Model): description = models.CharField(max_length=20) color = models.CharField(max_length=7) class Todo(models.Model): task = models.CharField(max_length=255) completed = models.BooleanField(default=False) priority = models.IntegerField() group = models.ForeignKey(Group, on_delete=models.CASCADE, null=True, blank=True) These models are currently not associated with users. Our task is to modify them by incorporating user references using Django's built-in User model.

Understanding the Django User Model

The Django framework provides a robust User model out of the box, designed to handle user authentication and management. This model includes essential fields like username, password, email, and more. Using Django's User model streamlines the management of user-related data, leveraging tested and secure components. Utilizing this pre-defined model brings several benefits: Simplicity: Save time by using a pre-built model with necessary authentication fields. Consistency: Using a standard User model ensures your code aligns with industry best practices. Security: Benefit from Django's security features, like password hashing, automatically. With this understanding, you can now enhance the existing models by linking them with the User model.

Adding User References to Models

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Updating Other Models

We can update other models similarly:

Python

class Tag(models.Model):
    description = models.CharField(max_length=20)
    color = models.CharField(max_length=7)
    user = models.ForeignKey(User, on_delete=models.CASCADE)

    def __str__(self):
        return self.description


class Todo(models.Model):
    task = models.CharField(max_length=255)
    completed = models.BooleanField(default=False)
    priority = models.IntegerField()
    assignee = models.ForeignKey(User, on_delete=models.CASCADE, related_name='assigned_todos', null=True, blank=True)
    group = models.ForeignKey(Group, on_delete=models.CASCADE, null=True, blank=True)
    due_date = models.DateTimeField(auto_now_add=True, blank=True, null=True)
    tags = models.ManyToManyField(Tag, blank=True)
    user = models.ForeignKey(User, on_delete=models.CASCADE, related_name='todos')

    def __str__(self):
        return self.task

class Tag(models.Model):
    description = models.CharField(max_length=20)
    color = models.CharField(max_length=7)
    user = models.ForeignKey(User, on_delete=models.CASCADE)

    def __str__(self):
        return self.description


class Todo(models.Model):
    task = models.CharField(max_length=255)
    completed = models.BooleanField(default=False)
    priority = models.IntegerField()
    assignee = models.ForeignKey(User, on_delete=models.CASCADE, related_name='assigned_todos', null=True, blank=True)
    group = models.ForeignKey(Group, on_delete=models.CASCADE, null=True, blank=True)
    due_date = models.DateTimeField(auto_now_add=True, blank=True, null=True)
    tags = models.ManyToManyField(Tag, blank=True)
    user = models.ForeignKey(User, on_delete=models.CASCADE, related_name='todos')

    def __str__(self):
        return self.task

The assignee field is another user reference, allowing specific users to be assigned to a Todo item separately from the owner or creator (user).
related_name provides a way to access reverse relationships from the user perspective. For example, related_name='assigned_todos' allows you to query todos assigned to a specific user using user.assigned_todos.all(). Similarly, related_name='todos' allows retrieval of todos owned by the user using user.todos.all().

These associations enable a structured relationship in your database, providing a way to keep all the models user-specific.

Writing Tests to Validate Model Changes: Setup

Testing ensures that the models behave as expected and verifies the correctness of our user references. The setUp method is a part of the Django TestCase where you initialize data before each test. Let's see how to structure this part: