Django admin.ModelAdmin.inlines で関連モデルをインライン編集

Django admin.ModelAdmin.inlines 解説

django.contrib.admin は、Django アプリケーションに管理インターフェースを提供するモジュールです。 admin.ModelAdmin クラスは、モデル管理ページの振る舞いを定義するために使用されます。 inlines 属性は、関連モデルをインライン編集可能にするためのオプションです。

インライン編集は、関連モデルを親モデルの編集ページから直接編集できる機能です。これは、関連モデルが少ない場合や、親子関係が密接な場合に便利です。

inlines 属性は、インライン編集で使用する StackedInline または TabularInline クラスのインスタンスのリストです。これらのクラスは、インライン編集のレイアウトと動作を定義します。

例

以下の例は、Book モデルと Author モデルの関係をインライン編集で表示する方法を示します。

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

class AuthorInline(admin.StackedInline):
    model = Author

この例では、Book モデルの編集ページには、Author モデルのインライン編集フォームが表示されます。

inlines 属性は以下のオプションを受け取ります。

• model: インライン編集で使用するモデル
• fk_name: 親モデルとの関連フィールド名
• verbose_name: インライン編集セクションのタイトル
• verbose_name_plural: 複数形のタイトル
• extra: 空白のインラインフォームの数
• max_num: 許可されるインラインフォームの最大数
• readonly_fields: 編集不可なフィールドのリスト
• fields: 編集可能なフィールドのリスト
• can_delete: 関連オブジェクトを削除できるかどうか

その他の質問

admin.ModelAdmin.inlines に関して、他に質問があれば遠慮なく聞いてください。

Django admin.ModelAdmin.inlines サンプルコード

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
        PublisherInline,
    ]

class AuthorInline(admin.StackedInline):
    model = Author

class PublisherInline(admin.TabularInline):
    model = Publisher

フィールドの制限

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

class AuthorInline(admin.StackedInline):
    model = Author
    fields = ('name', 'email')
    readonly_fields = ('email',)

カスタマイズフォーム

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

class AuthorInline(admin.StackedInline):
    model = Author
    form = AuthorInlineForm

class AuthorInlineForm(forms.ModelForm):
    class Meta:
        model = Author
        fields = ('name', 'email')
        widgets = {
            'email': forms.TextInput(attrs={'type': 'email'}),
        }

外部キーによるフィルタリング

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

class AuthorInline(admin.StackedInline):
    model = Author
    fk_name = 'book'

    def formfield_for_foreignkey(self, field, request, **kwargs):
        if field.name == 'book':
            kwargs['queryset'] = Book.objects.filter(author=request.user)
        return super().formfield_for_foreignkey(field, request, **kwargs)

複数選択

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

class AuthorInline(admin.TabularInline):
    model = Author
    extra = 1
    max_num = 5

上記のサンプルコードはほんの一例です。 admin.ModelAdmin.inlines 属性を使用して、さまざまな方法でインライン編集をカスタマイズできます。

Django admin.ModelAdmin.inlines の代替方法

• インライン編集は、関連モデルが少ない場合や、親子関係が密接な場合にのみ適しています。
• インライン編集は、複雑な編集フォームには適していません。
• インライン編集は、カスタマイズが難しい場合があります。

これらの制限を克服するために、admin.ModelAdmin.inlines 属性の代わりに以下の方法を使用できます。

独立した編集ページ

関連モデルを独立した編集ページで編集できるようにするには、ModelAdmin クラスを個別に作成します。

class BookAdmin(admin.ModelAdmin):
    pass

class AuthorAdmin(admin.ModelAdmin):
    pass

admin.site.register(Book, BookAdmin)
admin.site.register(Author, AuthorAdmin)

タブ付き編集

admin.ModelAdmin.tabs 属性を使用して、関連モデルをタブ付き編集ページで編集することができます。

class BookAdmin(admin.ModelAdmin):
    tabs = [
        ('book_info', 'Book Information'),
        ('author_info', 'Author Information'),
    ]

    def get_form(self, request, obj=None, **kwargs):
        form = super().get_form(request, obj, **kwargs)
        form.base_fields['author'].queryset = Author.objects.filter(book=obj)
        return form

class AuthorInline(admin.StackedInline):
    model = Author

class BookAdmin(admin.ModelAdmin):
    inlines = [
        AuthorInline,
    ]

カスタムビュー

高度なカスタマイズが必要な場合は、カスタムビューを作成することができます。

from django.views.generic import DetailView

class BookDetailView(DetailView):
    model = Book

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['authors'] = Author.objects.filter(book=self.object)
        return context

urlpatterns = [
    path('book/<int:pk>/', BookDetailView.as_view()),
]

これらの方法は、admin.ModelAdmin.inlines 属性よりも柔軟性とカスタマイズ性を提供します。ただし、より複雑な実装が必要になります。