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.

Explore modules View classes

orionis.http.routes.entities.compiled_route.CompiledRoute

class documentation

class CompiledRoute: (source)

View In Hierarchy

Represent a runtime-ready compiled HTTP or WebSocket route.

Instance Variable action Resolved handler descriptor containing module and either function (for functions) or class + method (for controllers and invokable classes).
Instance Variable compiled_middlewares Tuple of resolved middleware classes for efficient dispatch.
Instance Variable converters Maps each path parameter name to its converter function. Empty for static routes.
Instance Variable hub_protocol Realtime codec name for Hub actions; None for ordinary routes.
Instance Variable kind Route group kind; either 'web' or 'api'. Set by the loader when importing route files.
Instance Variable method HTTP method in uppercase, or the reserved 'WEBSOCKET' table key.
Instance Variable middleware Middleware classes attached to this route.
Instance Variable name Optional route name used for URL generation.
Instance Variable path The original route path, e.g. '/users/{id:int}'.
Instance Variable priority_score Specificity score used to order dynamic routes during dispatch. Higher scores are matched first. Computed as static_segments * 10 - dynamic_segments.
Instance Variable protocol Transport used for this route, independently of the action type.
Instance Variable public Whether automatic session, CSRF, and identity context are omitted.
Instance Variable regex Compiled regex for dynamic routes; None for static routes.
Instance Variable segment_count Number of non-empty path segments, e.g. 2 for '/users/{id}'. Used to narrow dynamic route matching to candidates of the same depth.
Instance Variable type How the handler will be resolved at dispatch time.
Instance Variable without_middleware Middleware classes explicitly excluded from this route.
action: dict = (source)

Resolved handler descriptor containing module and either function (for functions) or class + method (for controllers and invokable classes).

compiled_middlewares: tuple = (source)

Tuple of resolved middleware classes for efficient dispatch.

converters: dict[str, Callable] = (source)

Maps each path parameter name to its converter function. Empty for static routes.

hub_protocol: str | None = (source)

Realtime codec name for Hub actions; None for ordinary routes.

kind: str = (source)

Route group kind; either 'web' or 'api'. Set by the loader when importing route files.

method: str = (source)

HTTP method in uppercase, or the reserved 'WEBSOCKET' table key.

middleware: list = (source)

Middleware classes attached to this route.

name: str | None = (source)

Optional route name used for URL generation.

path: str = (source)

The original route path, e.g. '/users/{id:int}'.

priority_score: int = (source)

Specificity score used to order dynamic routes during dispatch. Higher scores are matched first. Computed as static_segments * 10 - dynamic_segments.

protocol: RouteProtocol = (source)

Transport used for this route, independently of the action type.

public: bool = (source)

Whether automatic session, CSRF, and identity context are omitted.

regex: Pattern | None = (source)

Compiled regex for dynamic routes; None for static routes.

segment_count: int = (source)

Number of non-empty path segments, e.g. 2 for '/users/{id}'. Used to narrow dynamic route matching to candidates of the same depth.

type: RouteType = (source)

How the handler will be resolved at dispatch time.

without_middleware: set = (source)

Middleware classes explicitly excluded from this route.