不修改Django源码让admin中的Model列表按注册顺序显示

不修改Django源码让admin中的Model列表按注册顺序显示

博客分类： 
• Django
• Python

Django Admin Model 顺序 ordering

Django的admin管理后台一直是一个很强大的工具，但是有一个让人很不爽的地方就是model列表的显示顺序是按model名字来的，如果是英文按字母顺序还比较好找，如果是中文则是完全无序了，一个app下的model一多就会比较难找要修改的model。

 

 

查看django源代码发现这个顺序是在admin代码里面写死的，并没有可以供人配置的地方。但为了这个修改源代码也不方便维护和升级。所以想到如何在不修改django源代码的情况下，按照model的注册顺序显示，那样就可以将相关的model在一块儿显示了。

 

其实代码原理非常简单，给django的admin site的index view 和 app_index view这2个函数添加decorator，修改这2个函数的返回值即可。因为从django 1.4开始，这2个函数返回的不是已经render好的HTML页面，而是一个lazy的TemplateResponse （参考 https://docs.djangoproject.com/en/1.4/ref/template-response/ ）。这个东西只有在需要的时候才生成HTML页面，而在这之前我们仍可以修改里面的context_data。那样最后render模板的时候就会使用修改后的context_data了。

 

最后的源代码如下所示：

 

Python代码  

1. # -*- coding: utf-8 -*-  
2. from django.contrib import admin  
3. from django.utils.text import capfirst  
4. from django.utils.datastructures import SortedDict  
5.   
6. def find_model_index(name):  
7.     count = 0  
8.     for model, model_admin in admin.site._registry.items():  
9.         if capfirst(model._meta.verbose_name_plural) == name:  
10.             return count  
11.         else:  
12.             count += 1  
13.     return count  
14.           
15. def index_decorator(func):  
16.     def inner(*args, **kwargs):  
17.         templateresponse = func(*args, **kwargs)  
18.         for app in templateresponse.context_data['app_list']:  
19.             app['models'].sort(key=lambda x: find_model_index(x['name']))  
20.         return templateresponse  
21.     return inner  
22.   
23. registry = SortedDict()  
24. registry.update(admin.site._registry)  
25. admin.site._registry = registry  
26. admin.site.index = index_decorator(admin.site.index)  
27. admin.site.app_index = index_decorator(admin.site.app_index)  
28. #admin.site.register(yourmodel, yourmodeladmin)  

 

1、首先使用有序字典替换原来的无序字典作为注册model的数据容器，并把已经存在的数据拷贝到新的有序字典里面。

2、装饰index view 和 app_index view这2个函数，修改templateresponse的返回值里面的context_data，按注册时的顺序重新排序。

3、之后安装正常的django admin register方式使用即可。

4、需要注意的地方，上述代码最好放在比较早运行的地方，比如settings.py 里面自己写的app里面的首个的admin.py文件中，否则在运行到这段代码之前已经注册的admin model是无序的。