Skip to content

Built-in Operations

This module contains the built-in RFC 6902 operation models: AddOp, RemoveOp, ReplaceOp, MoveOp, CopyOp, and TestOp.

AddOp

Bases: OperationSchema, Generic[T]

RFC 6902 add operation.

Source code in jsonpatchx/builtins.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class AddOp(OperationSchema, Generic[T]):
    """RFC 6902 add operation."""

    model_config = ConfigDict(
        title="Add operation",
        json_schema_extra={"description": "RFC 6902 add operation."},
    )

    op: Literal["add"] = "add"
    path: JSONPointer[T]
    value: T

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        return self.path.add(doc, self.value)

CopyOp

Bases: OperationSchema, Generic[T]

RFC 6902 copy operation.

Source code in jsonpatchx/builtins.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class CopyOp(OperationSchema, Generic[T]):
    """RFC 6902 copy operation."""

    model_config = ConfigDict(
        title="Copy operation",
        json_schema_extra={"description": "RFC 6902 copy operation."},
    )

    op: Literal["copy"] = "copy"
    from_: JSONPointer[T] = Field(alias="from")
    path: JSONPointer[T]

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        value = self.from_.get(doc)
        duplicate = copy.deepcopy(value)
        return AddOp[T](path=self.path, value=duplicate).apply(doc)

MoveOp

Bases: OperationSchema, Generic[T]

RFC 6902 move operation.

Source code in jsonpatchx/builtins.py 
 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
class MoveOp(OperationSchema, Generic[T]):
    """RFC 6902 move operation."""

    model_config = ConfigDict(
        title="Move operation",
        json_schema_extra={"description": "RFC 6902 move operation."},
    )

    op: Literal["move"] = "move"
    from_: JSONPointer[T] = Field(alias="from")
    path: JSONPointer[T]

    @model_validator(mode="after")
    def _reject_proper_prefixes(self) -> Self:
        if self.from_.is_parent_of(self.path):
            raise OperationValidationError(
                "pointer 'path' cannot be a child of pointer 'from'"
            )
        return self

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        value = self.from_.get(doc)
        doc = RemoveOp[T](path=self.from_).apply(doc)
        return AddOp[T](path=self.path, value=value).apply(doc)

RemoveOp

Bases: OperationSchema, Generic[T]

RFC 6902 remove operation. Removal of the root sets it to null.

Source code in jsonpatchx/builtins.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class RemoveOp(OperationSchema, Generic[T]):
    """RFC 6902 remove operation. Removal of the root sets it to null."""

    model_config = ConfigDict(
        title="Remove operation",
        json_schema_extra={
            "description": "RFC 6902 remove operation. Removal of the root sets it to null."
        },
    )

    op: Literal["remove"] = "remove"
    path: JSONPointer[T]

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        return self.path.remove(doc)

ReplaceOp

Bases: OperationSchema, Generic[T]

RFC 6902 replace operation.

Source code in jsonpatchx/builtins.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class ReplaceOp(OperationSchema, Generic[T]):
    """RFC 6902 replace operation."""

    model_config = ConfigDict(
        title="Replace operation",
        json_schema_extra={"description": "RFC 6902 replace operation."},
    )

    op: Literal["replace"] = "replace"
    path: JSONPointer[T]
    value: T

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        doc = RemoveOp[T](path=self.path).apply(doc)
        return AddOp[T](path=self.path, value=self.value).apply(doc)

TestOp

Bases: OperationSchema, Generic[T]

RFC 6902 test operation.

Source code in jsonpatchx/builtins.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
class TestOp(OperationSchema, Generic[T]):
    """RFC 6902 test operation."""

    __test__ = False  # Suppress pytest warning

    model_config = ConfigDict(
        title="Test operation",
        json_schema_extra={"description": "RFC 6902 test operation."},
    )

    op: Literal["test"] = "test"
    path: JSONPointer[T]
    value: T

    @override
    def apply(self, doc: JSONValue) -> JSONValue:
        actual = self.path.get(doc)
        if actual != self.value:
            raise TestOpFailed(
                f"test at path {self.path!r} failed, got {actual!r} but expected {self.value!r}"
            )
        return doc