worksheet: add very_hidden() method

Feature request #947

Author: jmcnamara

dev/docs/source/worksheet.rst

@@ -2071,6 +2071,20 @@ sheet::
 
 See :ref:`ex_hide_sheet` for more details.
 
+
+worksheet.very_hidden()
+-----------------------
+
+.. py:function:: very_hidden()
+
+   Hide the current worksheet. Can only be unhidden by VBA.
+
+The ``very_hidden()`` method can be used to hide a worksheet similar to the
+``hide()`` method. The difference is that the worksheet cannot be unhidden in
+the the Excel user interface. The Excel worksheet "xlSheetVeryHidden" option can
+only be unset programmatically by VBA.
+
+
 worksheet.set_first_sheet()
 ---------------------------
 

xlsxwriter/packager.py

@@ -306,24 +306,29 @@ def _write_app_file(self):
         properties = self.workbook.doc_properties
         app = App()
 
-        # Add the Worksheet heading pairs.
-        app._add_heading_pair(["Worksheets", self.worksheet_count])
-
-        # Add the Chartsheet heading pairs.
-        app._add_heading_pair(["Charts", self.chartsheet_count])
-
         # Add the Worksheet parts.
+        worksheet_count = 0
         for worksheet in self.workbook.worksheets():
             if worksheet.is_chartsheet:
                 continue
-            app._add_part_name(worksheet.name)
+
+            # Don't write/count veryHidden sheets.
+            if worksheet.hidden != 2:
+                app._add_part_name(worksheet.name)
+                worksheet_count += 1
+
+        # Add the Worksheet heading pairs.
+        app._add_heading_pair(["Worksheets", worksheet_count])
 
         # Add the Chartsheet parts.
         for worksheet in self.workbook.worksheets():
             if not worksheet.is_chartsheet:
                 continue
             app._add_part_name(worksheet.name)
 
+        # Add the Chartsheet heading pairs.
+        app._add_heading_pair(["Charts", self.chartsheet_count])
+
         # Add the Named Range heading pairs.
         if self.named_ranges:
             app._add_heading_pair(["Named Ranges", len(self.named_ranges)])

xlsxwriter/test/comparison/test_hide02.py

@@ -0,0 +1,35 @@
+###############################################################################
+#
+# 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("hide02.xlsx")
+
+    def test_create_file(self):
+        """Test the creation of a simple XlsxWriter file."""
+
+        workbook = Workbook(self.got_filename)
+
+        worksheet1 = workbook.add_worksheet()
+        worksheet2 = workbook.add_worksheet()
+        worksheet3 = workbook.add_worksheet()
+
+        worksheet2.very_hidden()
+
+        workbook.close()
+
+        self.assertExcelEqual()

xlsxwriter/test/comparison/xlsx_files/hide02.xlsx

@@ -1933,8 +1933,10 @@ def _write_sheet(self, name, sheet_id, hidden):
             ("sheetId", sheet_id),
         ]
 
-        if hidden:
+        if hidden == 1:
             attributes.append(("state", "hidden"))
+        elif hidden == 2:
+            attributes.append(("state", "veryHidden"))
 
         attributes.append(("r:id", "rId" + str(sheet_id)))
 

xlsxwriter/workbook.py

@@ -1822,6 +1822,22 @@ def hide(self):
         # A hidden worksheet shouldn't be active or selected.
         self.selected = 0
 
+    def very_hidden(self):
+        """
+        Hide the current worksheet. This can only be unhidden by VBA.
+
+        Args:
+            None.
+
+        Returns:
+            Nothing.
+
+        """
+        self.hidden = 2
+
+        # A hidden worksheet shouldn't be active or selected.
+        self.selected = 0
+
     def set_first_sheet(self):
         """
         Set current worksheet as the first visible sheet. This is necessary