Merge pull request astanin#23 from stmcginnis/prettytable

astanin · web-flow · commit 578071ddc551 · 2020-01-15T12:32:52.000+01:00
diff --git a/README.md b/README.md
@@ -142,6 +142,7 @@ Supported table formats are:
 -   "orgtbl"
 -   "jira"
 -   "presto"
+-   "pretty"
 -   "psql"
 -   "rst"
 -   "mediawiki"
@@ -221,6 +222,18 @@ corresponds to the `pipe` format without alignment colons:
      eggs   |   451
      bacon  |     0
 
+`pretty` attempts to be close to the format emitted by the PrettyTables
+library:
+
+    >>> print(tabulate(table, headers, tablefmt="pretty"))
+    +-------+-----+
+    | item  | qty |
+    +-------+-----+
+    | spam  | 42  |
+    | eggs  | 451 |
+    | bacon |  0  |
+    +-------+-----+
+
 `psql` is like tables formatted by Postgres' psql cli:
 
     >>> print(tabulate(table, headers, tablefmt="psql"))
@@ -580,6 +593,18 @@ a multiline cell, and headers with a multiline cell:
      more   |    42
      spam   |
 
+`pretty` tables:
+
+    >>> print(tabulate(table, headers, tablefmt="pretty"))
+    +------+-----+
+    | item | qty |
+    | name |     |
+    +------+-----+
+    | eggs | 451 |
+    | more | 42  |
+    | spam |     |
+    +------+-----+
+
 `psql` tables:
 
     >>> print(tabulate(table, headers, tablefmt="psql"))
diff --git a/tabulate.py b/tabulate.py
@@ -359,6 +359,16 @@ def escape_empty(val):
         padding=1,
         with_header_hide=None,
     ),
+    "pretty": TableFormat(
+        lineabove=Line("+", "-", "+", "+"),
+        linebelowheader=Line("+", "-", "+", "+"),
+        linebetweenrows=None,
+        linebelow=Line("+", "-", "+", "+"),
+        headerrow=DataRow("|", "|", "|"),
+        datarow=DataRow("|", "|", "|"),
+        padding=1,
+        with_header_hide=None,
+    ),
     "psql": TableFormat(
         lineabove=Line("+", "-", "+", "+"),
         linebelowheader=Line("|", "-", "+", "|"),
@@ -491,6 +501,7 @@ def escape_empty(val):
     "orgtbl": "orgtbl",
     "jira": "jira",
     "presto": "presto",
+    "pretty": "pretty",
     "psql": "psql",
     "rst": "rst",
 }
@@ -1421,6 +1432,17 @@ def tabulate(
     if tablefmt == "rst":
         list_of_lists, headers = _rst_escape_first_column(list_of_lists, headers)
 
+    # PrettyTable formatting does not use any extra padding.
+    # Numbers are not parsed and are treated the same as strings for alignment.
+    # Check if pretty is the format being used and override the defaults so it
+    # does not impact other formats.
+    min_padding = MIN_PADDING
+    if tablefmt == "pretty":
+        min_padding = 0
+        disable_numparse = True
+        numalign = "center"
+        stralign = "center"
+
     # optimization: look for ANSI control codes once,
     # enable smart width functions only if a control code is found
     plain_text = "\t".join(
@@ -1471,7 +1493,7 @@ def tabulate(
         for idx, align in enumerate(colalign):
             aligns[idx] = align
     minwidths = (
-        [width_fn(h) + MIN_PADDING for h in headers] if headers else [0] * len(cols)
+        [width_fn(h) + min_padding for h in headers] if headers else [0] * len(cols)
     )
     cols = [
         _align_column(c, a, minw, has_invisible, enable_widechars, is_multiline)
diff --git a/test/test_output.py b/test/test_output.py
@@ -700,6 +700,112 @@ def test_psql_multiline_with_empty_cells_headerless():
     assert_equal(expected, result)
 
 
+def test_pretty():
+    "Output: pretty with headers"
+    expected = "\n".join(
+        [
+            "+---------+---------+",
+            "| strings | numbers |",
+            "+---------+---------+",
+            "|  spam   | 41.9999 |",
+            "|  eggs   |  451.0  |",
+            "+---------+---------+",
+        ]
+    )
+    result = tabulate(_test_table, _test_table_headers, tablefmt="pretty")
+    assert_equal(expected, result)
+
+
+def test_pretty_headerless():
+    "Output: pretty without headers"
+    expected = "\n".join(
+        [
+            "+------+---------+",
+            "| spam | 41.9999 |",
+            "| eggs |  451.0  |",
+            "+------+---------+",
+        ]
+    )
+    result = tabulate(_test_table, tablefmt="pretty")
+    assert_equal(expected, result)
+
+
+def test_pretty_multiline_headerless():
+    "Output: pretty with multiline cells without headers"
+    table = [["foo bar\nbaz\nbau", "hello"], ["", "multiline\nworld"]]
+    expected = "\n".join(
+        [
+            "+---------+-----------+",
+            "| foo bar |   hello   |",
+            "|   baz   |           |",
+            "|   bau   |           |",
+            "|         | multiline |",
+            "|         |   world   |",
+            "+---------+-----------+",
+        ]
+    )
+    result = tabulate(table, tablefmt="pretty")
+    assert_equal(expected, result)
+
+
+def test_pretty_multiline():
+    "Output: pretty with multiline cells with headers"
+    table = [[2, "foo\nbar"]]
+    headers = ("more\nspam \x1b[31meggs\x1b[0m", "more spam\n& eggs")
+    expected = "\n".join(
+        [
+            "+-----------+-----------+",
+            "|   more    | more spam |",
+            "| spam \x1b[31meggs\x1b[0m |  & eggs   |",
+            "+-----------+-----------+",
+            "|     2     |    foo    |",
+            "|           |    bar    |",
+            "+-----------+-----------+",
+        ]
+    )
+    result = tabulate(table, headers, tablefmt="pretty")
+    assert_equal(expected, result)
+
+
+def test_pretty_multiline_with_empty_cells():
+    "Output: pretty with multiline cells and empty cells with headers"
+    table = [
+        ["hdr", "data", "fold"],
+        ["1", "", ""],
+        ["2", "very long data", "fold\nthis"],
+    ]
+    expected = "\n".join(
+        [
+            "+-----+----------------+------+",
+            "| hdr |      data      | fold |",
+            "+-----+----------------+------+",
+            "|  1  |                |      |",
+            "|  2  | very long data | fold |",
+            "|     |                | this |",
+            "+-----+----------------+------+",
+        ]
+    )
+    result = tabulate(table, headers="firstrow", tablefmt="pretty")
+    assert_equal(expected, result)
+
+
+def test_pretty_multiline_with_empty_cells_headerless():
+    "Output: pretty with multiline cells and empty cells without headers"
+    table = [["0", "", ""], ["1", "", ""], ["2", "very long data", "fold\nthis"]]
+    expected = "\n".join(
+        [
+            "+---+----------------+------+",
+            "| 0 |                |      |",
+            "| 1 |                |      |",
+            "| 2 | very long data | fold |",
+            "|   |                | this |",
+            "+---+----------------+------+",
+        ]
+    )
+    result = tabulate(table, tablefmt="pretty")
+    assert_equal(expected, result)
+
+
 def test_jira():
     "Output: jira with headers"
     expected = "\n".join(
