django-dynamic-raw-id 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00103/article/details/142277957

django-dynamic-raw-id 使用教程

django-dynamic-raw-id (formerly known as django-salmonella) A raw_id_fields widget replacement that handles display of an object's string value on change and can be overridden via a template. 项目地址: https://gitcode.com/gh_mirrors/dj/django-dynamic-raw-id

本教程旨在引导您了解并使用开源项目 django-dynamic-raw-id，这是一个增强Django管理界面中raw_id_fields功能的插件，允许以更友好的方式显示相关对象的信息。

1. 项目目录结构及介绍

django-dynamic-raw-id/
├── CHANGELOG.md           # 版本更新日志
├── README.md               # 项目说明文档
├── LICENSE                 # 许可证文件
├── env                     # 可能的虚拟环境配置（开发者自用）
├── editorconfig            # 编辑器配置文件
├── eslintrc.js             # ESLint配置文件
├── gitignore               # Git忽略文件列表
├── pyproject.toml          # 项目元数据和依赖管理文件
├── release.sh              # 发布脚本
├── tox.ini                 # Tox测试工具配置
├── django-dynamic-raw-id   # 主项目包
│   ├── __init__.py
│   ├── admin                # 包含自定义ModelAdmin Mixin和过滤器类
│   │   └── __init__.py
│   ├── filters              # 自定义筛选器
│   │   └── __init__.py
│   ├── migrations           # 数据库迁移文件
│   ├── models               # 示例模型或辅助模型（如果存在）
│   ├── static               # 静态文件，用于前端展示
│   ├── templatetags        # 自定义模板标签
│   │   └── __init__.py
│   ├── tests                # 测试代码
│   └── widgets              # 自定义小部件，如DynamicRawIDWidget
├── github                  # 与GitHub工作流相关的文件夹
│   └── workflows            # GitHub Actions的配置文件
└── tests                    # 单独的测试套件

重点文件解释：

widgets.py: 包含主要的动态ID字段小部件实现。
admin.py: 提供了DynamicRawIDMixin来集成到Django的ModelAdmin。
filters.py: 定义了DynamicRawIDFilter用于在列表筛选时使用。

2. 项目的启动文件介绍

此项目作为Django的扩展，并没有直接的“启动文件”，但您需要将其整合到您的Django项目中才能使用。关键步骤是通过修改Django设置和URL配置来启用它：

在你的Django项目的settings.py中的INSTALLED_APPS列表里添加'dynamic_raw_id'.
在urls.py中引入动态ID字段所需的URL模式，通常是在admin路径之前加入：

from django.urls import path, include

urlpatterns = [
    path('admin/dynamic_raw_id/', include('dynamic_raw_id.urls')),
    path("admin/", admin.site.urls),
    # ... 其他URL配置 ...
]

3. 项目的配置文件介绍

主配置: 修改Django的settings.py来加入该应用。

INSTALLED_APPS = (
    # ... 其他应用 ...
    'dynamic_raw_id',
    # ... 更多其他应用 ...
)

静态文件配置: 确保运行manage.py collectstatic收集必要的静态文件，以便正确显示自定义UI元素。
自定义配置: 虽然不是必须的，但您可以定制其行为，例如，改变动态ID字段值的显示逻辑，这通常通过创建特定的模板来完成，这些模板遵循dynamic_raw_id/<app>/<model>.html的命名规则，以提供个性化的显示效果。