【Django】管理サイトでforms.pyをカスタムして使用する

djangoのadmin管理サイトは非常に使いづらくはないでしょうか？

多くの人が、admin.pyをデフォルトのままで使わないか必要最低限のカスタムだけしてそのまま放置でしょう。

使い方によっては管理サイトは効率的な開発を進められることができます。

本日はそんなdjangoのadmin管理サイトをカスタムして、主に管理サイトの入力フォームを使い易くするための紹介記事になります。

コンテンツ

環境

・OS：Mac BigSur

・Python：3.8

・Django：3.2

ある程度、管理サイト、admin.pyのことを理解している、もしくは存在を知っているという前提で進めます。

djangoのadminサイトについて（公式）。

現状の問題点

おそらく多くの人がadmin.pyはデフォルトのままか、開発で最低限のことしか書いていないのではないでしょうか？

こんな感じに。

admin.py

from django.contrib import admin

from corporate.models import UserProfile

admin.site.register(UserProfile)

そして未設定の状態だとどんな感じかというと、以下のように1行のテキストボックスしかない状態で入力を求められている状態になります。

ちなみに今回は、プロフィール入力ページということを想定して、username,user_descriptionというフィールドを用意しました。

一言で、めちゃくちゃ味気ないです!!

そして困ったことに、inputタグ内で改行もできないですし全体を見通すこともできません。

とてもじゃありませんが、こんなform欄でobjectを何かpostしようとは思わないわけです。

今回はこれを使い勝手をいいようにしたいのです。

forms.pyに定義する

まず既にmodelsにはUserProfileというtableを定義済みということで進めていきます。

adminのforms.pyに管理画面で使用する専用のformクラスを定義します。

from django import forms
from .models import UserProfile

class UserProfileAdminForm(forms.ModelForm):
    """Django 管理サイト専用のフォーム
    """
    class Meta:
        model = UserProfile
        fields = [
                'username',
                'user_description',
                ]

    username = forms.CharField(
        required=True,
        max_length=50,
        widget=forms.TextInput(
            attrs={
                'placeholder': '50文字以内で入力してください。',
            }
        )
    )
    user_description = forms.CharField(
        required=True,
        max_length=255,
        widget=forms.Textarea(
            attrs={
                'placeholder': '内容を255文字以内で入力してください。',
            }
        )
    )

admin.pyに定義する

作成したformsの内容をadminにも反映させる必要があります。

admin.py

from django.contrib import admin

from .models import UserProfile
from .forms import UserProfileAdminForm


class UserProfileAdmin(admin.ModelAdmin):
    """ 管理サイトでUserProfileを扱う
    """
    form = UserProfileAdminForm

admin.site.register(UserProfile, UserProfileAdmin)