Django学习(10)后台批量导入导出import-export

后台管理页面也可通过安装插件来添加更人性化的功能,django-import-export插件可以django-admin直接从excel表格中导入数据,也可导出为excel表格。

安装

使用pip安装

pip install django-import-export

而后在settings 的installed_app 里添加上这个app

INSTALLED_APPS = [

#   ...,

    'import_export',

]

基本配置

使用此插件的基本思想与模型序列化是统一的,都是数据的按格式输入输出。模型和序列化都需要新建自己单独的文件,导入导出也可以有自己单独的文件,而且建议这样做(到后期关于导入-导出类的代码会比较多,放在单独文件里更方便)。

在需要使用导入导出功能的app内新建resource.py文件,写入以下基本内容

from import_export import resources

class TeacherResource(resources.ModelResource):
    # 此处可写方法以添加更多功能
    class Meta:
        model = teacher
        # fields内的模型字段会被导入导出, exclude内的会被排除在外,如果都不写,默认为模型中的全部字段都要包含。
        fields=[
            'job_num',
            'head_class',
            'name',
            'employ_src',
            'gender',
            'id_card_num',
        ]
        excloud = (
            'first_diploma',
            'home_address',
            'honor_award',
        )
        # export_order(自定义) 选项设置导出字段的显式顺序,没在这里规定的就按默认顺序排在后面(不能只写一个)(导入不用管顺序)
        export_order = ('id', 'name')
        # 下面规定联合主键,决定是update还是create,可以避免重复导入相同的记录
        import_id_fields = ['phone', 'id_card_num'] 

注意,在fields内,可以使用双下划线模型关系,如果有关联关系字段,一定要在这里设置需正确显示的内容,否则只会输出关系对象的id,不会输出模型的__str__。但这仅在导出时有用,如果希望导入导出都使用中文表头,推荐使用小部件widget,后面会讲到。
admin.py中使用这个“资源”文件,即可给管理页面添加一个导入导出的入口按钮。

from .models import teacher
# 取一个插件内的管理器
from import_export.admin import ImportExportModelAdmin
# 导入刚刚写好的Resource
from .resource import TeacherResource
# 重写一个管理类,并绑定到模型类
@admin.register(teacher)
class TeacherColumnsAdmin(ImportExportModelAdmin):
    # 对接资源类
    resource_class = TeacherResource
    # 类表页面展示哪些,与导入导出无关
    list_display = (
        'job_num',
            'id_card_num',
            'name',
            'gender',
            'employ_src',
            'employ_unit',
)

配置好这些,进入管理界面列表页,即可发现导入导出按钮,点击后可按提示进行正常操作。


图片.png

进阶设置

导入导出表格的表头改为自定义中文

因为这些工具都是外国人做的,很多地方语言都是英文,做网站给别人用的话还是中文比较人性化,所以我们要做一些修改。
第一种方法,适合需修改的地方比较少的情况

from import_export.fields import Field
class TeacherResource(resources.ModelResource):
    fieldname = Field(attribute='fieldname', column_name='自定义的名字')
    # 还可继续写其他字段
    class Meta:
        model = teacher

field.Field()功能很强大,可以覆写模型原本的字段以添加功能,也可添加模型中不存在的新字段,用于输出经过计算后的数据。
有时候模型字段的定义处verbose_name已经是中文了,这时可以直接拿来用,这就是第二种方法,
原理是重写ModelResource的成员方法

  • 如果只需要导出表表头为中文,重写get_export_fields();
  • 如果只需要导入表表头为中文,重写get_import_fields();
  • 如果导入和导出的表头都需要为中文,只重写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, 直接提取转化为字典
    # 如果导入和导出的表头都需要为中文,只重写get_fields即可
    def get_fields(self, **kwargs):
        fields = super().get_fields(**kwargs)
        for field in fields:
            field_name = self.get_field_name(field)
            # 自定义导出字段里可能有关联关系,但vname_dict肯定没有双下划线,所以必须处理
            if field_name.find("__") > 0:
                # 如果是关联关系的,只取字段名,不找关联,因为关联内容不在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

修改默认导出文件格式

相比之下,CSV格式的导出速度特别快,所以可以规定只能导出这种格式以提高使用体验。(如果需要其他格式可以再另存为啊)
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修改关联关系的导入导出

在field.Field()中添加widget参数可输入输出的数据格式。
如果模型中使用了关联关系字段,在导入导出中默认只能使用关系对象的主键,很不方便。import-export内置了接口可以很方便地修改。
从源码的注释抄来的范例:

        from import_export import fields, resources
        from import_export.widgets import ForeignKeyWidget

        class BookResource(resources.ModelResource):
# 给Resource添加一个自定义字段,指向模型的关系对象,用widget做格式规范
            author = fields.Field(
                column_name='author',
                attribute='author',
                widget=ForeignKeyWidget(Author, 'name'))
# 在字段列表里加上这个自定义字段
            class Meta:
                fields = ('author',)

如此修改后,导入导出就可以使用name而不需要使用主键了(name不要有相同的),而且双下划线也不需要写了,如果写上会出现重复的一列。

使用小部件widget实现布尔类型和“是否”的转换

导入时中文的“是否”都不识别,导出时只能显示0和1,以下是使用小部件widget的解决方案
resource.py中按如下代码修改

# 重写内置的BooleanWidget
class TeacherBooleanWidget(widgets.BooleanWidget):
    def render(self, value, obj):
# 如果模型字段做了`null=True`的设置,这里就可以处理“真、假、未知”三种状态
        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的设置,这里就可以处理“真、假、未知”三种状态
如果模型字段设置了blank=True,则管理界面的此字段变为非必填。但ForeignKey不可设置blank=True,能正常保存但会导致此纪录在列表页不可见,可能是BUG。

你可能感兴趣的:(Django学习(10)后台批量导入导出import-export)