Django之admin管理工具

admin组件使用

Django 提供了基于 web 的管理工具。

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

复制代码
# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    "app01"
]
复制代码

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

激活管理工具

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

复制代码
from django.conf.urls import url
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),

]
复制代码

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

使用管理工具

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

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

复制代码
from django.db import models

# Create your models here.




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)

    publisher=models.ForeignKey(to="Publish")
    authors=models.ManyToManyField(to='Author')

    def __str__(self):
        return self.title
复制代码

admin的定制

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

admin.site.register(models.UserInfo)

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

复制代码
方式一:
    class UserAdmin(admin.ModelAdmin):
        list_display = ('user', 'pwd',)
 
    admin.site.register(models.UserInfo, UserAdmin) # 第一个参数可以是列表
## 可以同时注册多个。 或者 admin.site.register([models.ArticleDetail,models.Article2Tag,models.Comment])
方式二: // 使用这种方式时,就不需要执行admin.site.register() @admin.register(models.UserInfo) # 第一个参数可以是列表 class UserAdmin(admin.ModelAdmin): list_display = ('user', 'pwd',)
复制代码

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

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd', 'xxxxx')
 
    def xxxxx(self, obj):
        return "xxxxx"

备注:使用自定制的方法时,一定要注意自定制函数的位置,自定制函数如果在上面,并且list_display中使用的是该函数名而不是该函数名的字符串时,跟普通函数使用一样时,不能传参。切记!如果在list_display中存放的是函数名的字符串时,不管自定制的函数在list_display的上面还是下面,都必须传入一个参数。否则会报错

默认在列中显示时,在列中显示的字段名默认为自定义类的类名全部大写,每行对应显示的内容为return返回的内容!!!

还有,使用list_play时,列表中的字段可以是一对一的字段(正查为字段名,反查为表名),也可以是一对多的正向查的关联的字段名,但是不能是反查的,同时也不能是多对多的任意的相关字段(不论正查反查)。也就是说可显示的关联字段的值必须唯一。

比如:

@admin.register(models.Blog)
class BlogShow(admin.ModelAdmin):
    def Foo(self):
        return '这是自定制的上面的Foo函数'   
    def Goo(self,obj):
        return '这是自定制上面的Goo函数'
    list_display = ['title','theme',Foo,'Goo','Coo']
    def Coo(self,obj):
        return '这是自定制下面的Coo函数'

自定义字段时,可以借助Django中的一些工具包进行一些相应的转化,比如:from django.utils.safestring import mark_safe  借助这个Django自带的工具,我们可以将一些标签字符串不转义的显示,从而达到添加一个点击操作的自定义实现。

比如:

from django.contrib import admin
from django.utils.safestring import mark_safe

class UserConfig(admin.ModelAdmin):
    list_display = ['operate']
    list_display_links = ['operate']
    def operate(self,obj)
        return mark_safe('<a href="/路径/">删除</a>')

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd', 'xxxxx')
    list_display_links = ('pwd',)

备注:不设置该属性时,默认第一个字段可以点击跳转。设置该字段属性后,列表中字段必须是list_play中的字段,设置列表中的字段可以点击跳转,一般跳转为编辑页面。另外,自定制的函数在该列表时,一定要对应list_display中的函数,如果list_display中的函数为字符串函数名,则对应list_display_links中必须也为字符串函数名,否则报错,而且这些自定制函数也默认点击跳转至编辑页面,

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

list_filter可使用与对一些字段做分组和过滤使用,在属性中配置一个list_filter=["字段名",...],对应的会在左侧生成一个筛选的页面。

 备注:筛选字段不依赖于list_display的属性。

class ArticleShow(admin.ModelAdmin):
    list_display = ['title','desc','user','category']
    list_filter = ['title','category','user']   #相对应的筛选字段

自动生成的页面:

备注:页面默认显示对应的表字段名,可以指定中文显示,在字段中设置verbose_name="名字"。

备注:list_filter 中可以使用多对多的相关字段,但是必须是表中的关联字段。

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

备注:使用于一对一、一对多、多对多关系字段。具体用途待补充。

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd','ug',)
    list_editable = ('ug',)

 设置这个属性后,列表中对应的字段就变为一个输入框的类型,可以直接修改,而不需要跳转至编辑页面。

备注:设置这个属性后,表中的字段不能与list_display_links中的字段共存,即两者只能选择一种编辑方式,要么直接输入框的编辑,要么跳转式的编辑,特别注意的是,如果不设置list_display_links属性,那么Django-admin会默认list_display中的第一个字段为可点击跳转的,所以,此时设置list_editable时,就不能使用第一个字段了。所以这个属性也是依赖于list_display的。

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
     
    search_fields = ('user', 'pwd')

 生成对应表中的字段的模糊匹配。

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    date_hierarchy = 'ctime'

8  inlines,详细页面,如果有其他表和当前表做FK(foreign key),那么详细页面可以进行动态增加和删除

复制代码
class UserInfoInline(admin.StackedInline): # TabularInline
    extra = 0
    model = models.UserInfo
 
 
class GroupAdminMode(admin.ModelAdmin):
    list_display = ('id', 'title',)
    inlines = [UserInfoInline, ]
复制代码

9 action,列表时,定制action中的操作,使用于做批量处理。

复制代码
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    # 定制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
复制代码

备注:print(queryset)    我们执行批量操作时,选中几个,queryset就接受几个选中的对象object

比如:选中三个书的标题  执行打印queryset为:<QuerySet [<Article: Spring中bean的注入方式>, <Article: 分布式架构的演进过程精选>, <Article: 拿Proxy可以做哪些有意思的事儿>]>

所以,我们可以在对应的函数中,根据queryset接收的对象,来对对象所拥有的字段做相关操作。

10 定制HTML模板

备注:可用于一些admin页面的替换,使用时,后直接跟相对应的HTML页面即可

add_form_template = None
change_form_template = None
change_list_template = None
delete_confirmation_template = None
delete_selected_confirmation_template = None
object_history_template = None  

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

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    raw_id_fields = ('FK字段', 'M2M字段',)

12  fields,详细页面时,显示字段的字段

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    fields = ('user',)

备注:使用该属性后,添加或者编辑页面时,就会只显示fields中的相关字段。

13 exclude,详细页面时,排除的字段,跟fields相反。

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    exclude = ('user',)

14  readonly_fields,详细页面时,只读字段

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    readonly_fields = ('user',)

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

复制代码
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    fieldsets = (
        ('基本数据', {
            'fields': ('user', 'pwd', 'ctime',)
        }),
        ('其他', {
            'classes': ('collapse', 'wide', 'extrapretty'),  # 'collapse','wide', 'extrapretty'
            'fields': ('user', 'pwd'),
        }),
    )
复制代码

16 详细页面时,M2M显示时,数据移动选择(方向:上下和左右)

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    filter_vertical = ("m2m字段",) # 或filter_horizontal = ("m2m字段",)

17 ordering,列表时,数据排序规则

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    ordering = ('-id',)
    或
    def get_ordering(self, request):
        return ['-id', ]

18. radio_fields,详细页面时,使用radio显示选项(FK默认使用select)

radio_fields = {"ug": admin.VERTICAL} # 或admin.HORIZONTAL

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

复制代码
from app01 import models
from django.forms import ModelForm
from django.forms import fields
 
 
class MyForm(ModelForm):
    others = fields.CharField()
 
    class Meta:
        model = models = models.UserInfo
        fields = "__all__"
 
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    form = MyForm
复制代码

20 empty_value_display = "列数据为空时,显示默认值"

复制代码
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    empty_value_display = "列数据为空时,默认显示"
 
    list_display = ('user','pwd','up')
 
    def up(self,obj):
        return obj.user
    up.empty_value_display = "指定列数据为空时,默认显示"
复制代码
from django.contrib import admin

# Register your models here.

from .models import *




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

class BookAdmin(admin.ModelAdmin):

    list_display = ("title",'publishDate', 'price',"foo","publisher")
    list_display_links = ('publishDate',"price")
    list_filter = ('price',)
    list_editable=("title","publisher")
    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)
View Code

admin源码解析

单例模式

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

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

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

  • 使用模块
  • 使用 __new__
  • 使用装饰器(decorator)
  • 使用元类(metaclass)

(1)使用 __new__

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

复制代码
class Singleton(object):
    _instance = None
    def __new__(cls, *args, **kw):
        if not cls._instance:
            cls._instance = super(Singleton, cls).__new__(cls, *args, **kw)  
        return cls._instance  

class MyClass(Singleton):  
    a = 1
复制代码

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

执行情况如下:

复制代码
>>> one = MyClass()
>>> two = MyClass()
>>> one == two
True
>>> one is two
True
>>> id(one), id(two)
(4303862608, 4303862608)
复制代码

(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  

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

<4> 执行register方法

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)
复制代码

思考:在每一个app的admin .py中加上

print(admin.site._registry)   # 执行结果?

到这里,注册结束!

<5> admin的URL配置

urlpatterns = [
    url(r'^admin/', admin.site.urls),
]
复制代码
class AdminSite(object):
    
     def get_urls(self):
        from django.conf.urls import url, include
      
        urlpatterns = []

        # 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 += [
                url(r'^%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)

      
        return urlpatterns

    @property
    def urls(self):
        return self.get_urls(), 'admin', self.name
复制代码

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

复制代码
from django.shortcuts import HttpResponse
def test01(request):
    return HttpResponse("test01")

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

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^yuan/', ([
                    url(r'^test01/', test01),
                    url(r'^test02/', test02),

                    ],None,None)),

]
复制代码

扩展优化

复制代码
from django.conf.urls import url,include
from django.contrib import admin

from django.shortcuts import HttpResponse

def change_list_view(request):
    return HttpResponse("change_list_view")
def add_view(request):
    return HttpResponse("add_view")
def delete_view(request):
    return HttpResponse("delete_view")
def change_view(request):
    return HttpResponse("change_view")

def get_urls():

    temp=[
        url(r"^$".format(app_name,model_name),change_list_view),
        url(r"^add/$".format(app_name,model_name),add_view),
        url(r"^d+/del/$".format(app_name,model_name),delete_view),
        url(r"^d+/change/$".format(app_name,model_name),change_view),
    ]

    return temp


url_list=[]

for model_class,obj in admin.site._registry.items():

    model_name=model_class._meta.model_name
    app_name=model_class._meta.app_label

    # temp=url(r"{0}/{1}/".format(app_name,model_name),(get_urls(),None,None))
    temp=url(r"{0}/{1}/".format(app_name,model_name),include(get_urls()))
    url_list.append(temp)

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^yuan/', (url_list,None,None)),
]
复制代码
原文地址:https://www.cnblogs.com/zhaopanpan/p/9118302.html