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
::ffff:10.10.10.10. 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: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
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.
Add the geeks app to
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
Python manage.py migrate
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.
Now let’s check it in admin server. We have created an instance of GeeksModel.
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.
|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.|
|Choices||An iterable (e.g., a list or tuple) of 2-tuples to use as choices for this field.|
|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.|
|Unique||If True, this field must be unique throughout the table.|
- GenericIPAddressField - Django Forms
- Django Models | Set - 1
- Django Models
- Django Models | Set - 2
- AutoField - Django Models
- TextField - Django Models
- BigIntegerField - Django Models
- SlugField - Django Models
- PositiveIntegerField - Django Models
- TimeField - Django Models
- URLField - Django Models
- UUIDField - Django Models
- SmallIntegerField - Django Models
- BigAutoField - Django Models
- DurationField - Django Models
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to firstname.lastname@example.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.