Skip to content

Core & object assertions

Assertions available on every value: equality, identity, type, None, truthiness, satisfies, structural matching, and recursive field checks.

Base mixin.

described_as 

described_as(description: str) -> Self

Describes the assertion. On failure, the description is included in the error message.

This is not an assertion itself. But if the any of the following chained assertions fail, the description will be included in addition to the regular error message.

Parameters:

Name Type Description Default
description str

the error message description

 required

Examples:

Usage:

assert_that(1).described_as('error msg desc').is_equal_to(2)  # fails
# [error msg desc] Expected <1> to be equal to <2>, but was not.

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion
Source code in assertpy2/base.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def described_as(self, description: str) -> Self:
    """Describes the assertion.  On failure, the description is included in the error message.

    This is not an assertion itself.  But if the any of the following chained assertions fail,
    the description will be included in addition to the regular error message.

    Args:
        description: the error message description

    Examples:
        Usage:

            assert_that(1).described_as('error msg desc').is_equal_to(2)  # fails
            # [error msg desc] Expected <1> to be equal to <2>, but was not.

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion
    """
    self.description = str(description)
    return self

is_equal_to 

is_equal_to(other: object, **kwargs: object) -> Self

Asserts that val is equal to other.

Checks actual is equal to expected using the == operator. When val is dict-like or has introspectable fields (dataclass, namedtuple, attrs, Pydantic model), optionally ignore or include keys/fields when checking equality.

Parameters:

Name Type Description Default
other object

the expected value

 required
**kwargs object

see below

 {}

Other Parameters:

Name Type Description
ignore Hashable | list | set | frozenset | None

the key/field (or list/set/frozenset of keys/fields) to ignore. Besides exact keys and nested-path tuples, a re.Pattern matches field names by regex and a type matches fields by value type.
include Hashable | list | set | frozenset | None

the key/field (or list/set/frozenset of keys/fields) to include. Accepts the same re.Pattern / type specs as ignore.
tolerance float | None

an absolute tolerance applied to every real-number leaf anywhere in the structure, so close floats compare equal (abs(actual - expected) <= tolerance).
comparators dict | None

a dict mapping a type or a field name to an (actual, expected) -> bool predicate that owns matching leaves; a field-name key wins over a type key.
ignore_null bool

when True, skip any named field the expected side leaves None (a partial expected/template), at any depth. Only the expected side is skipped, so an unexpectedly None actual field is still reported. Defaults to False.
strict_types bool

when True, both sides of every node must be the same type, at any depth. Plain == does not require this: True == 1, Decimal("1") == 1 and [True] == [1] are all true, so a boolean read from JSON compares equal to an integer without a word. Opting in also rejects pairs some callers consider equal (IntEnum against int, a dict subclass against dict, float against int), and it wins over tolerance, which says how far apart two numbers may be and not that they may be different types. A comparators entry still owns its leaves, and a Matcher on the expected side is exempt, so composed matchers keep working. Anything matched by hash is outside it, which means both dictionary keys and set elements: {True: "a"} against {1: "a"} and {1} against {1.0} both pass, because the pair is found before anything looks at its type and the recursion never sees it. The same values inside a list are covered normally, so [True] against [1] does fail. Defaults to False.

Examples:

Usage:

assert_that(1 + 2).is_equal_to(3)
assert_that('foo').is_equal_to('foo')
assert_that(123).is_equal_to(123)
assert_that(123.4).is_equal_to(123.4)
assert_that(['a', 'b']).is_equal_to(['a', 'b'])
assert_that((1, 2, 3)).is_equal_to((1, 2, 3))
assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1, 'b': 2})
assert_that({'a', 'b'}).is_equal_to({'a', 'b'})

When the val is dict-like, keys can optionally be ignored when checking equality:

# ignore a single key
assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1}, ignore='b')

# ignore multiple keys
assert_that({'a': 1, 'b': 2, 'c': 3}).is_equal_to({'a': 1}, ignore=['b', 'c'])

# ignore nested keys
assert_that({'a': {'b': 2, 'c': 3, 'd': 4}}).is_equal_to(
    {'a': {'d': 4}}, ignore=[('a', 'b'), ('a', 'c')]
)

When the val is dict-like, only certain keys can be included when checking equality:

# include a single key
assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1}, include='a')

# include multiple keys
assert_that({'a': 1, 'b': 2, 'c': 3}).is_equal_to({'a': 1, 'b': 2}, include=['a', 'b'])

Works with dataclasses, namedtuples, attrs, and Pydantic models:

@dataclass
class User:
    id: int
    name: str

assert_that(User(id=1, name="Alice")).is_equal_to(User(id=99, name="Alice"), ignore="id")

Compares lists of objects pairwise:

actual = [User(id=1, name="Alice"), User(id=2, name="Bob")]
expected = [User(id=99, name="Alice"), User(id=99, name="Bob")]
assert_that(actual).is_equal_to(expected, ignore="id")

Compare nested floats with an absolute tolerance, or supply custom comparators:

assert_that({"price": 1.0001}).is_equal_to({"price": 1.0}, tolerance=0.001)

# by type, or by field name (field name wins over type)
assert_that(actual).is_equal_to(expected, comparators={float: lambda a, e: round(a, 2) == round(e, 2)})
assert_that(actual).is_equal_to(expected, comparators={"name": lambda a, e: a.lower() == e.lower()})

Ignore fields by regex or by type:

import re

assert_that(payload).is_equal_to(expected, ignore=re.compile(r"^_"))  # ignore private-ish keys
assert_that(payload).is_equal_to(expected, ignore=float)               # ignore all float fields

Require the same type at every level, which plain == does not:

assert_that({"active": True}).is_equal_to({"active": 1})                     # passes
assert_that({"active": True}).is_equal_to({"active": 1}, strict_types=True)  # fails

Failure produces a nice error message:

assert_that(1).is_equal_to(2)  # fails
# Expected <1> to be equal to <2>, but was not.

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if actual is not equal to expected
TypeError

if ignore/include is a one-shot or otherwise unsupported iterable, or is used on a value that is neither dict-like nor has introspectable fields; if tolerance is not a real number or comparators is not a dict of callables; or if val or other is (or contains, at any nesting depth) an element-wise array/frame-like (numpy/pandas/polars) whose == has no single truth value (compare the value's own equality, e.g. actual.equals(expected), instead)
ValueError

if tolerance is NaN or negative
Tip

Using is_equal_to() with a float val is just asking for trouble. Instead, you'll always want to use fuzzy numeric assertions like is_close_to() or is_between().

See Also

is_equal_to_ignoring_case() - for case-insensitive string equality

Source code in assertpy2/base.py 
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
def is_equal_to(self, other: object, **kwargs: object) -> Self:
    """Asserts that val is equal to other.

    Checks actual is equal to expected using the ``==`` operator. When val is *dict-like*
    or has introspectable fields (dataclass, namedtuple, attrs, Pydantic model),
    optionally ignore or include keys/fields when checking equality.

    Args:
        other: the expected value
        **kwargs: see below

    Keyword Args:
        ignore (Hashable | list | set | frozenset | None): the key/field (or list/set/frozenset of
            keys/fields) to ignore.  Besides exact keys and nested-path tuples, a ``re.Pattern`` matches
            field names by regex and a ``type`` matches fields by value type.
        include (Hashable | list | set | frozenset | None): the key/field (or list/set/frozenset of
            keys/fields) to include.  Accepts the same ``re.Pattern`` / ``type`` specs as ``ignore``.
        tolerance (float | None): an absolute tolerance applied to every real-number leaf anywhere in
            the structure, so close floats compare equal (``abs(actual - expected) <= tolerance``).
        comparators (dict | None): a dict mapping a ``type`` or a field name to an
            ``(actual, expected) -> bool`` predicate that owns matching leaves; a field-name key wins
            over a type key.
        ignore_null (bool): when ``True``, skip any named field the *expected* side leaves ``None``
            (a partial expected/template), at any depth.  Only the expected side is skipped, so an
            unexpectedly ``None`` actual field is still reported.  Defaults to ``False``.
        strict_types (bool): when ``True``, both sides of every node must be the same type, at any
            depth.  Plain ``==`` does not require this: ``True == 1``, ``Decimal("1") == 1`` and
            ``[True] == [1]`` are all true, so a boolean read from JSON compares equal to an
            integer without a word.  Opting in also rejects pairs some callers consider equal
            (``IntEnum`` against ``int``, a ``dict`` subclass against ``dict``, ``float`` against
            ``int``), and it wins over ``tolerance``, which says how far apart two numbers may be
            and not that they may be different types.  A ``comparators`` entry still owns its
            leaves, and a `Matcher` on the expected side is exempt, so composed matchers keep
            working.  Anything matched *by hash* is outside it, which means both dictionary keys
            and set elements: ``{True: "a"}`` against ``{1: "a"}`` and ``{1}`` against ``{1.0}``
            both pass, because the pair is found before anything looks at its type and the
            recursion never sees it.  The same values inside a list are covered normally, so
            ``[True]`` against ``[1]`` does fail.  Defaults to ``False``.

    Examples:
        Usage:

            assert_that(1 + 2).is_equal_to(3)
            assert_that('foo').is_equal_to('foo')
            assert_that(123).is_equal_to(123)
            assert_that(123.4).is_equal_to(123.4)
            assert_that(['a', 'b']).is_equal_to(['a', 'b'])
            assert_that((1, 2, 3)).is_equal_to((1, 2, 3))
            assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1, 'b': 2})
            assert_that({'a', 'b'}).is_equal_to({'a', 'b'})

        When the val is *dict-like*, keys can optionally be *ignored* when checking equality:

            # ignore a single key
            assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1}, ignore='b')

            # ignore multiple keys
            assert_that({'a': 1, 'b': 2, 'c': 3}).is_equal_to({'a': 1}, ignore=['b', 'c'])

            # ignore nested keys
            assert_that({'a': {'b': 2, 'c': 3, 'd': 4}}).is_equal_to(
                {'a': {'d': 4}}, ignore=[('a', 'b'), ('a', 'c')]
            )

        When the val is *dict-like*, only certain keys can be *included* when checking equality:

            # include a single key
            assert_that({'a': 1, 'b': 2}).is_equal_to({'a': 1}, include='a')

            # include multiple keys
            assert_that({'a': 1, 'b': 2, 'c': 3}).is_equal_to({'a': 1, 'b': 2}, include=['a', 'b'])

        Works with dataclasses, namedtuples, attrs, and Pydantic models:

            @dataclass
            class User:
                id: int
                name: str

            assert_that(User(id=1, name="Alice")).is_equal_to(User(id=99, name="Alice"), ignore="id")

        Compares lists of objects pairwise:

            actual = [User(id=1, name="Alice"), User(id=2, name="Bob")]
            expected = [User(id=99, name="Alice"), User(id=99, name="Bob")]
            assert_that(actual).is_equal_to(expected, ignore="id")

        Compare nested floats with an absolute tolerance, or supply custom comparators:

            assert_that({"price": 1.0001}).is_equal_to({"price": 1.0}, tolerance=0.001)

            # by type, or by field name (field name wins over type)
            assert_that(actual).is_equal_to(expected, comparators={float: lambda a, e: round(a, 2) == round(e, 2)})
            assert_that(actual).is_equal_to(expected, comparators={"name": lambda a, e: a.lower() == e.lower()})

        Ignore fields by regex or by type:

            import re

            assert_that(payload).is_equal_to(expected, ignore=re.compile(r"^_"))  # ignore private-ish keys
            assert_that(payload).is_equal_to(expected, ignore=float)               # ignore all float fields

        Require the same type at every level, which plain ``==`` does not:

            assert_that({"active": True}).is_equal_to({"active": 1})                     # passes
            assert_that({"active": True}).is_equal_to({"active": 1}, strict_types=True)  # fails

        Failure produces a nice error message:

            assert_that(1).is_equal_to(2)  # fails
            # Expected <1> to be equal to <2>, but was not.

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if actual is **not** equal to expected
        TypeError: if ``ignore``/``include`` is a one-shot or otherwise unsupported iterable, or is
            used on a value that is neither dict-like nor has introspectable fields; if ``tolerance`` is
            not a real number or ``comparators`` is not a dict of callables; or if val or other is (or
            contains, at any nesting depth) an element-wise array/frame-like (numpy/pandas/polars) whose
            ``==`` has no single truth value (compare the value's own equality, e.g.
            ``actual.equals(expected)``, instead)
        ValueError: if ``tolerance`` is ``NaN`` or negative

    Tip:
        Using [`is_equal_to()`][assertpy2.base.BaseMixin.is_equal_to] with a ``float`` val is just
        asking for trouble. Instead, you'll
        always want to use *fuzzy* numeric assertions
        like [`is_close_to()`][assertpy2.numeric.NumericMixin.is_close_to]
        or [`is_between()`][assertpy2.numeric.NumericMixin.is_between].

    See Also:
        [`is_equal_to_ignoring_case()`][assertpy2.string.StringMixin.is_equal_to_ignoring_case] -
            for case-insensitive string equality
    """
    if not kwargs:
        if type(self.val) in _EQ_ATOMIC and type(other) in _EQ_ATOMIC:
            # atomic scalars: no array/dict-likeness, == yields a real bool - skip config/guards entirely
            if self.val != other:
                if isinstance(self.val, str) and isinstance(other, str):
                    actual_repr = _truncated(_elided_text_repr(self.val, other))
                    expected_repr = _truncated(_elided_text_repr(other, self.val))
                else:
                    actual_repr, expected_repr = _disambiguated(self.val, other)
                return self.error(
                    f"Expected <{actual_repr}> to be equal to <{expected_repr}>, but was not.",
                    actual=self.val,
                    expected=other,
                    diff=_build_equality_diff(self.val, other),
                )
            return self
        ignore = include = config = None
    else:
        reject_unknown_kwargs(kwargs, _IS_EQUAL_TO_OPTIONS, "is_equal_to")
        ignore = kwargs.get("ignore")
        include = kwargs.get("include")
        config = _build_compare_config(
            kwargs.get("tolerance"),
            kwargs.get("comparators"),
            kwargs.get("ignore_null", False),
            kwargs.get("strict_types", False),
        )

    operand = _ambiguous_array_operand(self.val, other)
    if operand is not None:
        raise _array_equality_error("is_equal_to", operand)

    if config is not None and config.strict_types and _types_differ(self.val, other):
        # the dispatch below routes two dict-likes straight into the key walk, which never sees the
        # pair itself, so an OrderedDict against a dict would otherwise pass a strict comparison
        actual_repr, expected_repr = _disambiguated(self.val, other)
        return self.error(
            f"Expected <{actual_repr}> to be equal to <{expected_repr}>, but was not.{_config_note(config)}",
            actual=self.val,
            expected=other,
            diff=_build_equality_diff(self.val, other, config=config),
        )

    if mapping_shaped(self.val, check_values=False) and mapping_shaped(other, check_values=False):
        if self._dict_not_equal(self.val, other, ignore=ignore, include=include, config=config):
            self._dict_err(self.val, other, ignore=ignore, include=include, config=config)
    elif ignore or include:
        val_is_namedtuple = is_namedtuple(self.val)
        other_is_namedtuple = is_namedtuple(other)
        if (
            isinstance(self.val, (list, tuple))
            and isinstance(other, (list, tuple))
            and not val_is_namedtuple
            and not other_is_namedtuple
        ):
            self._seq_equal_with_filter(self.val, other, ignore=ignore, include=include, config=config)
        else:
            self._obj_equal_with_filter(self.val, other, ignore=ignore, include=include, config=config)
    elif config is not None:
        diff = _build_equality_diff(self.val, other, config=config)
        if diff.entries:
            return self.error(
                f"Expected <{_truncated(str(self.val))}> to be equal to <{_truncated(str(other))}>, but was not."
                f"{_config_note(config)}",
                actual=self.val,
                expected=other,
                diff=diff,
            )
    else:
        if _guarded_not_equal(self.val, other):
            if _both_list_like(self.val, other):
                actual_repr = _truncated(_elided_seq_repr(self.val, other))
                expected_repr = _truncated(_elided_seq_repr(other, self.val))
            else:
                actual_repr, expected_repr = _disambiguated(self.val, other)
            diff = _build_equality_diff(self.val, other)
            return self.error(
                f"Expected <{actual_repr}> to be equal to <{expected_repr}>, but was not.",
                actual=self.val,
                expected=other,
                diff=diff,
            )
    return self

is_not_equal_to 

is_not_equal_to(other: object) -> Self

Asserts that val is not equal to other.

Checks actual is not equal to expected using the != operator.

Parameters:

Name Type Description Default
other object

the expected value

 required

Examples:

Usage:

assert_that(1 + 2).is_not_equal_to(4)
assert_that('foo').is_not_equal_to('bar')
assert_that(123).is_not_equal_to(456)
assert_that(123.4).is_not_equal_to(567.8)
assert_that(['a', 'b']).is_not_equal_to(['c', 'd'])
assert_that((1, 2, 3)).is_not_equal_to((1, 2, 4))
assert_that({'a': 1, 'b': 2}).is_not_equal_to({'a': 1, 'b': 3})
assert_that({'a', 'b'}).is_not_equal_to({'a', 'x'})

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if actual is equal to expected
TypeError

if val or other is (or contains, at any nesting depth) an element-wise array/frame-like (numpy/pandas/polars) whose == has no single truth value; compare the value's own equality instead
Source code in assertpy2/base.py 
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
def is_not_equal_to(self, other: object) -> Self:
    """Asserts that val is not equal to other.

    Checks actual is not equal to expected using the ``!=`` operator.

    Args:
        other: the expected value

    Examples:
        Usage:

            assert_that(1 + 2).is_not_equal_to(4)
            assert_that('foo').is_not_equal_to('bar')
            assert_that(123).is_not_equal_to(456)
            assert_that(123.4).is_not_equal_to(567.8)
            assert_that(['a', 'b']).is_not_equal_to(['c', 'd'])
            assert_that((1, 2, 3)).is_not_equal_to((1, 2, 4))
            assert_that({'a': 1, 'b': 2}).is_not_equal_to({'a': 1, 'b': 3})
            assert_that({'a', 'b'}).is_not_equal_to({'a', 'x'})

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if actual **is** equal to expected
        TypeError: if val or other is (or contains, at any nesting depth) an element-wise
            array/frame-like (numpy/pandas/polars) whose ``==`` has no single truth value; compare
            the value's own equality instead
    """
    operand = _ambiguous_array_operand(self.val, other)
    if operand is not None:
        raise _array_equality_error("is_not_equal_to", operand)

    if _guarded_equal(self.val, other, method="is_not_equal_to"):
        return self.error(
            f"Expected <{_truncated(str(self.val))}> to be not equal to <{_truncated(str(other))}>, but was."
        )
    return self

is_same_as 

is_same_as(other: object) -> Self

Asserts that val is identical to other.

Checks actual is identical to expected using the is operator.

Parameters:

Name Type Description Default
other object

the expected value

 required

Examples:

Basic types are identical:

assert_that(1).is_same_as(1)
assert_that('foo').is_same_as('foo')
assert_that(123.4).is_same_as(123.4)

As are immutables like tuple:

assert_that((1, 2, 3)).is_same_as((1, 2, 3))

But mutable collections like list, dict, and set are not:

# these all fail...
assert_that(['a', 'b']).is_same_as(['a', 'b'])  # fails
assert_that({'a': 1, 'b': 2}).is_same_as({'a': 1, 'b': 2})  # fails
assert_that({'a', 'b'}).is_same_as({'a', 'b'})  # fails

Unless they are the same object:

x = {'a': 1, 'b': 2}
y = x
assert_that(x).is_same_as(y)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if actual is not identical to expected
Source code in assertpy2/base.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
def is_same_as(self, other: object) -> Self:
    """Asserts that val is identical to other.

    Checks actual is identical to expected using the ``is`` operator.

    Args:
        other: the expected value

    Examples:
        Basic types are identical:

            assert_that(1).is_same_as(1)
            assert_that('foo').is_same_as('foo')
            assert_that(123.4).is_same_as(123.4)

        As are immutables like ``tuple``:

            assert_that((1, 2, 3)).is_same_as((1, 2, 3))

        But mutable collections like ``list``, ``dict``, and ``set`` are not:

            # these all fail...
            assert_that(['a', 'b']).is_same_as(['a', 'b'])  # fails
            assert_that({'a': 1, 'b': 2}).is_same_as({'a': 1, 'b': 2})  # fails
            assert_that({'a', 'b'}).is_same_as({'a', 'b'})  # fails

        Unless they are the same object:

            x = {'a': 1, 'b': 2}
            y = x
            assert_that(x).is_same_as(y)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if actual is **not** identical to expected
    """
    if self.val is not other:
        return self.error(f"Expected <{self.val}> to be identical to <{other}>, but was not.")
    return self

is_not_same_as 

is_not_same_as(other: object) -> Self

Asserts that val is not identical to other.

Checks actual is not identical to expected using the is operator.

Parameters:

Name Type Description Default
other object

the expected value

 required

Examples:

Usage:

assert_that(1).is_not_same_as(2)
assert_that('foo').is_not_same_as('bar')
assert_that(123.4).is_not_same_as(567.8)
assert_that((1, 2, 3)).is_not_same_as((1, 2, 4))

# mutable collections, even if equal, are not identical...
assert_that(['a', 'b']).is_not_same_as(['a', 'b'])
assert_that({'a': 1, 'b': 2}).is_not_same_as({'a': 1, 'b': 2})
assert_that({'a', 'b'}).is_not_same_as({'a', 'b'})

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if actual is identical to expected
Source code in assertpy2/base.py 
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
def is_not_same_as(self, other: object) -> Self:
    """Asserts that val is not identical to other.

    Checks actual is not identical to expected using the ``is`` operator.

    Args:
        other: the expected value

    Examples:
        Usage:

            assert_that(1).is_not_same_as(2)
            assert_that('foo').is_not_same_as('bar')
            assert_that(123.4).is_not_same_as(567.8)
            assert_that((1, 2, 3)).is_not_same_as((1, 2, 4))

            # mutable collections, even if equal, are not identical...
            assert_that(['a', 'b']).is_not_same_as(['a', 'b'])
            assert_that({'a': 1, 'b': 2}).is_not_same_as({'a': 1, 'b': 2})
            assert_that({'a', 'b'}).is_not_same_as({'a', 'b'})

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if actual **is** identical to expected
    """
    if self.val is other:
        return self.error(f"Expected <{self.val}> to be not identical to <{other}>, but was.")
    return self

is_true 

is_true() -> Self

Asserts that val is true.

Examples:

Usage:

assert_that(True).is_true()
assert_that(1).is_true()
assert_that('foo').is_true()
assert_that(1.0).is_true()
assert_that(['a', 'b']).is_true()
assert_that((1, 2, 3)).is_true()
assert_that({'a': 1, 'b': 2}).is_true()
assert_that({'a', 'b'}).is_true()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is false
Source code in assertpy2/base.py 
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
def is_true(self) -> Self:
    """Asserts that val is true.

    Examples:
        Usage:

            assert_that(True).is_true()
            assert_that(1).is_true()
            assert_that('foo').is_true()
            assert_that(1.0).is_true()
            assert_that(['a', 'b']).is_true()
            assert_that((1, 2, 3)).is_true()
            assert_that({'a': 1, 'b': 2}).is_true()
            assert_that({'a', 'b'}).is_true()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val **is** false
    """
    if not self.val:
        return self.error(f"Expected <{self.val}> to be <True>, but was not.")
    return self

is_false 

is_false() -> Self

Asserts that val is false.

Examples:

Usage:

assert_that(False).is_false()
assert_that(0).is_false()
assert_that('').is_false()
assert_that(0.0).is_false()
assert_that([]).is_false()
assert_that(()).is_false()
assert_that({}).is_false()
assert_that(set()).is_false()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is true
Source code in assertpy2/base.py 
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
def is_false(self) -> Self:
    """Asserts that val is false.

    Examples:
        Usage:

            assert_that(False).is_false()
            assert_that(0).is_false()
            assert_that('').is_false()
            assert_that(0.0).is_false()
            assert_that([]).is_false()
            assert_that(()).is_false()
            assert_that({}).is_false()
            assert_that(set()).is_false()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val **is** true
    """
    if self.val:
        return self.error(f"Expected <{self.val}> to be <False>, but was not.")
    return self

is_none 

is_none() -> Self

Asserts that val is none.

Examples:

Usage:

assert_that(None).is_none()
assert_that(print('hello world')).is_none()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not none
Source code in assertpy2/base.py 
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
def is_none(self) -> Self:
    """Asserts that val is none.

    Examples:
        Usage:

            assert_that(None).is_none()
            assert_that(print('hello world')).is_none()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** none
    """
    if self.val is not None:
        return self.error(f"Expected <{self.val}> to be <None>, but was not.")
    return self

is_not_none 

is_not_none() -> Self

Asserts that val is not none.

Examples:

Usage:

assert_that(0).is_not_none()
assert_that('foo').is_not_none()
assert_that(False).is_not_none()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is none
Source code in assertpy2/base.py 
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
def is_not_none(self) -> Self:
    """Asserts that val is not none.

    Examples:
        Usage:

            assert_that(0).is_not_none()
            assert_that('foo').is_not_none()
            assert_that(False).is_not_none()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val **is** none
    """
    if self.val is None:
        return self.error("Expected not <None>, but was.")
    return self

is_type_of 

is_type_of(some_type) -> Self

Asserts that val is of the given type.

Parameters:

Name Type Description Default
some_type type

the expected type

 required

Examples:

Usage:

assert_that(1).is_type_of(int)
assert_that('foo').is_type_of(str)
assert_that(123.4).is_type_of(float)
assert_that(['a', 'b']).is_type_of(list)
assert_that((1, 2, 3)).is_type_of(tuple)
assert_that({'a': 1, 'b': 2}).is_type_of(dict)
assert_that({'a', 'b'}).is_type_of(set)
assert_that(True).is_type_of(bool)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not of the given type
Source code in assertpy2/base.py 
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
def is_type_of(self, some_type) -> Self:
    """Asserts that val is of the given type.

    Args:
        some_type (type): the expected type

    Examples:
        Usage:

            assert_that(1).is_type_of(int)
            assert_that('foo').is_type_of(str)
            assert_that(123.4).is_type_of(float)
            assert_that(['a', 'b']).is_type_of(list)
            assert_that((1, 2, 3)).is_type_of(tuple)
            assert_that({'a': 1, 'b': 2}).is_type_of(dict)
            assert_that({'a', 'b'}).is_type_of(set)
            assert_that(True).is_type_of(bool)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** of the given type
    """
    if type(some_type) is not type and not issubclass(type(some_type), type):
        refuse(some_type, "a type", subject=argument("type"))
    if type(self.val) is not some_type:
        type_name = self._type(self.val)
        return self.error(f"Expected <{self.val}:{type_name}> to be of type <{some_type.__name__}>, but was not.")
    return self

is_instance_of 

is_instance_of(some_class: type) -> Self

Asserts that val is an instance of the given class.

Parameters:

Name Type Description Default
some_class type

the expected class

 required

Examples:

Usage:

assert_that(1).is_instance_of(int)
assert_that('foo').is_instance_of(str)
assert_that(123.4).is_instance_of(float)
assert_that(['a', 'b']).is_instance_of(list)
assert_that((1, 2, 3)).is_instance_of(tuple)
assert_that({'a': 1, 'b': 2}).is_instance_of(dict)
assert_that({'a', 'b'}).is_instance_of(set)
assert_that(True).is_instance_of(bool)

With a user-defined class:

class Foo: pass
f = Foo()
assert_that(f).is_instance_of(Foo)
assert_that(f).is_instance_of(object)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not an instance of the given class
Source code in assertpy2/base.py 
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
def is_instance_of(self, some_class: type) -> Self:
    """Asserts that val is an instance of the given class.

    Args:
        some_class: the expected class

    Examples:
        Usage:

            assert_that(1).is_instance_of(int)
            assert_that('foo').is_instance_of(str)
            assert_that(123.4).is_instance_of(float)
            assert_that(['a', 'b']).is_instance_of(list)
            assert_that((1, 2, 3)).is_instance_of(tuple)
            assert_that({'a': 1, 'b': 2}).is_instance_of(dict)
            assert_that({'a', 'b'}).is_instance_of(set)
            assert_that(True).is_instance_of(bool)

        With a user-defined class:

            class Foo: pass
            f = Foo()
            assert_that(f).is_instance_of(Foo)
            assert_that(f).is_instance_of(object)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** an instance of the given class
    """
    try:
        if not isinstance(self.val, some_class):
            type_name = self._type(self.val)
            return self.error(
                f"Expected <{self.val}:{type_name}> to be instance of class <{some_class.__name__}>, but was not."
            )
    except TypeError:
        refuse(some_class, "a class", subject=argument("class"))
    return self

is_instance_of_any 

is_instance_of_any(*some_classes: type) -> Self

Asserts that val is an instance of at least one of the given classes.

Parameters:

Name Type Description Default
*some_classes type

the candidate classes

 ()

Examples:

Usage:

assert_that(1).is_instance_of_any(int, float)
assert_that('foo').is_instance_of_any(str, bytes)
assert_that(TimeoutError()).is_instance_of_any(OSError, ValueError)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not an instance of any of the given classes
TypeError

if a given arg is not a class
ValueError

if no classes are given
Source code in assertpy2/base.py 
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
def is_instance_of_any(self, *some_classes: type) -> Self:
    """Asserts that val is an instance of at least one of the given classes.

    Args:
        *some_classes: the candidate classes

    Examples:
        Usage:

            assert_that(1).is_instance_of_any(int, float)
            assert_that('foo').is_instance_of_any(str, bytes)
            assert_that(TimeoutError()).is_instance_of_any(OSError, ValueError)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** an instance of any of the given classes
        TypeError: if a given arg is not a class
        ValueError: if no classes are given
    """
    if len(some_classes) == 0:
        raise ValueError("one or more args must be given")
    try:
        if not isinstance(self.val, some_classes):
            type_name = self._type(self.val)
            class_names = ", ".join(some_class.__name__ for some_class in some_classes)
            return self.error(
                f"Expected <{self.val}:{type_name}> to be instance of any of <{class_names}>, but was not."
            )
    except TypeError:
        refuse(some_classes, "classes", subject=argument("class"))
    return self

is_subclass_of 

is_subclass_of(some_class: type) -> Self

Asserts that val is a class and is a subclass of the given class.

Checks the class hierarchy using the issubclass() built-in, so a class counts as a subclass of itself.

Parameters:

Name Type Description Default
some_class type

the expected ancestor class

 required

Examples:

Usage:

assert_that(bool).is_subclass_of(int)
assert_that(TimeoutError).is_subclass_of(OSError)

class Base: pass
class Derived(Base): pass

assert_that(Derived).is_subclass_of(Base)
assert_that(Derived).is_subclass_of(Derived)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not a subclass of the given class
TypeError

if val or the given arg is not a class
Source code in assertpy2/base.py 
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
def is_subclass_of(self, some_class: type) -> Self:
    """Asserts that val is a class and is a subclass of the given class.

    Checks the class hierarchy using the ``issubclass()`` built-in, so a class counts as a
    subclass of itself.

    Args:
        some_class: the expected ancestor class

    Examples:
        Usage:

            assert_that(bool).is_subclass_of(int)
            assert_that(TimeoutError).is_subclass_of(OSError)

            class Base: pass
            class Derived(Base): pass

            assert_that(Derived).is_subclass_of(Base)
            assert_that(Derived).is_subclass_of(Derived)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** a subclass of the given class
        TypeError: if val or the given arg is not a class
    """
    require_type(self.val, type, "a class")
    try:
        if not issubclass(self.val, some_class):
            return self.error(
                f"Expected <{self.val.__name__}> to be subclass of <{some_class.__name__}>, but was not."
            )
    except TypeError:
        refuse(some_class, "a class", subject=argument("class"))
    return self

is_length 

is_length(length) -> Self

Asserts that val is the given length.

Checks val is the given length using the len() built-in.

Parameters:

Name Type Description Default
length int

the expected length

 required

Examples:

Usage:

assert_that('foo').is_length(3)
assert_that(['a', 'b']).is_length(2)
assert_that((1, 2, 3)).is_length(3)
assert_that({'a': 1, 'b': 2}).is_length(2)
assert_that({'a', 'b'}).is_length(2)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not the given length
Source code in assertpy2/base.py 
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
def is_length(self, length) -> Self:
    """Asserts that val is the given length.

    Checks val is the given length using the ``len()`` built-in.

    Args:
        length (int): the expected length

    Examples:
        Usage:

            assert_that('foo').is_length(3)
            assert_that(['a', 'b']).is_length(2)
            assert_that((1, 2, 3)).is_length(3)
            assert_that({'a': 1, 'b': 2}).is_length(2)
            assert_that({'a', 'b'}).is_length(2)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** the given length
    """
    if type(length) is not int:
        refuse(length, "an integer", subject=argument("length"))
    if length < 0:
        raise ValueError("given arg must be a positive int")
    if sized_len(self.val) != length:
        return self.error(f"Expected <{self.val}> to be of length <{length}>, but was <{sized_len(self.val)}>.")
    return self

is_length_between 

is_length_between(low: int, high: int) -> Self

Asserts that val's length is between low and high (both inclusive).

Checks val's length using the len() built-in, like is_length(). Identical to has_size_between() apart from the error message wording.

Parameters:

Name Type Description Default
low int

the inclusive lower length bound

 required
high int

the inclusive upper length bound

 required

Examples:

Usage:

assert_that('foo').is_length_between(1, 5)
assert_that(['a', 'b']).is_length_between(2, 2)
assert_that((1, 2, 3)).is_length_between(0, 3)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val's length is not between low and high
TypeError

if a given arg is not an int
ValueError

if a given arg is negative, or low is greater than high
Source code in assertpy2/base.py 
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
def is_length_between(self, low: int, high: int) -> Self:
    """Asserts that val's length is between low and high (both inclusive).

    Checks val's length using the ``len()`` built-in, like
    [`is_length()`][assertpy2.base.BaseMixin.is_length].  Identical to
    [`has_size_between()`][assertpy2.collection.CollectionMixin.has_size_between] apart from
    the error message wording.

    Args:
        low: the inclusive lower length bound
        high: the inclusive upper length bound

    Examples:
        Usage:

            assert_that('foo').is_length_between(1, 5)
            assert_that(['a', 'b']).is_length_between(2, 2)
            assert_that((1, 2, 3)).is_length_between(0, 3)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val's length is **not** between low and high
        TypeError: if a given arg is not an int
        ValueError: if a given arg is negative, or low is greater than high
    """
    if type(low) is not int:
        refuse(low, "an integer", subject=argument("low"))
    if type(high) is not int:
        refuse(high, "an integer", subject=argument("high"))
    if low < 0 or high < 0:
        raise ValueError("given args must be positive ints")
    if low > high:
        raise ValueError("given low arg must be less than given high arg")
    if not low <= sized_len(self.val) <= high:
        return self.error(
            f"Expected <{self.val}> to be of length between <{low}> and <{high}>, but was <{sized_len(self.val)}>."
        )
    return self

Predicate and matcher-application assertions: satisfies / each / *_satisfy / matches_structure.

all_fields_satisfy 

all_fields_satisfy(
    matcher: Matcher[Any] | Callable[..., bool],
    *,
    allow_empty: bool = False,
) -> Self

Asserts that every scalar leaf in val's object graph satisfies the given matcher.

Walks val recursively (mappings, dataclasses, namedtuples, Pydantic models, lists, tuples) and applies the matcher to each leaf value, reporting the path of every leaf that does not satisfy it. Scalars, strings, sets and opaque objects are treated as single leaves.

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher or callable predicate applied to every leaf

 required

Examples:

Usage:

from assertpy2 import match

assert_that({"a": 1, "nested": {"b": 2}}).all_fields_satisfy(match.is_positive())
assert_that([1, [2, 3]]).all_fields_satisfy(lambda x: x > 0)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if any leaf does not satisfy the matcher
TypeError

if matcher is neither a Matcher nor callable
Source code in assertpy2/_satisfies.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def all_fields_satisfy(self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = False) -> Self:
    """Asserts that every scalar leaf in val's object graph satisfies the given matcher.

    Walks val recursively (mappings, dataclasses, namedtuples, Pydantic models, lists, tuples) and
    applies the matcher to each leaf value, reporting the path of every leaf that does not satisfy it.
    Scalars, strings, sets and opaque objects are treated as single leaves.

    Args:
        matcher: a `Matcher` or callable predicate applied to every leaf

    Examples:
        Usage:

            from assertpy2 import match

            assert_that({"a": 1, "nested": {"b": 2}}).all_fields_satisfy(match.is_positive())
            assert_that([1, [2, 3]]).all_fields_satisfy(lambda x: x > 0)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if any leaf does **not** satisfy the matcher
        TypeError: if matcher is neither a Matcher nor callable
    """
    _warn_if_vacuous("all_fields_satisfy", self.val, allow_empty)
    if not _is_matcher(matcher) and not callable(matcher):
        refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    description = _describe_matcher(matcher)
    failures = [
        path.leaf_entry(actual=leaf, expected=description)
        for path, leaf in _walk_leaves(self.val)
        if not _apply_matcher(matcher, leaf)
    ]
    if failures:
        count = len(failures)
        field_word = "field" if count == 1 else "fields"
        return self.error(
            f"Expected all fields to satisfy {description}, but {count} {field_word} did not.",
            actual=self.val,
            expected=description,
            diff=DiffResult(kind="match", entries=failures),
        )
    return self

has_no_none_fields 

has_no_none_fields(*, allow_empty: bool = False) -> Self

Asserts that no scalar leaf in val's object graph is None.

Convenience wrapper over all_fields_satisfy() with a not-None matcher; reports the path of every None leaf found anywhere in the graph.

Examples:

Usage:

assert_that({"id": 1, "profile": {"name": "Alice"}}).has_no_none_fields()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if any leaf is None
Source code in assertpy2/_satisfies.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
def has_no_none_fields(self, *, allow_empty: bool = False) -> Self:
    """Asserts that no scalar leaf in val's object graph is ``None``.

    Convenience wrapper over `all_fields_satisfy()` with a not-``None`` matcher; reports the path
    of every ``None`` leaf found anywhere in the graph.

    Examples:
        Usage:

            assert_that({"id": 1, "profile": {"name": "Alice"}}).has_no_none_fields()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if any leaf **is** ``None``
    """
    _warn_if_vacuous("has_no_none_fields", self.val, allow_empty)
    return self.all_fields_satisfy(IsNotNoneMatcher(), allow_empty=True)

satisfies 

satisfies(
    matcher: Matcher[Any] | Callable[..., bool],
) -> Self

Asserts that val satisfies the given matcher.

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher instance, or a callable that takes a value and returns a bool

 required

Examples:

Usage with matchers:

from assertpy2 import match

assert_that(7).satisfies(match.greater_than(5) & match.less_than(10))
assert_that('hello').satisfies(match.starts_with('he'))

Usage with callables:

assert_that(42).satisfies(lambda x: x % 2 == 0)

When the callable is typed with TypeIs it also narrows the chain to the guarded type (refinement narrowing), so .value hands the value back typed - see Type Safety for checker support (advanced; not yet in PyCharm).

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val does not satisfy the matcher
Source code in assertpy2/_satisfies.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
def satisfies(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self:
    """Asserts that val satisfies the given matcher.

    Args:
        matcher: a `Matcher` instance, or a callable that takes
            a value and returns a bool

    Examples:
        Usage with matchers:

            from assertpy2 import match

            assert_that(7).satisfies(match.greater_than(5) & match.less_than(10))
            assert_that('hello').satisfies(match.starts_with('he'))

        Usage with callables:

            assert_that(42).satisfies(lambda x: x % 2 == 0)

        When the callable is typed with ``TypeIs`` it also *narrows* the chain to the guarded type
        (refinement narrowing), so ``.value`` hands the value back typed - see
        [Type Safety](../concepts/type-safety.md#refinement-narrowing-with-a-typeis-predicate-advanced) for
        checker support (advanced; not yet in PyCharm).

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val does **not** satisfy the matcher
    """
    if _is_matcher(matcher):
        # the matcher is asked twice about the same value, and a matcher over an iterable walks it
        # in both: on a one-shot iterator the second call saw what the first had left, so `each_item`
        # named the wrong item at the wrong index rather than merely losing detail
        value = materialized(self.val)
        # a matcher that walks its value is asked once, so a `key` or comparator inside it runs
        # once; one that answers from a type check keeps the cheap path, where the result nobody
        # reads is never built
        if _has_own_evaluate(matcher) or not matcher.matches(value):
            result = _evaluate_matcher(matcher, value)
        else:
            result = None
        if result is not None and not result.matched:
            return self.error(
                f"Expected {result.description}, but {result.mismatch}.",
                actual=value,
                expected=result.description,
                diff=DiffResult(
                    kind="match", entries=[_ROOT.leaf_entry(actual=value, expected=result.description)]
                ),
            )
    elif callable(matcher):
        if not cast("Callable[..., object]", matcher)(self.val):
            return self.error(f"Expected <{self.val}> to satisfy {_describe_matcher(matcher)}, but did not.")
    else:
        refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    return self

each 

each(
    matcher: Matcher[Any] | Callable[..., bool],
    *,
    allow_empty: bool = False,
) -> Self

Asserts that every item in val satisfies the given matcher.

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher instance, or a callable that takes a value and returns a bool

 required

Examples:

Usage with matchers:

from assertpy2 import match

assert_that([1, 2, 3]).each(match.is_positive())
assert_that([10, 20, 30]).each(match.between(1, 100))

Usage with extracting:

assert_that(users).extracting('age').each(match.between(18, 120))

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if any item does not satisfy the matcher
Source code in assertpy2/_satisfies.py 
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
def each(self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = False) -> Self:
    """Asserts that every item in val satisfies the given matcher.

    Args:
        matcher: a `Matcher` instance, or a callable that takes
            a value and returns a bool

    Examples:
        Usage with matchers:

            from assertpy2 import match

            assert_that([1, 2, 3]).each(match.is_positive())
            assert_that([10, 20, 30]).each(match.between(1, 100))

        Usage with extracting:

            assert_that(users).extracting('age').each(match.between(18, 120))

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if any item does **not** satisfy the matcher
    """
    _warn_if_vacuous("each", self.val, allow_empty)
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    if _is_matcher(matcher):
        description = matcher.describe()
        for i, item in enumerate(self.val):
            # asked once per item: the verdict and the reason come from the same look, so a matcher
            # over a one-shot item is right about both and a user's `key` runs once
            if not (_has_own_evaluate(matcher) or not matcher.matches(item)):
                continue
            outcome = _evaluate_matcher(matcher, item)
            if not outcome.matched:
                return self.error(
                    f"Expected all items to satisfy {description}, but item at index {i} <{item}> did not:"
                    f" {outcome.mismatch}.",
                    actual=item,
                    expected=description,
                    diff=DiffResult(
                        kind="match", entries=[_ROOT.index(i).entry(actual=item, expected=description)]
                    ),
                )
    elif callable(matcher):
        for i, item in enumerate(self.val):
            if not cast("Callable[..., object]", matcher)(item):
                return self.error(
                    f"Expected all items to satisfy {_describe_matcher(matcher)},"
                    f" but item at index {i} <{item}> did not."
                )
    else:
        refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    return self

matches_structure 

matches_structure(spec: dict[Any, Any]) -> Self

Asserts that val matches the given structure specification.

val may be any mapping (a dict, a MappingProxyType, 3.15's frozendict, or your own collections.abc.Mapping), a pydantic-style model (anything exposing model_dump()), or an attrs instance, which is normalized to its dict before matching. Each key in spec maps to either a Matcher, a raw value (checked via ==), or a nested dict for recursive matching. Extra keys in val that are absent from the spec are allowed.

Parameters:

Name Type Description Default
spec dict[Any, Any]

a dict where values can be Matcher instances, raw values, or nested dicts

 required

Examples:

Usage:

from assertpy2 import assert_that, match

user = {"name": "Alice", "age": 30, "id": "550e8400-e29b-41d4-a716-446655440000"}
assert_that(user).matches_structure({
    "name": match.is_non_empty_string(),
    "age": match.between(18, 120),
    "id": match.is_uuid(),
})

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val does not match the structure spec
Source code in assertpy2/_satisfies.py 
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
def matches_structure(self, spec: dict[Any, Any]) -> Self:
    """Asserts that val matches the given structure specification.

    ``val`` may be any mapping (a ``dict``, a ``MappingProxyType``, 3.15's ``frozendict``, or your
    own ``collections.abc.Mapping``), a pydantic-style model (anything exposing ``model_dump()``),
    or an ``attrs`` instance, which is normalized to its dict before matching.  Each key in
    ``spec`` maps to either a `Matcher`, a raw value (checked via ``==``), or a nested ``dict``
    for recursive matching.  Extra keys in val that are absent from the spec are allowed.

    Args:
        spec: a dict where values can be Matcher instances, raw values, or nested dicts

    Examples:
        Usage:

            from assertpy2 import assert_that, match

            user = {"name": "Alice", "age": 30, "id": "550e8400-e29b-41d4-a716-446655440000"}
            assert_that(user).matches_structure({
                "name": match.is_non_empty_string(),
                "age": match.between(18, 120),
                "id": match.is_uuid(),
            })

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val does **not** match the structure spec
    """
    if not is_mapping_like(self.val) and not is_model_dump_object(self.val) and not is_attrs_instance(self.val):
        refuse(self.val, "a mapping, a pydantic-style model, or an attrs instance")
    if not isinstance(spec, dict):
        refuse(spec, "a dict", subject=argument("spec"))
    matcher = StructureMatcher(spec)
    # one walk, read twice: the entries want every mismatch, the message wants the first one in words
    mismatches = matcher.walk_mismatches(self.val)
    if mismatches:
        entries = [
            mismatch.path.entry(actual=mismatch.actual, expected=mismatch.expected_desc) for mismatch in mismatches
        ]
        return self.error(
            f"Expected <{self.val}> to match structure {matcher.describe()}, but"
            f" {matcher.render_mismatch(mismatches)}.",
            actual=self.val,
            expected=spec,
            diff=DiffResult(kind="match", entries=entries),
        )
    return self

is_callable 

is_callable() -> Self

Asserts that val is callable.

Examples:

Usage:

assert_that(lambda: None).is_callable()
assert_that(print).is_callable()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is not callable
Source code in assertpy2/_satisfies.py 
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
def is_callable(self) -> Self:
    """Asserts that val is callable.

    Examples:
        Usage:

            assert_that(lambda: None).is_callable()
            assert_that(print).is_callable()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val is **not** callable
    """
    if not callable(self.val):
        return self.error(f"Expected <{self.val}> to be callable, but was not.")
    return self

is_not_callable 

is_not_callable() -> Self

Asserts that val is not callable.

Examples:

Usage:

assert_that(42).is_not_callable()
assert_that('foo').is_not_callable()

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if val is callable
Source code in assertpy2/_satisfies.py 
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
def is_not_callable(self) -> Self:
    """Asserts that val is not callable.

    Examples:
        Usage:

            assert_that(42).is_not_callable()
            assert_that('foo').is_not_callable()

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if val **is** callable
    """
    if callable(self.val):
        return self.error(f"Expected <{self.val}> to not be callable, but was.")
    return self

any_satisfy 

any_satisfy(
    matcher: Matcher[Any] | Callable[..., bool],
) -> Self

Asserts that at least one item in val satisfies the given matcher.

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher instance, or a callable that takes a value and returns a bool

 required

Examples:

Usage with matchers:

from assertpy2 import match

assert_that([1, -2, 3]).any_satisfy(match.is_negative())

Usage with callables:

assert_that([1, 2, 3]).any_satisfy(lambda x: x > 2)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if no item satisfies the matcher
Source code in assertpy2/_satisfies.py 
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
def any_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self:
    """Asserts that at least one item in val satisfies the given matcher.

    Args:
        matcher: a `Matcher` instance, or a callable that takes
            a value and returns a bool

    Examples:
        Usage with matchers:

            from assertpy2 import match

            assert_that([1, -2, 3]).any_satisfy(match.is_negative())

        Usage with callables:

            assert_that([1, 2, 3]).any_satisfy(lambda x: x > 2)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if no item satisfies the matcher
    """
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    description = _describe_matcher(matcher)
    if _is_matcher(matcher) or callable(matcher):
        # counted again below to name how many were examined, so drain a one-shot iterator
        values = materialized(self.val)
        if not any(_apply_matcher(matcher, item) for item in values):
            # "none did" alone leaves the reader to fetch the items themselves; the universal
            # sibling already lists every one that failed
            items = list(values)
            return self.error(
                f"Expected any item to satisfy {description}, but none of the {len(items)} did.",
                actual=values,
                expected=description,
                diff=DiffResult(
                    kind="match",
                    entries=[
                        _ROOT.index(index).entry(actual=item, expected=description)
                        for index, item in enumerate(items[:5])
                    ],
                ),
            )
    else:
        refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    return self

all_satisfy 

all_satisfy(
    matcher: Matcher[Any] | Callable[..., bool],
    *,
    allow_empty: bool = False,
) -> Self

Asserts that all items in val satisfy the given matcher.

Semantic alias for each().

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher instance, or a callable that takes a value and returns a bool

 required

Examples:

Usage with matchers:

from assertpy2 import match

assert_that([1, 2, 3]).all_satisfy(match.is_positive())

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if any item does not satisfy the matcher
Source code in assertpy2/_satisfies.py 
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
def all_satisfy(self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = False) -> Self:
    """Asserts that all items in val satisfy the given matcher.

    Semantic alias for [`each()`][assertpy2.base.BaseMixin.each].

    Args:
        matcher: a `Matcher` instance, or a callable that takes
            a value and returns a bool

    Examples:
        Usage with matchers:

            from assertpy2 import match

            assert_that([1, 2, 3]).all_satisfy(match.is_positive())

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if any item does **not** satisfy the matcher
    """
    _warn_if_vacuous("all_satisfy", self.val, allow_empty)
    return self.each(matcher, allow_empty=True)

none_satisfy 

none_satisfy(
    matcher: Matcher[Any] | Callable[..., bool],
) -> Self

Asserts that no item in val satisfies the given matcher.

Parameters:

Name Type Description Default
matcher Matcher[Any] | Callable[..., bool]

a Matcher instance, or a callable that takes a value and returns a bool

 required

Examples:

Usage with matchers:

from assertpy2 import match

assert_that([1, 2, 3]).none_satisfy(match.is_negative())

Usage with callables:

assert_that([1, 2, 3]).none_satisfy(lambda x: x < 0)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if any item satisfies the matcher
Source code in assertpy2/_satisfies.py 
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
def none_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self:
    """Asserts that no item in val satisfies the given matcher.

    Args:
        matcher: a `Matcher` instance, or a callable that takes
            a value and returns a bool

    Examples:
        Usage with matchers:

            from assertpy2 import match

            assert_that([1, 2, 3]).none_satisfy(match.is_negative())

        Usage with callables:

            assert_that([1, 2, 3]).none_satisfy(lambda x: x < 0)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if any item satisfies the matcher
    """
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    if _is_matcher(matcher):
        for i, item in enumerate(self.val):
            if matcher.matches(item):
                return self.error(
                    f"Expected no item to satisfy {matcher.describe()}, but item at index {i} <{item}> did."
                )
    elif callable(matcher):
        for i, item in enumerate(self.val):
            if cast("Callable[..., object]", matcher)(item):
                return self.error(
                    f"Expected no item to satisfy {_describe_matcher(matcher)}, but item at index {i} <{item}> did."
                )
    else:
        refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    return self

satisfies_exactly 

satisfies_exactly(
    *matchers: Matcher[Any] | Callable[..., bool],
) -> Self

Asserts that val has exactly one item per matcher, each satisfying the matcher at its position.

Unlike each() (one matcher applied to every item), this pairs the i-th item with the i-th matcher and additionally requires the lengths to match. Every positional mismatch is reported, not just the first.

Parameters:

Name Type Description Default
*matchers Matcher[Any] | Callable[..., bool]

one Matcher or callable predicate per expected item, applied in order

 ()

Examples:

Usage:

from assertpy2 import match

assert_that([1, "foo", 3.0]).satisfies_exactly(
    match.is_odd(), match.is_instance_of(str), match.is_positive()
)
assert_that([2, 4]).satisfies_exactly(lambda x: x == 2, lambda x: x == 4)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if the length differs, or any item does not satisfy its matcher
TypeError

if val is not iterable, or a given arg is neither a Matcher nor callable
ValueError

if no matchers are given
Source code in assertpy2/_satisfies.py 
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
def satisfies_exactly(self, *matchers: Matcher[Any] | Callable[..., bool]) -> Self:
    """Asserts that val has exactly one item per matcher, each satisfying the matcher at its position.

    Unlike [`each()`][assertpy2.base.BaseMixin.each] (one matcher applied to every item), this
    pairs the i-th item with the
    i-th matcher and additionally requires the lengths to match.  Every positional mismatch is
    reported, not just the first.

    Args:
        *matchers: one `Matcher` or callable predicate per expected item,
            applied in order

    Examples:
        Usage:

            from assertpy2 import match

            assert_that([1, "foo", 3.0]).satisfies_exactly(
                match.is_odd(), match.is_instance_of(str), match.is_positive()
            )
            assert_that([2, 4]).satisfies_exactly(lambda x: x == 2, lambda x: x == 4)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if the length differs, or any item does **not** satisfy its matcher
        TypeError: if val is not iterable, or a given arg is neither a Matcher nor callable
        ValueError: if no matchers are given
    """
    if len(matchers) == 0:
        raise ValueError("one or more args must be given")
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    items = list(self.val)
    if len(items) != len(matchers):
        return self.error(
            f"Expected collection length <{len(matchers)}>, but was <{len(items)}>.",
            actual=self.val,
            expected=[_describe_matcher(matcher) for matcher in matchers],
        )
    entries = [
        _ROOT.index(index).entry(actual=item, expected=_describe_matcher(matcher))
        for index, (item, matcher) in enumerate(zip(items, matchers, strict=True))
        if not _apply_matcher(matcher, item)
    ]
    if entries:
        failed = "item" if len(entries) == 1 else "items"
        return self.error(
            f"Expected items to satisfy the given matchers in order, but {len(entries)} {failed} did not.",
            actual=self.val,
            expected=[_describe_matcher(matcher) for matcher in matchers],
            diff=DiffResult(kind="match", entries=entries),
        )
    return self

satisfies_exactly_in_any_order 

satisfies_exactly_in_any_order(
    *matchers: Matcher[Any] | Callable[..., bool],
) -> Self

Asserts that the items and the given matchers can be paired one-to-one, in any order.

Like satisfies_exactly() but ignoring positions: passes when some one-to-one assignment pairs every item with a distinct matcher it satisfies. The lengths must still match, and no matcher may be reused for two items.

Since every matcher is probed against every item, a probe that raises TypeError (a type-incompatible comparison on a mixed collection, like is_positive() meeting a string) counts as a non-match instead of crashing the pairing. On failure, an unpaired matcher whose probes raised is annotated with the raise count in the diff, so a buggy predicate is not mistaken for an ordinary mismatch.

Parameters:

Name Type Description Default
*matchers Matcher[Any] | Callable[..., bool]

one Matcher or callable predicate per expected item, in any order

 ()

Examples:

Usage:

from assertpy2 import match

assert_that(["foo", 3]).satisfies_exactly_in_any_order(
    match.is_odd(), match.is_instance_of(str)
)
assert_that([2, 1]).satisfies_exactly_in_any_order(lambda x: x == 1, lambda x: x == 2)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if the length differs, or no one-to-one pairing satisfies all matchers
TypeError

if val is not iterable, or a given arg is neither a Matcher nor callable
ValueError

if no matchers are given
Source code in assertpy2/_satisfies.py 
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
def satisfies_exactly_in_any_order(self, *matchers: Matcher[Any] | Callable[..., bool]) -> Self:
    """Asserts that the items and the given matchers can be paired one-to-one, in any order.

    Like [`satisfies_exactly()`][assertpy2.base.BaseMixin.satisfies_exactly] but ignoring
    positions: passes when some one-to-one assignment pairs every item with a distinct matcher
    it satisfies.  The lengths must still match, and no matcher may be reused for two items.

    Since every matcher is probed against every item, a probe that raises ``TypeError`` (a
    type-incompatible comparison on a mixed collection, like ``is_positive()`` meeting a string)
    counts as a non-match instead of crashing the pairing.  On failure, an unpaired matcher whose
    probes raised is annotated with the raise count in the diff, so a buggy predicate is not
    mistaken for an ordinary mismatch.

    Args:
        *matchers: one `Matcher` or callable predicate per expected item, in any order

    Examples:
        Usage:

            from assertpy2 import match

            assert_that(["foo", 3]).satisfies_exactly_in_any_order(
                match.is_odd(), match.is_instance_of(str)
            )
            assert_that([2, 1]).satisfies_exactly_in_any_order(lambda x: x == 1, lambda x: x == 2)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if the length differs, or no one-to-one pairing satisfies all matchers
        TypeError: if val is not iterable, or a given arg is neither a Matcher nor callable
        ValueError: if no matchers are given
    """
    if len(matchers) == 0:
        raise ValueError("one or more args must be given")
    for matcher in matchers:
        if not _is_matcher(matcher) and not callable(matcher):
            refuse(matcher, "a Matcher or a callable", subject=argument("matcher"))
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    items = list(self.val)
    if len(items) != len(matchers):
        return self.error(
            f"Expected collection length <{len(matchers)}>, but was <{len(items)}>.",
            actual=self.val,
            expected=[_describe_matcher(matcher) for matcher in matchers],
        )
    raised_counts = [0] * len(matchers)
    satisfied = []
    for item in items:
        row = []
        for column, matcher in enumerate(matchers):
            try:
                row.append(_apply_matcher(matcher, item))
            except TypeError:  # noqa: PERF203  # every probe may raise independently on a mixed collection
                raised_counts[column] += 1
                row.append(False)
        satisfied.append(row)
    assignment = _max_bipartite_assignment(satisfied)
    unpaired_items = [index for index, column in enumerate(assignment) if column is None]
    if unpaired_items:
        paired_columns = {column for column in assignment if column is not None}
        entries = [
            _ROOT.member(items[index], "extra").entry(actual=items[index], expected=None, absent="expected")
            for index in unpaired_items
        ]
        entries.extend(
            DiffEntry(
                path="missing",
                actual=None,
                absent="actual",
                expected=_describe_unpaired(matcher, raised_counts[column]),
            )
            for column, matcher in enumerate(matchers)
            if column not in paired_columns
        )
        failed = "item" if len(unpaired_items) == 1 else "items"
        return self.error(
            f"Expected items to satisfy the given matchers in any order,"
            f" but no pairing covers {len(unpaired_items)} {failed}.",
            actual=self.val,
            expected=[_describe_matcher(matcher) for matcher in matchers],
            diff=DiffResult(kind="contains", entries=entries),
        )
    return self

zip_satisfies 

zip_satisfies(
    other: Iterable[object],
    predicate: Callable[..., bool],
    *,
    allow_empty: bool = False,
) -> Self

Asserts that each pair from zipping val with other satisfies the two-arg predicate.

Pairs the i-th item of val with the i-th item of other and checks predicate(a, b). The two iterables must have equal length. Every failing pair is reported.

Parameters:

Name Type Description Default
other Iterable[object]

the iterable to zip with val

 required
predicate Callable[..., bool]

a two-arg callable returning a bool, applied to each (val_item, other_item) pair

 required

Examples:

Usage:

assert_that([1, 2, 3]).zip_satisfies([2, 4, 6], lambda a, b: b == a * 2)
assert_that(["a", "bb"]).zip_satisfies([1, 2], lambda s, n: len(s) == n)

Returns:

Name Type Description
AssertionBuilder Self

returns this instance to chain to the next assertion

Raises:

Type Description
AssertionError

if the lengths differ, or any pair does not satisfy the predicate
TypeError

if val or other is not iterable, or predicate is not callable
Source code in assertpy2/_satisfies.py 
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
def zip_satisfies(
    self, other: Iterable[object], predicate: Callable[..., bool], *, allow_empty: bool = False
) -> Self:
    """Asserts that each pair from zipping val with other satisfies the two-arg predicate.

    Pairs the i-th item of val with the i-th item of ``other`` and checks ``predicate(a, b)``.
    The two iterables must have equal length.  Every failing pair is reported.

    Args:
        other: the iterable to zip with val
        predicate: a two-arg callable returning a bool, applied to each ``(val_item, other_item)`` pair

    Examples:
        Usage:

            assert_that([1, 2, 3]).zip_satisfies([2, 4, 6], lambda a, b: b == a * 2)
            assert_that(["a", "bb"]).zip_satisfies([1, 2], lambda s, n: len(s) == n)

    Returns:
        AssertionBuilder: returns this instance to chain to the next assertion

    Raises:
        AssertionError: if the lengths differ, or any pair does **not** satisfy the predicate
        TypeError: if val or other is not iterable, or predicate is not callable
    """
    _warn_if_vacuous("zip_satisfies", self.val, allow_empty)
    if not callable(predicate):
        refuse(predicate, "callable", subject=argument("predicate"))
    if not isinstance(self.val, collections.abc.Iterable):
        refuse(self.val, "iterable")
    if not isinstance(other, collections.abc.Iterable):
        refuse(other, "iterable", subject=argument("other"))
    val_items = list(self.val)
    other_items = list(other)
    if len(val_items) != len(other_items):
        return self.error(
            f"Expected collection length <{len(other_items)}>, but was <{len(val_items)}>.",
            actual=self.val,
            expected=other,
        )
    entries = [
        _ROOT.index(index).entry(actual=val_item, expected=other_item)
        for index, (val_item, other_item) in enumerate(zip(val_items, other_items, strict=True))
        if not predicate(val_item, other_item)
    ]
    if entries:
        failed = "pair" if len(entries) == 1 else "pairs"
        return self.error(
            f"Expected paired items to satisfy <{predicate}>, but {len(entries)} {failed} did not.",
            actual=self.val,
            expected=other,
            diff=DiffResult(kind="match", entries=entries),
        )
    return self