Global

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

Anggota

semua

bool all(elements)

Menampilkan true jika semua elemen bernilai True atau jika koleksi kosong. Elemen dikonversi ke 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 untuk diterapkan pada dependensi aturan pengujian analisis. Transisi ini hanya dapat diterapkan pada atribut aturan dengan analysis_test = True. Kemampuan aturan tersebut dibatasi (misalnya, ukuran hierarki dependensinya terbatas), sehingga transisi yang dibuat menggunakan fungsi ini memiliki cakupan potensial yang terbatas jika dibandingkan dengan transisi yang dibuat menggunakan transisi.

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

Parameter

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

apa pun

bool any(elements)

Menampilkan true jika setidaknya satu elemen bernilai True. Elemen dikonversi ke 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. Perintah ini hanya dapat digunakan oleh modul root; dengan kata lain, jika sebuah modul menetapkan penggantian apa pun, ia tidak dapat digunakan sebagai dependensi oleh orang lain.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
urls string; or Iterable of strings; wajib
URL arsip; dapat berupa URL http(s):// atau file://.
integrity default = ''
Checksum file arsip yang diharapkan, 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 patch file untuk diterapkan ke modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam 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 dengan 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 detail selengkapnya.

Parameter

Parameter Deskripsi
implementation diperlukan
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 sequence of strings; default = []
Daftar nama atribut. Aspek menyebar di sepanjang dependensi yang ditentukan dalam atribut target dengan nama ini. Nilai umum di sini mencakup deps dan exports. Daftar ini juga dapat berisi satu string "*" untuk diterapkan di sepanjang semua dependensi target.
attrs dict; or None; default = Tidak ada
Kamus yang mendeklarasikan semua atribut aspek. Atribut ini memetakan dari nama atribut ke objek atribut, seperti `attr.label` atau `attr.string` (lihat modul attr). Atribut aspek tersedia untuk fungsi penerapan sebagai kolom parameter ctx.

Atribut implisit yang dimulai dengan _ harus memiliki nilai default, dan memiliki jenis label atau label_list.

Atribut eksplisit harus memiliki jenis string, dan harus menggunakan pembatasan values. Atribut eksplisit membatasi aspek agar hanya digunakan pada aturan yang memiliki atribut dengan nama, jenis, dan nilai valid yang sama sesuai dengan batasan tersebut.

required_providers default = []
Atribut ini memungkinkan aspek membatasi penerapannya hanya ke target yang aturannya mengiklankan penyedia yang diperlukan. Nilai harus berupa daftar yang berisi penyedia individual atau daftar penyedia, tetapi tidak keduanya. Misalnya, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] adalah nilai yang valid sedangkan [FooInfo, BarInfo, [BazInfo, QuxInfo]] adalah nilai yang tidak valid.

Daftar penyedia tidak bertingkat akan otomatis dikonversi menjadi daftar yang berisi satu daftar penyedia. Artinya, [FooInfo, BarInfo] akan otomatis dikonversi menjadi [[FooInfo, BarInfo]].

Untuk membuat beberapa target aturan (mis. some_rule) terlihat pada suatu aspek, some_rule harus mengiklankan semua penyedia dari setidaknya salah satu daftar penyedia wajib. Misalnya, jika required_providers dari 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 lainnya. Nilai harus berupa daftar yang berisi penyedia individual atau daftar penyedia, tetapi tidak keduanya. Misalnya, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] adalah nilai yang valid sedangkan [FooInfo, BarInfo, [BazInfo, QuxInfo]] adalah nilai yang tidak valid.

Daftar penyedia tidak bertingkat akan otomatis dikonversi menjadi daftar yang berisi satu daftar penyedia. Artinya, [FooInfo, BarInfo] akan otomatis dikonversi menjadi [[FooInfo, BarInfo]].

Untuk membuat aspek lain (misalnya, other_aspect) terlihat pada aspek ini, other_aspect harus menyediakan semua penyedia dari setidaknya salah satu daftar. Pada 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 implementasi.

Akan terjadi error jika fungsi implementasi menghilangkan jenis penyedia apa pun yang tercantum di sini dari nilai yang ditampilkan. 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 string-nya.

requires sequence of Aspects; default = []
Daftar aspek yang perlu diterapkan 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 disetel, set toolchain yang diperlukan aturan ini. Daftar ini 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 lagi digunakan dan harus dihapus.
doc default = ''
Deskripsi aspek yang dapat diekstrak dengan alat pembuat dokumentasi.
apply_to_generating_rules default = False
Jika benar, aspek akan, saat diterapkan ke file output, akan diterapkan ke aturan penghasil file output.

Misalnya, anggaplah suatu aspek menyebarkan secara transitif melalui atribut `deps` dan diterapkan ke target `alpha`. Misalkan `alpha` memiliki `deps = [':beta_output']`, dengan `beta_output` adalah output yang dideklarasikan dari `beta` target. Misalkan `beta` memiliki target `charlie` sebagai salah satu `charlie` targetnya, maka jika `apply_to_wireframe_rules=True itu akan menyebarkan aspek.

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

bazel_dep

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

Mendeklarasikan dependensi langsung pada modul Bazel lainnya.

Parameter

Parameter Deskripsi
name wajib
Nama modul yang akan ditambahkan sebagai dependensi langsung.
version default = ''
Versi modul yang akan ditambahkan sebagai dependensi langsung.
repo_name default = ''
Nama repo eksternal yang mewakili dependensi ini. Ini adalah nama modul secara default.
dev_dependency default = False
Jika true (benar), dependensi ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_Dependency` diaktifkan.

bind

None bind(name, actual=None)

Peringatan: penggunaan bind() tidak direkomendasikan. Lihat Mempertimbangkan penghapusan ikatan untuk diskusi panjang tentang masalah dan alternatifnya.

Memberi target alias dalam paket //external.

Parameter

Parameter Deskripsi
name wajib
Label di bawah '//external' berfungsi sebagai nama alias
actual string; or None; default = Tidak ada
Label asli yang akan diberi alias

bool

bool bool(x=False)

Konstruktor untuk jenis bool. Metode ini akan menampilkan False jika objek berupa None, False, string kosong (""), angka 0, atau koleksi kosong (misalnya (), []). Jika tidak, metode ini akan menampilkan True.

Parameter

Parameter Deskripsi
x default = False
Variabel yang akan dikonversi.

configuration_field

LateBoundDefault configuration_field(fragment, name)

Mereferensikan nilai default batas akhir untuk atribut jenis label. Nilai disebut 'late-bound' jika konfigurasi harus 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 implementasi aturan: 

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

Parameter

Parameter Deskripsi
fragment wajib
Nama fragmen konfigurasi yang berisi nilai batas akhir.
name wajib
Nama nilai yang akan diperoleh dari fragmen konfigurasi.

dependensi

depset depset(direct=None, order="default", *, transitive=None)

Membuat dependensi. Parameter direct adalah daftar elemen langsung dari dependensi yang dibuat, dan parameter transitive adalah daftar dependensi yang elemennya menjadi elemen tidak langsung dari dependensi yang dibuat. Urutan elemen yang ditampilkan saat dependensi dikonversi ke daftar ditentukan oleh parameter order. Lihat Ringkasan Depset untuk mengetahui informasi selengkapnya.

Semua elemen (langsung dan tidak langsung) dari dependensi harus berjenis sama, seperti yang diperoleh dengan ekspresi type(x).

Karena set berbasis hash digunakan untuk menghilangkan duplikat selama iterasi, semua elemen dependensi harus dapat di-hash. Namun, invarian tersebut saat 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 pada rilis mendatang; lihat Masalah 10313.

Selain itu, elemen saat ini harus tidak dapat diubah, meskipun pembatasan ini akan disesuaikan di masa mendatang.

Urutan dependensi yang dibuat harus kompatibel dengan urutan dependensi transitive-nya. Pesanan "default" kompatibel dengan pesanan lainnya, semua pesanan lainnya hanya kompatibel dengan pesanan itu sendiri.

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

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

Parameter

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

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

Parameter

Parameter Deskripsi
pairs default = []
dict, atau iterable yang elemennya masing-masing panjangnya 2 (kunci, nilai).
kwargs required
Kamus entri tambahan.

direktori

list dir(x)

Menampilkan daftar string: nama atribut dan metode objek parameter.

Parameter

Parameter Deskripsi
x wajib
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 urutan input
yang diperlukan.
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 untuk platform eksekusi tertentu selama penerapan aturan.

Parameter

Parameter Deskripsi
toolchains sequence; default = []
Kumpulan toolchain yang diperlukan grup eksekusi ini. Daftar ini 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 eksekutif ini akan mewarisi toolchain dan batasan aturan tempat grup ini dilampirkan. Jika disetel ke string lain, ini akan memunculkan error.

fail

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

Menyebabkan kegagalan eksekusi dengan menampilkan error.

Parameter

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

float

float float(x=unbound)

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

Parameter

Parameter Deskripsi
x default = tidak terikat
Nilai yang akan dikonversi.

Getattr

unknown getattr(x, name, default=unbound)

Menampilkan kolom struct dari nama yang diberikan jika ada. Jika tidak, kode ini akan menampilkan default (jika ditentukan) atau menyebabkan error. getattr(x, "foobar") setara dengan x.foobar.
getattr(ctx.attr, "myattr")
getattr(ctx.attr, "myattr", "mydefault")

Parameter

Parameter Deskripsi
x wajib
struct yang atributnya diakses.
name wajib
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 dari repositori Git. Perintah ini hanya dapat digunakan oleh modul root; dengan kata lain, jika sebuah modul menetapkan penggantian apa pun, ia tidak dapat digunakan sebagai dependensi oleh orang lain.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
remote wajib
URL repositori Git jarak jauh.
commit default = ''
Commit yang harus diperiksa.
patches Iterable of strings; default = []
Daftar label yang mengarah ke patch file untuk diterapkan ke modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam 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 dengan argumen --strip patch Unix.

Hasattr

bool hasattr(x, name)

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

Parameter

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

hash

int hash(value)

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

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 merupakan int, int akan menampilkannya tanpa perubahan.
  • Jika x adalah bool, int akan menampilkan 1 untuk Benar dan 0 untuk Salah.
  • Jika x berupa string, string tersebut harus memiliki format <sign><prefix><digits>. <sign> adalah "+", "-", atau kosong (diinterpretasikan sebagai positif). <digits> adalah urutan angka dari 0 hingga base - 1, dengan huruf a-z (atau setara, A-Z) digunakan sebagai angka untuk 10-35. Dalam kasus dengan base adalah 2/8/16, <prefix> bersifat opsional dan mungkin 0b/0o/0x (atau setara dengan 0B/0O/0X); jika base adalah nilai lain selain basis ini atau nilai khusus 0, awalan harus kosong. Dalam kasus di mana base adalah 0, string ditafsirkan sebagai literal bilangan bulat, dalam arti bahwa salah satu basis 2/8/10/16 dipilih bergantung pada awalan mana jika ada yang digunakan. Jika base adalah 0, tidak ada awalan yang digunakan, dan ada lebih dari satu digit, digit terdepan tidak boleh 0; ini untuk menghindari kebingungan antara oktal dan desimal. Besarnya angka yang diwakili oleh string harus berada dalam rentang yang diizinkan untuk jenis int.
  • Jika x adalah float, int akan menampilkan nilai bilangan bulat float, yang membulatkan ke nol. Akan dianggap error jika x tidak terbatas (NaN atau tak terhingga).
Fungsi ini 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 diperlukan
String yang akan dikonversi.
base default = tidak terikat
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), dikte, 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 pada disk lokal. Perintah ini hanya dapat digunakan oleh modul root; dengan kata lain, jika sebuah modul menetapkan penggantian apa pun, ia tidak dapat digunakan sebagai dependensi oleh orang lain.

Parameter

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

maks.

unknown max(*args)

Menampilkan argumen terbesar dari semua argumen yang diberikan. Jika hanya satu argumen yang disediakan, argumen tersebut harus berupa iterable yang tidak kosong.Akan terjadi error 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 argumen terkecil dari semua argumen yang diberikan. Jika hanya satu argumen yang disediakan, argumen tersebut harus berupa iterable yang tidak kosong. Akan terjadi error 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 merupakan metadata penting modul (seperti nama dan versi), atau memengaruhi perilaku modul saat ini dan turunannya.

Nama tersebut harus dipanggil paling banyak sekali. Itu dapat dihilangkan hanya jika modul ini adalah modul root (seperti pada, jika tidak akan bergantung pada modul lain).

Parameter

Parameter Deskripsi
name default = ''
Nama modul. Dapat dihilangkan hanya jika modul ini adalah modul root (seperti pada, 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 (seperti pada, jika tidak akan bergantung pada modul lain).
compatibility_level default = 0
Tingkat kompatibilitas modul; tingkat ini harus diubah setiap kali diperkenalkan perubahan besar yang tidak kompatibel. Ini pada dasarnya adalah "versi utama" modul dalam hal SemVer, kecuali bahwa modul ini tidak disematkan dalam string versi itu sendiri, tetapi ada sebagai kolom terpisah. Modul dengan tingkat kompatibilitas yang berbeda berpartisipasi dalam resolusi versi seolah-olah modul tersebut adalah modul dengan nama yang berbeda, tetapi grafik dependensi akhir tidak boleh berisi beberapa modul dengan nama yang sama tetapi dengan tingkat kompatibilitas yang berbeda (kecuali jika multiple_version_override berlaku; lihat di sana untuk detail selengkapnya).
repo_name default = ''
Nama repositori yang mewakili modul ini, seperti yang terlihat oleh modul itu sendiri. Secara default, nama repo adalah nama modul. Nama ini dapat ditentukan untuk memudahkan migrasi bagi project yang telah menggunakan nama repo untuk project itu sendiri yang berbeda dengan nama modulnya.
bazel_compatibility Iterable of strings; default = []
Daftar versi bazel yang memungkinkan pengguna mendeklarasikan versi Bazel mana yang kompatibel dengan modul ini. Ini TIDAK memengaruhi resolusi 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 oleh koma. Tiga batasan didukung: <=X.X.X: Versi Bazel harus sama atau lebih lama dari X.X.X. Digunakan saat ada perubahan yang tidak kompatibel yang diketahui 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='')

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

Parameter

Parameter Deskripsi
implementation required
Fungsi yang mengimplementasikan ekstensi modul ini. Harus mengambil satu parameter, module_ctx. Fungsi ini dipanggil satu kali di awal build untuk menentukan kumpulan repositori yang tersedia.
tag_classes default = {}
Kamus untuk mendeklarasikan semua class tag yang digunakan oleh ekstensi. Class ini memetakan dari nama class tag ke objek tag_class.
doc default = ''
Deskripsi ekstensi modul yang dapat diekstrak dengan alat pembuat dokumentasi.

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 berdampingan. Perintah ini hanya dapat digunakan oleh modul root; dengan kata lain, jika sebuah modul menetapkan penggantian apa pun, ia tidak dapat digunakan sebagai dependensi oleh orang lain.

Parameter

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

cetak

None print(sep=" ", *args)

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

Menggunakan print dalam kode produksi tidak disarankan karena spam yang dibuatnya untuk pengguna. Untuk penghentian penggunaan, pilih error yang sulit menggunakan fail() jika memungkinkan.

Parameter

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

penyedia

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

Mendefinisikan simbol penyedia. Penyedia dapat dibuat instance-nya dengan memanggilnya, atau digunakan langsung sebagai kunci untuk mengambil instance penyedia tersebut dari target. Contoh:
MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

Lihat Aturan (Penyedia) untuk mendapatkan panduan komprehensif tentang cara menggunakan penyedia.

Menampilkan nilai callable Provider jika init tidak ditentukan.

Jika init ditentukan, menampilkan tuple yang berisi 2 elemen: nilai callable Provider dan nilai callable 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 dengan alat pembuat dokumentasi.
fields sequence of strings; or dict; or None; default = Tidak ada
Jika ditentukan, akan membatasi kumpulan kolom yang diizinkan.
Kemungkinan nilainya 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 pra-pemrosesan dan memvalidasi nilai kolom penyedia selama pembuatan instance. Jika init ditentukan, provider() akan menampilkan tuple yang berisi 2 elemen: simbol penyedia normal dan konstruktor raw.

Berikut deskripsi persisnya; lihat Aturan (Inisialisasi kustom penyedia) untuk diskusi dan kasus penggunaan yang intuitif.

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

  • Jika args tidak kosong, akan terjadi error.
  • Jika parameter fields ditentukan saat provider() dipanggil, dan jika kwargs berisi kunci yang tidak tercantum dalam fields, error akan terjadi.
  • Jika tidak, c akan 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 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 init diharapkan berupa kamus, d, yang kuncinya adalah string nama kolom. Jika tidak, akan terjadi error.
  3. Instance P baru dibuat seolah-olah dengan memanggil konstruktor default dengan entri d sebagai argumen kata kunci, seperti dalam c(**d).

Catatan: 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 akan menggeneralisasi konstruksi penyedia normal dengan mengizinkan argumen posisi dan logika arbitrer untuk prapemrosesan dan validasi. Kebijakan ini tidak memungkinkan pengelakan daftar fields yang diizinkan.

Jika init ditentukan, nilai yang ditampilkan provider() menjadi (P, r) tuple, dengan r sebagai 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 = ...)

rentang

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

Membuat daftar tempat item berubah dari start ke stop, menggunakan kenaikan 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 wajib
Nilai elemen awal jika perhentian diberikan, jika tidak, nilai perhentian dan awal sebenarnya adalah 0
stop_or_none int; or None; default = Tidak ada
indeks opsional item pertama yang tidak disertakan dalam daftar yang dihasilkan; pembuatan daftar akan berhenti sebelum stop tercapai.
step default = 1
Penambahan (default adalah 1). Nilainya bisa negatif.

register_execution_platforms()

None register_execution_platforms(*platform_labels)

Daftarkan platform yang sudah ditentukan sehingga Bazel dapat menggunakannya sebagai platform eksekusi selama resolusi toolchain.

Parameter

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

register_execution_platforms()

None register_execution_platforms(*platform_labels)

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

Parameter

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

register_toolchains()

None register_toolchains(*toolchain_labels)

Daftarkan toolchain yang sudah ditetapkan sehingga Bazel dapat menggunakannya selama resolusi toolchain. Lihat contoh menentukan dan mendaftarkan toolchain.

Parameter

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

register_toolchains()

None register_toolchains(*toolchain_labels)

Menentukan toolchain yang sudah ditetapkan untuk didaftarkan saat modul ini dipilih. Harus berupa pola target absolut (yaitu dimulai dengan @ atau //). Lihat resolusi toolchain untuk informasi lebih lanjut.

Parameter

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

repositori_rule(implementasi, attrs, lokal, lingkungan, konfigurasi, remotable, doc)

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

Membuat aturan repositori baru. Simpan dalam nilai global agar dapat dimuat dan dipanggil dari file WORKSPACE.

Parameter

Parameter Deskripsi
implementation diperlukan
fungsi yang mengimplementasikan aturan ini. Harus memiliki satu parameter, repository_ctx. Fungsi ini dipanggil selama fase pemuatan untuk setiap instance aturan.
attrs dict; or None; default = Kamus
tidak ada untuk mendeklarasikan semua atribut aturan. Atribut 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 ke file (aturan repositori tidak dapat bergantung pada artefak yang dihasilkan). Atribut name ditambahkan secara implisit dan tidak boleh ditentukan.
local default = False
Tunjukkan bahwa aturan ini mengambil semua dari sistem lokal dan harus dievaluasi ulang setiap kali pengambilan.
environ sequence of strings; default = []
Memberikan daftar variabel lingkungan yang menjadi dependensi 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 = Salah
Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah setiap saat. Jangan bergantung pada hal itu. Fitur ini dapat diaktifkan secara eksperimental dengan menetapkan ---experimental_repo_remote_exec
Kompatibel dengan eksekusi jarak jauh
doc default = ''
Deskripsi aturan repositori yang dapat diekstrak oleh alat pembuat dokumentasi.

repositori_rule(implementasi, attrs, lokal, lingkungan, konfigurasi, remotable, doc)

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

Membuat aturan repositori baru. Simpan dalam nilai global agar dapat dimuat dan dipanggil dari file WORKSPACE.

Parameter

Parameter Deskripsi
implementation diperlukan
fungsi yang mengimplementasikan aturan ini. Harus memiliki satu parameter, repository_ctx. Fungsi ini dipanggil selama fase pemuatan untuk setiap instance aturan.
attrs dict; or None; default = Kamus
tidak ada untuk mendeklarasikan semua atribut aturan. Atribut 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 ke file (aturan repositori tidak dapat bergantung pada artefak yang dihasilkan). Atribut name ditambahkan secara implisit dan tidak boleh ditentukan.
local default = False
Tunjukkan bahwa aturan ini mengambil semua dari sistem lokal dan harus dievaluasi ulang setiap kali pengambilan.
environ sequence of strings; default = []
Memberikan daftar variabel lingkungan yang menjadi dependensi 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 = Salah
Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah setiap saat. Jangan bergantung pada hal itu. Fitur ini dapat diaktifkan secara eksperimental dengan menetapkan ---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 diperlukan
Objek yang akan dikonversi.

terbalik

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 diperlukan
Urutan iterable (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 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 satu parameter: ctx. Fungsi ini dipanggil selama fase analisis untuk setiap instance aturan. Dapat mengakses atribut yang diberikan oleh pengguna. Aplikasi harus membuat tindakan untuk menghasilkan semua output yang dideklarasikan.
test default = False
Apakah aturan ini merupakan aturan pengujian, artinya, apakah aturan tersebut mungkin menjadi subjek perintah blaze test. Semua aturan pengujian secara otomatis dianggap dapat dieksekusi; aturan pengujian tidak diperlukan (dan tidak disarankan) untuk secara eksplisit menetapkan executable = True. Lihat halaman Aturan untuk informasi selengkapnya.
attrs dict; or None; default = Kamus
tidak ada untuk mendeklarasikan semua atribut aturan. Atribut 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 sedikit atribut. Untuk membatasi penggunaan memori, fungsi aturan memberlakukan batas pada ukuran atr.
outputs dict; or None; or function; default = Tidak ada
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Jangan bergantung pada hal itu. Fungsi ini dinonaktifkan dengan ---incompatible_no_rule_outputs_param. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera dilakukan.
Parameter ini tidak digunakan lagi. Migrasikan aturan agar menggunakan OutputGroupInfo atau attr.output sebagai gantinya.

Skema untuk menentukan output yang 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 dipradeklarasikan.

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. Apakah kamus ditentukan secara langsung atau melalui suatu fungsi, kamus akan ditafsirkan sebagai berikut.

Setiap entri dalam kamus membuat output yang dideklarasikan sebelumnya dengan kuncinya adalah ID dan nilainya adalah template string yang menentukan label output. Dalam fungsi implementasi aturan, ID menjadi nama kolom yang digunakan untuk mengakses File output di ctx.outputs. Label output memiliki paket yang sama seperti aturan, dan bagian setelah paket dihasilkan dengan mengganti setiap placeholder formulir "%{ATTR}" dengan string yang dibentuk dari nilai atribut ATTR:

  • Atribut tipe string diganti kata demi kata.
  • Atribut jenis label menjadi bagian label setelah paket, tanpa ekstensi file. Misalnya, label "//pkg:a/b.c" menjadi "a/b".
  • Atribut jenis output menjadi bagian label setelah paket, termasuk ekstensi file (untuk contoh di atas, "a/b.c").
  • Semua atribut dengan jenis daftar (misalnya, attr.label_list) yang digunakan dalam placeholder harus memiliki hanya 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 substitusi yang paling umum adalah "%{name}". Misalnya, untuk target bernama "foo", output dict {"bin": "%{name}.exe"} akan mendeklarasikan sebelumnya output bernama foo.exe yang dapat diakses dalam fungsi implementasi sebagai ctx.outputs.bin.

executable default = False
Apakah aturan ini dianggap dapat dieksekusi, yaitu, apakah aturan ini mungkin menjadi subjek perintah blaze run. Lihat halaman Aturan untuk informasi selengkapnya.
output_to_genfiles default = False
Jika true, file akan dibuat di direktori genfiles, bukan di 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 diwajibkan oleh aturan dalam konfigurasi target.
host_fragments sequence of strings; default = []
Daftar nama fragmen konfigurasi yang diwajibkan oleh aturan dalam konfigurasi host.
_skylark_testable default = False
(Eksperimental)

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

Perintah ini hanya boleh digunakan untuk menguji perilaku waktu analisis aturan Starlark. Tanda ini dapat dihapus pada masa mendatang.
toolchains sequence; default = []
Jika disetel, set toolchain yang diperlukan aturan ini. Daftar ini 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 lagi digunakan dan harus dihapus.
doc default = ''
Deskripsi aturan yang dapat diekstrak dengan alat pembuat dokumentasi.
provides default = []
Daftar penyedia yang harus ditampilkan oleh fungsi implementasi.

Akan terjadi error jika fungsi implementasi menghilangkan jenis penyedia apa pun yang tercantum di sini dari nilai yang ditampilkan. 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 string-nya.

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 akan diperlakukan sebagai pengujian analisis.

Catatan: Aturan pengujian analisis pada dasarnya ditentukan menggunakan infrastruktur yang disediakan di library Starlark inti. Lihat Pengujian untuk panduan.

Jika ditetapkan sebagai aturan pengujian analisis, aturan diizinkan untuk menggunakan transisi konfigurasi yang ditetapkan menggunakan analysis_test_transition pada atributnya, tetapi memilih beberapa batasan:

  • Target aturan ini memiliki batas jumlah dependensi transitif yang mungkin dimilikinya.
  • Aturan ini dianggap sebagai aturan pengujian (seolah-olah test=True telah ditetapkan). Ini menggantikan nilai test
  • Fungsi penerapan aturan mungkin tidak mendaftarkan tindakan. Sebagai gantinya, aplikasi harus mendaftarkan hasil lulus/gagal dengan memberikan AnalysisTestResultInfo.
build_setting BuildSetting; or None; default = Tidak ada
Jika ditetapkan, menjelaskan jenis build setting aturan ini. Lihat modul config. Jika kebijakan ini ditetapkan, atribut wajib bernama "build_setting_default" akan ditambahkan secara otomatis ke aturan ini, dengan jenis yang sesuai dengan nilai yang diteruskan di sini.
cfg default = Tidak ada
Jika ditetapkan, akan mengarah ke transisi konfigurasi, aturan akan diterapkan ke konfigurasinya sendiri sebelum analisis.
exec_groups dict; or None; default = Tidak ada
Dict nama grup eksekusi (string) ke exec_groups. Jika ditetapkan, aturan dapat menjalankan tindakan di beberapa platform eksekusi dalam satu target. Lihat dokumentasi grup eksekusi untuk info selengkapnya.
compile_one_filetype sequence of strings; or None; default = Tidak ada
Digunakan oleh --compile_one_Dependencies: jika beberapa aturan menggunakan file yang ditentukan, apakah kita harus memilih aturan ini daripada aturan yang lain.
name string; or None; default = Tidak ada
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Jangan bergantung pada hal itu. Fungsi ini dinonaktifkan dengan --+incompatible_remove_rule_name_parameter. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera dilakukan.
Tidak digunakan lagi: tidak digunakan.

Nama aturan ini, seperti yang 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 dibuat instance-nya dalam file BUILD sebagai foo_library(...).

Jika parameter ini dihilangkan, nama aturan akan ditetapkan ke nama variabel global Starlark pertama yang akan terikat ke aturan ini dalam modul deklarasi .bzl. Dengan demikian, foo_library = rule(...) tidak perlu menentukan parameter ini jika namanya adalah foo_library.

Menetapkan 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 ensiklopedia build untuk mengetahui detailnya.

Parameter

Parameter Deskripsi
x required
dict yang memetakan kondisi konfigurasi ke nilai. Setiap kunci adalah Label atau string label yang mengidentifikasi instance config_setting atau constraint_value. Lihat dokumentasi tentang makro untuk mengetahui kapan harus menggunakan Label, bukan string.
no_match_error default = ''
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 yang diterapkan. Perintah ini hanya dapat digunakan oleh modul root; dengan kata lain, jika sebuah modul menetapkan penggantian apa pun, ia tidak dapat digunakan sebagai dependensi oleh orang lain.

Parameter

Parameter Deskripsi
module_name wajib
Nama dependensi modul Bazel tempat penggantian ini diterapkan.
version default = ''
Mengganti versi yang dideklarasikan dari modul ini dalam grafik dependensi. Dengan kata lain, modul ini akan "disematkan" ke versi penggantian ini. Atribut ini dapat dihilangkan jika semua yang ingin diganti adalah registry atau patch.
registry default = ''
Mengganti registry untuk modul ini; alih-alih menemukan modul ini dari daftar default registry, registry yang ditentukan harus digunakan.
patches Iterable of strings; default = []
Daftar label yang mengarah ke patch file untuk diterapkan ke modul ini. File patch harus ada di hierarki sumber project tingkat atas. Kolom tersebut diterapkan dalam 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 dengan argumen --strip patch Unix.

diurutkan

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

Menampilkan daftar baru yang diurutkan yang berisi semua elemen dari urutan iterable yang diberikan. Kesalahan dapat terjadi jika ada pasangan elemen x dan y yang tidak dapat dibandingkan menggunakan x < y. Elemen diurutkan dalam urutan menaik, kecuali jika argumen terbalik bernilai Benar (True), urutannya menurun. Penyortiran bersifat stabil: elemen yang membandingkan 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
Tampilkan 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 diperlukan
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. Atribut ini memetakan dari nama atribut ke objek atribut (lihat modul attr).
doc default = ''
Deskripsi class tag yang dapat diekstrak dengan 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.

tipe

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 mungkin berubah di masa mendatang. Agar dapat menulis kode yang kompatibel dengan Python dan siap menghadapi masa depan, gunakan kode ini hanya untuk membandingkan nilai yang ditampilkan: 
if type(x) == type([]):  # if x is a list

Parameter

Parameter Deskripsi
x wajib
Objek yang akan diperiksa jenisnya.

use_extension

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

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

Parameter

Parameter Deskripsi
extension_bzl_file diperlukan
Label ke file Starlark yang menentukan ekstensi modul.
extension_name wajib
Nama ekstensi modul yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark.
dev_dependency default = False
Jika true (benar), penggunaan ekstensi modul ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_Dependency` diaktifkan.

use_repo

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

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

Parameter

Parameter Deskripsi
extension_proxy wajib
Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension.
args wajib
Nama repositori yang akan diimpor.
kwargs wajib
Menentukan repositori tertentu yang akan diimpor ke dalam cakupan modul saat ini dengan nama yang berbeda. Kunci 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)

Menyetel visibilitas pemuatan modul .bzl yang sedang diinisialisasi.

Visibilitas beban modul mengatur apakah file BUILD dan .bzl lain dapat memuatnya atau tidak. (Hal ini berbeda dengan visibilitas target file sumber .bzl pokok, yang mengatur apakah file dapat muncul sebagai dependensi target lain atau tidak.) Visibilitas pemuatan berfungsi pada tingkat paket: Untuk memuat modul, file yang melakukan pemuatan harus aktif 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 pada level teratas, bukan di dalam fungsi. Gaya yang direkomendasikan adalah menempatkan panggilan ini tepat di bawah pernyataan load() dan logika singkat yang diperlukan untuk menentukan argumen.

Jika tanda --check_bzl_visibility disetel ke salah (false), pelanggaran visibilitas pemuatan akan memberikan peringatan, tetapi tidak akan menggagalkan build.

Parameter

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

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

  • "//foo": paket //foo
  • "//foo/...": paket //foo dan semua sub-paketnya.
  • "public" atau "private": masing-masing paket atau tanpa paket

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

Jika value berupa daftar string, kumpulan paket yang diberi visibilitas ke modul ini adalah gabungan paket yang direpresentasikan oleh setiap spesifikasi. (Daftar kosong memiliki efek yang sama dengan private.) Jika value adalah string tunggal, string tersebut akan 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 dalam 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.

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

Nama ini digunakan untuk direktori tempat runfile repositori disimpan. Misalnya, jika ada runfile foo/bar di repositori lokal dan file WORKSPACE berisi workspace(name = 'baz'), runfile akan tersedia di bagian mytarget.runfiles/baz/foo/bar. Jika tidak ada nama ruang kerja yang ditentukan, runfile akan di-symlink 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 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 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 argumen atau iterable. Daftar ini memiliki ukuran input terpendek. Dengan satu argumen iterable, 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 daftar
yang diperlukan ke zip.