Changes in ModelSerializer

[Zwiezda]

I'd to recommend, a little improvement in ModelSerializer.
Class field named serializer_field_mapping could be moved to a normal class method.
It would be easier to override default model-serializer fields mapping.

[auvipy]

could you please share the code and use case for the change?

[Zwiezda]

@auvipy

class MySerializer(ModelSerializer):
    @classmethod
    def get_serializer_field_mapping(cls) -> Dict[DjangoModelField, Field]: #method instand of serializer_field_mapping field
        serializer_field_mapping = {
            models.AutoField: IntegerField,
            models.BigIntegerField: IntegerField,
            models.BooleanField: BooleanField,
            models.CharField: CharField,
            models.CommaSeparatedIntegerField: CharField,
            models.DateField: DateField,
            models.DateTimeField: DateTimeField,
            models.DecimalField: DecimalField,
            models.DurationField: DurationField,
            models.EmailField: EmailField,
            models.Field: ModelField,
            models.FileField: FileField,
            models.FloatField: FloatField,
            models.ImageField: ImageField,
            models.IntegerField: IntegerField,
            models.NullBooleanField: BooleanField,
            models.PositiveIntegerField: IntegerField,
            models.PositiveSmallIntegerField: IntegerField,
            models.SlugField: SlugField,
            models.SmallIntegerField: IntegerField,
            models.TextField: CharField,
            models.TimeField: TimeField,
            models.URLField: URLField,
            models.UUIDField: UUIDField,
            models.GenericIPAddressField: IPAddressField,
            models.FilePathField: FilePathField,
        }
        if hasattr(models, 'JSONField'):
            serializer_field_mapping[models.JSONField] = JSONField
        if postgres_fields:
            serializer_field_mapping[postgres_fields.HStoreField] = HStoreField
            serializer_field_mapping[postgres_fields.ArrayField] = ListField
            serializer_field_mapping[postgres_fields.JSONField] = JSONField
        return serializer_field_mapping

    def build_standard_field(self, field_name, model_field):  #method to override
        """
        Create regular model fields.
        """
        field_mapping = ClassLookupDict(self.get_serializer_field_mapping())  #my change
        ...

Use case:

class ExampleSerializer(MySerializer):
    class Meta:
        fields = '__all__'
        model = ExampleModel

    @classmethod
    def get_serializer_field_mapping(cls) -> Dict[DjangoModelField, Field]:
        fields_mapping = super().get_serializer_field_mapping()
        fields_mapping[models.DecimalField] = MyCustomDecimalField
        return fields_mapping