Migrations uses value of enum object instead of its name.

[oasl]

When using Enum object as a default value for a CharField, the generated migration file uses the value of the Enum object instead of the its name. This causes a problem when using Django translation on the value of the Enum object.

The problem is that, when the Enum object value get translated to the users language, the old migration files raise an error stating that the Enum does not have the corresponding value. (because the Enum value is translated to another language)

Example:

Let say we have this code in models.py:

from enum import Enum
from django.utils.translation import gettext_lazy as _
from django.db import models


class Status(Enum):
    GOOD = _('Good') # 'Good' will be translated
    BAD = _('Bad') # 'Bad' will be translated

    def __str__(self):
        return self.name

class Item(models.Model):
    status = models.CharField(default=Status.GOOD, max_length=128)

In the generated migration file, the code will be:

...
('status', models.CharField(default=Status('Good'), max_length=128))
...

After the translation, 'Good' will be translated to another word and it will not be part of the Status Enum class any more, so the migration file will raise the error on the previous line:

ValueError: 'Good' is not a valid Status

Shouldn't the code generated by the migration uses the name of the Status Enum 'GOOD', not the value of it, since it is changeable?

It should be:

('status', models.CharField(default=Status['GOOD'], max_length=128))

This will be correct regardless of the translated word

[Mariusz Felisiak]

Thanks for this report, however I'm not sure how translated values can brake migrations. Can you provide a sample project to reproduce this issue? Migrations with translatable strings works fine for me:

>>> class TextEnum(enum.Enum):
...     C = _('translatable value')
...
>>> TextEnum(_('translatable value'))
<TextEnum.C: 'translatable value'>
>>> TextEnum('translatable value')
<TextEnum.C: 'translatable value'>

[oasl]

To experience the bug:

In any Django project, set the default value of a CharField as an enum object:

class EnumClass(Enum):
     VALUE = _('Value')

where:
VALUE: is the constant enum object name
'Value': is the translatable enum object value

In the model:

field = models.CharField(default=EnumClass.VALUE, max_length=128)

then run: python manage.py makemigrations

In the generated migration file, you will notice that the default value of the field is set to: EnumClass('Value'), so it calls the enum object by its translatable value not it is constant name. (This is exactly the BUG, you can think of it without even continue)
run: python manage.py migrate

In the settings.py file:

LANGUAGE_CODE = 'fr-FR' # set it to any language code other than English

Run the project after generating, translating, and compiling the messages file (see: ​message-files)

The project will raise the error: ValueError: 'Value' is not a valid EnumClass , on the generated migration file.

[Mariusz Felisiak]

This use case looks quite niche for me, i.e. I would expect to store a unified values (the same for all languages) and translate only labels visible for users, however I agree that we can fix this.

[Hasan Ramezani]

Here is the diff based on the @oasl solution

Shouldn't the code generated by the migration uses the name of the Status Enum 'GOOD', not the value of it, since it is changeable?
It should be:
('status', models.CharField(default=Status['GOOD'], max_length=128))

diff --git a/django/db/migrations/serializer.py b/django/db/migrations/serializer.py
index 27b5cbd379..b00c6f0df2 100644
--- a/django/db/migrations/serializer.py
+++ b/django/db/migrations/serializer.py
@@ -120,9 +120,9 @@ class EnumSerializer(BaseSerializer):
     def serialize(self):
         enum_class = self.value.__class__
         module = enum_class.__module__
-        v_string, v_imports = serializer_factory(self.value.value).serialize()
+        _, v_imports = serializer_factory(self.value.value).serialize()
         imports = {'import %s' % module, *v_imports}
-        return "%s.%s(%s)" % (module, enum_class.__name__, v_string), imports
+        return "%s.%s['%s']" % (module, enum_class.__name__, self.value), imports
 

@felixxm, what do you think?

[Mariusz Felisiak]

You cannot use a string representation of self.value i.e. 'EnumClass.GOOD', IMO we should use a name property:

return "%s.%s[%r]" % (module, enum_class.__name__, self.value.name), imports

[Hasan Ramezani]

​PR

[Mariusz Felisiak <felisiak.mariusz@…>]

In f0adf3b9:

Fixed #30774 -- Made serialization in migrations use members names for Enums.

[Mariusz Felisiak <felisiak.mariusz@…>]

In df0c2ac3:

[3.0.x] Fixed #30774 -- Made serialization in migrations use members names for Enums.

Backport of f0adf3b9b7a19cdee05368ff0c0c2d087f011180 from master