Args

アクションが推移的依存関係から蓄積された値を含む大きなコマンドラインを必要とすることがよくあります。たとえば、リンカー コマンドラインでは、リンクされるすべてのライブラリが必要とするすべてのオブジェクト ファイルをリストできます。このような推移的データは、複数のターゲットで共有できるように 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 値に変換されます。
• 他のすべての型は、指定されていない方法で文字列に変換されます。このため、文字列型でも 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_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() とは異なり、before_each または terminate_with パラメータは一般に、アイテムを 1 つの引数に結合するときに有用ではないため、存在しません。

フィルタリング後に引数に結合する文字列がなく、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 を渡します。

パラメータ