Label

Laporkan masalah Lihat sumber Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Label adalah ID untuk target. Label standar dalam bentuk kanonis lengkap terlihat seperti:

@@myrepo//my/app/main:app_binary

Bagian pertama label adalah nama repositori, @@myrepo. Sintaksis @ ganda menunjukkan bahwa ini adalah nama repo kanonis, yang unik dalam ruang kerja. Label dengan nama repo kanonis secara jelas mengidentifikasi target terlepas dari konteks tempatnya muncul.

Sering kali nama repo kanonis adalah string misterius yang terlihat seperti @@rules_java++toolchains+local_jdk. Yang lebih sering terlihat adalah label dengan nama repo yang jelas, yang terlihat seperti:

@myrepo//my/app/main:app_binary

Satu-satunya perbedaan adalah nama repo diawali dengan satu @, bukan dua. Ini mengacu pada repo dengan nama yang terlihat myrepo, yang dapat berbeda berdasarkan konteks kemunculan label ini.

Dalam kasus umum bahwa label merujuk ke repositori yang sama tempat label digunakan, bagian nama repo dapat dihilangkan. Jadi, di dalam @@myrepo, label pertama biasanya ditulis sebagai

//my/app/main:app_binary

Bagian kedua label adalah nama paket yang tidak memenuhi syarat my/app/main, jalur ke paket yang relatif terhadap root repositori. Bersama-sama, nama repositori dan nama paket yang tidak memenuhi syarat membentuk nama paket yang sepenuhnya memenuhi syarat @@myrepo//my/app/main. Jika label merujuk ke paket yang sama dengan yang digunakan, nama paket (dan secara opsional, titik dua) dapat dihilangkan. Jadi, di dalam @@myrepo//my/app/main, label ini dapat ditulis dengan salah satu cara berikut:

app_binary
:app_binary

Tanda titik dua dihilangkan untuk file, tetapi dipertahankan untuk aturan, tetapi tidak signifikan.

Bagian label setelah titik dua, app_binary adalah nama target yang tidak memenuhi syarat. Jika cocok dengan komponen terakhir dari jalur paket, komponen tersebut, dan titik koma, dapat dihilangkan. Jadi, kedua label ini setara:

//my/app/lib
//my/app/lib:lib

Nama target file dalam subdirektori paket adalah jalur file yang relatif terhadap root paket (direktori yang berisi file BUILD). Jadi, file ini berada di subdirektori my/app/main/testdata repositori:

//my/app/main:testdata/input.txt

String seperti //my/app dan @@some_repo//my/app memiliki dua arti, bergantung pada konteks tempatnya digunakan: saat Bazel mengharapkan label, string tersebut masing-masing berarti //my/app:app dan @@some_repo//my/app:app. Namun, saat Bazel mengharapkan paket (misalnya dalam spesifikasi package_group), paket tersebut mereferensikan paket yang berisi label tersebut.

Kesalahan umum dalam file BUILD adalah menggunakan //my/app untuk merujuk ke paket, atau ke semua target dalam paket--tidak. Ingat, ini setara dengan //my/app:app, sehingga memberi nama target app dalam paket my/app repositori saat ini.

Namun, penggunaan //my/app untuk merujuk ke paket dianjurkan dalam spesifikasi package_group atau dalam file .bzl, karena dengan jelas menunjukkan bahwa nama paket bersifat absolut dan di-root di direktori level teratas ruang kerja.

Label relatif tidak dapat digunakan untuk merujuk ke target dalam paket lain; ID repositori dan nama paket harus selalu ditentukan dalam hal ini. Misalnya, jika hierarki sumber berisi paket my/app dan paket my/app/testdata (setiap dari dua direktori ini memiliki file BUILD-nya sendiri), paket kedua berisi file bernama testdepot.zip. Berikut ada dua cara (satu salah, satu benar) untuk merujuk ke file ini dalam //my/app:BUILD:

Salah — testdata adalah paket yang berbeda, sehingga Anda tidak dapat menggunakan jalur relatif

testdata/testdepot.zip

Benar — lihat testdata dengan jalur lengkapnya

//my/app/testdata:testdepot.zip

Label yang diawali dengan @@// adalah referensi ke repositori utama, yang akan tetap berfungsi bahkan dari repositori eksternal. Oleh karena itu, @@//a/b/c berbeda dengan //a/b/c saat dirujuk dari repositori eksternal. Yang pertama merujuk kembali ke repositori utama, sedangkan yang kedua mencari //a/b/c di repositori eksternal itu sendiri. Hal ini sangat relevan saat menulis aturan di repositori utama yang merujuk ke target di repositori utama, dan akan digunakan dari repositori eksternal.

Untuk mengetahui informasi tentang berbagai cara yang dapat Anda gunakan untuk merujuk ke target, lihat pola target.

Spesifikasi leksikal label

Sintaksis label tidak menganjurkan penggunaan karakter meta yang memiliki makna khusus untuk shell. Hal ini membantu menghindari masalah kutipan yang tidak disengaja, dan mempermudah pembuatan alat dan skrip yang memanipulasi label, seperti Bazel Query Language.

Detail persis nama target yang diizinkan tercantum di bawah.

Nama target — package-name:target-name

target-name adalah nama target dalam paket. Nama aturan adalah nilai atribut name dalam deklarasi aturan dalam file BUILD; nama file adalah jalurnya yang relatif terhadap direktori yang berisi file BUILD.

Nama target harus sepenuhnya terdiri dari karakter yang diambil dari kumpulan a–z, A–Z, 0–9, dan simbol tanda baca !%-@^_"#$&'()*-+,;<=>?[]{|}~/..

Nama file harus berupa nama jalur relatif dalam bentuk normal, yang berarti nama file tidak boleh dimulai atau diakhiri dengan garis miring (misalnya, /foo dan foo/ dilarang) atau berisi beberapa garis miring berturut-turut sebagai pemisah jalur (misalnya, foo//bar). Demikian pula, referensi tingkat atas (..) dan referensi direktori saat ini (./) dilarang.

Salah — Jangan gunakan .. untuk merujuk ke file dalam paket lain

Benar — Gunakan //package-name:filename

Meskipun penggunaan / dalam nama target file sudah umum, hindari penggunaan / dalam nama aturan. Terutama jika bentuk singkat label digunakan, hal ini dapat membingungkan pembaca. Label //foo/bar/wiz selalu merupakan singkatan untuk //foo/bar/wiz:wiz, meskipun tidak ada paket foo/bar/wiz tersebut; label ini tidak pernah merujuk ke //foo:bar/wiz, meskipun target tersebut ada.

Namun, ada beberapa situasi saat penggunaan garis miring lebih praktis, atau terkadang bahkan diperlukan. Misalnya, nama aturan tertentu harus cocok dengan file sumber utamanya, yang mungkin berada di subdirektori paket.

Nama paket — //package-name:target-name

Nama paket adalah nama direktori yang berisi file BUILD-nya, yang relatif terhadap direktori level teratas repositori yang berisi. Contoh: my/app.

Pada tingkat teknis, Bazel menerapkan hal berikut:

  • Karakter yang diizinkan dalam nama paket adalah huruf kecil a hingga z, huruf besar A hingga Z, angka 0 hingga 9, karakter ! \"#$%&'()*+,-.;<=>?@[]^_`{|} (ya, ada karakter spasi di dalamnya), dan tentu saja garis miring / (karena merupakan pemisah direktori).
  • Nama paket tidak boleh diawali atau diakhiri dengan karakter garis miring /.
  • Nama paket tidak boleh berisi substring //. Hal ini tidak akan membuat arti---apa jalur direktori yang sesuai?
  • Nama paket tidak boleh berisi substring /./ atau /../ atau /.../, dsb. Penerapan ini dilakukan untuk menghindari kebingungan saat menerjemahkan antara nama paket logis dan nama direktori fisik, mengingat makna semantik karakter titik dalam string jalur.

Pada tingkat praktis:

  • Untuk bahasa dengan struktur direktori yang signifikan bagi sistem modulnya (misalnya, Java), Anda harus memilih nama direktori yang merupakan ID yang valid dalam bahasa tersebut. Misalnya, jangan mulai dengan digit awal dan hindari karakter khusus, terutama garis bawah dan tanda hubung.
  • Meskipun Bazel mendukung target dalam paket root ruang kerja (misalnya, //:foo), sebaiknya biarkan paket tersebut kosong sehingga semua paket yang bermakna memiliki nama deskriptif.

Aturan

Aturan menentukan hubungan antara input dan output, serta langkah-langkah untuk mem-build output. Aturan dapat berupa salah satu dari banyak jenis (terkadang disebut class aturan), yang menghasilkan library dan file yang dapat dieksekusi yang dikompilasi, menguji file yang dapat dieksekusi, dan output lain yang didukung seperti yang dijelaskan dalam Ensiklopedia Build.

File BUILD mendeklarasikan target dengan memanggil aturan.

Pada contoh di bawah, kita melihat deklarasi my_app target menggunakan aturan cc_binary.

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    deps = [
        "//absl/base",
        "//absl/strings",
    ],
)

Setiap pemanggilan aturan memiliki atribut name (yang harus berupa nama target yang valid), yang mendeklarasikan target dalam paket file BUILD.

Setiap aturan memiliki kumpulan atribut; atribut yang berlaku untuk aturan tertentu, serta signifikansi dan semantik setiap atribut adalah fungsi dari jenis aturan; lihat Ensiklopedia Build untuk daftar aturan dan atribut yang sesuai. Setiap atribut memiliki nama dan jenis. Beberapa jenis umum yang dapat dimiliki atribut adalah bilangan bulat, label, daftar label, string, daftar string, label output, daftar label output. Tidak semua atribut perlu ditentukan dalam setiap aturan. Dengan demikian, atribut membentuk kamus dari kunci (nama) ke nilai opsional yang diketik.

Atribut srcs yang ada di banyak aturan memiliki jenis "daftar label"; nilainya, jika ada, adalah daftar label, yang masing-masing merupakan nama target yang merupakan input untuk aturan ini.

Dalam beberapa kasus, nama jenis aturan agak arbitrer, dan yang lebih menarik adalah nama file yang dihasilkan oleh aturan, dan ini berlaku untuk genrules. Untuk informasi selengkapnya, lihat Aturan Umum: genrule.

Dalam kasus lain, nama tersebut penting: misalnya, untuk aturan *_binary dan *_test, nama aturan menentukan nama file yang dapat dieksekusi yang dihasilkan oleh build.

Directed acyclic graph ini di atas target disebut grafik target atau grafik dependensi build, dan merupakan domain tempat alat Kueri Bazel beroperasi.

Target File BUILD