ctx.actions を使用します。メンバー
- args
- declare_directory
- declare_file
- declare_symlink
- do_nothingdo_nothing
- expand_template
- run
- run_shell
- symlink
- template_dict
- 書き込み
args
Args actions.args()メモリ効率の高いコマンドラインをビルドするために使用できる Args オブジェクトを返します。
declare_directory
File actions.declare_directory(filename, *, sibling=None)ルールまたはアスペクトが、現在のパッケージ内に指定の名前のディレクトリを作成することを宣言します。ディレクトリを生成するアクションを作成する必要があります。ディレクトリの内容は Starlark から直接アクセスすることはできませんが、
Args.add_all() を使用してアクション コマンドで展開できます。predicted_directory の展開済みコンテンツに含めることができるのは、通常のファイルとディレクトリのみです。
パラメータ
| パラメータ | 説明 |
|---|---|
filename
|
required sibling が指定されていない場合、新しいディレクトリのパス（現在のパッケージを基準とする相対パス）。それ以外の場合は、ファイルのベース名（兄弟姉妹がディレクトリを定義） |
sibling
|
File または None（デフォルトは None）新しく宣言されたディレクトリと同じディレクトリにあるファイル。ファイルは現在のパッケージ内に存在する必要があります。 |
declare_file
File actions.declare_file(filename, *, sibling=None)ルールまたはアスペクトが、指定されたファイル名でファイルを作成することを宣言します。
sibling が指定されていない場合、ファイル名はパッケージ ディレクトリからの相対名になります。それ以外の場合は、ファイルは sibling と同じディレクトリにあります。現在のパッケージの外部でファイルを作成することはできません。ファイルを宣言するだけでなく、ファイルを発行するアクションを別途作成する必要があります。このアクションを作成するには、返された File オブジェクトをアクションの構築関数に渡す必要があります。
事前に宣言された出力ファイルは、この関数を使用して宣言する必要はありません（宣言することもできません）。代わりに、ctx.outputs から File オブジェクトを取得できます。使用例をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
filename
|
required sibling が指定されていない場合、新しいファイルのパス（現在のパッケージを基準とする相対パス）。それ以外の場合は、ファイルのベース名（兄弟要素でディレクトリが決まります）。 |
sibling
|
File または None（デフォルトは None）新しく作成されたファイルと同じディレクトリにあるファイル。ファイルは現在のパッケージ内に存在する必要があります。 |
declare_symlink
File actions.declare_symlink(filename, *, sibling=None)ルールまたはアスペクトが、現在のパッケージ内に指定の名前のシンボリック リンクを作成することを宣言します。このシンボリック リンクを生成するアクションを作成する必要があります。Bazel はこのシンボリック リンクを逆参照せず、サンドボックスまたはリモート エグゼキュータにそのまま転送します。ツリー アーティファクト内のシンボリック リンクは現在サポートされていません。
パラメータ
| パラメータ | 説明 |
|---|---|
filename
|
required sibling が指定されていない場合は、現在のパッケージに対する新しいシンボリック リンクのパス。それ以外の場合は、ファイルのベース名（兄弟姉妹がディレクトリを定義） |
sibling
|
File、または None（デフォルトは None）新しく宣言されたシンボリック リンクと同じディレクトリに存在するファイル。 |
do_nothing
None actions.do_nothing(mnemonic, inputs=[])パラメータ
| パラメータ | 説明 |
|---|---|
mnemonic
|
required CppCompile や GoLink など、アクションの 1 単語の説明。 |
inputs
|
File のシーケンス、または depset。デフォルトは [] です。アクションの入力ファイルのリスト。 |
expand_template
None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)substitutions ディクショナリを使用して、置換が指定された順序で置き換えられます。辞書のキーがテンプレートに表示される場合（または以前の置換の結果）、関連する値に置き換えられます。キーに特別な構文はありません。たとえば、競合を避けるために中かっこを使用できます（例: {KEY}）。使用例を見る
パラメータ
| パラメータ | 説明 |
|---|---|
template
|
必須 テンプレート ファイル。UTF-8 でエンコードされたテキスト ファイルです。 |
output
|
required 出力ファイル。UTF-8 でエンコードされたテキスト ファイルです。 |
substitutions
|
デフォルトは {} です。テンプレートの拡張時に行う置換。 |
is_executable
|
デフォルトは False です。出力ファイルを実行可能かどうかを指定します。 |
computed_substitutions
|
TemplateDict: デフォルトは unbound ですテンプレートを展開する際に行う置換。 |
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=unbound)パラメータ
| パラメータ | 説明 |
|---|---|
outputs
|
File のシーケンス。必須 アクションの出力ファイルのリスト。 |
inputs
|
File のシーケンスまたは depset。デフォルトは [] ですアクションの入力ファイルのリストまたは depset。 |
unused_inputs_list
|
File; または None。デフォルトは None です。アクションで使用されていない入力のリストを含むファイル。 このファイルの内容（通常はアクションの出力の一つ）は、アクションの実行中に使用されなかった入力ファイルのリストに対応しています。これらのファイルを変更しても、アクションの出力にはどのような影響も及びません。 |
executable
|
File; または string; または FilesToRunProvider;
必須 アクションによって呼び出される実行可能ファイル。 |
tools
|
sequence または depset。デフォルトは unbound です。アクションに必要なツールのリストまたは depset。ツールは、アクションで自動的に使用可能になる追加のランファイルを含む入力です。リストを指定する場合、Files の異種コレクション、FilesToRunProvider インスタンス、または Files の Depset になります。リスト内に直接あり、での language.executable からのファイルには、runfile が自動的に追加されます。依存関係を指定する場合は、Files のみを含める必要があります。いずれの場合も、depset 内のファイルは runfile で HDFS.executable と相互参照されません。 |
arguments
|
sequence;
デフォルトは [] ですアクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。
|
mnemonic
|
string; または None:
デフォルトは Noneアクションの 1 単語の説明（例: CppCompile、GoLink）。 |
progress_message
|
string; または None:
デフォルトは Noneビルド中にユーザーに表示される進行状況メッセージ（例: 「Compiling foo.cc to create foo.o」）。メッセージには %{label}、%{input}、%{output} のパターンを含めることができ、これらはそれぞれラベル文字列、最初の入力、出力のパスに置換されます。静的文字列ではなくパターンを使用する方が効率的であるため、パターンを使用します。
|
use_default_shell_env
|
デフォルトは False です。アクションがデフォルトのシェル環境を使用するかどうか。このシェル環境は、いくつかの OS 依存変数と --action_env で設定された変数で構成されます。
|
env
|
dict または None: デフォルトは None です。環境変数の辞書を設定します。
|
execution_requirements
|
dict または None。デフォルトは None です。アクションをスケジュールするための情報。便利なキーについては、タグをご覧ください。 |
input_manifests
|
シーケンスまたは None。デフォルトは None です。（試験運用版）は、入力ランファイルのメタデータを設定します。通常は、resolve_command によって生成されます。 |
exec_group
|
文字列または None、
デフォルトは None指定された実行グループの実行プラットフォームでアクションを実行します。指定しない場合、ターゲットのデフォルトの実行プラットフォームが使用されます。 |
shadowed_action
|
Action: デフォルトは None です。指定されたシャドウ アクションの入力と、アクションの入力リストと環境に追加された環境を使用して、アクションを実行します。アクション環境は、シャドウ アクションの環境変数を上書きできます。指定しない場合、アクションの入力と指定された環境のみを使用します。 |
resource_set
|
呼び出し可能、または None。デフォルトは None です。リソースセット辞書を返すコールバック関数。アクションがローカルで実行されている場合に、実行時にリソース使用量を推定するために使用されます。 この関数は 2 つの位置引数を受け取ります。OS 名（「osx」など）を表す文字列と、アクションへの入力数を表す整数です。返されるディクショナリには次のエントリが含まれます。各エントリは float または int です。
このパラメータが コールバックはトップレベルにする必要があります（ラムダ関数とネストされた関数は使用できません）。 |
toolchain
|
ラベルまたは文字列、または None。デフォルトは unboundこのアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、このパラメータを設定する必要があります。 現時点では何もする必要はありませんが、今後の Bazel リリースで必要になるため、ツールチェーンを使用するときに設定することをおすすめします。 このアクションを作成するルールでは、「rule()」関数内でこのツールチェーンを定義する必要があります。 「ツールチェーン」と「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=unbound)パラメータ
| パラメータ | 説明 |
|---|---|
outputs
|
File のシーケンス。必須 アクションの出力ファイルのリスト。 |
inputs
|
File のシーケンスまたは depset。デフォルトは [] ですアクションの入力ファイルのリストまたは depset。 |
tools
|
File のシーケンスまたは depset。デフォルトは unbound ですアクションに必要なツールのリストまたは依存関係。ツールは、アクションで自動的に使用可能になる追加のランファイルを含む入力です。このリストには、Files インスタンスまたは FilesToRunProvider インスタンスを含めることができます。 |
arguments
|
sequence;
デフォルトは [] ですアクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。Bazel は、この属性内の要素を引数としてコマンドに渡します。コマンドは、
|
mnemonic
|
string; または None:
デフォルトは Noneアクションの 1 単語の説明（例: CppCompile、GoLink）。 |
command
|
string: または string のシーケンス。
必要な 実行に必要なシェルコマンド。文字列（推奨）か、文字列のシーケンス（非推奨）を指定できます。
（非推奨） Bazel では、genrules と同じシェルを使用してコマンドを実行します。 |
progress_message
|
string; または None:
デフォルトは Noneビルド中にユーザーに表示される進行状況メッセージ（例: 「Compiling foo.cc to create foo.o」）。メッセージには %{label}、%{input}、%{output} のパターンを含めることができ、これらはそれぞれラベル文字列、最初の入力、出力のパスに置換されます。静的文字列ではなくパターンを使用する方が効率的であるため、パターンを使用します。
|
use_default_shell_env
|
デフォルトは False です。アクションがデフォルトのシェル環境を使用するかどうか。このシェル環境は、いくつかの OS 依存変数と --action_env で設定された変数で構成されます。
|
env
|
dict または None: デフォルトは None です。環境変数の辞書を設定します。
|
execution_requirements
|
dict または None。デフォルトは None です。アクションをスケジュールするための情報。便利なキーについては、タグをご覧ください。 |
input_manifests
|
シーケンスまたは None。デフォルトは None です。（試験運用版）は、入力ランファイルのメタデータを設定します。通常は、resolve_command によって生成されます。 |
exec_group
|
文字列または None、
デフォルトは None指定された実行グループの実行プラットフォームでアクションを実行します。指定しない場合、ターゲットのデフォルトの実行プラットフォームが使用されます。 |
shadowed_action
|
Action:
デフォルトは None です。指定されたシャドウ アクションで検出された入力がアクションの入力リストに追加され、その入力を使用してアクションを実行します。指定しない場合は、アクションの入力のみを使用します。 |
resource_set
|
callable、または None。デフォルトは None です。ローカルで実行する場合のリソース使用量を見積もるコールバック関数。 ctx.actions.run() をご覧ください。 |
toolchain
|
ラベルまたは文字列、または None。デフォルトは unboundこのアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、このパラメータを設定する必要があります。 現時点では何もする必要はありませんが、今後の Bazel リリースで必要になるため、ツールチェーンを使用するときに設定することをおすすめします。 このアクションを作成するルールでは、「rule()」関数内でこのツールチェーンを定義する必要があります。 「ツールチェーン」と「exec_group」の両方のパラメータが設定されている場合、`exec_group` が使用されます。`exec_group` が同じものを指定していない場合、エラーが発生します。 |
symlink
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
|
required このアクションの出力。 |
target_file
|
ファイルまたは None（デフォルトは None）出力シンボリック リンクが参照するファイル。 |
target_path
|
文字列または None。
デフォルトは None です。出力シンボリック リンクが指す正確なパス。正規化やその他の処理は適用されません。 |
is_executable
|
デフォルトは False です。target_file でのみ使用でき、target_path では使用できません。true の場合、アクションの実行時に target_file のパスがチェックされて実行可能かどうかが確認され、実行可能でない場合はエラーが報告されます。is_executable を False に設定しても、ターゲットが実行不可であるわけではなく、単に検証が行われないだけです。
|
progress_message
|
string: None: デフォルトは None です。ビルド中にユーザーに表示される進行状況メッセージ。 |
template_dict
TemplateDict actions.template_dict()メモリ効率の高いテンプレート展開用の TemplateDict オブジェクトを返します。
書き込み
None actions.write(output, content, is_executable=False)expand_template の使用を検討してください。
パラメータ
| パラメータ | 説明 |
|---|---|
output
|
required 出力ファイル。 |
content
|
string: Args:
ファイルの内容。文字列または actions.args() オブジェクトのいずれかになります。 |
is_executable
|
デフォルトは False です。出力ファイルを実行可能かどうかを指定します。 |