Implemented the combinedequipmentload Excel Exporter

myems-api/excelexporters/combinedequipmentload.py

@@ -0,0 +1,368 @@
+import base64
+import uuid
+import os
+from openpyxl.chart import (
+    LineChart,
+    Reference,
+)
+from openpyxl.chart.label import DataLabelList
+from openpyxl.styles import PatternFill, Border, Side, Alignment, Font
+from openpyxl.drawing.image import Image
+from openpyxl import Workbook
+
+
+####################################################################################################################
+# 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
+
+    ####################################################################################################################
+    # 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=False,
+                              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=False,
+                              shrink_to_fit=False,
+                              indent=0)
+    # c_r_alignment = Alignment(vertical='bottom',
+    #                           horizontal='center',
+    #                           text_rotation=0,
+    #                           wrap_text=False,
+    #                           shrink_to_fit=False,
+    #                           indent=0)
+
+    # Img
+    img = Image("excelexporters/myems.png")
+    # img = Image("myems.png")
+    img.width = img.width * 0.85
+    img.height = img.height * 0.85
+    ws.add_image(img, 'B1')
+
+    # Title
+    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" not in report.keys() or \
+            "names" not in report['reporting_period'].keys() or len(report['reporting_period']['names']) == 0:
+        filename = str(uuid.uuid4()) + '.xlsx'
+        wb.save(filename)
+
+        return filename
+    #################################################
+    # First: 统计分析
+    # 6: title
+    # 7: table title
+    # 8~2*ca_len table_data
+    #################################################
+    reporting_period_data = report['reporting_period']
+
+    has_energy_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_energy_data_flag = False
+
+        filename = str(uuid.uuid4()) + '.xlsx'
+        wb.save(filename)
+
+        return filename
+
+    if has_energy_data_flag:
+        ws['B6'].font = title_font
+        ws['B6'] = name + ' 统计分析'
+
+        category = reporting_period_data['names']
+
+        # table_title
+        ws['B7'].fill = table_fill
+        ws['B7'].font = title_font
+        ws['B7'].alignment = c_c_alignment
+        ws['B7'] = '报告期'
+        ws['B7'].border = f_border
+
+        ws['C7'].font = title_font
+        ws['C7'].alignment = c_c_alignment
+        ws['C7'] = '平均负荷'
+        ws['C7'].border = f_border
+
+        ws['D7'].font = title_font
+        ws['D7'].alignment = c_c_alignment
+        ws['D7'] = '最大负荷'
+        ws['D7'].border = f_border
+
+        ws['E7'].font = title_font
+        ws['E7'].alignment = c_c_alignment
+        ws['E7'] = '负荷系数'
+        ws['E7'].border = f_border
+
+        # table_data
+
+        for i, value in enumerate(category):
+            row = i * 2 + 8
+            ws['B' + str(row)].font = name_font
+            ws['B' + str(row)].alignment = c_c_alignment
+            ws['B' + str(row)] = reporting_period_data['names'][i] + " (" + reporting_period_data['units'][i] + "/H )"
+            ws['B' + str(row)].border = f_border
+
+            ws['B' + str(row + 1)].font = name_font
+            ws['B' + str(row + 1)].alignment = c_c_alignment
+            ws['B' + str(row + 1)] = "环比"
+            ws['B' + str(row + 1)].border = f_border
+
+            ws['C' + str(row)].font = name_font
+            ws['C' + str(row)].alignment = c_c_alignment
+            ws['C' + str(row)] = round(reporting_period_data['averages'][i], 2) \
+                if reporting_period_data['averages'][i] is not None else ''
+            ws['C' + str(row)].border = f_border
+            ws['C' + str(row)].number_format = '0.00'
+
+            ws['C' + str(row + 1)].font = name_font
+            ws['C' + str(row + 1)].alignment = c_c_alignment
+            ws['C' + str(row + 1)] = str(round(reporting_period_data['averages_increment_rate'][i] * 100, 2)) + "%" \
+                if reporting_period_data['averages_increment_rate'][i] is not None else '0.00%'
+            ws['C' + str(row + 1)].border = f_border
+
+            ws['D' + str(row)].font = name_font
+            ws['D' + str(row)].alignment = c_c_alignment
+            ws['D' + str(row)] = round(reporting_period_data['maximums'][i], 2) \
+                if reporting_period_data['maximums'][i] is not None else ''
+            ws['D' + str(row)].border = f_border
+            ws['D' + str(row)].number_format = '0.00'
+
+            ws['D' + str(row + 1)].font = name_font
+            ws['D' + str(row + 1)].alignment = c_c_alignment
+            ws['D' + str(row + 1)] = str(round(reporting_period_data['maximums_increment_rate'][i] * 100, 2)) + "%" \
+                if reporting_period_data['maximums_increment_rate'][i] is not None else '0.00%'
+            ws['D' + str(row + 1)].border = f_border
+
+            ws['E' + str(row)].font = name_font
+            ws['E' + str(row)].alignment = c_c_alignment
+            ws['E' + str(row)] = round(reporting_period_data['factors'][i], 2) \
+                if reporting_period_data['factors'][i] is not None else ''
+            ws['E' + str(row)].border = f_border
+            ws['E' + str(row)].number_format = '0.00'
+
+            ws['E' + str(row + 1)].font = name_font
+            ws['E' + str(row + 1)].alignment = c_c_alignment
+            ws['E' + str(row + 1)] = str(round(reporting_period_data['factors_increment_rate'][i] * 100, 2)) + "%" \
+                if reporting_period_data['factors_increment_rate'][i] is not None else '0.00%'
+            ws['E' + str(row + 1)].border = f_border
+
+    ########################################################
+    # Third: 详细数据
+    # row_sat~ row_sat + 6*cal_len: line
+    # row_da: table title
+    # row_da + 1~: table_data
+    ########################################################
+    has_timestamps_flag = True
+    if "timestamps" not in reporting_period_data.keys() or \
+            reporting_period_data['timestamps'] is None or \
+            len(reporting_period_data['timestamps']) == 0:
+        has_timestamps_flag = False
+
+    if has_timestamps_flag:
+        timestamps = reporting_period_data['timestamps'][0]
+        names = reporting_period_data['names']
+        ca_len = len(names)
+        time_len = len(timestamps)
+        # row_lines == the number of rows of lines
+        row_lines = 6 * ca_len
+        # row_sat == the number of rows of statistical analysis table
+        row_sat = 9 + 2 * ca_len
+        # row_da == the number of rows of Detailed data
+        row_da = row_sat + row_lines + 1
+
+        ws['B' + str(row_da)].font = title_font
+        ws['B' + str(row_da)] = name + ' 详细数据'
+        # table_title
+        ws['B' + str(row_da + 1)].fill = table_fill
+        ws['B' + str(row_da + 1)].font = name_font
+        ws['B' + str(row_da + 1)].alignment = c_c_alignment
+        ws['B' + str(row_da + 1)] = "日期时间"
+        ws['B' + str(row_da + 1)].border = f_border
+
+        for i in range(0, ca_len):
+            col_average = chr(ord('C') + i)
+            col_maximum = chr(ord('C') + i + ca_len)
+
+            ws[col_average + str(row_da + 1)].font = name_font
+            ws[col_average + str(row_da + 1)].alignment = c_c_alignment
+            ws[col_average + str(row_da + 1)] = names[i] + " 平均负荷(" + reporting_period_data['units'][
+                i] + "/H)"
+            ws[col_average + str(row_da + 1)].border = f_border
+
+            ws[col_maximum + str(row_da + 1)].font = name_font
+            ws[col_maximum + str(row_da + 1)].alignment = c_c_alignment
+            ws[col_maximum + str(row_da + 1)] = names[i] + " 最大负荷(" + reporting_period_data['units'][
+                i] + "/H)"
+            ws[col_maximum + str(row_da + 1)].border = f_border
+        # table_date
+        for i in range(0, time_len):
+            rows = i + row_da + 2
+
+            ws['B' + str(rows)].font = name_font
+            ws['B' + str(rows)].alignment = c_c_alignment
+            ws['B' + str(rows)] = timestamps[i]
+            ws['B' + str(rows)].border = f_border
+
+            for index in range(0, ca_len):
+                col_average = chr(ord('C') + index)
+                col_maximum = chr(ord(col_average) + ca_len )
+
+                ws[col_average + str(rows)].font = name_font
+                ws[col_average + str(rows)].alignment = c_c_alignment
+                ws[col_average + str(rows)] = reporting_period_data['sub_averages'][index][i] \
+                    if reporting_period_data['sub_maximums'][index] is not None else ''
+                ws[col_average + str(rows)].number_format = '0.00'
+                ws[col_average + str(rows)].border = f_border
+
+                ws[col_maximum + str(rows)].font = name_font
+                ws[col_maximum + str(rows)].alignment = c_c_alignment
+                ws[col_maximum + str(rows)] = reporting_period_data['sub_maximums'][index][i] \
+                    if reporting_period_data['sub_maximums'][index] is not None else ''
+                ws[col_maximum + str(rows)].number_format = '0.00'
+                ws[col_maximum + str(rows)].border = f_border
+
+        # LineChart
+        for i in range(0, ca_len):
+            lc = LineChart()
+            lc.title = "报告期 最大负荷"
+            lc.style = 10
+            lc.x_axis.majorTickMark = 'in'
+            lc.y_axis.majorTickMark = 'in'
+            lc.smooth = True
+            lc.x_axis.crosses = 'min'
+            lc.height = 8.25
+            lc.width = 24
+            lc.dLbls = DataLabelList()
+            lc.dLbls.dLblPos = 't'
+            lc.dLbls.showVal = True
+            times = Reference(ws, min_col=2, min_row=row_da + 2,
+                              max_row=row_da + 2 + time_len)
+            lc_data = Reference(ws, min_col=3 + ca_len + i, min_row=row_da + 1,
+                                max_row=row_da + 1 + time_len)
+            lc.add_data(lc_data, titles_from_data=True)
+            lc.set_categories(times)
+            ser = lc.series[0]
+            ser.marker.symbol = "diamond"
+            ser.marker.size = 5
+            chart_col = 'B'
+            chart_cell = str(row_sat + 6 * i)
+            ws.add_chart(lc, chart_col + chart_cell)
+
+    filename = str(uuid.uuid4()) + '.xlsx'
+    wb.save(filename)
+
+    return filename

myems-api/excelexporters/shopfloorload.py

@@ -327,9 +327,9 @@ def generate_excel(report,
 
     ########################################################
     # Third: 详细数据
-    # row_sat+row_title~ row_sat+row_title+time_len: line
+    # row_sat~ row_sat + 6*cal_len: line
-    # row_sat+1+row_title: table title
+    # row_da: table title
-    # i + row_sat + 2 + 6 * ca_len~: table_data
+    # row_da + 1~: table_data
     ########################################################
     has_timestamps_flag = True
     if "timestamps" not in reporting_period_data.keys() or \
@@ -342,38 +342,40 @@ def generate_excel(report,
         names = reporting_period_data['names']
         ca_len = len(names)
         time_len = len(timestamps)
-        # title
+        # row_lines == the number of rows of lines
-        row_title = 6 * ca_len
+        row_lines = 6 * ca_len
-        # row_st == row_statistical analysis table
+        # row_sat == the number of rows of statistical analysis table
-        row_sat = 12 + 3 * ca_len
+        row_sat = 9 + 2 * ca_len
+        # row_da == the number of rows of Detailed data
+        row_da = row_sat + row_lines + 1
 
-        ws['B' + str(row_sat + row_title)].font = title_font
+        ws['B' + str(row_da)].font = title_font
-        ws['B' + str(row_sat + row_title)] = name + ' 详细数据'
+        ws['B' + str(row_da)] = name + ' 详细数据'
         # table_title
-        ws['B' + str(row_sat + 1 + row_title)].fill = table_fill
+        ws['B' + str(row_da + 1)].fill = table_fill
-        ws['B' + str(row_sat + 1 + row_title)].font = name_font
+        ws['B' + str(row_da + 1)].font = name_font
-        ws['B' + str(row_sat + 1 + row_title)].alignment = c_c_alignment
+        ws['B' + str(row_da + 1)].alignment = c_c_alignment
-        ws['B' + str(row_sat + 1 + row_title)] = "日期时间"
+        ws['B' + str(row_da + 1)] = "日期时间"
-        ws['B' + str(row_sat + 1 + row_title)].border = f_border
+        ws['B' + str(row_da + 1)].border = f_border
 
         for i in range(0, ca_len):
             col_average = chr(ord('C') + i)
             col_maximum = chr(ord('C') + i + ca_len)
 
-            ws[col_average + str(row_sat + 1 + row_title)].font = name_font
+            ws[col_average + str(row_da + 1)].font = name_font
-            ws[col_average + str(row_sat + 1 + row_title)].alignment = c_c_alignment
+            ws[col_average + str(row_da + 1)].alignment = c_c_alignment
-            ws[col_average + str(row_sat + 1 + row_title)] = names[i] + " 平均负荷(" + reporting_period_data['units'][
+            ws[col_average + str(row_da + 1)] = names[i] + " 平均负荷(" + reporting_period_data['units'][
                 i] + "/H)"
-            ws[col_average + str(row_sat + 1 + row_title)].border = f_border
+            ws[col_average + str(row_da + 1)].border = f_border
 
-            ws[col_maximum + str(row_sat + 1 + row_title)].font = name_font
+            ws[col_maximum + str(row_da + 1)].font = name_font
-            ws[col_maximum + str(row_sat + 1 + row_title)].alignment = c_c_alignment
+            ws[col_maximum + str(row_da + 1)].alignment = c_c_alignment
-            ws[col_maximum + str(row_sat + 1 + row_title)] = names[i] + " 最大负荷(" + reporting_period_data['units'][
+            ws[col_maximum + str(row_da + 1)] = names[i] + " 最大负荷(" + reporting_period_data['units'][
                 i] + "/H)"
-            ws[col_maximum + str(row_sat + 1 + row_title)].border = f_border
+            ws[col_maximum + str(row_da + 1)].border = f_border
         # table_date
         for i in range(0, time_len):
-            rows = i + row_sat + 2 + 6 * ca_len
+            rows = i + row_da + 2
 
             ws['B' + str(rows)].font = name_font
             ws['B' + str(rows)].alignment = c_c_alignment
@@ -381,8 +383,8 @@ def generate_excel(report,
             ws['B' + str(rows)].border = f_border
 
             for index in range(0, ca_len):
-                col_average = chr(ord('C') + index * 2)
+                col_average = chr(ord('C') + index)
-                col_maximum = chr(ord('C') + index * 2 + 1)
+                col_maximum = chr(ord(col_average) + ca_len)
 
                 ws[col_average + str(rows)].font = name_font
                 ws[col_average + str(rows)].alignment = c_c_alignment
@@ -412,10 +414,10 @@ def generate_excel(report,
             lc.dLbls = DataLabelList()
             lc.dLbls.dLblPos = 't'
             lc.dLbls.showVal = True
-            times = Reference(ws, min_col=2, min_row=row_sat + 2 + row_title,
+            times = Reference(ws, min_col=2, min_row=row_da + 2,
-                              max_row=row_sat + 2 + row_title + time_len)
+                              max_row=row_da + 2 + time_len)
-            lc_data = Reference(ws, min_col=3 + ca_len, min_row=row_sat + 1 + row_title,
+            lc_data = Reference(ws, min_col=3 + ca_len + i, min_row=row_da + 1,
-                                max_row=row_sat + 1 + row_title + time_len)
+                                max_row=row_da + 1 + time_len)
             lc.add_data(lc_data, titles_from_data=True)
             lc.set_categories(times)
             ser = lc.series[0]

myems-api/reports/combinedequipmentload.py

@@ -5,6 +5,7 @@ import config
 from datetime import datetime, timedelta, timezone
 from core import utilities
 from decimal import Decimal
+import excelexporters.combinedequipmentload
 
 
 class Reporting:
@@ -69,7 +70,7 @@ class Reporting:
             try:
                 base_start_datetime_utc = datetime.strptime(base_start_datetime_local,
                                                             '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) - \
-                    timedelta(minutes=timezone_offset)
+                                          timedelta(minutes=timezone_offset)
             except ValueError:
                 raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                        description="API.INVALID_BASE_PERIOD_START_DATETIME")
@@ -80,7 +81,7 @@ class Reporting:
             try:
                 base_end_datetime_utc = datetime.strptime(base_end_datetime_local,
                                                           '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) - \
-                    timedelta(minutes=timezone_offset)
+                                        timedelta(minutes=timezone_offset)
             except ValueError:
                 raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                        description="API.INVALID_BASE_PERIOD_END_DATETIME")
@@ -98,7 +99,7 @@ class Reporting:
             try:
                 reporting_start_datetime_utc = datetime.strptime(reporting_start_datetime_local,
                                                                  '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) - \
-                    timedelta(minutes=timezone_offset)
+                                               timedelta(minutes=timezone_offset)
             except ValueError:
                 raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                        description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
@@ -111,7 +112,7 @@ class Reporting:
             try:
                 reporting_end_datetime_utc = datetime.strptime(reporting_end_datetime_local,
                                                                '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) - \
-                    timedelta(minutes=timezone_offset)
+                                             timedelta(minutes=timezone_offset)
             except ValueError:
                 raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
                                        description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
@@ -269,10 +270,10 @@ class Reporting:
                                                               period_type)
                 base[energy_category_id]['factor'] = \
                     (base[energy_category_id]['average'] / base[energy_category_id]['maximum']
-                        if (base[energy_category_id]['average'] is not None and
+                     if (base[energy_category_id]['average'] is not None and
-                            base[energy_category_id]['maximum'] is not None and
+                         base[energy_category_id]['maximum'] is not None and
-                            base[energy_category_id]['maximum'] > Decimal(0.0))
+                         base[energy_category_id]['maximum'] > Decimal(0.0))
-                        else None)
+                     else None)
 
                 for row_combined_equipment_periodically in rows_combined_equipment_periodically:
                     current_datetime_local = row_combined_equipment_periodically[0].replace(tzinfo=timezone.utc) + \
@@ -523,4 +524,11 @@ class Reporting:
             "values": parameters_data['values']
         }
 
+        # export result to Excel file and then encode the file to base64 string
+        result['excel_bytes_base64'] = excelexporters.combinedequipmentload.export(result,
+                                                                                   combined_equipment['name'],
+                                                                                   reporting_start_datetime_local,
+                                                                                   reporting_end_datetime_local,
+                                                                                   period_type)
+
         resp.body = json.dumps(result)