Skip to content

vllm.utils.jsontree

Helper functions to work with nested JSON structures.

JSONTree module-attribute 

JSONTree = Union[
    dict[str, "JSONTree[_T]"],
    list["JSONTree[_T]"],
    tuple["JSONTree[_T]", ...],
    _T,
]

A nested JSON structure where the leaves need not be JSON-serializable.

_T module-attribute 

_T = TypeVar('_T')

_U module-attribute 

_U = TypeVar('_U')

json_iter_leaves 

json_iter_leaves(value: JSONTree[_T]) -> Iterable[_T]

Iterate through each leaf in a nested JSON structure.

Source code in vllm/utils/jsontree.py 
16
17
18
19
20
21
22
23
24
25
def json_iter_leaves(value: JSONTree[_T]) -> Iterable[_T]:
    """Iterate through each leaf in a nested JSON structure."""
    if isinstance(value, dict):
        for v in value.values():
            yield from json_iter_leaves(v)
    elif isinstance(value, (list, tuple)):
        for v in value:
            yield from json_iter_leaves(v)
    else:
        yield value

json_map_leaves 

json_map_leaves(
    func: Callable[[_T], _U], value: JSONTree[_T]
) -> JSONTree[_U]

Apply a function to each leaf in a nested JSON structure.

Source code in vllm/utils/jsontree.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
def json_map_leaves(
    func: Callable[[_T], _U],
    value: JSONTree[_T],
) -> JSONTree[_U]:
    """Apply a function to each leaf in a nested JSON structure."""
    if isinstance(value, dict):
        return {k: json_map_leaves(func, v) for k, v in value.items()}
    elif isinstance(value, list):
        return [json_map_leaves(func, v) for v in value]
    elif isinstance(value, tuple):
        return tuple(json_map_leaves(func, v) for v in value)
    else:
        return func(value)

json_reduce_leaves 

json_reduce_leaves(
    func: Callable[[_T, _T], _T], value: JSONTree[_T]
) -> _T

json_reduce_leaves(
    func: Callable[[_U, _T], _U],
    value: JSONTree[_T],
    initial: _U,
) -> _U

json_reduce_leaves(
    func: Callable[..., Union[_T, _U" backlink-type="used-by" backlink-anchor="vllm.utils.jsontree.json_reduce_leaves" optional hover>_U]],
    value: JSONTree[_T],
    initial: _U" backlink-type="used-by" backlink-anchor="vllm.utils.jsontree.json_reduce_leaves" optional hover>_U = ...,
) -> Union[_T, _U]

Apply a function of two arguments cumulatively to each leaf in a nested JSON structure, from left to right, so as to reduce the sequence to a single value.

Source code in vllm/utils/jsontree.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def json_reduce_leaves(
    func: Callable[..., Union[_T, _U]],
    value: JSONTree[_T],
    initial: _U = ...,  # type: ignore[assignment]
    /,
) -> Union[_T, _U]:
    """
    Apply a function of two arguments cumulatively to each leaf in a
    nested JSON structure, from left to right, so as to reduce the
    sequence to a single value.
    """
    if initial is ...:
        return reduce(func, json_iter_leaves(value))  # type: ignore[arg-type]

    return reduce(
        func,  # type: ignore[arg-type]
        json_iter_leaves(value),
        initial,
    )