GenericIPAddressField - Django Forms
Last Updated : 09 Jun, 2022
GenericIPAddressField in Django Forms is a text field, for input of IP Addresses. It is field containing either an IPv4 or an IPv6 address. The default widget for this input is TextInput. It normalizes to a Python string. It validates that the given value is a valid IP address.
GenericIPAddressField takes following optional arguments:
- protocol :- Limits valid inputs to the specified protocol. Accepted values are both (default), IPv4 or IPv6. Matching is case insensitive.
- 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'.
Syntax
field_name = forms.GenericIPAddressField(**options)
Django form 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 forms.py file of geeks app.
Python3 from django import forms # creating a form class GeeksForm(forms.Form): geeks_field = forms.GenericIPAddressField( )
Add the geeks app to INSTALLED_APPS
Python3 # Application definition INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'geeks', ]
Now to render this form into a view we need a view and a URL mapped to that URL. Let's create a view first in views.py of geeks app,
Python3 from django.shortcuts import render from .forms import GeeksForm # Create your views here. def home_view(request): context = {} context['form'] = GeeksForm() return render( request, "home.html", context) Here we are importing that particular form from forms.py and creating an object of it in the view so that it can be rendered in a template. Now, to initiate a Django form you need to create home.html where one would be designing the stuff as they like. Let's create a form in home.html.
html <form method="POST"> {% csrf_token %} {{ form.as_p }} <input type="submit" value="Submit"> </form> Finally, a URL to map to this view in urls.py
Python3 from django.urls import path # importing views from views..py from .views import home_view urlpatterns = [ path('', home_view ), ] Let's run the server and check what has actually happened, Run
Python manage.py runserver
Thus, an geeks_field GenericIPAddressField is created by replacing "_" with " ". It is a field to input of IP addresses.
How to use GenericIPAddressField ?
GenericIPAddressField is used for input of IP address in the database. One can input User IP address, IPv4, etc. Till now we have discussed how to implement GenericIPAddressField but how to use it in the view for performing the logical part. To perform some logic we would need to get the value entered into the field into a python string instance. To get GitHub code of working GenericIPAddressField, click here In views.py,
Python3 from django.shortcuts import render from .forms import GeeksForm # Create your views here. def home_view(request): context = {} form = GeeksForm(request.POST or None) context['form']= form if request.POST: if form.is_valid(): temp = form.cleaned_data.get("geeks_field") print(type(temp)) return render(request, "home.html", context) Now let's try entering some other data into the field.
You can clearly see it is asking for entering a valid IP address. Let's try entering valid IP address now.
Now this data can be fetched using corresponding request dictionary. If method is GET, data would be available in request.GET and if post, request.POST correspondingly. In above example we have the value in temp which we can use for any purpose. You can check that data is converted to a python string instance in geeks_field.
Core Field Arguments
Core Field arguments 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 required = False to GenericIPAddressField will enable it to be left blank by the user. Each Field class constructor takes at least these arguments. Some Field classes take additional, field-specific arguments, but the following should always be accepted:
.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; }
| Field Options | Description |
|---|
| required | By default, each Field class assumes the value is required, so to make it not required you need to set required=False |
| label | The label argument lets you specify the “human-friendly” label for this field. This is used when the Field is displayed in a Form. |
| label_suffix | The label_suffix argument lets you override the form’s label_suffix on a per-field basis. |
| widget | The widget argument lets you specify a Widget class to use when rendering this Field. See Widgets for more information. |
| help_text | The help_text argument lets you specify descriptive text for this Field. If you provide help_text, it will be displayed next to the Field when the Field is rendered by one of the convenience Form methods. |
| 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. |
| validators | The validators argument lets you provide a list of validation functions for this field. |
| localize | The localize argument enables the localization of form data input, as well as the rendered output. |
| disabled. | The disabled boolean argument, when set to True, disables a form field using the disabled HTML attribute so that it won’t be editable by users. |