How to Create a Custom Reporter

Contents

• Extend Reporter
• Example Custom Diff Tool
• Example NumPy

Extend Reporter

Create a class that extends Reporter and implement the report function. Report should return true/false based on if it is able to successfully report, this allows other reporters to try when the current one is unable to.

Example Custom Diff Tool

You can build your own GenericDiffReporter

class GettingStartedTest(unittest.TestCase):
    def test_simple(self):
        verify(
            "Hello",
            options=Options().with_reporter(
                GenericDiffReporter.create(r"C:\my\favorite\diff\utility.exe")
            ),
        )

^{snippet source | anchor}

As long as C:/my/favorite/diff/utility.exe can be invoked from the command line using the format utility.exe file1 file2 then it will be compatible with GenericDiffReporter. Otherwise you will have to derive your own reporter, which we won't cover here.

Example NumPy

def load_ndarray(path: str):
    with open(path, mode="rb") as f:
        return np.load(f)

class NDArrayDiffReporter(Reporter):
    @override
    def report(self, received_path: str, approved_path: str) -> bool:
        if not Path(approved_path).is_file():
            self._create_empty_array(approved_path)
        received = load_ndarray(received_path)
        approved = load_ndarray(approved_path)
        to_approve_msg = (
            f"To approve run:\n {get_command_text(received_path, approved_path)}"
        )
        print(np.testing.build_err_msg([received, approved], err_msg=to_approve_msg))
        return True

^{snippet source | anchor}