Admin管理界面是django的杀手级应用。它读取你模式中的元数据,然后提供给你一个强大而且可以使用的界面,网站管理者可以用它立即向网站中添加内容。
要使用admin,可以按照下面的步骤:
- 将'django.contrib.admin'加入setting的INSTALLED_APPS配置中。
- 保证INSTALLED_APPS中包含'django.contrib.auth','django.contrib.contenttypes','django.contrib.messages'和'django.contrib.sessions.',Django的admin需要这4个包。
- 将'django.contrib.messages.context_processors.messages'添加到 TEMPLATE_CONTEXT_PROCESSORS中,并确保MIDDLEWARE_CLASSES 包含'django.contrib.auth.middleware.AuthenticationMiddleware'和'django.contrib.messages.middleware.MessageMiddleware'。 (默认已加入)
- 确定哪些Model需要应用到admin中。
- 为每个需要admin的app中的admin.py中创建一个ModelAdmin。
- 注册Model及ModelAdmin
from django.contrib import admin from myproject.myapp.models import Author class AuthorAdmin(admin.ModelAdmin): pass admin.site.register(Author, AuthorAdmin)
- 将admin访问配置在URLconf中
from django.contrib import admin admin.autodiscover() # And include this URLpattern... urlpatterns = patterns('', # ... (r'^admin/', include(admin.site.urls)), # ... )
运行python manage.py migrate提醒创建superuser后就可以访问http://127.0.0.1:8000/admin/了。
ModelAdmin对象
register装饰器
register(*models[, site=django.admin.sites.site])
1.7中新添加。Model和ModelAdmin可以这样注册:
from django.contrib import admin from .models import Author @admin.register(Author) class AuthorAdmin(admin.ModelAdmin): pass
可以一次注册多个Model,并且可以使用自己定制的AdminSite:
from django.contrib import admin from .models import Author, Reader, Editor from myproject.admin_site import custom_admin_site @admin.register(Author, Reader, Editor, site=custom_admin_site) class PersonAdmin(admin.ModelAdmin): pass
Admin是如何工作的
当把'django.contrib.admin'添加到INSTALLED_APPS后,django会自动查找每个app中的admin.py模块并且import载入。
class apps.AdminConfig
Django 1.7新增.
admin默认的AppConfig类.当django启动时会执行autodiscover()。
class apps.SimpleAdminConfig
Django 1.7新增.
类似于AdminConfig,不会执行autodiscover().
autodiscover()
import每个app的admin.py模块。
Django 1.7改变:
在以前的版本中需要在urls.py中手动启动此方法去寻找每个app的admin.py,1.7后AdminConfig会自动执行此方法。
如果正在使用定制的AdminSite,需要将ModelAdmin的子类载入到自己的代码中并全部注册到定制的AdminSite中。这种情况下需要停止自动discovery(),可以将'django.contrib.admin.apps.SimpleAdminConfig'代替INSTALLED_APPS中的'django.contrib.admin'。
ModelAdmin选项
actions
admin actions的列表
actions_on_top
actions_on_bottom
action的位置。
date_hierarchy
将date_hierarchy设成Model的DateField或者DateTimeField,就可以为admin中的此Model添加日期层次。
fields
exclude
决定Model的form中展现哪些字段。fields是包括,exclude是排除。
from django.contrib import admin class AuthorAdmin(admin.ModelAdmin): fields = ('name', 'title') class AuthorAdmin(admin.ModelAdmin): exclude = ('birth_date',)
可以将一些字段放在同一行,如下url和title字段放在同一行:
class FlatPageAdmin(admin.ModelAdmin): fields = (('url', 'title'), 'content')
fieldsets
fieldsets是双元元组(name, field_options)的列表,可以将字段分块:
from django.contrib import admin class FlatPageAdmin(admin.ModelAdmin): fieldsets = ( (None, { 'fields': ('url', 'title', 'content', 'sites') }), ('Advanced options', { 'classes': ('collapse',), 'fields': ('enable_comments', 'registration_required', 'template_name') }), )
name是块的标题,field_options是一个字典。
field_options的key有下面几种:
fields
字段名称的元组,在fieldset中展示
{ 'fields': (('first_name', 'last_name'), 'address', 'city', 'state'), }
classes
提供给fieldset的额外CSS类的列表。
description
可以在fieldset顶部额外展示的文本。
filter_horizontal
filter_vertical
Model有ManyToManyField字段时,使用filter_horizontal,filter_vertical可以从现有的选项中多选。一个为横排,一个为竖排。
form
使用的表单。
from django import forms from django.contrib import admin from myapp.models import Person class PersonForm(forms.ModelForm): class Meta: model = Person exclude = ['name'] class PersonAdmin(admin.ModelAdmin): exclude = ['age'] form = PersonForm
发生冲突时,ModelAdmin优先。上面的例子中age会被排除,但name会在页面中展示。
formfield_overrides
可以覆盖Model表单界面的一些字段的选项,为一些特定类型的字段添加自己定制的部件
比如,想为自己Model的TextField字段使用富文本编辑器:
from django.db import models from django.contrib import admin # Import our custom widget and our model from where they're defined from myapp.widgets import RichTextEditorWidget from myapp.models import MyModel class MyModelAdmin(admin.ModelAdmin): formfield_overrides = { models.TextField: {'widget': RichTextEditorWidget}, }
list_display
Model的change list页面可以展示的字段,如果不设置list_display,admin界面会自动展示Model的__unicode__()结果。
list_display中有4种值:
- model的一个字段
list_display = ('first_name', 'last_name')
- 一个可调用的以model为参数的函数
def upper_case_name(obj): return ("%s %s" % (obj.first_name, obj.last_name)).upper() upper_case_name.short_description = 'Name' class PersonAdmin(admin.ModelAdmin): list_display = (upper_case_name,)
- ModelAdmin的一个属性,类似于可调用函数
class PersonAdmin(admin.ModelAdmin): list_display = ('upper_case_name',) def upper_case_name(self, obj): return ("%s %s" % (obj.first_name, obj.last_name)).upper() upper_case_name.short_description = 'Name'
- Model的一个属性,类似于可调用函数
from django.db import models from django.contrib import admin class Person(models.Model): name = models.CharField(max_length=50) birthday = models.DateField() def decade_born_in(self): return self.birthday.strftime('%Y')[:3] + "0's" decade_born_in.short_description = 'Birth decade' class PersonAdmin(admin.ModelAdmin): list_display = ('name', 'decade_born_in')
Note:
- 如果字段是ForeignKey,会显示外键的__unicode__。
- 不支持ManyToManyField
- 如果是BooleanField,会显示on或者off。
- 如果提供的字符串是Model或者ModelAdmin的方法或者一个可调用函数,django会自动的HTML-escape输出,如果不想转义,可以将方法的allow_tags设为True。为了避免XSS跨站攻击,需要使用format_html转义用户的输入:
from django.db import models from django.contrib import admin from django.utils.html import format_html class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) color_code = models.CharField(max_length=6) def colored_name(self): return format_html('<span style="color: #{0};">{1} {2}</span>', self.color_code, self.first_name, self.last_name) colored_name.allow_tags = True class PersonAdmin(admin.ModelAdmin): list_display = ('first_name', 'last_name', 'colored_name')
- 如果提供的字符串是Model或者ModelAdmin的方法或者一个可调用函数,并且返回True或者False,可以将方法的boolean属性设为True。这样页面上会展示on或者off图标。
from django.db import models from django.contrib import admin class Person(models.Model): first_name = models.CharField(max_length=50) birthday = models.DateField() def born_in_fifties(self): return self.birthday.strftime('%Y')[:3] == '195' born_in_fifties.boolean = True class PersonAdmin(admin.ModelAdmin): list_display = ('name', 'born_in_fifties')
- Model的__str__或者__unicode__方法也可以使用
list_display = ('__str__', 'some_other_field')
- 如果list_display中的项不是数据库的实际字段,那么不可以以此项排序。反之,则可以以此项排序,可以通过设置 admin_order_field属性指出这个事实。
from django.db import models from django.contrib import admin from django.utils.html import format_html class Person(models.Model): first_name = models.CharField(max_length=50) color_code = models.CharField(max_length=6) def colored_first_name(self): return format_html('<span style="color: #{0};">{1}</span>', self.color_code, self.first_name) colored_first_name.allow_tags = True colored_first_name.admin_order_field = 'first_name' class PersonAdmin(admin.ModelAdmin): list_display = ('first_name', 'colored_first_name')
这样试图以colored_first_name排序时,django会以first_name排序。可以反向排序:
colored_first_name.admin_order_field = '-first_name'
-
list_display中的项也可以是特性:
class Person(object): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) def my_property(self): return self.first_name + ' ' + self.last_name my_property.short_description = "Full name of the person" full_name = property(my_property) class PersonAdmin(admin.ModelAdmin): list_display = ('full_name',)
list_display_link
其中的字段会被链接到mode的change页面
class PersonAdmin(admin.ModelAdmin): list_display = ('first_name', 'last_name', 'birthday') list_display_links = ('first_name', 'last_name')
list_editable
其中的字段在change list页面是可以被更改的。在其中的字段也必须在list_display中。
list_filter
其中的字段可以作为过滤器过滤model 。可以是相关域。
class PersonAdmin(admin.UserAdmin): list_filter = ('company__name',)
list_max_show_all
show all页面上的model数目,缺省200。
list_per_page
每个change list页面的model数目,缺省100。
list_select_related
与select_related()有关。
ordering
排序。
paginator
使用的分页。缺省django.core.paginator.Paginator 。
prepopulated_fields
预置字段。
radio_fields
使用radio-button代替select-box( ForeignKey或者有choices选项时)。
class PersonAdmin(admin.ModelAdmin): radio_fields = {"group": admin.VERTICAL}
raw_id_fields
会展示其中字段的id,用于ForeignKey或者ManyToManyField。
class ArticleAdmin(admin.ModelAdmin): raw_id_fields = ("newspaper",)
readonly_fields
只可读不可编辑的字段。也可以是方法:
from django.contrib import admin from django.utils.html import format_html_join from django.utils.safestring import mark_safe class PersonAdmin(admin.ModelAdmin): readonly_fields = ('address_report',) def address_report(self, instance): # assuming get_full_address() returns a list of strings # for each line of the address and you want to separate each # line by a linebreak return format_html_join( mark_safe('<br/>'), '{0}', ((line,) for line in instance.get_full_address()), ) or "<span class='errors'>I can't determine this address.</span>" # short_description functions like a model field's verbose_name address_report.short_description = "Address" # in this example, we have used HTML tags in the output address_report.allow_tags = True
save_as
设为Ture时,change页面的 "Save and add another"按钮会被"Save as"代替。
save_on_top
设为Ture时,change页面的顶端也会有save按钮。
search_fields
可搜索字段。
view_on_site
是否显示View on site链接。
template options
一些定制admin模板时指定模板所用的选项。
add_form_template
add_view()使用的模板.
change_form_template
change_view()使用的模板.
change_list_template
changelist_view()使用的模板.
delete_confirmation_template
delete_view()使用的模板。
delete_selected_confirmation_template
delete_selected action method 使用的模板。
ModelAdmin.object_history_template
history_view()使用的模板,日志。