ctx.actions を使用してアクセスします。メンバー
- args
- declare_directory
- declare_file
- declare_symlink
- do_nothing
- expand_template
- run
- run_shell
- symlink
- template_dict
- write
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
|
File; or None;
デフォルト = None新たに作成されたファイルと同じディレクトリにあるファイル。ファイルは現在のパッケージに存在する必要があります。 |
declare_symlink
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 Experimental: Substitutions to make when expanding the template を設定することで、試験運用版として有効にできます。 |
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アクションで使用されない入力のリストを含むファイル。 このファイルの内容（通常はアクションの出力の 1 つ）は、アクションの実行全体で使用されなかった入力ファイルのリストに対応しています。これらのファイルの変更が、アクションの出力に影響を与えないようにする必要があります。 |
executable
|
File; or string; or FilesToRunProvider;
必須アクションによって呼び出される実行可能ファイル。 |
tools
|
sequence; or depset;
デフォルト = 無制限アクションに必要なツールのリストまたは depset。ツールは、アクションで自動的に使用できる追加のランファイルを備えた入力です。リストが指定されている場合は、Files、FilesToRunProvider インスタンス、または Files の depset の異種コレクションにすることができます。リストに直接含まれ、ctx.executable から取得されたファイルには、実行ファイルが自動的に追加されます。depset を指定する場合は、Files のみを含める必要があります。どちらの場合も、depset 内のファイルは、runfile の ctx.executable と相互参照されません。 |
arguments
|
sequence;
デフォルト = []アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。
|
mnemonic
|
string; or None;
デフォルト = Noneアクションの 1 語の説明（CppCompile や GoLink など）。 |
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このアクションがローカルで実行される場合に、実行時のリソース使用量を推定するために使用される、リソースセット ディクショナリを返すコールバック関数。 この関数は、OS 名を表す文字列（osx など）と、アクションへの入力の数を表す整数という 2 つの位置引数を受け取ります。返される辞書には、次のエントリが含まれます。各エントリは浮動小数点数または整数です。
このパラメータが コールバックはトップレベルである必要があります（ラムダ関数とネストされた関数は使用できません）。 |
toolchain
|
Label; or string; or None;
default = Noneこのアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、パラメータを設定する必要があります。 現在は 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=None)シェルコマンドを実行するアクションを作成します。使用例をご覧ください。
パラメータ
| パラメータ | 説明 |
|---|---|
outputs
|
sequence of Files;
必須アクションの出力ファイルのリスト。 |
inputs
|
sequence of Files; or depset;
デフォルト = []アクションの入力ファイルのリストまたは depset。 |
tools
|
sequence of Files; or depset;
デフォルト = 無制限アクションに必要なツールのリストまたは depset。ツールは、アクションで自動的に使用できる追加のランファイルを備えた入力です。このリストには、Files または FilesToRunProvider のインスタンスを含めることができます。 |
arguments
|
sequence;
デフォルト = []アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。Bazel は、この属性の要素をコマンドに引数として渡します。コマンドは、
|
mnemonic
|
string; or None;
デフォルト = Noneアクションの 1 語の説明（CppCompile や GoLink など）。 |
command
|
string; or sequence of strings;
必須実行するシェルコマンド。これは、文字列（推奨）または文字列のシーケンス（非推奨）です。
（非推奨） 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;
default = Noneこのアクションで使用される実行可能ファイルまたはツールのツールチェーン タイプ。アクションが正しい実行プラットフォームで実行されるように、パラメータを設定する必要があります。 現在は 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; or None;
デフォルト = None出力シンボリック リンクが参照するファイル。 |
target_path
|
string; or None;
デフォルト = None（試験運用版）出力シンボリック リンクが参照する正確なパス。正規化などの処理は適用されません。この機能にアクセスするには、 --experimental_allow_unresolved_symlinks を設定する必要があります。
|
is_executable
|
デフォルト = Falsetarget_path ではなく target_file でのみ使用できます。true の場合、アクションの実行時に target_file のパスを確認して実行可能かどうかを判断し、実行可能でない場合エラーを報告します。is_executable を False に設定しても、ターゲットが実行可能にならないわけではありません。検証が行われないだけです。ビルド時にダングル シンボリック リンクが存在しない可能性があるため、この機能は |
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 出力ファイルを実行可能にするかどうか。 |