Merge pull request piccolo-orm#78 from piccolo-orm/table_help_text

Table help text

Author: dantownsend

piccolo/table.py

@@ -52,6 +52,7 @@ class TableMeta:
     non_default_columns: t.List[Column] = field(default_factory=list)
     foreign_key_columns: t.List[ForeignKey] = field(default_factory=list)
     tags: t.List[str] = field(default_factory=list)
+    help_text: t.Optional[str] = None
     _db: t.Optional[Engine] = None
 
     # Records reverse foreign key relationships - i.e. when the current table
@@ -124,6 +125,7 @@ def __init_subclass__(
         tablename: t.Optional[str] = None,
         db: t.Optional[Engine] = None,
         tags: t.List[str] = [],
+        help_text: t.Optional[str] = None,
     ):
         """
         Automatically populate the _meta, which includes the tablename, and
@@ -138,6 +140,10 @@ def __init_subclass__(
             imported from piccolo_conf.py using ``engine_finder``.
         :param tags:
             Used for filtering, for example by ``table_finder``.
+        :param help_text:
+            A user friendly description of what the table is used for. It isn't
+            used in the database, but will be used by tools such a Piccolo
+            Admin for tooltips.
 
         """
         tablename = tablename if tablename else _camel_to_snake(cls.__name__)
@@ -189,6 +195,7 @@ def __init_subclass__(
             non_default_columns=non_default_columns,
             foreign_key_columns=foreign_key_columns,
             tags=tags,
+            help_text=help_text,
             _db=db,
         )
 

tests/table/test_instance.py tests/table/instance/test_instantiate.pytests/table/test_instance.py renamed to tests/table/instance/test_instantiate.py

@@ -1,5 +1,5 @@
-from ..base import DBTestCase, sqlite_only, postgres_only
-from ..example_app.tables import Band
+from tests.base import DBTestCase, sqlite_only, postgres_only
+from tests.example_app.tables import Band
 
 
 class TestInstance(DBTestCase):

tests/table/test_metaclass.py

@@ -23,3 +23,14 @@ class User(Table):
 
             class MyUser(Table, tablename="user"):
                 pass
+
+    def test_help_text(self):
+        """
+        Make sure help_text can be set for the Table.
+        """
+        help_text = "The manager of a band."
+
+        class Manager(Table, help_text=help_text):
+            pass
+
+        self.assertEqual(Manager._meta.help_text, help_text)