如何在Django项目中管理Postgres的Enum枚举类型？

可用第三方方案 #

Django 4.1 及以上版本已经原生内置PostgreSQL枚举支持，无需引入额外第三方库。如果使用低于4.1的版本，可以选择django-enumfields第三方包实现相同能力，接口逻辑和原生实现基本一致。 #

原生实现示例 #

1. 定义枚举类 #

from enum import Enum
from django.db import models

# 枚举定义
class Mood(Enum):
    SAD = "sad"
    OK = "ok"
    HAPPY = "happy"

# 模型定义
class Person(models.Model):
    name = models.TextField()
    # 直接使用内置EnumField，指定db_type为你要创建的pg枚举名
    current_mood = models.EnumField(enum=Mood, db_type="mood")

2. 创建枚举类型的迁移 #

先执行命令生成空迁移文件：
python manage.py makemigrations --empty 你的应用名
编辑生成的迁移文件，添加枚举创建逻辑：

from django.db import migrations

def create_mood_enum(apps, schema_editor):
    # 仅PostgreSQL环境执行枚举创建
    if schema_editor.connection.vendor == "postgresql":
        schema_editor.execute("CREATE TYPE mood AS ENUM ('sad', 'ok', 'happy');")

def remove_mood_enum(apps, schema_editor):
    if schema_editor.connection.vendor == "postgresql":
        schema_editor.execute("DROP TYPE mood;")

class Migration(migrations.Migration):
    dependencies = [
        # 替换成你应用的上一个迁移文件编号
        ("你的应用名", "0001_initial"),
    ]

    operations = [
        migrations.RunPython(create_mood_enum, remove_mood_enum),
    ]

执行迁移即可完成枚举类型创建，后续的模型字段迁移会直接使用已创建的枚举类型。 #

低版本Django手动实现方案 #

如果使用3.2及以下版本没有内置EnumField，可以自定义字段类实现：

from django.db import models

class PgEnumField(models.CharField):
    def __init__(self, enum_name, choices, *args, **kwargs):
        self.enum_name = enum_name
        kwargs["choices"] = choices
        # 自动设置max_length为枚举值的最大长度
        kwargs["max_length"] = max(len(v[0]) for v in choices)
        super().__init__(*args, **kwargs)

    def db_type(self, connection):
        if connection.vendor == "postgresql":
            return self.enum_name
        # 非PG环境退化为普通CharField
        return super().db_type(connection)

使用方式和内置枚举字段一致，迁移创建逻辑和上方完全相同。 #

常见操作说明 #

• 新增枚举值：单独创建空迁移，执行ALTER TYPE mood ADD VALUE 'excited';即可
• 修改枚举值：PostgreSQL不支持直接修改已有的枚举值，需要删除重建枚举或者使用更新语句批量替换
• 跨库兼容：自定义字段的逻辑会自动在非PG环境退化为带约束的CharField，无需额外适配

内容的提问来源于stack exchange，提问作者Arif