mitosheet: update formatting export to better preserve mito default formatting

Author: naterush

mitosheet/mitosheet/public/v3/formatting.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional, Dict
+from typing import Any, List, Optional, Dict
 
 from openpyxl.styles import Font, PatternFill
 from openpyxl.styles import NamedStyle
@@ -7,6 +7,7 @@
 from pandas import DataFrame, ExcelWriter
 
 from mitosheet.excel_utils import get_column_from_column_index
+from mitosheet.is_type_utils import is_float_dtype
 from mitosheet.types import (
     FC_BOOLEAN_IS_FALSE, FC_BOOLEAN_IS_TRUE, FC_DATETIME_EXACTLY,
     FC_DATETIME_GREATER, FC_DATETIME_GREATER_THAN_OR_EQUAL, FC_DATETIME_LESS,
@@ -89,10 +90,13 @@ def get_conditional_format_rule(
     return FormulaRule(fill=fill, font=font, formula=formula)
 
 def add_conditional_formats(
-    conditional_formats: list,
+    conditional_formats: Optional[List[Any]],
     sheet: Worksheet,
     df: DataFrame
 ) -> None:
+    if conditional_formats is None:
+        return
+
     for conditional_format in conditional_formats:
         for filter in conditional_format.get('filters', []):
             # Create the conditional formatting color objects
@@ -127,90 +131,153 @@ def add_number_formatting(
     sheet: Worksheet,
     df: DataFrame
 ) -> None:
-    if number_formats is None:
-        return
-    for column_header, number_format in number_formats.items():
-        column_index = df.columns.tolist().index(column_header)
+    default_number_format_column_indexes = set(range(len(df.columns)))
+
+    # For all the columns that have user defined number formats 
+    # apply those
+    if number_formats is not None:
+        for column_header, number_format in number_formats.items():
+            column_index = df.columns.tolist().index(column_header)
+            column = get_column_from_column_index(column_index)
+            cell_range = f'{column}2:{column}{sheet.max_row}'
+            for cell in sheet[cell_range]:
+                cell[0].number_format = number_format
+
+            default_number_format_column_indexes.remove(column_index)
+
+    # For all the float columns that have default number formats
+    # and contain numbers, apply the default number format
+    # which has comma separators and 2 decimal places
+    column_headers = df.columns.tolist()
+    for column_index in default_number_format_column_indexes:
+        column_header = column_headers[column_index]
+        dtype = str(df[column_header].dtype)
+        if not is_float_dtype(dtype):
+            continue
+
         column = get_column_from_column_index(column_index)
         cell_range = f'{column}2:{column}{sheet.max_row}'
         for cell in sheet[cell_range]:
-            cell[0].number_format = number_format
+            cell[0].number_format = '#,##0.00'
+
+def add_header_formatting_to_excel_sheet(
+    writer: ExcelWriter,
+    sheet_name: str,
+    header_background_color: Optional[str]=None,
+    header_font_color: Optional[str]=None
+) -> None:
+    """
+    Adds formatting to the header row of the sheet_name, based on the formatting the user
+    currently has applied in the frontend. 
+    """
+    workbook = writer.book
+    sheet = workbook.get_sheet_by_name(sheet_name)
+    
+    # Add formatting to the header row   
+    header_name = f"{sheet_name}_Header"
+    header_format = NamedStyle(name=header_name)
+    if header_font_color:
+        # Remove the # from the color
+        header_format.font = Font(color=header_font_color[1:])
+    if header_background_color:
+        # Remove the # from the color
+        header_format.fill = PatternFill(start_color=header_background_color[1:], end_color=header_background_color[1:], fill_type="solid")
+    
+    # Only add format if there is a header color or background color
+    has_header_formatting = header_background_color or header_font_color 
+    if has_header_formatting:
+        # Add named styles for the header rows to improve performance
+        workbook.add_named_style(header_format)
+
+        # Write the formatting to the sheet
+        for col in range(1, sheet.max_column + 1):
+            sheet.cell(row=1, column=col).style = header_name
+
+def add_row_formatting_to_excel_sheet(
+    writer: ExcelWriter,
+    sheet_name: str,
+    even_background_color: Optional[str]=None,
+    even_font_color: Optional[str]=None,
+    odd_background_color: Optional[str]=None,
+    odd_font_color: Optional[str]=None
+) -> None:
+    """
+    Adds formatting to the rows of the sheet_name, based on the formatting the user
+    currently has applied in the frontend. 
+    """
+    workbook = writer.book
+    sheet = workbook.get_sheet_by_name(sheet_name)
+
+    # Add formatting to the rows
+    even_name = f"{sheet_name}_Even"
+    odd_name = f"{sheet_name}_Odd"
+    even_format = NamedStyle(name=even_name)
+    odd_format = NamedStyle(name=odd_name)
+
+    # Remove the # from the colors and define the formatting objects
+    if even_background_color:
+        even_format.fill = PatternFill(start_color=even_background_color[1:], end_color=even_background_color[1:], fill_type="solid")
+    if even_font_color:
+        even_format.font = Font(color=even_font_color[1:])
+    if odd_background_color:
+        odd_format.fill = PatternFill(start_color=odd_background_color[1:], end_color=odd_background_color[1:], fill_type="solid")
+    if odd_font_color:
+        odd_format.font = Font(color=odd_font_color[1:])
+    
+    # Only add format if there is a background color or font color
+    has_row_formatting = even_background_color or even_font_color or odd_background_color or odd_font_color
+    if not has_row_formatting:
+        return
+
+    workbook.add_named_style(even_format)
+    workbook.add_named_style(odd_format)
+
+    for row in range(2, sheet.max_row + 1):
+        for col in range(1, sheet.max_column + 1):
+            if row % 2 == 0:
+                sheet.cell(row=row, column=col).style = even_name
+            else:
+                sheet.cell(row=row, column=col).style = odd_name
 
 
 def add_formatting_to_excel_sheet(
-        writer: ExcelWriter,
-        sheet_name: str,
-        df: DataFrame,
-        header_background_color: Optional[str]=None,
-        header_font_color: Optional[str]=None,
-        even_background_color: Optional[str]=None,
-        even_font_color: Optional[str]=None,
-        odd_background_color: Optional[str]=None,
-        odd_font_color: Optional[str]=None,
-        conditional_formats: Optional[list]=None,
-        number_formats: Optional[Dict[str, Any]]=None
-    ) -> None:
-        """
-        Adds formatting to the sheet_name, based on the formatting the user
-        currently has applied in the frontend. 
-
-        NOTE: this is a Mito Pro feature.
-        """
-        workbook = writer.book
-        sheet = workbook.get_sheet_by_name(sheet_name)
-        
-        # Add formatting to the header row   
-        header_name = f"{sheet_name}_Header"
-        header_format = NamedStyle(name=header_name)
-        if header_font_color:
-            # Remove the # from the color
-            header_format.font = Font(color=header_font_color[1:])
-        if header_background_color:
-            # Remove the # from the color
-            header_format.fill = PatternFill(start_color=header_background_color[1:], end_color=header_background_color[1:], fill_type="solid")
-        
-        # Only add format if there is a header color or background color
-        has_header_formatting = header_background_color or header_font_color 
-        if has_header_formatting:
-            # Add named styles for the header rows to improve performance
-            workbook.add_named_style(header_format)
-
-            # Write the formatting to the sheet
-            for col in range(1, sheet.max_column + 1):
-                sheet.cell(row=1, column=col).style = header_name
-
-        # Add formatting to the rows
-        even_name = f"{sheet_name}_Even"
-        odd_name = f"{sheet_name}_Odd"
-        even_format = NamedStyle(name=even_name)
-        odd_format = NamedStyle(name=odd_name)
-
-        # Remove the # from the colors and define the formatting objects
-        if even_background_color:
-            even_format.fill = PatternFill(start_color=even_background_color[1:], end_color=even_background_color[1:], fill_type="solid")
-        if even_font_color:
-            even_format.font = Font(color=even_font_color[1:])
-        if odd_background_color:
-            odd_format.fill = PatternFill(start_color=odd_background_color[1:], end_color=odd_background_color[1:], fill_type="solid")
-        if odd_font_color:
-            odd_format.font = Font(color=odd_font_color[1:])
-        
-        # Only add format if there is a background color or font color
-        has_row_formatting = even_background_color or even_font_color or odd_background_color or odd_font_color
-        if has_row_formatting:
-            workbook.add_named_style(even_format)
-            workbook.add_named_style(odd_format)
-
-            for row in range(2, sheet.max_row + 1):
-                for col in range(1, sheet.max_column + 1):
-                    if row % 2 == 0:
-                        sheet.cell(row=row, column=col).style = even_name
-                    else:
-                        sheet.cell(row=row, column=col).style = odd_name
-
-        # Add conditional formatting
-        if conditional_formats is not None:
-            add_conditional_formats(conditional_formats, sheet, df)
-
-        if number_formats is not None:
-            add_number_formatting(number_formats, sheet, df)
+    writer: ExcelWriter,
+    sheet_name: str,
+    df: DataFrame,
+    header_background_color: Optional[str]=None,
+    header_font_color: Optional[str]=None,
+    even_background_color: Optional[str]=None,
+    even_font_color: Optional[str]=None,
+    odd_background_color: Optional[str]=None,
+    odd_font_color: Optional[str]=None,
+    conditional_formats: Optional[list]=None,
+    number_formats: Optional[Dict[str, Any]]=None
+) -> None:
+    """
+    Adds formatting to the sheet_name, based on the formatting the user
+    currently has applied in the frontend. 
+
+    NOTE: this is a Mito Pro feature.
+    """
+    workbook = writer.book
+    sheet = workbook.get_sheet_by_name(sheet_name)
+
+    add_header_formatting_to_excel_sheet(
+        writer=writer,
+        sheet_name=sheet_name,
+        header_background_color=header_background_color,
+        header_font_color=header_font_color
+    )
+
+    add_row_formatting_to_excel_sheet(
+        writer=writer,
+        sheet_name=sheet_name,
+        even_background_color=even_background_color,
+        even_font_color=even_font_color,
+        odd_background_color=odd_background_color,
+        odd_font_color=odd_font_color
+    )
+
+    add_conditional_formats(conditional_formats, sheet, df)
+
+    add_number_formatting(number_formats, sheet, df)