Tüm .bzl dosyalarında kullanılabilen genel yöntemler.
Üyeler
- analysis_test_transition
- aspect
- configuration_field
- depset
- exec_group
- module_extension
- sağlayıcı
- repository_rule
- rule
- seçme
- alt kural
- tag_class
- görünürlük
analysis_test_transition
transition analysis_test_transition(settings)
Bir analiz-test kuralının bağımlılıklarına uygulanacak bir yapılandırma geçişi oluşturur. Bu geçiş yalnızca analysis_test = True
içeren kuralların özelliklerine uygulanabilir. Bu tür kuralların özellikleri kısıtlıdır (ör. bağımlılık ağaçlarının boyutu sınırlıdır). Bu nedenle, bu işlev kullanılarak oluşturulan geçişler, transition()
kullanılarak oluşturulan geçişlere kıyasla potansiyel kapsam açısından sınırlıdır.
Bu işlev, öncelikle Analysis Test Framework temel kitaplığını kolaylaştırmak için tasarlanmıştır. En iyi uygulamalar için ilgili dokümanları (veya uygulamayı) inceleyin.
Parametreler
Parametre | Açıklama |
---|---|
settings
|
required Bu yapılandırma geçişi tarafından ayarlanması gereken yapılandırma ayarları hakkında bilgi içeren bir sözlük. Anahtarlar, derleme ayarı etiketleridir ve değerler, geçiş sonrası yeni değerleridir. Diğer tüm ayarlar değişmez. Bir analiz testinin geçmesi için ayarlanması gereken belirli yapılandırma ayarlarını belirtmek amacıyla bunu kullanın. |
ilişkili program
Aspect aspect(implementation, attr_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])Yeni bir boyut oluşturur. Bu işlevin sonucu bir genel değerde depolanmalıdır. Daha fazla bilgi için lütfen yönlere giriş başlıklı makaleyi inceleyin.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
required Bu yönü uygulayan ve tam olarak iki parametre içeren bir Starlark işlevi: Target (yönün uygulandığı hedef) ve ctx (hedefin oluşturulduğu kural bağlamı). Hedefin özellikleri ctx.rule alanı üzerinden kullanılabilir. Bu işlev, analiz aşamasında bir özelliğin hedefe her uygulanması için değerlendirilir.
|
attr_aspects
|
Dize dizisi;
varsayılan değer [] Özellik adlarının listesi. Görünüm, bu adlara sahip bir hedefin özelliklerinde belirtilen bağımlılıklar boyunca yayılır. Buradaki yaygın değerler arasında deps ve exports bulunur. Liste, bir hedefin tüm bağımlılıkları boyunca dağıtılacak tek bir dize "*" de içerebilir.
|
attrs
|
dict;
varsayılan değer {} Boyutun tüm özelliklerini açıklayan bir sözlük. Bir özellik adını "attr.label" veya "attr.string" gibi bir özellik nesnesine eşler (attr modülüne bakın). Yön özellik değerleri, uygulama işlevi tarafından ctx parametresinin alanları olarak kullanılabilir.
Açık atıf özellikleri |
required_providers
|
varsayılan olarak [] şeklindedirBu özellik, özelliğin yayılmasını, yalnızca kuralları zorunlu sağlayıcıların reklamını yapan hedeflerle sınırlandırmasına olanak tanır. Değer, tek tek sağlayıcıları veya sağlayıcı listelerini içeren bir liste olmalıdır ancak ikisini birden içermemelidir. Örneğin, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] geçerli bir değerken [FooInfo, BarInfo, [BazInfo, QuxInfo]] geçerli değildir.İç içe yerleştirilmemiş sağlayıcılar listesi, otomatik olarak bir sağlayıcı listesi içeren bir listeye dönüştürülecektir. Yani Bazı kuralların (ör. |
required_aspect_providers
|
varsayılan değer [] Bu özellik, bu yönün diğer yönleri incelemesine olanak tanır. Değer, tek tek sağlayıcıları veya sağlayıcı listelerini içeren bir liste olmalıdır ancak ikisini birden içermemelidir. Örneğin, [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] geçerli bir değerken [FooInfo, BarInfo, [BazInfo, QuxInfo]] geçerli değildir.İç içe yerleştirilmemiş bir sağlayıcı listesi, otomatik olarak tek bir sağlayıcı listesi içeren bir listeye dönüştürülür. Yani Başka bir yönü (ör. |
provides
|
varsayılan değer [] Uygulama işlevinin döndürmesi gereken sağlayıcıların listesi. Uygulama işlevi, burada listelenen sağlayıcı türlerinden herhangi birini dönüş değerinden çıkarırsa hata oluşur. Ancak uygulama işlevi, burada listelenmeyen ek sağlayıcılar döndürebilir. Listenin her öğesi, |
requires
|
Aspect sequence;
varsayılan değer [] Bu özellikten önce dağıtılması gereken özelliklerin listesi. |
fragments
|
Dize dizisi;
varsayılan değer [] Yönelinmenin hedef yapılandırmada gerektirdiği yapılandırma parçalarının adları. |
host_fragments
|
Dize dizisi;
varsayılan değer [] Yönelinmenin ana makine yapılandırmasında gerektirdiği yapılandırma parçalarının adları. |
toolchains
|
sequence;
varsayılan değer [] Ayarlanırsa bu kuralın gerektirdiği araç zinciri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesnelerini içerebilir. Araçlar zincirleri, mevcut platform kontrol edilerek bulunur ve ctx.toolchain aracılığıyla kural uygulamasına sağlanır.
|
incompatible_use_toolchain_transition
|
varsayılan değer False Desteği sonlandırıldı, artık kullanılmıyor ve kaldırılması gerekiyor. |
doc
|
dize veya None ;
varsayılan değer None Belge oluşturma araçları tarafından ayıklanabilen yönün açıklaması. |
apply_to_generating_rules
|
varsayılan değer False Doğru ise bir çıkış dosyasına uygulanan yön, çıkış dosyasının oluşturma kuralına uygulanır. Örneğin, bir özelliğin "deps" özelliği aracılığıyla aktarmalı olarak yayıldığını ve "alpha" hedefine uygulandığını varsayalım. "alpha"nın "deps = [':beta_output']" değerine sahip olduğunu varsayalım. Burada "beta_output", bir "beta" hedefinin tanımlanmış bir çıkışıdır. "beta"nın "deps" özelliklerinden biri olarak "charlie" hedefinin olduğunu varsayalım. Özellik için "apply_to_generating_rules=True" ise özellik "alpha", "beta" ve "charlie" aracılığıyla yayılır. Yanlış ise özellik yalnızca "alpha"ya yayılır. Varsayılan olarak yanlıştır. |
exec_compatible_with
|
dizelerin sequence'ı;
varsayılan [] Yürütme platformunda bu özelliğin tüm örnekleri için geçerli olan kısıtlamaların listesi. |
exec_groups
|
dict veya None ;
varsayılan değer None Yürütme grubu adının (dize) exec_group s olarak dize dizini. Ayarlanırsa yönlerin tek bir örnek içinde birden fazla yürütme platformunda işlemler çalıştırmasına olanak tanır. Daha fazla bilgi için yürütme grupları belgelerine bakın.
|
subrules
|
Alt kural sequence;
varsayılan olarak [] Deneysel: Bu özelliğin kullandığı alt kuralların listesi. |
configuration_field
LateBoundDefault configuration_field(fragment, name)Etiket türündeki bir özellik için geç bağlanmış varsayılan değeri referans verir. Bir değer, değeri belirlemeden önce yapılandırmanın oluşturulmasını gerektiriyorsa "geç bağlanma" özelliğine sahiptir. Bu değeri kullanan tüm özellikler özel olmalıdır.
Örnek kullanım:
Kural özelliğini tanımlama:
'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))
Kural uygulamasında erişim:
def _rule_impl(ctx): foo_info = ctx.attr._foo ...
Parametreler
Parametre | Açıklama |
---|---|
fragment
|
gerekli Geç sınır değerini içeren bir yapılandırma parçasının adı. |
name
|
required Yapılandırma parçasından alınacak değerin adı. |
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
parametresi tarafından belirtilir. Daha fazla bilgi için Depset'lere genel bakış başlıklı makaleyi inceleyin.
Bir depsetteki tüm öğeler (doğrudan ve dolaylı), type(x)
ifadesiyle elde edilen 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 sabit olmalıdır ancak bu kısıtlama ileride 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 siparişlerle uyumludur, diğer tüm siparişler yalnızca kendileri ile uyumludur.
Parametreler
Parametre | Açıklama |
---|---|
direct
|
sequence; veya None ;
varsayılan değer None Bir depsetin doğrudan öğelerinin listesi. |
order
|
varsayılan değer "default" Yeni görünüm için geçiş stratejisidir. Olası değerler için buraya bakın. |
transitive
|
depset'lerin sequence; veya None ;
varsayılan olarak None şeklindedir Öğeleri, uygulamanın dolaylı öğeleri olacak depsetlerin listesi. |
exec_group
exec_group exec_group(toolchains=[], exec_compatible_with=[])Kural uygulama sırasında belirli bir yürütme platformu için işlem oluşturmak üzere kullanılabilecek bir yürütme grubu oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
toolchains
|
sequence;
varsayılan değer [] Bu yürütme grubunun gerektirdiği araç zinciri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesneleri içerebilir. |
exec_compatible_with
|
dizelerin sequence'ı;
varsayılan [] Yürütme platformundaki kısıtlamaların listesi. |
module_extension
unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)Yeni bir modül uzantısı oluşturur. Dışa aktarılıp MODULE.bazel dosyasında kullanılabilmesi için global bir değerde saklayın.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
required Bu modül uzantısını uygulayan işlev. Tek bir parametre olmalıdır: module_ctx . Mevcut depo grubunu belirlemek için işlev, derlemenin başında bir kez çağrılır.
|
tag_classes
|
varsayılan değer {} 'tirUzantının kullandığı tüm etiket sınıflarını bildiren bir sözlük. Etiket sınıfının adından bir tag_class nesnesine eşlenir.
|
doc
|
dize veya None ;
varsayılan değer None Doküman oluşturma araçları tarafından ayıklanabilen modül uzantısının açıklaması. |
environ
|
sequence of dize;
varsayılan değer [] Bu modül uzantısının bağımlı olduğu ortam değişkeninin listesini sağlar. Listedeki bir ortam değişkeni değişirse uzantı yeniden değerlendirilir. |
os_dependent
|
varsayılan değer False Bu uzantının işletim sistemine bağlı olup olmadığını belirtir |
arch_dependent
|
varsayılan değer False Bu uzantının mimariye bağlı olup olmadığını belirtir |
sağlayıcı
unknown provider(doc=None, *, fields=None, init=None)Bir sağlayıcı simgesini tanımlar. Sağlayıcı, çağrılarak örneklendirilebilir veya doğrudan bir hedeften ilgili sağlayıcının bir örneğini almak için anahtar olarak kullanılabilir. Örnek:
MyInfo = provider() ... def _my_library_impl(ctx): ... my_info = MyInfo(x = 2, y = 3) # my_info.x == 2 # my_info.y == 3 ...
Sağlayıcıların nasıl kullanılacağıyla ilgili kapsamlı bir kılavuz için Kurallar (Sağlayıcılar) başlıklı makaleyi inceleyin.
init
belirtilmezse Provider
çağrılabilir bir değer döndürür.
init
belirtilirse 2 öğeden oluşan bir tuple döndürür: Provider
çağrılabilir değer ve ham kurucu çağrılabilir değer. Ayrıntılar için Kurallar (Özel sağlayıcıların özel başlatılması) bölümüne ve aşağıdaki init
parametresi tartışmasına bakın.
Parametreler
Parametre | Açıklama |
---|---|
doc
|
string; veya None ;
varsayılan olarak None şeklindedirBelge oluşturma araçları tarafından ayıklanabilecek, sağlayıcının açıklaması. |
fields
|
Dize dizisi; veya dizin; veya None ;
varsayılan değer None Belirtilirse izin verilen alan grubunu kısıtlar. Olası değerler şunlardır:
|
init
|
çağrılabilir; veya None ;
varsayılan değer None Oluşturma sırasında sağlayıcının alan değerlerini ön işleme ve doğrulamak için isteğe bağlı bir geri çağırma işlevi. init belirtilirse provider() , 2 öğeden oluşan bir tuple döndürür: normal sağlayıcı sembolü ve bir ham kurucu.Aşağıda bu konu hakkında ayrıntılı bir açıklama verilmiştir. Anlaşılır bir tartışma ve kullanım alanları için Kurallar (Sağlayıcıların özel başlatılması) başlıklı makaleyi inceleyin.
init geri çağırma işlevi verilmediği durumlarda, P simgesine yapılan çağrı, varsayılan yapıcı işlevi c 'e yapılan çağrı gibi davranır. Diğer bir deyişle, P(*args, **kwargs) c(*args, **kwargs) değerini döndürür. Örneğin,MyInfo = provider() m = MyInfo(foo = 1) m 'un m.foo == 1 içeren bir MyInfo örneği olmasını sağlar.Ancak
Not: Yukarıdaki adımlar, Bu şekilde
MyInfo, _new_myinfo = provider(init = ...) |
repository_rule
callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)Yeni bir depo kuralı oluşturur. WORKSPACE dosyasından yüklenmesi ve çağrılabilmesi için genel bir değerde depolayın.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
gerekli bu kuralı uygulayan işlevin gerçekleştirilmesi gerekir. Tek bir parametre olmalıdır: repository_ctx . İşlev, kuralın her örneği için yükleme aşamasında çağrılır.
|
attrs
|
dict veya None ;
varsayılan değer None kuralın tüm özelliklerini bildirmek için sözlük. Özellik adı, özellik nesnesiyle eşlenir (attr modülüne bakın). _ ile başlayan özellikler gizlidir ve bir dosyaya etikete yönelik gizli bir bağımlılık eklemek için kullanılabilir (depo kuralı, oluşturulan bir yapıya bağlı olamaz). name özelliği dolaylı olarak eklenir ve belirtilmemelidir.
|
local
|
varsayılan değer False Bu kuralın her şeyi yerel sistemden getirdiğini ve her getirme işleminde yeniden değerlendirilmesi gerektiğini belirtir. |
environ
|
Dize dizisi;
varsayılan değer [] Desteği sonlandırıldı. Bu parametrenin desteği sonlandırılmıştır. Bunun yerine repository_ctx.getenv 'e geçin.Bu depo kuralının bağlı olduğu ortam değişkenlerinin listesini sağlar. Listedeki bir ortam değişkeni değişirse depo yeniden getirilir. |
configure
|
varsayılan değer False Deponun, yapılandırma amacıyla sistemi incelediğini belirtir |
remotable
|
Varsayılan değer False Deneysel. Bu parametre deneyseldir ve herhangi bir zamanda değişebilir. Lütfen bu metrikten yararlanmayın. ---experimental_repo_remote_exec Uzaktan yürütmeyle uyumlu olarak ayarlanarak deneme amaçlı olarak etkinleştirilebilir. |
doc
|
string; veya None ;
varsayılan değer None Belge oluşturma araçları tarafından çıkarılabilecek depo kuralının açıklaması. |
kural
callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])Hedef oluşturmak için BUILD dosyasından veya makrodan çağrılabilecek yeni bir kural oluşturur.
Kurallar, bir .bzl dosyasındaki genel değişkenlere atanmalıdır. Genel değişkenin adı, kuralın adıdır.
Test kurallarında adın _test
ile bitmesi gerekir. Diğer hiçbir kuralda ise bu son ek bulunmamalıdır. (Bu kısıtlama yalnızca kurallar için geçerli olup hedeflerinin kapsamına girmez.)
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
required Bu kuralı uygulayan Starlark işlevi tam olarak bir parametreye sahip olmalıdır: ctx. İşlev, kuralın her örneği için analiz aşamasında çağrılır. Kullanıcı tarafından sağlanan özelliklere erişebilir. Bildirilen tüm çıkışları oluşturmak için işlemler oluşturmalıdır. |
test
|
bool;
varsayılan değer unbound Bu kuralın test kuralı olup olmadığı, yani blaze test komutuna tabi olup olamayacağı. Tüm test kuralları otomatik olarak yürütülebilir olarak kabul edilir. Test kuralları için executable = True değerini açıkça ayarlamak gerekmez (ve önerilmez). Varsayılan değer False 'tür. Daha fazla bilgi için Kurallar sayfasına göz atın.
|
attrs
|
dict; kuralın tüm özelliklerini bildirmek için varsayılan olarak {} sözlük kullanılır. Bir özellik adından özellik nesnesine eşleme yapar (attr modülüne bakın). _ ile başlayan özellikler özeldir ve bir etikete dolaylı bağımlılık eklemek için kullanılabilir. name özelliği dolaylı olarak eklenir ve belirtilmemelidir. visibility , deprecation , tags , testonly ve features özellikleri örtülü olarak eklenir ve geçersiz kılınamaz. Çoğu kural için yalnızca birkaç özellik gerekir. Kural işlevi, bellek kullanımını sınırlandırmak için özelliklerin boyutuna bir sınır uygular.
|
outputs
|
dict; veya None ; veya function;
varsayılan değer None Kullanımdan kaldırıldı. Bu parametrenin desteği sonlandırıldı ve yakında kaldırılacak. Lütfen bu yönteme güvenmeyin. ---incompatible_no_rule_outputs_param ile devre dışı bırakılır. Kodunuzun yakında kaldırılacak olan işlevlerle uyumlu olup olmadığını doğrulamak için bu işareti kullanın. Bu parametrenin desteği sonlandırıldı. Kuralları, OutputGroupInfo veya attr.output yerine kullanacak şekilde taşıyın. Önceden beyan edilen çıkışları tanımlamak için kullanılan bir şema. Bu bağımsız değişkenin değeri ya bir sözlük ya da sözlük oluşturan bir geri çağırma işlevidir. Geri çağırma, hesaplanan bağımlılık özelliklerine benzer: İşlevin parametre adları, kuralın özellikleriyle eşleştirilir. Örneğin, Sözlükteki her giriş, anahtarın bir tanımlayıcı ve değerin, çıktının etiketini belirleyen bir dize şablonu olduğu önceden bildirilmiş bir çıktı oluşturur. Kuralın uygulama işlevinde tanımlayıcı,
Uygulamada en yaygın yer tutucu |
executable
|
bool;
varsayılan değer unbound Bu kuralın yürütülebilir olarak kabul edilip edilmeyeceğini, yani bir blaze run komutunun konusu olup olamayacağını belirtir. Varsayılan olarak False değerine ayarlanır. Daha fazla bilgi için Kurallar sayfasına bakın.
|
output_to_genfiles
|
varsayılan değer False Doğru ise dosyalar bin dizini yerine genfiles dizininde oluşturulur. Mevcut kurallarla uyumluluk için ihtiyacınız olmadığı sürece (ör. C++ için başlık dosyaları oluştururken) bu işareti ayarlamayınız. |
fragments
|
Dize dizisi;
varsayılan değer [] Kuralın hedef yapılandırmada gerektirdiği yapılandırma parçalarının adları. |
host_fragments
|
Dize dizisi;
varsayılan değer [] Kuralın ana makine yapılandırmasında gerektirdiği yapılandırma parçalarının adları. |
_skylark_testable
|
varsayılan değer False (Deneysel) Doğru ise bu kural, işlemlerini bir Actions sağlayıcı aracılığıyla kendisine bağlı kurallar tarafından incelenmek üzere gösterir. Sağlayıcı, ctx.created_actions() çağrısı yapılarak kuralın kendisi tarafından da kullanılabilir.Bu, yalnızca Starlark kurallarının analiz sırasındaki davranışını test etmek için kullanılmalıdır. Bu işaret ileride kaldırılabilir. |
toolchains
|
sequence;
varsayılan değer [] Ayarlanırsa bu kuralın gerektirdiği araç zinciri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesnelerini içerebilir. Araçlar zincirleri, mevcut platform kontrol edilerek bulunur ve ctx.toolchain aracılığıyla kural uygulamasına sağlanır.
|
incompatible_use_toolchain_transition
|
varsayılan False şeklindedirBu özellik artık kullanılmamaktadır ve kaldırılmalıdır. |
doc
|
dize veya None ;
varsayılan değer None Belge oluşturma araçları tarafından ayıklanabilen kural açıklaması. |
provides
|
varsayılan değer [] Uygulama işlevinin döndürmesi gereken sağlayıcıların listesi. Uygulama işlevi, burada listelenen sağlayıcı türlerinden herhangi birini dönüş değerinden çıkarırsa hata oluşur. Ancak uygulama işlevi, burada listelenmeyen ek sağlayıcılar döndürebilir. Listenin her öğesi, |
exec_compatible_with
|
Dize dizisi;
varsayılan değer [] Yürütme platformundaki, bu kural türünün tüm hedefleri için geçerli olan kısıtlamaların listesi. |
analysis_test
|
varsayılan değer False Doğru ise bu kural bir analiz testi olarak değerlendirilir. Not: Analiz testi kuralları, temel Starlark kitaplıklarında sağlanan altyapı kullanılarak tanımlanır. Yardım için Test bölümüne bakın. Bir kural analiz testi kuralı olarak tanımlanırsa özelliklerinde analysis_test_transition kullanılarak tanımlanan yapılandırma geçişlerinin kullanılmasına izin verilir ancak bazı kısıtlamalar etkinleştirilir:
|
build_setting
|
BuildSetting veya None ;
varsayılan değer None Ayarlanırsa bu kuralın ne tür bir build setting olduğunu açıklar. config modülüne bakın. Bu ayar belirlenirse bu kurala, burada iletilen değere karşılık gelen bir türde "build_setting_default" adlı zorunlu bir özellik otomatik olarak eklenir.
|
cfg
|
varsayılan değer None Ayarlanırsa kuralın analizden önce kendi yapılandırmasına uygulayacağı yapılandırma geçişini gösterir. |
exec_groups
|
dict veya None ;
varsayılan değer None Yürütme grubu adının (dize) exec_group s olarak dize dizini. Ayarlanırsa kuralların tek bir hedef içinde birden fazla yürütme platformunda işlemler yapmasını sağlar. Daha fazla bilgi için yürütme grupları belgelerine bakın.
|
initializer
|
varsayılan değer None Deneysel: Kuralın özelliklerini başlatan Stalark işlevi. İşlev, kuralın her örneği için yükleme sırasında çağrılır. Özellik adlarından istenen değerlere giden bir sözlük döndürmelidir. Döndürülmeyen özellikler etkilenmez. Değer olarak Başlatıcılar, bir özellik tanımında belirtilen varsayılan değerlerden önce değerlendirilir. Sonuç olarak, başlatıcının imzasındaki bir parametre varsayılan değerler içeriyorsa özellik tanımındaki varsayılan değerin üzerine yazılır ( Benzer şekilde, başlatıcının imzasındaki bir parametrenin varsayılan değeri yoksa parametre zorunlu hale gelir. Bu tür durumlarda bir özellik tanımında varsayılan/zorunlu ayarların kullanılmaması önerilir. İşlenmeyen özellikler için Genişletilmiş kurallar söz konusu olduğunda, tüm başlatıcılar alt öğeden üst öğelere doğru çağrılır. Her başlatıcıya yalnızca bildiği herkese açık özellikler iletilir. |
parent
|
Varsayılan değer None Deneme: Uzatılmış Stalark kuralı. Ayarlandığında, reklamı yapılan sağlayıcıların yanı sıra herkese açık özellikler de birleştirilir. Kural, üst öğedeki executable ve test ile eşleşir. fragments , toolchains , exec_compatible_with ve exec_groups değerleri birleştirilir. Eski veya desteği sonlandırılmış parametreler ayarlanamaz. Bu kuralın gelen yapılandırmasından sonra üst kuruluş biriminin gelen yapılandırma geçişi (cfg ) uygulandı.
|
extendable
|
bool; veya Label; veya string; veya None ;
varsayılan değer None Deneysel: Bu kuralı hangi kuralların genişletebileceğini tanımlayan izin verilenler listesi etiketi. Uzatma işlemine her zaman izin vermek/vermemek için True/False olarak da ayarlanabilir. Bazel varsayılan olarak uzantılara her zaman izin verir. |
subrules
|
Alt kural dizisi;
varsayılan değer [] Deneysel: Bu kuralın kullandığı alt kuralların listesi. |
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
|
required Yapılandırma koşullarını değerlerle eşleyen bir sözlük. 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
|
varsayılan değer '' Hiçbir koşul eşleşmezse raporlanacak isteğe bağlı özel hata. |
alt kural
Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])Bir alt kuralın yeni bir örneğini oluşturur. Bu işlevin sonucu, kullanılabilmesi için bir genel değişkende depolanmalıdır.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
function;
required Bu alt kuralı uygulayan Starlark işlevi |
attrs
|
dict;
varsayılan olarak {} şeklindedirAlt kuralın tüm (private) özelliklerini bildirmek için kullanılan bir sözlük. Alt kurallarda yalnızca etiket türüne sahip gizli özellikler (ör. etiket veya etiket listesi) bulunabilir. Bu etiketlere karşılık gelen çözümlenmiş değerler, Bazel tarafından alt kuralın uygulama işlevine adlandırılmış bağımsız değişkenler olarak otomatik olarak iletilir (bu nedenle uygulama işlevinin, özellik adlarıyla eşleşen adlandırılmış parametreleri kabul etmesi gerekir). Bu değerlerin türleri şunlardır:
|
toolchains
|
sequence;
varsayılan olarak [] şeklindedirAyarlanırsa bu alt kuralın gerektirdiği araç zincirleri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesnelerini içerebilir. Araç zincirleri, mevcut platform kontrol edilerek bulunur ve ctx.toolchains aracılığıyla alt kuralın uygulanmasına sağlanır.
|
fragments
|
dizi / dizes;
varsayılan [] alt kuralın hedef yapılandırmada gerektirdiği yapılandırma parçalarının adlarının listesi. |
subrules
|
Alt kural sıralı listesi;
varsayılan değer [] Bu alt kuralın ihtiyaç duyduğu diğer alt kuralların listesi. |
tag_class
tag_class tag_class(attrs={}, *, doc=None)Bir modül uzantısı tarafından kullanılabilen veri nesneleri olan etiket sınıfı için bir özellik şemasını tanımlayan yeni bir tag_class nesnesi oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
attrs
|
varsayılan değer {} 'tir.Bu etiket sınıfının tüm özelliklerini bildiren bir sözlüktür. Özellik adı, özellik nesnesiyle eşlenir (attr modülüne bakın). |
doc
|
dize veya None ;
varsayılan değer None Belge oluşturma araçları tarafından ayıklanabilen etiket sınıfının açıklaması. |
görünürlük
None
visibility(value)
Şu anda başlatılmakta olan .bzl modülünün yükleme görünürlüğünü ayarlar.
Bir modülün yükleme görünürlüğü, diğer BUILD ve .bzl dosyalarının bu modülü yükleyip yükleyemeyeceğini belirler. (Bu, dosyanın diğer hedeflerin bağımlılığı olarak görünüp görünmeyeceğini yöneten temel .bzl kaynak dosyasının hedef görünürlüğünden farklıdır.) Yükleme görünürlüğü paket düzeyinde çalışır: Bir modülün yüklenmesi için yüklemeyi yapan dosyanın, modüle görünürlük izni verilmiş bir pakette bulunması gerekir. Bir modül, görünürlüğünden bağımsız olarak her zaman kendi paketi içinde yüklenebilir.
visibility()
, .bzl dosyası başına yalnızca bir kez çağrılabilir ve işlev içinde değil, yalnızca üst düzeyde çağrılabilir. Tercih edilen stil, bu çağrıyı load()
ifadelerinin hemen altına ve bağımsız değişkeni belirlemek için gereken kısa mantığın altına yerleştirmektir.
--check_bzl_visibility
işareti yanlış değerine ayarlanırsa yükleme görünürlüğü ihlalleri uyarı verir ancak derlemede başarısız olmaz.
Parametreler
Parametre | Açıklama |
---|---|
value
|
required Paket spesifikasyonu dizelerinin listesi veya tek bir paket spesifikasyonu dizesi. Paket özellikleri, negatif paket özelliklerine izin verilmemesi dışında
"@" söz dizimine izin verilmiyor. Tüm özellikler mevcut modülün deposuna göre yorumlanır.
|