Django AdminPlus 技术文档

1. 安装指南

安装步骤

1. 使用 pip 从 PyPI 安装 AdminPlus：

   pip install django-adminplus
   

2. 或者从 GitHub 安装 AdminPlus：

   pip install -e git://github.com/jsocol/django-adminplus#egg=django-adminplus
   

3. 在 Django 项目的 INSTALLED_APPS 中添加 adminplus，并替换 django.contrib.admin 为 django.contrib.admin.apps.SimpleAdminConfig：

   INSTALLED_APPS = (
       'django.contrib.admin.apps.SimpleAdminConfig',
       # ...
       'adminplus',
       # ...
   )
   

4. 在 urls.py 中替换 django.contrib.admin.site 为 adminplus.sites.AdminSitePlus，并在调用 admin.autodiscover() 之前进行配置：

   # urls.py
   from django.contrib import admin
   from adminplus.sites import AdminSitePlus
   
   admin.site = AdminSitePlus()
   admin.autodiscover()
   
   urlpatterns = [
       # ...
       (r'^admin', include(admin.site.urls)),
       # ...
   ]
   

2. 项目的使用说明

使用 AdminPlus

安装完成后，AdminPlus 可以完全兼容 Django 内置的 admin 模块。如果你一直在使用 Django 的 admin 模块，不需要做任何更改。

AdminPlus 提供了一个新的函数 admin.site.register_view，用于将任意视图附加到 admin 中：

# someapp/admin.py
from django.contrib import admin

def my_view(request, *args, **kwargs):
    pass
admin.site.register_view('somepath', view=my_view)

# 当然，这仍然有效：
from someapp.models import MyModel
admin.site.register(MyModel)

现在，my_view 将可以通过 admin/somepath 访问，并且在 admin 索引页的 Custom Views 部分会有一个指向它的链接。

你也可以使用 register_view 作为装饰器：

@admin.site.register_view('somepath')
def my_view(request):
    pass

可选参数

register_view 还接受一些可选参数：

• name：用于在自定义视图列表中显示的友好名称。例如：

  def my_view(request):
      """Does something fancy!"""
  admin.site.register_view('somepath', 'My Fancy Admin View!', view=my_view)
  

• urlname：为 URL 模式命名，以便可以通过 redirect()、reverse() 等调用。视图将添加到 admin 命名空间中，因此 urlname 为 foo 的视图可以通过 reverse("admin:foo") 反转。

• visible：一个布尔值或返回布尔值的可调用对象，定义自定义视图是否在 admin 仪表板中可见。

所有注册的视图都会被 admin.site.admin_view 包装。

注意：URL 与自动发现的 URL（例如通过 ModelAdmins 创建的 URL）匹配的视图将覆盖自动发现的 URL。

3. 项目API使用文档

admin.site.register_view

• 功能：将自定义视图注册到 Django admin 中。
• 参数：
  • url：视图的 URL 路径。
  • view：要注册的视图函数。
  • name（可选）：视图的友好名称，用于在 admin 索引页中显示。
  • urlname（可选）：为 URL 模式命名，以便可以通过 reverse() 等调用。
  • visible（可选）：定义视图是否在 admin 仪表板中可见。

admin.site.admin_view

• 功能：包装视图函数，确保其具有 admin 视图的权限和特性。

4. 项目安装方式

通过 PyPI 安装

pip install django-adminplus

通过 GitHub 安装

pip install -e git://github.com/jsocol/django-adminplus#egg=django-adminplus

配置 Django 项目

在 INSTALLED_APPS 中添加 adminplus，并替换 django.contrib.admin 为 django.contrib.admin.apps.SimpleAdminConfig。在 urls.py 中替换 django.contrib.admin.site 为 adminplus.sites.AdminSitePlus。

完成这些步骤后，你就可以开始使用 AdminPlus 了。