Merge pull request #6041 from hayd/master (reworked)

* hayd-show_dimensions_option:
  DOC: add show_dimensions to faq
  ENH: html repr respects show_dimensions
  ENH: add show_dimensions display config

Author: y-p

doc/source/faq.rst

@@ -47,6 +47,7 @@ As of 0.13, these are the relevant options, all under the `display` namespace,
   truncated table or, with this set to 'info', as a short summary view.
 - max_columns (default 20): max dataframe columns to display.
 - max_rows (default 60): max dataframe rows display.
+- show_dimensions (default True): controls the display of the row/col counts footer.
 
 Two additional options only apply to displaying DataFrames in terminals,
 not to the HTML view:

doc/source/v0.13.1.txt

@@ -104,6 +104,16 @@ Enhancements
      df['diff'] = df['today']-df['age']
      df
 
+- Add ``show_dimensions`` display option for the new DataFrame repr:
+
+   .. ipython:: python
+
+      df = DataFrame([[1, 2], [3, 4]])
+      pd.set_option('show_dimensions', False)
+      df
+
+      pd.set_option('show_dimensions', True)
+
 - ``Panel.apply`` will work on non-ufuncs. See :ref:`the docs<basics.apply_panel>`.
 
   .. ipython:: python

pandas/core/config_init.py

@@ -119,6 +119,11 @@
     wrap-around across multiple "pages" if it's width exceeds `display.width`.
 """
 
+pc_show_dimensions_doc = """
+: boolean
+    Whether to print out dimensions at the end of DataFrame repr.
+"""
+
 pc_line_width_doc = """
 : int
     Deprecated.
@@ -163,7 +168,6 @@
     If set to None, the number of items to be printed is unlimited.
 """
 
-
 pc_max_info_rows_doc = """
 : int or None
     df.info() will usually show null-counts for each column.
@@ -243,6 +247,7 @@ def mpl_style_cb(key):
     cf.register_option('encoding', detect_console_encoding(), pc_encoding_doc,
                        validator=is_text)
     cf.register_option('expand_frame_repr', True, pc_expand_repr_doc)
+    cf.register_option('show_dimensions', True, pc_show_dimensions_doc)
     cf.register_option('chop_threshold', None, pc_chop_threshold_doc)
     cf.register_option('max_seq_items', 100, pc_max_seq_items)
     cf.register_option('mpl_style', None, pc_mpl_style_doc,

pandas/core/frame.py

@@ -451,12 +451,13 @@ def __unicode__(self):
 
         max_rows = get_option("display.max_rows")
         max_cols = get_option("display.max_columns")
+        show_dimensions = get_option("display.show_dimensions")
         if get_option("display.expand_frame_repr"):
             width, _ = fmt.get_console_size()
         else:
             width = None
         self.to_string(buf=buf, max_rows=max_rows, max_cols=max_cols,
-                       line_width=width, show_dimensions=True)
+                       line_width=width, show_dimensions=show_dimensions)
 
         return buf.getvalue()
 
@@ -485,11 +486,12 @@ def _repr_html_(self):
         if get_option("display.notebook_repr_html"):
             max_rows = get_option("display.max_rows")
             max_cols = get_option("display.max_columns")
+            show_dimensions = get_option("display.show_dimensions")
 
             return ('<div style="max-height:1000px;'
                     'max-width:1500px;overflow:auto;">\n' +
                     self.to_html(max_rows=max_rows, max_cols=max_cols,
-                                 show_dimensions=True) + '\n</div>')
+                                 show_dimensions=show_dimensions) + '\n</div>')
         else:
             return None
 

pandas/tests/test_format.py

@@ -1428,6 +1428,13 @@ def test_repr_html(self):
 
         fmt.reset_option('^display.')
 
+        df = DataFrame([[1, 2], [3, 4]])
+        self.assertTrue('2 rows' in df._repr_html_())
+        fmt.set_option('display.show_dimensions', False)
+        self.assertFalse('2 rows' in df._repr_html_())
+
+        fmt.reset_option('^display.')
+
     def test_repr_html_wide(self):
         row = lambda l, k: [tm.rands(k) for _ in range(l)]
         max_cols = get_option('display.max_columns')

pandas/tests/test_frame.py

@@ -4175,6 +4175,15 @@ def test_repr(self):
         self.assertFalse("\r" in repr(df))
         self.assertFalse("a\n" in repr(df))
 
+    def test_repr_dimensions(self):
+        df = DataFrame([[1, 2,], [3, 4]])
+        self.assertTrue("2 rows x 2 columns" in repr(df))
+
+        fmt.set_option('display.show_dimensions', False)
+        self.assertFalse("2 rows x 2 columns" in repr(df))
+
+        fmt.reset_option('^display\.')
+
     @slow
     def test_repr_big(self):
         buf = StringIO()