MODULE.bazel dosyaları

Sorun bildir Nightly · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

MODULE.bazel dosyalarında kullanılabilen yöntemler.

Üyeler

archive_override

None archive_override(module_name, **kwargs)

Bu bağımlılığın, kayıt otoritesinden değil, belirli bir konumdaki bir arşiv dosyasından (zip, gzip vb.) gelmesi gerektiğini belirtir. Bu bağımlılık, http_archive kuralı tarafından desteklenir.

Bu yönerge yalnızca kök modülde geçerli olur. Diğer bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılma işlemleri yoksayılır.

Parametreler

Parametre Açıklama
module_name string; required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
kwargs required
Diğer tüm bağımsız değişkenler, temel http_archive repo kuralına yönlendirilir. name özelliğinin belirtilmemesi gerektiğini unutmayın. Bunun yerine module_name özelliğini kullanın.

bazel_dep

None bazel_dep(name, version='', max_compatibility_level=-1, repo_name='', dev_dependency=False)

Başka bir Bazel modülüne doğrudan bağımlılık belirtir.

Parametreler

Parametre Açıklama
name dize; zorunlu
Doğrudan bağımlılık olarak eklenecek modülün adı.
version dize; varsayılan değer ''
Doğrudan bağımlılık olarak eklenecek modülün sürümü.
max_compatibility_level int; varsayılan değer -1
Modülün doğrudan bağımlılık olarak eklenmesi için desteklenen maksimum compatibility_level. Modülün sürümü, desteklenen minimum compatibility_level değerini ve bu özellik belirtilmemişse maksimum değeri belirtir.
repo_name dize; varsayılan değer ''
Bu bağımlılığı temsil eden harici deponun adı. Bu, varsayılan olarak modülün adıdır.
dev_dependency bool; varsayılan değer False
Doğru ise mevcut modül kök modül değilse veya `--ignore_dev_dependency` etkinse bu bağımlılık yoksayılır.

git_override

None git_override(module_name, **kwargs)

Bu bağımlılığın, kayıt otoritesinden değil, bir Git deposundaki belirli bir taahhütten gelmesi gerektiğini belirtir. Bu bağımlılık, bir git_repository kuralı tarafından desteklenir.

Bu yönerge yalnızca kök modülde geçerli olur. Diğer bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılma işlemleri yoksayılır.

Parametreler

Parametre Açıklama
module_name dize; zorunlu
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
kwargs required
Diğer tüm bağımsız değişkenler, temel git_repository repo kuralına yönlendirilir. name özelliğinin belirtilmemesi gerektiğini unutmayın. Bunun yerine module_name özelliğini kullanın.

dahil et

None include(label)

Başka bir MODULE.bazel benzeri dosyanın içeriğini içerir. include(), dahil edilen dosya include() çağrısının konumuna metinsel olarak yerleştirilmiş gibi davranır. Bununla birlikte, değişken bağlamaları (use_extension için kullanılanlar gibi) yalnızca bulundukları dosyada görünür, dahil edilen veya dahil eden dosyalarda görünmez.

Yalnızca kök modül include() kullanabilir; bir bazel_dep'un MODÜL dosyası include() kullanıyorsa bu bir hatadır.

Yalnızca ana depoda bulunan dosyalar dahil edilebilir.

include(), devasa bir MODULE.bazel dosyası olmasını önlemek veya ayrı anlamsal segmentler için erişim denetimini daha iyi yönetmek amacıyla kök modül dosyasını birden fazla bölüme ayırmanıza olanak tanır.

Parametreler

Parametre Açıklama
label dize; zorunlu
Dahil edilecek dosyayı işaret eden etiket. Etiket, ana depoda bir dosyayı işaret etmelidir. Diğer bir deyişle, çift eğik çizgiyle (//) başlamalıdır.

inject_repo

None inject_repo(extension_proxy, *args, **kwargs)

Belirtilen modül uzantısına bir veya daha fazla yeni depo ekler. Geçerli modül kök modül değilse veya --ignore_dev_dependency etkinse bu ayar yoksayılır.

Mevcut bir deposu geçersiz kılmak için bunun yerine override_repo seçeneğini kullanın.

Parametreler

Parametre Açıklama
extension_proxy module_extension_proxy; required
Bir use_extension çağrısı tarafından döndürülen modül uzantısı proxy nesnesi.
args required
Mevcut modül tarafından görülebilen ve aynı ada sahip uzantıya eklenmesi gereken depolardır.
kwargs required
Uzantıya eklenecek yeni depolar. Burada değerler, mevcut modülün kapsamındaki depoların adları, anahtarlar ise uzantıda görünecekleri adlardır.

local_path_override

None local_path_override(module_name, path)

Bu bağımlılığın, kayıt otoritesinden değil, yerel diskteki belirli bir dizinden gelmesi gerektiğini belirtir. Bu bağımlılık, bir local_repository kuralı tarafından desteklenir.

Bu yönerge yalnızca kök modülde geçerli olur. Diğer bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılma işlemleri yoksayılır.

Parametreler

Parametre Açıklama
module_name dize; zorunlu
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
path string; required
Bu modülün bulunduğu dizinin yolu.

modül

None module(name='', version='', compatibility_level=0, repo_name='', bazel_compatibility=[])

Mevcut Bazel deposu tarafından temsil edilen Bazel modülünün belirli özelliklerini belirtir. Bu özellikler, modülün temel meta verileridir (ad ve sürüm gibi) veya mevcut modülün ve bağımlılarının davranışını etkiler.

En fazla bir kez çağrılmalıdır ve çağrılırsa MODULE.bazel dosyasındaki ilk yönerge olmalıdır. Yalnızca bu modül kök modülse (yani başka bir modül tarafından bağımlı olmayacaksa) atlanabilir.

Parametreler

Parametre Açıklama
name dize; varsayılan değer ''
Modülün adı. Yalnızca bu modül kök modülse (yani başka bir modül tarafından bağımlı olmayacaksa) atlanabilir. Geçerli bir modül adı: 1) yalnızca küçük harfler (a-z), rakamlar (0-9), noktalar (.), kısa çizgiler (-) ve alt çizgiler (_) içermelidir; 2) küçük harfle başlamalı; 3) küçük harf veya rakamla bitmelidir.
version dize; varsayılan değer ''
Modülün sürümü. Yalnızca bu modül kök modülse (yani başka bir modül tarafından bağımlı olmayacaksa) atlanabilir. Sürüm, gevşek SemVer biçiminde olmalıdır. Daha fazla bilgi için dokümanlara göz atın.
compatibility_level int; varsayılan değer 0
Modülün uyumluluk düzeyidir. Bu değer, uyumlu olmayan önemli bir değişiklik her uygulandığında değiştirilmelidir. Bu, SemVer açısından modülün "büyük sürümü"dür. Bununla birlikte, sürüm dizesine yerleştirilmez ve ayrı bir alan olarak bulunur. Farklı uyumluluk düzeylerine sahip modüller, farklı ada sahip modüllermiş gibi sürüm çözümüne katılır ancak nihai bağımlılık grafiği, aynı ada sahip ancak farklı uyumluluk düzeylerine sahip birden fazla modül içeremez (multiple_version_override etkin olmadığı sürece). Daha fazla ayrıntı için dokümanları inceleyin.
repo_name dize; varsayılan değer ''
Bu modülün kendisinin gördüğü şekilde, modülü temsil eden deponun adı. Varsayılan olarak, deponun adı modülün adıdır. Bu, kendisi için modül adından farklı bir depo adı kullanan projelerin taşınmasını kolaylaştırmak için belirtilebilir.
bazel_compatibility Dize öğelerinin iterasyonu; varsayılan değer []
Kullanıcıların bu modülle uyumlu Bazel sürümlerini belirtmesine olanak tanıyan Bazel sürümlerinin listesi. Bağımlılık çözümünü etkilemez ancak bzlmod, mevcut Bazel sürümünüzün uyumlu olup olmadığını kontrol etmek için bu bilgileri kullanır. Bu değerin biçimi, virgülle ayrılmış bazı kısıtlama değerlerinin dizesidir. Üç kısıtlama desteklenir: <=X.X.X: Bazel sürümü X.X.X'e eşit veya bu sürümden eski olmalıdır. Daha yeni bir sürümde bilinen uyumsuz bir değişiklik olduğunda kullanılır. >=X.X.X: Bazel sürümü X.X.X ile aynı veya daha yeni olmalıdır.Yalnızca X.X.X sürümünden itibaren kullanılabilen bazı özelliklere ihtiyaç duyduğunuzda kullanılır. -X.X.X: X.X.X Bazel sürümü uyumlu değildir. X.X.X sürümünde, çalışmanızı engelleyen ancak sonraki sürümlerde düzeltilen bir hata olduğunda kullanılır.

multiple_version_override

None multiple_version_override(module_name, versions, registry='')

Bir bağımlılık yine de bir kayıt defteri kaynaklı olmalıdır ancak birden fazla sürümünün birlikte var olmasına izin verilmelidir. Daha fazla ayrıntı için dokümanları inceleyin. Bu yönerge yalnızca kök modülde geçerli olur. Diğer bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılma işlemleri yoksayılır.

Parametreler

Parametre Açıklama
module_name string; required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
versions Dize öğelerinin iterasyonu; zorunlu
Bir arada bulunmasına izin verilen sürümleri açıkça belirtir. Bu sürümler, bağımlılık grafiği ön seçiminde zaten mevcut olmalıdır. Bu modülün bağımlılıkları, aynı uyumluluk düzeyinde izin verilen en yakın üst sürüme "yükseltilir". Aynı uyumluluk düzeyinde izin verilen sürümlerden daha yüksek sürüme sahip bağımlılıklar ise hataya neden olur.
registry dize; varsayılan değer ''
Bu modülün kayıt defterini geçersiz kılar. Bu modül, varsayılan kayıt defteri listesinden değil, belirtilen kayıt defteri kullanılarak bulunur.

override_repo

None override_repo(extension_proxy, *args, **kwargs)

Belirli bir modül uzantısı tarafından tanımlanan bir veya daha fazla depoyu, mevcut modül tarafından görülebilen belirli depolarla geçersiz kılar. Geçerli modül kök modül değilse veya `--ignore_dev_dependency` etkinse bu yoksayılır.

Yeni bir depo eklemek için bunun yerine inject_repo simgesini kullanın.

Parametreler

Parametre Açıklama
extension_proxy module_extension_proxy; required
Bir use_extension çağrısı tarafından döndürülen modül uzantısı proxy nesnesi.
args required
Uzantıdaki, mevcut modüldeki aynı ada sahip depolarla geçersiz kılınması gereken depolardır.
kwargs required
Uzantı tarafından oluşturulan depolara uygulanacak geçersiz kılmalar. Burada değerler, geçerli modülün kapsamındaki depoların adları, anahtarlar ise uzantıda geçersiz kılacakları depoların adlarıdır.

register_execution_platforms

None register_execution_platforms(dev_dependency=False, *platform_labels)

Bu modül seçildiğinde kaydedilecek önceden tanımlanmış yürütme platformlarını belirtir. Mutlak hedef kalıpları (ör. @ veya // ile başlayan) olmalıdır. Daha fazla bilgi için araç zinciri çözümü bölümüne bakın. :all gibi birden fazla hedefe genişleyen kalıplar, ada göre alfabetik sırayla kaydedilir.

Parametreler

Parametre Açıklama
dev_dependency bool; varsayılan değer False
Doğru ise geçerli modül kök modül değilse veya `--ignore_dev_dependency` etkinse yürütme platformları kaydedilmez.
platform_labels Dize dizisi; zorunlu
Kaydedilecek hedef kalıplar.

register_toolchains

None register_toolchains(dev_dependency=False, *toolchain_labels)

Bu modül seçildiğinde kaydedilecek önceden tanımlanmış araç zincirlerini belirtir. Mutlak hedef kalıpları (ör. @ veya // ile başlayan) olmalıdır. Daha fazla bilgi için araç zinciri çözümü bölümüne bakın. :all gibi birden fazla hedefe genişleyen kalıplar, hedef adına göre (araç zinciri uygulamasının adına göre değil) alfabetik sırayla kaydedilir.

Parametreler

Parametre Açıklama
dev_dependency bool; varsayılan değer False
Doğru ise geçerli modül kök modül değilse veya `--ignore_dev_dependency` etkinse araç zincirleri kaydedilmez.
toolchain_labels Dize dizisi; zorunlu
Kaydedilecek hedef kalıplar.

single_version_override

None single_version_override(module_name, version='', registry='', patches=[], patch_cmds=[], patch_strip=0)

Bir bağımlılık yine de bir kayıt defteri tarafından sağlanmalıdır ancak sürümünün sabitlenmesi, kayıt defterinin geçersiz kılınması veya bir yamalar listesinin uygulanması gerekir. Bu yönerge yalnızca kök modülde geçerli olur. Diğer bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılma işlemleri yoksayılır.

Parametreler

Parametre Açıklama
module_name string; required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
version dize; varsayılan değer ''
Bağımlılık grafiğinde bu modülün bildirilen sürümünü geçersiz kılar. Diğer bir deyişle, bu modül bu geçersiz kılma sürümüne "sabitlenir". Yalnızca kayıt otoritesini veya yamaları geçersiz kılmak istiyorsanız bu özellik atlanabilir.
registry dize; varsayılan değer ''
Bu modülün kayıt defterini geçersiz kılar. Bu modül, varsayılan kayıt defteri listesinden değil, belirtilen kayıt defteri kullanılarak bulunur.
patches Dize öğelerinin iterasyonu; varsayılan değer []
Bu modüle uygulanacak yamalar dosyalarını işaret eden etiketlerin listesi. Yama dosyaları, üst düzey projenin kaynak ağacında bulunmalıdır. Bunlar liste sırasına göre uygulanır.

Bir yama MODULE.bazel dosyasında değişiklik yaparsa bu değişiklikler yalnızca yama dosyası kök modül tarafından sağlanırsa geçerli olur.

patch_cmds Dize öğelerinin iterasyonu; varsayılan değer []
Yamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi.

MODULE.bazel dosyasında yapılan değişiklikler geçerli olmaz.

patch_strip int; varsayılan değer 0
Unix yamasının --strip bağımsız değişkeniyle aynıdır.

use_extension

module_extension_proxy use_extension(extension_bzl_file, extension_name, *, dev_dependency=False, isolate=False)

Modül uzantısını temsil eden bir proxy nesnesi döndürür. Modül uzantısı etiketleri oluşturmak için yöntemleri çağrılabilir.

Parametreler

Parametre Açıklama
extension_bzl_file string; required
Modül uzantısını tanımlayan Starlark dosyası etiketi.
extension_name dize; zorunlu
Kullanılacak modül uzantısının adı. Starlark dosyası bu ada sahip bir simge dışa aktarmalıdır.
dev_dependency bool; varsayılan değer False
Doğru ise mevcut modül kök modül değilse veya `--ignore_dev_dependency` etkinse modül uzantısının bu kullanımı yoksayılır.
isolate 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_isolated_extension_usages
ayarlanarak deneysel olarak etkinleştirilebilir. Doğru ise modül uzantısının bu kullanımı hem bu modülde hem de diğer modüllerdeki diğer kullanımlardan izole edilir. Bu kullanım için oluşturulan etiketler diğer kullanımları etkilemez ve uzantı tarafından bu kullanım için oluşturulan depolar, uzantı tarafından oluşturulan diğer tüm depolardan farklı olur.

Bu parametre şu anda deneyseldir ve yalnızca --experimental_isolated_extension_usages işaretiyle kullanılabilir.

use_repo

None use_repo(extension_proxy, *args, **kwargs)

Belirtilen modül uzantısı tarafından oluşturulan bir veya daha fazla deposu mevcut modülün kapsamına aktarır.

Parametreler

Parametre Açıklama
extension_proxy module_extension_proxy; required
Bir use_extension çağrısı tarafından döndürülen modül uzantısı proxy nesnesi.
args required
İçe aktarılacak depoların adları.
kwargs required
Mevcut modülün kapsamına farklı adlarla içe aktarılacak belirli depoları belirtir. Anahtarlar, geçerli kapsamda kullanılacak ad, değerler ise modül uzantısı tarafından dışa aktarılan orijinal adlar olmalıdır.

use_repo_rule

repo_rule_proxy use_repo_rule(repo_rule_bzl_file, repo_rule_name)

MODULE.bazel dosyasında doğrudan depo kuralı olarak bir veya daha fazla kez çağrılabilecek bir proxy değeri döndürür. Bu şekilde oluşturulan depolar yalnızca proxy'de name özelliği kullanılarak belirtilen ad altında geçerli modül tarafından görülebilir. Belirli bir deposunun yalnızca mevcut modül kök modül olduğunda oluşturulacağını belirtmek için proxy'de de örtülü Boole dev_dependency özelliği kullanılabilir.

Parametreler

Parametre Açıklama
repo_rule_bzl_file dize; zorunlu
Depo kuralını tanımlayan Starlark dosyası etiketi.
repo_rule_name string; required
Kullanılacak depo kuralının adı. Starlark dosyası bu ada sahip bir simge dışa aktarmalıdır.