Skip to content
Related Articles

Related Articles

Improve Article

GenericIPAddressField – Django Models

  • Last Updated : 12 Feb, 2020

GenericIPAddressField is a field which stores an IPv4 or IPv6 address, in string format (e.g. or 2a02:42fe::4). The default form widget for this field is a TextInput. The IPv6 address normalization follows RFC 4291#section-2.2 section 2.2, including using the IPv4 format suggested in paragraph 3 of that section, like ::ffff: For example, 2001:0::0:01 would be normalized to 2001::1, and ::ffff:0a0a:0a0a to ::ffff: All characters are converted to lowercase.


field_name = models.GenericIPAddressField(**options)

GenericIPAddressField accepts following arguments :


Limits valid inputs to the specified protocol. Accepted values are ‘both‘ (default), ‘IPv4‘ or ‘IPv6‘. Matching is case insensitive.


Unpacks IPv4 mapped addresses like ::ffff: If this option is enabled that address would be unpacked to Default is disabled. Can only be used when protocol is set to ‘both’.

Django Model GenericIPAddressField Explanation

Illustration of GenericIPAddressField using an Example. Consider a project named geeksforgeeks having an app named geeks.

Refer to the following articles to check how to create a project and an app in Django.

Enter the following code into file of geeks app.

from django.db import models
from django.db.models import Model
# Create your models here.
class GeeksModel(Model):
    geeks_field = models.GenericIPAddressField()

Add the geeks app to INSTALLED_APPS

# Application definition

Now when we run makemigrations command from the terminal,

Python makemigrations

A new folder named migrations would be created in geeks directory with a file named

# Generated by Django 2.2.5 on 2019-09-25 06:00
from django.db import migrations, models
class Migration(migrations.Migration):
    initial = True
    dependencies = [
    operations = [
            name ='GeeksModel',
            fields =[
                  auto_created = True,
                  primary_key = True,
                  serialize = False
                  verbose_name ='ID'

Now run,

Python migrate

Thus, an geeks_field GenericIPAddressField is created when you run migrations on the project. It is a field to store a integer numbers.

How to use GenericIPAddressField ?

GenericIPAddressField is used for storing Pv4 or IPv6 address, in string format, so it is basically a CharField with validation of IP Address. Let’s try to save a IP address “” in this field.

# importing the model
# from geeks app
from geeks.models import GeeksModel
# creating an instance of
# IP addresses
d = ""
# creating a instance of 
# GeeksModel
geek_object = GeeksModel.objects.create(geeks_field = d)

Now let’s check it in admin server. We have created an instance of GeeksModel.

GenericIPAddressField django models

Field Options

Field Options are the arguments given to each field for applying some constraint or imparting a particular characteristic to a particular Field. For example, adding an argument null = True to GenericIPAddressField will enable it to store empty values for that table in relational database.
Here are the field options and attributes that an GenericIPAddressField can use.

Field OptionsDescription
NullIf True, Django will store empty values as NULL in the database. Default is False.
BlankIf True, the field is allowed to be blank. Default is False.
db_columnThe name of the database column to use for this field. If this isn’t given, Django will use the field’s name.
DefaultThe default value for the field. This can be a value or a callable object. If callable it will be called every time a new object is created.
help_textExtra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.
primary_keyIf True, this field is the primary key for the model.
editableIf False, the field will not be displayed in the admin or any other ModelForm. They are also skipped during model validation. Default is True.
error_messagesThe error_messages argument lets you override the default messages that the field will raise. Pass in a dictionary with keys matching the error messages you want to override.
help_textExtra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.
verbose_nameA human-readable name for the field. If the verbose name isn’t given, Django will automatically create it using the field’s attribute name, converting underscores to spaces.
validatorsA list of validators to run for this field. See the validators documentation for more information.
UniqueIf True, this field must be unique throughout the table.

 Attention geek! Strengthen your foundations with the Python Programming Foundation Course and learn the basics.  

To begin with, your interview preparations Enhance your Data Structures concepts with the Python DS Course. And to begin with your Machine Learning Journey, join the Machine Learning – Basic Level Course

My Personal Notes arrow_drop_up
Recommended Articles
Page :