MODULE.bazel dosyalarında bulunan yöntemler.
Üyeler
- archive_override
- bazel_dep
- git_override
- include
- inject_repo
- local_path_override
- module
- multiple_version_override
- override_repo
- register_execution_platforms
- register_toolchains
- single_version_override
- use_extension
- use_repo
- use_repo_rule
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 yok sayı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ı. |
urls
|
dize veya dize türünde iteratör;
zorunlu Arşivin URL'leri; http(s):// veya file:// URL'leri olabilir. |
integrity
|
varsayılan '' şeklindedirArşiv dosyasının, Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı. |
strip_prefix
|
varsayılan ayar '' Çıkarılan dosyalardan kaldırılacak bir dizin ön eki. |
patches
|
dize yinelemesi; varsayılan [] şeklindedirBu modül için uygulanacak yama dosyalarına 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
|
Dize yinelemesi; varsayılan olarak [] şeklindedirYamalar 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 belirtir.
Parametreler
Parametre | Açıklama |
---|---|
name
|
required Doğrudan bağımlılık olarak eklenecek modülün adı. |
version
|
varsayılan olarak '' Doğrudan bağımlılık olarak eklenecek modülün sürümü. |
max_compatibility_level
|
varsayılan olarak -1 şeklindedirModü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
|
varsayılan değeri '' şeklindedirBu bağımlılığı temsil eden harici deponun adı. Bu, varsayılan olarak modülün adıdır. |
dev_dependency
|
varsayılan değeri False şeklindedirGeçerli 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. 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ı. |
remote
|
zorunlu Uzak Git deposunun URL'si. |
commit
|
varsayılan değer '' Dikkate alınması gereken kayıttır. |
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. Liste sırasına göre uygulanırlar. |
patch_cmds
|
Dize yinelemesi; varsayılan olarak [] şeklindedirYamalar 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 '' şeklindedirAyıklanan dosyalardan kaldırılacak bir dizin öneki. Bu, git deposunun bir alt dizesini hedeflemek için kullanılabilir. Alt dizinde, bu `git_override` işlevine 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. bazel_dep
'ın MODULE dosyası include()
kullanıyorsa bu 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
|
gerekli 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.
Mevcut modül kök modül değilse veya "--ignore_dev_dependency" etkinse bu değer yoksayılır.
Mevcut bir depoyu geçersiz kılmak için bunun yerine override_repo
kullanın.
Parametreler
Parametre | Açıklama |
---|---|
extension_proxy
|
gerekliuse_extension çağrısı tarafından döndürülen bir modül uzantısı proxy nesnesi.
|
args
|
required Mevcut modül tarafından görülebilen ve aynı ad altında uzantıya eklenmesi gereken depolardır. |
kwargs
|
gerekli Uzantıya eklenecek yeni kod depolarıdır. Burada, değerler mevcut modülün kapsamındaki depo adlarıdır ve anahtarlar, uzantıda görünecekleri addır. |
local_path_override
None
local_path_override(module_name, path)
Bir bağımlılık öğesinin 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ı 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ı. |
path
|
gerekli 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, 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 (başka bir modüle bağımlı olmayacaksa olduğu gibi) atlanabilir.
Parametreler
Parametre | Açıklama |
---|---|
name
|
varsayılan değeri '' şeklindedirModü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ıdır; 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 (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 'tir.Modülün uyumluluk düzeyi; önemli bir uyumsuz değişiklik sunulduğunda bu ayar 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 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ü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 yinelemesi; varsayılan olarak [] şeklindedirKullanı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ğ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 uyumsuz olduğu bilinen 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 tarihinden sonra kullanılabilen bazı özelliklere ihtiyacınız olduğunda kullanılır. -X.X.X: Bazel sürümü X.X.X 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ı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 bilgi için belgeleri 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
|
gerekli Bu geçersiz kılmanın 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. |
override_repo
None
override_repo(extension_proxy, *args, **kwargs)
Belirtilen modül uzantısı tarafından tanımlanan bir veya daha fazla depoyu, geçerli modül tarafından görülebilen belirtilen depolarla geçersiz kılar. Mevcut modül kök modül değilse veya "--ignore_dev_dependency" etkinleştirilmişse bu değer yoksayılır.
Yeni bir depo eklemek için bunun yerine inject_repo
simgesini kullanın.
Parametreler
Parametre | Açıklama |
---|---|
extension_proxy
|
gerekliuse_extension çağrısı tarafından döndürülen bir modül uzantısı proxy nesnesi.
|
args
|
required Uzantıdaki ve mevcut modüldeki aynı ada sahip depoların geçersiz kılınması gereken depolardır. |
kwargs
|
gerekli Uzantı tarafından oluşturulan kod depolarına uygulanacak geçersiz kılmalar. Burada değerler, geçerli modülün kapsamındaki depo adlarıdır, anahtarlar ise uzantıda geçersiz kılacak 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ı 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 şeklindedirGeç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şlamalıdır). Daha fazla bilgi için araç zinciri çözünürlüğünü inceleyin.
Parametreler
Parametre | Açıklama |
---|---|
dev_dependency
|
Varsayılan değer False şeklindedirGeçerli 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)
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. 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ı. |
version
|
varsayılan değer '' değeridir.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 bu geçersiz kılma sürümüne "sabitlenir". Geçersiz kılmak isteyen tek şey kayıt defteri veya yamalarsa 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 yinelemesi; varsayılan [] şeklindedirBu modül için uygulanacak yama dosyalarına 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. Bir yama MODULE.bazel dosyasında değişiklik yaparsa bu değişiklikler yalnızca yama dosyasının kök modül tarafından sağlanması durumunda geçerli olur. |
patch_cmds
|
Dize yinelemesi; varsayılan olarak [] şeklindedirYamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi. MODULE.bazel dosyasında yapılan değişiklikler geçerli olmaz. |
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 proxy nesnesini döndürür. Yöntemleri, modül uzantı etiketleri oluşturmak için çağrılabilir.
Parametreler
Parametre | Açıklama |
---|---|
extension_bzl_file
|
gerekli Starlark dosyasına, modül uzantısını tanımlayan bir etiket. |
extension_name
|
gerekli 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 şeklindedirGeç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 metrikten yararlanmayın. ---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 kod depolarından farklı olur. Bu parametre şu anda deneyseldir ve yalnızca |
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
|
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 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)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 mevcut modül tarafından, proxy'deki
name
özelliği kullanılarak belirtilen ad altında 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
|
gerekli Starlark dosyasında depo kuralını tanımlayan bir etiket. |
repo_rule_name
|
gerekli Kullanılacak depo kuralının adı. Starlark dosyası bu ada sahip bir simgeyi dışa aktarmalıdır. |