From 4f4b376ed4f8f43d0b5dced86c8fb6b905112f11 Mon Sep 17 00:00:00 2001
From: YangZhang-GitHub <2533471770@qq.com>
Date: Tue, 27 Apr 2021 17:30:13 +0800
Subject: [PATCH] Implemented the SpaceEfficiency Excel Exporter

---
 myems-api/excelexporters/spaceefficiency.py | 607 ++++++++++++++++++++
 1 file changed, 607 insertions(+)
 create mode 100644 myems-api/excelexporters/spaceefficiency.py

diff --git a/myems-api/excelexporters/spaceefficiency.py b/myems-api/excelexporters/spaceefficiency.py
new file mode 100644
index 00000000..85e5e9a9
--- /dev/null
+++ b/myems-api/excelexporters/spaceefficiency.py
@@ -0,0 +1,607 @@
+import base64
+import uuid
+import os
+from openpyxl.chart import (
+    PieChart,
+    LineChart,
+    BarChart,
+    Reference,
+)
+from openpyxl.styles import PatternFill, Border, Side, Alignment, Font
+from openpyxl.drawing.image import Image
+from openpyxl import Workbook
+from openpyxl.chart.label import DataLabelList
+import openpyxl.utils.cell as format_cell
+
+
+####################################################################################################################
+# PROCEDURES
+# Step 1: Validate the report data
+# Step 2: Generate excel file
+# Step 3: Encode the excel file bytes to Base64
+####################################################################################################################
+
+
+def export(report,
+           name,
+           reporting_start_datetime_local,
+           reporting_end_datetime_local,
+           period_type):
+    ####################################################################################################################
+    # Step 1: Validate the report data
+    ####################################################################################################################
+    if report is None:
+        return None
+    print(report)
+
+    ####################################################################################################################
+    # Step 2: Generate excel file from the report data
+    ####################################################################################################################
+    filename = generate_excel(report,
+                              name,
+                              reporting_start_datetime_local,
+                              reporting_end_datetime_local,
+                              period_type)
+    ####################################################################################################################
+    # Step 3: Encode the excel file to Base64
+    ####################################################################################################################
+    try:
+        with open(filename, 'rb') as binary_file:
+            binary_file_data = binary_file.read()
+    except IOError as ex:
+        pass
+
+    # Base64 encode the bytes
+    base64_encoded_data = base64.b64encode(binary_file_data)
+    # get the Base64 encoded data using human-readable characters.
+    base64_message = base64_encoded_data.decode('utf-8')
+    # delete the file from server
+    try:
+        os.remove(filename)
+    except NotImplementedError as ex:
+        pass
+    return base64_message
+
+
+def generate_excel(report,
+                   name,
+                   reporting_start_datetime_local,
+                   reporting_end_datetime_local,
+                   period_type):
+    wb = Workbook()
+    ws = wb.active
+
+    # Row height
+    ws.row_dimensions[1].height = 102
+    for i in range(2, 2000 + 1):
+        ws.row_dimensions[i].height = 42
+
+    # Col width
+    ws.column_dimensions['A'].width = 1.5
+
+    ws.column_dimensions['B'].width = 25.0
+
+    for i in range(ord('C'), ord('L')):
+        ws.column_dimensions[chr(i)].width = 15.0
+
+    # Font
+    name_font = Font(name='Constantia', size=15, bold=True)
+    title_font = Font(name='宋体', size=15, bold=True)
+    data_font = Font(name='Franklin Gothic Book', size=11)
+
+    table_fill = PatternFill(fill_type='solid', fgColor='1F497D')
+    f_border = Border(left=Side(border_style='medium', color='00000000'),
+                      right=Side(border_style='medium', color='00000000'),
+                      bottom=Side(border_style='medium', color='00000000'),
+                      top=Side(border_style='medium', color='00000000')
+                      )
+    b_border = Border(
+        bottom=Side(border_style='medium', color='00000000'),
+    )
+
+    b_c_alignment = Alignment(vertical='bottom',
+                              horizontal='center',
+                              text_rotation=0,
+                              wrap_text=True,
+                              shrink_to_fit=False,
+                              indent=0)
+    c_c_alignment = Alignment(vertical='center',
+                              horizontal='center',
+                              text_rotation=0,
+                              wrap_text=True,
+                              shrink_to_fit=False,
+                              indent=0)
+    b_r_alignment = Alignment(vertical='bottom',
+                              horizontal='right',
+                              text_rotation=0,
+                              wrap_text=True,
+                              shrink_to_fit=False,
+                              indent=0)
+    c_r_alignment = Alignment(vertical='bottom',
+                              horizontal='center',
+                              text_rotation=0,
+                              wrap_text=True,
+                              shrink_to_fit=False,
+                              indent=0)
+    # Img
+    img = Image("excelexporters/myems.png")
+    img.width = img.width * 0.85
+    img.height = img.height * 0.85
+    # img = Image("myems.png")
+    ws.add_image(img, 'B1')
+
+    # Title
+    ws.row_dimensions[3].height = 60
+
+    ws['B3'].font = name_font
+    ws['B3'].alignment = b_r_alignment
+    ws['B3'] = 'Name:'
+    ws['C3'].border = b_border
+    ws['C3'].alignment = b_c_alignment
+    ws['C3'].font = name_font
+    ws['C3'] = name
+
+    ws['D3'].font = name_font
+    ws['D3'].alignment = b_r_alignment
+    ws['D3'] = 'Period:'
+    ws['E3'].border = b_border
+    ws['E3'].alignment = b_c_alignment
+    ws['E3'].font = name_font
+    ws['E3'] = period_type
+
+    ws['F3'].font = name_font
+    ws['F3'].alignment = b_r_alignment
+    ws['F3'] = 'Date:'
+    ws['G3'].border = b_border
+    ws['G3'].alignment = b_c_alignment
+    ws['G3'].font = name_font
+    ws['G3'] = reporting_start_datetime_local + "__" + reporting_end_datetime_local
+    ws.merge_cells("G3:H3")
+
+    if "reporting_period_efficiency" not in report.keys() or \
+            "names" not in report['reporting_period_efficiency'].keys() or len(
+            report['reporting_period_efficiency']['names']) == 0:
+        filename = str(uuid.uuid4()) + '.xlsx'
+        wb.save(filename)
+
+        return filename
+
+    ##################################
+
+    current_row_number = 6
+
+    reporting_period_data = report['reporting_period_efficiency']
+
+    has_names_data_flag = True
+
+    if "names" not in reporting_period_data.keys() or \
+            reporting_period_data['names'] is None or \
+            len(reporting_period_data['names']) == 0:
+        has_names_data_flag = False
+
+    if has_names_data_flag:
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)] = name + ' 报告期累积效率'
+
+        current_row_number += 1
+
+        category = reporting_period_data['names']
+        ca_len = len(category)
+
+        ws.row_dimensions[current_row_number].height = 80
+        ws['B' + str(current_row_number)].fill = table_fill
+        ws['B' + str(current_row_number)].border = f_border
+
+        col = 'C'
+
+        for i in range(0, ca_len):
+            ws[col + str(current_row_number)].fill = table_fill
+            ws[col + str(current_row_number)].font = name_font
+            ws[col + str(current_row_number)].alignment = c_c_alignment
+            ws[col + str(current_row_number)].border = f_border
+            ws[col + str(current_row_number)] = \
+                reporting_period_data['names'][i] + " (" + reporting_period_data['units'][i] + ")"
+
+            col = chr(ord(col) + 1)
+
+        current_row_number += 1
+
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)].alignment = c_c_alignment
+        ws['B' + str(current_row_number)].border = f_border
+        ws['B' + str(current_row_number)] = '累积效率'
+
+        col = 'C'
+
+        for i in range(0, ca_len):
+            ws[col + str(current_row_number)].font = name_font
+            ws[col + str(current_row_number)].alignment = c_c_alignment
+            ws[col + str(current_row_number)].border = f_border
+            ws[col + str(current_row_number)] = round(reporting_period_data['cumulations'][i], 2) \
+                if reporting_period_data['cumulations'][i] is not None else 0
+
+            col = chr(ord(col) + 1)
+
+        current_row_number += 1
+
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)].alignment = c_c_alignment
+        ws['B' + str(current_row_number)].border = f_border
+        ws['B' + str(current_row_number)] = '环比'
+
+        col = 'C'
+
+        for i in range(0, ca_len):
+            ws[col + str(current_row_number)].font = name_font
+            ws[col + str(current_row_number)].alignment = c_c_alignment
+            ws[col + str(current_row_number)].border = f_border
+            ws[col + str(current_row_number)] = str(
+                round(reporting_period_data['increment_rates'][i] * 100, 2)) + '%' \
+                if reporting_period_data['increment_rates'][i] is not None else '-'
+
+            col = chr(ord(col) + 1)
+
+        current_row_number += 2
+
+    #####################################
+
+    has_parameters_names_and_timestamps_and_values_data = True
+    current_sheet_parameters_row_number = current_row_number
+
+    if 'parameters' not in report.keys() or \
+            report['parameters'] is None or \
+            'names' not in report['parameters'].keys() or \
+            report['parameters']['names'] is None or \
+            len(report['parameters']['names']) == 0 or \
+            'timestamps' not in report['parameters'].keys() or \
+            report['parameters']['timestamps'] is None or \
+            len(report['parameters']['timestamps']) == 0 or \
+            'values' not in report['parameters'].keys() or \
+            report['parameters']['values'] is None or \
+            len(report['parameters']['values']) == 0 or \
+            timestamps_data_all_equal_0(report['parameters']['timestamps']):
+
+        has_parameters_names_and_timestamps_and_values_data = False
+
+    #####################################
+
+    has_values_data = True
+    has_timestamps_data = True
+
+    if 'values' not in reporting_period_data.keys() or \
+            reporting_period_data['values'] is None or \
+            len(reporting_period_data['values']) == 0:
+        has_values_data = False
+
+    if 'timestamps' not in reporting_period_data.keys() or \
+            reporting_period_data['timestamps'] is None or \
+            len(reporting_period_data['timestamps']) == 0 or \
+            len(reporting_period_data['timestamps'][0]) == 0:
+        has_timestamps_data = False
+
+    if has_values_data and has_timestamps_data:
+        ca_len = len(reporting_period_data['names'])
+        time = reporting_period_data['timestamps'][0]
+
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)] = name + ' 报告期累积效率'
+
+        current_row_number += 1
+
+        chart_start_row_number = current_row_number
+
+        current_row_number += ca_len * 6 + 1
+
+        if has_parameters_names_and_timestamps_and_values_data:
+            current_sheet_parameters_row_number = current_row_number
+            real_timestamps_len = timestamps_data_not_equal_0(report['parameters']['timestamps'])
+            current_row_number += 6*real_timestamps_len + 2
+
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)] = name + ' 详细数据'
+
+        current_row_number += 1
+
+        table_start_row_number = current_row_number
+
+        ws.row_dimensions[current_row_number].height = 85
+        ws['B' + str(current_row_number)].fill = table_fill
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)].alignment = c_c_alignment
+        ws['B' + str(current_row_number)].border = f_border
+        ws['B' + str(current_row_number)] = '日期时间'
+
+        col = 'C'
+
+        for i in range(0, ca_len):
+            ws[col + str(current_row_number)].fill = table_fill
+            ws[col + str(current_row_number)].font = title_font
+            ws[col + str(current_row_number)].alignment = c_c_alignment
+            ws[col + str(current_row_number)].border = f_border
+            ws[col + str(current_row_number)] = \
+                reporting_period_data['names'][i] + " (" + reporting_period_data['units'][i] + ")"
+            col = chr(ord(col) + 1)
+
+        current_row_number += 1
+
+        for i in range(0, len(time)):
+            ws['B' + str(current_row_number)].font = title_font
+            ws['B' + str(current_row_number)].alignment = c_c_alignment
+            ws['B' + str(current_row_number)].border = f_border
+            ws['B' + str(current_row_number)] = time[i]
+
+            col = 'C'
+            for j in range(0, ca_len):
+                ws[col + str(current_row_number)].font = title_font
+                ws[col + str(current_row_number)].alignment = c_c_alignment
+                ws[col + str(current_row_number)].border = f_border
+                ws[col + str(current_row_number)] = round(reporting_period_data['values'][j][i], 2) \
+                    if reporting_period_data['values'][j][i] is not None else 0.00
+                col = chr(ord(col) + 1)
+
+            current_row_number += 1
+
+        table_end_row_number = current_row_number - 1
+
+        ws['B' + str(current_row_number)].font = title_font
+        ws['B' + str(current_row_number)].alignment = c_c_alignment
+        ws['B' + str(current_row_number)].border = f_border
+        ws['B' + str(current_row_number)] = '小计'
+
+        col = 'C'
+
+        for i in range(0, ca_len):
+            ws[col + str(current_row_number)].font = title_font
+            ws[col + str(current_row_number)].alignment = c_c_alignment
+            ws[col + str(current_row_number)].border = f_border
+            ws[col + str(current_row_number)] = round(reporting_period_data['cumulations'][i], 2) \
+                if reporting_period_data['cumulations'][i] is not None else 0.00
+            col = chr(ord(col) + 1)
+
+        current_row_number += 2
+
+        format_time_width_number = 1.0
+        min_len_number = 1.0
+        min_width_number = 11.0  # format_time_width_number * min_len_number + 4 and min_width_number > 11.0
+
+        if period_type == 'hourly':
+            format_time_width_number = 4.0
+            min_len_number = 2
+            min_width_number = 12.0
+        elif period_type == 'daily':
+            format_time_width_number = 2.5
+            min_len_number = 4
+            min_width_number = 14.0
+        elif period_type == 'monthly':
+            format_time_width_number = 2.1
+            min_len_number = 4
+            min_width_number = 12.4
+        elif period_type == 'yearly':
+            format_time_width_number = 1.5
+            min_len_number = 5
+            min_width_number = 11.5
+
+        for i in range(0, ca_len):
+            line = LineChart()
+            line.title = '报告期累积效率 - ' + \
+                         reporting_period_data['names'][i] + " (" + reporting_period_data['units'][i] + ")"
+            labels = Reference(ws, min_col=2, min_row=table_start_row_number + 1, max_row=table_end_row_number)
+            line_data = Reference(ws, min_col=3 + i, min_row=table_start_row_number, max_row=table_end_row_number)
+            line.add_data(line_data, titles_from_data=True)
+            line.set_categories(labels)
+            line_data = line.series[0]
+            line_data.marker.symbol = "circle"
+            line_data.smooth = True
+            line.x_axis.crosses = 'min'
+            line.height = 8.25
+            line.width = format_time_width_number * len(time) if len(time) > min_len_number else min_width_number
+            if line.width > 24:
+                line.width = 24
+            line.dLbls = DataLabelList()
+            line.dLbls.dLblPos = 't'
+            line.dLbls.showVal = True
+            line.dLbls.showPercent = False
+            chart_col = 'B'
+            chart_cell = chart_col + str(chart_start_row_number)
+            chart_start_row_number += 6
+            ws.add_chart(line, chart_cell)
+
+    #####################################################################
+
+    if has_parameters_names_and_timestamps_and_values_data:
+
+        ###############################
+        # new worksheet
+        ###############################
+
+        parameters_data = report['parameters']
+        parameters_names_len = len(parameters_data['names'])
+
+        parameters_ws = wb.create_sheet('相关参数')
+
+        parameters_timestamps_data_max_len = \
+            get_parameters_timestamps_lists_max_len(list(parameters_data['timestamps']))
+
+        # Row height
+        parameters_ws.row_dimensions[1].height = 102
+        for i in range(2, 7 + 1):
+            parameters_ws.row_dimensions[i].height = 42
+
+        for i in range(8, parameters_timestamps_data_max_len + 10):
+            parameters_ws.row_dimensions[i].height = 60
+
+        # Col width
+        parameters_ws.column_dimensions['A'].width = 1.5
+
+        parameters_ws.column_dimensions['B'].width = 25.0
+
+        for i in range(3, 12+parameters_names_len*3):
+            parameters_ws.column_dimensions[format_cell.get_column_letter(i)].width = 15.0
+
+        # Img
+        img = Image("excelexporters/myems.png")
+        img.width = img.width * 0.85
+        img.height = img.height * 0.85
+        # img = Image("myems.png")
+        parameters_ws.add_image(img, 'B1')
+
+        # Title
+        parameters_ws.row_dimensions[3].height = 60
+
+        parameters_ws['B3'].font = name_font
+        parameters_ws['B3'].alignment = b_r_alignment
+        parameters_ws['B3'] = 'Name:'
+        parameters_ws['C3'].border = b_border
+        parameters_ws['C3'].alignment = b_c_alignment
+        parameters_ws['C3'].font = name_font
+        parameters_ws['C3'] = name
+
+        parameters_ws['D3'].font = name_font
+        parameters_ws['D3'].alignment = b_r_alignment
+        parameters_ws['D3'] = 'Period:'
+        parameters_ws['E3'].border = b_border
+        parameters_ws['E3'].alignment = b_c_alignment
+        parameters_ws['E3'].font = name_font
+        parameters_ws['E3'] = period_type
+
+        parameters_ws['F3'].font = name_font
+        parameters_ws['F3'].alignment = b_r_alignment
+        parameters_ws['F3'] = 'Date:'
+        parameters_ws['G3'].border = b_border
+        parameters_ws['G3'].alignment = b_c_alignment
+        parameters_ws['G3'].font = name_font
+        parameters_ws['G3'] = reporting_start_datetime_local + "__" + reporting_end_datetime_local
+        parameters_ws.merge_cells("G3:H3")
+
+        parameters_ws_current_row_number = 6
+
+        parameters_ws['B' + str(parameters_ws_current_row_number)].font = title_font
+        parameters_ws['B' + str(parameters_ws_current_row_number)] = name + ' 相关参数'
+
+        parameters_ws_current_row_number += 1
+
+        parameters_table_start_row_number = parameters_ws_current_row_number
+
+        parameters_ws.row_dimensions[parameters_ws_current_row_number].height = 80
+
+        parameters_ws_current_row_number += 1
+
+        table_current_col_number = 2
+
+        for i in range(0, parameters_names_len):
+
+            if len(parameters_data['timestamps'][i]) == 0:
+                continue
+
+            col = format_cell.get_column_letter(table_current_col_number)
+
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].fill = table_fill
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].border = f_border
+
+            col = format_cell.get_column_letter(table_current_col_number + 1)
+
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].fill = table_fill
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].border = f_border
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].font = name_font
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)].alignment = c_c_alignment
+            parameters_ws[col + str(parameters_ws_current_row_number - 1)] = parameters_data['names'][i]
+
+            table_current_row_number = parameters_ws_current_row_number
+
+            for j, value in enumerate(list(parameters_data['timestamps'][i])):
+                col = format_cell.get_column_letter(table_current_col_number)
+
+                parameters_ws[col + str(table_current_row_number)].border = f_border
+                parameters_ws[col + str(table_current_row_number)].font = title_font
+                parameters_ws[col + str(table_current_row_number)].alignment = c_c_alignment
+                parameters_ws[col + str(table_current_row_number)] = value
+
+                col = format_cell.get_column_letter(table_current_col_number + 1)
+
+                parameters_ws[col + str(table_current_row_number)].border = f_border
+                parameters_ws[col + str(table_current_row_number)].font = title_font
+                parameters_ws[col + str(table_current_row_number)].alignment = c_c_alignment
+                parameters_ws[col + str(table_current_row_number)] = round(parameters_data['values'][i][j], 2)
+
+                table_current_row_number += 1
+
+            table_current_col_number = table_current_col_number + 3
+
+        ########################################################
+        # parameters chart and parameters table
+        ########################################################
+
+        ws['B' + str(current_sheet_parameters_row_number)].font = title_font
+        ws['B' + str(current_sheet_parameters_row_number)] = name + ' 相关参数'
+
+        current_sheet_parameters_row_number += 1
+
+        chart_start_row_number = current_sheet_parameters_row_number
+
+        col_index = 0
+
+        for i in range(0, parameters_names_len):
+
+            if len(parameters_data['timestamps'][i]) == 0:
+                continue
+
+            line = LineChart()
+            data_col = 3+col_index*3
+            labels_col = 2+col_index*3
+            col_index += 1
+            line.title = '相关参数 - ' + \
+                         parameters_ws.cell(row=parameters_table_start_row_number, column=data_col).value
+            labels = Reference(parameters_ws, min_col=labels_col, min_row=parameters_table_start_row_number + 1,
+                               max_row=(len(parameters_data['timestamps'][i])+parameters_table_start_row_number))
+            line_data = Reference(parameters_ws, min_col=data_col, min_row=parameters_table_start_row_number,
+                                  max_row=(len(parameters_data['timestamps'][i])+parameters_table_start_row_number))
+            line.add_data(line_data, titles_from_data=True)
+            line.set_categories(labels)
+            line_data = line.series[0]
+            line_data.marker.symbol = "circle"
+            line_data.smooth = True
+            line.x_axis.crosses = 'min'
+            line.height = 8.25
+            line.width = 24
+            line.dLbls = DataLabelList()
+            line.dLbls.dLblPos = 't'
+            line.dLbls.showVal = False
+            line.dLbls.showPercent = False
+            chart_col = 'B'
+            chart_cell = chart_col + str(chart_start_row_number)
+            chart_start_row_number += 6
+            ws.add_chart(line, chart_cell)
+
+        current_sheet_parameters_row_number = chart_start_row_number
+
+        current_sheet_parameters_row_number += 1
+
+    filename = str(uuid.uuid4()) + '.xlsx'
+    wb.save(filename)
+
+    return filename
+
+
+def get_parameters_timestamps_lists_max_len(parameters_timestamps_lists):
+    max_len = 0
+    for i, value in enumerate(list(parameters_timestamps_lists)):
+        if len(value) > max_len:
+            max_len = len(value)
+
+    return max_len
+
+
+def timestamps_data_all_equal_0(lists):
+    for i, value in enumerate(list(lists)):
+        if len(value) > 0:
+            return False
+
+    return True
+
+
+def timestamps_data_not_equal_0(lists):
+    number = 0
+    for i, value in enumerate(list(lists)):
+        if len(value) > 0:
+            number += 1
+    return number