modül_kalori

Sorun bildir Kaynağı görüntüle Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bağımlılıklar grafiğindeki alakalı etiketlerle ilgili yardımcı işlevleri ve bilgileri içeren modül uzantısının bağlamı. Bir modül uzantısı oluşturduğunuzda, implementation işlevinin bağımsız değişkeni olarak bir modül_ctx nesnesi alırsınız.

Üyeler

indir

struct module_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, *, integrity='')

Bir dosyayı, sağlanan URL'nin çıkış yoluna indirir ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlanırsa true olan bir işarettir. İndirme işlemi başarılı olursa sha256 ve integrity alanlarını içeren dosyanın karmasını döndürür.

Parametreler

Parametre Açıklama
url string; veya dizelerin yinelenebilir; gerekli
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output dize; veya Etiket; veya yol; varsayılan değer ''
depolama alanı dizine göre çıkış dosyasının yolu.
sha256 varsayılan değer '' olan
, indirilen dosyanın beklenen SHA-256 karmasıdır. Bu, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceğinden SHA-256'nın atlanması güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır.
executable varsayılan olarak False şeklindedir
oluşturulan dosyada yürütülebilir işareti varsayılan olarak false (yanlış) olarak ayarlar.
allow_fail varsayılan değer False
Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine hatayı döndürülen değerde belirtin
canonical_id varsayılan değer '' şeklindedir
Ayarlanırsa önbellek isabetlerini, dosyanın aynı standart kimliğe sahip önbelleğe eklendiği durumlarla sınırlandırın
auth varsayılan değer {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
integrity varsayılan '' şeklindedir
İndirilen dosyanın Alt Kaynak Bütünlüğü biçiminde beklenen sağlama toplamı. Bu, indirilen dosyanın sağlama toplamıyla eşleşmelidir. Uzak dosyalar değişebileceğinden sağlama toplamını çıkarmak güvenlik açısından risklidir. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır.

download_and_extract

struct module_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, *, integrity='', rename_files={})

Bir dosyayı, sağlanan URL'nin çıkış yoluna indirir, dosyayı çıkarır ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlanırsa true olan bir işarettir. İşlem başarılı olursa sha256 ve integrity alanlarını içeren dosyanın karmasını döndürür.

Parametreler

Parametre Açıklama
url string; veya dizelerin yinelenebilir; gerekli
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output dize; veya etiket; veya yol; varsayılan değer ''
Arşivin, depo dizine göre paketten çıkarılacağı dizinin yolu.
sha256 varsayılan değer ''
indirilen dosyanın beklenen SHA-256 karması. Bu, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceğinden SHA-256'yı çıkarmak güvenlik riski oluşturur. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak göndermeden önce ayarlanmalıdır. Sağlanırsa ilk olarak depo önbelleği, belirtilen karmaya sahip bir dosya olup olmadığını kontrol eder. İndirme işlemi yalnızca dosya önbellekte bulunamazsa denenir. İndirme işlemi başarılı olduğunda dosya önbelleğe eklenir.
type varsayılan olarak ''
indirilen dosyanın arşiv türü. Varsayılan olarak, arşiv türü URL'nin dosya uzantısına göre belirlenir. Dosyanın uzantısı yoksa "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".debar" veya ".debz" değerlerini açık bir şekilde belirtebilirsiniz.
stripPrefix varsayılan olarak ''
çıkarılan dosyalardan kaldırılacak bir dizin ön eki. Birçok arşiv, arşivdeki tüm dosyaları içeren üst düzey bir dizin içerir. Bu ön eki build_file içinde tekrar tekrar belirtmek yerine, bu alan çıkarılan dosyalardan kaldırmak için kullanılabilir.
allow_fail varsayılan değer False
Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine hatayı döndürülen değerde belirtin
canonical_id varsayılan değer '' şeklindedir
Ayarlanırsa önbellek isabetlerini, dosyanın aynı standart kimliğe sahip önbelleğe eklendiği durumlarla sınırlandırın
auth varsayılan değer {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
integrity varsayılan değer ''
İndirilen dosyanın, alt öğe bütünlüğü biçiminde beklenen sağlama toplamı. Bu, indirilen dosyanın sağlama toplamıyla eşleşmelidir. Uzak dosyalar değişebileceğinden sağlama toplamını çıkarmak güvenlik açısından risklidir. Bu alanın atlanması, en iyi ihtimalle derlemenizin hermetik olmasını engeller. Geliştirmeyi kolaylaştırmak isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır.
rename_files varsayılan değer {}
Çıkarma sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir sözlük. Adları bir anahtarla tam olarak eşleşen arşiv girişleri, dizin ön ek düzenlemesinden önce değerle yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harf duyarlı olmayan dosya sistemlerinde aynı yola ayıklanacak dosyalar içeren arşivleri ayıklamak için kullanılabilir.

execute

exec_result module_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

Bağımsız değişkenler listesi tarafından verilen komutu yürütür. Komutun yürütme süresi timeout ile sınırlıdır (saniye cinsinden, varsayılan olarak 600 saniye). Bu yöntem, komutun çıktısını içeren bir exec_result yapısı döndürür. environment eşlemesi, işleme iletilecek bazı ortam değişkenlerini geçersiz kılmak için kullanılabilir.

Parametreler

Parametre Açıklama
arguments gerekli
Bağımsız değişkenler listesi; ilk öğe, yürütülecek programa giden yol olmalıdır.
timeout varsayılan değer 600
komutun saniye cinsinden maksimum süresi (varsayılan değer 600 saniyedir).
environment varsayılan değer {}
bazı ortam değişkenlerinin işleme aktarılacak şekilde ayarlanmasını zorunlu kılar.
quiet varsayılan değer True
stdout ve stderr'nin terminale yazdırılıp yazdırılmayacağı.
working_directory varsayılan olarak "" şeklindedir
Komut yürütme için çalışma dizini. Depo kökü veya mutlak ile göreli olabilir.

extension_metadata

extension_metadata module_ctx.extension_metadata(root_module_direct_deps=None, root_module_direct_dev_deps=None)

Modül uzantısının uygulama işlevinden döndürülebilecek opak bir nesne oluşturur. Bu nesne, uzantı tarafından oluşturulan depolarla ilgili meta verileri Bazel'e sağlar.

Parametreler

Parametre Açıklama
root_module_direct_deps dize'lerin sequence; veya dize; veya None; varsayılan olarak None
Uzantının kök modülün doğrudan bağımlılığı olarak kabul ettiği depoların adları. Kök modül ek depolar içe aktarırsa veya bu depoların tümünü use_repo aracılığıyla içe aktarmazsa Bazel, uzantı değerlendirilirken bir uyarı ve düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps'den biri belirtilirse diğeri de belirtilmelidir. Bu iki parametre tarafından belirtilen listeler kesişmemelidir.

root_module_direct_deps ve root_module_direct_dev_deps arasından tam olarak biri "all" özel değerine ayarlanabilir. Bu değer, uzantı tarafından oluşturulan tüm depoların adlarını içeren bir listeymiş gibi değerlendirilir.

root_module_direct_dev_deps Dize dizisi; veya dize; veya None; varsayılan değer None
Uzantı tarafından kök modülün doğrudan geliştirici bağımlılıkları olarak kabul edilen depoların adları. Kök modül use_extension(..., dev_dependency = True) ile oluşturulan bir uzantı proxy'sinde use_repo aracılığıyla ek depolar içe aktarırsa veya bu depoların tümünü içe aktarmazsa Bazel, uzantı değerlendirilirken bir uyarı ve düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps'den biri belirtilirse diğeri de belirtilmelidir. Bu iki parametre tarafından belirtilen listeler ayrı olmalıdır.

root_module_direct_deps ve root_module_direct_dev_deps arasından tam olarak biri "all" özel değerine ayarlanabilir. Bu değer, uzantı tarafından oluşturulan tüm depoların adlarını içeren bir listeymiş gibi değerlendirilir.

dosya

None module_ctx.file(path, content='', executable=True, legacy_utf8=True)

Depo dizininde, sağlanan içeriği içeren bir dosya oluşturur.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
Oluşturulacak dosyanın, depolama alanı dizine göre yolu.
content varsayılan değer ''
oluşturulacak dosyanın içeriğidir, varsayılan olarak boştur.
executable varsayılan olarak True şeklindedir
oluşturulan dosyadaki yürütülebilir işaret varsayılan olarak "doğru" olarak ayarlanır.
legacy_utf8 varsayılan değer True
dosya içeriğini UTF-8 olarak kodlar, varsayılan olarak doğrudur. Gelecek sürümlerde varsayılan ayar değiştirilecek ve bu parametre kaldırılacaktır.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Belirtilen etiketin, devDependency = True ile bir use_extension çağrısının sonucunda belirtilip belirtilmediğini döndürür.

Parametreler

Parametre Açıklama
tag bazel_module_tag; zorunlu
bazel_module.tags kaynağından alınan bir etiket.

modüllerin

list module_ctx.modules

Harici bağımlılık grafiğinde bu modül uzantısını kullanan tüm Bazel modüllerinin listesi. Bu modüllerin her biri, bu uzantı için belirttiği tüm etiketleri gösteren bir bazel_module nesnesi şeklindedir. Bu sözlüğün iterasyon sırasının, kök modülden başlayarak kapsama öncelik veren aramayla aynı olması garanti edilmektedir.

işletim sistemi

repository_os module_ctx.os

Sistemdeki bilgilere erişmek için bir struct.

yol

path module_ctx.path(path)

Bir dizeden, etiketten veya yoldan bir yol döndürür. Göreli bir yol ise kod deposu dizine göre çözümlenir. Yol bir etiketse ilgili dosyanın yoluna çözümlenir. Uzak depoların analiz aşamasında çalıştırıldığını ve bu nedenle hedef bir sonuca bağlı olamayacağını unutmayın (etiket, oluşturulmamış bir dosyayı işaret etmelidir). Yol bir yolsa bu yolu olduğu gibi döndürür.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; gerekli
içinden yol oluşturulacak dize, etiket veya yol

okuma

string module_ctx.read(path)

Dosya sistemindeki bir dosyanın içeriğini okur.

Parametreler

Parametre Açıklama
path dize; veya Etiket; veya yol; zorunlu
Okunacak dosyanın yolu.

report_progress

None module_ctx.report_progress(status='')

Bu deposunun veya modül uzantısının getirilmesi işleminin ilerleme durumunu günceller

Parametreler

Parametre Açıklama
status dize; varsayılan olarak getirme işleminin mevcut durumunu açıklayan ''
dizesidir

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

Kök modülün bu uzantıyı geliştirici dışı bir bağımlılık olarak kullanıp kullanmadığını belirtir.

hangi

path module_ctx.which(program)

İlgili programın yolunu döndürür veya yolda böyle bir program yoksa None değerini döndürür.

Parametreler

Parametre Açıklama
program required
Yolda bulunacak program.
None değerini döndürebilir.