.bzl dosyaları

Tüm .bzl dosyalarında kullanılabilen genel yöntemler.

Üyeler

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 gerekli
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=[], 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önler'e giriş bölümünü 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 özelliklerine ctx.rule alanı aracılığıyla erişilebilir. 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.
attrs dict; varsayılan değer {}
Özelliğin tüm özelliklerini açıklayan bir sözlük. Özellik adından "attr.label" veya "attr.string" gibi bir özellik nesnesiyle eşlenir (attr modülüne bakın). En boy özellikleri, uygulama işlevinde ctx parametresinin alanları olarak kullanılabilir.

_ ile başlayan dolaylı özellikler, varsayılan değerlere sahip olmalı ve label veya label_list türünde olmalıdır.

Açık atıf özellikleri string türüne sahip olmalı ve values kısıtlamasını kullanmalıdır. Belirli özellikler, görünümün yalnızca kısıtlamaya göre aynı ada, türe ve geçerli değerlere sahip özellikler içeren kurallarla kullanılmasını kısıtlar.

required_providers varsayılan değer []
Bu özellik, yönü yalnızca kurallarında gerekli sağlayıcılarının reklamını yapan hedeflerle sınırlandırması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 [FooInfo, BarInfo], otomatik olarak [[FooInfo, BarInfo]] biçimine dönüştürülecek.

Bazı kuralların (ör. some_rule) hedeflerinin bir görünüme görünür olması için some_rule'ün, gerekli sağlayıcı listelerinden en az birinde bulunan tüm sağlayıcıların reklamını yapması gerekir. Örneğin, bir özelliğin required_providers değeri [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] ise bu özellik, some_rule hedeflerini yalnızca some_rule FooInfo, veya BarInfo, veya hem BazInfo ve QuxInfo sağladığında görebilir.

required_aspect_providers varsayılan değer []'tır.
Bu özellik, bu özelliğin diğer unsurları 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ğerdir ancak [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 [FooInfo, BarInfo], otomatik olarak [[FooInfo, BarInfo]]'e dönüştürülecek.

Başka bir yönü (ör. other_aspect) bu yönü tarafından görünür hale getirmek için other_aspect, listelerden en az birindeki tüm sağlayıcıları sağlamalıdır. [[FooInfo], [BarInfo], [BazInfo, QuxInfo]] örneğinde bu özellik, other_aspect yalnızca FooInfo, veya BarInfo, veya hem BazInfo hem de QuxInfo sağladığında other_aspect'i görebilir.

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ö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, provider() tarafından döndürülen bir *Info nesnesidir. Ancak eski sağlayıcı, bunun yerine dize adıyla temsil edilir. Kuralın bir hedefi, zorunlu sağlayıcıyı tanımlayan bir hedef için bağımlılık olarak kullanıldığında, bu sağlayıcının burada belirtilmesi gerekmez. Uygulama işlevinin bunu döndürmesi yeterlidir. Ancak zorunlu olmasa da bunu belirtmek en iyi uygulama olarak kabul edilir. Ancak bir yönün required_providers alanında, sağlayıcıların burada belirtilmesi gerekir.

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 False şeklindedir
Bu özellik artık kullanılmamaktadır ve kaldırılmalıdır.
doc string; veya None; varsayılan değer None
Belge oluşturma araçları tarafından çıkarılabilecek özelliğin 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.

Varsayılan olarak yanlıştır.
exec_compatible_with Dize dizisi; varsayılan değer []
Yürütme platformundaki, 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_groups olarak dize dizini. Ayarlanırsa özelliklerin tek bir örnek içinde birden fazla yürütme platformunda işlem çalıştırmasına olanak tanır. Daha fazla bilgi için yürütme grupları belgelerine bakın.
subrules Alt kural dizini; varsayılan değer []
Deneysel: Bu yön tarafından kullanılan alt kuralların listesi.

configuration_field

LateBoundDefault configuration_field(fragment, name)

Etiket türündeki bir özellik için geç sınırlanan bir varsayılan değere başvuruda bulunuyor. Bir değer, değeri belirlemeden önce yapılandırmanın oluşturulması gerekiyorsa "geç sınır"dır. Bunu değer olarak kullanan tüm özellikler gizli 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 required
Geç bağlanan değeri içeren bir yapılandırma parçasının adı.
name gerekli
Yapılandırma parçasından alınacak değerin adı.

çökmüş

depset depset(direct=None, order="default", *, transitive=None)

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 Depsise 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şken ş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 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 depo kümesi 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.

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[])

Kural uygulaması sırasında belirli bir yürütme platformu için işlemler oluşturmak amacıyla 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 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 use_extension ile 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 {}
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 nesnesiyle eşlenir.
doc string; veya None; varsayılan olarak None şeklindedir
Belge oluşturma araçları tarafından çıkarılabilecek modül uzantısının bir açıklaması.
environ Dize dizisi; varsayılan değer []
Bu modül uzantısının bağlı olduğu ortam değişkenlerinin listesini sağlar. Bu listedeki bir ortam değişkeni değişirse uzantı yeniden değerlendirilir.
os_dependent varsayılan False şeklindedir
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 örneklenebilir veya doğrudan bir hedeften bu 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:
  • alan listesi:
    provider(fields = ['a', 'b'])

  • dictionary field name -> documentation:
    provider(
       fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
Tüm alanlar isteğe bağlıdır.
init çağrılabilir; veya None; varsayılan None şeklindedir
Ö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.

P, provider() çağrısıyla oluşturulan sağlayıcı sembolü olsun. Kavramsal olarak, varsayılan oluşturucu işlevi c(*args, **kwargs) çağırılarak bir P örneği oluşturulur. Bu işlev şunları yapar:

  • args boş değilse bir hata oluşur.
  • provider() çağrılırken fields parametresi belirtilmişse ve kwargs, fields'te listelenmeyen bir anahtar içeriyorsa hata meydana gelir.
  • Aksi takdirde c, kwargs içindeki her k: v girişi için v değerine sahip k adlı bir alana sahip yeni bir örnek döndürür.
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 init belirtilirse P(*args, **kwargs) çağrısı bunun yerine aşağıdaki adımları gerçekleştirir:

  1. Geri çağırma, init(*args, **kwargs) olarak, yani P içine iletilen konum ve anahtar kelime bağımsız değişkenleriyle tamamen aynı şekilde çağrılır.
  2. init işlevinin döndürdüğü değerin, anahtarları alan adı dizeleri olan bir sözlük (d) olması beklenir. Aksi takdirde hata oluşur.
  3. c(**d)'de olduğu gibi, varsayılan yapıcıyı d'un girişlerini anahtar kelime bağımsız değişkenleri olarak çağırarak P sınıfının yeni bir örneği oluşturulur.

Not: Yukarıdaki adımlar, *args veya **kwargs öğesinin init imzasıyla eşleşmemesi veya init öğesinin gövdesinin değerlendirilmesinin başarısız olması (belki kasıtlı olarak fail() çağrısıyla) veya init değerinin beklenen şemaya sahip bir sözlük olmadığı durumlarda bir hata oluştuğu anlamına gelir.

Bu şekilde, init geri çağırması konumsal bağımsız değişkenlere ve ön işleme ile doğrulama için rastgele mantığa izin vererek normal sağlayıcı yapısını genelleştirir. İzin verilen fields listesinin etrafından dolanmayı etkinleştirmez.

init belirtildiğinde provider()'un döndürdüğü değer bir tuple (P, r) olur. Burada r, ham kurucu olur. Aslında r işlevinin davranışı, tam olarak yukarıda açıklanan c varsayılan oluşturucu işleviyle aynıdır. Genellikle r, adının önüne bir alt çizgi eklenen bir değişkene bağlıdır. Böylece, yalnızca geçerli .bzl dosyası doğrudan erişebilir:

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. Bir module extension uygulama işlevinden yüklenebilir ve çağrılabilir veya use_repo_rule tarafından kullanılabilir olması için global bir değerde depolayın.

Parametreler

Parametre Açıklama
implementation gerekli
bu kuralı uygulayan işlevin gerçekleştirilmesi gerekir. Tek bir parametre (repository_ctx) içermelidir. İşlev, kuralın her örneği için yükleme aşamasında çağrılır.
attrs dict; veya None; varsayılan olarak, kuralın tüm özelliklerini bildirmek için None
sözlüktür. Ö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'dir
Bu kuralın yerel sistemdeki her şeyi aldığını ve her getirmede yeniden değerlendirilmesi gerektiğini belirtin.
environ dizelerin sequence'ı; varsayılan []
Kullanımdan kaldı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 yönteme güvenmeyin. ---experimental_repo_remote_exec
Uzaktan yürütmeyle uyumlu olarak ayarlanarak deneysel 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ı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 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ının sağladığı ö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 bir test kuralı olup olmadığı, yani bir blaze test komutunun konusu olup olmadığı. 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). Değer varsayılan olarak False değerine ayarlanı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. Özellik adı, özellik nesnesiyle eşlenir (attr modülüne bakın). _ 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 dolaylı 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ı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ıldı. 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. output ve output_list özelliklerinin aksine kullanıcı, bu dosyalar için etiketleri belirtmez. Önceden beyan edilmiş çıkışlar hakkında daha fazla bilgi için Kurallar sayfasını inceleyin.

Bu bağımsız değişkenin değeri bir sözlük veya 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, def _my_func(srcs, deps): ... tanımıyla outputs = _my_func parametresini geçirirseniz işlev, srcs ve deps özelliklerine erişebilir. Sözlük ister doğrudan ister bir işlev aracılığıyla belirtilmiş olsun, şu şekilde yorumlanır.

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ı, ctx.outputs'te çıkışın File öğesine erişmek için kullanılan alan adı olur. Çıktının etiketi, kuralla aynı pakete sahiptir ve paketten sonraki kısım, "%{ATTR}" biçimindeki her yer tutucunun ATTR özelliğinin değerinden oluşturulan bir dizeyle değiştirilmesiyle oluşturulur:

  • Dize türündeki özellikler olduğu gibi değiştirilir.
  • Etiket türündeki özellikler, paketten sonra dosya uzantısı çıkarılarak etiketin bir parçası olur. Örneğin, "//pkg:a/b.c" etiketi "a/b" olur.
  • Çıkış türünde özellikler, dosya uzantısı da dahil olmak üzere etiketin paketten sonraki parçası haline gelir (yukarıdaki örnekte "a/b.c").
  • Yer tutucularda kullanılan tüm liste türünde özelliklerin (örneğin, attr.label_list) tam olarak bir öğeye sahip olması gerekir. Dönüşümleri, liste dışı sürümleriyle (attr.label) aynıdır.
  • Diğer özellik türleri yer tutucularda görünmeyebilir.
  • Özellik olmayan özel yer tutucular %{dirname} ve %{basename}, paketi hariç tutarak kural etiketinin bu kısımlarına genişler. Örneğin, "//pkg:a/b.c" dosyasında dirname a, basename ise b.c olur.

Uygulamada en yaygın yer tutucu "%{name}"'tür. Örneğin, "foo" adlı bir hedef için çıkışlar sözlüğü {"bin": "%{name}.exe"}, uygulama işlevinde ctx.outputs.bin olarak erişilebilen foo.exe adlı bir çıkışı önceden bildirir.

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 varsayılan olarak False şeklindedir
True (doğru) değerine ayarlanırsa 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 sıra / dizes; varsayılan []
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 varsayılan değerdir: False
(Deneysel)

Doğru değerine ayarlanırsa bu kural, işlemlerini Actions sağlayıcısı 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 gelecekte 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ç zincirleri, mevcut platform kontrol edilerek bulunur ve ctx.toolchain aracılığıyla kuralın uygulanması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 string; veya None; varsayılan değer None
Belge oluşturma araçları tarafından çıkarılabilecek kuralın 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ö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, provider() tarafından döndürülen bir *Info nesnesidir. Ancak eski sağlayıcı, bunun yerine dize adıyla temsil edilir. Kuralın bir hedefi, zorunlu sağlayıcıyı tanımlayan bir hedef için bağımlılık olarak kullanıldığında, bu sağlayıcının burada belirtilmesi gerekmez. Uygulama işlevinin bunu döndürmesi yeterlidir. Ancak, zorunlu olmasa da bunu belirtmek en iyi uygulama olarak kabul edilir. Ancak bir en boy değerinin required_providers alanı için sağlayıcıların burada belirtilmesi gerekir.

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ğeri False şeklindedir
True (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 test 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:

  • Bu kuralın hedefleri, sahip olabileceği geçişli bağımlılıkların sayısı açısından sınırlıdır.
  • Kural, bir test kuralı olarak kabul edilir (test=True ayarlanmış gibi). Bu, test değerinin yerini alır
  • Kural uygulama işlevi işlemleri kaydedemeyebilir. Bunun yerine, AnalysisTestResultInfo sağlayarak başarılı/başarısız sonuç kaydetmesi gerekir.
build_setting BuildSetting veya None; varsayılan olarak None olur
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 şeklindedir
Ayarlanırsa kuralın analizden önce 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_groups 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 ayar None şeklindedir
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. name ve kural tarafından tanımlanan herkese açık özelliklerin değerleriyle çağrılır (tags gibi genel özelliklerle değil).

Özellik adlarından istenen değerlere bir sözlük döndürmesi gerekir. Döndürülmeyen özellikler bu durumdan etkilenmez. Değer olarak None döndürülmesi, özellik tanımında belirtilen varsayılan değerin kullanılmasına neden olur.

Başlatıcılar, ö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 (None döndürülmesi hariç).

Benzer şekilde, başlatıcının imzasında varsayılan bir parametre yoksa parametre zorunlu hale gelir. Bu gibi durumlarda, özellik tanımında varsayılan/zorunlu ayarları çıkarmak iyi bir uygulamadır.

İşlenmeyen özellikler için **kwargs kullanmak iyi bir uygulamadır.

Genişletilmiş kurallar söz konusu olduğunda tüm başlatıcılar alt öğeden üst öğeye ilerleme olarak adlandırılır. Her başlatıcıya yalnızca bilgi sahibi olduğu herkese açık özellikler aktarılır.

parent varsayılan ayar None şeklindedir
Deneysel: 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 kullanımdan kaldı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 dize; veya None; varsayılan olarak None
Deneysel: Bu kuralı hangi kuralların uzatabileceğini tanımlayan bir 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'ın sequence'ı; varsayılan değer []
Deneysel: Bu kural tarafından kullanılan 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, config_setting veyarestriction_value örneğini tanımlayan bir Etiket veya etiket dizesidir. Dize yerine Etiket ne zaman kullanılacağını öğrenmek 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 genel bir değişkende saklanmalıdır.

Parametreler

Parametre Açıklama
implementation function; required
Bu alt kuralı uygulayan Starlark işlevi
attrs dict; varsayılan değer {}
Alt kuralın tüm (gizli) özelliklerini bildirmek için 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ürü şu şekilde olur:

  • executable=True ile etiket özellikleri için FilesToRunProvider
  • allow_single_file=True ile etiket özellikleri için File
  • Diğer tüm etiket özellikleri için Target
  • Tüm etiket listesi özellikleri için [Target]
toolchains sequence; varsayılan olarak [] şeklindedir
Ayarlanırsa bu alt kuralın gerektirdiği araç zincirleri grubu. Liste, herhangi bir kombinasyonda String, Label veya StarlarkToolchainTypeApi nesneleri 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)

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 varsayılan değer {}
Bu etiket sınıfının tüm özelliklerini bildiren bir sözlük. Bir özellik adından özellik nesnesine eşleme yapar (attr modülüne bakın).
doc string; veya None; varsayılan değer None
Belge oluşturma araçları tarafından çıkarılabilecek 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ük 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ü yüklemek için yüklemeyi yapan dosya, modüle görünürlüğü verilen bir pakette bulunmalıdır. 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 ve bağımsız değişkeni belirlemek için gereken kısa mantığın hemen 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 package_group ile aynı biçimi izler. Diğer bir deyişle, bir spesifikasyon şu biçimlerde olabilir:

  • "//foo": //foo paketi
  • "//foo/...": //foo paketi ve tüm alt paketleri.
  • "public" veya "private": sırasıyla tüm paketler veya hiçbir paket

"@" söz dizimine izin verilmez; tüm özellikler geçerli modülün deposuna göre yorumlanır.

value bir dize listesiyse bu modüle görünürlük verilen paket grubu, her spesifikasyonla temsil edilen paketlerin birleşimidir. (Boş liste, private ile aynı etkiye sahiptir.) value tek bir dize ise [value] tek öğeli liste gibi işlenir.

--incompatible_package_group_has_public_syntax ve --incompatible_fix_package_group_reporoot_syntax işaretlerinin bu bağımsız değişken üzerinde herhangi bir etkisinin olmadığını unutmayın. "public" ve "private" değerleri her zaman kullanılabilir. "//..." ise her zaman "mevcut depoda bulunan tüm paketler" olarak yorumlanır.