Changeset 5bcc3ba in rattail

Timestamp:

10/30/2022 04:56:02 PM (3 months ago)

Author:

Lance Edgar <lance@…>

Branches:

master

Children:

a2e54d9

Parents:

0189de2

Message:

Make some behavior optional, for writing Excel reports

Location:

rattail

Files:

• excel.py (modified) (3 diffs)
• reporting/excel.py (modified) (4 diffs)

rattail/excel.py

@@ -196 +196 @@
     """
 
-    def __init__(self, path, fields, sheet_title=None, number_formats={}):
+    def __init__(self, path, fields, sheet_title=None, number_formats={},
+                 highlight_rows=True):
         """
         Constructor; opens an Excel workbook for writing.
@@ -207 +208 @@
             self.sheet.title = sheet_title
         self.number_formats = number_formats
+        self.highlight_rows = highlight_rows
+
+    def load_workbook(self, path, clear_sheet=False):
+        self.book = openpyxl.load_workbook(filename=path)
+        self.sheet = self.book.active
+
+        if clear_sheet:
+            # remove all non-header rows from the sheet
+            # TODO: make header row count configurable
+            self.sheet.delete_rows(2, self.sheet.max_row)
 
     def create_sheet(self, title):
@@ -251 +262 @@
 
         # apply row highlighting
-        if row % 2 == 0:
-            fill_even = PatternFill(patternType='solid',
-                                    fgColor='d9d9d9',
-                                    bgColor='d9d9d9')
-            for col, field in enumerate(self.fields, 1):
-                cell = self.sheet.cell(row=row, column=col)
-                cell.fill = fill_even
+        if self.highlight_rows:
+            if row % 2 == 0:
+                fill_even = PatternFill(patternType='solid',
+                                        fgColor='d9d9d9',
+                                        bgColor='d9d9d9')
+                for col, field in enumerate(self.fields, 1):
+                    cell = self.sheet.cell(row=row, column=col)
+                    cell.fill = fill_even
 
     def write_rows(self, rows, progress=None):

rattail/reporting/excel.py

@@ -52 +52 @@
        Optional list of fields which should be "totalled" and represented in a
        final totals row within the output.
+
+    .. attr:: write_data_header
+
+       Boolean flag (true by default) indicating that a header row
+       with field names should be written to the data sheet.  Set this
+       to false if you are using a template file.
+
+    .. attr:: auto_format_data
+
+       Boolean flag (true by default) indicating that certain
+       "auto-formatting" should be applied to the data sheet.
+
+    .. attr:: include_summary_sheet
+
+       Boolean flag (true by default) indicating that a second
+       "summary" sheet should be added to the output file.
     """
     output_fields = []
     number_formats = {}
     totalled_fields = []
+    write_data_header = True
+    auto_format_data = True
+    include_summary_sheet = True
 
     def make_filename(self, session, params, data, **kwargs):
@@ -80 +99 @@
         Write the primary data sheet for the Excel output file.
         """
-        writer.write_header()
+        if self.write_data_header:
+            writer.write_header()
         fields = self.get_output_fields(params)
 
@@ -117 +137 @@
                 cell.fill = fill_totals
 
-        writer.auto_freeze()
-        writer.auto_filter()
-        writer.auto_resize()
+        if self.auto_format_data:
+            writer.auto_freeze()
+            writer.auto_filter()
+            writer.auto_resize()
 
     def write_summary_sheet(self, writer, session, params, data,
@@ -160 +181 @@
         self.write_data_sheet(writer, session, params, data, progress=progress)
 
-        self.write_summary_sheet(writer, session, params, data, progress=progress)
+        if self.include_summary_sheet:
+            self.write_summary_sheet(writer, session, params, data,
+                                     progress=progress)
 
         writer.save(progress=progress)