orionis.console.commands.route.list.RouteListCommand

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)

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`	Undocumented
Class Variable	`signature`	Undocumented
Class Variable	`timestamps`	Undocumented

def __collectRoutes(self, route_loader: RouteLoader) -> list[CompiledRoute]: (source) ¶

Flatten compiled method buckets and sort routes by their URI.

Parameters
route_loader:`RouteLoader`	Loader that provides the application's compiled route buckets.

Returns
`list[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:`CompiledRoute`	Route whose action descriptor is displayed.

Returns
`str`	Qualified 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:`CompiledRoute`	Route whose effective middleware stack is displayed.

Returns
`str`	Comma-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:`RouteLoader`	Loader that provides the application's compiled route buckets.
console:`Console`	Rich console used to display route information.

Returns
`int`	Zero when routes are displayed; one when no routes are registered.

Undocumented

Undocumented

Undocumented