def parse_sheet_views(self, element):
for el in element.findall("{%s}sheetView" % SHEET_MAIN_NS):
# according to the specification the last view wins
pass
self.ws.sheet_view = SheetView.from_tree(el)
def parse_sheet_views(self, element):
for el in element.findall("{%s}sheetView" % SHEET_MAIN_NS):
# according to the specification the last view wins
pass
self.ws.sheet_view = SheetView.from_tree(el)
def render(self, data, accepted_media_type=None, renderer_context=None):
"""
Render `data` into XLSX workbook, returning a workbook.
"""
if not self._check_validation_data(data):
return json.dumps(data)
if data is None:
return bytes()
wb = Workbook()
self.ws = wb.active
results = data["results"] if "results" in data else data
drf_view = renderer_context.get("view")
# Take header and column_header params from view
header = get_attribute(drf_view, "header", {})
use_header = header and header.get("use_header", True)
self.ws.title = header.get("tab_title", "Report")
header_title = header.get("header_title", "Report")
img_addr = header.get("img")
if img_addr:
img = Image(img_addr)
self.ws.add_image(img, "A1")
header_style = (XLSXStyle(header.get("style"))
if header and "style" in header else None)
column_header = get_attribute(drf_view, "column_header", {})
column_header_style = (XLSXStyle(column_header.get("style"))
if column_header and "style" in column_header
else None)
column_count = 0
row_count = 1
if use_header:
row_count += 1
# Make column headers
column_titles = column_header.get("titles", [])
# If we have results, then flatten field
# names
if len(results):
# Set `xlsx_use_labels = True` inside the API View to enable labels.
use_labels = getattr(drf_view, "xlsx_use_labels", False)
# A list of header keys to ignore in our export
self.ignore_headers = getattr(drf_view, "xlsx_ignore_headers", [])
# Create a mapping dict named `xlsx_boolean_labels` inside the API View.
# I.e.: xlsx_boolean_labels: {True: "Yes", False: "No"}
self.boolean_display = getattr(drf_view, "xlsx_boolean_labels",
None)
# Set dict named column_data_styles with headers as keys and style as value. i.e.
# column_data_styles = {
# 'distance': {
# 'fill': {'fill_type': 'solid', 'start_color': 'FFCCFFCC'},
# 'alignment': {'horizontal': 'center', 'vertical': 'center', 'wrapText': True, 'shrink_to_fit': True},
# 'border_side': {'border_style': 'thin', 'color': 'FF000000'},
# 'font': {'name': 'Arial', 'size': 14, 'bold': True, 'color': 'FF000000'},
# 'format': '0.00E+00'
# },
# }
self.column_data_styles = get_attribute(drf_view,
"column_data_styles",
dict())
# Set dict of additional columns. Can be useful when wanting to add columns
# that don't exist in the API response. For example, you could want to
# show values of a dict in individual cols. Takes key, an optional label
# and value than can be callable
# Example:
# {"Additional Col": { label: "Something (optional)", formatter: my_function }}
self.custom_cols = getattr(drf_view, "xlsx_custom_cols", dict())
# Map a specific key to a column (I.e. if the field returns a json) or pass
# a function to format the value
# Example with key:
# {"custom_choice": "display"}, showing 'display' in the
# 'custom_choice' col
# Example with function:
# {"custom_choice": custom_func }, passing the value of 'custom_choice' to
# 'custom_func', allowing for formatting logic
self.custom_mappings = getattr(drf_view, "xlsx_custom_mappings",
dict())
self.fields_dict = self._serializer_fields(
drf_view.get_serializer())
xlsx_header_dict = self._flatten_serializer_keys(
drf_view.get_serializer(), use_labels=use_labels)
if self.custom_cols:
custom_header_dict = {
key: self.custom_cols[key].get("label", None) or key
for key in self.custom_cols.keys()
}
self.combined_header_dict = dict(
list(xlsx_header_dict.items()) +
list(custom_header_dict.items()))
else:
self.combined_header_dict = xlsx_header_dict
for column_name, column_label in self.combined_header_dict.items():
if column_name == "row_color":
continue
column_count += 1
if column_count > len(column_titles):
column_name_display = column_label
else:
column_name_display = column_titles[column_count - 1]
header_cell = self.ws.cell(row=row_count,
column=column_count,
value=column_name_display)
set_cell_style(header_cell, column_header_style)
self.ws.row_dimensions[row_count].height = column_header.get(
"height", 45)
# Set the header row
if use_header:
last_col_letter = "G"
if column_count:
last_col_letter = get_column_letter(column_count)
self.ws.merge_cells("A1:{}1".format(last_col_letter))
cell = self.ws.cell(row=1, column=1, value=header_title)
set_cell_style(cell, header_style)
self.ws.row_dimensions[1].height = header.get("height", 45)
# Set column width
column_width = column_header.get("column_width", 20)
if isinstance(column_width, list):
for i, width in enumerate(column_width):
col_letter = get_column_letter(i + 1)
self.ws.column_dimensions[col_letter].width = width
else:
for ws_column in range(1, column_count + 1):
col_letter = get_column_letter(ws_column)
self.ws.column_dimensions[col_letter].width = column_width
# Make body
body = get_attribute(drf_view, "body", {})
self.body_style = (XLSXStyle(body.get("style"))
if body and "style" in body else None)
if isinstance(results, dict):
self._make_body(body, results, row_count)
elif isinstance(results, list):
for row in results:
self._make_body(body, row, row_count)
row_count += 1
# Set sheet view options
# Example:
# sheet_view_options = {
# 'rightToLeft': True,
# 'showGridLines': False
# }
self.sheet_view_options = get_attribute(drf_view, "sheet_view_options",
dict())
self.ws.views.sheetView[0] = SheetView(**self.sheet_view_options)
return save_virtual_workbook(wb)