Daftar Isi
paket
package(default_deprecation, default_package_metadata, default_testonly, default_visibility, features)
Fungsi ini mendeklarasikan metadata yang berlaku untuk setiap aturan dalam paket. Ini digunakan paling banyak sekali dalam satu paket (file BUILD).
Contoh lainnya yang mendeklarasikan {i>metadata <i}yang berlaku untuk setiap aturan
repositori, gunakan fungsi repo()
di
File REPO.bazel
di root repo Anda.
Fungsi repo()
menggunakan argumen yang sama persis dengan package()
.
Fungsi package() harus dipanggil tepat setelah semua pernyataan load() di bagian atas sebelum aturan apa pun.
Argumen
Atribut | Deskripsi |
---|---|
default_applicable_licenses |
Alias untuk |
default_visibility |
Daftar label; default adalah Visibilitas default aturan dalam paket ini. Setiap aturan dalam paket ini memiliki visibilitas yang ditentukan dalam
kecuali jika ditentukan lain dalam |
default_deprecation |
String; default-nya adalah Menetapkan nilai default
|
default_package_metadata |
Daftar label; default adalah Menetapkan daftar default target metadata yang berlaku untuk semua target lain dalam paket. Ini biasanya adalah target yang terkait dengan deklarasi lisensi dan paket OSS. Lihat rules_license untuk mengetahui contohnya. |
default_testonly |
Boolean; default-nya adalah Menetapkan nilai default
Dalam paket di bawah |
features |
String daftar; default-nya adalah Menetapkan berbagai tanda yang memengaruhi semantik file BUILD ini. Fitur ini terutama digunakan oleh orang-orang yang bekerja pada sistem build untuk paket tag yang membutuhkan perawatan khusus. Jangan gunakan ini kecuali secara eksplisit diminta oleh seseorang yang bekerja pada sistem build. |
Contoh
Deklarasi di bawah ini mendeklarasikan bahwa aturan dalam paket ini hanya dapat dilihat oleh anggota paket grup//foo:target
. Pernyataan visibilitas individual
pada aturan, jika ada, mengganti spesifikasi ini.
package(default_visibility = ["//foo:target"])
package_group
package_group(name, packages, includes)
Fungsi ini menentukan kumpulan paket
dan mengaitkan label dengan himpunan data. Label dapat dirujuk di
Atribut visibility
.
Grup paket terutama digunakan untuk kontrol visibilitas. Iklan yang terlihat secara publik target dapat direferensikan dari setiap paket dalam struktur pohon sumber. A secara pribadi target yang terlihat hanya dapat direferensikan dalam paketnya sendiri (bukan sub-paket). Di antara ekstrem ini, target mungkin mengizinkan akses ke paketnya sendiri ditambah paket yang dijelaskan oleh satu atau lebih kelompok paket. Untuk gambaran yang lebih detail tentang sistem visibilitas, lihat visibilitas .
Paket yang diberikan dianggap berada dalam grup jika cocok dengan
packages
, atau sudah ada dalam salah satu atribut lainnya
grup paket yang disebutkan dalam atribut includes
.
Grup paket secara teknis merupakan target, tetapi tidak dibuat oleh aturan, dan melakukan tidak memiliki perlindungan visibilitas.
Argumen
Atribut | Deskripsi |
---|---|
name |
Nama; wajib diisi Nama unik untuk target ini. |
packages |
Daftar {i>string<i}; default-nya adalah Daftar tanpa spesifikasi paket atau lebih. Setiap string spesifikasi paket dapat memiliki salah satu formulir:
Selain itu, dua jenis spesifikasi paket
pertama juga dapat
diawali dengan Grup paket berisi paket apa pun
yang cocok dengan setidaknya salah satu
spesifikasi positifnya dan tidak satu pun dari spesifikasi negatifnya
Misalnya, nilai Selain visibilitas publik, tidak ada cara untuk menentukan secara langsung paket di luar repositori saat ini. Jika atribut ini tidak ada, sama dengan menyetelnya ke
daftar kosong, yang juga sama dengan mengaturnya
ke daftar yang berisi
hanya Catatan: Sebelum Bazel 6.0, spesifikasi Catatan: Sebelum Bazel 6.0, jika atribut ini diserialisasi sebagai
bagian dari |
includes |
Daftar label; default adalah Grup paket lain yang termasuk dalam paket ini. Label dalam atribut ini harus merujuk pada grup paket lainnya.
Paket dalam grup paket yang direferensikan dianggap sebagai bagian dari
. Ini adalah transitif — jika grup paket
Bila digunakan bersama dengan spesifikasi paket yang diabaikan, perhatikan bahwa satu set paket untuk setiap kelompok mula-mula dihitung secara independen, hasilnya kemudian disatukan. Ini berarti bahwa negatif spesifikasi dalam satu kelompok tidak mempengaruhi spesifikasi dalam kelompok lain. |
Contoh
Deklarasi package_group
berikut menentukan
grup paket yang disebut "tropical" yang mengandung buah-buahan tropis.
package_group( name = "tropical", packages = [ "//fruits/mango", "//fruits/orange", "//fruits/papaya/...", ], )
Deklarasi berikut menetapkan kelompok paket objek aplikasi:
package_group( name = "fooapp", includes = [ ":controller", ":model", ":view", ], ) package_group( name = "model", packages = ["//fooapp/database"], ) package_group( name = "view", packages = [ "//fooapp/swingui", "//fooapp/webui", ], ) package_group( name = "controller", packages = ["//fooapp/algorithm"], )
exports_files
exports_files([label, ...], visibility, licenses)
exports_files()
menentukan daftar file milik
paket ini yang diekspor
ke paket lain.
File BUILD untuk sebuah paket hanya dapat merujuk langsung ke file sumber milik
ke paket lain jika secara eksplisit diekspor
Pernyataan exports_files()
. Baca selengkapnya tentang
visibilitas file.
Sebagai perilaku lama, file yang disebutkan sebagai input ke aturan juga diekspor
dengan visibilitas default hingga flag
--incompatible_no_implicit_file_export
dibalik. Namun, perilaku ini tidak boleh diandalkan dan secara aktif
tempat migrasi berasal.
Argumen
Argumennya adalah daftar nama file dalam paket saat ini. J
deklarasi visibilitas juga dapat ditentukan; dalam hal ini, file tersebut akan
terlihat oleh target yang ditentukan. Jika tidak ada visibilitas yang ditentukan, file
akan terlihat oleh setiap paket, bahkan jika visibilitas {i>default<i} paket adalah
ditentukan dalam package
. Lisensi
juga dapat ditentukan.
Contoh
Contoh berikut mengekspor golden.txt
,
file teks dari paket test_data
, sehingga
paket dapat menggunakannya, misalnya, dalam atribut data
pengujian.
# from //test_data/BUILD exports_files(["golden.txt"])
glob
glob(include, exclude=[], exclude_directories=1, allow_empty=True)
Glob adalah fungsi bantuan yang menemukan semua file yang cocok dengan pola jalur tertentu, dan menampilkan daftar jalur yang baru, dapat diubah, dan diurutkan. Glob hanya menelusuri file dalam paketnya sendiri, dan hanya mencari file sumber (bukan file yang dihasilkan atau target lain).
Label file sumber dimasukkan dalam hasil jika paket-relatif file
cocok dengan salah satu pola include
dan tidak ada satu pun
pola exclude
.
Daftar include
dan exclude
berisi pola jalur
yang relatif terhadap paket saat ini. Setiap pola dapat
terdiri dari satu atau
lebih banyak segmen jalur. Seperti biasa pada jalur Unix, segmen ini dipisahkan oleh
/
. Segmen dalam pola dicocokkan dengan segmen dari
jalur tersebut. Segmen dapat berisi karakter pengganti *
: ini cocok
substring apa pun di segmen jalur (bahkan {i>substring<i} kosong), tidak termasuk
pemisah direktori /
. Karakter pengganti ini dapat digunakan beberapa kali
dalam satu segmen jalur. Selain itu, karakter pengganti **
dapat cocok
nol atau beberapa segmen jalur lengkap, tetapi harus dideklarasikan sebagai segmen jalur mandiri
segmen jalur.
foo/bar.txt
sama persis dengan filefoo/bar.txt
dalam paket ini (kecuali jikafoo/
adalah subpaket)foo/*.txt
cocok dengan setiap file di direktorifoo/
jika file diakhiri dengan.txt
(kecuali jikafoo/
adalah sub-paket)foo/a*.htm*
cocok dengan setiap file dalamfoo/
yang dimulai dengana
, lalu memiliki string arbitrer (bisa kosong), lalu memiliki.htm
, dan diakhiri dengan string arbitrer lainnya (kecuali jikafoo/
adalah subpaket); sepertifoo/axx.htm
danfoo/a.html
ataufoo/axxx.html
foo/*
cocok dengan setiap file dalam direktorifoo/
, (kecuali jikafoo/
adalah subpaket); tidak cocok denganfoo
direktori itu sendiri meskipunexclude_directories
disetel ke 0foo/**
cocok dengan setiap file di setiap subdirektori non-subpaket di bawah subdirektori tingkat pertama paketfoo/
; jikaexclude_directories
disetel ke 0,foo
direktori itu sendiri juga sesuai dengan pola tersebut; dalam hal ini,**
dianggap cocok dengan segmen jalur nol**/a.txt
cocok dengana.txt
file dalam paket direktori plus subdirektori non-subpaket.**/bar/**/*.txt
cocok dengan setiap file.txt
di setiap subdirektori non-subpaket dari paket ini, jika setidaknya satu direktori pada jalur yang dihasilkan disebutbar
, sepertixxx/bar/yyy/zzz/a.txt
ataubar/a.txt
(ingatlah bahwa**
juga cocok dengan segmen nol) ataubar/zzz/a.txt
**
mencocokkan setiap file di setiap subdirektori non-subpaket dari paket inifoo**/a.txt
adalah pola yang tidak valid, karena**
harus berdiri sendiri sebagai segmenfoo/
adalah pola yang tidak valid, karena segmen kedua menentukan setelah/
adalah string kosong
Jika argumen exclude_directories
diaktifkan (disetel ke 1), file
jenis direktori akan dihilangkan dari hasil (default 1).
Jika argumen allow_empty
disetel ke False
, parameter
Fungsi glob
akan mengalami error jika hasilnya sebaliknya
daftar kosong.
Ada beberapa batasan dan peringatan penting:
-
Karena
glob()
berjalan selama evaluasi file BUILD,glob()
hanya cocok dengan file di hierarki sumber, tidak pernah file yang dihasilkan. Jika Anda membangun target yang memerlukan sumber dan file yang dihasilkan, Anda harus menambahkan daftar eksplisit yang dihasilkan ke glob. Lihat contoh di bawah dengan:mylib
dan:gen_java_srcs
. -
Jika aturan memiliki nama yang sama dengan file sumber yang cocok, aturan akan "bayangan" file tersebut.
Untuk memahaminya, ingatlah bahwa
glob()
menampilkan daftar jalur, jadi menggunakanglob()
dalam aturan lain (mis.srcs = glob(["*.cc"])
) memiliki efek yang sama dengan mencantumkan jalur yang cocok secara eksplisit. Misalnya, jikaglob()
menghasilkan["Foo.java", "bar/Baz.java"]
, tetapi ada juga aturan di paket bernama "Foo.java" (yang diperbolehkan, meskipun Bazel sudah memperingatkannya), konsumenglob()
akan menggunakan "Foo.java" aturan (outputnya) bukan "Foo.java" . Lihat GitHub masalah #10395 untuk mengetahui detail selengkapnya. - Globs dapat cocok dengan file di subdirektori. Dan nama subdirektori dapat menggunakan karakter pengganti. Namun...
-
Label tidak diizinkan melewati batas paket dan glob melakukan tidak mencocokkan file dalam sub-paket.
Misalnya, ekspresi glob
**/*.cc
dalam paketx
tidak menyertakanx/y/z.cc
jikax/y
ada sebagai paket (baik sebagaix/y/BUILD
, atau di tempat lain pada jalur paket). Ini berarti bahwa hasil ekspresi glob sebenarnya bergantung pada keberadaan file BUILD — yaitu, ekspresi glob yang sama akan sertakanx/y/z.cc
jika tidak ada paket yang disebutx/y
atau ditandai sebagai dihapus menggunakan --deleted_packages penanda. - Pembatasan di atas berlaku untuk semua ekspresi glob, tidak peduli {i>wildcard <i}mana yang mereka gunakan.
-
File tersembunyi dengan nama file yang dimulai dengan
.
akan dicocokkan sepenuhnya dengan karakter pengganti**
dan*
. Jika Anda ingin mencocokkan file tersembunyi dengan pola majemuk, pola Anda harus dimulai dengan.
. Misalnya,*
dan.*.txt
akan cocok dengan.foo.txt
, tetapi*.txt
tidak akan terjadi. Direktori tersembunyi juga dicocokkan dengan cara yang sama. Direktori tersembunyi dapat menyertakan file yang tidak diperlukan sebagai input, dan dapat meningkatkan jumlah file globb yang tidak perlu dan konsumsi memori. Untuk mengecualikan direktori tersembunyi, tambahkan ke "exclude" (kecualikan) daftar argumen. -
"**" karakter pengganti memiliki satu huruf besar/kecil: pola
"**"
tidak cocok dengan jalur direktori paket. Yaitu untuk misalnya,glob(["**"], exclude_directories = 0)
cocok dengan semua file dan direktori secara transitif secara ketat berada di bawah direktori paket saat ini (tapi tentu saja tidak masuk ke direktori sub-paket - lihat catatan tentang hal itu).
Secara umum, Anda harus mencoba memberikan ekstensi yang sesuai (misalnya *.html) alih-alih menggunakan '*' kosong untuk pola glob. Semakin eksplisit nama mendokumentasikan dirinya sendiri dan memastikan bahwa Anda tidak sengaja mencocokkan file, atau emacs/vi/... file yang disimpan secara otomatis.
Saat menulis aturan build, Anda dapat menghitung elemen glob. Ini memungkinkan pembuatan aturan individu untuk setiap input, misalnya. Lihat contoh glob yang diperluas di bawah ini.
Contoh Glob
Buatlah library Java yang dibangun dari
semua file java di direktori ini,
dan semua file yang dibuat oleh aturan :gen_java_srcs
.
java_library( name = "mylib", srcs = glob(["*.java"]) + [":gen_java_srcs"], deps = "...", ) genrule( name = "gen_java_srcs", outs = [ "Foo.java", "Bar.java", ], ... )
Sertakan semua file txt dalam testdata direktori kecuali experiment.txt. Perhatikan bahwa file dalam subdirektori data pengujian tidak akan disertakan. Jika Anda ingin menyertakan file tersebut, gunakan glob rekursif (**).
sh_test( name = "mytest", srcs = ["mytest.sh"], data = glob( ["testdata/*.txt"], exclude = ["testdata/experimental.txt"], ), )
Contoh Glob Rekursif
Buat pengujian bergantung pada semua file txt di direktori testdata dan subdirektorinya (beserta subdirektorinya, dan sebagainya). Subdirektori yang berisi file BUILD diabaikan. (Lihat batasan dan peringatan di atas.)
sh_test( name = "mytest", srcs = ["mytest.sh"], data = glob(["testdata/**/*.txt"]), )
Buat library yang dibangun dari semua file java di direktori ini dan semuanya subdirektori kecuali yang jalurnya menyertakan direktori bernama pengujian. Pola ini sebaiknya dihindari jika memungkinkan, karena dapat mengurangi build inkrementalitas sehingga dapat meningkatkan waktu build.
java_library( name = "mylib", srcs = glob( ["**/*.java"], exclude = ["**/testing/**"], ), )
Contoh Glob yang Diperluas
Buat genrule individual untuk *_test.cc di direktori saat ini yang menghitung jumlah baris dalam file.
# Conveniently, the build language supports list comprehensions. [genrule( name = "count_lines_" + f[:-3], # strip ".cc" srcs = [f], outs = ["%s-linecount.txt" % f[:-3]], cmd = "wc -l $< >$@", ) for f in glob(["*_test.cc"])]
Jika file BUILD di atas ada dalam paket //foo dan paket tersebut berisi tiga
mencocokkan file, a_test.cc, b_test.cc, dan c_test.cc kemudian menjalankan
bazel query '//foo:all'
akan mencantumkan semua aturan yang dibuat:
$ bazel query '//foo:all' | sort //foo:count_lines_a_test //foo:count_lines_b_test //foo:count_lines_c_test
pilih
select( {conditionA: valuesA, conditionB: valuesB, ...}, no_match_error = "custom message" )
select()
adalah fungsi bantuan yang membuat atribut aturan
dapat dikonfigurasi.
Ini dapat menggantikan sisi kanan
hampir
penetapan atribut apa pun sehingga nilainya
bergantung pada tanda Bazel {i>command line<i}.
Anda bisa menggunakannya, misalnya, untuk mendefinisikan
dependensi spesifik platform atau untuk
menyematkan resource yang berbeda bergantung pada apakah aturan dibuat di "developer" atau tidak
vs. "rilis" mode.
Penggunaan dasarnya adalah sebagai berikut:
sh_binary( name = "mytarget", srcs = select({ ":conditionA": ["mytarget_a.sh"], ":conditionB": ["mytarget_b.sh"], "//conditions:default": ["mytarget_default.sh"] }) )
Ini membuat atribut srcs
dari
sh_binary
yang dapat dikonfigurasi dengan mengganti label normalnya
daftar tugas dengan panggilan select
yang memetakan
kondisi konfigurasi hingga nilai yang cocok. Setiap kondisi adalah label
referensi ke
config_setting
atau
constraint_value
,
yang “cocok” jika konfigurasi target cocok dengan kumpulan
masing-masing. Nilai mytarget#srcs
kemudian menjadi salah satu
daftar label cocok dengan pemanggilan saat ini.
Catatan:
- Hanya satu kondisi yang dipilih pada setiap pemanggilan.
- Jika beberapa kondisi cocok dan satu kondisi merupakan spesialisasi dari kondisi yang lain, spesialisasi lebih diprioritaskan. Kondisi B dianggap spesialisasi kondisi A jika B memiliki semua penanda dan batasan yang sama nilai sebagai A ditambah beberapa penanda atau nilai batasan tambahan. Hal ini juga berarti bahwa resolusi spesialisasi tidak dirancang untuk membuat pengaturan seperti ditunjukkan dalam Contoh 2 di bawah ini.
- Jika beberapa kondisi cocok dan salah satunya bukan merupakan spesialisasi dari semua yang lainnya, Bazel gagal dengan sebuah {i>error<i}, kecuali jika semua kondisi diselesaikan dengan nilai yang sama.
- Label semu khusus
//conditions:default
adalah dianggap cocok jika tidak ada kondisi lain yang cocok. Jika kondisi ini diabaikan, beberapa aturan lain harus cocok untuk menghindari kesalahan. select
dapat disematkan di dalam file yang lebih besar penetapan atribut. Jadisrcs = ["common.sh"] + select({ ":conditionA": ["myrule_a.sh"], ...})
dansrcs = select({ ":conditionA": ["a.sh"]}) + select({ ":conditionB": ["b.sh"]})
adalah ekspresi yang valid.select
berfungsi dengan sebagian besar, tetapi tidak semua, atribut. Tidak kompatibel ditandai sebagainonconfigurable
dalam dokumentasinya.sub-paket
subpackages(include, exclude=[], allow_empty=True)
subpackages()
adalah fungsi bantuan, mirip denganglob()
yang mencantumkan sub-paket alih-alih file dan direktori. Model ini menggunakan metode sebagaiglob()
dan dapat cocok dengan sub-paket apa pun yang turunan langsung dari file BUILD yang sedang dimuat. Lihat glob untuk mengetahui penjelasan mendetail serta contoh penyertaan dan contoh mengecualikan pola.Daftar sub-paket yang dihasilkan dikembalikan dalam urutan yang diurutkan dan berisi jalur relatif terhadap paket pemuatan saat ini yang sesuai dengan pola yang diberikan
include
dan bukan yang ada diexclude
.Contoh
Contoh berikut mencantumkan semua sub-paket langsung untuk paket
foo/BUILD
# The following BUILD files exist: # foo/BUILD # foo/bar/baz/BUILD # foo/bar/but/bad/BUILD # foo/sub/BUILD # foo/sub/deeper/BUILD # # In foo/BUILD a call to subs1 = subpackages(include = ["**"]) # results in subs1 == ["sub", "bar/baz", "bar/but/bad"] # # 'sub/deeper' is not included because it is a subpackage of 'foo/sub' not of # 'foo' subs2 = subpackages(include = ["bar/*"]) # results in subs2 = ["bar/baz"] # # Since 'bar' is not a subpackage itself, this looks for any subpackages under # all first level subdirectories of 'bar'. subs3 = subpackages(include = ["bar/**"]) # results in subs3 = ["bar/baz", "bar/but/bad"] # # Since bar is not a subpackage itself, this looks for any subpackages which are # (1) under all subdirectories of 'bar' which can be at any level, (2) not a # subpackage of another subpackages. subs4 = subpackages(include = ["sub"]) subs5 = subpackages(include = ["sub/*"]) subs6 = subpackages(include = ["sub/**"]) # results in subs4 and subs6 being ["sub"] # results in subs5 = []. # # In subs4, expression "sub" checks whether 'foo/sub' is a package (i.e. is a # subpackage of 'foo'). # In subs5, "sub/*" looks for subpackages under directory 'foo/sub'. Since # 'foo/sub' is already a subpackage itself, the subdirectories will not be # traversed anymore. # In subs6, 'foo/sub' is a subpackage itself and matches pattern "sub/**", so it # is returned. But the subdirectories of 'foo/sub' will not be traversed # anymore.
Secara umum, lebih baik daripada memanggil fungsi ini secara langsung bahwa pengguna menggunakan 'sub-paket' modul skylib.