Add references

Author: tarsil

esmerald/conf/global_settings.py

@@ -971,7 +971,7 @@ def openapi_config(self) -> OpenAPIConfig:
     @property
     def middleware(self) -> Sequence[Middleware]:
         """
-        A global sequence of Starlette middlewares or `esmerald.middlewares` that are
+        A global sequence of Lilya middlewares or `esmerald.middlewares` that are
         used by the application.
 
         Read more about the [Middleware](https://esmerald.dev/middleware/middleware/).

esmerald/middleware/authentication.py

@@ -29,7 +29,7 @@ class BaseAuthMiddleware(ABC, MiddlewareProtocol):  # pragma: no cover
 
     It is not mandatory to use it and you are free to implement your.
 
-    Esmerald being based on Starlette, also offers a simple but powerful
+    Esmerald being based on Lilya, also offers a simple but powerful
     interface for handling `authentication` and [permissions](https://esmerald.dev/permissions/).
 
     Once you have installed the `AuthenticationMiddleware` and implemented the

esmerald/middleware/exceptions.py

@@ -2,7 +2,7 @@
 from typing import Any, Callable, Dict, List, Mapping, Optional, Type, Union, cast
 
 from lilya import status
-from lilya.exceptions import HTTPException as StarletteHTTPException
+from lilya.exceptions import HTTPException as LilyaException
 from lilya.middleware.exceptions import ExceptionMiddleware as LilyaExceptionMiddleware
 from lilya.responses import Response as LilyaResponse
 from lilya.types import ASGIApp, Receive, Scope, Send
@@ -35,7 +35,7 @@ def __init__(
         self._status_handlers: Dict[int, Callable] = {}
         self._exception_handlers: Dict[Type[Exception], Callable] = {
             HTTPException: http_exception_handler,
-            StarletteHTTPException: http_exception_handler,
+            LilyaException: http_exception_handler,
             WebSocketException: self.websocket_exception,
         }
         if handlers is not None:
@@ -99,7 +99,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
             if isinstance(ex, WebSocketException):
                 code = ex.code
                 reason = ex.detail
-            elif isinstance(ex, StarletteHTTPException):
+            elif isinstance(ex, LilyaException):
                 code = ex.status_code + 4000
                 reason = ex.detail
             else:
@@ -113,7 +113,7 @@ def default_http_exception_handler(self, request: Request, exc: Exception) -> "L
         """Default handler for exceptions subclassed from HTTPException."""
         status_code = (
             exc.status_code
-            if isinstance(exc, StarletteHTTPException)
+            if isinstance(exc, LilyaException)
             else status.HTTP_500_INTERNAL_SERVER_ERROR
         )
         if status_code == status.HTTP_500_INTERNAL_SERVER_ERROR and self.debug:
@@ -122,7 +122,7 @@ def default_http_exception_handler(self, request: Request, exc: Exception) -> "L
         return self.create_exception_response(exc)
 
     def create_exception_response(self, exc: Exception) -> Response:
-        if isinstance(exc, (HTTPException, StarletteHTTPException)):
+        if isinstance(exc, (HTTPException, LilyaException)):
             content = ResponseContent(detail=exc.detail, status_code=exc.status_code)
             if isinstance(exc, HTTPException):
                 extra = exc.extra.get("extra", {})
@@ -134,9 +134,7 @@ def create_exception_response(self, exc: Exception) -> Response:
             media_type=MediaType.JSON,
             content=content.model_dump(exclude_none=True),
             status_code=content.status_code,
-            headers=(
-                exc.headers if isinstance(exc, (HTTPException, StarletteHTTPException)) else None
-            ),
+            headers=(exc.headers if isinstance(exc, (HTTPException, LilyaException)) else None),
         )
 
     def get_exception_handler(

esmerald/permissions/base.py

@@ -212,7 +212,7 @@ def is_user_authenticated(self, request: "Request") -> bool:
         This method must be overridden by subclasses.
 
         Args:
-            request: A Starlette 'Connection' instance.
+            request: A Lilya 'Connection' instance.
 
         Returns:
             bool: True or False
@@ -225,7 +225,7 @@ def is_user_staff(self, request: "Request") -> bool:
         This method must be overridden by subclasses.
 
         Args:
-            request: A Starlette 'Connection' instance.
+            request: A Lilya 'Connection' instance.
 
         Returns:
             bool: True or False
@@ -278,7 +278,7 @@ def has_permission(
     ) -> bool:
         """
         Args:
-            request: A Starlette 'Connection' instance.
+            request: A Lilya 'Connection' instance.
             apiview: A Esmerald 'APIController' instance or a `APIGateHandler` instance.
 
         Returns:
@@ -300,7 +300,7 @@ def has_permission(
     ) -> bool:
         """
         Args:
-            request: A Starlette 'Connection' instance.
+            request: A Lilya 'Connection' instance.
             apiview: A Esmerald 'APIController' instance or a `APIGateHandler` instance.
 
         Returns:
@@ -322,7 +322,7 @@ def has_permission(
     ) -> bool:
         """
         Args:
-            request: A Starlette 'Connection' instance.
+            request: A Lilya 'Connection' instance.
             apiview: A Esmerald 'APIController' instance or a `APIGateHandler` instance.
 
         Returns:

esmerald/routing/apis/base.py

@@ -112,7 +112,7 @@ class CustomView(View):
         Optional[List["Middleware"]],
         Doc(
             """
-            A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+            A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
             """
         ),
     ]

esmerald/routing/base.py

@@ -90,7 +90,7 @@ class PathParameterSchema(TypedDict):
 class OpenAPIDefinitionMixin:  # pragma: no cover
     def parse_path(self, path: str) -> List[Union[str, PathParameterSchema]]:
         """
-        Using the Starlette CONVERTORS and the application registered convertors,
+        Using the Lilya TRANSFORMERS and the application registered convertors,
         transforms the path into a PathParameterSchema used for the OpenAPI definition.
         """
         _, path, variables, _ = compile_path(path)
@@ -241,7 +241,7 @@ def starlette_response_handler(
         cookies: "ResponseCookies",
         headers: Optional["ResponseHeaders"] = None,
     ) -> "AsyncAnyCallable":
-        """Creates an handler for Starlette Responses."""
+        """Creates an handler for Lilya Responses."""
 
         async def response_content(data: LilyaResponse, **kwargs: Dict[str, Any]) -> LilyaResponse:
             _cookies = self.get_cookies(cookies, [])

esmerald/routing/events.py

@@ -15,10 +15,6 @@ class AyncLifespanContextManager:  # pragma: no cover
     Manages and handles the on_startup and on_shutdown events
     in an Esmerald way.
 
-    This is not the same as the on_startup and on_shutdown
-    from Starlette. Those are now deprecated and will be removed
-    in the version 1.0 of Starlette.
-
     This aims to provide a similar functionality but by generating
     a lifespan event based on the values from the on_startup and on_shutdown
     lists.
@@ -57,7 +53,7 @@ def handle_lifespan_events(
     on_shutdown: Optional[Sequence["LifeSpanHandler"]] = None,
     lifespan: Optional[Lifespan[Any]] = None,
 ) -> Any:  # pragma: no cover
-    """Handles with the lifespan events in the new Starlette format of lifespan.
+    """Handles with the lifespan events in the new Lilya format of lifespan.
     This adds a mask that keeps the old `on_startup` and `on_shutdown` events variable
     declaration for legacy and comprehension purposes and build the async context manager
     for the lifespan.

esmerald/routing/gateways.py

@@ -152,7 +152,7 @@ def __init__(
             Optional[List["Middleware"]],
             Doc(
                 """
-                A list of middleware to run for every request. The middlewares of a Gateway will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of a Gateway will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
             ),
         ] = None,
@@ -263,7 +263,7 @@ def __init__(
         )
         """
         A "bridge" to a handler and router mapping functionality.
-        Since the default Starlette Route handler does not understand the Esmerald handlers,
+        Since the default Lilya Route handler does not understand the Esmerald handlers,
         the Gateway bridges both functionalities and adds an extra "flair" to be compliant with both class based views and decorated function views.
         """
         self._interceptors: Union[List["Interceptor"], "VoidType"] = Void
@@ -415,7 +415,7 @@ def __init__(
             Optional[List["Middleware"]],
             Doc(
                 """
-                A list of middleware to run for every request. The middlewares of a Gateway will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of a Gateway will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
             ),
         ] = None,
@@ -485,7 +485,7 @@ def __init__(
         )
         """
         A "bridge" to a handler and router mapping functionality.
-        Since the default Starlette Route handler does not understand the Esmerald handlers,
+        Since the default Lilya Route handler does not understand the Esmerald handlers,
         the Gateway bridges both functionalities and adds an extra "flair" to be compliant with both class based views and decorated function views.
         """
         self._interceptors: Union[List["Interceptor"], "VoidType"] = Void

esmerald/routing/handlers.py

@@ -159,7 +159,7 @@ async def get_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -529,7 +529,7 @@ def head(
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -836,7 +836,7 @@ async def create_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -1239,7 +1239,7 @@ async def update_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -1642,7 +1642,7 @@ async def update_partial_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -2045,7 +2045,7 @@ async def delete_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -2415,7 +2415,7 @@ def options(
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -2684,7 +2684,7 @@ def trace(
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -3006,7 +3006,7 @@ async def operate_joiners() -> None:
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,
@@ -3336,7 +3336,7 @@ def websocket(
         Optional[List["Middleware"]],
         Doc(
             """
-                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Starlette Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
+                A list of middleware to run for every request. The middlewares of an Include will be checked from top-down or [Lilya Middleware](https://www.lilya.dev/middleware/) as they are both converted internally. Read more about [Python Protocols](https://peps.python.org/pep-0544/).
                 """
         ),
     ] = None,