Pendaftaran BazelCon 2024 sudah dibuka!

Halaman ini diterjemahkan oleh Cloud Translation API.

file .bzl

Laporkan masalah Malam · 7,4 kami. 7,3 · 7,2 · 7,1 · 7,0 · 6,5

Metode global yang tersedia di semua file .bzl.

Anggota

analysis_test_transition
aspek
configuration_field
depset
exec_group
exec_transition
module_extension
penyedia
repository_rule
rule
select
subaturan
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. Aturan tersebut dibatasi kemampuannya (misalnya, ukuran hierarki dependensinya terbatas), sehingga transisi yang dibuat menggunakan fungsi ini dibatasi dalam cakupan potensial dibandingkan dengan transisi yang dibuat menggunakan transition().

Fungsi ini terutama dirancang untuk memfasilitasi library inti Framework Pengujian Analisis. Lihat dokumentasi (atau penerapannya) untuk mengetahui praktik terbaik.

Parameter

Parameter	Deskripsi
`settings`	dict; 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 harus ditetapkan oleh pengujian analisis agar lulus.

aspek

Aspect aspect(implementation, attr_aspects=[], toolchains_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 dari fungsi ini harus disimpan dalam nilai global. Lihat pengantar Aspek untuk detail selengkapnya.

Parameter

Parameter	Deskripsi
`implementation`	function; wajib Fungsi Starlark yang menerapkan aspek ini, dengan tepat 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 ke target.
`attr_aspects`	urutan string; default adalah `[]` Daftar nama atribut. Aspek ini disebarkan bersama dependensi yang ditentukan dalam atribut target dengan nama-nama ini. Nilai umum di sini mencakup `deps` dan `exports`. Daftar ini juga dapat berisi satu string `"*"` untuk diterapkan di sepanjang semua dependensi target.
`toolchains_aspects`	sequence; default adalah `[]` Daftar jenis toolchain. Aspek ini disebarkan ke toolchain target yang cocok dengan jenis toolchain ini.
`attrs`	dict; default adalah `{}` Kamus yang mendeklarasikan semua atribut aspek. Class ini memetakan dari nama atribut ke objek atribut, seperti `attr.label` atau `attr.string` (lihat modul `attr`). Atribut aspek tersedia untuk fungsi implementasi sebagai kolom parameter `ctx`. Atribut implisit yang dimulai dengan `_` harus memiliki nilai default, dan memiliki jenis `label` atau `label_list`. Atribut eksplisit harus memiliki jenis `string`, dan harus menggunakan batasan `values`. Atribut eksplisit membatasi aspek agar hanya digunakan dengan aturan yang memiliki atribut dengan nama, jenis, dan nilai yang valid yang sama sesuai dengan batasan. Atribut yang dideklarasikan akan mengonversi `None` ke nilai default.
`required_providers`	sequence; 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, `[FooInfo, BarInfo]` akan otomatis dikonversi menjadi `[[FooInfo, BarInfo]]`. Agar beberapa target aturan (misalnya, `some_rule`) terlihat oleh aspek, `some_rule` harus mengiklankan semua penyedia dari minimal salah satu daftar penyedia yang diwajibkan. Misalnya, jika `required_providers` dari sebuah aspek adalah `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]`, aspek ini dapat melihat target `some_rule` jika dan hanya jika `some_rule` menyediakan `FooInfo`, atau `BarInfo`, atau `BazInfo` dan `QuxInfo`.
`required_aspect_providers`	sequence; default adalah `[]` Atribut ini memungkinkan aspek ini memeriksa aspek lain. 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, `[FooInfo, BarInfo]` akan otomatis dikonversi menjadi `[[FooInfo, BarInfo]]`. Agar aspek lain (misalnya `other_aspect`) terlihat oleh aspek ini, `other_aspect` harus menyediakan semua penyedia dari setidaknya salah satu daftar. Pada contoh `[[FooInfo], [BarInfo], [BazInfo, QuxInfo]]`, aspek ini dapat melihat `other_aspect` jika dan hanya jika `other_aspect` menyediakan `FooInfo`, atau `BarInfo`, atau `BazInfo` dan `QuxInfo`.
`provides`	sequence; 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 dapat menampilkan penyedia tambahan yang tidak tercantum di sini. Setiap elemen daftar adalah objek `*Info` yang ditampilkan oleh `provider()`, kecuali bahwa penyedia lama diwakili oleh nama stringnya. Jika target aturan digunakan sebagai dependensi untuk target yang mendeklarasikan penyedia yang diperlukan, Anda tidak perlu menentukan penyedia tersebut di sini. Fungsi implementasi cukup menampilkannya. Namun, menentukannya dianggap sebagai praktik terbaik, meskipun tidak diwajibkan. Namun, kolom `required_providers` dari aspek mengharuskan penyedia tersebut ditentukan di sini.
`requires`	urutan Aspek; default adalah `[]` Daftar aspek yang harus disebarkan sebelum aspek ini.
`fragments`	urutan string; default adalah `[]` Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi target.
`host_fragments`	urutan string; default adalah `[]` Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi host.
`toolchains`	sequence; default-nya adalah `[]` Jika ditetapkan, kumpulan toolchain yang diperlukan aspek ini. Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun. Toolchain akan ditemukan dengan memeriksa platform saat ini, dan disediakan untuk implementasi aspek melalui `ctx.toolchain`.
`incompatible_use_toolchain_transition`	bool; default adalah `False` Tidak digunakan lagi, tidak lagi digunakan dan harus dihapus.
`doc`	string; atau `None`; default adalah `None` Deskripsi aspek yang dapat diekstrak dengan alat penghasil dokumentasi.
`apply_to_generating_rules`	bool; default adalah `False` Jika benar, aspek ini akan, saat diterapkan ke file output, akan diterapkan ke aturan pembuatan file output. Misalnya, aspek menyebar secara transitif melalui atribut `deps` dan diterapkan ke `alpha` target. Misalkan `alpha` memiliki `deps = [':beta_output']`, dengan `beta_output` adalah output yang dideklarasikan dari `beta` target. Misalkan `beta` memiliki target `charlie` sebagai salah satu `deps`-nya. Jika `apply_to_generate_rules=True` untuk aspek, aspek tersebut akan menyebar ke seluruh `alpha`, `beta`, dan `charlie`. Jika False, aspek ini hanya akan disebarkan ke `alpha`. Salah secara default.
`exec_compatible_with`	urutan string; default adalah `[]` Daftar batasan pada platform eksekusi yang berlaku untuk semua instance aspek ini.
`exec_groups`	dict; atau `None`; default adalah `None` Dict nama grup eksekusi (string) ke `exec_group`s. Jika ditetapkan, memungkinkan aspek menjalankan tindakan di beberapa platform eksekusi dalam satu instance. Lihat dokumentasi grup eksekusi untuk info selengkapnya.
`subrules`	urutan Sub-aturan; default adalah `[]` Eksperimental: daftar sub-aturan yang digunakan oleh aspek ini.

configuration_field

LateBoundDefault configuration_field(fragment, name)

Mereferensikan nilai default akhir batas untuk atribut jenis label. Nilai 'terikat lambat' jika memerlukan konfigurasi untuk dibuat sebelum menentukan nilai. Setiap atribut yang menggunakan ini sebagai nilai harus bersifat 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`	string; wajib Nama fragmen konfigurasi yang berisi nilai yang terikat akhir.
`name`	string; required 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. Menggunakan tanda --incompatible_always_check_depset_ elements untuk memungkinkan 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. 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`	string; default 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 bagi platform eksekusi tertentu selama penerapan aturan.

Parameter

Parameter	Deskripsi
`toolchains`	sequence; default adalah `[]` Set 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.

exec_transition

transition exec_transition(implementation, inputs, outputs)

Versi khusus transition() yang digunakan untuk menentukan transisi eksekusi. Lihat dokumentasi (atau penerapannya) untuk mengetahui praktik terbaik. Hanya dapat digunakan dari bawaan Bazel.

Parameter

Parameter	Deskripsi
`implementation`	callable; wajib
`inputs`	urutan string; wajib
`outputs`	urutan string; wajib

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`	callable; required Fungsi yang mengimplementasikan ekstensi modul ini. Harus mengambil satu parameter, `module_ctx`. Fungsi ini dipanggil sekali di awal build untuk menentukan kumpulan repo yang tersedia.
`tag_classes`	dict; default 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 dengan 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`	bool; defaultnya adalah `False` Menunjukkan apakah ekstensi ini bergantung pada OS atau tidak
`arch_dependent`	bool; defaultnya adalah `False` Menunjukkan apakah ekstensi ini bergantung pada arsitektur atau tidak

provider

unknown provider(doc=None, *, fields=None, init=None)

Menentukan simbol penyedia. Nilai yang dihasilkan dari fungsi ini harus disimpan dalam nilai global agar dapat digunakan dalam penerapan aturan atau aspek. Penyedia dapat dibuat instance-nya dengan memanggil nilai yang dihasilkan sebagai fungsi, atau digunakan langsung sebagai kunci indeks 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 mengetahui panduan komprehensif tentang cara menggunakan penyedia.

Menampilkan nilai yang dapat dipanggil Provider jika init tidak ditentukan.

Jika init ditentukan, akan menampilkan tuple dari 2 elemen: nilai yang dapat dipanggil Provider dan nilai yang dapat dipanggil 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 adalah None
Deskripsi penyedia yang dapat diekstrak dengan alat yang menghasilkan dokumentasi.

Parameter	Deskripsi
`doc`	string; atau `None`; default adalah `None` Deskripsi penyedia yang dapat diekstrak dengan alat yang menghasilkan dokumentasi.
`fields`	urutan string; atau dict; atau `None`; defaultnya adalah `None` Jika ditentukan, akan membatasi kumpulan kolom yang diizinkan. Nilai yang mungkin adalah: daftar kolom: provider(fields = ['a', 'b']) nama kolom kamus -> dokumentasi: provider( fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' }) Semua kolom bersifat opsional.
`init`	callable; atau `None`; default adalah `None` Callback opsional untuk memproses 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 tepatnya; lihat Aturan (Inisialisasi kustom penyedia) untuk mengetahui diskusi dan kasus penggunaan yang intuitif. Misalkan `P` menjadi simbol penyedia yang dibuat dengan memanggil `provider()`. Secara konseptual, instance `P` dibuat dengan memanggil fungsi konstruktor default `c(args, kwargs)`, yang melakukan hal berikut: Jika `args` tidak kosong, error akan terjadi. Jika parameter `fields` ditentukan saat `provider()` dipanggil, dan jika `kwargs` berisi kunci yang tidak tercantum dalam `fields`, error akan terjadi. Jika tidak, `c` menampilkan instance baru yang memiliki kolom bernama `k` dengan nilai `v` untuk setiap entri `k: v` di `kwargs`. Jika callback `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 `init` ditentukan, panggilan `P(args, *kwargs)` akan melakukan langkah-langkah berikut: Callback dipanggil sebagai `init(args, kwargs)`, yaitu dengan argumen kata kunci dan posisi yang sama persis seperti yang diteruskan ke `P`. Nilai yang ditampilkan `init` diharapkan berupa kamus, `d`, yang kuncinya adalah string nama kolom. Jika tidak, error akan terjadi. Instance `P` baru dibuat seolah-olah dengan memanggil konstruktor default dengan entri `d` sebagai argumen kata kunci, seperti dalam `c(d)`. Catatan: langkah-langkah di atas menyiratkan bahwa error terjadi jika `args` atau `kwargs` tidak cocok dengan tanda tangan `init`, atau evaluasi isi `init` gagal (mungkin sengaja melalui panggilan ke `fail()`), atau jika nilai yang ditampilkan `init` bukan kamus dengan skema yang diharapkan. Dengan cara ini, callback `init` menggeneralisasi konstruksi penyedia normal dengan mengizinkan argumen posisi dan logika arbitrer untuk prapemrosesan dan validasi. Tindakan ini tidak* memungkinkan pengelakan dari daftar `fields` yang diizinkan. Jika `init` ditentukan, nilai yang ditampilkan dari `provider()` menjadi tuple `(P, r)`, dengan `r` adalah konstruktor mentah. Bahkan, perilaku `r` persis seperti fungsi konstruktor default `c` yang dibahas di atas. Biasanya, `r` terikat dengan variabel yang namanya diawali dengan garis bawah, sehingga hanya file .bzl saat ini yang memiliki akses langsung ke variabel tersebut: MyInfo, _new_myinfo = provider(init = ...)

fields

urutan string; atau dict; atau None; defaultnya adalah None
Jika ditentukan, akan membatasi kumpulan kolom yang diizinkan.
Nilai yang mungkin adalah:

daftar kolom:
```
provider(fields = ['a', 'b'])
```

nama kolom kamus -> dokumentasi:

provider(
       fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })

Semua kolom bersifat opsional.

init

callable; atau None; default adalah None
Callback opsional untuk memproses 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 tepatnya; lihat Aturan (Inisialisasi kustom penyedia) untuk mengetahui diskusi dan kasus penggunaan yang intuitif.

Misalkan P menjadi simbol penyedia yang dibuat dengan memanggil provider(). Secara konseptual, instance P dibuat dengan memanggil fungsi konstruktor default c(*args, **kwargs), yang melakukan hal berikut:

Jika args tidak kosong, error akan terjadi.
Jika parameter fields ditentukan saat provider() dipanggil, dan jika kwargs berisi kunci yang tidak tercantum dalam fields, error akan terjadi.
Jika tidak, c menampilkan instance baru yang memiliki kolom bernama k dengan nilai v untuk setiap entri k: v di kwargs.

Jika callback 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 init ditentukan, panggilan P(*args, **kwargs) akan melakukan langkah-langkah berikut:

Callback dipanggil sebagai init(*args, **kwargs), yaitu dengan argumen kata kunci dan posisi yang sama persis seperti yang diteruskan ke P.
Nilai yang ditampilkan init diharapkan berupa kamus, d, yang kuncinya adalah string nama kolom. Jika tidak, error akan terjadi.
Instance P baru dibuat seolah-olah dengan memanggil konstruktor default dengan entri d sebagai argumen kata kunci, seperti dalam c(**d).

Catatan: langkah-langkah di atas menyiratkan bahwa error terjadi jika *args atau **kwargs tidak cocok dengan tanda tangan init, atau evaluasi isi init gagal (mungkin sengaja melalui panggilan ke fail()), atau jika nilai yang ditampilkan init bukan kamus dengan skema yang diharapkan.

Dengan cara ini, callback init menggeneralisasi konstruksi penyedia normal dengan mengizinkan argumen posisi dan logika arbitrer untuk prapemrosesan dan validasi. Tindakan ini tidak memungkinkan pengelakan dari daftar fields yang diizinkan.

Jika init ditentukan, nilai yang ditampilkan dari provider() menjadi tuple (P, r), dengan r adalah konstruktor mentah. Bahkan, perilaku r persis seperti fungsi konstruktor default c yang dibahas di atas. Biasanya, r terikat dengan variabel yang namanya diawali dengan garis bawah, sehingga hanya file .bzl saat ini yang memiliki akses langsung ke variabel tersebut:

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`	callable; required 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 `None` Kamus untuk mendeklarasikan semua atribut aturan repositori. 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. Atribut yang dideklarasikan akan mengonversi `None` ke nilai default.
`local`	bool; default adalah `False` Menunjukkan bahwa aturan ini mengambil semua 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 kembali.
`configure`	bool; default adalah `False` Menunjukkan bahwa repositori memeriksa sistem untuk tujuan konfigurasi
`remotable`	bool; 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 adalah `None` Deskripsi aturan repositori yang dapat diekstrak oleh alat pembuat 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=[], dependency_resolution_rule=False, 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 targetnya.)

Parameter

Parameter	Deskripsi
`implementation`	function; wajib fungsi Starlark yang menerapkan aturan ini harus memiliki tepat satu parameter: ctx. Fungsi ini dipanggil selama fase analisis untuk setiap instance aturan. Dapat mengakses atribut yang disediakan oleh pengguna. Fungsi ini harus membuat tindakan untuk menghasilkan semua output yang dideklarasikan.
`test`	bool; default adalah `unbound` Apakah aturan ini merupakan aturan pengujian, yaitu apakah aturan tersebut merupakan subjek perintah `blaze test`. Semua aturan pengujian secara otomatis dianggap executable; `executable = True` tidak perlu ditetapkan (dan tidak disarankan) untuk aturan pengujian secara eksplisit. Nilai defaultnya adalah `False`. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
`attrs`	dict; default adalah `{}` Kamus untuk mendeklarasikan semua atribut aturan. Pendekatan ini memetakan dari nama atribut ke objek atribut (lihat Modul `attr`). Atribut yang dimulai 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, ada batas jumlah atribut yang dapat dideklarasikan. Atribut yang dideklarasikan akan mengonversi `None` ke nilai default.
`outputs`	dict; atau `None`; atau function; default adalah `None` Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Jangan bergantung pada hal ini. Fitur ini dinonaktifkan dengan `--incompatible_no_rule_outputs_param`. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusannya yang akan segera dilakukan. Parameter ini tidak digunakan lagi. Migrasikan aturan untuk menggunakan `OutputGroupInfo` atau `attr.output`. Skema untuk menentukan output yang telah dideklarasikan sebelumnya. Tidak seperti atribut `output` dan `output_list`, pengguna tidak menentukan label untuk file ini. Lihat halaman Aturan untuk mengetahui informasi selengkapnya tentang output yang telah dideklarasikan. 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 `outputs = _my_func` dengan definisi `def _my_func(srcs, deps): ...`, fungsi tersebut memiliki akses ke atribut `srcs` dan `deps`. Baik kamus ditentukan secara langsung maupun melalui fungsi, kamus akan ditafsirkan sebagai berikut. 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 `File` output di `ctx.outputs`. Label output memiliki paket yang sama dengan aturan, dan bagian setelah paket dibuat dengan mengganti setiap placeholder dari bentuk `"%{ATTR}"` dengan string yang dibentuk dari nilai atribut `ATTR`: Atribut bertipe string diganti verbatim. Atribut yang diketik label menjadi bagian dari label setelah paket, tanpa ekstensi file. Misalnya, label `"//pkg:a/b.c"` menjadi `"a/b"`. Atribut yang diketik output menjadi bagian dari label setelah paket, termasuk ekstensi file (untuk contoh di atas, `"a/b.c"`). Semua atribut berjenis daftar (misalnya, `attr.label_list`) yang digunakan dalam placeholder harus memiliki persis satu elemen. Konversinya sama dengan versi non-daftarnya (`attr.label`). Jenis atribut lainnya mungkin tidak muncul di placeholder. Placeholder non-atribut khusus `%{dirname}` dan `%{basename}` diperluas ke bagian label aturan tersebut, tidak termasuk paketnya. Misalnya, dalam `"//pkg:a/b.c"`, dirname-nya adalah `a` dan basename-nya adalah `b.c`. Dalam praktiknya, placeholder pengganti yang paling umum adalah `"%{name}"`. Misalnya, untuk target bernama "foo", output dict `{"bin": "%{name}.exe"}` mendeklarasikan output bernama `foo.exe` di awal yang dapat diakses dalam fungsi implementasi sebagai `ctx.outputs.bin`.
`executable`	bool; default 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`	bool; default adalah `False` Jika true, file akan dibuat di direktori genfiles, bukan direktori bin. Jangan setel flag ini kecuali Anda memerlukannya untuk kompatibilitas dengan aturan yang ada (misalnya saat membuat file header untuk C++).
`fragments`	urutan string; default 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`	bool; default adalah `False` (Eksperimental) Jika true (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`	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`	bool; default adalah `False` Tidak digunakan lagi, tidak lagi digunakan dan harus dihapus.
`doc`	string; atau `None`; default adalah `None` Deskripsi aturan yang dapat diekstrak dengan alat pembuat dokumentasi.
`provides`	sequence; default adalah `[]` Daftar penyedia yang harus ditampilkan oleh fungsi implementasi. Akan terjadi error jika fungsi implementasi menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkannya. Namun, fungsi implementasi dapat menampilkan penyedia tambahan yang tidak tercantum di sini. Setiap elemen daftar adalah objek `*Info` yang ditampilkan oleh `provider()`, kecuali bahwa penyedia lama diwakili oleh nama stringnya.Jika target aturan digunakan sebagai dependensi untuk target yang mendeklarasikan penyedia wajib, Anda tidak perlu menentukan penyedia tersebut di sini. Cukup dengan fungsi implementasi yang menampilkannya. Namun, praktik terbaiknya adalah menentukannya, meskipun hal ini tidak diwajibkan. Namun, kolom `required_providers` dari aspek mengharuskan penyedia ditentukan di sini.
`dependency_resolution_rule`	bool; default adalah `False` Jika ditetapkan, aturan dapat menjadi dependensi melalui atribut yang juga ditandai sebagai tersedia di materializer. Setiap atribut aturan dengan flag yang ditetapkan ini juga harus ditandai sebagai tersedia di materializer. Hal ini dilakukan agar aturan yang ditandai tidak dapat bergantung pada aturan yang tidak ditandai.
`exec_compatible_with`	urutan string; default adalah `[]` Daftar batasan pada platform eksekusi yang berlaku untuk semua target jenis aturan ini.
`analysis_test`	bool; default adalah `False` Jika benar, aturan ini akan 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: Target aturan ini dibatasi jumlah dependensi transitif yang mungkin dimilikinya. Aturan ini dianggap sebagai aturan pengujian (seolah-olah `test=True` ditetapkan). Opsi ini menggantikan nilai `test` Fungsi penerapan aturan mungkin tidak mendaftarkan tindakan. Sebagai gantinya, aplikasi harus mendaftarkan hasil lulus/gagal melalui penyediaan AnalysisTestResultInfo.
`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, mengarah ke transisi konfigurasi yang akan diterapkan aturan ke konfigurasinya sendiri sebelum analisis.
`exec_groups`	dict; atau `None`; default adalah `None` Dikte nama grup eksekusi (string) ke `exec_group`. 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 `name` dan nilai atribut publik yang ditentukan oleh aturan (bukan dengan atribut umum, misalnya `tags`). Fungsi ini harus menampilkan kamus dari nama atribut ke nilai yang diinginkan. Atribut yang tidak ditampilkan tidak akan terpengaruh. Menampilkan `None` sebagai nilai akan menggunakan nilai default yang ditentukan dalam definisi atribut. Penginisialisasi dievaluasi sebelum nilai default yang ditentukan dalam definisi atribut. Akibatnya, jika parameter dalam tanda tangan penginisialisasi berisi nilai default, parameter tersebut akan menimpa default dari definisi atribut (kecuali jika menampilkan `None`). Demikian pula, jika parameter dalam tanda tangan penginisialisasi tidak memiliki nilai default, parameter akan menjadi wajib. Sebaiknya hapus setelan default/wajib pada definisi atribut dalam kasus tersebut. Anda sebaiknya menggunakan `**kwargs` untuk atribut yang tidak ditangani. Dalam kasus aturan yang diperluas, semua penginisialisasi dipanggil dari turunan ke ancestor. Setiap penginisialisasi hanya diteruskan atribut publik yang diketahuinya.
`parent`	default adalah `None` Eksperimental: aturan Stalark yang diperluas. Saat ditetapkan, atribut publik akan digabungkan dan juga 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`; default-nya adalah `None` Eksperimental: Label daftar yang diizinkan yang menentukan aturan mana yang dapat memperluas aturan ini. Atribut ini juga dapat ditetapkan ke True/False untuk selalu mengizinkan/tidak mengizinkan perluasan. Secara default, Bazel akan selalu mengizinkan ekstensi.
`subrules`	urutan Sub-aturan; default adalah `[]` Eksperimental: Daftar sub-aturan yang digunakan oleh aturan ini.

pilih

unknown select(x, no_match_error='')

select() adalah fungsi bantuan yang membuat atribut aturan dapat dikonfigurasi. Lihat membuat ensiklopedia untuk mengetahui detailnya.

Parameter

Parameter	Deskripsi
`x`	dict; wajib Dikte 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`	string; default adalah `''` Error kustom opsional yang akan dilaporkan jika tidak ada kondisi yang cocok.

subaturan

Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])

Membuat instance baru subaturan. Hasil fungsi ini harus disimpan dalam variabel global sebelum dapat digunakan.

Parameter

Parameter	Deskripsi
`implementation`	function; wajib Fungsi Starlark yang menerapkan subaturan ini
`attrs`	dict; default adalah `{}` Kamus untuk mendeklarasikan semua atribut (pribadi) subaturan. Sub-aturan hanya boleh memiliki atribut pribadi berjenis label (yaitu label atau daftar label). Nilai yang di-resolve yang sesuai dengan label ini secara otomatis diteruskan oleh Bazel ke fungsi implementasi subaturan sebagai argumen bernama (sehingga fungsi implementasi diperlukan untuk menerima parameter bernama yang cocok dengan nama atribut). Jenis nilai ini adalah: `FilesToRunProvider` untuk atribut label dengan `executable=True` `File` untuk atribut label dengan `allow_single_file=True` `Target` untuk semua atribut label lainnya `[Target]` untuk semua atribut daftar label
`toolchains`	sequence; default adalah `[]` Jika ditetapkan, set toolchain yang diperlukan oleh sub-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 implementasi subaturan melalui `ctx.toolchains`.
`fragments`	urutan string; default adalah `[]` Daftar nama fragmen konfigurasi yang diperlukan sub-aturan dalam konfigurasi target.
`subrules`	urutan Subaturan; default-nya adalah `[]` Daftar subaturan 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`	dict; default adalah `{}` Kamus untuk mendeklarasikan semua atribut class tag ini. Objek ini dipetakan dari nama atribut ke objek atribut (lihat modul attr). Perhatikan bahwa tidak seperti `rule()`, `aspect()`, dan `repository_rule()`, atribut yang dideklarasikan tidak akan mengonversi `None` ke nilai default. Agar default dapat digunakan, atribut harus dihilangkan sepenuhnya oleh pemanggil.
`doc`	string; atau `None`; default adalah `None` Deskripsi class tag yang dapat diekstrak dengan alat pembuat dokumentasi.

visibilitas

None visibility(value)

Menyetel visibilitas beban modul .bzl yang sedang diinisialisasi.

Visibilitas pemuatan modul mengatur apakah file BUILD dan .bzl lainnya dapat memuat modul tersebut atau tidak. (Hal ini berbeda dengan visibilitas target file sumber .bzl yang mendasarinya, yang mengatur apakah file tersebut muncul sebagai dependensi target lain.) Visibilitas pemuatan berfungsi di tingkat paket: Untuk memuat modul, file yang melakukan pemuatan harus berada dalam paket yang telah diberi visibilitas ke modul. Modul selalu dapat dimuat dalam paketnya sendiri, terlepas dari visibilitasnya.

visibility() hanya dapat dipanggil sekali per file .bzl, dan hanya di level 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

Parameter	Deskripsi
`value`	wajib Daftar string spesifikasi paket, atau string spesifikasi paket tunggal. Spesifikasi paket mengikuti format yang sama seperti `package_group`, namun spesifikasi paket negatif tidak diizinkan. Artinya, spesifikasi dapat berupa: `"//foo"`: paket `//foo` `"//foo/..."`: paket `//foo` dan semua subpaketnya. `"public"` atau `"private"`: semua paket atau tidak ada paket Sintaksis "@" tidak diizinkan; semua spesifikasi ditafsirkan relatif terhadap repositori modul saat ini. Jika `value` adalah daftar string, kumpulan paket yang diberi visibilitas ke modul ini adalah gabungan paket yang diwakili oleh setiap spesifikasi. (Daftar kosong memiliki efek yang sama dengan `private`.) Jika `value` adalah string tunggal, string tersebut akan diperlakukan seolah-olah itu adalah daftar singleton `[value]`. Perhatikan bahwa flag `--incompatible_package_group_has_public_syntax` dan `--incompatible_fix_package_group_reporoot_syntax` tidak berpengaruh pada argumen ini. Nilai `"public"` dan `"private"` selalu tersedia, dan `"//..."` selalu ditafsirkan sebagai "semua paket dalam repositori saat ini".

value

wajib
Daftar string spesifikasi paket, atau string spesifikasi paket tunggal.

Spesifikasi paket mengikuti format yang sama seperti package_group, namun spesifikasi paket negatif tidak diizinkan. Artinya, spesifikasi dapat berupa:

"//foo": paket //foo
"//foo/...": paket //foo dan semua subpaketnya.
"public" atau "private": semua paket atau tidak ada paket

Sintaksis "@" tidak diizinkan; semua spesifikasi ditafsirkan relatif terhadap repositori modul saat ini.

Jika value adalah daftar string, kumpulan paket yang diberi visibilitas ke modul ini adalah gabungan paket yang diwakili oleh setiap spesifikasi. (Daftar kosong memiliki efek yang sama dengan private.) Jika value adalah string tunggal, string tersebut akan diperlakukan seolah-olah itu adalah daftar singleton [value].

Perhatikan bahwa flag --incompatible_package_group_has_public_syntax dan --incompatible_fix_package_group_reporoot_syntax tidak berpengaruh pada argumen ini. Nilai "public" dan "private" selalu tersedia, dan "//..." selalu ditafsirkan sebagai "semua paket dalam repositori saat ini".