BaseAuthMiddleware class

This is the reference for the main object BaseAuthMiddleware that contains all the parameters, attributes and functions.

ravyn.middleware.authentication.BaseAuthMiddleware

BaseAuthMiddleware(app)

Bases: ABC, MiddlewareProtocol

BaseAuthMiddleware is the object that you can implement if you want to implement any authentication middleware with Ravyn.

It is not mandatory to use it and you are free to implement your.

Ravyn being based on Lilya, also offers a simple but powerful interface for handling authentication and permissions.

Once you have installed the AuthenticationMiddleware and implemented the authenticate, the request.user will be available in any of your endpoints.

Read more about how Ravyn implements the BaseAuthMiddleware.

When implementing the authenticate, you must assign the result into the AuthResult object in order for the middleware to assign the request.user properly.

Deprecation Warning

BaseAuthMiddleware is deprecated and will be removed in a future release. Please use AuthenticationMiddleware from ravyn.middleware.authentication which provides the same functionality with a more robust implementation.

The AuthResult is of type ravyn.middleware.authentication.AuthResult.

PARAMETER	DESCRIPTION
app	An ASGI type callable. TYPE: ASGIApp

Source code in ravyn/middleware/authentication.py

def __init__(
    self,
    app: Annotated[
        ASGIApp,
        Doc(
            """
            An ASGI type callable.
            """
        ),
    ],
):
    super().__init__(app)
    self.app = app
    self.scopes: Set[str] = {ScopeType.HTTP, ScopeType.WEBSOCKET}

    warning_msg = (
        "`BaseAuthMiddleware` is deprecated and will be removed in a future release (0.4.0). "
        "Please use `AuthenticationMiddleware`from `ravyn.middleware.authentication` which "
        "provides the same functionality with a more robust implementation."
    )
    warnings.warn(
        warning_msg,
        DeprecationWarning,
        stacklevel=2,
    )

app instance-attribute

app = app

scopes instance-attribute

scopes = {HTTP, WEBSOCKET}

authenticate abstractmethod async

authenticate(request)

The abstract method that needs to be implemented for any authentication middleware.

Source code in ravyn/middleware/authentication.py

@abstractmethod
async def authenticate(self, request: Connection) -> AuthResult:
    """
    The abstract method that needs to be implemented for any authentication middleware.
    """
    raise NotImplementedError("authenticate must be implemented.")

ravyn.middleware.authentication.AuthResult

Bases: ArbitraryBaseModel

user instance-attribute

user

Arbitrary user coming from the authenticate of the BaseAuthMiddleware and can be assigned to the request.user.