table: fix issue where column formulas were overwritten by table data

Issue #1015

Author: jmcnamara

xlsxwriter/test/comparison/test_table34.py

@@ -0,0 +1,59 @@
+###############################################################################
+#
+# Tests for XlsxWriter.
+#
+# SPDX-License-Identifier: BSD-2-Clause
+# Copyright (c), 2013-2023, John McNamara, [email protected]
+#
+
+from ..excel_comparison_test import ExcelComparisonTest
+from ...workbook import Workbook
+
+
+class TestCompareXLSXFiles(ExcelComparisonTest):
+    """
+    Test file created by XlsxWriter against a file created by Excel.
+
+    """
+
+    def setUp(self):
+        self.set_filename("table34.xlsx")
+
+        self.ignore_files = [
+            "xl/calcChain.xml",
+            "[Content_Types].xml",
+            "xl/_rels/workbook.xml.rels",
+        ]
+
+    def test_create_file(self):
+        """Test the creation of a simple XlsxWriter file with tables."""
+
+        workbook = Workbook(self.got_filename)
+        worksheet = workbook.add_worksheet()
+        format1 = workbook.add_format({"num_format": "0.0000"})
+
+        data = [
+            ["Foo", 1234, 0, 4321],
+            ["Bar", 1256, 0, 4320],
+            ["Baz", 2234, 0, 4332],
+            ["Bop", 1324, 0, 4333],
+        ]
+
+        worksheet.set_column("C:F", 10.288)
+
+        worksheet.add_table(
+            "C2:F6",
+            {
+                "data": data,
+                "columns": [
+                    {},
+                    {},
+                    {},
+                    {"formula": "Table1[[#This Row],[Column3]]", "format": format1},
+                ],
+            },
+        )
+
+        workbook.close()
+
+        self.assertExcelEqual()

xlsxwriter/test/comparison/xlsx_files/table34.xlsx

@@ -3388,9 +3388,7 @@ def add_table(self, first_row, first_col, last_row, last_col, options=None):
                         formula = formula.replace("@", "[#This Row],")
 
                         col_data["formula"] = formula
-
-                        for row in range(first_data_row, last_data_row + 1):
-                            self._write_formula(row, col_num, formula, xformat)
+                        # We write the formulas below after the table data.
 
                     # Handle the function for the total row.
                     if user_data.get("total_function"):
@@ -3475,6 +3473,17 @@ def add_table(self, first_row, first_col, last_row, last_col, options=None):
                     j += 1
                 i += 1
 
+        # Write any columns formulas after the user supplied table data to
+        # overwrite it if required.
+        for col_id, col_num in enumerate(range(first_col, last_col + 1)):
+            column_data = table["columns"][col_id]
+            if column_data and column_data["formula"]:
+                formula_format = col_formats.get(col_id)
+                formula = column_data["formula"]
+
+                for row in range(first_data_row, last_data_row + 1):
+                    self._write_formula(row, col_num, formula, formula_format)
+
         # Store the table data.
         self.tables.append(table)