orionis.http.default.controllers.register_controller.RegisterController

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 RegisterController(BaseController): (source)

Undocumented

Async Method	`__resolveUser`	Resolve the account referenced by an encrypted verification link.
Async Method	`index`	Return the registration page response.
Async Method	`register`	Handle the registration form submission.
Async Method	`sendVerificationEmail`	Send a verification email to the newly registered user.
Async Method	`verifyEmail`	Activate the account addressed by a verification link.
Constant	`REGISTER_REDIRECT_PATH`	Undocumented
Constant	`REGISTER_VIEW_NAME`	Undocumented
Constant	`VERIFY_PARAM_NAME`	Undocumented
Constant	`VERIFY_VIEW_NAME`	Undocumented

async def __resolveUser(self, encrypted_id: str | None) -> User | None: (source) ¶

Resolve the account referenced by an encrypted verification link.

Parameters
encrypted_id:`str \| None`	Encrypted identifier extracted from the verification link.

Returns
`User \| None`	Matching user, or `None` when the link is absent, forged or points to an account that no longer exists.

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

Return the registration page response.

Returns
`HttpResponse`	Rendered response for the registration page.

async def register(self, payload: RegisterSchema, request: Request) -> HttpResponse: (source) ¶

Handle the registration form submission.

Parameters
payload:`RegisterSchema`	Incoming request carrying the submitted account data.
request:`Request`	Current request and its trusted execution context.

Returns
`HttpResponse`	Redirect to login after the account is created.

async def sendVerificationEmail(self, base_url: str, user: User) -> MailResult: (source) ¶

Send a verification email to the newly registered user.

Parameters
base_url:`str`	The base URL of the application, used to construct the verification link.
user:`User`	The user to whom the verification email will be sent.