Merge pull request piccolo-orm#100 from piccolo-orm/command_aliases

Added aliases for CLI commands

Author: dantownsend

piccolo/apps/app/piccolo_app.py

@@ -1,8 +1,13 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.new import new
 from .commands.show_all import show_all
 
 
 APP_CONFIG = AppConfig(
-    app_name="app", migrations_folder_path="", commands=[new, show_all]
+    app_name="app",
+    migrations_folder_path="",
+    commands=[
+        Command(callable=new, aliases=["create"]),
+        Command(callable=show_all, aliases=["show", "all", "list"]),
+    ],
 )

piccolo/apps/asgi/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.new import new
 
 
 APP_CONFIG = AppConfig(
-    app_name="asgi", migrations_folder_path="", commands=[new]
+    app_name="asgi",
+    migrations_folder_path="",
+    commands=[Command(callable=new, aliases=["create"])],
 )

piccolo/apps/meta/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.version import version
 
 
 APP_CONFIG = AppConfig(
-    app_name="meta", migrations_folder_path="", commands=[version]
+    app_name="meta",
+    migrations_folder_path="",
+    commands=[Command(callable=version, aliases=["v"])],
 )

piccolo/apps/migrations/piccolo_app.py

@@ -1,4 +1,4 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.backwards import backwards
 from .commands.check import check
 from .commands.clean import clean
@@ -9,5 +9,11 @@
 APP_CONFIG = AppConfig(
     app_name="migrations",
     migrations_folder_path="",
-    commands=[backwards, check, clean, forwards, new],
+    commands=[
+        Command(callable=backwards, aliases=["b", "back", "backward"]),
+        Command(callable=check),
+        Command(callable=clean),
+        Command(callable=forwards, aliases=["f", "forward"]),
+        Command(callable=new, aliases=["n", "create"]),
+    ],
 )

piccolo/apps/playground/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.run import run
 
 
 APP_CONFIG = AppConfig(
-    app_name="playground", migrations_folder_path="", commands=[run]
+    app_name="playground",
+    migrations_folder_path="",
+    commands=[Command(callable=run, aliases=["start"])],
 )

piccolo/apps/project/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.new import new
 
 
 APP_CONFIG = AppConfig(
-    app_name="project", migrations_folder_path="", commands=[new]
+    app_name="project",
+    migrations_folder_path="",
+    commands=[Command(callable=new, aliases=["create"])],
 )

piccolo/apps/shell/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.run import run
 
 
 APP_CONFIG = AppConfig(
-    app_name="shell", migrations_folder_path="", commands=[run]
+    app_name="shell",
+    migrations_folder_path="",
+    commands=[Command(callable=run, aliases=["start"])],
 )

piccolo/apps/sql_shell/piccolo_app.py

@@ -1,7 +1,9 @@
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.run import run
 
 
 APP_CONFIG = AppConfig(
-    app_name="sql_shell", migrations_folder_path="", commands=[run]
+    app_name="sql_shell",
+    migrations_folder_path="",
+    commands=[Command(callable=run, aliases=["start"])],
 )

piccolo/apps/user/piccolo_app.py

@@ -1,6 +1,6 @@
 import os
 
-from piccolo.conf.apps import AppConfig
+from piccolo.conf.apps import AppConfig, Command
 from .commands.change_password import change_password
 from .commands.change_permissions import change_permissions
 from .commands.create import create
@@ -17,5 +17,9 @@
     ),
     table_classes=[BaseUser],
     migration_dependencies=[],
-    commands=[create, change_password, change_permissions],
+    commands=[
+        Command(callable=create, aliases=["new"]),
+        Command(callable=change_password, aliases=["password", "pass"]),
+        Command(callable=change_permissions, aliases=["perm", "perms"]),
+    ],
 )

piccolo/conf/apps.py

@@ -84,6 +84,12 @@ def table_finder(
     return table_subclasses
 
 
+@dataclass
+class Command:
+    callable: t.Callable
+    aliases: t.List[str] = field(default_factory=list)
+
+
 @dataclass
 class AppConfig:
     """
@@ -94,7 +100,14 @@ class AppConfig:
     migrations_folder_path: str
     table_classes: t.List[t.Type[Table]] = field(default_factory=list)
     migration_dependencies: t.List[str] = field(default_factory=list)
-    commands: t.List[t.Callable] = field(default_factory=list)
+    commands: t.List[t.Union[t.Callable, Command]] = field(
+        default_factory=list
+    )
+
+    def __post_init__(self):
+        self.commands = [
+            i if isinstance(i, Command) else Command(i) for i in self.commands
+        ]
 
     def register_table(self, table_class: t.Type[Table]):
         self.table_classes.append(table_class)