Django Admin Autocomplete Filter 项目使用教程

1. 项目目录结构及介绍

Django Admin Autocomplete Filter 是一个简单的 Django 应用程序，用于在 Django 管理界面中使用自动完成小部件渲染列表过滤器。以下是项目的目录结构：

• admin_auto_filters/：主应用目录，包含所有与应用相关的文件和子目录。
  • admin_auto_filters/：Python 包目录，包含模型、视图、管理类等。
    • __init__.py：初始化包文件。
    • admin.py：Django 管理界面配置文件。
    • apps.py：应用配置文件。
    • models.py：模型定义文件。
    • views.py：视图函数文件。
    • templatetags/：模板标签目录。
      • __init__.py：初始化模板标签包文件。
      • admin_auto_filters_tags.py：自定义模板标签文件。
    • static/：静态文件目录。
      • css/：样式文件目录。
      • js/：JavaScript 文件目录。
    • templates/：模板文件目录。
      • admin_auto_filters/：管理界面模板目录。
        • filter.html：过滤器模板文件。
  • tests/：测试文件目录。
  • setup.py：安装包配置文件。
  • requirements.txt：项目依赖文件。
  • README.md：项目说明文件。
  • LICENSE：项目许可证文件。
  • MANIFEST.in：打包包含文件列表。

2. 项目的启动文件介绍

启动文件通常是 manage.py，但由于这是一个 Django 插件，它不会直接运行一个项目。相反，它会被包含在 Django 项目中，并作为依赖项安装。安装此应用后，您可以在 Django 管理界面中使用自动完成过滤器功能。

3. 项目的配置文件介绍

以下是项目的主要配置文件：

• settings.py：Django 项目的设置文件，您需要在这里添加 admin_auto_filters 到 INSTALLED_APPS 列表中，如下所示：

  INSTALLED_APPS = [
      # ...
      'admin_auto_filters',
      # ...
  ]
  

• admin.py：在您的 Django 应用的 admin.py 文件中，您需要定义自定义的过滤器，并注册到相应的模型管理器中。例如：

  from django.contrib import admin
  from admin_auto_filters.filters import AutocompleteFilter
  from .models import YourModel
  
  class CustomAutocompleteFilter(AutocompleteFilter):
      title = 'Your Custom Filter'
      field_name = 'your_field'
  
  class YourModelAdmin(admin.ModelAdmin):
      list_filter = [CustomAutocompleteFilter]
  
  admin.site.register(YourModel, YourModelAdmin)
  

确保在您的 Django 项目的 URL 配置中包含 admin_auto_filters 应用的 URL，通常这是自动完成的，但如果需要，可以手动添加。

通过这些基本配置，您就可以在 Django 管理界面中使用自动完成过滤器功能了。