template_ctx

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

メンバー

args

Args template_ctx.args()

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

declare_file

File template_ctx.declare_file(filename, *, directory)

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

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

パラメータ

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

run

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

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

パラメータ

パラメータ 説明
outputs Filesequence。必須
アクションの出力ファイルのリスト。
inputs Filesequence、または depset。デフォルトは []
です。 アクションの入力ファイルのリストまたは depset。
executable Filestring、または FilesToRunProvider。必須。
アクションによって呼び出される実行可能ファイル。
tools sequencedepset、または None。デフォルトは None
です。 アクションに必要なツールのリストまたは depset。ツールは実行可能な入力であり、アクションで自動的に使用可能になる独自のランファイルを持つ場合があります。

リストが指定されている場合、次の要素の異種コレクションにすることができます。

  • File
  • FilesToRunProvider 個のインスタンス
  • depset 秒の File
ctx.executableFile と、リストに直接含まれる FilesToRunProvider の実行ファイルは自動的に追加されます。すべてのツールが入力として暗黙的に追加されます。

arguments sequence; デフォルトは []
アクションのコマンドライン引数。文字列または actions.args() オブジェクトのリストにする必要があります。
progress_message 文字列、または None。デフォルトは None
です。 ビルド中にユーザーに表示する進行状況メッセージ。