orionis.http.routes.contracts.fluent.IFluentRoute

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.

Explore modules View classes

class documentation

class IFluentRoute(ABC): (source)

Known subclasses: orionis.http.routes.fluent.FluentRoute

View In Hierarchy

Undocumented

Method	`action`	Set the controller class and handler for the route.
Method	`export`	Export a complete route configuration as a plain dictionary.
Method	`middleware`	Add middleware to the route.
Method	`name`	Set the name for the route.
Method	`prefix`	Prepend a path segment to the route's current path.
Method	`public`	Select a stateless route without automatic session or identity setup.
Method	`withOutMiddleware`	Exclude one or more middleware classes from the route.
Property	`id`	Return the unique identifier of the route.

@abstractmethod

def action(self, controller: type, handler: str) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Set the controller class and handler for the route.

Parameters
controller:`type`	Controller class to associate with the route.
handler:`str`	Name of the handler method.

Returns
`Self`	This instance for method chaining.

@abstractmethod

def export(self) -> dict: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Export a complete route configuration as a plain dictionary.

Returns
`dict`	Dictionary with keys: id, method, path, class, handler, callable_handler, view, name, middleware, without_middleware, kind, and public.

Raises
`ValueError`	If the route has neither a view nor an assigned action.

@abstractmethod

def middleware(self, *middleware: MiddlewareInput) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Add middleware to the route.

Parameters
*middleware:`MiddlewareInput`	One or more middleware classes (not instances) to attach. Classes may be passed individually or wrapped in a `list`, `tuple` or `set`.

Returns
`Self`	This instance for method chaining.

@abstractmethod

def name(self, name: str) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Set the name for the route.

Parameters
name:`str`	Name to assign to the route.

Returns
`Self`	This instance for method chaining.

@abstractmethod

def prefix(self, prefix: str) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Prepend a path segment to the route's current path.

Parameters
prefix:`str`	The path prefix to prepend.

Returns
`Self`	This instance for method chaining.

@abstractmethod

def public(self, *, enabled: bool = True) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Select a stateless route without automatic session or identity setup.

Global security, CORS, rate limits, and explicitly attached middleware still run. Web session, CSRF, and automatic identity resolution do not. Use this profile only for endpoints that do not use cookie credentials.

Parameters
enabled:`bool, optional`	Whether to opt out of the default web or API context middleware. False explicitly retains that context inside a public group.

Returns
`Self`	This route with the requested execution profile.

Raises
`TypeError`	If enabled is not a boolean.

@abstractmethod

def withOutMiddleware(self, *middleware: MiddlewareInput) -> Self: (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Exclude one or more middleware classes from the route.

Parameters
*middleware:`MiddlewareInput`	One or more middleware classes to exclude from this route. Classes may be passed individually or wrapped in a `list`, `tuple` or `set`.

Returns
`Self`	This instance for method chaining.

@property
@abstractmethod

id: str = (source) ¶

overridden in orionis.http.routes.fluent.FluentRoute

Return the unique identifier of the route.

Returns
`str`	The unique identifier of the route.