added test for Table._table_str

Author: dantownsend

piccolo/table.py

@@ -594,10 +594,11 @@ def _get_index_name(cls, column_names: t.List[str]) -> str:
     def _table_str(cls, abbreviated=False):
         """
         Returns a basic string representation of the table and its columns.
+        Used by the playground.
 
-        Used by the playground, and migrations.
+        :param abbreviated:
+            If True, a very high level representation is printed out.
 
-        If abbreviated, we just return a very high level representation.
         """
         spacer = "\n    "
         columns = []

tests/table/test_str.py

@@ -0,0 +1,27 @@
+from unittest import TestCase
+
+from ..example_project.tables import Manager
+
+
+class TestTableStr(TestCase):
+    def test_table_exists(self):
+        self.assertEqual(
+            Manager._table_str(),
+            (
+                "class Manager(Table, tablename='manager'):\n"
+                "    id = PrimaryKey(null=False, primary=True, key=True, unique=False, index=False)\n"  # noqa
+                "    name = Varchar(length=50, default='', null=False, primary=False, key=False, unique=False, index=False)\n"  # noqa
+            ),
+        )
+
+        self.assertEqual(
+            Manager._table_str(abbreviated=True),
+            (
+                "class Manager(Table):\n"
+                "    id = PrimaryKey()\n"
+                "    name = Varchar()\n"
+            ),
+        )
+
+        # We should also be able to print it directly.
+        print(Manager)