Metode yang tersedia dalam file BUILD. Lihat juga Ensiklopedia Build untuk mengetahui fungsi dan aturan build tambahan, yang juga dapat digunakan dalam file BUILD.
Anggota
- depset
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repository_name
- select
- subpaket
depset
depset depset(direct=None, order="default", *, transitive=None)
direct adalah daftar elemen langsung depset, dan parameter transitive adalah daftar depset yang elemennya menjadi elemen tidak langsung depset yang dibuat. Urutan elemen yang ditampilkan saat depset dikonversi menjadi daftar ditentukan oleh parameter order. Lihat Ringkasan depset untuk mengetahui informasi selengkapnya.
Semua elemen (langsung dan tidak langsung) depset harus memiliki jenis yang sama, seperti yang diperoleh oleh ekspresi type(x).
Karena set berbasis hash digunakan untuk menghilangkan duplikat selama iterasi, semua elemen depset harus dapat di-hash. Namun, invarian ini saat ini tidak diperiksa secara konsisten di semua konstruktor. Gunakan flag --incompatible_always_check_depset_elements untuk mengaktifkan pemeriksaan yang konsisten; ini akan menjadi perilaku default dalam rilis mendatang; lihat Masalah 10313.
Selain itu, elemen saat ini tidak boleh diubah, meskipun pembatasan ini akan dilonggarkan pada masa mendatang.
Urutan depset yang dibuat harus kompatibel dengan urutan depset transitive-nya. Urutan "default" kompatibel dengan urutan lainnya, semua urutan lainnya hanya kompatibel dengan dirinya sendiri.
Parameter
| Parameter | Deskripsi |
|---|---|
direct
|
sequence; atau None;
defaultnya adalah NoneDaftar elemen direct dari depset. |
order
|
default adalah "default"Strategi traversal untuk depset baru. Lihat di sini untuk mengetahui kemungkinan nilai. |
transitive
|
urutan depset; atau None;
default adalah NoneDaftar depset yang elemennya akan menjadi elemen tidak langsung depset. |
existing_rule
unknown existing_rule(name)
None jika tidak ada instance aturan dengan nama tersebut.Di sini, objek seperti dict yang tidak dapat diubah berarti objek x yang tidak dapat diubah secara mendalam yang mendukung iterasi seperti dict, len(x), name in x, x[name], x.get(name), x.items(), x.keys(), dan x.values().
Jika tanda --noincompatible_existing_rules_immutable_view ditetapkan, dict baru yang dapat diubah dengan konten yang sama akan ditampilkan.
Hasilnya berisi entri untuk setiap atribut, dengan pengecualian atribut pribadi (yang namanya tidak diawali dengan huruf) dan beberapa jenis atribut lama yang tidak dapat direpresentasikan. Selain itu, kamus berisi entri untuk name dan kind instance aturan (misalnya, 'cc_binary').
Nilai hasil mewakili nilai atribut sebagai berikut:
- Atribut jenis str, int, dan bool direpresentasikan apa adanya.
- Label dikonversi menjadi string dalam bentuk
':foo'untuk target dalam paket yang sama atau'//pkg:name'untuk target dalam paket yang berbeda. - Daftar direpresentasikan sebagai tuple, dan kamus dikonversi menjadi kamus baru yang dapat diubah. Elemennya dikonversi secara rekursif dengan cara yang sama.
- Nilai
selectditampilkan dengan kontennya yang diubah seperti yang dijelaskan di atas. - Atribut yang tidak memiliki nilai yang ditentukan selama pembuatan instance aturan dan nilai defaultnya dihitung akan dikecualikan dari hasil. (Default yang dihitung tidak dapat dihitung hingga fase analisis.).
Jika memungkinkan, hindari penggunaan fungsi ini. Hal ini membuat file BUILD menjadi rapuh dan bergantung pada urutan. Selain itu, perhatikan bahwa konversi ini sedikit berbeda dari dua konversi nilai atribut aturan lainnya dari bentuk internal ke Starlark: satu digunakan oleh default yang dihitung, yang lainnya digunakan oleh ctx.attr.foo.
Parameter
| Parameter | Deskripsi |
|---|---|
name
|
required Nama target. |
existing_rules
unknown existing_rules()
existing_rule(name).Di sini, objek seperti dict yang tidak dapat diubah berarti objek x yang tidak dapat diubah secara mendalam yang mendukung iterasi seperti dict, len(x), name in x, x[name], x.get(name), x.items(), x.keys(), dan x.values().
Jika tanda --noincompatible_existing_rules_immutable_view ditetapkan, dict baru yang dapat diubah dengan konten yang sama akan ditampilkan.
Catatan: Jika memungkinkan, hindari penggunaan fungsi ini. Hal ini membuat file BUILD menjadi rapuh dan bergantung pada urutan. Selain itu, jika tanda --noincompatible_existing_rules_immutable_view ditetapkan, fungsi ini mungkin sangat mahal, terutama jika dipanggil dalam loop.
exports_files
None exports_files(srcs, visibility=None, licenses=None)Parameter
| Parameter | Deskripsi |
|---|---|
srcs
|
urutan string;
wajib Daftar file yang akan diekspor. |
visibility
|
sequence; atau None;
defaultnya adalah NonePernyataan visibilitas dapat ditentukan. File akan terlihat oleh target yang ditentukan. Jika tidak ada visibilitas yang ditentukan, file akan terlihat oleh setiap paket. |
licenses
|
urutan string; atau None;
defaultnya adalah NoneLisensi yang akan ditentukan. |
glob
sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- Cocok dengan setidaknya satu pola di
include. - Tidak cocok dengan pola apa pun di
exclude([]default).
exclude_directories diaktifkan (ditetapkan ke 1), file jenis direktori akan dihilangkan dari hasil (1 default).
Parameter
| Parameter | Deskripsi |
|---|---|
include
|
urutan string;
default-nya adalah []Daftar pola glob yang akan disertakan. |
exclude
|
urutan string;
default adalah []Daftar pola glob yang akan dikecualikan. |
exclude_directories
|
default adalah 1Flag untuk mengecualikan direktori atau tidak. |
allow_empty
|
default adalah unboundApakah kita mengizinkan pola glob untuk tidak cocok dengan apa pun. Jika `allow_empty` bernilai Salah, setiap pola penyertaan harus cocok dengan sesuatu dan hasil akhir juga tidak boleh kosong (setelah kecocokan pola `exclude` dikecualikan). |
module_name
string module_name()
module.name yang terlihat di module_ctx.modules.
Dapat menampilkan None.
module_version
string module_version()
module.version yang terlihat di module_ctx.modules.
Dapat menampilkan None.
package_group
None package_group(name, packages=[], includes=[])visibility.
Parameter
| Parameter | Deskripsi |
|---|---|
name
|
required Nama unik untuk aturan ini. |
packages
|
urutan string;
default adalah []Enumerasi lengkap paket dalam grup ini. |
includes
|
urutan string;
default adalah []Grup paket lain yang disertakan dalam grup ini. |
package_name
string package_name()
some/package/BUILD, nilainya akan menjadi some/package. Jika file BUILD memanggil fungsi yang ditentukan dalam file .bzl, package_name() akan cocok dengan paket file BUILD pemanggil. Fungsi ini setara dengan variabel PACKAGE_NAME yang tidak digunakan lagi.
package_relative_label
Label package_relative_label(input)
BUILD yang makro saat ini dijalankan). Jika input sudah berupa Label, input tersebut akan ditampilkan tanpa perubahan.Fungsi ini hanya dapat dipanggil saat mengevaluasi file BUILD dan makro yang dipanggil secara langsung atau tidak langsung; fungsi ini tidak boleh dipanggil dalam (misalnya) fungsi penerapan aturan.
Hasil fungsi ini adalah nilai Label yang sama seperti yang akan dihasilkan dengan meneruskan string yang diberikan ke atribut bernilai label dari target yang dideklarasikan dalam file BUILD.
Catatan penggunaan: Perbedaan antara fungsi ini dan Label() adalah Label() menggunakan konteks paket file .bzl yang memanggilnya, bukan paket file BUILD. Gunakan Label() saat Anda perlu merujuk ke target tetap yang di-hardcode ke dalam makro, seperti compiler. Gunakan package_relative_label() saat Anda perlu menormalisasi string label yang disediakan oleh file BUILD ke objek Label. (Tidak ada cara untuk mengonversi string menjadi Label dalam konteks paket selain file BUILD atau file .bzl panggilan. Oleh karena itu, makro luar harus selalu lebih memilih untuk meneruskan objek Label ke makro dalam, bukan string label.)
Parameter
| Parameter | Deskripsi |
|---|---|
input
|
string; atau Label;
wajib String label input atau objek Label. Jika diteruskan, objek Label akan ditampilkan apa adanya. |
repository_name
string repository_name()
local_repository(name='local', path=...) akan disetel ke @local. Dalam paket di repositori utama, nilai ini akan ditetapkan ke @. Fungsi ini setara dengan variabel REPOSITORY_NAME yang tidak digunakan lagi.
pilih
unknown select(x, no_match_error='')
select() adalah fungsi bantuan yang membuat atribut aturan dapat dikonfigurasi. Lihat ensiklopedi build untuk mengetahui detailnya.
Parameter
| Parameter | Deskripsi |
|---|---|
x
|
required Dict yang memetakan kondisi konfigurasi ke nilai. Setiap kunci adalah Label atau string label yang mengidentifikasi instance config_setting atau constraint_value. Lihat dokumentasi tentang makro untuk mengetahui kapan harus menggunakan Label, bukan string. |
no_match_error
|
default adalah ''Error kustom opsional untuk dilaporkan jika tidak ada kondisi yang cocok. |
sub-paket
sequence subpackages(include, exclude=[], allow_empty=False)
Parameter
| Parameter | Deskripsi |
|---|---|
include
|
urutan string;
wajib Daftar pola glob yang akan disertakan dalam pemindaian subpaket. |
exclude
|
urutan string;
default adalah []Daftar pola glob yang akan dikecualikan dari pemindaian subpaket. |
allow_empty
|
defaultnya adalah FalseApakah kita gagal jika panggilan menampilkan daftar kosong. Secara default, daftar kosong menunjukkan potensi error dalam file BUILD saat panggilan ke subpackages() tidak diperlukan. Menetapkan ke true memungkinkan fungsi ini berhasil dalam kasus tersebut. |