Added support for click commands

Author: eadwinCode

ellar_cli/main.py

@@ -2,23 +2,25 @@
 import sys
 import typing as t
 
+import click
 import typer
 from ellar.common.commands import EllarTyper
 from ellar.common.constants import CALLABLE_COMMAND_INFO, MODULE_METADATA
 from ellar.core.factory import AppFactory
 from ellar.core.modules import ModuleSetup
 from ellar.core.services import Reflector
-from typer import Typer
 from typer.models import CommandInfo
 
 from ellar_cli.constants import ELLAR_META
 
 from .manage_commands import create_module, create_project, new_command, runserver
 from .service import EllarCLIService
+from .typer import EllarCLITyper
 
 __all__ = ["build_typers", "_typer", "typer_callback"]
 
-_typer = Typer(name="ellar")
+
+_typer = EllarCLITyper(name="ellar")
 _typer.command(name="new")(new_command)
 _typer.command()(runserver)
 _typer.command(name="create-project")(create_project)
@@ -41,21 +43,20 @@ def typer_callback(
     ctx.meta[ELLAR_META] = meta_
 
 
-def build_typers() -> t.Any:
+def build_typers() -> t.Any:  # pragma: no cover
+    app_name: t.Optional[str] = None
     try:
+        argv = list(sys.argv)
         options, args = getopt.getopt(
-            sys.argv[1:],
-            "p:",
+            argv[1:],
+            "hp:",
             ["project=", "help"],
         )
-        app_name: t.Optional[str] = None
-
         for k, v in options:
             if k in ["-p", "--project"] and v:
                 app_name = v
-    except Exception:
-        typer.Abort()
-        return 1
+    except Exception as ex:
+        click.echo(ex)
 
     meta_: t.Optional[EllarCLIService] = EllarCLIService.import_project_meta(app_name)
 
@@ -77,3 +78,5 @@ def build_typers() -> t.Any:
                         CALLABLE_COMMAND_INFO
                     ]
                     _typer.registered_commands.append(command_info)
+                elif isinstance(typer_command, click.Command):
+                    _typer.add_click_command(typer_command)

ellar_cli/manage_commands/create_project.py

@@ -57,7 +57,7 @@ def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
         _prefix = f"{self.prefix}." if self.prefix else ""
         template_context = {
             "project_name": working_project_name,
-            "secret_key": f"ellar_{secrets.token_hex(32)}",
+            "secret_key": f"ellar_{secrets.token_urlsafe(32)}",
             "config_prefix": _prefix,
         }
         return template_context

ellar_cli/typer.py

@@ -0,0 +1,55 @@
+import sys
+import typing as t
+from dataclasses import dataclass
+
+import click
+from typer import Typer
+from typer.main import _typer_developer_exception_attr_name, except_hook, get_command
+from typer.models import DeveloperExceptionConfig
+
+
+@dataclass
+class _TyperClickCommand:
+    command: click.Command
+    name: t.Optional[str]
+
+
+class EllarCLITyper(Typer):
+    """
+    Adapting Typer and Click Commands
+    """
+
+    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._click_commands: t.List[_TyperClickCommand] = []
+
+    def add_click_command(
+        self, cmd: click.Command, name: t.Optional[str] = None
+    ) -> None:
+        self._click_commands.append(_TyperClickCommand(command=cmd, name=name))
+
+    def __call__(self, *args: t.Any, **kwargs: t.Any) -> t.Any:
+        if sys.excepthook != except_hook:
+            sys.excepthook = except_hook  # type: ignore[assignment]
+        try:
+            typer_click_commands = get_command(self)
+            for item in self._click_commands:
+                typer_click_commands.add_command(item.command, item.name)  # type: ignore[attr-defined]
+            return typer_click_commands(*args, **kwargs)
+        except Exception as e:
+            # Set a custom attribute to tell the hook to show nice exceptions for user
+            # code. An alternative/first implementation was a custom exception with
+            # raise custom_exc from e
+            # but that means the last error shown is the custom exception, not the
+            # actual error. This trick improves developer experience by showing the
+            # actual error last.
+            setattr(
+                e,
+                _typer_developer_exception_attr_name,
+                DeveloperExceptionConfig(
+                    pretty_exceptions_enable=self.pretty_exceptions_enable,
+                    pretty_exceptions_show_locals=self.pretty_exceptions_show_locals,
+                    pretty_exceptions_short=self.pretty_exceptions_short,
+                ),
+            )
+            raise e

tests/sample_app/example_project/commands.py

@@ -1,3 +1,4 @@
+import click
 from ellar.common import EllarTyper, command
 
 db = EllarTyper(name="db")
@@ -13,3 +14,8 @@ def create_migration():
 def whatever_you_want():
     """Whatever you want"""
     print("Whatever you want command")
+
+
+@click.command()
+def say_hello():
+    click.echo("Hello from ellar.")

tests/sample_app/example_project/root_module.py

@@ -2,10 +2,10 @@
 from ellar.core import ModuleBase
 from ellar.core.connection import Request
 
-from .commands import db, whatever_you_want
+from .commands import db, say_hello, whatever_you_want
 
 
-@Module(commands=[db, whatever_you_want])
+@Module(commands=[db, whatever_you_want, say_hello])
 class ApplicationModule(ModuleBase):
     @exception_handler(404)
     def exception_404_handler(cls, request: Request, exc: Exception) -> Response:

tests/test_build_typers.py

@@ -40,11 +40,11 @@ def test_build_typers_command_for_specific_project_works():
     os.chdir(sample_app_path)
 
     result = subprocess.run(
-        ["ellar", "-p", "example_project_2", "whatever-you-want"],
+        ["ellar", "-p", "example_project", "whatever-you-want"],
         stdout=subprocess.PIPE,
     )
     assert result.returncode == 0
-    assert result.stdout == b"Whatever you want command from example_project_2\n"
+    assert result.stdout == b"Whatever you want command\n"
 
     result = subprocess.run(
         ["ellar", "-p", "example_project_2", "whatever-you-want"],
@@ -68,3 +68,11 @@ def test_help_command(cli_runner):
         ["ellar", "-p", "example_project_2", "--help"], stdout=subprocess.PIPE
     )
     assert result.returncode == 0
+
+
+def test_click_command_works(cli_runner):
+    os.chdir(sample_app_path)
+    result = subprocess.run(["ellar", "say-hello"], stdout=subprocess.PIPE)
+    assert result.returncode == 0
+
+    assert result.stdout == b"Hello from ellar.\n"