modül_kalori

Nightly · 9.0 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7
Bağımlılık grafiğindeki ilgili etiketler hakkında yardımcı işlevler ve bilgiler içeren modül uzantısının bağlamı. Bir modül uzantısı oluşturduğunuzda implementation işlevine bağımsız değişken olarak bir module_ctx nesnesi iletilir.

Üyeler

indir

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

Belirtilen URL'deki dosyayı çıkış yoluna indirir ve success içeren bir yapı döndürür. Bu yapı, indirme işlemi başarıyla tamamlandıysa true olan bir işarettir. Başarılı olursa sha256 ve integrity alanlarıyla birlikte dosyanın karmasını içerir.

Parametreler

Parametre Açıklama
url string veya string yinelemesi; zorunlu
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output string; veya Label; veya path; varsayılan değer ''
çıktı dosyasının yolu (depo dizinine göre).
sha256 varsayılan değer ''
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'yı atlamak güvenlik riski oluşturur. Bu alanın atlanması en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır.
executable varsayılan değer False
'dir. Oluşturulan dosyada yürütülebilir işaretini ayarlayın. Varsayılan olarak false değerini alır.
allow_fail varsayılan değer False
Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine döndürülen değerde hatayı belirtin.
canonical_id varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonik kimlikle 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 kaynak bütünlüğü biçimindeki 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ı atlamak güvenlik riski oluşturur. Bu alanın atlanması en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden ö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={})

Belirtilen URL için bir dosyayı çıkış yoluna indirir, dosyayı ayıklar ve success içeren bir yapı döndürür. success, indirme işlemi başarıyla tamamlandıysa true olan bir işarettir. Başarılı olursa sha256 ve integrity alanlarıyla birlikte dosyanın karmasını döndürür.

Parametreler

Parametre Açıklama
url string veya string yinelemesi; zorunlu
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output string; veya Label; veya path; varsayılan değer ''
arşivin açılacağı dizinin yolu (depo dizinine göre).
sha256 varsayılan değer ''
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'yı atlamak güvenlik riski oluşturur. Bu alanın atlanması en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır. Sağlanırsa önce verilen karma değerine sahip bir dosya için depo önbelleği kontrol edilir. Yalnızca dosya önbellekte bulunamazsa indirme işlemi denenir. Dosya başarıyla indirildikten sonra önbelleğe eklenir.
type Varsayılan değer, indirilen dosyanın arşiv türü olan ''
'dir. Varsayılan olarak, arşiv türü URL'nin dosya uzantısından belirlenir. Dosyanın uzantısı yoksa "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" veya ".deb" uzantılarını açıkça belirtebilirsiniz.
stripPrefix Varsayılan değer ''
çıkarılan dosyalardan kaldırılacak bir dizin önekidir. Birçok arşiv, arşivdeki tüm dosyaları içeren üst düzey bir dizin içerir. Bu öneki build_file içinde tekrar tekrar belirtmek yerine, bu alan çıkarılan dosyalardan öneki 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 döndürülen değerde hatayı belirtin.
canonical_id varsayılan değer ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonik kimlikle 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 kaynak bütünlüğü biçimindeki 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ı atlamak güvenlik riski oluşturur. Bu alanın atlanması en iyi ihtimalle derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderimden önce ayarlanmalıdır.
rename_files Varsayılan değer {}
'dir. Çıkarma işlemi 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 önekinde herhangi bir düzenleme yapılmadan önce değerle yeniden adlandırılır. Bu seçenek, Unicode olmayan dosya adları içeren veya büyük/küçük harfe duyarsız dosya sistemlerinde aynı yola çıkarılacak dosyalar içeren arşivleri çıkarmak 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 değer 600 saniyedir). Bu yöntem, komutun çıkışını içeren bir exec_result yapısı döndürür. environment haritası, işleme iletilecek bazı ortam değişkenlerini geçersiz kılmak için kullanılabilir.

Parametreler

Parametre Açıklama
arguments zorunlu
Bağımsız değişkenlerin listesi. İlk öğe, yürütülecek programın yolu 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 {}
'dir. Bazı ortam değişkenlerinin işleme iletilecek şekilde ayarlanmasını zorlar.
quiet Varsayılan değer True
'dir. stdout ve stderr'in terminale yazdırılıp yazdırılmayacağı.
working_directory Varsayılan değer ""
'dir. Komut yürütme için çalışma dizini. Depo köküne göre göreli veya mutlak 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ülebilen ve uzantı tarafından oluşturulan depolarla ilgili meta verileri Bazel'e sağlayan opak bir nesne oluşturur.

Parametreler

Parametre Açıklama
root_module_direct_deps string'lerin sırası; veya string; veya None; varsayılan değer None
Uzantının, kök modülün doğrudan bağımlılıkları olarak kabul ettiği depoların adları. Kök modül ek depoları içe aktarıyorsa veya bu depoların tümünü use_repo üzerinden içe aktarmıyorsa Bazel, uzantı değerlendirilirken bir uyarı ve düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden biri belirtilirse diğeri de belirtilmelidir. Bu iki parametreyle belirtilen listeler ayrık olmalıdır.

root_module_direct_deps ve root_module_direct_dev_deps değerlerinden yalnızca biri, "all" özel değerine ayarlanabilir. Bu değer, uzantı tarafından oluşturulan tüm depoların adlarının bulunduğu bir liste değer olarak belirtilmiş gibi değerlendirilir.

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

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden biri belirtilirse diğeri de belirtilmelidir. Bu iki parametreyle belirtilen listeler ayrık olmalıdır.

root_module_direct_deps ve root_module_direct_dev_deps değerlerinden yalnızca biri, "all" özel değerine ayarlanabilir. Bu değer, uzantı tarafından oluşturulan tüm depoların adlarının bulunduğu bir liste değer olarak belirtilmiş gibi değerlendirilir.

dosya

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

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

Parametreler

Parametre Açıklama
path string; veya Label; veya path; required
path of the file to create, relative to the repository directory.
content varsayılan değer ''
oluşturulacak dosyanın içeriği, varsayılan olarak boş.
executable Varsayılan değer True
'dir. Oluşturulan dosyada yürütülebilir işaretini ayarlayın. Varsayılan olarak true değerini alır.
legacy_utf8 Varsayılan değer True
'dir. Dosya içeriğini UTF-8 olarak kodlayın. Varsayılan olarak true değerini alır. Gelecekteki sürümlerde varsayılan değer değiştirilecek ve bu parametre kaldırılacak.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

devDependency = True ile use_extension çağrısının sonucunda belirtilen etiketin olup olmadığını döndürür.

Parametreler

Parametre Açıklama
tag bazel_module_tag; required
bazel_module.tags'den alınan bir etiket.

modüllerin

list module_ctx.modules

Harici bağımlılık grafiğindeki bu modül uzantısını kullanan tüm Bazel modüllerinin listesi. Bu listedeki her modül, bu uzantı için belirttiği tüm etiketleri kullanıma sunan bir bazel_module nesnesidir. Bu sözlüğün yineleme sırasının, kök modülden başlayarak genişlik öncelikli aramayla aynı olacağı garanti edilir.

os

repository_os module_ctx.os

Sistemdeki bilgilere erişmek için kullanılan yapı.

yol

path module_ctx.path(path)

Dize, etiket veya yoldan bir yol döndürür. Yol göreliyse depo dizinine göre çözümlenir. Yol bir etiketse ilgili dosyanın yoluna çözümlenir. Uzak depoların analiz aşamasında yürütüldüğünü ve bu nedenle hedef sonuca bağlı olamayacağını unutmayın (etiket, oluşturulmamış bir dosyayı işaret etmelidir). Yol bir yol ise bu yolu olduğu gibi döndürür.

Parametreler

Parametre Açıklama
path dize; veya etiket; veya yol; gerekli
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 string; veya Label; veya path; required
Okunacak dosyanın yolu.

report_progress

None module_ctx.report_progress(status='')

Bu depo veya modül uzantısının getirilmesiyle ilgili ilerleme durumunu günceller.

Parametreler

Parametre Açıklama
status string; varsayılan değer ''
getirme ilerleme durumunun mevcut durumunu açıklayan dize

root_module_has_non_dev_dependency

bool module_ctx.root_module_has_non_dev_dependency

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

hangi

path module_ctx.which(program)

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

Parametreler

Parametre Açıklama
program gerekli
Yolda bulunacak program.
Dönüş None.