MODULE.bazel dosyaları

. Sorun bildir Gece · 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, 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; 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ı yoksayılır.

Parametreler

Parametre Açıklama
module_name zorunlu
Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı.
urls string; veya dizeler yinelenebilir; gerekli
Arşivin URL'leri; http(s):// veya file:// URL'leri olabilir.
integrity varsayılan değer ''
Arşiv dosyasının, Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı.
strip_prefix varsayılan değer ''
Ayıklanan dosyalardan alınacak dizin ön eki.
patches string yinelenebilir; varsayılan değer: []
Bu modüle uygulanacak yama dosyalarını işaret eden etiketlerin listesi. Yama dosyaları, üst düzey projenin kaynak ağacında bulunmalıdır. Liste sırasına göre uygulanırlar.
patch_cmds string yinelenebilir; 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 zorunlu
Doğrudan bağımlılık olarak eklenecek modülün adı.
version varsayılan değer ''
Doğrudan bağımlılık olarak eklenecek modülün 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 değerine ayarlanırsa 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ığın, bir Git deposunun belirli bir kaydından 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ı yoksayılır.

Parametreler

Parametre Açıklama
module_name zorunlu
Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı.
remote zorunlu
Uzak Git deposunun URL'si.
commit varsayılan değer ''
İncelenmesi gereken kayıt.
patches string yinelenebilir; varsayılan değer: []
Bu modüle uygulanacak yama dosyalarını işaret eden etiketlerin listesi. Yama dosyaları, üst düzey projenin kaynak ağacında bulunmalıdır. Liste sırasına göre uygulanırlar.
patch_cmds string yinelenebilir; 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 değer ''
Ayıklanan dosyalardan alınacak 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)

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

include(), yalnızca kök modül tarafından kullanılabilir; bir bazel_dep'ın MODULE dosyası include() kullanıyorsa hatadır.

Yalnızca ana depodaki 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 zorunlu
Dahil edilecek 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; 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ı yoksayılır.

Parametreler

Parametre Açıklama
module_name zorunlu
Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı.
path zorunlu
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. Çağrılması durumunda, MODULE.bazel dosyasındaki ilk yönerge olmalıdır. Yalnızca bu modül kök modülse (başka bir modüle bağımlı olmayacaksa olduğu gibi) 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 (.), tire (-) ve alt çizgi (_) içermelidir; 2) küçük harfle başlamalı, 3) küçük harfle veya rakamla bitmelidir.
version varsayılan değer ''
Modülün sürümü. Yalnızca bu modül kök modülse (başka bir modüle bağımlı olmayacaksa olduğu gibi) atlanabilir. Sürüm, rahat bir SemVer biçiminde olmalıdır; Daha ayrıntılı bilgi için belgeleri inceleyin.
compatibility_level varsayılan değer 0
Modülün uyumluluk düzeyi; önemli bir uyumsuz değişiklik ortaya çıktığında bunun değiştirilmesi gerekir. Bu aslında "ana sürüm" dahil edilmiştir. Tek fark, sürüm dizesine gömülü olmaması, ancak ayrı bir alan olarak bulunmasıdır. Farklı uyumluluk seviyelerine sahip modüller, farklı adlara sahip modüller gibi sürüm çözünürlüğüne katılır. Ancak nihai bağımlılık grafiği aynı ada ancak farklı uyumluluk seviyelerine sahip birden fazla modül içeremez (multiple_version_override geçerli değilse). Daha fazla bilgi için belgeleri inceleyin.
repo_name varsayılan değer ''
Bu modülü temsil eden deponun adı, modülün kendisi tarafından görüntülenir. Varsayılan olarak, kod deposunun adı modülün adıdır. Bu, modül adından farklı bir depo adı kullanan projeler için taşımayı kolaylaştırmak amacıyla belirtilebilir.
bazel_compatibility string yinelenebilir; varsayılan değer: []
Kullanıcıların hangi Bazel sürümlerinin bu modülle uyumlu olduğunu bildirmelerini sağlayan 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ğerlerini içeren bir dizedir. Üç 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 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'ten itibaren kullanılabilen bazı özelliklere bağlı olduğunuzda kullanılır. -X.X.X: X.X.X Bazel sürümü uyumlu değildir. X.X.X'te sizi bozan, 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ığın yine de bir kayıt defterinden gelmesi gerektiğini ancak bunun birden fazla sürümünün birlikte bulunmasına izin verilmesi gerektiğini belirtir. Daha fazla bilgi için belgeleri inceleyin. 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ı yoksayılır.

Parametreler

Parametre Açıklama
module_name zorunlu
Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı.
versions string yinelenebilir; gerekli
Birlikte kullanılması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üldeki bağımlılıklar "yükseltilecek" .
registry varsayılan değer ''
Bu modül için kayıt defterini geçersiz kılar; Bu modülü varsayılan kayıt defteri listesinden bulmak yerine, verilen kayıt defteri kullanılmalı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 olmalıdır (ör. @ veya // ile başlamalıdır). 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
Doğru değerine ayarlanırsa mevcut modül kök modül değilse veya "--ignore_dev_dependency" etkinse yürütme platformları kaydedilmez.
platform_labels sequence of dize; gerekli
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şlamalıdır). 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
Doğru değerine ayarlanırsa mevcut modül kök modül değilse veya "--ignore_dev_dependency" etkinse araç zincirleri kaydedilmez.
toolchain_labels sequence of dize; gerekli
Kaydedilecek araç zincirlerinin etiketleri. Etiketler :all içerebilir. Bu durumda, paketteki tüm araç zinciri sağlayan hedefler, ada göre sözlük sırasına göre kaydedilir.

single_version_override

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

Bağımlılığın hâlâ bir kayıt defterinden gelmesi gerektiğini ancak sürümünün sabitlenmesi, kaydının geçersiz kılınması veya bir yama listesi uygulanması 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ı yoksayılır.

Parametreler

Parametre Açıklama
module_name zorunlu
Bu geçersiz kılmanın 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. Başka bir deyişle, bu modül "sabitlenmiş" olacaktır bu geçersiz kılma sürümüne ekleyebilirsiniz. Geçersiz kılmak isteyen tek şey kayıt defteri veya yamalarsa bu özellik atlanabilir.
registry varsayılan değer ''
Bu modül için kayıt defterini geçersiz kılar; Bu modülü varsayılan kayıt defteri listesinden bulmak yerine, verilen kayıt defteri kullanılmalıdır.
patches string yinelenebilir; varsayılan değer: []
Bu modüle uygulanacak yama dosyalarını işaret eden etiketlerin listesi. Yama dosyaları, üst düzey projenin kaynak ağacında bulunmalıdır. Liste sırasına göre uygulanırlar.
patch_cmds string yinelenebilir; 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.

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; yöntemleri, modül uzantı etiketleri oluşturmak için çağrılabilir.

Parametreler

Parametre Açıklama
extension_bzl_file zorunlu
Starlark dosyasında modül uzantısını tanımlayan bir etiket.
extension_name zorunlu
Kullanılacak modül uzantısının adı. Starlark dosyası bu ada sahip bir simgeyi dışa aktarmalıdır.
dev_dependency varsayılan değer False
Doğru değerine ayarlanırsa 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 varsayılan değer False
Deneyseldir. Bu parametre deneme amaçlıdır ve herhangi bir zamanda değişebilir. Lütfen bu metrikten yararlanmayın. ---experimental_isolated_extension_usages ayarlanarak deneysel olarak etkinleştirilebilir.
Doğru değerine ayarlanırsa modül uzantısının bu kullanımı, hem bu modüldeki 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 kod depolarından 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 zorunlu
use_extension çağrısı tarafından döndürülen bir modül uzantısı proxy nesnesi.
args zorunlu
İçe aktarılacak depoların adları.
kwargs zorunlu
Geçerli modülün kapsamına farklı adlarla içe aktarılacak belirli depoları belirtir. Anahtarlar, geçerli kapsamda kullanılacak ad olmalıdır. 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)

Doğrudan MODULE.bazel dosyasında 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 mevcut modül tarafından, proxy'deki name özelliği kullanılarak belirtilen ad altında görülebilir. Örtülü Boole dev_dependency özelliği, belirli bir deponun yalnızca geçerli modül kök modül olduğunda oluşturulduğunu belirtmek için proxy üzerinde de kullanılabilir.

Parametreler

Parametre Açıklama
repo_rule_bzl_file zorunlu
Starlark dosyasında depo kuralını tanımlayan bir etiket.
repo_rule_name zorunlu
Kullanılacak depo kuralının adı. Starlark dosyası bu ada sahip bir simgeyi dışa aktarmalıdır.