Python: assert vs throw AssertionError

[AlexanderLanin]

assert output:

        for warning_info in rst_data.warning_infos:
            for expected in warning_info.expected:
>               assert warning_matches(rst_data, warning_info, expected, warnings), (
                    f"Expected warning: {expected} not found"
                )
E               AssertionError: Expected warning: feat_req__child__abce: parent need `feat_req__parent__abcd` does not fulfill condition `{'and': ['safety != QM', 'status == valid']}`. not found
E               assert False
E                +  where False = warning_matches(RstData(filename='test_metamodel_graph.rst', enabled_checks='check_metamodel_graph', warning_infos=[WarningInfo(lineno...pected=[], not_expected=['feat_req__child2__abce: parent need `feat_req__parent2__abcd` does not fulfill condition'])]), WarningInfo(lineno=23, expected=["feat_req__child__abce: parent need `feat_req__parent__abcd` does not fulfill condition `{'and': ['safety != QM', 'status == valid']}`."], not_expected=[]), "feat_req__child__abce: parent need `feat_req__parent__abcd` does not fulfill condition `{'and': ['safety != QM', 'status == valid']}`.", ['\x1b[91m/tmp/pytest-of-vscode/pytest-40/docs0/test_metamodel_graph.rst:14: WARNING: Explicit markup ends without a b... to document 'test_metamodel_graph' that doesn't have a title: no link will be generated [toc.no_title]\x1b[39;49;00m"])

/workspaces/score/docs/_tooling/extensions/score_metamodel/tests/test_rules_file_based.py:198: AssertionError

throw output:

        for warning_info in rst_data.warning_infos:
            for expected in warning_info.expected:
                if not warning_matches(rst_data, warning_info, expected, warnings):
>                   raise AssertionError(f"Expected warning: {expected} not found")
E                   AssertionError: Expected warning: feat_req__child__abce: parent need `feat_req__parent__abcd` does not fulfill condition `{'and': ['safety != QM', 'status == valid']}`. not found

/workspaces/score/docs/_tooling/extensions/score_metamodel/tests/test_rules_file_based.py:199: AssertionError

[MaximilianSoerenPollak]

The assertion error has cleaner output for sure.

I however in my opinion like asserts a lot, especially using them frequently if possible to assert worldview at points where it makes no sense to continue / recover if the worldview you are expecting at that moment is not met.

[AlexanderLanin]

Maybe that's exactly it: asserts assert the world view and print it in case of errors (stack trace).

In some cases however, we want to optimize for usability (for the test author). They do not need or even want a stack trace when something is wrong with the rst file.

[MaximilianSoerenPollak]

I think in this instance it makes more sense to have the error raised, as it gives a more readable output.
And then use asserts in maybe other tests & the normal running code depening on what / where it is.

That seems reasonable