modül_kalori

Yardımcı işlevleri ve bağımlılık grafiğinde ilgili etiketlerle ilgili bilgileri içeren modül uzantısının bağlamı. Modül uzantısı oluşturduğunuzda implementation işlevi için bağımsız değişken olarak bir modül_ctx nesnesi alırsınız.

Üyeler

indirme

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

Sağlanan URL'nin çıkış yoluna bir dosya indirir ve success içeren bir struct döndürür. success, indirme işlemi başarıyla tamamlanırsa true işaretidir ve 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 = ''
depo dizinine göreli çıkış dosyası yolu.
sha256 default = ''
indirilen dosyanın beklenen SHA-256 karmasıdır. Bu değer, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceği için SHA-256'nın atlanması güvenlik riski oluşturur. Bu alanın atlanması, derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderim öncesinde ayarlanmalıdır.
executable default = False
Oluşturulan dosyadaki yürütülebilir işareti varsayılan olarak false (yanlış) değerine ayarlayın.
allow_fail default = False
Ayarlanırsa başarısız olan indirme işlemleri için hata oluşturmak yerine döndürülen değerde hatayı belirtin
canonical_id default = ''
Ayarlanırsa önbellek isabetleri, dosyanın aynı standart kimlikle önbelleğe eklendiği durumlarla kısıtlanır
auth default = {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir ifade.
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ği için sağlama toplamını atlamak güvenlik açısından risk taşır. Bu alanın atlanması, derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderim öncesinde 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={})

Sağlanan URL'nin çıkış yoluna bir dosya indirir, dosyayı çıkarır ve success işaretini içeren bir struct döndürür. true Bu işaret, indirme işlemi başarıyla tamamlanırsa sha256 ve integrity alanlarını içeren dosyanın karmasını içerir.

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 = ''
depo dizinine göre, arşivin paketinin açılacağı dizine giden yol.
sha256 default = ''
indirilen dosyanın beklenen SHA-256 karmasıdır. Bu değer, indirilen dosyanın SHA-256 karmasıyla eşleşmelidir. Uzak dosyalar değişebileceği için SHA-256'nın atlanması güvenlik riski oluşturur. Bu alanın atlanması, derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderim öncesinde ayarlanmalıdır. Kod deposu önbelleği sağlanırsa önce belirtilen karmaya sahip bir dosya olup olmadığı kontrol edilir. İndirme işlemi yalnızca dosyanın önbellekte bulunmaması durumunda denenir. İndirme işlemi başarılı olduktan sonra dosya önbelleğe eklenir.
type default = ''
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 açık bir şekilde "zip", "jar", "war", "aar", "tar", "tar.gz", "txz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".ar" veya ".deb" değerlerini belirtebilirsiniz.
stripPrefix default = ''
ayıklanan dosyalardan çıkarılacak bir dizin önekidir. 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 zorunda kalmak yerine, bu alan onu ayıklanan dosyalardan çıkarmak için kullanılabilir.
allow_fail default = False
Ayarlanırsa başarısız olan indirme işlemleri için hata oluşturmak yerine döndürülen değerde hatayı belirtin
canonical_id default = ''
Ayarlanırsa önbellek isabetleri, dosyanın aynı standart kimlikle önbelleğe eklendiği durumlarla kısıtlanır
auth default = {}
Bazı URL'ler için kimlik doğrulama bilgilerini belirten isteğe bağlı bir ifade.
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ği için sağlama toplamını atlamak güvenlik açısından risk taşır. Bu alanın atlanması, derlemenizin hermetik olmamasına neden olur. Geliştirmeyi kolaylaştırmak için isteğe bağlıdır ancak gönderim öncesinde ayarlanmalıdır.
rename_files default = {}
Ayıklama sırasında yeniden adlandırılacak dosyaları belirten isteğe bağlı bir dikte. Adları bir anahtarla tam olarak eşleşen arşiv girişleri, herhangi bir dizin öneki düzenlemesinden önce değer olarak yeniden adlandırılır. Bu, Unicode olmayan dosya adları veya büyük/küçük harfe duyarlı olmayan dosya sistemlerinde aynı yola çıkarılacak 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 listesinde verilen komutu yürütür. Komutun yürütülme süresi timeout ile sınırlıdır (saniye cinsinden, varsayılan olarak 600 saniye). Bu yöntem, komutun çıkışını içeren bir exec_result yapısı döndürür. environment eşlemesi, işleme geçirilecek 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 için ilk öğe, yürütülecek programın yolu olmalıdır.
timeout varsayılan = 600
komutun saniye cinsinden maksimum süresi (varsayılan değer 600 saniyedir).
environment default = {}
bazı ortam değişkenlerini işleme geçirilecek şekilde ayarlamaya zorlar.
quiet default = True
stdout ve stderr'in terminale yazdırılması gerekiyorsa.
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)

Bazel uzantısı tarafından oluşturulan depolar hakkında meta veri sağlamak için modül uzantısının uygulama işlevinden döndürülebilen opak bir nesne oluşturur.

Parametreler

Parametre Açıklama
root_module_direct_deps sequence of strings; or string; or None; default = 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 bir düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden biri belirtilmişse diğerinin de belirtilmesi gerekir. Bu iki parametreyle 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, uzantı tarafından oluşturulan tüm kod depolarının adlarını içeren bir liste değer olarak belirtilmiş gibi kabul edilir.

root_module_direct_dev_deps sequence of strings; or string; or None; default = None
Uzantının kök modülün doğrudan geliştirici bağımlılıkları 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 bir uzantı proxy'sinde use_repo aracılığıyla bu depoların tümünü içe aktarmazsa Bazel, uzantı değerlendirilirken bir uyarı ve bir düzeltme komutu yazdırır.

root_module_direct_deps ve root_module_direct_dev_deps özelliklerinden biri belirtilmişse diğerinin de belirtilmesi gerekir. Bu iki parametreyle 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, uzantı tarafından oluşturulan tüm kod depolarının adlarını içeren bir liste değer olarak belirtilmiş gibi kabul edilir.

file

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

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

Parametreler

Parametre Açıklama
path string; or Label; or path; zorunlu
oluşturulacak dosyanın yolu (repository dizinine göre).
content varsayılan = ''
oluşturulacak dosyanın içeriği varsayılan olarak boştur.
executable varsayılan = Doğru
Oluşturulan dosyadaki yürütülebilir işareti varsayılan olarak true şeklinde ayarlar.
legacy_utf8 default = True
Dosya içeriğini varsayılan olarak doğru olan UTF-8 olarak kodlar. Gelecekteki sürümler varsayılanı değiştirecek ve bu parametreyi kaldıracak.

is_dev_dependency

bool module_ctx.is_dev_dependency(tag)

Belirtilen etiketin devDependency = True ile yapılan 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'dan alınan bir etiket.

is_isolated

bool module_ctx.is_isolated

Uzantının bu özel kullanımında isolate = True belirtilip belirtilmediği ve dolayısıyla diğer tüm kullanımlardan izole edilip edilmediğidir.

modules

list module_ctx.modules

Harici bağımlılık grafiğinde, bu modül uzantısını kullanan tüm Bazel modüllerinin listesi. Bunların her biri, bu uzantı için belirttiği tüm etiketleri gösteren bir bazel_module nesnesidir. Bu sözlüğün yineleme sırası, kök modülden başlayarak geniş öncelikli arama ile aynı olacaktır.

os

repository_os module_ctx.os

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

yol

path module_ctx.path(path)

Bir 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 yolsa bu yolu olduğu gibi döndürür.

Parametreler

Parametre Açıklama
path string; or Label; or path; zorunlu
dize, etiket veya yol oluşturmak için

okuma

string module_ctx.read(path)

Bir dosyanın içeriğini dosya sisteminde okur.

Parametreler

Parametre Açıklama
path string; or Label; or path; okuma için zorunlu
dosyanın yolu.

report_progress

None module_ctx.report_progress(status='')

Bu kod deposunun veya modül uzantısının getirilmesiyle ilgili ilerleme durumunu günceller

Parametreler

Parametre Açıklama
status string; default = ''
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ştirme dışı 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.
None cihazı döndürülebilir.