django admin配置以及使用

Posted 2020-11-22 pungchur

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了django admin配置以及使用相关的知识，希望对你有一定的参考价值。

django admin配置以及使用

知识预览

admin组件使用
admin源码解析

admin组件使用

Django 提供了基于 web 的管理工具（django 2.0+, python3.6+）。

Django 自动管理工具是 django.contrib 的一部分。你可以在项目的 settings.py 中的 INSTALLED_APPS 看到它：

# Application definition
# 新建一个应用名为mysite,注册application

INSTALLED_APPS = [
    ‘django.contrib.admin‘,
    ‘django.contrib.auth‘,
    ‘django.contrib.contenttypes‘,
    ‘django.contrib.sessions‘,
    ‘django.contrib.messages‘,
    ‘django.contrib.staticfiles‘,
    ‘mysite.apps.mysiteConfig‘,
]

django.contrib是一套庞大的功能集，它是Django基本代码的组成部分。

激活管理工具

通常我们在生成项目时会在 urls.py 中自动设置好，

from django.contrib import admin
from django.urls import path

urlpatterns = [
    path(‘admin/‘, admin.site.urls),
]

当这一切都配置好后，Django 管理工具就可以运行了。

使用管理工具

启动开发服务器，然后在浏览器中访问 http://127.0.0.1:8000/admin/，得到登陆界面，你可以通过命令 python manage.py createsuperuser 来创建超级用户。

为了让 admin 界面管理某个数据模型，我们需要先注册该数据模型到 admin

from django.db import models


class Author(models.Model):
    name = models.CharField(max_length=32)
    age = models.IntegerField()

    def __str__(self):
        return self.name


class Publish(models.Model):
    name = models.CharField(max_length=32)
    email = models.EmailField()

    def __str__(self):
        return self.name


class Book(models.Model):
    title = models.CharField(max_length=32)
    publishDate = models.DateField()
    price = models.DecimalField(max_digits=5, decimal_places=2)
    publish = models.ForeignKey(to="Publish", on_delete=models.CASCADE)
    authors = models.ManyToManyField(to=‘Author‘)

    def __str__(self):
        return self.title

models.py

admin的定制

在admin.py中只需要讲Mode中的某个类注册，即可在Admin中实现增删改查的功能，如：

from mysite.models import Book

admin.site.register(models.Book)

但是，这种方式比较简单，如果想要进行更多的定制操作，需要利用ModelAdmin进行操作，如：

方式一：
    class BookAdmin(admin.ModelAdmin):
        list_display = (‘title‘, ‘price‘,)
 
    admin.site.register(models.Book, BookAdmin) # 第一个参数可以是列表
     
 
方式二：
    @admin.register(models.Book)                # 第一个参数可以是列表
    class BookAdmin(admin.ModelAdmin):
        list_display = (‘title‘, ‘price‘,)

ModelAdmin中提供了大量的可定制功能，如

1. list_display，列表时，定制显示的列。

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = (‘title‘, ‘price‘)

2. list_display_links，列表时，定制列可以点击跳转

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = (‘title‘, ‘price‘)
    list_display_links = (‘price‘,)

3. list_filter，列表时，定制右侧快速筛选。

4. list_select_related，列表时，连表查询是否自动select_related

5. list_editable，列表时，可以编辑的列

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    list_display = (‘title‘, ‘price‘,)
    list_editable = (‘price‘,)

6. search_fields，列表时，模糊搜索的功能

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    search_fields = (‘title‘, ‘price‘)

7. date_hierarchy，列表时，对Date和DateTime类型进行搜索

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
 
    date_hierarchy = ‘publishDate‘

8 inlines，详细页面，如果有其他表和当前表做外键，那么详细页面可以进行动态增加和删除

class BookInline(admin.StackedInline): # TabularInline
    extra = 0
    model = models.Book
 
 
class GroupAdminMode(admin.ModelAdmin):
    list_display = (‘id‘, ‘title‘,)
    inlines = [BookInline, ]

9 action，列表时，定制action中的操作

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
 
    # 定制Action行为具体方法
    def show(self, request, queryset):
        print(self, request, queryset)
        print(request.POST.getlist(‘_selected_action‘))
 
    func.short_description = "中文显示自定义Actions"
    actions = [show, ]
 
    # Action选项都是在页面上方显示
    actions_on_top = True
    # Action选项都是在页面下方显示
    actions_on_bottom = False
 
    # 是否显示选择个数
    actions_selection_counter = True

10 raw_id_fields，详细页面，针对FK和M2M字段变成以Input框形式

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    raw_id_fields = (‘publish‘, ‘authors‘,)

11 fields，详细页面时，显示字段的字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    fields = (‘title‘, ‘price‘)

12 exclude，详细页面时，排除的字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    exclude = (‘price‘)

13 readonly_fields，详细页面时，只读字段

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    readonly_fields = (‘price‘)

14 fieldsets，详细页面时，使用fieldsets标签对数据进行分割显示

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    fieldsets = (
        (‘基本数据‘, {
            ‘fields‘: (‘title‘, ‘price‘)
        }),
        (‘其他‘, {
            ‘classes‘: (‘collapse‘, ‘wide‘, ‘extrapretty‘),  # ‘collapse‘,‘wide‘, ‘extrapretty‘
            ‘fields‘: (‘title‘, ‘price‘),
        }),
    )

15 详细页面时，多对多显示时，数据移动选择（方向：上下和左右）

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
 
    filter_vertical = (‘authors‘)

16 ordering，列表时，数据排序规则

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
    ordering = (‘id‘,)
    # ordering = (‘-id‘,) # 倒序
    # 或
    # def get_ordering(self, request):
    #    return [‘-id‘, ]

17 radio_fields，详细页面时，使用radio显示选项（外键默认使用select）

@admin.register(models.BookInfo)
class BookAdmin(admin.ModelAdmin):
    
    radio_fields = {"publish": admin.VERTICAL}

18 form = ModelForm，用于定制用户请求时候表单验证

from mysite import models
from django.forms import ModelForm
from django.forms import fields
 
 
class MyForm(ModelForm):
    others = fields.CharField()
 
    class Meta:
        model = models = models.Book
        fields = "__all__"
 
@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
 
    form = MyForm

19 empty_value_display = "列数据为空时，显示默认值"

@admin.register(models.Book)
class BookAdmin(admin.ModelAdmin):
    empty_value_display = "列数据为空时，默认显示"
 
    list_display = (‘title‘,‘price‘,‘publish‘)
 
    def up(self,obj):
        return obj.publish
    up.empty_value_display = "指定列数据为空时，默认显示"

from django.contrib import admin

from mysite.models import *


class BookInline(admin.StackedInline): # TabularInline
    extra = 0
    model = Book

class BookAdmin(admin.ModelAdmin):

    list_display = ("title",‘publishDate‘, ‘price‘,"foo","publish")
    list_display_links = (‘publishDate‘,"price")
    list_filter = (‘price‘,)
    list_editable=("title","publish")
    search_fields = (‘title‘,)
    date_hierarchy = ‘publishDate‘
    preserve_filters=False

    def foo(self,obj):
        return obj.title+str(obj.price)

    # 定制Action行为具体方法
    def func(self, request, queryset):
        print(self, request, queryset)
        print(request.POST.getlist(‘_selected_action‘))

    func.short_description = "中文显示自定义Actions"
    actions = [func, ]
    # Action选项都是在页面上方显示
    actions_on_top = True
    # Action选项都是在页面下方显示
    actions_on_bottom = False

    # 是否显示选择个数
    actions_selection_counter = True

    change_list_template="my_change_list_template.html"


class PublishAdmin(admin.ModelAdmin):
     list_display = (‘name‘, ‘email‘,)
     inlines = [BookInline, ]


admin.site.register(Book, BookAdmin) # 第一个参数可以是列表
admin.site.register(Publish,PublishAdmin)
admin.site.register(Author)

admins

admin源码解析

单例模式

单例模式（Singleton Pattern）是一种常用的软件设计模式，该模式的主要目的是确保某一个类只有一个实例存在。当你希望在整个系统中，某个类只能出现一个实例时，单例对象就能派上用场。

比如，某个服务器程序的配置信息存放在一个文件中，客户端通过一个 AppConfig 的类来读取配置文件的信息。如果在程序运行期间，有很多地方都需要使用配置文件的内容，也就是说，很多地方都需要创建 AppConfig 对象的实例，这就导致系统中存在多个 AppConfig 的实例对象，而这样会严重浪费内存资源，尤其是在配置文件内容很多的情况下。事实上，类似 AppConfig 这样的类，我们希望在程序运行期间只存在一个实例对象。

在 Python 中，我们可以用多种方法来实现单例模式：

使用模块
使用 __new__
使用装饰器（decorator）
使用元类（metaclass）

（1）使用 `new`

为了使类只能出现一个实例，我们可以使用 __new__ 来控制实例的创建过程，代码如下：

class Singleton(object):
    _instance = None
    def __new__(cls, *args, **kwargs):
        if not cls._instance:
            cls._instance = super(Singleton, cls).__new__(cls, *args, **kwargs)  
        return cls._instance  

class MyClass(Singleton):  
    a = 1
    
one_single = MyClass()
two_single = MyClass()

print(id(one_single), id(two_single))

# 32423121 32423121

在上面的代码中，我们将类的实例和一个类变量 _instance 关联起来，如果 cls._instance 为 None 则创建实例，否则直接返回 cls._instance。

（2）使用模块

其实，Python 的模块就是天然的单例模式，因为模块在第一次导入时，会生成 .pyc 文件，当第二次导入时，就会直接加载 .pyc 文件，而不会再次执行模块代码。因此，我们只需把相关的函数和数据定义在一个模块中，就可以获得一个单例对象了。如果我们真的想要一个单例类，可以考虑这样做：

# mysingleton.py
class My_Singleton(object):
    def foo(self):
        pass
 
my_singleton = My_Singleton()

将上面的代码保存在文件 mysingleton.py 中，然后这样使用：

from mysingleton import my_singleton
 
my_singleton.foo()

admin执行流程

<1> 循环加载执行所有已经注册的app中的admin.py文件

def autodiscover():
    autodiscover_modules(‘admin‘, register_to=site)

<2> 执行代码

＃admin.py

class BookAdmin(admin.ModelAdmin):
    list_display = ("title",‘publishDate‘, ‘price‘)

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

<3> admin.site

class AdminSite:
    ...

# This global object represents the default admin site, for the common case.
# You can provide your own AdminSite using the (Simple)AdminConfig.default_site
# attribute. You can also instantiate AdminSite in your own code to create a
# custom admin site.
site = DefaultAdminSite()

这里应用的是一个单例模式，对于AdminSite类的一个单例模式，执行的每一个app中的每一个admin.site都是一个对象

<4> 执行register方法

# admin.py

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

class ModelAdmin(BaseModelAdmin):pass

def register(self, model_or_iterable, admin_class=None, **options):
    if not admin_class:
            admin_class = ModelAdmin
    # Instantiate the admin class to save in the registry
    self._registry[model] = admin_class(model, self)

<5> admin的URL配置

urlpatterns = [
    path(‘admin/‘, admin.site.urls),
]

class AdminSite(object):
    def get_urls(self):
        from django.urls import include, path, re_path
        # Since this module gets imported in the application‘s root package,
        # it cannot import models from other applications at the module level,
        # and django.contrib.contenttypes.views imports ContentType.
        from django.contrib.contenttypes import views as contenttype_views

        def wrap(view, cacheable=False):
            def wrapper(*args, **kwargs):
                return self.admin_view(view, cacheable)(*args, **kwargs)
            wrapper.admin_site = self
            return update_wrapper(wrapper, view)

        # Admin-site-wide views.
        urlpatterns = [
            path(‘‘, wrap(self.index), name=‘index‘),
            path(‘login/‘, self.login, name=‘login‘),
            path(‘logout/‘, wrap(self.logout), name=‘logout‘),
            path(‘password_change/‘, wrap(self.password_change, cacheable=True), name=‘password_change‘),
            path(
                ‘password_change/done/‘,
                wrap(self.password_change_done, cacheable=True),
                name=‘password_change_done‘,
            ),
            path(‘jsi18n/‘, wrap(self.i18n_javascript, cacheable=True), name=‘jsi18n‘),
            path(
                ‘r/<int:content_type_id>/<path:object_id>/‘,
                wrap(contenttype_views.shortcut),
                name=‘view_on_site‘,
            ),
        ]

        # Add in each model‘s views, and create a list of valid URLS for the
        # app_index
        valid_app_labels = []
        for model, model_admin in self._registry.items():
            urlpatterns += [
                path(‘%s/%s/‘ % (model._meta.app_label, model._meta.model_name), include(model_admin.urls)),
            ]
            if model._meta.app_label not in valid_app_labels:
                valid_app_labels.append(model._meta.app_label)

        # If there were ModelAdmins registered, we should have a list of app
        # labels for which we need to allow access to the app_index view,
        if valid_app_labels:
            regex = r‘^(?P<app_label>‘ + ‘|‘.join(valid_app_labels) + ‘)/$‘
            urlpatterns += [
                re_path(regex, wrap(self.app_index), name=‘app_list‘),
            ]
        return urlpatterns

    @property
    def urls(self):
        return self.get_urls(), ‘admin‘, self.name

class AdminSite

<6> url()方法的扩展应用

from django.contrib import admin
from django.urls import path

from django.shortcuts import HttpResponse


def test1(request):
    return HttpResponse("test1")

def test2(request):
    return HttpResponse("test2")


urlpatterns = [
    path(‘admin/‘, admin.site.urls),
    path("test/", ([
        path(‘test1/‘, test1),
        path(‘test2/‘, test2),
                   ], None, None))
]