assertpy 2.35.0__py3-none-any.whl

assertpy/_engine/_capable_typing.py

@@ -0,0 +1,772 @@
+"""The surface of a value the capability umbrella claims.
+
+Generated by `scripts/generate_poll_protocols.py`.
+
+Do not edit.  `assert_that()` hands this back for a value that answers to some capability and to no
+overload by name: a model, a dataclass, an HTTP response, a container of one's own.  It offers what the
+builder offers, because that is what such a value used to get and none of it can be taken away without
+refusing a call that runs.
+
+What it exists to add is one restriction.  The six ordering assertions read the value with an ordering,
+so a builder over a value that has none is not one they can be asked of.  Before this,
+`assert_that(a_mapping).is_positive()` type-checked on ty, mypy and Pyright, the three gated then, and raised
+ran.
+
+A protocol rather than a subclass of the builder: narrowing ``self`` in a subclass is an invalid
+override, measured on ty, and the working precedents that narrow it all end in a rung open to anything,
+which is what a refusal cannot have.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import datetime
+    import logging
+    import re
+    from collections.abc import Callable, Iterable, Mapping, Sized
+    from pathlib import Path
+    from typing import Any, Protocol, SupportsFloat, SupportsIndex, TypeVar, overload
+
+    from typing_extensions import TypeIs
+
+    from .._matcher_impls import ClassInfo, ExceptionInfo, RetriedInfo, WarningInfo
+    from ..assertpy import AssertionBuilder
+    from ..matchers import Matcher
+    from ._builder_check_typing import _CheckAnyValue
+    from ._compat import Self
+    from ._poll_typing import _AsyncPoll, _NoExpectationOnAChain, _SyncPoll
+    from ._typing import (
+        _E,
+        _K,
+        _R,
+        _U,
+        _V,
+        _ExpectedCompletionAssertion,
+        _ExpectedRaiseAssertion,
+        _ExpectedWarningAssertion,
+        _Landed,
+        _ListAssertion,
+    )
+
+    # covariant: the façade only ever hands the subject back, through `value`
+    _CapableT_co = TypeVar("_CapableT_co", covariant=True)
+    _U2 = TypeVar("_U2")
+    _U3 = TypeVar("_U3")
+    _E_co = TypeVar("_E_co", covariant=True)
+
+    class _Orderable(Protocol):
+        """A value with an ordering, which is all the relational assertions ask of one."""
+
+        def __lt__(self, other: Any, /) -> Any: ...
+
+    class _Indexed(Protocol[_E_co]):
+        """The older way to be a sequence: integer lookup that stops with `IndexError`, and no `__iter__`.
+
+        `list(value)` accepts it, so `contains_in_order()` runs on it, and asking only for `Iterable`
+        refused a value that works.
+
+        One shape gets through that the runtime refuses, and it cannot be spelled out of: a class with
+        this lookup and ``__iter__ = None`` disables the fallback, so `list(value)` raises while this
+        still matches.  Structural typing has no way to ask for the absence of a member, and the
+        direction is the safe one: the call is accepted here and refused with "val must be iterable"
+        when it runs, which is what every other umbrella rung already does.
+        """
+
+        def __getitem__(self, index: int, /) -> _E_co: ...
+
+    class _Keyed(Protocol):
+        """`keys()`, which the dict gate reads before anything else.
+
+        Iterability is read too and is deliberately NOT here: the gate asks
+        `isinstance(value, collections.abc.Iterable)`, which a class earns by registration, and
+        requiring `__iter__` structurally refused a registered value that runs.  Same blind spot as
+        `numbers.Number` in the numeric family, and the same answer.
+        """
+
+        def keys(self) -> Any: ...
+
+    class _KeyedWithItems(_Keyed, Protocol):
+        """And a lookup, which reading an entry needs and reading a key does not."""
+
+        def __getitem__(self, key: Any, /) -> Any: ...
+
+    class _KeyedWithValues(_Keyed, Protocol):
+        """And the values, which only the value pair reads.  A lookup is not enough: measured on a
+        subject carrying `keys` and `__getitem__`, `contains_value` still refuses."""
+
+        def values(self) -> Any: ...
+
+    class _PathLike(Protocol):
+        """A value the filesystem assertions can read a path out of, spelled as `os.PathLike` spells it."""
+
+        def __fspath__(self) -> Any: ...
+
+    class _Callable(Protocol):
+        """A value the exception and warning assertions can call, which is what `callable()` asks."""
+
+        def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
+
+    class _ElementSource(Protocol[_E_co]):
+        """Anything whose value can be walked for `_E_co`, spelled the way the builder spells it.
+
+        `Iterable` and not `Collection`: a value with only `__iter__` fell through to the `Self` overload,
+        so `first()` kept the container's type after the value had become an element.
+        """
+
+        @property
+        def value(self) -> Iterable[_E_co]: ...
+
+    class _CapableAssertion(Protocol[_CapableT_co]):
+        """What a value the umbrella claims can be asked."""
+
+        # the data the builder carries: absent from `dir()`, so `__getattr__` read `description` as a callable
+        val: Any
+        description: str
+        kind: str | None
+        expected: type[BaseException] | ExceptionInfo | None
+        logger: logging.LoggerAdapter[Any]
+
+        @property
+        def value(self) -> _CapableT_co: ...
+        @property
+        def not_(self) -> _NegatedCapableAssertion[_CapableT_co]: ...
+        def __getattr__(self, name: str) -> Callable[..., Self]: ...
+
+        # the builder's ladders, carried across: a narrowing lost here is lost for every value the umbrella claims
+        @overload
+        def is_not_none(self: _CapableAssertion[_U | None]) -> _CapableAssertion[_U]: ...
+        @overload
+        def is_not_none(self) -> Self: ...
+        @overload
+        def is_instance_of(self, some_class: tuple[type[_U], type[_U2]]) -> AssertionBuilder[_U | _U2]: ...
+        @overload
+        def is_instance_of(
+            self, some_class: tuple[type[_U], type[_U2], type[_U3]]
+        ) -> AssertionBuilder[_U | _U2 | _U3]: ...
+        @overload
+        def is_instance_of(self, some_class: type[_U]) -> AssertionBuilder[_U]: ...
+        @overload
+        def is_instance_of(self, some_class: ClassInfo) -> Self: ...
+        @overload
+        def is_instance_of_any(self, first: type[_U], second: type[_U2], /) -> AssertionBuilder[_U | _U2]: ...
+        @overload
+        def is_instance_of_any(
+            self, first: type[_U], second: type[_U2], third: type[_U3], /
+        ) -> AssertionBuilder[_U | _U2 | _U3]: ...
+        @overload
+        def is_instance_of_any(self, *some_classes: ClassInfo) -> Self: ...
+        @overload
+        def first(self: _CapableAssertion[Mapping[_K, _V]]) -> AssertionBuilder[_K]: ...
+        @overload
+        def first(self: _ElementSource[_E]) -> AssertionBuilder[_E]: ...
+        @overload
+        def first(self) -> Self: ...
+        @overload
+        def last(self: _CapableAssertion[Mapping[_K, _V]]) -> AssertionBuilder[_K]: ...
+        @overload
+        def last(self: _ElementSource[_E]) -> AssertionBuilder[_E]: ...
+        @overload
+        def last(self) -> Self: ...
+        @overload
+        def element(self: _CapableAssertion[Mapping[_K, _V]], index: SupportsIndex) -> AssertionBuilder[_K]: ...
+        @overload
+        def element(self: _ElementSource[_E], index: SupportsIndex) -> AssertionBuilder[_E]: ...
+        @overload
+        def element(self, index: SupportsIndex) -> Self: ...
+        @overload
+        def mapped(self: _ElementSource[_E], func: Callable[[_E], _R]) -> AssertionBuilder[list[_R]]: ...
+        @overload
+        def mapped(self, func: Callable[..., Any]) -> Self: ...
+        @overload
+        def single(self: _CapableAssertion[Mapping[_K, _V]]) -> AssertionBuilder[_K]: ...
+        @overload
+        def single(self: _ElementSource[_E]) -> AssertionBuilder[_E]: ...
+        @overload
+        def single(self) -> Self: ...
+        @overload
+        def satisfies(self, matcher: Callable[[Any], TypeIs[_U]]) -> AssertionBuilder[_U]: ...
+        @overload
+        def satisfies(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self: ...
+        # the polling pivots, over `Any`: no capability says the value is callable, so the chain keeps every rung open
+        def eventually(
+            self,
+            *,
+            timeout: float = ...,
+            interval: float = ...,
+            ignoring: type[Exception] | RetriedInfo = ...,
+            trace: bool = ...,
+        ) -> _AsyncPoll[Any]: ...
+        def eventually_sync(
+            self,
+            *,
+            timeout: float = ...,
+            interval: float = ...,
+            ignoring: type[Exception] | RetriedInfo = ...,
+            trace: bool = ...,
+        ) -> _SyncPoll[Any]: ...
+        # where the callable view lands: flattened, the runtime's `-> Self` kept a caught message typed as the callable
+        @overload
+        def raises(self: _CapableAssertion[_Callable], ex: type[_Landed]) -> _ExpectedRaiseAssertion[Any, _Landed]: ...
+        @overload
+        def raises(
+            self: _CapableAssertion[_Callable], ex: type | ExceptionInfo
+        ) -> _ExpectedRaiseAssertion[Any, BaseException]: ...
+        def does_not_raise(
+            self: _CapableAssertion[_Callable], ex: type | ExceptionInfo
+        ) -> _ExpectedCompletionAssertion[Any]: ...
+        def warns(
+            self: _CapableAssertion[_Callable], warning: type[Warning] | WarningInfo = ...
+        ) -> _ExpectedWarningAssertion[Any]: ...
+        def does_not_warn(
+            self: _CapableAssertion[_Callable], warning: type[Warning] | WarningInfo = ...
+        ) -> _ExpectedCompletionAssertion[Any]: ...
+
+        when_called_with: _NoExpectationOnAChain
+
+        # the builder's own helpers: left to `__getattr__`, `builder()` read as this facade over the value already here
+        def builder(
+            self,
+            val: Any,
+            description: str = ...,
+            kind: str | None = ...,
+            expected: Any = ...,
+            logger: Any = ...,
+            origin: Any = ...,
+        ) -> AssertionBuilder[Any]: ...
+        def error(
+            self,
+            msg: str,
+            *,
+            actual: Any = ...,
+            expected: Any = ...,
+            diff: Any = ...,
+            trace: Any = ...,
+            suppress_context: bool = ...,
+        ) -> Self: ...
+        def check(self) -> _CheckAnyValue[_CapableT_co]: ...
+        def all_fields_satisfy(
+            self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...
+        ) -> Self: ...
+        def all_satisfy(self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...) -> Self: ...
+        def any_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self: ...
+        def at_json_path(self, path: str) -> AssertionBuilder[Any]: ...
+        def caused_by(self, ex: ClassInfo) -> AssertionBuilder[Any]: ...
+        def conforms_to_openapi(
+            self,
+            spec: dict[str, Any],
+            path: str,
+            method: str,
+            *,
+            status: str | int | None = ...,
+            content_type: str = ...,
+            strict_nullable: bool = ...,
+        ) -> Self: ...
+        def contains(self, *items: object) -> Self: ...
+        def contains_any_of(self, *items: str) -> Self: ...
+        def contains_bytes(
+            self: _CapableAssertion[bytes | bytearray], sub: bytes | bytearray
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_duplicates(self) -> Self: ...
+        def contains_entry(
+            self: _CapableAssertion[_KeyedWithItems], *args: object, **kwargs: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_error(self, *ex_types: type | ExceptionInfo) -> Self: ...
+        def contains_exactly(self, *items: object) -> Self: ...
+        def contains_exactly_in_any_order(self, *items: object) -> Self: ...
+        def contains_ignoring_case(self, *items: str) -> Self: ...
+        def contains_in_order(
+            self: _CapableAssertion[Iterable[_E] | _Indexed[_E]], *items: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_key(self: _CapableAssertion[_Keyed], *keys: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_none_of(self, *items: str) -> Self: ...
+        def contains_only(self, *items: object) -> Self: ...
+        def contains_only_once(self, *items: object) -> Self: ...
+        def contains_sequence(self, *items: object) -> Self: ...
+        def contains_value(
+            self: _CapableAssertion[_KeyedWithValues], *values: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def decoded_as(self: _CapableAssertion[bytes | bytearray], encoding: str = ...) -> AssertionBuilder[Any]: ...
+        def decoded_as_json(self) -> AssertionBuilder[object]: ...
+        def described_as(self, description: str) -> Self: ...
+        def does_not_contain(self, *items: object) -> Self: ...
+        def does_not_contain_duplicates(self) -> Self: ...
+        def does_not_contain_entry(
+            self: _CapableAssertion[_KeyedWithItems], *args: object, **kwargs: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_error(self, *ex_types: type | ExceptionInfo) -> Self: ...
+        def does_not_contain_key(self: _CapableAssertion[_Keyed], *keys: object) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_value(
+            self: _CapableAssertion[_KeyedWithValues], *values: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_exist(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_have_json_path(self, path: str) -> Self: ...
+        def does_not_match(
+            self: _CapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def each(self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...) -> Self: ...
+        def ends_with(self, suffix: object) -> Self: ...
+        def ends_with_ignoring_case(self: _CapableAssertion[str], suffix: str) -> _CapableAssertion[_CapableT_co]: ...
+        def error_of(self, ex: type) -> AssertionBuilder[Any]: ...
+        def errors(self) -> AssertionBuilder[Any]: ...
+        def exists(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def extracting(self, *names: object, **kwargs: object) -> _ListAssertion[Any]: ...
+        def extracting_group(
+            self: _CapableAssertion[str], pattern: str | re.Pattern[str], group: int | str = ...
+        ) -> AssertionBuilder[Any]: ...
+        def filtered_on(self, predicate: Matcher[Any] | Callable[[Any], bool]) -> _ListAssertion[Any]: ...
+        def flat_mapped(self, func: Callable[[Any], Iterable[Any]]) -> _ListAssertion[Any]: ...
+        def has_byte_at(
+            self: _CapableAssertion[bytes | bytearray], index: SupportsIndex, expected: SupportsIndex
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def has_json_path(self, path: str) -> Self: ...
+        def has_no_none_fields(self, *, allow_empty: bool = ...) -> Self: ...
+        def has_root_cause(self, ex: ClassInfo) -> AssertionBuilder[Any]: ...
+        def has_same_size_as(self, other: Sized) -> Self: ...
+        def has_size_between(self, low: SupportsIndex, high: SupportsIndex) -> Self: ...
+        def has_size_greater_than(self, size: SupportsIndex) -> Self: ...
+        def has_size_less_than(self, size: SupportsIndex) -> Self: ...
+        def is_after(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_after_or_equal_to(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_alpha(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_alphanumeric(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_array_close_to(
+            self, expected: object, *, rtol: float = ..., atol: float = ..., equal_nan: bool = ..., **options: Any
+        ) -> Self: ...
+        def is_array_equal(self, expected: object, **options: Any) -> Self: ...
+        def is_before(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_before_or_equal_to(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_between(self, low: object, high: object) -> Self: ...
+        def is_callable(self) -> Self: ...
+        def is_child_of(self: _CapableAssertion[_PathLike], parent: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_close_to(
+            self: _CapableAssertion[SupportsFloat | SupportsIndex],
+            other: SupportsFloat | SupportsIndex | datetime.datetime,
+            tolerance: SupportsFloat | SupportsIndex | datetime.timedelta | None = ...,
+            *,
+            rel: SupportsFloat | SupportsIndex | None = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_digit(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_directory(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_divisible_by(
+            self: _CapableAssertion[int], divisor: SupportsIndex
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_empty(self) -> Self: ...
+        def is_equal_to(self, other: object, **kwargs: object) -> Self: ...
+        def is_equal_to_ignoring_case(self: _CapableAssertion[str], other: str) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_milliseconds(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_seconds(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_time(
+            self: _CapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_whitespace(
+            self: _CapableAssertion[str], other: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_even(self: _CapableAssertion[int]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_executable(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_false(self) -> Self: ...
+        def is_file(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_frame_equal(self, expected: object, **options: Any) -> Self: ...
+        def is_greater_than(self: _CapableAssertion[_Orderable], other: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_greater_than_or_equal_to(
+            self: _CapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_hex_equal_to(
+            self: _CapableAssertion[bytes | bytearray], expected_hex: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_in(self, *items: object) -> Self: ...
+        def is_inf(self: _CapableAssertion[SupportsFloat | SupportsIndex]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_iterable(self) -> Self: ...
+        def is_length(self, length: SupportsIndex | Matcher[int]) -> Self: ...
+        def is_length_between(self, low: SupportsIndex, high: SupportsIndex) -> Self: ...
+        def is_less_than(self: _CapableAssertion[_Orderable], other: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_less_than_or_equal_to(
+            self: _CapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_lower(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_named(self: _CapableAssertion[_PathLike], filename: str) -> _CapableAssertion[_CapableT_co]: ...
+        def is_nan(self: _CapableAssertion[SupportsFloat | SupportsIndex]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_negative(self: _CapableAssertion[_Orderable]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_none(self) -> Self: ...
+        def is_not_between(self, low: object, high: object) -> Self: ...
+        def is_not_callable(self) -> Self: ...
+        def is_not_close_to(
+            self,
+            other: SupportsFloat | SupportsIndex | datetime.datetime,
+            tolerance: SupportsFloat | SupportsIndex | datetime.timedelta | None = ...,
+            *,
+            rel: SupportsFloat | SupportsIndex | None = ...,
+        ) -> Self: ...
+        def is_not_empty(self) -> Self: ...
+        def is_not_equal_to(self, other: object) -> Self: ...
+        def is_not_in(self, *items: object) -> Self: ...
+        def is_not_inf(self: _CapableAssertion[SupportsFloat | SupportsIndex]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_iterable(self) -> Self: ...
+        def is_not_nan(self: _CapableAssertion[SupportsFloat | SupportsIndex]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_same_as(self, other: object) -> Self: ...
+        def is_not_zero(self) -> Self: ...
+        def is_odd(self: _CapableAssertion[int]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_positive(self: _CapableAssertion[_Orderable]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_readable(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_same_as(self, other: object) -> Self: ...
+        def is_sorted(
+            self, key: Callable[[Any], Any] = ..., reverse: bool = ..., *, allow_empty: bool = ...
+        ) -> Self: ...
+        def is_subclass_of(self, some_class: ClassInfo) -> Self: ...
+        def is_subset_of(self, *supersets: object, allow_empty: bool = ...) -> Self: ...
+        def is_true(self) -> Self: ...
+        def is_type_of(self, some_type: type) -> Self: ...
+        def is_unicode(self) -> Self: ...
+        def is_upper(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_valid_encoding(
+            self: _CapableAssertion[bytes | bytearray], encoding: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_valid_utf8(self: _CapableAssertion[bytes | bytearray]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_whitespace(self: _CapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_writable(self: _CapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_zero(self) -> Self: ...
+        def matches(
+            self: _CapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_contract_snapshot(self, id: str | None = ..., path: str = ...) -> Self: ...
+        def matches_error_tree(self, *expected: type | list[Any]) -> Self: ...
+        def matches_inline(
+            self,
+            expected: object = ...,
+            *,
+            ignore: object = ...,
+            include: object = ...,
+            tolerance: float | None = ...,
+            rel: float | None = ...,
+            comparators: dict[Any, Callable[[Any, Any], Any]] | None = ...,
+            placeholders: Mapping[Any, Matcher[Any] | Callable[[Any], object]] | None = ...,
+        ) -> Self: ...
+        def matches_json_schema(self, schema: dict[str, Any]) -> Self: ...
+        def matches_json_schema_from_file(self, path: str | Path) -> Self: ...
+        def matches_structure(self, spec: dict[Any, Any]) -> Self: ...
+        def matches_with_groups(
+            self: _CapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> AssertionBuilder[Any]: ...
+        def none_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> Self: ...
+        def raised(self) -> AssertionBuilder[Any]: ...
+        def returned(self) -> AssertionBuilder[Any]: ...
+        def satisfies_exactly(self, *matchers: Matcher[Any] | Callable[..., bool]) -> Self: ...
+        def satisfies_exactly_in_any_order(self, *matchers: Matcher[Any] | Callable[..., bool]) -> Self: ...
+        def snapshot(
+            self,
+            id: str | None = ...,
+            path: str = ...,
+            *,
+            ignore: object = ...,
+            include: object = ...,
+            tolerance: float | None = ...,
+            rel: float | None = ...,
+            comparators: dict[Any, Callable[[Any, Any], Any]] | None = ...,
+            placeholders: Mapping[Any, Matcher[Any] | Callable[[Any], object]] | None = ...,
+        ) -> Self: ...
+        def starts_with(self, prefix: object) -> Self: ...
+        def starts_with_bytes(
+            self: _CapableAssertion[bytes | bytearray], prefix: bytes | bytearray
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def starts_with_ignoring_case(self: _CapableAssertion[str], prefix: str) -> _CapableAssertion[_CapableT_co]: ...
+        def zip_satisfies(
+            self, other: Iterable[object], predicate: Callable[..., bool], *, allow_empty: bool = ...
+        ) -> Self: ...
+
+    class _NegatedCapableAssertion(Protocol[_CapableT_co]):
+        """The negation twin of the capability facade: one step, then it back."""
+
+        def is_not_none(self) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of(self, some_class: tuple[type[_U], type[_U2]]) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of(
+            self, some_class: tuple[type[_U], type[_U2], type[_U3]]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of(self, some_class: type[_U]) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of(self, some_class: ClassInfo) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of_any(self, first: type[_U], second: type[_U2], /) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of_any(
+            self, first: type[_U], second: type[_U2], third: type[_U3], /
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        @overload
+        def is_instance_of_any(self, *some_classes: ClassInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def satisfies(self, matcher: Matcher[Any] | Callable[..., bool]) -> _CapableAssertion[_CapableT_co]: ...
+        def all_fields_satisfy(
+            self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def all_satisfy(
+            self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def any_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> _CapableAssertion[_CapableT_co]: ...
+        def caused_by(self, ex: ClassInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def conforms_to_openapi(
+            self,
+            spec: dict[str, Any],
+            path: str,
+            method: str,
+            *,
+            status: str | int | None = ...,
+            content_type: str = ...,
+            strict_nullable: bool = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_any_of(self, *items: str) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_bytes(
+            self: _NegatedCapableAssertion[bytes | bytearray], sub: bytes | bytearray
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_duplicates(self) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_entry(
+            self: _NegatedCapableAssertion[_KeyedWithItems], *args: object, **kwargs: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_error(self, *ex_types: type | ExceptionInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_exactly(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_exactly_in_any_order(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_ignoring_case(self, *items: str) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_in_order(
+            self: _NegatedCapableAssertion[Iterable[_E] | _Indexed[_E]], *items: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_key(self: _NegatedCapableAssertion[_Keyed], *keys: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_none_of(self, *items: str) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_only(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_only_once(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_sequence(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def contains_value(
+            self: _NegatedCapableAssertion[_KeyedWithValues], *values: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_duplicates(self) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_entry(
+            self: _NegatedCapableAssertion[_KeyedWithItems], *args: object, **kwargs: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_error(self, *ex_types: type | ExceptionInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_key(
+            self: _NegatedCapableAssertion[_Keyed], *keys: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_contain_value(
+            self: _NegatedCapableAssertion[_KeyedWithValues], *values: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_exist(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_have_json_path(self, path: str) -> _CapableAssertion[_CapableT_co]: ...
+        def does_not_match(
+            self: _NegatedCapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def each(
+            self, matcher: Matcher[Any] | Callable[..., bool], *, allow_empty: bool = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def ends_with(self, suffix: object) -> _CapableAssertion[_CapableT_co]: ...
+        def ends_with_ignoring_case(
+            self: _NegatedCapableAssertion[str], suffix: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def error_of(self, ex: type) -> _CapableAssertion[_CapableT_co]: ...
+        def exists(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def extracting_group(
+            self: _NegatedCapableAssertion[str], pattern: str | re.Pattern[str], group: int | str = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def has_byte_at(
+            self: _NegatedCapableAssertion[bytes | bytearray], index: SupportsIndex, expected: SupportsIndex
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def has_json_path(self, path: str) -> _CapableAssertion[_CapableT_co]: ...
+        def has_no_none_fields(self, *, allow_empty: bool = ...) -> _CapableAssertion[_CapableT_co]: ...
+        def has_root_cause(self, ex: ClassInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def has_same_size_as(self, other: Sized) -> _CapableAssertion[_CapableT_co]: ...
+        def has_size_between(self, low: SupportsIndex, high: SupportsIndex) -> _CapableAssertion[_CapableT_co]: ...
+        def has_size_greater_than(self, size: SupportsIndex) -> _CapableAssertion[_CapableT_co]: ...
+        def has_size_less_than(self, size: SupportsIndex) -> _CapableAssertion[_CapableT_co]: ...
+        def is_after(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_after_or_equal_to(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_alpha(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_alphanumeric(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_array_close_to(
+            self, expected: object, *, rtol: float = ..., atol: float = ..., equal_nan: bool = ..., **options: Any
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_array_equal(self, expected: object, **options: Any) -> _CapableAssertion[_CapableT_co]: ...
+        def is_before(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_before_or_equal_to(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_between(self, low: object, high: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_callable(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_child_of(
+            self: _NegatedCapableAssertion[_PathLike], parent: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_close_to(
+            self: _NegatedCapableAssertion[SupportsFloat | SupportsIndex],
+            other: SupportsFloat | SupportsIndex | datetime.datetime,
+            tolerance: SupportsFloat | SupportsIndex | datetime.timedelta | None = ...,
+            *,
+            rel: SupportsFloat | SupportsIndex | None = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_digit(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_directory(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_divisible_by(
+            self: _NegatedCapableAssertion[int], divisor: SupportsIndex
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_empty(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to(self, other: object, **kwargs: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_case(
+            self: _NegatedCapableAssertion[str], other: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_milliseconds(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_seconds(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_time(
+            self: _NegatedCapableAssertion[datetime.datetime], other: datetime.datetime
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_equal_to_ignoring_whitespace(
+            self: _NegatedCapableAssertion[str], other: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_even(self: _NegatedCapableAssertion[int]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_executable(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_false(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_file(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_frame_equal(self, expected: object, **options: Any) -> _CapableAssertion[_CapableT_co]: ...
+        def is_greater_than(
+            self: _NegatedCapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_greater_than_or_equal_to(
+            self: _NegatedCapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_hex_equal_to(
+            self: _NegatedCapableAssertion[bytes | bytearray], expected_hex: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_in(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_inf(
+            self: _NegatedCapableAssertion[SupportsFloat | SupportsIndex],
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_iterable(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_length(self, length: SupportsIndex | Matcher[int]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_length_between(self, low: SupportsIndex, high: SupportsIndex) -> _CapableAssertion[_CapableT_co]: ...
+        def is_less_than(
+            self: _NegatedCapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_less_than_or_equal_to(
+            self: _NegatedCapableAssertion[_Orderable], other: object
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_lower(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_named(self: _NegatedCapableAssertion[_PathLike], filename: str) -> _CapableAssertion[_CapableT_co]: ...
+        def is_nan(
+            self: _NegatedCapableAssertion[SupportsFloat | SupportsIndex],
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_negative(self: _NegatedCapableAssertion[_Orderable]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_none(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_between(self, low: object, high: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_callable(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_close_to(
+            self,
+            other: SupportsFloat | SupportsIndex | datetime.datetime,
+            tolerance: SupportsFloat | SupportsIndex | datetime.timedelta | None = ...,
+            *,
+            rel: SupportsFloat | SupportsIndex | None = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_empty(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_equal_to(self, other: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_in(self, *items: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_inf(
+            self: _NegatedCapableAssertion[SupportsFloat | SupportsIndex],
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_iterable(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_nan(
+            self: _NegatedCapableAssertion[SupportsFloat | SupportsIndex],
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_same_as(self, other: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_not_zero(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_odd(self: _NegatedCapableAssertion[int]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_positive(self: _NegatedCapableAssertion[_Orderable]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_readable(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_same_as(self, other: object) -> _CapableAssertion[_CapableT_co]: ...
+        def is_sorted(
+            self, key: Callable[[Any], Any] = ..., reverse: bool = ..., *, allow_empty: bool = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_subclass_of(self, some_class: ClassInfo) -> _CapableAssertion[_CapableT_co]: ...
+        def is_subset_of(self, *supersets: object, allow_empty: bool = ...) -> _CapableAssertion[_CapableT_co]: ...
+        def is_true(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_type_of(self, some_type: type) -> _CapableAssertion[_CapableT_co]: ...
+        def is_unicode(self) -> _CapableAssertion[_CapableT_co]: ...
+        def is_upper(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_valid_encoding(
+            self: _NegatedCapableAssertion[bytes | bytearray], encoding: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def is_valid_utf8(self: _NegatedCapableAssertion[bytes | bytearray]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_whitespace(self: _NegatedCapableAssertion[str]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_writable(self: _NegatedCapableAssertion[_PathLike]) -> _CapableAssertion[_CapableT_co]: ...
+        def is_zero(self) -> _CapableAssertion[_CapableT_co]: ...
+        def matches(
+            self: _NegatedCapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_contract_snapshot(
+            self, id: str | None = ..., path: str = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_error_tree(self, *expected: type | list[Any]) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_inline(
+            self,
+            expected: object = ...,
+            *,
+            ignore: object = ...,
+            include: object = ...,
+            tolerance: float | None = ...,
+            rel: float | None = ...,
+            comparators: dict[Any, Callable[[Any, Any], Any]] | None = ...,
+            placeholders: Mapping[Any, Matcher[Any] | Callable[[Any], object]] | None = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_json_schema(self, schema: dict[str, Any]) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_json_schema_from_file(self, path: str | Path) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_structure(self, spec: dict[Any, Any]) -> _CapableAssertion[_CapableT_co]: ...
+        def matches_with_groups(
+            self: _NegatedCapableAssertion[str], pattern: str | re.Pattern[str]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def none_satisfy(self, matcher: Matcher[Any] | Callable[..., bool]) -> _CapableAssertion[_CapableT_co]: ...
+        def satisfies_exactly(
+            self, *matchers: Matcher[Any] | Callable[..., bool]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def satisfies_exactly_in_any_order(
+            self, *matchers: Matcher[Any] | Callable[..., bool]
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def snapshot(
+            self,
+            id: str | None = ...,
+            path: str = ...,
+            *,
+            ignore: object = ...,
+            include: object = ...,
+            tolerance: float | None = ...,
+            rel: float | None = ...,
+            comparators: dict[Any, Callable[[Any, Any], Any]] | None = ...,
+            placeholders: Mapping[Any, Matcher[Any] | Callable[[Any], object]] | None = ...,
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def starts_with(self, prefix: object) -> _CapableAssertion[_CapableT_co]: ...
+        def starts_with_bytes(
+            self: _NegatedCapableAssertion[bytes | bytearray], prefix: bytes | bytearray
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def starts_with_ignoring_case(
+            self: _NegatedCapableAssertion[str], prefix: str
+        ) -> _CapableAssertion[_CapableT_co]: ...
+        def zip_satisfies(
+            self, other: Iterable[object], predicate: Callable[..., bool], *, allow_empty: bool = ...
+        ) -> _CapableAssertion[_CapableT_co]: ...