Open In App

GenericIPAddressField – Django Models

Improve
Improve
Like Article
Like
Save
Share
Report

GenericIPAddressField is a field which stores an IPv4 or IPv6 address, in string format (e.g. 192.0.2.30 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:192.0.2.0. For example, 2001:0::0:01 would be normalized to 2001::1, and ::ffff:0a0a:0a0a to ::ffff:10.10.10.10. All characters are converted to lowercase.

Syntax:

field_name = models.GenericIPAddressField(**options)

GenericIPAddressField accepts following arguments :

GenericIPAddressField.protocol

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

GenericIPAddressField.unpack_ipv4

Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1. If this option is enabled that address would be unpacked to 192.0.2.1. 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 models.py 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
  
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'geeks',
]


Now when we run makemigrations command from the terminal,

Python manage.py makemigrations

A new folder named migrations would be created in geeks directory with a file named 0001_initial.py




# 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 = [
        migrations.CreateModel(
            name ='GeeksModel',
            fields =[
                ('id'
                  models.AutoField(
                  auto_created = True,
                  primary_key = True,
                  serialize = False
                  verbose_name ='ID'
                )),
                ('geeks_field'
                  models.GenericIPAddressField()),
            ],
        ),
    ]


Now run,

Python manage.py 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 “0.0.0.0” in this field.




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


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 Options Description
Null If True, Django will store empty values as NULL in the database. Default is False.
Blank If True, the field is allowed to be blank. Default is False.
db_column The name of the database column to use for this field. If this isn’t given, Django will use the field’s name.
Default The 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_text Extra “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_key If True, this field is the primary key for the model.
editable If 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_messages The 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_text Extra “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_name A 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.
validators A list of validators to run for this field. See the validators documentation for more information.
Unique If True, this field must be unique throughout the table.


Last Updated : 12 Feb, 2020
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads