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 yoksayılır.
Parametreler
Parametre | Açıklama |
---|---|
module_name
|
string;
gerekli Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı. |
urls
|
dize veya dize türünde bir dizi;
zorunlu Arşivin URL'leri; http(s):// veya file:// URL'leri olabilir. |
integrity
|
string;
varsayılan değer: '' Arşiv dosyasının, Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı. |
strip_prefix
|
dize;
varsayılan değer '' Ayıklanan 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
|
int;
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
|
string;
gerekli Doğrudan bağımlılık olarak eklenecek modülün adı. |
version
|
string;
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
|
string;
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ğruysa 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. 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;
gerekli Bu geçersiz kılmanın uygulanacağı Bazel modülü bağımlılığının adı. |
remote
|
string;
gerekli Uzak Git deposunun URL'si. |
commit
|
string;
varsayılan değer: '' İncelenmesi gereken kayı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. Liste sırasına göre uygulanırlar. |
patch_cmds
|
Dize öğelerinin iterasyonu;
varsayılan değer [] Yamalar uygulandıktan sonra Linux/Macos'ta uygulanacak Bash komutları dizisi. |
patch_strip
|
int;
varsayılan değer: 0 Unix yamasının --strip bağımsız değişkeniyle aynıdır. |
init_submodules
|
bool;
varsayılan değer: False Getirilen depodaki git alt modüllerinin yinelemeli olarak başlatılıp başlatılmayacağı. |
strip_prefix
|
dize;
varsayılan değer '' Ayıklanan 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()
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.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 depodaki 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 parçaya ayırmanıza olanak tanır.
Parametreler
Parametre | Açıklama |
---|---|
label
|
string;
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 kod deposu ekler.
Mevcut mod kök mod değilse veya `--ignore_dev_dependency` etkinse bu yoksayılır.
Bir ayarı geçersiz kılmak için override_repo
depolayabilirsiniz.
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ı ad altında uzantıya eklenmesi gereken depolardır. |
kwargs
|
zorunlu Uzantıya eklenecek yeni depolar. Burada değerler, geçerli modülün kapsamındaki depoları ve anahtarlar olacakları addır görünü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
|
string;
gerekli Bu geçersiz kılmanın 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 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
|
string;
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 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
|
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, 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 ayrıntı için dokümanları inceleyin.
|
repo_name
|
string;
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, kendisi için modül adından farklı bir depo adı kullanan projelerin taşınmasını kolaylaştırmak için belirtilebilir. |
bazel_compatibility
|
string yinelemeli;
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 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ığı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 ayrıntı için dokümanları inceleyin. Bu yönerge yalnızca kök modülde geçerli olur; Yani 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
|
string;
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üldeki bağımlılıklar "yükseltilecek" bir hataya neden olurken, aynı uyumluluk düzeyindeki izin verilen sürümlerden daha yüksek bir sürüme sahip olan bağımlılıklar hataya neden olur. |
registry
|
string;
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. |
override_repo
None
override_repo(extension_proxy, *args, **kwargs)
Belirtilen modül uzantısı tarafından tanımlanan bir veya daha fazla depoyu belirtilen kod depolarıyla geçersiz kılar
görebilirsiniz. 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 ve mevcut modüldeki aynı ada sahip depoların geçersiz kılınması gereken depolardır. |
kwargs
|
zorunlu Uzantı tarafından oluşturulan kod depolarına uygulanacak geçersiz kılmalar. Buradaki değerler, mevcut modül kapsamındaki depoların adlarıdır. Anahtarlar ise uzantıda geçersiz kılacak depoların adlarını belirtir. |
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 çok hedefe genişleyen kalıplar, ada göre sözlüksel sırayla kaydedilir.
Parametreler
Parametre | Açıklama |
---|---|
dev_dependency
|
bool;
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 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
|
sequence of dize;
gerekli Kaydedilecek hedef kalıplar. |
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; Yani 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
|
string;
required Bu geçersiz kılma işleminin uygulanacağı Bazel modülü bağımlılığının adı. |
version
|
string;
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". Geçersiz kılmak isteyen tek şey kayıt defteri veya yamalarsa 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
|
string yinelemeli;
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. 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; yöntemleri, modül uzantı etiketleri oluşturmak için çağrılabilir.
Parametreler
Parametre | Açıklama |
---|---|
extension_bzl_file
|
string;
gerekli Starlark dosyasında modül uzantısını tanımlayan bir etiket. |
extension_name
|
dize;
zorunlu 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
|
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 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 depolardan 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
|
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 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. 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
|
string;
gerekli Starlark dosyasında depo kuralını tanımlayan bir etiket. |
repo_rule_name
|
string;
gerekli Kullanılacak depo kuralının adı. Starlark dosyası bu ada sahip bir simge dışa aktarmalıdır. |