atraktif

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

Ini adalah modul tingkat atas untuk menentukan skema atribut aturan atau aspek. Setiap fungsi menampilkan objek yang mewakili skema satu atribut. Objek ini digunakan sebagai nilai argumen kamus attrs dari rule() dan aspect().

Lihat halaman Aturan untuk mengetahui informasi selengkapnya tentang cara menentukan dan menggunakan atribut.

Anggota

bool

Attribute attr.bool(default=False, doc=None, mandatory=False)

Membuat skema untuk atribut boolean. Atribut ctx.attr yang sesuai akan berjenis bool.

Parameter

Parameter Deskripsi
default default adalah False
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).

int

Attribute attr.int(default=0, doc=None, mandatory=False, values=[])

Membuat skema untuk atribut bilangan bulat. Nilai harus dalam rentang 32-bit yang telah ditandai. Atribut ctx.attr yang sesuai akan berjenis int.

Parameter

Parameter Deskripsi
default default adalah 0
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
values urutan int; default adalah []
Daftar nilai yang diizinkan untuk atribut. Error akan muncul jika nilai lain diberikan.

int_list

Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

Membuat skema untuk atribut daftar bilangan bulat. Setiap elemen harus berada dalam rentang 32-bit bertanda.

Parameter

Parameter Deskripsi
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
allow_empty default adalah True
Benar jika atribut dapat kosong.
default urutan int; default adalah []
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.

label

Attribute attr.label(default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[], flags=[])

Membuat skema untuk atribut label. Ini adalah atribut dependensi.

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis (dalam fungsi penerapan aturan), saat mengambil nilai atribut dari ctx.attr, label akan diganti dengan Target yang sesuai. Hal ini memungkinkan Anda mengakses penyedia dependensi target saat ini.

Selain file sumber biasa, jenis atribut ini sering digunakan untuk merujuk ke alat -- misalnya, compiler. Alat tersebut dianggap sebagai dependensi, sama seperti file sumber. Agar pengguna tidak perlu menentukan label alat setiap kali mereka menggunakan aturan dalam file BUILD, Anda dapat melakukan hard code pada label alat kanonis sebagai nilai default atribut ini. Jika Anda juga ingin mencegah pengguna mengganti setelan default ini, Anda dapat membuat atribut menjadi pribadi dengan memberinya nama yang diawali dengan garis bawah. Lihat halaman Aturan untuk mengetahui informasi selengkapnya.

Parameter

Parameter Deskripsi
default Label; atau string; atau LateBoundDefault; atau NativeComputedDefault; atau function; atau None; default adalah None
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.Gunakan string atau fungsi Label untuk menentukan nilai default, misalnya, attr.label(default = "//a:b").
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
executable default adalah False
Benar jika dependensi harus dapat dieksekusi. Artinya, label harus merujuk ke file yang dapat dieksekusi, atau ke aturan yang menghasilkan file yang dapat dieksekusi. Akses label dengan ctx.executable.<attribute_name>.
allow_files bool; atau urutan string; atau None; defaultnya adalah None
Apakah target File diizinkan. Dapat berupa True, False (default), atau daftar ekstensi file yang diizinkan (misalnya, [".cc", ".cpp"]).
allow_single_file default adalah None
Ini mirip dengan allow_files, dengan batasan bahwa label harus sesuai dengan satu File. Akses melalui ctx.file.<attribute_name>.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
providers default adalah []
Penyedia yang harus diberikan oleh dependensi apa pun yang muncul dalam atribut ini.

Format argumen ini adalah daftar daftar penyedia -- objek *Info yang ditampilkan oleh provider() (atau dalam kasus penyedia lama, nama stringnya). Dependensi harus menampilkan SEMUA penyedia yang disebutkan di setidaknya SATU daftar dalam. Untuk memudahkan, argumen ini juga dapat berupa daftar penyedia satu tingkat, dalam hal ini argumen akan digabungkan dalam daftar luar dengan satu elemen. Aturan dependensi TIDAK diwajibkan untuk mengiklankan penyedia tersebut dalam parameter provides-nya, tetapi hal ini dianggap sebagai praktik terbaik.

allow_rules urutan string; atau None; default adalah None
Target aturan mana (nama class) yang diizinkan. Fungsi ini tidak digunakan lagi (hanya dipertahankan untuk kompatibilitas), gunakan penyedia sebagai gantinya.
cfg default adalah None
Konfigurasi atribut. Nilainya dapat berupa "exec", yang menunjukkan bahwa dependensi dibuat untuk execution platform, atau "target", yang menunjukkan bahwa dependensi dibuat untuk target platform. Contoh umum perbedaannya adalah saat mem-build aplikasi seluler, dengan target platform adalah Android atau iOS, sedangkan execution platform adalah Linux, macOS, atau Windows. Parameter ini diperlukan jika executable bernilai True untuk mencegah pembuatan alat host secara tidak sengaja dalam konfigurasi target. "target" tidak memiliki efek semantik, jadi jangan tetapkan jika executable bernilai Salah (False), kecuali jika benar-benar membantu memperjelas niat Anda.
aspects urutan Aspek; default adalah []
Aspek yang harus diterapkan ke dependensi atau dependensi yang ditentukan oleh atribut ini.
flags urutan string; default-nya adalah []
Tidak digunakan lagi, akan dihapus.

label_keyed_string_dict

Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Membuat skema untuk atribut yang menyimpan kamus, dengan kunci adalah label dan nilai adalah string. Ini adalah atribut dependensi.

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis (dalam fungsi penerapan aturan), saat mengambil nilai atribut dari ctx.attr, label akan diganti dengan Target yang sesuai. Hal ini memungkinkan Anda mengakses penyedia dependensi target saat ini.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
default dict; atau function; default adalah {}
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.Gunakan string atau fungsi Label untuk menentukan nilai default, misalnya, attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}).
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
allow_files bool; atau urutan string; atau None; defaultnya adalah None
Apakah target File diizinkan. Dapat berupa True, False (default), atau daftar ekstensi file yang diizinkan (misalnya, [".cc", ".cpp"]).
allow_rules urutan string; atau None; default adalah None
Target aturan mana (nama class) yang diizinkan. Fungsi ini tidak digunakan lagi (hanya dipertahankan untuk kompatibilitas), gunakan penyedia sebagai gantinya.
providers default adalah []
Penyedia yang harus diberikan oleh dependensi apa pun yang muncul dalam atribut ini.

Format argumen ini adalah daftar daftar penyedia -- objek *Info yang ditampilkan oleh provider() (atau dalam kasus penyedia lama, nama stringnya). Dependensi harus menampilkan SEMUA penyedia yang disebutkan di setidaknya SATU daftar dalam. Untuk memudahkan, argumen ini juga dapat berupa daftar penyedia satu tingkat, dalam hal ini argumen akan digabungkan dalam daftar luar dengan satu elemen. Aturan dependensi TIDAK diwajibkan untuk mengiklankan penyedia tersebut dalam parameter provides-nya, tetapi hal ini dianggap sebagai praktik terbaik.

flags urutan string; default-nya adalah []
Tidak digunakan lagi, akan dihapus.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
cfg default adalah None
Konfigurasi atribut. Nilainya dapat berupa "exec", yang menunjukkan bahwa dependensi dibuat untuk execution platform, atau "target", yang menunjukkan bahwa dependensi dibuat untuk target platform. Contoh umum perbedaannya adalah saat mem-build aplikasi seluler, dengan target platform adalah Android atau iOS, sedangkan execution platform adalah Linux, macOS, atau Windows.
aspects urutan Aspek; default adalah []
Aspek yang harus diterapkan ke dependensi atau dependensi yang ditentukan oleh atribut ini.

label_list

Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Membuat skema untuk atribut daftar label. Ini adalah atribut dependensi. Atribut ctx.attr yang sesuai akan berjenis daftar Target.

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis (dalam fungsi penerapan aturan), saat mengambil nilai atribut dari ctx.attr, label akan diganti dengan Target yang sesuai. Hal ini memungkinkan Anda mengakses penyedia dependensi target saat ini.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
default urutan Label; atau fungsi; default adalah []
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.Gunakan string atau fungsi Label untuk menentukan nilai default, misalnya, attr.label_list(default = ["//a:b", "//a:c"]).
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
allow_files bool; atau urutan string; atau None; defaultnya adalah None
Apakah target File diizinkan. Dapat berupa True, False (default), atau daftar ekstensi file yang diizinkan (misalnya, [".cc", ".cpp"]).
allow_rules urutan string; atau None; default adalah None
Target aturan mana (nama class) yang diizinkan. Fungsi ini tidak digunakan lagi (hanya dipertahankan untuk kompatibilitas), gunakan penyedia sebagai gantinya.
providers default adalah []
Penyedia yang harus diberikan oleh dependensi apa pun yang muncul dalam atribut ini.

Format argumen ini adalah daftar daftar penyedia -- objek *Info yang ditampilkan oleh provider() (atau dalam kasus penyedia lama, nama stringnya). Dependensi harus menampilkan SEMUA penyedia yang disebutkan di setidaknya SATU daftar dalam. Untuk memudahkan, argumen ini juga dapat berupa daftar penyedia satu tingkat, dalam hal ini argumen akan digabungkan dalam daftar luar dengan satu elemen. Aturan dependensi TIDAK diwajibkan untuk mengiklankan penyedia tersebut dalam parameter provides-nya, tetapi hal ini dianggap sebagai praktik terbaik.

flags urutan string; default-nya adalah []
Tidak digunakan lagi, akan dihapus.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
cfg default adalah None
Konfigurasi atribut. Nilainya dapat berupa "exec", yang menunjukkan bahwa dependensi dibuat untuk execution platform, atau "target", yang menunjukkan bahwa dependensi dibuat untuk target platform. Contoh umum perbedaannya adalah saat mem-build aplikasi seluler, dengan target platform adalah Android atau iOS, sedangkan execution platform adalah Linux, macOS, atau Windows.
aspects urutan Aspek; default adalah []
Aspek yang harus diterapkan ke dependensi atau dependensi yang ditentukan oleh atribut ini.

hasil

Attribute attr.output(doc=None, mandatory=False)

Membuat skema untuk atribut output (label).

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis, File yang sesuai dapat diambil menggunakan ctx.outputs.

Parameter

Parameter Deskripsi
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).

output_list

Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)

Membuat skema untuk atribut daftar output.

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis, File yang sesuai dapat diambil menggunakan ctx.outputs.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).

string

Attribute attr.string(default='', doc=None, mandatory=False, values=[])

Membuat skema untuk atribut string.

Parameter

Parameter Deskripsi
default string; atau NativeComputedDefault; default adalah ''
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
values urutan string; default adalah []
Daftar nilai yang diizinkan untuk atribut. Error akan muncul jika nilai lain diberikan.

string_dict

Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

Membuat skema untuk atribut yang menyimpan kamus, dengan kunci dan nilai berupa string.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
default default adalah {}
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).

string_keyed_label_dict

Attribute attr.string_keyed_label_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Membuat skema untuk atribut yang nilainya adalah kamus dengan kunci berupa string dan nilai berupa label. Ini adalah atribut dependensi.

Atribut ini berisi nilai Label yang unik. Jika string diberikan sebagai pengganti Label, string tersebut akan dikonversi menggunakan konstruktor label. Bagian relatif dari jalur label, termasuk repositori (mungkin diganti namanya), di-resolve sehubungan dengan paket target yang dibuat instance-nya.

Pada waktu analisis (dalam fungsi penerapan aturan), saat mengambil nilai atribut dari ctx.attr, label akan diganti dengan Target yang sesuai. Hal ini memungkinkan Anda mengakses penyedia dependensi target saat ini.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
default dict; atau function; default adalah {}
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.Gunakan string atau fungsi Label untuk menentukan nilai default, misalnya, attr.string_keyed_label_dict(default = {"foo": "//a:b", "bar": "//a:c"}).
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
allow_files bool; atau urutan string; atau None; defaultnya adalah None
Apakah target File diizinkan. Dapat berupa True, False (default), atau daftar ekstensi file yang diizinkan (misalnya, [".cc", ".cpp"]).
allow_rules urutan string; atau None; default adalah None
Target aturan mana (nama class) yang diizinkan. Fungsi ini tidak digunakan lagi (hanya dipertahankan untuk kompatibilitas), gunakan penyedia sebagai gantinya.
providers default adalah []
Penyedia yang harus diberikan oleh dependensi apa pun yang muncul dalam atribut ini.

Format argumen ini adalah daftar daftar penyedia -- objek *Info yang ditampilkan oleh provider() (atau dalam kasus penyedia lama, nama stringnya). Dependensi harus menampilkan SEMUA penyedia yang disebutkan di setidaknya SATU daftar dalam. Untuk memudahkan, argumen ini juga dapat berupa daftar penyedia satu tingkat, dalam hal ini argumen akan digabungkan dalam daftar luar dengan satu elemen. Aturan dependensi TIDAK diwajibkan untuk mengiklankan penyedia tersebut dalam parameter provides-nya, tetapi hal ini dianggap sebagai praktik terbaik.

flags urutan string; default-nya adalah []
Tidak digunakan lagi, akan dihapus.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
cfg default adalah None
Konfigurasi atribut. Nilainya dapat berupa "exec", yang menunjukkan bahwa dependensi dibuat untuk execution platform, atau "target", yang menunjukkan bahwa dependensi dibuat untuk target platform. Contoh umum perbedaannya adalah saat mem-build aplikasi seluler, dengan target platform adalah Android atau iOS, sedangkan execution platform adalah Linux, macOS, atau Windows.
aspects urutan Aspek; default adalah []
Aspek yang harus diterapkan ke dependensi atau dependensi yang ditentukan oleh atribut ini.

string_list

Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

Membuat skema untuk atribut daftar string.

Parameter

Parameter Deskripsi
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).
allow_empty default adalah True
Benar jika atribut dapat kosong.
default urutan string; atau NativeComputedDefault; default adalah []
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.

string_list_dict

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

Membuat skema untuk atribut yang menyimpan kamus, dengan kunci berupa string dan nilai berupa daftar string.

Parameter

Parameter Deskripsi
allow_empty default adalah True
Benar jika atribut dapat kosong.
default default adalah {}
Nilai default yang akan digunakan jika tidak ada nilai untuk atribut ini yang diberikan saat membuat instance aturan.
doc string; atau None; default adalah None
Deskripsi atribut yang dapat diekstrak oleh alat pembuat dokumentasi.
mandatory default adalah False
Jika benar, nilai harus ditentukan secara eksplisit (meskipun memiliki default).