i am writing an API in python django rest framework and i am stuck at creating a serializer field for an ENUM, how can i create a serializer field for an ENUM field. my model code is:
class Queue(models.Model):
class Meta:
db_table = 'queues'
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False, unique=True)
name = models.CharField(max_length=45)
type = EnumChoiceField(QueueTypes, default=QueueTypes.pending)
date = models.DateTimeField(auto_now=True)
and i am writing a serializer for this model.
class QueueSerializer(serializers.ModelSerializer):
class Meta:
model = Queue
fields = ('__all__')
id = serializers.CharField(read_only=True)
name = serializers.CharField(max_length=45, required=True)
type=?????# what am i supposed to do here?
date = serializers.DateTimeField(read_only=True)
After doing a lot of searches on google i finally found the answer to the serializing issue with the EnumchoiceField the following changes did the job.
my Model.py:
from enumchoicefield import ChoiceEnum, EnumChoiceField
class QueueTypes(ChoiceEnum):
appointment = "appointment"
wait = "wait"
process = "process"
pending = "pending"
class Queue(models.Model):
class Meta:
db_table = 'queues'
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False, unique=True)
name = models.CharField(max_length=45)
type = EnumChoiceField(enum_class=QueueTypes , default=QueueTypes.process)
date = models.DateTimeField(auto_now=True)
fk_department = models.ForeignKey(Department, related_name='department',null=True, on_delete=models.CASCADE)
my Serialize.py:
from enumchoicefield import ChoiceEnum, EnumChoiceField
class QueueSerializer(serializers.ModelSerializer):
class Meta:
model = Queue
fields = ('__all__')
id = serializers.UUIDField(read_only=True)
name = serializers.CharField(max_length=45, required=True)
type = EnumChoiceField(enum_class=QueueTypes)
date = serializers.DateTimeField(read_only=True)
The EnumChoiceField
extension seems to work fine but does not correctly support the HTML support render of the REST Framework, fields serialized as EnumChoiceField
are not rendered.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With