使用 Django 和 HTMX 创建 To-Do 应用程序 - 使用 TDD 添加 Todo 模型部分

这是我们关于如何使用 HTMX 和 Django 构建 Todo 应用程序系列的第二篇文章。单击此处查看第 1 部分。

在第 2 部分中，我们将创建 Todo 模型并通过单元测试实现其基本功能。

创建 Todo 模型

在 models.py 中，我们创建 Todo 模型及其基本属性。我们希望将 Todo 项目与 UserProfile 相关联，以便用户只能看到自己的项目。待办事项还将有一个标题和一个布尔属性 is_completed。我们对 Todo 模型有很多未来的想法，例如除了已完成或未开始之外还可以将任务设置为“正在进行”，以及截止日期，但那是以后的事了。现在让我们保持简单，尽快在屏幕上显示一些内容。

注意：在现实世界的应用程序中，我们可能应该考虑使用 UUID 作为 UserProfile 和 Todo 模型的主键，但我们现在会保持简单。

# core/models.py

from django.contrib.auth.models import AbstractUser
from django.db import models  # <-- NEW

class UserProfile(AbstractUser):
    pass

# NEW
class Todo(models.Model):
    title = models.CharField(max_length=255)
    is_completed = models.BooleanField(default=False)
    user = models.ForeignKey(
        UserProfile,
        related_name="todos",
        on_delete=models.CASCADE,
    )
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    def __str__(self):
        return self.title

让我们运行新模型的迁移：

❯ uv run python manage.py makemigrations
Migrations for 'core':
  core/migrations/0002_todo.py
    + Create model Todo
❯ uv run python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, core, sessions
Running migrations:
  Applying core.0002_todo... OK

编写我们的第一个测试

让我们为我们的项目编写第一个测试。我们希望确保用户只能看到自己的待办事项，而看不到其他用户的项目。

为了帮助我们编写测试，我们将向我们的项目 model-bakery 添加新的开发依赖项，这简化了创建虚拟 Django 模型实例的过程。我们还将添加 pytest-django。

❯ uv add model-bakery pytest-django --dev
Resolved 27 packages in 425ms
Installed 2 packagez in 12ms
 + model-bakery==1.20.0
 + pytest-django==4.9.0

在 pyproject.toml 中，我们需要通过在文件末尾添加一些行来配置 pytest：

# pyproject.toml

# NEW
[tool.pytest.ini_options]
DJANGO_SETTINGS_MODULE = "todomx.settings"
python_files = ["test_*.py", "*_test.py", "testing/python/*.py"]

现在让我们编写第一个测试，以确保用户只能访问自己的待办事项。

# core/tests/test_todo_model.py

import pytest


@pytest.mark.django_db
class TestTodoModel:
    def test_todo_items_are_associated_to_users(self, make_todo, make_user):
        [user1, user2] = make_user(_quantity=2)

        for i in range(3):
            make_todo(user=user1, title=f"user1 todo {i}")

        make_todo(user=user2, title="user2 todo")

        assert {todo.title for todo in user1.todos.all()} == {
            "user1 todo 0",
            "user1 todo 1",
            "user1 todo 2",
        }

        assert {todo.title for todo in user2.todos.all()} == {"user2 todo"}

我们使用 pytest 中的 conftest.py 文件来存放我们计划在测试中使用的所有装置。 model_bakery 库使得使用最少的样板文件创建 UserProfile 和 Todo 的实例变得简单。

#core/tests/conftest.py

import pytest
from model_bakery import baker


@pytest.fixture
def make_user(django_user_model):
    def _make_user(**kwargs):
        return baker.make("core.UserProfile", **kwargs)

    return _make_user


@pytest.fixture
def make_todo(make_user):
    def _make_todo(user=None, **kwargs):
        return baker.make("core.Todo", user=user or make_user(), **kwargs)

    return _make_todo

让我们运行测试！

❯ uv run pytest
Test session starts (platform: darwin, Python 3.12.8, pytest 8.3.4, pytest-sugar 1.0.0)
django: version: 5.1.4, settings: todomx.settings (from ini)
configfile: pyproject.toml
plugins: sugar-1.0.0, django-4.9.0
collected 1 item

 core/tests/test_todo_model.py ✓                                                                                                                                   100% ██████████

Results (0.25s):
       1 passed

注册 Todos 的管理页面

最后，我们可以为其注册一个管理页面：

# core/admin.py

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from .models import Todo, UserProfile # <-- NEW

# .. previous code

# NEW
@admin.register(Todo)
class TodoAdmin(admin.ModelAdmin):
    model = Todo
    list_display = ["title", "is_completed", "user"]
    list_filter = ["is_completed"]
    search_fields = ["title"]
    list_per_page = 10
    ordering = ["title"]

我们现在可以从管理员添加一些待办事项！

如果你想查看第 2 部分结束之前的整个代码，可以在 Github 的第 02 部分分支上查看。

以上是使用 Django 和 HTMX 创建 To-Do 应用程序 - 使用 TDD 添加 Todo 模型部分的详细内容。更多信息请关注PHP中文网其他相关文章！