File MODULE.bazel

Laporkan masalahopen_in_new

Halaman ini berisi metode global yang tersedia dalam file MODULE.bazel.

Anggota

• pengarsipan_pengarsipan
• bazel_dep
• git_ganti
• local_path_override
• modul
• penggantian_beberapa_versi
• register_eksekusi_platform
• register_Toolchain
• penggantian_versi tunggal
• use_extension
• penggunaan_repo

arsip_ganti

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 modul menentukan penggantian apa pun, modul tersebut tidak dapat digunakan sebagai dependensi oleh pihak lain.

Parameter

Parameter	Deskripsi
module_name	wajib Nama dependensi modul Bazel untuk menerapkan penggantian ini.
urls	string; or Iterable of strings; diperlukan URL arsip; dapat berupa URL http(s):// atau file://.
integrity	default = '' Checksum yang diharapkan dari file arsip, dalam format Integritas Subresource.
strip_prefix	default = '' Awalan direktori untuk menghapus file yang diekstrak.
patches	Iterable of strings; default = [] Daftar label yang mengarah ke file patch untuk diterapkan pada modul ini. File patch harus ada di hierarki sumber project tingkat atas. Aturan 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 dari patch Unix.

ba__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, dependensi ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependensi` diaktifkan.

git_ganti

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 modul menentukan penggantian apa pun, modul tersebut tidak dapat digunakan sebagai dependensi oleh pihak lain.

Parameter

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

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 modul menentukan penggantian apa pun, modul tersebut tidak dapat digunakan sebagai dependensi oleh pihak lain.

Parameter

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

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

Fungsi ini harus dipanggil maksimal sekali. Modul ini dapat dihilangkan hanya jika modul ini merupakan modul root (seperti pada modul, jika tidak akan bergantung oleh modul lain).

Parameter

Parameter	Deskripsi
name	default = '' Nama modul. Hanya dapat dihilangkan jika modul ini adalah modul root (seperti dalam modul, jika tidak akan bergantung oleh modul lain). Nama modul yang valid harus: 1) hanya berisi huruf kecil (a-z), angka (0-9), titik (.), tanda hubung (-), dan garis bawah (_); 2) dimulai dengan huruf kecil; 3) diakhiri dengan huruf kecil atau angka.
version	default = '' Versi modul. Hanya dapat dihilangkan jika modul ini adalah modul root (seperti dalam modul, jika tidak akan bergantung oleh modul lain). Versi harus dalam format SemVer yang santai; lihat dokumentasi untuk detail selengkapnya.
compatibility_level	default = 0 Tingkat kompatibilitas modul; ini harus diubah setiap kali perubahan besar yang tidak kompatibel diperkenalkan. Pada dasarnya, ini 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 berbeda berpartisipasi dalam resolusi versi seolah-olah merupakan modul dengan nama berbeda, tetapi grafik dependensi akhir tidak dapat berisi beberapa modul dengan nama yang sama tetapi tingkat kompatibilitasnya berbeda (kecuali jika multiple_version_override berlaku). Lihat dokumentasi 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. Hal ini dapat ditentukan untuk memudahkan migrasi bagi project yang telah menggunakan nama repo untuk project itu sendiri yang berbeda dari 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 beberapa nilai batasan yang dipisahkan koma. Ada tiga batasan yang didukung: <=X.X.X: Versi Bazel harus sama atau lebih lama dari X.X.X. Digunakan saat ada perubahan yang tidak kompatibel dan diketahui di 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.

beberapa_versi_ganti

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

Menentukan bahwa dependensi harus tetap berasal dari registry, tetapi beberapa versi dependensi tersebut harus diizinkan untuk berdampingan. Lihat dokumentasi untuk detail selengkapnya. Perintah ini hanya dapat digunakan oleh modul root. Dengan kata lain, jika modul menentukan penggantian apa pun, modul tersebut tidak dapat digunakan sebagai dependensi oleh pihak lain.

Parameter

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

platform_eksekusi_eksekusi

None register_execution_platforms(*platform_labels)

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

Parameter

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

register_Toolchain

None register_toolchains(*toolchain_labels)

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

Parameter

Parameter	Deskripsi
toolchain_labels	sequence of strings; diperlukan Label toolchain untuk didaftarkan.

versi_penggantian tunggal

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 modul menentukan penggantian apa pun, modul tersebut tidak dapat digunakan sebagai dependensi oleh pihak lain.

Parameter

Parameter	Deskripsi
module_name	wajib Nama dependensi modul Bazel untuk menerapkan penggantian ini.
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 mengganti adalah registry atau patch.
registry	default = '' Mengganti registry untuk modul ini. Daripada menemukan modul ini dari daftar registry default, registry yang ditentukan harus digunakan.
patches	Iterable of strings; default = [] Daftar label yang mengarah ke file patch untuk diterapkan pada modul ini. File patch harus ada di hierarki sumber project tingkat atas. Aturan 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 dari patch Unix.

use_ekstensi

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

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

Parameter

Parameter	Deskripsi
extension_bzl_file	wajib 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_dependensi` diaktifkan.

gunakan_repo

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

Mengimpor satu atau beberapa repo yang dihasilkan 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 repo yang akan diimpor.
kwargs	wajib Menentukan repo tertentu yang akan diimpor ke dalam cakupan modul saat ini dengan nama yang berbeda. Kunci harus berupa nama yang digunakan dalam cakupan saat ini, sedangkan nilai harus berupa nama asli yang diekspor oleh ekstensi modul.