引数

コマンドラインの一部の構築または全体の構築に必要なデータを、メモリ効率的にカプセル化するオブジェクト。

多くの場合、アクションには、伝播依存関係から蓄積された値を含む大きなコマンドラインが必要になります。たとえば、リンカー コマンドラインには、リンクされるすべてのライブラリに必要なすべてのオブジェクト ファイルが一覧表示されます。このような伝播データを depset に保存して、複数のターゲットで共有することをおすすめします。ただし、ルール作成者がアクション コマンドラインを作成する際にこれらの Depset を文字列のリストに変換しなければならない場合、このメモリ共有の最適化は無効になります。

このため、アクション構築関数は文字列に加えて Args オブジェクトを受け入れます。各 Args オブジェクトは、文字列と depset の連結を表します。データ操作の変換は省略可能です。Args オブジェクトは、実行フェーズでコマンドラインを計算するまで、カプセル化された Depset を処理しません。これにより、費用のかかるコピーを分析フェーズが完了するまで遅らせることができます。詳細については、パフォーマンスの最適化のページをご覧ください。

Args は ctx.actions.args() を呼び出して作成されます。ctx.actions.run() または ctx.actions.run_shell() の arguments パラメータとして渡すことができます。Args オブジェクトの各ミューテーションは、最終的なコマンドラインに値を追加します。

map_each 機能を使用すると、アイテムを文字列に変換する方法をカスタマイズできます。map_each 関数を指定しない場合、標準の変換は次のようになります。

• すでに文字列になっている値は、そのままになります。
• File オブジェクトは File.path 値に変換されます。
• Label オブジェクトは文字列表現に変換され、メイン リポジトリのコンテキストで解決されたときに同じオブジェクトに解決されます。可能であれば、文字列表現ではリポジトリの正規名を優先してリポジトリの名前を使用します。そのため、この表現は BUILD ファイルでの使用に適しています。表現の正確な形式は保証されませんが、//foo:bar、@repo//foo:bar、@@canonical_name~//foo:bar.bzl がその典型的な例です。
• 他のすべての型は、未指定の方法で文字列に変換されます。このため、文字列型でも File 型でもない値を add() に渡すことは避ける必要があります。また、それらを add_all() または add_joined() に渡す場合は、map_each 関数を指定する必要があります。

文字列のフォーマット（add*() メソッドの format、format_each、format_joined パラメータ）を使用する場合、形式テンプレートは文字列の % 置換と同じ方法で解釈されます。ただし、テンプレートに置換プレースホルダが 1 つだけ必要で、%s である必要があります。パーセント記号のリテラルは、%% としてエスケープできます。書式設定は、上記のように値が文字列に変換された後に適用されます。

各 add*() メソッドには、追加の位置パラメータ（残りの引数の前に挿入する「引数名」の文字列）を受け入れる代替形式があります。add_all と add_joined の場合、シーケンスが空であることが判明した場合、追加の文字列は追加されません。たとえば、同じ使用方法で、指定されたシーケンスに val1..val3 が含まれているか空であるかに応じて、--foo val1 val2 val3 --bar または --bar をコマンドラインに加えることができます。

コマンドラインの大きさがシステムで許容される最大サイズを超える可能性がある場合は、引数をパラメータ ファイルにスプールできます。use_param_file() と set_param_file_format() をご覧ください。

例: 次のコマンドラインを生成するとします。

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz

# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

メンバー

• add
• add_all
• add_joined
• set_param_file_format
• use_param_file

追加

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

パラメータ

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

処理のほとんどは、次の手順に沿って、追加される引数のリストに対して行われます。

1. 各ディレクトリ File 項目は、そのディレクトリに再帰的に含まれるすべての File に置き換えられます。
2. map_each が指定されている場合、各アイテムに適用され、結果の文字列リストが連結されて最初の引数リストが形成されます。それ以外の場合、初期引数リストは、各アイテムに標準変換を適用した結果です。
3. リスト内の各引数は、存在する場合は format_each でフォーマットされます。
4. uniquify が true の場合、重複する引数は削除されます。最初の出現箇所が残っています。
5. before_each 文字列が指定されている場合、リスト内の既存の引数の前に新しい引数として挿入されます。これにより、この時点で追加される引数の数は実質的に 2 倍になります。
6. リストが空で omit_if_empty が true（デフォルト）の場合を除き、引数名と terminate_with が指定されている場合は、それぞれ最初の引数と最後の引数として挿入されます。

パラメータ

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

処理は add_all() に似ていますが、values から派生した引数のリストは、join_with.join(...) のように 1 つの引数に結合され、指定された format_joined 文字列テンプレートを使用してフォーマットされます。add_all() とは異なり、アイテムが 1 つの引数に結合される場合は通常有用ではないため、before_each パラメータや terminate_with パラメータはありません。

フィルタリング後に引数に結合する文字列がなく、omit_if_empty が true（デフォルト）の場合、処理は行われません。結合する文字列が存在せず、omit_if_empty が false の場合、結合された文字列は空の文字列になります。

パラメータ

set_param_file_format

Args Args.set_param_file_format(format)

パラメータ

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

Bazel は、効率性を高めるために、実行中に params ファイルを出力ツリーに書き込むことを省略する場合があります。アクションをデバッグしていて、param ファイルを検査する場合は、ビルドに --materialize_param_files を渡します。

パラメータ