orionis.http.default.controllers.login_controller.LoginController

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class LoginController(BaseController): (source)

Undocumented

Method	`__init__`	Configure the controller from the session authentication settings.
Async Method	`index`	Return the login page response.
Async Method	`login`	Handle the login form submission.
Async Method	`logout`	Invalidate the current session and return to the public welcome page.
Constant	`DEFAULT_LOGIN_PATH`	Undocumented
Constant	`HOME_REDIRECT_PATH`	Undocumented
Constant	`LOGIN_VIEW_NAME`	Undocumented
Constant	`LOGOUT_REDIRECT_PATH`	Undocumented
Instance Variable	`redirect_to`	Undocumented

def __init__(self, application: IApplication): (source) ¶

Configure the controller from the session authentication settings.

Web login uses the session guard through Auth.attempt() regardless of the guard configured as the application's default.

Parameters
application:`IApplication`	Application instance used to read the `auth` configuration.

Returns
`None`	Complete the documented operation without returning a value.

async def index(self) -> HttpResponse: (source) ¶

Return the login page response.

Returns
`HttpResponse`	Rendered response for the login page.

async def login(self, request: Request, payload: LoginSchema, auth: IAuthManager) -> HttpResponse: (source) ¶

Handle the login form submission.

Parameters
request:`Request`	Incoming HTTP request, used to read the raw submitted payload.
payload:`LoginSchema`	Validated credentials; invalid submissions never reach this method.
auth:`IAuthManager`	Authentication service using the request's existing session.