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.test.contracts.engine.ITestingEngine

class documentation

class ITestingEngine(ABC): (source)

Known subclasses: orionis.test.core.engine.TestingEngine

View In Hierarchy

Undocumented

Method discover Discover and filter tests using configuration parameters.
Async Method run Run the discovered test suite asynchronously.
Method setFailFast Set the fail-fast behavior for the testing engine.
Method setFilePattern Set the file pattern for test file discovery.
Method setMethodPattern Set the method pattern for test method discovery.
Method setStartDir Set the start directory for test discovery.
Method setVerbosity Set the verbosity level for the testing engine.
Method withoutPanel Disable the start panel display for the testing engine.
def discover(self) -> unittest.TestSuite: (source)
overridden in orionis.test.core.engine.TestingEngine

Discover and filter tests using configuration parameters.

Returns
unittest.TestSuiteTest suite containing filtered test cases.
async def run(self) -> list[TestResult]: (source)
overridden in orionis.test.core.engine.TestingEngine

Run the discovered test suite asynchronously.

Discovers the tests, builds a runner carrying the configured verbosity, and executes them using a thread pool to avoid blocking. Saves results to cache if enabled.

Returns
list[TestResult]List of TestResult objects containing test execution outcomes.
def setFailFast(self, *, fail_fast: bool) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Set the fail-fast behavior for the testing engine.

Parameters
fail_fast:boolWhether to stop on first failure.
Returns
SelfReturns self for method chaining.
def setFilePattern(self, file_pattern: str) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Set the file pattern for test file discovery.

Parameters
file_pattern:strPattern to match test files.
Returns
SelfReturns self for method chaining.
def setMethodPattern(self, method_pattern: str) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Set the method pattern for test method discovery.

Parameters
method_pattern:strPattern to match test methods.
Returns
SelfReturns self for method chaining.
def setStartDir(self, start_dir: str) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Set the start directory for test discovery.

Parameters
start_dir:strDirectory to start test discovery from.
Returns
SelfReturns self for method chaining.
def setVerbosity(self, verbosity: int) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Set the verbosity level for the testing engine.

Parameters
verbosity:intVerbosity level to set.
Returns
SelfReturns self for method chaining.
def withoutPanel(self) -> Self: (source)
overridden in orionis.test.core.engine.TestingEngine

Disable the start panel display for the testing engine.

Returns
SelfReturns self for method chaining.