ORIONIS API REFERENCE

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 RouteListCommand(BaseCommand): (source)

View In Hierarchy

Display registered HTTP routes in URI order.

Method __collectRoutes Flatten compiled method buckets and sort routes by their URI.
Method __getAction Format the route handler as an importable Python name.
Method __getMiddleware Format the middleware stack attached to a route.
Async Method handle Print all application routes as a sorted Rich table.
Class Variable description List the application's registered HTTP routes..
Class Variable signature route:list.
Class Variable timestamps Timestamps flag used by RouteListCommand.
def __collectRoutes(self, route_loader: RouteLoader) -> list[CompiledRoute]: (source)

Flatten compiled method buckets and sort routes by their URI.

Parameters
route_loader:orionis.http.routes.loader.RouteLoaderLoader that provides the application's compiled route buckets.
Returns
list[orionis.http.routes.entities.compiled_route.CompiledRoute]All registered routes sorted by path in ascending order.
def __getAction(self, route: CompiledRoute) -> str: (source)

Format the route handler as an importable Python name.

Parameters
route:orionis.http.routes.entities.compiled_route.CompiledRouteRoute whose action descriptor is displayed.
Returns
strQualified handler name or a dash when no action is available.
def __getMiddleware(self, route: CompiledRoute) -> str: (source)

Format the middleware stack attached to a route.

Parameters
route:orionis.http.routes.entities.compiled_route.CompiledRouteRoute whose effective middleware stack is displayed.
Returns
strComma-separated middleware names or a dash when the stack is empty.
async def handle(self, route_loader: RouteLoader, console: Console) -> int: (source)

Print all application routes as a sorted Rich table.

Parameters
route_loader:orionis.http.routes.loader.RouteLoaderLoader that provides the application's compiled route buckets.
console:orionis.console.ConsoleRich console used to display route information.
Returns
intZero when routes are displayed; one when no routes are registered.
description: str = (source)

List the application's registered HTTP routes..

signature: str = (source)

route:list.

timestamps: bool = (source)

Timestamps flag used by RouteListCommand.