fgen_runtime.testing

Testing tools

CompareDataCallable

class CompareDataCallable(*args, **kwargs)

Bases: Protocol

assert_timeseries_collection_equal

assert_timeseries_collection_equal(left, right)

Assert that two TimeseriesCollection are equal

Parameters:

• left (fgen_runtime.timeseries_collection.TimeseriesCollection) – First object to compare

• right (fgen_runtime.timeseries_collection.TimeseriesCollection) – Second object to compare

Raises:

AssertionError – The two objects are not equal

Return type:

None

assert_timeseries_collection_allclose

assert_timeseries_collection_allclose(left, right, rtol=1e-06, atol=1e-08)

Assert that two TimeseriesCollection’s values are all close

Parameters:

• left (fgen_runtime.timeseries_collection.TimeseriesCollection) – First object to compare

• right (fgen_runtime.timeseries_collection.TimeseriesCollection) – Second object to compare

• rtol (float) – Relative tolerance to pass through to pint.testing.assert_allclose()

• atol (float) – Absolute tolerance to pass through to pint.testing.assert_allclose()

Raises:

AssertionError – The two objects are not equal

Return type:

None

assert_timeseries_collection_compare

assert_timeseries_collection_compare(left, right, compare_data, get_data_error_message)

Assert that two TimeseriesCollection’s values are all close

Parameters:

• left (fgen_runtime.timeseries_collection.TimeseriesCollection) – First object to compare

• right (fgen_runtime.timeseries_collection.TimeseriesCollection) – Second object to compare

• compare_data (fgen_runtime.testing.CompareDataCallable) – Function to use to compare the data attributes of left and right

• get_data_error_message (typing.Callable[[int], str]) – Function that creates the error message if the data attributes are not identical based on the index that is being compared.

Raises:

AssertionError – The two objects are not equal

Return type:

None