MODULE.bazel dosyaları

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

MODULE.bazel dosyalarında bulunan yöntemler.

Üyeler

archive_override

None archive_override(module_name, urls, integrity='', strip_prefix='', patches=[], patch_cmds=[], patch_strip=0)

Bu bağımlılığın bir kayıt defteri yerine belirli bir konumdaki bir arşiv dosyasından (zip, gzip vb.) gelmesi gerektiğini belirtir. 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 required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
urls dize veya dize türünde iteratör; zorunlu
Arşivin URL'leri; http(s):// veya file:// URL'leri olabilir.
integrity varsayılan değer ''
Alt Kaynak Bütünlüğü biçiminde arşiv dosyasının beklenen sağlama toplamıdır.
strip_prefix varsayılan ayar ''
Çıkarılan dosyalardan kaldırılacak bir dizin ön eki.
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.
patch_cmds Dize öğelerinin iterasyonu; varsayılan değer []
Yamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi.
patch_strip varsayılan değer 0
Unix yamasının --strip bağımsız değişkeniyle aynıdır.

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 bildirir.

Parametreler

Parametre Açıklama
name gerekli
Doğrudan bağımlılık olarak eklenecek modülün adı.
version varsayılan ayar '' şeklindedir
Modülün doğrudan bağımlılık olarak eklenecek sürümü.
max_compatibility_level 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 uyumluluk_seviyesini ve bu özellik belirtilmezse maksimum uyumluluk düzeyini ifade eder.
repo_name 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 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, remote, commit='', patches=[], patch_cmds=[], patch_strip=0, init_submodules=False, strip_prefix='')

Bir bağımlılık için Git deposunun belirli bir gönderiminden gelmesi gerektiğini belirtir. Bu yönerge yalnızca kök modülde geçerli olur. Başka bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılmaları yok sayılır.

Parametreler

Parametre Açıklama
module_name required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
remote gerekli
Uzak Git deposunun URL'si.
commit varsayılan değer ''
Kontrol edilmesi gereken taahhüt.
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.
patch_cmds Dize öğelerinin iterasyonu; varsayılan değer []
Yamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi.
patch_strip varsayılan değer 0
Unix yamasının --strip bağımsız değişkeniyle aynıdır.
init_submodules varsayılan değer False
Getirilen depodaki git alt modüllerinin yinelemeli olarak başlatılıp başlatılmayacağı.
strip_prefix varsayılan ayar ''
Çıkarılan dosyalardan kaldırılacak bir dizin ön eki. Bu, git deposunun bir alt dizinini hedeflemek için kullanılabilir. Alt dizinin, bu "git_override"a iletilen "module_name" bağımsız değişkeniyle aynı modül adına sahip kendi "MODULE.bazel" dosyasının olması gerektiğini unutmayı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 bağımsız anlamsal segmentler için erişim denetimini daha iyi yönetmek amacıyla kök modül dosyasını birden çok bölüme ayırmanızı sağlar.

Parametreler

Parametre Açıklama
label required
Eklenecek dosyayı işaret eden etiket. Etiket, ana depodaki bir dosyaya işaret etmelidir. Diğer bir deyişle, çift eğik çizgiyle (//) başlamalıdır.

local_path_override

None local_path_override(module_name, path)

Bir bağımlılığın yerel diskteki belirli bir dizinden gelmesi gerektiğini belirtir. 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 gerekli
Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı.
path required
Bu modülün bulunduğu dizinin yolu.

modül

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

Mevcut Bazel deposunda gösterilen Bazel modülünün belirli özelliklerini tanımlar. Bu özellikler ya modülün temel meta verileridir (ad ve sürüm gibi) ya da 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 varsayılan değer ''
Modülün adı. Yalnızca bu modül kök modülse (başka bir modüle bağımlı olmayacaksa olduğu gibi) atlanabilir. Geçerli bir modül adı: 1) yalnızca küçük harf (a-z), rakam (0-9), nokta (.), kısa çizgi (-) ve alt çizgi (_) içermelidir; 2) küçük harfle başlamalı; 3) küçük harf veya rakamla bitmelidir.
version 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 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 değilse). Daha fazla bilgi için belgeleri inceleyin.
repo_name 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 ile aynı veya daha eski olmalıdır. 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 için yine de bir kayıt defteri kullanılacağını ancak birden fazla sürümünün birlikte var olmasına izin verilmesi gerektiğini belirtir. 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 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 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.

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ı olmalıdır (ör. @ veya // ile başlar). Daha fazla bilgi için araç zinciri çözünürlüğü bölümüne bakın.

Parametreler

Parametre Açıklama
dev_dependency varsayılan değer False şeklindedir
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 platformların etiketleri.

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ı olmalıdır (ör. @ veya // ile başlar). Daha fazla bilgi için araç zinciri çözünürlüğü bölümüne bakın.

Parametreler

Parametre Açıklama
dev_dependency Varsayılan değer False şeklindedir
Geçerli modül kök modül değilse veya "--ignore_dev_dependency" etkinse araç zincirleri kaydedilmez.
toolchain_labels Dize dizisi; zorunlu
Kaydedilecek araç zincirlerinin etiketleri. Etiketler :all içerebilir. Bu durumda, paketteki araç zinciri sağlayan tüm hedefler, ada göre alfabetik sırayla kaydedilir.

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 düzeltme listesi uygulanması gerekir. Bu yönerge yalnızca kök modülde geçerli olur. Başka bir deyişle, bir modül başkaları tarafından bağımlılık olarak kullanılırsa kendi geçersiz kılmaları yok sayılır.

Parametreler

Parametre Açıklama
module_name required
Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı.
version 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 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.
patch_cmds Dize yinelemesi; varsayılan olarak [] şeklindedir
Yamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi.
patch_strip 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)

Bir 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 required
Starlark dosyasında modül uzantısını tanımlayan bir etiket.
extension_name gerekli
Kullanılacak modül uzantısının adı. Bu ada sahip bir simge, Starlark dosyası tarafından dışa aktarılmalıdır.
dev_dependency varsayılan değer False şeklindedir
Geçerli 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 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 tüm 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 depoyu mevcut modülün kapsamına içe aktarır.

Parametreler

Parametre Açıklama
extension_proxy required
Bir use_extension çağrısı tarafından döndürülen modül uzantısı proxy nesnesi.
args gerekli
İç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 tanımlanan 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 required
Starlark dosyasında depo kuralını tanımlayan bir etiket.
repo_rule_name required
Kullanılacak repo kuralının adı. Starlark dosyası bu ada sahip bir simgeyi dışa aktarmalıdır.