Django Admin Autocomplete Filter 安装与配置指南

1. 项目基础介绍

Django Admin Autocomplete Filter 是一个简单的 Django 应用，它允许开发者在 Django 的管理后台使用自动完成小部件来渲染列表过滤器。这个应用可以显著提高在 Django 管理界面进行数据筛选的效率。项目主要使用 Python 编程语言。

2. 项目使用的关键技术和框架

• Django：该项目基于 Django 框架，一个高级的 Python Web 框架，允许快速开发安全且可维护的网站。
• Select2 Widget：利用 Django 2.0 引入的 autocomplete_fields 属性，通过 Select2 插件异步加载数据选项。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保您的系统中已安装 Python 和 Django。
• 安装 Django 如果您的系统中尚未安装。
• 准备好您的 Django 项目。

安装步骤

1. 安装 Django Admin Autocomplete Filter

   通过 pip 命令安装最新版本的 Django Admin Autocomplete Filter：

   pip install django-admin-autocomplete-filter
   

2. 添加应用到 INSTALLED_APPS

   打开您的 Django 项目的 settings.py 文件，并将 admin_auto_filters 添加到 INSTALLED_APPS 列表中：

   INSTALLED_APPS = [
       # 其他应用...
       'admin_auto_filters',
   ]
   

3. 创建/修改模型

   确保您的模型定义了需要的字段，比如外键字段，这样您才能使用自动完成过滤器。

   from django.db import models
   
   class Artist(models.Model):
       name = models.CharField(max_length=128)
   
   class Album(models.Model):
       name = models.CharField(max_length=64)
       artist = models.ForeignKey(Artist, on_delete=models.CASCADE)
   

4. 定义自动完成过滤器

   在您的 admin.py 文件中，为需要自动完成过滤的字段创建一个过滤器类。

   from django.contrib import admin
   from admin_auto_filters.filters import AutocompleteFilter
   
   class ArtistFilter(AutocompleteFilter):
       title = 'Artist'
       field_name = 'artist'
   

5. 将过滤器添加到 ModelAdmin

   在 admin.py 中，将创建的过滤器添加到相应的 ModelAdmin 类的 list_filter 属性中。

   class AlbumAdmin(admin.ModelAdmin):
       list_filter = [ArtistFilter]
   

6. 运行迁移

   在完成以上步骤后，运行以下命令来确保所有迁移都被正确应用：

   python manage.py migrate
   

7. 启动开发服务器

   最后，启动 Django 的开发服务器来测试自动完成过滤器功能。

   python manage.py runserver
   

完成以上步骤后，您应该能在 Django 的管理后台看到自动完成过滤器，并能使用它进行数据筛选。