fixed runserver command

Author: eadwinCode

ellar_cli/click/util.py

@@ -5,7 +5,7 @@
 import click
 from ellar.threading import execute_coroutine_with_sync_worker
 
-from ellar_cli.constants import ELLAR_META, ELLAR_PROJECT_NAME
+from ellar_cli.constants import ELLAR_META
 from ellar_cli.service import EllarCLIService
 
 
@@ -52,9 +52,6 @@ async def _run_with_application_context(
 
     @click.pass_context
     def decorator(__ctx: click.Context, *args: t.Any, **kwargs: t.Any) -> t.Any:
-        meta_: t.Optional[EllarCLIService] = EllarCLIService.import_project_meta(
-            __ctx.meta.get(ELLAR_PROJECT_NAME)
-        )
         meta_ = __ctx.meta.get(ELLAR_META)
 
         def _get_command_args(*ar: t.Any, **kw: t.Any) -> t.Any:

ellar_cli/main.py

@@ -51,6 +51,8 @@ def app_cli(ctx: click.Context, project: str) -> None:
 
 
 app_cli.command(name="new")(new_command)
-app_cli.command(context_settings={"auto_envvar_prefix": "UVICORN"})(runserver)
+app_cli.command(
+    context_settings={"auto_envvar_prefix": "UVICORN"}, with_app_context=False
+)(runserver)
 app_cli.command(name="create-project")(create_project)
 app_cli.command(name="create-module")(create_module)

ellar_cli/manage_commands/runserver.py

@@ -4,7 +4,7 @@
 import typing as t
 from datetime import datetime
 
-import ellar
+from ellar import __version__ as ellar_version
 from ellar.app import current_config
 from ellar.common.utils.enums import create_enums_from_list
 from uvicorn import config as uvicorn_config
@@ -322,13 +322,6 @@
     default=None,
     help="For h11, the maximum number of bytes to buffer of an incomplete event.",
 )
-@eClick.option(
-    "--factory",
-    is_flag=True,
-    default=False,
-    help="Treat APP as an application factory, i.e. a () -> <ASGI app> callable.",
-    show_default=True,
-)
 @eClick.pass_context
 def runserver(
     ctx: eClick.Context,
@@ -376,7 +369,6 @@ def runserver(
     use_colors: bool,
     # app_dir: str,
     h11_max_incomplete_event_size: int | None,
-    factory: bool,
 ):
     """- Starts Uvicorn Server -"""
     ellar_project_meta = t.cast(t.Optional[EllarCLIService], ctx.meta.get(ELLAR_META))
@@ -389,9 +381,7 @@ def runserver(
             "No available project found. please create ellar project with `ellar create-project 'project-name'`"
         )
 
-    application_import_string = (
-        None if factory else ellar_project_meta.project_meta.application
-    )
+    application_import_string = ellar_project_meta.project_meta.application
 
     log_config = current_config.LOGGING_CONFIG
     _log_level = current_config.LOG_LEVEL
@@ -443,16 +433,15 @@ def runserver(
         "ssl_ciphers": ssl_ciphers,
         "headers": [header.split(":", 1) for header in headers],
         "use_colors": use_colors,
-        "factory": factory,
+        "factory": ellar_project_meta.is_app_callable(),
         # "app_dir": application_import_string.split(':')[0].replace('.', '/'),
     }
 
     now = datetime.now().strftime("%B %d, %Y - %X")
-    version = ellar.__version__
     print(
         f"\nStarting Uvicorn server...\n"
         f"{now}\n"
-        f"Ellar version {version}, using settings {current_config.config_module!r}\n"
+        f"Ellar version {ellar_version}, using settings {current_config.config_module!r}\n"
     )
 
     uvicorn_run(application_import_string, **init_kwargs)

ellar_cli/scaffolding/project_template/project_name/server.ellar

@@ -1,30 +1,33 @@
 import os
 
-from ellar.app import AppFactory
+from ellar.app import App, AppFactory
 from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.core import LazyModuleImport as lazyLoad
 # from ellar.openapi import OpenAPIDocumentModule, OpenAPIDocumentBuilder, SwaggerUI
 
-application = AppFactory.create_from_app_module(
-    lazyLoad("{{project_name}}.root_module:ApplicationModule"),
-    config_module=os.environ.get(
-        ELLAR_CONFIG_MODULE, "{{config_prefix}}{{project_name}}.config:DevelopmentConfig"
-    ),
-    global_guards=[]
-)
 
-# uncomment this section if you want API documentation
+def bootstrap() -> App:
+    application = AppFactory.create_from_app_module(
+        lazyLoad("{{project_name}}.root_module:ApplicationModule"),
+        config_module=os.environ.get(
+            ELLAR_CONFIG_MODULE, "{{config_prefix}}{{project_name}}.config:DevelopmentConfig"
+        ),
+        global_guards=[]
+    )
 
-# document_builder = OpenAPIDocumentBuilder()
-# document_builder.set_title('{{project_name | capitalize}} Title') \
-#     .set_version('1.0.2') \
-#     .set_contact(name='Author Name', url='https://www.author-name.com', email='[email protected]') \
-#     .set_license('MIT Licence', url='https://www.google.com')
-# 
-# document = document_builder.build_document(application)
-# module = OpenAPIDocumentModule.setup(
-#    document=document,
-#    docs_ui=SwaggerUI(),
-#    guards=[]
-# )
-# application.install_module(module)
+    # uncomment this section if you want API documentation
+
+    # document_builder = OpenAPIDocumentBuilder()
+    # document_builder.set_title('{{project_name | capitalize}} Title') \
+    #     .set_version('1.0.2') \
+    #     .set_contact(name='Author Name', url='https://www.author-name.com', email='[email protected]') \
+    #     .set_license('MIT Licence', url='https://www.google.com')
+    #
+    # document = document_builder.build_document(application)
+    # module = OpenAPIDocumentModule.setup(
+    #    document=document,
+    #    docs_ui=SwaggerUI(),
+    #    guards=[]
+    # )
+    # application.install_module(module)
+    return application

ellar_cli/service.py

@@ -1,3 +1,4 @@
+import asyncio
 import functools
 import os
 import typing as t
@@ -183,7 +184,7 @@ def create_ellar_project_meta(
         ellar_new_project = ellar_py_project.get_or_create_project(project_name.lower())
         ellar_new_project.add("project-name", project_name.lower())
         ellar_new_project.add(
-            "application", f"{_prefix}{project_name}.server:application"
+            "application", f"{_prefix}{project_name}.server:bootstrap"
         )
         ellar_new_project.add(
             "config", f"{_prefix}{project_name}.config:DevelopmentConfig"
@@ -212,11 +213,33 @@ def write_py_project(path: str, content: Table) -> None:
     def import_application(self) -> "App":
         assert self._meta
         if "App" not in self._store:
-            self._store["App"] = t.cast(
-                "App", import_from_string(self._meta.application)
-            )
+            self._store["App"] = t.cast(App, import_from_string(self._meta.application))
+
+            if not isinstance(self._store["App"], App):
+                # if its factory, we resolve the factory.
+                app_instance = self._store["App"]()
+
+                if isinstance(app_instance, t.Coroutine):
+                    raise EllarCLIException(
+                        "Coroutine Application Bootstrapping is not supported."
+                    )
+                self._store["App"] = app_instance
+
         return self._store["App"]  # type:ignore[no-any-return]
 
+    def is_app_callable(self) -> bool:
+        assert self._meta
+
+        app = import_from_string(self._meta.application)
+        res = not isinstance(app, App)
+
+        if res and asyncio.iscoroutinefunction(app):
+            raise EllarCLIException(
+                "Coroutine Application Bootstrapping is not supported."
+            )
+
+        return res
+
     def import_configuration(self) -> t.Type["Config"]:
         assert self._meta
         if "Config" not in self._store: