evidently.suite

Submodules

base_suite module

class Context(execution_graph: Optional[ExecutionGraph], metrics: list, tests: list, metric_results: dict, test_results: dict, state: State, renderers: RenderersDefinitions)

Bases: object

Pipeline execution context tracks pipeline execution and lifecycle

Attributes:

execution_graph : Optional[ExecutionGraph]

metric_results : dict

metrics : list

renderers : RenderersDefinitions

state : State

test_results : dict

tests : list

class Display(options: Optional[list] = None)

Bases: object

Attributes:

options_provider : OptionsProvider

Methods:

abstract as_dict()

json()

save_html(filename: str, mode: Union[str, SaveMode] = SaveMode.SINGLE_FILE)

save_json(filename)

show()

exception ExecutionError()

Bases: Exception

class State(name: str)

Bases: object

Attributes:

name : str

class States()

Bases: object

Attributes:

Calculated = State(name='Calculated')

Init = State(name='Init')

Tested = State(name='Tested')

Verified = State(name='Verified')

class Suite()

Bases: object

Attributes:

context : Context

Methods:

add_metric(metric: Metric)

add_test(test: Test)

run_calculate(data: InputData)

run_checks()

verify()

find_metric_renderer(obj, renderers: RenderersDefinitions)

find_test_renderer(obj, renderers: RenderersDefinitions)

execution_graph module

class ExecutionGraph()

Bases: object

Methods:

abstract get_metric_execution_iterator()

abstract get_test_execution_iterator()

class SimpleExecutionGraph(metrics: List[Metric], tests: List[Test])

Bases: ExecutionGraph

Simple execution graph without any work with dependencies at all,

assumes that metrics already in order for execution

Attributes:

metrics : List[Metric]

tests : List[Test]

Methods:

get_metric_execution_iterator()

get_test_execution_iterator()