template_ctx

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1
Objek konteks yang diteruskan ke fungsi ekspansi template tindakan.

Anggota

args

Args template_ctx.args()

Menampilkan objek Args yang dapat digunakan untuk membuat command line yang hemat memori.

declare_file

File template_ctx.declare_file(filename, *, directory)

Mendeklarasikan bahwa implementasi membuat file dengan nama file yang diberikan dalam direktori yang ditentukan.

Perlu diingat bahwa selain mendeklarasikan file, Anda harus membuat tindakan yang memancarkan file secara terpisah. Untuk membuat tindakan tersebut, Anda harus meneruskan objek File yang ditampilkan ke fungsi konstruksi tindakan.

Parameter

Parameter Deskripsi
filename string; wajib
Jalur relatif file dalam direktori.
directory File; wajib
Direktori tempat file harus dibuat.

declare_subdirectory

File template_ctx.declare_subdirectory(subdirectory, *, directory)

Mendeklarasikan bahwa implementasi membuat subdirektori dengan nama yang diberikan dalam direktori yang ditentukan.

Perlu diingat bahwa selain mendeklarasikan subdirektori, Anda harus membuat tindakan yang memancarkan subdirektori secara terpisah. Untuk membuat tindakan tersebut, Anda harus meneruskan objek File yang ditampilkan ke fungsi konstruksi tindakan.

Parameter

Parameter Deskripsi
subdirectory string; wajib
Jalur relatif subdirektori dalam direktori.
directory File; wajib
Direktori tempat subdirektori harus dibuat.

run

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

Membuat tindakan yang menjalankan file yang dapat dieksekusi.

Parameter

Parameter Deskripsi
outputs urutan File; wajib
Daftar file output tindakan.
inputs urutan File; atau depset; default adalah []
Daftar atau depset file input tindakan.
executable File; atau string; atau FilesToRunProvider; wajib
File yang dapat dieksekusi untuk dipanggil oleh tindakan.
tools urutan; atau depset; atau None; default adalah None
Daftar atau depset alat apa pun yang diperlukan oleh tindakan. Alat adalah input yang dapat dieksekusi yang mungkin memiliki runfile sendiri yang otomatis tersedia untuk tindakan.

Jika daftar disediakan, daftar tersebut dapat berupa kumpulan heterogen dari:

  • File
  • instance FilesToRunProvider
  • depset dari File
File dari ctx.executable dan FilesToRunProvider yang langsung ada dalam daftar akan otomatis ditambahkan runfile-nya. Semua alat secara implisit ditambahkan sebagai input.

arguments urutan; default adalah []
Argumen command line tindakan. Harus berupa daftar string atau actions.args() objek.
progress_message string; atau None; default adalah None
Pesan progres yang akan ditampilkan kepada pengguna selama build.