后臺管理頁面也可通過安裝插件來添加更人性化的功能,django-import-export
插件可以django-admin直接從excel表格中導(dǎo)入數(shù)據(jù),也可導(dǎo)出為excel表格光戈。
安裝
使用pip安裝
pip install django-import-export
而后在settings 的installed_app 里添加上這個app
INSTALLED_APPS = [
# ...,
'import_export',
]
基本配置
使用此插件的基本思想與模型、序列化是統(tǒng)一的,都是數(shù)據(jù)的按格式輸入輸出暇仲。模型和序列化都需要新建自己單獨的文件,導(dǎo)入導(dǎo)出也可以有自己單獨的文件枣抱,而且建議這樣做(到后期關(guān)于導(dǎo)入-導(dǎo)出類的代碼會比較多熔吗,放在單獨文件里更方便)。
在需要使用導(dǎo)入導(dǎo)出功能的app內(nèi)新建resource.py
文件佳晶,寫入以下基本內(nèi)容
from import_export import resources
class TeacherResource(resources.ModelResource):
# 此處可寫方法以添加更多功能
class Meta:
model = teacher
# fields內(nèi)的模型字段會被導(dǎo)入導(dǎo)出, exclude內(nèi)的會被排除在外桅狠,如果都不寫,默認為模型中的全部字段都要包含轿秧。
fields=[
'job_num',
'head_class',
'name',
'employ_src',
'gender',
'id_card_num',
]
excloud = (
'first_diploma',
'home_address',
'honor_award',
)
# export_order(自定義) 選項設(shè)置導(dǎo)出字段的顯式順序中跌,沒在這里規(guī)定的就按默認順序排在后面(不能只寫一個)(導(dǎo)入不用管順序)
export_order = ('id', 'name')
# 下面規(guī)定聯(lián)合主鍵,決定是update還是create菇篡,可以避免重復(fù)導(dǎo)入相同的記錄
import_id_fields = ['phone', 'id_card_num']
注意漩符,在fields內(nèi),可以使用雙下劃線模型關(guān)系驱还,如果有關(guān)聯(lián)關(guān)系字段嗜暴,一定要在這里設(shè)置需正確顯示的內(nèi)容,否則只會輸出關(guān)系對象的id议蟆,不會輸出模型的__str__
闷沥。但這僅在導(dǎo)出時有用,如果希望導(dǎo)入導(dǎo)出都使用中文表頭咐容,推薦使用小部件widget舆逃,后面會講到。
在admin.py
中使用這個“資源”文件,即可給管理頁面添加一個導(dǎo)入導(dǎo)出的入口按鈕路狮。
from .models import teacher
# 取一個插件內(nèi)的管理器
from import_export.admin import ImportExportModelAdmin
# 導(dǎo)入剛剛寫好的Resource
from .resource import TeacherResource
# 重寫一個管理類虫啥,并綁定到模型類
@admin.register(teacher)
class TeacherColumnsAdmin(ImportExportModelAdmin):
# 對接資源類
resource_class = TeacherResource
# 類表頁面展示哪些,與導(dǎo)入導(dǎo)出無關(guān)
list_display = (
'job_num',
'id_card_num',
'name',
'gender',
'employ_src',
'employ_unit',
)
配置好這些奄妨,進入管理界面列表頁涂籽,即可發(fā)現(xiàn)導(dǎo)入導(dǎo)出按鈕,點擊后可按提示進行正常操作展蒂。
進階設(shè)置
導(dǎo)入導(dǎo)出表格的表頭改為自定義中文
因為這些工具都是外國人做的又活,很多地方語言都是英文,做網(wǎng)站給別人用的話還是中文比較人性化锰悼,所以我們要做一些修改柳骄。
第一種方法,適合需修改的地方比較少的情況
from import_export.fields import Field
class TeacherResource(resources.ModelResource):
fieldname = Field(attribute='fieldname', column_name='自定義的名字')
# 還可繼續(xù)寫其他字段
class Meta:
model = teacher
field.Field()功能很強大箕般,可以覆寫模型原本的字段以添加功能耐薯,也可添加模型中不存在的新字段,用于輸出經(jīng)過計算后的數(shù)據(jù)丝里。
有時候模型字段的定義處verbose_name已經(jīng)是中文了曲初,這時可以直接拿來用,這就是第二種方法杯聚,
原理是重寫ModelResource的成員方法
- 如果只需要導(dǎo)出表表頭為中文臼婆,重寫get_export_fields();
- 如果只需要導(dǎo)入表表頭為中文幌绍,重寫get_import_fields()颁褂;
- 如果導(dǎo)入和導(dǎo)出的表頭都需要為中文,只重寫get_fields()即可
class TeacherResource(resources.ModelResource):
def __init__(self):
super(TeacherResource, self).__init__()
# 獲取模型的字段列表,
field_list = teacher._meta.fields
# 做成一個{字段名:中文名}的字典傀广,作為成員變量
self.vname_dict = {i.name:i.verbose_name for i in field_list}
# 每一個field中包含有name和verbose_name, 直接提取轉(zhuǎn)化為字典
# 如果導(dǎo)入和導(dǎo)出的表頭都需要為中文颁独,只重寫get_fields即可
def get_fields(self, **kwargs):
fields = super().get_fields(**kwargs)
for field in fields:
field_name = self.get_field_name(field)
# 自定義導(dǎo)出字段里可能有關(guān)聯(lián)關(guān)系,但vname_dict肯定沒有雙下劃線伪冰,所以必須處理
if field_name.find("__") > 0:
# 如果是關(guān)聯(lián)關(guān)系的誓酒,只取字段名,不找關(guān)聯(lián)贮聂,因為關(guān)聯(lián)內(nèi)容不在vname_dict里
field_name = field_name.split("__")[0]
# 如果此字段有verbose_name靠柑,就用
if field_name in self.vname_dict.keys():
field.column_name = self.vname_dict[field_name]
return fields
修改默認導(dǎo)出文件格式
相比之下,CSV格式的導(dǎo)出速度特別快吓懈,所以可以規(guī)定只能導(dǎo)出這種格式以提高使用體驗病往。(如果需要其他格式可以再另存為啊)
在admin.py
中按照如下代碼修改
@admin.register(teacher)
class TeacherAdmin(ImportExportModelAdmin):
def get_export_formats(self): #該方法是限制格式
formats = (
base_formats.CSV,
)
return [f for f in formats if f().can_export()]
resource_class = TeacherResource
使用小部件widget修改關(guān)聯(lián)關(guān)系的導(dǎo)入導(dǎo)出
在field.Field()中添加widget參數(shù)可輸入輸出的數(shù)據(jù)格式。
如果模型中使用了關(guān)聯(lián)關(guān)系字段骄瓣,在導(dǎo)入導(dǎo)出中默認只能使用關(guān)系對象的主鍵,很不方便。import-export內(nèi)置了接口可以很方便地修改榕栏。
從源碼的注釋抄來的范例:
from import_export import fields, resources
from import_export.widgets import ForeignKeyWidget
class BookResource(resources.ModelResource):
# 給Resource添加一個自定義字段畔勤,指向模型的關(guān)系對象,用widget做格式規(guī)范
author = fields.Field(
column_name='author',
attribute='author',
widget=ForeignKeyWidget(Author, 'name'))
# 在字段列表里加上這個自定義字段
class Meta:
fields = ('author',)
如此修改后扒磁,導(dǎo)入導(dǎo)出就可以使用name
而不需要使用主鍵了(name不要有相同的)庆揪,而且雙下劃線也不需要寫了,如果寫上會出現(xiàn)重復(fù)的一列妨托。
使用小部件widget實現(xiàn)布爾類型和“是否”的轉(zhuǎn)換
導(dǎo)入時中文的“是否”都不識別缸榛,導(dǎo)出時只能顯示0和1,以下是使用小部件widget的解決方案
在resource.py
中按如下代碼修改
# 重寫內(nèi)置的BooleanWidget
class TeacherBooleanWidget(widgets.BooleanWidget):
def render(self, value, obj):
# 如果模型字段做了`null=True`的設(shè)置兰伤,這里就可以處理“真内颗、假、未知”三種狀態(tài)
if value in self.NULL_VALUES:
return "未知"
return '是' if value else '否'
def clean(self, value, row, *args, **kwargs):
if value in self.NULL_VALUES:
return None
return True if value in ['是','師范'] else False
# 在Resource里再聲明一下字段
class TeacherResource(resources.ModelResource):
is_teacher_college = Field(attribute='is_teacher_college', widget=TeacherBooleanWidget())
is_teacher_major = Field(attribute='is_teacher_major', widget=TeacherBooleanWidget())
如果模型字段做了null=True
的設(shè)置敦腔,這里就可以處理“真均澳、假、未知”三種狀態(tài)
如果模型字段設(shè)置了blank=True
符衔,則管理界面的此字段變?yōu)榉潜靥钫仪啊5獸oreignKey不可設(shè)置blank=True
,能正常保存但會導(dǎo)致此紀(jì)錄在列表頁不可見判族,可能是BUG躺盛。