Yerel kuralları ve diğer paket yardımcı işlevlerini destekleyen yerleşik bir modül. Tüm yerel kurallar bu modülde işlev olarak görünür (ör. native.cc_library
). Yerel modülün yalnızca yükleme aşamasında kullanılabildiğini (yani kural uygulamalarında değil, makrolar için) unutmayın. Özellikler, None
değerlerini yok sayar ve bunları özellik ayarlanmamış gibi değerlendirir.
Aşağıdaki işlevler de kullanılabilir:
Üyeler
- existing_rule
- existing_rules
- exports_files
- glob
- module_name
- module_version
- package_group
- package_name
- package_relative_label
- repo_name
- repository_name
- subpackages
existing_rule
unknown native.existing_rule(name)Bu ileti dizisinin paketinde örneklendirilmiş 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 değişmez sözlük benzeri nesne, sözlük benzeri iterasyonu (len(x)
, name in x
, x[name]
, x.get(name)
, x.items()
, x.keys()
ve x.values()
) destekleyen, temelden değişmez bir nesne x
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.
Sonuçtaki değerler, özellik değerlerini aşağıdaki gibi 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.
select
değerleri, içerikleri yukarıda açıklandığı şekilde dönüştürülmüş olarak döndürülür.- Kuralın oluşturulması sırasında değeri 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 tamamlayıcısı 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 native.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 değişmez sözlük benzeri nesne, sözlük benzeri iterasyonu (len(x)
, name in x
, x[name]
, x.get(name)
, x.items()
, x.keys()
ve x.values()
) destekleyen, temelden değişmez bir nesne x
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
native.exports_files(srcs, visibility=None, licenses=None)
Bu pakete ait olup diğer paketlere aktarılan dosyaların listesini belirtir.
Parametreler
Parametre | Açıklama |
---|---|
srcs
|
Dize dizisi;
zorunlu Dışa aktarılacak dosyaların listesi. |
visibility
|
sequence veya None ;
varsayılan değer None Görünürlük beyanı 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 None Belirtilecek lisanslar. |
glob
sequence native.glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)Glob, geçerli paketteki her dosyanın yeni, değiştirilebilir ve sıralanmış bir listesini döndürür. Bu liste:
include
'te en az bir kalıpla eşleşir.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 dizisi;
varsayılan değer [] Dahil edilecek genel eşleme kalıplarının listesi. |
exclude
|
Dize dizisi;
varsayılan değer [] Hariç tutulacak genel eşleme kalıplarının listesi. |
exclude_directories
|
int;
varsayılan değer 1 Dizinlerin hariç tutulup tutulmayacağını belirten bir işaret. |
allow_empty
|
varsayılan değer unbound Glob kalıplarının hiçbir şeyle eşleşmesine izin verip vermeyeceğimizi belirtir. "allow_empty" değeri False ise her dahil etme kalıbı bir şeyle eşleşmeli ve nihai sonuç da boş olmamalıdır ("exclude" kalıplarının eşleşmeleri hariç tutulduktan sonra). |
module_name
string native.module_name()Bu paketin bulunduğu depoyla ilişkili Bazel modülünün adı. Bu paket MODULE.bazel yerine WORKSPACE içinde tanımlanan bir depodaysa bu alan boştur. Modül uzantıları tarafından oluşturulan depolar için 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 native.module_version()Bu paketin bulunduğu depoyla ilişkili Bazel modülünün sürümü. Bu paket MODULE.bazel yerine WORKSPACE içinde tanımlanmış bir depodaysa bu alan boştur. 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
değerini döndürebilir.
package_group
None
native.package_group(name, packages=[], includes=[])
Bu işlev, bir paket grubu tanımlar ve gruba bir etiket atar. Etiket, 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 native.package_name()Depo adı olmadan değerlendirilen paketin adı. Örneğin, BUILD dosyasında
some/package/BUILD
için değer some/package
olur. BUILD dosyası bir .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 native.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()
'in BUILD
dosyasının paketini değil, kendisini çağıran .bzl
dosyasının paketini 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 her zaman etiket dizeleri yerine etiket nesnelerini iç makrolara iletmeyi 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 native.repo_name()Şu anda değerlendirilmekte olan paketi içeren deponun, @ işareti içermeyen standart adı.
repository_name
string native.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 kıtası tarafından oluşturulan paketlerde local_repository(name='local', path=...)
, @local
olarak ayarlanır. Ana depoda bulunan paketlerde bu değer @
olarak ayarlanır.
alt paketler
sequence native.subpackages(include, exclude=[], allow_empty=False)Dosya sistemi dizini derinliğinden bağımsız olarak, geçerli 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 dizisi;
varsayılan değer [] Alt paket taramasından hariç tutulacak genel ifade 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 olarak ayarlandığında bu işlev bu durumda başarılı olur. |