template_ctx

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6
Objek konteks yang diteruskan ke fungsi perluasan 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 tertentu dalam direktori yang ditentukan.

Ingat bahwa selain mendeklarasikan file, Anda harus membuat tindakan yang memancarkan file secara terpisah. Membuat tindakan tersebut akan memerlukan penerusan objek File yang ditampilkan ke fungsi pembuatan tindakan.

Parameter

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

lari

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 sequence dari File; required
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 yang akan dipanggil oleh tindakan.
tools sequence; atau depset; atau None; default adalah None
Daftar atau depset alat yang diperlukan oleh tindakan. Alat adalah input yang dapat dieksekusi yang mungkin memiliki file run sendiri yang otomatis tersedia untuk tindakan.

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

  • File dtk
  • FilesToRunProvider instance
  • depset detik File
Files dari ctx.executable dan FilesToRunProviders yang langsung ada dalam daftar akan ditambahkan runfilenya secara otomatis. Semua alat ditambahkan secara implisit sebagai input.

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