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

Represent the outcome of a test execution.

Instance Variable class_name Name of the class containing the test, if applicable.
Instance Variable doc_string Docstring of the test, if applicable.
Instance Variable error_message Error message if the test failed, otherwise None.
Instance Variable exception Name of the raised exception class if an error occurred, otherwise None.
Instance Variable execution_time Time taken to execute the test, in seconds.
Instance Variable file_path Path to the file containing the test, if applicable.
Instance Variable id Unique identifier for the test result.
Instance Variable line_no Source line associated with the failure, if available.
Instance Variable method Name of the method representing the test, if applicable.
Instance Variable module Name of the module containing the test, if applicable.
Instance Variable name Name of the test.
Instance Variable source_code Source line numbers and text surrounding the failure.
Instance Variable status Status of the test execution (e.g., passed, failed).
Instance Variable traceback Formatted traceback lines if an error occurred, otherwise None.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method __post_init__ Provide a no-op hook for subclass validation and normalization.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
class_name: str | None, optional = (source)

Name of the class containing the test, if applicable.

doc_string: str | None, optional = (source)

Docstring of the test, if applicable.

error_message: str | None, optional = (source)

Error message if the test failed, otherwise None.

exception: str | None, optional = (source)

Name of the raised exception class if an error occurred, otherwise None.

execution_time: float = (source)

Time taken to execute the test, in seconds.

file_path: str | None, optional = (source)

Path to the file containing the test, if applicable.

Unique identifier for the test result.

line_no: int | None, optional = (source)

Source line associated with the failure, if available.

method: str | None, optional = (source)

Name of the method representing the test, if applicable.

module: str | None, optional = (source)

Name of the module containing the test, if applicable.

Name of the test.

source_code: list[tuple[int, str]] | None, optional = (source)

Source line numbers and text surrounding the failure.

Status of the test execution (e.g., passed, failed).

traceback: list[str] | None, optional = (source)

Formatted traceback lines if an error occurred, otherwise None.