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

Delegate output while retiring a startup message before its first write.

Method __enter__ Enter the wrapped stream's context and return this proxy.
Method __exit__ Exit the wrapped stream's context with its exception details.
Method __getattr__ Delegate an unresolved attribute to the wrapped stream.
Method __init__ Initialize a stream proxy with shared startup feedback.
Method write Write data and retire feedback before nonempty output.
Method writelines Write each line through the proxy without adding separators.
Instance Variable _buffer_proxy Binary-stream proxy corresponding to the text output wrapper.
Instance Variable _stream Wrapped stream that receives delegated operations.
Instance Variable feedback Controller that clears the startup message before output.
Property buffer Return a cached proxy for the wrapped stream's binary buffer.
def __enter__(self) -> Self: (source)

Enter the wrapped stream's context and return this proxy.

Returns
typing.SelfThis proxy after entering the wrapped stream's context.
def __exit__(self, *arguments: object) -> bool | None: (source)

Exit the wrapped stream's context with its exception details.

Parameters
*arguments:objectException type, exception value, and traceback to forward.
Returns
bool | NoneException-suppression result returned by the wrapped stream.
def __getattr__(self, name: str) -> object: (source)

Delegate an unresolved attribute to the wrapped stream.

Parameters
name:strAttribute name to retrieve from the wrapped stream.
Returns
objectAttribute value exposed by the wrapped stream.
def __init__(self, stream: TextIO | BinaryIO, feedback: _StartupFeedback): (source)

Initialize a stream proxy with shared startup feedback.

Parameters
stream:typing.TextIO | typing.BinaryIOWrapped stream that receives delegated operations.
feedback:orionis.console.startup._StartupFeedbackController that clears the startup message before output.
Returns
NoneStore the stream and controller without creating a buffer proxy.
def write(self, value: str | bytes | bytearray | memoryview) -> int: (source)

Write data and retire feedback before nonempty output.

Parameters
value:str | bytes | bytearray | memoryviewText or binary data; empty values leave feedback unchanged.
Returns
intNumber of characters or bytes written by the wrapped stream.
def writelines(self, lines: Iterable[str | bytes]): (source)

Write each line through the proxy without adding separators.

Parameters
lines:collections.abc.Iterable[str | bytes]Text or binary lines to forward in iteration order.
Returns
NoneForward each line through write to retire active feedback.
_buffer_proxy: _OutputProxy | None = (source)

Binary-stream proxy corresponding to the text output wrapper.

Wrapped stream that receives delegated operations.

feedback = (source)

Controller that clears the startup message before output.

Return a cached proxy for the wrapped stream's binary buffer.

Returns
orionis.console.startup._OutputProxyBinary buffer proxy sharing the same feedback controller.