pydantic-json-patch 0.6.2__tar.gz → 0.6.4__tar.gz

{pydantic_json_patch-0.6.2 → pydantic_json_patch-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydantic_json_patch
-Version: 0.6.2
+Version: 0.6.4
 Summary: Pydantic models for implementing JSON Patch.
 Author: Jonathan Sharpe
 Author-email: Jonathan Sharpe <mail@jonrshar.pe>
@@ -33,8 +33,9 @@ Description-Content-Type: text/markdown
 # Pydantic JSON Patch
 
 [![Python uv CI][ci-badge]][ci-page]
-[![Coverage Status][coverage-badge]][coverage-page]
 [![PyPI - Version][pypi-badge]][pypi-page]
+[![SonarQube Cloud - Maintainability][sonar-badge]][sonar-page]
+[![Coverage Status][coverage-badge]][coverage-page]
 
 [Pydantic] models for implementing [JSON Patch].
 
@@ -176,7 +177,10 @@ def _(
     ...
 ```
 
-**Note**: explicitly specifying the [discriminator][pydantic-discriminator] gives better results on _failed_ validation for unions of operations.
+**Notes**:
+
+- Explicitly specifying the [discriminator][pydantic-discriminator] gives better results on _failed_ validation for unions of operations; and
+- Parameterised versions of the operations will also appear in the JSON Schema as e.g. `AddOp_int_` (with the title _"JsonPatchAddOperation\[int\]"_).
 
 ## Development
 
@@ -217,8 +221,8 @@ This will auto-restart as you make changes.
 
   [ci-badge]: https://github.com/textbook/pydantic_json_patch/actions/workflows/push.yml/badge.svg
   [ci-page]: https://github.com/textbook/pydantic_json_patch/actions/workflows/push.yml
-  [coverage-badge]: https://coveralls.io/repos/github/textbook/pydantic_json_patch/badge.svg?branch=main
-  [coverage-page]: https://coveralls.io/github/textbook/pydantic_json_patch?branch=main
+  [coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=textbook_pydantic_json_patch&metric=coverage
+  [coverage-page]: https://sonarcloud.io/summary/new_code?id=textbook_pydantic_json_patch
   [fastapi]: https://fastapi.tiangolo.com/
   [isort]: https://pycqa.github.io/isort/
   [json patch]: https://datatracker.ietf.org/doc/html/rfc6902/
@@ -230,6 +234,8 @@ This will auto-restart as you make changes.
   [pypi-page]: https://pypi.org/project/pydantic-json-patch/
   [pytest]: https://docs.pytest.org/en/stable/
   [ruff]: https://docs.astral.sh/ruff/
+  [sonar-badge]: https://sonarcloud.io/api/project_badges/measure?project=textbook_pydantic_json_patch&metric=sqale_rating
+  [sonar-page]: https://sonarcloud.io/summary/new_code?id=textbook_pydantic_json_patch
   [swagger-example]: https://github.com/textbook/pydantic_json_patch/blob/main/docs/swagger-example.png?raw=true
   [swagger-schemas]: https://github.com/textbook/pydantic_json_patch/blob/main/docs/swagger-schemas.png?raw=true
   [ty]: https://docs.astral.sh/ty/

{pydantic_json_patch-0.6.2 → pydantic_json_patch-0.6.4}/README.md

@@ -1,8 +1,9 @@
 # Pydantic JSON Patch
 
 [![Python uv CI][ci-badge]][ci-page]
-[![Coverage Status][coverage-badge]][coverage-page]
 [![PyPI - Version][pypi-badge]][pypi-page]
+[![SonarQube Cloud - Maintainability][sonar-badge]][sonar-page]
+[![Coverage Status][coverage-badge]][coverage-page]
 
 [Pydantic] models for implementing [JSON Patch].
 
@@ -144,7 +145,10 @@ def _(
     ...
 ```
 
-**Note**: explicitly specifying the [discriminator][pydantic-discriminator] gives better results on _failed_ validation for unions of operations.
+**Notes**:
+
+- Explicitly specifying the [discriminator][pydantic-discriminator] gives better results on _failed_ validation for unions of operations; and
+- Parameterised versions of the operations will also appear in the JSON Schema as e.g. `AddOp_int_` (with the title _"JsonPatchAddOperation\[int\]"_).
 
 ## Development
 
@@ -185,8 +189,8 @@ This will auto-restart as you make changes.
 
   [ci-badge]: https://github.com/textbook/pydantic_json_patch/actions/workflows/push.yml/badge.svg
   [ci-page]: https://github.com/textbook/pydantic_json_patch/actions/workflows/push.yml
-  [coverage-badge]: https://coveralls.io/repos/github/textbook/pydantic_json_patch/badge.svg?branch=main
-  [coverage-page]: https://coveralls.io/github/textbook/pydantic_json_patch?branch=main
+  [coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=textbook_pydantic_json_patch&metric=coverage
+  [coverage-page]: https://sonarcloud.io/summary/new_code?id=textbook_pydantic_json_patch
   [fastapi]: https://fastapi.tiangolo.com/
   [isort]: https://pycqa.github.io/isort/
   [json patch]: https://datatracker.ietf.org/doc/html/rfc6902/
@@ -198,6 +202,8 @@ This will auto-restart as you make changes.
   [pypi-page]: https://pypi.org/project/pydantic-json-patch/
   [pytest]: https://docs.pytest.org/en/stable/
   [ruff]: https://docs.astral.sh/ruff/
+  [sonar-badge]: https://sonarcloud.io/api/project_badges/measure?project=textbook_pydantic_json_patch&metric=sqale_rating
+  [sonar-page]: https://sonarcloud.io/summary/new_code?id=textbook_pydantic_json_patch
   [swagger-example]: https://github.com/textbook/pydantic_json_patch/blob/main/docs/swagger-example.png?raw=true
   [swagger-schemas]: https://github.com/textbook/pydantic_json_patch/blob/main/docs/swagger-schemas.png?raw=true
   [ty]: https://docs.astral.sh/ty/

{pydantic_json_patch-0.6.2 → pydantic_json_patch-0.6.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pydantic_json_patch"
-version = "0.6.2"
+version = "0.6.4"
 description = "Pydantic models for implementing JSON Patch."
 readme = "README.md"
 authors = [
@@ -49,6 +49,7 @@ dev = [
     "fastapi-cli>=0.0.20",
     "httpx>=0.28.1",
     "isort>=7.0.0",
+    "joythief>=0.8.1",
     "pre-commit>=4.5.1",
     "pytest>=9.0.2",
     "ruff>=0.15.0",
@@ -63,9 +64,15 @@ mutation = [
 [tool.coverage.run]
 omit = ["tests/**"]
 
+[tool.coverage.html]
+directory = "coverage/html/"
+
 [tool.coverage.lcov]
 output = "coverage/lcov.info"
 
+[tool.coverage.xml]
+output = "coverage/coverage.xml"
+
 [tool.isort]
 profile = "black"
 

{pydantic_json_patch-0.6.2 → pydantic_json_patch-0.6.4}/src/pydantic_json_patch/models.py

@@ -16,7 +16,7 @@ from pydantic import (
     model_validator,
 )
 
-_JSON_POINTER = re.compile(r"^(?:/(?:[^/~]|~[01])+)*$")
+_JSON_POINTER = re.compile(r"^(?:/(?:[^/~]|~[01])*)*$")
 
 T = tx.TypeVar("T", default=tp.Any)
 
@@ -24,9 +24,12 @@ T = tx.TypeVar("T", default=tp.Any)
 
 
 def _generate_title(model: type[tp.Any]) -> str:
-    """Strip any type metadata and expand the shortened name."""
-    name, *_ = model.__name__.partition("[")
-    return f"JsonPatch{name}eration"
+    """Prefix with 'JsonPatch' and expand 'Op' contraction."""
+    name, *rest = model.__name__.partition("[")
+    if not name.endswith("Op"):
+        msg = f"{name!r} does not end with 'Op'"
+        raise ValueError(msg)
+    return "".join(("JsonPatch", name, "eration", *rest))
 
 
 class _BaseOp(BaseModel):
@@ -108,6 +111,15 @@ class _FromOp(_BaseOp):
 
 
 class _ValueOp(_BaseOp, tp.Generic[T]):
+    @classmethod
+    def __class_getitem__(
+        cls, typevar_values: type[tp.Any] | tuple[type[tp.Any], ...]
+    ) -> type[BaseModel]:
+        """Propagate docstring to generic alias."""
+        alias = super().__class_getitem__(typevar_values)
+        alias.__doc__ = cls.__doc__
+        return alias
+
     @classmethod
     def create(cls, *, path: str | Sequence[str], value: T) -> tx.Self:  # ty: ignore[invalid-method-override] -- deliberately narrows **kwargs to named params
         """Return an instance of the appropriate operation."""
@@ -123,9 +135,9 @@ class _ValueOp(_BaseOp, tp.Generic[T]):
 
 
 class AddOp(_ValueOp[T], tp.Generic[T]):
-    """Represents the `add`_ operation.
+    """Represents the [add] operation.
 
-    .. _add: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.1
+    [add]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.1
 
     """
 
@@ -133,9 +145,9 @@ class AddOp(_ValueOp[T], tp.Generic[T]):
 
 
 class CopyOp(_FromOp):
-    """Represents the `copy`_ operation.
+    """Represents the [copy] operation.
 
-    .. _copy: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.5
+    [copy]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.5
 
     """
 
@@ -143,9 +155,9 @@ class CopyOp(_FromOp):
 
 
 class MoveOp(_FromOp):
-    """Represents the `move`_ operation.
+    """Represents the [move] operation.
 
-    .. _move: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.4
+    [move]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.4
 
     """
 
@@ -153,9 +165,9 @@ class MoveOp(_FromOp):
 
 
 class RemoveOp(_BaseOp):
-    """Represents the `remove`_ operation.
+    """Represents the [remove] operation.
 
-    .. _remove: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.2
+    [remove]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.2
 
     """
 
@@ -168,9 +180,9 @@ class RemoveOp(_BaseOp):
 
 
 class ReplaceOp(_ValueOp[T], tp.Generic[T]):
-    """Represents the `replace`_ operation.
+    """Represents the [replace] operation.
 
-    .. _replace: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.3
+    [replace]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.3
 
     """
 
@@ -178,9 +190,9 @@ class ReplaceOp(_ValueOp[T], tp.Generic[T]):
 
 
 class TestOp(_ValueOp[T], tp.Generic[T]):
-    """Represents the `test`_ operation.
+    """Represents the [test] operation.
 
-    .. _test: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.6
+    [test]: https://datatracker.ietf.org/doc/html/rfc6902/#section-4.6
 
     """
 
@@ -198,9 +210,9 @@ Operation: tp.TypeAlias = tp.Annotated[
 
 
 class JsonPatch(RootModel[Sequence[Operation]], Sequence[Operation]):
-    """Represents a full JSON Patch `document`_.
+    """Represents a full JSON Patch [document].
 
-    .. _document: https://datatracker.ietf.org/doc/html/rfc6902/#section-3
+    [document]: https://datatracker.ietf.org/doc/html/rfc6902/#section-3
 
     """
 
@@ -208,7 +220,7 @@ class JsonPatch(RootModel[Sequence[Operation]], Sequence[Operation]):
 
     @model_validator(mode="before")
     @classmethod
-    def _coerce_to_tuple(cls, value: tp.Any) -> tuple[tp.Any, ...]:  # noqa: ANN401
+    def _coerce_seq_to_tuple(cls, value: tp.Any) -> tp.Any:  # noqa: ANN401
         if isinstance(value, Sequence) and not isinstance(value, tuple):
             return tuple(value)
         return value
@@ -217,7 +229,7 @@ class JsonPatch(RootModel[Sequence[Operation]], Sequence[Operation]):
     def __getitem__(self, index: int) -> Operation: ...
 
     @tp.overload
-    def __getitem__(self, index: slice) -> list[Operation]: ...
+    def __getitem__(self, index: slice) -> tuple[Operation, ...]: ...
 
     def __getitem__(self, index):
         return self.root[index]