Django Admin中增長導出CSV功能

參考: https://books.agiliq.com/projects/django-admin-cookbook/en/latest/export.html

在使用Django Admin時, 對於列表咱們有時須要提供數據導出功能, 以下圖:

在Django Admin中每一個模型的Admin類(繼承至admin.ModelAdmin), 咱們能夠經過actions增長支持的動做, 值爲當前類存在的方法名, 例如:

.......
@admin.register(Issue)
class IssueAdmin(admin.ModelAdmin):
    ......
    actions = ['export_as_csv']  # 增長動做, 對應相應的方法名
    def export_as_csv(self, request, queryset):  # 具體的導出csv方法的實現
        pass
    
    export_as_csv.short_description = '導出CSV'  # 該動做在admin中的顯示文字

導出CSV方法詳細實現以下:

def export_as_csv(self, request, queryset):
        meta = self.model._meta  # 用於肯定導出的文件名, 格式爲: app名.模型類名
        field_names = [field.name for field in meta.fields]  # 全部屬性名

        response = HttpResponse(content_type='text/csv')   # 指定響應內容類型
        response['Content-Disposition'] = f'attachment; filename={meta}.csv'
        response.charset = 'utf-8-sig'  # 可選, 修改編碼爲帶BOM的utf-8格式(Excel打開不會有亂碼)
        writer = csv.writer(response)
        writer.writerow(field_names)  # 將屬性名寫入csv
        for obj in queryset:  # 遍歷要導出的對象列表
            row = writer.writerow([getattr(obj, field) for field in field_names])  # 將當前對象的各屬性值寫入csv
        return response

因爲導出CSV動做能夠做爲各個模型的通用動做, 咱們能夠封裝成一個Mixin類使用, 完整代碼以下:

import csv
from django.contrib import admin
from django.http import HttpResponse
from .models import  Issue

class ExportCsvMixin(object):
    def export_as_csv(self, request, queryset):
        meta = self.model._meta
        field_names = [field.name for field in meta.fields]

        response = HttpResponse(content_type='text/csv')
        response['Content-Disposition'] = f'attachment; filename={meta}.csv'
        response.charset = 'utf-8-sig'
        writer = csv.writer(response)
        writer.writerow(field_names)
        for obj in queryset:
            row = writer.writerow([getattr(obj, field) for field in field_names])

        return response

    export_as_csv.short_description = '導出CSV'

@admin.register(Issue)
class IssueAdmin(admin.ModelAdmin, ExportCsvMixin):
    fields = ('key', 'summary', 'status', 'project',
              'origin', 'components', 'prj_level', 'prj_category',
              'assignee', 'origin_person', 'pm', 'dev_manager', 'test_manager', 'tester', 'fe_dev', 'backend_dev',
              'plan_begin', 'plan_end', 'fe_plan_begin', 'fe_plan_end', 'test_plan_begin',
              'test_plan_end', 'backend_plan_begin', 'backend_plan_end',
              'created', 'reopen', 'prd_begin', 'prd_end', 'dev_begin', 'dev_end',
              'test_begin', 'test_end', 'pm_check', 'ready', 'pause', 'done',
              'pm_take', 'dev_take', 'test_take', 'total_take',
              'tags',
              )
    readonly_fields = fields
    list_display = ('key', 'summary', 'status', 'origin', 'components', 'created', 'visit')
    list_filter = ('origin', 'components', 'status', 'tags')
    search_fields = ('key', 'summary')
    date_hierarchy = 'created'
    actions = ['export_as_csv']