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

Own the temporary streams and clear the message once, without a thread.

Method __init__ Initialize inactive startup feedback and its stream proxies.
Method clear Clear active feedback and restore the original standard streams.
Method finish Retire startup feedback while holding its lock.
Method start Display the startup message and install temporary stream proxies.
Instance Variable active Active flag used by _StartupFeedback.
Instance Variable frame Single-line startup message to display on stderr.
Instance Variable lock Lock produced by allocate_lock.
Instance Variable stderr Original error stream used to display and clear the message.
Instance Variable stderr_proxy Stderr proxy produced by _OutputProxy.
Instance Variable stdout Original standard output stream to restore after feedback.
Instance Variable stdout_proxy Stdout proxy produced by _OutputProxy.
def __init__(self, stdout: TextIO, stderr: TextIO, frame: str): (source)

Initialize inactive startup feedback and its stream proxies.

Parameters
stdout:typing.TextIOOriginal standard output stream to restore after feedback.
stderr:typing.TextIOOriginal error stream used to display and clear the message.
frame:strSingle-line startup message to display on stderr.
Returns
NoneStore the streams and prepare their proxies and shared lock.
def clear(self): (source)

Clear active feedback and restore the original standard streams.

Call while holding lock. Suppress display I/O errors and restore only standard streams that still reference this controller's proxies.

Returns
NoneDeactivate feedback even if clearing the display fails.
def finish(self): (source)

Retire startup feedback while holding its lock.

Returns
NoneClear active feedback and restore the original streams.
def start(self): (source)

Display the startup message and install temporary stream proxies.

Returns
NoneActivate feedback, replace both streams, and flush the message.

Active flag used by _StartupFeedback.

Single-line startup message to display on stderr.

Lock produced by allocate_lock.

Original error stream used to display and clear the message.

stderr_proxy = (source)

Stderr proxy produced by _OutputProxy.

Original standard output stream to restore after feedback.

stdout_proxy = (source)

Stdout proxy produced by _OutputProxy.