1.0.2: New attributes, ok and table_width.

Author: Robpol86

terminaltables.py

@@ -25,7 +25,7 @@
 
 __author__ = '@Robpol86'
 __license__ = 'MIT'
-__version__ = '1.0.1'
+__version__ = '1.0.2'
 
 DEFAULT_TERMINAL_HEIGHT = None
 DEFAULT_TERMINAL_WIDTH = None
@@ -166,7 +166,7 @@ def column_max_width(self, column_number):
         borders_padding = (len(column_widths) * self.padding_left) + (len(column_widths) * self.padding_right)
         if self.outer_border:
             borders_padding += 2
-        if self.inner_column_border:
+        if self.inner_column_border and column_widths:
             borders_padding += len(column_widths) - 1
         other_column_widths = sum(column_widths) - column_widths[column_number]
         return terminal_width() - other_column_widths - borders_padding
@@ -188,6 +188,11 @@ def column_widths(self):
 
         return widths
 
+    @property
+    def ok(self):
+        """Returns True if the table fits within the terminal width, False if the table breaks."""
+        return self.table_width <= terminal_width()
+
     @property
     def padded_table_data(self):
         """Returns a list of lists of strings. It's self.table_data but with the cells padded with spaces and newlines.
@@ -265,6 +270,17 @@ def table(self):
 
         return '\n'.join(final_table_data)
 
+    @property
+    def table_width(self):
+        """Returns the width of the table including padding and borders."""
+        column_widths = self.column_widths
+        borders_padding = (len(column_widths) * self.padding_left) + (len(column_widths) * self.padding_right)
+        if self.outer_border:
+            borders_padding += 2
+        if self.inner_column_border and column_widths:
+            borders_padding += len(column_widths) - 1
+        return sum(column_widths) + borders_padding
+
 
 class UnixTable(AsciiTable):
     """Draw a table using box-drawing characters on Unix platforms. Table borders won't have any gaps between lines.

tests/test_table_width_ok.py

@@ -0,0 +1,94 @@
+from textwrap import dedent
+
+import pytest
+
+import terminaltables
+from terminaltables import AsciiTable, UnixTable
+
+
+@pytest.mark.parametrize('cls', [AsciiTable, UnixTable])
+def test_empty(cls):
+    terminaltables.DEFAULT_TERMINAL_WIDTH = 80
+    table = cls([])
+    assert 2 == table.table_width
+    assert table.ok is True
+
+    table = cls([[]])
+    assert 2 == table.table_width
+    assert table.ok is True
+
+    table = cls([['']])
+    assert 4 == table.table_width
+    assert table.ok is True
+
+    table = cls([[' ']])
+    assert 5 == table.table_width
+    assert table.ok is True
+
+
+@pytest.mark.parametrize('cls', [AsciiTable, UnixTable])
+def test_simple(cls):
+    terminaltables.DEFAULT_TERMINAL_WIDTH = 80
+    table_data = [
+        ['Name', 'Color', 'Type'],
+        ['Avocado', 'green', 'nut'],
+        ['Tomato', 'red', 'fruit'],
+        ['Lettuce', 'green', 'vegetable'],
+    ]
+    table = cls(table_data)
+
+    assert 31 == table.table_width
+    assert table.ok is True
+
+    table_data.append(['Watermelon', 'green', 'fruit'])
+    assert 34 == table.table_width
+    assert table.ok is True
+
+    terminaltables.DEFAULT_TERMINAL_WIDTH = 34
+    assert table.ok is True
+
+    terminaltables.DEFAULT_TERMINAL_WIDTH = 33
+    assert table.ok is False
+
+
+@pytest.mark.parametrize('cls', [AsciiTable, UnixTable])
+def test_multi_line(cls):
+    terminaltables.DEFAULT_TERMINAL_WIDTH = 100
+    table_data = [
+        ['Show', 'Characters'],
+        ['Rugrats', dedent('Tommy Pickles, Chuckie Finster, Phillip DeVille, Lillian DeVille, Angelica Pickles,\n'
+                           'Susie Carmichael, Dil Pickles, Kimi Finster, Spike')],
+        ['South Park', 'Stan Marsh, Kyle Broflovski, Eric Cartman, Kenny McCormick']
+    ]
+    table = cls(table_data)
+    assert 100 == table.table_width
+    assert table.ok is True
+
+
+def test_attributes():
+    table_data = [
+        ['Name', 'Color', 'Type'],
+        ['Avocado', 'green', 'nut'],
+        ['Tomato', 'red', 'fruit'],
+        ['Lettuce', 'green', 'vegetable'],
+    ]
+    table = AsciiTable(table_data)
+
+    assert 31 == max(len(r) for r in table.table.splitlines())
+    assert 31 == table.table_width
+
+    table.outer_border = False
+    assert 29 == max(len(r) for r in table.table.splitlines())
+    assert 29 == table.table_width
+
+    table.inner_column_border = False
+    assert 27 == max(len(r) for r in table.table.splitlines())
+    assert 27 == table.table_width
+
+    table.padding_left = 0
+    assert 24 == max(len(r) for r in table.table.splitlines())
+    assert 24 == table.table_width
+
+    table.padding_right = 0
+    assert 21 == max(len(r) for r in table.table.splitlines())
+    assert 21 == table.table_width