footings.testing.assert_footings_xlsx_files_equal¶
-
assert_footings_xlsx_files_equal
(test: str, expected: str, tolerance: Optional[float] = None, exclude_keys: Optional[list] = None)[source]¶ Assert whether two footing xlsx files are equal. This function is useful for unit testing models to ensure models stay true over time.
- Parameters
test (str) – The path to the test file.
expected (str) – The path to the expected file.
tolerance (Union[float,None]) – The tolerance to test on numeric values.
exclude_keys (Union[list,None]) – Keys to exclude from testing.
- Returns
True or false on whether files are equal given parameters.
- Return type
bool
- Raises
ValueError – If the test and expected files share different extension types.
AssertionError – If any records between the test and expected files are different.