Improve error message for array_equal asserts.

[csadorf]

No description provided.

[wphicks]

I like this change generally, but we should look at the CI failures not just to fix them but to make sure we like the error formatting we're seeing.

[csadorf]

I like this change generally, but we should look at the CI failures not just to fix them but to make sure we like the error formatting we're seeing.

Good point. The problem is that right now this will only print nice errors if the repr is explicitly printed, i.e., to not show \n, but print an actual line break. I think it might be possible to generally get a nicer output by implementing a custom pytest_assertrepr_compare for this class.

[wphicks]

I think it might be possible to generally get a nicer output by implementing a custom pytest_assertrepr_compare for this class.

Totally fine to leave that for a followup. If you're going to do so, though, just be sure to create an associated issue.

[csadorf]

I think it might be possible to generally get a nicer output by implementing a custom pytest_assertrepr_compare for this class.

Totally fine to leave that for a followup. If you're going to do so, though, just be sure to create an associated issue.

I'll try to address that immediately.

[csadorf]

Not quite happy with the latest change yet, as it encourages array_equal == True patterns.

[csadorf]

@wphicks This would be ready for another review. I have adjusted the error message slightly and also added a assert_array_equal function in analogy to np.testing.assert_equal which would probably be preferred over assert array_equal. There is unfortunately currently no way to hack pytest to show a custom error message for simple asserts (not a comparison), see pytest-dev/pytest#5535 .

Edit: Clarifying assert_array_eqal would be preferred over assert array_equal

[wphicks]

@gpucibot merge