Django forms.ModelChoiceField.to_field_name とは？

django.forms.ModelChoiceField.to_field_name は、ModelChoiceField フィールドで使用されるオプション引数です。これは、選択リストの値として使用するフィールドを指定するために使用されます。デフォルトでは、プライマリキーが使用されます。

利点

• 柔軟な選択リストの作成
• 読みやすいフォーム
• データベースの整合性を保つ

使い方

to_field_name は、ModelChoiceField フィールドのコンストラクタで指定できます。例：

from django.forms import ModelChoiceField

class MyForm(forms.Form):
    category = ModelChoiceField(
        queryset=Category.objects.all(),
        to_field_name='name',
    )

この例では、category フィールドは Category モデルのすべてのオブジェクトを表示しますが、選択リストの値は name フィールドになります。

注意点

• to_field_name で指定したフィールドは、一意である必要があります。
• 外部キーフィールドの場合、to_field_name は関連モデルのフィールドを指す必要があります。

• to_field_name は、ModelMultipleChoiceField フィールドでも使用できます。
• label_from_instance メソッドを使用して、選択リストのラベルをカスタマイズできます。

この情報は参考用です。最新の情報については、Django ドキュメントを参照してください。

ModelChoiceField.to_field_name サンプルコード集

from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=255)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['category'].to_field_name = 'name'

この例では、ProductForm の category フィールドは Category モデルの name フィールドを参照します。

複数のフィールドを結合して選択リストの値とする

from django.db import models

class Country(models.Model):
    name = models.CharField(max_length=255)
    code = models.CharField(max_length=2)

class City(models.Model):
    country = models.ForeignKey(Country, on_delete=models.CASCADE)
    name = models.CharField(max_length=255)

class CityForm(forms.ModelForm):
    class Meta:
        model = City
        fields = ['country']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['country'].to_field_name = 'name'

    def get_queryset(self):
        return super().get_queryset().annotate(
            full_name=models.Expression(models.Concatenate('name', ' (', 'code', ')'))
        )

この例では、CityForm の country フィールドは Country モデルの name フィールドと code フィールドを結合して選択リストの値とします。

カスタムクエリセットを使用する

from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=255)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['category'].queryset = Category.objects.filter(is_active=True)

この例では、ProductForm の category フィールドは is_active=True な Category モデルのみを表示します。

選択リストのラベルをカスタマイズする

from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=255)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['category'].label_from_instance = lambda obj: f"{obj.name} ({obj.code})"

この例では、ProductForm の category フィールドのラベルは name フィールドと code フィールドを結合したものになります。

その他

• choices 属性を使用して、選択リストの選択肢を明示的に指定することもできます。

これらのサンプルコードは、ModelChoiceField.to_field_name オプション引数の使い方を理解するのに役立つでしょう。

ModelChoiceField.to_field_name 以外の選択肢

カスタムモデルマネージャーを使用する

from django.db import models

class CategoryManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().annotate(
            full_name=models.Expression(models.Concatenate('name', ' (', 'code', ')'))
        )

class Category(models.Model):
    name = models.CharField(max_length=255)
    code = models.CharField(max_length=2)

    objects = CategoryManager()

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

この例では、Category モデルにカスタムモデルマネージャー CategoryManager を定義し、full_name という仮想フィールドを追加しています。ProductForm の category フィールドはこの仮想フィールドを参照します。

ラムダ式を使用する

from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=255)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['category'].choices = [
            (category.pk, f"{category.name} ({category.code})")
            for category in Category.objects.all()
        ]

この例では、ProductForm の category フィールドの選択肢をラムダ式を使用して生成しています。

choices 属性を使用する

from django.db import models

class Category(models.Model):
    name = models.CharField(max_length=255)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

class ProductForm(forms.ModelForm):
    class Meta:
        model = Product
        fields = ['category']

    category = forms.ModelChoiceField(
        queryset=Category.objects.all(),
        choices=[
            ('1', 'カテゴリー1'),
            ('2', 'カテゴリー2'),
            ('3', 'カテゴリー3'),
        ],
    )

この例では、ProductForm の category フィールドに choices 属性を使用して選択肢を明示的に指定しています。

これらの方法は、それぞれ異なる利点と欠点があります。状況に合わせて最適な方法を選択してください。