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

Undocumented

Method __endPanel Display the test summary panel using Rich.
Method __init__ Initialize the test runner with custom settings.
Method __startPanel Display the test suite start panel using Rich.
Method run Execute the given test suite or test case.
Instance Variable __console Undocumented
Instance Variable __with_panel Undocumented
def __endPanel(self, test_result: list[TestResult], time_taken: float): (source)

Display the test summary panel using Rich.

Summarize and render the results of the test suite execution, including counts for each test status and total execution time.

Parameters
test_result:list[TestResult]List of test result objects to summarize.
time_taken:floatTotal time taken to execute the test suite.
Returns
NoneThis method performs output and does not return a value.
def __init__(self, verbosity: int = 0, failfast: bool = False, buffer: bool = False, warnings: str | None = None, with_panel: bool = True, **kwargs: dict): (source)

Initialize the test runner with custom settings.

Parameters
verbosity:int, optionalLevel of detail printed for each test. It is handed to the TestResultProcessor built by _makeResult, which owns the console rendering: 1 prints one line per test, 2 prints a detailed panel and any other value prints nothing, by default 0
failfast:bool, optionalStop on first failure, by default False
buffer:bool, optionalBuffer stdout and stderr during tests, by default False
warnings:str | None, optionalControl warnings during test execution, by default None
with_panel:bool, optionalRender the Rich start and summary panels around the run. When False both panels are skipped and the console is never cleared, by default True
**kwargs:dictAdditional keyword arguments forwarded verbatim to unittest.TextTestRunner (stream, descriptions, tb_locals, durations), whose semantics are defined by the standard library.
Returns
NoneThis constructor initializes the instance and returns None.
def __startPanel(self): (source)

Display the test suite start panel using Rich.

Initializes and renders a Rich panel to indicate the start of the test suite execution, including server status, start time, process ID, and event loop policy.

Returns
NoneThis method performs output and does not return a value.
def run(self, test: unittest.suite.TestSuite) -> unittest.result.TestResult: (source)

Execute the given test suite or test case.

Parameters
test:unittest.suite.TestSuiteThe test case or suite to execute.
Returns
unittest.result.TestResultThe result object containing test execution details.
__console: Console = (source)

Undocumented

__with_panel: bool = (source)

Undocumented