Skip to content

set pair on CompareError instead of just index #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pmeier merged 2 commits into from
Jun 9, 2025
Merged

set pair on CompareError instead of just index #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e79c529
set pair on CompareError instead of just index
pmeier Jun 9, 2025
dd1a3e7
Merge branch 'main' into compare-error-pair
pmeier Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/compyre/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ class Pair:

@dataclasses.dataclass
class CompareError:
"""Comparison exception with position information."""
"""Comparison exception with pair that caused it."""

index: tuple[str | int, ...]
pair: Pair
exception: Exception


Expand Down Expand Up @@ -130,7 +130,7 @@ def compare(

if unpack_result is not None:
if isinstance(unpack_result, Exception):
errors.append(CompareError(index=pair.index, exception=unpack_result))
errors.append(CompareError(pair=pair, exception=unpack_result))
else:
for p in reversed(unpack_result):
pairs.appendleft(p)
Expand All @@ -153,7 +153,7 @@ def compare(
)

if isinstance(equal_result, Exception):
errors.append(CompareError(index=pair.index, exception=equal_result))
errors.append(CompareError(pair, exception=equal_result))

return errors

Expand Down Expand Up @@ -366,7 +366,7 @@ def _extract_equal_errors(errors: list[CompareError]) -> list[CompareError]:
def _format_compare_errors(errors: list[CompareError]) -> str:
parts = []
for e in errors:
i = ".".join(map(str, e.index))
i = ".".join(map(str, e.pair.index))
m = f"{type(e.exception).__name__}: {e.exception}"
parts.append(f"{i}\n{indent(m, ' ' * 4)}")
return "\n".join(parts)
6 changes: 3 additions & 3 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ def unpack_fn(pair, /):
assert len(errors) == 1
error = errors[0]

assert error.index == ()
assert error.pair.index == ()
assert error.exception is exc

def test_unpack_pairs_order(self):
Expand Down Expand Up @@ -286,7 +286,7 @@ def equal_fn(pair, /):
assert len(errors) == 1
error = errors[0]

assert error.index == ()
assert error.pair.index == ()

assert isinstance(error.exception, api.CompyreError)
assert all(
Expand All @@ -313,7 +313,7 @@ def equal_fn(pair, /):
assert len(errors) == 1
error = errors[0]

assert error.index == ()
assert error.pair.index == ()

assert isinstance(error.exception, AssertionError)
assert repr(actual) in str(error.exception)
Expand Down