ENH14194: switch index_hidden to index_visible

Author: nchmura4

pandas/io/formats/style.py

@@ -70,8 +70,14 @@ class Styler(object):
         a unique identifier to avoid CSS collisons; generated automatically
     caption: str, default None
         caption to attach to the table
-    index_hidden: bool, default False
-        hides the index in the html output
+    index: bool, default True
+        determines if the index is rendered in the html output
+
+        .. versionadded:: 0.20.1
+
+    hidden_cols: IndexSlice, default None
+        hides a subset of columns from rendering
+
         .. versionadded:: 0.20.1
 
     Attributes
@@ -121,7 +127,7 @@ class Styler(object):
     template = env.get_template("html.tpl")
 
     def __init__(self, data, precision=None, table_styles=None, uuid=None,
-                 caption=None, table_attributes=None, index_hidden=False,
+                 caption=None, table_attributes=None, index=True,
                  hidden_cols=None):
         self.ctx = defaultdict(list)
         self._todo = []
@@ -144,7 +150,7 @@ def __init__(self, data, precision=None, table_styles=None, uuid=None,
             precision = get_option('display.precision')
         self.precision = precision
         self.table_attributes = table_attributes
-        self.index_hidden = index_hidden
+        self.index_visible = index
         if hidden_cols is None:
             hidden_cols = []
         self.hidden_cols = hidden_cols
@@ -196,7 +202,7 @@ def _translate(self):
         caption = self.caption
         ctx = self.ctx
         precision = self.precision
-        index_hidden = self.index_hidden
+        index_visible = self.index_visible
         hidden_cols = self.hidden_cols
         uuid = self.uuid or str(uuid1()).replace("-", "_")
         ROW_HEADING_CLASS = "row_heading"
@@ -235,7 +241,7 @@ def format_attr(pair):
             row_es = [{"type": "th",
                        "value": BLANK_VALUE,
                        "display_value": BLANK_VALUE,
-                       "is_visible": (not index_hidden),
+                       "is_visible": index_visible,
                        "class": " ".join([BLANK_CLASS])}] * (n_rlvls - 1)
 
             # ... except maybe the last for columns.names
@@ -247,7 +253,7 @@ def format_attr(pair):
                            "value": name,
                            "display_value": name,
                            "class": " ".join(cs),
-                           "is_visible": (not index_hidden)})
+                           "is_visible": index_visible})
 
             for c, value in enumerate(clabels[r]):
                 cs = [COL_HEADING_CLASS, "level%s" % r, "col%s" % c]
@@ -268,7 +274,7 @@ def format_attr(pair):
                 row_es.append(es)
             head.append(row_es)
 
-        if self.data.index.names and not index_hidden\
+        if self.data.index.names and index_visible\
            and not all(x is None for x in self.data.index.names):
             index_header_row = []
 
@@ -294,7 +300,7 @@ def format_attr(pair):
                 es = {
                     "type": "th",
                     "is_visible": (_is_visible(r, c, idx_lengths) &
-                                   (~index_hidden)),
+                                   index_visible),
                     "value": value,
                     "display_value": value,
                     "class": " ".join([ROW_HEADING_CLASS, "level%s" % c,
@@ -475,7 +481,7 @@ def _copy(self, deepcopy=False):
         styler = Styler(self.data, precision=self.precision,
                         caption=self.caption, uuid=self.uuid,
                         table_styles=self.table_styles,
-                        index_hidden=self.index_hidden,
+                        index=self.index_visible,
                         hidden_cols=self.hidden_cols)
         if deepcopy:
             styler.ctx = copy.deepcopy(self.ctx)
@@ -788,7 +794,7 @@ def hide_index(self):
         -------
         self : Styler
         """
-        self.index_hidden = True
+        self.index_visible = False
         return self
 
     def hide_columns(self, subset):

pandas/tests/io/formats/test_style.py

@@ -814,17 +814,17 @@ def test_mi_sparse_column_names(self):
     def test_hide_single_index(self):
         # single unnamed index
         ctx = self.df.style._translate()
-        self.assertTrue(ctx['body'][0][0]['is_visible'])
-        self.assertTrue(ctx['head'][0][0]['is_visible'])
+        assert(ctx['body'][0][0]['is_visible'])
+        assert(ctx['head'][0][0]['is_visible'])
         ctx2 = self.df.style.hide_index()._translate()
         self.assertFalse(ctx2['body'][0][0]['is_visible'])
         self.assertFalse(ctx2['head'][0][0]['is_visible'])
 
         # single named index
         ctx3 = self.df.set_index('A').style._translate()
-        self.assertTrue(ctx3['body'][0][0]['is_visible'])
+        assert(ctx3['body'][0][0]['is_visible'])
         self.assertEqual(len(ctx3['head']), 2)  # 2 header levels
-        self.assertTrue(ctx3['head'][0][0]['is_visible'])
+        assert(ctx3['head'][0][0]['is_visible'])
 
         ctx4 = self.df.set_index('A').style.hide_index()._translate()
         self.assertFalse(ctx4['body'][0][0]['is_visible'])
@@ -838,11 +838,11 @@ def test_hide_multiindex(self):
         )
         ctx1 = df.style._translate()
         # tests for 'a' and '0'
-        self.assertTrue(ctx1['body'][0][0]['is_visible'])
-        self.assertTrue(ctx1['body'][0][1]['is_visible'])
+        assert(ctx1['body'][0][0]['is_visible'])
+        assert(ctx1['body'][0][1]['is_visible'])
         # check for blank header rows
-        self.assertTrue(ctx1['head'][0][0]['is_visible'])
-        self.assertTrue(ctx1['head'][0][1]['is_visible'])
+        assert(ctx1['head'][0][0]['is_visible'])
+        assert(ctx1['head'][0][1]['is_visible'])
 
         ctx2 = df.style.hide_index()._translate()
         # tests for 'a' and '0'
@@ -855,17 +855,17 @@ def test_hide_multiindex(self):
     def test_hide_columns_single_level(self):
         # test hiding single column
         ctx = self.df.style._translate()
-        self.assertTrue(ctx['head'][0][1]['is_visible'])
+        assert(ctx['head'][0][1]['is_visible'])
         self.assertEqual(ctx['head'][0][1]['display_value'], 'A')
-        self.assertTrue(ctx['head'][0][2]['is_visible'])
+        assert(ctx['head'][0][2]['is_visible'])
         self.assertEqual(ctx['head'][0][2]['display_value'], 'B')
-        self.assertTrue(ctx['body'][0][1]['is_visible'])  # col A, row 1
-        self.assertTrue(ctx['body'][1][2]['is_visible'])  # col B, row 1
+        assert(ctx['body'][0][1]['is_visible'])  # col A, row 1
+        assert(ctx['body'][1][2]['is_visible'])  # col B, row 1
 
         ctx = self.df.style.hide_columns('A')._translate()
         self.assertFalse(ctx['head'][0][1]['is_visible'])
         self.assertFalse(ctx['body'][0][1]['is_visible'])  # col A, row 1
-        self.assertTrue(ctx['body'][1][2]['is_visible'])  # col B, row 1
+        assert(ctx['body'][1][2]['is_visible'])  # col B, row 1
 
         # test hiding mulitiple columns
         ctx = self.df.style.hide_columns(['A', 'B'])._translate()
@@ -885,40 +885,40 @@ def test_hide_columns_mult_levels(self):
         df = pd.DataFrame([[1, 2], [3, 4]], index=i1, columns=i2)
         ctx = df.style._translate()
         # column headers
-        self.assertTrue(ctx['head'][0][2]['is_visible'])
-        self.assertTrue(ctx['head'][1][2]['is_visible'])
+        assert(ctx['head'][0][2]['is_visible'])
+        assert(ctx['head'][1][2]['is_visible'])
         self.assertEqual(ctx['head'][1][3]['display_value'], 1)
         # indices
-        self.assertTrue(ctx['body'][0][0]['is_visible'])
+        assert(ctx['body'][0][0]['is_visible'])
         # data
-        self.assertTrue(ctx['body'][1][2]['is_visible'])
+        assert(ctx['body'][1][2]['is_visible'])
         self.assertEqual(ctx['body'][1][2]['display_value'], 3)
-        self.assertTrue(ctx['body'][1][3]['is_visible'])
+        assert(ctx['body'][1][3]['is_visible'])
         self.assertEqual(ctx['body'][1][3]['display_value'], 4)
 
         # hide top column level, which hides both columns
         ctx = df.style.hide_columns('b')._translate()
         self.assertFalse(ctx['head'][0][2]['is_visible'])  # b
         self.assertFalse(ctx['head'][1][2]['is_visible'])  # 0
         self.assertFalse(ctx['body'][1][2]['is_visible'])  # 3
-        self.assertTrue(ctx['body'][0][0]['is_visible'])  # index
+        assert(ctx['body'][0][0]['is_visible'])  # index
 
         # hide first column only
         ctx = df.style.hide_columns([('b', 0)])._translate()
-        self.assertTrue(ctx['head'][0][2]['is_visible'])  # b
+        assert(ctx['head'][0][2]['is_visible'])  # b
         self.assertFalse(ctx['head'][1][2]['is_visible'])  # 0
         self.assertFalse(ctx['body'][1][2]['is_visible'])  # 3
-        self.assertTrue(ctx['body'][1][3]['is_visible'])
+        assert(ctx['body'][1][3]['is_visible'])
         self.assertEqual(ctx['body'][1][3]['display_value'], 4)
 
         # hide second column and index
         ctx = df.style.hide_columns([('b', 1)]).hide_index()._translate()
         self.assertFalse(ctx['body'][0][0]['is_visible'])  # index
-        self.assertTrue(ctx['head'][0][2]['is_visible'])  # b
-        self.assertTrue(ctx['head'][1][2]['is_visible'])  # 0
+        assert(ctx['head'][0][2]['is_visible'])  # b
+        assert(ctx['head'][1][2]['is_visible'])  # 0
         self.assertFalse(ctx['head'][1][3]['is_visible'])  # 1
         self.assertFalse(ctx['body'][1][3]['is_visible'])  # 4
-        self.assertTrue(ctx['body'][1][2]['is_visible'])
+        assert(ctx['body'][1][2]['is_visible'])
         self.assertEqual(ctx['body'][1][2]['display_value'], 3)