アクション

Action を作成する関数を提供するモジュール。このモジュールにアクセスするには、ctx.actions を使用します。

メンバー

args

Args actions.args()

メモリ効率の高いコマンドラインの構築に使用できる Args オブジェクトを返します。

declare_directory

File actions.declare_directory(filename, *, sibling=None)

ルールまたはアスペクトが、現在のパッケージに指定された名前のディレクトリを作成することを宣言します。ディレクトリを生成するアクションを作成する必要があります。ディレクトリの内容は Starlark から直接アクセスすることはできませんが、Args.add_all() を使用してアクション コマンドで展開できます。

パラメータ

パラメータ 説明
filename 必須
「兄弟」が指定されていない場合、現在のパッケージを基準とする新しいディレクトリのパス。それ以外は、ファイルのベース名です（兄弟姉妹でディレクトリを定義）。
sibling File; or None; デフォルト = None
新たに宣言されたディレクトリと同じディレクトリにあるファイル。ファイルは現在のパッケージに存在する必要があります。

declare_file

File actions.declare_file(filename, *, sibling=None)

ルールまたはアスペクトが、指定されたファイル名でファイルを作成することを宣言します。sibling が指定されていない場合、ファイル名はパッケージ ディレクトリを基準とします。指定されている場合は、ファイルは sibling と同じディレクトリにあります。現在のパッケージの外部でファイルを作成することはできません。

ファイルを宣言するだけでなく、ファイルを発行するアクションを別途作成する必要があります。このアクションを作成するには、返された File オブジェクトをアクションの構築関数に渡す必要があります。

事前宣言された出力ファイルは、この関数を使用して宣言する必要はありません（宣言できません）。代わりに、ctx.outputs から File オブジェクトを取得できます。使用例をご覧ください。

パラメータ

パラメータ 説明
filename 必須
「sibling」がない場合指定された新しいファイルのパス（現在のパッケージに対する相対パス）。それ以外の場合は、ファイルのベース名（「兄弟」はディレクトリを決定します）。
sibling File; or None; デフォルト = None
新たに作成されたファイルと同じディレクトリにあるファイル。ファイルは現在のパッケージに存在する必要があります。 

File actions.declare_symlink(filename, *, sibling=None)

試験運用版。このパラメータは試験運用版で、いつでも変更できます。これに依存しないでください。--experimental_allow_unresolved_symlinks を設定することで、試験運用版として有効にできます。

ルールまたはアスペクトが、現在のパッケージ内に指定の名前のシンボリック リンクを作成することを宣言します。このシンボリック リンクを生成するアクションを作成する必要があります。Bazel は、このシンボリック リンクを参照解除することはなく、そのままサンドボックスまたはリモート エグゼキュータに転送します。

パラメータ

パラメータ 説明
filename 必須
「兄弟」が指定されていない場合、現在のパッケージに対する新しいシンボリック リンクのパス。それ以外は、ファイルのベース名です（兄弟姉妹でディレクトリを定義）。
sibling File; or None; デフォルト = None
新たに宣言されたシンボリック リンクと同じディレクトリにあるファイル。

do_nothing

None actions.do_nothing(mnemonic, inputs=[])

コマンドを実行も出力も生成しない空のアクションを作成しますが、「追加のアクション」を挿入するために役立ちます。

パラメータ

パラメータ 説明
mnemonic 必須
アクションの 1 語の説明（CppCompile や GoLink など）。
inputs sequence of Files; or depset; デフォルト = []
アクションの入力ファイルのリスト。

expand_template

None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)

テンプレート展開アクションを作成します。アクションが実行されると、テンプレートに基づいてファイルが生成されます。テンプレートの一部は、置換が指定された順序で substitutions ディクショナリを使用して置き換えられます。テンプレート（または以前の置換の結果）に辞書のキーが出現するたびに、関連する値に置き換えられます。キーに特別な構文はありません。たとえば、競合を避けるために中かっこを使用できます（例: {KEY}）。使用例を見る

パラメータ

パラメータ 説明
template 必須
UTF-8 でエンコードされたテキスト ファイルであるテンプレート ファイル。
output 必須
UTF-8 でエンコードされたテキスト ファイルである出力ファイル。
substitutions default = {}
テンプレートの展開時に行う置換。
is_executable デフォルト = False
出力ファイルを実行可能にするかどうか。
computed_substitutions TemplateDict; デフォルト = バインドなし
試験運用版。このパラメータは試験運用版で、いつでも変更できます。これに依存しないでください。--+experimental_lazy_template_expansion
[試験運用版: テンプレートの拡張時に使用する置換] を設定すると、試験運用版に基づいて有効にできます。

run

None actions.run(outputs, inputs=[], unused_inputs_list=None, executable, tools=unbound, arguments=[], mnemonic=None, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)

実行可能ファイルを実行するアクションを作成します。使用例をご覧ください。

パラメータ

パラメータ 説明
outputs sequence of Files; 必須
アクションの出力ファイルのリスト。
inputs sequence of Files; or depset; デフォルト = []
アクションの入力ファイルのリストまたは depset。
unused_inputs_list File; or None; デフォルト = None
アクションで使用されない入力のリストを含むファイル。

このファイルの内容（通常はアクションの出力の一つ）は、アクションの実行中に使用されなかった入力ファイルのリストに対応しています。これらのファイルの変更が、アクションの出力に影響を与えないようにする必要があります。

executable File; or string; or FilesToRunProvider; 必須
アクションによって呼び出される実行可能ファイル。
tools sequence; or depset; デフォルト = 無制限
アクションに必要なツールのリストまたは depset。ツールは、アクションで自動的に使用できる追加のランファイルを備えた入力です。リストを指定する場合、Files の異種コレクション、FilesToRunProvider インスタンス、または Files の Depset になります。リストに直接含まれ、ctx.executable から取得されたファイルには、ランファイルが自動的に追加されます。depset を指定する場合は、Files のみを含める必要があります。どちらの場合も、depset 内のファイルは runfile で HDFS.executable との相互参照は行われません。
arguments sequence; デフォルト = []
アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。
mnemonic string; or None; デフォルト = None
アクションの 1 語の説明（CppCompile や GoLink など）。
progress_message string; or None; デフォルト = None
ビルド中にユーザーに表示される進行状況メッセージ（例: 「Compiling foo.cc to create foo.o」）。メッセージには %{label}、%{input}、%{output} のいずれかのパターンが含まれ、それぞれラベル文字列、最初の入力、出力のパスに置き換えられます。静的文字列ではなくパターンを使用することをおすすめします。パターンの方が効率的です。
use_default_shell_env default = False
このアクションで組み込みのシェル環境を使用するかどうか。
env dict; or None; デフォルト = None
環境変数の辞書を設定します。
execution_requirements dict; or None; デフォルト = None
アクションのスケジュール設定に関する情報。便利なキーについては、タグをご覧ください。
input_manifests sequence; or None; デフォルト = None
（試験運用版）入力ランファイルのメタデータを設定します。通常は resolve_command によって生成されます。
exec_group string; or None; デフォルト = None
指定された実行グループの実行プラットフォームでアクションを実行します。指定しない場合、ターゲットのデフォルトの実行プラットフォームが使用されます。
shadowed_action Action; デフォルト = None
指定されたシャドウされたアクションの入力と、アクションの入力リストと環境に追加された環境を使用してアクションを実行します。アクション環境は、シャドウ アクションの環境変数を上書きできます。指定しない場合、アクションの入力と指定された環境のみを使用します。
resource_set callable; or None; デフォルト = None
リソースセット ディクショナリを返すコールバック関数。このアクションがローカルで実行される場合に、実行時にリソース使用量を見積もるために使用されます。

この関数は、OS 名を表す文字列（osx など）と、アクションへの入力の数を表す整数という 2 つの位置引数を受け取ります。返される辞書には、次のエントリが含まれます。各エントリは浮動小数点数または整数です。

  • "cpu": CPU の数。デフォルト 1
  • "memory": MB 単位。デフォルトは 250
  • "local_test": ローカルテストの数。デフォルト 1

このパラメータが None に設定されている場合、または --experimental_action_resource_set が false の場合、デフォルト値が使用されます。

コールバックはトップレベルである必要があります（ラムダ関数とネストされた関数は使用できません）。
toolchain Label; or string; or None; デフォルト = None

このアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、このパラメータを設定する必要があります。

現在は no-op ですが、今後の Bazel リリースで必須となるため、ツールチェーンを使用する場合は設定することをおすすめします。

このアクションを作成するルールでは、このツールチェーンを「rule()」内で定義する必要があります。使用します。

「toolchain」パラメータと「exec_group」パラメータの両方が設定されている場合、「exec_group」が使用されます。「exec_group」が同じ値を指定していない場合、エラーが発生します。

run_shell

None actions.run_shell(outputs, inputs=[], tools=unbound, arguments=[], mnemonic=None, command, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=None)

シェルコマンドを実行するアクションを作成します。使用例をご覧ください。

パラメータ

パラメータ 説明
outputs sequence of Files; 必須
アクションの出力ファイルのリスト。
inputs sequence of Files; or depset; デフォルト = []
アクションの入力ファイルのリストまたは依存関係。
tools sequence of Files; or depset; デフォルト = バインドなし
アクションに必要なツールを列挙またはデプロイします。ツールは、アクションで自動的に使用可能になる追加のランファイルを含む入力です。このリストには、Files または FilesToRunProvider のインスタンスを含めることができます。
arguments sequence; デフォルト = []
アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。

Bazel は、この属性内の要素を引数としてコマンドに渡します。コマンドは、$1、$2 などのシェル変数置換を使用してこれらの引数にアクセスできます。Args オブジェクトはインデックス作成前にフラット化されるため、サイズの不明な Args オブジェクトがある場合、後続のすべての文字列は予測不能なインデックスになります。サイズが不確定な Args オブジェクトと一緒に $@（すべての引数を取得する）を使用すると便利なことがあります。

command が文字列のリストの場合、このパラメータは使用できません。

mnemonic string; or None; デフォルト = None
アクションの 1 語の説明（CppCompile や GoLink など）。
command string; or sequence of strings; 必須
実行するシェルコマンド。文字列（推奨）か、文字列のシーケンス（非推奨）を指定できます。

command が文字列の場合は、sh -c <command> "" <arguments> であるかのように実行されます。つまり、arguments の要素は $1、$2（または、Windows バッチを使用する場合は %1、%2）などとしてコマンドで使用可能になります。arguments に actions.args() オブジェクトが含まれている場合、その内容がコマンドラインに 1 つずつ追加されるため、$i は Args オブジェクト内の個々の文字列を参照できます。不明なサイズの Args オブジェクトが arguments の一部として渡されると、文字列は不明なインデックスになります。この場合は、$@ シェルの置換（すべての引数の取得）が便利です。

（非推奨）command が文字列のシーケンスの場合、最初の項目は実行する実行可能ファイルで、残りの項目はその引数です。この形式を使用する場合は、arguments パラメータを指定しないでください。なお、このフォームは非推奨となり、まもなく削除される予定です。これは `--compatible_run_shell_command_string` を使用すると無効になります。このフラグを使用して、コードの互換性を検証します。で確認できます。

Bazel では、genrules と同じシェルを使用してコマンドを実行します。

progress_message string; or None; default = None
ビルド中にユーザーに表示する進行状況メッセージ（「foo.cc をコンパイルして foo.o を作成」など）。メッセージには %{label}、%{input}、%{output} のパターンを含めることができ、これらはそれぞれラベル文字列、最初の入力、出力のパスに置換されます。静的文字列ではなくパターンを使用することをおすすめします。パターンの方が効率的です。
use_default_shell_env default = False
このアクションで組み込みのシェル環境を使用するかどうか。
env dict; or None; デフォルト = None
環境変数のディクショナリを設定します。
execution_requirements dict; or None; デフォルト = None
アクションのスケジュール設定に関する情報。便利なキーについては、タグをご覧ください。
input_manifests sequence; or None; デフォルト = None
（試験運用版）入力ランファイルのメタデータを設定します。通常は resolve_command によって生成されます。
exec_group string; or None; デフォルト = None
指定された実行グループの実行プラットフォームでアクションを実行します。指定しない場合、ターゲットのデフォルトの実行プラットフォームが使用されます。
shadowed_action Action; デフォルト = None
アクションの入力リストに追加された、指定されたシャドウ アクションで検出された入力を使用してアクションを実行します。指定しない場合、アクションの入力のみを使用します。
resource_set callable; or None; デフォルト = None
ローカルで実行する場合のリソース使用量を見積もるためのコールバック関数。ctx.actions.run() を参照してください。
toolchain Label; or string; or None; デフォルト = None

このアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、パラメータを設定する必要があります。

現在は no-op ですが、今後の Bazel リリースで必須となるため、ツールチェーンを使用する場合は設定することをおすすめします。

このアクションを作成するルールでは、このツールチェーンを「rule()」内で定義する必要があります。使用します。

「ツールチェーン」と「exec_group」の両方のパラメータが設定されている場合、`exec_group` が使用されます。「exec_group」で同じ toolchain が指定されていない場合、エラーが発生します。

 

None actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)

ファイル システムにシンボリック リンクを書き込成するアクションを作成します。

この関数は、target_file または target_path のいずれか 1 つを指定して呼び出す必要があります。

target_file を使用する場合は、output を declare_file() または declare_directory() で宣言し、target_file の型と一致させます。これにより、シンボリック リンクが target_file を参照するようになります。Bazel は、シンボリック リンクのターゲットまたはその内容が変更されるたびに、このアクションの出力を無効にします。

それ以外の場合は、target_path を使用するときに、declare_symlink() で output を宣言します。この場合、シンボリック リンクは target_path を指します。Bazel ではシンボリック リンクは解決されず、シンボリック リンクのテキスト コンテンツ（readlink() の値）が変更された場合にのみ、このアクションの出力が無効になります。特に、これを使用してダングリング シンボリック リンクを作成できます。

パラメータ

パラメータ 説明
output 必須
このアクションの出力。
target_file File; or None; デフォルト = None
出力シンボリック リンクが参照するファイル。
target_path string; or None; デフォルト = None
（試験運用版）出力シンボリック リンクが参照する正確なパス。正規化などの処理は適用されません。この機能にアクセスするには、--experimental_allow_unresolved_symlinks を設定する必要があります。
is_executable デフォルト = False
target_file でのみ使用でき、target_path では使用できません。true の場合、アクションの実行時に target_file のパスを確認して実行可能かどうかを確認し、実行可能でない場合エラーを報告します。is_executable を False に設定しても、ターゲットが実行不可であるわけではなく、検証が行われないだけです。

target_path の場合、ビルド時にダングリング シンボリック リンクが存在しない可能性があるため、この機能は意味がありません。
progress_message string; or None; デフォルト = None
ビルド中にユーザーに表示する進行状況メッセージ。

template_dict

TemplateDict actions.template_dict()

試験運用版。この API は試験運用版であり、いつでも変更される可能性があります。これに依存しないでください。--+experimental_lazy_template_expansion
試験運用版: メモリ効率の高いテンプレート展開用の TemplateDict オブジェクトを返します。を設定することで、試験運用版として有効にできます。

write

None actions.write(output, content, is_executable=False)

ファイル書き込みアクションを作成します。アクションが実行されると、指定されたコンテンツがファイルに書き込まれます。分析フェーズで入手可能な情報を使用してファイルを生成するために使用されます。ファイルが大きく、静的コンテンツが多い場合は、expand_template の使用を検討してください。

パラメータ

パラメータ 説明
output 必須
出力ファイル。
content string; or Args: 必須
ファイルの内容。文字列または actions.args() オブジェクトです。
is_executable デフォルト = False
出力ファイルを実行可能にするかどうか。