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 IFluentRoute(ABC): (source)
Known subclasses: orionis.http.routes.fluent.FluentRoute
Define the contract for fluent route implementations.
| 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 | with |
Exclude one or more middleware classes from the route. |
| Property | id |
Return the unique identifier of the route. |
orionis.http.routes.fluent.FluentRouteSet 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 | |
typing.Self | This instance for method chaining. |
orionis.http.routes.fluent.FluentRouteExport 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. |
orionis.http.routes.fluent.FluentRouteAdd middleware to the route.
| Parameters | |
*middleware:orionis.http.routes.types.MiddlewareInput | One or more middleware classes (not instances) to attach. Classes may be passed individually or wrapped in a list, tuple or set. |
| Returns | |
typing.Self | This instance for method chaining. |
orionis.http.routes.fluent.FluentRouteSet the name for the route.
| Parameters | |
name:str | Name to assign to the route. |
| Returns | |
typing.Self | This instance for method chaining. |
orionis.http.routes.fluent.FluentRoutePrepend a path segment to the route's current path.
| Parameters | |
prefix:str | The path prefix to prepend. |
| Returns | |
typing.Self | This instance for method chaining. |
orionis.http.routes.fluent.FluentRouteSelect 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 | |
typing.Self | This route with the requested execution profile. |
| Raises | |
TypeError | If enabled is not a boolean. |
orionis.http.routes.fluent.FluentRouteExclude one or more middleware classes from the route.
| Parameters | |
*middleware:orionis.http.routes.types.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 | |
typing.Self | This instance for method chaining. |
orionis.http.routes.fluent.FluentRouteReturn the unique identifier of the route.
| Returns | |
str | The unique identifier of the route. |