Django-tablib 使用详解

1. 安装指南

首先，确保您的环境中已经安装了 Django。接下来，可以使用 pip 命令安装 django-tablib：

pip install django-tablib

安装完成后，需要在 Django 项目的 settings.py 文件中添加 'django_tablib' 到 INSTALLED_APPS 列表中。

INSTALLED_APPS = [
    # 其他应用...
    'django_tablib',
]

2. 项目的使用说明

django-tablib 允许开发者从 Django 模型生成 tablib 数据集。以下是几个基本用法的示例。

创建数据集

根据模型自动创建包含所有字段的数据集：

from django_tablib import ModelDataset
from myapp.models import MyModel

class MyModelDataset(ModelDataset):
    class Meta:
        model = MyModel

data = MyModelDataset()

创建仅包含指定字段的数据集：

class MyModelDataset(ModelDataset):
    class Meta:
        model = MyModel
        fields = ['id', 'myfield1']

创建排除某些字段的数据集：

class MyModelDataset(ModelDataset):
    class Meta:
        model = MyModel
        exclude = ['myfield2']

声明式地指定字段及其头部的数据集：

from django_tablib import ModelDataset, Field

class MyModelDataset(ModelDataset):
    myfield1 = Field(header='有趣的字段名')

    class Meta:
        model = MyModel

数据集操作

• 添加新行：

data.append(MyModel(**values))

• 添加新列：

data.append(col=['头部', '值1', '值2', ... '值n'])

• 删除行：

del data[1]

更多操作请参考 tablib 文档。

3. 项目API使用文档

django-tablib 提供了几个视图来支持数据的导出。

• django_tablib.views.export：导出模型数据到 Excel。

  在 urls.py 中添加：

  (r'^export/$', 'django_tablib.views.export', {
      'model': MyModel,
  })
  

• django_tablib.views.generic_export：支持多个模型的通用导出视图。

  在 urls.py 中添加：

  url(r'export/(?P<model_name>[^/]+)/$', "django_tablib.views.generic_export"),
  

  在 settings.py 中配置 TABLIB_MODELS：

  TABLIB_MODELS = {
      'myapp.simple': None,
      'myapp.related': {'simple__title': ('exact', 'iexact')},
  }
  

• django_tablib.admin.TablibAdmin：在 Django 管理界面中添加导出功能。

  from django.contrib import admin
  from django_tablib.admin import TablibAdmin
  from myapp.models import MyModel
  
  class MyModelAdmin(TablibAdmin):
      formats = ['xls', 'json', 'yaml', 'csv', 'html',]
  
  admin.site.register(MyModel, MyModelAdmin)
  

4. 项目安装方式

项目安装方式已在“安装指南”一节中详细说明。简要概括如下：

1. 使用 pip 安装 django-tablib；
2. 将 'django_tablib' 添加到 Django 项目的 INSTALLED_APPS 中。