Merge python-tabulate into feature/named-dataframe-index

astanin · astanin · commit a9a22e97b460 · 2016-03-21T16:04:01.000+01:00
diff --git a/tabulate.py b/tabulate.py
@@ -711,7 +711,12 @@ def _normalize_tabular_data(tabular_data, headers, showindex="default"):
             rows = list(izip_longest(*tabular_data.values()))  # columns have to be transposed
         elif hasattr(tabular_data, "index"):
             # values is a property, has .index => it's likely a pandas.DataFrame (pandas 0.11.0)
-            keys = tabular_data.keys()
+            keys = list(tabular_data)
+            if tabular_data.index.name is not None:
+                if isinstance(tabular_data.index.name, list):
+                    keys[:0] = tabular_data.index.name
+                else:
+                    keys[:0] = [tabular_data.index.name]
             vals = tabular_data.values  # values matrix doesn't need to be transposed
             # for DataFrames add an index per default
             index = list(tabular_data.index)
@@ -1068,6 +1073,9 @@ def tabulate(tabular_data, headers=(), tablefmt="simple",
     list_of_lists, headers = _normalize_tabular_data(
             tabular_data, headers, showindex=showindex)
 
+    if tablefmt == 'rst' and len(headers) > 0 and headers[0] == '':
+        headers[0] = '-'
+
     # optimization: look for ANSI control codes once,
     # enable smart width functions only if a control code is found
     plain_text = '\n'.join(['\t'.join(map(_text_type, headers))] + \
diff --git a/test/test_output.py b/test/test_output.py
@@ -455,6 +455,49 @@ def test_pandas_without_index():
         raise SkipTest()   # this test is optional
 
 
+def test_pandas_rst_with_index():
+    "Output: a pandas Dataframe with an index in ReStructuredText format"
+    try:
+        import pandas
+        df = pandas.DataFrame([["one", 1], ["two", None]],
+                              columns=["string", "number"],
+                              index=["a", "b"])
+        expected = "\n".join(
+            ['===  ========  ========',
+             '-    string      number',
+             '===  ========  ========',
+             'a    one              1',
+             'b    two            nan',
+             '===  ========  ========'])
+        result = tabulate(df, tablefmt="rst", headers="keys")
+        assert_equal(expected, result)
+    except ImportError:
+        print("test_pandas_rst_with_index is skipped")
+        raise SkipTest()   # this test is optional
+
+
+def test_pandas_rst_with_named_index():
+    "Output: a pandas Dataframe with a named index in ReStructuredText format"
+    try:
+        import pandas
+        index = pandas.Index(["a", "b"], name='index')
+        df = pandas.DataFrame([["one", 1], ["two", None]],
+                              columns=["string", "number"],
+                              index=index)
+        expected = "\n".join(
+            ['=======  ========  ========',
+             'index    string      number',
+             '=======  ========  ========',
+             'a        one              1',
+             'b        two            nan',
+             '=======  ========  ========'])
+        result = tabulate(df, tablefmt="rst", headers="keys")
+        assert_equal(expected, result)
+    except ImportError:
+        print("test_pandas_rst_with_index is skipped")
+        raise SkipTest()   # this test is optional
+
+
 def test_dict_like_with_index():
     "Output: a table with a running index"
     dd = {"b": range(101,104)}
