Args

Laporkan masalah Lihat sumber Nightly

Objek yang mengenkapsulasi, dengan cara yang hemat memori, data yang diperlukan untuk membuat sebagian atau seluruh command line.

Sering kali tindakan memerlukan command line besar yang berisi nilai yang diakumulasi dari dependensi transitif. Misalnya, command line penaut mungkin mencantumkan setiap file objek yang dibutuhkan oleh semua library yang ditautkan. Praktik terbaiknya adalah menyimpan data transitif tersebut di depset, sehingga dapat digunakan bersama oleh beberapa target. Namun, jika penulis aturan harus mengonversi depset ini menjadi daftar string untuk membuat command line tindakan, proses pengoptimalan berbagi memori ini akan kalah.

Oleh karena itu, fungsi konstruksi tindakan menerima objek Args selain string. Setiap objek Args mewakili penyambungan string dan depset, dengan transformasi opsional untuk memanipulasi data. Objek Args tidak memproses depset yang dienkapsulasi hingga fase eksekusi, ketika sudah waktunya untuk menghitung command line. Hal ini membantu menunda penyalinan yang mahal hingga fase analisis selesai. Lihat halaman Mengoptimalkan Performa untuk informasi selengkapnya.

Args dibuat dengan memanggil ctx.actions.args(). Parameter tersebut dapat diteruskan sebagai parameter arguments dari ctx.actions.run() atau ctx.actions.run_shell(). Setiap mutasi objek Args menambahkan nilai ke command line akhir.

Fitur map_each memungkinkan Anda menyesuaikan cara item diubah menjadi string. Jika Anda tidak memberikan fungsi map_each, konversi standarnya adalah sebagai berikut:

  • Nilai yang sudah menjadi string akan dibiarkan apa adanya.
  • Objek File diubah menjadi nilai File.path.
  • Objek Label diubah menjadi representasi string yang di-resolve kembali ke objek yang sama saat di-resolve dalam konteks repositori utama. Jika memungkinkan, representasi string menggunakan nama jelas repositori dan mendukung nama kanonis repositori, yang membuat representasi ini cocok untuk digunakan dalam file BUILD. Meskipun bentuk representasi yang tepat tidak dijamin, contoh umumnya adalah //foo:bar, @repo//foo:bar, dan @@canonical_name~//foo:bar.bzl.
  • Semua jenis lainnya diubah menjadi string dengan cara yang tidak ditentukan. Oleh karena itu, Anda harus menghindari penerusan nilai yang bukan dari string atau jenis File ke add(), dan jika Anda meneruskannya ke add_all() atau add_joined(), Anda harus menyediakan fungsi map_each.

Saat menggunakan pemformatan string (parameter format, format_each, dan format_joined dari metode add*()), template format ditafsirkan dengan cara yang sama seperti substitusi % pada string, kecuali bahwa template harus memiliki tepat satu placeholder substitusi dan harus %s. Persentase literal dapat di-escape sebagai %%. Pemformatan diterapkan setelah nilai dikonversi menjadi string sesuai yang di atas.

Setiap metode add*() memiliki bentuk alternatif yang menerima parameter posisi tambahan, yaitu string "arg name" yang akan disisipkan sebelum argumen lainnya. Untuk add_all dan add_joined, string tambahan tidak akan ditambahkan jika urutan tersebut ternyata kosong. Misalnya, penggunaan yang sama dapat menambahkan --foo val1 val2 val3 --bar atau hanya --bar ke command line, bergantung pada apakah urutan yang diberikan berisi val1..val3 atau kosong.

Jika ukuran command line bisa bertambah lebih panjang dari ukuran maksimum yang diizinkan oleh sistem, argumen dapat tumpang-tindih ke dalam file parameter. Lihat use_param_file() dan set_param_file_format().

Contoh: Misalkan kita ingin membuat command line: 

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz
Kita dapat menggunakan objek Args berikut: 
# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

Anggota

add

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

Menambahkan argumen ke command line ini.

Parameter

Parameter Deskripsi
arg_name_or_value wajib diisi
Jika dua parameter posisi diteruskan, parameter ini akan ditafsirkan sebagai nama arg. Nama arg ditambahkan sebelum nilai tanpa pemrosesan apa pun. Jika hanya satu parameter posisi yang diteruskan, parameter tersebut akan ditafsirkan sebagai value (lihat di bawah).
value defaultnya adalah unbound
Objek yang akan ditambahkan. Hal tersebut akan dikonversi menjadi string menggunakan konversi standar yang disebutkan di atas. Karena tidak ada parameter map_each untuk fungsi ini, value harus berupa string atau File. Daftar, tuple, depset, atau direktori File harus diteruskan ke add_all() atau add_joined(), bukan metode ini.
format string; atau None; default-nya adalah None
Pola string format, yang akan diterapkan ke versi string value.

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

Menambahkan beberapa argumen ke command line ini. Item tersebut diproses dengan lambat selama fase eksekusi.

Sebagian besar pemrosesan terjadi pada daftar argumen yang akan ditambahkan, sesuai dengan langkah-langkah berikut:

  1. Setiap item File direktori diganti dengan semua File yang terdapat secara rekursif dalam direktori tersebut.
  2. Jika map_each diberikan, kode tersebut akan diterapkan ke setiap item, dan daftar string yang dihasilkan akan digabungkan untuk membentuk daftar argumen awal. Jika tidak, daftar argumen awal adalah hasil penerapan konversi standar ke setiap item.
  3. Setiap argumen dalam daftar diformat dengan format_each, jika ada.
  4. Jika uniquify bernilai benar (true), argumen duplikat akan dihapus. Kejadian pertama adalah yang tetap ada.
  5. Jika string before_each diberikan, string tersebut akan disisipkan sebagai argumen baru sebelum setiap argumen yang ada dalam daftar. Hal ini secara efektif menggandakan jumlah argumen yang akan ditambahkan oleh titik ini.
  6. Kecuali jika daftar kosong dan omit_if_empty bernilai benar (default), nama argumen dan terminate_with masing-masing akan disisipkan sebagai argumen pertama dan terakhir, jika diberikan.
Perhatikan bahwa string kosong adalah argumen valid yang tunduk pada semua langkah pemrosesan ini.

Parameter

Parameter Deskripsi
arg_name_or_values wajib diisi
Jika dua parameter posisi diteruskan, parameter ini akan ditafsirkan sebagai nama arg. Nama arg ditambahkan sebelum values sebagai argumen terpisah tanpa pemrosesan apa pun. Nama argumen ini tidak akan ditambahkan jika omit_if_empty bernilai benar (true) (default) dan tidak ada item lain yang ditambahkan (seperti yang terjadi jika values kosong atau semua itemnya difilter). Jika hanya satu parameter posisi yang diteruskan, parameter tersebut akan ditafsirkan sebagai values (lihat di bawah).
values sequence; atau depset; default-nya adalah unbound
Daftar, tuple, atau depset yang itemnya akan ditambahkan.
map_each callable; atau None; defaultnya adalah None
Fungsi yang mengonversi setiap item menjadi nol atau beberapa string, yang dapat diproses lebih lanjut sebelum ditambahkan. Jika parameter ini tidak disediakan, konversi standar akan digunakan.

Fungsi meneruskan satu atau dua argumen posisi: item yang akan dikonversi, diikuti dengan DirectoryExpander opsional. Argumen kedua akan diteruskan hanya jika fungsi yang disediakan ditentukan oleh pengguna (bukan bawaan) dan mendeklarasikan lebih dari satu parameter.

Jenis nilai yang ditampilkan bergantung pada jumlah argumen yang akan dibuat untuk item:

  • Dalam kasus umum saat setiap item berubah menjadi satu string, fungsi harus menampilkan string tersebut.
  • Jika item akan difilter sepenuhnya, fungsi akan menampilkan None.
  • Jika item berubah menjadi beberapa string, fungsi akan menampilkan daftar string tersebut.
Menampilkan string tunggal atau None memiliki efek yang sama dengan menampilkan daftar dengan panjang 1 atau panjang 0. Namun, cara ini lebih efisien dan mudah dibaca untuk menghindari pembuatan daftar jika tidak diperlukan.

Biasanya, item yang merupakan direktori secara otomatis diperluas ke kontennya saat expand_directories=True disetel. Namun, ini tidak akan memperluas direktori yang ada di dalam nilai lain -- misalnya, bila item adalah struct yang memiliki direktori sebagai kolom. Dalam situasi ini, argumen DirectoryExpander dapat diterapkan untuk mendapatkan file dari direktori tertentu secara manual.

Untuk menghindari retensi yang tidak diinginkan dari struktur data fase analisis besar ke dalam fase eksekusi, fungsi map_each harus dideklarasikan oleh pernyataan def level teratas; fungsi ini mungkin bukan merupakan penutupan fungsi bertingkat secara default.

Peringatan: Pernyataan print() yang dijalankan selama panggilan ke map_each tidak akan menghasilkan output yang terlihat.

format_each string; atau None; default-nya adalah None
Pola string format opsional, yang diterapkan ke setiap string yang ditampilkan oleh fungsi map_each. String format harus memiliki satu placeholder '%s'.
before_each string; atau None; defaultnya adalah None
Argumen opsional yang akan ditambahkan sebelum setiap argumen yang berasal dari values ditambahkan.
omit_if_empty bool; defaultnya adalah True
Jika tidak ada argumen yang berasal dari values yang akan ditambahkan, semua pemrosesan lebih lanjut akan disembunyikan dan command line tidak akan berubah. Jika salah (false), nama argumen dan terminate_with, jika disediakan, akan tetap ditambahkan, terlepas dari apakah ada argumen lain atau tidak.
uniquify bool; defaultnya adalah False
Jika benar, argumen duplikat yang berasal dari values akan dihilangkan. Hanya kemunculan pertama dari setiap argumen yang akan tetap ada. Biasanya fitur ini tidak diperlukan karena depset sudah menghilangkan duplikat, tetapi dapat berguna jika map_each memunculkan string yang sama untuk beberapa item.
expand_directories bool; defaultnya adalah True
Jika true (benar), direktori apa pun di values akan diperluas ke daftar file datar. Hal ini terjadi sebelum map_each diterapkan.
terminate_with string; atau None; default-nya adalah None
Argumen opsional yang akan ditambahkan setelah semua argumen lainnya. Argumen ini tidak akan ditambahkan jika omit_if_empty bernilai benar (default) dan tidak ada item lain yang ditambahkan (seperti yang terjadi jika values kosong atau semua itemnya difilter).
allow_closure bool; defaultnya adalah False
Jika true (benar), memungkinkan penggunaan penutupan dalam parameter fungsi seperti map_each. Biasanya hal ini tidak diperlukan dan berisiko mempertahankan struktur data fase analisis yang besar ke dalam fase eksekusi.

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

Menambahkan argumen ke command line ini dengan menggabungkan beberapa nilai menggunakan pemisah. Item tersebut diproses dengan lambat selama fase eksekusi.

Pemrosesannya mirip dengan add_all(), tetapi daftar argumen yang berasal dari values digabungkan menjadi satu argumen seolah-olah oleh join_with.join(...), lalu diformat menggunakan template string format_joined yang diberikan. Tidak seperti add_all(), tidak ada parameter before_each atau terminate_with karena parameter ini umumnya tidak berguna saat item digabungkan menjadi satu argumen.

Jika setelah memfilter tidak ada string yang akan digabungkan menjadi argumen, dan jika omit_if_empty bernilai benar (default), tidak ada pemrosesan yang dilakukan. Sebaliknya jika tidak ada string yang akan digabungkan, tetapi omit_if_empty bernilai salah (false), string gabungan akan berupa string kosong.

Parameter

Parameter Deskripsi
arg_name_or_values wajib diisi
Jika dua parameter posisi diteruskan, parameter ini akan ditafsirkan sebagai nama arg. Nama arg ditambahkan sebelum values tanpa pemrosesan apa pun. argumen ini tidak akan ditambahkan jika omit_if_empty benar (default) dan tidak ada string yang berasal dari values untuk digabungkan (yang dapat terjadi jika values kosong atau semua itemnya difilter). Jika hanya satu parameter posisi yang diteruskan, parameter tersebut akan ditafsirkan sebagai values (lihat di bawah).
values sequence; atau depset; default-nya adalah unbound
Daftar, tuple, atau depset yang itemnya akan digabungkan.
join_with string; wajib
String pembatas yang digunakan untuk menggabungkan string yang diperoleh dari penerapan map_each dan format_each, dengan cara yang sama seperti string.join().
map_each callable; atau None; default-nya adalah None
Sama seperti add_all.
format_each string; atau None; default-nya adalah None
Sama seperti add_all.
format_joined string; atau None; default-nya adalah None
Pola string format opsional yang diterapkan ke string gabungan. String format harus memiliki satu placeholder '%s'.
omit_if_empty bool; defaultnya adalah True
Jika tidak ada string untuk digabungkan (baik karena values kosong atau semua itemnya difilter), semua pemrosesan lebih lanjut akan disembunyikan dan command line tidak akan berubah. Jika false, meskipun tidak ada string yang akan digabungkan, dua argumen akan ditambahkan: nama arg diikuti dengan string kosong (yang merupakan gabungan logis dari string nol).
uniquify bool; defaultnya adalah False
Sama seperti add_all.
expand_directories bool; defaultnya adalah True
Sama seperti add_all.
allow_closure bool; defaultnya adalah False
Sama seperti add_all.

set_param_file_format

Args Args.set_param_file_format(format)

Menetapkan format file parameter, jika salah satunya digunakan

Parameter

Parameter Deskripsi
format string; wajib
Harus berupa salah satu dari:
  • "multiline": Setiap item (nama atau nilai argumen) ditulis kata demi kata ke file param dengan karakter baris baru yang mengikutinya.
  • "shell": Sama seperti "multiline", tetapi itemnya diberi tanda kutip shell
  • "flag_per_line": Sama seperti "multiline", tetapi (1) hanya flag (dimulai dengan '--') yang ditulis ke file param, dan (2) nilai flag, jika ada, ditulis pada baris yang sama dengan pemisah '='. Format ini diharapkan oleh library tanda Abseil.

Jika tidak dipanggil, format default-nya adalah "shell".

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

Menumpahkan argumen ke file params, menggantinya dengan pointer ke file param. Gunakan saat argumen Anda mungkin terlalu besar untuk batas panjang perintah sistem.

Bazel dapat memilih untuk menghapus file parameter ke hierarki output selama eksekusi agar efisien. Jika Anda men-debug tindakan dan ingin memeriksa file parameter, teruskan --materialize_param_files ke build Anda.

Parameter

Parameter Deskripsi
param_file_arg string; wajib
String format dengan satu "%s". Jika argumen ditambahkan ke file params, argumen tersebut akan diganti dengan argumen yang terdiri dari string ini yang diformat dengan jalur file params.

Misalnya, jika argumen ditambahkan ke file params "params.txt", maka menentukan "--file=%s" akan menyebabkan baris perintah tindakan berisi "--file=params.txt".

use_always bool; defaultnya adalah False
Apakah akan selalu menumpahkan argumen ke file params. Jika false, bazel akan memutuskan apakah argumen perlu ditumpangkan berdasarkan sistem dan panjang arg Anda.