Args

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

Sering terjadi bahwa suatu tindakan memerlukan command line besar yang berisi nilai yang diakumulasi dari dependensi transitif. Misalnya, command line penaut dapat mencantumkan setiap file objek yang diperlukan oleh semua library yang ditautkan. Praktik terbaiknya adalah menyimpan data transitif tersebut di depset, sehingga dapat dibagikan oleh beberapa target. Namun, jika penulis aturan harus mengonversi depset ini menjadi daftar string untuk membuat command line tindakan, hal ini akan mengalahkan pengoptimalan berbagi memori ini.

Karena alasan ini, 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. Tindakan ini membantu menunda penyalinan yang mahal hingga setelah fase analisis selesai. Lihat halaman Mengoptimalkan Performa untuk mengetahui informasi selengkapnya.

Args dibuat dengan memanggil ctx.actions.args(). Parameter ini 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 berupa string akan dibiarkan apa adanya.
• Objek File diubah menjadi nilai File.path.
• Semua jenis lainnya akan diubah menjadi string dengan cara yang tidak ditentukan. Karena itu, Anda harus menghindari penerusan nilai yang bukan dari jenis string atau 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. Persen literal dapat di-escape sebagai %%. Format diterapkan setelah nilai dikonversi menjadi string seperti di atas.

Setiap metode add*() memiliki bentuk alternatif yang menerima parameter posisional tambahan, string "arg name" yang akan disisipkan sebelum argumen lainnya. Untuk add_all dan add_joined, string tambahan tidak akan ditambahkan jika urutan 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 dapat bertambah lebih panjang dari ukuran maksimum yang diizinkan oleh sistem, argumen dapat dialihkan ke file parameter. Lihat use_param_file() dan set_param_file_format().

Contoh: Misalnya, kita ingin membuat command line:

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz

# 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

• tambahkan
• add_all
• add_joined
• set_param_file_format
• use_param_file

tambahkan

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

Parameter

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)

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

1. Setiap item File direktori diganti oleh semua File yang secara rekursif terdapat dalam direktori tersebut.
2. Jika diberikan, map_each 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 benar, 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 pada titik ini.
6. Kecuali jika daftar kosong dan omit_if_empty bernilai benar (default), nama arg dan terminate_with akan disisipkan sebagai argumen pertama dan terakhir, jika diberikan.

Parameter

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)

Pemrosesan 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 pemfilteran tidak ada string yang akan digabungkan ke dalam 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, string gabungan akan berupa string kosong.

Parameter

set_param_file_format

Args Args.set_param_file_format(format)

Parameter

use_param_file

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

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