Merge pull request astanin#115 from krishvk/master

astanin · web-flow · commit 431b9de86b13 · 2022-06-22T13:40:33.000Z
Support intfmt - Closes astanin#24
diff --git a/README.md b/README.md
@@ -569,6 +569,14 @@ column, in which case every column may have different number formatting:
     0.1  0.123  0.12345
     ---  -----  -------
 
+`intfmt` works similarly for integers
+
+    >>> print(tabulate([["a",1000],["b",90000]], intfmt=","))
+    -  ------
+    a   1,000
+    b  90,000
+    -  ------
+
 ### Text formatting
 
 By default, `tabulate` removes leading and trailing whitespace from text
@@ -783,6 +791,7 @@ Usage of the command line utility
     -o FILE, --output FILE    print table to FILE (default: stdout)
     -s REGEXP, --sep REGEXP   use a custom column separator (default: whitespace)
     -F FPFMT, --float FPFMT   floating point number format (default: g)
+    -I INTFMT, --int INTFMT   integer point number format (default: "")
     -f FMT, --format FMT      set output table format; supported formats:
                               plain, simple, github, grid, fancy_grid, pipe,
                               orgtbl, rst, mediawiki, html, latex, latex_raw,
diff --git a/tabulate.py b/tabulate.py
@@ -32,6 +32,7 @@ def _is_file(f):
 PRESERVE_WHITESPACE = False
 
 _DEFAULT_FLOATFMT = "g"
+_DEFAULT_INTFMT = ""
 _DEFAULT_MISSINGVAL = ""
 # default align will be overwritten by "left", "center" or "decimal"
 # depending on the formatter
@@ -1032,7 +1033,7 @@ def _column_type(strings, has_invisible=True, numparse=True):
     return reduce(_more_generic, types, bool)
 
 
-def _format(val, valtype, floatfmt, missingval="", has_invisible=True):
+def _format(val, valtype, floatfmt, intfmt, missingval="", has_invisible=True):
     """Format a value according to its type.
 
     Unicode is supported:
@@ -1047,8 +1048,10 @@ def _format(val, valtype, floatfmt, missingval="", has_invisible=True):
     if val is None:
         return missingval
 
-    if valtype in [int, str]:
+    if valtype is str:
         return f"{val}"
+    elif valtype is int:
+        return format(val, intfmt)
     elif valtype is bytes:
         try:
             return str(val, "ascii")
@@ -1324,6 +1327,7 @@ def tabulate(
     headers=(),
     tablefmt="simple",
     floatfmt=_DEFAULT_FLOATFMT,
+    intfmt=_DEFAULT_INTFMT,
     numalign=_DEFAULT_ALIGN,
     stralign=_DEFAULT_ALIGN,
     missingval=_DEFAULT_MISSINGVAL,
@@ -1398,6 +1402,10 @@ def tabulate(
     Table formats
     -------------
 
+    `intfmt` is a format specification used for columns which
+    contain numeric data without a decimal point. This can also be
+    a list or tuple of format strings, one per column.
+
     `floatfmt` is a format specification used for columns which
     contain numeric data with a decimal point. This can also be
     a list or tuple of format strings, one per column.
@@ -1843,15 +1851,25 @@ def tabulate(
         float_formats = list(floatfmt)
         if len(float_formats) < len(cols):
             float_formats.extend((len(cols) - len(float_formats)) * [_DEFAULT_FLOATFMT])
+    if isinstance(intfmt, str):  # old version
+        int_formats = len(cols) * [
+            intfmt
+        ]  # just duplicate the string to use in each column
+    else:  # if intfmt is list, tuple etc we have one per column
+        int_formats = list(intfmt)
+        if len(int_formats) < len(cols):
+            int_formats.extend((len(cols) - len(int_formats)) * [_DEFAULT_INTFMT])
     if isinstance(missingval, str):
         missing_vals = len(cols) * [missingval]
     else:
         missing_vals = list(missingval)
         if len(missing_vals) < len(cols):
             missing_vals.extend((len(cols) - len(missing_vals)) * [_DEFAULT_MISSINGVAL])
     cols = [
-        [_format(v, ct, fl_fmt, miss_v, has_invisible) for v in c]
-        for c, ct, fl_fmt, miss_v in zip(cols, coltypes, float_formats, missing_vals)
+        [_format(v, ct, fl_fmt, int_fmt, miss_v, has_invisible) for v in c]
+        for c, ct, fl_fmt, int_fmt, miss_v in zip(
+            cols, coltypes, float_formats, int_formats, missing_vals
+        )
     ]
 
     # align columns
@@ -2266,6 +2284,7 @@ def _main():
     -o FILE, --output FILE    print table to FILE (default: stdout)
     -s REGEXP, --sep REGEXP   use a custom column separator (default: whitespace)
     -F FPFMT, --float FPFMT   floating point number format (default: g)
+    -I INTFMT, --int INTFMT   integer point number format (default: "")
     -f FMT, --format FMT      set output table format; supported formats:
                               plain, simple, grid, fancy_grid, pipe, orgtbl,
                               rst, mediawiki, html, latex, latex_raw,
@@ -2281,14 +2300,15 @@ def _main():
         opts, args = getopt.getopt(
             sys.argv[1:],
             "h1o:s:F:A:f:",
-            ["help", "header", "output", "sep=", "float=", "align=", "format="],
+            ["help", "header", "output", "sep=", "float=", "int=", "align=", "format="],
         )
     except getopt.GetoptError as e:
         print(e)
         print(usage)
         sys.exit(2)
     headers = []
     floatfmt = _DEFAULT_FLOATFMT
+    intfmt = _DEFAULT_INTFMT
     colalign = None
     tablefmt = "simple"
     sep = r"\s+"
@@ -2300,6 +2320,8 @@ def _main():
             outfile = value
         elif opt in ["-F", "--float"]:
             floatfmt = value
+        elif opt in ["-I", "--int"]:
+            intfmt = value
         elif opt in ["-C", "--colalign"]:
             colalign = value.split()
         elif opt in ["-f", "--format"]:
@@ -2325,6 +2347,7 @@ def _main():
                     tablefmt=tablefmt,
                     sep=sep,
                     floatfmt=floatfmt,
+                    intfmt=intfmt,
                     file=out,
                     colalign=colalign,
                 )
@@ -2336,16 +2359,17 @@ def _main():
                         tablefmt=tablefmt,
                         sep=sep,
                         floatfmt=floatfmt,
+                        intfmt=intfmt,
                         file=out,
                         colalign=colalign,
                     )
 
 
-def _pprint_file(fobject, headers, tablefmt, sep, floatfmt, file, colalign):
+def _pprint_file(fobject, headers, tablefmt, sep, floatfmt, intfmt, file, colalign):
     rows = fobject.readlines()
     table = [re.split(sep, r.rstrip()) for r in rows if r.strip()]
     print(
-        tabulate(table, headers, tablefmt, floatfmt=floatfmt, colalign=colalign),
+        tabulate(table, headers, tablefmt, floatfmt=floatfmt, intfmt=intfmt, colalign=colalign),
         file=file,
     )
 
diff --git a/test/test_api.py b/test/test_api.py
@@ -42,6 +42,7 @@ def test_tabulate_signature():
         ("headers", ()),
         ("tablefmt", "simple"),
         ("floatfmt", "g"),
+        ("intfmt", ""),
         ("numalign", "default"),
         ("stralign", "default"),
         ("missingval", ""),
diff --git a/test/test_output.py b/test/test_output.py
@@ -2110,6 +2110,13 @@ def test_empty_data_without_headers():
     assert_equal(expected, result)
 
 
+def test_intfmt():
+    "Output: integer format"
+    result = tabulate([[10000], [10]], intfmt=",", tablefmt="plain")
+    expected = "10,000\n    10"
+    assert_equal(expected, result)
+
+
 def test_empty_data_with_headers():
     "Output: table with empty data and headers as firstrow"
     expected = ""
