Metode yang tersedia di file MODULE.bazel.
Anggota
- archive_override
- bazel_dep
- git_override
- include
- inject_repo
- local_path_override
- module
- multiple_version_override
- override_repo
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
archive_override
None
archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)
Parameter
Parameter | Deskripsi |
---|---|
module_name
|
required Nama dependensi modul Bazel yang akan menerapkan penggantian ini. |
urls
|
string; atau Iterable dari string;
wajib URL arsip; dapat berupa URL http(s):// atau file://. |
integrity
|
default adalah '' Checksum yang diharapkan dari file arsip, dalam format Subresource Integrity. |
strip_prefix
|
default adalah '' Awalan direktori yang akan dihapus dari file yang diekstrak. |
patches
|
Iterable string;
default adalah [] Daftar label yang mengarah ke file patch yang akan diterapkan untuk modul ini. File patch harus ada di hierarki sumber project level teratas. Aturan tersebut diterapkan sesuai urutan daftar. |
patch_cmds
|
Iterable string;
default adalah [] Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan. |
patch_strip
|
defaultnya adalah 0 Sama dengan --strip argumen patch Unix. |
bazel_dep
None
bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)
Parameter
Parameter | Deskripsi |
---|---|
name
|
required Nama modul yang akan ditambahkan sebagai dependensi langsung. |
version
|
default adalah '' Versi modul yang akan ditambahkan sebagai dependensi langsung. |
max_compatibility_level
|
default adalah -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 adalah '' Nama repo eksternal yang mewakili dependensi ini. Secara default, ini adalah nama modul. |
dev_dependency
|
default adalah False Jika benar, dependensi ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan. |
git_override
None
git_override(module_name, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')
Parameter
Parameter | Deskripsi |
---|---|
module_name
|
required Nama dependensi modul Bazel yang akan menerapkan penggantian ini. |
remote
|
required URL repositori Git jarak jauh. |
commit
|
default adalah '' Commit yang harus di-check out. |
patches
|
Iterable string;
defaultnya adalah [] Daftar label yang mengarah ke file patch yang akan diterapkan ke modul ini. File patch harus ada di hierarki sumber project level teratas. Aturan tersebut diterapkan sesuai urutan daftar. |
patch_cmds
|
Iterable string;
defaultnya adalah [] Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan. |
patch_strip
|
defaultnya adalah 0 Sama dengan --strip argumen patch Unix. |
init_submodules
|
defaultnya adalah False Apakah submodul git di repo yang diambil harus diinisialisasi secara rekursif. |
strip_prefix
|
defaultnya adalah '' Awalan direktori yang akan dihapus dari file yang diekstrak. Ini dapat digunakan untuk menargetkan subdirektori repo git. Perhatikan bahwa subdirektori harus memiliki file `MODULE.bazel` sendiri dengan nama modul yang sama dengan argumen `module_name` yang diteruskan ke `git_override` ini. |
sertakan
None
include(label)
include()
berperilaku seolah-olah file yang disertakan ditempatkan secara tekstual di lokasi panggilan include()
, kecuali bahwa binding variabel (seperti yang digunakan untuk use_extension
) hanya terlihat dalam file tempatnya terjadi, bukan dalam file yang disertakan atau menyertakan.Hanya modul root yang dapat menggunakan include()
; akan terjadi error jika file MODULE bazel_dep
menggunakan include()
.
Hanya file di repo utama yang dapat disertakan.
include()
memungkinkan Anda menyegmentasikan file modul root menjadi beberapa bagian, untuk menghindari file MODULE.bazel yang sangat besar atau untuk mengelola kontrol akses dengan lebih baik untuk setiap segmen semantik.
Parameter
Parameter | Deskripsi |
---|---|
label
|
required Label yang mengarah ke file yang akan disertakan. Label harus mengarah ke file dalam repo utama; dengan kata lain, label harus diawali dengan garis miring ganda ( // ).
|
inject_repo
None
inject_repo(extension_proxy, *args, **kwargs)
Sebagai gantinya, gunakan override_repo
untuk mengganti
repo yang ada.
Parameter
Parameter | Deskripsi |
---|---|
extension_proxy
|
diperlukan Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension .
|
args
|
required Repositori yang terlihat oleh modul saat ini yang harus dimasukkan ke dalam ekstensi dengan nama yang sama. |
kwargs
|
required Repositori baru yang akan dimasukkan ke dalam ekstensi, dengan nilai berupa nama repositori dalam cakupan modul saat ini dan kunci adalah nama yang akan terlihat dalam ekstensi. |
local_path_override
None
local_path_override(module_name, path)
Parameter
Parameter | Deskripsi |
---|---|
module_name
|
required Nama dependensi modul Bazel yang akan menerapkan penggantian ini. |
path
|
required Jalur ke direktori tempat modul ini berada. |
modul
None
module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])
Fungsi ini harus dipanggil maksimal sekali, dan jika dipanggil, harus menjadi perintah pertama dalam file MODULE.bazel. Ini hanya dapat dihilangkan jika modul ini adalah modul root (yaitu, jika tidak akan bergantung pada modul lain).
Parameter
Parameter | Deskripsi |
---|---|
name
|
default adalah '' Nama modul. Hanya dapat dihilangkan jika modul ini adalah modul root (yaitu, jika tidak akan menjadi dependensi 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-nya adalah '' Versi modul. Hanya dapat dihilangkan jika modul ini adalah modul root (yaitu, jika tidak akan menjadi dependensi modul lain). Versi harus dalam format SemVer yang longgar; lihat dokumentasi untuk mengetahui detail selengkapnya. |
compatibility_level
|
default adalah 0 Tingkat kompatibilitas modul; ini harus diubah setiap kali perubahan besar yang tidak kompatibel diperkenalkan. Ini pada dasarnya 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 resolusi versi seolah-olah merupakan modul dengan nama yang berbeda, tetapi grafik dependensi akhir tidak boleh berisi beberapa modul dengan nama yang sama, tetapi tingkat kompatibilitasnya berbeda (kecuali jika multiple_version_override diberlakukan). Lihat dokumentasi untuk mengetahui detail selengkapnya.
|
repo_name
|
default adalah '' Nama repositori yang mewakili modul ini, seperti yang dilihat 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 dirinya sendiri yang berbeda dengan nama modulnya. |
bazel_compatibility
|
Iterable string;
default adalah [] Daftar versi bazel yang memungkinkan pengguna mendeklarasikan versi Bazel yang kompatibel dengan modul ini. Tindakan 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 koma. Tiga batasan didukung: <=X.X.X: Versi Bazel harus sama dengan atau lebih lama dari X.X.X. Digunakan jika ada perubahan yang diketahui tidak kompatibel dalam versi yang lebih baru. >=X.X.X: Versi Bazel harus sama dengan 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 jika ada bug di X.X.X yang menyebabkan error, tetapi diperbaiki di versi yang lebih baru. |
multiple_version_override
None
multiple_version_override(module_name, versions, registry='')
Parameter
Parameter | Deskripsi |
---|---|
module_name
|
required Nama dependensi modul Bazel yang akan menerapkan penggantian ini. |
versions
|
Iterable string;
required Secara eksplisit menentukan versi yang diizinkan untuk berdampingan. Versi ini harus sudah ada di pra-pemilihan grafik dependensi. Dependensi pada modul ini akan "diupgrade" ke versi terdekat yang diizinkan dan lebih tinggi 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 adalah '' Mengganti registry untuk modul ini; bukan menemukan modul ini dari daftar registry default, registry yang diberikan harus digunakan. |
override_repo
None
override_repo(extension_proxy, *args, **kwargs)
Sebagai gantinya, gunakan inject_repo
untuk menambahkan repo baru.
Parameter
Parameter | Deskripsi |
---|---|
extension_proxy
|
required Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension .
|
args
|
required Repositori di ekstensi yang harus diganti dengan repositori dengan nama yang sama di modul saat ini. |
kwargs
|
required Penggantian diterapkan ke repositori yang dihasilkan oleh ekstensi, dengan nilainya adalah nama repositori dalam cakupan modul saat ini dan kunci adalah nama repo yang akan diganti dalam ekstensi. |
register_execution_platforms
None
register_execution_platforms(dev_dependency=False, *platform_labels)
@
atau //
). Lihat resolusi toolchain untuk mengetahui informasi selengkapnya.
Parameter
Parameter | Deskripsi |
---|---|
dev_dependency
|
defaultnya adalah False Jika benar, platform eksekusi tidak akan didaftarkan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan. |
platform_labels
|
urutan string;
wajib Label platform yang akan didaftarkan. |
register_toolchains
None
register_toolchains(dev_dependency=False, *toolchain_labels)
@
atau //
). Lihat resolusi toolchain untuk mengetahui informasi selengkapnya.
Parameter
Parameter | Deskripsi |
---|---|
dev_dependency
|
defaultnya adalah False Jika true (benar), toolchain tidak akan didaftarkan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan. |
toolchain_labels
|
urutan string;
wajib Label toolchain yang akan didaftarkan. Label dapat menyertakan :all . Dalam hal ini, semua target penyediaan toolchain dalam paket akan didaftarkan dalam urutan leksikografis berdasarkan nama.
|
single_version_override
None
single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)
Parameter
Parameter | Deskripsi |
---|---|
module_name
|
required Nama dependensi modul Bazel yang akan menerapkan penggantian ini. |
version
|
defaultnya adalah '' Mengganti versi yang dideklarasikan modul ini dalam grafik dependensi. Dengan kata lain, modul ini akan "disematkan" ke versi penggantian ini. Atribut ini dapat dihilangkan jika yang ingin diganti hanyalah registry atau patch. |
registry
|
default adalah '' Mengganti registry untuk modul ini; bukan menemukan modul ini dari daftar registry default, registry yang diberikan harus digunakan. |
patches
|
Iterable string;
default adalah [] Daftar label yang mengarah ke file patch yang akan diterapkan untuk modul ini. File patch harus ada di hierarki sumber project level teratas. Aturan tersebut diterapkan sesuai urutan daftar. Jika patch membuat perubahan pada file MODULE.bazel, perubahan ini hanya akan efektif jika file patch disediakan oleh modul root. |
patch_cmds
|
Iterable string;
default adalah [] Urutan perintah Bash yang akan diterapkan di Linux/Macos setelah patch diterapkan. Perubahan pada file MODULE.bazel tidak akan efektif. |
patch_strip
|
default adalah 0 Sama dengan argumen --strip dari patch Unix. |
use_extension
module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)
Parameter
Parameter | Deskripsi |
---|---|
extension_bzl_file
|
required Label ke file Starlark yang menentukan ekstensi modul. |
extension_name
|
required Nama ekstensi modul yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark. |
dev_dependency
|
default adalah False Jika true, penggunaan ekstensi modul ini akan diabaikan jika modul saat ini bukan modul root atau `--ignore_dev_dependency` diaktifkan. |
isolate
|
default-nya adalah False Eksperimental. Parameter ini bersifat eksperimental dan dapat berubah sewaktu-waktu. Jangan bergantung pada hal ini. Fitur ini dapat diaktifkan secara eksperimental dengan menyetel ---experimental_isolated_extension_usages Jika benar, penggunaan ekstensi modul ini akan diisolasi dari semua penggunaan lain, baik dalam 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 dengan semua repositori lain yang dihasilkan oleh ekstensi. Parameter ini saat ini bersifat eksperimental dan hanya tersedia dengan tanda |
use_repo
None
use_repo(extension_proxy, *args, **kwargs)
Parameter
Parameter | Deskripsi |
---|---|
extension_proxy
|
required Objek proxy ekstensi modul yang ditampilkan oleh panggilan use_extension .
|
args
|
required Nama repo yang akan diimpor. |
kwargs
|
required Menentukan repo tertentu untuk diimpor ke dalam cakupan modul saat ini dengan nama yang berbeda. Kunci harus berupa nama yang akan digunakan dalam cakupan saat ini, sedangkan nilai harus berupa nama asli yang diekspor oleh ekstensi modul. |
use_repo_rule
repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)
name
pada proxy. Atribut dev_dependency
Boolean implisit juga dapat digunakan pada proxy untuk menunjukkan bahwa repo tertentu hanya akan dibuat ketika modul saat ini adalah modul root.
Parameter
Parameter | Deskripsi |
---|---|
repo_rule_bzl_file
|
required Label ke file Starlark yang menentukan aturan repo. |
repo_rule_name
|
required Nama aturan repo yang akan digunakan. Simbol dengan nama ini harus diekspor oleh file Starlark. |