Django中的admin自定制相关-阿里云开发者社区

开发者社区> 开发与运维> 正文

Django中的admin自定制相关

简介: Django admin是Django 提供的基于 web 的管理工具。Django 自动管理工具是 django.contrib 的一部分。你可以在项目的 settings.py 中的 INSTALLED_APPS 看到它。

Django admin是Django 提供的基于 web 的管理工具。Django 自动管理工具是 django.contrib 的一部分。你可以在项目的 settings.py 中的 INSTALLED_APPS 看到它。django.contrib是一套庞大的功能集,它是Django基本代码的组成部分。

Django内置的Admin是对于model中对应的数据表进行增删改查提供的组件。

admin的内部依赖:
    依赖APP:
        django.contrib.auth
        django.contrib.contenttypes
        django.contrib.messages
        django.contrib.sessions

    模板的context_processors:
        django.contrib.auth.context_processors.auth
        django.contrib.messages.context_processors.messages

    中间件:
        django.contrib.auth.middleware.AuthenticationMiddleware 
        django.contrib.messages.middleware.MessageMiddleware

一、定制admin

  • 在admin.py中只需要将Mode中的某个类注册一下,即可在Admin中实现增删改查的功能,注册规则如下:
from django.contrib import admin
from app import models
admin.site.register(models.UserInfo)
  • 以上这种方式比较简单,如果想要进行更多的定制操作,需要利用ModelAdmin进行操作,如下:
方式一:
    class UserAdmin(admin.ModelAdmin):#必须继承admin.ModelAdmin
        pass 
    admin.site.register(models.UserInfo, UserAdmin)  # 第一个参数可以是列表
      
方式二:
    @admin.register(models.UserInfo) # 第一个参数可以是列表
    class UserAdmin(admin.ModelAdmin):
        list_display = ('user', 'pwd',)

二、 ModelAdmin中提供的可定制功能简单示例

  • list_display,列表或元组内的元素是Model中的字符串类型的字段,定制显示的列。
class UserInfo(admin.ModelAdmin):
   list_display = ("username","phone","email")

admin.site.register(models.UserInfo,UserInfo)
  • list_display_links,列表或元组内的元素是Model中的字符串类型的字段,定制列可以点击跳转。
class UserInfo(admin.ModelAdmin):
    list_display = ("username","phone","email")
    list_display_links = ['username','phone','email']
admin.site.register(models.UserInfo,UserInfo)
  • list_filter,定制右侧快速筛选。
class UserInfo(admin.ModelAdmin):
    list_display = ("username","phone","email")
    list_display_links = ['username','phone','email']
    list_filter = ['username','phone']#一般列表里面存放的字段都是一对多的字段,要不然就没什么意义了

admin.site.register(models.UserInfo,UserInfo)
  • search_fields,模糊搜索的功能
class UserInfo(admin.ModelAdmin):
    list_display = ("username","phone","email")
    list_display_links = ['username','phone','email']
    list_filter = ['username','phone']#一般列表里面存放的字段都是一对多的字段,要不然就没什么意义了
    search_fields = ["username",'phone']

admin.site.register(models.UserInfo,UserInfo)
  • action,定制action中的操作
class ArticleAction(admin.ModelAdmin):

    def func(self, request, queryset):
        queryset.delete()

    func.short_description = "快捷删除选中项"
    actions = [func, ]
    # Action选项都是在页面上方显示
    actions_on_top = True
    # Action选项都是在页面下方显示
    actions_on_bottom = False
    # 是否显示选择个数
    actions_selection_counter = True

admin.site.register(models.Article,ArticleAction)
  • list_select_related,连表查询是否自动select_related,对应的值是Ture或False
  • 分页相关
# 分页,每页显示条数
    list_per_page = 100
 
# 分页,显示全部(真实数据<该值时,才会有显示全部)
    list_max_show_all = 200
 
# 分页插件
    paginator = Paginator
  • date_hierarchy,对Date和DateTime类型进行搜索
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    date_hierarchy = 'ctime'
  • preserve_filters,详细页面,删除、修改,更新后跳转回列表后,是否保留原搜索条件
  • save_as = False,详细页面,按钮为“Sava as new” 或 “Sava and add another”
  • save_as_continue = True,点击保存并继续编辑
save_as_continue = True
 
# 如果 save_as=True,save_as_continue = True, 点击Sava as new 按钮后继续编辑。
# 如果 save_as=True,save_as_continue = False,点击Sava as new 按钮后返回列表。
 
New in Django 1.10.
  • save_on_top = False,详细页面,在页面上方是否也显示保存删除等按钮
  • inlines,详细页面,如果有其他表和当前表做FK,那么详细页面可以进行动态增加和删除
class UserInfoInline(admin.StackedInline): # TabularInline
    extra = 0
    model = models.UserInfo
 
class GroupAdminMode(admin.ModelAdmin):
    list_display = ('id', 'title',)
    inlines = [UserInfoInline, ]
  • 定制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
  • raw_id_fields,详细页面,针对FK和M2M字段变成以Input框形式
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    raw_id_fields = ('FK字段', 'M2M字段',)
  • fields,详细页面时,显示字段的字段
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    fields = ('user',)
  • exclude,详细页面时,排除的字段
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    exclude = ('user',)
  • readonly_fields,详细页面时,只读字段
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    readonly_fields = ('user',)
  • 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'),
        }),
    )
  • 详细页面时,M2M显示时,数据移动选择(方向:上下和左右)
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    filter_vertical = ("m2m字段",) # 或filter_horizontal = ("m2m字段",)
  • ordering,列表时,数据排序规则
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
   ordering = ('-id',)
   或
   def get_ordering(self, request):
       return ['-id', ]
  • view_on_site,编辑时,是否在页面上显示view on set
view_on_site = False
或
def view_on_site(self, obj):
    return 'https://www.baidu.com'
  • radio_fields,详细页面时,使用radio显示选项(FK默认使用select)
radio_fields = {"ug": admin.VERTICAL} # 或admin.HORIZONTAL
  • show_full_result_count = True,列表时,模糊搜索后面显示的数据个数样式
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    # show_full_result_count = True # 1 result (12 total)
    # show_full_result_count = False  # 1 result (Show all)
    search_fields = ('user',)
  • formfield_overrides = {},详细页面时,指定现实插件
from django.forms import widgets
from django.utils.html import format_html
 
class MyTextarea(widgets.Widget):
    def __init__(self, attrs=None):
        # Use slightly better defaults than HTML's 20x2 box
        default_attrs = {'cols': '40', 'rows': '10'}
        if attrs:
            default_attrs.update(attrs)
        super(MyTextarea, self).__init__(default_attrs)
 
    def render(self, name, value, attrs=None):
        if value is None:
            value = ''
        final_attrs = self.build_attrs(attrs, name=name)
        return format_html('<textarea {}>\r\n{}</textarea>',final_attrs, value)
  
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    formfield_overrides = {
        models.models.CharField: {'widget': MyTextarea},
    }
  • prepopulated_fields = {},添加页面,当在某字段填入值后,自动会将值填充到指定字段。
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    prepopulated_fields = {"email": ("user","pwd",)}

PS: DjangoAdmin中使用js实现功能,页面email字段的值会在输入:user、pwd时自动填充
  • 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
  • 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 = "指定列数据为空时,默认显示"

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

其他文章