Python – Set serializer fields from data values with different names (custom field mappings for ModelSerizer)

Set serializer fields from data values with different names (custom field mappings for ModelSerizer)… here is a solution to the problem.

Set serializer fields from data values with different names (custom field mappings for ModelSerizer)

I have a Request model and follow it

class TruRouteRequest(models. Model):
    msisdn = models. CharField('Subscriber international MSISDN ', max_length=25)
    sessionid = models. CharField(max_length=100, unique=True)
    msg_type = models. CharField(max_length=255)
    msg = models. CharField(max_length=255)

I

failed to write the name of the model field as “type“, so I wrote “msg_type“. I have a ModelSerializer for the above model.
The data I received contains the required field “Type”. How to map type from serializer data to msg_type to avoid this error when the call is valid

>> serializer = TruRouteRequestSerializer(data=request.data)
>> serializer.data 
>> {'msisdn': 'M', 'sessionid': 'S', 'msg': 'MSG'}
>> request.data
>> {'msisdn': 'M', 'type': 'T', 'sessionid': 'S', 'msg': 'MSG'} # there is type
>> serializer.is_valid()
>> False
>> serializer.errors
>> {'msg_type': [ErrorDetail(string='This field is required.', code='required')]}

Solution

You can explicitly define the type field in the serializer and map it to the msg_type field using the source parameter

class TruRouteRequestSerializer(serializers. ModelSerializer):
    type = serializers. CharField(source='msg_type')

class Meta:
        model = TruRouteRequest
        fields = ['type', ...]

Related Problems and Solutions