Open In App
Related Articles

IPAddressField in serializers – Django REST Framework

Improve Article
Save Article
Like Article

In Django REST Framework the very concept of Serializing is to convert DB data to a datatype that can be used by javascript. Every serializer comes with some fields (entries) which are going to be processed. For example if you have a class with name Employee and its fields as Employee_id, Employee_name, is_admin, etc. Then, you would need AutoField, CharField and BooleanField for storing and manipulating data through Django. Similarly, serializer also works with same principle and has fields that are used to create a serializer. 
This article revolves around IPAddressField in Serializers in Django REST Framework. 


IPAddressField is a field that ensures the input is a valid IPv4 or IPv6 string. It is same as GenericIPAddressField – Django Forms.
Syntax – 

field_name = serializers.IPAddressField(*args, **kwargs)


How to use IPAddressField in Serializers ?

To explain the usage of IPAddressField, let’s use the same project setup from – How to Create a basic API using Django Rest Framework ?
Now that you have a file called serializers in your project, let’s create a serializer with IPAddressField as the field. 


# import serializer from rest_framework
from rest_framework import serializers
class Geeks(object):
    def __init__(self, ip):
        self.ip = ip
# create a serializer
class GeeksSerializer(serializers.Serializer):
    # initialize fields
    ip = serializers.IPAddressField()

Now let us create some objects and try serializing them and check if they are actually working, Run, – 

Python shell

Now, run following python commands in the shell 

# import everything from serializers
>>> from apis.serializers import *

# create a object of type Geeks
>>> obj = Geeks("")

# serialize the object
>>> serializer = GeeksSerializer(obj)

# print serialized data
{'ip': ''}

Here is the output of all these operations on terminal – 



Validation on IPAddressField

Note that prime motto of these fields is to impart validations, such as IPAddressField validates the data to IP address only. Let’s check if these validations are working or not – 

# Create a dictionary and add invalid values
>>> data={}
>>> data['ip']="invalid_ip"

# dictionary created
>>> data
{'ip': 'invalid_ip'}

# deserialize the data
>>> serializer = GeeksSerializer(data=data)

# check if data is valid
>>> serializer.is_valid()

# check the errors
>>> serializer.errors
{'ip': [ErrorDetail(string='Enter a valid IPv4 or IPv6 address.',

Here is the output of these commands which clearly shows email and phone_number as invalid – 



Advanced concepts

Validations are part of Deserialization and not serialization. As explained earlier, serializing is process of converting already made data into another data type, so there is no requirement of these default validations out there. Deserialization requires validations as data needs to be saved to database or any more operation as specified. So if you serialize data using these fields that would work. 

Core arguments in serializer fields


.math-table {
border-collapse: collapse;
width: 100%;
.math-table td {
border: 1px solid #5fb962;
text-align: left !important;
padding: 8px;
.math-table th {
border: 1px solid #5fb962;
padding: 8px;
.math-table tr>th{
background-color: #c6ebd9;
vertical-align: middle;
.math-table tr:nth-child(odd) {
background-color: #ffffff;


read_onlySet this to True to ensure that the field is used when serializing a representation, but is not used when creating or updating an instance during deserialization
write_onlySet this to True to ensure that the field may be used when updating or creating an instance, but is not included when serializing the representation.
requiredSetting this to False also allows the object attribute or dictionary key to be omitted from output when serializing the instance.
defaultIf set, this gives the default value that will be used for the field if no input value is supplied.
allow_nullNormally an error will be raised if None is passed to a serializer field. Set this keyword argument to True if None should be considered a valid value.
sourceThe name of the attribute that will be used to populate the field.
validatorsA list of validator functions which should be applied to the incoming field input, and which either raise a validation error or simply return.
error_messagesA dictionary of error codes to error messages.
labelA short text string that may be used as the name of the field in HTML form fields or other descriptive elements.
help_textA text string that may be used as a description of the field in HTML form fields or other descriptive elements.
initialA value that should be used for pre-populating the value of HTML form fields.


Last Updated : 13 Jul, 2021
Like Article
Save Article
Similar Reads
Related Tutorials