file .bzl

Atribut implisit yang diawali dengan _ harus memiliki nilai default, dan memiliki jenis label atau label_list.

Atribut eksplisit harus memiliki jenis string, dan harus menggunakan batasan values. Atribut eksplisit membatasi aspek agar hanya digunakan dengan aturan yang memiliki atribut dengan nama, jenis, dan nilai valid yang sama sesuai dengan batasan.

Daftar penyedia yang tidak bertingkat akan otomatis dikonversi menjadi daftar yang berisi satu daftar penyedia. Artinya, [FooInfo, BarInfo] akan otomatis dikonversi menjadi [[FooInfo, BarInfo]].

Agar beberapa target aturan (misalnya, some_rule) terlihat oleh aspek, some_rule harus mengiklankan semua penyedia dari setidaknya salah satu daftar penyedia yang diperlukan. Misalnya, jika required_providers suatu aspek adalah [[FooInfo], [BarInfo], [BazInfo, QuxInfo]], aspek ini dapat melihat target some_rule jika dan hanya jika some_rule menyediakan FooInfo, atau BarInfo, atau BazInfo dan QuxInfo.

Daftar penyedia yang tidak bertingkat akan otomatis dikonversi menjadi daftar yang berisi satu daftar penyedia. Artinya, [FooInfo, BarInfo] akan otomatis dikonversi menjadi [[FooInfo, BarInfo]].

Agar aspek lain (misalnya, other_aspect) terlihat oleh aspek ini, other_aspect harus menyediakan semua penyedia dari setidaknya salah satu daftar. Dalam contoh [[FooInfo], [BarInfo], [BazInfo, QuxInfo]], aspek ini dapat melihat other_aspect jika dan hanya jika other_aspect menyediakan BarInfo, atau BazInfo dan QuxInfo.FooInfo

Terjadi error jika fungsi penerapan menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkan. Namun, fungsi penerapan dapat menampilkan penyedia tambahan yang tidak tercantum di sini.

Setiap elemen daftar adalah objek *Info yang ditampilkan oleh provider(), kecuali penyedia lama diwakili oleh nama stringnya.Jika target aturan digunakan sebagai dependensi untuk target yang mendeklarasikan penyedia yang diperlukan, penyedia tersebut tidak perlu ditentukan di sini. Fungsi penerapan cukup menampilkannya. Namun, sebaiknya tentukan, meskipun tidak wajib. Namun, kolom required_providers dari aspek mengharuskan penyedia ditentukan di sini.

Misalnya, anggaplah suatu aspek berpropagasi secara transitif melalui atribut `deps` dan diterapkan ke target `alpha`. Anggaplah `alpha` memiliki `deps = [':beta_output']`, dengan `beta_output` adalah output yang dideklarasikan dari target `beta`. Anggaplah `beta` memiliki target `charlie` sebagai salah satu `deps`-nya. Jika `apply_to_generating_rules=True` untuk aspek tersebut, maka aspek tersebut akan berpropagasi melalui `alpha`, `beta`, dan `charlie`. Jika False, maka aspek tersebut hanya akan berpropagasi ke `alpha`.

False secara default.

• daftar kolom:
  

  provider(fields = ['a', 'b'])

• nama kolom kamus -> dokumentasi:
  

  provider(
         fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })

Deskripsi yang tepat akan mengikuti; lihat Aturan (Inisialisasi penyedia kustom) untuk pembahasan dan kasus penggunaan yang intuitif.

Biarkan P menjadi simbol penyedia yang dibuat dengan memanggil provider(). Secara konseptual, instance P dibuat dengan memanggil fungsi konstruktor default c(*args, **kwargs), yang melakukan hal berikut:

• Jika args tidak kosong, error akan terjadi.
• Jika parameter fields ditentukan saat provider() dipanggil, dan jika kwargs berisi kunci yang tidak tercantum dalam fields, akan terjadi error.
• Jika tidak, c akan menampilkan instance baru yang, untuk setiap entri k: v dalam kwargs, memiliki kolom bernama k dengan nilai v.

MyInfo = provider()
m = MyInfo(foo = 1)

Namun, jika init ditentukan, panggilan P(*args, **kwargs) akan melakukan langkah-langkah berikut:

1. Callback dipanggil sebagai init(*args, **kwargs), yaitu dengan argumen posisional dan kata kunci yang sama persis seperti yang diteruskan ke P.
2. Nilai yang ditampilkan dari init diharapkan berupa kamus, d, yang kuncinya adalah string nama kolom. Jika tidak, akan terjadi error.
3. Instance baru P dibuat seolah-olah dengan memanggil konstruktor default dengan entri d sebagai argumen kata kunci, seperti pada c(**d).

NB: langkah-langkah di atas menyiratkan bahwa error terjadi jika *args atau **kwargs tidak cocok dengan tanda tangan init, atau evaluasi isi init gagal (mungkin secara sengaja melalui panggilan ke fail()), atau jika nilai yang ditampilkan init bukan kamus dengan skema yang diharapkan.

Dengan cara ini, callback init menggeneralisasi konstruksi penyedia normal dengan mengizinkan argumen posisi dan logika arbitrer untuk praproses dan validasi. Fitur ini tidak memungkinkan pengelabuan daftar fields yang diizinkan.

Jika init ditentukan, nilai yang ditampilkan oleh provider() akan menjadi tuple (P, r), dengan r adalah konstruktor mentah. Faktanya, perilaku r persis seperti fungsi konstruktor default c yang dibahas di atas. Biasanya, r terikat ke variabel yang namanya diawali dengan garis bawah, sehingga hanya file .bzl saat ini yang memiliki akses langsung ke variabel tersebut:

MyInfo, _new_myinfo = provider(init = ...)

Skema untuk menentukan output yang telah dideklarasikan sebelumnya. Tidak seperti atribut output dan output_list, pengguna tidak menentukan label untuk file ini. Lihat halaman Aturan untuk mengetahui informasi selengkapnya tentang output yang dideklarasikan sebelumnya.

Nilai argumen ini berupa kamus atau fungsi panggil balik yang menghasilkan kamus. Callback berfungsi mirip dengan atribut dependensi terkomputasi: Nama parameter fungsi dicocokkan dengan atribut aturan, jadi misalnya jika Anda meneruskan outputs = _my_func dengan definisi def _my_func(srcs, deps): ..., fungsi memiliki akses ke atribut srcs dan deps. Apakah kamus ditentukan secara langsung atau melalui fungsi, kamus ditafsirkan sebagai berikut.

Setiap entri dalam kamus membuat output yang telah dideklarasikan sebelumnya dengan kunci berupa ID dan nilai berupa template string yang menentukan label output. Dalam fungsi penerapan aturan, ID menjadi nama kolom yang digunakan untuk mengakses File output di ctx.outputs. Label output memiliki paket yang sama dengan aturan, dan bagian setelah paket dihasilkan dengan mengganti setiap placeholder formulir "%{ATTR}" dengan string yang dibentuk dari nilai atribut ATTR:

• Atribut berjenis string diganti kata demi kata.
• Atribut berjenis label menjadi bagian dari label setelah paket, minus ekstensi file. Misalnya, label "//pkg:a/b.c" menjadi "a/b".
• Atribut berjenis output menjadi bagian dari label setelah paket, termasuk ekstensi file (untuk contoh di atas, "a/b.c").
• Semua atribut berjenis daftar (misalnya, attr.label_list) yang digunakan dalam placeholder harus memiliki tepat satu elemen. Konversi mereka sama dengan versi non-daftar mereka (attr.label).
• Jenis atribut lainnya mungkin tidak muncul di placeholder.
• Placeholder non-atribut khusus %{dirname} dan %{basename} diperluas ke bagian label aturan tersebut, tidak termasuk paketnya. Misalnya, di "//pkg:a/b.c", dirname adalah a dan basename adalah b.c.

Dalam praktiknya, placeholder penggantian yang paling umum adalah "%{name}". Misalnya, untuk target bernama "foo", dict output {"bin": "%{name}.exe"} mendeklarasikan output bernama foo.exe yang dapat diakses dalam fungsi penerapan sebagai ctx.outputs.bin.

Terjadi error jika fungsi penerapan menghilangkan salah satu jenis penyedia yang tercantum di sini dari nilai yang ditampilkan. Namun, fungsi penerapan dapat menampilkan penyedia tambahan yang tidak tercantum di sini.

Setiap elemen daftar adalah objek *Info yang ditampilkan oleh provider(), kecuali penyedia lama diwakili oleh nama stringnya.Jika target aturan digunakan sebagai dependensi untuk target yang mendeklarasikan penyedia yang diperlukan, penyedia tersebut tidak perlu ditentukan di sini. Fungsi penerapan cukup menampilkannya. Namun, sebaiknya tentukan, meskipun tidak wajib. Namun, kolom required_providers dari aspek mengharuskan penyedia ditentukan di sini.

Catatan: Aturan pengujian analisis terutama ditentukan menggunakan infrastruktur yang disediakan di library Starlark inti. Lihat Pengujian untuk mendapatkan panduan.

Jika ditentukan sebagai aturan pengujian analisis, aturan diizinkan untuk menggunakan transisi konfigurasi yang ditentukan menggunakan analysis_test_transition pada atributnya, tetapi memilih untuk menerapkan beberapa batasan:

• Target aturan ini dibatasi dalam jumlah dependensi transitif yang mungkin dimilikinya.
• Aturan ini dianggap sebagai aturan pengujian (seolah-olah test=True ditetapkan). Nilai ini menggantikan nilai test
• Fungsi penerapan aturan mungkin tidak mendaftarkan tindakan. Sebagai gantinya, hasil lulus/gagal harus didaftarkan dengan memberikan AnalysisTestResultInfo.

Fungsi ini dipanggil pada waktu pemuatan untuk setiap instance aturan. Fungsi ini dipanggil dengan name dan nilai atribut publik yang ditentukan oleh aturan (bukan dengan atribut generik, misalnya tags).

Harus menampilkan kamus dari nama atribut ke nilai yang diinginkan. Atribut yang tidak ditampilkan tidak terpengaruh. Menampilkan None sebagai nilai akan menghasilkan penggunaan nilai default yang ditentukan dalam definisi atribut.

Penginisialisasi dievaluasi sebelum nilai default yang ditentukan dalam definisi atribut. Akibatnya, jika parameter dalam tanda tangan penginisialisasi berisi nilai default, nilai tersebut akan menggantikan default dari definisi atribut (kecuali jika menampilkan None).

Demikian pula, jika parameter dalam tanda tangan penginisialisasi tidak memiliki default, parameter akan menjadi wajib. Sebaiknya hilangkan setelan default/wajib pada definisi atribut dalam kasus seperti itu.

Sebaiknya gunakan **kwargs untuk atribut yang tidak ditangani.

Dalam kasus aturan yang diperluas, semua penginisialisasi dipanggil dari turunan ke ancestor. Setiap penginisialisasi hanya meneruskan atribut publik yang diketahuinya.

Subaturan hanya boleh memiliki atribut pribadi yang berjenis label (yaitu label atau label-list). Nilai yang di-resolve yang sesuai dengan label ini secara otomatis diteruskan oleh Bazel ke fungsi penerapan subaturan sebagai argumen bernama (sehingga fungsi penerapan harus menerima parameter bernama yang cocok dengan nama atribut). Jenis nilai ini adalah:

• FilesToRunProvider untuk atribut label dengan executable=True
• File untuk atribut label dengan allow_single_file=True
• Target untuk semua atribut label lainnya
• [Target] untuk semua atribut daftar label

Spesifikasi paket mengikuti format yang sama seperti untuk package_group, kecuali spesifikasi paket negatif tidak diizinkan. Artinya, spesifikasi dapat memiliki bentuk:

• "//foo": paket //foo
• "//foo/...": paket //foo dan semua sub-paketnya.
• "public" atau "private": semua paket atau tidak ada paket

Sintaksis "@" tidak diizinkan; semua spesifikasi ditafsirkan relatif terhadap repositori modul saat ini.

Jika value adalah daftar string, kumpulan paket yang diberi visibilitas ke modul ini adalah gabungan dari paket yang diwakili oleh setiap spesifikasi. (Daftar kosong memiliki efek yang sama dengan private.) Jika value adalah string tunggal, string tersebut diperlakukan seolah-olah merupakan daftar singleton [value].

Perhatikan bahwa tanda --incompatible_package_group_has_public_syntax dan --incompatible_fix_package_group_reporoot_syntax tidak berpengaruh pada argumen ini. Nilai "public" dan "private" selalu tersedia, dan "//..." selalu ditafsirkan sebagai "semua paket dalam repositori saat ini".