native

Laporkan masalah Lihat sumber Nightly · 8.2 · 8.1 · 8.0 · 7.6 · 7.5

Modul bawaan untuk mendukung aturan native dan fungsi helper 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

unknown native.existing_rule(name)

Menampilkan objek seperti kamus yang tidak dapat diubah yang menjelaskan atribut aturan yang dibuat instance-nya dalam paket thread ini, atau 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 dalam bentuk ':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()

Menampilkan objek seperti dict yang tidak dapat diubah yang menjelaskan aturan yang sejauh ini dibuat instance-nya dalam paket thread ini. Setiap entri objek seperti kamus memetakan nama instance aturan ke hasil yang akan ditampilkan oleh 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; hal ini membuat file BUILD rapuh dan bergantung pada urutan.

exports_files

None native.exports_files(srcs, visibility=None, licenses=None)

Menentukan daftar file milik paket ini yang diekspor ke paket lain.

Parameter

Parameter Deskripsi
srcs urutan string; wajib
Daftar file yang akan diekspor.
visibility sequence; atau None; default-nya 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)

Glob menampilkan daftar baru yang dapat diubah dan diurutkan dari setiap file dalam paket saat ini yang:
  • Cocok dengan setidaknya satu pola di include.
  • Tidak cocok dengan pola apa pun di exclude ([] default).
Jika argumen 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; default 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()

Nama modul Bazel yang terkait dengan repo tempat paket ini berada. Jika paket ini berasal dari repo yang ditentukan di WORKSPACE, bukan MODULE.bazel, paket ini akan kosong. Untuk repo yang dibuat oleh ekstensi modul, ini adalah nama modul yang menghosting ekstensi. Ini sama dengan kolom module.name yang terlihat di module_ctx.modules. Dapat menampilkan None.

module_version

string native.module_version()

Versi modul Bazel yang terkait dengan repo tempat paket ini berada. Jika paket ini berasal dari repo yang ditentukan di WORKSPACE, bukan MODULE.bazel, paket ini akan kosong. Untuk repo yang dihasilkan oleh ekstensi modul, ini adalah versi modul yang menghosting ekstensi. Ini sama dengan kolom module.version yang terlihat di module_ctx.modules. Dapat menampilkan None.

package_default_visibility

List native.package_default_visibility()

Menampilkan visibilitas default paket yang sedang dievaluasi. Ini adalah nilai parameter default_visibility dari package(), yang diperluas untuk menyertakan paket itu sendiri.

package_group

None native.package_group(name, packages=[], includes=[])

Fungsi ini menentukan sekumpulan paket dan menetapkan label ke grup. Label dapat direferensikan dalam atribut visibility.

Parameter

Parameter Deskripsi
name string; required
Nama unik untuk aturan ini.
packages urutan string; default 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()

Nama paket yang sedang dievaluasi, tanpa nama repositori. Misalnya, dalam file BUILD 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)

Mengonversi string input menjadi objek Label, dalam konteks paket yang sedang diinisialisasi (yaitu, file BUILD yang makro saat ini dijalankan). 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 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 lebih 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()

Nama kanonis repositori yang berisi paket yang saat ini sedang dievaluasi, tanpa tanda @ di awal.

repository_name

string native.repository_name()

Eksperimental. API ini bersifat eksperimental dan dapat berubah sewaktu-waktu. Jangan mengandalkannya. Fitur ini dapat diaktifkan secara eksperimental dengan menetapkan --+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=...) akan disetel ke @local. Dalam paket di repositori utama, nilai ini akan ditetapkan ke @.

sub-paket

sequence native.subpackages(include, exclude=[], allow_empty=False)

Menampilkan daftar baru yang dapat diubah dari setiap subpaket langsung dari paket saat ini, terlepas dari kedalaman direktori sistem file. Daftar yang ditampilkan diurutkan dan berisi nama subpaket yang terkait dengan paket saat ini. Sebaiknya gunakan metode dalam modul bazel_skylib.subpackages, bukan memanggil fungsi ini secara langsung.

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.