Skip to content

vllm.utils.collection_utils

Contains helpers that are applied to collections.

This is similar in concept to the collections module.

Classes:

  • LazyDict –

    Evaluates dictionary items only when they are accessed.

Functions:

LazyDict

Bases: Mapping[str, _V], Generic[_V]

Evaluates dictionary items only when they are accessed.

Adapted from: https://stackoverflow.com/a/47212782/5082708

Source code in vllm/utils/collection_utils.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class LazyDict(Mapping[str, _V], Generic[_V]):
    """
    Evaluates dictionary items only when they are accessed.

    Adapted from: https://stackoverflow.com/a/47212782/5082708
    """

    def __init__(self, factory: dict[str, Callable[[], _V]]):
        self._factory = factory
        self._dict: dict[str, _V] = {}

    def __getitem__(self, key: str) -> _V:
        if key not in self._dict:
            if key not in self._factory:
                raise KeyError(key)
            self._dict[key] = self._factory[key]()
        return self._dict[key]

    def __setitem__(self, key: str, value: Callable[[], _V]):
        self._factory[key] = value

    def __iter__(self):
        return iter(self._factory)

    def __len__(self):
        return len(self._factory)

as_list(maybe_list)

Convert iterable to list, unless it's already a list.

Source code in vllm/utils/collection_utils.py 
49
50
51
def as_list(maybe_list: Iterable[T]) -> list[T]:
    """Convert iterable to list, unless it's already a list."""
    return maybe_list if isinstance(maybe_list, list) else list(maybe_list)

chunk_list(lst, chunk_size)

Yield successive chunk_size chunks from lst.

Source code in vllm/utils/collection_utils.py 
 99
100
101
102
def chunk_list(lst: list[T], chunk_size: int) -> Generator[list[T]]:
    """Yield successive chunk_size chunks from lst."""
    for i in range(0, len(lst), chunk_size):
        yield lst[i : i + chunk_size]

common_prefix(items) 

common_prefix(items: Sequence[str]) -> str

common_prefix(items: Sequence[Sequence[T]]) -> Sequence[T]

Find the longest prefix common to all items.

Source code in vllm/utils/collection_utils.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
def common_prefix(items: Sequence[Sequence[T] | str]) -> Sequence[T] | str:
    """Find the longest prefix common to all items."""
    if len(items) == 0:
        return []
    if len(items) == 1:
        return items[0]

    shortest = min(items, key=len)
    if not shortest:
        return shortest[:0]

    for match_len in range(1, len(shortest) + 1):
        match = shortest[:match_len]
        for item in items:
            if item[:match_len] != match:
                return shortest[: match_len - 1]

    return shortest

flatten_2d_lists(lists)

Flatten a list of lists to a single list.

Source code in vllm/utils/collection_utils.py 
105
106
107
def flatten_2d_lists(lists: Iterable[Iterable[T]]) -> list[T]:
    """Flatten a list of lists to a single list."""
    return [item for sublist in lists for item in sublist]

full_groupby(values, *, key)

Unlike itertools.groupby, groups are not broken by non-contiguous data.

Source code in vllm/utils/collection_utils.py 
110
111
112
113
114
115
116
117
118
119
120
def full_groupby(values: Iterable[_V], *, key: Callable[[_V], _K]):
    """
    Unlike [`itertools.groupby`][], groups are not broken by
    non-contiguous data.
    """
    groups = defaultdict[_K, list[_V]](list)

    for value in values:
        groups[key(value)].append(value)

    return groups.items()

swap_dict_values(obj, key1, key2)

Swap values between two keys.

Source code in vllm/utils/collection_utils.py 
123
124
125
126
127
128
129
130
131
132
133
134
def swap_dict_values(obj: dict[_K, _V], key1: _K, key2: _K) -> None:
    """Swap values between two keys."""
    v1 = obj.get(key1)
    v2 = obj.get(key2)
    if v1 is not None:
        obj[key2] = v1
    else:
        obj.pop(key2, None)
    if v2 is not None:
        obj[key1] = v2
    else:
        obj.pop(key1, None)