Global

Objek, fungsi, dan modul yang terdaftar di lingkungan global.

Anggota

semua

bool all(elements)

Menampilkan benar (True) jika semua elemen bernilai Benar (True) atau jika koleksi kosong. Elemen dikonversi menjadi boolean menggunakan fungsi bool.
all(["hello", 3, True]) == True
all([-1, 0, 1]) == False

Parameter

Parameter Deskripsi
elements wajib
String atau kumpulan elemen.

analysis_test_transition

transition analysis_test_transition(settings)

Membuat transisi konfigurasi yang akan diterapkan pada dependensi aturan analisis-pengujian. Transisi ini hanya dapat diterapkan pada atribut aturan dengan analysis_test = True. Kemampuan aturan tersebut dibatasi (misalnya, ukuran hierarki dependensinya dibatasi), sehingga transisi yang dibuat menggunakan fungsi ini dibatasi dalam potensi cakupannya dibandingkan dengan transisi yang dibuat menggunakan transition.

Fungsi ini terutama dirancang untuk memfasilitasi library inti Analysis Test Framework. Lihat dokumentasinya (atau implementasinya) untuk mengetahui praktik terbaik.

Parameter

Parameter Deskripsi
settings wajib
Kamus yang berisi informasi tentang setelan konfigurasi yang harus ditetapkan oleh transisi konfigurasi ini. Kunci adalah label setelan build dan nilai adalah nilai baru setelah transisi. Semua setelan lainnya tidak berubah. Gunakan ini untuk mendeklarasikan setelan konfigurasi tertentu yang harus ditetapkan agar lulus pengujian analisis.

apa pun

bool any(elements)

Menampilkan benar jika setidaknya satu elemen dievaluasi ke Benar. Elemen dikonversi menjadi boolean menggunakan fungsi bool.
any([-1, 0, 1]) == True
any([False, 0, ""]) == False

Parameter

Parameter Deskripsi
elements wajib
String atau kumpulan elemen.

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Menentukan bahwa dependensi ini harus berasal dari file arsip (zip, gzip, dll.) di lokasi tertentu, bukan dari registry. Petunjuk ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh modul lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel yang akan diterapkan penggantian ini.
urls string; or Iterable of strings; wajib diisi
URL arsip; dapat berupa URL http(s):// atau file://.
integrity default = ''
Checksum yang diharapkan dari file arsip, dalam format Subresource Integrity.
strip_prefix default = ''
Awalan direktori yang akan dihapus dari file yang diekstrak.
patches Iterable of strings; default = []
Daftar label yang mengarah ke file patch yang akan diterapkan untuk modul ini. File patch harus ada di hierarki sumber project tingkat teratas. Aturan diterapkan sesuai urutan daftar.
patch_cmds Iterable of strings; default = []
Urutan perintah Bash yang akan diterapkan di Linux/MacOS setelah patch diterapkan.
patch_strip default = 0
Sama seperti argumen --strip patch Unix.

aspek

Aspect aspect(implementation, attr_aspects=[], attrs=None, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None)

Membuat aspek baru. Hasil fungsi ini harus disimpan dalam nilai global. Lihat pengantar Aspek untuk mengetahui detail selengkapnya.

Parameter

Parameter Deskripsi
implementation required
Fungsi Starlark yang menerapkan aspek ini, dengan tepat dua parameter: Target (target yang diterapkan aspeknya) dan ctx (konteks aturan yang dibuat targetnya). Atribut target tersedia melalui kolom ctx.rule. Fungsi ini dievaluasi selama fase analisis untuk setiap penerapan aspek ke target.
attr_aspects sequence of strings; default = []
Daftar nama atribut. Aspek ini disebarkan di sepanjang dependensi yang ditentukan dalam atribut target dengan nama ini. Nilai umum di sini mencakup deps dan exports. Daftar juga dapat berisi satu string "*" untuk disebarkan di semua dependensi target.
attrs dict; or None; default = None
Kamus yang menyatakan semua atribut aspek. 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 diawali 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 valid yang sama sesuai dengan batasan.

required_providers default = []
Atribut ini memungkinkan aspek membatasi penyebarannya hanya ke target yang aturannya mengiklankan penyedia yang diperlukan. Nilai harus berupa daftar yang berisi masing-masing 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 menjadi daftar yang berisi satu daftar penyedia. Artinya, [FooInfo, BarInfo] akan otomatis dikonversi menjadi [[FooInfo, BarInfo]].

Agar beberapa target aturan (misalnya, some_rule) terlihat di aspek, some_rule harus mengiklankan semua penyedia dari setidaknya salah satu daftar penyedia yang diperlukan. Misalnya, jika required_providers suatu aspek adalah [[FooInfo], [BarInfo], [BazInfo, QuxInfo]], aspek ini hanya dapat melihat target some_rule jika dan hanya jika some_rule menyediakan FooInfo *atau* BarInfo *atau* BazInfo *dan* QuxInfo.

required_aspect_providers default = []
Atribut ini memungkinkan aspek ini memeriksa aspek lain. Nilai harus berupa daftar yang berisi masing-masing 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 menjadi 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. Dalam contoh [[FooInfo], [BarInfo], [BazInfo, QuxInfo]], aspek ini hanya dapat melihat other_aspect jika dan hanya jika other_aspect menyediakan FooInfo *atau* BarInfo *atau* BazInfo *dan* QuxInfo.

provides default = []
Daftar penyedia yang harus ditampilkan oleh fungsi penerapan.

Terjadi error jika fungsi penerapan menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkan. Namun, fungsi penerapan 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.

requires sequence of Aspects; default = []
Daftar aspek yang harus disebarkan sebelum aspek ini.
fragments sequence of strings; default = []
Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi target.
host_fragments sequence of strings; default = []
Daftar nama fragmen konfigurasi yang diperlukan aspek dalam konfigurasi host.
toolchains sequence; default = []
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 default = False
Tidak digunakan lagi, tidak digunakan lagi dan harus dihapus.
doc default = ''
Deskripsi aspek yang dapat diekstrak oleh alat pembuat dokumentasi.
apply_to_generating_rules default = False
Jika benar (true), aspek akan diterapkan ke aturan pembuatan file output, bukan ke file output, saat diterapkan ke file output.

Misalnya, anggaplah suatu aspek berpropagasi secara transitif melalui atribut `deps` dan diterapkan ke target `alpha`. Anggaplah `alpha` memiliki `deps = [':beta_output']`, dengan `beta_output` adalah output yang dideklarasikan dari target `beta`. Anggaplah `beta` memiliki target `charlie` sebagai salah satu `deps`-nya. Jika `apply_to_generating_rules=True` untuk aspek tersebut, aspek akan berpropagasi melalui `alpha`, `beta`, dan `charlie`. Jika False, aspek hanya akan berpropagasi ke `alpha`.

False secara default.
exec_compatible_with sequence of strings; default = []
Daftar batasan pada platform eksekusi yang berlaku untuk semua instance aspek ini.
exec_groups dict; or None; default = None
Dict nama grup eksekusi (string) ke exec_groups. Jika disetel, memungkinkan aspek menjalankan tindakan di beberapa platform eksekusi dalam satu instance. Lihat dokumentasi grup eksekusi untuk mengetahui info selengkapnya.

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

Mendeklarasikan dependensi langsung pada modul Bazel lain.

Parameter

Parameter Deskripsi
name wajib
Nama modul yang akan ditambahkan sebagai dependensi langsung.
version default = ''
Versi modul yang akan ditambahkan sebagai dependensi langsung.
max_compatibility_level default = -1
compatibility_level maksimum yang didukung untuk modul yang akan ditambahkan sebagai dependensi langsung. Versi modul menyiratkan compatibility_level minimum yang didukung, serta maksimum jika atribut ini tidak ditentukan.
repo_name default = ''
Nama repo eksternal yang merepresentasikan dependensi ini. Secara default, ini adalah nama modul.
dev_dependency default = False
Jika benar, dependensi ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.

mengikat

None bind(name, actual=None)

Peringatan: penggunaan bind() tidak direkomendasikan. Lihat Pertimbangkan untuk menghapus pengikatan untuk mengetahui diskusi panjang tentang masalah dan alternatifnya.

Memberi target alias dalam paket //external.

Parameter

Parameter Deskripsi
name wajib
Label di bagian '//external' yang berfungsi sebagai nama alias
actual string; or None; default = None
Label sebenarnya yang akan diberi alias

bool

bool bool(x=False)

Konstruktor untuk jenis bool. Fungsi ini menampilkan False jika objeknya adalah None, False, string kosong (""), angka 0, atau koleksi kosong (misalnya, (), []). Jika tidak, fungsi ini akan menampilkan True.

Parameter

Parameter Deskripsi
x default = False
Variabel yang akan dikonversi.

configuration_field

LateBoundDefault configuration_field(fragment, name)

Mereferensikan nilai default yang terikat terlambat untuk atribut berjenis label. Nilai 'terikat terlambat' 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 required
Nama fragmen konfigurasi yang berisi nilai terikat lambat.
name wajib diisi
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 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 memiliki jenis yang 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, saat ini invarian ini tidak diperiksa secara konsisten di semua konstruktor. Gunakan tanda --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, sedangkan pesanan lainnya hanya kompatibel dengan pesanan itu sendiri.

Catatan tentang kompatibilitas mundur/maju. Fungsi ini saat ini menerima parameter items posisional. Parameter ini tidak digunakan lagi dan akan dihapus pada masa mendatang, dan setelah penghapusannya, direct akan menjadi satu-satunya parameter posisi fungsi depset. Dengan demikian, kedua panggilan berikut setara dan siap untuk masa mendatang:

depset(['a', 'b'], transitive = [...])
depset(direct = ['a', 'b'], transitive = [...])

Parameter

Parameter Deskripsi
direct sequence; or None; default = None
Daftar elemen direct dari depset.
order default = "default"
Strategi penelusuran untuk depset baru. Lihat di sini untuk mengetahui kemungkinan nilai.
transitive sequence of depsets; or None; default = None
Daftar depsets yang elemennya akan menjadi elemen tidak langsung dari depset.

dict

dict dict(pairs=[], **kwargs)

Membuat kamus dari argumen posisi opsional dan kumpulan argumen kata kunci opsional. Jika kunci yang sama diberikan beberapa kali, nilai terakhir akan digunakan. Entri yang diberikan melalui argumen kata kunci dianggap muncul setelah entri yang diberikan melalui argumen posisional.

Parameter

Parameter Deskripsi
pairs default = []
Dict, atau iterable yang setiap elemennya memiliki panjang 2 (kunci, nilai).
kwargs required
Dictionary entri tambahan.

dir

list dir(x)

Menampilkan daftar string: nama atribut dan metode objek parameter.

Parameter

Parameter Deskripsi
x required
Objek yang akan diperiksa.

menghitung

list enumerate(list, start=0)

Menampilkan daftar pasangan (tuple dua elemen), dengan indeks (int) dan item dari urutan input. 
enumerate([24, 21, 84]) == [(0, 24), (1, 21), (2, 84)]

Parameter

Parameter Deskripsi
list diperlukan
urutan input.
start default = 0
indeks awal.

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[], copy_from_rule=False)

Membuat grup eksekusi yang dapat digunakan untuk membuat tindakan bagi platform eksekusi tertentu selama penerapan aturan.

Parameter

Parameter Deskripsi
toolchains sequence; default = []sequence Kumpulan toolchain yang diperlukan oleh grup eksekusi ini.
Daftar dapat berisi objek String, Label, atau StarlarkToolchainTypeApi, dalam kombinasi apa pun.
exec_compatible_with sequence of strings; default = []
Daftar batasan pada platform eksekusi.
copy_from_rule default = False
Jika disetel ke benar (true), grup exec ini akan mewarisi toolchain dan batasan aturan yang menjadi tempat grup ini dilampirkan. Jika disetel ke string lain, error akan muncul.

fail

None fail(msg=None, attr=None, *args)

Menyebabkan eksekusi gagal dengan error.

Parameter

Parameter Deskripsi
msg default = None
Tidak digunakan lagi: gunakan argumen posisi sebagai gantinya. Argumen ini bertindak seperti argumen posisi awal implisit.
attr string; or None; default = None
Tidak digunakan lagi. Menyebabkan awalan opsional yang berisi string ini ditambahkan ke pesan error.
args required
Daftar nilai, yang diformat dengan debugPrint (yang secara default setara dengan str) dan digabungkan dengan spasi, yang muncul dalam pesan error.

float

float float(x=unbound)

Menampilkan x sebagai nilai float.
  • Jika x sudah berupa float, float akan menampilkannya tanpa perubahan.
  • Jika x adalah bool, float menampilkan 1,0 untuk True dan 0,0 untuk False.
  • Jika x adalah int, float akan menampilkan nilai floating point terbatas terdekat ke x, atau error jika besarnya terlalu besar.
  • Jika x adalah string, string tersebut harus berupa literal floating point yang valid, atau sama (dengan mengabaikan huruf besar/kecil) dengan NaN, Inf, atau Infinity, yang secara opsional diawali dengan tanda + atau -.
Nilai lainnya akan menyebabkan error. Tanpa argumen, float() menampilkan 0,0.

Parameter

Parameter Deskripsi
x default = unbound
Nilai yang akan dikonversi.

getattr

unknown getattr(x, name, default=unbound)

Menampilkan kolom struct dengan nama tertentu jika ada. Jika tidak, fungsi ini akan menampilkan default (jika ditentukan) atau memunculkan error. getattr(x, "foobar") setara dengan x.foobar.
getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

Parameter

Parameter Deskripsi
x required
Struct yang atributnya diakses.
name wajib diisi
Nama atribut struct.
default default = unbound
Nilai default yang akan ditampilkan jika struct tidak memiliki atribut dengan nama yang diberikan.

git_override

None git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0)

Menentukan bahwa dependensi harus berasal dari commit tertentu repositori Git. Petunjuk ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh modul lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel yang akan diterapkan penggantian ini.
remote wajib diisi
URL repositori Git jarak jauh.
commit default = ''
Commit yang harus diperiksa.
patches Iterable of strings; default = []
Daftar label yang mengarah ke file patch yang akan diterapkan untuk modul ini. File patch harus ada di hierarki sumber project tingkat teratas. Aturan diterapkan sesuai urutan daftar.
patch_cmds Iterable of strings; default = []
Urutan perintah Bash yang akan diterapkan di Linux/MacOS setelah patch diterapkan.
patch_strip default = 0
Sama seperti argumen --strip patch Unix.

hasattr

bool hasattr(x, name)

Menampilkan True jika objek x memiliki atribut atau metode name yang diberikan, atau False jika tidak. Contoh:
hasattr(ctx.attr, "myattr")

Parameter

Parameter Deskripsi
x required
Objek yang akan diperiksa.
name wajib
Nama atribut.

hash

int hash(value)

Menampilkan nilai hash untuk string. Nilai ini dihitung secara deterministik menggunakan algoritma yang sama dengan String.hashCode() Java, yaitu:
Hashing nilai selain string saat ini tidak didukung.
s[0] * (31^(n-1)) + s[1] * (31^(n-2)) + ... + s[n-1]

Parameter

Parameter Deskripsi
value wajib
Nilai string yang akan di-hash.

int

int int(x, base=unbound)

Menampilkan x sebagai nilai int.
  • Jika x sudah berupa int, int akan menampilkannya tanpa perubahan.
  • Jika x adalah bool, int menampilkan 1 untuk True dan 0 untuk False.
  • Jika x adalah string, formatnya harus <sign><prefix><digits>. <sign> adalah "+", "-", atau kosong (ditafsirkan sebagai positif). <digits> adalah urutan angka dari 0 hingga base - 1, dengan huruf a-z (atau A-Z) digunakan sebagai angka untuk 10-35. Jika base adalah 2/8/16, <prefix> bersifat opsional dan dapat berupa 0b/0o/0x (atau setara, 0B/0O/0X); jika base adalah nilai lain selain basis ini atau nilai khusus 0, awalan harus kosong. Jika base adalah 0, string ditafsirkan sebagai literal bilangan bulat, dalam arti bahwa salah satu basis 2/8/10/16 dipilih bergantung pada awalan yang digunakan, jika ada. Jika base adalah 0, tidak ada awalan yang digunakan, dan ada lebih dari satu digit, digit pertama tidak boleh 0; hal ini untuk menghindari kebingungan antara oktal dan desimal. Besar angka yang diwakili oleh string harus berada dalam rentang yang diizinkan untuk jenis int.
  • Jika x adalah float, int akan menampilkan nilai bilangan bulat dari float, yang dibulatkan ke nol. Error akan terjadi jika x tidak berhingga (NaN atau tak terhingga).
Fungsi ini akan gagal jika x adalah jenis lain, atau jika nilainya adalah string yang tidak memenuhi format di atas. Tidak seperti fungsi int Python, fungsi ini tidak mengizinkan nol argumen, dan tidak mengizinkan spasi kosong yang tidak relevan untuk argumen string.

Contoh:

int("123") == 123
int("-123") == -123
int("+123") == 123
int("FF", 16) == 255
int("0xFF", 16) == 255
int("10", 0) == 10
int("-0x10", 0) == -16
int("-0x10", 0) == -16
int("123.456") == 123

Parameter

Parameter Deskripsi
x wajib
String yang akan dikonversi.
base default = unbound
Basis yang digunakan untuk menafsirkan nilai string; defaultnya adalah 10. Harus antara 2 dan 36 (inklusif), atau 0 untuk mendeteksi basis seolah-olah x adalah literal bilangan bulat. Parameter ini tidak boleh diberikan jika nilainya bukan string.

len

int len(x)

Menampilkan panjang string, urutan (seperti daftar atau tuple), dict, atau iterable lainnya.

Parameter

Parameter Deskripsi
x wajib
Nilai yang panjangnya akan dilaporkan.

list

list list(x=[])

Menampilkan daftar baru dengan elemen yang sama seperti nilai iterable yang diberikan.
list([1, 2]) == [1, 2]
list((2, 3, 2)) == [2, 3, 2]
list({5: "a", 2: "b", 4: "c"}) == [5, 2, 4]

Parameter

Parameter Deskripsi
x default = []
Objek yang akan dikonversi.

local_path_override

None local_path_override(module_name, path)

Menentukan bahwa dependensi harus berasal dari direktori tertentu di disk lokal. Petunjuk ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh modul lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel yang akan diterapkan penggantian ini.
path wajib diisi
Jalur ke direktori tempat modul ini berada.

maks

unknown max(*args)

Menampilkan argumen terbesar dari semua argumen yang diberikan. Jika hanya satu argumen yang diberikan, argumen tersebut harus berupa iterable yang tidak kosong.Error akan terjadi jika elemen tidak dapat dibandingkan (misalnya, int dengan string), atau jika tidak ada argumen yang diberikan. 
max(2, 5, 4) == 5
max([5, 6, 3]) == 6

Parameter

Parameter Deskripsi
args wajib
Elemen yang akan diperiksa.

mnt

unknown min(*args)

Menampilkan yang terkecil dari semua argumen yang diberikan. Jika hanya satu argumen yang diberikan, argumen tersebut harus berupa iterable yang tidak kosong. Error akan terjadi jika elemen tidak dapat dibandingkan (misalnya, int dengan string), atau jika tidak ada argumen yang diberikan. 
min(2, 5, 4) == 2
min([5, 6, 3]) == 3

Parameter

Parameter Deskripsi
args wajib
Elemen yang akan diperiksa.

modul

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

Mendeklarasikan properti tertentu dari modul Bazel yang diwakili oleh repo Bazel saat ini. Properti ini adalah metadata penting modul (seperti nama dan versi), atau memengaruhi perilaku modul saat ini dan dependensinya.

Metode ini harus dipanggil paling banyak satu kali. Dapat dihilangkan hanya jika modul ini adalah modul root (yaitu, jika tidak akan bergantung pada modul lain).

Parameter

Parameter Deskripsi
name default = ''
Nama modul. Dapat dihilangkan hanya jika modul ini adalah modul root (yaitu, jika tidak akan bergantung pada modul lain). Nama modul yang valid harus: 1) hanya berisi huruf kecil (a-z), angka (0-9), titik (.), tanda hubung (-), dan garis bawah (_); 2) diawali dengan huruf kecil; 3) diakhiri dengan huruf kecil atau angka.
version default = ''
Versi modul. Dapat dihilangkan hanya jika modul ini adalah modul root (yaitu, jika tidak akan bergantung pada modul lain).
compatibility_level default = 0
Tingkat kompatibilitas modul; ini harus diubah setiap kali perubahan utama yang tidak kompatibel diperkenalkan. Pada dasarnya, ini adalah "versi utama" modul dalam hal SemVer, kecuali bahwa versi ini tidak disematkan dalam string versi itu sendiri, tetapi ada sebagai kolom terpisah. Modul dengan tingkat kompatibilitas yang berbeda berpartisipasi dalam penyelesaian versi seolah-olah merupakan modul dengan nama yang berbeda, tetapi grafik dependensi akhir tidak boleh berisi beberapa modul dengan nama yang sama tetapi tingkat kompatibilitas yang berbeda (kecuali jika multiple_version_override berlaku; lihat di sana untuk mengetahui detail selengkapnya).
repo_name default = ''
Nama repositori yang merepresentasikan modul ini, seperti yang terlihat oleh modul itu sendiri. Secara default, nama repo adalah nama modul. Hal ini dapat ditentukan untuk mempermudah migrasi bagi project yang telah menggunakan nama repo untuk dirinya sendiri yang berbeda dengan nama modulnya.
bazel_compatibility Iterable of strings; default = []
Daftar versi bazel yang memungkinkan pengguna menyatakan versi Bazel mana yang kompatibel dengan modul ini. Hal ini TIDAK memengaruhi penyelesaian dependensi, tetapi bzlmod akan menggunakan informasi ini untuk memeriksa apakah versi Bazel Anda saat ini kompatibel. Format nilai ini adalah string dari beberapa nilai batasan yang dipisahkan dengan koma. Tiga batasan yang didukung: <=X.X.X: Versi Bazel harus sama dengan atau lebih lama dari X.X.X. Digunakan jika ada perubahan yang tidak kompatibel dalam versi yang lebih baru. >=X.X.X: Versi Bazel harus sama atau lebih baru dari X.X.X.Digunakan saat Anda bergantung pada beberapa fitur yang hanya tersedia sejak X.X.X. -X.X.X: Versi Bazel X.X.X tidak kompatibel. Digunakan saat ada bug di X.X.X yang merusak Anda, tetapi diperbaiki di versi yang lebih baru.

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc='', environ=[], os_dependent=False, arch_dependent=False)

Membuat ekstensi modul baru. Simpan di nilai global, sehingga dapat diekspor dan digunakan dalam file MODULE.bazel.

Parameter

Parameter Deskripsi
implementation required
Fungsi yang menerapkan ekstensi modul ini. Harus mengambil satu parameter, module_ctx. Fungsi ini dipanggil sekali di awal build untuk menentukan kumpulan repo yang tersedia.
tag_classes default = {}
Kamus untuk mendeklarasikan semua class tag yang digunakan oleh ekstensi. Memetakan dari nama class tag ke objek tag_class.
doc default = ''
Deskripsi ekstensi modul yang dapat diekstrak oleh alat pembuat dokumentasi.
environ sequence of strings; default = []
Menyediakan daftar variabel lingkungan yang menjadi tempat bergantung ekstensi modul ini. Jika variabel lingkungan dalam daftar tersebut berubah, ekstensi akan dievaluasi ulang.
os_dependent default = False
Menunjukkan apakah ekstensi ini bergantung pada OS atau tidak
arch_dependent default = False
Menunjukkan apakah ekstensi ini bergantung pada arsitektur atau tidak

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

Menentukan bahwa dependensi harus tetap berasal dari registry, tetapi beberapa versinya harus diizinkan untuk berjalan bersama. Lihat dokumentasi untuk mengetahui detail selengkapnya. Petunjuk ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh modul lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel yang akan diterapkan penggantian ini.
versions Iterable of strings; wajib
Menentukan secara eksplisit versi yang diizinkan untuk berjalan bersama. Versi ini harus sudah ada dalam pra-pemilihan grafik dependensi. Dependensi pada modul ini akan "diupgrade" ke versi yang diizinkan lebih tinggi terdekat pada tingkat kompatibilitas yang sama, sedangkan dependensi yang memiliki versi lebih tinggi daripada versi yang diizinkan pada tingkat kompatibilitas yang sama akan menyebabkan error.
registry default = ''
Menggantikan pendaftaran untuk modul ini; alih-alih menemukan modul ini dari daftar pendaftaran default, pendaftaran yang diberikan harus digunakan.

cetak

None print(sep=" ", *args)

Mencetak args sebagai output debug. Pesan ini akan diawali dengan string "DEBUG" dan lokasi (file dan nomor baris) panggilan ini. Cara persis argumen dikonversi menjadi string tidak ditentukan dan dapat berubah kapan saja. Secara khusus, format ini mungkin berbeda dari (dan lebih mendetail daripada) format yang dilakukan oleh str() dan repr().

Penggunaan print dalam kode produksi tidak disarankan karena spam yang ditimbulkannya bagi pengguna. Untuk penghentian penggunaan, sebaiknya gunakan error berat menggunakan fail() jika memungkinkan.

Parameter

Parameter Deskripsi
sep default = " "
String pemisah antara objek, defaultnya adalah spasi (" ").
args required
Objek yang akan dicetak.

provider

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

Menentukan simbol penyedia. Penyedia dapat di-instantiate dengan memanggilnya, atau digunakan secara 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 yang dapat dipanggil Provider jika init tidak ditentukan.

Jika init ditentukan, akan menampilkan tuple 2 elemen: nilai yang dapat dipanggil Provider dan nilai yang dapat dipanggil konstruktor mentah. Lihat Aturan (Inisialisasi kustom penyedia kustom) dan pembahasan parameter init di bawah untuk mengetahui detailnya.

Parameter

Parameter Deskripsi
doc default = ''
Deskripsi penyedia yang dapat diekstrak oleh alat pembuat dokumentasi.
fields sequence of strings; or dict; or None; default = None
Jika ditentukan, 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; or None; default = None
Callback opsional untuk memproses dan memvalidasi nilai kolom penyedia selama instansiasi. Jika init ditentukan, provider() akan menampilkan tuple 2 elemen: simbol penyedia normal dan konstruktor mentah.

Deskripsi yang tepat akan mengikuti; lihat Aturan (Inisialisasi penyedia kustom) untuk pembahasan dan kasus penggunaan yang intuitif.

Biarkan 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, akan terjadi error.
  • Jika tidak, c akan menampilkan instance baru yang memiliki, untuk setiap entri k: v di kwargs, kolom bernama k dengan nilai v.
Jika callback init tidak diberikan, panggilan ke simbol P itu sendiri 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 secara langsung membuat m menjadi instance MyInfo dengan m.foo == 1.

Namun, jika init ditentukan, panggilan P(*args, **kwargs) akan melakukan langkah-langkah berikut:

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

NB: langkah-langkah di atas menyiratkan bahwa error terjadi jika *args atau **kwargs tidak cocok dengan tanda tangan init, atau evaluasi isi init gagal (mungkin secara 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 praproses dan validasi. Fitur ini tidak memungkinkan pengelabuan daftar fields yang diizinkan.

Jika init ditentukan, nilai yang ditampilkan oleh provider() akan menjadi tuple (P, r), dengan r adalah konstruktor mentah. Faktanya, perilaku r sama persis dengan fungsi konstruktor default c yang dibahas di atas. Biasanya, r terikat ke 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 = ...)

rentang

sequence range(start_or_stop, stop_or_none=None, step=1)

Membuat daftar yang itemnya bergerak dari start ke stop, menggunakan inkremen step. Jika satu argumen diberikan, item akan berkisar dari 0 hingga elemen tersebut.
range(4) == [0, 1, 2, 3]
range(3, 9, 2) == [3, 5, 7]
range(3, 0, -1) == [3, 2, 1]

Parameter

Parameter Deskripsi
start_or_stop required
Nilai elemen awal jika stop disediakan, jika tidak, nilai stop dan awal sebenarnya adalah 0
stop_or_none int; or None; default = None
indeks opsional item pertama yang tidak disertakan dalam daftar yang dihasilkan; pembuatan daftar berhenti sebelum stop tercapai.
step default = 1
Peningkatan (defaultnya adalah 1). Nilainya mungkin negatif.

register_execution_platforms()

None register_execution_platforms(*platform_labels)

Daftarkan platform yang sudah ditentukan agar Bazel dapat menggunakannya sebagai platform eksekusi selama penyelesaian toolchain.

Parameter

Parameter Deskripsi
platform_labels sequence of strings; wajib
Label platform yang akan didaftarkan.

register_execution_platforms(dev_dependency)

None register_execution_platforms(dev_dependency=False, *platform_labels)

Menentukan platform eksekusi yang telah ditentukan untuk didaftarkan saat modul ini dipilih. Harus berupa pola target absolut (yaitu, dimulai dengan @ atau //). Lihat resolusi toolchain untuk mengetahui informasi selengkapnya.

Parameter

Parameter Deskripsi
dev_dependency default = False
Jika benar (true), platform eksekusi tidak akan didaftarkan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.
platform_labels sequence of strings; wajib
Label platform yang akan didaftarkan.

register_toolchains()

None register_toolchains(*toolchain_labels)

Mendaftarkan toolchain yang sudah ditentukan agar Bazel dapat menggunakannya selama penyelesaian toolchain. Lihat contoh menentukan dan mendaftarkan toolchain.

Parameter

Parameter Deskripsi
toolchain_labels sequence of strings; required
Label toolchain yang akan didaftarkan.

register_toolchains(dev_dependency)

None register_toolchains(dev_dependency=False, *toolchain_labels)

Menentukan toolchain yang sudah ditentukan untuk didaftarkan saat modul ini dipilih. Harus berupa pola target absolut (yaitu, dimulai dengan @ atau //). Lihat resolusi toolchain untuk mengetahui informasi selengkapnya.

Parameter

Parameter Deskripsi
dev_dependency default = False
Jika benar, toolchain tidak akan didaftarkan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.
toolchain_labels sequence of strings; required
Label toolchain yang akan didaftarkan.

repository_rule

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc='')

Membuat aturan repositori baru. Simpan di nilai global, sehingga dapat dimuat dan dipanggil dari file WORKSPACE.

Parameter

Parameter Deskripsi
implementation required
fungsi yang menerapkan aturan ini. Harus memiliki satu parameter, repository_ctx. Fungsi ini dipanggil selama fase pemuatan untuk setiap instance aturan.
attrs dict; or None; default = None
kamus untuk mendeklarasikan semua atribut aturan. 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 ke file (aturan repositori tidak dapat bergantung pada artefak yang dihasilkan). Atribut name ditambahkan secara implisit dan tidak boleh ditentukan.
local default = False
Menunjukkan bahwa aturan ini mengambil semuanya dari sistem lokal dan harus dievaluasi ulang pada setiap pengambilan.
environ sequence of strings; default = []
Menyediakan daftar variabel lingkungan yang menjadi tempat bergantung aturan repositori ini. Jika variabel lingkungan dalam daftar tersebut berubah, repositori akan diambil ulang.
configure default = False
Menunjukkan bahwa repositori memeriksa sistem untuk tujuan konfigurasi
remotable default = False
Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah kapan saja. Jangan mengandalkannya. Fitur ini dapat diaktifkan secara eksperimental dengan menyetel ---experimental_repo_remote_exec
Kompatibel dengan eksekusi jarak jauh
doc default = ''
Deskripsi aturan repositori yang dapat diekstrak oleh alat pembuat dokumentasi.

repr

string repr(x)

Mengonversi objek apa pun menjadi representasi string. Hal ini berguna untuk proses debug.
repr("ab") == '"ab"'

Parameter

Parameter Deskripsi
x wajib
Objek yang akan dikonversi.

dibalik

list reversed(sequence)

Menampilkan daftar baru yang tidak dibekukan yang berisi elemen urutan iterable asli dalam urutan terbalik.
reversed([3, 5, 4]) == [4, 5, 3]

Parameter

Parameter Deskripsi
sequence wajib diisi
Urutan yang dapat diiterasi (misalnya, daftar) yang akan dibalik.

aturan

callable rule(implementation, test=False, attrs=None, outputs=None, executable=False, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc='', *, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, compile_one_filetype=None, name=None)

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 diperlukan
fungsi Starlark yang menerapkan aturan ini, harus memiliki tepat satu parameter: ctx. Fungsi ini dipanggil selama fase analisis untuk setiap instance aturan. Aplikasi dapat mengakses atribut yang diberikan oleh pengguna. Tindakan ini harus membuat tindakan untuk menghasilkan semua output yang dideklarasikan.
test default = False
Apakah aturan ini adalah aturan pengujian, yaitu apakah aturan ini dapat menjadi subjek perintah blaze test. Semua aturan pengujian otomatis dianggap dapat dieksekusi; tidak perlu (dan tidak disarankan) untuk menetapkan executable = True secara eksplisit untuk aturan pengujian. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
attrs dict; or None; default = None
kamus untuk mendeklarasikan semua atribut aturan. 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, fungsi aturan membatasi ukuran attrs.
outputs dict; or None; or function; default = None
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Jangan mengandalkannya. 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 sebagai gantinya.

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 sebelumnya.

Nilai argumen ini berupa kamus atau fungsi panggil balik yang menghasilkan kamus. Callback berfungsi mirip dengan atribut dependensi terkomputasi: Nama parameter fungsi dicocokkan dengan atribut aturan, jadi misalnya jika Anda meneruskan outputs = _my_func dengan definisi def _my_func(srcs, deps): ..., fungsi memiliki akses ke atribut srcs dan deps. Apakah kamus ditentukan secara langsung atau melalui fungsi, kamus ditafsirkan sebagai berikut.

Setiap entri dalam kamus membuat output yang telah dideklarasikan sebelumnya dengan kunci berupa ID dan nilai berupa 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 dihasilkan dengan mengganti setiap placeholder formulir "%{ATTR}" dengan string yang dibentuk dari nilai atribut ATTR:

  • Atribut berjenis string diganti kata demi kata.
  • Atribut berjenis label menjadi bagian dari label setelah paket, minus ekstensi file. Misalnya, label "//pkg:a/b.c" menjadi "a/b".
  • Atribut berjenis 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 tepat satu elemen. Konversi mereka sama dengan versi non-daftar mereka (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, di "//pkg:a/b.c", dirname adalah a dan basename adalah b.c.

Dalam praktiknya, placeholder penggantian yang paling umum adalah "%{name}". Misalnya, untuk target bernama "foo", dict output {"bin": "%{name}.exe"} mendeklarasikan terlebih dahulu output bernama foo.exe yang dapat diakses dalam fungsi penerapan sebagai ctx.outputs.bin.

executable default = False
Apakah aturan ini dianggap dapat dieksekusi, yaitu apakah aturan ini dapat menjadi subjek perintah blaze run. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.
output_to_genfiles default = False
Jika benar (true), file akan dibuat di direktori genfiles, bukan direktori bin. Jangan tetapkan tanda ini kecuali Anda memerlukannya untuk kompatibilitas dengan aturan yang ada (misalnya, saat membuat file header untuk C++).
fragments sequence of strings; default = []
Daftar nama fragmen konfigurasi yang diperlukan aturan dalam konfigurasi target.
host_fragments sequence of strings; default = []
Daftar nama fragmen konfigurasi yang diperlukan aturan dalam konfigurasi host.
_skylark_testable default = False
(Eksperimental)

Jika benar (true), aturan ini akan mengekspos tindakannya untuk diperiksa oleh aturan yang bergantung padanya melalui penyedia Tindakan. Penyedia juga tersedia untuk aturan itu sendiri dengan memanggil ctx.created_actions().

Ini hanya boleh digunakan untuk menguji perilaku waktu analisis aturan Starlark. Flag ini dapat dihapus pada masa mendatang.
toolchains sequence; default = []
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 default = False
Tidak digunakan lagi, tidak digunakan lagi dan harus dihapus.
doc default = ''
Deskripsi aturan yang dapat diekstrak oleh alat pembuat dokumentasi.
provides default = []
Daftar penyedia yang harus ditampilkan oleh fungsi penerapan.

Terjadi error jika fungsi penerapan menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkan. Namun, fungsi penerapan 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.

exec_compatible_with sequence of strings; default = []
Daftar batasan pada platform eksekusi yang berlaku untuk semua target jenis aturan ini.
analysis_test default = 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 ditentukan sebagai aturan pengujian analisis, aturan diizinkan untuk menggunakan transisi konfigurasi yang ditentukan menggunakan analysis_test_transition pada atributnya, tetapi memilih untuk menerapkan beberapa batasan:

  • Target aturan ini dibatasi dalam jumlah dependensi transitif yang mungkin dimilikinya.
  • Aturan ini dianggap sebagai aturan pengujian (seolah-olah test=True ditetapkan). Nilai ini menggantikan nilai test
  • Fungsi penerapan aturan mungkin tidak mendaftarkan tindakan. Sebagai gantinya, hasil lulus/gagal harus didaftarkan dengan memberikan AnalysisTestResultInfo.
build_setting BuildSetting; or None; default = None
Jika disetel, 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 = None
Jika disetel, mengarah ke transisi konfigurasi yang akan diterapkan aturan ke konfigurasinya sendiri sebelum analisis.
exec_groups dict; or None; default = None
Dict nama grup eksekusi (string) ke exec_groups. Jika disetel, memungkinkan aturan menjalankan tindakan di beberapa platform eksekusi dalam satu target. Lihat dokumentasi grup eksekusi untuk mengetahui info selengkapnya.
compile_one_filetype sequence of strings; or None; default = None
Digunakan oleh --compile_one_dependency: jika beberapa aturan menggunakan file yang ditentukan, haruskah kita memilih aturan ini daripada aturan lainnya.
name string; or None; default = None
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Jangan mengandalkannya. Dinonaktifkan dengan --+incompatible_remove_rule_name_parameter. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusannya yang akan segera dilakukan.
Tidak digunakan lagi: jangan gunakan.

Nama aturan ini, sebagaimana dipahami oleh Bazel dan dilaporkan dalam konteks seperti logging, native.existing_rule(...)[kind], dan bazel query. Biasanya ini sama dengan ID Starlark yang terikat ke aturan ini; misalnya, aturan yang disebut foo_library biasanya akan dideklarasikan sebagai foo_library = rule(...) dan di-instansiasi dalam file BUILD sebagai foo_library(...).

Jika parameter ini tidak disertakan, nama aturan akan ditetapkan ke nama variabel global Starlark pertama yang akan terikat ke aturan ini dalam modul .bzl yang mendeklarasikannya. Oleh karena itu, foo_library = rule(...) tidak perlu menentukan parameter ini jika namanya adalah foo_library.

Menentukan nama eksplisit untuk aturan tidak mengubah tempat Anda diizinkan untuk membuat instance aturan.

pilih

unknown select(x, no_match_error='')

select() adalah fungsi bantuan yang membuat atribut aturan dapat dikonfigurasi. Lihat membangun ensiklopedia 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 = ''
Error kustom opsional yang akan dilaporkan jika tidak ada kondisi yang cocok.

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

Menentukan bahwa dependensi harus tetap berasal dari registry, tetapi versinya harus disematkan, atau registry-nya diganti, atau daftar patch diterapkan. Petunjuk ini hanya berlaku di modul root; dengan kata lain, jika modul digunakan sebagai dependensi oleh modul lain, penggantiannya sendiri akan diabaikan.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel yang akan diterapkan penggantian ini.
version default = ''
Menggantikan versi modul ini yang dinyatakan dalam grafik dependensi. Dengan kata lain, modul ini akan "disematkan" ke versi penggantian ini. Atribut ini dapat dihilangkan jika yang ingin diganti hanyalah registri atau patch.
registry default = ''
Menggantikan pendaftaran untuk modul ini; alih-alih menemukan modul ini dari daftar pendaftaran default, pendaftaran yang diberikan harus digunakan.
patches Iterable of strings; default = []
Daftar label yang mengarah ke file patch yang akan diterapkan untuk modul ini. File patch harus ada di hierarki sumber project tingkat teratas. Aturan diterapkan sesuai urutan daftar.
patch_cmds Iterable of strings; default = []
Urutan perintah Bash yang akan diterapkan di Linux/MacOS setelah patch diterapkan.
patch_strip default = 0
Sama seperti argumen --strip patch Unix.

diurutkan

list sorted(iterable, *, key=None, reverse=False)

Menampilkan daftar baru yang diurutkan dan berisi semua elemen dari urutan iterable yang diberikan. Error dapat terjadi jika pasangan elemen x, y tidak dapat dibandingkan menggunakan x < y. Elemen diurutkan dalam urutan menaik, kecuali jika argumen reverse adalah True, yang dalam hal ini urutannya menurun. Pengurutan stabil: elemen yang dibandingkan sama akan mempertahankan urutan relatif aslinya. 
sorted([3, 5, 4]) == [3, 4, 5]

Parameter

Parameter Deskripsi
iterable wajib
Urutan iterable yang akan diurutkan.
key default = None
Fungsi opsional yang diterapkan ke setiap elemen sebelum perbandingan.
reverse default = False
Menampilkan hasil dalam urutan menurun.

str

string str(x)

Mengonversi objek apa pun menjadi string. Hal ini berguna untuk proses debug.
str("ab") == "ab"
str(8) == "8"

Parameter

Parameter Deskripsi
x wajib
Objek yang akan dikonversi.

tag_class

tag_class tag_class(attrs={}, *, doc='')

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 = {}
Kamus untuk mendeklarasikan semua atribut class tag ini. Memetakan dari nama atribut ke objek atribut (lihat modul attr).
doc default = ''
Deskripsi class tag yang dapat diekstrak oleh alat pembuat dokumentasi.

tuple

tuple tuple(x=())

Menampilkan tuple dengan elemen yang sama seperti nilai iterable yang diberikan.
tuple([1, 2]) == (1, 2)
tuple((2, 3, 2)) == (2, 3, 2)
tuple({5: "a", 2: "b", 4: "c"}) == (5, 2, 4)

Parameter

Parameter Deskripsi
x default = ()
Objek yang akan dikonversi.

jenis

string type(x)

Menampilkan nama jenis argumennya. Hal ini berguna untuk proses debug dan pemeriksaan jenis. Contoh:
type(2) == "int"
type([1]) == "list"
type(struct(a = 2)) == "struct"
Fungsi ini dapat berubah pada masa mendatang. Untuk menulis kode yang kompatibel dengan Python dan siap untuk masa depan, gunakan hanya untuk membandingkan nilai yang ditampilkan: 
if type(x) == type([]):  # if x is a list

Parameter

Parameter Deskripsi
x required
Objek yang akan diperiksa jenisnya.

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

Menampilkan objek proxy yang merepresentasikan ekstensi modul; metodenya dapat dipanggil untuk membuat tag ekstensi modul.

Parameter

Parameter Deskripsi
extension_bzl_file required
Label ke file Starlark yang menentukan ekstensi modul.
extension_name wajib diisi
Nama ekstensi modul yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark.
dev_dependency default = False
Jika benar (true), penggunaan ekstensi modul ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan.
isolate default = False
Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah kapan saja. Jangan mengandalkannya. Fitur ini dapat diaktifkan secara eksperimental dengan menyetel ---experimental_isolated_extension_usages
Jika benar (true), penggunaan ekstensi modul ini akan diisolasi dari semua penggunaan lainnya, baik di modul ini maupun modul lainnya. Tag yang dibuat untuk penggunaan ini tidak memengaruhi penggunaan lain dan repositori yang dihasilkan oleh ekstensi untuk penggunaan ini akan berbeda dari semua repositori lain yang dihasilkan oleh ekstensi.

Parameter ini saat ini bersifat eksperimental dan hanya tersedia dengan tanda --experimental_isolated_extension_usages.

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Mengimpor satu atau beberapa repositori yang dihasilkan oleh ekstensi modul tertentu ke dalam cakupan modul saat ini.

Parameter

Parameter Deskripsi
extension_proxy required
Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension.
args required
Nama repositori yang akan diimpor.
kwargs required
Menentukan repositori tertentu untuk diimpor ke dalam cakupan modul saat ini dengan nama yang berbeda. Kuncinya harus berupa nama yang akan digunakan dalam cakupan saat ini, sedangkan nilainya harus berupa nama asli yang diekspor oleh ekstensi modul.

visibilitas

None visibility(value)

Menetapkan visibilitas pemuatan modul .bzl yang saat ini sedang diinisialisasi.

Visibilitas pemuatan modul menentukan apakah file BUILD dan .bzl lainnya dapat memuatnya atau tidak. (Hal ini berbeda dengan visibilitas target dari file sumber .bzl yang mendasarinya, yang mengatur apakah file dapat 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 satu kali 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 disetel ke false, pelanggaran visibilitas pemuatan akan memunculkan peringatan, tetapi tidak akan menyebabkan build gagal.

Parameter

Parameter Deskripsi
value wajib
Daftar string spesifikasi paket, atau satu string spesifikasi paket.

Spesifikasi paket mengikuti format yang sama seperti untuk package_group, kecuali spesifikasi paket negatif tidak diizinkan. Artinya, spesifikasi dapat memiliki bentuk:

  • "//foo": paket //foo
  • "//foo/...": paket //foo dan semua sub-paketnya.
  • "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 dari paket yang diwakili oleh setiap spesifikasi. (Daftar kosong memiliki efek yang sama dengan private.) Jika value adalah string tunggal, string tersebut diperlakukan seolah-olah merupakan daftar singleton [value].

Perhatikan bahwa tanda --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 di repositori saat ini".

ruang kerja

None workspace(name)

Fungsi ini hanya dapat digunakan dalam file WORKSPACE dan harus dideklarasikan sebelum semua fungsi lain dalam file WORKSPACE. Setiap file WORKSPACE harus memiliki fungsi workspace.

Menetapkan nama untuk ruang kerja ini. Nama ruang kerja harus berupa deskripsi project gaya paket Java, menggunakan garis bawah sebagai pemisah, misalnya, github.com/bazelbuild/bazel harus menggunakan com_github_bazelbuild_bazel.

Nama ini digunakan untuk direktori tempat file yang dapat dijalankan repositori disimpan. Misalnya, jika ada runfile foo/bar di repositori lokal dan file WORKSPACE berisi workspace(name = 'baz'), runfile akan tersedia di mytarget.runfiles/baz/foo/bar. Jika tidak ada nama ruang kerja yang ditentukan, file yang dapat dieksekusi akan ditautkan secara simbolis ke bar.runfiles/foo/bar.

Nama aturan repositori jarak jauh harus berupa nama ruang kerja yang valid. Misalnya, Anda dapat memiliki maven_jar(name = 'foo'), tetapi tidak memiliki maven_jar(name = 'foo%bar'), karena Bazel akan mencoba menulis file WORKSPACE untuk maven_jar yang berisi workspace(name = 'foo%bar').

Parameter

Parameter Deskripsi
name wajib diisi
nama ruang kerja. Nama harus diawali dengan huruf dan hanya dapat berisi huruf, angka, garis bawah, tanda hubung, dan titik.

zip

list zip(*args)

Menampilkan list dari tuple, dengan tuple ke-i berisi elemen ke-i dari setiap urutan atau iterable argumen. Daftar memiliki ukuran input terpendek. Dengan satu argumen yang dapat diiterasi, fungsi ini akan menampilkan daftar 1-tuple. Tanpa argumen, fungsi ini akan menampilkan daftar kosong. Contoh:
zip()  # == []
zip([1, 2])  # == [(1,), (2,)]
zip([1, 2], [3, 4])  # == [(1, 3), (2, 4)]
zip([1, 2], [3, 4, 5])  # == [(1, 3), (2, 4)]

Parameter

Parameter Deskripsi
args required
daftar ke ZIP.