Metode global yang tersedia di semua file .bzl.
Anggota
- analysis_test_transition
- aspek
- configuration_field
- depset
- exec_group
- module_extension
- penyedia
- repository_rule
- aturan
- select
- subrule
- tag_class
- visibilitas
analysis_test_transition
transition analysis_test_transition(settings)
Membuat transisi konfigurasi yang akan diterapkan pada dependensi aturan pengujian analisis. Transisi ini hanya dapat diterapkan pada atribut aturan dengan analysis_test = True
. Kemampuan aturan tersebut dibatasi (misalnya, ukuran hierarki dependensinya terbatas), sehingga transisi yang dibuat menggunakan fungsi ini memiliki cakupan potensial yang terbatas dibandingkan dengan transisi yang dibuat menggunakan transition()
.
Fungsi ini terutama dirancang untuk memfasilitasi library inti Analysis Test Framework. Lihat dokumentasi (atau penerapannya) untuk mengetahui praktik terbaik.
Parameter
Parameter | Deskripsi |
---|---|
settings
|
required Kamus yang berisi informasi tentang setelan konfigurasi yang harus ditetapkan oleh transisi konfigurasi ini. Kunci adalah label setelan build, dan nilai adalah nilai pasca-transisi baru. Semua setelan lainnya tidak berubah. Gunakan ini untuk mendeklarasikan setelan konfigurasi tertentu yang diperlukan untuk menetapkan pengujian analisis agar lulus. |
aspek
Aspect aspect(implementation, attr_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])Membuat aspek baru. Hasil fungsi ini harus disimpan dalam nilai global. Lihat pengantar Aspek untuk detail selengkapnya.
Parameter
Parameter | Deskripsi |
---|---|
implementation
|
wajib Fungsi Starlark yang menerapkan aspek ini, dengan dua parameter: Target (target tempat aspek diterapkan) dan ctx (konteks aturan tempat target dibuat). Atribut target tersedia melalui kolom ctx.rule . Fungsi ini dievaluasi selama fase analisis untuk setiap penerapan aspek pada target.
|
attr_aspects
|
Urutan string;
default-nya adalah [] Daftar nama atribut. Aspek ini diperluas bersama dependensi yang ditentukan dalam atribut target dengan nama ini. Nilai umum di sini mencakup deps dan exports . Daftar ini juga dapat berisi satu string "*" untuk diterapkan di sepanjang semua dependensi target.
|
attrs
|
dict;
default adalah {} Kamus yang mendeklarasikan semua atribut aspek. Fungsi ini memetakan dari nama atribut ke objek atribut, seperti `attr.label` atau `attr.string` (lihat modul attr). Atribut aspek tersedia untuk fungsi penerapan sebagai kolom parameter ctx . Atribut implisit yang dimulai dengan Atribut eksplisit harus memiliki jenis |
required_providers
|
default adalah [] Atribut ini memungkinkan aspek membatasi penyebarannya hanya ke target yang aturannya mengiklankan penyedia yang diperlukan. Nilai harus berupa daftar yang berisi setiap penyedia atau daftar penyedia, tetapi tidak keduanya. Misalnya, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] adalah nilai yang valid, sedangkan [FooInfo, BarInfo, [BazInfo, QuxInfo]] tidak valid.Daftar penyedia yang tidak bertingkat akan otomatis dikonversi ke daftar yang berisi satu daftar penyedia. Artinya, Agar beberapa target aturan (misalnya, |
required_aspect_providers
|
default adalah [] Atribut ini memungkinkan aspek ini memeriksa aspek lain. Nilainya harus berupa daftar yang berisi penyedia individual atau daftar penyedia, tetapi tidak keduanya. Misalnya, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] adalah nilai yang valid, sedangkan [FooInfo, BarInfo, [BazInfo, QuxInfo]] tidak valid.Daftar penyedia yang tidak bertingkat akan otomatis dikonversi menjadi daftar yang berisi satu daftar penyedia. Artinya, Untuk membuat aspek lain (misalnya, |
provides
|
default adalah [] Daftar penyedia yang harus ditampilkan oleh fungsi implementasi. Muncul error jika fungsi implementasi menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkannya. Namun, fungsi implementasi mungkin menampilkan penyedia tambahan yang tidak tercantum di sini. Setiap elemen daftar adalah objek |
requires
|
Urutan Aspek;
defaultnya adalah [] Daftar aspek yang harus disebarkan sebelum aspek ini. |
fragments
|
Urutan string;
defaultnya adalah [] Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi target. |
host_fragments
|
Urutan string;
defaultnya adalah [] Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi host. |
toolchains
|
sequence;
default-nya adalah [] Jika ditetapkan, kumpulan toolchain yang diperlukan aturan ini. Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun. Toolchain akan ditemukan dengan memeriksa platform saat ini, dan diberikan ke penerapan aturan melalui ctx.toolchain .
|
incompatible_use_toolchain_transition
|
defaultnya adalah False Tidak digunakan lagi, tidak lagi digunakan dan harus dihapus. |
doc
|
string; atau None ;
default adalah None Deskripsi aspek yang dapat diekstrak oleh alat pembuat dokumentasi. |
apply_to_generating_rules
|
default adalah False Jika benar, aspek akan diterapkan ke aturan pembuatan file output, bukan ke file output, saat diterapkan ke file output. Misalnya, aspek menyebar secara transitif melalui atribut `deps` dan diterapkan ke target `alpha`. Misalnya `alpha` memiliki `deps = [':beta_output']`, dengan `beta_output` adalah output yang dideklarasikan dari target `beta`. Misalkan `beta` memiliki target `charlie` sebagai salah satu `deps`-nya. Jika `apply_to_created_rules=True`, aspek `alpha` hanya akan disebarkan ke aspek `alpha`. Salah secara default. |
exec_compatible_with
|
urutan string;
defaultnya adalah [] Daftar batasan pada platform eksekusi yang berlaku untuk semua instance aspek ini. |
exec_groups
|
dict; atau None ;
default-nya adalah None Dict dari nama grup eksekusi (string) ke exec_group . Jika ditetapkan, memungkinkan aspek menjalankan tindakan di beberapa platform eksekusi dalam satu instance. Lihat dokumentasi grup eksekusi untuk info selengkapnya.
|
subrules
|
urutan Subaturan;
default adalah [] Eksperimental: daftar subaturan yang digunakan oleh aspek ini. |
configuration_field
LateBoundDefault configuration_field(fragment, name)Mereferensikan nilai default yang terikat lambat untuk atribut berjenis label. Nilai 'terikat lambat' jika memerlukan konfigurasi untuk dibuat sebelum menentukan nilai. Setiap atribut yang menggunakan ini sebagai nilai harus pribadi.
Contoh penggunaan:
Menentukan atribut aturan:
'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))
Mengakses dalam penerapan aturan:
def _rule_impl(ctx): foo_info = ctx.attr._foo ...
Parameter
Parameter | Deskripsi |
---|---|
fragment
|
wajib Nama fragmen konfigurasi yang berisi nilai yang terikat akhir. |
name
|
wajib Nama nilai yang akan diperoleh dari fragmen konfigurasi. |
depset
depset depset(direct=None, order="default", *, transitive=None)Membuat depset. Parameter
direct
adalah daftar elemen langsung dari depset, dan parameter transitive
adalah daftar depset yang elemennya menjadi elemen tidak langsung dari 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) dari depset harus berjenis sama, seperti yang diperoleh dengan 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 harus tidak dapat diubah, meskipun batasan ini akan dilonggarkan pada masa mendatang.
Urutan depset yang dibuat harus kompatibel dengan urutan depset transitive
-nya. Pesanan "default"
kompatibel dengan pesanan lainnya, semua pesanan lainnya hanya kompatibel dengan pesanan sendiri.
Parameter
Parameter | Deskripsi |
---|---|
direct
|
sequence; atau None ;
defaultnya adalah None Daftar elemen direct dari depset. |
order
|
defaultnya adalah "default" Strategi traversal untuk depset baru. Lihat di sini untuk nilai yang memungkinkan. |
transitive
|
urutan depset; atau None ;
default adalah None Daftar depset yang elemennya akan menjadi elemen tidak langsung depset. |
exec_group
exec_group exec_group(toolchains=[], exec_compatible_with=[])Membuat grup eksekusi yang dapat digunakan untuk membuat tindakan untuk platform eksekusi tertentu selama penerapan aturan.
Parameter
Parameter | Deskripsi |
---|---|
toolchains
|
sequence;
default adalah [] Kumpulan toolchain yang diperlukan grup eksekusi ini. Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun. |
exec_compatible_with
|
urutan string;
default adalah [] Daftar batasan pada platform eksekusi. |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)Membuat ekstensi modul baru. Simpan dalam nilai global, sehingga dapat diekspor dan digunakan dalam file MODULE.bazel dengan
use_extension
.
Parameter
Parameter | Deskripsi |
---|---|
implementation
|
diperlukan Fungsi yang mengimplementasikan ekstensi modul ini. Harus menggunakan satu parameter, module_ctx . Fungsi ini dipanggil sekali di awal build untuk menentukan kumpulan repo yang tersedia.
|
tag_classes
|
defaultnya adalah {} Kamus untuk mendeklarasikan semua class tag yang digunakan oleh ekstensi. Class ini memetakan dari nama class tag ke objek tag_class .
|
doc
|
string; atau None ;
default adalah None Deskripsi ekstensi modul yang dapat diekstrak oleh alat pembuat dokumentasi. |
environ
|
urutan string;
default adalah [] Memberikan daftar variabel lingkungan yang menjadi dependensi ekstensi modul ini. Jika variabel lingkungan dalam daftar tersebut berubah, ekstensi akan dievaluasi ulang. |
os_dependent
|
default adalah False Menunjukkan apakah ekstensi ini bergantung pada OS atau tidak |
arch_dependent
|
defaultnya adalah False Menunjukkan apakah ekstensi ini bergantung pada arsitektur atau tidak |
provider
unknown provider(doc=None, *, fields=None, init=None)Menentukan simbol penyedia. Penyedia dapat dibuat instance-nya dengan memanggilnya, atau digunakan langsung sebagai kunci untuk mengambil instance penyedia tersebut dari target. Contoh:
MyInfo = provider() ... def _my_library_impl(ctx): ... my_info = MyInfo(x = 2, y = 3) # my_info.x == 2 # my_info.y == 3 ...
Lihat Aturan (Penyedia) untuk panduan komprehensif tentang cara menggunakan penyedia.
Menampilkan nilai callable Provider
jika init
tidak ditentukan.
Jika init
ditentukan, akan menampilkan tuple yang terdiri dari 2 elemen: nilai callable Provider
dan nilai callable konstruktor mentah. Lihat Aturan (Inisialisasi kustom penyedia kustom) dan diskusi tentang parameter init
di bawah untuk mengetahui detailnya.
Parameter
Parameter | Deskripsi |
---|---|
doc
|
string; atau None ;
default-nya adalah None Deskripsi penyedia yang dapat diekstrak dengan alat penghasil dokumentasi. |
fields
|
Urutan string; atau dict; atau None ;
defaultnya adalah None Jika ditentukan, akan membatasi kumpulan kolom yang diizinkan. Kemungkinan nilainya adalah:
|
init
|
callable; atau None ; defaultnya adalah None Callback opsional untuk memproses sebelumnya dan memvalidasi nilai kolom penyedia selama pembuatan instance. Jika init ditentukan, provider() akan menampilkan tuple dari 2 elemen: simbol penyedia normal dan konstruktor mentah.Berikut deskripsi yang tepat; lihat Aturan (Inisialisasi kustom bagi penyedia) untuk mengetahui diskusi dan kasus penggunaan yang intuitif. Anggap
init tidak diberikan, panggilan ke simbol P itu sendiri akan bertindak sebagai panggilan ke fungsi konstruktor default c ; dengan kata lain, P(*args, **kwargs) menampilkan c(*args, **kwargs) . Misalnya,MyInfo = provider() m = MyInfo(foo = 1)akan langsung membuat sehingga m adalah instance MyInfo dengan m.foo == 1 .Namun, jika
Catatan: langkah-langkah di atas menyiratkan bahwa error terjadi jika Dengan cara ini, callback Jika MyInfo, _new_myinfo = provider(init = ...) |
repository_rule
callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)Membuat aturan repositori baru. Simpan dalam nilai global, sehingga dapat dimuat dan dipanggil dari fungsi implementasi
module extension
, atau digunakan oleh use_repo_rule
.
Parameter
Parameter | Deskripsi |
---|---|
implementation
|
diperlukan fungsi yang menerapkan aturan ini. Harus memiliki satu parameter, repository_ctx . Fungsi ini dipanggil selama fase pemuatan untuk setiap instance aturan.
|
attrs
|
dict; atau None ;
default adalah kamus None untuk mendeklarasikan semua atribut aturan. Pemetaan ini dilakukan dari nama atribut ke objek atribut (lihat modul attr). Atribut yang dimulai dengan _ bersifat pribadi, dan dapat digunakan untuk menambahkan dependensi implisit pada label ke file (aturan repositori tidak dapat bergantung pada artefak yang dihasilkan). Atribut name ditambahkan secara implisit dan tidak boleh ditentukan.
|
local
|
default adalah False Menunjukkan bahwa aturan ini mengambil semua data dari sistem lokal dan harus dievaluasi ulang pada setiap pengambilan. |
environ
|
urutan string;
defaultnya adalah [] Tidak digunakan lagi. Parameter ini tidak digunakan lagi. Migrasikan ke repository_ctx.getenv .Menyediakan daftar variabel lingkungan yang menjadi dependensi aturan repositori ini. Jika variabel lingkungan dalam daftar tersebut berubah, repositori akan diambil ulang. |
configure
|
defaultnya adalah False Menunjukkan bahwa repositori memeriksa sistem untuk tujuan konfigurasi |
remotable
|
default-nya adalah False Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah sewaktu-waktu. Harap tidak bergantung padanya. Fitur ini dapat diaktifkan secara eksperimental dengan menetapkan ---experimental_repo_remote_exec Kompatibel dengan eksekusi jarak jauh |
doc
|
string; atau None ;
default-nya adalah None Deskripsi aturan repositori yang dapat diekstrak dengan alat penghasil dokumentasi. |
aturan
callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])Membuat aturan baru, yang dapat dipanggil dari file BUILD atau makro untuk membuat target.
Aturan harus ditetapkan ke variabel global dalam file .bzl; nama variabel global adalah nama aturan.
Aturan pengujian harus memiliki nama yang diakhiri dengan _test
, sedangkan semua aturan lainnya tidak boleh memiliki akhiran ini. (Pembatasan ini hanya berlaku untuk aturan, bukan untuk targetnya.)
Parameter
Parameter | Deskripsi |
---|---|
implementation
|
wajib fungsi Starlark yang menerapkan aturan ini, harus memiliki satu parameter: ctx. Fungsi ini dipanggil selama fase analisis untuk setiap instance aturan. Fungsi ini dapat mengakses atribut yang diberikan oleh pengguna. Aplikasi harus membuat tindakan untuk menghasilkan semua output yang dideklarasikan. |
test
|
bool;
default adalah unbound Apakah aturan ini adalah aturan pengujian, yaitu apakah aturan ini dapat menjadi subjek perintah blaze test . Semua aturan pengujian otomatis dianggap dapat dieksekusi; Anda tidak perlu (dan tidak disarankan) menetapkan executable = True secara eksplisit untuk aturan pengujian. Nilai default-nya adalah False . Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
|
attrs
|
dict;
default adalah kamus {} untuk mendeklarasikan semua atribut aturan. Atribut ini memetakan dari nama atribut ke objek atribut (lihat modul attr). Atribut yang diawali dengan _ bersifat pribadi, dan dapat digunakan untuk menambahkan dependensi implisit pada label. Atribut name ditambahkan secara implisit dan tidak boleh ditentukan. Atribut visibility , deprecation , tags , testonly , dan features ditambahkan secara implisit dan tidak dapat diganti. Sebagian besar aturan hanya memerlukan beberapa atribut. Untuk membatasi penggunaan memori, fungsi aturan akan membatasi ukuran atribut.
|
outputs
|
dict; atau None ; atau function;
default adalah None Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Harap tidak bergantung padanya. Layanan ini dinonaktifkan dengan ---incompatible_no_rule_outputs_param . Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera terjadi. Parameter ini tidak digunakan lagi. Migrasikan aturan untuk menggunakan OutputGroupInfo atau attr.output sebagai gantinya. Skema untuk menentukan output yang telah dideklarasikan sebelumnya. Tidak seperti atribut Nilai argumen ini adalah kamus atau fungsi callback yang menghasilkan kamus. Callback berfungsi mirip dengan atribut dependensi yang dihitung: Nama parameter fungsi dicocokkan dengan atribut aturan, jadi misalnya jika Anda meneruskan Tiap entri dalam kamus membuat output yang telah dideklarasikan sebelumnya, dengan kuncinya adalah ID dan nilainya adalah template string yang menentukan label output. Dalam fungsi penerapan aturan, ID menjadi nama kolom yang digunakan untuk mengakses
Dalam praktiknya, placeholder penggantian yang paling umum adalah |
executable
|
bool;
defaultnya adalah unbound Apakah aturan ini dianggap dapat dieksekusi, yaitu apakah aturan ini merupakan subjek perintah blaze run . Nilai defaultnya adalah False . Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
|
output_to_genfiles
|
defaultnya adalah False Jika benar, file akan dibuat di direktori genfiles, bukan direktori bin. Kecuali jika Anda memerlukannya untuk kompatibilitas dengan aturan yang ada (misalnya, saat membuat file header untuk C++), jangan tetapkan tanda ini. |
fragments
|
Urutan string;
defaultnya adalah [] Daftar nama fragmen konfigurasi yang diperlukan aturan dalam konfigurasi target. |
host_fragments
|
urutan string;
default adalah [] Daftar nama fragmen konfigurasi yang diperlukan aturan dalam konfigurasi host. |
_skylark_testable
|
defaultnya adalah False (Eksperimental) Jika benar, aturan ini akan menampilkan tindakannya untuk diperiksa oleh aturan yang bergantung padanya melalui penyedia Actions . Penyedia juga tersedia untuk aturan itu sendiri dengan memanggil ctx.created_actions().Ini hanya boleh digunakan untuk menguji perilaku waktu analisis aturan Starlark. Tanda ini dapat dihapus pada masa mendatang. |
toolchains
|
urutan;
defaultnya adalah [] Jika ditetapkan, set toolchain yang diperlukan aturan ini. Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun. Toolchain akan ditemukan dengan memeriksa platform saat ini, dan disediakan ke implementasi aturan melalui ctx.toolchain .
|
incompatible_use_toolchain_transition
|
defaultnya adalah False Tidak digunakan lagi, tidak lagi digunakan dan harus dihapus. |
doc
|
string; atau None ;
default adalah None Deskripsi aturan yang dapat diekstrak oleh alat pembuat dokumentasi. |
provides
|
default adalah [] Daftar penyedia yang harus ditampilkan oleh fungsi implementasi. Muncul error jika fungsi implementasi menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkannya. Namun, fungsi implementasi mungkin menampilkan penyedia tambahan yang tidak tercantum di sini. Setiap elemen daftar adalah objek |
exec_compatible_with
|
urutan string;
default adalah [] Daftar batasan pada platform eksekusi yang berlaku untuk semua target jenis aturan ini. |
analysis_test
|
defaultnya adalah False Jika benar, aturan ini diperlakukan sebagai pengujian analisis. Catatan: Aturan pengujian analisis terutama ditentukan menggunakan infrastruktur yang disediakan di library Starlark inti. Lihat Pengujian untuk mendapatkan panduan. Jika sebuah aturan ditetapkan sebagai aturan pengujian analisis, aturan tersebut akan diizinkan untuk menggunakan transisi konfigurasi yang ditentukan menggunakan analysis_test_transition di atributnya, tetapi dapat menerapkan beberapa batasan berikut:
|
build_setting
|
BuildSetting; atau None ;
default-nya adalah None Jika ditetapkan, menjelaskan jenis build setting aturan ini. Lihat modul config . Jika ditetapkan, atribut wajib bernama "build_setting_default" akan otomatis ditambahkan ke aturan ini, dengan jenis yang sesuai dengan nilai yang diteruskan di sini.
|
cfg
|
default adalah None Jika ditetapkan, akan mengarah ke transisi konfigurasi yang akan diterapkan aturan ke konfigurasinya sendiri sebelum analisis. |
exec_groups
|
dict; atau None ;
default adalah None Dict nama grup eksekusi (string) ke exec_group s. Jika ditetapkan, aturan dapat menjalankan tindakan di beberapa platform eksekusi dalam satu target. Lihat dokumentasi grup eksekusi untuk info selengkapnya.
|
initializer
|
default adalah None Eksperimental: fungsi Stalark yang melakukan inisialisasi atribut aturan. Fungsi ini dipanggil pada waktu pemuatan untuk setiap instance aturan. Callback ini dipanggil dengan Fungsi ini harus menampilkan kamus dari nama atribut ke nilai yang diinginkan. Atribut yang tidak ditampilkan tidak akan terpengaruh. Menampilkan Inisialisasi dievaluasi sebelum nilai default yang ditentukan dalam definisi atribut. Akibatnya, jika parameter dalam tanda tangan penginisialisasi berisi nilai default, parameter tersebut akan menimpa nilai default dari definisi atribut (kecuali jika menampilkan Demikian pula, jika parameter dalam tanda tangan penginisialisasi tidak memiliki nilai default, parameter akan menjadi wajib. Dalam kasus semacam ini, sebaiknya hapus setelan default/wajib pada definisi atribut. Anda sebaiknya menggunakan Pada aturan yang diperluas, semua penginisialisasi akan dipanggil dari turunan ke ancestor. Setiap penginisialisasi hanya meneruskan atribut publik yang diketahuinya. |
parent
|
default adalah None Eksperimental: aturan Stalark yang diperluas. Saat ditetapkan, atribut publik akan digabungkan serta penyedia yang diiklankan. Aturan cocok dengan executable dan test dari induk. Nilai fragments , toolchains , exec_compatible_with , dan exec_groups digabungkan. Parameter lama atau yang tidak digunakan lagi tidak boleh ditetapkan. Transisi konfigurasi masuk cfg induk diterapkan setelah konfigurasi masuk aturan ini.
|
extendable
|
bool; atau Label; atau string; atau None ;
defaultnya adalah None Eksperimental: Label daftar yang diizinkan yang menentukan aturan mana yang dapat memperluas aturan ini. Nilai ini juga dapat ditetapkan ke True/False untuk selalu mengizinkan/melarang perpanjangan. Bazel secara default selalu mengizinkan ekstensi. |
subrules
|
urutan Subaturan;
default adalah [] Eksperimental: Daftar subaturan yang digunakan oleh aturan ini. |
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
|
defaultnya adalah '' Error kustom opsional yang akan dilaporkan jika tidak ada kondisi yang cocok. |
subaturan
Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])Membuat instance subaturan baru. Hasil fungsi ini harus disimpan dalam variabel global sebelum dapat digunakan.
Parameter
Parameter | Deskripsi |
---|---|
implementation
|
function;
required Fungsi Starlark yang menerapkan subaturan ini |
attrs
|
dict;
defaultnya adalah {} Kamus untuk mendeklarasikan semua atribut (pribadi) sub-aturan. Subaturan hanya boleh memiliki atribut pribadi yang berjenis label (yaitu label atau daftar label). Nilai yang di-resolve sesuai dengan label ini secara otomatis diteruskan oleh Bazel ke fungsi penerapan subaturan sebagai argumen yang dinamai (sehingga fungsi implementasi diperlukan untuk menerima parameter bernama yang cocok dengan nama atribut). Jenis nilai ini akan berupa:
|
toolchains
|
sequence;
default adalah [] Jika ditetapkan, kumpulan toolchain yang diperlukan subaturan ini. Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun. Toolchain akan ditemukan dengan memeriksa platform saat ini, dan diberikan ke implementasi subaturan melalui ctx.toolchains .
|
fragments
|
Urutan string;
defaultnya adalah [] Daftar nama fragmen konfigurasi yang diperlukan sub-aturan dalam konfigurasi target. |
subrules
|
Urutan Sub-aturan;
defaultnya adalah [] Daftar sub-aturan lain yang diperlukan oleh subaturan ini. |
tag_class
tag_class tag_class(attrs={}, *, doc=None)Membuat objek tag_class baru, yang menentukan skema atribut untuk class tag, yang merupakan objek data yang dapat digunakan oleh ekstensi modul.
Parameter
Parameter | Deskripsi |
---|---|
attrs
|
default adalah {} Kamus untuk mendeklarasikan semua atribut class tag ini. Pemetaan ini dilakukan dari nama atribut ke objek atribut (lihat modul attr). |
doc
|
string; atau None ;
default adalah None Deskripsi class tag yang dapat diekstrak oleh alat pembuat dokumentasi. |
visibilitas
None
visibility(value)
Menetapkan visibilitas pemuatan modul .bzl yang saat ini sedang diinisialisasi.
Visibilitas pemuatan modul mengatur apakah file BUILD dan .bzl lainnya dapat memuat modul atau tidak. (Hal ini berbeda dengan visibilitas target file sumber .bzl yang mendasarinya, yang mengatur apakah file tersebut muncul sebagai dependensi target lain.) Visibilitas beban berfungsi di level paket: Untuk memuat modul, file yang melakukan pemuatan harus berada di paket yang telah diberi visibilitas ke modul. Modul selalu dapat dimuat dalam paketnya sendiri, terlepas dari visibilitasnya.
visibility()
hanya boleh dipanggil sekali per file .bzl, dan hanya di tingkat teratas, bukan di dalam fungsi. Gaya yang disukai adalah menempatkan panggilan ini tepat di bawah pernyataan load()
dan logika singkat yang diperlukan untuk menentukan argumen.
Jika tanda --check_bzl_visibility
ditetapkan ke salah (false), pelanggaran visibilitas pemuatan akan memberikan peringatan, tetapi tidak akan menggagalkan build.
Parameter
Parameter | Deskripsi |
---|---|
value
|
required Daftar string spesifikasi paket, atau satu string spesifikasi paket. Spesifikasi paket mengikuti format yang sama seperti untuk
Sintaksis "@" tidak diizinkan; semua spesifikasi ditafsirkan secara relatif terhadap repositori modul saat ini. Jika Perhatikan bahwa flag |