Admin管理界面是django的杀手级应用。它读取你模式中的元数据,而后提供给你一个强大并且可使用的界面,网站管理者能够用它当即向网站中添加内容。css
好比,数据表以下:html
from django.db import models
# Create your models here.
class Author(models.Model):
#做者
name = models.CharField(max_length=30,verbose_name='姓名')#姓名
age = models.CharField(max_length=30,verbose_name='年龄')#年龄
phone = models.CharField(max_length=11,verbose_name='手机号')#手机号
email = models.EmailField(verbose_name='邮箱')#邮箱
def __str__(self):
return self.name
class Meta:
verbose_name = '做者'
verbose_name_plural = '做者'
class Publisher(models.Model):#出版社
name = models.CharField(max_length=30,verbose_name='出版社')#出版社姓名
address = models.CharField(max_length=50,verbose_name='地址')#出版社地址
city = models.CharField(max_length=60,verbose_name='城市')#出版社城市
state_province = models.CharField(max_length=30,verbose_name='省份')#省份
country = models.CharField(max_length=50,verbose_name='国家')#国家
website = models.URLField(verbose_name='官网')#官网
def __str__(self):
return self.name
class Meta:
verbose_name = '出版社'
verbose_name_plural = '出版社'
class Book(models.Model):#书
name = models.CharField(max_length=60,verbose_name='书名')#书名
author = models.ManyToManyField(Author,verbose_name='做者')#关联做者
publisher = models.ForeignKey(Publisher,verbose_name='出版社')#关联
publication_date = models.DateField(verbose_name='出版时间')#时间
def __str__(self):
return self.name
class Meta:
verbose_name = '书名'
verbose_name_plural = '书名'
要使用admin,能够按照下面的步骤:python
'django.contrib.admin'
加入setting的INSTALLED_APPS配置中。保证INSTALLED_APPS中,包含'django.contrib.auth'
,'django.contrib.contenttypes'
,'django.contrib.messages'
和'django.contrib.sessions.'
,Django的admin须要这4个包。web
settings.py:数据库
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'book',
]
'django.contrib.messages.context_processors.messages'
添加到 TEMPLATE_CONTEXT_PROCESSORS
中,并确保MIDDLEWARE_CLASSES
包含'django.contrib.auth.middleware.AuthenticationMiddleware'
和'django.contrib.messages.middleware.MessageMiddleware'
。 (默认已加入)注册Model及ModelAdmin:django
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/ 了。其实就是生成表结构的过程:markdown
python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser
register(*models[, site=django.admin.sites.site])
1.7中新添加。Model和ModelAdmin能够这样注册:session
from django.contrib import admin
from .models import Author
class AuthorAdmin(admin.ModelAdmin):
pass
能够一次注册多个Model,而且可使用本身定制的AdminSite:app
from django.contrib import admin
from .models import Author, Reader, Editor
from myproject.admin_site import custom_admin_site
class PersonAdmin(admin.ModelAdmin):
pass
当把'django.contrib.admin'添加到INSTALLED_APPS后,django会自动查找每一个app中的admin.py模块而且import载入。
Django 1.7新增.
admin默认的AppConfig类.当django启动时会执行autodiscover()。
Django 1.7新增.
相似于AdminConfig,不会执行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'
。
admin actions的列表
action的位置。
将date_hierarchy设成Model的DateField或者DateTimeField,就能够为admin中的此Model添加日期层次。
决定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是双元元组(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顶部额外展现的文本。
Model有ManyToManyField字段时,使用filter_horizontal,(支持拖拽),filter_vertical能够从现有的选项中多选。一个为横排,一个为竖排。
使用的表单.
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会在页面中展现。
能够覆盖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},
}
Model的change list页面能够展现的字段,若是不设置list_display,admin界面会自动展现Model的__unicode__()
结果,在python3中为__str__()
。
list_display中有4种值:
list_display = ('first_name', 'last_name')
list_display = ('first_name', 'last_name')
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,)
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'
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')
若是提供的字符串是Model或者ModelAdmin的方法或者一个可调用函数,django会自动的HTML-escape输出,若是不想转义,能够将方法的allow_tags设为True。为了不XSS跨站攻击,须要使用format_html转义用户的输入:
若是提供的字符串是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 = ('__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'
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',)
其中的字段会被连接到mode的change页面
class PersonAdmin(admin.ModelAdmin):
list_display = ('first_name', 'last_name', 'birthday')
list_display_links = ('first_name', 'last_name')
其中的字段在change list页面是能够被更改的。在其中的字段也必须在list_display中。
其中的字段能够做为过滤器过滤model 。能够是相关域。页面右边会出现相应的过滤器选项
class PersonAdmin(admin.UserAdmin):
list_filter = ('company__name',)
show all页面上的model数目,缺省200。
每一个change list页面的model数目,缺省100。
与select_related()有关。
排序。
from django.contrib import admin
# Register your models here.
from book import models
class AuthorAdmin(admin.ModelAdmin):
list_display = ('name','age','phone','email')
search_fields = ('name','age','phone','email')
fields = ('name','age','email','phone')
#按照年龄排序
ordering = ('age',)
#将做者注册到admin后台
admin.site.register(models.Author,AuthorAdmin)
使用的分页。缺省django.core.paginator.Paginator 。
预置字段。
使用radio-button代替select-box( ForeignKey或者有choices选项时)。
class PersonAdmin(admin.ModelAdmin):
radio_fields = {"group": admin.VERTICAL}
会展现其中字段的id,用于ForeignKey或者ManyToManyField。
class ArticleAdmin(admin.ModelAdmin):
raw_id_fields = ("newspaper",)
只可读不可编辑的字段。也能够是方法:
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
设为Ture时,change页面的 "Save and add another"按钮会被"Save as"代替。
设为Ture时,change页面的顶端也会有save按钮。
可搜索字段。这样就能够按照标题或内容搜索了
from django.contrib import admin
# Register your models here.
from book import models
class AuthorAdmin(admin.ModelAdmin):
list_display = ('name','age','phone','email')
#添加搜索功能
search_fields = ('name','age','phone','email')
#将做者注册到admin后台
admin.site.register(models.Author,AuthorAdmin)
是否显示View on site连接。
一些定制admin模板时指定模板所用的选项。
add_view()使用的模板.
change_view()使用的模板.
changelist_view()使用的模板.
delete_view()使用的模板。
delete_selected action method 使用的模板。
history_view()使用的模板,日志。
此方法为admin界面用户保存model实例时的行为。request为HttpRequest实例,obj为model实例,form为ModelForm实例,change为bool值,取决于model实例是新增的仍是修改的。
重写此方法能够作一些pre-save或者post-save行为。
好比,能够把request.user保存为model实例的属性:
from django.contrib import admin
class ArticleAdmin(admin.ModelAdmin):
def save_model(self, request, obj, form, change):
obj.user = request.user
obj.save()
admin界面用户删除model实例时的方法。
admin界面用户保存formset的方法,能够改写:
class ArticleAdmin(admin.ModelAdmin):
def save_formset(self, request, form, formset, change):
instances = formset.save(commit=False)
for instance in instances:
instance.user = request.user
instance.save()
formset.save_m2m()
排序
class PersonAdmin(admin.ModelAdmin):
def get_ordering(self, request):
if request.user.is_superuser:
return ['name', 'rank']
else:
return ['name']
能够定制查询结果
formsets是model的inline formsets的列表。model的相关对象保存时的行为。
def save_related(self, request, form, formsets, change):
"""
Given the ``HttpRequest``, the parent ``ModelForm`` instance, the
list of inline formsets and a boolean value based on whether the
parent is being added or changed, save the related objects to the
database. Note that at this point save_form() and save_model() have
already been called.
"""
form.save_m2m()
for formset in formsets:
self.save_formset(request, form, formset, change=change)
返回只读字段。
返回预置字段。
返回list_display。
返回list_display_link。
返回fields。
返回fieldsets。
返回list_filter。
返回search_fields。
返回InlineModelAdmin对象的列表或元组
class MyModelAdmin(admin.ModelAdmin):
def get_inline_instances(self, request, obj=None):
return [inline(self.model, self.admin_site) for inline in self.inlines]
返回ModelAdmin的可用urls。
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
urls = super(MyModelAdmin, self).get_urls()
my_urls = patterns('',
(r'^my_view/$', self.my_view)
)
return my_urls + urls
def my_view(self, request):
# custom view which should return an HttpResponse
pass
上面my_view方法的路径就是 /admin/myapp/mymodel/my_view/
。
不过上面的例子中无验证和缓存,要提供验证和缓存:
class MyModelAdmin(admin.ModelAdmin):
def get_urls(self):
urls = super(MyModelAdmin, self).get_urls()
my_urls = patterns('',
(r'^my_view/$', self.admin_site.admin_view(self.my_view))
)
return my_urls + urls
若是页面可缓存而仍是要进行权限验证:
(r'^my_view/$', self.admin_site.admin_view(self.my_view, cacheable=True))
(r'^my_view/$', self.admin_site.admin_view(self.my_view, cacheable=True))
class MyModelAdmin(admin.ModelAdmin):
def get_form(self, request, obj=None, **kwargs):
self.exclude = []
if not request.user.is_superuser:
self.exclude.append('field_to_hide')
return super(MyModelAdmin, self).get_form(request, obj, **kwargs)
Yields InlineModelAdmins for use in admin add and change views.
若是只想在the change view中展现一个特殊的inline:
class MyModelAdmin(admin.ModelAdmin):
inlines = [MyInline, SomeOtherInline]
def get_formsets(self, request, obj=None):
for inline in self.get_inline_instances(request, obj):
# hide MyInline in the add view
if isinstance(inline, MyInline) and obj is None:
continue
yield inline.get_formset(request, obj)
Yields (FormSet, InlineModelAdmin) pairs for use in admin add and change views.
若是只想在the change view中展现一个特殊的inline:
class MyModelAdmin(admin.ModelAdmin):
inlines = [MyInline, SomeOtherInline]
def get_formsets_with_inlines(self, request, obj=None):
for inline in self.get_inline_instances(request, obj):
# hide MyInline in the add view
if isinstance(inline, MyInline) and obj is None:
continue
yield inline.get_formset(request, obj), inline
class MyModelAdmin(admin.ModelAdmin):
def formfield_for_foreignkey(self, db_field, request, **kwargs):
if db_field.name == "car":
kwargs["queryset"] = Car.objects.filter(owner=request.user)
return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)
class MyModelAdmin(admin.ModelAdmin):
def formfield_for_manytomany(self, db_field, request, **kwargs):
if db_field.name == "cars":
kwargs["queryset"] = Car.objects.filter(owner=request.user)
return super(MyModelAdmin, self).formfield_for_manytomany(db_field, request, **kwargs)
class MyModelAdmin(admin.ModelAdmin):
def formfield_for_choice_field(self, db_field, request, **kwargs):
if db_field.name == "status":
kwargs['choices'] = (
('accepted', 'Accepted'),
('denied', 'Denied'),
)
if request.user.is_superuser:
kwargs['choices'] += (('ready', 'Ready for deployment'),)
return super(MyModelAdmin, self).formfield_for_choice_field(db_field, request, **kwargs)
from django import forms
class MyForm(forms.ModelForm):
pass
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_form(self, request, **kwargs):
return MyForm
from django.forms.models import BaseModelFormSet
class MyAdminFormSet(BaseModelFormSet):
pass
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_formset(self, request, **kwargs):
kwargs['formset'] = MyAdminFormSet
return super(MyModelAdmin, self).get_changelist_formset(request, **kwargs)
是否具备add权限。
是否具备change权限。
是否具备delete权限。
返回admin界面可编辑的model QuerySet集。 根据不一样的user返回不一样的结果:
class MyModelAdmin(admin.ModelAdmin):
def get_queryset(self, request):
qs = super(MyModelAdmin, self).get_queryset(request)
if request.user.is_superuser:
return qs
return qs.filter(author=request.user)
向使用django.contrib.messages backend的用户发送信息。
返回一个分页实例。Returns an instance of the paginator to use for this view. By default, instantiates an instance of paginator.
决定add_view()的HttpResponse,model被建立后运行。
决定change_view()的HttpResponse,model被修改后运行。
决定delete_view()的HttpResponse,model被删除后运行。
obj_display是被删除对象的name。
A hook for the initial data on admin change forms. By default, fields are given initial values from GET parameters. For instance, ?name=initial_value will set the name field’s initial value to be initial_value.
This method should return a dictionary in the form {'fieldname': 'fieldval'}:
def get_changeform_initial_data(self, request):
return {'name': 'custom_initial_value'}
Django view for the model instance addition page. See note below.
Django view for the model instance edition page. See note below.
Django view for the model instances change list/actions page. See note below.
Django view for the model instance(s) deletion confirmation page. See note below.
Django view for the page that shows the modification history for a given model instance.
这5个方法是被实际的设定为django的view方法的。能够重构,通常是添加渲染view使用的模板的context data:
class MyModelAdmin(admin.ModelAdmin):
# A template for a very customized change view:
change_form_template = 'admin/myapp/extras/openstreetmap_change_form.html'
def get_osm_info(self):
# ...
pass
def change_view(self, request, object_id, form_url='', extra_context=None):
extra_context = extra_context or {}
extra_context['osm_data'] = self.get_osm_info()
return super(MyModelAdmin, self).change_view(request, object_id,
form_url, extra_context=extra_context)
为ModelAdmin的 add/change views添加js和css:
class ArticleAdmin(admin.ModelAdmin):
class Media:
css = {
"all": ("my_styles.css",)
}
js = ("my_code.js",)
定制form:
class MyArticleAdminForm(forms.ModelForm):
def clean_name(self):
# do something that validates your data
return self.cleaned_data["name"]
class ArticleAdmin(admin.ModelAdmin):
form = MyArticleAdminForm