Add ability to hide worksheets (#237)

Author: 9thbit

README.rst

@@ -363,6 +363,20 @@ attribute as well. This permits you to modify the style at a later time.
     ws[1][1].style.font = font
     wb.save("output.xlsx")
 
+Hidden sheet
+~~~~~~~~~~~~
+
+PyExcelerate supports adding hidden sheets. Note that the first sheet cannot be hidden.
+
+::
+
+    from pyexcelerate import Workbook
+
+    wb = Workbook()
+    ws = wb.new_sheet("visible sheet")
+    ws = wb.new_sheet("hidden sheet", hidden=True)
+    wb.save("output.xlsx")
+
 Packaging with PyInstaller
 --------------------------
 

pyexcelerate/Workbook.py

@@ -33,8 +33,8 @@ def add_sheet(self, worksheet):
                 )
         self._worksheets.append(worksheet)
 
-    def new_sheet(self, sheet_name, data=None, force_name=False):
-        worksheet = Worksheet.Worksheet(sheet_name, self, data, force_name)
+    def new_sheet(self, sheet_name, data=None, force_name=False, hidden=False):
+        worksheet = Worksheet.Worksheet(sheet_name, self, data, force_name, hidden)
         self.add_sheet(worksheet)
         return worksheet
 

pyexcelerate/Worksheet.py

@@ -65,10 +65,11 @@ class Worksheet(object):
         "_attributes",
         "_panes",
         "_show_grid_lines",
+        "hidden",
         "auto_filter",
     )
 
-    def __init__(self, name, workbook, data=None, force_name=False):
+    def __init__(self, name, workbook, data=None, force_name=False, hidden=False):
         self._columns = 0  # cache this for speed
         if len(name) > 31 and not force_name:
             # http://stackoverflow.com/questions/3681868/is-there-a-limit-on-an-excel-worksheets-name-length
@@ -86,6 +87,7 @@ def __init__(self, name, workbook, data=None, force_name=False):
         self._attributes = {}
         self._panes = Panes.Panes()
         self._show_grid_lines = True
+        self.hidden = hidden
         self.auto_filter = False
         if data is not None:
             # Iterate over the data to ensure we receive a copy of immutables.

pyexcelerate/templates/xl/workbook.xml

@@ -7,7 +7,7 @@
     </bookViews>
     <sheets>
         {% for index, sheet in workbook.get_xml_data() %}
-        <sheet name="{{ sheet.name }}" sheetId="{{ index }}" r:id="rId{{ index }}" />
+        <sheet name="{{ sheet.name }}" sheetId="{{ index }}" r:id="rId{{ index }}" {% if sheet.hidden %}state="hidden" {% endif %}/>
         {% endfor %}
     </sheets>
     <calcPr calcId="145621" />

pyexcelerate/tests/test_Workbook.py

@@ -242,3 +242,11 @@ def test_show_grid_lines():
     ws = wb.new_sheet("default_with_grid_lines")
     ws[1][1].value = "even more data"
     wb.save(get_output_path("grid_lines.xlsx"))
+
+
+def test_hidden_sheet():
+    wb = Workbook()
+    wb.new_sheet("Visible sheet", hidden=False)
+    wb.new_sheet("Hidden sheet", hidden=True)
+    wb.new_sheet("Another hidden sheet", hidden=True)
+    wb.save(get_output_path("hidden_sheet.xlsx"))