yerel

Sorun bildir Kaynağı görüntüle Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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ğerleri yoksayar ve onları özellik ayarlanmamış gibi ele alır.
Aşağıdaki işlevler de kullanılabilir:

Üyeler

existing_rule

unknown native.existing_rule(name)

Bu ileti dizisinin paketinde örneklendirilen bir kuralın özelliklerini açıklayan, değişmez bir sözlük benzeri nesne döndürür veya bu ada sahip bir kural örneği yoksa None döndürür.

Burada dikkat benzeri sabit nesne, dikt benzeri yinelemeyi destekleyen x, tamamen sabit olmayan nesne x, len(x), name in x, x[name], x.get(name), x.items(), x.keys() ve x.values() anlamına gelir.

--noincompatible_existing_rules_immutable_view işareti ayarlanmışsa bunun yerine aynı içeriğe sahip yeni bir değiştirilebilir sözlük döndürülür.

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, kural, kural örneğinin name ve kind (örneğin, 'cc_binary') öğeleri 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ündeki özellikler olduğu gibi gösterilir.
  • Etiketler, aynı paketteki hedefler için ':foo' veya farklı bir paketteki hedefler için '//pkg:name' biçiminde dizelere 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 kullanmaktan kaçının. 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 gerekli
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. Dict benzeri nesnenin her girişi, kural örneğinin adını existing_rule(name) tarafından döndürülecek sonuçla eşleştirir.

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.

--noincompatible_existing_rules_immutable_view işareti ayarlanmışsa bunun yerine aynı içeriğe sahip yeni bir değiştirilebilir sözlük döndürülür.

Not: Mümkünse bu işlevi kullanmaktan kaçının. BUILD dosyalarını kırılgan ve sıraya bağımlı hale getirir. Ayrıca, --noincompatible_existing_rules_immutable_view işareti ayarlanmışsa bu işlev, özellikle bir döngü içinde çağrıldığında çok pahalı olabilir.

exports_files

None native.exports_files(srcs, visibility=None, licenses=None)

Bu pakete ait olan ve diğer paketlere aktarılan dosyaların listesini belirtir.

Parametreler

Parametre Açıklama
srcs sequence/dize; gerekli
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 içindeki kalıpların hiçbiriyle eşleşmiyor (varsayılan []).
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 ifade kalıplarının listesi.
exclude_directories 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_boş" Yanlış değerine ayarlanırsa her bağımsız dahil etme kalıbı bir öğeyle eşleşmeli ve nihai sonuç boş olmamalıdır ("hariç_tutulan" kalıplarıyla eşleşmeler hariç tutulduktan sonra).

module_name

string native.module_name()

Bu paketin bulunduğu depoyla ilişkili Bazel modülünün adı. Bu paket MODULE.bazel yerine WORKSPACE'te tanımlanan bir depodan geliyorsa bu boş olur. Modül uzantıları tarafından oluşturulan depolar için bu, uzantıyı barındıran modülün 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şkilendirilmiş 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 sonucunu döndürebilir.

package_group

None native.package_group(name, packages=[], includes=[])

Bu işlev bir paket kümesini tanımlar ve gruba bir etiket atar. Etikete, visibility özelliklerinde referans verilebilir.

Parametreler

Parametre Açıklama
name required
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ı, .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, o anda başlatılmakta olan paket (yani, geçerli makronun yürütüldüğü BUILD dosyası) bağlamında bir Label nesnesine dönüştürür. Giriş zaten bir Label ise değişmeden döndürülür.

Bu işlev yalnızca DERLE dosyası ve doğrudan veya dolaylı olarak çağırdığı makrolar değerlendirilirken çağrılabilir. Örneğin, bir kural uygulama işlevinde çağrılamayabilir.

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 Etiket nesnelerini her zaman etiket dizeleri yerine iç makrolara geçirmeyi tercih etmelidir.)

Parametreler

Parametre Açıklama
input dize veya Etiket; zorunlu
Giriş etiketi dizesi veya Etiket nesnesi. Bir Etiket nesnesi geçilirse 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, başında ve sonunda yapay bir işaret içermeyen, ancak benzer şekilde davranan repo_name etiketini kullanmayı tercih ediyorum.

Değerlendirilmekte olan paketi içeren deponun, tek bir "at-sign" (@) ön eki içeren 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, mevcut paketin her doğrudan alt paketinin yeni ve değiştirilebilir bir listesini döndürür. Döndürülen liste sıralanır ve geçerli 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 sequence of dize; required
Alt paket taramasına dahil edilecek glob kalıplarının listesi.
exclude dize'lerin sequence'ı; varsayılan []
Alt paket taramasından hariç tutulacak glob kalıplarının listesi.
allow_empty varsayılan değer False
Arama boş bir liste döndürürse başarısız olup olmayacağımızı belirtir. Varsayılan olarak boş liste, BUILD dosyasında subpackages() çağrısının gereksiz olduğu potansiyel hatayı gösterir. Doğru değerine ayarlamak, bu durumda bu işlevin başarılı olmasını sağlar.