Refactored grid classes to put them in an inheritance hierarchy with an abstract base class at the root

generate_table() now takes an instance of a Grid class for grid_style instead of a class type.

There is a global DEFAULT_GRID which can be overriden with the set_default_grid() method.

AlternatingRowGrid now takes two optional arguments in its initializer: bg_reset and bg_color for the two alternating colors.

Also:
- Added the start of a color.py example for showcasing colored output
- Updated README
- Minor formatting tweaks to the examples

Author: tleonhardt

README.md

@@ -102,7 +102,7 @@ Supported grid sytles are:
 ```Python
 from tableformatter import FancyGrid
 
-print(generate_table(rows, grid_style=FancyGrid))
+print(generate_table(rows, grid_style=FancyGrid()))
 ╔════╤════╤════╤════╗
 ║ A1 │ A2 │ A3 │ A4 ║
 ╟────┼────┼────┼────╢

examples/color.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+# coding=utf-8
+"""
+Simple demonstration of TableFormatter with some colored output.
+"""
+import tableformatter as tf
+from tableformatter import generate_table
+
+try:
+    from colorama import Back
+    BACK_RESET = Back.RESET
+    BACK_BLUE = Back.LIGHTBLUE_EX
+except ImportError:
+    try:
+        from colored import bg
+        BACK_RESET = bg(0)
+        BACK_BLUE = bg(27)
+    except ImportError:
+        BACK_RESET = ''
+        BACK_BLUE = ''
+
+rows = [('A1', 'A2', 'A3', 'A4'),
+        ('B1', 'B2\nB2\nB2', 'B3', 'B4'),
+        ('C1', 'C2', 'C3', 'C4'),
+        ('D1', 'D2', 'D3', 'D4')]
+
+columns = ('Col1', 'Col2', 'Col3', 'Col4')
+
+print("Table with colorful alternting rows")
+print(generate_table(rows, columns, grid_style=tf.AlternatingRowGrid(BACK_RESET, BACK_BLUE)))
+

examples/simple_object.py

@@ -1,14 +1,13 @@
 #!/usr/bin/env python
 # coding=utf-8
-from tableformatter import generate_table, FancyGrid, SparseGrid, Column
-
 """
 Simple demonstration of TableFormatter with a list of objects for the table entries.
-This approach requires providing the name of the object attribute to query 
-for each cell (via attrib='attrib_name'). 
+This approach requires providing the name of the object attribute to query
+for each cell (via attrib='attrib_name').
 TableFormatter will check if the attribute is callable. If it is, it wall be called
 and the returned result will be displayed for that cell.
 """
+from tableformatter import generate_table, FancyGrid, SparseGrid, Column
 
 
 class MyRowObject(object):
@@ -44,10 +43,10 @@ def get_field3(self):
 
 
 print("Table with header, transposed, FancyGrid:")
-print(generate_table(rows, columns, grid_style=FancyGrid, transpose=True))
+print(generate_table(rows, columns, grid_style=FancyGrid(), transpose=True))
 
 print("Table with header, transposed, SparseGrid:")
-print(generate_table(rows, columns, grid_style=SparseGrid, transpose=True))
+print(generate_table(rows, columns, grid_style=SparseGrid(), transpose=True))
 
 
 columns2 = (Column('Col1', attrib='field3'),

examples/simple_text.py

@@ -1,18 +1,17 @@
 #!/usr/bin/env python
 # coding=utf-8
-from tableformatter import generate_table, FancyGrid, SparseGrid
 """
 Simple demonstration of TableFormatter with a list of tuples as table entries.
 TableFormatter will automatically expand the row height to handle multi-line entries.
 """
-
+import tableformatter as tf
+from tableformatter import generate_table
 
 rows = [('A1', 'A2', 'A3', 'A4'),
         ('B1', 'B2\nB2\nB2', 'B3', 'B4'),
         ('C1', 'C2', 'C3', 'C4'),
         ('D1', 'D2', 'D3', 'D4')]
 
-
 columns = ('Col1', 'Col2', 'Col3', 'Col4')
 
 print("Basic Table, default style (AlternatingRowGrid):")
@@ -24,10 +23,10 @@
 
 
 print("Basic Table, FancyGrid:")
-print(generate_table(rows, grid_style=FancyGrid))
+print(generate_table(rows, grid_style=tf.FancyGrid()))
 
 print("Basic Table, SparseGrid:")
-print(generate_table(rows, grid_style=SparseGrid))
+print(generate_table(rows, grid_style=tf.SparseGrid()))
 
 print("Table with header, AlteratingRowGrid:")
 print(generate_table(rows, columns))
@@ -38,7 +37,7 @@
 
 
 print("Table with header, transposed, FancyGrid:")
-print(generate_table(rows, columns, grid_style=FancyGrid, transpose=True))
+print(generate_table(rows, columns, grid_style=tf.FancyGrid(), transpose=True))
 
 print("Table with header, transposed, SparseGrid:")
-print(generate_table(rows, columns, grid_style=SparseGrid, transpose=True))
+print(generate_table(rows, columns, grid_style=tf.SparseGrid(), transpose=True))