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