modül_kalori

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='')

Sağlanan URL için çıkış yoluna bir dosya indirir ve success öğesini içeren bir struct döndürür. Bu işaret, indirme işlemi başarıyla tamamlandıysa true ve başarılıysa sha256 ile integrity alanlarını içeren karma bir dosyadır.

Parametreler

Parametre Açıklama
url string; or Iterable of strings; zorunlu
Aynı dosyaya atıfta bulunan ayna URL'lerin listesi.
output string; or Label; or path; varsayılan = ''
Çıkış dosyasının, depo dizine göre yolu.
sha256 varsayılan = ''
indirilen dosyanın beklenen SHA-256 karması. Bu değer, 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.
executable default = False
Oluşturulan dosyada yürütülebilirlik işaretini ayarlar. Varsayılan olarak yanlıştır.
allow_fail default = False
Ayarlanırsa başarısız indirmeler için hata oluşturmak yerine hatayı döndürülen değerde belirtin
canonical_id default = ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonikal kimlikle eklendiği durumlarla kısıtlayın
auth default = {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
integrity varsayılan = ''
İndirilen dosyanın beklenen sağlama toplamı (Subresource Integrity biçiminde). Bu, indirilen dosyanın sağlama toplamıyla eşleşmelidir. Uzak dosyalar değişebileceği için sağlama toplamı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 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={})

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; or Iterable of strings; zorunlu
Aynı dosyaya referans veren yansıtma URL'lerinin listesi.
output string; or Label; or path; default = ''
Arşivin, depo dizine göre paketten çıkarılacağı dizinin yolu.
sha256 varsayılan = ''
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'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. 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 = ''
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 burada "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar" veya ".deb" değerlerini açıkça belirtebilirsiniz.
stripPrefix varsayılan = ''
Çıkarılan dosyalardan kaldırılacak bir dizin ön eki. Birçok arşiv, arşivdeki tüm dosyaları içeren bir üst düzey dizin içerir. Bu ön eki build_file içinde tekrar tekrar belirtmek yerine bu alan, ayıklanan dosyalardan onu ayırmak için kullanılabilir.
allow_fail default = False
Ayarlanırsa, başarısız indirmeler için hata mesajı iletmek yerine döndürülen değerde hatayı belirtin
canonical_id default = ''
Ayarlanırsa önbellek isabetlerini, dosyanın önbelleğe aynı kanonikal kimlikle eklendiği durumlarla kısıtlayın
auth default = {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir sözlük.
integrity default = ''
İ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.
rename_files default = {}
Ayıklama sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir sözlük. Bir anahtarla tam olarak eşleşen adlara sahip arşiv girişleri, herhangi bir dizin öneki ayarlamasından önce değer olarak 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ütülme süresi timeout ile sınırlıdır (saniye cinsinden, varsayılan 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 default = 600
komutun saniye cinsinden maksimum süresi (varsayılan değer 600 saniyedir).
environment default = {}
bazı ortam değişkenlerinin sürece aktarılacak şekilde ayarlanmasını zorunlu kılar.
quiet varsayılan = True
stdout ve stderr'nin terminale yazdırılıp yazdırılmayacağı.
working_directory default = ""
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 sequence of strings; or string; or None; default = None
Uzantı tarafından kök modülün doğrudan bağımlılıkları olarak kabul edilen 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 özelliklerinden biri belirtilirse diğerinin de belirtilmesi gerekir. 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.

root_module_direct_dev_deps sequence of strings; or string; or None; default = Yok
Uzantının, kök modülünün doğrudan geliştirici bağımlıları olarak kabul ettiği depoların adları. Kök modül ek depoları içe aktarırsa veya use_extension(..., dev_dependency = True) ile oluşturulan uzantı proxy'sinde use_repo aracılığıyla bu depoların tümünü içe aktarmazsa Bazel uzantı değerlendirildiğinde 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 özelliklerinden tam olarak biri, "all" özel değerine ayarlanabilir. Bu durumda, uzantı tarafından oluşturulan tüm depoların adlarını içeren 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; or Label; or path; oluşturulacak dosyanın depo diziniyle göreceli
yolu.
content default = ''
Oluşturulacak dosyanın içeriğidir. Varsayılan olarak boştur.
executable default = True
Oluşturulan dosyada yürütülebilirlik işaretini varsayılan olarak true olarak ayarlayın.
legacy_utf8 default = True
Dosya içeriğini UTF-8 olarak kodlayın (varsayılan olarak true). 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 belirtilmeyeceğini döndürür.

Parametreler

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

is_isolated

bool module_ctx.is_isolated

Uzantının bu özel kullanımının isolate = True belirtip belirtmediği ve bu nedenle diğer tüm kullanımlardan ayrı tutulup tutulmadığı.

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 geniş kapsamlı aramayla aynı olacağı garanti edilir.

os

repository_os module_ctx.os

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

yol

path module_ctx.path(path)

Bir dize, etiket veya yoldan yol döndürür. Göreli bir yol ise kod deposu dizine göre çözümlenir. Yol bir etiketse karşılık gelen 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). path bir yol ise bu yol olduğu gibi döndürülür.

Parametreler

Parametre Açıklama
path string; or Label; or path; zorunlu
yol oluşturmak için kullanılacak 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; or Label; or path; okumanın yapılacağı dosyanın gerekli
yoludur.

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 string; varsayılan = "'
getirme işleminin 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ştirici dışı bir bağımlılık olarak kullanıp kullanmadığı.

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 gerekli
Yolda bulunacak programı kullanın.
None değerini döndürebilir.