Modul bawaan untuk mendukung aturan native dan fungsi bantuan paket lainnya. Semua aturan native muncul sebagai fungsi dalam modul ini, misalnya native.cc_library
. Perhatikan bahwa modul native hanya tersedia dalam fase pemuatan (yaitu untuk makro, bukan untuk penerapan aturan). Atribut akan mengabaikan nilai None
, dan memperlakukannya seolah-olah atribut tidak ditetapkan.
Fungsi berikut juga tersedia:
Anggota
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- subpaket
existing_rule
unknown native.existing_rule(name)
None
jika tidak ada instance aturan dengan nama tersebut.Di sini, objek seperti dict yang tidak dapat diubah berarti objek x
yang tidak dapat diubah secara mendalam yang mendukung iterasi seperti dict, len(x)
, name in x
, x[name]
, x.get(name)
, x.items()
, x.keys()
, dan x.values()
.
Hasilnya berisi entri untuk setiap atribut, dengan pengecualian atribut pribadi (yang namanya tidak diawali dengan huruf) dan beberapa jenis atribut lama yang tidak dapat direpresentasikan. Selain itu, kamus berisi entri untuk name
dan kind
instance aturan (misalnya, 'cc_binary'
).
Nilai hasil mewakili nilai atribut sebagai berikut:
- Atribut jenis str, int, dan bool direpresentasikan apa adanya.
- Label dikonversi menjadi string formulir
':foo'
untuk target dalam paket yang sama atau'//pkg:name'
untuk target dalam paket yang berbeda. - Daftar direpresentasikan sebagai tuple, dan kamus dikonversi menjadi kamus baru yang dapat diubah. Elemennya dikonversi secara rekursif dengan cara yang sama.
- Nilai
select
ditampilkan dengan kontennya yang diubah seperti yang dijelaskan di atas. - Atribut yang tidak memiliki nilai yang ditentukan selama pembuatan instance aturan dan nilai defaultnya dihitung akan dikecualikan dari hasil. (Default yang dihitung tidak dapat dihitung hingga fase analisis.).
Jika memungkinkan, gunakan fungsi ini hanya dalam fungsi implementasi makro simbolis finalisasi aturan. Penggunaan fungsi ini dalam konteks lain tidak direkomendasikan, dan akan dinonaktifkan dalam rilis Bazel mendatang; hal ini membuat file BUILD
rapuh dan bergantung pada urutan. Selain itu, perhatikan bahwa konversi ini sedikit berbeda dari dua konversi nilai atribut aturan lainnya dari bentuk internal ke Starlark: satu digunakan oleh default yang dihitung, yang lainnya digunakan oleh ctx.attr.foo
.
Parameter
Parameter | Deskripsi |
---|---|
name
|
string;
required Nama target. |
existing_rules
unknown native.existing_rules()
existing_rule(name)
.Di sini, objek seperti dict yang tidak dapat diubah berarti objek x
yang tidak dapat diubah secara mendalam yang mendukung iterasi seperti dict, len(x)
, name in x
, x[name]
, x.get(name)
, x.items()
, x.keys()
, dan x.values()
.
Jika memungkinkan, gunakan fungsi ini hanya dalam fungsi implementasi makro simbolis finalisasi aturan. Penggunaan fungsi ini dalam konteks lain tidak direkomendasikan dan akan dinonaktifkan dalam rilis Bazel mendatang; fungsi ini membuat file BUILD
rapuh dan bergantung pada urutan.
exports_files
None
native.exports_files(srcs, visibility=None, licenses=None)
Parameter
Parameter | Deskripsi |
---|---|
srcs
|
urutan string;
wajib Daftar file yang akan diekspor. |
visibility
|
sequence; atau None ;
defaultnya adalah None Pernyataan visibilitas dapat ditentukan. File akan terlihat oleh target yang ditentukan. Jika tidak ada visibilitas yang ditentukan, file akan terlihat oleh setiap paket. |
licenses
|
urutan string; atau None ;
defaultnya adalah None Lisensi yang akan ditentukan. |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)
- Mencocokkan setidaknya satu pola di
include
. - Tidak cocok dengan pola apa pun di
exclude
([]
default).
exclude_directories
diaktifkan (ditetapkan ke 1
), file jenis direktori akan dihilangkan dari hasil (1
default).
Parameter
Parameter | Deskripsi |
---|---|
include
|
urutan string;
default-nya adalah [] Daftar pola glob yang akan disertakan. |
exclude
|
urutan string;
default adalah [] Daftar pola glob yang akan dikecualikan. |
exclude_directories
|
int;
defaultnya adalah 1 Flag untuk mengecualikan direktori atau tidak. |
allow_empty
|
default adalah unbound Apakah kita mengizinkan pola glob untuk tidak cocok dengan apa pun. Jika `allow_empty` bernilai Salah, setiap pola penyertaan harus cocok dengan sesuatu dan hasil akhir juga tidak boleh kosong (setelah kecocokan pola `exclude` dikecualikan). |
module_name
string native.module_name()
module.name
yang terlihat di module_ctx.modules
.
Dapat menampilkan None
.
module_version
string native.module_version()
module.version
yang terlihat di module_ctx.modules
.
Dapat menampilkan None
.
package_group
None
native.package_group(name, packages=[], includes=[])
visibility
.
Parameter
Parameter | Deskripsi |
---|---|
name
|
string;
required Nama unik untuk aturan ini. |
packages
|
urutan string;
default-nya adalah [] Enumerasi lengkap paket dalam grup ini. |
includes
|
urutan string;
default adalah [] Grup paket lain yang disertakan dalam grup ini. |
package_name
string native.package_name()
some/package/BUILD
, nilainya akan menjadi some/package
. Jika file BUILD memanggil fungsi yang ditentukan dalam file .bzl, package_name()
akan cocok dengan paket file BUILD pemanggil.
package_relative_label
Label native.package_relative_label(input)
BUILD
yang makro saat ini dieksekusi). Jika input sudah berupa Label
, input tersebut akan ditampilkan tanpa perubahan.Fungsi ini hanya dapat dipanggil saat mengevaluasi file BUILD dan makro yang dipanggil secara langsung atau tidak langsung; fungsi ini tidak boleh dipanggil dalam (misalnya) fungsi penerapan aturan.
Hasil dari fungsi ini adalah nilai Label
yang sama seperti yang akan dihasilkan dengan meneruskan string yang diberikan ke atribut bernilai label dari target yang dideklarasikan dalam file BUILD.
Catatan penggunaan: Perbedaan antara fungsi ini dan Label() adalah Label()
menggunakan konteks paket file .bzl
yang memanggilnya, bukan paket file BUILD
. Gunakan Label()
saat Anda perlu merujuk ke target tetap yang di-hardcode ke dalam makro, seperti compiler. Gunakan package_relative_label()
saat Anda perlu menormalisasi string label yang disediakan oleh file BUILD ke objek Label
. (Tidak ada cara untuk mengonversi string menjadi Label
dalam konteks paket selain file BUILD atau file .bzl panggilan. Oleh karena itu, makro luar harus selalu memilih untuk meneruskan objek Label ke makro dalam, bukan string label.)
Parameter
Parameter | Deskripsi |
---|---|
input
|
string; atau Label;
wajib String label input atau objek Label. Jika diteruskan, objek Label akan ditampilkan apa adanya. |
repo_name
string native.repo_name()
repository_name
string native.repository_name()
--+incompatible_enable_deprecated_label_apis
Tidak digunakan lagi. Sebaiknya gunakan
repo_name
, yang tidak berisi tanda @ di awal yang tidak sah, tetapi berperilaku sama.Nama kanonis repositori yang berisi paket yang saat ini sedang dievaluasi, dengan awalan tanda @ (@
) tunggal. Misalnya, dalam paket yang dipanggil oleh stanza WORKSPACE local_repository(name='local', path=...)
, ini akan ditetapkan ke @local
. Dalam paket di repositori utama, nilai ini akan ditetapkan ke @
.
sub-paket
sequence native.subpackages(include, exclude=[], allow_empty=False)
Parameter
Parameter | Deskripsi |
---|---|
include
|
Urutan string; wajib Daftar pola glob yang akan disertakan dalam pemindaian subpaket. |
exclude
|
urutan string;
default adalah [] Daftar pola glob yang akan dikecualikan dari pemindaian subpaket. |
allow_empty
|
bool;
defaultnya adalah False Apakah kita gagal jika panggilan menampilkan daftar kosong. Secara default, daftar kosong menunjukkan potensi error dalam file BUILD saat panggilan ke subpackages() tidak diperlukan. Menetapkan ke true memungkinkan fungsi ini berhasil dalam kasus tersebut. |