| Home | Trees | Indices | Help |
|
|---|
|
|
Record entry for list of patch tasks.
Attributes:
**op**:
operations: ::
add, copy, move, remove, replace, test
**target**:
JSONPointer for the modification target, see RFC6902.
**value**:
Value, either a branch, or a leaf of the JSON data structure.
**src**:
JSONPointer for the modification source, see RFC6902.
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from |
|||
|
|||
|
Inherited from |
|||
|
|||
Create an entry for the patch list.
Args:
**op**:
Operation: ::
add, copy, move, remove, replace, test
**target**:
Target node. ::
target := (
<rfc6901-string>
| JSONPointer
| <path-items-list>
)
**param**:
Specific parameter for the operation.
+-------+--------------------+
| type | operation |
+=======+====================+
| value | add, replace, test |
+-------+--------------------+
| src | copy, move |
+-------+--------------------+
| param | None for 'remove' |
+-------+--------------------+
kargs:
**replace**:
Replace masked characters in *target* specification. ::
replace := (
True # replaces rfc6901 escape sequences: ~0 and ~1
| False # omit unescaping
)
.. note::
Match operations are proceeded literally, thus the
escaped characters should be consistent,
see rfc6901, Section 3.
default := False
Returns:
When successful returns 'True', else returns either 'False', or
raises an exception.
Success is the complete addition only, thus one failure returns
False.
Raises:
JSONDataPatchItemError
|
Evaluates the related task for the provided data.
Args:
**jdata**:
JSON data the task has to be
applied on.
Returns:
Returns a tuple of: ::
(n,lerr):
n: number of present active entries
lerr: list of failed entries
Raises:
JSONDataPatchError:
|
Compares this pointer with x.
Args:
**x**:
A valid Pointer.
Returns:
*True* or *False*.
Raises:
JSONPointerError
|
Support of various mappings. #. self[key] #. self[i:j:k] #. x in self #. for x in self |
Compares this pointer with x.
Args:
**x**: A valid Pointer.
Returns:
*True* or *False*.
Raises:
JSONPointerError
|
Prints the patch string in accordance to RFC6901.
|
Prints the patch string in accordance to RFC6901.
|
Applies the present patch list on the provided JSON document.
Args:
**jsondata**:
Document to be patched.
kargs:
**replace**:
Replace masked characters in *target* specification. ::
replace := (
True # replaces rfc6901 escape sequences: ~0 and ~1
| False # omit unescaping
)
.. note::
Match operations are proceeded literally, thus the
escaped characters should be consistent,
see rfc6901, Section 3.
If already decoded e.g. by the constructor, than should be
*FALSE*, is not idempotent.
default := False
Returns:
When successful returns 'True', else raises an exception.
Or returns a tuple: ::
(n,lerr):
n: number of present active entries
lerr: list of failed entries
Raises:
JSONDataPatchError:
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 4.0.0 on Fri Jun 15 17:16:45 2018 | http://epydoc.sourceforge.net |