forms.GenericIPAddressField でできることとは？ DjangoフォームにおけるIPアドレス入力を徹底解説

django.forms.GenericIPAddressField は、Django フォームにおいて、IPv4 または IPv6 アドレスを入力するためのフィールドです。モデルフィールド GenericIPAddressField と同様に、データベースに格納される IP アドレスを表現します。

主な特徴

unpack_ipv4 オプションを使用して、::ffff:192.0.2.3 のような IPv4 マッピングされたアドレスを処理できます。
protocol オプションを使用して、有効な入力プロトコルを制限できます。
デフォルトのフォームウィジェットは TextInput です。
IPv4 または IPv6 アドレスの入力を検証します。

使い方

GenericIPAddressField をフォームに定義するには、次のようにします。

from django import forms

class MyForm(forms.Form):
    ip_address = forms.GenericIPAddressField()

このコードは、ip_address という名前のフィールドを作成します。このフィールドは、IPv4 または IPv6 アドレスを受け付けます。

バリデーション

GenericIPAddressField は、入力された IP アドレスが有効かどうかを検証します。無効な IP アドレスが入力された場合、ValidationError が発生します。

カスタマイズ

GenericIPAddressField は、いくつかのオプションを使用してカスタマイズできます。

protocol オプションを使用して、有効な入力プロトコルを制限できます。たとえば、次のようにして IPv6 アドレスのみを許可できます。

ip_address = forms.GenericIPAddressField(protocol='IPv6')

unpack_ipv4 オプションを使用して、::ffff:192.0.2.3 のような IPv4 マッピングされたアドレスを処理できます。

ip_address = forms.GenericIPAddressField(unpack_ipv4=True)

例

次の例は、GenericIPAddressField を使用して、ユーザーからの IP アドレス入力を収集するフォームを示しています。

from django import forms

class MyForm(forms.Form):
    ip_address = forms.GenericIPAddressField(label='IP アドレス')
    comment = forms.CharField(label='コメント')

def clean(self):
    # ここで入力された IP アドレスを処理する
    ip_address = self.cleaned_data['ip_address']
    # ...

    return self.cleaned_data

このフォームは、ユーザーに IP アドレスとコメントを入力させることができます。clean() メソッドは、入力された IP アドレスを処理するために使用できます。

GenericIPAddressField は、ユーザーからの IP アドレス入力を収集する必要がある場合に役立つ便利なフィールドです。オプションを使用して、ニーズに合わせてカスタマイズできます。

from django import forms

class MyForm(forms.Form):
    ip_address = forms.GenericIPAddressField(label="IPアドレス")
    comment = forms.CharField(label="コメント")

def clean(self):
    # 入力されたIPアドレスを処理する
    ip_address = self.cleaned_data["ip_address"]
    # ...

    return self.cleaned_data

モデルでの使用

このフィールドは、モデルでIPアドレスを格納するためにも使用できます。次の例は、GenericIPAddressField を使用するモデルを示しています。

from django.db import models

class MyModel(models.Model):
    ip_address = models.GenericIPAddressField()
    # その他のフィールド

フォームセットでの使用

GenericIPAddressField は、フォームセットでも使用できます。次の例は、GenericIPAddressField を使用するフォームセットを示しています。

from django import forms

class MyFormSet(forms.FormSet):
    ip_address = forms.GenericIPAddressField(label="IPアドレス")
    comment = forms.CharField(label="コメント")

このフォームセットは、複数のIPアドレスとコメントの入力を収集するために使用できます。

以下の例は、GenericIPAddressField でカスタムバリデーションを行う方法を示しています。

from django import forms
from django.core.exceptions import ValidationError


def validate_ip_range(value):
    # 特定のIPアドレス範囲のみを許可する
    if not value.startswith('192.168.'):
        raise ValidationError('無効なIPアドレス')


class MyForm(forms.Form):
    ip_address = forms.GenericIPAddressField(validators=[validate_ip_range])
    # その他のフィールド

このコードは、192.168. で始まるIPアドレスのみを許可します。

GenericIPAddressField は、さまざまな目的に使用できます。以下は、いくつかの例です。

スパムを防止する
ユーザーの場所に基づいてコンテンツをカスタマイズする
ユーザーの国を推定する

Django フォームにおいて、forms.GenericIPAddressField は IPv4 または IPv6 アドレスの入力を処理するために一般的に使用されます。しかしながら、状況によっては代替手段の方が適切な場合もあります。以下、いくつかの代替案とその長所・短所をご紹介します。

カスタムバリデーション付き CharField

短所:
- 冗長性: バリデーションロジックを別途記述する必要があり、コードが冗長になる可能性があります。
- 読み取りやすさ: 複雑なバリデーションロジックは、コードの可読性を損なう可能性があります。
長所:
- 柔軟性: 正規表現を用いて、より複雑なバリデーションルールを定義できます。
- エラーメッセージの制御: エラーメッセージを独自にカスタマイズできます。

from django.core.validators import RegexValidator
from django import forms

ipv4_validator = RegexValidator(
    regex=r"(25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.( 
    25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.( 
    25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)\.( 
    25[0-5]|2[0-4][0-9]|[0-1]?[0-9][0-9]?)$",
    message="有効なIPv4アドレスを入力してください。",
)

ipv6_validator = RegexValidator(
    regex=r"((?:(?:[0-9A-Fa-f]{0,4}:){7}[0-9A-Fa-f]{0,4}|::(?:(?:[0-9A-Fa-f]{0,4}:){6}[0-9A-Fa-f]{0,4}|:(?:(?:[0-9A-Fa-f]{0,4}:){5}[0-9A-Fa-f]{0,4}|::[0-9A-Fa-f]{0,4})))|(?:(?:[0-9A-Fa-f]{0,4}:){0,7}::(?:[0-9A-Fa-f]{0,4}:){0,7}[0-9A-Fa-f]{0,4})|(?:(?:[0-9A-Fa-f]{0,4}:){0,6}::[0-9A-Fa-f]{0,4}:0)|(?:(?:[0-9A-Fa-f]{0,4}:){0,5}::[0-9A-Fa-f]{0,3}:0:0)|(?:(?:[0-9A-Fa-f]{0,4}:){0,4}::0:0:0:0)|(?:(?:[0-9A-Fa-f]{0,4}:){0,3}::0:0:0:0:0)|(?:(?:[0-9A-Fa-f]{0,2}::0:0:0:0:0:0)|(?:[0-9A-Fa-f]{0,2}:0:0:0:0:0:0)|(?:0:0:0:0:0:0:0))|(?:(?:(?:[0-9A-Fa-f]{0,4}:){0,6}[0-9A-Fa-f]{0,4}|::[0-9A-Fa-f]{0,4}:0)|(?:(?:[0-9A-Fa-f]{0,4}:){0,5}::[0-9A-Fa-f]{0,3}:0:0)|(?:(?:[0-9A-Fa-f]{0,4}:){0,4}::0:0:0:0)|(?:(?:[0-9A-Fa-f]{0,3}::0:0:0:0:0)|(?:[0-9A-Fa-f]{0,2}::0:0:0:0:0)|(?:0:0:0:0:0:0:0))])(?:(?:(?:[0-9A-Fa-f]{0,4}:){0,7}|::(?:[0-9A-Fa-f]{0,4}:){0,7}[0-