知識預覽

admin元件使用

admin原始碼解析

admin元件使用

Django提供了基於web的管理工具

Django自動管理工具是django.contrib的一部分，你可以在專案的setting.py中的INSTALLED_APPS看到它：

# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    
 
'django.contrib.messages',
    'django.contrib.staticfiles',
    "app01"
]

 django.contrib是一套龐大的功能集，它是Django基本程式碼的組成部分。

啟用管理工具

通常我們會在生成專案時在urls.py中自動設定好

from django.conf.urls import url
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),

]

使用管理工具

啟動開發伺服器，然後在瀏覽器中訪問 http://127.0.0.1:8000/admin/，得到登陸介面，你可以通過命令 python manage.py createsuperuser

 來建立超級使用者。

為了讓 admin 介面管理某個資料模型，我們需要先註冊該資料模型到 admin

from django.db import models

# Create your models here.




class Author(models.Model):

    name=models.CharField( max_length=32)
    age=models.IntegerField()


    def __str__(self):
        return self.name

class Publish(models.Model):

    name
 
=models.CharField( max_length=32)
    email=models.EmailField()

    def __str__(self):
        return self.name


class Book(models.Model):

    title = models.CharField( max_length=32)
    publishDate=models.DateField()
    price=models.DecimalField(max_digits=5,decimal_places=2)

    publisher=models.ForeignKey(to="Publish")
    authors=models.ManyToManyField(to='Author')

    def __str__(self):
        return self.title

admin的定製

在admin.py中只需要講Mode中的某個類註冊，即可在Admin中實現增刪改查的功能，如：

admin.site.register(models.UserInfo)

但是，這種方式比較簡單，如果想要進行更多的定製操作，需要利用ModelAdmin進行操作，如：

方式一：
    class UserAdmin(admin.ModelAdmin):
        list_display = ('user', 'pwd',)
 
    admin.site.register(models.UserInfo, UserAdmin) # 第一個引數可以是列表
     
 
方式二：
    @admin.register(models.UserInfo)                # 第一個引數可以是列表
    class UserAdmin(admin.ModelAdmin):
        list_display = ('user', 'pwd',)

ModelAdmin中提供了大量的可定製功能，如

 1. list_display，列表時，定製顯示的列。

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd', 'xxxxx')
 
    def xxxxx(self, obj):
        return "xxxxx"

2. list_display_links，列表時，定製列可以點選跳轉。

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd', 'xxxxx')
    list_display_links = ('pwd',)

3. list_filter，列表時，定製右側快速篩選。

4. list_select_related，列表時，連表查詢是否自動select_related

5. list_editable，列表時，可以編輯的列 

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    list_display = ('user', 'pwd','ug',)
    list_editable = ('ug',)

6. search_fields，列表時，模糊搜尋的功能

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
     
    search_fields = ('user', 'pwd')

7. date_hierarchy，列表時，對Date和DateTime型別進行搜尋

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    date_hierarchy = 'ctime'

8  inlines，詳細頁面，如果有其他表和當前表做FK，那麼詳細頁面可以進行動態增加和刪除

class UserInfoInline(admin.StackedInline): # TabularInline
    extra = 0
    model = models.UserInfo
 
 
class GroupAdminMode(admin.ModelAdmin):
    list_display = ('id', 'title',)
    inlines = [UserInfoInline, ]

9 action，列表時，定製action中的操作

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    # 定製Action行為具體方法
    def func(self, request, queryset):
        print(self, request, queryset)
        print(request.POST.getlist('_selected_action'))
 
    func.short_description = "中文顯示自定義Actions"
    actions = [func, ]
 
    # Action選項都是在頁面上方顯示
    actions_on_top = True
    # Action選項都是在頁面下方顯示
    actions_on_bottom = False
 
    # 是否顯示選擇個數
    actions_selection_counter = True

10 定製HTML模板

add_form_template = None
change_form_template = None
change_list_template = None
delete_confirmation_template = None
delete_selected_confirmation_template = None
object_history_template = None

11 raw_id_fields，詳細頁面，針對FK和M2M欄位變成以Input框形式

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    raw_id_fields = ('FK欄位', 'M2M欄位',)

12  fields，詳細頁面時，顯示欄位的欄位

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    fields = ('user',)

13 exclude，詳細頁面時，排除的欄位

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    exclude = ('user',)

14  readonly_fields，詳細頁面時，只讀欄位

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    readonly_fields = ('user',)

15 fieldsets，詳細頁面時，使用fieldsets標籤對資料進行分割顯示

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    fieldsets = (
        ('基本資料', {
            'fields': ('user', 'pwd', 'ctime',)
        }),
        ('其他', {
            'classes': ('collapse', 'wide', 'extrapretty'),  # 'collapse','wide', 'extrapretty'
            'fields': ('user', 'pwd'),
        }),
    )

16 詳細頁面時，M2M顯示時，資料移動選擇（方向：上下和左右）

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    filter_vertical = ("m2m欄位",) # 或filter_horizontal = ("m2m欄位",)

17 ordering，列表時，資料排序規則

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    ordering = ('-id',)
    或
    def get_ordering(self, request):
        return ['-id', ]

18. radio_fields，詳細頁面時，使用radio顯示選項（FK預設使用select）

radio_fields = {"ug": admin.VERTICAL} # 或admin.HORIZONTAL

19 form = ModelForm，用於定製使用者請求時候表單驗證

from app01 import models
from django.forms import ModelForm
from django.forms import fields
 
 
class MyForm(ModelForm):
    others = fields.CharField()
 
    class Meta:
        model = models = models.UserInfo
        fields = "__all__"
 
@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
 
    form = MyForm

20 empty_value_display = "列資料為空時，顯示預設值"

@admin.register(models.UserInfo)
class UserAdmin(admin.ModelAdmin):
    empty_value_display = "列資料為空時，預設顯示"
 
    list_display = ('user','pwd','up')
 
    def up(self,obj):
        return obj.user
    up.empty_value_display = "指定列資料為空時，預設顯示"

admin原始碼解析

單例模式

單例模式（Singleton Pattern）是一種常用的軟體設計模式，該模式的主要目的是確保某一個類只有一個例項存在。當你希望在整個系統中，某個類只能出現一個例項時，單例物件就能派上用場。

比如，某個伺服器程式的配置資訊存放在一個檔案中，客戶端通過一個 AppConfig 的類來讀取配置檔案的資訊。如果在程式執行期間，有很多地方都需要使用配置檔案的內容，也就是說，很多地方都需要建立 AppConfig 物件的例項，這就導致系統中存在多個 AppConfig 的例項物件，而這樣會嚴重浪費記憶體資源，尤其是在配置檔案內容很多的情況下。事實上，類似 AppConfig 這樣的類，我們希望在程式執行期間只存在一個例項物件。

在 Python 中，我們可以用多種方法來實現單例模式：

• 使用模組
• 使用 __new__
• 使用裝飾器（decorator）
• 使用元類（metaclass）

（1）使用 __new__

為了使類只能出現一個例項，我們可以使用 __new__ 來控制例項的建立過程，程式碼如下：

class Singleton(object):
    _instance = None
    def __new__(cls, *args, **kw):
        if not cls._instance:
            cls._instance = super(Singleton, cls).__new__(cls, *args, **kw)  
        return cls._instance  

class MyClass(Singleton):  
    a = 1

在上面的程式碼中，我們將類的例項和一個類變數 _instance 關聯起來，如果 cls._instance 為 None 則建立例項，否則直接返回 cls._instance。

執行情況如下：

>>> one = MyClass()
>>> two = MyClass()
>>> one == two
True
>>> one is two
True
>>> id(one), id(two)
(4303862608, 4303862608)

（2）使用模組

其實，Python 的模組就是天然的單例模式，因為模組在第一次匯入時，會生成 .pyc 檔案，當第二次匯入時，就會直接載入 .pyc 檔案，而不會再次執行模組程式碼。因此，我們只需把相關的函式和資料定義在一個模組中，就可以獲得一個單例物件了。如果我們真的想要一個單例類，可以考慮這樣做：

# mysingleton.py
class My_Singleton(object):
    def foo(self):
        pass
 
my_singleton = My_Singleton()

將上面的程式碼儲存在檔案 mysingleton.py 中，然後這樣使用：

from mysingleton import my_singleton
 
my_singleton.foo()

admin執行流程

<1> 迴圈載入執行所有已經註冊的app中的admin.py檔案

def autodiscover():
    autodiscover_modules('admin', register_to=site)

<2> 執行程式碼

＃admin.py

class BookAdmin(admin.ModelAdmin):
    list_display = ("title",'publishDate', 'price')

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

<3> admin.site  

這裡應用的是一個單例模式，對於AdminSite類的一個單例模式，執行的每一個app中的每一個admin.site都是一個物件

<4> 執行register方法

admin.site.register(Book, BookAdmin) 
admin.site.register(Publish)

class ModelAdmin(BaseModelAdmin):pass

def register(self, model_or_iterable, admin_class=None, **options):
    if not admin_class:
            admin_class = ModelAdmin
    # Instantiate the admin class to save in the registry
    self._registry[model] = admin_class(model, self)

思考：在每一個app的admin .py中加上

print(admin.site._registry)   ＃ 執行結果？

到這裡，註冊結束！

<5> admin的URL配置

urlpatterns = [
    url(r'^admin/', admin.site.urls),
]

class AdminSite(object):
    
     def get_urls(self):
        from django.conf.urls import url, include
      
        urlpatterns = []

        # Add in each model's views, and create a list of valid URLS for the
        # app_index
        valid_app_labels = []
        for model, model_admin in self._registry.items():
            urlpatterns += [
                url(r'^%s/%s/' % (model._meta.app_label, model._meta.model_name), include(model_admin.urls)),
            ]
            if model._meta.app_label not in valid_app_labels:
                valid_app_labels.append(model._meta.app_label)

      
        return urlpatterns

    @property
    def urls(self):
        return self.get_urls(), 'admin', self.name

<6>  url()方法的擴充套件應用

from django.shortcuts import HttpResponse
def test01(request):
    return HttpResponse("test01")

def test02(request):
    return HttpResponse("test02")

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^yuan/', ([
                    url(r'^test01/', test01),
                    url(r'^test02/', test02),

                    ],None,None)),

]

擴充套件優化

from django.conf.urls import url,include
from django.contrib import admin

from django.shortcuts import HttpResponse

def change_list_view(request):
    return HttpResponse("change_list_view")
def add_view(request):
    return HttpResponse("add_view")
def delete_view(request):
    return HttpResponse("delete_view")
def change_view(request):
    return HttpResponse("change_view")

def get_urls():

    temp=[
        url(r"^$".format(app_name,model_name),change_list_view),
        url(r"^add/$".format(app_name,model_name),add_view),
        url(r"^\d+/del/$".format(app_name,model_name),delete_view),
        url(r"^\d+/change/$".format(app_name,model_name),change_view),
    ]

    return temp


url_list=[]

for model_class,obj in admin.site._registry.items():

    model_name=model_class._meta.model_name
    app_name=model_class._meta.app_label

    # temp=url(r"{0}/{1}/".format(app_name,model_name),(get_urls(),None,None))
    temp=url(r"{0}/{1}/".format(app_name,model_name),include(get_urls()))
    url_list.append(temp)

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^yuan/', (url_list,None,None)),
]