template_ctx

アクション テンプレート拡張関数に渡されるコンテキスト オブジェクト。

メンバー

• args
• declare_file
• run

args

Args template_ctx.args()

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

declare_file

File template_ctx.declare_file(filename, *, directory)

実装により、指定したディレクトリ内に指定したファイル名のファイルが作成されることを宣言します。

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

パラメータ

パラメータ	説明
filename	文字列; 必須 ディレクトリ内のファイルの相対パス。
directory	ファイル。 必須 ファイルを作成するディレクトリ。

run

None template_ctx.run(*, outputs, inputs=[], executable, tools=None, arguments=[], progress_message=None)

実行可能ファイルを実行するアクションを作成します。

パラメータ

パラメータ	説明
outputs	ファイルのシーケンス。 必須 アクションの出力ファイルのリスト。
inputs	sequence of Files、または depset。デフォルトは [] 。アクションの入力ファイルのリストまたは depset。
executable	ファイル、または文字列、またはFilesToRunProvider。 必須 アクションによって呼び出される実行可能ファイル。
tools	シーケンス、または depset、または None。 デフォルトは None アクションに必要なツールのリストまたは depset。ツールは、アクションで自動的に使用可能になる独自の runfiles を持つ実行可能入力です。 リストが指定されている場合、次の要素の異種コレクションにできます。 File FilesToRunProvider インスタンス File の depset File と、リストに直接含まれる FilesToRunProvider の runfiles が自動的に追加されます。ctx.executableすべてのツールは暗黙的に入力として追加されます。
arguments	[sequence]; デフォルトは [] アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。
progress_message	文字列または None。 デフォルトは None 。 ビルド中にユーザーに表示する進行状況メッセージ。