assertpy2 2.5.0__tar.gz → 2.5.1__tar.gz

assertpy2-2.5.1/.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
+
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.14"
+
+      - name: Install docs dependencies
+        run: uv sync --only-group docs
+
+      - name: Build docs
+        run: uv run mkdocs build --strict
+
+      - name: Upload Pages artifact
+        if: github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
+        with:
+          path: site
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

{assertpy2-2.5.0 → assertpy2-2.5.1}/.gitignore

@@ -30,3 +30,4 @@ dist
 # docs output
 docs/build
 docs/out
+/site/

{assertpy2-2.5.0 → assertpy2-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: assertpy2
-Version: 2.5.0
+Version: 2.5.1
 Summary: Fluent assertion library for Python with composable matchers, structural matching, and full type safety
 Project-URL: Homepage, https://github.com/Solganis/assertpy2
 Project-URL: Repository, https://github.com/Solganis/assertpy2
@@ -26,7 +26,7 @@ Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Testing
 Requires-Python: >=3.10
-Requires-Dist: typing-extensions>=4.0
+Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Provides-Extra: allure
 Requires-Dist: allure-pytest>=2.13; extra == 'allure'
 Provides-Extra: behave
@@ -56,7 +56,7 @@ Description-Content-Type: text/markdown
   <a href="https://pypi.org/project/assertpy2/"><img src="https://img.shields.io/pypi/pyversions/assertpy2" alt="Python"></a>
   <a href="https://codecov.io/gh/Solganis/assertpy2"><img src="https://codecov.io/gh/Solganis/assertpy2/graph/badge.svg" alt="Coverage"></a>
   <br>
-  <a href="https://github.com/Solganis/assertpy2/blob/main/docs/api.md"><img src="https://img.shields.io/badge/Docs-Read%20The%20Docs-black" alt="Documentation"></a>
+  <a href="https://solganis.github.io/assertpy2/"><img src="https://img.shields.io/badge/Docs-online-black" alt="Documentation"></a>
   <a href="https://docs.astral.sh/ruff/"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
   <a href="https://github.com/astral-sh/uv"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv"></a>
   <a href="https://github.com/astral-sh/ty"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json" alt="ty"></a>
@@ -123,28 +123,28 @@ Your IDE shows only methods relevant to the value you're testing, not all 100+:
 
 **Fluent API**
 
-- [**Composable matchers**](docs/api.md#composable-matchers): `match.greater_than(5)`, `match.is_uuid()`, combine with `&`, `|`, `~`. Also work with plain `assert ==`.
-- [**Structural matching**](docs/api.md#structural-matching): `matches_structure()` for declarative dict/API response validation.
-- [**Universal negation**](docs/api.md#universal-negation): `.not_` inverts any assertion without dedicated `is_not_*` methods.
-- [**Collection pipeline**](docs/api.md#collection-pipeline): `filtered_on()`, `mapped()`, `flat_mapped()`, `first()`, `last()`, `element()`, `single()`.
-- [**Fluent chaining**](docs/api.md#chaining): write assertions as readable one-liners that chain naturally.
+- [**Composable matchers**](https://solganis.github.io/assertpy2/matchers/): `match.greater_than(5)`, `match.is_uuid()`, combine with `&`, `|`, `~`. Also work with plain `assert ==`.
+- [**Structural matching**](https://solganis.github.io/assertpy2/matchers/#structural-matching): `matches_structure()` for declarative dict/API response validation.
+- [**Universal negation**](https://solganis.github.io/assertpy2/fluent/#universal-negation): `.not_` inverts any assertion without dedicated `is_not_*` methods.
+- [**Collection pipeline**](https://solganis.github.io/assertpy2/fluent/#collection-pipeline): `filtered_on()`, `mapped()`, `flat_mapped()`, `first()`, `last()`, `element()`, `single()`.
+- [**Fluent chaining**](https://solganis.github.io/assertpy2/fluent/#chaining): write assertions as readable one-liners that chain naturally.
 
 **Built-in types**
 
-- [Strings](docs/api.md#strings), [numbers](docs/api.md#numbers), [lists](docs/api.md#lists), [tuples](docs/api.md#tuples), [sets](docs/api.md#sets), [dicts](docs/api.md#dicts), [dates](docs/api.md#dates), [booleans](docs/api.md#booleans), [objects](docs/api.md#objects), [bytes](docs/api.md#bytes--bytearray-assertions), [files](docs/api.md#files), [exceptions](docs/api.md#failure).
-- [**Bytes assertions**](docs/api.md#bytes--bytearray-assertions): `is_valid_utf8()`, `starts_with_bytes()`, `is_hex_equal_to()`, `decoded_as()` for `bytes`/`bytearray`.
-- [**JSON assertions**](docs/api.md#json-path--schema-validation): JSONPath navigation and JSON Schema validation. `pip install assertpy2[json]`.
-- [**Dynamic assertions**](docs/api.md#objects): `has_<name>()` for any attribute, property, or zero-argument method.
-- [**Dict comparison**](docs/api.md#dicts): `is_equal_to()` with `ignore` and `include` for selective key/field matching (dicts, dataclasses, namedtuples, Pydantic models, attrs, plain objects).
-- [**Extracting**](docs/api.md#objects): flatten collections on attributes with `filter` and `sort` support.
+- [Strings](https://solganis.github.io/assertpy2/assertions/#strings), [numbers](https://solganis.github.io/assertpy2/assertions/#numbers), [lists](https://solganis.github.io/assertpy2/assertions/#lists), [tuples](https://solganis.github.io/assertpy2/assertions/#tuples), [sets](https://solganis.github.io/assertpy2/assertions/#sets), [dicts](https://solganis.github.io/assertpy2/assertions/#dicts), [dates](https://solganis.github.io/assertpy2/assertions/#dates), [booleans](https://solganis.github.io/assertpy2/assertions/#booleans), [objects](https://solganis.github.io/assertpy2/assertions/#objects), [bytes](https://solganis.github.io/assertpy2/assertions/#bytes--bytearray), [files](https://solganis.github.io/assertpy2/assertions/#files), [exceptions](https://solganis.github.io/assertpy2/errors/#expected-exceptions).
+- [**Bytes assertions**](https://solganis.github.io/assertpy2/assertions/#bytes--bytearray): `is_valid_utf8()`, `starts_with_bytes()`, `is_hex_equal_to()`, `decoded_as()` for `bytes`/`bytearray`.
+- [**JSON assertions**](https://solganis.github.io/assertpy2/data/#json-path--schema): JSONPath navigation and JSON Schema validation. `pip install assertpy2[json]`.
+- [**Dynamic assertions**](https://solganis.github.io/assertpy2/assertions/#dynamic-assertions-on-objects): `has_<name>()` for any attribute, property, or zero-argument method.
+- [**Dict comparison**](https://solganis.github.io/assertpy2/assertions/#selective-comparison-ignore--include): `is_equal_to()` with `ignore` and `include` for selective key/field matching (dicts, dataclasses, namedtuples, Pydantic models, attrs, plain objects).
+- [**Extracting**](https://solganis.github.io/assertpy2/assertions/#extracting-attributes-from-objects): flatten collections on attributes with `filter` and `sort` support.
 
 **Testing**
 
-- [**Soft assertions**](docs/api.md#soft-assertions): thread-safe, async-safe via `contextvars`. Group errors with `sa.group()`, or use `assert_all()`.
-- [**Async assertions**](docs/api.md#async-assertions): `eventually()` with polling/retry for eventual consistency.
-- [**Structured errors**](docs/api.md#structured-errors): `AssertionFailure` with `.actual`, `.expected`, `.diff` attributes.
-- [**Rich pytest diffs**](docs/api.md#rich-pytest-diffs): recursive structural diffs for lists, sets, strings, dicts, dataclasses, namedtuples, Pydantic models. Circular reference protection.
-- [**Snapshot testing**](docs/api.md#snapshot-testing): store and compare data structures in JSON format.
+- [**Soft assertions**](https://solganis.github.io/assertpy2/testing/#soft-assertions): thread-safe, async-safe via `contextvars`. Group errors with `sa.group()`, or use `assert_all()`.
+- [**Async assertions**](https://solganis.github.io/assertpy2/testing/#async-assertions): `eventually()` with polling/retry for eventual consistency.
+- [**Structured errors**](https://solganis.github.io/assertpy2/errors/#structured-errors): `AssertionFailure` with `.actual`, `.expected`, `.diff` attributes.
+- [**Rich pytest diffs**](https://solganis.github.io/assertpy2/errors/#rich-pytest-diffs): recursive structural diffs for lists, sets, strings, dicts, dataclasses, namedtuples, Pydantic models. Circular reference protection.
+- [**Snapshot testing**](https://solganis.github.io/assertpy2/testing/#snapshot-testing): store and compare data structures in JSON format.
 
 **Type safety**
 
@@ -153,16 +153,16 @@ Your IDE shows only methods relevant to the value you're testing, not all 100+:
 
 **Extensibility**
 
-- [**Custom matchers**](docs/api.md#custom-matchers---registering-domain-matchers): `register_matcher()` for domain-specific matchers, composable with `&`, `|`, `~`.
-- [**Regex group extraction**](docs/api.md#regex-group-extraction): `extracting_group()` and `matches_with_groups()` for regex captures.
-- [**Extensions**](docs/api.md#extension-system---adding-custom-assertions): `add_extension()` for custom assertion methods.
+- [**Custom matchers**](https://solganis.github.io/assertpy2/matchers/#custom-matchers): `register_matcher()` for domain-specific matchers, composable with `&`, `|`, `~`.
+- [**Regex group extraction**](https://solganis.github.io/assertpy2/data/#regex-group-extraction): `extracting_group()` and `matches_with_groups()` for regex captures.
+- [**Extensions**](https://solganis.github.io/assertpy2/extending/): `add_extension()` for custom assertion methods.
 
 **Integrations**
 
-- [**Allure**](docs/api.md#allure-integration): auto-attach structured diff and actual/expected data to reports. `pip install assertpy2[allure]`.
-- [**Behave**](docs/api.md#behave-step-matchers): ready-made parameter types for step definitions. `pip install assertpy2[behave]`.
+- [**Allure**](https://solganis.github.io/assertpy2/integrations/#allure): auto-attach structured diff and actual/expected data to reports. `pip install assertpy2[allure]`.
+- [**Behave**](https://solganis.github.io/assertpy2/integrations/#behave): ready-made parameter types for step definitions. `pip install assertpy2[behave]`.
 
-See the [full API reference](docs/api.md) for all assertion methods, examples, and advanced features.
+See the [full documentation](https://solganis.github.io/assertpy2/) for all assertion methods, examples, and advanced features.
 
 ---
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/README.md

@@ -18,7 +18,7 @@
   <a href="https://pypi.org/project/assertpy2/"><img src="https://img.shields.io/pypi/pyversions/assertpy2" alt="Python"></a>
   <a href="https://codecov.io/gh/Solganis/assertpy2"><img src="https://codecov.io/gh/Solganis/assertpy2/graph/badge.svg" alt="Coverage"></a>
   <br>
-  <a href="https://github.com/Solganis/assertpy2/blob/main/docs/api.md"><img src="https://img.shields.io/badge/Docs-Read%20The%20Docs-black" alt="Documentation"></a>
+  <a href="https://solganis.github.io/assertpy2/"><img src="https://img.shields.io/badge/Docs-online-black" alt="Documentation"></a>
   <a href="https://docs.astral.sh/ruff/"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
   <a href="https://github.com/astral-sh/uv"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv"></a>
   <a href="https://github.com/astral-sh/ty"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json" alt="ty"></a>
@@ -85,28 +85,28 @@ Your IDE shows only methods relevant to the value you're testing, not all 100+:
 
 **Fluent API**
 
-- [**Composable matchers**](docs/api.md#composable-matchers): `match.greater_than(5)`, `match.is_uuid()`, combine with `&`, `|`, `~`. Also work with plain `assert ==`.
-- [**Structural matching**](docs/api.md#structural-matching): `matches_structure()` for declarative dict/API response validation.
-- [**Universal negation**](docs/api.md#universal-negation): `.not_` inverts any assertion without dedicated `is_not_*` methods.
-- [**Collection pipeline**](docs/api.md#collection-pipeline): `filtered_on()`, `mapped()`, `flat_mapped()`, `first()`, `last()`, `element()`, `single()`.
-- [**Fluent chaining**](docs/api.md#chaining): write assertions as readable one-liners that chain naturally.
+- [**Composable matchers**](https://solganis.github.io/assertpy2/matchers/): `match.greater_than(5)`, `match.is_uuid()`, combine with `&`, `|`, `~`. Also work with plain `assert ==`.
+- [**Structural matching**](https://solganis.github.io/assertpy2/matchers/#structural-matching): `matches_structure()` for declarative dict/API response validation.
+- [**Universal negation**](https://solganis.github.io/assertpy2/fluent/#universal-negation): `.not_` inverts any assertion without dedicated `is_not_*` methods.
+- [**Collection pipeline**](https://solganis.github.io/assertpy2/fluent/#collection-pipeline): `filtered_on()`, `mapped()`, `flat_mapped()`, `first()`, `last()`, `element()`, `single()`.
+- [**Fluent chaining**](https://solganis.github.io/assertpy2/fluent/#chaining): write assertions as readable one-liners that chain naturally.
 
 **Built-in types**
 
-- [Strings](docs/api.md#strings), [numbers](docs/api.md#numbers), [lists](docs/api.md#lists), [tuples](docs/api.md#tuples), [sets](docs/api.md#sets), [dicts](docs/api.md#dicts), [dates](docs/api.md#dates), [booleans](docs/api.md#booleans), [objects](docs/api.md#objects), [bytes](docs/api.md#bytes--bytearray-assertions), [files](docs/api.md#files), [exceptions](docs/api.md#failure).
-- [**Bytes assertions**](docs/api.md#bytes--bytearray-assertions): `is_valid_utf8()`, `starts_with_bytes()`, `is_hex_equal_to()`, `decoded_as()` for `bytes`/`bytearray`.
-- [**JSON assertions**](docs/api.md#json-path--schema-validation): JSONPath navigation and JSON Schema validation. `pip install assertpy2[json]`.
-- [**Dynamic assertions**](docs/api.md#objects): `has_<name>()` for any attribute, property, or zero-argument method.
-- [**Dict comparison**](docs/api.md#dicts): `is_equal_to()` with `ignore` and `include` for selective key/field matching (dicts, dataclasses, namedtuples, Pydantic models, attrs, plain objects).
-- [**Extracting**](docs/api.md#objects): flatten collections on attributes with `filter` and `sort` support.
+- [Strings](https://solganis.github.io/assertpy2/assertions/#strings), [numbers](https://solganis.github.io/assertpy2/assertions/#numbers), [lists](https://solganis.github.io/assertpy2/assertions/#lists), [tuples](https://solganis.github.io/assertpy2/assertions/#tuples), [sets](https://solganis.github.io/assertpy2/assertions/#sets), [dicts](https://solganis.github.io/assertpy2/assertions/#dicts), [dates](https://solganis.github.io/assertpy2/assertions/#dates), [booleans](https://solganis.github.io/assertpy2/assertions/#booleans), [objects](https://solganis.github.io/assertpy2/assertions/#objects), [bytes](https://solganis.github.io/assertpy2/assertions/#bytes--bytearray), [files](https://solganis.github.io/assertpy2/assertions/#files), [exceptions](https://solganis.github.io/assertpy2/errors/#expected-exceptions).
+- [**Bytes assertions**](https://solganis.github.io/assertpy2/assertions/#bytes--bytearray): `is_valid_utf8()`, `starts_with_bytes()`, `is_hex_equal_to()`, `decoded_as()` for `bytes`/`bytearray`.
+- [**JSON assertions**](https://solganis.github.io/assertpy2/data/#json-path--schema): JSONPath navigation and JSON Schema validation. `pip install assertpy2[json]`.
+- [**Dynamic assertions**](https://solganis.github.io/assertpy2/assertions/#dynamic-assertions-on-objects): `has_<name>()` for any attribute, property, or zero-argument method.
+- [**Dict comparison**](https://solganis.github.io/assertpy2/assertions/#selective-comparison-ignore--include): `is_equal_to()` with `ignore` and `include` for selective key/field matching (dicts, dataclasses, namedtuples, Pydantic models, attrs, plain objects).
+- [**Extracting**](https://solganis.github.io/assertpy2/assertions/#extracting-attributes-from-objects): flatten collections on attributes with `filter` and `sort` support.
 
 **Testing**
 
-- [**Soft assertions**](docs/api.md#soft-assertions): thread-safe, async-safe via `contextvars`. Group errors with `sa.group()`, or use `assert_all()`.
-- [**Async assertions**](docs/api.md#async-assertions): `eventually()` with polling/retry for eventual consistency.
-- [**Structured errors**](docs/api.md#structured-errors): `AssertionFailure` with `.actual`, `.expected`, `.diff` attributes.
-- [**Rich pytest diffs**](docs/api.md#rich-pytest-diffs): recursive structural diffs for lists, sets, strings, dicts, dataclasses, namedtuples, Pydantic models. Circular reference protection.
-- [**Snapshot testing**](docs/api.md#snapshot-testing): store and compare data structures in JSON format.
+- [**Soft assertions**](https://solganis.github.io/assertpy2/testing/#soft-assertions): thread-safe, async-safe via `contextvars`. Group errors with `sa.group()`, or use `assert_all()`.
+- [**Async assertions**](https://solganis.github.io/assertpy2/testing/#async-assertions): `eventually()` with polling/retry for eventual consistency.
+- [**Structured errors**](https://solganis.github.io/assertpy2/errors/#structured-errors): `AssertionFailure` with `.actual`, `.expected`, `.diff` attributes.
+- [**Rich pytest diffs**](https://solganis.github.io/assertpy2/errors/#rich-pytest-diffs): recursive structural diffs for lists, sets, strings, dicts, dataclasses, namedtuples, Pydantic models. Circular reference protection.
+- [**Snapshot testing**](https://solganis.github.io/assertpy2/testing/#snapshot-testing): store and compare data structures in JSON format.
 
 **Type safety**
 
@@ -115,16 +115,16 @@ Your IDE shows only methods relevant to the value you're testing, not all 100+:
 
 **Extensibility**
 
-- [**Custom matchers**](docs/api.md#custom-matchers---registering-domain-matchers): `register_matcher()` for domain-specific matchers, composable with `&`, `|`, `~`.
-- [**Regex group extraction**](docs/api.md#regex-group-extraction): `extracting_group()` and `matches_with_groups()` for regex captures.
-- [**Extensions**](docs/api.md#extension-system---adding-custom-assertions): `add_extension()` for custom assertion methods.
+- [**Custom matchers**](https://solganis.github.io/assertpy2/matchers/#custom-matchers): `register_matcher()` for domain-specific matchers, composable with `&`, `|`, `~`.
+- [**Regex group extraction**](https://solganis.github.io/assertpy2/data/#regex-group-extraction): `extracting_group()` and `matches_with_groups()` for regex captures.
+- [**Extensions**](https://solganis.github.io/assertpy2/extending/): `add_extension()` for custom assertion methods.
 
 **Integrations**
 
-- [**Allure**](docs/api.md#allure-integration): auto-attach structured diff and actual/expected data to reports. `pip install assertpy2[allure]`.
-- [**Behave**](docs/api.md#behave-step-matchers): ready-made parameter types for step definitions. `pip install assertpy2[behave]`.
+- [**Allure**](https://solganis.github.io/assertpy2/integrations/#allure): auto-attach structured diff and actual/expected data to reports. `pip install assertpy2[allure]`.
+- [**Behave**](https://solganis.github.io/assertpy2/integrations/#behave): ready-made parameter types for step definitions. `pip install assertpy2[behave]`.
 
-See the [full API reference](docs/api.md) for all assertion methods, examples, and advanced features.
+See the [full documentation](https://solganis.github.io/assertpy2/) for all assertion methods, examples, and advanced features.
 
 ---
 

assertpy2-2.5.1/assertpy2/_compat.py

@@ -0,0 +1,15 @@
+"""Internal compatibility shims.
+
+``Self`` entered the standard library's :mod:`typing` in Python 3.11; on 3.10 it is provided by
+``typing_extensions``. Re-exporting it from one place lets every mixin import ``Self`` without repeating
+the version gate, and lets ``typing_extensions`` be dropped as a runtime dependency on Python 3.11+.
+"""
+
+import sys
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+__all__ = ["Self"]

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/_mixin_base.py

@@ -4,8 +4,7 @@ import logging
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
-
+    from ._compat import Self
     from .errors import DiffResult
 
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/_typing.py

@@ -7,8 +7,7 @@ if TYPE_CHECKING:
     from pathlib import Path
     from typing import Any, Protocol
 
-    from typing_extensions import Self
-
+    from ._compat import Self
     from .assertpy import NegatedBuilder
     from .async_assertions import AsyncAssertionBuilder
     from .matchers import Matcher

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/assertpy.py

@@ -16,8 +16,7 @@ if TYPE_CHECKING:
     import datetime
     import pathlib
 
-    from typing_extensions import Self
-
+    from ._compat import Self
     from ._typing import (
         _BytesAssertion,
         _CallableAssertion,
@@ -47,7 +46,7 @@ from .numeric import NumericMixin
 from .snapshot import SnapshotMixin
 from .string import StringMixin
 
-__version__ = "2.4.0"
+__version__ = "2.5.1"
 
 __tracebackhide__ = True  # clean tracebacks via py.test integration
 contextlib.__tracebackhide__ = True  # ty: ignore[unresolved-attribute]  # pytest monkey-patch

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/async_assertions.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from collections.abc import Callable
 
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/base.py

@@ -9,7 +9,7 @@ from .errors import DiffEntry, DiffResult
 from .matchers import Matcher, StructureMatcher
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/bytes_mixin.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/collection.py

@@ -8,7 +8,7 @@ from ._mixin_base import _MixinBase
 from .matchers import BaseMatcher
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/contains.py

@@ -8,7 +8,7 @@ from .errors import DiffEntry, DiffResult
 from .matchers import Matcher
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/date.py

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/dict.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/exception.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING, cast
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/extracting.py

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/file.py

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/json_mixin.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Any
 from ._mixin_base import _MixinBase
 
 if TYPE_CHECKING:
-    from typing_extensions import Self
+    from ._compat import Self
 
 __tracebackhide__ = True
 

{assertpy2-2.5.0 → assertpy2-2.5.1}/assertpy2/matchers.py

@@ -655,146 +655,214 @@ class _MatchNamespace:
 
     @staticmethod
     def equal_to(expected: object) -> EqualToMatcher:
+        """Matcher for a value equal to ``expected``."""
         return EqualToMatcher(expected)
 
     @staticmethod
     def greater_than(val: object) -> GreaterThanMatcher:
+        """Matcher for a value greater than ``val``."""
         return GreaterThanMatcher(val)
 
     @staticmethod
     def greater_than_or_equal_to(val: object) -> GreaterThanOrEqualToMatcher:
+        """Matcher for a value greater than or equal to ``val``."""
         return GreaterThanOrEqualToMatcher(val)
 
     @staticmethod
     def less_than(val: object) -> LessThanMatcher:
+        """Matcher for a value less than ``val``."""
         return LessThanMatcher(val)
 
     @staticmethod
     def less_than_or_equal_to(val: object) -> LessThanOrEqualToMatcher:
+        """Matcher for a value less than or equal to ``val``."""
         return LessThanOrEqualToMatcher(val)
 
     @staticmethod
     def between(low: object, high: object) -> BetweenMatcher:
+        """Matcher for a value in the inclusive range ``low`` to ``high``."""
         return BetweenMatcher(low, high)
 
     @staticmethod
     def close_to(expected: object, tolerance: object) -> CloseToMatcher:
+        """Matcher for a value within ``tolerance`` of ``expected`` (``abs(value - expected) <= tolerance``).
+
+        Args:
+            expected: the target value
+            tolerance: the maximum allowed absolute difference from ``expected``
+        """
         return CloseToMatcher(expected, tolerance)
 
     @staticmethod
     def is_none() -> IsNoneMatcher:
+        """Matcher for ``None``."""
         return IsNoneMatcher()
 
     @staticmethod
     def is_not_none() -> IsNotNoneMatcher:
+        """Matcher for any value that is not ``None``."""
         return IsNotNoneMatcher()
 
     @staticmethod
     def is_instance_of(expected_type: type) -> IsInstanceOfMatcher:
+        """Matcher for an instance of ``expected_type`` (via ``isinstance``)."""
         return IsInstanceOfMatcher(expected_type)
 
     @staticmethod
     def is_truthy() -> IsTruthyMatcher:
+        """Matcher for a truthy value."""
         return IsTruthyMatcher()
 
     @staticmethod
     def is_falsy() -> IsFalsyMatcher:
+        """Matcher for a falsy value."""
         return IsFalsyMatcher()
 
     @staticmethod
     def has_length(length: int) -> HasLengthMatcher:
+        """Matcher for a value whose ``len()`` equals ``length``."""
         return HasLengthMatcher(length)
 
     @staticmethod
     def is_empty() -> IsEmptyMatcher:
+        """Matcher for an empty value (``len() == 0``)."""
         return IsEmptyMatcher()
 
     @staticmethod
     def is_not_empty() -> IsNotEmptyMatcher:
+        """Matcher for a non-empty value (``len() > 0``)."""
         return IsNotEmptyMatcher()
 
     @staticmethod
     def is_positive() -> IsPositiveMatcher:
+        """Matcher for a value greater than zero."""
         return IsPositiveMatcher()
 
     @staticmethod
     def is_negative() -> IsNegativeMatcher:
+        """Matcher for a value less than zero."""
         return IsNegativeMatcher()
 
     @staticmethod
     def is_zero() -> IsZeroMatcher:
+        """Matcher for a value equal to zero."""
         return IsZeroMatcher()
 
     @staticmethod
     def is_even() -> IsEvenMatcher:
+        """Matcher for an even integer."""
         return IsEvenMatcher()
 
     @staticmethod
     def is_odd() -> IsOddMatcher:
+        """Matcher for an odd integer."""
         return IsOddMatcher()
 
     @staticmethod
     def is_divisible_by(divisor: int) -> IsDivisibleByMatcher:
+        """Matcher for an integer divisible by ``divisor``."""
         return IsDivisibleByMatcher(divisor)
 
     @staticmethod
     def is_callable() -> IsCallableMatcher:
+        """Matcher for a callable object."""
         return IsCallableMatcher()
 
     @staticmethod
     def is_in(*values: object) -> IsInMatcher:
+        """Matcher for a value present in ``values``.
+
+        Args:
+            *values: the candidate values; the matched value must equal one of them
+        """
         return IsInMatcher(*values)
 
     @staticmethod
     def has_property(name: str, matcher: Matcher | None = None) -> HasPropertyMatcher:
+        """Matcher for an object with attribute ``name``, optionally matching ``matcher``.
+
+        Args:
+            name: the attribute name the object must have
+            matcher: optional matcher the attribute value must satisfy; if ``None``,
+                only the presence of the attribute is checked
+        """
         return HasPropertyMatcher(name, matcher)
 
     @staticmethod
     def contains_string(substring: str) -> ContainsStringMatcher:
+        """Matcher for a string containing ``substring``."""
         return ContainsStringMatcher(substring)
 
     @staticmethod
     def matches_regex(pattern: str) -> MatchesRegexMatcher:
+        """Matcher for a string in which ``pattern`` is found (``re.search``)."""
         return MatchesRegexMatcher(pattern)
 
     @staticmethod
     def starts_with(prefix: str) -> StartsWithMatcher:
+        """Matcher for a string starting with ``prefix``."""
         return StartsWithMatcher(prefix)
 
     @staticmethod
     def ends_with(suffix: str) -> EndsWithMatcher:
+        """Matcher for a string ending with ``suffix``."""
         return EndsWithMatcher(suffix)
 
     @staticmethod
     def all_of(*matchers: Matcher) -> AllOfMatcher:
+        """Matcher that holds when every one of ``matchers`` matches (the ``&`` operator)."""
         return AllOfMatcher(*matchers)
 
     @staticmethod
     def any_of(*matchers: Matcher) -> AnyOfMatcher:
+        """Matcher that holds when at least one of ``matchers`` matches (the ``|`` operator)."""
         return AnyOfMatcher(*matchers)
 
     @staticmethod
     def not_(matcher: Matcher) -> NotMatcher:
+        """Matcher that inverts ``matcher`` (the ``~`` operator)."""
         return NotMatcher(matcher)
 
     @staticmethod
     def ignore() -> IgnoreMatcher:
+        """Matcher that accepts anything; useful as a placeholder in ``structure`` specs."""
         return IgnoreMatcher()
 
     @staticmethod
     def is_uuid() -> IsUuidMatcher:
+        """Matcher for a string parseable as a UUID."""
         return IsUuidMatcher()
 
     @staticmethod
     def is_non_empty_string() -> IsNonEmptyStringMatcher:
+        """Matcher for a non-empty string."""
         return IsNonEmptyStringMatcher()
 
     @staticmethod
     def each_item(matcher: Matcher) -> EachMatcher:
+        """Matcher for an iterable whose every item matches ``matcher``.
+
+        Args:
+            matcher: the matcher each item of the iterable must satisfy; a non-iterable
+                value never matches
+        """
         return EachMatcher(matcher)
 
     @staticmethod
     def structure(spec: dict) -> StructureMatcher:
+        """Matcher for a dict matching ``spec``.
+
+        Args:
+            spec: dict whose values are matchers, raw values (compared with ``==``),
+                or nested dict specs. Keys present in the value but absent from the spec are ignored.
+
+        Examples:
+            Usage::
+
+                assert_that(user).satisfies(
+                    match.structure({"id": match.is_instance_of(int), "name": "Alice"})
+                )
+        """
         return StructureMatcher(spec)
 
     def __getattr__(self, name: str) -> Callable[..., BaseMatcher]: