Django django-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',)

导入导出中文格式

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

下面规定联合主键，决定是update还是create，可以避免重复导入相同的记录

    import_id_fields = ['phone', 'id_card_num'] 

导入文件时候，必须是 utf-8 格式

使用记事本打开并重新保存一下，为 utf-8 格式

修改默认导出文件格式

相比之下，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实现布尔类型和“是否”的转换

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

# 重写内置的BooleanWidget
from import_export.widgets import ForeignKeyWidget, BooleanWidget
class TeacherBooleanWidget(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。

实例

• model.py

class DmGroupsModel(models.Model):
    name = models.CharField(max_length=32, verbose_name='分组', unique=True)
    ct_time = models.DateTimeField('创建时间',auto_now_add=True)
    up_time = models.DateTimeField('更新时间',auto_now=True)
    create_by = models.ForeignKey(User, on_delete=models.CASCADE, related_name='dmgroups', verbose_name='创建者')

    def __str__(self):
        return self.name

    class Meta:
        ordering  = ['-up_time','-id']
        verbose_name = '分组'
        verbose_name_plural  = verbose_name


class DomainsModel(models.Model):
    name = models.CharField(max_length=32, verbose_name='域名', unique=True)
    status = models.BooleanField(default=True, verbose_name='状态')
    redirect = models.URLField(null=False,max_length=500,verbose_name='跳转地址')
    group = models.ForeignKey(DmGroupsModel, on_delete=models.CASCADE, related_name='groups', verbose_name='所属组')
    ct_time = models.DateTimeField('创建时间',auto_now_add=True)
    up_time = models.DateTimeField('更新时间',auto_now=True)
    create_by = models.ForeignKey(User, on_delete=models.CASCADE, related_name='domains', verbose_name='创建者')

    def __str__(self):
        return self.name

    class Meta:
        ordering  = ['-up_time','-id']
        verbose_name = '域名'
        verbose_name_plural  = verbose_name

• resources.py

from import_export import resources, fields
from import_export.widgets import ForeignKeyWidget, BooleanWidget
from django.contrib.auth.models import User
from .models import DmGroupsModel, DomainsModel




class StatusBooleanWidget(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



        
class DomainResource(resources.ModelResource):
    def __init__(self):
        super(DomainResource, self).__init__()
        # 获取模型的字段列表, 
        field_list = DomainsModel._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

    status = fields.Field(attribute='status', widget=StatusBooleanWidget())
    # 处理一对多外键
    group = fields.Field(column_name='group', attribute='group', widget=ForeignKeyWidget(DmGroupsModel, 'name'))
    create_by = fields.Field(column_name='create_by', attribute='create_by', widget=ForeignKeyWidget(User, 'username'))

    class Meta:
        model = DomainsModel

        fields = [
            'id',
            'name',
            'status',
            'redirect',
            'group',
            'create_by',
            'ct_time',
            'up_time',
        ]
        # excloud 排除字段
        # excloud = []
        # export_order（自定义） 导出顺序排序
        export_order = ['id','name','group','create_by']
        import_id_fields = ['name'] 

• admin.py

class DomainsModelAdmin(ImportExportModelAdmin, AjaxAdmin):
     # 对接资源类
    resource_class = DomainResource