Django之model admin自定義後臺管理

Admin管理界面是django的殺手級應用。它讀取你模式中的元數據,而後提供給你一個強大並且可使用的界面,網站管理者能夠用它當即向網站中添加內容。css

好比,數據表以下:html

  1.  
    from django.db import models
  2.  
     
  3.  
    # Create your models here.
  4.  
    class Author(models.Model):
  5.  
    #做者
  6.  
    name = models.CharField(max_length=30,verbose_name='姓名')#姓名
  7.  
    age = models.CharField(max_length=30,verbose_name='年齡')#年齡
  8.  
    phone = models.CharField(max_length=11,verbose_name='手機號')#手機號
  9.  
    email = models.EmailField(verbose_name='郵箱')#郵箱
  10.  
    def __str__(self):
  11.  
    return self.name
  12.  
    class Meta:
  13.  
    verbose_name = '做者'
  14.  
    verbose_name_plural = '做者'
  15.  
    class Publisher(models.Model):#出版社
  16.  
    name = models.CharField(max_length=30,verbose_name='出版社')#出版社姓名
  17.  
    address = models.CharField(max_length=50,verbose_name='地址')#出版社地址
  18.  
    city = models.CharField(max_length=60,verbose_name='城市')#出版社城市
  19.  
    state_province = models.CharField(max_length=30,verbose_name='省份')#省份
  20.  
    country = models.CharField(max_length=50,verbose_name='國家')#國家
  21.  
    website = models.URLField(verbose_name='官網')#官網
  22.  
    def __str__(self):
  23.  
    return self.name
  24.  
    class Meta:
  25.  
    verbose_name = '出版社'
  26.  
    verbose_name_plural = '出版社'
  27.  
    class Book(models.Model):#書
  28.  
    name = models.CharField(max_length=60,verbose_name='書名')#書名
  29.  
    author = models.ManyToManyField(Author,verbose_name='做者')#關聯做者
  30.  
    publisher = models.ForeignKey(Publisher,verbose_name='出版社')#關聯
  31.  
    publication_date = models.DateField(verbose_name='出版時間')#時間
  32.  
    def __str__(self):
  33.  
    return self.name
  34.  
    class Meta:
  35.  
    verbose_name = '書名'
  36.  
    verbose_name_plural = '書名'

要使用admin,能夠按照下面的步驟:python

  1. 'django.contrib.admin'加入setting的INSTALLED_APPS配置中。
  2. 保證INSTALLED_APPS中,包含'django.contrib.auth''django.contrib.contenttypes''django.contrib.messages''django.contrib.sessions.',Django的admin須要這4個包。web

    settings.py:數據庫

    1.  
      INSTALLED_APPS = [
    2.  
      'django.contrib.admin',
    3.  
      'django.contrib.auth',
    4.  
      'django.contrib.contenttypes',
    5.  
      'django.contrib.sessions',
    6.  
      'django.contrib.messages',
    7.  
      'django.contrib.staticfiles',
    8.  
      'book',
    9.  
      ]
  3. 'django.contrib.messages.context_processors.messages'添加到 TEMPLATE_CONTEXT_PROCESSORS中,並確保MIDDLEWARE_CLASSES 包含'django.contrib.auth.middleware.AuthenticationMiddleware''django.contrib.messages.middleware.MessageMiddleware'。 (默認已加入)
  4. 肯定哪些Model須要應用到admin中。
  5. 爲每一個須要admin的app中的admin.py中建立一個ModelAdmin。
  6. 註冊Model及ModelAdmin:django

    1.  
      from django.contrib import admin
    2.  
      from myproject.myapp.models import Author
    3.  
       
    4.  
      class AuthorAdmin(admin.ModelAdmin):
    5.  
      pass
    6.  
      admin.site.register(Author, AuthorAdmin)
  7. 將admin訪問配置在URLconf中緩存

    1.  
      from django.contrib import admin
    2.  
      admin.autodiscover()
    3.  
       
    4.  
      # And include this URLpattern...
    5.  
      urlpatterns = patterns('',
    6.  
      # ...
    7.  
      (r'^admin/', include(admin.site.urls)),
    8.  
      # ...
    9.  
      )
  8. 運行python manage.py migrate提醒建立superuser後就能夠訪問 http://127.0.0.1:8000/admin/ 了。其實就是生成表結構的過程:markdown

    1.  
      python manage.py makemigrations
    2.  
      python manage.py migrate
    3.  
      python manage.py createsuperuser

    ModelAdmin對象

    register裝飾器

register(*models[, site=django.admin.sites.site])

1.7中新添加。Model和ModelAdmin能夠這樣註冊:session

  1.  
    from django.contrib import admin
  2.  
    from .models import Author
  3.  
     
  4.  
    @admin.register(Author)
  5.  
    class AuthorAdmin(admin.ModelAdmin):
  6.  
    pass

能夠一次註冊多個Model,而且可使用本身定製的AdminSite:app

  1.  
    from django.contrib import admin
  2.  
    from .models import Author, Reader, Editor
  3.  
    from myproject.admin_site import custom_admin_site
  4.  
     
  5.  
    @admin.register(Author, Reader, Editor, site=custom_admin_site)
  6.  
    class PersonAdmin(admin.ModelAdmin):
  7.  
    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是排除。

  1.  
    from django.contrib import admin
  2.  
     
  3.  
    class AuthorAdmin(admin.ModelAdmin):
  4.  
    fields = ('name', 'title')
  5.  
     
  6.  
    class AuthorAdmin(admin.ModelAdmin):
  7.  
    exclude = ('birth_date',)

能夠將一些字段放在同一行,以下url和title字段放在同一行:

  1.  
    class FlatPageAdmin(admin.ModelAdmin):
  2.  
    fields = (('url', 'title'), 'content')

fieldsets

fieldsets是雙元元組(name, field_options)的列表,能夠將字段分塊:

  1.  
    from django.contrib import admin
  2.  
     
  3.  
    class FlatPageAdmin(admin.ModelAdmin):
  4.  
    fieldsets = (
  5.  
    (None, {
  6.  
    'fields': ('url', 'title', 'content', 'sites')
  7.  
    }),
  8.  
    ('Advanced options', {
  9.  
    'classes': ('collapse',),
  10.  
    'fields': ('enable_comments', 'registration_required', 'template_name')
  11.  
    }),
  12.  
    )

name

name是塊的標題,field_options是一個字典。

field_options

field_options的key有下面幾種:

fields

字段名稱的元組,在fieldset中展現:

  1.  
    {
  2.  
    'fields': (('first_name', 'last_name'), 'address', 'city', 'state'),
  3.  
    }

classes

提供給fieldset的額外CSS類的列表。

description

能夠在fieldset頂部額外展現的文本。

filter_horizontal / filter_vertical

Model有ManyToManyField字段時,使用filter_horizontal,(支持拖拽),filter_vertical能夠從現有的選項中多選。一個爲橫排,一個爲豎排。

form

使用的表單.

  1.  
    from django import forms
  2.  
    from django.contrib import admin
  3.  
    from myapp.models import Person
  4.  
     
  5.  
    class PersonForm(forms.ModelForm):
  6.  
     
  7.  
    class Meta:
  8.  
    model = Person
  9.  
    exclude = ['name']
  10.  
     
  11.  
    class PersonAdmin(admin.ModelAdmin):
  12.  
    exclude = ['age']
  13.  
    form = PersonForm

發生衝突時,ModelAdmin優先。上面的例子中age會被排除,但name會在頁面中展現。

formfield_overrides

能夠覆蓋Model表單界面的一些字段的選項,爲一些特定類型的字段添加本身定製的部件,好比,想爲本身Model的TextField字段使用富文本編輯器:

  1.  
    from django.db import models
  2.  
    from django.contrib import admin
  3.  
     
  4.  
    # Import our custom widget and our model from where they're defined
  5.  
    from myapp.widgets import RichTextEditorWidget
  6.  
    from myapp.models import MyModel
  7.  
     
  8.  
    class MyModelAdmin(admin.ModelAdmin):
  9.  
    formfield_overrides = {
  10.  
    models.TextField: {'widget': RichTextEditorWidget},
  11.  
    }

list_display

Model的change list頁面能夠展現的字段,若是不設置list_display,admin界面會自動展現Model的__unicode__()結果,在python3中爲__str__()

list_display中有4種值:

model的一個字段

list_display = ('first_name', 'last_name')list_display = ('first_name', 'last_name')

一個可調用的以model爲參數的函數

  1.  
    def upper_case_name(obj):
  2.  
    return ("%s %s" % (obj.first_name, obj.last_name)).upper()
  3.  
    upper_case_name.short_description = 'Name'
  4.  
     
  5.  
    class PersonAdmin(admin.ModelAdmin):
  6.  
    list_display = (upper_case_name,) 

ModelAdmin的一個屬性,相似於可調用函數

  1.  
    class PersonAdmin(admin.ModelAdmin):
  2.  
    list_display = ('upper_case_name',)
  3.  
     
  4.  
    def upper_case_name(self, obj):
  5.  
    return ("%s %s" % (obj.first_name, obj.last_name)).upper()
  6.  
    upper_case_name.short_description = 'Name'

Model的一個屬性,相似於可調用函數

  1.  
    from django.db import models
  2.  
    from django.contrib import admin
  3.  
     
  4.  
    class Person(models.Model):
  5.  
    name = models.CharField(max_length=50)
  6.  
    birthday = models.DateField()
  7.  
     
  8.  
    def decade_born_in(self):
  9.  
    return self.birthday.strftime('%Y')[:3] + "0's"
  10.  
    decade_born_in.short_description = 'Birth decade'
  11.  
     
  12.  
    class PersonAdmin(admin.ModelAdmin):
  13.  
    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轉義用戶的輸入:

    1.  
      from django.db import models
    2.  
      from django.contrib import admin
    3.  
      from django.utils.html import format_html
    4.  
       
    5.  
      class Person(models.Model):
    6.  
      first_name = models.CharField(max_length= 50)
    7.  
      last_name = models.CharField(max_length= 50)
    8.  
      color_code = models.CharField(max_length= 6)
    9.  
       
    10.  
      def colored_name(self):
    11.  
      return format_html('<span style="color: #{0};">{1} {2}</span>',
    12.  
      self.color_code,
    13.  
      self.first_name,
    14.  
      self.last_name)
    15.  
       
    16.  
      colored_name.allow_tags = True
    17.  
       
    18.  
      class PersonAdmin(admin.ModelAdmin):
    19.  
      list_display = ( 'first_name', 'last_name', 'colored_name')
  • 若是提供的字符串是Model或者ModelAdmin的方法或者一個可調用函數,而且返回True或者False,能夠將方法的boolean屬性設爲True。這樣頁面上會展現on或者off圖標。

    1.  
      from django.db import models
    2.  
      from django.contrib import admin
    3.  
       
    4.  
      class Person(models.Model):
    5.  
      first_name = models.CharField(max_length=50)
    6.  
      birthday = models.DateField()
    7.  
       
    8.  
      def born_in_fifties(self):
    9.  
      return self.birthday.strftime('%Y')[:3] == '195'
    10.  
      born_in_fifties.boolean = True
    11.  
       
    12.  
      class PersonAdmin(admin.ModelAdmin):
    13.  
      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屬性指出這個事實。

    1.  
      from django.db import models
    2.  
      from django.contrib import admin
    3.  
      from django.utils.html import format_html
    4.  
       
    5.  
      class Person(models.Model):
    6.  
      first_name = models.CharField(max_length=50)
    7.  
      color_code = models.CharField(max_length=6)
    8.  
       
    9.  
      def colored_first_name(self):
    10.  
      return format_html('<span style="color: #{0};">{1}</span>',
    11.  
      self.color_code,
    12.  
      self.first_name)
    13.  
       
    14.  
      colored_first_name.allow_tags = True
    15.  
      colored_first_name.admin_order_field = 'first_name'
    16.  
       
    17.  
      class PersonAdmin(admin.ModelAdmin):
    18.  
      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中的項也能夠是特性:

    1.  
      class Person(object):
    2.  
      first_name = models.CharField(max_length=50)
    3.  
      last_name = models.CharField(max_length=50)
    4.  
       
    5.  
      def my_property(self):
    6.  
      return self.first_name + ' ' + self.last_name
    7.  
      my_property.short_description = "Full name of the person"
    8.  
       
    9.  
      full_name = property(my_property)
    10.  
       
    11.  
      class PersonAdmin(admin.ModelAdmin):
    12.  
      list_display = ('full_name',) 

其中的字段會被連接到mode的change頁面

  1.  
    class PersonAdmin(admin.ModelAdmin):
  2.  
    list_display = ('first_name', 'last_name', 'birthday')
  3.  
    list_display_links = ('first_name', 'last_name')

list_editable

其中的字段在change list頁面是能夠被更改的。在其中的字段也必須在list_display中。

list_filter

其中的字段能夠做爲過濾器過濾model 。能夠是相關域。頁面右邊會出現相應的過濾器選項

  1.  
    class PersonAdmin(admin.UserAdmin):
  2.  
    list_filter = ('company__name',)

list_max_show_all

show all頁面上的model數目,缺省200。

list_per_page

每一個change list頁面的model數目,缺省100。

與select_related()有關。

ordering

排序。

  1.  
    from django.contrib import admin
  2.  
     
  3.  
    # Register your models here.
  4.  
    from book import models
  5.  
     
  6.  
    class AuthorAdmin(admin.ModelAdmin):
  7.  
    list_display = ('name','age','phone','email')
  8.  
    search_fields = ('name','age','phone','email')
  9.  
    fields = ('name','age','email','phone')
  10.  
    #按照年齡排序
  11.  
    ordering = ('age',)
  12.  
    #將做者註冊到admin後臺
  13.  
    admin.site.register(models.Author,AuthorAdmin)

paginator

使用的分頁。缺省django.core.paginator.Paginator 。

prepopulated_fields

預置字段。

radio_fields

使用radio-button代替select-box( ForeignKey或者有choices選項時)。

  1.  
    class PersonAdmin(admin.ModelAdmin):
  2.  
    radio_fields = {"group": admin.VERTICAL}

raw_id_fields

會展現其中字段的id,用於ForeignKey或者ManyToManyField。

  1.  
    class ArticleAdmin(admin.ModelAdmin):
  2.  
    raw_id_fields = ("newspaper",)

readonly_fields

只可讀不可編輯的字段。也能夠是方法:

  1.  
    from django.contrib import admin
  2.  
    from django.utils.html import format_html_join
  3.  
    from django.utils.safestring import mark_safe
  4.  
     
  5.  
    class PersonAdmin(admin.ModelAdmin):
  6.  
    readonly_fields = ('address_report',)
  7.  
     
  8.  
    def address_report(self, instance):
  9.  
    # assuming get_full_address() returns a list of strings
  10.  
    # for each line of the address and you want to separate each
  11.  
    # line by a linebreak
  12.  
    return format_html_join(
  13.  
    mark_safe('<br/>'),
  14.  
    '{0}',
  15.  
    ((line,) for line in instance.get_full_address()),
  16.  
    ) or "<span class='errors'>I can't determine this address.</span>"
  17.  
     
  18.  
    # short_description functions like a model field's verbose_name
  19.  
    address_report.short_description = "Address"
  20.  
    # in this example, we have used HTML tags in the output
  21.  
    address_report.allow_tags = True

save_as

設爲Ture時,change頁面的 "Save and add another"按鈕會被"Save as"代替。

save_on_top

設爲Ture時,change頁面的頂端也會有save按鈕。

search_fields

可搜索字段。這樣就能夠按照標題或內容搜索了

  1.  
    from django.contrib import admin
  2.  
     
  3.  
    # Register your models here.
  4.  
    from book import models
  5.  
     
  6.  
    class AuthorAdmin(admin.ModelAdmin):
  7.  
    list_display = ('name','age','phone','email')
  8.  
    #添加搜索功能
  9.  
    search_fields = ('name','age','phone','email')
  10.  
    #將做者註冊到admin後臺
  11.  
    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實例的屬性:

  1.  
    from django.contrib import admin
  2.  
     
  3.  
    class ArticleAdmin(admin.ModelAdmin):
  4.  
    def save_model(self, request, obj, form, change):
  5.  
    obj.user = request.user
  6.  
    obj.save()

delete_model(request, obj)

admin界面用戶刪除model實例時的方法。

save_formset(request, form, formset, change)

admin界面用戶保存formset的方法,能夠改寫:

  1.  
    class ArticleAdmin(admin.ModelAdmin):
  2.  
    def save_formset(self, request, form, formset, change):
  3.  
    instances = formset.save(commit=False)
  4.  
    for instance in instances:
  5.  
    instance.user = request.user
  6.  
    instance.save()
  7.  
    formset.save_m2m()

get_ordering(request)

排序

  1.  
    class PersonAdmin(admin.ModelAdmin):
  2.  
     
  3.  
    def get_ordering(self, request):
  4.  
    if request.user.is_superuser:
  5.  
    return ['name', 'rank']
  6.  
    else:
  7.  
    return ['name']

get_search_results(request, queryset, search_term)

能夠定製查詢結果

save_related(request, form, formsets, change)

formsets是model的inline formsets的列表。model的相關對象保存時的行爲。

  1.  
    def save_related(self, request, form, formsets, change):
  2.  
    """
  3.  
    Given the ``HttpRequest``, the parent ``ModelForm`` instance, the
  4.  
    list of inline formsets and a boolean value based on whether the
  5.  
    parent is being added or changed, save the related objects to the
  6.  
    database. Note that at this point save_form() and save_model() have
  7.  
    already been called.
  8.  
    """
  9.  
    form.save_m2m()
  10.  
    for formset in formsets:
  11.  
    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對象的列表或元組

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def get_inline_instances(self, request, obj=None):
  3.  
    return [inline(self.model, self.admin_site) for inline in self.inlines]

get_urls()

返回ModelAdmin的可用urls。

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def get_urls(self):
  3.  
    urls = super(MyModelAdmin, self).get_urls()
  4.  
    my_urls = patterns('',
  5.  
    (r'^my_view/$', self.my_view)
  6.  
    )
  7.  
    return my_urls + urls
  8.  
     
  9.  
    def my_view(self, request):
  10.  
    # custom view which should return an HttpResponse
  11.  
    pass

上面my_view方法的路徑就是 /admin/myapp/mymodel/my_view/ 。

不過上面的例子中無驗證和緩存,要提供驗證和緩存:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def get_urls(self):
  3.  
    urls = super(MyModelAdmin, self).get_urls()
  4.  
    my_urls = patterns('',
  5.  
    (r'^my_view/$', self.admin_site.admin_view(self.my_view))
  6.  
    )
  7.  
    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))

get_form(request, obj=None, **kwargs)
返回add和change view使用的ModelForm。下面用戶非superuser時會隱藏一些字段。

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def get_form(self, request, obj=None, **kwargs):
  3.  
    self.exclude = []
  4.  
    if not request.user.is_superuser:
  5.  
    self.exclude.append('field_to_hide')
  6.  
    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:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    inlines = [MyInline, SomeOtherInline]
  3.  
     
  4.  
    def get_formsets(self, request, obj=None):
  5.  
    for inline in self.get_inline_instances(request, obj):
  6.  
    # hide MyInline in the add view
  7.  
    if isinstance(inline, MyInline) and obj is None:
  8.  
    continue
  9.  
    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:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    inlines = [MyInline, SomeOtherInline]
  3.  
     
  4.  
    def get_formsets_with_inlines(self, request, obj=None):
  5.  
    for inline in self.get_inline_instances(request, obj):
  6.  
    # hide MyInline in the add view
  7.  
    if isinstance(inline, MyInline) and obj is None:
  8.  
    continue
  9.  
    yield inline.get_formset(request, obj), inline

formfield_for_foreignkey(db_field, request, **kwargs)
Foreignkey字段使用的默認formfield. 根據不一樣的用戶返回不一樣的子集:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def formfield_for_foreignkey(self, db_field, request, **kwargs):
  3.  
    if db_field.name == "car":
  4.  
    kwargs["queryset"] = Car.objects.filter(owner=request.user)
  5.  
    return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)

formfield_for_manytomany(db_field, request, **kwargs)
相似於formfield_for_foreignkey,這個方法用於many to many字段.:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def formfield_for_manytomany(self, db_field, request, **kwargs):
  3.  
    if db_field.name == "cars":
  4.  
    kwargs["queryset"] = Car.objects.filter(owner=request.user)
  5.  
    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:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def formfield_for_choice_field(self, db_field, request, **kwargs):
  3.  
    if db_field.name == "status":
  4.  
    kwargs['choices'] = (
  5.  
    ('accepted', 'Accepted'),
  6.  
    ('denied', 'Denied'),
  7.  
    )
  8.  
    if request.user.is_superuser:
  9.  
    kwargs['choices'] += (('ready', 'Ready for deployment'),)
  10.  
    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類。

  1.  
    from django import forms
  2.  
     
  3.  
    class MyForm(forms.ModelForm):
  4.  
    pass
  5.  
     
  6.  
    class MyModelAdmin(admin.ModelAdmin):
  7.  
    def get_changelist_form(self, request, **kwargs):
  8.  
    return MyForm

ModelAdmin.get_changelist_formset(request, **kwargs)
返回changelist頁面使用的ModelFormSet類。

  1.  
    from django.forms.models import BaseModelFormSet
  2.  
     
  3.  
    class MyAdminFormSet(BaseModelFormSet):
  4.  
    pass
  5.  
     
  6.  
    class MyModelAdmin(admin.ModelAdmin):
  7.  
    def get_changelist_formset(self, request, **kwargs):
  8.  
    kwargs['formset'] = MyAdminFormSet
  9.  
    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返回不一樣的結果:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
    def get_queryset(self, request):
  3.  
    qs = super(MyModelAdmin, self).get_queryset(request)
  4.  
    if request.user.is_superuser:
  5.  
    return qs
  6.  
    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'}:

  1.  
    def get_changeform_initial_data(self, request):
  2.  
    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:

  1.  
    class MyModelAdmin(admin.ModelAdmin):
  2.  
     
  3.  
    # A template for a very customized change view:
  4.  
    change_form_template = 'admin/myapp/extras/openstreetmap_change_form.html'
  5.  
     
  6.  
    def get_osm_info(self):
  7.  
    # ...
  8.  
    pass
  9.  
     
  10.  
    def change_view(self, request, object_id, form_url='', extra_context=None):
  11.  
    extra_context = extra_context or {}
  12.  
    extra_context['osm_data'] = self.get_osm_info()
  13.  
    return super(MyModelAdmin, self).change_view(request, object_id,
  14.  
    form_url, extra_context=extra_context)

ModelAdmin asset definitions

爲ModelAdmin的 add/change views添加js和css:

  1.  
    class ArticleAdmin(admin.ModelAdmin):
  2.  
    class Media:
  3.  
    css = {
  4.  
    "all": ("my_styles.css",)
  5.  
    }
  6.  
    js = ("my_code.js",)

Adding custom validation to the admin

定製form:

  1.  
    class MyArticleAdminForm(forms.ModelForm):
  2.  
    def clean_name(self):
  3.  
    # do something that validates your data
  4.  
    return self.cleaned_data["name"]
  5.  
    class ArticleAdmin(admin.ModelAdmin):
  6.  
    form = MyArticleAdminForm
 
 
 
標籤
相關文章
相關標籤/搜索