Demonstation of setting per-row text color. Added new Row definition function to mirror Column definition function.

Author: anselor

examples/rows.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python
+# coding=utf-8
+"""
+Demonstration of per-row customizations (currently only text foreground color)
+Also demonstrates use of object formatter with both tuple-based and object-base row entries
+"""
+import tableformatter as tf
+
+
+class MyRowObject(object):
+    """Simple object to demonstrate using a list of objects with TableFormatter"""
+    def __init__(self, field1: str, field2: str, field3: int, field4: int):
+        self.field1 = field1
+        self.field2 = field2
+        self._field3 = field3
+        self.field4 = field4
+
+    def get_field3(self):
+        """Demonstrates accessing object functions"""
+        return self._field3
+
+
+def multiply(row_obj: MyRowObject):
+    """Demonstrates an object formatter function"""
+    return str(row_obj.get_field3() * row_obj.field4)
+
+
+def multiply_tuple(row_obj):
+    """Demonstrates an object formatter function"""
+    return str(row_obj[2] * row_obj[3])
+
+
+def int2word(num, separator="-"):
+    """Demonstrates a field formatter function
+    From: https://codereview.stackexchange.com/questions/156590/create-the-english-word-for-a-number
+    """
+    ones_and_teens = {0: "Zero", 1: 'One', 2: 'Two', 3: 'Three',
+                      4: 'Four', 5: 'Five', 6: 'Six', 7: 'Seven',
+                      8: 'Eight', 9: 'Nine', 10: 'Ten', 11: 'Eleven',
+                      12: 'Twelve', 13: 'Thirteen', 14: 'Fourteen',
+                      15: 'Fifteen', 16: 'Sixteen', 17: 'Seventeen',
+                      18: 'Eighteen', 19: 'Nineteen'}
+    twenty2ninety = {2: 'Twenty', 3: 'Thirty', 4: 'Forty', 5: 'Fifty',
+                     6: 'Sixty', 7: 'Seventy', 8: 'Eighty', 9: 'Ninety', 0: ""}
+
+    if 0 <= num < 19:
+        return ones_and_teens[num]
+    elif 20 <= num <= 99:
+        tens, below_ten = divmod(num, 10)
+        if below_ten > 0:
+            words = twenty2ninety[tens] + separator + \
+                ones_and_teens[below_ten].lower()
+        else:
+            words = twenty2ninety[tens]
+        return words
+
+    elif 100 <= num <= 999:
+        hundreds, below_hundred = divmod(num, 100)
+        tens, below_ten = divmod(below_hundred, 10)
+        if below_hundred == 0:
+            words = ones_and_teens[hundreds] + separator + "hundred"
+        elif below_ten == 0:
+            words = ones_and_teens[hundreds] + separator + \
+                "hundred" + separator + twenty2ninety[tens].lower()
+        else:
+            if tens > 0:
+                words = ones_and_teens[hundreds] + separator + "hundred" + separator + twenty2ninety[
+                    tens].lower() + separator + ones_and_teens[below_ten].lower()
+            else:
+                words = ones_and_teens[
+                    hundreds] + separator + "hundred" + separator + ones_and_teens[below_ten].lower()
+        return words
+
+    else:
+        print("num out of range")
+
+
+rows = [tf.Row(MyRowObject('Longer text that will trigger the column wrapping', 'A2', 5, 56),
+               text_color=tf.TableColors.TEXT_COLOR_RED),
+        tf.Row(MyRowObject('B1', 'B2\nB2\nB2', 23, 8),
+               text_color=tf.TableColors.TEXT_COLOR_GREEN),
+        MyRowObject('C1', 'C2', 4, 9),
+        MyRowObject('D1', 'D2', 7, 5)]
+
+
+columns = (tf.Column('First', width=20, attrib='field1'),
+           tf.Column('Second', attrib='field2'),
+           tf.Column('Num 1', width=3, attrib='get_field3'),
+           tf.Column('Num 2', attrib='field4'),
+           tf.Column('Multiplied', obj_formatter=multiply))
+print("Per-row customizations with object-based row entries")
+print(tf.generate_table(rows, columns))
+
+
+rows = [tf.Row('Longer text that will trigger the column wrapping', 'A2', 5, 56, None,
+               text_color=tf.TableColors.TEXT_COLOR_RED),
+        tf.Row('B1', 'B2\nB2\nB2', 23, 8, None,
+               text_color=tf.TableColors.TEXT_COLOR_GREEN),
+        ('C1', 'C2', 4, 9, None),
+        ('D1', 'D2', 7, 5, None)]
+
+
+columns = (tf.Column('First', width=20, wrap_mode=tf.WrapMode.TRUNCATE_HARD),
+           tf.Column('Second'),
+           tf.Column('Num 1'),
+           tf.Column('Num 2', formatter=int2word),
+           tf.Column('Multiplied', obj_formatter=multiply_tuple))
+
+
+print("Per-row customizations with tuple-based row entries")
+print(tf.generate_table(rows, columns))

tableformatter.py

@@ -683,6 +683,24 @@ def Column(col_name: str,
         return col_name, opts
 
 
+def Row(*args, text_color: TableColors=None):
+    """
+    Processes row options and generates a tuple in the format the TableFormatter expects
+    :param args: Can be either 1 object or a list of values
+    :param text_color: text color to use when displaying this row
+    :return: Tuple formatted for the TableFormatter to consume
+    """
+    opts = dict()
+
+    if text_color is not None:
+        opts[TableFormatter.ROW_OPT_TEXT_COLOR] = text_color
+
+    row = list(args)
+    if opts:
+        row.append(opts)
+    return tuple(row)
+
+
 class TableFormatter(object):
     """
     Simple implementation of an ascii table formatter.
@@ -926,7 +944,10 @@ def generate_table(self, entries: List[Iterable], force_transpose=False):
                     # skip extra values beyond the columns configured
                     if column_index < len(self._columns):
                         formatter = self._get_column_option(column_index, TableFormatter.COL_OPT_FIELD_FORMATTER)
-                        if formatter is not None and callable(formatter):
+                        obj_formatter = self._get_column_option(column_index, TableFormatter.COL_OPT_OBJECT_FORMATTER)
+                        if obj_formatter is not None and callable(obj_formatter):
+                            field_string = obj_formatter(entry)
+                        elif formatter is not None and callable(formatter):
                             field_string = formatter(field, )
                         elif isinstance(field, str):
                             field_string = field