BUILD dosyalarında kullanılabilen yöntemler. Ayrıca, DERLE dosyalarında da kullanılabilecek ek işlevler ve oluşturma kuralları için Build Ansiklopedisi Oluşturma konusuna göz atın.
Üyeler
- depset
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- seçme
- subpackages
depset
depset depset(direct=None, order="default", *, transitive=None)Bir depset oluşturur.
direct parametresi, bağımlılık grubunun doğrudan öğelerinin bir listesi, transitive parametresi ise öğeleri oluşturulan bağımlılık grubunun dolaylı öğeleri haline gelen bağımlılık gruplarının bir listesidir. Depset bir listeye dönüştürüldüğünde öğelerin döndürülme sırası order parametresiyle belirtilir. Daha fazla bilgi için Depset'lere genel bakış başlıklı makaleyi inceleyin.
Bir kümenin tüm öğeleri (doğrudan ve dolaylı), type(x) ifadesiyle elde edilenle aynı türde olmalıdır.
Yineleme sırasında yinelemeleri ortadan kaldırmak için karma oluşturmaya dayalı bir küme kullanıldığından, depset'in tüm öğeleri karma oluşturmaya uygun olmalıdır. Ancak bu değişmez özellik şu anda tüm kurucularda tutarlı bir şekilde kontrol edilmemektedir. Tutarlı kontrolü etkinleştirmek için --incompatible_always_check_depset_elements işaretini kullanın. Bu, gelecekteki sürümlerde varsayılan davranış olacaktır. Sayı 10313 sorununa bakın.
Ayrıca, öğeler şu anda değiştirilemez olmalıdır ancak bu kısıtlama gelecekte gevşetilecektir.
Oluşturulan depo grubunun sırası, transitive depo gruplarının sırasıyla uyumlu olmalıdır. "default" siparişi diğer tüm siparişlerle uyumludur. Diğer tüm siparişler yalnızca kendileriyle uyumludur.
Parametreler
| Parametre | Açıklama |
|---|---|
direct
|
sequence; veya None; varsayılan olarak None değeridirBir kümenin doğrudan öğelerinin listesi. |
order
|
dize;
varsayılan değer "default"Yeni depset için tarama stratejisi. Olası değerler için buraya bakın. |
transitive
|
Depset dizisi veya None;
varsayılan değer NoneÖğeleri, depsetin dolaylı öğeleri olacak depsetlerin listesi. |
existing_rule
unknown existing_rule(name)Bu ileti dizisinin paketinde örneklendirilen bir kuralın özelliklerini açıklayan, değişmez bir sözlük benzeri nesne döndürür veya bu ada sahip bir kural örneği yoksa
None döndürür.Burada dikkat benzeri sabit nesne, dikt benzeri yinelemeyi destekleyen x, tamamen sabit olmayan nesne x, len(x), name in x, x[name], x.get(name), x.items(), x.keys() ve x.values() anlamına gelir.
Sonuç, özel olanlar (adları harfle başlamayan) ve temsil edilemeyen birkaç eski özellik türü hariç her özellik için bir giriş içerir. Ayrıca sözlük, kural örneğinin name ve kind (örneğin, 'cc_binary') değerleri için girişler içerir.
Sonucun değerleri, özellik değerlerini şu şekilde temsil eder:
- str, int ve bool türünde özellikler olduğu gibi temsil edilir.
- Etiketler, aynı paketteki hedefler için
':foo'veya farklı bir paketteki hedefler için'//pkg:name'biçiminde dizeler halinde dönüştürülür. - Listeler tuple olarak, sözlükler ise yeni ve değiştirilebilir sözlüklere dönüştürülür. Öğeleri de aynı şekilde yinelemeli olarak dönüştürülür.
selectdeğerleri, içerikleri yukarıda açıklandığı şekilde dönüştürülmüş olarak döndürülür.- Kural örneklendirmesi sırasında hiçbir değer belirtilmeyen ve varsayılan değeri hesaplanan özellikler sonuçtan hariç tutulur. (Hesaplanmış varsayılan değerler, analiz aşamasına kadar hesaplanamaz.).
Mümkünse bu işlevi yalnızca kural sonlandırıcı sembolik makrolarının uygulama işlevlerinde kullanın. Bu işlevin diğer bağlamlarda kullanılması önerilmez ve gelecekteki bir Bazel sürümünde devre dışı bırakılacaktır. Bu işlev, BUILD dosyalarını kırılgan ve sıraya bağımlı hale getirir. Ayrıca, kural özelliği değerlerinin dahili biçimden Starlark'a yapılan diğer iki dönüşümden farklı olduğuna dikkat edin: Biri hesaplanmış varsayılanlar tarafından, diğeri ctx.attr.foo tarafından kullanılır.
Parametreler
| Parametre | Açıklama |
|---|---|
name
|
string;
required Hedefin adı. |
existing_rules
unknown existing_rules()Bu ileti dizisinin paketinde şimdiye kadar oluşturulan kuralları açıklayan, değiştirilemeyen bir sözlük benzeri nesne döndürür. Sözlük benzeri nesnenin her girişi, kural örneğinin adını
existing_rule(name) tarafından döndürülecek sonuçla eşler.Burada dikkat benzeri sabit nesne, dikt benzeri yinelemeyi destekleyen x, tamamen sabit olmayan nesne x, len(x), name in x, x[name], x.get(name), x.items(), x.keys() ve x.values() anlamına gelir.
Mümkünse bu işlevi yalnızca kural sonlandırıcı sembolik makrolarının uygulama işlevlerinde kullanın. Bu işlevin diğer bağlamlarda kullanılması önerilmez ve gelecekteki bir Bazel sürümünde devre dışı bırakılacaktır. Bu işlev, BUILD dosyalarını kırılgan ve sıraya bağımlı hale getirir.
exports_files
None exports_files(srcs, visibility=None, licenses=None)Parametreler
| Parametre | Açıklama |
|---|---|
srcs
|
Dize dizisi;
zorunlu Dışa aktarılacak dosyaların listesi. |
visibility
|
sequence; veya None;
varsayılan olarak NoneGörünürlük bildirimi belirtilebilir. Dosyalar, belirtilen hedefler tarafından görülebilir. Görünürlük belirtilmezse dosyalar her paket tarafından görülebilir. |
licenses
|
Dize dizisi veya None;
varsayılan değer NoneBelirtilecek lisanslar. |
glob
sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)Glob, geçerli paketteki her dosya için aşağıdaki özelliklere sahip yeni, değişebilir, sıralanmış bir liste döndürür:
includeiçindeki en az bir kalıpla eşleşiyor.exclude(varsayılan[]) içindeki kalıpların hiçbiriyle eşleşmez.
exclude_directories bağımsız değişkeni etkinleştirilirse (1 olarak ayarlanırsa) dizin türündeki dosyalar sonuçlardan çıkarılır (varsayılan 1).
Parametreler
| Parametre | Açıklama |
|---|---|
include
|
dize değerlerinin sequence (dizi) değeri; varsayılan değer []'dir. Dahil edilecek glob kalıplarının listesidir. |
exclude
|
Dize dizisi;
varsayılan değer []Hariç tutulacak genel ifade kalıplarının listesi. |
exclude_directories
|
int;
varsayılan değer 1Dizinlerin hariç tutulup tutulmayacağını belirten bir işaret. |
allow_empty
|
varsayılan değer unboundGlob kalıplarının hiçbir şeyle eşleşmesine izin verip vermeyeceğimizi belirtir. "allow_boş" Yanlış değerine ayarlanırsa her bağımsız dahil etme kalıbı bir öğeyle eşleşmeli ve nihai sonuç boş olmamalıdır ("hariç_tutulan" kalıplarıyla eşleşmeler hariç tutulduktan sonra). |
module_name
string module_name()Bu paketin bulunduğu depoyla ilişkili Bazel modülünün adı. Bu paket MODULE.bazel yerine WORKSPACE içinde tanımlanmış bir depodaysa bu alan boştur. Modül uzantıları tarafından oluşturulan depolarda bu, uzantıyı barındıran modülün adıdır.
module_ctx.modules içinde görülen module.name alanıyla aynıdır.
None değerini döndürebilir.
module_version
string module_version()Bu paketin bulunduğu depoyla ilişkili Bazel modülünün sürümü. Bu paket MODULE.bazel yerine WORKSPACE'te tanımlanan bir depodan geliyorsa bu boş olur. Modül uzantıları tarafından oluşturulan depolar için bu, uzantıyı barındıran modülün sürümüdür.
module_ctx.modules içinde görülen module.version alanıyla aynıdır.
None sonucunu döndürebilir.
package_group
None package_group(name, packages=[], includes=[])visibility özelliklerinde referans olarak kullanılabilir.
Parametreler
| Parametre | Açıklama |
|---|---|
name
|
dize;
zorunlu Bu kuralın benzersiz adı. |
packages
|
Dize dizisi;
varsayılan değer []Bu gruptaki paketlerin tam listesi. |
includes
|
Dize dizisi;
varsayılan değer []Bu pakete dahil edilen diğer paket grupları. |
package_name
string package_name()Depo adı olmadan değerlendirilen paketin adı. Örneğin,
some/package/BUILD BUILD dosyasında değeri some/package olur. BUILD dosyası, .bzl dosyasında tanımlanan bir işlevi çağırıyorsa package_name(), çağıran BUILD dosyası paketiyle eşleşir.
package_relative_label
Label package_relative_label(input)Giriş dizesini, şu anda başlatılmakta olan paket bağlamında (yani mevcut makronun yürütüldüğü
BUILD dosyası) bir Etiket nesnesine dönüştürür. Giriş zaten bir Label ise değişmeden döndürülür.Bu işlev yalnızca bir BUILD dosyası ve doğrudan veya dolaylı olarak çağırdığı makrolar değerlendirilirken çağrılabilir; (ör.) kural uygulama işlevinde çağrılamaz.
Bu işlevin sonucu, verilen dizenin BUILD dosyasında tanımlanan bir hedefin etiket değerli özelliğine iletilmesi sonucunda üretilecek Label değeriyle aynıdır.
Kullanım notu: Bu işlev ile Label() arasındaki fark Label() özelliğinin BUILD dosyasının paketini değil, onu çağıran .bzl dosyasının paketinin bağlamını kullanmasıdır. Bir derleyici gibi makroya sabit kodlanmış sabit bir hedefe başvurmanız gerektiğinde Label() değerini kullanın. BUILD dosyası tarafından sağlanan bir etiket dizesini Label nesnesine normalleştirmeniz gerektiğinde package_relative_label() kullanın. (BUILD dosyası veya çağıran .bzl dosyası dışında bir paket bağlamında bir dizeyi Label olarak dönüştürmenin bir yolu yoktur. Bu nedenle, dış makrolar Etiket nesnelerini her zaman etiket dizeleri yerine iç makrolara geçirmeyi tercih etmelidir.)
Parametreler
| Parametre | Açıklama |
|---|---|
input
|
dize veya Etiket;
zorunlu Giriş etiketi dizesi veya Etiket nesnesi. Bir Label nesnesi iletilirse olduğu gibi döndürülür. |
repo_name
string repo_name()Şu anda değerlendirilmekte olan paketi içeren deponun, önde gelen işaret işaretleri olmadan standart adı.
repository_name
string repository_name()Deneysel. Bu API deneme aşamasındadır ve herhangi bir zamanda değişebilir. Lütfen bu yönteme güvenmeyin.
--+incompatible_enable_deprecated_label_apis Desteklenmiyor olarak ayarlanarak deneysel olarak etkinleştirilebilir. Bunun yerine,
repo_name kullanmayı tercih edin. Bu karakter, sahte bir @ işareti içermez ancak diğer açılardan aynı şekilde çalışır.Şu anda değerlendirilmekte olan paketi içeren deponun, başına tek bir @ işareti (@) eklenmiş standart adı. Örneğin, WORKSPACE local_repository(name='local', path=...) ifadesiyle varlığa çağrılan paketlerde bu değer @local olarak ayarlanır. Ana depoda bulunan paketlerde bu değer @ olarak ayarlanır.
seç
unknown select(x, no_match_error='')
select(), kural özelliğini yapılandırılabilir hale getiren yardımcı işlevdir. Ayrıntılar için derleme ansiklopedisine bakın.
Parametreler
| Parametre | Açıklama |
|---|---|
x
|
dict;
required Yapılandırma koşullarını değerlerle eşleyen bir diktedir. Her anahtar, bir config_setting veya constraint_value örneğini tanımlayan bir etiket ya da etiket dizesidir. Dize yerine etiketin ne zaman kullanılacağı hakkında bilgi edinmek için makrolarla ilgili dokümanlara bakın. |
no_match_error
|
dize;
varsayılan olarak ''Hiçbir koşul eşleşmezse raporlanacak isteğe bağlı özel hata. |
alt paketler
sequence subpackages(include, exclude=[], allow_empty=False)Dosya sistemi dizini derinliğinden bağımsız olarak, mevcut paketin her doğrudan alt paketinin yeni ve değiştirilebilir bir listesini döndürür. Döndürülen liste sıralanır ve mevcut pakete göre alt paketlerin adlarını içerir. Bu işlevi doğrudan çağırmak yerine bazel_skylib.subpackages modülündeki yöntemleri tercih etmeniz önerilir.
Parametreler
| Parametre | Açıklama |
|---|---|
include
|
Dize dizisi;
zorunlu Alt paket taramasına dahil edilecek genel eşleme kalıplarının listesi. |
exclude
|
dize'lerin sequence'ı;
varsayılan []Alt paket taramasından hariç tutulacak glob kalıplarının listesi. |
allow_empty
|
bool;
varsayılan değer FalseÇağrı boş bir liste döndürürse başarısız olup olmayacağımızı belirtir. Varsayılan olarak boş liste, BUILD dosyasında subpackages() çağrısının gereksiz olduğu potansiyel hatayı gösterir. Doğru değerine ayarlamak, bu durumda bu işlevin başarılı olmasını sağlar. |