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

Compile expansion once and verify every inverse result by expansion.

Class Method compile Require an explicit inverse for RFC operators with ambiguous matching.
Method _customVariables Validate the result of a configured custom inverse matcher.
Method match Return validated URI variables without loading any resource or file.
Class Variable captures Capture metadata used to extract template variable values.
Class Variable custom Custom implementations registered by the application.
Class Variable expander Callable used to expand a URI template with variable values.
Class Variable pattern Compiled pattern used to match the declared URI template.
Class Variable template URI template from which the matcher was compiled.
Class Variable variable_names Names of variables referenced by the URI template.
def compile(cls, definition: type[Resource]) -> UriMatcher: (source)

Require an explicit inverse for RFC operators with ambiguous matching.

Parameters
definition:type[orionis.mcp.Resource]Class declaration whose metadata is being inspected.
Returns
orionis.mcp.server.templates.UriMatcherResult of the operation described above.
def _customVariables(self, uri: str, custom: Callable[[str], Mapping[str, object] | None]) -> dict[str, object] | None: (source)

Validate the result of a configured custom inverse matcher.

Parameters
uri:strURI already validated by the public matching entry point.
custom:collections.abc.CallableConfigured inverse matcher, already narrowed to a callable.
Returns
dict[str, object] or NoneCopied declared variables, or None when the custom matcher declines.
def match(self, uri: str) -> dict[str, object] | None: (source)

Return validated URI variables without loading any resource or file.

Parameters
uri:strValue supplied for uri.
Returns
dict[str, object] | NoneValidated URI variables without loading any resource or file.
captures: tuple[str, ...] = (source)

Capture metadata used to extract template variable values.

Custom implementations registered by the application.

expander: URITemplate = (source)

Callable used to expand a URI template with variable values.

Compiled pattern used to match the declared URI template.

template: str = (source)

URI template from which the matcher was compiled.

variable_names: tuple[str, ...] = (source)

Names of variables referenced by the URI template.