Tüm .bzl dosyalarında kullanılabilen genel yöntemler.
Üyeler
- analysis_test_transition
- aspect
- configuration_field
- depset
- exec_group
- exec_transition
- module_extension
- sağlayıcı
- repository_rule
- kural
- 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, temel olarak 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
|
dict;
zorunlu 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 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=[], toolchains_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, genel bir 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
|
function;
required Bu yönü uygulayan ve tam olarak iki parametre içeren bir Starlark işlevi: Hedef (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, bir özelliğin bir hedefe her uygulanması için analiz aşamasında 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.
|
toolchains_aspects
|
sequence;
varsayılan değer [] Araç zinciri türlerinin listesi. Yön, bu araç zinciri türleriyle eşleşen hedef araç zincirlerine yayılır. |
attrs
|
dict;
varsayılan değer: {} Özelliğin tüm özelliklerini açıklayan bir sözlük. Bir özellik adından attr.label veya attr.string gibi bir özellik nesnesine eşleme yapar (bkz. attr modülü). En boy özellikleri, uygulama işlevinde ctx parametresinin alanları olarak kullanılabilir.
Açık özelliklerin türü Tanımlanmış özellikler, |
required_providers
|
sequence;
varsayılan değer: [] Bu özellik, özelliğin yayılmasını, yalnızca kuralları zorunlu sağlayıcıların reklamını yapan hedeflerle sınırlamasına olanak tanır. Değer, ya tek tek sağlayıcılar ya da sağlayıcı listeleri içeren (ikisini birden değil) bir liste olmalıdır. Ö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
|
sequence;
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ş sağlayıcılar listesi, otomatik olarak bir sağlayıcı listesi içeren bir listeye dönüştürülecektir. Yani Bu unsura başka bir özelliğin (ör. |
provides
|
sequence;
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öndürdüğü değerden çıkarırsa bu bir hatadır. Ancak uygulama işlevi, burada listelenmeyen ek sağlayıcıları döndürebilir. Listenin her öğesi, |
requires
|
Aspect'lerin sequence (dizi)
varsayılan değer [] Bu özellikten önce uygulanması gereken özelliklerin listesi. |
fragments
|
sequence of dize;
varsayılan değer [] Özelliğin hedef yapılandırmada gerektirdiği yapılandırma parçalarının adlarının listesi. |
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ı listesi. |
toolchains
|
sequence;
varsayılan değer [] Ayarlanırsa bu özelliğin gerektirdiği araç zinciri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesneleri içerebilir. Araç zincirleri, mevcut platform kontrol edilerek bulunur ve ctx.toolchain üzerinden özelliğin uygulanmasına olanak tanır.
|
incompatible_use_toolchain_transition
|
bool;
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
|
bool;
varsayılan değer: False Doğru değerine ayarlanırsa öğe, çıkış dosyasına uygulandığında çı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
|
sequence of dize;
varsayılan değer [] 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 göz atın.
|
subrules
|
Alt Kural'ların sequence'ı;
varsayılan değer [] Deneysel: Bu özellik tarafından kullanılan 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 alır. Değerin belirlenmesinden önce yapılandırmanın oluşturulmasını gerektiren değerler "geç bağlanma" özelliğine sahiptir. Bu değeri kullanan tüm özellikler özel olmalıdır.
Örnek kullanım:
Kural özelliği 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
|
string;
zorunlu Geç bağlanan değeri içeren bir yapılandırma parçasının adı. |
name
|
string;
gerekli Yapılandırma parçasından alınacak değerin adı. |
çökmüş
depset depset(direct=None, order="default", *, transitive=None)Bir depset oluşturur.
direct
parametresi, depset'in doğrudan öğelerinin listesidir. transitive
parametresi ise öğeleri, oluşturulan görüntünün dolaylı öğeleri haline gelen depset'lerin 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 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 tabanlı bir küme kullanıldığından, kümedeki tüm öğeler karma oluşturma işlemine tabi olmalıdır. Ancak bu değişken, şu anda tüm kurucularda tutarlı bir şekilde kontrol edilmemektedir. Tutarlı kontrol sağlamak için --inuyumlu_always_check_depset_elements işaretini kullanın; bu, gelecekteki sürümlerde varsayılan davranış olacaktır. Sorun 10313'e 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 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 değer None Bir depsetin doğrudan öğelerinin listesi. |
order
|
string;
varsayılan değer: "default" Yeni lansman için geçiş stratejisi. Olası değerler için buraya bakın. |
transitive
|
sequence of depset'ler; veya None ;
varsayılan değer None Öğeleri, derinliğin dolaylı öğeleri haline gelecek olan depset'lerin 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 nesnelerini içerebilir. |
exec_compatible_with
|
sequence of dize;
varsayılan değer [] Yürütme platformundaki kısıtlamaların listesi. |
exec_transition
transition exec_transition(implementation, inputs, outputs)Yönetici geçişini tanımlamak için kullanılan özel bir
transition()
sürümü. En iyi uygulamalar için dokümanlarına (veya uygulanmasına) bakın. Yalnızca Bazel yerleşiklerinden kullanılabilir.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
callable;
zorunlu |
inputs
|
sequence of dize;
gerekli |
outputs
|
dize dizisi;
zorunlu |
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
use_extension
ile MODULE.bazel dosyasında kullanılabilmesi için global bir değerde depolayın.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
callable;
required Bu modül uzantısını uygulayan işlev. Tek bir parametre ( module_ctx ) almalıdır. Mevcut depoların kümesini belirlemek için işlev, derlemenin başında bir kez çağrılır.
|
tag_classes
|
dict;
varsayılan değer {} Uzantı tarafından kullanılan 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
|
string; veya None ;
varsayılan değer: None Belge oluşturma araçları ile çıkarılabilecek 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. Bu listedeki bir ortam değişkeni değişirse uzantı yeniden değerlendirilir. |
os_dependent
|
bool;
varsayılan değer False Bu uzantının işletim sistemine bağlı olup olmadığını belirtir |
arch_dependent
|
bool;
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)Sağlayıcı sembolünü tanımlar. Bu işlevin sonucu, genel bir değerde depolanmalıdır. 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
|
dize veya None ;
varsayılan değer None Sağlayıcının, doküman oluşturma araçları tarafından ayıklanabilen 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
|
callable; veya None ;
varsayılan değer None Örnekleme 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. 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ğırması verilmediğinde, P simgesine yapılan bir çağrı, varsayılan oluşturucu işlevi c için bir çağrı olarak işlev görü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.
module_extension()
uygulama işlevinden yüklenip çağrılabilmesi veya use_repo_rule()
tarafından kullanılabilmesi için genel bir değerde depolayın.
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
callable;
zorunlu bu kuralı uygulayan fonksiyondur. 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 Depo kuralının tüm özelliklerini tanımlayacak bir sözlük. Bir özellik adından özellik nesnesine eşleme yapar ( attr modülüne bakın). _ ile başlayan özellikler gizlidir ve bir dosyaya etiket için örtülü 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.
Tanımlanmış özellikler, |
local
|
bool;
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
|
sequence of dize;
varsayılan değer [] Kullanımdan kaldırıldı. Bu parametre kullanımdan kaldırıldı. Bunun yerine repository_ctx.getenv ürününe geçiş yapın.Bu depo kuralının bağlı olduğu ortam değişkeninin listesini sağlar. Listedeki bir ortam değişkeni değişirse depo yeniden getirilir. |
configure
|
bool;
varsayılan değer False Deponun, yapılandırma amacıyla sistemi incelediğini belirtir |
remotable
|
bool;
varsayılan değer False Deneysel. Bu parametre deneyseldir ve herhangi bir zamanda değişebilir. Lütfen bu yönteme güvenmeyin. --experimental_repo_remote_exec Uzaktan yürütme ile uyumlu olarak ayarlanarak deneme amaçlı olarak etkinleştirilebilir. |
doc
|
string; veya None ;
varsayılan değer: None Belge oluşturma araçları ile çı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=[], dependency_resolution_rule=False, 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 DERLE dosyası 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ının adının _test
ile bitmesi gerekir. Diğer tüm kuralların adında bu son ek bulunmamalıdır. (Bu kısıtlama yalnızca kurallar için geçerlidir, hedefleri için geçerli değildir.)
Parametreler
Parametre | Açıklama |
---|---|
implementation
|
function;
zorunlu Bu kuralı uygulayan Starlark işlevinin tam olarak bir parametresi 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. Tanımlanan tüm çıkışları oluşturmak için işlemler oluşturması gerekir. |
test
|
bool;
varsayılan değer: unbound Bu kuralın bir test kuralı olup olmadığı, yani bir blaze test komutunun konusu olup olmadığı. Tüm test kuralları otomatik olarak executable kabul edilir; bir test kuralı için executable = True değerinin açıkça ayarlanması gerekmez (ve önerilmez). Değer varsayılan olarak False değerine ayarlanır. Daha fazla bilgi için Kurallar sayfasına göz atın.
|
attrs
|
dict;
varsayılan değer: {} Kuralın tüm özelliklerini bildiren bir sözlük. Bir özellik adı, bir özellik nesnesine eşlenir (bkz. attr modülünü kullanabilirsiniz. _ ile başlayan özellikler gizlidir 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. Bellek kullanımını sınırlamak için tanımlanabilecek özellik sayısına bir sınır uygulanır.
Tanımlanan özellikler |
outputs
|
dict; veya None ; veya function;
varsayılan değer: None Kullanımdan kaldırıldı. Bu parametrenin desteği sonlandırılmıştır ve yakında kaldırılacaktır. Lütfen bu yönteme güvenmeyin. --incompatible_no_rule_outputs_param ile devre dışı bırakıldı. Kodunuzun, kaldırılma olasılığı yüksek olan içerikle uyumlu olduğunu doğrulamak için bu işareti kullanın. Bu parametrenin desteği sonlandırılmıştır. Kuralları, bunun yerine OutputGroupInfo veya attr.output 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 işlevi, hesaplanmış bağımlılık özelliklerine benzer şekilde çalışır: İş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ı,
Pratikte, en yaygın değiştirme yer tutucusu |
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 göz atın.
|
output_to_genfiles
|
bool;
varsayılan değer False Doğru ise dosyalar bin dizini yerine genfiles dizininde oluşturulur. Mevcut kurallarla uyumluluk için gerekli olmadığı sürece (ör. C++ için başlık dosyaları oluştururken) bu işareti ayarlamayın. |
fragments
|
sequence of dize;
varsayılan değer [] Kuralın hedef yapılandırmada gerektirdiği yapılandırma parçalarının adlarının listesi. |
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
|
bool;
varsayılan değer: False (Deneysel) Doğru (doğru) ise bu kural, işlemlerini bir Actions sağlayıcı aracılığıyla ona bağımlı kurallar tarafından incelenmek üzere kullanıma sunar. 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ç zincirleri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesneleri 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
|
bool;
varsayılan değer: False Kullanımdan kaldırıldı ve 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 kural açıklaması. |
provides
|
sequence;
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öndürdüğü değerden çıkarırsa bu bir hatadır. Ancak uygulama işlevi, burada listelenmeyen ek sağlayıcıları döndürebilir. Listenin her öğesi, |
dependency_resolution_rule
|
bool;
varsayılan değer: False Ayarlanırsa kural, malzeme oluşturucuda kullanılabilir olarak da işaretlenmiş özellikler aracılığıyla bir bağımlılık olabilir. Bu işaret kümesine sahip kuralların her özelliği, materyalleştiricilerde de kullanılabilir olarak işaretlenmelidir. Burada amaç, bu şekilde işaretlenen kuralların, özel olarak işaretlenmemiş kurallara dayalı olmamasıdır. |
exec_compatible_with
|
sequence of dize;
varsayılan değer [] Yürütme platformunda bu kural türünün tüm hedefleri için geçerli olan kısıtlamaların listesi. |
analysis_test
|
bool;
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. Yol gösterici bilgiler 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 ayarlanırsa "build_setting_default" adlı zorunlu bir özellik ayarlanır. değeri, buraya geçirilen değere karşılık gelen bir türle otomatik olarak bu kurala eklenir.
|
cfg
|
varsayılan değer None Ayarlanırsa, analizden önce kuralın kendi yapılandırmasına uygulayacağı yapılandırma geçişine işaret eder. |
exec_groups
|
dict; veya None ;
varsayılan değer: None Yürütme grubu adının (dize) exec_group sn. sayısına. Ayarlanırsa kuralların tek bir hedef içinde birden fazla yürütme platformunda işlem çalıştırmasına izin verir. 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 bir sözlük döndürmesi gerekir. 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, herkese açık özellikler, reklamı yapılan sağlayıcıların yanı sıra birleştirilir. Kural, üst öğedeki executable ve test ile eşleşir. fragments , toolchains , exec_compatible_with ve exec_groups değerleri birleştirildi. Eski veya desteği sonlandırılmış parametreler ayarlanamaz. Üst öğenin gelen yapılandırma geçişi cfg , thisrule öğesinin gelen yapılandırmasından sonra uygulanır.
|
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 ansiklopedi oluşturma bölümüne bakın.
Parametreler
Parametre | Açıklama |
---|---|
x
|
dict;
gerekli Yapılandırma koşullarını değerlerle eşleyen bir dikte. Her anahtar, config_setting veyarestriction_value örneğini tanımlayan bir Etiket veya 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 kural
Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])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;
gerekli Bu alt kuralı uygulayan Starlark fonksiyonu |
attrs
|
dict;
varsayılan değer: {} Alt kuralın tüm (gizli) ö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ümlenen değerler Bazel tarafından alt kuralın uygulama işlevine otomatik olarak adlandırılmış bağımsız değişkenler olarak aktarılır (böylece, 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 değer [] Ayarlanırsa bu alt kuralın gerektirdiği araç zinciri 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 uygulamasına sağlanır.
|
fragments
|
sequence of dize;
varsayılan değer [] 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)Modül uzantısı tarafından kullanılabilen veri nesneleri olan bir etiket sınıfı için özellik şemasını tanımlayan yeni bir tag_class nesnesi oluşturur.
Parametreler
Parametre | Açıklama |
---|---|
attrs
|
dict;
varsayılan değer {} Bu etiket sınıfının tüm özelliklerini bildirmek için kullanılan bir sözlük. Bir özellik adından özellik nesnesine eşleme yapar ( 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ük görünürlüğü, diğer BUILD ve .bzl dosyalarının o 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üğüne bakılmaksızın her zaman kendi paketine yüklenebilir.
visibility()
, her .bzl dosyası için yalnızca bir kez ve bir işlevin içinde değil, yalnızca en ü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ük görünürlüğü ihlalleri uyarı verir ancak derleme başarısız olmaz.
Parametreler
Parametre | Açıklama |
---|---|
value
|
required Paket spesifikasyonu dizelerinin listesi veya tek bir paket spesifikasyonu dizesi. Negatif paket özelliklerine izin verilmemesi dışında paket spesifikasyonları
"@" söz dizimine izin verilmez; tüm özellikler geçerli modülün deposuna göre yorumlanır.
|