orionis.http.routes.fluent.FluentRoute

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 FluentRoute(IFluentRoute): (source)

Constructor: FluentRoute(method, path, action, view)

View In Hierarchy

Undocumented

Method	`__init__`	Initialize a FluentRoute instance.
Method	`_hub`	Set the Hub class and its fixed connection codec.
Method	`_kind`	Set the kind of the route (e.g., 'web', 'api').
Method	`action`	Set the controller class and handler for the route.
Method	`export`	Export a complete route configuration as a plain dictionary.
Method	`inheritGroup`	Apply validated group context during registration.
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.
Constant	`_ALLOWED_METHODS`	Undocumented
Instance Variable	`__callable_handler`	Undocumented
Instance Variable	`__class`	Undocumented
Instance Variable	`__handler`	Undocumented
Instance Variable	`__hub`	Undocumented
Instance Variable	`__hub_protocol`	Undocumented
Instance Variable	`__id`	Undocumented
Instance Variable	`__kind`	Undocumented
Instance Variable	`__method`	Undocumented
Instance Variable	`__middleware`	Undocumented
Instance Variable	`__name`	Undocumented
Instance Variable	`__path`	Undocumented
Instance Variable	`__public`	Undocumented
Instance Variable	`__view`	Undocumented
Instance Variable	`__without_middleware`	Undocumented
Property	`id`	Return the unique identifier of the route.
Property	`path`	Return the current canonical path, including inherited prefixes.

def __init__(self, method: str, path: str, action: RouteAction | None = None, *, view: str | None = None): (source) ¶

Initialize a FluentRoute instance.

Parameters
method:`str`	HTTP method (e.g., 'GET', 'POST').
path:`str`	Route path.
action:`RouteAction \| None, optional`	Action to execute. Three forms are accepted: Invokable controller - bare class that defines `__call__`: FluentRoute("GET", "/", UserController) Controller + method - two-element list: FluentRoute("GET", "/", [UserController, "index"]) Callable - plain function or coroutine function: FluentRoute("GET", "/", my_view) Ignored when view is provided. If omitted or None, set the controller and method with `action()` before exporting.
view:`str \| None, optional`	Template name rendered directly by the kernel. When given, the route carries no Python handler and action is not parsed.

Returns
`None`	The instance is initialized; no value is returned.

Raises
`TypeError`	If method or path is not a string, or a supplied action is invalid.
`ValueError`	If method is unsupported, view is invalid, or a controller pair has an invalid length or names a missing method.

def _hub(self, hub: type[Hub], protocol: str) -> Self: (source) ¶

Set the Hub class and its fixed connection codec.

Parameters
hub:`type[Hub]`	Concrete Hub subclass resolved through the application container.
protocol:`str`	Realtime codec name: `json` or `msgpack`.

Returns
`Self`	This connection route with an explicit Hub action.

Raises
`TypeError`	If the class does not inherit from Hub.
`ValueError`	If the route is HTTP or the codec is unsupported.

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

Set the kind of the route (e.g., 'web', 'api').

Parameters
kind:`str`	The kind to set for the route.

Returns
`Self`	This FluentRoute instance for method chaining.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.action

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 FluentRoute instance for method chaining.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.export

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, public, protocol, hub, and hub_protocol.

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

def inheritGroup(self, prefix: str, middleware: tuple[type[BaseMiddleware], ...], without_middleware: frozenset[type[BaseMiddleware]], *, public: bool | None = None) -> Self: (source) ¶

Apply validated group context during registration.

Parameters
prefix:`str`	Canonical prefix without a trailing slash, or an empty string.
middleware:`tuple[type[BaseMiddleware], ...]`	Parent middleware, in declaration order.
without_middleware:`frozenset[type[BaseMiddleware]]`	Exclusions inherited by the route.
public:`bool \| None, optional`	Parent profile applied only when the route has no explicit profile.

Returns
`Self`	This route with the parent context prepended.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.middleware

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 FluentRoute instance for method chaining.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.name

Set the name for the route.

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

Returns
`Self`	This FluentRoute instance for method chaining.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.prefix

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

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

Returns
`Self`	This FluentRoute instance for method chaining.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.public

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.

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

overrides orionis.http.routes.contracts.fluent.IFluentRoute.withOutMiddleware

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 FluentRoute instance for method chaining.

_ALLOWED_METHODS: frozenset[str] = (source) ¶

Undocumented

Value

frozenset(set(['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'QUERY', 'WEBSOCKET']))

__callable_handler: Callable | None = (source) ¶

Undocumented

__class: type | None = (source) ¶

Undocumented

__handler: str | None = (source) ¶

Undocumented

__hub: type[Hub] | None = (source) ¶

Undocumented

__hub_protocol: str | None = (source) ¶

Undocumented

__id: str = (source) ¶

Undocumented

__kind: str = (source) ¶

Undocumented

__method: str = (source) ¶

Undocumented

__middleware: list[type[BaseMiddleware]] = (source) ¶

Undocumented

__name: str | None = (source) ¶

Undocumented

__path: str = (source) ¶

Undocumented

__public: bool | None = (source) ¶

Undocumented

__view: str | None = (source) ¶

Undocumented

__without_middleware: set[type[BaseMiddleware]] = (source) ¶

Undocumented

@property

id: str = (source) ¶

overrides orionis.http.routes.contracts.fluent.IFluentRoute.id

Return the unique identifier of the route.

Returns
`str`	The unique identifier of the route.

@property

path: str = (source) ¶

Return the current canonical path, including inherited prefixes.

Returns
`str`	The current canonical path, including inherited prefixes.