port lilya #269 to esmerald (path option instead of argument) (#594)

* port lilya #269 to esmerald (path option instead of argument)
* fix crypto imports
* don't fail on missing lifespan
---------

Co-authored-by: tarsil <tiago.arasilva@gmail.com>

Author: devkral

docs/en/docs/release-notes.md

@@ -5,23 +5,33 @@ hide:
 
 # Release Notes
 
-## 3.8.12
+## 3.9.0
+
+### Changed
+
+- Morph path argument into path option and expose it for all commands.
 
 ### Fixed
 
+- Properly detect wrapped Esmerald instances.
+- Fix double initialization of app in runserver.
 - Fix crash in runserver when no autodiscovery.
 
 ### Internal
 
 - Add the new `format` in the `Taskfile` and `pyproject.toml`.
 
+### Breaking
+
+- `esmerald runserver` loses its path argument. You can specify it via `esmerald --path foo runserver`.
+
 ## 3.8.11
 
 ### Added
 
 - `--version` attribute when running `createapp` directive allowing to generate a versioned scaffold.
 - `--location` attribute when using `createapp` and `createproject` directive allowing to specify the location to be created.
-  
+
 ### Changed
 
 - To make Esmerald lighter and simpler, the some minimal changes for the `SessionMiddleware` import were added.

esmerald/__init__.py

@@ -2,7 +2,7 @@
 
 from monkay import Monkay
 
-__version__ = "3.8.11"
+__version__ = "3.9.0"
 
 if TYPE_CHECKING:
     from lilya import status

esmerald/applications.py

@@ -14,15 +14,17 @@
 )
 
 from lilya.apps import BaseLilya
-from lilya.conf import _monkay  # noqa
+from lilya.conf import _monkay as monkay
 from lilya.logging import setup_logging
 from lilya.middleware import DefineMiddleware  # noqa
 from lilya.types import Lifespan, Receive, Scope, Send
 from monkay import load
 from pydantic import AnyUrl, ValidationError
 from typing_extensions import Annotated, Doc
 
-from esmerald.conf import monkay as monkay_for_settings
+from esmerald.conf import (
+    monkay as monkay_for_settings,
+)
 from esmerald.conf.global_settings import EsmeraldSettings
 from esmerald.contrib.schedulers.base import SchedulerConfig
 from esmerald.core.config import (
@@ -1767,7 +1769,7 @@ def extend(self, config: PluggableConfig) -> None:
         )
         self.get_default_exception_handlers()
         if self.register_as_global_instance:
-            _monkay.set_instance(self)
+            monkay.set_instance(self)
         self.user_middleware = self.build_user_middleware_stack()
         self.middleware_stack = self.build_middleware_stack()
         self.template_engine = self.get_template_engine(self.template_config)
@@ -2514,7 +2516,7 @@ async def hello(self) -> str:
                         dependencies=route.dependencies,
                         exception_handlers=route.exception_handlers,
                         name=route.name,
-                        middleware=cast("list[Middleware]", route.middleware),
+                        middleware=route.middleware,
                         interceptors=route.interceptors,
                         permissions=route.permissions,
                         routes=cast("Sequence[Union[APIGateHandler, Include]]", route.routes),

esmerald/core/directives/cli.py

@@ -76,7 +76,8 @@ def invoke(self, ctx: click.Context) -> typing.Any:
         Directives can be ignored depending of the functionality from what is being
         called.
         """
-        path = ctx.params.get("app", None)
+        app = ctx.params.get("app", None)
+        path = ctx.params.get("path", None)
 
         # Process any settings
         self.process_settings(ctx)
@@ -86,7 +87,7 @@ def invoke(self, ctx: click.Context) -> typing.Any:
         ):
             try:
                 directive = DirectiveEnv()
-                app_env = directive.load_from_env(path=path)
+                app_env = directive.load_from_env(path=app, cwd=path)
                 ctx.obj = app_env
             except OSError as e:
                 if not any(value in sys.argv for value in IGNORE_DIRECTIVES):
@@ -129,6 +130,13 @@ def esmerald_callback(
             help="Module path to the Esmerald application. In a module:path format.",
         ),
     ],
+    path: typing.Annotated[
+        str | None,
+        Option(
+            required=False,
+            help="A path to a Python file or package directory with ([blue]__init__.py[/blue] files) containing a [bold]Lilya[/bold] app. If not provided, Lilya will try to discover.",
+        ),
+    ],
 ) -> None: ...
 
 

esmerald/core/directives/env.py

@@ -5,13 +5,15 @@
 from pathlib import Path
 
 from esmerald import ChildEsmerald, Esmerald
+from esmerald.conf import monkay
 from esmerald.core.directives.constants import (
     DISCOVERY_ATTRS,
     DISCOVERY_FILES,
     DISCOVERY_FUNCTIONS,
     ESMERALD_DISCOVER_APP,
 )
 from esmerald.core.terminal import Print
+from esmerald.types import ASGIApp
 
 printer = Print()
 
@@ -25,7 +27,8 @@ class Scaffold:
     """
 
     path: str
-    app: Esmerald | ChildEsmerald
+    app: ASGIApp
+    esmerald_app: Esmerald | ChildEsmerald | None = None
     app_location: Path | None = None
     discovery_file: str | None = None
 
@@ -46,17 +49,23 @@ class DirectiveEnv:
     """
 
     path: str | None = None
-    app: Esmerald | ChildEsmerald | None = None
+    app: ASGIApp | None = None
+    esmerald_app: Esmerald | ChildEsmerald | None = None
     command_path: str | None = None
     module_info: ModuleInfo | None = None
 
-    def load_from_env(self, path: str | None = None) -> "DirectiveEnv":
+    def load_from_env(
+        self, path: str | None = None, cwd: None | str | Path = None
+    ) -> "DirectiveEnv":
         """
         Loads the environment variables into the scaffold.
         """
         # Adds the current path where the command is being invoked
         # To the system path
-        cwd = Path().cwd()
+        if cwd is None:
+            cwd = Path.cwd()
+        if not isinstance(cwd, Path):
+            cwd = Path(cwd)
         command_path = str(cwd)
         if command_path not in sys.path:
             sys.path.append(command_path)
@@ -73,6 +82,7 @@ def load_from_env(self, path: str | None = None) -> "DirectiveEnv":
         return DirectiveEnv(
             path=_app.path,
             app=_app.app,
+            esmerald_app=_app.esmerald_app,
             command_path=command_path,
             module_info=self.get_module_data_from_path(
                 _app.app_location, _app.path, _app.discovery_file
@@ -131,7 +141,12 @@ def import_app_from_string(cls, path: str | None = None) -> Scaffold:
         module_str_path, app_name = path.split(":")
         module = import_module(module_str_path)
         app = getattr(module, app_name)
-        return Scaffold(path=path, app=app)
+
+        if isinstance(app, Esmerald):
+            esmerald = app
+        else:
+            esmerald = monkay.instance
+        return Scaffold(path=path, app=app, esmerald_app=esmerald)
 
     def _get_folders(self, path: Path) -> list[str]:
         """
@@ -154,35 +169,52 @@ def _find_app_in_folder(self, path: Path, cwd: Path) -> Scaffold | None:
             # Load file from module
             module = import_module(dotted_path)
 
-            # FIrst check some attrs
-            for attr in DISCOVERY_ATTRS:
-                value = getattr(module, attr, None)
-                if value:
+            # Iterates through the elements of the module.
+            for attr, value in module.__dict__.items():
+                if isinstance(value, Esmerald):
                     app_path = f"{dotted_path}:{attr}"
                     return Scaffold(
                         app=value,
+                        esmerald_app=value,
                         path=app_path,
                         app_location=path,
                         discovery_file=discovery_file,
                     )
 
-            # Iterates through the elements of the module.
-            for attr, value in module.__dict__.items():
-                if isinstance(value, Esmerald):
-                    app_path = f"{dotted_path}:{attr}"
-                    return Scaffold(app=value, path=app_path)
+            # Is registered
+            if isinstance((esmerald_instance := monkay.instance), Esmerald):
+                for attr in DISCOVERY_ATTRS:
+                    if (value := getattr(module, attr, None)) is not None:
+                        app_path = f"{dotted_path}:{attr}"
+                        return Scaffold(
+                            app=value,
+                            esmerald_app=esmerald_instance,
+                            path=app_path,
+                            app_location=path,
+                            discovery_file=discovery_file,
+                        )
 
             # Iterate over default pattern application functions
             for func in DISCOVERY_FUNCTIONS:
-                if hasattr(module, func):
+                if (fn := getattr(module, func, None)) is not None:
+                    app_candidate = fn()
                     app_path = f"{dotted_path}:{func}"
-                    fn = getattr(module, func)
-                    return Scaffold(
-                        app=fn(),
-                        path=app_path,
-                        app_location=path,
-                        discovery_file=discovery_file,
-                    )
+                    if isinstance(app_candidate, Esmerald):
+                        return Scaffold(
+                            app=app_candidate,
+                            esmerald_app=app_candidate,
+                            path=app_path,
+                            app_location=path,
+                            discovery_file=discovery_file,
+                        )
+                    if isinstance((esmerald_instance := monkay.instance), Esmerald):
+                        return Scaffold(
+                            app=app_candidate,
+                            esmerald_app=esmerald_instance,
+                            path=app_path,
+                            app_location=path,
+                            discovery_file=discovery_file,
+                        )
         return None
 
     def find_app(self, path: str | None, cwd: Path) -> Scaffold:

esmerald/core/directives/operations/list.py

@@ -26,7 +26,7 @@ def directives(env: DirectiveEnv) -> None:
     directives = get_directives(PATH)
 
     # Handles the application directives
-    if getattr(env, "app", None) is not None:
+    if getattr(env, "esmerald_app", None) is not None:
         app_directives = get_application_directives(env.command_path)
         if app_directives:
             directives.extend(app_directives)

esmerald/core/directives/operations/run.py

@@ -10,10 +10,9 @@
 from lilya._internal._events import generate_lifespan_events  # noqa
 from lilya.cli.base import BaseDirective
 from lilya.context import G, g_context
-from lilya.types import Lifespan
+from lilya.types import ASGIApp, Lifespan
 from sayer import Argument, Option, command, error
 
-from esmerald.applications import ChildEsmerald, Esmerald
 from esmerald.core.directives.constants import APP_PARAMETER, ESMERALD_DISCOVER_APP
 from esmerald.core.directives.env import DirectiveEnv
 from esmerald.core.directives.utils import fetch_directive
@@ -98,7 +97,15 @@ async def run(
 
     ## Check if application is up and execute any event
     # Shutting down after
-    lifespan = generate_lifespan_events(env.app.on_startup, env.app.on_shutdown, env.app.lifespan)
+    lifespan = (
+        generate_lifespan_events(
+            env.esmerald_app.on_startup,
+            env.esmerald_app.on_shutdown,
+            env.esmerald_app.lifespan,
+        )
+        if env.esmerald_app
+        else generate_lifespan_events()
+    )
     await execute_lifespan(env.app, lifespan, directive, program_name, position)
 
 
@@ -136,7 +143,7 @@ async def reset_global_context(token: Any) -> None:
 
 
 async def execute_lifespan(
-    app: Esmerald | ChildEsmerald | None,
+    app: ASGIApp | None,
     lifespan: Lifespan,
     directive: Any,
     program_name: str,

esmerald/core/directives/operations/runserver.py

@@ -5,7 +5,7 @@
 
 import click
 from rich.tree import Tree
-from sayer import Argument, Option, command, error
+from sayer import Option, command, error
 
 from esmerald.core.directives.env import DirectiveEnv
 from esmerald.core.directives.exceptions import DirectiveError
@@ -46,13 +46,6 @@ def get_app_tree(module_paths: list[Path], discovery_file: str) -> Tree:
 
 @command
 def runserver(
-    path: Annotated[
-        str | None,
-        Argument(
-            required=False,
-            help="A path to a Python file or package directory with ([blue]__init__.py[/blue] files) containing a [bold]Esmerald[/bold] app. If not provided, Esmerald will try to discover.",
-        ),
-    ],
     port: Annotated[
         int, Option(8000, "-p", help="Port to run the development server.", show_default=True)
     ],
@@ -196,11 +189,13 @@ def runserver(
         )
         toolkit.print_line()
 
-        if debug:
-            app.debug = debug
+        if debug and env.esmerald_app:
+            env.esmerald_app.debug = debug
 
         uvicorn.run(
-            app=path or env.path,
+            # in case of no reload and workers, we might end up initializing twice when
+            # using a function, so use app instead
+            app=app if not reload and not workers else env.path,
             port=port,
             host=host,
             reload=reload,

esmerald/core/directives/operations/show_urls.py

@@ -66,8 +66,10 @@ def show_urls(env: DirectiveEnv) -> None:
             "ESMERALD_DEFAULT_APP environment variable."
         )
         sys.exit(1)
-
-    app = env.app
+    if getattr(env, "esmerald_app", None) is None:
+        error("Not an esmerald app.")
+        sys.exit(1)
+    app = env.esmerald_app
     table = Table(title=app.app_name)
     table = get_routes_table(app, table)
     echo(table)
@@ -112,7 +114,7 @@ def parse_routes(
                 # of the table not being able to render the string
                 route_name = ":".join(names)
 
-                http_methods = ", ".join(sorted(route.methods))
+                http_methods = ", ".join(sorted(route.methods or []))
                 parameters = ", ".join(sorted(route.stringify_parameters))
                 table.add_row(path, parameters, route_name, fn_type, http_methods)
                 continue

esmerald/utils/crypto.py

@@ -1,3 +1,3 @@
-from lilya.crypto import get_random_secret_key, get_random_string
+from lilya._internal._crypto import get_random_secret_key, get_random_string
 
 __all__ = ["get_random_string", "get_random_secret_key"]