depset
A specialized data structure that supports efficient merge operations and has a defined traversal order. Commonly used for accumulating data from transitive dependencies in rules and aspects. For more information see here.
Depsets are not implemented as hash sets and do not support fast membership tests. If you need a general set datatype, you can simulate one using a dictionary where all keys map to True
.
Depsets are immutable. They should be created using their constructor function and merged or augmented with other depsets via the transitive
argument. There are other deprecated methods (
and +
operators, union
method) that will eventually go away.
The order
parameter determines the kind of traversal that is done to convert the depset to an iterable. There are four possible values:
"default"
(formerly"stable"
): Order is unspecified (but deterministic)."postorder"
(formerly"compile"
): A lefttoright postordering. Precisely, this recursively traverses all children leftmostfirst, then the direct elements leftmostfirst."preorder"
(formerly"naive_link"
): A lefttoright preordering. Precisely, this traverses the direct elements leftmostfirst, then recursively traverses the children leftmostfirst."topological"
(formerly"link"
): A topological ordering from the root down to the leaves. There is no lefttoright guarantee.
Two depsets may only be merged if either both depsets have the same order, or one of them has "default"
order. In the latter case the resulting depset's order will be the same as the other's order.
Depsets may contain duplicate values but these will be suppressed when iterating (using to_list()
). Duplicates may interfere with the ordering semantics.
to_list
list depset.to_list()Returns a list of the elements, without duplicates, in the depset's traversal order. Note that order is unspecified (but deterministic) for elements that were added more than once to the depset. Order is also unspecified for
"default"
ordered depsets, and for elements of child depsets whose order differs from that of the parent depset. The list is a copy; modifying it has no effect on the depset and vice versa.
union
depset depset.union(new_elements)(Deprecated) Returns a new depset that is the merge of the given depset and
new_elements
. Use the transitive
constructor argument instead.
Parameters
Parameter  Description 

new_elements

The elements to be added. 