Admin管理界面是django的殺手級應用。它讀取你模式中的元數據,然后提供給你一個強大而且可以使用的界面,網站管理者可以用它立即向網站中添加內容。
比如,數據表如下:
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,可以按照下面的步驟:
-
將
'django.contrib.admin'
加入setting的INSTALLED_APPS配置中。 -
保證INSTALLED_APPS中,包含
'django.contrib.auth'
,'django.contrib.contenttypes'
,'django.contrib.messages'
和'django.contrib.sessions.'
,Django的admin需要這4個包。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需要應用到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/ 了。其實就是生成表結構的過程:
python manage.py makemigrations python manage.py migrate python manage.py createsuperuser
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
name是塊的標題,field_options是一個字典。
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__()
結果,在python3中為__str__()
。
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')
list_display之TIPS:
-
如果字段是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
排序。
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)
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
可搜索字段。這樣就可以按照標題或內容搜索了
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
是否顯示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()使用的模板,日志。
ModelAdmin methods
save_model(request, obj, form, change)
此方法為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()
delete_model(request, obj)
admin界面用戶刪除model實例時的方法。
save_formset(request, form, formset, change)
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()
get_ordering(request)
排序
class PersonAdmin(admin.ModelAdmin):
def get_ordering(self, request):
if request.user.is_superuser:
return ['name', 'rank']
else:
return ['name']
get_search_results(request, queryset, search_term)
可以定制查詢結果
save_related(request, form, formsets, change)
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)
get_readonly_fields(request, obj=None)
返回只讀字段。
get_prepopulated_fields(request, obj=None)
返回預置字段。
get_list_display(request)
返回list_display。
get_list_display_links(request, list_display)
返回list_display_link。
get_fields(request, obj=None)
返回fields。
get_fieldsets(request, obj=None)
返回fieldsets。
get_list_filter(request)
返回list_filter。
get_search_fields(request)
返回search_fields。
get_inline_instances(request, obj=None)
返回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]
get_urls()
返回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))
get_form(request, obj=None, **kwargs)
返回add和change view使用的ModelForm。下面用戶非superuser時會隱藏一些字段。
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)
get_formsets(request, obj=None)
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)
get_formsets_with_inlines(request, obj=None)
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
formfield_for_foreignkey(db_field, request, **kwargs)
Foreignkey字段使用的默認formfield. 根據不同的用戶返回不同的子集:
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)
formfield_for_manytomany(db_field, request, **kwargs)
類似於formfield_for_foreignkey,這個方法用於many to many字段.:
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)
ModelAdmin.formfield_for_choice_field(db_field, request, **kwargs)
類似於formfield_for_foreignkey和formfield_for_manytomany,這個方法用於choices:
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)
ModelAdmin.get_changelist(request, **kwargs)
返回changelist頁面使用的Changelis類. 缺省django.contrib.admin.views.main.ChangeList。
ModelAdmin.get_changelist_form(request, **kwargs)
返回changelist頁面使用的ModelForm類。
from django import forms
class MyForm(forms.ModelForm):
pass
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_form(self, request, **kwargs):
return MyForm
ModelAdmin.get_changelist_formset(request, **kwargs)
返回changelist頁面使用的ModelFormSet類。
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)
ModelAdmin.has_add_permission(request)
是否具有add權限。
ModelAdmin.has_change_permission(request, obj=None)
是否具有change權限。
ModelAdmin.has_delete_permission(request, obj=None)
是否具有delete權限。
ModelAdmin.get_queryset(request)
返回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)
ModelAdmin.message_user(request, message, level=messages.INFO, extra_tags='', fail_silently=False)
向使用django.contrib.messages backend的用戶發送信息。
ModelAdmin.get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True)
返回一個分頁實例。Returns an instance of the paginator to use for this view. By default, instantiates an instance of paginator.
ModelAdmin.response_add(request, obj, post_url_continue=None)
決定add_view()的HttpResponse,model被創建后運行。
ModelAdmin.response_change(request, obj)
決定change_view()的HttpResponse,model被修改后運行。
ModelAdmin.response_delete(request, obj_display)
決定delete_view()的HttpResponse,model被刪除后運行。
obj_display是被刪除對象的name。
ModelAdmin.get_changeform_initial_data(request)
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'}
其他方法
ModelAdmin.add_view(request, form_url='', extra_context=None)
Django view for the model instance addition page. See note below.
ModelAdmin.change_view(request, object_id, form_url='', extra_context=None)
Django view for the model instance edition page. See note below.
ModelAdmin.changelist_view(request, extra_context=None)
Django view for the model instances change list/actions page. See note below.
ModelAdmin.delete_view(request, object_id, extra_context=None)
Django view for the model instance(s) deletion confirmation page. See note below.
ModelAdmin.history_view(request, object_id, extra_context=None)
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 asset definitions
為ModelAdmin的 add/change views添加js和css:
class ArticleAdmin(admin.ModelAdmin):
class Media:
css = {
"all": ("my_styles.css",)
}
js = ("my_code.js",)
Adding custom validation to the admin
定制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