Depset は、ターゲットの伝播依存関係全体でデータを効率的に収集するための特殊なデータ構造です。これらはルール処理の重要な要素です。
depset の特徴は、時間とスペースを節約する連結オペレーションです。depset コンストラクタは、要素のリスト（「直接」）と他の depset のリスト（「推移的」）を受け取り、すべての直接要素とすべての推移的セットのユニオンを含むセットを表す depset を返します。概念的には、コンストラクタは、直接ノードと推移ノードを持つ新しいグラフノードを作成します。Depset には、このグラフの走査に基づいて明確に定義された順序付けのセマンティクスがあります。
depset の使用例には、次のようなものがあります。
プログラムのライブラリのすべてのオブジェクト ファイルのパスを保存します。このパスは、プロバイダを介してリンカー アクションに渡すことができます。
インタープリタ言語の場合、実行可能ファイルの実行ファイルに含まれる伝播ソースファイルを保存します。
説明とオペレーション
概念的には、depset は有向非巡回グラフ（DAG）であり、通常はターゲット グラフに似ています。葉から根まで構築されます。依存関係チェーン内の各ターゲットは、前のターゲットを読み取ったりコピーしたりすることなく、独自のコンテンツを追加できます。
DAG 内の各ノードは、直接要素のリストと子ノードのリストを保持します。depset の内容は、すべてのノードの直接要素などの他動詞要素です。新しい depset は depset コンストラクタを使用して作成できます。このコンストラクタは、直接要素のリストと子ノードのリストを受け取ります。
s = depset(["a", "b", "c"])
t = depset(["d", "e"], transitive = [s])
print(s) # depset(["a", "b", "c"])
print(t) # depset(["d", "e", "a", "b", "c"])
depset の内容を取得するには、to_list() メソッドを使用します。重複を除くすべての推移関係要素のリストを返します。DAG の正確な構造を直接検査する方法はありませんが、この構造は要素が返される順序に影響します。
s = depset(["a", "b", "c"])
print("c" in s.to_list()) # True
print(s.to_list() == ["a", "b", "c"]) # True
辞書で許可されるキーが制限されているように、depset で許可されるアイテムも制限されています。特に、depset の内容は変更できない場合があります。
Depset は参照の等価性を使用します。Depset は自身と等価ですが、同じ内容と内部構造を持つ場合でも、他の Depset とは等しくありません。
s = depset(["a", "b", "c"])
t = s
print(s == t) # True
t = depset(["a", "b", "c"])
print(s == t) # False
d = {}
d[s] = None
d[t] = None
print(len(d)) # 2
内容で depset を比較するには、並べ替えられたリストに変換します。
s = depset(["a", "b", "c"])
t = depset(["c", "b", "a"])
print(sorted(s.to_list()) == sorted(t.to_list())) # True
depset から要素を削除することはできません。これが必要な場合は、depset のコンテンツ全体を読み取り、削除する要素をフィルタして、新しい depset を再構築する必要があります。これは特に効率的ではありません。
s = depset(["a", "b", "c"])
t = depset(["b", "c"])
# Compute set difference s - t. Precompute t.to_list() so it's not done
# in a loop, and convert it to a dictionary for fast membership tests.
t_items = {e: None for e in t.to_list()}
diff_items = [x for x in s.to_list() if x not in t_items]
# Convert back to depset if it's still going to be used for union operations.
s = depset(diff_items)
print(s) # depset(["a"])
注文
to_list オペレーションは DAG の走査を実行します。走査の種類は、depset の作成時に指定された順序によって異なります。ツールが入力の順序を気にすることがあるため、Bazel が複数の順序をサポートすることは便利です。たとえば、B が A に依存している場合、リンカーのコマンドラインでは A.o が B.o の前に配置されるように、リンカー アクションで確認する必要があります。他のツールでは、逆の要件が適用される場合があります。
3 つの走査順序（postorder、preorder、topological）がサポートされています。最初の 2 つは、DAG 上で動作し、すでに訪問したノードをスキップするという点を除き、ツリー トラバースとまったく同じように動作します。3 番目の順序は、ルートからリーフへのトポロジ順序付けとして機能します。共有子孫は、すべての親の後にのみリストされるという点を除き、基本的には先行順序と同じです。先行順序と後行順序は左から右への走査として動作しますが、各ノード内の直接要素は子要素に対して順序付けられません。トポロジ順序では、左から右への順序は保証されません。DAG の異なるノードに重複する要素がある場合、すべての親が子の前に来る保証も適用されません。
# This demonstrates different traversal orders.
def create(order):
cd = depset(["c", "d"], order = order)
gh = depset(["g", "h"], order = order)
return depset(["a", "b", "e", "f"], transitive = [cd, gh], order = order)
print(create("postorder").to_list()) # ["c", "d", "g", "h", "a", "b", "e", "f"]
print(create("preorder").to_list()) # ["a", "b", "e", "f", "c", "d", "g", "h"]
# This demonstrates different orders on a diamond graph.
def create(order):
a = depset(["a"], order=order)
b = depset(["b"], transitive = [a], order = order)
c = depset(["c"], transitive = [a], order = order)
d = depset(["d"], transitive = [b, c], order = order)
return d
print(create("postorder").to_list()) # ["a", "b", "c", "d"]
print(create("preorder").to_list()) # ["d", "b", "a", "c"]
print(create("topological").to_list()) # ["d", "b", "c", "a"]
走査の実装方法により、コンストラクタの order キーワード引数を使用して、depset の作成時に順序を指定する必要があります。この引数を省略すると、depset には特別な default 順序が付けられます。この場合、要素の順序は保証されません（確定的であることを除く）。
完全な例
この例は、https://github.com/bazelbuild/examples/tree/main/rules/depsets で入手できます。
仮想的なインタプリタ言語 Foo があるとします。各 foo_binary をビルドするには、直接または間接的に依存するすべての *.foo ファイルを把握する必要があります。
# //depsets:BUILD
load(":foo.bzl", "foo_library", "foo_binary")
# Our hypothetical Foo compiler.
py_binary(
name = "foocc",
srcs = ["foocc.py"],
)
foo_library(
name = "a",
srcs = ["a.foo", "a_impl.foo"],
)
foo_library(
name = "b",
srcs = ["b.foo", "b_impl.foo"],
deps = [":a"],
)
foo_library(
name = "c",
srcs = ["c.foo", "c_impl.foo"],
deps = [":a"],
)
foo_binary(
name = "d",
srcs = ["d.foo"],
deps = [":b", ":c"],
)
# //depsets:foocc.py
# "Foo compiler" that just concatenates its inputs to form its output.
import sys
if __name__ == "__main__":
assert len(sys.argv) >= 1
output = open(sys.argv[1], "wt")
for path in sys.argv[2:]:
input = open(path, "rt")
output.write(input.read())
ここで、バイナリ d の伝播ソースは、a、b、c、d の srcs フィールドにあるすべての *.foo ファイルです。foo_binary ターゲットが d.foo 以外のファイルを認識するには、foo_library ターゲットがプロバイダでそれらを渡す必要があります。各ライブラリは、独自の依存関係からプロバイダを受け取り、独自の即時ソースを追加し、拡張されたコンテンツを含む新しいプロバイダを渡します。foo_binary ルールも同じことを行いますが、プロバイダを返す代わりに、ソースの完全なリストを使用してアクションのコマンドラインを作成する点が異なります。
foo_library ルールと foo_binary ルールの完全な実装は次のとおりです。
# //depsets/foo.bzl
# A provider with one field, transitive_sources.
FooFiles = provider(fields = ["transitive_sources"])
def get_transitive_srcs(srcs, deps):
"""Obtain the source files for a target and its transitive dependencies.
Args:
srcs: a list of source files
deps: a list of targets that are direct dependencies
Returns:
a collection of the transitive sources
"""
return depset(
srcs,
transitive = [dep[FooFiles].transitive_sources for dep in deps])
def _foo_library_impl(ctx):
trans_srcs = get_transitive_srcs(ctx.files.srcs, ctx.attr.deps)
return [FooFiles(transitive_sources=trans_srcs)]
foo_library = rule(
implementation = _foo_library_impl,
attrs = {
"srcs": attr.label_list(allow_files=True),
"deps": attr.label_list(),
},
)
def _foo_binary_impl(ctx):
foocc = ctx.executable._foocc
out = ctx.outputs.out
trans_srcs = get_transitive_srcs(ctx.files.srcs, ctx.attr.deps)
srcs_list = trans_srcs.to_list()
ctx.actions.run(executable = foocc,
arguments = [out.path] + [src.path for src in srcs_list],
inputs = srcs_list + [foocc],
outputs = [out])
foo_binary = rule(
implementation = _foo_binary_impl,
attrs = {
"srcs": attr.label_list(allow_files=True),
"deps": attr.label_list(),
"_foocc": attr.label(default=Label("//depsets:foocc"),
allow_files=True, executable=True, cfg="host")
},
outputs = {"out": "%{name}.out"},
)
これをテストするには、これらのファイルを新しいパッケージにコピーし、ラベルの名前を適切に変更し、ダミー コンテンツを含むソース *.foo ファイルを作成して、d ターゲットをビルドします。
パフォーマンス
depset を使用する理由を確認するには、get_transitive_srcs() がソースをリストに収集した場合にどうなるかを考えてみましょう。
def get_transitive_srcs(srcs, deps):
trans_srcs = []
for dep in deps:
trans_srcs += dep[FooFiles].transitive_sources
trans_srcs += srcs
return trans_srcs
重複は考慮されないため、a のソースファイルはコマンドラインと出力ファイルのコンテンツに 2 回表示されます。
別の方法として、一般的なセットを使用することもできます。これは、キーが要素で、すべてのキーが True にマッピングされる辞書でシミュレートできます。
def get_transitive_srcs(srcs, deps):
trans_srcs = {}
for dep in deps:
for file in dep[FooFiles].transitive_sources:
trans_srcs[file] = True
for file in srcs:
trans_srcs[file] = True
return trans_srcs
これにより重複は排除されますが、コマンドライン引数の順序（およびファイルの内容）は指定されなくなります（ただし、確定的です）。
さらに、どちらのアプローチも、depset ベースのアプローチよりも漸近的に劣ります。Foo ライブラリに長い依存関係チェーンがある場合を考えてみましょう。すべてのルールを処理するには、その前に存在したすべての参照元を新しいデータ構造にコピーする必要があります。つまり、個々のライブラリまたはバイナリ ターゲットの分析にかかる時間とスペースのコストは、チェーン内の高さに比例します。長さ n のチェーン foolib_1 ← foolib_2 ← … ← foolib_n の場合、全体的なコストは実質的に O(n^2) になります。
一般に、転送依存関係を通じて情報を蓄積するときは、常に depset を使用する必要があります。これにより、ターゲット グラフの深さが増加してもビルドが適切にスケーリングされます。
最後に、ルールの実装で depset の内容を不必要に取得しないことが重要です。バイナリルールの最後に to_list() を 1 回呼び出すのは問題ありません。全体的なコストは O(n) にすぎません。ターミナル以外のターゲットが to_list() を呼び出そうとすると、二次的な動作が発生します。
depset を効率的に使用する方法について詳しくは、パフォーマンス ページをご覧ください。
API リファレンス
詳しくは、こちらをご覧ください。