Django之model admin自定義後臺管理
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='年齡' 要使用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 createsuperuserModelAdmin物件
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):
passAdmin是如何工作的
當把'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 = Truesave_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(