Django Object Tools 技术文档

1. 安装指南

环境要求

• Python 2.7, 3.5-3.7
• Django 1.11, 2.0, 2.1

安装步骤

1. 安装或添加 django-object-tools 到您的 Python 路径。

2. 在您的 INSTALLED_APPS 设置中添加 object_tools。由于 django-object-tools 覆盖了某些 admin 模板，您必须在 django.contrib.admin 之前添加它。

3. 配置 URLConf。将一个 URL 指向 tools.urls 方法。以下示例将默认的 Tools 实例 object_tools.tools 注册在 /object-tools/ 路由上：

   # urls.py
   from django.urls import path
   import object_tools
   
   urlpatterns = [
       path('object-tools/', object_tools.tools.urls)
   ]
   

4. 确保已经按照 Django 官方文档 安装了 Django Admin。

5. 每次安装新的工具时，请运行 migrate 命令来设置权限。

2. 项目使用说明

django-object-tools 是一个 Django 应用程序，它简化了创建和管理额外的 admin 对象工具的过程。它本身不提供实用的工具，而是为了简化其他 Django 应用程序提供的自定义工具的创建和集成。

创建自定义工具

以下是一个示例，展示如何创建一个允许删除所有对象的工具：

1. 创建一个名为 delete 的 Django 应用文件夹结构，包含一个名为 tools.py 的文件。结构如下：

   delete/
       __init__.py
       tools.py
   

2. 编辑 tools.py 文件：

   from django.contrib.admin.actions import delete_selected
   from django.contrib.admin.sites import site
   import object_tools
   
   class Delete(object_tools.ObjectTool):
       name = 'delete'
       label = '删除所有'
   
       def view(self, request, extra_context=None):
           queryset = self.model.objects.all()
           modeladmin = site._registry.get(self.model)
           response = delete_selected(modeladmin, request, queryset)
           if response:
               return response
           else:
               return modeladmin.changelist_view(request)
   
   object_tools.tools.register(Delete)
   

• object_tools 行为类似于 Django 的 admin，允许显式注册工具（第 17 行）。
• 导入 Django 提供的 delete_selected 方法。
• 创建一个继承自 object_tools.ObjectTool 的工具类。
• 设置工具名称和标签。
• 实现 view 方法，这是工具的核心逻辑。
• 使用 object_tools 注册工具。

3. 在 INSTALLED_APPS 设置中添加 delete。

现在，当您导航到任何模型的更改列表视图时，您会在右上角找到 删除所有 对象工具。

注意： django-object-tools 添加了每个工具的权限，以补充 Django 的内置权限集。因此，在此示例中，只有超级用户或具有 可以删除 <模型> 权限的用户才能看到和使用该工具。如果看不到或无法使用某个特定工具，请确保认证用户具有执行操作的所需权限。

3. 项目API使用文档

django-object-tools 提供了一个基础类 ObjectTool，允许开发者创建自定义的 admin 工具。以下是几个关键的 API：

• ObjectTool: 所有工具类应该继承的基础类。
• register: 用于注册自定义工具的方法。

4. 项目安装方式

请按照上述“安装指南”中的步骤进行安装。