1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
from django.core.exceptions import ImproperlyConfigured
from django.http import HttpResponse
try:
from tablib import Dataset
except ImportError: # pragma: no cover
raise ImproperlyConfigured(
"You must have tablib installed in order to use the django-tables2 export functionality"
)
class TableExport:
"""
Export data from a table to the file type specified.
Arguments:
export_format (str): one of `csv, json, latex, ods, tsv, xls, xlsx, yaml`
table (`~.Table`): instance of the table to export the data from
exclude_columns (iterable): list of column names to exclude from the export
dataset_kwargs (dictionary): passed as `**kwargs` to `tablib.Dataset` constructor
"""
CSV = "csv"
JSON = "json"
LATEX = "latex"
ODS = "ods"
TSV = "tsv"
XLS = "xls"
XLSX = "xlsx"
YAML = "yaml"
FORMATS = {
CSV: "text/csv; charset=utf-8",
JSON: "application/json",
LATEX: "text/plain",
ODS: "application/vnd.oasis.opendocument.spreadsheet",
TSV: "text/tsv; charset=utf-8",
XLS: "application/vnd.ms-excel",
XLSX: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
YAML: "text/yaml; charset=utf-8",
}
def __init__(self, export_format, table, exclude_columns=None, dataset_kwargs=None):
if not self.is_valid_format(export_format):
raise TypeError(f'Export format "{export_format}" is not supported.')
self.format = export_format
self.dataset = self.table_to_dataset(table, exclude_columns, dataset_kwargs)
def table_to_dataset(self, table, exclude_columns, dataset_kwargs=None):
"""Transform a table to a tablib dataset."""
def default_dataset_title():
try:
return table.Meta.model._meta.verbose_name_plural.title()
except AttributeError:
return "Export Data"
kwargs = {"title": default_dataset_title()}
kwargs.update(dataset_kwargs or {})
dataset = Dataset(**kwargs)
for i, row in enumerate(table.as_values(exclude_columns=exclude_columns)):
if i == 0:
dataset.headers = row
else:
dataset.append(row)
return dataset
@classmethod
def is_valid_format(self, export_format):
"""
Returns true if `export_format` is one of the supported export formats
"""
return export_format is not None and export_format in TableExport.FORMATS.keys()
def content_type(self):
"""
Returns the content type for the current export format
"""
return self.FORMATS[self.format]
def export(self):
"""
Returns the string/bytes for the current export format
"""
return self.dataset.export(self.format)
def response(self, filename=None):
"""
Builds and returns a `HttpResponse` containing the exported data
Arguments:
filename (str): if not `None`, the filename is attached to the
`Content-Disposition` header of the response.
"""
response = HttpResponse(content_type=self.content_type())
if filename is not None:
response["Content-Disposition"] = f'attachment; filename="{filename}"'
response.write(self.export())
return response
|
